Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.docusign.esign.api.BulkProcessDataApi Maven / Gradle / Ivy
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 com.docusign.esign.client.ApiClient;
import com.docusign.esign.client.ApiException;
import com.docusign.esign.client.ApiResponse;
import com.docusign.esign.client.Configuration;
import com.docusign.esign.client.Pair;
import com.docusign.esign.model.*;
import jakarta.ws.rs.core.GenericType;
/** BulkProcessDataApi class. */
public class BulkProcessDataApi {
private ApiClient apiClient;
/** BulkProcessDataApi. */
public BulkProcessDataApi() {
this(Configuration.getDefaultApiClient());
}
/** BulkProcessDataApi. */
public BulkProcessDataApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* getApiClient Method.
*
* @return ApiClient
*/
public ApiClient getApiClient() {
return apiClient;
}
/** setApiClient Method. */
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Uses the specified bulk envelopes list to update the envelopes specified in the payload.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @throws ApiException if fails to make API call
*/
public void createBulkProcessRequest(String accountId, String processAction) throws ApiException {
createBulkProcessRequestWithHttpInfo(accountId, processAction);
}
/**
* Uses the specified bulk envelopes list to update the envelopes specified in the payload
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse createBulkProcessRequestWithHttpInfo(
String accountId, String processAction) 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 createBulkProcessRequest");
}
// verify the required parameter 'processAction' is set
if (processAction == null) {
throw new ApiException(
400,
"Missing the required parameter 'processAction' when calling createBulkProcessRequest");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "processAction" + "\\}", apiClient.escapeString(processAction.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"};
apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null);
return new ApiResponse(apiClient.getStatusCode(), apiClient.getResponseHeaders(), null);
}
/**
* Uses the specified bulk envelopes list to update the envelopes specified in the payload.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @param bulkProcessRequest (optional)
* @return BulkProcessResponse
* @throws ApiException if fails to make API call
*/
public BulkProcessResponse createBulkProcessRequestToQueue(
String accountId,
String processAction,
String bulkProcessListId,
BulkProcessRequest bulkProcessRequest)
throws ApiException {
ApiResponse localVarResponse =
createBulkProcessRequestToQueueWithHttpInfo(
accountId, processAction, bulkProcessListId, bulkProcessRequest);
return localVarResponse.getData();
}
/**
* Uses the specified bulk envelopes list to update the envelopes specified in the payload
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @param bulkProcessRequest (optional)
* @return BulkProcessResponse
* @throws ApiException if fails to make API call
*/
public ApiResponse createBulkProcessRequestToQueueWithHttpInfo(
String accountId,
String processAction,
String bulkProcessListId,
BulkProcessRequest bulkProcessRequest)
throws ApiException {
Object localVarPostBody = bulkProcessRequest;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400,
"Missing the required parameter 'accountId' when calling createBulkProcessRequestToQueue");
}
// verify the required parameter 'processAction' is set
if (processAction == null) {
throw new ApiException(
400,
"Missing the required parameter 'processAction' when calling createBulkProcessRequestToQueue");
}
// verify the required parameter 'bulkProcessListId' is set
if (bulkProcessListId == null) {
throw new ApiException(
400,
"Missing the required parameter 'bulkProcessListId' when calling createBulkProcessRequestToQueue");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "processAction" + "\\}", apiClient.escapeString(processAction.toString()))
.replaceAll(
"\\{" + "bulkProcessListId" + "\\}",
apiClient.escapeString(bulkProcessListId.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() {};
BulkProcessResponse localVarResponse =
apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Deletes a specific bulk process list.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @return BulkProcessResult
* @throws ApiException if fails to make API call
*/
public BulkProcessResult deleteBulkProcessList(
String accountId, String processAction, String bulkProcessListId) throws ApiException {
ApiResponse localVarResponse =
deleteBulkProcessListWithHttpInfo(accountId, processAction, bulkProcessListId);
return localVarResponse.getData();
}
/**
* Deletes a specific bulk process list
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @return BulkProcessResult
* @throws ApiException if fails to make API call
*/
public ApiResponse deleteBulkProcessListWithHttpInfo(
String accountId, String processAction, String bulkProcessListId) 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 deleteBulkProcessList");
}
// verify the required parameter 'processAction' is set
if (processAction == null) {
throw new ApiException(
400, "Missing the required parameter 'processAction' when calling deleteBulkProcessList");
}
// verify the required parameter 'bulkProcessListId' is set
if (bulkProcessListId == null) {
throw new ApiException(
400,
"Missing the required parameter 'bulkProcessListId' when calling deleteBulkProcessList");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "processAction" + "\\}", apiClient.escapeString(processAction.toString()))
.replaceAll(
"\\{" + "bulkProcessListId" + "\\}",
apiClient.escapeString(bulkProcessListId.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() {};
BulkProcessResult localVarResponse =
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Deletes a specific bulk process list.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessingLists (optional)
* @return BulkProcessResult
* @throws ApiException if fails to make API call
*/
public BulkProcessResult deleteBulkProcessLists(
String accountId, String processAction, BulkProcessingLists bulkProcessingLists)
throws ApiException {
ApiResponse localVarResponse =
deleteBulkProcessListsWithHttpInfo(accountId, processAction, bulkProcessingLists);
return localVarResponse.getData();
}
/**
* Deletes a specific bulk process list
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessingLists (optional)
* @return BulkProcessResult
* @throws ApiException if fails to make API call
*/
public ApiResponse deleteBulkProcessListsWithHttpInfo(
String accountId, String processAction, BulkProcessingLists bulkProcessingLists)
throws ApiException {
Object localVarPostBody = bulkProcessingLists;
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new ApiException(
400, "Missing the required parameter 'accountId' when calling deleteBulkProcessLists");
}
// verify the required parameter 'processAction' is set
if (processAction == null) {
throw new ApiException(
400,
"Missing the required parameter 'processAction' when calling deleteBulkProcessLists");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "processAction" + "\\}", apiClient.escapeString(processAction.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() {};
BulkProcessResult localVarResponse =
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Gets a specific bulk process list.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @throws ApiException if fails to make API call
*/
public void getBulkProcessList(String accountId, String processAction, String bulkProcessListId)
throws ApiException {
getBulkProcessListWithHttpInfo(accountId, processAction, bulkProcessListId);
}
/**
* Gets a specific bulk process list
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse getBulkProcessListWithHttpInfo(
String accountId, String processAction, String bulkProcessListId) 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 getBulkProcessList");
}
// verify the required parameter 'processAction' is set
if (processAction == null) {
throw new ApiException(
400, "Missing the required parameter 'processAction' when calling getBulkProcessList");
}
// verify the required parameter 'bulkProcessListId' is set
if (bulkProcessListId == null) {
throw new ApiException(
400,
"Missing the required parameter 'bulkProcessListId' when calling getBulkProcessList");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "processAction" + "\\}", apiClient.escapeString(processAction.toString()))
.replaceAll(
"\\{" + "bulkProcessListId" + "\\}",
apiClient.escapeString(bulkProcessListId.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"};
apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null);
return new ApiResponse(apiClient.getStatusCode(), apiClient.getResponseHeaders(), null);
}
/**
* Lists top-level details for all bulk process lists visible to the current user.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @return BulkProcessingListSummaries
* @throws ApiException if fails to make API call
*/
public BulkProcessingListSummaries getBulkProcessLists(String accountId, String processAction)
throws ApiException {
ApiResponse localVarResponse =
getBulkProcessListsWithHttpInfo(accountId, processAction);
return localVarResponse.getData();
}
/**
* Lists top-level details for all bulk process lists visible to the current user
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @return BulkProcessingListSummaries
* @throws ApiException if fails to make API call
*/
public ApiResponse getBulkProcessListsWithHttpInfo(
String accountId, String processAction) 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 getBulkProcessLists");
}
// verify the required parameter 'processAction' is set
if (processAction == null) {
throw new ApiException(
400, "Missing the required parameter 'processAction' when calling getBulkProcessLists");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "processAction" + "\\}", apiClient.escapeString(processAction.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() {};
BulkProcessingListSummaries localVarResponse =
apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType);
return new ApiResponse(
apiClient.getStatusCode(), apiClient.getResponseHeaders(), localVarResponse);
}
/**
* Updates a specific bulk process list.
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @throws ApiException if fails to make API call
*/
public void updateBulkProcessList(
String accountId, String processAction, String bulkProcessListId) throws ApiException {
updateBulkProcessListWithHttpInfo(accountId, processAction, bulkProcessListId);
}
/**
* Updates a specific bulk process list
*
* @param accountId The external account number (int) or account ID Guid. (required)
* @param processAction (required)
* @param bulkProcessListId (required)
* @throws ApiException if fails to make API call
*/
public ApiResponse updateBulkProcessListWithHttpInfo(
String accountId, String processAction, String bulkProcessListId) 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 updateBulkProcessList");
}
// verify the required parameter 'processAction' is set
if (processAction == null) {
throw new ApiException(
400, "Missing the required parameter 'processAction' when calling updateBulkProcessList");
}
// verify the required parameter 'bulkProcessListId' is set
if (bulkProcessListId == null) {
throw new ApiException(
400,
"Missing the required parameter 'bulkProcessListId' when calling updateBulkProcessList");
}
// create path and map variables
String localVarPath =
"/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}"
.replaceAll("\\{" + "accountId" + "\\}", apiClient.escapeString(accountId.toString()))
.replaceAll(
"\\{" + "processAction" + "\\}", apiClient.escapeString(processAction.toString()))
.replaceAll(
"\\{" + "bulkProcessListId" + "\\}",
apiClient.escapeString(bulkProcessListId.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"};
apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarPostBody,
localVarHeaderParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null);
return new ApiResponse(apiClient.getStatusCode(), apiClient.getResponseHeaders(), null);
}
}
