com.docdoku.api.services

Class FoldersApi

java.lang.Object

com.docdoku.api.services.FoldersApi

public class FoldersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
FoldersApi()
FoldersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DocumentRevisionDTO	createDocumentMasterInFolder(String workspaceId, DocumentCreationDTO body, String folderId) Create a new document revision in given folder
com.squareup.okhttp.Call	createDocumentMasterInFolderAsync(String workspaceId, DocumentCreationDTO body, String folderId, ApiCallback<DocumentRevisionDTO> callback) Create a new document revision in given folder (asynchronously)
ApiResponse<DocumentRevisionDTO>	createDocumentMasterInFolderWithHttpInfo(String workspaceId, DocumentCreationDTO body, String folderId) Create a new document revision in given folder
FolderDTO	createRootFolder(String workspaceId, FolderDTO body) Create root folder
com.squareup.okhttp.Call	createRootFolderAsync(String workspaceId, FolderDTO body, ApiCallback<FolderDTO> callback) Create root folder (asynchronously)
ApiResponse<FolderDTO>	createRootFolderWithHttpInfo(String workspaceId, FolderDTO body) Create root folder
FolderDTO	createSubFolder(String workspaceId, String parentFolderPath, FolderDTO body) Create a sub folder in a given folder
com.squareup.okhttp.Call	createSubFolderAsync(String workspaceId, String parentFolderPath, FolderDTO body, ApiCallback<FolderDTO> callback) Create a sub folder in a given folder (asynchronously)
ApiResponse<FolderDTO>	createSubFolderWithHttpInfo(String workspaceId, String parentFolderPath, FolderDTO body) Create a sub folder in a given folder
void	deleteRootFolder(String workspaceId, String folderId) Delete root folder
com.squareup.okhttp.Call	deleteRootFolderAsync(String workspaceId, String folderId, ApiCallback<Void> callback) Delete root folder (asynchronously)
ApiResponse<Void>	deleteRootFolderWithHttpInfo(String workspaceId, String folderId) Delete root folder
ApiClient	getApiClient()
List<DocumentRevisionDTO>	getDocumentsWithGivenFolderIdAndWorkspaceId(String workspaceId, String folderId) Get document revisions in given folder
com.squareup.okhttp.Call	getDocumentsWithGivenFolderIdAndWorkspaceIdAsync(String workspaceId, String folderId, ApiCallback<List<DocumentRevisionDTO>> callback) Get document revisions in given folder (asynchronously)
ApiResponse<List<DocumentRevisionDTO>>	getDocumentsWithGivenFolderIdAndWorkspaceIdWithHttpInfo(String workspaceId, String folderId) Get document revisions in given folder
List<FolderDTO>	getRootFolders(String workspaceId) Get root folders
com.squareup.okhttp.Call	getRootFoldersAsync(String workspaceId, ApiCallback<List<FolderDTO>> callback) Get root folders (asynchronously)
ApiResponse<List<FolderDTO>>	getRootFoldersWithHttpInfo(String workspaceId) Get root folders
List<FolderDTO>	getSubFolders(String workspaceId, String completePath) Get sub folders of given folder
com.squareup.okhttp.Call	getSubFoldersAsync(String workspaceId, String completePath, ApiCallback<List<FolderDTO>> callback) Get sub folders of given folder (asynchronously)
ApiResponse<List<FolderDTO>>	getSubFoldersWithHttpInfo(String workspaceId, String completePath) Get sub folders of given folder
FolderDTO	moveFolder(String workspaceId, String folderId, FolderDTO body) Move a folder to given folder
com.squareup.okhttp.Call	moveFolderAsync(String workspaceId, String folderId, FolderDTO body, ApiCallback<FolderDTO> callback) Move a folder to given folder (asynchronously)
ApiResponse<FolderDTO>	moveFolderWithHttpInfo(String workspaceId, String folderId, FolderDTO body) Move a folder to given folder
FolderDTO	renameFolder(String workspaceId, String folderId, FolderDTO body) Rename a folder
com.squareup.okhttp.Call	renameFolderAsync(String workspaceId, String folderId, FolderDTO body, ApiCallback<FolderDTO> callback) Rename a folder (asynchronously)
ApiResponse<FolderDTO>	renameFolderWithHttpInfo(String workspaceId, String folderId, FolderDTO body) Rename a folder
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

FoldersApi

public FoldersApi()

