diff --git a/.release.json b/.release.json index 79f3c57..420b289 100644 --- a/.release.json +++ b/.release.json @@ -1,9 +1,9 @@ { "source": { "repo_url": "https://github.com/onfido/onfido-openapi-spec", - "short_sha": "30c4d08", - "long_sha": "30c4d08a018e09bc02d87e6c04a137c371541163", - "version": "v5.6.0" + "short_sha": "3e893ef", + "long_sha": "3e893efe638faef78662beb4eb2ad2e14f1d2506", + "version": "v5.7.0" }, - "release": "v5.6.0" + "release": "v5.7.0" } diff --git a/onfido/__init__.py b/onfido/__init__.py index 0ff9d6c..d0561a6 100644 --- a/onfido/__init__.py +++ b/onfido/__init__.py @@ -14,7 +14,7 @@ """ # noqa: E501 -__version__ = "5.6.0" +__version__ = "5.7.0" # import apis into sdk package from onfido.api.default_api import DefaultApi @@ -232,6 +232,9 @@ from onfido.models.location_shared import LocationShared from onfido.models.motion_capture import MotionCapture from onfido.models.motion_captures_list import MotionCapturesList +from onfido.models.passkey import Passkey +from onfido.models.passkey_updater import PasskeyUpdater +from onfido.models.passkeys_list import PasskeysList from onfido.models.photo_auto_reasons import PhotoAutoReasons from onfido.models.photo_reasons import PhotoReasons from onfido.models.proof_of_address_breakdown import ProofOfAddressBreakdown @@ -260,6 +263,10 @@ from onfido.models.sdk_token_builder import SdkTokenBuilder from onfido.models.sdk_token_request import SdkTokenRequest from onfido.models.sdk_token_response import SdkTokenResponse +from onfido.models.signing_document import SigningDocument +from onfido.models.signing_document_response import SigningDocumentResponse +from onfido.models.signing_document_shared import SigningDocumentShared +from onfido.models.signing_documents_list import SigningDocumentsList from onfido.models.task import Task from onfido.models.task_item import TaskItem from onfido.models.timeline_file_reference import TimelineFileReference diff --git a/onfido/api/default_api.py b/onfido/api/default_api.py index 4f08f7f..a917e2a 100644 --- a/onfido/api/default_api.py +++ b/onfido/api/default_api.py @@ -43,12 +43,17 @@ from onfido.models.location_builder import LocationBuilder from onfido.models.motion_capture import MotionCapture from onfido.models.motion_captures_list import MotionCapturesList +from onfido.models.passkey import Passkey +from onfido.models.passkey_updater import PasskeyUpdater +from onfido.models.passkeys_list import PasskeysList from onfido.models.repeat_attempts_list import RepeatAttemptsList from onfido.models.report import Report from onfido.models.reports_list import ReportsList from onfido.models.results_feedback import ResultsFeedback from onfido.models.sdk_token import SdkToken from onfido.models.sdk_token_builder import SdkTokenBuilder +from onfido.models.signing_document import SigningDocument +from onfido.models.signing_documents_list import SigningDocumentsList from onfido.models.task import Task from onfido.models.task_item import TaskItem from onfido.models.timeline_file_reference import TimelineFileReference @@ -2541,9 +2546,10 @@ def _delete_applicant_serialize( @validate_call - def delete_watchlist_monitor( + def delete_passkey( self, - monitor_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2557,12 +2563,14 @@ def delete_watchlist_monitor( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Delete monitor + """Delete passkey - Deactivates the given monitor + Deletes a passkey. - :param monitor_id: (required) - :type monitor_id: str + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_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 @@ -2585,8 +2593,9 @@ def delete_watchlist_monitor( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._delete_passkey_serialize( + username=username, + passkey_id=passkey_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2595,6 +2604,7 @@ def delete_watchlist_monitor( _response_types_map: Dict[str, Optional[str]] = { '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -2608,9 +2618,10 @@ def delete_watchlist_monitor( @validate_call - def delete_watchlist_monitor_with_http_info( + def delete_passkey_with_http_info( self, - monitor_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2624,12 +2635,14 @@ def delete_watchlist_monitor_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Delete monitor + """Delete passkey - Deactivates the given monitor + Deletes a passkey. - :param monitor_id: (required) - :type monitor_id: str + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_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 @@ -2652,8 +2665,9 @@ def delete_watchlist_monitor_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._delete_passkey_serialize( + username=username, + passkey_id=passkey_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2662,6 +2676,7 @@ def delete_watchlist_monitor_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -2675,9 +2690,10 @@ def delete_watchlist_monitor_with_http_info( @validate_call - def delete_watchlist_monitor_without_preload_content( + def delete_passkey_without_preload_content( self, - monitor_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2691,12 +2707,14 @@ def delete_watchlist_monitor_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Delete monitor + """Delete passkey - Deactivates the given monitor + Deletes a passkey. - :param monitor_id: (required) - :type monitor_id: str + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_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 @@ -2719,8 +2737,9 @@ def delete_watchlist_monitor_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._delete_passkey_serialize( + username=username, + passkey_id=passkey_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2729,6 +2748,7 @@ def delete_watchlist_monitor_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -2737,9 +2757,10 @@ def delete_watchlist_monitor_without_preload_content( return response_data.response - def _delete_watchlist_monitor_serialize( + def _delete_passkey_serialize( self, - monitor_id, + username, + passkey_id, _request_auth, _content_type, _headers, @@ -2761,8 +2782,10 @@ def _delete_watchlist_monitor_serialize( _body_params: Optional[bytes] = None # process the path parameters - if monitor_id is not None: - _path_params['monitor_id'] = monitor_id + if username is not None: + _path_params['username'] = username + if passkey_id is not None: + _path_params['passkey_id'] = passkey_id # process the query parameters # process the header parameters # process the form parameters @@ -2785,7 +2808,7 @@ def _delete_watchlist_monitor_serialize( return self.api_client.param_serialize( method='DELETE', - resource_path='/watchlist_monitors/{monitor_id}', + resource_path='/passkeys/{username}/{passkey_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2802,9 +2825,9 @@ def _delete_watchlist_monitor_serialize( @validate_call - def delete_webhook( + def delete_passkeys( self, - webhook_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username whose passkeys will be deleted.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2818,12 +2841,12 @@ def delete_webhook( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> None: - """Delete a webhook + """Delete passkeys - Deletes a webhook. + Removes every passkey for the username. - :param webhook_id: (required) - :type webhook_id: str + :param username: Username whose passkeys will be deleted. (required) + :type username: 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 @@ -2846,8 +2869,8 @@ def delete_webhook( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_webhook_serialize( - webhook_id=webhook_id, + _param = self._delete_passkeys_serialize( + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2856,6 +2879,7 @@ def delete_webhook( _response_types_map: Dict[str, Optional[str]] = { '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -2869,9 +2893,9 @@ def delete_webhook( @validate_call - def delete_webhook_with_http_info( + def delete_passkeys_with_http_info( self, - webhook_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username whose passkeys will be deleted.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2885,12 +2909,12 @@ def delete_webhook_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[None]: - """Delete a webhook + """Delete passkeys - Deletes a webhook. + Removes every passkey for the username. - :param webhook_id: (required) - :type webhook_id: str + :param username: Username whose passkeys will be deleted. (required) + :type username: 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 @@ -2913,8 +2937,8 @@ def delete_webhook_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_webhook_serialize( - webhook_id=webhook_id, + _param = self._delete_passkeys_serialize( + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2923,6 +2947,7 @@ def delete_webhook_with_http_info( _response_types_map: Dict[str, Optional[str]] = { '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -2936,9 +2961,9 @@ def delete_webhook_with_http_info( @validate_call - def delete_webhook_without_preload_content( + def delete_passkeys_without_preload_content( self, - webhook_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username whose passkeys will be deleted.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2952,12 +2977,12 @@ def delete_webhook_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Delete a webhook + """Delete passkeys - Deletes a webhook. + Removes every passkey for the username. - :param webhook_id: (required) - :type webhook_id: str + :param username: Username whose passkeys will be deleted. (required) + :type username: 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 @@ -2980,8 +3005,8 @@ def delete_webhook_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._delete_webhook_serialize( - webhook_id=webhook_id, + _param = self._delete_passkeys_serialize( + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2990,6 +3015,7 @@ def delete_webhook_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { '204': None, + '404': None, } response_data = self.api_client.call_api( *_param, @@ -2998,9 +3024,9 @@ def delete_webhook_without_preload_content( return response_data.response - def _delete_webhook_serialize( + def _delete_passkeys_serialize( self, - webhook_id, + username, _request_auth, _content_type, _headers, @@ -3022,8 +3048,8 @@ def _delete_webhook_serialize( _body_params: Optional[bytes] = None # process the path parameters - if webhook_id is not None: - _path_params['webhook_id'] = webhook_id + if username is not None: + _path_params['username'] = username # process the query parameters # process the header parameters # process the form parameters @@ -3046,7 +3072,7 @@ def _delete_webhook_serialize( return self.api_client.param_serialize( method='DELETE', - resource_path='/webhooks/{webhook_id}', + resource_path='/passkeys/{username}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3063,10 +3089,9 @@ def _delete_webhook_serialize( @validate_call - def download_aes_document( + def delete_watchlist_monitor( 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.")], + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3079,15 +3104,13 @@ def download_aes_document( _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 + ) -> None: + """Delete monitor - Retrieves the signed document or signing transaction receipt depending on the id provided. + Deactivates the given monitor - :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 monitor_id: (required) + :type monitor_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 @@ -3110,9 +3133,8 @@ def download_aes_document( :return: Returns the result object. """ # noqa: E501 - _param = self._download_aes_document_serialize( - workflow_run_id=workflow_run_id, - id=id, + _param = self._delete_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3120,8 +3142,7 @@ def download_aes_document( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, - '200': "bytearray", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3135,10 +3156,9 @@ def download_aes_document( @validate_call - def download_aes_document_with_http_info( + def delete_watchlist_monitor_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.")], + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3151,15 +3171,13 @@ def download_aes_document_with_http_info( _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 + ) -> ApiResponse[None]: + """Delete monitor - Retrieves the signed document or signing transaction receipt depending on the id provided. + Deactivates the given monitor - :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 monitor_id: (required) + :type monitor_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 @@ -3182,9 +3200,8 @@ def download_aes_document_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_aes_document_serialize( - workflow_run_id=workflow_run_id, - id=id, + _param = self._delete_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3192,8 +3209,7 @@ def download_aes_document_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, - '200': "bytearray", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3207,10 +3223,9 @@ def download_aes_document_with_http_info( @validate_call - def download_aes_document_without_preload_content( + def delete_watchlist_monitor_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.")], + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3224,14 +3239,12 @@ def download_aes_document_without_preload_content( _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 + """Delete monitor - Retrieves the signed document or signing transaction receipt depending on the id provided. + Deactivates the given monitor - :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 monitor_id: (required) + :type monitor_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 @@ -3254,9 +3267,8 @@ def download_aes_document_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_aes_document_serialize( - workflow_run_id=workflow_run_id, - id=id, + _param = self._delete_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3264,8 +3276,7 @@ def download_aes_document_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, - '200': "bytearray", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3274,10 +3285,9 @@ def download_aes_document_without_preload_content( return response_data.response - def _download_aes_document_serialize( + def _delete_watchlist_monitor_serialize( self, - workflow_run_id, - id, + monitor_id, _request_auth, _content_type, _headers, @@ -3299,15 +3309,9 @@ def _download_aes_document_serialize( _body_params: Optional[bytes] = None # process the path parameters + if monitor_id is not None: + _path_params['monitor_id'] = monitor_id # 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 @@ -3317,7 +3321,6 @@ def _download_aes_document_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - 'application/pdf', 'application/json' ] ) @@ -3329,8 +3332,8 @@ def _download_aes_document_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/advanced_electronic_signature/documents', + method='DELETE', + resource_path='/watchlist_monitors/{monitor_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3347,9 +3350,9 @@ def _download_aes_document_serialize( @validate_call - def download_check( + def delete_webhook( self, - check_id: StrictStr, + webhook_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3362,13 +3365,13 @@ def download_check( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> bytearray: - """Download check + ) -> None: + """Delete a webhook - Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF. + Deletes a webhook. - :param check_id: (required) - :type check_id: str + :param webhook_id: (required) + :type webhook_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 @@ -3391,8 +3394,8 @@ def download_check( :return: Returns the result object. """ # noqa: E501 - _param = self._download_check_serialize( - check_id=check_id, + _param = self._delete_webhook_serialize( + webhook_id=webhook_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3400,7 +3403,7 @@ def download_check( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "bytearray", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3414,9 +3417,9 @@ def download_check( @validate_call - def download_check_with_http_info( + def delete_webhook_with_http_info( self, - check_id: StrictStr, + webhook_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3429,13 +3432,13 @@ def download_check_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[bytearray]: - """Download check + ) -> ApiResponse[None]: + """Delete a webhook - Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF. + Deletes a webhook. - :param check_id: (required) - :type check_id: str + :param webhook_id: (required) + :type webhook_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 @@ -3458,8 +3461,8 @@ def download_check_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_check_serialize( - check_id=check_id, + _param = self._delete_webhook_serialize( + webhook_id=webhook_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3467,7 +3470,7 @@ def download_check_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "bytearray", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3481,9 +3484,9 @@ def download_check_with_http_info( @validate_call - def download_check_without_preload_content( + def delete_webhook_without_preload_content( self, - check_id: StrictStr, + webhook_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3497,12 +3500,12 @@ def download_check_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download check + """Delete a webhook - Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF. + Deletes a webhook. - :param check_id: (required) - :type check_id: str + :param webhook_id: (required) + :type webhook_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 @@ -3525,8 +3528,8 @@ def download_check_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_check_serialize( - check_id=check_id, + _param = self._delete_webhook_serialize( + webhook_id=webhook_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3534,7 +3537,7 @@ def download_check_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "bytearray", + '204': None, } response_data = self.api_client.call_api( *_param, @@ -3543,9 +3546,9 @@ def download_check_without_preload_content( return response_data.response - def _download_check_serialize( + def _delete_webhook_serialize( self, - check_id, + webhook_id, _request_auth, _content_type, _headers, @@ -3567,8 +3570,8 @@ def _download_check_serialize( _body_params: Optional[bytes] = None # process the path parameters - if check_id is not None: - _path_params['check_id'] = check_id + if webhook_id is not None: + _path_params['webhook_id'] = webhook_id # process the query parameters # process the header parameters # process the form parameters @@ -3579,7 +3582,6 @@ def _download_check_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - 'application/pdf', 'application/json' ] ) @@ -3591,8 +3593,8 @@ def _download_check_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/checks/{check_id}/download', + method='DELETE', + resource_path='/webhooks/{webhook_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3609,9 +3611,10 @@ def _download_check_serialize( @validate_call - def download_document( + def download_aes_document( self, - document_id: StrictStr, + 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)], @@ -3625,12 +3628,14 @@ def download_document( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download document + """Retrieves the signed document or signing transaction receipt - Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. + Retrieves the signed document or signing transaction receipt depending on the id provided. - :param document_id: (required) - :type document_id: str + :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 @@ -3653,8 +3658,9 @@ def download_document( :return: Returns the result object. """ # noqa: E501 - _param = self._download_document_serialize( - document_id=document_id, + _param = self._download_aes_document_serialize( + workflow_run_id=workflow_run_id, + id=id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3662,6 +3668,7 @@ def download_document( ) _response_types_map: Dict[str, Optional[str]] = { + '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -3676,9 +3683,10 @@ def download_document( @validate_call - def download_document_with_http_info( + def download_aes_document_with_http_info( self, - document_id: StrictStr, + 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)], @@ -3692,14 +3700,16 @@ def download_document_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download document + """Retrieves the signed document or signing transaction receipt - Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. + Retrieves the signed document or signing transaction receipt depending on the id provided. - :param document_id: (required) - :type document_id: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request + :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 @@ -3720,8 +3730,9 @@ def download_document_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_document_serialize( - document_id=document_id, + _param = self._download_aes_document_serialize( + workflow_run_id=workflow_run_id, + id=id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3729,6 +3740,7 @@ def download_document_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { + '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -3743,9 +3755,10 @@ def download_document_with_http_info( @validate_call - def download_document_without_preload_content( + def download_aes_document_without_preload_content( self, - document_id: StrictStr, + 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)], @@ -3759,12 +3772,14 @@ def download_document_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download document + """Retrieves the signed document or signing transaction receipt - Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. + Retrieves the signed document or signing transaction receipt depending on the id provided. - :param document_id: (required) - :type document_id: str + :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 @@ -3787,8 +3802,9 @@ def download_document_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_document_serialize( - document_id=document_id, + _param = self._download_aes_document_serialize( + workflow_run_id=workflow_run_id, + id=id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3796,6 +3812,7 @@ def download_document_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { + '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -3805,9 +3822,10 @@ def download_document_without_preload_content( return response_data.response - def _download_document_serialize( + def _download_aes_document_serialize( self, - document_id, + workflow_run_id, + id, _request_auth, _content_type, _headers, @@ -3829,9 +3847,15 @@ def _download_document_serialize( _body_params: Optional[bytes] = None # process the path parameters - if document_id is not None: - _path_params['document_id'] = document_id # 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 @@ -3841,7 +3865,7 @@ def _download_document_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - '*/*', + 'application/pdf', 'application/json' ] ) @@ -3854,7 +3878,7 @@ def _download_document_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/documents/{document_id}/download', + resource_path='/advanced_electronic_signature/documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -3871,9 +3895,9 @@ def _download_document_serialize( @validate_call - def download_document_video( + def download_check( self, - document_id: StrictStr, + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3887,12 +3911,12 @@ def download_document_video( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download document video + """Download check - Downloads a document video. If successful, the response will be the binary data representing the video. + Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF. - :param document_id: (required) - :type document_id: str + :param check_id: (required) + :type check_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 @@ -3915,8 +3939,8 @@ def download_document_video( :return: Returns the result object. """ # noqa: E501 - _param = self._download_document_video_serialize( - document_id=document_id, + _param = self._download_check_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -3938,9 +3962,9 @@ def download_document_video( @validate_call - def download_document_video_with_http_info( + def download_check_with_http_info( self, - document_id: StrictStr, + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -3954,12 +3978,12 @@ def download_document_video_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download document video + """Download check - Downloads a document video. If successful, the response will be the binary data representing the video. + Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF. - :param document_id: (required) - :type document_id: str + :param check_id: (required) + :type check_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 @@ -3982,8 +4006,8 @@ def download_document_video_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_document_video_serialize( - document_id=document_id, + _param = self._download_check_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4005,9 +4029,9 @@ def download_document_video_with_http_info( @validate_call - def download_document_video_without_preload_content( + def download_check_without_preload_content( self, - document_id: StrictStr, + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4021,12 +4045,12 @@ def download_document_video_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download document video + """Download check - Downloads a document video. If successful, the response will be the binary data representing the video. + Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF. - :param document_id: (required) - :type document_id: str + :param check_id: (required) + :type check_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 @@ -4049,8 +4073,8 @@ def download_document_video_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_document_video_serialize( - document_id=document_id, + _param = self._download_check_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4067,9 +4091,9 @@ def download_document_video_without_preload_content( return response_data.response - def _download_document_video_serialize( + def _download_check_serialize( self, - document_id, + check_id, _request_auth, _content_type, _headers, @@ -4091,8 +4115,8 @@ def _download_document_video_serialize( _body_params: Optional[bytes] = None # process the path parameters - if document_id is not None: - _path_params['document_id'] = document_id + if check_id is not None: + _path_params['check_id'] = check_id # process the query parameters # process the header parameters # process the form parameters @@ -4103,7 +4127,7 @@ def _download_document_video_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - '*/*', + 'application/pdf', 'application/json' ] ) @@ -4116,7 +4140,7 @@ def _download_document_video_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/documents/{document_id}/video/download', + resource_path='/checks/{check_id}/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4133,9 +4157,9 @@ def _download_document_video_serialize( @validate_call - def download_evidence_folder( + def download_document( self, - workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4149,12 +4173,12 @@ def download_evidence_folder( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Retrieve Workflow Run Evidence Folder + """Download document - Retrieves the evidence folder for the designated Workflow Run + Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. - :param workflow_run_id: Workflow Run ID (required) - :type workflow_run_id: str + :param document_id: (required) + :type document_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 @@ -4177,8 +4201,8 @@ def download_evidence_folder( :return: Returns the result object. """ # noqa: E501 - _param = self._download_evidence_folder_serialize( - workflow_run_id=workflow_run_id, + _param = self._download_document_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4186,7 +4210,6 @@ def download_evidence_folder( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -4201,9 +4224,9 @@ def download_evidence_folder( @validate_call - def download_evidence_folder_with_http_info( + def download_document_with_http_info( self, - workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4217,12 +4240,12 @@ def download_evidence_folder_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Retrieve Workflow Run Evidence Folder + """Download document - Retrieves the evidence folder for the designated Workflow Run + Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. - :param workflow_run_id: Workflow Run ID (required) - :type workflow_run_id: str + :param document_id: (required) + :type document_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 @@ -4245,8 +4268,8 @@ def download_evidence_folder_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_evidence_folder_serialize( - workflow_run_id=workflow_run_id, + _param = self._download_document_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4254,7 +4277,6 @@ def download_evidence_folder_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -4269,9 +4291,9 @@ def download_evidence_folder_with_http_info( @validate_call - def download_evidence_folder_without_preload_content( + def download_document_without_preload_content( self, - workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4285,12 +4307,12 @@ def download_evidence_folder_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Workflow Run Evidence Folder + """Download document - Retrieves the evidence folder for the designated Workflow Run + Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. - :param workflow_run_id: Workflow Run ID (required) - :type workflow_run_id: str + :param document_id: (required) + :type document_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 @@ -4313,8 +4335,8 @@ def download_evidence_folder_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_evidence_folder_serialize( - workflow_run_id=workflow_run_id, + _param = self._download_document_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4322,7 +4344,6 @@ def download_evidence_folder_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -4332,9 +4353,9 @@ def download_evidence_folder_without_preload_content( return response_data.response - def _download_evidence_folder_serialize( + def _download_document_serialize( self, - workflow_run_id, + document_id, _request_auth, _content_type, _headers, @@ -4356,8 +4377,8 @@ def _download_evidence_folder_serialize( _body_params: Optional[bytes] = None # process the path parameters - if workflow_run_id is not None: - _path_params['workflow_run_id'] = workflow_run_id + if document_id is not None: + _path_params['document_id'] = document_id # process the query parameters # process the header parameters # process the form parameters @@ -4368,7 +4389,7 @@ def _download_evidence_folder_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - 'application/zip', + '*/*', 'application/json' ] ) @@ -4381,7 +4402,7 @@ def _download_evidence_folder_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/workflow_runs/{workflow_run_id}/evidence_folder', + resource_path='/documents/{document_id}/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4398,9 +4419,9 @@ def _download_evidence_folder_serialize( @validate_call - def download_id_photo( + def download_document_video( self, - id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4414,12 +4435,12 @@ def download_id_photo( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download ID photo + """Download document video - ID photos are downloaded using this endpoint. + Downloads a document video. If successful, the response will be the binary data representing the video. - :param id_photo_id: The ID photo's unique identifier. (required) - :type id_photo_id: str + :param document_id: (required) + :type document_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 @@ -4442,8 +4463,8 @@ def download_id_photo( :return: Returns the result object. """ # noqa: E501 - _param = self._download_id_photo_serialize( - id_photo_id=id_photo_id, + _param = self._download_document_video_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4465,9 +4486,9 @@ def download_id_photo( @validate_call - def download_id_photo_with_http_info( + def download_document_video_with_http_info( self, - id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4481,12 +4502,12 @@ def download_id_photo_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download ID photo + """Download document video - ID photos are downloaded using this endpoint. + Downloads a document video. If successful, the response will be the binary data representing the video. - :param id_photo_id: The ID photo's unique identifier. (required) - :type id_photo_id: str + :param document_id: (required) + :type document_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 @@ -4509,8 +4530,8 @@ def download_id_photo_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_id_photo_serialize( - id_photo_id=id_photo_id, + _param = self._download_document_video_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4532,9 +4553,9 @@ def download_id_photo_with_http_info( @validate_call - def download_id_photo_without_preload_content( + def download_document_video_without_preload_content( self, - id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4548,12 +4569,12 @@ def download_id_photo_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download ID photo + """Download document video - ID photos are downloaded using this endpoint. + Downloads a document video. If successful, the response will be the binary data representing the video. - :param id_photo_id: The ID photo's unique identifier. (required) - :type id_photo_id: str + :param document_id: (required) + :type document_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 @@ -4576,8 +4597,8 @@ def download_id_photo_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_id_photo_serialize( - id_photo_id=id_photo_id, + _param = self._download_document_video_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4594,9 +4615,9 @@ def download_id_photo_without_preload_content( return response_data.response - def _download_id_photo_serialize( + def _download_document_video_serialize( self, - id_photo_id, + document_id, _request_auth, _content_type, _headers, @@ -4618,8 +4639,8 @@ def _download_id_photo_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id_photo_id is not None: - _path_params['id_photo_id'] = id_photo_id + if document_id is not None: + _path_params['document_id'] = document_id # process the query parameters # process the header parameters # process the form parameters @@ -4643,7 +4664,7 @@ def _download_id_photo_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/id_photos/{id_photo_id}/download', + resource_path='/documents/{document_id}/video/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4660,9 +4681,9 @@ def _download_id_photo_serialize( @validate_call - def download_live_photo( + def download_evidence_folder( self, - live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], + workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4676,12 +4697,12 @@ def download_live_photo( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download live photo + """Retrieve Workflow Run Evidence Folder - Live photos are downloaded using this endpoint. + Retrieves the evidence folder for the designated Workflow Run - :param live_photo_id: The live photo's unique identifier. (required) - :type live_photo_id: str + :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 @@ -4704,8 +4725,8 @@ def download_live_photo( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_photo_serialize( - live_photo_id=live_photo_id, + _param = self._download_evidence_folder_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4713,6 +4734,7 @@ def download_live_photo( ) _response_types_map: Dict[str, Optional[str]] = { + '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -4727,9 +4749,9 @@ def download_live_photo( @validate_call - def download_live_photo_with_http_info( + def download_evidence_folder_with_http_info( self, - live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], + workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4743,12 +4765,12 @@ def download_live_photo_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download live photo + """Retrieve Workflow Run Evidence Folder - Live photos are downloaded using this endpoint. + Retrieves the evidence folder for the designated Workflow Run - :param live_photo_id: The live photo's unique identifier. (required) - :type live_photo_id: str + :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 @@ -4771,8 +4793,8 @@ def download_live_photo_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_photo_serialize( - live_photo_id=live_photo_id, + _param = self._download_evidence_folder_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4780,6 +4802,7 @@ def download_live_photo_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { + '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -4794,9 +4817,9 @@ def download_live_photo_with_http_info( @validate_call - def download_live_photo_without_preload_content( + def download_evidence_folder_without_preload_content( self, - live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], + workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4810,12 +4833,12 @@ def download_live_photo_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download live photo + """Retrieve Workflow Run Evidence Folder - Live photos are downloaded using this endpoint. + Retrieves the evidence folder for the designated Workflow Run - :param live_photo_id: The live photo's unique identifier. (required) - :type live_photo_id: str + :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 @@ -4838,8 +4861,8 @@ def download_live_photo_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_photo_serialize( - live_photo_id=live_photo_id, + _param = self._download_evidence_folder_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4847,6 +4870,7 @@ def download_live_photo_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { + '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -4856,9 +4880,9 @@ def download_live_photo_without_preload_content( return response_data.response - def _download_live_photo_serialize( + def _download_evidence_folder_serialize( self, - live_photo_id, + workflow_run_id, _request_auth, _content_type, _headers, @@ -4880,8 +4904,8 @@ def _download_live_photo_serialize( _body_params: Optional[bytes] = None # process the path parameters - if live_photo_id is not None: - _path_params['live_photo_id'] = live_photo_id + 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 @@ -4892,7 +4916,7 @@ def _download_live_photo_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - '*/*', + 'application/zip', 'application/json' ] ) @@ -4905,7 +4929,7 @@ def _download_live_photo_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/live_photos/{live_photo_id}/download', + resource_path='/workflow_runs/{workflow_run_id}/evidence_folder', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -4922,9 +4946,9 @@ def _download_live_photo_serialize( @validate_call - def download_live_video( + def download_id_photo( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -4938,12 +4962,12 @@ def download_live_video( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download live video + """Download ID photo - Live videos are downloaded using this endpoint. + ID photos are downloaded using this endpoint. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param id_photo_id: The ID photo's unique identifier. (required) + :type id_photo_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 @@ -4966,8 +4990,8 @@ def download_live_video( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_video_serialize( - live_video_id=live_video_id, + _param = self._download_id_photo_serialize( + id_photo_id=id_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -4989,9 +5013,9 @@ def download_live_video( @validate_call - def download_live_video_with_http_info( + def download_id_photo_with_http_info( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5005,12 +5029,12 @@ def download_live_video_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download live video + """Download ID photo - Live videos are downloaded using this endpoint. + ID photos are downloaded using this endpoint. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param id_photo_id: The ID photo's unique identifier. (required) + :type id_photo_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 @@ -5033,8 +5057,8 @@ def download_live_video_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_video_serialize( - live_video_id=live_video_id, + _param = self._download_id_photo_serialize( + id_photo_id=id_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5056,9 +5080,9 @@ def download_live_video_with_http_info( @validate_call - def download_live_video_without_preload_content( + def download_id_photo_without_preload_content( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5072,12 +5096,12 @@ def download_live_video_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download live video + """Download ID photo - Live videos are downloaded using this endpoint. + ID photos are downloaded using this endpoint. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param id_photo_id: The ID photo's unique identifier. (required) + :type id_photo_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 @@ -5100,8 +5124,8 @@ def download_live_video_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_video_serialize( - live_video_id=live_video_id, + _param = self._download_id_photo_serialize( + id_photo_id=id_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5118,9 +5142,9 @@ def download_live_video_without_preload_content( return response_data.response - def _download_live_video_serialize( + def _download_id_photo_serialize( self, - live_video_id, + id_photo_id, _request_auth, _content_type, _headers, @@ -5142,8 +5166,8 @@ def _download_live_video_serialize( _body_params: Optional[bytes] = None # process the path parameters - if live_video_id is not None: - _path_params['live_video_id'] = live_video_id + if id_photo_id is not None: + _path_params['id_photo_id'] = id_photo_id # process the query parameters # process the header parameters # process the form parameters @@ -5167,7 +5191,7 @@ def _download_live_video_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/live_videos/{live_video_id}/download', + resource_path='/id_photos/{id_photo_id}/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5184,9 +5208,9 @@ def _download_live_video_serialize( @validate_call - def download_live_video_frame( + def download_live_photo( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5200,12 +5224,12 @@ def download_live_video_frame( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download live video frame + """Download live photo - Returns the binary data representing a single frame from a live video. + Live photos are downloaded using this endpoint. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param live_photo_id: The live photo's unique identifier. (required) + :type live_photo_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 @@ -5228,8 +5252,8 @@ def download_live_video_frame( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_video_frame_serialize( - live_video_id=live_video_id, + _param = self._download_live_photo_serialize( + live_photo_id=live_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5251,9 +5275,9 @@ def download_live_video_frame( @validate_call - def download_live_video_frame_with_http_info( + def download_live_photo_with_http_info( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5267,12 +5291,12 @@ def download_live_video_frame_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download live video frame + """Download live photo - Returns the binary data representing a single frame from a live video. + Live photos are downloaded using this endpoint. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param live_photo_id: The live photo's unique identifier. (required) + :type live_photo_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 @@ -5295,8 +5319,8 @@ def download_live_video_frame_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_video_frame_serialize( - live_video_id=live_video_id, + _param = self._download_live_photo_serialize( + live_photo_id=live_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5318,9 +5342,9 @@ def download_live_video_frame_with_http_info( @validate_call - def download_live_video_frame_without_preload_content( + def download_live_photo_without_preload_content( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5334,12 +5358,12 @@ def download_live_video_frame_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download live video frame + """Download live photo - Returns the binary data representing a single frame from a live video. + Live photos are downloaded using this endpoint. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param live_photo_id: The live photo's unique identifier. (required) + :type live_photo_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 @@ -5362,8 +5386,8 @@ def download_live_video_frame_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_live_video_frame_serialize( - live_video_id=live_video_id, + _param = self._download_live_photo_serialize( + live_photo_id=live_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5380,9 +5404,9 @@ def download_live_video_frame_without_preload_content( return response_data.response - def _download_live_video_frame_serialize( + def _download_live_photo_serialize( self, - live_video_id, + live_photo_id, _request_auth, _content_type, _headers, @@ -5404,8 +5428,8 @@ def _download_live_video_frame_serialize( _body_params: Optional[bytes] = None # process the path parameters - if live_video_id is not None: - _path_params['live_video_id'] = live_video_id + if live_photo_id is not None: + _path_params['live_photo_id'] = live_photo_id # process the query parameters # process the header parameters # process the form parameters @@ -5429,7 +5453,7 @@ def _download_live_video_frame_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/live_videos/{live_video_id}/frame', + resource_path='/live_photos/{live_photo_id}/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5446,9 +5470,9 @@ def _download_live_video_frame_serialize( @validate_call - def download_motion_capture( + def download_live_video( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5462,12 +5486,12 @@ def download_motion_capture( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download motion capture + """Download live video - Motion captures are downloaded using this endpoint. + Live videos are downloaded using this endpoint. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -5490,8 +5514,8 @@ def download_motion_capture( :return: Returns the result object. """ # noqa: E501 - _param = self._download_motion_capture_serialize( - motion_capture_id=motion_capture_id, + _param = self._download_live_video_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5513,9 +5537,9 @@ def download_motion_capture( @validate_call - def download_motion_capture_with_http_info( + def download_live_video_with_http_info( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5529,12 +5553,12 @@ def download_motion_capture_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download motion capture + """Download live video - Motion captures are downloaded using this endpoint. + Live videos are downloaded using this endpoint. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -5557,8 +5581,8 @@ def download_motion_capture_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_motion_capture_serialize( - motion_capture_id=motion_capture_id, + _param = self._download_live_video_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5580,9 +5604,9 @@ def download_motion_capture_with_http_info( @validate_call - def download_motion_capture_without_preload_content( + def download_live_video_without_preload_content( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5596,12 +5620,12 @@ def download_motion_capture_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download motion capture + """Download live video - Motion captures are downloaded using this endpoint. + Live videos are downloaded using this endpoint. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -5624,8 +5648,8 @@ def download_motion_capture_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_motion_capture_serialize( - motion_capture_id=motion_capture_id, + _param = self._download_live_video_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5642,9 +5666,9 @@ def download_motion_capture_without_preload_content( return response_data.response - def _download_motion_capture_serialize( + def _download_live_video_serialize( self, - motion_capture_id, + live_video_id, _request_auth, _content_type, _headers, @@ -5666,8 +5690,8 @@ def _download_motion_capture_serialize( _body_params: Optional[bytes] = None # process the path parameters - if motion_capture_id is not None: - _path_params['motion_capture_id'] = motion_capture_id + if live_video_id is not None: + _path_params['live_video_id'] = live_video_id # process the query parameters # process the header parameters # process the form parameters @@ -5691,7 +5715,7 @@ def _download_motion_capture_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/motion_captures/{motion_capture_id}/download', + resource_path='/live_videos/{live_video_id}/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5708,9 +5732,9 @@ def _download_motion_capture_serialize( @validate_call - def download_motion_capture_frame( + def download_live_video_frame( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5724,12 +5748,12 @@ def download_motion_capture_frame( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download motion capture frame + """Download live video frame - Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame. + Returns the binary data representing a single frame from a live video. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -5752,8 +5776,8 @@ def download_motion_capture_frame( :return: Returns the result object. """ # noqa: E501 - _param = self._download_motion_capture_frame_serialize( - motion_capture_id=motion_capture_id, + _param = self._download_live_video_frame_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5775,9 +5799,9 @@ def download_motion_capture_frame( @validate_call - def download_motion_capture_frame_with_http_info( + def download_live_video_frame_with_http_info( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5791,12 +5815,12 @@ def download_motion_capture_frame_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download motion capture frame + """Download live video frame - Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame. + Returns the binary data representing a single frame from a live video. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -5819,8 +5843,8 @@ def download_motion_capture_frame_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_motion_capture_frame_serialize( - motion_capture_id=motion_capture_id, + _param = self._download_live_video_frame_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5842,9 +5866,9 @@ def download_motion_capture_frame_with_http_info( @validate_call - def download_motion_capture_frame_without_preload_content( + def download_live_video_frame_without_preload_content( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5858,12 +5882,12 @@ def download_motion_capture_frame_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download motion capture frame + """Download live video frame - Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame. + Returns the binary data representing a single frame from a live video. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -5886,8 +5910,8 @@ def download_motion_capture_frame_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_motion_capture_frame_serialize( - motion_capture_id=motion_capture_id, + _param = self._download_live_video_frame_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -5904,9 +5928,9 @@ def download_motion_capture_frame_without_preload_content( return response_data.response - def _download_motion_capture_frame_serialize( + def _download_live_video_frame_serialize( self, - motion_capture_id, + live_video_id, _request_auth, _content_type, _headers, @@ -5928,8 +5952,8 @@ def _download_motion_capture_frame_serialize( _body_params: Optional[bytes] = None # process the path parameters - if motion_capture_id is not None: - _path_params['motion_capture_id'] = motion_capture_id + if live_video_id is not None: + _path_params['live_video_id'] = live_video_id # process the query parameters # process the header parameters # process the form parameters @@ -5953,7 +5977,7 @@ def _download_motion_capture_frame_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/motion_captures/{motion_capture_id}/frame', + resource_path='/live_videos/{live_video_id}/frame', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -5970,9 +5994,9 @@ def _download_motion_capture_frame_serialize( @validate_call - def download_nfc_face( + def download_motion_capture( self, - document_id: StrictStr, + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5986,12 +6010,12 @@ def download_nfc_face( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Download NFC face + """Download motion capture - Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. + Motion captures are downloaded using this endpoint. - :param document_id: (required) - :type document_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -6014,8 +6038,8 @@ def download_nfc_face( :return: Returns the result object. """ # noqa: E501 - _param = self._download_nfc_face_serialize( - document_id=document_id, + _param = self._download_motion_capture_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6037,9 +6061,9 @@ def download_nfc_face( @validate_call - def download_nfc_face_with_http_info( + def download_motion_capture_with_http_info( self, - document_id: StrictStr, + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6053,12 +6077,12 @@ def download_nfc_face_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Download NFC face + """Download motion capture - Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. + Motion captures are downloaded using this endpoint. - :param document_id: (required) - :type document_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -6081,8 +6105,8 @@ def download_nfc_face_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_nfc_face_serialize( - document_id=document_id, + _param = self._download_motion_capture_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6104,9 +6128,9 @@ def download_nfc_face_with_http_info( @validate_call - def download_nfc_face_without_preload_content( + def download_motion_capture_without_preload_content( self, - document_id: StrictStr, + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6120,12 +6144,12 @@ def download_nfc_face_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Download NFC face + """Download motion capture - Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. + Motion captures are downloaded using this endpoint. - :param document_id: (required) - :type document_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -6148,8 +6172,8 @@ def download_nfc_face_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_nfc_face_serialize( - document_id=document_id, + _param = self._download_motion_capture_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6166,9 +6190,9 @@ def download_nfc_face_without_preload_content( return response_data.response - def _download_nfc_face_serialize( + def _download_motion_capture_serialize( self, - document_id, + motion_capture_id, _request_auth, _content_type, _headers, @@ -6190,8 +6214,8 @@ def _download_nfc_face_serialize( _body_params: Optional[bytes] = None # process the path parameters - if document_id is not None: - _path_params['document_id'] = document_id + if motion_capture_id is not None: + _path_params['motion_capture_id'] = motion_capture_id # process the query parameters # process the header parameters # process the form parameters @@ -6215,7 +6239,7 @@ def _download_nfc_face_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/documents/{document_id}/nfc_face', + resource_path='/motion_captures/{motion_capture_id}/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6232,10 +6256,9 @@ def _download_nfc_face_serialize( @validate_call - def download_qes_document( + def download_motion_capture_frame( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")], - file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")], + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6249,14 +6272,12 @@ def download_qes_document( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Retrieves the signed document or application form + """Download motion capture frame - Retrieves the signed document or application form depending on the file_id provided. + Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame. - :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 file_id: The unique identifier of the file which you want to retrieve. (required) - :type file_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -6279,9 +6300,8 @@ def download_qes_document( :return: Returns the result object. """ # noqa: E501 - _param = self._download_qes_document_serialize( - workflow_run_id=workflow_run_id, - file_id=file_id, + _param = self._download_motion_capture_frame_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6289,7 +6309,6 @@ def download_qes_document( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -6304,10 +6323,9 @@ def download_qes_document( @validate_call - def download_qes_document_with_http_info( + def download_motion_capture_frame_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.")], - file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")], + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6321,14 +6339,12 @@ def download_qes_document_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Retrieves the signed document or application form + """Download motion capture frame - Retrieves the signed document or application form depending on the file_id provided. + Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame. - :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 file_id: The unique identifier of the file which you want to retrieve. (required) - :type file_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -6351,9 +6367,8 @@ def download_qes_document_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_qes_document_serialize( - workflow_run_id=workflow_run_id, - file_id=file_id, + _param = self._download_motion_capture_frame_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6361,7 +6376,6 @@ def download_qes_document_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -6376,10 +6390,9 @@ def download_qes_document_with_http_info( @validate_call - def download_qes_document_without_preload_content( + def download_motion_capture_frame_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.")], - file_id: Annotated[StrictStr, Field(description="The unique identifier of the file which you want to retrieve.")], + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6393,14 +6406,12 @@ def download_qes_document_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieves the signed document or application form + """Download motion capture frame - Retrieves the signed document or application form depending on the file_id provided. + Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame. - :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 file_id: The unique identifier of the file which you want to retrieve. (required) - :type file_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -6423,9 +6434,8 @@ def download_qes_document_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_qes_document_serialize( - workflow_run_id=workflow_run_id, - file_id=file_id, + _param = self._download_motion_capture_frame_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6433,7 +6443,6 @@ def download_qes_document_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -6443,10 +6452,9 @@ def download_qes_document_without_preload_content( return response_data.response - def _download_qes_document_serialize( + def _download_motion_capture_frame_serialize( self, - workflow_run_id, - file_id, + motion_capture_id, _request_auth, _content_type, _headers, @@ -6468,15 +6476,9 @@ def _download_qes_document_serialize( _body_params: Optional[bytes] = None # process the path parameters + if motion_capture_id is not None: + _path_params['motion_capture_id'] = motion_capture_id # process the query parameters - if workflow_run_id is not None: - - _query_params.append(('workflow_run_id', workflow_run_id)) - - if file_id is not None: - - _query_params.append(('file_id', file_id)) - # process the header parameters # process the form parameters # process the body parameter @@ -6486,7 +6488,7 @@ def _download_qes_document_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - 'application/pdf', + '*/*', 'application/json' ] ) @@ -6499,7 +6501,7 @@ def _download_qes_document_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/qualified_electronic_signature/documents', + resource_path='/motion_captures/{motion_capture_id}/frame', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6516,9 +6518,9 @@ def _download_qes_document_serialize( @validate_call - def download_signed_evidence_file( + def download_nfc_face( self, - workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6532,12 +6534,12 @@ def download_signed_evidence_file( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> bytearray: - """Retrieve Workflow Run Evidence Summary File + """Download NFC face - Retrieves the signed evidence file for the designated Workflow Run + Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. - :param workflow_run_id: Workflow Run ID (required) - :type workflow_run_id: str + :param document_id: (required) + :type document_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 @@ -6560,8 +6562,8 @@ def download_signed_evidence_file( :return: Returns the result object. """ # noqa: E501 - _param = self._download_signed_evidence_file_serialize( - workflow_run_id=workflow_run_id, + _param = self._download_nfc_face_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6569,7 +6571,6 @@ def download_signed_evidence_file( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -6584,9 +6585,9 @@ def download_signed_evidence_file( @validate_call - def download_signed_evidence_file_with_http_info( + def download_nfc_face_with_http_info( self, - workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6600,12 +6601,12 @@ def download_signed_evidence_file_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[bytearray]: - """Retrieve Workflow Run Evidence Summary File + """Download NFC face - Retrieves the signed evidence file for the designated Workflow Run + Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. - :param workflow_run_id: Workflow Run ID (required) - :type workflow_run_id: str + :param document_id: (required) + :type document_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 @@ -6628,8 +6629,8 @@ def download_signed_evidence_file_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._download_signed_evidence_file_serialize( - workflow_run_id=workflow_run_id, + _param = self._download_nfc_face_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6637,7 +6638,6 @@ def download_signed_evidence_file_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -6652,9 +6652,9 @@ def download_signed_evidence_file_with_http_info( @validate_call - def download_signed_evidence_file_without_preload_content( + def download_nfc_face_without_preload_content( self, - workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -6668,12 +6668,12 @@ def download_signed_evidence_file_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Workflow Run Evidence Summary File + """Download NFC face - Retrieves the signed evidence file for the designated Workflow Run + Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image. - :param workflow_run_id: Workflow Run ID (required) - :type workflow_run_id: str + :param document_id: (required) + :type document_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 @@ -6696,8 +6696,8 @@ def download_signed_evidence_file_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._download_signed_evidence_file_serialize( - workflow_run_id=workflow_run_id, + _param = self._download_nfc_face_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6705,7 +6705,6 @@ def download_signed_evidence_file_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, '200': "bytearray", } response_data = self.api_client.call_api( @@ -6715,9 +6714,9 @@ def download_signed_evidence_file_without_preload_content( return response_data.response - def _download_signed_evidence_file_serialize( + def _download_nfc_face_serialize( self, - workflow_run_id, + document_id, _request_auth, _content_type, _headers, @@ -6739,8 +6738,8 @@ def _download_signed_evidence_file_serialize( _body_params: Optional[bytes] = None # process the path parameters - if workflow_run_id is not None: - _path_params['workflow_run_id'] = workflow_run_id + if document_id is not None: + _path_params['document_id'] = document_id # process the query parameters # process the header parameters # process the form parameters @@ -6751,7 +6750,7 @@ def _download_signed_evidence_file_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - 'application/pdf', + '*/*', 'application/json' ] ) @@ -6764,7 +6763,7 @@ def _download_signed_evidence_file_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/workflow_runs/{workflow_run_id}/signed_evidence_file', + resource_path='/documents/{document_id}/nfc_face', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -6781,9 +6780,10 @@ def _download_signed_evidence_file_serialize( @validate_call - def extract( + def download_qes_document( self, - extract_request: ExtractRequest, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")], + file_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)], @@ -6796,13 +6796,15 @@ def extract( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Extraction: - """Autofill + ) -> bytearray: + """Retrieves the signed document or application form - Extract information from a document + Retrieves the signed document or application form depending on the file_id provided. - :param extract_request: (required) - :type extract_request: ExtractRequest + :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 file_id: The unique identifier of the file which you want to retrieve. (required) + :type file_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 @@ -6825,8 +6827,9 @@ def extract( :return: Returns the result object. """ # noqa: E501 - _param = self._extract_serialize( - extract_request=extract_request, + _param = self._download_qes_document_serialize( + workflow_run_id=workflow_run_id, + file_id=file_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6834,7 +6837,8 @@ def extract( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Extraction", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -6848,9 +6852,10 @@ def extract( @validate_call - def extract_with_http_info( + def download_qes_document_with_http_info( self, - extract_request: ExtractRequest, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")], + file_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)], @@ -6863,13 +6868,15 @@ def extract_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Extraction]: - """Autofill + ) -> ApiResponse[bytearray]: + """Retrieves the signed document or application form - Extract information from a document + Retrieves the signed document or application form depending on the file_id provided. - :param extract_request: (required) - :type extract_request: ExtractRequest + :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 file_id: The unique identifier of the file which you want to retrieve. (required) + :type file_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 @@ -6892,8 +6899,9 @@ def extract_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._extract_serialize( - extract_request=extract_request, + _param = self._download_qes_document_serialize( + workflow_run_id=workflow_run_id, + file_id=file_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6901,7 +6909,8 @@ def extract_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Extraction", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -6915,9 +6924,10 @@ def extract_with_http_info( @validate_call - def extract_without_preload_content( + def download_qes_document_without_preload_content( self, - extract_request: ExtractRequest, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run for which you want to retrieve the signed document.")], + file_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)], @@ -6931,12 +6941,14 @@ def extract_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Autofill + """Retrieves the signed document or application form - Extract information from a document + Retrieves the signed document or application form depending on the file_id provided. - :param extract_request: (required) - :type extract_request: ExtractRequest + :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 file_id: The unique identifier of the file which you want to retrieve. (required) + :type file_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 @@ -6959,8 +6971,9 @@ def extract_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._extract_serialize( - extract_request=extract_request, + _param = self._download_qes_document_serialize( + workflow_run_id=workflow_run_id, + file_id=file_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -6968,7 +6981,8 @@ def extract_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Extraction", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -6977,9 +6991,10 @@ def extract_without_preload_content( return response_data.response - def _extract_serialize( + def _download_qes_document_serialize( self, - extract_request, + workflow_run_id, + file_id, _request_auth, _content_type, _headers, @@ -7002,34 +7017,28 @@ def _extract_serialize( # 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 file_id is not None: + + _query_params.append(('file_id', file_id)) + # process the header parameters # process the form parameters # process the body parameter - if extract_request is not None: - _body_params = extract_request # set the HTTP header `Accept` if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ + 'application/pdf', 'application/json' ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -7037,8 +7046,8 @@ def _extract_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/extractions', + method='GET', + resource_path='/qualified_electronic_signature/documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7055,9 +7064,10 @@ def _extract_serialize( @validate_call - def find_addresses( + def download_ses_document( self, - postcode: StrictStr, + 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)], @@ -7070,13 +7080,15 @@ def find_addresses( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> AddressesList: - """Address Picker + ) -> bytearray: + """Retrieves the signed document or signing transaction receipt - Search for addresses by postcode + Retrieves the signed document or signing transaction receipt depending on the id provided. - :param postcode: (required) - :type postcode: str + :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 @@ -7099,8 +7111,9 @@ def find_addresses( :return: Returns the result object. """ # noqa: E501 - _param = self._find_addresses_serialize( - postcode=postcode, + _param = self._download_ses_document_serialize( + workflow_run_id=workflow_run_id, + id=id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7108,7 +7121,8 @@ def find_addresses( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AddressesList", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7122,9 +7136,10 @@ def find_addresses( @validate_call - def find_addresses_with_http_info( + def download_ses_document_with_http_info( self, - postcode: StrictStr, + 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)], @@ -7137,13 +7152,15 @@ def find_addresses_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[AddressesList]: - """Address Picker + ) -> ApiResponse[bytearray]: + """Retrieves the signed document or signing transaction receipt - Search for addresses by postcode + Retrieves the signed document or signing transaction receipt depending on the id provided. - :param postcode: (required) - :type postcode: str + :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 @@ -7166,8 +7183,9 @@ def find_addresses_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_addresses_serialize( - postcode=postcode, + _param = self._download_ses_document_serialize( + workflow_run_id=workflow_run_id, + id=id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7175,7 +7193,8 @@ def find_addresses_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AddressesList", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7189,9 +7208,10 @@ def find_addresses_with_http_info( @validate_call - def find_addresses_without_preload_content( + def download_ses_document_without_preload_content( self, - postcode: StrictStr, + 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)], @@ -7205,12 +7225,14 @@ def find_addresses_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Address Picker + """Retrieves the signed document or signing transaction receipt - Search for addresses by postcode + Retrieves the signed document or signing transaction receipt depending on the id provided. - :param postcode: (required) - :type postcode: str + :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 @@ -7233,8 +7255,9 @@ def find_addresses_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_addresses_serialize( - postcode=postcode, + _param = self._download_ses_document_serialize( + workflow_run_id=workflow_run_id, + id=id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7242,7 +7265,8 @@ def find_addresses_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "AddressesList", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7251,9 +7275,10 @@ def find_addresses_without_preload_content( return response_data.response - def _find_addresses_serialize( + def _download_ses_document_serialize( self, - postcode, + workflow_run_id, + id, _request_auth, _content_type, _headers, @@ -7276,9 +7301,13 @@ def _find_addresses_serialize( # process the path parameters # process the query parameters - if postcode is not None: + if workflow_run_id is not None: - _query_params.append(('postcode', postcode)) + _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 @@ -7289,6 +7318,7 @@ def _find_addresses_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ + 'application/pdf', 'application/json' ] ) @@ -7301,7 +7331,7 @@ def _find_addresses_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/addresses/pick', + resource_path='/simple_electronic_signature/documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7318,9 +7348,9 @@ def _find_addresses_serialize( @validate_call - def find_applicant( + def download_signed_evidence_file( self, - applicant_id: StrictStr, + workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7333,13 +7363,13 @@ def find_applicant( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Applicant: - """Retrieve Applicant + ) -> bytearray: + """Retrieve Workflow Run Evidence Summary File - Retrieves a single applicant. Returns an applicant object. + Retrieves the signed evidence file for the designated Workflow Run - :param applicant_id: (required) - :type applicant_id: str + :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 @@ -7362,8 +7392,8 @@ def find_applicant( :return: Returns the result object. """ # noqa: E501 - _param = self._find_applicant_serialize( - applicant_id=applicant_id, + _param = self._download_signed_evidence_file_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7371,7 +7401,8 @@ def find_applicant( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Applicant", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7385,9 +7416,9 @@ def find_applicant( @validate_call - def find_applicant_with_http_info( + def download_signed_evidence_file_with_http_info( self, - applicant_id: StrictStr, + workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7400,13 +7431,13 @@ def find_applicant_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Applicant]: - """Retrieve Applicant + ) -> ApiResponse[bytearray]: + """Retrieve Workflow Run Evidence Summary File - Retrieves a single applicant. Returns an applicant object. + Retrieves the signed evidence file for the designated Workflow Run - :param applicant_id: (required) - :type applicant_id: str + :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 @@ -7429,8 +7460,8 @@ def find_applicant_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_applicant_serialize( - applicant_id=applicant_id, + _param = self._download_signed_evidence_file_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7438,7 +7469,8 @@ def find_applicant_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Applicant", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7452,9 +7484,9 @@ def find_applicant_with_http_info( @validate_call - def find_applicant_without_preload_content( + def download_signed_evidence_file_without_preload_content( self, - applicant_id: StrictStr, + workflow_run_id: Annotated[StrictStr, Field(description="Workflow Run ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7468,12 +7500,12 @@ def find_applicant_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Applicant + """Retrieve Workflow Run Evidence Summary File - Retrieves a single applicant. Returns an applicant object. + Retrieves the signed evidence file for the designated Workflow Run - :param applicant_id: (required) - :type applicant_id: str + :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 @@ -7496,8 +7528,8 @@ def find_applicant_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_applicant_serialize( - applicant_id=applicant_id, + _param = self._download_signed_evidence_file_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7505,7 +7537,8 @@ def find_applicant_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Applicant", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7514,9 +7547,9 @@ def find_applicant_without_preload_content( return response_data.response - def _find_applicant_serialize( + def _download_signed_evidence_file_serialize( self, - applicant_id, + workflow_run_id, _request_auth, _content_type, _headers, @@ -7538,8 +7571,8 @@ def _find_applicant_serialize( _body_params: Optional[bytes] = None # process the path parameters - if applicant_id is not None: - _path_params['applicant_id'] = applicant_id + 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 @@ -7550,6 +7583,7 @@ def _find_applicant_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ + 'application/pdf', 'application/json' ] ) @@ -7562,7 +7596,7 @@ def _find_applicant_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/applicants/{applicant_id}', + resource_path='/workflow_runs/{workflow_run_id}/signed_evidence_file', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7579,9 +7613,9 @@ def _find_applicant_serialize( @validate_call - def find_applicant_consents( + def download_signing_document( self, - applicant_id: StrictStr, + signing_document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7594,13 +7628,13 @@ def find_applicant_consents( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[ApplicantConsent]: - """Retrieve Applicant Consents + ) -> bytearray: + """Download signing document - Retrieves consents for single applicant. + Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf. - :param applicant_id: (required) - :type applicant_id: str + :param signing_document_id: (required) + :type signing_document_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 @@ -7623,8 +7657,8 @@ def find_applicant_consents( :return: Returns the result object. """ # noqa: E501 - _param = self._find_applicant_consents_serialize( - applicant_id=applicant_id, + _param = self._download_signing_document_serialize( + signing_document_id=signing_document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7632,7 +7666,7 @@ def find_applicant_consents( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ApplicantConsent]", + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7646,9 +7680,9 @@ def find_applicant_consents( @validate_call - def find_applicant_consents_with_http_info( + def download_signing_document_with_http_info( self, - applicant_id: StrictStr, + signing_document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7661,13 +7695,13 @@ def find_applicant_consents_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[ApplicantConsent]]: - """Retrieve Applicant Consents + ) -> ApiResponse[bytearray]: + """Download signing document - Retrieves consents for single applicant. + Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf. - :param applicant_id: (required) - :type applicant_id: str + :param signing_document_id: (required) + :type signing_document_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 @@ -7690,8 +7724,8 @@ def find_applicant_consents_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_applicant_consents_serialize( - applicant_id=applicant_id, + _param = self._download_signing_document_serialize( + signing_document_id=signing_document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7699,7 +7733,7 @@ def find_applicant_consents_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ApplicantConsent]", + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7713,9 +7747,9 @@ def find_applicant_consents_with_http_info( @validate_call - def find_applicant_consents_without_preload_content( + def download_signing_document_without_preload_content( self, - applicant_id: StrictStr, + signing_document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7729,12 +7763,12 @@ def find_applicant_consents_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Applicant Consents + """Download signing document - Retrieves consents for single applicant. + Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf. - :param applicant_id: (required) - :type applicant_id: str + :param signing_document_id: (required) + :type signing_document_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 @@ -7757,8 +7791,8 @@ def find_applicant_consents_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_applicant_consents_serialize( - applicant_id=applicant_id, + _param = self._download_signing_document_serialize( + signing_document_id=signing_document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7766,7 +7800,7 @@ def find_applicant_consents_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[ApplicantConsent]", + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -7775,9 +7809,9 @@ def find_applicant_consents_without_preload_content( return response_data.response - def _find_applicant_consents_serialize( + def _download_signing_document_serialize( self, - applicant_id, + signing_document_id, _request_auth, _content_type, _headers, @@ -7799,8 +7833,8 @@ def _find_applicant_consents_serialize( _body_params: Optional[bytes] = None # process the path parameters - if applicant_id is not None: - _path_params['applicant_id'] = applicant_id + if signing_document_id is not None: + _path_params['signing_document_id'] = signing_document_id # process the query parameters # process the header parameters # process the form parameters @@ -7811,6 +7845,7 @@ def _find_applicant_consents_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ + '*/*', 'application/json' ] ) @@ -7823,7 +7858,7 @@ def _find_applicant_consents_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/applicants/{applicant_id}/consents', + resource_path='/signing_documents/{signing_document_id}/download', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -7840,9 +7875,9 @@ def _find_applicant_consents_serialize( @validate_call - def find_check( + def extract( self, - check_id: StrictStr, + extract_request: ExtractRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7855,13 +7890,13 @@ def find_check( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Check: - """Retrieve a Check + ) -> Extraction: + """Autofill - Retrieves a single check. Returns a check object. + Extract information from a document - :param check_id: (required) - :type check_id: str + :param extract_request: (required) + :type extract_request: ExtractRequest :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 @@ -7884,8 +7919,8 @@ def find_check( :return: Returns the result object. """ # noqa: E501 - _param = self._find_check_serialize( - check_id=check_id, + _param = self._extract_serialize( + extract_request=extract_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7893,7 +7928,7 @@ def find_check( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Check", + '200': "Extraction", } response_data = self.api_client.call_api( *_param, @@ -7907,9 +7942,9 @@ def find_check( @validate_call - def find_check_with_http_info( + def extract_with_http_info( self, - check_id: StrictStr, + extract_request: ExtractRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7922,13 +7957,13 @@ def find_check_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Check]: - """Retrieve a Check + ) -> ApiResponse[Extraction]: + """Autofill - Retrieves a single check. Returns a check object. + Extract information from a document - :param check_id: (required) - :type check_id: str + :param extract_request: (required) + :type extract_request: ExtractRequest :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 @@ -7951,8 +7986,8 @@ def find_check_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_check_serialize( - check_id=check_id, + _param = self._extract_serialize( + extract_request=extract_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -7960,7 +7995,7 @@ def find_check_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Check", + '200': "Extraction", } response_data = self.api_client.call_api( *_param, @@ -7974,9 +8009,9 @@ def find_check_with_http_info( @validate_call - def find_check_without_preload_content( + def extract_without_preload_content( self, - check_id: StrictStr, + extract_request: ExtractRequest, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -7990,12 +8025,12 @@ def find_check_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve a Check + """Autofill - Retrieves a single check. Returns a check object. + Extract information from a document - :param check_id: (required) - :type check_id: str + :param extract_request: (required) + :type extract_request: ExtractRequest :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 @@ -8018,8 +8053,8 @@ def find_check_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_check_serialize( - check_id=check_id, + _param = self._extract_serialize( + extract_request=extract_request, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8027,7 +8062,7 @@ def find_check_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Check", + '200': "Extraction", } response_data = self.api_client.call_api( *_param, @@ -8036,9 +8071,9 @@ def find_check_without_preload_content( return response_data.response - def _find_check_serialize( + def _extract_serialize( self, - check_id, + extract_request, _request_auth, _content_type, _headers, @@ -8060,12 +8095,12 @@ def _find_check_serialize( _body_params: Optional[bytes] = None # process the path parameters - if check_id is not None: - _path_params['check_id'] = check_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter + if extract_request is not None: + _body_params = extract_request # set the HTTP header `Accept` @@ -8076,6 +8111,19 @@ def _find_check_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -8083,8 +8131,8 @@ def _find_check_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/checks/{check_id}', + method='POST', + resource_path='/extractions', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8101,9 +8149,9 @@ def _find_check_serialize( @validate_call - def find_document( + def find_addresses( self, - document_id: StrictStr, + postcode: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8116,13 +8164,13 @@ def find_document( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Document: - """Retrieve document + ) -> AddressesList: + """Address Picker - A single document can be retrieved by calling this endpoint with the document's unique identifier. + Search for addresses by postcode - :param document_id: (required) - :type document_id: str + :param postcode: (required) + :type postcode: 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 @@ -8145,8 +8193,8 @@ def find_document( :return: Returns the result object. """ # noqa: E501 - _param = self._find_document_serialize( - document_id=document_id, + _param = self._find_addresses_serialize( + postcode=postcode, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8154,7 +8202,7 @@ def find_document( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Document", + '200': "AddressesList", } response_data = self.api_client.call_api( *_param, @@ -8168,9 +8216,9 @@ def find_document( @validate_call - def find_document_with_http_info( + def find_addresses_with_http_info( self, - document_id: StrictStr, + postcode: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8183,13 +8231,13 @@ def find_document_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Document]: - """Retrieve document + ) -> ApiResponse[AddressesList]: + """Address Picker - A single document can be retrieved by calling this endpoint with the document's unique identifier. + Search for addresses by postcode - :param document_id: (required) - :type document_id: str + :param postcode: (required) + :type postcode: 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 @@ -8212,8 +8260,8 @@ def find_document_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_document_serialize( - document_id=document_id, + _param = self._find_addresses_serialize( + postcode=postcode, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8221,7 +8269,7 @@ def find_document_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Document", + '200': "AddressesList", } response_data = self.api_client.call_api( *_param, @@ -8235,9 +8283,9 @@ def find_document_with_http_info( @validate_call - def find_document_without_preload_content( + def find_addresses_without_preload_content( self, - document_id: StrictStr, + postcode: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8251,12 +8299,12 @@ def find_document_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve document + """Address Picker - A single document can be retrieved by calling this endpoint with the document's unique identifier. + Search for addresses by postcode - :param document_id: (required) - :type document_id: str + :param postcode: (required) + :type postcode: 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 @@ -8279,8 +8327,8 @@ def find_document_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_document_serialize( - document_id=document_id, + _param = self._find_addresses_serialize( + postcode=postcode, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8288,7 +8336,7 @@ def find_document_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Document", + '200': "AddressesList", } response_data = self.api_client.call_api( *_param, @@ -8297,9 +8345,9 @@ def find_document_without_preload_content( return response_data.response - def _find_document_serialize( + def _find_addresses_serialize( self, - document_id, + postcode, _request_auth, _content_type, _headers, @@ -8321,9 +8369,11 @@ def _find_document_serialize( _body_params: Optional[bytes] = None # process the path parameters - if document_id is not None: - _path_params['document_id'] = document_id # process the query parameters + if postcode is not None: + + _query_params.append(('postcode', postcode)) + # process the header parameters # process the form parameters # process the body parameter @@ -8345,7 +8395,7 @@ def _find_document_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/documents/{document_id}', + resource_path='/addresses/pick', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8362,9 +8412,9 @@ def _find_document_serialize( @validate_call - def find_id_photo( + def find_applicant( self, - id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8377,13 +8427,13 @@ def find_id_photo( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> IdPhoto: - """Retrieve ID photo + ) -> Applicant: + """Retrieve Applicant - Retrieves a single ID photo. Returns a ID photo object. + Retrieves a single applicant. Returns an applicant object. - :param id_photo_id: The ID photo's unique identifier. (required) - :type id_photo_id: str + :param applicant_id: (required) + :type applicant_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 @@ -8406,8 +8456,8 @@ def find_id_photo( :return: Returns the result object. """ # noqa: E501 - _param = self._find_id_photo_serialize( - id_photo_id=id_photo_id, + _param = self._find_applicant_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8415,7 +8465,7 @@ def find_id_photo( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "IdPhoto", + '200': "Applicant", } response_data = self.api_client.call_api( *_param, @@ -8429,9 +8479,9 @@ def find_id_photo( @validate_call - def find_id_photo_with_http_info( + def find_applicant_with_http_info( self, - id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8444,13 +8494,13 @@ def find_id_photo_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[IdPhoto]: - """Retrieve ID photo + ) -> ApiResponse[Applicant]: + """Retrieve Applicant - Retrieves a single ID photo. Returns a ID photo object. + Retrieves a single applicant. Returns an applicant object. - :param id_photo_id: The ID photo's unique identifier. (required) - :type id_photo_id: str + :param applicant_id: (required) + :type applicant_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 @@ -8473,8 +8523,8 @@ def find_id_photo_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_id_photo_serialize( - id_photo_id=id_photo_id, + _param = self._find_applicant_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8482,7 +8532,7 @@ def find_id_photo_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "IdPhoto", + '200': "Applicant", } response_data = self.api_client.call_api( *_param, @@ -8496,9 +8546,9 @@ def find_id_photo_with_http_info( @validate_call - def find_id_photo_without_preload_content( + def find_applicant_without_preload_content( self, - id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8512,12 +8562,12 @@ def find_id_photo_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve ID photo + """Retrieve Applicant - Retrieves a single ID photo. Returns a ID photo object. + Retrieves a single applicant. Returns an applicant object. - :param id_photo_id: The ID photo's unique identifier. (required) - :type id_photo_id: str + :param applicant_id: (required) + :type applicant_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 @@ -8540,8 +8590,8 @@ def find_id_photo_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_id_photo_serialize( - id_photo_id=id_photo_id, + _param = self._find_applicant_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8549,7 +8599,7 @@ def find_id_photo_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "IdPhoto", + '200': "Applicant", } response_data = self.api_client.call_api( *_param, @@ -8558,9 +8608,9 @@ def find_id_photo_without_preload_content( return response_data.response - def _find_id_photo_serialize( + def _find_applicant_serialize( self, - id_photo_id, + applicant_id, _request_auth, _content_type, _headers, @@ -8582,8 +8632,8 @@ def _find_id_photo_serialize( _body_params: Optional[bytes] = None # process the path parameters - if id_photo_id is not None: - _path_params['id_photo_id'] = id_photo_id + if applicant_id is not None: + _path_params['applicant_id'] = applicant_id # process the query parameters # process the header parameters # process the form parameters @@ -8606,7 +8656,7 @@ def _find_id_photo_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/id_photos/{id_photo_id}', + resource_path='/applicants/{applicant_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8623,9 +8673,9 @@ def _find_id_photo_serialize( @validate_call - def find_live_photo( + def find_applicant_consents( self, - live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8638,13 +8688,13 @@ def find_live_photo( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LivePhoto: - """Retrieve live photo + ) -> List[ApplicantConsent]: + """Retrieve Applicant Consents - Retrieves a single live photo. Returns a live photo object. + Retrieves consents for single applicant. - :param live_photo_id: The live photo's unique identifier. (required) - :type live_photo_id: str + :param applicant_id: (required) + :type applicant_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 @@ -8667,8 +8717,8 @@ def find_live_photo( :return: Returns the result object. """ # noqa: E501 - _param = self._find_live_photo_serialize( - live_photo_id=live_photo_id, + _param = self._find_applicant_consents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8676,7 +8726,7 @@ def find_live_photo( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LivePhoto", + '200': "List[ApplicantConsent]", } response_data = self.api_client.call_api( *_param, @@ -8690,9 +8740,9 @@ def find_live_photo( @validate_call - def find_live_photo_with_http_info( + def find_applicant_consents_with_http_info( self, - live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8705,13 +8755,13 @@ def find_live_photo_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LivePhoto]: - """Retrieve live photo + ) -> ApiResponse[List[ApplicantConsent]]: + """Retrieve Applicant Consents - Retrieves a single live photo. Returns a live photo object. + Retrieves consents for single applicant. - :param live_photo_id: The live photo's unique identifier. (required) - :type live_photo_id: str + :param applicant_id: (required) + :type applicant_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 @@ -8734,8 +8784,8 @@ def find_live_photo_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_live_photo_serialize( - live_photo_id=live_photo_id, + _param = self._find_applicant_consents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8743,7 +8793,7 @@ def find_live_photo_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LivePhoto", + '200': "List[ApplicantConsent]", } response_data = self.api_client.call_api( *_param, @@ -8757,9 +8807,9 @@ def find_live_photo_with_http_info( @validate_call - def find_live_photo_without_preload_content( + def find_applicant_consents_without_preload_content( self, - live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8773,12 +8823,12 @@ def find_live_photo_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve live photo + """Retrieve Applicant Consents - Retrieves a single live photo. Returns a live photo object. + Retrieves consents for single applicant. - :param live_photo_id: The live photo's unique identifier. (required) - :type live_photo_id: str + :param applicant_id: (required) + :type applicant_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 @@ -8801,8 +8851,8 @@ def find_live_photo_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_live_photo_serialize( - live_photo_id=live_photo_id, + _param = self._find_applicant_consents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8810,7 +8860,7 @@ def find_live_photo_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LivePhoto", + '200': "List[ApplicantConsent]", } response_data = self.api_client.call_api( *_param, @@ -8819,9 +8869,9 @@ def find_live_photo_without_preload_content( return response_data.response - def _find_live_photo_serialize( + def _find_applicant_consents_serialize( self, - live_photo_id, + applicant_id, _request_auth, _content_type, _headers, @@ -8843,8 +8893,8 @@ def _find_live_photo_serialize( _body_params: Optional[bytes] = None # process the path parameters - if live_photo_id is not None: - _path_params['live_photo_id'] = live_photo_id + if applicant_id is not None: + _path_params['applicant_id'] = applicant_id # process the query parameters # process the header parameters # process the form parameters @@ -8867,7 +8917,7 @@ def _find_live_photo_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/live_photos/{live_photo_id}', + resource_path='/applicants/{applicant_id}/consents', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8884,9 +8934,9 @@ def _find_live_photo_serialize( @validate_call - def find_live_video( + def find_check( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8899,13 +8949,13 @@ def find_live_video( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LiveVideo: - """Retrieve live video + ) -> Check: + """Retrieve a Check - Retrieves a single live video. Returns the corresponding live video object. + Retrieves a single check. Returns a check object. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param check_id: (required) + :type check_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 @@ -8928,8 +8978,8 @@ def find_live_video( :return: Returns the result object. """ # noqa: E501 - _param = self._find_live_video_serialize( - live_video_id=live_video_id, + _param = self._find_check_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -8937,7 +8987,7 @@ def find_live_video( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LiveVideo", + '200': "Check", } response_data = self.api_client.call_api( *_param, @@ -8951,9 +9001,9 @@ def find_live_video( @validate_call - def find_live_video_with_http_info( + def find_check_with_http_info( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8966,13 +9016,13 @@ def find_live_video_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LiveVideo]: - """Retrieve live video + ) -> ApiResponse[Check]: + """Retrieve a Check - Retrieves a single live video. Returns the corresponding live video object. + Retrieves a single check. Returns a check object. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param check_id: (required) + :type check_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 @@ -8995,8 +9045,8 @@ def find_live_video_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_live_video_serialize( - live_video_id=live_video_id, + _param = self._find_check_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9004,7 +9054,7 @@ def find_live_video_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LiveVideo", + '200': "Check", } response_data = self.api_client.call_api( *_param, @@ -9018,9 +9068,9 @@ def find_live_video_with_http_info( @validate_call - def find_live_video_without_preload_content( + def find_check_without_preload_content( self, - live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9034,12 +9084,12 @@ def find_live_video_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve live video + """Retrieve a Check - Retrieves a single live video. Returns the corresponding live video object. + Retrieves a single check. Returns a check object. - :param live_video_id: The live video's unique identifier. (required) - :type live_video_id: str + :param check_id: (required) + :type check_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 @@ -9062,8 +9112,8 @@ def find_live_video_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_live_video_serialize( - live_video_id=live_video_id, + _param = self._find_check_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9071,7 +9121,7 @@ def find_live_video_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LiveVideo", + '200': "Check", } response_data = self.api_client.call_api( *_param, @@ -9080,9 +9130,9 @@ def find_live_video_without_preload_content( return response_data.response - def _find_live_video_serialize( + def _find_check_serialize( self, - live_video_id, + check_id, _request_auth, _content_type, _headers, @@ -9104,8 +9154,8 @@ def _find_live_video_serialize( _body_params: Optional[bytes] = None # process the path parameters - if live_video_id is not None: - _path_params['live_video_id'] = live_video_id + if check_id is not None: + _path_params['check_id'] = check_id # process the query parameters # process the header parameters # process the form parameters @@ -9128,7 +9178,7 @@ def _find_live_video_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/live_videos/{live_video_id}', + resource_path='/checks/{check_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -9145,9 +9195,9 @@ def _find_live_video_serialize( @validate_call - def find_motion_capture( + def find_document( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9160,13 +9210,13 @@ def find_motion_capture( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> MotionCapture: - """Retrieve motion capture + ) -> Document: + """Retrieve document - Retrieves a single motion capture. Returns the corresponding motion capture object. + A single document can be retrieved by calling this endpoint with the document's unique identifier. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param document_id: (required) + :type document_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 @@ -9189,8 +9239,8 @@ def find_motion_capture( :return: Returns the result object. """ # noqa: E501 - _param = self._find_motion_capture_serialize( - motion_capture_id=motion_capture_id, + _param = self._find_document_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9198,7 +9248,7 @@ def find_motion_capture( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MotionCapture", + '200': "Document", } response_data = self.api_client.call_api( *_param, @@ -9212,9 +9262,9 @@ def find_motion_capture( @validate_call - def find_motion_capture_with_http_info( + def find_document_with_http_info( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9227,13 +9277,13 @@ def find_motion_capture_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[MotionCapture]: - """Retrieve motion capture + ) -> ApiResponse[Document]: + """Retrieve document - Retrieves a single motion capture. Returns the corresponding motion capture object. + A single document can be retrieved by calling this endpoint with the document's unique identifier. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param document_id: (required) + :type document_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 @@ -9256,8 +9306,8 @@ def find_motion_capture_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_motion_capture_serialize( - motion_capture_id=motion_capture_id, + _param = self._find_document_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9265,7 +9315,7 @@ def find_motion_capture_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MotionCapture", + '200': "Document", } response_data = self.api_client.call_api( *_param, @@ -9279,9 +9329,9 @@ def find_motion_capture_with_http_info( @validate_call - def find_motion_capture_without_preload_content( + def find_document_without_preload_content( self, - motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], + document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9295,12 +9345,12 @@ def find_motion_capture_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve motion capture + """Retrieve document - Retrieves a single motion capture. Returns the corresponding motion capture object. + A single document can be retrieved by calling this endpoint with the document's unique identifier. - :param motion_capture_id: The motion capture's unique identifier. (required) - :type motion_capture_id: str + :param document_id: (required) + :type document_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 @@ -9323,8 +9373,8 @@ def find_motion_capture_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_motion_capture_serialize( - motion_capture_id=motion_capture_id, + _param = self._find_document_serialize( + document_id=document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9332,7 +9382,7 @@ def find_motion_capture_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MotionCapture", + '200': "Document", } response_data = self.api_client.call_api( *_param, @@ -9341,9 +9391,9 @@ def find_motion_capture_without_preload_content( return response_data.response - def _find_motion_capture_serialize( + def _find_document_serialize( self, - motion_capture_id, + document_id, _request_auth, _content_type, _headers, @@ -9365,8 +9415,8 @@ def _find_motion_capture_serialize( _body_params: Optional[bytes] = None # process the path parameters - if motion_capture_id is not None: - _path_params['motion_capture_id'] = motion_capture_id + if document_id is not None: + _path_params['document_id'] = document_id # process the query parameters # process the header parameters # process the form parameters @@ -9389,7 +9439,7 @@ def _find_motion_capture_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/motion_captures/{motion_capture_id}', + resource_path='/documents/{document_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -9406,9 +9456,9 @@ def _find_motion_capture_serialize( @validate_call - def find_report( + def find_id_photo( self, - report_id: StrictStr, + id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9421,13 +9471,13 @@ def find_report( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Report: - """Retrieve report + ) -> IdPhoto: + """Retrieve ID photo - A single report can be retrieved using this endpoint with the corresponding unique identifier. + Retrieves a single ID photo. Returns a ID photo object. - :param report_id: (required) - :type report_id: str + :param id_photo_id: The ID photo's unique identifier. (required) + :type id_photo_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 @@ -9450,8 +9500,8 @@ def find_report( :return: Returns the result object. """ # noqa: E501 - _param = self._find_report_serialize( - report_id=report_id, + _param = self._find_id_photo_serialize( + id_photo_id=id_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9459,7 +9509,7 @@ def find_report( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Report", + '200': "IdPhoto", } response_data = self.api_client.call_api( *_param, @@ -9473,9 +9523,9 @@ def find_report( @validate_call - def find_report_with_http_info( + def find_id_photo_with_http_info( self, - report_id: StrictStr, + id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9488,13 +9538,13 @@ def find_report_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Report]: - """Retrieve report + ) -> ApiResponse[IdPhoto]: + """Retrieve ID photo - A single report can be retrieved using this endpoint with the corresponding unique identifier. + Retrieves a single ID photo. Returns a ID photo object. - :param report_id: (required) - :type report_id: str + :param id_photo_id: The ID photo's unique identifier. (required) + :type id_photo_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 @@ -9517,8 +9567,8 @@ def find_report_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_report_serialize( - report_id=report_id, + _param = self._find_id_photo_serialize( + id_photo_id=id_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9526,7 +9576,7 @@ def find_report_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Report", + '200': "IdPhoto", } response_data = self.api_client.call_api( *_param, @@ -9540,9 +9590,9 @@ def find_report_with_http_info( @validate_call - def find_report_without_preload_content( + def find_id_photo_without_preload_content( self, - report_id: StrictStr, + id_photo_id: Annotated[StrictStr, Field(description="The ID photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9556,12 +9606,12 @@ def find_report_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve report + """Retrieve ID photo - A single report can be retrieved using this endpoint with the corresponding unique identifier. + Retrieves a single ID photo. Returns a ID photo object. - :param report_id: (required) - :type report_id: str + :param id_photo_id: The ID photo's unique identifier. (required) + :type id_photo_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 @@ -9584,8 +9634,8 @@ def find_report_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_report_serialize( - report_id=report_id, + _param = self._find_id_photo_serialize( + id_photo_id=id_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9593,7 +9643,7 @@ def find_report_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Report", + '200': "IdPhoto", } response_data = self.api_client.call_api( *_param, @@ -9602,9 +9652,9 @@ def find_report_without_preload_content( return response_data.response - def _find_report_serialize( + def _find_id_photo_serialize( self, - report_id, + id_photo_id, _request_auth, _content_type, _headers, @@ -9626,8 +9676,8 @@ def _find_report_serialize( _body_params: Optional[bytes] = None # process the path parameters - if report_id is not None: - _path_params['report_id'] = report_id + if id_photo_id is not None: + _path_params['id_photo_id'] = id_photo_id # process the query parameters # process the header parameters # process the form parameters @@ -9650,7 +9700,7 @@ def _find_report_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/reports/{report_id}', + resource_path='/id_photos/{id_photo_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -9667,10 +9717,9 @@ def _find_report_serialize( @validate_call - def find_task( + def find_live_photo( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Task belongs.")], - task_id: Annotated[StrictStr, Field(description="The identifier of the Task you want to retrieve.")], + live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9683,15 +9732,13 @@ def find_task( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Task: - """Retrieve Task + ) -> LivePhoto: + """Retrieve live photo - A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. + Retrieves a single live photo. Returns a live photo object. - :param workflow_run_id: The unique identifier of the Workflow Run to which the Task belongs. (required) - :type workflow_run_id: str - :param task_id: The identifier of the Task you want to retrieve. (required) - :type task_id: str + :param live_photo_id: The live photo's unique identifier. (required) + :type live_photo_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 @@ -9714,9 +9761,8 @@ def find_task( :return: Returns the result object. """ # noqa: E501 - _param = self._find_task_serialize( - workflow_run_id=workflow_run_id, - task_id=task_id, + _param = self._find_live_photo_serialize( + live_photo_id=live_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9724,7 +9770,7 @@ def find_task( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Task", + '200': "LivePhoto", } response_data = self.api_client.call_api( *_param, @@ -9738,10 +9784,9 @@ def find_task( @validate_call - def find_task_with_http_info( + def find_live_photo_with_http_info( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Task belongs.")], - task_id: Annotated[StrictStr, Field(description="The identifier of the Task you want to retrieve.")], + live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9754,15 +9799,13 @@ def find_task_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Task]: - """Retrieve Task + ) -> ApiResponse[LivePhoto]: + """Retrieve live photo - A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. + Retrieves a single live photo. Returns a live photo object. - :param workflow_run_id: The unique identifier of the Workflow Run to which the Task belongs. (required) - :type workflow_run_id: str - :param task_id: The identifier of the Task you want to retrieve. (required) - :type task_id: str + :param live_photo_id: The live photo's unique identifier. (required) + :type live_photo_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 @@ -9785,9 +9828,8 @@ def find_task_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_task_serialize( - workflow_run_id=workflow_run_id, - task_id=task_id, + _param = self._find_live_photo_serialize( + live_photo_id=live_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9795,7 +9837,7 @@ def find_task_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Task", + '200': "LivePhoto", } response_data = self.api_client.call_api( *_param, @@ -9809,10 +9851,9 @@ def find_task_with_http_info( @validate_call - def find_task_without_preload_content( + def find_live_photo_without_preload_content( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Task belongs.")], - task_id: Annotated[StrictStr, Field(description="The identifier of the Task you want to retrieve.")], + live_photo_id: Annotated[StrictStr, Field(description="The live photo's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9826,14 +9867,12 @@ def find_task_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Task + """Retrieve live photo - A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. + Retrieves a single live photo. Returns a live photo object. - :param workflow_run_id: The unique identifier of the Workflow Run to which the Task belongs. (required) - :type workflow_run_id: str - :param task_id: The identifier of the Task you want to retrieve. (required) - :type task_id: str + :param live_photo_id: The live photo's unique identifier. (required) + :type live_photo_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 @@ -9856,9 +9895,8 @@ def find_task_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_task_serialize( - workflow_run_id=workflow_run_id, - task_id=task_id, + _param = self._find_live_photo_serialize( + live_photo_id=live_photo_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -9866,7 +9904,7 @@ def find_task_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Task", + '200': "LivePhoto", } response_data = self.api_client.call_api( *_param, @@ -9875,10 +9913,9 @@ def find_task_without_preload_content( return response_data.response - def _find_task_serialize( + def _find_live_photo_serialize( self, - workflow_run_id, - task_id, + live_photo_id, _request_auth, _content_type, _headers, @@ -9900,10 +9937,8 @@ def _find_task_serialize( _body_params: Optional[bytes] = None # process the path parameters - if workflow_run_id is not None: - _path_params['workflow_run_id'] = workflow_run_id - if task_id is not None: - _path_params['task_id'] = task_id + if live_photo_id is not None: + _path_params['live_photo_id'] = live_photo_id # process the query parameters # process the header parameters # process the form parameters @@ -9926,7 +9961,7 @@ def _find_task_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/workflow_runs/{workflow_run_id}/tasks/{task_id}', + resource_path='/live_photos/{live_photo_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -9943,10 +9978,9 @@ def _find_task_serialize( @validate_call - def find_timeline_file( + def find_live_video( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], - timeline_file_id: Annotated[StrictStr, Field(description="The unique identifier for the Timefile File.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9959,15 +9993,13 @@ def find_timeline_file( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> bytearray: - """Retrieve Timeline File for Workflow Run + ) -> LiveVideo: + """Retrieve live video - Retrieves the Timeline File for the designated Workflow Run. + Retrieves a single live video. Returns the corresponding live video object. - :param workflow_run_id: The unique identifier of the Workflow Run. (required) - :type workflow_run_id: str - :param timeline_file_id: The unique identifier for the Timefile File. (required) - :type timeline_file_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -9990,9 +10022,8 @@ def find_timeline_file( :return: Returns the result object. """ # noqa: E501 - _param = self._find_timeline_file_serialize( - workflow_run_id=workflow_run_id, - timeline_file_id=timeline_file_id, + _param = self._find_live_video_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10000,8 +10031,7 @@ def find_timeline_file( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, - '200': "bytearray", + '200': "LiveVideo", } response_data = self.api_client.call_api( *_param, @@ -10015,10 +10045,9 @@ def find_timeline_file( @validate_call - def find_timeline_file_with_http_info( + def find_live_video_with_http_info( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], - timeline_file_id: Annotated[StrictStr, Field(description="The unique identifier for the Timefile File.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10031,15 +10060,13 @@ def find_timeline_file_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[bytearray]: - """Retrieve Timeline File for Workflow Run + ) -> ApiResponse[LiveVideo]: + """Retrieve live video - Retrieves the Timeline File for the designated Workflow Run. + Retrieves a single live video. Returns the corresponding live video object. - :param workflow_run_id: The unique identifier of the Workflow Run. (required) - :type workflow_run_id: str - :param timeline_file_id: The unique identifier for the Timefile File. (required) - :type timeline_file_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -10062,9 +10089,8 @@ def find_timeline_file_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_timeline_file_serialize( - workflow_run_id=workflow_run_id, - timeline_file_id=timeline_file_id, + _param = self._find_live_video_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10072,8 +10098,7 @@ def find_timeline_file_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, - '200': "bytearray", + '200': "LiveVideo", } response_data = self.api_client.call_api( *_param, @@ -10087,10 +10112,9 @@ def find_timeline_file_with_http_info( @validate_call - def find_timeline_file_without_preload_content( + def find_live_video_without_preload_content( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], - timeline_file_id: Annotated[StrictStr, Field(description="The unique identifier for the Timefile File.")], + live_video_id: Annotated[StrictStr, Field(description="The live video's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10104,14 +10128,12 @@ def find_timeline_file_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Timeline File for Workflow Run + """Retrieve live video - Retrieves the Timeline File for the designated Workflow Run. + Retrieves a single live video. Returns the corresponding live video object. - :param workflow_run_id: The unique identifier of the Workflow Run. (required) - :type workflow_run_id: str - :param timeline_file_id: The unique identifier for the Timefile File. (required) - :type timeline_file_id: str + :param live_video_id: The live video's unique identifier. (required) + :type live_video_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 @@ -10134,9 +10156,8 @@ def find_timeline_file_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_timeline_file_serialize( - workflow_run_id=workflow_run_id, - timeline_file_id=timeline_file_id, + _param = self._find_live_video_serialize( + live_video_id=live_video_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10144,8 +10165,7 @@ def find_timeline_file_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '302': None, - '200': "bytearray", + '200': "LiveVideo", } response_data = self.api_client.call_api( *_param, @@ -10154,10 +10174,9 @@ def find_timeline_file_without_preload_content( return response_data.response - def _find_timeline_file_serialize( + def _find_live_video_serialize( self, - workflow_run_id, - timeline_file_id, + live_video_id, _request_auth, _content_type, _headers, @@ -10179,10 +10198,8 @@ def _find_timeline_file_serialize( _body_params: Optional[bytes] = None # process the path parameters - if workflow_run_id is not None: - _path_params['workflow_run_id'] = workflow_run_id - if timeline_file_id is not None: - _path_params['timeline_file_id'] = timeline_file_id + if live_video_id is not None: + _path_params['live_video_id'] = live_video_id # process the query parameters # process the header parameters # process the form parameters @@ -10193,7 +10210,6 @@ def _find_timeline_file_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - 'application/pdf', 'application/json' ] ) @@ -10206,7 +10222,7 @@ def _find_timeline_file_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}', + resource_path='/live_videos/{live_video_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -10223,9 +10239,9 @@ def _find_timeline_file_serialize( @validate_call - def find_watchlist_monitor( + def find_motion_capture( self, - monitor_id: Annotated[StrictStr, Field(description="The watchlist monitor's unique identifier.")], + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10238,13 +10254,13 @@ def find_watchlist_monitor( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> WatchlistMonitor: - """Retrieve monitor + ) -> MotionCapture: + """Retrieve motion capture - Retrieves a single monitor + Retrieves a single motion capture. Returns the corresponding motion capture object. - :param monitor_id: The watchlist monitor's unique identifier. (required) - :type monitor_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -10267,8 +10283,8 @@ def find_watchlist_monitor( :return: Returns the result object. """ # noqa: E501 - _param = self._find_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._find_motion_capture_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10276,7 +10292,7 @@ def find_watchlist_monitor( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitor", + '200': "MotionCapture", } response_data = self.api_client.call_api( *_param, @@ -10290,9 +10306,9 @@ def find_watchlist_monitor( @validate_call - def find_watchlist_monitor_with_http_info( + def find_motion_capture_with_http_info( self, - monitor_id: Annotated[StrictStr, Field(description="The watchlist monitor's unique identifier.")], + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10305,13 +10321,13 @@ def find_watchlist_monitor_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[WatchlistMonitor]: - """Retrieve monitor + ) -> ApiResponse[MotionCapture]: + """Retrieve motion capture - Retrieves a single monitor + Retrieves a single motion capture. Returns the corresponding motion capture object. - :param monitor_id: The watchlist monitor's unique identifier. (required) - :type monitor_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -10334,8 +10350,8 @@ def find_watchlist_monitor_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._find_motion_capture_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10343,7 +10359,7 @@ def find_watchlist_monitor_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitor", + '200': "MotionCapture", } response_data = self.api_client.call_api( *_param, @@ -10357,9 +10373,9 @@ def find_watchlist_monitor_with_http_info( @validate_call - def find_watchlist_monitor_without_preload_content( + def find_motion_capture_without_preload_content( self, - monitor_id: Annotated[StrictStr, Field(description="The watchlist monitor's unique identifier.")], + motion_capture_id: Annotated[StrictStr, Field(description="The motion capture's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10373,12 +10389,12 @@ def find_watchlist_monitor_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve monitor + """Retrieve motion capture - Retrieves a single monitor + Retrieves a single motion capture. Returns the corresponding motion capture object. - :param monitor_id: The watchlist monitor's unique identifier. (required) - :type monitor_id: str + :param motion_capture_id: The motion capture's unique identifier. (required) + :type motion_capture_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 @@ -10401,8 +10417,8 @@ def find_watchlist_monitor_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._find_motion_capture_serialize( + motion_capture_id=motion_capture_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10410,7 +10426,7 @@ def find_watchlist_monitor_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitor", + '200': "MotionCapture", } response_data = self.api_client.call_api( *_param, @@ -10419,9 +10435,9 @@ def find_watchlist_monitor_without_preload_content( return response_data.response - def _find_watchlist_monitor_serialize( + def _find_motion_capture_serialize( self, - monitor_id, + motion_capture_id, _request_auth, _content_type, _headers, @@ -10443,8 +10459,8 @@ def _find_watchlist_monitor_serialize( _body_params: Optional[bytes] = None # process the path parameters - if monitor_id is not None: - _path_params['monitor_id'] = monitor_id + if motion_capture_id is not None: + _path_params['motion_capture_id'] = motion_capture_id # process the query parameters # process the header parameters # process the form parameters @@ -10467,7 +10483,7 @@ def _find_watchlist_monitor_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/watchlist_monitors/{monitor_id}', + resource_path='/motion_captures/{motion_capture_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -10484,9 +10500,10 @@ def _find_watchlist_monitor_serialize( @validate_call - def find_webhook( + def find_passkey( self, - webhook_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10499,13 +10516,15 @@ def find_webhook( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Webhook: - """Retrieve a Webhook + ) -> Passkey: + """Retrieve passkey - Retrieves a single webhook. Returns a webhook object. + Returns a passkey's details. - :param webhook_id: (required) - :type webhook_id: str + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_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 @@ -10528,8 +10547,9 @@ def find_webhook( :return: Returns the result object. """ # noqa: E501 - _param = self._find_webhook_serialize( - webhook_id=webhook_id, + _param = self._find_passkey_serialize( + username=username, + passkey_id=passkey_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10537,7 +10557,8 @@ def find_webhook( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Webhook", + '200': "Passkey", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -10551,9 +10572,10 @@ def find_webhook( @validate_call - def find_webhook_with_http_info( + def find_passkey_with_http_info( self, - webhook_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10566,13 +10588,15 @@ def find_webhook_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Webhook]: - """Retrieve a Webhook + ) -> ApiResponse[Passkey]: + """Retrieve passkey - Retrieves a single webhook. Returns a webhook object. + Returns a passkey's details. - :param webhook_id: (required) - :type webhook_id: str + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_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 @@ -10595,8 +10619,9 @@ def find_webhook_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_webhook_serialize( - webhook_id=webhook_id, + _param = self._find_passkey_serialize( + username=username, + passkey_id=passkey_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10604,7 +10629,8 @@ def find_webhook_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Webhook", + '200': "Passkey", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -10618,9 +10644,10 @@ def find_webhook_with_http_info( @validate_call - def find_webhook_without_preload_content( + def find_passkey_without_preload_content( self, - webhook_id: StrictStr, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10634,12 +10661,14 @@ def find_webhook_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve a Webhook + """Retrieve passkey - Retrieves a single webhook. Returns a webhook object. + Returns a passkey's details. - :param webhook_id: (required) - :type webhook_id: str + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_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 @@ -10662,8 +10691,9 @@ def find_webhook_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_webhook_serialize( - webhook_id=webhook_id, + _param = self._find_passkey_serialize( + username=username, + passkey_id=passkey_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10671,7 +10701,8 @@ def find_webhook_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Webhook", + '200': "Passkey", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -10680,9 +10711,10 @@ def find_webhook_without_preload_content( return response_data.response - def _find_webhook_serialize( + def _find_passkey_serialize( self, - webhook_id, + username, + passkey_id, _request_auth, _content_type, _headers, @@ -10704,8 +10736,10 @@ def _find_webhook_serialize( _body_params: Optional[bytes] = None # process the path parameters - if webhook_id is not None: - _path_params['webhook_id'] = webhook_id + if username is not None: + _path_params['username'] = username + if passkey_id is not None: + _path_params['passkey_id'] = passkey_id # process the query parameters # process the header parameters # process the form parameters @@ -10728,7 +10762,7 @@ def _find_webhook_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/webhooks/{webhook_id}', + resource_path='/passkeys/{username}/{passkey_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -10745,9 +10779,9 @@ def _find_webhook_serialize( @validate_call - def find_workflow_run( + def find_report( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], + report_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10760,13 +10794,13 @@ def find_workflow_run( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> WorkflowRun: - """Retrieve Workflow Run + ) -> Report: + """Retrieve report - A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. + A single report can be retrieved using this endpoint with the corresponding unique identifier. - :param workflow_run_id: The unique identifier of the Workflow Run. (required) - :type workflow_run_id: str + :param report_id: (required) + :type report_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 @@ -10789,8 +10823,8 @@ def find_workflow_run( :return: Returns the result object. """ # noqa: E501 - _param = self._find_workflow_run_serialize( - workflow_run_id=workflow_run_id, + _param = self._find_report_serialize( + report_id=report_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10798,7 +10832,7 @@ def find_workflow_run( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WorkflowRun", + '200': "Report", } response_data = self.api_client.call_api( *_param, @@ -10812,9 +10846,9 @@ def find_workflow_run( @validate_call - def find_workflow_run_with_http_info( + def find_report_with_http_info( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], + report_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10827,13 +10861,13 @@ def find_workflow_run_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[WorkflowRun]: - """Retrieve Workflow Run + ) -> ApiResponse[Report]: + """Retrieve report - A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. + A single report can be retrieved using this endpoint with the corresponding unique identifier. - :param workflow_run_id: The unique identifier of the Workflow Run. (required) - :type workflow_run_id: str + :param report_id: (required) + :type report_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 @@ -10856,8 +10890,8 @@ def find_workflow_run_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._find_workflow_run_serialize( - workflow_run_id=workflow_run_id, + _param = self._find_report_serialize( + report_id=report_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10865,7 +10899,7 @@ def find_workflow_run_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WorkflowRun", + '200': "Report", } response_data = self.api_client.call_api( *_param, @@ -10879,9 +10913,9 @@ def find_workflow_run_with_http_info( @validate_call - def find_workflow_run_without_preload_content( + def find_report_without_preload_content( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], + report_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10895,12 +10929,12 @@ def find_workflow_run_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Workflow Run + """Retrieve report - A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. + A single report can be retrieved using this endpoint with the corresponding unique identifier. - :param workflow_run_id: The unique identifier of the Workflow Run. (required) - :type workflow_run_id: str + :param report_id: (required) + :type report_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 @@ -10923,8 +10957,8 @@ def find_workflow_run_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._find_workflow_run_serialize( - workflow_run_id=workflow_run_id, + _param = self._find_report_serialize( + report_id=report_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10932,7 +10966,7 @@ def find_workflow_run_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WorkflowRun", + '200': "Report", } response_data = self.api_client.call_api( *_param, @@ -10941,9 +10975,9 @@ def find_workflow_run_without_preload_content( return response_data.response - def _find_workflow_run_serialize( + def _find_report_serialize( self, - workflow_run_id, + report_id, _request_auth, _content_type, _headers, @@ -10965,8 +10999,8 @@ def _find_workflow_run_serialize( _body_params: Optional[bytes] = None # process the path parameters - if workflow_run_id is not None: - _path_params['workflow_run_id'] = workflow_run_id + if report_id is not None: + _path_params['report_id'] = report_id # process the query parameters # process the header parameters # process the form parameters @@ -10989,7 +11023,7 @@ def _find_workflow_run_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/workflow_runs/{workflow_run_id}', + resource_path='/reports/{report_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -11006,9 +11040,9 @@ def _find_workflow_run_serialize( @validate_call - def force_report_creation_from_watchlist_monitor( + def find_signing_document( self, - monitor_id: StrictStr, + signing_document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11021,13 +11055,13 @@ def force_report_creation_from_watchlist_monitor( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Force new report creation (BETA) + ) -> SigningDocument: + """Retrieve signing document - Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update. + A single signing document can be retrieved by calling this endpoint with the signing document's unique identifier. - :param monitor_id: (required) - :type monitor_id: str + :param signing_document_id: (required) + :type signing_document_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 @@ -11050,8 +11084,8 @@ def force_report_creation_from_watchlist_monitor( :return: Returns the result object. """ # noqa: E501 - _param = self._force_report_creation_from_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._find_signing_document_serialize( + signing_document_id=signing_document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11059,7 +11093,7 @@ def force_report_creation_from_watchlist_monitor( ) _response_types_map: Dict[str, Optional[str]] = { - '201': None, + '200': "SigningDocument", } response_data = self.api_client.call_api( *_param, @@ -11073,9 +11107,9 @@ def force_report_creation_from_watchlist_monitor( @validate_call - def force_report_creation_from_watchlist_monitor_with_http_info( + def find_signing_document_with_http_info( self, - monitor_id: StrictStr, + signing_document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11088,13 +11122,13 @@ def force_report_creation_from_watchlist_monitor_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Force new report creation (BETA) + ) -> ApiResponse[SigningDocument]: + """Retrieve signing document - Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update. + A single signing document can be retrieved by calling this endpoint with the signing document's unique identifier. - :param monitor_id: (required) - :type monitor_id: str + :param signing_document_id: (required) + :type signing_document_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 @@ -11117,8 +11151,8 @@ def force_report_creation_from_watchlist_monitor_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._force_report_creation_from_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._find_signing_document_serialize( + signing_document_id=signing_document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11126,7 +11160,7 @@ def force_report_creation_from_watchlist_monitor_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '201': None, + '200': "SigningDocument", } response_data = self.api_client.call_api( *_param, @@ -11140,9 +11174,9 @@ def force_report_creation_from_watchlist_monitor_with_http_info( @validate_call - def force_report_creation_from_watchlist_monitor_without_preload_content( + def find_signing_document_without_preload_content( self, - monitor_id: StrictStr, + signing_document_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11156,12 +11190,12 @@ def force_report_creation_from_watchlist_monitor_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Force new report creation (BETA) + """Retrieve signing document - Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update. + A single signing document can be retrieved by calling this endpoint with the signing document's unique identifier. - :param monitor_id: (required) - :type monitor_id: str + :param signing_document_id: (required) + :type signing_document_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 @@ -11184,8 +11218,8 @@ def force_report_creation_from_watchlist_monitor_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._force_report_creation_from_watchlist_monitor_serialize( - monitor_id=monitor_id, + _param = self._find_signing_document_serialize( + signing_document_id=signing_document_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11193,7 +11227,7 @@ def force_report_creation_from_watchlist_monitor_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '201': None, + '200': "SigningDocument", } response_data = self.api_client.call_api( *_param, @@ -11202,9 +11236,9 @@ def force_report_creation_from_watchlist_monitor_without_preload_content( return response_data.response - def _force_report_creation_from_watchlist_monitor_serialize( + def _find_signing_document_serialize( self, - monitor_id, + signing_document_id, _request_auth, _content_type, _headers, @@ -11226,8 +11260,8 @@ def _force_report_creation_from_watchlist_monitor_serialize( _body_params: Optional[bytes] = None # process the path parameters - if monitor_id is not None: - _path_params['monitor_id'] = monitor_id + if signing_document_id is not None: + _path_params['signing_document_id'] = signing_document_id # process the query parameters # process the header parameters # process the form parameters @@ -11249,8 +11283,8 @@ def _force_report_creation_from_watchlist_monitor_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/watchlist_monitors/{monitor_id}/new_report', + method='GET', + resource_path='/signing_documents/{signing_document_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -11267,9 +11301,10 @@ def _force_report_creation_from_watchlist_monitor_serialize( @validate_call - def generate_sdk_token( + def find_task( self, - sdk_token_builder: SdkTokenBuilder, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Task belongs.")], + task_id: Annotated[StrictStr, Field(description="The identifier of the Task you want to retrieve.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11282,13 +11317,15 @@ def generate_sdk_token( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> SdkToken: - """Generate a SDK token + ) -> Task: + """Retrieve Task - Generates an SDK token. Returns a token object containing the SDK token. + A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. - :param sdk_token_builder: (required) - :type sdk_token_builder: SdkTokenBuilder + :param workflow_run_id: The unique identifier of the Workflow Run to which the Task belongs. (required) + :type workflow_run_id: str + :param task_id: The identifier of the Task you want to retrieve. (required) + :type task_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 @@ -11311,8 +11348,9 @@ def generate_sdk_token( :return: Returns the result object. """ # noqa: E501 - _param = self._generate_sdk_token_serialize( - sdk_token_builder=sdk_token_builder, + _param = self._find_task_serialize( + workflow_run_id=workflow_run_id, + task_id=task_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11320,7 +11358,7 @@ def generate_sdk_token( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SdkToken", + '200': "Task", } response_data = self.api_client.call_api( *_param, @@ -11334,9 +11372,10 @@ def generate_sdk_token( @validate_call - def generate_sdk_token_with_http_info( + def find_task_with_http_info( self, - sdk_token_builder: SdkTokenBuilder, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Task belongs.")], + task_id: Annotated[StrictStr, Field(description="The identifier of the Task you want to retrieve.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11349,13 +11388,15 @@ def generate_sdk_token_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[SdkToken]: - """Generate a SDK token + ) -> ApiResponse[Task]: + """Retrieve Task - Generates an SDK token. Returns a token object containing the SDK token. + A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. - :param sdk_token_builder: (required) - :type sdk_token_builder: SdkTokenBuilder + :param workflow_run_id: The unique identifier of the Workflow Run to which the Task belongs. (required) + :type workflow_run_id: str + :param task_id: The identifier of the Task you want to retrieve. (required) + :type task_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 @@ -11378,8 +11419,9 @@ def generate_sdk_token_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._generate_sdk_token_serialize( - sdk_token_builder=sdk_token_builder, + _param = self._find_task_serialize( + workflow_run_id=workflow_run_id, + task_id=task_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11387,7 +11429,7 @@ def generate_sdk_token_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SdkToken", + '200': "Task", } response_data = self.api_client.call_api( *_param, @@ -11401,9 +11443,10 @@ def generate_sdk_token_with_http_info( @validate_call - def generate_sdk_token_without_preload_content( + def find_task_without_preload_content( self, - sdk_token_builder: SdkTokenBuilder, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Task belongs.")], + task_id: Annotated[StrictStr, Field(description="The identifier of the Task you want to retrieve.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11417,12 +11460,14 @@ def generate_sdk_token_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Generate a SDK token + """Retrieve Task - Generates an SDK token. Returns a token object containing the SDK token. + A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. - :param sdk_token_builder: (required) - :type sdk_token_builder: SdkTokenBuilder + :param workflow_run_id: The unique identifier of the Workflow Run to which the Task belongs. (required) + :type workflow_run_id: str + :param task_id: The identifier of the Task you want to retrieve. (required) + :type task_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 @@ -11445,8 +11490,9 @@ def generate_sdk_token_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._generate_sdk_token_serialize( - sdk_token_builder=sdk_token_builder, + _param = self._find_task_serialize( + workflow_run_id=workflow_run_id, + task_id=task_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11454,7 +11500,7 @@ def generate_sdk_token_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "SdkToken", + '200': "Task", } response_data = self.api_client.call_api( *_param, @@ -11463,9 +11509,10 @@ def generate_sdk_token_without_preload_content( return response_data.response - def _generate_sdk_token_serialize( + def _find_task_serialize( self, - sdk_token_builder, + workflow_run_id, + task_id, _request_auth, _content_type, _headers, @@ -11487,12 +11534,14 @@ def _generate_sdk_token_serialize( _body_params: Optional[bytes] = None # process the path parameters + if workflow_run_id is not None: + _path_params['workflow_run_id'] = workflow_run_id + if task_id is not None: + _path_params['task_id'] = task_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if sdk_token_builder is not None: - _body_params = sdk_token_builder # set the HTTP header `Accept` @@ -11503,19 +11552,6 @@ def _generate_sdk_token_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -11523,8 +11559,8 @@ def _generate_sdk_token_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/sdk_token', + method='GET', + resource_path='/workflow_runs/{workflow_run_id}/tasks/{task_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -11541,11 +11577,10 @@ def _generate_sdk_token_serialize( @validate_call - def list_applicants( + def find_timeline_file( self, - page: Annotated[Optional[StrictInt], Field(description="The page to return. The first page is `page=1`")] = None, - per_page: Annotated[Optional[StrictInt], Field(description="The number of objects per page.")] = None, - include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include applicants scheduled for deletion.")] = None, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], + timeline_file_id: Annotated[StrictStr, Field(description="The unique identifier for the Timefile File.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11558,17 +11593,15 @@ def list_applicants( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApplicantsList: - """List Applicants + ) -> bytearray: + """Retrieve Timeline File for Workflow Run - Lists all applicants you've created, sorted by creation date in descending order. + Retrieves the Timeline File for the designated Workflow Run. - :param page: The page to return. The first page is `page=1` - :type page: int - :param per_page: The number of objects per page. - :type per_page: int - :param include_deleted: Whether to also include applicants scheduled for deletion. - :type include_deleted: bool + :param workflow_run_id: The unique identifier of the Workflow Run. (required) + :type workflow_run_id: str + :param timeline_file_id: The unique identifier for the Timefile File. (required) + :type timeline_file_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 @@ -11591,10 +11624,9 @@ def list_applicants( :return: Returns the result object. """ # noqa: E501 - _param = self._list_applicants_serialize( - page=page, - per_page=per_page, - include_deleted=include_deleted, + _param = self._find_timeline_file_serialize( + workflow_run_id=workflow_run_id, + timeline_file_id=timeline_file_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11602,7 +11634,8 @@ def list_applicants( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ApplicantsList", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -11616,11 +11649,10 @@ def list_applicants( @validate_call - def list_applicants_with_http_info( + def find_timeline_file_with_http_info( self, - page: Annotated[Optional[StrictInt], Field(description="The page to return. The first page is `page=1`")] = None, - per_page: Annotated[Optional[StrictInt], Field(description="The number of objects per page.")] = None, - include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include applicants scheduled for deletion.")] = None, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], + timeline_file_id: Annotated[StrictStr, Field(description="The unique identifier for the Timefile File.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11633,17 +11665,15 @@ def list_applicants_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ApplicantsList]: - """List Applicants + ) -> ApiResponse[bytearray]: + """Retrieve Timeline File for Workflow Run - Lists all applicants you've created, sorted by creation date in descending order. + Retrieves the Timeline File for the designated Workflow Run. - :param page: The page to return. The first page is `page=1` - :type page: int - :param per_page: The number of objects per page. - :type per_page: int - :param include_deleted: Whether to also include applicants scheduled for deletion. - :type include_deleted: bool + :param workflow_run_id: The unique identifier of the Workflow Run. (required) + :type workflow_run_id: str + :param timeline_file_id: The unique identifier for the Timefile File. (required) + :type timeline_file_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 @@ -11666,10 +11696,9 @@ def list_applicants_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_applicants_serialize( - page=page, - per_page=per_page, - include_deleted=include_deleted, + _param = self._find_timeline_file_serialize( + workflow_run_id=workflow_run_id, + timeline_file_id=timeline_file_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11677,7 +11706,8 @@ def list_applicants_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ApplicantsList", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -11691,11 +11721,10 @@ def list_applicants_with_http_info( @validate_call - def list_applicants_without_preload_content( + def find_timeline_file_without_preload_content( self, - page: Annotated[Optional[StrictInt], Field(description="The page to return. The first page is `page=1`")] = None, - per_page: Annotated[Optional[StrictInt], Field(description="The number of objects per page.")] = None, - include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include applicants scheduled for deletion.")] = None, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], + timeline_file_id: Annotated[StrictStr, Field(description="The unique identifier for the Timefile File.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11709,16 +11738,14 @@ def list_applicants_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List Applicants + """Retrieve Timeline File for Workflow Run - Lists all applicants you've created, sorted by creation date in descending order. + Retrieves the Timeline File for the designated Workflow Run. - :param page: The page to return. The first page is `page=1` - :type page: int - :param per_page: The number of objects per page. - :type per_page: int - :param include_deleted: Whether to also include applicants scheduled for deletion. - :type include_deleted: bool + :param workflow_run_id: The unique identifier of the Workflow Run. (required) + :type workflow_run_id: str + :param timeline_file_id: The unique identifier for the Timefile File. (required) + :type timeline_file_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 @@ -11741,10 +11768,9 @@ def list_applicants_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_applicants_serialize( - page=page, - per_page=per_page, - include_deleted=include_deleted, + _param = self._find_timeline_file_serialize( + workflow_run_id=workflow_run_id, + timeline_file_id=timeline_file_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11752,7 +11778,8 @@ def list_applicants_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ApplicantsList", + '302': None, + '200': "bytearray", } response_data = self.api_client.call_api( *_param, @@ -11761,11 +11788,10 @@ def list_applicants_without_preload_content( return response_data.response - def _list_applicants_serialize( + def _find_timeline_file_serialize( self, - page, - per_page, - include_deleted, + workflow_run_id, + timeline_file_id, _request_auth, _content_type, _headers, @@ -11787,19 +11813,11 @@ def _list_applicants_serialize( _body_params: Optional[bytes] = None # process the path parameters + if workflow_run_id is not None: + _path_params['workflow_run_id'] = workflow_run_id + if timeline_file_id is not None: + _path_params['timeline_file_id'] = timeline_file_id # process the query parameters - if page is not None: - - _query_params.append(('page', page)) - - if per_page is not None: - - _query_params.append(('per_page', per_page)) - - if include_deleted is not None: - - _query_params.append(('include_deleted', include_deleted)) - # process the header parameters # process the form parameters # process the body parameter @@ -11809,6 +11827,7 @@ def _list_applicants_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ + 'application/pdf', 'application/json' ] ) @@ -11821,7 +11840,7 @@ def _list_applicants_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/applicants', + resource_path='/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -11838,9 +11857,9 @@ def _list_applicants_serialize( @validate_call - def list_checks( + def find_watchlist_monitor( self, - applicant_id: StrictStr, + monitor_id: Annotated[StrictStr, Field(description="The watchlist monitor's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11853,13 +11872,13 @@ def list_checks( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ChecksList: - """Retrieve Checks + ) -> WatchlistMonitor: + """Retrieve monitor - Retrieves a single check. Returns a check object. + Retrieves a single monitor - :param applicant_id: (required) - :type applicant_id: str + :param monitor_id: The watchlist monitor's unique identifier. (required) + :type monitor_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 @@ -11882,8 +11901,8 @@ def list_checks( :return: Returns the result object. """ # noqa: E501 - _param = self._list_checks_serialize( - applicant_id=applicant_id, + _param = self._find_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11891,7 +11910,7 @@ def list_checks( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ChecksList", + '200': "WatchlistMonitor", } response_data = self.api_client.call_api( *_param, @@ -11905,9 +11924,9 @@ def list_checks( @validate_call - def list_checks_with_http_info( + def find_watchlist_monitor_with_http_info( self, - applicant_id: StrictStr, + monitor_id: Annotated[StrictStr, Field(description="The watchlist monitor's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11920,13 +11939,13 @@ def list_checks_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ChecksList]: - """Retrieve Checks + ) -> ApiResponse[WatchlistMonitor]: + """Retrieve monitor - Retrieves a single check. Returns a check object. + Retrieves a single monitor - :param applicant_id: (required) - :type applicant_id: str + :param monitor_id: The watchlist monitor's unique identifier. (required) + :type monitor_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 @@ -11949,8 +11968,8 @@ def list_checks_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_checks_serialize( - applicant_id=applicant_id, + _param = self._find_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -11958,7 +11977,7 @@ def list_checks_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ChecksList", + '200': "WatchlistMonitor", } response_data = self.api_client.call_api( *_param, @@ -11972,9 +11991,9 @@ def list_checks_with_http_info( @validate_call - def list_checks_without_preload_content( + def find_watchlist_monitor_without_preload_content( self, - applicant_id: StrictStr, + monitor_id: Annotated[StrictStr, Field(description="The watchlist monitor's unique identifier.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11988,12 +12007,12 @@ def list_checks_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve Checks + """Retrieve monitor - Retrieves a single check. Returns a check object. + Retrieves a single monitor - :param applicant_id: (required) - :type applicant_id: str + :param monitor_id: The watchlist monitor's unique identifier. (required) + :type monitor_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 @@ -12016,8 +12035,8 @@ def list_checks_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_checks_serialize( - applicant_id=applicant_id, + _param = self._find_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12025,7 +12044,7 @@ def list_checks_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ChecksList", + '200': "WatchlistMonitor", } response_data = self.api_client.call_api( *_param, @@ -12034,9 +12053,9 @@ def list_checks_without_preload_content( return response_data.response - def _list_checks_serialize( + def _find_watchlist_monitor_serialize( self, - applicant_id, + monitor_id, _request_auth, _content_type, _headers, @@ -12058,11 +12077,9 @@ def _list_checks_serialize( _body_params: Optional[bytes] = None # process the path parameters + if monitor_id is not None: + _path_params['monitor_id'] = monitor_id # process the query parameters - if applicant_id is not None: - - _query_params.append(('applicant_id', applicant_id)) - # process the header parameters # process the form parameters # process the body parameter @@ -12084,7 +12101,7 @@ def _list_checks_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/checks', + resource_path='/watchlist_monitors/{monitor_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -12101,9 +12118,9 @@ def _list_checks_serialize( @validate_call - def list_documents( + def find_webhook( self, - applicant_id: StrictStr, + webhook_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12116,13 +12133,13 @@ def list_documents( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> DocumentsList: - """List documents + ) -> Webhook: + """Retrieve a Webhook - All documents belonging to an applicant can be listed from this endpoint + Retrieves a single webhook. Returns a webhook object. - :param applicant_id: (required) - :type applicant_id: str + :param webhook_id: (required) + :type webhook_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 @@ -12145,8 +12162,8 @@ def list_documents( :return: Returns the result object. """ # noqa: E501 - _param = self._list_documents_serialize( - applicant_id=applicant_id, + _param = self._find_webhook_serialize( + webhook_id=webhook_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12154,7 +12171,7 @@ def list_documents( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "DocumentsList", + '200': "Webhook", } response_data = self.api_client.call_api( *_param, @@ -12168,9 +12185,9 @@ def list_documents( @validate_call - def list_documents_with_http_info( + def find_webhook_with_http_info( self, - applicant_id: StrictStr, + webhook_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12183,13 +12200,13 @@ def list_documents_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[DocumentsList]: - """List documents + ) -> ApiResponse[Webhook]: + """Retrieve a Webhook - All documents belonging to an applicant can be listed from this endpoint + Retrieves a single webhook. Returns a webhook object. - :param applicant_id: (required) - :type applicant_id: str + :param webhook_id: (required) + :type webhook_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 @@ -12212,8 +12229,8 @@ def list_documents_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_documents_serialize( - applicant_id=applicant_id, + _param = self._find_webhook_serialize( + webhook_id=webhook_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12221,7 +12238,7 @@ def list_documents_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "DocumentsList", + '200': "Webhook", } response_data = self.api_client.call_api( *_param, @@ -12235,9 +12252,9 @@ def list_documents_with_http_info( @validate_call - def list_documents_without_preload_content( + def find_webhook_without_preload_content( self, - applicant_id: StrictStr, + webhook_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12251,12 +12268,12 @@ def list_documents_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List documents + """Retrieve a Webhook - All documents belonging to an applicant can be listed from this endpoint + Retrieves a single webhook. Returns a webhook object. - :param applicant_id: (required) - :type applicant_id: str + :param webhook_id: (required) + :type webhook_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 @@ -12279,8 +12296,8 @@ def list_documents_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_documents_serialize( - applicant_id=applicant_id, + _param = self._find_webhook_serialize( + webhook_id=webhook_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12288,7 +12305,7 @@ def list_documents_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "DocumentsList", + '200': "Webhook", } response_data = self.api_client.call_api( *_param, @@ -12297,9 +12314,9 @@ def list_documents_without_preload_content( return response_data.response - def _list_documents_serialize( + def _find_webhook_serialize( self, - applicant_id, + webhook_id, _request_auth, _content_type, _headers, @@ -12321,11 +12338,9 @@ def _list_documents_serialize( _body_params: Optional[bytes] = None # process the path parameters + if webhook_id is not None: + _path_params['webhook_id'] = webhook_id # process the query parameters - if applicant_id is not None: - - _query_params.append(('applicant_id', applicant_id)) - # process the header parameters # process the form parameters # process the body parameter @@ -12347,7 +12362,7 @@ def _list_documents_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/documents', + resource_path='/webhooks/{webhook_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -12364,9 +12379,9 @@ def _list_documents_serialize( @validate_call - def list_id_photos( + def find_workflow_run( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the ID photos belong to.")], + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12379,13 +12394,13 @@ def list_id_photos( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> IdPhotosList: - """List ID photos + ) -> WorkflowRun: + """Retrieve Workflow Run - Lists the ID photos that belong to an applicant. + A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. - :param applicant_id: The id of the applicant the ID photos belong to. (required) - :type applicant_id: str + :param workflow_run_id: The unique identifier of the Workflow Run. (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 @@ -12408,8 +12423,8 @@ def list_id_photos( :return: Returns the result object. """ # noqa: E501 - _param = self._list_id_photos_serialize( - applicant_id=applicant_id, + _param = self._find_workflow_run_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12417,7 +12432,7 @@ def list_id_photos( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "IdPhotosList", + '200': "WorkflowRun", } response_data = self.api_client.call_api( *_param, @@ -12431,9 +12446,9 @@ def list_id_photos( @validate_call - def list_id_photos_with_http_info( + def find_workflow_run_with_http_info( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the ID photos belong to.")], + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12446,13 +12461,13 @@ def list_id_photos_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[IdPhotosList]: - """List ID photos + ) -> ApiResponse[WorkflowRun]: + """Retrieve Workflow Run - Lists the ID photos that belong to an applicant. + A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. - :param applicant_id: The id of the applicant the ID photos belong to. (required) - :type applicant_id: str + :param workflow_run_id: The unique identifier of the Workflow Run. (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 @@ -12475,8 +12490,8 @@ def list_id_photos_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_id_photos_serialize( - applicant_id=applicant_id, + _param = self._find_workflow_run_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12484,7 +12499,7 @@ def list_id_photos_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "IdPhotosList", + '200': "WorkflowRun", } response_data = self.api_client.call_api( *_param, @@ -12498,9 +12513,9 @@ def list_id_photos_with_http_info( @validate_call - def list_id_photos_without_preload_content( + def find_workflow_run_without_preload_content( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the ID photos belong to.")], + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12514,12 +12529,12 @@ def list_id_photos_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List ID photos + """Retrieve Workflow Run - Lists the ID photos that belong to an applicant. + A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. - :param applicant_id: The id of the applicant the ID photos belong to. (required) - :type applicant_id: str + :param workflow_run_id: The unique identifier of the Workflow Run. (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 @@ -12542,8 +12557,8 @@ def list_id_photos_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_id_photos_serialize( - applicant_id=applicant_id, + _param = self._find_workflow_run_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12551,7 +12566,7 @@ def list_id_photos_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "IdPhotosList", + '200': "WorkflowRun", } response_data = self.api_client.call_api( *_param, @@ -12560,9 +12575,9 @@ def list_id_photos_without_preload_content( return response_data.response - def _list_id_photos_serialize( + def _find_workflow_run_serialize( self, - applicant_id, + workflow_run_id, _request_auth, _content_type, _headers, @@ -12584,11 +12599,9 @@ def _list_id_photos_serialize( _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 - if applicant_id is not None: - - _query_params.append(('applicant_id', applicant_id)) - # process the header parameters # process the form parameters # process the body parameter @@ -12610,7 +12623,7 @@ def _list_id_photos_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/id_photos', + resource_path='/workflow_runs/{workflow_run_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -12627,9 +12640,9 @@ def _list_id_photos_serialize( @validate_call - def list_live_photos( + def force_report_creation_from_watchlist_monitor( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live photos belong to.")], + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12642,13 +12655,13 @@ def list_live_photos( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LivePhotosList: - """List live photos + ) -> None: + """Force new report creation (BETA) - Lists the live photos that belong to an applicant. + Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update. - :param applicant_id: The id of the applicant the live photos belong to. (required) - :type applicant_id: str + :param monitor_id: (required) + :type monitor_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 @@ -12671,8 +12684,8 @@ def list_live_photos( :return: Returns the result object. """ # noqa: E501 - _param = self._list_live_photos_serialize( - applicant_id=applicant_id, + _param = self._force_report_creation_from_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12680,7 +12693,7 @@ def list_live_photos( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LivePhotosList", + '201': None, } response_data = self.api_client.call_api( *_param, @@ -12694,9 +12707,9 @@ def list_live_photos( @validate_call - def list_live_photos_with_http_info( + def force_report_creation_from_watchlist_monitor_with_http_info( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live photos belong to.")], + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12709,13 +12722,13 @@ def list_live_photos_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LivePhotosList]: - """List live photos + ) -> ApiResponse[None]: + """Force new report creation (BETA) - Lists the live photos that belong to an applicant. + Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update. - :param applicant_id: The id of the applicant the live photos belong to. (required) - :type applicant_id: str + :param monitor_id: (required) + :type monitor_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 @@ -12738,8 +12751,8 @@ def list_live_photos_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_live_photos_serialize( - applicant_id=applicant_id, + _param = self._force_report_creation_from_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12747,7 +12760,7 @@ def list_live_photos_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LivePhotosList", + '201': None, } response_data = self.api_client.call_api( *_param, @@ -12761,9 +12774,9 @@ def list_live_photos_with_http_info( @validate_call - def list_live_photos_without_preload_content( + def force_report_creation_from_watchlist_monitor_without_preload_content( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live photos belong to.")], + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12777,12 +12790,12 @@ def list_live_photos_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List live photos + """Force new report creation (BETA) - Lists the live photos that belong to an applicant. + Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update. - :param applicant_id: The id of the applicant the live photos belong to. (required) - :type applicant_id: str + :param monitor_id: (required) + :type monitor_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 @@ -12805,8 +12818,8 @@ def list_live_photos_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_live_photos_serialize( - applicant_id=applicant_id, + _param = self._force_report_creation_from_watchlist_monitor_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12814,7 +12827,7 @@ def list_live_photos_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LivePhotosList", + '201': None, } response_data = self.api_client.call_api( *_param, @@ -12823,9 +12836,9 @@ def list_live_photos_without_preload_content( return response_data.response - def _list_live_photos_serialize( + def _force_report_creation_from_watchlist_monitor_serialize( self, - applicant_id, + monitor_id, _request_auth, _content_type, _headers, @@ -12847,11 +12860,9 @@ def _list_live_photos_serialize( _body_params: Optional[bytes] = None # process the path parameters + if monitor_id is not None: + _path_params['monitor_id'] = monitor_id # process the query parameters - if applicant_id is not None: - - _query_params.append(('applicant_id', applicant_id)) - # process the header parameters # process the form parameters # process the body parameter @@ -12872,8 +12883,8 @@ def _list_live_photos_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/live_photos', + method='POST', + resource_path='/watchlist_monitors/{monitor_id}/new_report', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -12890,9 +12901,9 @@ def _list_live_photos_serialize( @validate_call - def list_live_videos( + def generate_sdk_token( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live videos belong to.")], + sdk_token_builder: SdkTokenBuilder, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12905,13 +12916,13 @@ def list_live_videos( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LiveVideosList: - """List live videos + ) -> SdkToken: + """Generate a SDK token - Lists all the live videos that belong to an applicant. + Generates an SDK token. Returns a token object containing the SDK token. - :param applicant_id: The id of the applicant the live videos belong to. (required) - :type applicant_id: str + :param sdk_token_builder: (required) + :type sdk_token_builder: SdkTokenBuilder :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 @@ -12934,8 +12945,8 @@ def list_live_videos( :return: Returns the result object. """ # noqa: E501 - _param = self._list_live_videos_serialize( - applicant_id=applicant_id, + _param = self._generate_sdk_token_serialize( + sdk_token_builder=sdk_token_builder, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -12943,7 +12954,7 @@ def list_live_videos( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LiveVideosList", + '200': "SdkToken", } response_data = self.api_client.call_api( *_param, @@ -12957,9 +12968,9 @@ def list_live_videos( @validate_call - def list_live_videos_with_http_info( + def generate_sdk_token_with_http_info( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live videos belong to.")], + sdk_token_builder: SdkTokenBuilder, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12972,13 +12983,13 @@ def list_live_videos_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LiveVideosList]: - """List live videos + ) -> ApiResponse[SdkToken]: + """Generate a SDK token - Lists all the live videos that belong to an applicant. + Generates an SDK token. Returns a token object containing the SDK token. - :param applicant_id: The id of the applicant the live videos belong to. (required) - :type applicant_id: str + :param sdk_token_builder: (required) + :type sdk_token_builder: SdkTokenBuilder :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 @@ -13001,8 +13012,8 @@ def list_live_videos_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_live_videos_serialize( - applicant_id=applicant_id, + _param = self._generate_sdk_token_serialize( + sdk_token_builder=sdk_token_builder, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13010,7 +13021,7 @@ def list_live_videos_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LiveVideosList", + '200': "SdkToken", } response_data = self.api_client.call_api( *_param, @@ -13024,9 +13035,9 @@ def list_live_videos_with_http_info( @validate_call - def list_live_videos_without_preload_content( + def generate_sdk_token_without_preload_content( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live videos belong to.")], + sdk_token_builder: SdkTokenBuilder, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13040,12 +13051,12 @@ def list_live_videos_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List live videos + """Generate a SDK token - Lists all the live videos that belong to an applicant. + Generates an SDK token. Returns a token object containing the SDK token. - :param applicant_id: The id of the applicant the live videos belong to. (required) - :type applicant_id: str + :param sdk_token_builder: (required) + :type sdk_token_builder: SdkTokenBuilder :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 @@ -13068,8 +13079,8 @@ def list_live_videos_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_live_videos_serialize( - applicant_id=applicant_id, + _param = self._generate_sdk_token_serialize( + sdk_token_builder=sdk_token_builder, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13077,7 +13088,7 @@ def list_live_videos_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "LiveVideosList", + '200': "SdkToken", } response_data = self.api_client.call_api( *_param, @@ -13086,9 +13097,9 @@ def list_live_videos_without_preload_content( return response_data.response - def _list_live_videos_serialize( + def _generate_sdk_token_serialize( self, - applicant_id, + sdk_token_builder, _request_auth, _content_type, _headers, @@ -13111,13 +13122,11 @@ def _list_live_videos_serialize( # process the path parameters # process the query parameters - if applicant_id is not None: - - _query_params.append(('applicant_id', applicant_id)) - # process the header parameters # process the form parameters # process the body parameter + if sdk_token_builder is not None: + _body_params = sdk_token_builder # set the HTTP header `Accept` @@ -13128,6 +13137,19 @@ def _list_live_videos_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -13135,8 +13157,8 @@ def _list_live_videos_serialize( ] return self.api_client.param_serialize( - method='GET', - resource_path='/live_videos', + method='POST', + resource_path='/sdk_token', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -13153,9 +13175,11 @@ def _list_live_videos_serialize( @validate_call - def list_motion_captures( + def list_applicants( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the motion captures belong to.")], + page: Annotated[Optional[StrictInt], Field(description="The page to return. The first page is `page=1`")] = None, + per_page: Annotated[Optional[StrictInt], Field(description="The number of objects per page.")] = None, + include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include applicants scheduled for deletion.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13168,13 +13192,17 @@ def list_motion_captures( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> MotionCapturesList: - """List motion captures + ) -> ApplicantsList: + """List Applicants - Lists all the motion captures that belong to an applicant. + Lists all applicants you've created, sorted by creation date in descending order. - :param applicant_id: The id of the applicant the motion captures belong to. (required) - :type applicant_id: str + :param page: The page to return. The first page is `page=1` + :type page: int + :param per_page: The number of objects per page. + :type per_page: int + :param include_deleted: Whether to also include applicants scheduled for deletion. + :type include_deleted: bool :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 @@ -13197,8 +13225,10 @@ def list_motion_captures( :return: Returns the result object. """ # noqa: E501 - _param = self._list_motion_captures_serialize( - applicant_id=applicant_id, + _param = self._list_applicants_serialize( + page=page, + per_page=per_page, + include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13206,7 +13236,7 @@ def list_motion_captures( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MotionCapturesList", + '200': "ApplicantsList", } response_data = self.api_client.call_api( *_param, @@ -13220,9 +13250,11 @@ def list_motion_captures( @validate_call - def list_motion_captures_with_http_info( + def list_applicants_with_http_info( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the motion captures belong to.")], + page: Annotated[Optional[StrictInt], Field(description="The page to return. The first page is `page=1`")] = None, + per_page: Annotated[Optional[StrictInt], Field(description="The number of objects per page.")] = None, + include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include applicants scheduled for deletion.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13235,13 +13267,17 @@ def list_motion_captures_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[MotionCapturesList]: - """List motion captures + ) -> ApiResponse[ApplicantsList]: + """List Applicants - Lists all the motion captures that belong to an applicant. + Lists all applicants you've created, sorted by creation date in descending order. - :param applicant_id: The id of the applicant the motion captures belong to. (required) - :type applicant_id: str + :param page: The page to return. The first page is `page=1` + :type page: int + :param per_page: The number of objects per page. + :type per_page: int + :param include_deleted: Whether to also include applicants scheduled for deletion. + :type include_deleted: bool :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 @@ -13264,8 +13300,10 @@ def list_motion_captures_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_motion_captures_serialize( - applicant_id=applicant_id, + _param = self._list_applicants_serialize( + page=page, + per_page=per_page, + include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13273,7 +13311,7 @@ def list_motion_captures_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MotionCapturesList", + '200': "ApplicantsList", } response_data = self.api_client.call_api( *_param, @@ -13287,9 +13325,11 @@ def list_motion_captures_with_http_info( @validate_call - def list_motion_captures_without_preload_content( + def list_applicants_without_preload_content( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the motion captures belong to.")], + page: Annotated[Optional[StrictInt], Field(description="The page to return. The first page is `page=1`")] = None, + per_page: Annotated[Optional[StrictInt], Field(description="The number of objects per page.")] = None, + include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include applicants scheduled for deletion.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13303,17 +13343,21 @@ def list_motion_captures_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List motion captures + """List Applicants - Lists all the motion captures that belong to an applicant. + Lists all applicants you've created, sorted by creation date in descending order. - :param applicant_id: The id of the applicant the motion captures belong to. (required) - :type applicant_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 page: The page to return. The first page is `page=1` + :type page: int + :param per_page: The number of objects per page. + :type per_page: int + :param include_deleted: Whether to also include applicants scheduled for deletion. + :type include_deleted: bool + :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. @@ -13331,8 +13375,10 @@ def list_motion_captures_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_motion_captures_serialize( - applicant_id=applicant_id, + _param = self._list_applicants_serialize( + page=page, + per_page=per_page, + include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13340,7 +13386,7 @@ def list_motion_captures_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "MotionCapturesList", + '200': "ApplicantsList", } response_data = self.api_client.call_api( *_param, @@ -13349,9 +13395,11 @@ def list_motion_captures_without_preload_content( return response_data.response - def _list_motion_captures_serialize( + def _list_applicants_serialize( self, - applicant_id, + page, + per_page, + include_deleted, _request_auth, _content_type, _headers, @@ -13374,9 +13422,17 @@ def _list_motion_captures_serialize( # process the path parameters # process the query parameters - if applicant_id is not None: + if page is not None: - _query_params.append(('applicant_id', applicant_id)) + _query_params.append(('page', page)) + + if per_page is not None: + + _query_params.append(('per_page', per_page)) + + if include_deleted is not None: + + _query_params.append(('include_deleted', include_deleted)) # process the header parameters # process the form parameters @@ -13399,7 +13455,7 @@ def _list_motion_captures_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/motion_captures', + resource_path='/applicants', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -13416,9 +13472,9 @@ def _list_motion_captures_serialize( @validate_call - def list_repeat_attempts( + def list_checks( self, - report_id: StrictStr, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13431,13 +13487,13 @@ def list_repeat_attempts( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> RepeatAttemptsList: - """Retrieve repeat attempts + ) -> ChecksList: + """Retrieve Checks - Returns all repeat attempts for a given Document report + Retrieves a single check. Returns a check object. - :param report_id: (required) - :type report_id: str + :param applicant_id: (required) + :type applicant_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 @@ -13460,8 +13516,8 @@ def list_repeat_attempts( :return: Returns the result object. """ # noqa: E501 - _param = self._list_repeat_attempts_serialize( - report_id=report_id, + _param = self._list_checks_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13469,7 +13525,7 @@ def list_repeat_attempts( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "RepeatAttemptsList", + '200': "ChecksList", } response_data = self.api_client.call_api( *_param, @@ -13483,9 +13539,9 @@ def list_repeat_attempts( @validate_call - def list_repeat_attempts_with_http_info( + def list_checks_with_http_info( self, - report_id: StrictStr, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13498,13 +13554,13 @@ def list_repeat_attempts_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[RepeatAttemptsList]: - """Retrieve repeat attempts + ) -> ApiResponse[ChecksList]: + """Retrieve Checks - Returns all repeat attempts for a given Document report + Retrieves a single check. Returns a check object. - :param report_id: (required) - :type report_id: str + :param applicant_id: (required) + :type applicant_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 @@ -13527,8 +13583,8 @@ def list_repeat_attempts_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_repeat_attempts_serialize( - report_id=report_id, + _param = self._list_checks_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13536,7 +13592,7 @@ def list_repeat_attempts_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "RepeatAttemptsList", + '200': "ChecksList", } response_data = self.api_client.call_api( *_param, @@ -13550,9 +13606,9 @@ def list_repeat_attempts_with_http_info( @validate_call - def list_repeat_attempts_without_preload_content( + def list_checks_without_preload_content( self, - report_id: StrictStr, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13566,12 +13622,12 @@ def list_repeat_attempts_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Retrieve repeat attempts + """Retrieve Checks - Returns all repeat attempts for a given Document report + Retrieves a single check. Returns a check object. - :param report_id: (required) - :type report_id: str + :param applicant_id: (required) + :type applicant_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 @@ -13594,8 +13650,8 @@ def list_repeat_attempts_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_repeat_attempts_serialize( - report_id=report_id, + _param = self._list_checks_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13603,7 +13659,7 @@ def list_repeat_attempts_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "RepeatAttemptsList", + '200': "ChecksList", } response_data = self.api_client.call_api( *_param, @@ -13612,9 +13668,9 @@ def list_repeat_attempts_without_preload_content( return response_data.response - def _list_repeat_attempts_serialize( + def _list_checks_serialize( self, - report_id, + applicant_id, _request_auth, _content_type, _headers, @@ -13636,9 +13692,11 @@ def _list_repeat_attempts_serialize( _body_params: Optional[bytes] = None # process the path parameters - if report_id is not None: - _path_params['report_id'] = report_id # process the query parameters + if applicant_id is not None: + + _query_params.append(('applicant_id', applicant_id)) + # process the header parameters # process the form parameters # process the body parameter @@ -13660,7 +13718,7 @@ def _list_repeat_attempts_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/repeat_attempts/{report_id}', + resource_path='/checks', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -13677,9 +13735,9 @@ def _list_repeat_attempts_serialize( @validate_call - def list_reports( + def list_documents( self, - check_id: StrictStr, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13692,13 +13750,13 @@ def list_reports( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ReportsList: - """List reports + ) -> DocumentsList: + """List documents - All the reports belonging to a particular check can be listed from this endpoint. + All documents belonging to an applicant can be listed from this endpoint - :param check_id: (required) - :type check_id: str + :param applicant_id: (required) + :type applicant_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 @@ -13721,8 +13779,8 @@ def list_reports( :return: Returns the result object. """ # noqa: E501 - _param = self._list_reports_serialize( - check_id=check_id, + _param = self._list_documents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13730,7 +13788,7 @@ def list_reports( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ReportsList", + '200': "DocumentsList", } response_data = self.api_client.call_api( *_param, @@ -13744,9 +13802,9 @@ def list_reports( @validate_call - def list_reports_with_http_info( + def list_documents_with_http_info( self, - check_id: StrictStr, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13759,13 +13817,13 @@ def list_reports_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ReportsList]: - """List reports + ) -> ApiResponse[DocumentsList]: + """List documents - All the reports belonging to a particular check can be listed from this endpoint. + All documents belonging to an applicant can be listed from this endpoint - :param check_id: (required) - :type check_id: str + :param applicant_id: (required) + :type applicant_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 @@ -13788,8 +13846,8 @@ def list_reports_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_reports_serialize( - check_id=check_id, + _param = self._list_documents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13797,7 +13855,7 @@ def list_reports_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ReportsList", + '200': "DocumentsList", } response_data = self.api_client.call_api( *_param, @@ -13811,9 +13869,9 @@ def list_reports_with_http_info( @validate_call - def list_reports_without_preload_content( + def list_documents_without_preload_content( self, - check_id: StrictStr, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13827,12 +13885,12 @@ def list_reports_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List reports + """List documents - All the reports belonging to a particular check can be listed from this endpoint. + All documents belonging to an applicant can be listed from this endpoint - :param check_id: (required) - :type check_id: str + :param applicant_id: (required) + :type applicant_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 @@ -13855,8 +13913,8 @@ def list_reports_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_reports_serialize( - check_id=check_id, + _param = self._list_documents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13864,7 +13922,7 @@ def list_reports_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ReportsList", + '200': "DocumentsList", } response_data = self.api_client.call_api( *_param, @@ -13873,9 +13931,9 @@ def list_reports_without_preload_content( return response_data.response - def _list_reports_serialize( + def _list_documents_serialize( self, - check_id, + applicant_id, _request_auth, _content_type, _headers, @@ -13898,9 +13956,9 @@ def _list_reports_serialize( # process the path parameters # process the query parameters - if check_id is not None: + if applicant_id is not None: - _query_params.append(('check_id', check_id)) + _query_params.append(('applicant_id', applicant_id)) # process the header parameters # process the form parameters @@ -13923,7 +13981,7 @@ def _list_reports_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/reports', + resource_path='/documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -13940,9 +13998,9 @@ def _list_reports_serialize( @validate_call - def list_tasks( + def list_id_photos( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Tasks belong.")], + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the ID photos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -13955,13 +14013,13 @@ def list_tasks( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[TaskItem]: - """List Tasks + ) -> IdPhotosList: + """List ID photos - The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. + Lists the ID photos that belong to an applicant. - :param workflow_run_id: The unique identifier of the Workflow Run to which the Tasks belong. (required) - :type workflow_run_id: str + :param applicant_id: The id of the applicant the ID photos belong to. (required) + :type applicant_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 @@ -13984,8 +14042,8 @@ def list_tasks( :return: Returns the result object. """ # noqa: E501 - _param = self._list_tasks_serialize( - workflow_run_id=workflow_run_id, + _param = self._list_id_photos_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -13993,7 +14051,7 @@ def list_tasks( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TaskItem]", + '200': "IdPhotosList", } response_data = self.api_client.call_api( *_param, @@ -14007,9 +14065,9 @@ def list_tasks( @validate_call - def list_tasks_with_http_info( + def list_id_photos_with_http_info( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Tasks belong.")], + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the ID photos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14022,13 +14080,13 @@ def list_tasks_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[TaskItem]]: - """List Tasks + ) -> ApiResponse[IdPhotosList]: + """List ID photos - The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. + Lists the ID photos that belong to an applicant. - :param workflow_run_id: The unique identifier of the Workflow Run to which the Tasks belong. (required) - :type workflow_run_id: str + :param applicant_id: The id of the applicant the ID photos belong to. (required) + :type applicant_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 @@ -14051,8 +14109,8 @@ def list_tasks_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_tasks_serialize( - workflow_run_id=workflow_run_id, + _param = self._list_id_photos_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14060,7 +14118,7 @@ def list_tasks_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TaskItem]", + '200': "IdPhotosList", } response_data = self.api_client.call_api( *_param, @@ -14074,9 +14132,9 @@ def list_tasks_with_http_info( @validate_call - def list_tasks_without_preload_content( + def list_id_photos_without_preload_content( self, - workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Tasks belong.")], + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the ID photos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14090,12 +14148,12 @@ def list_tasks_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List Tasks + """List ID photos - The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. + Lists the ID photos that belong to an applicant. - :param workflow_run_id: The unique identifier of the Workflow Run to which the Tasks belong. (required) - :type workflow_run_id: str + :param applicant_id: The id of the applicant the ID photos belong to. (required) + :type applicant_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 @@ -14118,8 +14176,8 @@ def list_tasks_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_tasks_serialize( - workflow_run_id=workflow_run_id, + _param = self._list_id_photos_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14127,7 +14185,7 @@ def list_tasks_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[TaskItem]", + '200': "IdPhotosList", } response_data = self.api_client.call_api( *_param, @@ -14136,9 +14194,9 @@ def list_tasks_without_preload_content( return response_data.response - def _list_tasks_serialize( + def _list_id_photos_serialize( self, - workflow_run_id, + applicant_id, _request_auth, _content_type, _headers, @@ -14160,9 +14218,11 @@ def _list_tasks_serialize( _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 + if applicant_id is not None: + + _query_params.append(('applicant_id', applicant_id)) + # process the header parameters # process the form parameters # process the body parameter @@ -14184,7 +14244,7 @@ def _list_tasks_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/workflow_runs/{workflow_run_id}/tasks', + resource_path='/id_photos', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -14201,9 +14261,9 @@ def _list_tasks_serialize( @validate_call - def list_watchlist_monitor_matches( + def list_live_photos( self, - monitor_id: StrictStr, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live photos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14216,13 +14276,13 @@ def list_watchlist_monitor_matches( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> WatchlistMonitorMatchesList: - """List matches (BETA) + ) -> LivePhotosList: + """List live photos - List match IDs on this monitor, as well as their enabled/disabled status + Lists the live photos that belong to an applicant. - :param monitor_id: (required) - :type monitor_id: str + :param applicant_id: The id of the applicant the live photos belong to. (required) + :type applicant_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 @@ -14245,8 +14305,8 @@ def list_watchlist_monitor_matches( :return: Returns the result object. """ # noqa: E501 - _param = self._list_watchlist_monitor_matches_serialize( - monitor_id=monitor_id, + _param = self._list_live_photos_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14254,7 +14314,7 @@ def list_watchlist_monitor_matches( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorMatchesList", + '200': "LivePhotosList", } response_data = self.api_client.call_api( *_param, @@ -14268,9 +14328,9 @@ def list_watchlist_monitor_matches( @validate_call - def list_watchlist_monitor_matches_with_http_info( + def list_live_photos_with_http_info( self, - monitor_id: StrictStr, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live photos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14283,13 +14343,13 @@ def list_watchlist_monitor_matches_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[WatchlistMonitorMatchesList]: - """List matches (BETA) + ) -> ApiResponse[LivePhotosList]: + """List live photos - List match IDs on this monitor, as well as their enabled/disabled status + Lists the live photos that belong to an applicant. - :param monitor_id: (required) - :type monitor_id: str + :param applicant_id: The id of the applicant the live photos belong to. (required) + :type applicant_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 @@ -14312,8 +14372,8 @@ def list_watchlist_monitor_matches_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_watchlist_monitor_matches_serialize( - monitor_id=monitor_id, + _param = self._list_live_photos_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14321,7 +14381,7 @@ def list_watchlist_monitor_matches_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorMatchesList", + '200': "LivePhotosList", } response_data = self.api_client.call_api( *_param, @@ -14335,9 +14395,9 @@ def list_watchlist_monitor_matches_with_http_info( @validate_call - def list_watchlist_monitor_matches_without_preload_content( + def list_live_photos_without_preload_content( self, - monitor_id: StrictStr, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live photos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14351,12 +14411,12 @@ def list_watchlist_monitor_matches_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List matches (BETA) + """List live photos - List match IDs on this monitor, as well as their enabled/disabled status + Lists the live photos that belong to an applicant. - :param monitor_id: (required) - :type monitor_id: str + :param applicant_id: The id of the applicant the live photos belong to. (required) + :type applicant_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 @@ -14379,8 +14439,8 @@ def list_watchlist_monitor_matches_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_watchlist_monitor_matches_serialize( - monitor_id=monitor_id, + _param = self._list_live_photos_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14388,7 +14448,7 @@ def list_watchlist_monitor_matches_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorMatchesList", + '200': "LivePhotosList", } response_data = self.api_client.call_api( *_param, @@ -14397,9 +14457,9 @@ def list_watchlist_monitor_matches_without_preload_content( return response_data.response - def _list_watchlist_monitor_matches_serialize( + def _list_live_photos_serialize( self, - monitor_id, + applicant_id, _request_auth, _content_type, _headers, @@ -14421,9 +14481,11 @@ def _list_watchlist_monitor_matches_serialize( _body_params: Optional[bytes] = None # process the path parameters - if monitor_id is not None: - _path_params['monitor_id'] = monitor_id # process the query parameters + if applicant_id is not None: + + _query_params.append(('applicant_id', applicant_id)) + # process the header parameters # process the form parameters # process the body parameter @@ -14445,7 +14507,7 @@ def _list_watchlist_monitor_matches_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/watchlist_monitors/{monitor_id}/matches', + resource_path='/live_photos', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -14462,10 +14524,9 @@ def _list_watchlist_monitor_matches_serialize( @validate_call - def list_watchlist_monitors( + def list_live_videos( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.")], - include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include deleted (inactive) monitors.")] = None, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live videos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14478,15 +14539,13 @@ def list_watchlist_monitors( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> WatchlistMonitorsList: - """List monitors + ) -> LiveVideosList: + """List live videos - List all available monitors for an applicant + Lists all the live videos that belong to an applicant. - :param applicant_id: The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required) + :param applicant_id: The id of the applicant the live videos belong to. (required) :type applicant_id: str - :param include_deleted: Whether to also include deleted (inactive) monitors. - :type include_deleted: bool :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 @@ -14509,9 +14568,8 @@ def list_watchlist_monitors( :return: Returns the result object. """ # noqa: E501 - _param = self._list_watchlist_monitors_serialize( + _param = self._list_live_videos_serialize( applicant_id=applicant_id, - include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14519,7 +14577,7 @@ def list_watchlist_monitors( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorsList", + '200': "LiveVideosList", } response_data = self.api_client.call_api( *_param, @@ -14533,10 +14591,9 @@ def list_watchlist_monitors( @validate_call - def list_watchlist_monitors_with_http_info( + def list_live_videos_with_http_info( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.")], - include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include deleted (inactive) monitors.")] = None, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live videos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14549,15 +14606,13 @@ def list_watchlist_monitors_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[WatchlistMonitorsList]: - """List monitors + ) -> ApiResponse[LiveVideosList]: + """List live videos - List all available monitors for an applicant + Lists all the live videos that belong to an applicant. - :param applicant_id: The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required) + :param applicant_id: The id of the applicant the live videos belong to. (required) :type applicant_id: str - :param include_deleted: Whether to also include deleted (inactive) monitors. - :type include_deleted: bool :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 @@ -14580,9 +14635,8 @@ def list_watchlist_monitors_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_watchlist_monitors_serialize( + _param = self._list_live_videos_serialize( applicant_id=applicant_id, - include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14590,7 +14644,7 @@ def list_watchlist_monitors_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorsList", + '200': "LiveVideosList", } response_data = self.api_client.call_api( *_param, @@ -14604,10 +14658,9 @@ def list_watchlist_monitors_with_http_info( @validate_call - def list_watchlist_monitors_without_preload_content( + def list_live_videos_without_preload_content( self, - applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.")], - include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include deleted (inactive) monitors.")] = None, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the live videos belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14621,14 +14674,12 @@ def list_watchlist_monitors_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List monitors + """List live videos - List all available monitors for an applicant + Lists all the live videos that belong to an applicant. - :param applicant_id: The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required) + :param applicant_id: The id of the applicant the live videos belong to. (required) :type applicant_id: str - :param include_deleted: Whether to also include deleted (inactive) monitors. - :type include_deleted: bool :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 @@ -14651,9 +14702,8 @@ def list_watchlist_monitors_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_watchlist_monitors_serialize( + _param = self._list_live_videos_serialize( applicant_id=applicant_id, - include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14661,7 +14711,7 @@ def list_watchlist_monitors_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorsList", + '200': "LiveVideosList", } response_data = self.api_client.call_api( *_param, @@ -14670,10 +14720,9 @@ def list_watchlist_monitors_without_preload_content( return response_data.response - def _list_watchlist_monitors_serialize( + def _list_live_videos_serialize( self, applicant_id, - include_deleted, _request_auth, _content_type, _headers, @@ -14700,10 +14749,6 @@ def _list_watchlist_monitors_serialize( _query_params.append(('applicant_id', applicant_id)) - if include_deleted is not None: - - _query_params.append(('include_deleted', include_deleted)) - # process the header parameters # process the form parameters # process the body parameter @@ -14725,7 +14770,7 @@ def _list_watchlist_monitors_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/watchlist_monitors', + resource_path='/live_videos', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -14742,8 +14787,9 @@ def _list_watchlist_monitors_serialize( @validate_call - def list_webhooks( + def list_motion_captures( self, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the motion captures belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14756,11 +14802,13 @@ def list_webhooks( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> WebhooksList: - """List webhooks + ) -> MotionCapturesList: + """List motion captures - Lists all webhooks you've created. + Lists all the motion captures that belong to an applicant. + :param applicant_id: The id of the applicant the motion captures belong to. (required) + :type applicant_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 @@ -14783,7 +14831,8 @@ def list_webhooks( :return: Returns the result object. """ # noqa: E501 - _param = self._list_webhooks_serialize( + _param = self._list_motion_captures_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14791,7 +14840,7 @@ def list_webhooks( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WebhooksList", + '200': "MotionCapturesList", } response_data = self.api_client.call_api( *_param, @@ -14805,8 +14854,9 @@ def list_webhooks( @validate_call - def list_webhooks_with_http_info( + def list_motion_captures_with_http_info( self, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the motion captures belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14819,11 +14869,13 @@ def list_webhooks_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[WebhooksList]: - """List webhooks + ) -> ApiResponse[MotionCapturesList]: + """List motion captures - Lists all webhooks you've created. + Lists all the motion captures that belong to an applicant. + :param applicant_id: The id of the applicant the motion captures belong to. (required) + :type applicant_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 @@ -14846,7 +14898,8 @@ def list_webhooks_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_webhooks_serialize( + _param = self._list_motion_captures_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14854,7 +14907,7 @@ def list_webhooks_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WebhooksList", + '200': "MotionCapturesList", } response_data = self.api_client.call_api( *_param, @@ -14868,8 +14921,9 @@ def list_webhooks_with_http_info( @validate_call - def list_webhooks_without_preload_content( + def list_motion_captures_without_preload_content( self, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the motion captures belong to.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -14883,10 +14937,12 @@ def list_webhooks_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List webhooks + """List motion captures - Lists all webhooks you've created. + Lists all the motion captures that belong to an applicant. + :param applicant_id: The id of the applicant the motion captures belong to. (required) + :type applicant_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 @@ -14909,7 +14965,8 @@ def list_webhooks_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_webhooks_serialize( + _param = self._list_motion_captures_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -14917,7 +14974,7 @@ def list_webhooks_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WebhooksList", + '200': "MotionCapturesList", } response_data = self.api_client.call_api( *_param, @@ -14926,8 +14983,9 @@ def list_webhooks_without_preload_content( return response_data.response - def _list_webhooks_serialize( + def _list_motion_captures_serialize( self, + applicant_id, _request_auth, _content_type, _headers, @@ -14950,6 +15008,10 @@ def _list_webhooks_serialize( # process the path parameters # process the query parameters + if applicant_id is not None: + + _query_params.append(('applicant_id', applicant_id)) + # process the header parameters # process the form parameters # process the body parameter @@ -14971,7 +15033,7 @@ def _list_webhooks_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/webhooks', + resource_path='/motion_captures', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -14988,14 +15050,9 @@ def _list_webhooks_serialize( @validate_call - def list_workflow_runs( + def list_passkeys( self, - page: Annotated[Optional[StrictInt], Field(description="The number of the page to be retrieved. If not specified, defaults to 1.")] = None, - status: Annotated[Optional[StrictStr], Field(description="A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.")] = None, - created_at_gt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date greater than (after) the one provided.")] = None, - created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None, - sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None, - applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None, + username: Annotated[StrictStr, Field(description="Username that owns the passkeys.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15008,23 +15065,13 @@ def list_workflow_runs( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> List[WorkflowRun]: - """List Workflow Runs + ) -> PasskeysList: + """List passkeys - Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects. + Returns every passkey registered under the supplied username. - :param page: The number of the page to be retrieved. If not specified, defaults to 1. - :type page: int - :param status: A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. - :type status: str - :param created_at_gt: A ISO-8601 date to filter results with a created date greater than (after) the one provided. - :type created_at_gt: datetime - :param created_at_lt: A ISO-8601 date to filter results with a created date less than (before) the one provided. - :type created_at_lt: datetime - :param sort: A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. - :type sort: str - :param applicant_id: the applicant's id. - :type applicant_id: str + :param username: Username that owns the passkeys. (required) + :type username: 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 @@ -15047,13 +15094,8 @@ def list_workflow_runs( :return: Returns the result object. """ # noqa: E501 - _param = self._list_workflow_runs_serialize( - page=page, - status=status, - created_at_gt=created_at_gt, - created_at_lt=created_at_lt, - sort=sort, - applicant_id=applicant_id, + _param = self._list_passkeys_serialize( + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15061,7 +15103,8 @@ def list_workflow_runs( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[WorkflowRun]", + '200': "PasskeysList", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -15075,14 +15118,9 @@ def list_workflow_runs( @validate_call - def list_workflow_runs_with_http_info( + def list_passkeys_with_http_info( self, - page: Annotated[Optional[StrictInt], Field(description="The number of the page to be retrieved. If not specified, defaults to 1.")] = None, - status: Annotated[Optional[StrictStr], Field(description="A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.")] = None, - created_at_gt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date greater than (after) the one provided.")] = None, - created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None, - sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None, - applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None, + username: Annotated[StrictStr, Field(description="Username that owns the passkeys.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15095,23 +15133,13 @@ def list_workflow_runs_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[List[WorkflowRun]]: - """List Workflow Runs + ) -> ApiResponse[PasskeysList]: + """List passkeys - Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects. + Returns every passkey registered under the supplied username. - :param page: The number of the page to be retrieved. If not specified, defaults to 1. - :type page: int - :param status: A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. - :type status: str - :param created_at_gt: A ISO-8601 date to filter results with a created date greater than (after) the one provided. - :type created_at_gt: datetime - :param created_at_lt: A ISO-8601 date to filter results with a created date less than (before) the one provided. - :type created_at_lt: datetime - :param sort: A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. - :type sort: str - :param applicant_id: the applicant's id. - :type applicant_id: str + :param username: Username that owns the passkeys. (required) + :type username: 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 @@ -15134,13 +15162,8 @@ def list_workflow_runs_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_workflow_runs_serialize( - page=page, - status=status, - created_at_gt=created_at_gt, - created_at_lt=created_at_lt, - sort=sort, - applicant_id=applicant_id, + _param = self._list_passkeys_serialize( + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15148,7 +15171,8 @@ def list_workflow_runs_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[WorkflowRun]", + '200': "PasskeysList", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -15162,14 +15186,9 @@ def list_workflow_runs_with_http_info( @validate_call - def list_workflow_runs_without_preload_content( + def list_passkeys_without_preload_content( self, - page: Annotated[Optional[StrictInt], Field(description="The number of the page to be retrieved. If not specified, defaults to 1.")] = None, - status: Annotated[Optional[StrictStr], Field(description="A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.")] = None, - created_at_gt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date greater than (after) the one provided.")] = None, - created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None, - sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None, - applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None, + username: Annotated[StrictStr, Field(description="Username that owns the passkeys.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15183,22 +15202,12 @@ def list_workflow_runs_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List Workflow Runs + """List passkeys - Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects. + Returns every passkey registered under the supplied username. - :param page: The number of the page to be retrieved. If not specified, defaults to 1. - :type page: int - :param status: A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. - :type status: str - :param created_at_gt: A ISO-8601 date to filter results with a created date greater than (after) the one provided. - :type created_at_gt: datetime - :param created_at_lt: A ISO-8601 date to filter results with a created date less than (before) the one provided. - :type created_at_lt: datetime - :param sort: A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. - :type sort: str - :param applicant_id: the applicant's id. - :type applicant_id: str + :param username: Username that owns the passkeys. (required) + :type username: 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 @@ -15221,13 +15230,8 @@ def list_workflow_runs_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_workflow_runs_serialize( - page=page, - status=status, - created_at_gt=created_at_gt, - created_at_lt=created_at_lt, - sort=sort, - applicant_id=applicant_id, + _param = self._list_passkeys_serialize( + username=username, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15235,7 +15239,8 @@ def list_workflow_runs_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "List[WorkflowRun]", + '200': "PasskeysList", + '404': None, } response_data = self.api_client.call_api( *_param, @@ -15244,14 +15249,9 @@ def list_workflow_runs_without_preload_content( return response_data.response - def _list_workflow_runs_serialize( + def _list_passkeys_serialize( self, - page, - status, - created_at_gt, - created_at_lt, - sort, - applicant_id, + username, _request_auth, _content_type, _headers, @@ -15273,49 +15273,9 @@ def _list_workflow_runs_serialize( _body_params: Optional[bytes] = None # process the path parameters + if username is not None: + _path_params['username'] = username # process the query parameters - if page is not None: - - _query_params.append(('page', page)) - - if status is not None: - - _query_params.append(('status', status)) - - if created_at_gt is not None: - if isinstance(created_at_gt, datetime): - _query_params.append( - ( - 'created_at_gt', - created_at_gt.strftime( - self.api_client.configuration.datetime_format - ) - ) - ) - else: - _query_params.append(('created_at_gt', created_at_gt)) - - if created_at_lt is not None: - if isinstance(created_at_lt, datetime): - _query_params.append( - ( - 'created_at_lt', - created_at_lt.strftime( - self.api_client.configuration.datetime_format - ) - ) - ) - else: - _query_params.append(('created_at_lt', created_at_lt)) - - if sort is not None: - - _query_params.append(('sort', sort)) - - if applicant_id is not None: - - _query_params.append(('applicant_id', applicant_id)) - # process the header parameters # process the form parameters # process the body parameter @@ -15337,7 +15297,7 @@ def _list_workflow_runs_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/workflow_runs', + resource_path='/passkeys/{username}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -15354,8 +15314,9 @@ def _list_workflow_runs_serialize( @validate_call - def ping( + def list_repeat_attempts( self, + report_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15368,11 +15329,13 @@ def ping( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> str: - """Ping + ) -> RepeatAttemptsList: + """Retrieve repeat attempts - Run a health check on the Onfido API + Returns all repeat attempts for a given Document report + :param report_id: (required) + :type report_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 @@ -15395,7 +15358,8 @@ def ping( :return: Returns the result object. """ # noqa: E501 - _param = self._ping_serialize( + _param = self._list_repeat_attempts_serialize( + report_id=report_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15403,7 +15367,7 @@ def ping( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "str", + '200': "RepeatAttemptsList", } response_data = self.api_client.call_api( *_param, @@ -15417,8 +15381,9 @@ def ping( @validate_call - def ping_with_http_info( + def list_repeat_attempts_with_http_info( self, + report_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15431,11 +15396,13 @@ def ping_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[str]: - """Ping + ) -> ApiResponse[RepeatAttemptsList]: + """Retrieve repeat attempts - Run a health check on the Onfido API + Returns all repeat attempts for a given Document report + :param report_id: (required) + :type report_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 @@ -15458,7 +15425,8 @@ def ping_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._ping_serialize( + _param = self._list_repeat_attempts_serialize( + report_id=report_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15466,7 +15434,7 @@ def ping_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "str", + '200': "RepeatAttemptsList", } response_data = self.api_client.call_api( *_param, @@ -15480,8 +15448,9 @@ def ping_with_http_info( @validate_call - def ping_without_preload_content( + def list_repeat_attempts_without_preload_content( self, + report_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15495,10 +15464,12 @@ def ping_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Ping + """Retrieve repeat attempts - Run a health check on the Onfido API + Returns all repeat attempts for a given Document report + :param report_id: (required) + :type report_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 @@ -15521,7 +15492,8 @@ def ping_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._ping_serialize( + _param = self._list_repeat_attempts_serialize( + report_id=report_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15529,7 +15501,7 @@ def ping_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "str", + '200': "RepeatAttemptsList", } response_data = self.api_client.call_api( *_param, @@ -15538,8 +15510,9 @@ def ping_without_preload_content( return response_data.response - def _ping_serialize( + def _list_repeat_attempts_serialize( self, + report_id, _request_auth, _content_type, _headers, @@ -15561,6 +15534,8 @@ def _ping_serialize( _body_params: Optional[bytes] = None # process the path parameters + if report_id is not None: + _path_params['report_id'] = report_id # process the query parameters # process the header parameters # process the form parameters @@ -15571,7 +15546,6 @@ def _ping_serialize( if 'Accept' not in _header_params: _header_params['Accept'] = self.api_client.select_header_accept( [ - 'text/plain', 'application/json' ] ) @@ -15584,7 +15558,7 @@ def _ping_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/ping', + resource_path='/repeat_attempts/{report_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -15601,9 +15575,9 @@ def _ping_serialize( @validate_call - def post_results_feedback( + def list_reports( self, - results_feedback: ResultsFeedback, + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15616,13 +15590,13 @@ def post_results_feedback( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ResultsFeedback: - """Fraud reporting (ALPHA) + ) -> ReportsList: + """List reports - Create Feedback on checks and reports + All the reports belonging to a particular check can be listed from this endpoint. - :param results_feedback: (required) - :type results_feedback: ResultsFeedback + :param check_id: (required) + :type check_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 @@ -15645,8 +15619,8 @@ def post_results_feedback( :return: Returns the result object. """ # noqa: E501 - _param = self._post_results_feedback_serialize( - results_feedback=results_feedback, + _param = self._list_reports_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15654,7 +15628,7 @@ def post_results_feedback( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ResultsFeedback", + '200': "ReportsList", } response_data = self.api_client.call_api( *_param, @@ -15668,9 +15642,9 @@ def post_results_feedback( @validate_call - def post_results_feedback_with_http_info( + def list_reports_with_http_info( self, - results_feedback: ResultsFeedback, + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15683,13 +15657,13 @@ def post_results_feedback_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ResultsFeedback]: - """Fraud reporting (ALPHA) + ) -> ApiResponse[ReportsList]: + """List reports - Create Feedback on checks and reports + All the reports belonging to a particular check can be listed from this endpoint. - :param results_feedback: (required) - :type results_feedback: ResultsFeedback + :param check_id: (required) + :type check_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 @@ -15712,8 +15686,8 @@ def post_results_feedback_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._post_results_feedback_serialize( - results_feedback=results_feedback, + _param = self._list_reports_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15721,7 +15695,7 @@ def post_results_feedback_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ResultsFeedback", + '200': "ReportsList", } response_data = self.api_client.call_api( *_param, @@ -15735,9 +15709,9 @@ def post_results_feedback_with_http_info( @validate_call - def post_results_feedback_without_preload_content( + def list_reports_without_preload_content( self, - results_feedback: ResultsFeedback, + check_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15751,12 +15725,12 @@ def post_results_feedback_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Fraud reporting (ALPHA) + """List reports - Create Feedback on checks and reports + All the reports belonging to a particular check can be listed from this endpoint. - :param results_feedback: (required) - :type results_feedback: ResultsFeedback + :param check_id: (required) + :type check_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 @@ -15779,8 +15753,8 @@ def post_results_feedback_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._post_results_feedback_serialize( - results_feedback=results_feedback, + _param = self._list_reports_serialize( + check_id=check_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15788,7 +15762,7 @@ def post_results_feedback_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ResultsFeedback", + '200': "ReportsList", } response_data = self.api_client.call_api( *_param, @@ -15797,9 +15771,9 @@ def post_results_feedback_without_preload_content( return response_data.response - def _post_results_feedback_serialize( + def _list_reports_serialize( self, - results_feedback, + check_id, _request_auth, _content_type, _headers, @@ -15822,11 +15796,13 @@ def _post_results_feedback_serialize( # process the path parameters # process the query parameters + if check_id is not None: + + _query_params.append(('check_id', check_id)) + # process the header parameters # process the form parameters # process the body parameter - if results_feedback is not None: - _body_params = results_feedback # set the HTTP header `Accept` @@ -15837,19 +15813,6 @@ def _post_results_feedback_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -15857,8 +15820,8 @@ def _post_results_feedback_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/results_feedback', + method='GET', + resource_path='/reports', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -15875,9 +15838,9 @@ def _post_results_feedback_serialize( @validate_call - def resend_webhooks( + def list_signing_documents( self, - webhook_resend: WebhookResend, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15890,13 +15853,13 @@ def resend_webhooks( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Resends webhooks + ) -> SigningDocumentsList: + """List signing documents - Resends events to all webhooks registered with a matching environment in your account. + All signing documents belonging to an applicant can be listed from this endpoint - :param webhook_resend: (required) - :type webhook_resend: WebhookResend + :param applicant_id: (required) + :type applicant_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 @@ -15919,8 +15882,8 @@ def resend_webhooks( :return: Returns the result object. """ # noqa: E501 - _param = self._resend_webhooks_serialize( - webhook_resend=webhook_resend, + _param = self._list_signing_documents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15928,8 +15891,7 @@ def resend_webhooks( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, - '422': None, + '200': "SigningDocumentsList", } response_data = self.api_client.call_api( *_param, @@ -15943,9 +15905,9 @@ def resend_webhooks( @validate_call - def resend_webhooks_with_http_info( + def list_signing_documents_with_http_info( self, - webhook_resend: WebhookResend, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -15958,13 +15920,13 @@ def resend_webhooks_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Resends webhooks + ) -> ApiResponse[SigningDocumentsList]: + """List signing documents - Resends events to all webhooks registered with a matching environment in your account. + All signing documents belonging to an applicant can be listed from this endpoint - :param webhook_resend: (required) - :type webhook_resend: WebhookResend + :param applicant_id: (required) + :type applicant_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 @@ -15987,8 +15949,8 @@ def resend_webhooks_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._resend_webhooks_serialize( - webhook_resend=webhook_resend, + _param = self._list_signing_documents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -15996,8 +15958,7 @@ def resend_webhooks_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, - '422': None, + '200': "SigningDocumentsList", } response_data = self.api_client.call_api( *_param, @@ -16011,9 +15972,9 @@ def resend_webhooks_with_http_info( @validate_call - def resend_webhooks_without_preload_content( + def list_signing_documents_without_preload_content( self, - webhook_resend: WebhookResend, + applicant_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16027,12 +15988,12 @@ def resend_webhooks_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Resends webhooks + """List signing documents - Resends events to all webhooks registered with a matching environment in your account. + All signing documents belonging to an applicant can be listed from this endpoint - :param webhook_resend: (required) - :type webhook_resend: WebhookResend + :param applicant_id: (required) + :type applicant_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 @@ -16055,8 +16016,8 @@ def resend_webhooks_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._resend_webhooks_serialize( - webhook_resend=webhook_resend, + _param = self._list_signing_documents_serialize( + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16064,8 +16025,7 @@ def resend_webhooks_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, - '422': None, + '200': "SigningDocumentsList", } response_data = self.api_client.call_api( *_param, @@ -16074,9 +16034,9 @@ def resend_webhooks_without_preload_content( return response_data.response - def _resend_webhooks_serialize( + def _list_signing_documents_serialize( self, - webhook_resend, + applicant_id, _request_auth, _content_type, _headers, @@ -16099,11 +16059,13 @@ def _resend_webhooks_serialize( # process the path parameters # process the query parameters + if applicant_id is not None: + + _query_params.append(('applicant_id', applicant_id)) + # process the header parameters # process the form parameters # process the body parameter - if webhook_resend is not None: - _body_params = webhook_resend # set the HTTP header `Accept` @@ -16114,19 +16076,6 @@ def _resend_webhooks_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -16134,8 +16083,8 @@ def _resend_webhooks_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/webhooks/resend', + method='GET', + resource_path='/signing_documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -16152,9 +16101,9 @@ def _resend_webhooks_serialize( @validate_call - def restore_applicant( + def list_tasks( self, - applicant_id: StrictStr, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Tasks belong.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16167,13 +16116,13 @@ def restore_applicant( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Restore Applicant + ) -> List[TaskItem]: + """List Tasks - Restores a single applicant scheduled for deletion. + The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. - :param applicant_id: (required) - :type applicant_id: str + :param workflow_run_id: The unique identifier of the Workflow Run to which the Tasks belong. (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 @@ -16196,8 +16145,8 @@ def restore_applicant( :return: Returns the result object. """ # noqa: E501 - _param = self._restore_applicant_serialize( - applicant_id=applicant_id, + _param = self._list_tasks_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16205,7 +16154,7 @@ def restore_applicant( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "List[TaskItem]", } response_data = self.api_client.call_api( *_param, @@ -16219,9 +16168,9 @@ def restore_applicant( @validate_call - def restore_applicant_with_http_info( + def list_tasks_with_http_info( self, - applicant_id: StrictStr, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Tasks belong.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16234,13 +16183,13 @@ def restore_applicant_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Restore Applicant + ) -> ApiResponse[List[TaskItem]]: + """List Tasks - Restores a single applicant scheduled for deletion. + The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. - :param applicant_id: (required) - :type applicant_id: str + :param workflow_run_id: The unique identifier of the Workflow Run to which the Tasks belong. (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 @@ -16263,8 +16212,8 @@ def restore_applicant_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._restore_applicant_serialize( - applicant_id=applicant_id, + _param = self._list_tasks_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16272,7 +16221,7 @@ def restore_applicant_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "List[TaskItem]", } response_data = self.api_client.call_api( *_param, @@ -16286,9 +16235,9 @@ def restore_applicant_with_http_info( @validate_call - def restore_applicant_without_preload_content( + def list_tasks_without_preload_content( self, - applicant_id: StrictStr, + workflow_run_id: Annotated[StrictStr, Field(description="The unique identifier of the Workflow Run to which the Tasks belong.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16302,12 +16251,12 @@ def restore_applicant_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Restore Applicant + """List Tasks - Restores a single applicant scheduled for deletion. + The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. - :param applicant_id: (required) - :type applicant_id: str + :param workflow_run_id: The unique identifier of the Workflow Run to which the Tasks belong. (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 @@ -16330,8 +16279,8 @@ def restore_applicant_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._restore_applicant_serialize( - applicant_id=applicant_id, + _param = self._list_tasks_serialize( + workflow_run_id=workflow_run_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16339,7 +16288,7 @@ def restore_applicant_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "List[TaskItem]", } response_data = self.api_client.call_api( *_param, @@ -16348,9 +16297,9 @@ def restore_applicant_without_preload_content( return response_data.response - def _restore_applicant_serialize( + def _list_tasks_serialize( self, - applicant_id, + workflow_run_id, _request_auth, _content_type, _headers, @@ -16372,8 +16321,8 @@ def _restore_applicant_serialize( _body_params: Optional[bytes] = None # process the path parameters - if applicant_id is not None: - _path_params['applicant_id'] = applicant_id + 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 @@ -16395,8 +16344,8 @@ def _restore_applicant_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/applicants/{applicant_id}/restore', + method='GET', + resource_path='/workflow_runs/{workflow_run_id}/tasks', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -16413,9 +16362,9 @@ def _restore_applicant_serialize( @validate_call - def resume_check( + def list_watchlist_monitor_matches( self, - check_id: StrictStr, + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16428,13 +16377,13 @@ def resume_check( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Resume a Check + ) -> WatchlistMonitorMatchesList: + """List matches (BETA) - Resumes a paused check. + List match IDs on this monitor, as well as their enabled/disabled status - :param check_id: (required) - :type check_id: str + :param monitor_id: (required) + :type monitor_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 @@ -16457,8 +16406,8 @@ def resume_check( :return: Returns the result object. """ # noqa: E501 - _param = self._resume_check_serialize( - check_id=check_id, + _param = self._list_watchlist_monitor_matches_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16466,7 +16415,7 @@ def resume_check( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "WatchlistMonitorMatchesList", } response_data = self.api_client.call_api( *_param, @@ -16480,9 +16429,9 @@ def resume_check( @validate_call - def resume_check_with_http_info( + def list_watchlist_monitor_matches_with_http_info( self, - check_id: StrictStr, + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16495,13 +16444,13 @@ def resume_check_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Resume a Check + ) -> ApiResponse[WatchlistMonitorMatchesList]: + """List matches (BETA) - Resumes a paused check. + List match IDs on this monitor, as well as their enabled/disabled status - :param check_id: (required) - :type check_id: str + :param monitor_id: (required) + :type monitor_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 @@ -16524,8 +16473,8 @@ def resume_check_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._resume_check_serialize( - check_id=check_id, + _param = self._list_watchlist_monitor_matches_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16533,7 +16482,7 @@ def resume_check_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "WatchlistMonitorMatchesList", } response_data = self.api_client.call_api( *_param, @@ -16547,9 +16496,9 @@ def resume_check_with_http_info( @validate_call - def resume_check_without_preload_content( + def list_watchlist_monitor_matches_without_preload_content( self, - check_id: StrictStr, + monitor_id: StrictStr, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16563,12 +16512,12 @@ def resume_check_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Resume a Check + """List matches (BETA) - Resumes a paused check. + List match IDs on this monitor, as well as their enabled/disabled status - :param check_id: (required) - :type check_id: str + :param monitor_id: (required) + :type monitor_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 @@ -16591,8 +16540,8 @@ def resume_check_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._resume_check_serialize( - check_id=check_id, + _param = self._list_watchlist_monitor_matches_serialize( + monitor_id=monitor_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16600,7 +16549,7 @@ def resume_check_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "WatchlistMonitorMatchesList", } response_data = self.api_client.call_api( *_param, @@ -16609,9 +16558,9 @@ def resume_check_without_preload_content( return response_data.response - def _resume_check_serialize( + def _list_watchlist_monitor_matches_serialize( self, - check_id, + monitor_id, _request_auth, _content_type, _headers, @@ -16633,8 +16582,8 @@ def _resume_check_serialize( _body_params: Optional[bytes] = None # process the path parameters - if check_id is not None: - _path_params['check_id'] = check_id + if monitor_id is not None: + _path_params['monitor_id'] = monitor_id # process the query parameters # process the header parameters # process the form parameters @@ -16656,8 +16605,8 @@ def _resume_check_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/checks/{check_id}/resume', + method='GET', + resource_path='/watchlist_monitors/{monitor_id}/matches', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -16674,9 +16623,10 @@ def _resume_check_serialize( @validate_call - def resume_report( + def list_watchlist_monitors( self, - report_id: StrictStr, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.")], + include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include deleted (inactive) monitors.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16689,13 +16639,15 @@ def resume_report( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> None: - """Resume report + ) -> WatchlistMonitorsList: + """List monitors - Resumes a single paused report. + List all available monitors for an applicant - :param report_id: (required) - :type report_id: str + :param applicant_id: The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required) + :type applicant_id: str + :param include_deleted: Whether to also include deleted (inactive) monitors. + :type include_deleted: bool :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 @@ -16718,8 +16670,9 @@ def resume_report( :return: Returns the result object. """ # noqa: E501 - _param = self._resume_report_serialize( - report_id=report_id, + _param = self._list_watchlist_monitors_serialize( + applicant_id=applicant_id, + include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16727,7 +16680,7 @@ def resume_report( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "WatchlistMonitorsList", } response_data = self.api_client.call_api( *_param, @@ -16741,9 +16694,10 @@ def resume_report( @validate_call - def resume_report_with_http_info( + def list_watchlist_monitors_with_http_info( self, - report_id: StrictStr, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.")], + include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include deleted (inactive) monitors.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16756,13 +16710,15 @@ def resume_report_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[None]: - """Resume report + ) -> ApiResponse[WatchlistMonitorsList]: + """List monitors - Resumes a single paused report. + List all available monitors for an applicant - :param report_id: (required) - :type report_id: str + :param applicant_id: The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required) + :type applicant_id: str + :param include_deleted: Whether to also include deleted (inactive) monitors. + :type include_deleted: bool :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 @@ -16785,8 +16741,9 @@ def resume_report_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._resume_report_serialize( - report_id=report_id, + _param = self._list_watchlist_monitors_serialize( + applicant_id=applicant_id, + include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16794,7 +16751,7 @@ def resume_report_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "WatchlistMonitorsList", } response_data = self.api_client.call_api( *_param, @@ -16808,9 +16765,10 @@ def resume_report_with_http_info( @validate_call - def resume_report_without_preload_content( + def list_watchlist_monitors_without_preload_content( self, - report_id: StrictStr, + applicant_id: Annotated[StrictStr, Field(description="The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.")], + include_deleted: Annotated[Optional[StrictBool], Field(description="Whether to also include deleted (inactive) monitors.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16824,12 +16782,14 @@ def resume_report_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Resume report + """List monitors - Resumes a single paused report. + List all available monitors for an applicant - :param report_id: (required) - :type report_id: str + :param applicant_id: The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed. (required) + :type applicant_id: str + :param include_deleted: Whether to also include deleted (inactive) monitors. + :type include_deleted: bool :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 @@ -16852,8 +16812,9 @@ def resume_report_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._resume_report_serialize( - report_id=report_id, + _param = self._list_watchlist_monitors_serialize( + applicant_id=applicant_id, + include_deleted=include_deleted, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16861,7 +16822,7 @@ def resume_report_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '204': None, + '200': "WatchlistMonitorsList", } response_data = self.api_client.call_api( *_param, @@ -16870,9 +16831,10 @@ def resume_report_without_preload_content( return response_data.response - def _resume_report_serialize( + def _list_watchlist_monitors_serialize( self, - report_id, + applicant_id, + include_deleted, _request_auth, _content_type, _headers, @@ -16894,9 +16856,15 @@ def _resume_report_serialize( _body_params: Optional[bytes] = None # process the path parameters - if report_id is not None: - _path_params['report_id'] = report_id # process the query parameters + if applicant_id is not None: + + _query_params.append(('applicant_id', applicant_id)) + + if include_deleted is not None: + + _query_params.append(('include_deleted', include_deleted)) + # process the header parameters # process the form parameters # process the body parameter @@ -16917,8 +16885,8 @@ def _resume_report_serialize( ] return self.api_client.param_serialize( - method='POST', - resource_path='/reports/{report_id}/resume', + method='GET', + resource_path='/watchlist_monitors', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -16935,10 +16903,8 @@ def _resume_report_serialize( @validate_call - def update_applicant( + def list_webhooks( self, - applicant_id: StrictStr, - applicant_updater: ApplicantUpdater, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -16951,15 +16917,11 @@ def update_applicant( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Applicant: - """Update Applicant + ) -> WebhooksList: + """List webhooks - Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant + Lists all webhooks you've created. - :param applicant_id: (required) - :type applicant_id: str - :param applicant_updater: (required) - :type applicant_updater: ApplicantUpdater :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 @@ -16982,9 +16944,7 @@ def update_applicant( :return: Returns the result object. """ # noqa: E501 - _param = self._update_applicant_serialize( - applicant_id=applicant_id, - applicant_updater=applicant_updater, + _param = self._list_webhooks_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -16992,7 +16952,7 @@ def update_applicant( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Applicant", + '200': "WebhooksList", } response_data = self.api_client.call_api( *_param, @@ -17006,10 +16966,8 @@ def update_applicant( @validate_call - def update_applicant_with_http_info( + def list_webhooks_with_http_info( self, - applicant_id: StrictStr, - applicant_updater: ApplicantUpdater, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17022,15 +16980,11 @@ def update_applicant_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Applicant]: - """Update Applicant + ) -> ApiResponse[WebhooksList]: + """List webhooks - Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant + Lists all webhooks you've created. - :param applicant_id: (required) - :type applicant_id: str - :param applicant_updater: (required) - :type applicant_updater: ApplicantUpdater :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 @@ -17053,9 +17007,7 @@ def update_applicant_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._update_applicant_serialize( - applicant_id=applicant_id, - applicant_updater=applicant_updater, + _param = self._list_webhooks_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17063,7 +17015,7 @@ def update_applicant_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Applicant", + '200': "WebhooksList", } response_data = self.api_client.call_api( *_param, @@ -17077,10 +17029,8 @@ def update_applicant_with_http_info( @validate_call - def update_applicant_without_preload_content( + def list_webhooks_without_preload_content( self, - applicant_id: StrictStr, - applicant_updater: ApplicantUpdater, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17094,14 +17044,10 @@ def update_applicant_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Update Applicant + """List webhooks - Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant + Lists all webhooks you've created. - :param applicant_id: (required) - :type applicant_id: str - :param applicant_updater: (required) - :type applicant_updater: ApplicantUpdater :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 @@ -17124,9 +17070,7 @@ def update_applicant_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._update_applicant_serialize( - applicant_id=applicant_id, - applicant_updater=applicant_updater, + _param = self._list_webhooks_serialize( _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17134,7 +17078,7 @@ def update_applicant_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Applicant", + '200': "WebhooksList", } response_data = self.api_client.call_api( *_param, @@ -17143,10 +17087,8 @@ def update_applicant_without_preload_content( return response_data.response - def _update_applicant_serialize( + def _list_webhooks_serialize( self, - applicant_id, - applicant_updater, _request_auth, _content_type, _headers, @@ -17168,14 +17110,10 @@ def _update_applicant_serialize( _body_params: Optional[bytes] = None # process the path parameters - if applicant_id is not None: - _path_params['applicant_id'] = applicant_id # process the query parameters # process the header parameters # process the form parameters # process the body parameter - if applicant_updater is not None: - _body_params = applicant_updater # set the HTTP header `Accept` @@ -17186,19 +17124,6 @@ def _update_applicant_serialize( ] ) - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ @@ -17206,8 +17131,8 @@ def _update_applicant_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/applicants/{applicant_id}', + method='GET', + resource_path='/webhooks', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -17224,10 +17149,14 @@ def _update_applicant_serialize( @validate_call - def update_watchlist_monitor_match( + def list_workflow_runs( self, - monitor_id: StrictStr, - watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater, + page: Annotated[Optional[StrictInt], Field(description="The number of the page to be retrieved. If not specified, defaults to 1.")] = None, + status: Annotated[Optional[StrictStr], Field(description="A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.")] = None, + created_at_gt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date greater than (after) the one provided.")] = None, + created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None, + sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17240,15 +17169,23 @@ def update_watchlist_monitor_match( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> WatchlistMonitorMatchesList: - """Set match status (BETA) + ) -> List[WorkflowRun]: + """List Workflow Runs - Update the status of the given matches + Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects. - :param monitor_id: (required) - :type monitor_id: str - :param watchlist_monitor_matches_updater: (required) - :type watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater + :param page: The number of the page to be retrieved. If not specified, defaults to 1. + :type page: int + :param status: A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. + :type status: str + :param created_at_gt: A ISO-8601 date to filter results with a created date greater than (after) the one provided. + :type created_at_gt: datetime + :param created_at_lt: A ISO-8601 date to filter results with a created date less than (before) the one provided. + :type created_at_lt: datetime + :param sort: A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. + :type sort: str + :param applicant_id: the applicant's id. + :type applicant_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 @@ -17271,9 +17208,13 @@ def update_watchlist_monitor_match( :return: Returns the result object. """ # noqa: E501 - _param = self._update_watchlist_monitor_match_serialize( - monitor_id=monitor_id, - watchlist_monitor_matches_updater=watchlist_monitor_matches_updater, + _param = self._list_workflow_runs_serialize( + page=page, + status=status, + created_at_gt=created_at_gt, + created_at_lt=created_at_lt, + sort=sort, + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17281,7 +17222,7 @@ def update_watchlist_monitor_match( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorMatchesList", + '200': "List[WorkflowRun]", } response_data = self.api_client.call_api( *_param, @@ -17295,10 +17236,14 @@ def update_watchlist_monitor_match( @validate_call - def update_watchlist_monitor_match_with_http_info( + def list_workflow_runs_with_http_info( self, - monitor_id: StrictStr, - watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater, + page: Annotated[Optional[StrictInt], Field(description="The number of the page to be retrieved. If not specified, defaults to 1.")] = None, + status: Annotated[Optional[StrictStr], Field(description="A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.")] = None, + created_at_gt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date greater than (after) the one provided.")] = None, + created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None, + sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17311,15 +17256,23 @@ def update_watchlist_monitor_match_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[WatchlistMonitorMatchesList]: - """Set match status (BETA) + ) -> ApiResponse[List[WorkflowRun]]: + """List Workflow Runs - Update the status of the given matches + Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects. - :param monitor_id: (required) - :type monitor_id: str - :param watchlist_monitor_matches_updater: (required) - :type watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater + :param page: The number of the page to be retrieved. If not specified, defaults to 1. + :type page: int + :param status: A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. + :type status: str + :param created_at_gt: A ISO-8601 date to filter results with a created date greater than (after) the one provided. + :type created_at_gt: datetime + :param created_at_lt: A ISO-8601 date to filter results with a created date less than (before) the one provided. + :type created_at_lt: datetime + :param sort: A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. + :type sort: str + :param applicant_id: the applicant's id. + :type applicant_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 @@ -17342,9 +17295,13 @@ def update_watchlist_monitor_match_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._update_watchlist_monitor_match_serialize( - monitor_id=monitor_id, - watchlist_monitor_matches_updater=watchlist_monitor_matches_updater, + _param = self._list_workflow_runs_serialize( + page=page, + status=status, + created_at_gt=created_at_gt, + created_at_lt=created_at_lt, + sort=sort, + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17352,7 +17309,7 @@ def update_watchlist_monitor_match_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorMatchesList", + '200': "List[WorkflowRun]", } response_data = self.api_client.call_api( *_param, @@ -17366,10 +17323,14 @@ def update_watchlist_monitor_match_with_http_info( @validate_call - def update_watchlist_monitor_match_without_preload_content( + def list_workflow_runs_without_preload_content( self, - monitor_id: StrictStr, - watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater, + page: Annotated[Optional[StrictInt], Field(description="The number of the page to be retrieved. If not specified, defaults to 1.")] = None, + status: Annotated[Optional[StrictStr], Field(description="A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'.")] = None, + created_at_gt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date greater than (after) the one provided.")] = None, + created_at_lt: Annotated[Optional[datetime], Field(description="A ISO-8601 date to filter results with a created date less than (before) the one provided.")] = None, + sort: Annotated[Optional[StrictStr], Field(description="A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'.")] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="the applicant's id.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17383,14 +17344,22 @@ def update_watchlist_monitor_match_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Set match status (BETA) + """List Workflow Runs - Update the status of the given matches + Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects. - :param monitor_id: (required) - :type monitor_id: str - :param watchlist_monitor_matches_updater: (required) - :type watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater + :param page: The number of the page to be retrieved. If not specified, defaults to 1. + :type page: int + :param status: A list of comma separated status values to filter the results. Possible values are 'processing', 'awaiting_input', 'approved', 'declined', 'review', 'abandoned' and 'error'. + :type status: str + :param created_at_gt: A ISO-8601 date to filter results with a created date greater than (after) the one provided. + :type created_at_gt: datetime + :param created_at_lt: A ISO-8601 date to filter results with a created date less than (before) the one provided. + :type created_at_lt: datetime + :param sort: A string with the value 'desc' or 'asc' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to 'desc'. + :type sort: str + :param applicant_id: the applicant's id. + :type applicant_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 @@ -17413,9 +17382,13 @@ def update_watchlist_monitor_match_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._update_watchlist_monitor_match_serialize( - monitor_id=monitor_id, - watchlist_monitor_matches_updater=watchlist_monitor_matches_updater, + _param = self._list_workflow_runs_serialize( + page=page, + status=status, + created_at_gt=created_at_gt, + created_at_lt=created_at_lt, + sort=sort, + applicant_id=applicant_id, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17423,7 +17396,7 @@ def update_watchlist_monitor_match_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "WatchlistMonitorMatchesList", + '200': "List[WorkflowRun]", } response_data = self.api_client.call_api( *_param, @@ -17432,10 +17405,14 @@ def update_watchlist_monitor_match_without_preload_content( return response_data.response - def _update_watchlist_monitor_match_serialize( + def _list_workflow_runs_serialize( self, - monitor_id, - watchlist_monitor_matches_updater, + page, + status, + created_at_gt, + created_at_lt, + sort, + applicant_id, _request_auth, _content_type, _headers, @@ -17457,49 +17434,2832 @@ def _update_watchlist_monitor_match_serialize( _body_params: Optional[bytes] = None # process the path parameters - if monitor_id is not None: - _path_params['monitor_id'] = monitor_id # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if watchlist_monitor_matches_updater is not None: - _body_params = watchlist_monitor_matches_updater - - - # set the HTTP header `Accept` - if 'Accept' not in _header_params: - _header_params['Accept'] = self.api_client.select_header_accept( - [ - 'application/json' - ] - ) - - # set the HTTP header `Content-Type` - if _content_type: - _header_params['Content-Type'] = _content_type - else: - _default_content_type = ( - self.api_client.select_header_content_type( - [ - 'application/json' - ] - ) - ) - if _default_content_type is not None: - _header_params['Content-Type'] = _default_content_type - - # authentication setting - _auth_settings: List[str] = [ - 'Token' - ] - - return self.api_client.param_serialize( - method='PATCH', - resource_path='/watchlist_monitors/{monitor_id}/matches', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, + if page is not None: + + _query_params.append(('page', page)) + + if status is not None: + + _query_params.append(('status', status)) + + if created_at_gt is not None: + if isinstance(created_at_gt, datetime): + _query_params.append( + ( + 'created_at_gt', + created_at_gt.strftime( + self.api_client.configuration.datetime_format + ) + ) + ) + else: + _query_params.append(('created_at_gt', created_at_gt)) + + if created_at_lt is not None: + if isinstance(created_at_lt, datetime): + _query_params.append( + ( + 'created_at_lt', + created_at_lt.strftime( + self.api_client.configuration.datetime_format + ) + ) + ) + else: + _query_params.append(('created_at_lt', created_at_lt)) + + if sort is not None: + + _query_params.append(('sort', sort)) + + if applicant_id is not None: + + _query_params.append(('applicant_id', applicant_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/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/workflow_runs', + 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 ping( + self, + _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, + ) -> str: + """Ping + + Run a health check on the Onfido API + + :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._ping_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + 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 ping_with_http_info( + self, + _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[str]: + """Ping + + Run a health check on the Onfido API + + :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._ping_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + 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 ping_without_preload_content( + self, + _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: + """Ping + + Run a health check on the Onfido API + + :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._ping_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ping_serialize( + self, + _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 + # 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( + [ + 'text/plain', + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/ping', + 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 post_results_feedback( + self, + results_feedback: ResultsFeedback, + _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, + ) -> ResultsFeedback: + """Fraud reporting (ALPHA) + + Create Feedback on checks and reports + + :param results_feedback: (required) + :type results_feedback: ResultsFeedback + :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._post_results_feedback_serialize( + results_feedback=results_feedback, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultsFeedback", + } + 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 post_results_feedback_with_http_info( + self, + results_feedback: ResultsFeedback, + _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[ResultsFeedback]: + """Fraud reporting (ALPHA) + + Create Feedback on checks and reports + + :param results_feedback: (required) + :type results_feedback: ResultsFeedback + :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._post_results_feedback_serialize( + results_feedback=results_feedback, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultsFeedback", + } + 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 post_results_feedback_without_preload_content( + self, + results_feedback: ResultsFeedback, + _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: + """Fraud reporting (ALPHA) + + Create Feedback on checks and reports + + :param results_feedback: (required) + :type results_feedback: ResultsFeedback + :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._post_results_feedback_serialize( + results_feedback=results_feedback, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ResultsFeedback", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _post_results_feedback_serialize( + self, + results_feedback, + _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 + # process the header parameters + # process the form parameters + # process the body parameter + if results_feedback is not None: + _body_params = results_feedback + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/results_feedback', + 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 resend_webhooks( + self, + webhook_resend: WebhookResend, + _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, + ) -> None: + """Resends webhooks + + Resends events to all webhooks registered with a matching environment in your account. + + :param webhook_resend: (required) + :type webhook_resend: WebhookResend + :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._resend_webhooks_serialize( + webhook_resend=webhook_resend, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '422': None, + } + 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 resend_webhooks_with_http_info( + self, + webhook_resend: WebhookResend, + _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[None]: + """Resends webhooks + + Resends events to all webhooks registered with a matching environment in your account. + + :param webhook_resend: (required) + :type webhook_resend: WebhookResend + :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._resend_webhooks_serialize( + webhook_resend=webhook_resend, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '422': None, + } + 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 resend_webhooks_without_preload_content( + self, + webhook_resend: WebhookResend, + _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: + """Resends webhooks + + Resends events to all webhooks registered with a matching environment in your account. + + :param webhook_resend: (required) + :type webhook_resend: WebhookResend + :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._resend_webhooks_serialize( + webhook_resend=webhook_resend, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + '422': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resend_webhooks_serialize( + self, + webhook_resend, + _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 + # process the header parameters + # process the form parameters + # process the body parameter + if webhook_resend is not None: + _body_params = webhook_resend + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/webhooks/resend', + 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 restore_applicant( + self, + applicant_id: StrictStr, + _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, + ) -> None: + """Restore Applicant + + Restores a single applicant scheduled for deletion. + + :param applicant_id: (required) + :type applicant_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._restore_applicant_serialize( + applicant_id=applicant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + 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 restore_applicant_with_http_info( + self, + applicant_id: StrictStr, + _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[None]: + """Restore Applicant + + Restores a single applicant scheduled for deletion. + + :param applicant_id: (required) + :type applicant_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._restore_applicant_serialize( + applicant_id=applicant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + 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 restore_applicant_without_preload_content( + self, + applicant_id: StrictStr, + _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: + """Restore Applicant + + Restores a single applicant scheduled for deletion. + + :param applicant_id: (required) + :type applicant_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._restore_applicant_serialize( + applicant_id=applicant_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _restore_applicant_serialize( + self, + applicant_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 applicant_id is not None: + _path_params['applicant_id'] = applicant_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/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/applicants/{applicant_id}/restore', + 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 resume_check( + self, + check_id: StrictStr, + _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, + ) -> None: + """Resume a Check + + Resumes a paused check. + + :param check_id: (required) + :type check_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._resume_check_serialize( + check_id=check_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + 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 resume_check_with_http_info( + self, + check_id: StrictStr, + _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[None]: + """Resume a Check + + Resumes a paused check. + + :param check_id: (required) + :type check_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._resume_check_serialize( + check_id=check_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + 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 resume_check_without_preload_content( + self, + check_id: StrictStr, + _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: + """Resume a Check + + Resumes a paused check. + + :param check_id: (required) + :type check_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._resume_check_serialize( + check_id=check_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resume_check_serialize( + self, + check_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 check_id is not None: + _path_params['check_id'] = check_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/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/checks/{check_id}/resume', + 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 resume_report( + self, + report_id: StrictStr, + _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, + ) -> None: + """Resume report + + Resumes a single paused report. + + :param report_id: (required) + :type report_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._resume_report_serialize( + report_id=report_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + 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 resume_report_with_http_info( + self, + report_id: StrictStr, + _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[None]: + """Resume report + + Resumes a single paused report. + + :param report_id: (required) + :type report_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._resume_report_serialize( + report_id=report_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + 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 resume_report_without_preload_content( + self, + report_id: StrictStr, + _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: + """Resume report + + Resumes a single paused report. + + :param report_id: (required) + :type report_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._resume_report_serialize( + report_id=report_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _resume_report_serialize( + self, + report_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 report_id is not None: + _path_params['report_id'] = report_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/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/reports/{report_id}/resume', + 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 update_applicant( + self, + applicant_id: StrictStr, + applicant_updater: ApplicantUpdater, + _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, + ) -> Applicant: + """Update Applicant + + Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant + + :param applicant_id: (required) + :type applicant_id: str + :param applicant_updater: (required) + :type applicant_updater: ApplicantUpdater + :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._update_applicant_serialize( + applicant_id=applicant_id, + applicant_updater=applicant_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Applicant", + } + 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 update_applicant_with_http_info( + self, + applicant_id: StrictStr, + applicant_updater: ApplicantUpdater, + _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[Applicant]: + """Update Applicant + + Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant + + :param applicant_id: (required) + :type applicant_id: str + :param applicant_updater: (required) + :type applicant_updater: ApplicantUpdater + :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._update_applicant_serialize( + applicant_id=applicant_id, + applicant_updater=applicant_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Applicant", + } + 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 update_applicant_without_preload_content( + self, + applicant_id: StrictStr, + applicant_updater: ApplicantUpdater, + _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: + """Update Applicant + + Allows updating applicant's information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant + + :param applicant_id: (required) + :type applicant_id: str + :param applicant_updater: (required) + :type applicant_updater: ApplicantUpdater + :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._update_applicant_serialize( + applicant_id=applicant_id, + applicant_updater=applicant_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Applicant", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_applicant_serialize( + self, + applicant_id, + applicant_updater, + _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 applicant_id is not None: + _path_params['applicant_id'] = applicant_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if applicant_updater is not None: + _body_params = applicant_updater + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/applicants/{applicant_id}', + 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 update_passkey( + self, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], + passkey_updater: Annotated[PasskeyUpdater, Field(description="Passkey update payload.")], + _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, + ) -> Passkey: + """Update passkey + + Updates a passkey's state. + + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_id: str + :param passkey_updater: Passkey update payload. (required) + :type passkey_updater: PasskeyUpdater + :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._update_passkey_serialize( + username=username, + passkey_id=passkey_id, + passkey_updater=passkey_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Passkey", + '400': None, + '404': None, + } + 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 update_passkey_with_http_info( + self, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], + passkey_updater: Annotated[PasskeyUpdater, Field(description="Passkey update payload.")], + _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[Passkey]: + """Update passkey + + Updates a passkey's state. + + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_id: str + :param passkey_updater: Passkey update payload. (required) + :type passkey_updater: PasskeyUpdater + :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._update_passkey_serialize( + username=username, + passkey_id=passkey_id, + passkey_updater=passkey_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Passkey", + '400': None, + '404': None, + } + 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 update_passkey_without_preload_content( + self, + username: Annotated[StrictStr, Field(description="Username that owns the passkey.")], + passkey_id: Annotated[StrictStr, Field(description="Passkey ID.")], + passkey_updater: Annotated[PasskeyUpdater, Field(description="Passkey update payload.")], + _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: + """Update passkey + + Updates a passkey's state. + + :param username: Username that owns the passkey. (required) + :type username: str + :param passkey_id: Passkey ID. (required) + :type passkey_id: str + :param passkey_updater: Passkey update payload. (required) + :type passkey_updater: PasskeyUpdater + :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._update_passkey_serialize( + username=username, + passkey_id=passkey_id, + passkey_updater=passkey_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Passkey", + '400': None, + '404': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_passkey_serialize( + self, + username, + passkey_id, + passkey_updater, + _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 username is not None: + _path_params['username'] = username + if passkey_id is not None: + _path_params['passkey_id'] = passkey_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if passkey_updater is not None: + _body_params = passkey_updater + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/passkeys/{username}/{passkey_id}', + 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 update_watchlist_monitor_match( + self, + monitor_id: StrictStr, + watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater, + _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, + ) -> WatchlistMonitorMatchesList: + """Set match status (BETA) + + Update the status of the given matches + + :param monitor_id: (required) + :type monitor_id: str + :param watchlist_monitor_matches_updater: (required) + :type watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater + :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._update_watchlist_monitor_match_serialize( + monitor_id=monitor_id, + watchlist_monitor_matches_updater=watchlist_monitor_matches_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WatchlistMonitorMatchesList", + } + 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 update_watchlist_monitor_match_with_http_info( + self, + monitor_id: StrictStr, + watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater, + _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[WatchlistMonitorMatchesList]: + """Set match status (BETA) + + Update the status of the given matches + + :param monitor_id: (required) + :type monitor_id: str + :param watchlist_monitor_matches_updater: (required) + :type watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater + :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._update_watchlist_monitor_match_serialize( + monitor_id=monitor_id, + watchlist_monitor_matches_updater=watchlist_monitor_matches_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WatchlistMonitorMatchesList", + } + 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 update_watchlist_monitor_match_without_preload_content( + self, + monitor_id: StrictStr, + watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater, + _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: + """Set match status (BETA) + + Update the status of the given matches + + :param monitor_id: (required) + :type monitor_id: str + :param watchlist_monitor_matches_updater: (required) + :type watchlist_monitor_matches_updater: WatchlistMonitorMatchesUpdater + :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._update_watchlist_monitor_match_serialize( + monitor_id=monitor_id, + watchlist_monitor_matches_updater=watchlist_monitor_matches_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WatchlistMonitorMatchesList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_watchlist_monitor_match_serialize( + self, + monitor_id, + watchlist_monitor_matches_updater, + _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 monitor_id is not None: + _path_params['monitor_id'] = monitor_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if watchlist_monitor_matches_updater is not None: + _body_params = watchlist_monitor_matches_updater + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='PATCH', + resource_path='/watchlist_monitors/{monitor_id}/matches', + 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 update_webhook( + self, + webhook_id: StrictStr, + webhook_updater: WebhookUpdater, + _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, + ) -> Webhook: + """Edit a webhook + + Edits a webhook. Returns the updated webhook object. + + :param webhook_id: (required) + :type webhook_id: str + :param webhook_updater: (required) + :type webhook_updater: WebhookUpdater + :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._update_webhook_serialize( + webhook_id=webhook_id, + webhook_updater=webhook_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Webhook", + } + 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 update_webhook_with_http_info( + self, + webhook_id: StrictStr, + webhook_updater: WebhookUpdater, + _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[Webhook]: + """Edit a webhook + + Edits a webhook. Returns the updated webhook object. + + :param webhook_id: (required) + :type webhook_id: str + :param webhook_updater: (required) + :type webhook_updater: WebhookUpdater + :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._update_webhook_serialize( + webhook_id=webhook_id, + webhook_updater=webhook_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Webhook", + } + 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 update_webhook_without_preload_content( + self, + webhook_id: StrictStr, + webhook_updater: WebhookUpdater, + _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: + """Edit a webhook + + Edits a webhook. Returns the updated webhook object. + + :param webhook_id: (required) + :type webhook_id: str + :param webhook_updater: (required) + :type webhook_updater: WebhookUpdater + :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._update_webhook_serialize( + webhook_id=webhook_id, + webhook_updater=webhook_updater, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "Webhook", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _update_webhook_serialize( + self, + webhook_id, + webhook_updater, + _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 webhook_id is not None: + _path_params['webhook_id'] = webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if webhook_updater is not None: + _body_params = webhook_updater + + + # set the HTTP header `Accept` + if 'Accept' not in _header_params: + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Token' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/webhooks/{webhook_id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, @@ -17513,10 +20273,16 @@ def _update_watchlist_monitor_match_serialize( @validate_call - def update_webhook( + def upload_document( self, - webhook_id: StrictStr, - webhook_updater: WebhookUpdater, + type: Annotated[StrictStr, Field(description="The type of document")], + applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose document is being uploaded.")], + file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], + file_type: Annotated[Optional[StrictStr], Field(description="The file type of the uploaded file")] = None, + side: Annotated[Optional[StrictStr], Field(description="The side of the document, if applicable. The possible values are front and back")] = None, + issuing_country: Annotated[Optional[StrictStr], Field(description="The issuing country of the document, a 3-letter ISO code.")] = None, + validate_image_quality: Annotated[Optional[StrictBool], Field(description="Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.")] = None, + location: Optional[LocationBuilder] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17529,15 +20295,27 @@ def update_webhook( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> Webhook: - """Edit a webhook + ) -> Document: + """Upload a document - Edits a webhook. Returns the updated webhook object. + Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB. - :param webhook_id: (required) - :type webhook_id: str - :param webhook_updater: (required) - :type webhook_updater: WebhookUpdater + :param type: The type of document (required) + :type type: DocumentTypes + :param applicant_id: The ID of the applicant whose document is being uploaded. (required) + :type applicant_id: str + :param file: The file to be uploaded. (required) + :type file: bytearray + :param file_type: The file type of the uploaded file + :type file_type: str + :param side: The side of the document, if applicable. The possible values are front and back + :type side: str + :param issuing_country: The issuing country of the document, a 3-letter ISO code. + :type issuing_country: CountryCodes + :param validate_image_quality: Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. + :type validate_image_quality: bool + :param location: + :type location: LocationBuilder :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 @@ -17560,9 +20338,15 @@ def update_webhook( :return: Returns the result object. """ # noqa: E501 - _param = self._update_webhook_serialize( - webhook_id=webhook_id, - webhook_updater=webhook_updater, + _param = self._upload_document_serialize( + type=type, + applicant_id=applicant_id, + file=file, + file_type=file_type, + side=side, + issuing_country=issuing_country, + validate_image_quality=validate_image_quality, + location=location, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17570,7 +20354,7 @@ def update_webhook( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Webhook", + '201': "Document", } response_data = self.api_client.call_api( *_param, @@ -17584,10 +20368,16 @@ def update_webhook( @validate_call - def update_webhook_with_http_info( + def upload_document_with_http_info( self, - webhook_id: StrictStr, - webhook_updater: WebhookUpdater, + type: Annotated[StrictStr, Field(description="The type of document")], + applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose document is being uploaded.")], + file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], + file_type: Annotated[Optional[StrictStr], Field(description="The file type of the uploaded file")] = None, + side: Annotated[Optional[StrictStr], Field(description="The side of the document, if applicable. The possible values are front and back")] = None, + issuing_country: Annotated[Optional[StrictStr], Field(description="The issuing country of the document, a 3-letter ISO code.")] = None, + validate_image_quality: Annotated[Optional[StrictBool], Field(description="Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.")] = None, + location: Optional[LocationBuilder] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17600,15 +20390,27 @@ def update_webhook_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Webhook]: - """Edit a webhook + ) -> ApiResponse[Document]: + """Upload a document - Edits a webhook. Returns the updated webhook object. + Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB. - :param webhook_id: (required) - :type webhook_id: str - :param webhook_updater: (required) - :type webhook_updater: WebhookUpdater + :param type: The type of document (required) + :type type: DocumentTypes + :param applicant_id: The ID of the applicant whose document is being uploaded. (required) + :type applicant_id: str + :param file: The file to be uploaded. (required) + :type file: bytearray + :param file_type: The file type of the uploaded file + :type file_type: str + :param side: The side of the document, if applicable. The possible values are front and back + :type side: str + :param issuing_country: The issuing country of the document, a 3-letter ISO code. + :type issuing_country: CountryCodes + :param validate_image_quality: Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. + :type validate_image_quality: bool + :param location: + :type location: LocationBuilder :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 @@ -17631,9 +20433,15 @@ def update_webhook_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._update_webhook_serialize( - webhook_id=webhook_id, - webhook_updater=webhook_updater, + _param = self._upload_document_serialize( + type=type, + applicant_id=applicant_id, + file=file, + file_type=file_type, + side=side, + issuing_country=issuing_country, + validate_image_quality=validate_image_quality, + location=location, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17641,7 +20449,7 @@ def update_webhook_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Webhook", + '201': "Document", } response_data = self.api_client.call_api( *_param, @@ -17655,10 +20463,16 @@ def update_webhook_with_http_info( @validate_call - def update_webhook_without_preload_content( + def upload_document_without_preload_content( self, - webhook_id: StrictStr, - webhook_updater: WebhookUpdater, + type: Annotated[StrictStr, Field(description="The type of document")], + applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose document is being uploaded.")], + file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], + file_type: Annotated[Optional[StrictStr], Field(description="The file type of the uploaded file")] = None, + side: Annotated[Optional[StrictStr], Field(description="The side of the document, if applicable. The possible values are front and back")] = None, + issuing_country: Annotated[Optional[StrictStr], Field(description="The issuing country of the document, a 3-letter ISO code.")] = None, + validate_image_quality: Annotated[Optional[StrictBool], Field(description="Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.")] = None, + location: Optional[LocationBuilder] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17672,14 +20486,26 @@ def update_webhook_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Edit a webhook + """Upload a document - Edits a webhook. Returns the updated webhook object. + Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB. - :param webhook_id: (required) - :type webhook_id: str - :param webhook_updater: (required) - :type webhook_updater: WebhookUpdater + :param type: The type of document (required) + :type type: DocumentTypes + :param applicant_id: The ID of the applicant whose document is being uploaded. (required) + :type applicant_id: str + :param file: The file to be uploaded. (required) + :type file: bytearray + :param file_type: The file type of the uploaded file + :type file_type: str + :param side: The side of the document, if applicable. The possible values are front and back + :type side: str + :param issuing_country: The issuing country of the document, a 3-letter ISO code. + :type issuing_country: CountryCodes + :param validate_image_quality: Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. + :type validate_image_quality: bool + :param location: + :type location: LocationBuilder :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 @@ -17702,9 +20528,15 @@ def update_webhook_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._update_webhook_serialize( - webhook_id=webhook_id, - webhook_updater=webhook_updater, + _param = self._upload_document_serialize( + type=type, + applicant_id=applicant_id, + file=file, + file_type=file_type, + side=side, + issuing_country=issuing_country, + validate_image_quality=validate_image_quality, + location=location, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17712,7 +20544,7 @@ def update_webhook_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "Webhook", + '201': "Document", } response_data = self.api_client.call_api( *_param, @@ -17721,10 +20553,16 @@ def update_webhook_without_preload_content( return response_data.response - def _update_webhook_serialize( + def _upload_document_serialize( self, - webhook_id, - webhook_updater, + type, + applicant_id, + file, + file_type, + side, + issuing_country, + validate_image_quality, + location, _request_auth, _content_type, _headers, @@ -17746,14 +20584,26 @@ def _update_webhook_serialize( _body_params: Optional[bytes] = None # process the path parameters - if webhook_id is not None: - _path_params['webhook_id'] = webhook_id # process the query parameters # process the header parameters # process the form parameters + if file_type is not None: + _form_params.append(('file_type', file_type)) + if type is not None: + _form_params.append(('type', type)) + if side is not None: + _form_params.append(('side', side)) + if issuing_country is not None: + _form_params.append(('issuing_country', issuing_country)) + if applicant_id is not None: + _form_params.append(('applicant_id', applicant_id)) + if file is not None: + _files['file'] = file + if validate_image_quality is not None: + _form_params.append(('validate_image_quality', validate_image_quality)) + if location is not None: + _form_params.append(('location', location)) # process the body parameter - if webhook_updater is not None: - _body_params = webhook_updater # set the HTTP header `Accept` @@ -17771,7 +20621,7 @@ def _update_webhook_serialize( _default_content_type = ( self.api_client.select_header_content_type( [ - 'application/json' + 'multipart/form-data' ] ) ) @@ -17784,8 +20634,8 @@ def _update_webhook_serialize( ] return self.api_client.param_serialize( - method='PUT', - resource_path='/webhooks/{webhook_id}', + method='POST', + resource_path='/documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -17802,16 +20652,10 @@ def _update_webhook_serialize( @validate_call - def upload_document( + def upload_id_photo( self, - type: Annotated[StrictStr, Field(description="The type of document")], - applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose document is being uploaded.")], - file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], - file_type: Annotated[Optional[StrictStr], Field(description="The file type of the uploaded file")] = None, - side: Annotated[Optional[StrictStr], Field(description="The side of the document, if applicable. The possible values are front and back")] = None, - issuing_country: Annotated[Optional[StrictStr], Field(description="The issuing country of the document, a 3-letter ISO code.")] = None, - validate_image_quality: Annotated[Optional[StrictBool], Field(description="Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.")] = None, - location: Optional[LocationBuilder] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose ID photo is being uploaded.")] = None, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17823,28 +20667,16 @@ def upload_document( _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, - ) -> Document: - """Upload a document + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> IdPhoto: + """Upload ID photo - Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB. + You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. - :param type: The type of document (required) - :type type: DocumentTypes - :param applicant_id: The ID of the applicant whose document is being uploaded. (required) + :param applicant_id: The ID of the applicant whose ID photo is being uploaded. :type applicant_id: str - :param file: The file to be uploaded. (required) + :param file: The file to be uploaded. :type file: bytearray - :param file_type: The file type of the uploaded file - :type file_type: str - :param side: The side of the document, if applicable. The possible values are front and back - :type side: str - :param issuing_country: The issuing country of the document, a 3-letter ISO code. - :type issuing_country: CountryCodes - :param validate_image_quality: Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. - :type validate_image_quality: bool - :param location: - :type location: LocationBuilder :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 @@ -17867,15 +20699,9 @@ def upload_document( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_document_serialize( - type=type, + _param = self._upload_id_photo_serialize( applicant_id=applicant_id, file=file, - file_type=file_type, - side=side, - issuing_country=issuing_country, - validate_image_quality=validate_image_quality, - location=location, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17883,7 +20709,7 @@ def upload_document( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "Document", + '201': "IdPhoto", } response_data = self.api_client.call_api( *_param, @@ -17897,16 +20723,10 @@ def upload_document( @validate_call - def upload_document_with_http_info( + def upload_id_photo_with_http_info( self, - type: Annotated[StrictStr, Field(description="The type of document")], - applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose document is being uploaded.")], - file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], - file_type: Annotated[Optional[StrictStr], Field(description="The file type of the uploaded file")] = None, - side: Annotated[Optional[StrictStr], Field(description="The side of the document, if applicable. The possible values are front and back")] = None, - issuing_country: Annotated[Optional[StrictStr], Field(description="The issuing country of the document, a 3-letter ISO code.")] = None, - validate_image_quality: Annotated[Optional[StrictBool], Field(description="Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.")] = None, - location: Optional[LocationBuilder] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose ID photo is being uploaded.")] = None, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -17919,27 +20739,15 @@ def upload_document_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[Document]: - """Upload a document + ) -> ApiResponse[IdPhoto]: + """Upload ID photo - Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB. + You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. - :param type: The type of document (required) - :type type: DocumentTypes - :param applicant_id: The ID of the applicant whose document is being uploaded. (required) + :param applicant_id: The ID of the applicant whose ID photo is being uploaded. :type applicant_id: str - :param file: The file to be uploaded. (required) + :param file: The file to be uploaded. :type file: bytearray - :param file_type: The file type of the uploaded file - :type file_type: str - :param side: The side of the document, if applicable. The possible values are front and back - :type side: str - :param issuing_country: The issuing country of the document, a 3-letter ISO code. - :type issuing_country: CountryCodes - :param validate_image_quality: Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. - :type validate_image_quality: bool - :param location: - :type location: LocationBuilder :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 @@ -17962,15 +20770,9 @@ def upload_document_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_document_serialize( - type=type, + _param = self._upload_id_photo_serialize( applicant_id=applicant_id, file=file, - file_type=file_type, - side=side, - issuing_country=issuing_country, - validate_image_quality=validate_image_quality, - location=location, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -17978,7 +20780,7 @@ def upload_document_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "Document", + '201': "IdPhoto", } response_data = self.api_client.call_api( *_param, @@ -17992,16 +20794,10 @@ def upload_document_with_http_info( @validate_call - def upload_document_without_preload_content( + def upload_id_photo_without_preload_content( self, - type: Annotated[StrictStr, Field(description="The type of document")], - applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose document is being uploaded.")], - file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], - file_type: Annotated[Optional[StrictStr], Field(description="The file type of the uploaded file")] = None, - side: Annotated[Optional[StrictStr], Field(description="The side of the document, if applicable. The possible values are front and back")] = None, - issuing_country: Annotated[Optional[StrictStr], Field(description="The issuing country of the document, a 3-letter ISO code.")] = None, - validate_image_quality: Annotated[Optional[StrictBool], Field(description="Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.")] = None, - location: Optional[LocationBuilder] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose ID photo is being uploaded.")] = None, + file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -18015,26 +20811,14 @@ def upload_document_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Upload a document + """Upload ID photo - Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB. + You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. - :param type: The type of document (required) - :type type: DocumentTypes - :param applicant_id: The ID of the applicant whose document is being uploaded. (required) + :param applicant_id: The ID of the applicant whose ID photo is being uploaded. :type applicant_id: str - :param file: The file to be uploaded. (required) + :param file: The file to be uploaded. :type file: bytearray - :param file_type: The file type of the uploaded file - :type file_type: str - :param side: The side of the document, if applicable. The possible values are front and back - :type side: str - :param issuing_country: The issuing country of the document, a 3-letter ISO code. - :type issuing_country: CountryCodes - :param validate_image_quality: Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds. - :type validate_image_quality: bool - :param location: - :type location: LocationBuilder :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 @@ -18057,15 +20841,9 @@ def upload_document_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_document_serialize( - type=type, + _param = self._upload_id_photo_serialize( applicant_id=applicant_id, file=file, - file_type=file_type, - side=side, - issuing_country=issuing_country, - validate_image_quality=validate_image_quality, - location=location, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -18073,7 +20851,7 @@ def upload_document_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "Document", + '201': "IdPhoto", } response_data = self.api_client.call_api( *_param, @@ -18082,16 +20860,10 @@ def upload_document_without_preload_content( return response_data.response - def _upload_document_serialize( + def _upload_id_photo_serialize( self, - type, applicant_id, file, - file_type, - side, - issuing_country, - validate_image_quality, - location, _request_auth, _content_type, _headers, @@ -18116,22 +20888,10 @@ def _upload_document_serialize( # process the query parameters # process the header parameters # process the form parameters - if file_type is not None: - _form_params.append(('file_type', file_type)) - if type is not None: - _form_params.append(('type', type)) - if side is not None: - _form_params.append(('side', side)) - if issuing_country is not None: - _form_params.append(('issuing_country', issuing_country)) if applicant_id is not None: _form_params.append(('applicant_id', applicant_id)) if file is not None: _files['file'] = file - if validate_image_quality is not None: - _form_params.append(('validate_image_quality', validate_image_quality)) - if location is not None: - _form_params.append(('location', location)) # process the body parameter @@ -18164,7 +20924,7 @@ def _upload_document_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/documents', + resource_path='/id_photos', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -18181,10 +20941,11 @@ def _upload_document_serialize( @validate_call - def upload_id_photo( + def upload_live_photo( self, - applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose ID photo is being uploaded.")] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose live photo is being uploaded.")] = None, file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, + advanced_validation: Annotated[Optional[StrictBool], Field(description="Validates that the live photo contains exactly one face.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -18197,15 +20958,17 @@ def upload_id_photo( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> IdPhoto: - """Upload ID photo + ) -> LivePhoto: + """Upload live photo - You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. + You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false. - :param applicant_id: The ID of the applicant whose ID photo is being uploaded. + :param applicant_id: The ID of the applicant whose live photo is being uploaded. :type applicant_id: str :param file: The file to be uploaded. :type file: bytearray + :param advanced_validation: Validates that the live photo contains exactly one face. + :type advanced_validation: bool :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 @@ -18228,9 +20991,10 @@ def upload_id_photo( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_id_photo_serialize( + _param = self._upload_live_photo_serialize( applicant_id=applicant_id, file=file, + advanced_validation=advanced_validation, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -18238,7 +21002,7 @@ def upload_id_photo( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "IdPhoto", + '201': "LivePhoto", } response_data = self.api_client.call_api( *_param, @@ -18252,10 +21016,11 @@ def upload_id_photo( @validate_call - def upload_id_photo_with_http_info( + def upload_live_photo_with_http_info( self, - applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose ID photo is being uploaded.")] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose live photo is being uploaded.")] = None, file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, + advanced_validation: Annotated[Optional[StrictBool], Field(description="Validates that the live photo contains exactly one face.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -18268,15 +21033,17 @@ def upload_id_photo_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[IdPhoto]: - """Upload ID photo + ) -> ApiResponse[LivePhoto]: + """Upload live photo - You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. + You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false. - :param applicant_id: The ID of the applicant whose ID photo is being uploaded. + :param applicant_id: The ID of the applicant whose live photo is being uploaded. :type applicant_id: str :param file: The file to be uploaded. :type file: bytearray + :param advanced_validation: Validates that the live photo contains exactly one face. + :type advanced_validation: bool :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 @@ -18299,9 +21066,10 @@ def upload_id_photo_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_id_photo_serialize( + _param = self._upload_live_photo_serialize( applicant_id=applicant_id, file=file, + advanced_validation=advanced_validation, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -18309,7 +21077,7 @@ def upload_id_photo_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "IdPhoto", + '201': "LivePhoto", } response_data = self.api_client.call_api( *_param, @@ -18323,10 +21091,11 @@ def upload_id_photo_with_http_info( @validate_call - def upload_id_photo_without_preload_content( + def upload_live_photo_without_preload_content( self, - applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose ID photo is being uploaded.")] = None, + applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose live photo is being uploaded.")] = None, file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, + advanced_validation: Annotated[Optional[StrictBool], Field(description="Validates that the live photo contains exactly one face.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -18340,14 +21109,16 @@ def upload_id_photo_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Upload ID photo + """Upload live photo - You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. + You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false. - :param applicant_id: The ID of the applicant whose ID photo is being uploaded. + :param applicant_id: The ID of the applicant whose live photo is being uploaded. :type applicant_id: str :param file: The file to be uploaded. :type file: bytearray + :param advanced_validation: Validates that the live photo contains exactly one face. + :type advanced_validation: bool :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 @@ -18370,9 +21141,10 @@ def upload_id_photo_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_id_photo_serialize( + _param = self._upload_live_photo_serialize( applicant_id=applicant_id, file=file, + advanced_validation=advanced_validation, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -18380,7 +21152,7 @@ def upload_id_photo_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "IdPhoto", + '201': "LivePhoto", } response_data = self.api_client.call_api( *_param, @@ -18389,10 +21161,11 @@ def upload_id_photo_without_preload_content( return response_data.response - def _upload_id_photo_serialize( + def _upload_live_photo_serialize( self, applicant_id, file, + advanced_validation, _request_auth, _content_type, _headers, @@ -18421,6 +21194,8 @@ def _upload_id_photo_serialize( _form_params.append(('applicant_id', applicant_id)) if file is not None: _files['file'] = file + if advanced_validation is not None: + _form_params.append(('advanced_validation', advanced_validation)) # process the body parameter @@ -18453,7 +21228,7 @@ def _upload_id_photo_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/id_photos', + resource_path='/live_photos', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -18470,11 +21245,10 @@ def _upload_id_photo_serialize( @validate_call - def upload_live_photo( + def upload_signing_document( self, - applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose live photo is being uploaded.")] = None, - file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, - advanced_validation: Annotated[Optional[StrictBool], Field(description="Validates that the live photo contains exactly one face.")] = None, + applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose signing document is being uploaded.")], + file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -18487,17 +21261,15 @@ def upload_live_photo( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> LivePhoto: - """Upload live photo + ) -> SigningDocument: + """Upload a signing document - You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false. + Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB. - :param applicant_id: The ID of the applicant whose live photo is being uploaded. + :param applicant_id: The ID of the applicant whose signing document is being uploaded. (required) :type applicant_id: str - :param file: The file to be uploaded. + :param file: The file to be uploaded. (required) :type file: bytearray - :param advanced_validation: Validates that the live photo contains exactly one face. - :type advanced_validation: bool :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 @@ -18520,10 +21292,9 @@ def upload_live_photo( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_live_photo_serialize( + _param = self._upload_signing_document_serialize( applicant_id=applicant_id, file=file, - advanced_validation=advanced_validation, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -18531,7 +21302,7 @@ def upload_live_photo( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "LivePhoto", + '201': "SigningDocument", } response_data = self.api_client.call_api( *_param, @@ -18545,11 +21316,10 @@ def upload_live_photo( @validate_call - def upload_live_photo_with_http_info( + def upload_signing_document_with_http_info( self, - applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose live photo is being uploaded.")] = None, - file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, - advanced_validation: Annotated[Optional[StrictBool], Field(description="Validates that the live photo contains exactly one face.")] = None, + applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose signing document is being uploaded.")], + file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -18562,17 +21332,15 @@ def upload_live_photo_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[LivePhoto]: - """Upload live photo + ) -> ApiResponse[SigningDocument]: + """Upload a signing document - You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false. + Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB. - :param applicant_id: The ID of the applicant whose live photo is being uploaded. + :param applicant_id: The ID of the applicant whose signing document is being uploaded. (required) :type applicant_id: str - :param file: The file to be uploaded. + :param file: The file to be uploaded. (required) :type file: bytearray - :param advanced_validation: Validates that the live photo contains exactly one face. - :type advanced_validation: bool :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 @@ -18595,10 +21363,9 @@ def upload_live_photo_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_live_photo_serialize( + _param = self._upload_signing_document_serialize( applicant_id=applicant_id, file=file, - advanced_validation=advanced_validation, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -18606,7 +21373,7 @@ def upload_live_photo_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "LivePhoto", + '201': "SigningDocument", } response_data = self.api_client.call_api( *_param, @@ -18620,11 +21387,10 @@ def upload_live_photo_with_http_info( @validate_call - def upload_live_photo_without_preload_content( + def upload_signing_document_without_preload_content( self, - applicant_id: Annotated[Optional[StrictStr], Field(description="The ID of the applicant whose live photo is being uploaded.")] = None, - file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The file to be uploaded.")] = None, - advanced_validation: Annotated[Optional[StrictBool], Field(description="Validates that the live photo contains exactly one face.")] = None, + applicant_id: Annotated[StrictStr, Field(description="The ID of the applicant whose signing document is being uploaded.")], + file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The file to be uploaded.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -18638,16 +21404,14 @@ def upload_live_photo_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Upload live photo + """Upload a signing document - You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false. + Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB. - :param applicant_id: The ID of the applicant whose live photo is being uploaded. + :param applicant_id: The ID of the applicant whose signing document is being uploaded. (required) :type applicant_id: str - :param file: The file to be uploaded. + :param file: The file to be uploaded. (required) :type file: bytearray - :param advanced_validation: Validates that the live photo contains exactly one face. - :type advanced_validation: bool :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 @@ -18670,10 +21434,9 @@ def upload_live_photo_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._upload_live_photo_serialize( + _param = self._upload_signing_document_serialize( applicant_id=applicant_id, file=file, - advanced_validation=advanced_validation, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -18681,7 +21444,7 @@ def upload_live_photo_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '201': "LivePhoto", + '201': "SigningDocument", } response_data = self.api_client.call_api( *_param, @@ -18690,11 +21453,10 @@ def upload_live_photo_without_preload_content( return response_data.response - def _upload_live_photo_serialize( + def _upload_signing_document_serialize( self, applicant_id, file, - advanced_validation, _request_auth, _content_type, _headers, @@ -18723,8 +21485,6 @@ def _upload_live_photo_serialize( _form_params.append(('applicant_id', applicant_id)) if file is not None: _files['file'] = file - if advanced_validation is not None: - _form_params.append(('advanced_validation', advanced_validation)) # process the body parameter @@ -18757,7 +21517,7 @@ def _upload_live_photo_serialize( return self.api_client.param_serialize( method='POST', - resource_path='/live_photos', + resource_path='/signing_documents', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/onfido/api_client.py b/onfido/api_client.py index 490d82b..00144e8 100644 --- a/onfido/api_client.py +++ b/onfido/api_client.py @@ -90,7 +90,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'onfido-python/5.6.0' + self.user_agent = 'onfido-python/5.7.0' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/onfido/configuration.py b/onfido/configuration.py index da7dbbb..8d71f50 100644 --- a/onfido/configuration.py +++ b/onfido/configuration.py @@ -501,7 +501,7 @@ def to_debug_report(self) -> str: "OS: {env}\n"\ "Python Version: {pyversion}\n"\ "Version of the API: v3.6\n"\ - "SDK Package Version: 5.6.0".\ + "SDK Package Version: 5.7.0".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self) -> List[HostSetting]: diff --git a/onfido/models/__init__.py b/onfido/models/__init__.py index 78465e2..9eb29a8 100644 --- a/onfido/models/__init__.py +++ b/onfido/models/__init__.py @@ -215,6 +215,9 @@ from onfido.models.location_shared import LocationShared from onfido.models.motion_capture import MotionCapture from onfido.models.motion_captures_list import MotionCapturesList +from onfido.models.passkey import Passkey +from onfido.models.passkey_updater import PasskeyUpdater +from onfido.models.passkeys_list import PasskeysList from onfido.models.photo_auto_reasons import PhotoAutoReasons from onfido.models.photo_reasons import PhotoReasons from onfido.models.proof_of_address_breakdown import ProofOfAddressBreakdown @@ -243,6 +246,10 @@ from onfido.models.sdk_token_builder import SdkTokenBuilder from onfido.models.sdk_token_request import SdkTokenRequest from onfido.models.sdk_token_response import SdkTokenResponse +from onfido.models.signing_document import SigningDocument +from onfido.models.signing_document_response import SigningDocumentResponse +from onfido.models.signing_document_shared import SigningDocumentShared +from onfido.models.signing_documents_list import SigningDocumentsList from onfido.models.task import Task from onfido.models.task_item import TaskItem from onfido.models.timeline_file_reference import TimelineFileReference diff --git a/onfido/models/passkey.py b/onfido/models/passkey.py new file mode 100644 index 0000000..e7bfe26 --- /dev/null +++ b/onfido/models/passkey.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Onfido Public 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) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class Passkey(BaseModel): + """ + Passkey + """ # noqa: E501 + id: StrictStr = Field(description="Passkey identifier.") + application_domain: StrictStr = Field(description="domain that the passkey is registered to, the rpId.") + state: StrictStr = Field(description="Current passkey state.") + created_at: datetime = Field(description="Timestamp when the passkey was created.") + last_used_at: Optional[datetime] = Field(default=None, description="Timestamp when the passkey was last used.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["id", "application_domain", "state", "created_at", "last_used_at"] + + @field_validator('state') + def state_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['ACTIVE', 'INACTIVE', 'unknown_default_open_api']): + raise ValueError("must be one of enum values ('ACTIVE', 'INACTIVE', 'unknown_default_open_api')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Passkey from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Passkey from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "application_domain": obj.get("application_domain"), + "state": obj.get("state"), + "created_at": obj.get("created_at"), + "last_used_at": obj.get("last_used_at") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/onfido/models/passkey_updater.py b/onfido/models/passkey_updater.py new file mode 100644 index 0000000..ecce673 --- /dev/null +++ b/onfido/models/passkey_updater.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + Onfido Public 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) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self + +class PasskeyUpdater(BaseModel): + """ + PasskeyUpdater + """ # noqa: E501 + state: StrictStr = Field(description="Desired passkey state value.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["state"] + + @field_validator('state') + def state_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['ACTIVE', 'INACTIVE', 'unknown_default_open_api']): + raise ValueError("must be one of enum values ('ACTIVE', 'INACTIVE', 'unknown_default_open_api')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PasskeyUpdater from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PasskeyUpdater from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "state": obj.get("state") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/onfido/models/passkeys_list.py b/onfido/models/passkeys_list.py new file mode 100644 index 0000000..c01b130 --- /dev/null +++ b/onfido/models/passkeys_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + Onfido Public 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) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from onfido.models.passkey import Passkey +from typing import Optional, Set +from typing_extensions import Self + +class PasskeysList(BaseModel): + """ + PasskeysList + """ # noqa: E501 + passkeys: List[Passkey] + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["passkeys"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PasskeysList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in passkeys (list) + _items = [] + if self.passkeys: + for _item_passkeys in self.passkeys: + if _item_passkeys: + _items.append(_item_passkeys.to_dict()) + _dict['passkeys'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PasskeysList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "passkeys": [Passkey.from_dict(_item) for _item in obj["passkeys"]] if obj.get("passkeys") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/onfido/models/signing_document.py b/onfido/models/signing_document.py new file mode 100644 index 0000000..e4807b5 --- /dev/null +++ b/onfido/models/signing_document.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + Onfido Public 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) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SigningDocument(BaseModel): + """ + SigningDocument + """ # noqa: E501 + applicant_id: Optional[StrictStr] = Field(default=None, description="The ID of the applicant whose signing document is being uploaded.") + id: StrictStr = Field(description="The unique identifier for the signing document") + created_at: Optional[datetime] = Field(default=None, description="The date and time at which the signing document was uploaded") + href: Optional[StrictStr] = Field(default=None, description="The uri of this resource") + download_href: Optional[StrictStr] = Field(default=None, description="The uri that can be used to download the signing document") + file_type: Optional[StrictStr] = Field(default=None, description="The file type of the uploaded file") + file_name: Optional[StrictStr] = Field(default=None, description="The name of the uploaded file") + file_size: Optional[StrictInt] = Field(default=None, description="The size of the file in bytes") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["applicant_id", "id", "created_at", "href", "download_href", "file_type", "file_name", "file_size"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SigningDocument from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SigningDocument from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applicant_id": obj.get("applicant_id"), + "id": obj.get("id"), + "created_at": obj.get("created_at"), + "href": obj.get("href"), + "download_href": obj.get("download_href"), + "file_type": obj.get("file_type"), + "file_name": obj.get("file_name"), + "file_size": obj.get("file_size") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/onfido/models/signing_document_response.py b/onfido/models/signing_document_response.py new file mode 100644 index 0000000..4081235 --- /dev/null +++ b/onfido/models/signing_document_response.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + Onfido Public 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) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from datetime import datetime +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SigningDocumentResponse(BaseModel): + """ + SigningDocumentResponse + """ # noqa: E501 + id: StrictStr = Field(description="The unique identifier for the signing document") + created_at: Optional[datetime] = Field(default=None, description="The date and time at which the signing document was uploaded") + href: Optional[StrictStr] = Field(default=None, description="The uri of this resource") + download_href: Optional[StrictStr] = Field(default=None, description="The uri that can be used to download the signing document") + file_type: Optional[StrictStr] = Field(default=None, description="The file type of the uploaded file") + file_name: Optional[StrictStr] = Field(default=None, description="The name of the uploaded file") + file_size: Optional[StrictInt] = Field(default=None, description="The size of the file in bytes") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["id", "created_at", "href", "download_href", "file_type", "file_name", "file_size"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SigningDocumentResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SigningDocumentResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "id": obj.get("id"), + "created_at": obj.get("created_at"), + "href": obj.get("href"), + "download_href": obj.get("download_href"), + "file_type": obj.get("file_type"), + "file_name": obj.get("file_name"), + "file_size": obj.get("file_size") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/onfido/models/signing_document_shared.py b/onfido/models/signing_document_shared.py new file mode 100644 index 0000000..b100314 --- /dev/null +++ b/onfido/models/signing_document_shared.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Onfido Public 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) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + +class SigningDocumentShared(BaseModel): + """ + SigningDocumentShared + """ # noqa: E501 + applicant_id: Optional[StrictStr] = Field(default=None, description="The ID of the applicant whose signing document is being uploaded.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["applicant_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SigningDocumentShared from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SigningDocumentShared from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "applicant_id": obj.get("applicant_id") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/onfido/models/signing_documents_list.py b/onfido/models/signing_documents_list.py new file mode 100644 index 0000000..8fdb0e3 --- /dev/null +++ b/onfido/models/signing_documents_list.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + Onfido Public 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) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List +from onfido.models.signing_document import SigningDocument +from typing import Optional, Set +from typing_extensions import Self + +class SigningDocumentsList(BaseModel): + """ + SigningDocumentsList + """ # noqa: E501 + signing_documents: List[SigningDocument] + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["signing_documents"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SigningDocumentsList from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in signing_documents (list) + _items = [] + if self.signing_documents: + for _item_signing_documents in self.signing_documents: + if _item_signing_documents: + _items.append(_item_signing_documents.to_dict()) + _dict['signing_documents'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SigningDocumentsList from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "signing_documents": [SigningDocument.from_dict(_item) for _item in obj["signing_documents"]] if obj.get("signing_documents") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj + + diff --git a/pyproject.toml b/pyproject.toml index d47af4a..ec765a4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "onfido-python" -version = "5.6.0" +version = "5.7.0" description = "Python library for the Onfido API" authors = ["OpenAPI Generator Community "] license = "MIT" diff --git a/setup.py b/setup.py index c4f77fc..9c5a084 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "onfido-python" -VERSION = "5.6.0" +VERSION = "5.7.0" PYTHON_REQUIRES = ">= 3.8" REQUIRES = [ "urllib3 >= 1.25.3, < 3.0.0",