Package com.docusign.esign.api

Class BulkProcessDataSendApi

java.lang.Object

com.docusign.esign.api.BulkProcessDataSendApi

public class BulkProcessDataSendApi
extends Object

BulkProcessDataSendApi class.

Constructor Summary

Constructors

Constructor	Description
BulkProcessDataSendApi()	BulkProcessDataSendApi.
BulkProcessDataSendApi(ApiClient apiClient)	BulkProcessDataSendApi.

Method Summary

Modifier and Type	Method	Description
BulkProcessResponse	createBulkProcessRequestToQueue(String accountId, String processAction, String bulkProcessListId, BulkProcessRequest bulkProcessRequest)	Uses the specified bulk envelopes list to update the envelopes specified in the payload.
BulkProcessResult	deleteBulkProcessList(String accountId, String processAction, String bulkProcessListId)	Deletes a specific bulk process list.
ApiClient	getApiClient()	getApiClient Method.
void	getBulkProcessList(String accountId, String processAction, String bulkProcessListId)	Gets a specific bulk process list.
void	setApiClient(ApiClient apiClient)	setApiClient Method.
void	updateBulkProcessList(String accountId, String processAction, String bulkProcessListId)	Updates a specific bulk process list.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkProcessDataSendApi

public BulkProcessDataSendApi()

BulkProcessDataSendApi.

BulkProcessDataSendApi

public BulkProcessDataSendApi(ApiClient apiClient)

BulkProcessDataSendApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createBulkProcessRequestToQueue

public BulkProcessResponse createBulkProcessRequestToQueue(String accountId,
                                                           String processAction,
                                                           String bulkProcessListId,
                                                           BulkProcessRequest bulkProcessRequest)
                                                    throws ApiException

Uses the specified bulk envelopes list to update the envelopes specified in the payload.

Parameters:

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

processAction - (required)

bulkProcessListId - (required)

bulkProcessRequest - (optional)

Returns:

BulkProcessResponse

Throws:

ApiException - if fails to make API call

deleteBulkProcessList

public BulkProcessResult deleteBulkProcessList(String accountId,
                                               String processAction,
                                               String bulkProcessListId)
                                        throws ApiException

Deletes a specific bulk process list.

Parameters:

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

processAction - (required)

bulkProcessListId - (required)

Returns:

BulkProcessResult

Throws:

ApiException - if fails to make API call

getBulkProcessList

public void getBulkProcessList(String accountId,
                               String processAction,
                               String bulkProcessListId)
                        throws ApiException

Gets a specific bulk process list.

Parameters:

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

processAction - (required)

bulkProcessListId - (required)

Throws:

ApiException - if fails to make API call

updateBulkProcessList

public void updateBulkProcessList(String accountId,
                                  String processAction,
                                  String bulkProcessListId)
                           throws ApiException

Updates a specific bulk process list.

Parameters:

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

processAction - (required)

bulkProcessListId - (required)

Throws:

ApiException - if fails to make API call