module:api/BulkProcessDataSendApi

new module:api/BulkProcessDataSendApi(apiClient)

Source:

api/BulkProcessDataSendApi.js, line 41

Constructs a new BulkProcessDataSendApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

createBulkProcessRequestToQueue(accountId, processAction, bulkProcessListId, optsOrCallback, callback)

Source:

api/BulkProcessDataSendApi.js, line 73

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

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

processAction String

bulkProcessListId String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`bulkProcessRequest`	module:model/BulkProcessRequest

callback

module:api/BulkProcessDataSendApi~createBulkProcessRequestToQueueCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BulkProcessResponse

deleteBulkProcessList(accountId, processAction, bulkProcessListId, callback)

Source:

api/BulkProcessDataSendApi.js, line 146

Deletes a specific bulk process list

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`processAction`	String
`bulkProcessListId`	String
`callback`	module:api/BulkProcessDataSendApi~deleteBulkProcessListCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/BulkProcessResult`

getBulkProcessList(accountId, processAction, bulkProcessListId, callback)

Source:

api/BulkProcessDataSendApi.js, line 211

Gets a specific bulk process list

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`processAction`	String
`bulkProcessListId`	String
`callback`	module:api/BulkProcessDataSendApi~getBulkProcessListCallback	The callback function, accepting three arguments: error, data, response

updateBulkProcessList(accountId, processAction, bulkProcessListId, callback)

Source:

api/BulkProcessDataSendApi.js, line 276

Updates a specific bulk process list

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`processAction`	String
`bulkProcessListId`	String
`callback`	module:api/BulkProcessDataSendApi~updateBulkProcessListCallback	The callback function, accepting three arguments: error, data, response

Type Definitions

createBulkProcessRequestToQueueCallback(error, data, If)

Source:

api/BulkProcessDataSendApi.js, line 54

(Optional) Callback function to receive the result of the createBulkProcessRequestToQueue operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/BulkProcessResponse	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteBulkProcessListCallback(error, data, If)

Source:

api/BulkProcessDataSendApi.js, line 129

(Optional) Callback function to receive the result of the deleteBulkProcessList operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/BulkProcessResult	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBulkProcessListCallback(error, data, If)

Source:

api/BulkProcessDataSendApi.js, line 195

(Optional) Callback function to receive the result of the getBulkProcessList operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateBulkProcessListCallback(error, data, If)

Source:

api/BulkProcessDataSendApi.js, line 260

(Optional) Callback function to receive the result of the updateBulkProcessList operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.