com.approveapi

Class ApproveApi

java.lang.Object

com.approveapi.ApproveApi

public class ApproveApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApproveApi()
ApproveApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Prompt	createPrompt(CreatePromptRequest createPromptRequest) Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
okhttp3.Call	createPromptAsync(CreatePromptRequest createPromptRequest, ApiCallback<Prompt> callback) Sending a prompt (asynchronously) Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
okhttp3.Call	createPromptCall(CreatePromptRequest createPromptRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createPrompt
ApiResponse<Prompt>	createPromptWithHttpInfo(CreatePromptRequest createPromptRequest) Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
ApiClient	getApiClient()
Prompt	getPrompt(String id, Boolean longPoll) Retrieve a prompt Retrieve the prompt object with the given ID.
okhttp3.Call	getPromptAsync(String id, Boolean longPoll, ApiCallback<Prompt> callback) Retrieve a prompt (asynchronously) Retrieve the prompt object with the given ID.
okhttp3.Call	getPromptCall(String id, Boolean longPoll, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPrompt
PromptStatus	getPromptStatus(String id) Check prompt status Returns whether a prompt has been completed by the user.
okhttp3.Call	getPromptStatusAsync(String id, ApiCallback<PromptStatus> callback) Check prompt status (asynchronously) Returns whether a prompt has been completed by the user.
okhttp3.Call	getPromptStatusCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPromptStatus
ApiResponse<PromptStatus>	getPromptStatusWithHttpInfo(String id) Check prompt status Returns whether a prompt has been completed by the user.
ApiResponse<Prompt>	getPromptWithHttpInfo(String id, Boolean longPoll) Retrieve a prompt Retrieve the prompt object with the given ID.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApproveApi

public ApproveApi()

ApproveApi

public ApproveApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPromptCall

public okhttp3.Call createPromptCall(CreatePromptRequest createPromptRequest,
                                     ProgressResponseBody.ProgressListener progressListener,
                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                              throws ApiException

Build call for createPrompt

Parameters:

createPromptRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createPrompt

public Prompt createPrompt(CreatePromptRequest createPromptRequest)
                    throws ApiException

Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).

Parameters:

createPromptRequest - (required)

Returns:

Prompt

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createPromptWithHttpInfo

public ApiResponse<Prompt> createPromptWithHttpInfo(CreatePromptRequest createPromptRequest)
                                             throws ApiException

Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).

Parameters:

createPromptRequest - (required)

Returns:

ApiResponse<Prompt>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createPromptAsync

public okhttp3.Call createPromptAsync(CreatePromptRequest createPromptRequest,
                                      ApiCallback<Prompt> callback)
                               throws ApiException

Sending a prompt (asynchronously) Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).

Parameters:

createPromptRequest - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getPromptCall

public okhttp3.Call getPromptCall(String id,
                                  Boolean longPoll,
                                  ProgressResponseBody.ProgressListener progressListener,
                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                           throws ApiException

Build call for getPrompt

Parameters:

id - The identifier for a pending or completed prompt. This is returned when you create a prompt. (required)

longPoll - If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPrompt

public Prompt getPrompt(String id,
                        Boolean longPoll)
                 throws ApiException

Retrieve a prompt Retrieve the prompt object with the given ID.

Parameters:

id - The identifier for a pending or completed prompt. This is returned when you create a prompt. (required)

longPoll - If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. (optional)

Returns:

Prompt

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPromptWithHttpInfo

public ApiResponse<Prompt> getPromptWithHttpInfo(String id,
                                                 Boolean longPoll)
                                          throws ApiException

Retrieve a prompt Retrieve the prompt object with the given ID.

Parameters:

id - The identifier for a pending or completed prompt. This is returned when you create a prompt. (required)

longPoll - If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. (optional)

Returns:

ApiResponse<Prompt>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPromptAsync

public okhttp3.Call getPromptAsync(String id,
                                   Boolean longPoll,
                                   ApiCallback<Prompt> callback)
                            throws ApiException

Retrieve a prompt (asynchronously) Retrieve the prompt object with the given ID.

Parameters:

id - The identifier for a pending or completed prompt. This is returned when you create a prompt. (required)

longPoll - If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getPromptStatusCall

public okhttp3.Call getPromptStatusCall(String id,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException

Build call for getPromptStatus

Parameters:

id - The prompt identifier. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPromptStatus

public PromptStatus getPromptStatus(String id)
                             throws ApiException

Check prompt status Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.

Parameters:

id - The prompt identifier. (required)

Returns:

PromptStatus

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPromptStatusWithHttpInfo

public ApiResponse<PromptStatus> getPromptStatusWithHttpInfo(String id)
                                                      throws ApiException

Check prompt status Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.

Parameters:

id - The prompt identifier. (required)

Returns:

ApiResponse<PromptStatus>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPromptStatusAsync

public okhttp3.Call getPromptStatusAsync(String id,
                                         ApiCallback<PromptStatus> callback)
                                  throws ApiException

Check prompt status (asynchronously) Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.

Parameters:

id - The prompt identifier. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object