module:api/BulkProcessDataApi

module:api/BulkProcessDataApi

new module:api/BulkProcessDataApi(apiClient)

Source:

Constructs a new BulkProcessDataApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

createBulkProcessRequest(accountId, processAction, callback)

Source:

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
callback module:api/BulkProcessDataApi~createBulkProcessRequestCallback

The callback function, accepting three arguments: error, data, response

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

Source:

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/BulkProcessDataApi~createBulkProcessRequestToQueueCallback

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

deleteBulkProcessList(accountId, processAction, bulkProcessListId, callback)

Source:

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/BulkProcessDataApi~deleteBulkProcessListCallback

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

deleteBulkProcessLists(accountId, processAction, optsOrCallback, callback)

Source:

Deletes a specific bulk process list

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
processAction 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
bulkProcessingLists module:model/BulkProcessingLists
callback module:api/BulkProcessDataApi~deleteBulkProcessListsCallback

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

getBulkProcessList(accountId, processAction, bulkProcessListId, callback)

Source:

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/BulkProcessDataApi~getBulkProcessListCallback

The callback function, accepting three arguments: error, data, response

getBulkProcessLists(accountId, processAction, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
processAction String
callback module:api/BulkProcessDataApi~getBulkProcessListsCallback

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

updateBulkProcessList(accountId, processAction, bulkProcessListId, callback)

Source:

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/BulkProcessDataApi~updateBulkProcessListCallback

The callback function, accepting three arguments: error, data, response

Type Definitions

createBulkProcessRequestCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createBulkProcessRequest 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.

createBulkProcessRequestToQueueCallback(error, data, If)

Source:

(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:

(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.

deleteBulkProcessListsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteBulkProcessLists 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:

(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.

getBulkProcessListsCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/BulkProcessingListSummaries

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.

updateBulkProcessListCallback(error, data, If)

Source:

(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.