sibApi

Class FoldersApi

java.lang.Object

sibApi.FoldersApi

public class FoldersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
FoldersApi()
FoldersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateModel	createFolder(CreateUpdateFolder createFolder) Create a folder
com.squareup.okhttp.Call	createFolderAsync(CreateUpdateFolder createFolder, ApiCallback<CreateModel> callback) Create a folder (asynchronously)
com.squareup.okhttp.Call	createFolderCall(CreateUpdateFolder createFolder, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createFolder
ApiResponse<CreateModel>	createFolderWithHttpInfo(CreateUpdateFolder createFolder) Create a folder
void	deleteFolder(Long folderId) Delete a folder (and all its lists)
com.squareup.okhttp.Call	deleteFolderAsync(Long folderId, ApiCallback<Void> callback) Delete a folder (and all its lists) (asynchronously)
com.squareup.okhttp.Call	deleteFolderCall(Long folderId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteFolder
ApiResponse<Void>	deleteFolderWithHttpInfo(Long folderId) Delete a folder (and all its lists)
ApiClient	getApiClient()
GetFolder	getFolder(Long folderId) Returns a folder's details
com.squareup.okhttp.Call	getFolderAsync(Long folderId, ApiCallback<GetFolder> callback) Returns a folder's details (asynchronously)
com.squareup.okhttp.Call	getFolderCall(Long folderId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFolder
GetFolderLists	getFolderLists(Long folderId, Long limit, Long offset, String sort) Get lists in a folder
com.squareup.okhttp.Call	getFolderListsAsync(Long folderId, Long limit, Long offset, String sort, ApiCallback<GetFolderLists> callback) Get lists in a folder (asynchronously)
com.squareup.okhttp.Call	getFolderListsCall(Long folderId, Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFolderLists
ApiResponse<GetFolderLists>	getFolderListsWithHttpInfo(Long folderId, Long limit, Long offset, String sort) Get lists in a folder
GetFolders	getFolders(Long limit, Long offset, String sort) Get all folders
com.squareup.okhttp.Call	getFoldersAsync(Long limit, Long offset, String sort, ApiCallback<GetFolders> callback) Get all folders (asynchronously)
com.squareup.okhttp.Call	getFoldersCall(Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getFolders
ApiResponse<GetFolders>	getFoldersWithHttpInfo(Long limit, Long offset, String sort) Get all folders
ApiResponse<GetFolder>	getFolderWithHttpInfo(Long folderId) Returns a folder's details
void	setApiClient(ApiClient apiClient)
void	updateFolder(Long folderId, CreateUpdateFolder updateFolder) Update a folder
com.squareup.okhttp.Call	updateFolderAsync(Long folderId, CreateUpdateFolder updateFolder, ApiCallback<Void> callback) Update a folder (asynchronously)
com.squareup.okhttp.Call	updateFolderCall(Long folderId, CreateUpdateFolder updateFolder, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateFolder
ApiResponse<Void>	updateFolderWithHttpInfo(Long folderId, CreateUpdateFolder updateFolder) Update a folder

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)

createFolderCall

public com.squareup.okhttp.Call createFolderCall(CreateUpdateFolder createFolder,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for createFolder

Parameters:

createFolder - Name of the folder (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createFolder

public CreateModel createFolder(CreateUpdateFolder createFolder)
                         throws ApiException

Create a folder

Parameters:

createFolder - Name of the folder (required)

Returns:

CreateModel

Throws:

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

createFolderWithHttpInfo

public ApiResponse<CreateModel> createFolderWithHttpInfo(CreateUpdateFolder createFolder)
                                                  throws ApiException

Create a folder

Parameters:

createFolder - Name of the folder (required)

Returns:

ApiResponse<CreateModel>

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(CreateUpdateFolder createFolder,
                                                  ApiCallback<CreateModel> callback)
                                           throws ApiException

Create a folder (asynchronously)

Parameters:

createFolder - Name of the folder (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

deleteFolderCall

public com.squareup.okhttp.Call deleteFolderCall(Long folderId,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for deleteFolder

Parameters:

folderId - Id of the folder (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteFolder

public void deleteFolder(Long folderId)
                  throws ApiException

Delete a folder (and all its lists)

Parameters:

folderId - Id of the folder (required)

Throws:

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

deleteFolderWithHttpInfo

public ApiResponse<Void> deleteFolderWithHttpInfo(Long folderId)
                                           throws ApiException

Delete a folder (and all its lists)

Parameters:

folderId - Id of the folder (required)

Returns:

ApiResponse<Void>

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(Long folderId,
                                                  ApiCallback<Void> callback)
                                           throws ApiException

Delete a folder (and all its lists) (asynchronously)

Parameters:

folderId - Id of the folder (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

getFolderCall

public com.squareup.okhttp.Call getFolderCall(Long folderId,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for getFolder

Parameters:

folderId - id of the folder (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFolder

public GetFolder getFolder(Long folderId)
                    throws ApiException

Returns a folder's details

Parameters:

folderId - id of the folder (required)

Returns:

GetFolder

Throws:

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

getFolderWithHttpInfo

public ApiResponse<GetFolder> getFolderWithHttpInfo(Long folderId)
                                             throws ApiException

Returns a folder's details

Parameters:

folderId - id of the folder (required)

Returns:

ApiResponse<GetFolder>

Throws:

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

getFolderAsync

public com.squareup.okhttp.Call getFolderAsync(Long folderId,
                                               ApiCallback<GetFolder> callback)
                                        throws ApiException

Returns a folder's details (asynchronously)

Parameters:

folderId - id of the folder (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

getFolderListsCall

public com.squareup.okhttp.Call getFolderListsCall(Long folderId,
                                                   Long limit,
                                                   Long offset,
                                                   String sort,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getFolderLists

Parameters:

folderId - Id of the folder (required)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFolderLists

public GetFolderLists getFolderLists(Long folderId,
                                     Long limit,
                                     Long offset,
                                     String sort)
                              throws ApiException

Get lists in a folder

Parameters:

folderId - Id of the folder (required)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetFolderLists

Throws:

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

getFolderListsWithHttpInfo

public ApiResponse<GetFolderLists> getFolderListsWithHttpInfo(Long folderId,
                                                              Long limit,
                                                              Long offset,
                                                              String sort)
                                                       throws ApiException

Get lists in a folder

Parameters:

folderId - Id of the folder (required)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

ApiResponse<GetFolderLists>

Throws:

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

getFolderListsAsync

public com.squareup.okhttp.Call getFolderListsAsync(Long folderId,
                                                    Long limit,
                                                    Long offset,
                                                    String sort,
                                                    ApiCallback<GetFolderLists> callback)
                                             throws ApiException

Get lists in a folder (asynchronously)

Parameters:

folderId - Id of the folder (required)

limit - Number of documents per page (optional, default to 10)

offset - Index of the first document of the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

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

getFoldersCall

public com.squareup.okhttp.Call getFoldersCall(Long limit,
                                               Long offset,
                                               String sort,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for getFolders

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getFolders

public GetFolders getFolders(Long limit,
                             Long offset,
                             String sort)
                      throws ApiException

Get all folders

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetFolders

Throws:

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

getFoldersWithHttpInfo

public ApiResponse<GetFolders> getFoldersWithHttpInfo(Long limit,
                                                      Long offset,
                                                      String sort)
                                               throws ApiException

Get all folders

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

ApiResponse<GetFolders>

Throws:

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

getFoldersAsync

public com.squareup.okhttp.Call getFoldersAsync(Long limit,
                                                Long offset,
                                                String sort,
                                                ApiCallback<GetFolders> callback)
                                         throws ApiException

Get all folders (asynchronously)

Parameters:

limit - Number of documents per page (required)

offset - Index of the first document of the page (required)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

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

updateFolderCall

public com.squareup.okhttp.Call updateFolderCall(Long folderId,
                                                 CreateUpdateFolder updateFolder,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for updateFolder

Parameters:

folderId - Id of the folder (required)

updateFolder - Name of the folder (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateFolder

public void updateFolder(Long folderId,
                         CreateUpdateFolder updateFolder)
                  throws ApiException

Update a folder

Parameters:

folderId - Id of the folder (required)

updateFolder - Name of the folder (required)

Throws:

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

updateFolderWithHttpInfo

public ApiResponse<Void> updateFolderWithHttpInfo(Long folderId,
                                                  CreateUpdateFolder updateFolder)
                                           throws ApiException

Update a folder

Parameters:

folderId - Id of the folder (required)

updateFolder - Name of the folder (required)

Returns:

ApiResponse<Void>

Throws:

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

updateFolderAsync

public com.squareup.okhttp.Call updateFolderAsync(Long folderId,
                                                  CreateUpdateFolder updateFolder,
                                                  ApiCallback<Void> callback)
                                           throws ApiException

Update a folder (asynchronously)

Parameters:

folderId - Id of the folder (required)

updateFolder - Name of the folder (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