BulkEnvelopesApi
in package
BulkEnvelopesApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- createBulkSendList() : BulkSendingList
- Operation createBulkSendList
- createBulkSendListWithHttpInfo() : array<string|int, mixed>
- Operation createBulkSendListWithHttpInfo
- createBulkSendRequest() : BulkSendResponse
- Operation createBulkSendRequest
- createBulkSendRequestWithHttpInfo() : array<string|int, mixed>
- Operation createBulkSendRequestWithHttpInfo
- createBulkSendTestRequest() : BulkSendTestResponse
- Operation createBulkSendTestRequest
- createBulkSendTestRequestWithHttpInfo() : array<string|int, mixed>
- Operation createBulkSendTestRequestWithHttpInfo
- deleteBulkSendList() : BulkSendingListSummaries
- Operation deleteBulkSendList
- deleteBulkSendListWithHttpInfo() : array<string|int, mixed>
- Operation deleteBulkSendListWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getBulkSendBatchEnvelopes() : EnvelopesInformation
- Operation getBulkSendBatchEnvelopes
- getBulkSendBatchEnvelopesWithHttpInfo() : array<string|int, mixed>
- Operation getBulkSendBatchEnvelopesWithHttpInfo
- getBulkSendBatches() : BulkSendBatchSummaries
- Operation getBulkSendBatches
- getBulkSendBatchesWithHttpInfo() : array<string|int, mixed>
- Operation getBulkSendBatchesWithHttpInfo
- getBulkSendBatchStatus() : BulkSendBatchStatus
- Operation getBulkSendBatchStatus
- getBulkSendBatchStatusWithHttpInfo() : array<string|int, mixed>
- Operation getBulkSendBatchStatusWithHttpInfo
- getBulkSendList() : BulkSendingList
- Operation getBulkSendList
- getBulkSendLists() : BulkSendingListSummaries
- Operation getBulkSendLists
- getBulkSendListsWithHttpInfo() : array<string|int, mixed>
- Operation getBulkSendListsWithHttpInfo
- getBulkSendListWithHttpInfo() : array<string|int, mixed>
- Operation getBulkSendListWithHttpInfo
- setApiClient() : self
- Set the API client
- updateBulkSendBatchAction() : BulkSendBatchStatus
- Operation updateBulkSendBatchAction
- updateBulkSendBatchActionWithHttpInfo() : array<string|int, mixed>
- Operation updateBulkSendBatchActionWithHttpInfo
- updateBulkSendBatchStatus() : BulkSendBatchStatus
- Operation updateBulkSendBatchStatus
- updateBulkSendBatchStatusWithHttpInfo() : array<string|int, mixed>
- Operation updateBulkSendBatchStatusWithHttpInfo
- updateBulkSendList() : BulkSendingList
- Operation updateBulkSendList
- updateBulkSendListWithHttpInfo() : array<string|int, mixed>
- Operation updateBulkSendListWithHttpInfo
- 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 —createBulkSendList()
Operation createBulkSendList
public
createBulkSendList(string|null $account_id[, BulkSendingList $bulk_sending_list = null ]) : BulkSendingList
Creates a new bulk send list
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_sending_list : BulkSendingList = null
-
(optional)
Tags
Return values
BulkSendingList —createBulkSendListWithHttpInfo()
Operation createBulkSendListWithHttpInfo
public
createBulkSendListWithHttpInfo(string|null $account_id[, BulkSendingList $bulk_sending_list = null ]) : array<string|int, mixed>
Creates a new bulk send list
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_sending_list : BulkSendingList = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendingList, HTTP status code, HTTP response headers (array of strings)
createBulkSendRequest()
Operation createBulkSendRequest
public
createBulkSendRequest(string|null $account_id, string|null $bulk_send_list_id[, BulkSendRequest $bulk_send_request = null ]) : BulkSendResponse
Uses the specified bulk send list to send the envelope specified in the payload
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
- $bulk_send_request : BulkSendRequest = null
-
(optional)
Tags
Return values
BulkSendResponse —createBulkSendRequestWithHttpInfo()
Operation createBulkSendRequestWithHttpInfo
public
createBulkSendRequestWithHttpInfo(string|null $account_id, string|null $bulk_send_list_id[, BulkSendRequest $bulk_send_request = null ]) : array<string|int, mixed>
Uses the specified bulk send list to send the envelope specified in the payload
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
- $bulk_send_request : BulkSendRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendResponse, HTTP status code, HTTP response headers (array of strings)
createBulkSendTestRequest()
Operation createBulkSendTestRequest
public
createBulkSendTestRequest(string|null $account_id, string|null $bulk_send_list_id[, BulkSendRequest $bulk_send_request = null ]) : BulkSendTestResponse
Tests whether the specified bulk sending list can be used to send an envelope
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
- $bulk_send_request : BulkSendRequest = null
-
(optional)
Tags
Return values
BulkSendTestResponse —createBulkSendTestRequestWithHttpInfo()
Operation createBulkSendTestRequestWithHttpInfo
public
createBulkSendTestRequestWithHttpInfo(string|null $account_id, string|null $bulk_send_list_id[, BulkSendRequest $bulk_send_request = null ]) : array<string|int, mixed>
Tests whether the specified bulk sending list can be used to send an envelope
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
- $bulk_send_request : BulkSendRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendTestResponse, HTTP status code, HTTP response headers (array of strings)
deleteBulkSendList()
Operation deleteBulkSendList
public
deleteBulkSendList(string|null $account_id, string|null $bulk_send_list_id) : BulkSendingListSummaries
Deletes an existing bulk send list
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
Tags
Return values
BulkSendingListSummaries —deleteBulkSendListWithHttpInfo()
Operation deleteBulkSendListWithHttpInfo
public
deleteBulkSendListWithHttpInfo(string|null $account_id, string|null $bulk_send_list_id) : array<string|int, mixed>
Deletes an existing bulk send list
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendingListSummaries, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getBulkSendBatchEnvelopes()
Operation getBulkSendBatchEnvelopes
public
getBulkSendBatchEnvelopes(string|null $account_id, string|null $bulk_send_batch_id[, GetBulkSendBatchEnvelopesOptions $options = null ]) : EnvelopesInformation
Gets envelopes from a specific bulk send batch
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_batch_id : string|null
- $options : GetBulkSendBatchEnvelopesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
EnvelopesInformation —getBulkSendBatchEnvelopesWithHttpInfo()
Operation getBulkSendBatchEnvelopesWithHttpInfo
public
getBulkSendBatchEnvelopesWithHttpInfo(string|null $account_id, string|null $bulk_send_batch_id[, GetBulkSendBatchEnvelopesOptions $options = null ]) : array<string|int, mixed>
Gets envelopes from a specific bulk send batch
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_batch_id : string|null
- $options : GetBulkSendBatchEnvelopesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\EnvelopesInformation, HTTP status code, HTTP response headers (array of strings)
getBulkSendBatches()
Operation getBulkSendBatches
public
getBulkSendBatches(string|null $account_id[, GetBulkSendBatchesOptions $options = null ]) : BulkSendBatchSummaries
Returns a list of bulk send batch satuses initiated by account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetBulkSendBatchesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
BulkSendBatchSummaries —getBulkSendBatchesWithHttpInfo()
Operation getBulkSendBatchesWithHttpInfo
public
getBulkSendBatchesWithHttpInfo(string|null $account_id[, GetBulkSendBatchesOptions $options = null ]) : array<string|int, mixed>
Returns a list of bulk send batch satuses initiated by account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : GetBulkSendBatchesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendBatchSummaries, HTTP status code, HTTP response headers (array of strings)
getBulkSendBatchStatus()
Operation getBulkSendBatchStatus
public
getBulkSendBatchStatus(string|null $account_id, string|null $bulk_send_batch_id) : BulkSendBatchStatus
Gets a specific bulk send batch status
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_batch_id : string|null
Tags
Return values
BulkSendBatchStatus —getBulkSendBatchStatusWithHttpInfo()
Operation getBulkSendBatchStatusWithHttpInfo
public
getBulkSendBatchStatusWithHttpInfo(string|null $account_id, string|null $bulk_send_batch_id) : array<string|int, mixed>
Gets a specific bulk send batch status
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_batch_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendBatchStatus, HTTP status code, HTTP response headers (array of strings)
getBulkSendList()
Operation getBulkSendList
public
getBulkSendList(string|null $account_id, string|null $bulk_send_list_id) : BulkSendingList
Gets a specific bulk send list
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
Tags
Return values
BulkSendingList —getBulkSendLists()
Operation getBulkSendLists
public
getBulkSendLists(string|null $account_id) : BulkSendingListSummaries
Lists top-level details for all bulk send lists visible to the current user
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
BulkSendingListSummaries —getBulkSendListsWithHttpInfo()
Operation getBulkSendListsWithHttpInfo
public
getBulkSendListsWithHttpInfo(string|null $account_id) : array<string|int, mixed>
Lists top-level details for all bulk send lists visible to the current user
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendingListSummaries, HTTP status code, HTTP response headers (array of strings)
getBulkSendListWithHttpInfo()
Operation getBulkSendListWithHttpInfo
public
getBulkSendListWithHttpInfo(string|null $account_id, string|null $bulk_send_list_id) : array<string|int, mixed>
Gets a specific bulk send list
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendingList, 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 —updateBulkSendBatchAction()
Operation updateBulkSendBatchAction
public
updateBulkSendBatchAction(string|null $account_id, string|null $bulk_action, string|null $bulk_send_batch_id[, BulkSendBatchActionRequest $bulk_send_batch_action_request = null ]) : BulkSendBatchStatus
Initiate a specific bulk send batch action
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_action : string|null
- $bulk_send_batch_id : string|null
- $bulk_send_batch_action_request : BulkSendBatchActionRequest = null
-
(optional)
Tags
Return values
BulkSendBatchStatus —updateBulkSendBatchActionWithHttpInfo()
Operation updateBulkSendBatchActionWithHttpInfo
public
updateBulkSendBatchActionWithHttpInfo(string|null $account_id, string|null $bulk_action, string|null $bulk_send_batch_id[, BulkSendBatchActionRequest $bulk_send_batch_action_request = null ]) : array<string|int, mixed>
Initiate a specific bulk send batch action
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_action : string|null
- $bulk_send_batch_id : string|null
- $bulk_send_batch_action_request : BulkSendBatchActionRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendBatchStatus, HTTP status code, HTTP response headers (array of strings)
updateBulkSendBatchStatus()
Operation updateBulkSendBatchStatus
public
updateBulkSendBatchStatus(string|null $account_id, string|null $bulk_send_batch_id[, BulkSendBatchRequest $bulk_send_batch_request = null ]) : BulkSendBatchStatus
Put/Update a specific bulk send batch status
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_batch_id : string|null
- $bulk_send_batch_request : BulkSendBatchRequest = null
-
(optional)
Tags
Return values
BulkSendBatchStatus —updateBulkSendBatchStatusWithHttpInfo()
Operation updateBulkSendBatchStatusWithHttpInfo
public
updateBulkSendBatchStatusWithHttpInfo(string|null $account_id, string|null $bulk_send_batch_id[, BulkSendBatchRequest $bulk_send_batch_request = null ]) : array<string|int, mixed>
Put/Update a specific bulk send batch status
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_batch_id : string|null
- $bulk_send_batch_request : BulkSendBatchRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendBatchStatus, HTTP status code, HTTP response headers (array of strings)
updateBulkSendList()
Operation updateBulkSendList
public
updateBulkSendList(string|null $account_id, string|null $bulk_send_list_id[, BulkSendingList $bulk_sending_list = null ]) : BulkSendingList
Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
- $bulk_sending_list : BulkSendingList = null
-
(optional)
Tags
Return values
BulkSendingList —updateBulkSendListWithHttpInfo()
Operation updateBulkSendListWithHttpInfo
public
updateBulkSendListWithHttpInfo(string|null $account_id, string|null $bulk_send_list_id[, BulkSendingList $bulk_sending_list = null ]) : array<string|int, mixed>
Updates an existing bulk send list. If send_envelope query string value is provided, will accept an empty payload and try to send the specified envelope
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $bulk_send_list_id : string|null
- $bulk_sending_list : BulkSendingList = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\BulkSendingList, 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