BulkProcessDataSendApi
in package
BulkProcessDataSendApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- createBulkProcessRequestToQueue() : BulkProcessResponse
- Operation createBulkProcessRequestToQueue
- createBulkProcessRequestToQueueWithHttpInfo() : array<string|int, mixed>
- Operation createBulkProcessRequestToQueueWithHttpInfo
- deleteBulkProcessList() : BulkProcessResult
- Operation deleteBulkProcessList
- deleteBulkProcessListWithHttpInfo() : array<string|int, mixed>
- Operation deleteBulkProcessListWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getBulkProcessList() : mixed
- Operation getBulkProcessList
- 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
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —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
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
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkProcessResponse, 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
Return values
BulkProcessResult —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
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkProcessResult, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
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
Return values
mixed —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
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —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
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
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