AssemblyApi (groupdocs-assembly-cloud 25.1 API)

java.lang.Object
- com.groupdocs.assembly.cloud.api.AssemblyApi

```
public class AssemblyApi
extends Object
```

Constructor Summary

Constructors
Constructor Description

AssemblyApi()

AssemblyApi(ApiClient apiClient)

AssemblyApi(String appSid, String appKey, String baseUrl)

Constructors
Constructor	Description
`AssemblyApi()`
`AssemblyApi(ApiClient apiClient)`
`AssemblyApi(String appSid, String appKey, String baseUrl)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`File`	`assembleDocument(AssembleDocumentRequest request)`	Builds a document using document template and XML or JSON data passed in request.
`com.squareup.okhttp.Call`	`assembleDocumentAsync(AssembleDocumentRequest request, ApiCallback<File> callback)`	Builds a document using document template and XML or JSON data passed in request.
`void`	`copyFile(CopyFileRequest request)`	Copy file
`com.squareup.okhttp.Call`	`copyFileAsync(CopyFileRequest request, ApiCallback<Void> callback)`	Copy file (asynchronously)
`void`	`copyFolder(CopyFolderRequest request)`	Copy folder
`com.squareup.okhttp.Call`	`copyFolderAsync(CopyFolderRequest request, ApiCallback<Void> callback)`	Copy folder (asynchronously)
`void`	`createFolder(CreateFolderRequest request)`	Create the folder
`com.squareup.okhttp.Call`	`createFolderAsync(CreateFolderRequest request, ApiCallback<Void> callback)`	Create the folder (asynchronously)
`void`	`deleteFile(DeleteFileRequest request)`	Delete file
`com.squareup.okhttp.Call`	`deleteFileAsync(DeleteFileRequest request, ApiCallback<Void> callback)`	Delete file (asynchronously)
`void`	`deleteFolder(DeleteFolderRequest request)`	Delete folder
`com.squareup.okhttp.Call`	`deleteFolderAsync(DeleteFolderRequest request, ApiCallback<Void> callback)`	Delete folder (asynchronously)
`File`	`downloadFile(DownloadFileRequest request)`	Download file
`com.squareup.okhttp.Call`	`downloadFileAsync(DownloadFileRequest request, ApiCallback<File> callback)`	Download file (asynchronously)
`ApiClient`	`getApiClient()`
`FilesList`	`getFilesList(GetFilesListRequest request)`	Get all files and folders within a folder
`com.squareup.okhttp.Call`	`getFilesListAsync(GetFilesListRequest request, ApiCallback<FilesList> callback)`	Get all files and folders within a folder (asynchronously)
`FileFormatsResponse`	`getSupportedFileFormats(GetSupportedFileFormatsRequest request)`	Retrieves list of supported file formats.
`com.squareup.okhttp.Call`	`getSupportedFileFormatsAsync(GetSupportedFileFormatsRequest request, ApiCallback<FileFormatsResponse> callback)`	Retrieves list of supported file formats.
`void`	`moveFile(MoveFileRequest request)`	Move file
`com.squareup.okhttp.Call`	`moveFileAsync(MoveFileRequest request, ApiCallback<Void> callback)`	Move file (asynchronously)
`void`	`moveFolder(MoveFolderRequest request)`	Move folder
`com.squareup.okhttp.Call`	`moveFolderAsync(MoveFolderRequest request, ApiCallback<Void> callback)`	Move folder (asynchronously)
`void`	`setApiClient(ApiClient apiClient)`
`FilesUploadResult`	`uploadFile(UploadFileRequest request)`	Upload file
`com.squareup.okhttp.Call`	`uploadFileAsync(UploadFileRequest request, ApiCallback<FilesUploadResult> callback)`	Upload file (asynchronously)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AssemblyApi
```
public AssemblyApi(String appSid,
                   String appKey,
                   String baseUrl)
