Package com.docusign.esign.api

Class BulkEnvelopesApi

java.lang.Object

com.docusign.esign.api.BulkEnvelopesApi

public class BulkEnvelopesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BulkEnvelopesApi.GetBulkSendBatchEnvelopesOptions
class	BulkEnvelopesApi.GetBulkSendBatchesOptions

Constructor Summary

Constructors

Constructor	Description
BulkEnvelopesApi()
BulkEnvelopesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BulkSendingList	createBulkSendList(String accountId, BulkSendingList bulkSendingList)	Creates a new bulk send list
BulkSendResponse	createBulkSendRequest(String accountId, String bulkSendListId, BulkSendRequest bulkSendRequest)	Uses the specified bulk send list to send the envelope specified in the payload
BulkSendTestResponse	createBulkSendTestRequest(String accountId, String bulkSendListId, BulkSendRequest bulkSendRequest)	Tests whether the specified bulk sending list can be used to send an envelope
BulkSendingListSummaries	deleteBulkSendList(String accountId, String bulkSendListId)	Deletes an existing bulk send list
ApiClient	getApiClient()
EnvelopesInformation	getBulkSendBatchEnvelopes(String accountId, String bulkSendBatchId)	Gets envelopes from a specific bulk send batch
EnvelopesInformation	getBulkSendBatchEnvelopes(String accountId, String bulkSendBatchId, BulkEnvelopesApi.GetBulkSendBatchEnvelopesOptions options)	Gets envelopes from a specific bulk send batch
BulkSendBatchSummaries	getBulkSendBatches(String accountId)	Returns a list of bulk send batch satuses initiated by account.
BulkSendBatchSummaries	getBulkSendBatches(String accountId, BulkEnvelopesApi.GetBulkSendBatchesOptions options)	Returns a list of bulk send batch satuses initiated by account.
BulkSendBatchStatus	getBulkSendBatchStatus(String accountId, String bulkSendBatchId)	Gets a specific bulk send batch status
BulkSendingList	getBulkSendList(String accountId, String bulkSendListId)	Gets a specific bulk send list
BulkSendingListSummaries	getBulkSendLists(String accountId)	Lists top-level details for all bulk send lists visible to the current user
void	setApiClient(ApiClient apiClient)
BulkSendBatchStatus	updateBulkSendBatchStatus(String accountId, String bulkSendBatchId, BulkSendBatchRequest bulkSendBatchRequest)	Put/Update a specific bulk send batch status
BulkSendingList	updateBulkSendList(String accountId, String bulkSendListId, BulkSendingList bulkSendingList)	Updates an existing bulk send list.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkEnvelopesApi

public BulkEnvelopesApi()

BulkEnvelopesApi

public BulkEnvelopesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createBulkSendList

public BulkSendingList createBulkSendList(String accountId,
                                          BulkSendingList bulkSendingList)
                                   throws ApiException

Creates a new bulk send list

Parameters:

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

bulkSendingList - (optional)

Returns:

BulkSendingList

Throws:

ApiException - if fails to make API call

createBulkSendRequest

public BulkSendResponse createBulkSendRequest(String accountId,
                                              String bulkSendListId,
                                              BulkSendRequest bulkSendRequest)
                                       throws ApiException

Uses the specified bulk send list to send the envelope specified in the payload

Parameters:

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

bulkSendListId - (required)

bulkSendRequest - (optional)

Returns:

BulkSendResponse

Throws:

ApiException - if fails to make API call

createBulkSendTestRequest

public BulkSendTestResponse createBulkSendTestRequest(String accountId,
                                                      String bulkSendListId,
                                                      BulkSendRequest bulkSendRequest)
                                               throws ApiException

Tests whether the specified bulk sending list can be used to send an envelope

Parameters:

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

bulkSendListId - (required)

bulkSendRequest - (optional)

Returns:

BulkSendTestResponse

Throws:

ApiException - if fails to make API call

deleteBulkSendList

public BulkSendingListSummaries deleteBulkSendList(String accountId,
                                                   String bulkSendListId)
                                            throws ApiException

Deletes an existing bulk send list

Parameters:

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

bulkSendListId - (required)

Returns:

BulkSendingListSummaries

Throws:

ApiException - if fails to make API call

getBulkSendBatchEnvelopes

public EnvelopesInformation getBulkSendBatchEnvelopes(String accountId,
                                                      String bulkSendBatchId)
                                               throws ApiException

Gets envelopes from a specific bulk send batch

Parameters:

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

bulkSendBatchId - (required)

Returns:

EnvelopesInformation

Throws:

ApiException

getBulkSendBatchEnvelopes

public EnvelopesInformation getBulkSendBatchEnvelopes(String accountId,
                                                      String bulkSendBatchId,
                                                      BulkEnvelopesApi.GetBulkSendBatchEnvelopesOptions options)
                                               throws ApiException

Gets envelopes from a specific bulk send batch

Parameters:

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

bulkSendBatchId - (required)

options - for modifying the method behavior.

Returns:

EnvelopesInformation

Throws:

ApiException - if fails to make API call

getBulkSendBatchStatus

public BulkSendBatchStatus getBulkSendBatchStatus(String accountId,
                                                  String bulkSendBatchId)
                                           throws ApiException

Gets a specific bulk send batch status

Parameters:

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

bulkSendBatchId - (required)

Returns:

BulkSendBatchStatus

Throws:

ApiException - if fails to make API call

getBulkSendBatches

public BulkSendBatchSummaries getBulkSendBatches(String accountId)
                                          throws ApiException

Returns a list of bulk send batch satuses initiated by account.

Parameters:

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

Returns:

BulkSendBatchSummaries

Throws:

ApiException

getBulkSendBatches

public BulkSendBatchSummaries getBulkSendBatches(String accountId,
                                                 BulkEnvelopesApi.GetBulkSendBatchesOptions options)
                                          throws ApiException

Returns a list of bulk send batch satuses initiated by account.

Parameters:

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

options - for modifying the method behavior.

Returns:

BulkSendBatchSummaries

Throws:

ApiException - if fails to make API call

getBulkSendList

public BulkSendingList getBulkSendList(String accountId,
                                       String bulkSendListId)
                                throws ApiException

Gets a specific bulk send list

Parameters:

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

bulkSendListId - (required)

Returns:

BulkSendingList

Throws:

ApiException - if fails to make API call

getBulkSendLists

public BulkSendingListSummaries getBulkSendLists(String accountId)
                                          throws ApiException

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

Parameters:

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

Returns:

BulkSendingListSummaries

Throws:

ApiException - if fails to make API call

updateBulkSendBatchStatus

public BulkSendBatchStatus updateBulkSendBatchStatus(String accountId,
                                                     String bulkSendBatchId,
                                                     BulkSendBatchRequest bulkSendBatchRequest)
                                              throws ApiException

Put/Update a specific bulk send batch status

Parameters:

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

bulkSendBatchId - (required)

bulkSendBatchRequest - (optional)

Returns:

BulkSendBatchStatus

Throws:

ApiException - if fails to make API call

updateBulkSendList

public BulkSendingList updateBulkSendList(String accountId,
                                          String bulkSendListId,
                                          BulkSendingList bulkSendingList)
                                   throws ApiException

Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope

Parameters:

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

bulkSendListId - (required)

bulkSendingList - (optional)

Returns:

BulkSendingList

Throws:

ApiException - if fails to make API call