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 and Description
class	BulkEnvelopesApi.GetOptions
class	BulkEnvelopesApi.GetRecipientsOptions
class	BulkEnvelopesApi.ListOptions

Constructor Summary

Constructors

Constructor and Description
BulkEnvelopesApi()
BulkEnvelopesApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and 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
BulkRecipientsUpdateResponse	deleteRecipients(String accountId, String envelopeId, String recipientId) Deletes the bulk recipient file from an envelope.
BulkEnvelopeStatus	get(String accountId, String batchId) Gets the status of a specified bulk send operation.
BulkEnvelopeStatus	get(String accountId, String batchId, BulkEnvelopesApi.GetOptions options) Gets the status of a specified bulk send operation.
ApiClient	getApiClient()
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
BulkRecipientsResponse	getRecipients(String accountId, String envelopeId, String recipientId) Gets the bulk recipient file from an envelope.
BulkRecipientsResponse	getRecipients(String accountId, String envelopeId, String recipientId, BulkEnvelopesApi.GetRecipientsOptions options) Gets the bulk recipient file from an envelope.
BulkEnvelopesResponse	list(String accountId) Gets status information about bulk recipient batches.
BulkEnvelopesResponse	list(String accountId, BulkEnvelopesApi.ListOptions options) Gets status information about bulk recipient batches.
void	setApiClient(ApiClient apiClient)
BulkSendingList	updateBulkSendList(String accountId, String bulkSendListId, BulkSendingList bulkSendingList) Updates an existing bulk send list.
BulkRecipientsSummaryResponse	updateRecipients(String accountId, String envelopeId, String recipientId, byte[] bulkRecipientsRequest) Adds or replaces envelope bulk recipients.

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

deleteRecipients

public BulkRecipientsUpdateResponse deleteRecipients(String accountId,
                                            String envelopeId,
                                            String recipientId)
                                              throws ApiException

Deletes the bulk recipient file from an envelope. Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.

Parameters:

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

envelopeId - The envelopeId Guid of the envelope being accessed. (required)

recipientId - The ID of the recipient being accessed. (required)

Returns:

BulkRecipientsUpdateResponse

Throws:

ApiException - if fails to make API call

get

public BulkEnvelopeStatus get(String accountId,
                     String batchId)
                       throws ApiException

Gets the status of a specified bulk send operation. Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.

Parameters:

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

batchId - (required)

Returns:

BulkEnvelopeStatus

Throws:

ApiException

get

public BulkEnvelopeStatus get(String accountId,
                     String batchId,
                     BulkEnvelopesApi.GetOptions options)
                       throws ApiException

Gets the status of a specified bulk send operation. Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.

Parameters:

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

batchId - (required)

options - for modifying the method behavior.

Returns:

BulkEnvelopeStatus

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

getRecipients

public BulkRecipientsResponse getRecipients(String accountId,
                                   String envelopeId,
                                   String recipientId)
                                     throws ApiException

Gets the bulk recipient file from an envelope. Retrieves the bulk recipient file information from an envelope that has a bulk recipient.

Parameters:

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

envelopeId - The envelopeId Guid of the envelope being accessed. (required)

recipientId - The ID of the recipient being accessed. (required)

Returns:

BulkRecipientsResponse

Throws:

ApiException

getRecipients

public BulkRecipientsResponse getRecipients(String accountId,
                                   String envelopeId,
                                   String recipientId,
                                   BulkEnvelopesApi.GetRecipientsOptions options)
                                     throws ApiException

Gets the bulk recipient file from an envelope. Retrieves the bulk recipient file information from an envelope that has a bulk recipient.

Parameters:

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

envelopeId - The envelopeId Guid of the envelope being accessed. (required)

recipientId - The ID of the recipient being accessed. (required)

options - for modifying the method behavior.

Returns:

BulkRecipientsResponse

Throws:

ApiException - if fails to make API call

list

public BulkEnvelopesResponse list(String accountId)
                           throws ApiException

Gets status information about bulk recipient batches. Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches.

Parameters:

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

Returns:

BulkEnvelopesResponse

Throws:

ApiException

list

public BulkEnvelopesResponse list(String accountId,
                         BulkEnvelopesApi.ListOptions options)
                           throws ApiException

Gets status information about bulk recipient batches. Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches.

Parameters:

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

options - for modifying the method behavior.

Returns:

BulkEnvelopesResponse

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

updateRecipients

public BulkRecipientsSummaryResponse updateRecipients(String accountId,
                                             String envelopeId,
                                             String recipientId,
                                             byte[] bulkRecipientsRequest)
                                               throws ApiException

Adds or replaces envelope bulk recipients. Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.

Parameters:

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

envelopeId - The envelope's GUID. Example: `93be49ab-afa0-4adf-933c-f752070d71ec` (required)

recipientId - A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. (required)

bulkRecipientsRequest - (required)

Returns:

BulkRecipientsSummaryResponse

Throws:

ApiException - if fails to make API call