Package com.jumio.sdk.retrieval_v3.api

Class RetrievalApi

java.lang.Object

com.jumio.sdk.retrieval_v3.api.RetrievalApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-05-09T15:46:41.754885500+02:00[Europe/Vienna]")
public class RetrievalApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RetrievalApi()
RetrievalApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteAllPIIData(UUID accountId)	Deletes all the PII data for every workflow-execution
org.springframework.http.ResponseEntity<Void>	deleteAllPIIDataWithHttpInfo(UUID accountId)	Deletes all the PII data for every workflow-execution
void	deletePIIDataForWorkflowExecution(UUID accountId, UUID workflowExecutionId)	deletes all the PII data for the executed workflow
org.springframework.http.ResponseEntity<Void>	deletePIIDataForWorkflowExecutionWithHttpInfo(UUID accountId, UUID workflowExecutionId)	deletes all the PII data for the executed workflow
File	getAccountCredential(UUID accountId, UUID credentialId, String classifier)	Returns the binaries of the part of the Credential
org.springframework.http.ResponseEntity<File>	getAccountCredentialWithHttpInfo(UUID accountId, UUID credentialId, String classifier)	Returns the binaries of the part of the Credential
ApiClient	getApiClient()
WorkflowExecutionResponse	getWorkflowExecutionDetails(UUID accountId, UUID workflowExecutionId)	Returns the detailed result for the executed workflow
org.springframework.http.ResponseEntity<WorkflowExecutionResponse>	getWorkflowExecutionDetailsWithHttpInfo(UUID accountId, UUID workflowExecutionId)	Returns the detailed result for the executed workflow
WorkflowExecutionRulesResponse	getWorkflowExecutionRules(UUID accountId, UUID workflowExecutionId)	Returns the rules in the executed workflow.
org.springframework.http.ResponseEntity<WorkflowExecutionRulesResponse>	getWorkflowExecutionRulesWithHttpInfo(UUID accountId, UUID workflowExecutionId)	Returns the rules in the executed workflow.
WorkflowStatusResponse	getWorkflowExecutionStatus(UUID accountId, UUID workflowExecutionId)	Returns the status of the executed workflow.
org.springframework.http.ResponseEntity<WorkflowStatusResponse>	getWorkflowExecutionStatusWithHttpInfo(UUID accountId, UUID workflowExecutionId)	Returns the status of the executed workflow.
WorkflowStepsResponse	getWorkflowExecutionSteps(UUID accountId, UUID workflowExecutionId)	Returns the steps in the executed workflow.
org.springframework.http.ResponseEntity<WorkflowStepsResponse>	getWorkflowExecutionStepsWithHttpInfo(UUID accountId, UUID workflowExecutionId)	Returns the steps in the executed workflow.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RetrievalApi

public RetrievalApi()

RetrievalApi

public RetrievalApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteAllPIIData

public void deleteAllPIIData(UUID accountId)
                      throws org.springframework.web.client.RestClientException

Deletes all the PII data for every workflow-execution

202 - The request was accepted and all the data will be removed

204 - All workflow-execution of the account have already been wiped out

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteAllPIIDataWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deleteAllPIIDataWithHttpInfo(UUID accountId)
                                                                           throws org.springframework.web.client.RestClientException

Deletes all the PII data for every workflow-execution

202 - The request was accepted and all the data will be removed

204 - All workflow-execution of the account have already been wiped out

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deletePIIDataForWorkflowExecution

public void deletePIIDataForWorkflowExecution(UUID accountId,
 UUID workflowExecutionId)
                                       throws org.springframework.web.client.RestClientException

deletes all the PII data for the executed workflow

202 - The request was accepted and all the data will be removed

204 - The Workflow-execution has already been wiped out

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deletePIIDataForWorkflowExecutionWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deletePIIDataForWorkflowExecutionWithHttpInfo(UUID accountId,
 UUID workflowExecutionId)
                                                                                            throws org.springframework.web.client.RestClientException

deletes all the PII data for the executed workflow

202 - The request was accepted and all the data will be removed

204 - The Workflow-execution has already been wiped out

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAccountCredential

public File getAccountCredential(UUID accountId,
 UUID credentialId,
 String classifier)
                          throws org.springframework.web.client.RestClientException

Returns the binaries of the part of the Credential

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

credentialId - (required)

classifier - (required)

Returns:

File

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAccountCredentialWithHttpInfo

public org.springframework.http.ResponseEntity<File> getAccountCredentialWithHttpInfo(UUID accountId,
 UUID credentialId,
 String classifier)
                                                                               throws org.springframework.web.client.RestClientException

Returns the binaries of the part of the Credential

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

credentialId - (required)

classifier - (required)

Returns:

ResponseEntity<File>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionDetails

public WorkflowExecutionResponse getWorkflowExecutionDetails(UUID accountId,
 UUID workflowExecutionId)
                                                      throws org.springframework.web.client.RestClientException

Returns the detailed result for the executed workflow

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

WorkflowExecutionResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionDetailsWithHttpInfo

public org.springframework.http.ResponseEntity<WorkflowExecutionResponse> getWorkflowExecutionDetailsWithHttpInfo(UUID accountId,
 UUID workflowExecutionId)
                                                                                                           throws org.springframework.web.client.RestClientException

Returns the detailed result for the executed workflow

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

ResponseEntity<WorkflowExecutionResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionRules

public WorkflowExecutionRulesResponse getWorkflowExecutionRules(UUID accountId,
 UUID workflowExecutionId)
                                                         throws org.springframework.web.client.RestClientException

Returns the rules in the executed workflow.

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

WorkflowExecutionRulesResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionRulesWithHttpInfo

public org.springframework.http.ResponseEntity<WorkflowExecutionRulesResponse> getWorkflowExecutionRulesWithHttpInfo(UUID accountId,
 UUID workflowExecutionId)
                                                                                                              throws org.springframework.web.client.RestClientException

Returns the rules in the executed workflow.

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

ResponseEntity<WorkflowExecutionRulesResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionStatus

public WorkflowStatusResponse getWorkflowExecutionStatus(UUID accountId,
 UUID workflowExecutionId)
                                                  throws org.springframework.web.client.RestClientException

Returns the status of the executed workflow. The response is the same as the one being sent by the callback

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

WorkflowStatusResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionStatusWithHttpInfo

public org.springframework.http.ResponseEntity<WorkflowStatusResponse> getWorkflowExecutionStatusWithHttpInfo(UUID accountId,
 UUID workflowExecutionId)
                                                                                                       throws org.springframework.web.client.RestClientException

Returns the status of the executed workflow. The response is the same as the one being sent by the callback

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

ResponseEntity<WorkflowStatusResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionSteps

public WorkflowStepsResponse getWorkflowExecutionSteps(UUID accountId,
 UUID workflowExecutionId)
                                                throws org.springframework.web.client.RestClientException

Returns the steps in the executed workflow.

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

WorkflowStepsResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getWorkflowExecutionStepsWithHttpInfo

public org.springframework.http.ResponseEntity<WorkflowStepsResponse> getWorkflowExecutionStepsWithHttpInfo(UUID accountId,
 UUID workflowExecutionId)
                                                                                                     throws org.springframework.web.client.RestClientException

Returns the steps in the executed workflow.

200 - OK

401 - Unauthorized

403 - Forbidden

404 - Not Found

Parameters:

accountId - (required)

workflowExecutionId - (required)

Returns:

ResponseEntity<WorkflowStepsResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API