```
  - AssemblyApi
```
public AssemblyApi()
```
  - AssemblyApi
```
public AssemblyApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - assembleDocument
```
public File assembleDocument(AssembleDocumentRequest request)
                      throws ApiException
```
    Builds a document using document template and XML or JSON data passed in request.
    
    Parameters:
    
    request - Request object
    
    Returns:
    
    File
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - assembleDocumentAsync
```
public com.squareup.okhttp.Call assembleDocumentAsync(AssembleDocumentRequest request,
                                                      ApiCallback<File> callback)
                                               throws ApiException
```
    Builds a document using document template and XML or JSON data passed in request. (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - copyFile
```
public void copyFile(CopyFileRequest request)
              throws ApiException
```
    Copy file
    
    Parameters:
    
    request - Request object
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - copyFileAsync
```
public com.squareup.okhttp.Call copyFileAsync(CopyFileRequest request,
                                              ApiCallback<Void> callback)
                                       throws ApiException
```
    Copy file (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - copyFolder
```
public void copyFolder(CopyFolderRequest request)
                throws ApiException
```
    Copy folder
    
    Parameters:
    
    request - Request object
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - copyFolderAsync
```
public com.squareup.okhttp.Call copyFolderAsync(CopyFolderRequest request,
                                                ApiCallback<Void> callback)
                                         throws ApiException
```
    Copy folder (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - createFolder
```
public void createFolder(CreateFolderRequest request)
                  throws ApiException
```
    Create the folder
    
    Parameters:
    
    request - Request object
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - createFolderAsync
```
public com.squareup.okhttp.Call createFolderAsync(CreateFolderRequest request,
                                                  ApiCallback<Void> callback)
                                           throws ApiException
```
    Create the folder (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - deleteFile
```
public void deleteFile(DeleteFileRequest request)
                throws ApiException
```
    Delete file
    
    Parameters:
    
    request - Request object
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteFileAsync
```
public com.squareup.okhttp.Call deleteFileAsync(DeleteFileRequest request,
                                                ApiCallback<Void> callback)
                                         throws ApiException
```
    Delete file (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - deleteFolder
```
public void deleteFolder(DeleteFolderRequest request)
                  throws ApiException
```
    Delete folder
    
    Parameters:
    
    request - Request object
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteFolderAsync
```
public com.squareup.okhttp.Call deleteFolderAsync(DeleteFolderRequest request,
                                                  ApiCallback<Void> callback)
                                           throws ApiException
```
    Delete folder (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - downloadFile
```
public File downloadFile(DownloadFileRequest request)
                  throws ApiException
```
    Download file
    
    Parameters:
    
    request - Request object
    
    Returns:
    
    File
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - downloadFileAsync
```
public com.squareup.okhttp.Call downloadFileAsync(DownloadFileRequest request,
                                                  ApiCallback<File> callback)
                                           throws ApiException
```
    Download file (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - getFilesList
```
public FilesList getFilesList(GetFilesListRequest request)
                       throws ApiException
```
    Get all files and folders within a folder
    
    Parameters:
    
    request - Request object
    
    Returns:
    
    FilesList
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getFilesListAsync
```
public com.squareup.okhttp.Call getFilesListAsync(GetFilesListRequest request,
                                                  ApiCallback<FilesList> callback)
                                           throws ApiException
```
    Get all files and folders within a folder (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - getSupportedFileFormats
```
public FileFormatsResponse getSupportedFileFormats(GetSupportedFileFormatsRequest request)
                                            throws ApiException
```
    Retrieves list of supported file formats.
    
    Parameters:
    
    request - Request object
    
    Returns:
    
    FileFormatsResponse
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getSupportedFileFormatsAsync
```
public com.squareup.okhttp.Call getSupportedFileFormatsAsync(GetSupportedFileFormatsRequest request,
                                                             ApiCallback<FileFormatsResponse> callback)
                                                      throws ApiException
```
    Retrieves list of supported file formats. (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - moveFile
```
public void moveFile(MoveFileRequest request)
              throws ApiException
```
    Move file
    
    Parameters:
    
    request - Request object
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - moveFileAsync
```
public com.squareup.okhttp.Call moveFileAsync(MoveFileRequest request,
                                              ApiCallback<Void> callback)
                                       throws ApiException
```
    Move file (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - moveFolder
```
public void moveFolder(MoveFolderRequest request)
                throws ApiException
```
    Move folder
    
    Parameters:
    
    request - Request object
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - moveFolderAsync
```
public com.squareup.okhttp.Call moveFolderAsync(MoveFolderRequest request,
                                                ApiCallback<Void> callback)
                                         throws ApiException
```
    Move folder (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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
  - uploadFile
```
public FilesUploadResult uploadFile(UploadFileRequest request)
                             throws ApiException
```
    Upload file
    
    Parameters:
    
    request - Request object
    
    Returns:
    
    FilesUploadResult
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - uploadFileAsync
```
public com.squareup.okhttp.Call uploadFileAsync(UploadFileRequest request,
                                                ApiCallback<FilesUploadResult> callback)
                                         throws ApiException
```
    Upload file (asynchronously)
    
    Parameters:
    
    request - Request object
    
    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

Class AssemblyApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssemblyApi

AssemblyApi

AssemblyApi

Method Detail

getApiClient

setApiClient

assembleDocument

assembleDocumentAsync

copyFile

copyFileAsync

copyFolder

copyFolderAsync

createFolder

createFolderAsync

deleteFile

deleteFileAsync

deleteFolder

deleteFolderAsync

downloadFile

downloadFileAsync

getFilesList

getFilesListAsync

getSupportedFileFormats

getSupportedFileFormatsAsync

moveFile

moveFileAsync

moveFolder

moveFolderAsync

uploadFile

uploadFileAsync