com.docusign.esign.api.FoldersApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docusign-esign-java Show documentation
Show all versions of docusign-esign-java Show documentation
The official Docusign eSignature JAVA client is based on version 2.1 of the Docusign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.
package com.docusign.esign.api;
import javax.ws.rs.core.GenericType;
import com.docusign.esign.client.ApiException;
import com.docusign.esign.client.ApiClient;
import com.docusign.esign.client.Configuration;
import com.docusign.esign.model.*;
import com.docusign.esign.client.Pair;
public class FoldersApi {
private ApiClient apiClient;
public FoldersApi() {
this(Configuration.getDefaultApiClient());
}
public FoldersApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
///
/// 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.
///
public class ListOptions
{
private String include = null;
private String includeItems = null;
private String startPosition = null;
private String template = null;
private String userFilter = null;
/*
*
*/
public void setInclude(String include) {
this.include = include;
}
public String getInclude() {
return this.include;
}
/*
*
*/
public void setIncludeItems(String includeItems) {
this.includeItems = includeItems;
}
public String getIncludeItems() {
return this.includeItems;
}
/*
*
*/
public void setStartPosition(String startPosition) {
this.startPosition = startPosition;
}
public String getStartPosition() {
return this.startPosition;
}
/*
* Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
*/
public void setTemplate(String template) {
this.template = template;
}
public String getTemplate() {
return this.template;
}
/*
*
*/
public void setUserFilter(String userFilter) {
this.userFilter = userFilter;
}
public String getUserFilter() {
return this.userFilter;
}
}
/**
* 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.
* @param accountId The external account number (int) or account ID Guid. (required)
* @return FoldersResponse
*/
public FoldersResponse list(String accountId) throws ApiException {
return list(accountId, null);
}
/**
* 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.
* @param accountId The external account number (int) or account ID Guid. (required)
* @param options for modifying the method behavior.
* @return FoldersResponse
* @throws ApiException if fails to make API call
*/
public FoldersResponse list(String accountId, FoldersApi.ListOptions options) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(400, "Missing the required parameter 'accountId' when calling list");
}
// create path and map variables
String localVarPath = "/v2.1/accounts/{accountId}/folders"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("include", options.include));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("include_items", options.includeItems));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("start_position", options.startPosition));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("template", options.template));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("user_filter", options.userFilter));
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "docusignAccessCode" };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
///
/// 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.
///
public class ListItemsOptions
{
private String fromDate = null;
private String includeItems = null;
private String ownerEmail = null;
private String ownerName = null;
private String searchText = null;
private String startPosition = null;
private String status = null;
private String toDate = null;
/*
* Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
*/
public void setFromDate(String fromDate) {
this.fromDate = fromDate;
}
public String getFromDate() {
return this.fromDate;
}
/*
*
*/
public void setIncludeItems(String includeItems) {
this.includeItems = includeItems;
}
public String getIncludeItems() {
return this.includeItems;
}
/*
* The email of the folder owner.
*/
public void setOwnerEmail(String ownerEmail) {
this.ownerEmail = ownerEmail;
}
public String getOwnerEmail() {
return this.ownerEmail;
}
/*
* The name of the folder owner.
*/
public void setOwnerName(String ownerName) {
this.ownerName = ownerName;
}
public String getOwnerName() {
return this.ownerName;
}
/*
* The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
*/
public void setSearchText(String searchText) {
this.searchText = searchText;
}
public String getSearchText() {
return this.searchText;
}
/*
* The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
*/
public void setStartPosition(String startPosition) {
this.startPosition = startPosition;
}
public String getStartPosition() {
return this.startPosition;
}
/*
* The current status of the envelope. If no value is provided, the default search is all/any status.
*/
public void setStatus(String status) {
this.status = status;
}
public String getStatus() {
return this.status;
}
/*
* Only return items up to this date. If no value is provided, the default search is to the current date.
*/
public void setToDate(String toDate) {
this.toDate = toDate;
}
public String getToDate() {
return this.toDate;
}
}
/**
* 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.
* @param accountId The external account number (int) or account ID Guid. (required)
* @param folderId The ID of the folder being accessed. (required)
* @return FolderItemsResponse
*/
public FolderItemsResponse listItems(String accountId, String folderId) throws ApiException {
return listItems(accountId, folderId, null);
}
/**
* 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.
* @param accountId The external account number (int) or account ID Guid. (required)
* @param folderId The ID of the folder being accessed. (required)
* @param options for modifying the method behavior.
* @return FolderItemsResponse
* @throws ApiException if fails to make API call
*/
public FolderItemsResponse listItems(String accountId, String folderId, FoldersApi.ListItemsOptions options) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(400, "Missing the required parameter 'accountId' when calling listItems");
}
// verify the required parameter 'folderId' is set
if (folderId == null) {
throw new ApiException(400, "Missing the required parameter 'folderId' when calling listItems");
}
// create path and map variables
String localVarPath = "/v2.1/accounts/{accountId}/folders/{folderId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "folderId" + "\\}", apiClient.escapeString(folderId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("from_date", options.fromDate));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("include_items", options.includeItems));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("owner_email", options.ownerEmail));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("owner_name", options.ownerName));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("search_text", options.searchText));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("start_position", options.startPosition));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("status", options.status));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("to_date", options.toDate));
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "docusignAccessCode" };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
/**
* Moves an envelope from its current folder to the specified folder.
* Moves envelopes to the specified folder.
* @param accountId The external account number (int) or account ID Guid. (required)
* @param folderId The ID of the folder being accessed. (required)
* @param foldersRequest (optional)
* @return FoldersResponse
* @throws ApiException if fails to make API call
*/
public FoldersResponse moveEnvelopes(String accountId, String folderId, FoldersRequest foldersRequest) throws ApiException {
Object localVarPostBody = foldersRequest;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(400, "Missing the required parameter 'accountId' when calling moveEnvelopes");
}
// verify the required parameter 'folderId' is set
if (folderId == null) {
throw new ApiException(400, "Missing the required parameter 'folderId' when calling moveEnvelopes");
}
// create path and map variables
String localVarPath = "/v2.1/accounts/{accountId}/folders/{folderId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "folderId" + "\\}", apiClient.escapeString(folderId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "docusignAccessCode" };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
///
/// 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.
///
public class SearchOptions
{
private String all = null;
private String count = null;
private String fromDate = null;
private String includeRecipients = null;
private String order = null;
private String orderBy = null;
private String startPosition = null;
private String toDate = null;
/*
* Specifies that all envelopes that match the criteria are returned.
*/
public void setAll(String all) {
this.all = all;
}
public String getAll() {
return this.all;
}
/*
* Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
*/
public void setCount(String count) {
this.count = count;
}
public String getCount() {
return this.count;
}
/*
* Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
*/
public void setFromDate(String fromDate) {
this.fromDate = fromDate;
}
public String getFromDate() {
return this.fromDate;
}
/*
* When set to **true**, the recipient information is returned in the response.
*/
public void setIncludeRecipients(String includeRecipients) {
this.includeRecipients = includeRecipients;
}
public String getIncludeRecipients() {
return this.includeRecipients;
}
/*
* Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.
*/
public void setOrder(String order) {
this.order = order;
}
public String getOrder() {
return this.order;
}
/*
* Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.
*/
public void setOrderBy(String orderBy) {
this.orderBy = orderBy;
}
public String getOrderBy() {
return this.orderBy;
}
/*
* Specifies the the starting location in the result set of the items that are returned.
*/
public void setStartPosition(String startPosition) {
this.startPosition = startPosition;
}
public String getStartPosition() {
return this.startPosition;
}
/*
* Specifies the end of the date range to return.
*/
public void setToDate(String toDate) {
this.toDate = toDate;
}
public String getToDate() {
return this.toDate;
}
}
/**
* 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.
* @param accountId The external account number (int) or account ID Guid. (required)
* @param 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)
* @return FolderItemResponse
*/
public FolderItemResponse search(String accountId, String searchFolderId) throws ApiException {
return search(accountId, searchFolderId, null);
}
/**
* 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.
* @param accountId The external account number (int) or account ID Guid. (required)
* @param 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)
* @param options for modifying the method behavior.
* @return FolderItemResponse
* @throws ApiException if fails to make API call
*/
public FolderItemResponse search(String accountId, String searchFolderId, FoldersApi.SearchOptions options) throws ApiException {
Object localVarPostBody = "{}";
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(400, "Missing the required parameter 'accountId' when calling search");
}
// verify the required parameter 'searchFolderId' is set
if (searchFolderId == null) {
throw new ApiException(400, "Missing the required parameter 'searchFolderId' when calling search");
}
// create path and map variables
String localVarPath = "/v2.1/accounts/{accountId}/search_folders/{searchFolderId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll("\\{" + "searchFolderId" + "\\}", apiClient.escapeString(searchFolderId.toString()));
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.List localVarCollectionQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("all", options.all));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("count", options.count));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("from_date", options.fromDate));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("include_recipients", options.includeRecipients));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("order", options.order));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("order_by", options.orderBy));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("start_position", options.startPosition));
}if (options != null) {
localVarQueryParams.addAll(apiClient.parameterToPair("to_date", options.toDate));
}
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "docusignAccessCode" };
GenericType localVarReturnType = new GenericType() {};
return apiClient.invokeAPI(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, localVarReturnType);
}
}