Package com.docusign.esign.api

Class BulkProcessDataApi

java.lang.Object

com.docusign.esign.api.BulkProcessDataApi

public class BulkProcessDataApi
extends java.lang.Object

BulkProcessDataApi class.

Constructor Summary

Constructors

Constructor	Description
BulkProcessDataApi()	BulkProcessDataApi.
BulkProcessDataApi(ApiClient apiClient)	BulkProcessDataApi.

Method Summary

Modifier and Type	Method	Description
void	createBulkProcessRequest(java.lang.String accountId, java.lang.String processAction)	Uses the specified bulk envelopes list to update the envelopes specified in the payload.
BulkProcessResponse	createBulkProcessRequestToQueue(java.lang.String accountId, java.lang.String processAction, java.lang.String bulkProcessListId, BulkProcessRequest bulkProcessRequest)	Uses the specified bulk envelopes list to update the envelopes specified in the payload.
BulkProcessResult	deleteBulkProcessList(java.lang.String accountId, java.lang.String processAction, java.lang.String bulkProcessListId)	Deletes a specific bulk process list.
BulkProcessResult	deleteBulkProcessLists(java.lang.String accountId, java.lang.String processAction, BulkProcessingLists bulkProcessingLists)	Deletes a specific bulk process list.
ApiClient	getApiClient()	getApiClient Method.
void	getBulkProcessList(java.lang.String accountId, java.lang.String processAction, java.lang.String bulkProcessListId)	Gets a specific bulk process list.
BulkProcessingListSummaries	getBulkProcessLists(java.lang.String accountId, java.lang.String processAction)	Lists top-level details for all bulk process lists visible to the current user.
void	setApiClient(ApiClient apiClient)	setApiClient Method.
void	updateBulkProcessList(java.lang.String accountId, java.lang.String processAction, java.lang.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

BulkProcessDataApi

public BulkProcessDataApi()

BulkProcessDataApi.

BulkProcessDataApi

public BulkProcessDataApi(ApiClient apiClient)

BulkProcessDataApi.

Method Detail

getApiClient

public ApiClient getApiClient()

getApiClient Method.

Returns:

ApiClient

setApiClient

public void setApiClient(ApiClient apiClient)

setApiClient Method.

createBulkProcessRequest

public void createBulkProcessRequest(java.lang.String accountId,
                                     java.lang.String processAction)
                              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)

Throws:

ApiException - if fails to make API call

createBulkProcessRequestToQueue

public BulkProcessResponse createBulkProcessRequestToQueue(java.lang.String accountId,
                                                           java.lang.String processAction,
                                                           java.lang.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(java.lang.String accountId,
                                               java.lang.String processAction,
                                               java.lang.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

deleteBulkProcessLists

public BulkProcessResult deleteBulkProcessLists(java.lang.String accountId,
                                                java.lang.String processAction,
                                                BulkProcessingLists bulkProcessingLists)
                                         throws ApiException

Deletes a specific bulk process list.

Parameters:

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

processAction - (required)

bulkProcessingLists - (optional)

Returns:

BulkProcessResult

Throws:

ApiException - if fails to make API call

getBulkProcessList

public void getBulkProcessList(java.lang.String accountId,
                               java.lang.String processAction,
                               java.lang.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

getBulkProcessLists

public BulkProcessingListSummaries getBulkProcessLists(java.lang.String accountId,
                                                       java.lang.String processAction)
                                                throws ApiException

Lists top-level details for all bulk process lists visible to the current user.

Parameters:

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

processAction - (required)

Returns:

BulkProcessingListSummaries

Throws:

ApiException - if fails to make API call

updateBulkProcessList

public void updateBulkProcessList(java.lang.String accountId,
                                  java.lang.String processAction,
                                  java.lang.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