FoldersApi

public FoldersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getRootFolders

public List<FolderDTO> getRootFolders(String workspaceId)
                               throws ApiException

Get root folders

Parameters:

workspaceId - Workspace id

Returns:

List

Throws:

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

getRootFoldersWithHttpInfo

public ApiResponse<List<FolderDTO>> getRootFoldersWithHttpInfo(String workspaceId)
                                                        throws ApiException

Get root folders

Parameters:

workspaceId - Workspace id

Returns:

ApiResponse>

Throws:

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

getRootFoldersAsync

public com.squareup.okhttp.Call getRootFoldersAsync(String workspaceId,
                                                    ApiCallback<List<FolderDTO>> callback)
                                             throws ApiException

Get root folders (asynchronously)

Parameters:

workspaceId - Workspace id

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

createRootFolder

public FolderDTO createRootFolder(String workspaceId,
                                  FolderDTO body)
                           throws ApiException

Create root folder

Parameters:

workspaceId - Workspace id

body - Folder to create

Returns:

FolderDTO

Throws:

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

createRootFolderWithHttpInfo

public ApiResponse<FolderDTO> createRootFolderWithHttpInfo(String workspaceId,
                                                           FolderDTO body)
                                                    throws ApiException

Create root folder

Parameters:

workspaceId - Workspace id

body - Folder to create

Returns:

ApiResponse

Throws:

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

createRootFolderAsync

public com.squareup.okhttp.Call createRootFolderAsync(String workspaceId,
                                                      FolderDTO body,
                                                      ApiCallback<FolderDTO> callback)
                                               throws ApiException

Create root folder (asynchronously)

Parameters:

workspaceId - Workspace id

body - Folder to create

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

getSubFolders

public List<FolderDTO> getSubFolders(String workspaceId,
                                     String completePath)
                              throws ApiException

Get sub folders of given folder

Parameters:

workspaceId - Workspace id

completePath - Folder id

Returns:

List

Throws:

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

getSubFoldersWithHttpInfo

public ApiResponse<List<FolderDTO>> getSubFoldersWithHttpInfo(String workspaceId,
                                                              String completePath)
                                                       throws ApiException

Get sub folders of given folder

Parameters:

workspaceId - Workspace id

completePath - Folder id

Returns:

ApiResponse>

Throws:

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

getSubFoldersAsync

public com.squareup.okhttp.Call getSubFoldersAsync(String workspaceId,
                                                   String completePath,
                                                   ApiCallback<List<FolderDTO>> callback)
                                            throws ApiException

Get sub folders of given folder (asynchronously)

Parameters:

workspaceId - Workspace id

completePath - Folder id

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

renameFolder

public FolderDTO renameFolder(String workspaceId,
                              String folderId,
                              FolderDTO body)
                       throws ApiException

Rename a folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

body - Folder with new name

Returns:

FolderDTO

Throws:

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

renameFolderWithHttpInfo

public ApiResponse<FolderDTO> renameFolderWithHttpInfo(String workspaceId,
                                                       String folderId,
                                                       FolderDTO body)
                                                throws ApiException

Rename a folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

body - Folder with new name

Returns:

ApiResponse

Throws:

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

renameFolderAsync

public com.squareup.okhttp.Call renameFolderAsync(String workspaceId,
                                                  String folderId,
                                                  FolderDTO body,
                                                  ApiCallback<FolderDTO> callback)
                                           throws ApiException

Rename a folder (asynchronously)

Parameters:

workspaceId - Workspace id

folderId - Folder id

body - Folder with new name

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

deleteRootFolder

public void deleteRootFolder(String workspaceId,
                             String folderId)
                      throws ApiException

Delete root folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

Throws:

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

deleteRootFolderWithHttpInfo

public ApiResponse<Void> deleteRootFolderWithHttpInfo(String workspaceId,
                                                      String folderId)
                                               throws ApiException

Delete root folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

Returns:

ApiResponse

Throws:

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

deleteRootFolderAsync

public com.squareup.okhttp.Call deleteRootFolderAsync(String workspaceId,
                                                      String folderId,
                                                      ApiCallback<Void> callback)
                                               throws ApiException

Delete root folder (asynchronously)

Parameters:

workspaceId - Workspace id

folderId - Folder id

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

getDocumentsWithGivenFolderIdAndWorkspaceId

