com.docdoku.api.services

Class DocumentTemplateBinaryApi

java.lang.Object

com.docdoku.api.services.DocumentTemplateBinaryApi

public class DocumentTemplateBinaryApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DocumentTemplateBinaryApi()
DocumentTemplateBinaryApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
File	downloadDocumentTemplateFile(String workspaceId, String templateId, String fileName, String range, String type, String output) Download document template file
com.squareup.okhttp.Call	downloadDocumentTemplateFileAsync(String workspaceId, String templateId, String fileName, String range, String type, String output, ApiCallback<File> callback) Download document template file (asynchronously)
ApiResponse<File>	downloadDocumentTemplateFileWithHttpInfo(String workspaceId, String templateId, String fileName, String range, String type, String output) Download document template file
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	uploadDocumentTemplateFiles(String workspaceId, String templateId, File upload) Upload document template file
com.squareup.okhttp.Call	uploadDocumentTemplateFilesAsync(String workspaceId, String templateId, File upload, ApiCallback<Void> callback) Upload document template file (asynchronously)
ApiResponse<Void>	uploadDocumentTemplateFilesWithHttpInfo(String workspaceId, String templateId, File upload) Upload document template file

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentTemplateBinaryApi

public DocumentTemplateBinaryApi()

DocumentTemplateBinaryApi

public DocumentTemplateBinaryApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

uploadDocumentTemplateFiles

public void uploadDocumentTemplateFiles(String workspaceId,
                                        String templateId,
                                        File upload)
                                 throws ApiException

Upload document template file

Parameters:

workspaceId - Workspace id

templateId - Template id

upload -

Throws:

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

uploadDocumentTemplateFilesWithHttpInfo

public ApiResponse<Void> uploadDocumentTemplateFilesWithHttpInfo(String workspaceId,
                                                                 String templateId,
                                                                 File upload)
                                                          throws ApiException

Upload document template file

Parameters:

workspaceId - Workspace id

templateId - Template id

upload -

Returns:

ApiResponse

Throws:

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

uploadDocumentTemplateFilesAsync

public com.squareup.okhttp.Call uploadDocumentTemplateFilesAsync(String workspaceId,
                                                                 String templateId,
                                                                 File upload,
                                                                 ApiCallback<Void> callback)
                                                          throws ApiException

Upload document template file (asynchronously)

Parameters:

workspaceId - Workspace id

templateId - Template id

upload -

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

downloadDocumentTemplateFile

public File downloadDocumentTemplateFile(String workspaceId,
                                         String templateId,
                                         String fileName,
                                         String range,
                                         String type,
                                         String output)
                                  throws ApiException

Download document template file

Parameters:

workspaceId - Workspace id

templateId - Template id

fileName - File name

range - Range

type - Type

output - Output

Returns:

File

Throws:

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

downloadDocumentTemplateFileWithHttpInfo

public ApiResponse<File> downloadDocumentTemplateFileWithHttpInfo(String workspaceId,
                                                                  String templateId,
                                                                  String fileName,
                                                                  String range,
                                                                  String type,
                                                                  String output)
                                                           throws ApiException

Download document template file

Parameters:

workspaceId - Workspace id

templateId - Template id

fileName - File name

range - Range

type - Type

output - Output

Returns:

ApiResponse

Throws:

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

downloadDocumentTemplateFileAsync

public com.squareup.okhttp.Call downloadDocumentTemplateFileAsync(String workspaceId,
                                                                  String templateId,
                                                                  String fileName,
                                                                  String range,
                                                                  String type,
                                                                  String output,
                                                                  ApiCallback<File> callback)
                                                           throws ApiException

Download document template file (asynchronously)

Parameters:

workspaceId - Workspace id

templateId - Template id

fileName - File name

range - Range

type - Type

output - Output

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