Package com.docusign.esign.api

Class FoldersApi

java.lang.Object

com.docusign.esign.api.FoldersApi

public class FoldersApi
extends Object

FoldersApi class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FoldersApi.CallListOptions	CallListOptions Class.
class	FoldersApi.ListItemsOptions	ListItemsOptions Class.
class	FoldersApi.SearchOptions	SearchOptions Class.

Constructor Summary

Constructors

Constructor	Description
FoldersApi()	FoldersApi.
FoldersApi(ApiClient apiClient)	FoldersApi.

Method Summary

Modifier and Type	Method	Description
FoldersResponse	callList(String accountId)	Gets a list of the folders for the account..
FoldersResponse	callList(String accountId, FoldersApi.CallListOptions options)	Gets a list of the folders for the account..
ApiResponse<FoldersResponse>	callListWithHttpInfo(String accountId, FoldersApi.CallListOptions options)	Gets a list of the folders for the account.
ApiClient	getApiClient()	getApiClient Method.
FolderItemsResponse	listItems(String accountId, String folderId)	Gets a list of the envelopes in the specified folder..
FolderItemsResponse	listItems(String accountId, String folderId, FoldersApi.ListItemsOptions options)	Gets a list of the envelopes in the specified folder..
ApiResponse<FolderItemsResponse>	listItemsWithHttpInfo(String accountId, String folderId, FoldersApi.ListItemsOptions options)	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..
ApiResponse<FoldersResponse>	moveEnvelopesWithHttpInfo(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..
ApiResponse<FolderItemResponse>	searchWithHttpInfo(String accountId, String searchFolderId, FoldersApi.SearchOptions options)	Gets a list of envelopes in folders matching the specified criteria.
void	setApiClient(ApiClient apiClient)	setApiClient Method.

Methods inherited from class java.lang.Object

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

Constructor Detail

FoldersApi

public FoldersApi()

FoldersApi.

FoldersApi

public FoldersApi(ApiClient apiClient)

FoldersApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

callList

public FoldersResponse callList(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. (required)

Returns:

FoldersResponse

Throws:

ApiException

callList

public FoldersResponse callList(String accountId,
                                FoldersApi.CallListOptions options)
                         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. (required)

options - for modifying the method behavior.

Returns:

FoldersResponse

Throws:

ApiException - if fails to make API call

callListWithHttpInfo

public ApiResponse<FoldersResponse> callListWithHttpInfo(String accountId,
                                                         FoldersApi.CallListOptions options)
                                                  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. (required)

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. (required)

folderId - The ID of the folder being accessed. (required)

Returns:

FolderItemsResponse

Throws:

ApiException

listItems

public FolderItemsResponse listItems(String accountId,
                                     String folderId,
                                     FoldersApi.ListItemsOptions options)
                              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. (required)

folderId - The ID of the folder being accessed. (required)

options - for modifying the method behavior.

Returns:

FolderItemsResponse

Throws:

ApiException - if fails to make API call

listItemsWithHttpInfo

public ApiResponse<FolderItemsResponse> listItemsWithHttpInfo(String accountId,
                                                              String folderId,
                                                              FoldersApi.ListItemsOptions options)
                                                       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. (required)

folderId - The ID of the folder being accessed. (required)

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 envelopes to the specified folder.

Parameters:

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

folderId - The ID of the folder being accessed. (required)

foldersRequest - (optional)

Returns:

FoldersResponse

Throws:

ApiException - if fails to make API call

moveEnvelopesWithHttpInfo

public ApiResponse<FoldersResponse> moveEnvelopesWithHttpInfo(String accountId,
                                                              String folderId,
                                                              FoldersRequest foldersRequest)
                                                       throws ApiException

Moves an envelope from its current folder to the specified folder. Moves envelopes to the specified folder.

Parameters:

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

folderId - The ID of the folder being accessed. (required)

foldersRequest - (optional)

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. If 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. (required)

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. (required)

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. If 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. (required)

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. (required)

options - for modifying the method behavior.

Returns:

FolderItemResponse

Throws:

ApiException - if fails to make API call

searchWithHttpInfo

public ApiResponse<FolderItemResponse> searchWithHttpInfo(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. If 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. (required)

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. (required)

options - for modifying the method behavior.

Returns:

FolderItemResponse

Throws:

ApiException - if fails to make API call