DocuSign.eSign.Api.IBulkProcessDataSendApi Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.IBulkProcessDataSendApi:

Public Member Functions
BulkProcessResponse	CreateBulkProcessRequestToQueue (string accountId, string processAction, string bulkProcessListId, BulkProcessRequest bulkProcessRequest=null)
	Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
ApiResponse< BulkProcessResponse >	CreateBulkProcessRequestToQueueWithHttpInfo (string accountId, string processAction, string bulkProcessListId, BulkProcessRequest bulkProcessRequest=null)
	Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
BulkProcessResult	DeleteBulkProcessList (string accountId, string processAction, string bulkProcessListId)
	Deletes a specific bulk process list More...
ApiResponse< BulkProcessResult >	DeleteBulkProcessListWithHttpInfo (string accountId, string processAction, string bulkProcessListId)
	Deletes a specific bulk process list More...
void	GetBulkProcessList (string accountId, string processAction, string bulkProcessListId)
	Gets a specific bulk process list More...
ApiResponse< Object >	GetBulkProcessListWithHttpInfo (string accountId, string processAction, string bulkProcessListId)
	Gets a specific bulk process list More...
void	UpdateBulkProcessList (string accountId, string processAction, string bulkProcessListId)
	Updates a specific bulk process list More...
ApiResponse< Object >	UpdateBulkProcessListWithHttpInfo (string accountId, string processAction, string bulkProcessListId)
	Updates a specific bulk process list More...
System.Threading.Tasks.Task< BulkProcessResponse >	CreateBulkProcessRequestToQueueAsync (string accountId, string processAction, string bulkProcessListId, BulkProcessRequest bulkProcessRequest=null)
	Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
System.Threading.Tasks.Task< ApiResponse< BulkProcessResponse > >	CreateBulkProcessRequestToQueueAsyncWithHttpInfo (string accountId, string processAction, string bulkProcessListId, BulkProcessRequest bulkProcessRequest=null)
	Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
System.Threading.Tasks.Task< BulkProcessResult >	DeleteBulkProcessListAsync (string accountId, string processAction, string bulkProcessListId)
	Deletes a specific bulk process list More...
System.Threading.Tasks.Task< ApiResponse< BulkProcessResult > >	DeleteBulkProcessListAsyncWithHttpInfo (string accountId, string processAction, string bulkProcessListId)
	Deletes a specific bulk process list More...
System.Threading.Tasks.Task	GetBulkProcessListAsync (string accountId, string processAction, string bulkProcessListId)
	Gets a specific bulk process list More...
System.Threading.Tasks.Task< ApiResponse< Object > >	GetBulkProcessListAsyncWithHttpInfo (string accountId, string processAction, string bulkProcessListId)
	Gets a specific bulk process list More...
System.Threading.Tasks.Task	UpdateBulkProcessListAsync (string accountId, string processAction, string bulkProcessListId)
	Updates a specific bulk process list More...
System.Threading.Tasks.Task< ApiResponse< Object > >	UpdateBulkProcessListAsyncWithHttpInfo (string accountId, string processAction, string bulkProcessListId)
	Updates a specific bulk process list More...
Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient [get, set]
	Gets or sets the ApiClient object More...
ExceptionFactory	ExceptionFactory [get, set]
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

CreateBulkProcessRequestToQueue()

BulkProcessResponse DocuSign.eSign.Api.IBulkProcessDataSendApi.CreateBulkProcessRequestToQueue	(	string	accountId,
		string	processAction,
		string	bulkProcessListId,
		BulkProcessRequest	bulkProcessRequest = null
	)

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

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

CreateBulkProcessRequestToQueueAsync()

System.Threading.Tasks.Task<BulkProcessResponse> DocuSign.eSign.Api.IBulkProcessDataSendApi.CreateBulkProcessRequestToQueueAsync	(	string	accountId,
		string	processAction,
		string	bulkProcessListId,
		BulkProcessRequest	bulkProcessRequest = null
	)

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

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest	(optional)

Returns

Task of BulkProcessResponse

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

CreateBulkProcessRequestToQueueAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BulkProcessResponse> > DocuSign.eSign.Api.IBulkProcessDataSendApi.CreateBulkProcessRequestToQueueAsyncWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId,
		BulkProcessRequest	bulkProcessRequest = null
	)

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

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest	(optional)

Returns

Task of ApiResponse (BulkProcessResponse)

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

CreateBulkProcessRequestToQueueWithHttpInfo()

ApiResponse<BulkProcessResponse> DocuSign.eSign.Api.IBulkProcessDataSendApi.CreateBulkProcessRequestToQueueWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId,
		BulkProcessRequest	bulkProcessRequest = null
	)

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

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest	(optional)

Returns

ApiResponse of

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

DeleteBulkProcessList()

BulkProcessResult DocuSign.eSign.Api.IBulkProcessDataSendApi.DeleteBulkProcessList	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Deletes a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

DeleteBulkProcessListAsync()

System.Threading.Tasks.Task<BulkProcessResult> DocuSign.eSign.Api.IBulkProcessDataSendApi.DeleteBulkProcessListAsync	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Deletes a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Task of BulkProcessResult

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

DeleteBulkProcessListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BulkProcessResult> > DocuSign.eSign.Api.IBulkProcessDataSendApi.DeleteBulkProcessListAsyncWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Deletes a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Task of ApiResponse (BulkProcessResult)

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

DeleteBulkProcessListWithHttpInfo()

ApiResponse<BulkProcessResult> DocuSign.eSign.Api.IBulkProcessDataSendApi.DeleteBulkProcessListWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Deletes a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

ApiResponse of

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

GetBulkProcessList()

void DocuSign.eSign.Api.IBulkProcessDataSendApi.GetBulkProcessList	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Gets a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

GetBulkProcessListAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IBulkProcessDataSendApi.GetBulkProcessListAsync	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Gets a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Task of void

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

GetBulkProcessListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IBulkProcessDataSendApi.GetBulkProcessListAsyncWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Gets a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Task of ApiResponse

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

GetBulkProcessListWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IBulkProcessDataSendApi.GetBulkProcessListWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Gets a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

UpdateBulkProcessList()

void DocuSign.eSign.Api.IBulkProcessDataSendApi.UpdateBulkProcessList	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Updates a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

UpdateBulkProcessListAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IBulkProcessDataSendApi.UpdateBulkProcessListAsync	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Updates a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Task of void

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

UpdateBulkProcessListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IBulkProcessDataSendApi.UpdateBulkProcessListAsyncWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Updates a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

Task of ApiResponse

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

UpdateBulkProcessListWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IBulkProcessDataSendApi.UpdateBulkProcessListWithHttpInfo	(	string	accountId,
		string	processAction,
		string	bulkProcessListId
	)

Updates a specific bulk process list

Exceptions

DocuSign.eSign.Client.ApiException

Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
processAction
bulkProcessListId

Returns

ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.BulkProcessDataSendApi.

---

The documentation for this interface was generated from the following file:

• sdk/src/DocuSign.eSign/Api/BulkProcessDataSendApi.cs