com.docusign.esign.api

Class FoldersApi

java.lang.Object

com.docusign.esign.api.FoldersApi

public class FoldersApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FoldersApi.SearchOptions

Constructor Summary

Constructors

Constructor and Description
FoldersApi()
FoldersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
FoldersResponse	list(String accountId) Gets a list of the folders for the account.
FolderItemsResponse	listItems(String accountId, String folderId) Gets a list of the envelopes in the specified folder.
FoldersResponse	moveEnvelopes(String accountId, String folderId, FoldersRequest foldersRequest) Moves an envelope from its current folder to the specified folder.
FolderItemResponse	search(String accountId, String searchFolderId) Gets a list of envelopes in folders matching the specified criteria.
FolderItemResponse	search(String accountId, String searchFolderId, FoldersApi.SearchOptions options) Gets a list of envelopes in folders matching the specified criteria.
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)

list

public FoldersResponse list(String accountId)
                     throws ApiException

Gets a list of the folders for the account. Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

Parameters:

accountId - The external account number (int) or account ID Guid. FoldersApi.ListOptions Options for modifying the method behavior.

Returns:

FoldersResponse

Throws:

ApiException - if fails to make API call

listItems

public FolderItemsResponse listItems(String accountId,
                                     String folderId)
                              throws ApiException

Gets a list of the envelopes in the specified folder. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

Parameters:

accountId - The external account number (int) or account ID Guid.

folderId - The ID of the folder being accessed. FoldersApi.ListItemsOptions Options for modifying the method behavior.

Returns:

FolderItemsResponse

Throws:

ApiException - if fails to make API call

moveEnvelopes

public FoldersResponse moveEnvelopes(String accountId,
                                     String folderId,
                                     FoldersRequest foldersRequest)
                              throws ApiException

Moves an envelope from its current folder to the specified folder. Moves an envelope from its current folder to the specified folder.\n\n###### Note: You can use this endpoint to delete envelopes by specifying `recyclebin' in the `folderId` parameter of the endpoint. Placing an in process envelope (envelope status of `sent` or `delivered`) in the recycle bin voids the envelope. You can also use this endpoint to delete templates by specifying a template ID instead of an envelope ID in the 'envelopeIds' property and specifying `recyclebin` in the `folderId` parameter.

Parameters:

accountId - The external account number (int) or account ID Guid.

folderId - The ID of the folder being accessed. FoldersApi.MoveEnvelopesOptions Options for modifying the method behavior.

Returns:

FoldersResponse

Throws:

ApiException - if fails to make API call

search

public FolderItemResponse search(String accountId,
                                 String searchFolderId)
                          throws ApiException

Gets a list of envelopes in folders matching the specified criteria. Retrieves a list of envelopes that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Parameters:

accountId - The external account number (int) or account ID Guid.

searchFolderId - Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.

Returns:

FolderItemResponse

Throws:

ApiException

search

public FolderItemResponse search(String accountId,
                                 String searchFolderId,
                                 FoldersApi.SearchOptions options)
                          throws ApiException

Gets a list of envelopes in folders matching the specified criteria. Retrieves a list of envelopes that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Parameters:

accountId - The external account number (int) or account ID Guid.

searchFolderId - Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature. FoldersApi.SearchOptions Options for modifying the method behavior.

Returns:

FolderItemResponse

Throws:

ApiException - if fails to make API call