com.genesys.internal.engagement.api

Class CallbacksApi

java.lang.Object

com.genesys.internal.engagement.api.CallbacksApi

public class CallbacksApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CallbacksApi()
CallbacksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateCallbackResponse200	bookCallbackExternal(java.lang.String xApiKey, CreateCallbackParms body) Creates a new callback.
com.squareup.okhttp.Call	bookCallbackExternalAsync(java.lang.String xApiKey, CreateCallbackParms body, ApiCallback<CreateCallbackResponse200> callback) Creates a new callback.
com.squareup.okhttp.Call	bookCallbackExternalCall(java.lang.String xApiKey, CreateCallbackParms body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for bookCallbackExternal
ApiResponse<CreateCallbackResponse200>	bookCallbackExternalWithHttpInfo(java.lang.String xApiKey, CreateCallbackParms body) Creates a new callback.
CancelCallbackResponse200	cancelCallback(java.lang.String xApiKey, CallbackIdParms body) Cancels an existing callback.
com.squareup.okhttp.Call	cancelCallbackAsync(java.lang.String xApiKey, CallbackIdParms body, ApiCallback<CancelCallbackResponse200> callback) Cancels an existing callback.
com.squareup.okhttp.Call	cancelCallbackCall(java.lang.String xApiKey, CallbackIdParms body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for cancelCallback
ApiResponse<CancelCallbackResponse200>	cancelCallbackWithHttpInfo(java.lang.String xApiKey, CallbackIdParms body) Cancels an existing callback.
ApiClient	getApiClient()
GetCallbackResponse200	queryCallbackById(java.lang.String xApiKey, CallbackIdParms body) Queries an existing callback.
com.squareup.okhttp.Call	queryCallbackByIdAsync(java.lang.String xApiKey, CallbackIdParms body, ApiCallback<GetCallbackResponse200> callback) Queries an existing callback.
com.squareup.okhttp.Call	queryCallbackByIdCall(java.lang.String xApiKey, CallbackIdParms body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for queryCallbackById
ApiResponse<GetCallbackResponse200>	queryCallbackByIdWithHttpInfo(java.lang.String xApiKey, CallbackIdParms body) Queries an existing callback.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CallbacksApi

public CallbacksApi()

CallbacksApi

public CallbacksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

bookCallbackExternalCall

public com.squareup.okhttp.Call bookCallbackExternalCall(java.lang.String xApiKey,
                                                         CreateCallbackParms body,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for bookCallbackExternal

Parameters:

xApiKey - API Key (required)

body - Callback properties. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

bookCallbackExternal

public CreateCallbackResponse200 bookCallbackExternal(java.lang.String xApiKey,
                                                      CreateCallbackParms body)
                                               throws ApiException

Creates a new callback. Initiates a callback request.

Parameters:

xApiKey - API Key (required)

body - Callback properties. (required)

Returns:

CreateCallbackResponse200

Throws:

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

bookCallbackExternalWithHttpInfo

public ApiResponse<CreateCallbackResponse200> bookCallbackExternalWithHttpInfo(java.lang.String xApiKey,
                                                                               CreateCallbackParms body)
                                                                        throws ApiException

Creates a new callback. Initiates a callback request.

Parameters:

xApiKey - API Key (required)

body - Callback properties. (required)

Returns:

ApiResponse<CreateCallbackResponse200>

Throws:

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

bookCallbackExternalAsync

public com.squareup.okhttp.Call bookCallbackExternalAsync(java.lang.String xApiKey,
                                                          CreateCallbackParms body,
                                                          ApiCallback<CreateCallbackResponse200> callback)
                                                   throws ApiException

Creates a new callback. (asynchronously) Initiates a callback request.

Parameters:

xApiKey - API Key (required)

body - Callback properties. (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

cancelCallbackCall

public com.squareup.okhttp.Call cancelCallbackCall(java.lang.String xApiKey,
                                                   CallbackIdParms body,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for cancelCallback

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

body - Callback properties. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

cancelCallback

public CancelCallbackResponse200 cancelCallback(java.lang.String xApiKey,
                                                CallbackIdParms body)
                                         throws ApiException

Cancels an existing callback. Cancels an existing callback by its callback ID.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

body - Callback properties. (required)

Returns:

CancelCallbackResponse200

Throws:

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

cancelCallbackWithHttpInfo

public ApiResponse<CancelCallbackResponse200> cancelCallbackWithHttpInfo(java.lang.String xApiKey,
                                                                         CallbackIdParms body)
                                                                  throws ApiException

Cancels an existing callback. Cancels an existing callback by its callback ID.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

body - Callback properties. (required)

Returns:

ApiResponse<CancelCallbackResponse200>

Throws:

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

cancelCallbackAsync

public com.squareup.okhttp.Call cancelCallbackAsync(java.lang.String xApiKey,
                                                    CallbackIdParms body,
                                                    ApiCallback<CancelCallbackResponse200> callback)
                                             throws ApiException

Cancels an existing callback. (asynchronously) Cancels an existing callback by its callback ID.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

body - Callback properties. (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

queryCallbackByIdCall

public com.squareup.okhttp.Call queryCallbackByIdCall(java.lang.String xApiKey,
                                                      CallbackIdParms body,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for queryCallbackById

Parameters:

xApiKey - API Key (required)

body - Callback properties. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

queryCallbackById

public GetCallbackResponse200 queryCallbackById(java.lang.String xApiKey,
                                                CallbackIdParms body)
                                         throws ApiException

Queries an existing callback. Queries an existing callback by its callback ID.

Parameters:

xApiKey - API Key (required)

body - Callback properties. (required)

Returns:

GetCallbackResponse200

Throws:

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

queryCallbackByIdWithHttpInfo

public ApiResponse<GetCallbackResponse200> queryCallbackByIdWithHttpInfo(java.lang.String xApiKey,
                                                                         CallbackIdParms body)
                                                                  throws ApiException

Queries an existing callback. Queries an existing callback by its callback ID.

Parameters:

xApiKey - API Key (required)

body - Callback properties. (required)

Returns:

ApiResponse<GetCallbackResponse200>

Throws:

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

queryCallbackByIdAsync

public com.squareup.okhttp.Call queryCallbackByIdAsync(java.lang.String xApiKey,
                                                       CallbackIdParms body,
                                                       ApiCallback<GetCallbackResponse200> callback)
                                                throws ApiException

Queries an existing callback. (asynchronously) Queries an existing callback by its callback ID.

Parameters:

xApiKey - API Key (required)

body - Callback properties. (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