DocuSign CSharp Docs
Public Member Functions | List of all members
DocuSign.eSign.Api.IBulkProcessDataApi Interface Reference

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

Inheritance diagram for DocuSign.eSign.Api.IBulkProcessDataApi:
DocuSign.eSign.Client.IApiAccessor DocuSign.eSign.Api.BulkProcessDataApi

Public Member Functions

void CreateBulkProcessRequest (string accountId, string processAction)
 Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
 
ApiResponse< Object > CreateBulkProcessRequestWithHttpInfo (string accountId, string processAction)
 Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
 
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< BulkProcessResponseCreateBulkProcessRequestToQueueWithHttpInfo (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< BulkProcessResultDeleteBulkProcessListWithHttpInfo (string accountId, string processAction, string bulkProcessListId)
 Deletes a specific bulk process list More...
 
BulkProcessResult DeleteBulkProcessLists (string accountId, string processAction, BulkProcessingLists bulkProcessingLists=null)
 Deletes a specific bulk process list More...
 
ApiResponse< BulkProcessResultDeleteBulkProcessListsWithHttpInfo (string accountId, string processAction, BulkProcessingLists bulkProcessingLists=null)
 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...
 
BulkProcessingListSummaries GetBulkProcessLists (string accountId, string processAction)
 Lists top-level details for all bulk process lists visible to the current user More...
 
ApiResponse< BulkProcessingListSummariesGetBulkProcessListsWithHttpInfo (string accountId, string processAction)
 Lists top-level details for all bulk process lists visible to the current user 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 CreateBulkProcessRequestAsync (string accountId, string processAction)
 Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
 
System.Threading.Tasks.Task< ApiResponse< Object > > CreateBulkProcessRequestAsyncWithHttpInfo (string accountId, string processAction)
 Uses the specified bulk envelopes list to update the envelopes specified in the payload More...
 
System.Threading.Tasks.Task< BulkProcessResponseCreateBulkProcessRequestToQueueAsync (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< BulkProcessResultDeleteBulkProcessListAsync (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< BulkProcessResultDeleteBulkProcessListsAsync (string accountId, string processAction, BulkProcessingLists bulkProcessingLists=null)
 Deletes a specific bulk process list More...
 
System.Threading.Tasks.Task< ApiResponse< BulkProcessResult > > DeleteBulkProcessListsAsyncWithHttpInfo (string accountId, string processAction, BulkProcessingLists bulkProcessingLists=null)
 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< BulkProcessingListSummariesGetBulkProcessListsAsync (string accountId, string processAction)
 Lists top-level details for all bulk process lists visible to the current user More...
 
System.Threading.Tasks.Task< ApiResponse< BulkProcessingListSummaries > > GetBulkProcessListsAsyncWithHttpInfo (string accountId, string processAction)
 Lists top-level details for all bulk process lists visible to the current user 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

◆ CreateBulkProcessRequest()

void DocuSign.eSign.Api.IBulkProcessDataApi.CreateBulkProcessRequest ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ CreateBulkProcessRequestAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IBulkProcessDataApi.CreateBulkProcessRequestAsync ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns
Task of void

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ CreateBulkProcessRequestAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IBulkProcessDataApi.CreateBulkProcessRequestAsyncWithHttpInfo ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns
Task of ApiResponse

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ CreateBulkProcessRequestToQueue()

BulkProcessResponse DocuSign.eSign.Api.IBulkProcessDataApi.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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest(optional)
Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ CreateBulkProcessRequestToQueueAsync()

System.Threading.Tasks.Task<BulkProcessResponse> DocuSign.eSign.Api.IBulkProcessDataApi.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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest(optional)
Returns
Task of BulkProcessResponse

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ CreateBulkProcessRequestToQueueAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BulkProcessResponse> > DocuSign.eSign.Api.IBulkProcessDataApi.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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest(optional)
Returns
Task of ApiResponse (BulkProcessResponse)

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ CreateBulkProcessRequestToQueueWithHttpInfo()

ApiResponse<BulkProcessResponse> DocuSign.eSign.Api.IBulkProcessDataApi.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.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
bulkProcessRequest(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ CreateBulkProcessRequestWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IBulkProcessDataApi.CreateBulkProcessRequestWithHttpInfo ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns
ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessList()

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

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessListAsync()

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

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
Task of BulkProcessResult

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessListAsyncWithHttpInfo()

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

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
Task of ApiResponse (BulkProcessResult)

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessLists()

BulkProcessResult DocuSign.eSign.Api.IBulkProcessDataApi.DeleteBulkProcessLists ( string  accountId,
string  processAction,
BulkProcessingLists  bulkProcessingLists = null 
)

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessingLists(optional)
Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessListsAsync()

System.Threading.Tasks.Task<BulkProcessResult> DocuSign.eSign.Api.IBulkProcessDataApi.DeleteBulkProcessListsAsync ( string  accountId,
string  processAction,
BulkProcessingLists  bulkProcessingLists = null 
)

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessingLists(optional)
Returns
Task of BulkProcessResult

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessListsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BulkProcessResult> > DocuSign.eSign.Api.IBulkProcessDataApi.DeleteBulkProcessListsAsyncWithHttpInfo ( string  accountId,
string  processAction,
BulkProcessingLists  bulkProcessingLists = null 
)

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessingLists(optional)
Returns
Task of ApiResponse (BulkProcessResult)

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessListsWithHttpInfo()

ApiResponse<BulkProcessResult> DocuSign.eSign.Api.IBulkProcessDataApi.DeleteBulkProcessListsWithHttpInfo ( string  accountId,
string  processAction,
BulkProcessingLists  bulkProcessingLists = null 
)

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessingLists(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ DeleteBulkProcessListWithHttpInfo()

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

Deletes a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessList()

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

Gets a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessListAsync()

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

Gets a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
Task of void

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessListAsyncWithHttpInfo()

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

Gets a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
Task of ApiResponse

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessLists()

BulkProcessingListSummaries DocuSign.eSign.Api.IBulkProcessDataApi.GetBulkProcessLists ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessListsAsync()

System.Threading.Tasks.Task<BulkProcessingListSummaries> DocuSign.eSign.Api.IBulkProcessDataApi.GetBulkProcessListsAsync ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns
Task of BulkProcessingListSummaries

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessListsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<BulkProcessingListSummaries> > DocuSign.eSign.Api.IBulkProcessDataApi.GetBulkProcessListsAsyncWithHttpInfo ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns
Task of ApiResponse (BulkProcessingListSummaries)

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessListsWithHttpInfo()

ApiResponse<BulkProcessingListSummaries> DocuSign.eSign.Api.IBulkProcessDataApi.GetBulkProcessListsWithHttpInfo ( string  accountId,
string  processAction 
)

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

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ GetBulkProcessListWithHttpInfo()

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

Gets a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ UpdateBulkProcessList()

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

Updates a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ UpdateBulkProcessListAsync()

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

Updates a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
Task of void

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ UpdateBulkProcessListAsyncWithHttpInfo()

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

Updates a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
Task of ApiResponse

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.

◆ UpdateBulkProcessListWithHttpInfo()

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

Updates a specific bulk process list

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
processAction
bulkProcessListId
Returns
ApiResponse of Object(void)

Implemented in DocuSign.eSign.Api.BulkProcessDataApi.


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