public List<DocumentRevisionDTO> getDocumentsWithGivenFolderIdAndWorkspaceId(String workspaceId,
                                                                             String folderId)
                                                                      throws ApiException

Get document revisions in given folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

Returns:

List

Throws:

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

getDocumentsWithGivenFolderIdAndWorkspaceIdWithHttpInfo

public ApiResponse<List<DocumentRevisionDTO>> getDocumentsWithGivenFolderIdAndWorkspaceIdWithHttpInfo(String workspaceId,
                                                                                                      String folderId)
                                                                                               throws ApiException

Get document revisions in given folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

Returns:

ApiResponse>

Throws:

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

getDocumentsWithGivenFolderIdAndWorkspaceIdAsync

public com.squareup.okhttp.Call getDocumentsWithGivenFolderIdAndWorkspaceIdAsync(String workspaceId,
                                                                                 String folderId,
                                                                                 ApiCallback<List<DocumentRevisionDTO>> callback)
                                                                          throws ApiException

Get document revisions in given folder (asynchronously)

Parameters:

workspaceId - Workspace id

folderId - Folder id

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

createDocumentMasterInFolder

public DocumentRevisionDTO createDocumentMasterInFolder(String workspaceId,
                                                        DocumentCreationDTO body,
                                                        String folderId)
                                                 throws ApiException

Create a new document revision in given folder

Parameters:

workspaceId - Workspace id

body - Document to create

folderId - Folder id

Returns:

DocumentRevisionDTO

Throws:

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

createDocumentMasterInFolderWithHttpInfo

public ApiResponse<DocumentRevisionDTO> createDocumentMasterInFolderWithHttpInfo(String workspaceId,
                                                                                 DocumentCreationDTO body,
                                                                                 String folderId)
                                                                          throws ApiException

Create a new document revision in given folder

Parameters:

workspaceId - Workspace id

body - Document to create

folderId - Folder id

Returns:

ApiResponse

Throws:

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

createDocumentMasterInFolderAsync

public com.squareup.okhttp.Call createDocumentMasterInFolderAsync(String workspaceId,
                                                                  DocumentCreationDTO body,
                                                                  String folderId,
                                                                  ApiCallback<DocumentRevisionDTO> callback)
                                                           throws ApiException

Create a new document revision in given folder (asynchronously)

Parameters:

workspaceId - Workspace id

body - Document to create

folderId - Folder id

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 FolderDTO moveFolder(String workspaceId,
                            String folderId,
                            FolderDTO body)
                     throws ApiException

Move a folder to given folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

body - Folder to move

Returns:

FolderDTO

Throws:

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

moveFolderWithHttpInfo

public ApiResponse<FolderDTO> moveFolderWithHttpInfo(String workspaceId,
                                                     String folderId,
                                                     FolderDTO body)
                                              throws ApiException

Move a folder to given folder

Parameters:

workspaceId - Workspace id

folderId - Folder id

body - Folder to move

Returns:

ApiResponse

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(String workspaceId,
                                                String folderId,
                                                FolderDTO body,
                                                ApiCallback<FolderDTO> callback)
                                         throws ApiException

Move a folder to given folder (asynchronously)

Parameters:

workspaceId - Workspace id

folderId - Folder id

body - Folder to move

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

createSubFolder

public FolderDTO createSubFolder(String workspaceId,
                                 String parentFolderPath,
                                 FolderDTO body)
                          throws ApiException

Create a sub folder in a given folder

Parameters:

workspaceId - Workspace id

parentFolderPath - Parent folder id

body - Folder to create

Returns:

FolderDTO

Throws:

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

createSubFolderWithHttpInfo

public ApiResponse<FolderDTO> createSubFolderWithHttpInfo(String workspaceId,
                                                          String parentFolderPath,
                                                          FolderDTO body)
                                                   throws ApiException

Create a sub folder in a given folder

Parameters:

workspaceId - Workspace id

parentFolderPath - Parent folder id

body - Folder to create

Returns:

ApiResponse

Throws:

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

createSubFolderAsync

public com.squareup.okhttp.Call createSubFolderAsync(String workspaceId,
                                                     String parentFolderPath,
                                                     FolderDTO body,
                                                     ApiCallback<FolderDTO> callback)
                                              throws ApiException

Create a sub folder in a given folder (asynchronously)

Parameters:

workspaceId - Workspace id

parentFolderPath - Parent folder id

body - Folder to create

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