Documentation

BulkProcessDataApi
in package

BulkProcessDataApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$apiClient  : ApiClient
API Client
__construct()  : void
Constructor
createBulkProcessRequest()  : mixed
Operation createBulkProcessRequest
createBulkProcessRequestToQueue()  : BulkProcessResponse
Operation createBulkProcessRequestToQueue
createBulkProcessRequestToQueueWithHttpInfo()  : array<string|int, mixed>
Operation createBulkProcessRequestToQueueWithHttpInfo
createBulkProcessRequestWithHttpInfo()  : array<string|int, mixed>
Operation createBulkProcessRequestWithHttpInfo
deleteBulkProcessList()  : BulkProcessResult
Operation deleteBulkProcessList
deleteBulkProcessLists()  : BulkProcessResult
Operation deleteBulkProcessLists
deleteBulkProcessListsWithHttpInfo()  : array<string|int, mixed>
Operation deleteBulkProcessListsWithHttpInfo
deleteBulkProcessListWithHttpInfo()  : array<string|int, mixed>
Operation deleteBulkProcessListWithHttpInfo
getApiClient()  : ApiClient
Get API client
getBulkProcessList()  : mixed
Operation getBulkProcessList
getBulkProcessLists()  : BulkProcessingListSummaries
Operation getBulkProcessLists
getBulkProcessListsWithHttpInfo()  : array<string|int, mixed>
Operation getBulkProcessListsWithHttpInfo
getBulkProcessListWithHttpInfo()  : array<string|int, mixed>
Operation getBulkProcessListWithHttpInfo
setApiClient()  : self
Set the API client
updateBulkProcessList()  : mixed
Operation updateBulkProcessList
updateBulkProcessListWithHttpInfo()  : array<string|int, mixed>
Operation updateBulkProcessListWithHttpInfo
updateResourcePath()  : string
Update $resourcePath with $

Properties

Methods

__construct()

Constructor

public __construct([ApiClient|null $apiClient = null ]) : void
Parameters
$apiClient : ApiClient|null = null

The api client to use

Return values
void

createBulkProcessRequest()

Operation createBulkProcessRequest

public createBulkProcessRequest(string|null $account_id, string|null $process_action) : mixed

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

Parameters
$account_id : string|null

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

$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

createBulkProcessRequestToQueue()

Operation createBulkProcessRequestToQueue

public createBulkProcessRequestToQueue(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action[, BulkProcessRequest $bulk_process_request = null ]) : BulkProcessResponse

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

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
$bulk_process_request : BulkProcessRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
BulkProcessResponse

createBulkProcessRequestToQueueWithHttpInfo()

Operation createBulkProcessRequestToQueueWithHttpInfo

public createBulkProcessRequestToQueueWithHttpInfo(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action[, BulkProcessRequest $bulk_process_request = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
$bulk_process_request : BulkProcessRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\BulkProcessResponse, HTTP status code, HTTP response headers (array of strings)

createBulkProcessRequestWithHttpInfo()

Operation createBulkProcessRequestWithHttpInfo

public createBulkProcessRequestWithHttpInfo(string|null $account_id, string|null $process_action) : array<string|int, mixed>

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

Parameters
$account_id : string|null

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

$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

deleteBulkProcessList()

Operation deleteBulkProcessList

public deleteBulkProcessList(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action) : BulkProcessResult

Deletes a specific bulk process list

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
BulkProcessResult

deleteBulkProcessLists()

Operation deleteBulkProcessLists

public deleteBulkProcessLists(string|null $account_id, string|null $process_action[, BulkProcessingLists $bulk_processing_lists = null ]) : BulkProcessResult

Deletes a specific bulk process list

Parameters
$account_id : string|null

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

$process_action : string|null
$bulk_processing_lists : BulkProcessingLists = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
BulkProcessResult

deleteBulkProcessListsWithHttpInfo()

Operation deleteBulkProcessListsWithHttpInfo

public deleteBulkProcessListsWithHttpInfo(string|null $account_id, string|null $process_action[, BulkProcessingLists $bulk_processing_lists = null ]) : array<string|int, mixed>

Deletes a specific bulk process list

Parameters
$account_id : string|null

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

$process_action : string|null
$bulk_processing_lists : BulkProcessingLists = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\BulkProcessResult, HTTP status code, HTTP response headers (array of strings)

deleteBulkProcessListWithHttpInfo()

Operation deleteBulkProcessListWithHttpInfo

public deleteBulkProcessListWithHttpInfo(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action) : array<string|int, mixed>

Deletes a specific bulk process list

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\BulkProcessResult, HTTP status code, HTTP response headers (array of strings)

getBulkProcessList()

Operation getBulkProcessList

public getBulkProcessList(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action) : mixed

Gets a specific bulk process list

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

getBulkProcessLists()

Operation getBulkProcessLists

public getBulkProcessLists(string|null $account_id, string|null $process_action) : BulkProcessingListSummaries

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

Parameters
$account_id : string|null

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

$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
BulkProcessingListSummaries

getBulkProcessListsWithHttpInfo()

Operation getBulkProcessListsWithHttpInfo

public getBulkProcessListsWithHttpInfo(string|null $account_id, string|null $process_action) : array<string|int, mixed>

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

Parameters
$account_id : string|null

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

$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\BulkProcessingListSummaries, HTTP status code, HTTP response headers (array of strings)

getBulkProcessListWithHttpInfo()

Operation getBulkProcessListWithHttpInfo

public getBulkProcessListWithHttpInfo(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action) : array<string|int, mixed>

Gets a specific bulk process list

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

updateBulkProcessList()

Operation updateBulkProcessList

public updateBulkProcessList(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action) : mixed

Updates a specific bulk process list

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

updateBulkProcessListWithHttpInfo()

Operation updateBulkProcessListWithHttpInfo

public updateBulkProcessListWithHttpInfo(string|null $account_id, string|null $bulk_process_list_id, string|null $process_action) : array<string|int, mixed>

Updates a specific bulk process list

Parameters
$account_id : string|null

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

$bulk_process_list_id : string|null
$process_action : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

updateResourcePath()

Update $resourcePath with $

public updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
$resourcePath : string

the resource path to use

$baseName : string

the base name param

$paramName : string

the parameter name

Return values
string

Search results