Package com.groupdocs.cloud.parser.api

Class TemplateApi

java.lang.Object

com.groupdocs.cloud.parser.api.TemplateApi

public class TemplateApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TemplateApi(Configuration configuration)	Initializes new instance of TemplateApi
TemplateApi(String appSid, String appKey)	Initializes new instance of TemplateApi

Method Summary

Modifier and Type	Method	Description
TemplateResult	createTemplate(CreateTemplateRequest request)	Create or update document template.
com.squareup.okhttp.Call	createTemplateAsync(CreateTemplateRequest request, ApiCallback<TemplateResult> callback)	Create or update document template.
com.squareup.okhttp.Call	createTemplateCall(CreateTemplateRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for createTemplate
ApiResponse<TemplateResult>	createTemplateWithHttpInfo(CreateTemplateRequest request)	Create or update document template.
void	deleteTemplate(DeleteTemplateRequest request)	Delete document template.
com.squareup.okhttp.Call	deleteTemplateAsync(DeleteTemplateRequest request, ApiCallback<Void> callback)	Delete document template.
com.squareup.okhttp.Call	deleteTemplateCall(DeleteTemplateRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deleteTemplate
ApiResponse<Void>	deleteTemplateWithHttpInfo(DeleteTemplateRequest request)	Delete document template.
ApiClient	getApiClient()	Gets ApiClient
Template	getTemplate(GetTemplateRequest request)	Retrieve document template.
com.squareup.okhttp.Call	getTemplateAsync(GetTemplateRequest request, ApiCallback<Template> callback)	Retrieve document template.
com.squareup.okhttp.Call	getTemplateCall(GetTemplateRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getTemplate
ApiResponse<Template>	getTemplateWithHttpInfo(GetTemplateRequest request)	Retrieve document template.
void	setApiClient(ApiClient apiClient)	Sets ApiClient

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateApi

public TemplateApi(String appSid,
                   String appKey)

Initializes new instance of TemplateApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

TemplateApi

public TemplateApi(Configuration configuration)

Initializes new instance of TemplateApi

Parameters:

configuration - Configuration The configuration

Method Detail

getApiClient

public ApiClient getApiClient()

Gets ApiClient

Returns:

ApiClient The Api client

setApiClient

public void setApiClient(ApiClient apiClient)

Sets ApiClient

Parameters:

apiClient - The Api client

createTemplateCall

public com.squareup.okhttp.Call createTemplateCall(CreateTemplateRequest request,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for createTemplate

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createTemplate

public TemplateResult createTemplate(CreateTemplateRequest request)
                              throws ApiException

Create or update document template.

Parameters:

request - The request model

Returns:

TemplateResult

Throws:

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

createTemplateWithHttpInfo

public ApiResponse<TemplateResult> createTemplateWithHttpInfo(CreateTemplateRequest request)
                                                       throws ApiException

Create or update document template.

Parameters:

request - The request model

Returns:

ApiResponse<TemplateResult>

Throws:

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

createTemplateAsync

public com.squareup.okhttp.Call createTemplateAsync(CreateTemplateRequest request,
                                                    ApiCallback<TemplateResult> callback)
                                             throws ApiException

Create or update document template. (asynchronously)

Parameters:

request - The request model

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

deleteTemplateCall

public com.squareup.okhttp.Call deleteTemplateCall(DeleteTemplateRequest request,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for deleteTemplate

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteTemplate

public void deleteTemplate(DeleteTemplateRequest request)
                    throws ApiException

Delete document template.

Parameters:

request - The request model

Throws:

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

deleteTemplateWithHttpInfo

public ApiResponse<Void> deleteTemplateWithHttpInfo(DeleteTemplateRequest request)
                                             throws ApiException

Delete document template.

Parameters:

request - The request model

Returns:

ApiResponse<Void>

Throws:

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

deleteTemplateAsync

public com.squareup.okhttp.Call deleteTemplateAsync(DeleteTemplateRequest request,
                                                    ApiCallback<Void> callback)
                                             throws ApiException

Delete document template. (asynchronously)

Parameters:

request - The request model

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

getTemplateCall

public com.squareup.okhttp.Call getTemplateCall(GetTemplateRequest request,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getTemplate

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getTemplate

public Template getTemplate(GetTemplateRequest request)
                     throws ApiException

Retrieve document template.

Parameters:

request - The request model

Returns:

Template

Throws:

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

getTemplateWithHttpInfo

public ApiResponse<Template> getTemplateWithHttpInfo(GetTemplateRequest request)
                                              throws ApiException

Retrieve document template.

Parameters:

request - The request model

Returns:

ApiResponse<Template>

Throws:

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

getTemplateAsync

public com.squareup.okhttp.Call getTemplateAsync(GetTemplateRequest request,
                                                 ApiCallback<Template> callback)
                                          throws ApiException

Retrieve document template. (asynchronously)

Parameters:

request - The request model

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