SignatureApi
in package
SignatureApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- completeSignHash() : CompleteSignHashResponse
- Operation completeSignHash
- completeSignHashWithHttpInfo() : array<string|int, mixed>
- Operation completeSignHashWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getUserInfo() : UserInfoResponse
- Operation getUserInfo
- getUserInfoWithHttpInfo() : array<string|int, mixed>
- Operation getUserInfoWithHttpInfo
- healthCheck() : mixed
- Operation healthCheck
- healthCheckWithHttpInfo() : array<string|int, mixed>
- Operation healthCheckWithHttpInfo
- setApiClient() : self
- Set the API client
- signHashSessionInfo() : SignHashSessionInfoResponse
- Operation signHashSessionInfo
- signHashSessionInfoWithHttpInfo() : array<string|int, mixed>
- Operation signHashSessionInfoWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
- updateTransaction() : UpdateTransactionResponse
- Operation updateTransaction
- updateTransactionWithHttpInfo() : array<string|int, mixed>
- Operation updateTransactionWithHttpInfo
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 —completeSignHash()
Operation completeSignHash
public
completeSignHash([CompleteSignRequest $complete_sign_request = null ]) : CompleteSignHashResponse
Complete Sign Hash
Parameters
- $complete_sign_request : CompleteSignRequest = null
-
(optional)
Tags
Return values
CompleteSignHashResponse —completeSignHashWithHttpInfo()
Operation completeSignHashWithHttpInfo
public
completeSignHashWithHttpInfo([CompleteSignRequest $complete_sign_request = null ]) : array<string|int, mixed>
Complete Sign Hash
Parameters
- $complete_sign_request : CompleteSignRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CompleteSignHashResponse, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getUserInfo()
Operation getUserInfo
public
getUserInfo() : UserInfoResponse
Get User Info To Sign Document
Tags
Return values
UserInfoResponse —getUserInfoWithHttpInfo()
Operation getUserInfoWithHttpInfo
public
getUserInfoWithHttpInfo() : array<string|int, mixed>
Get User Info To Sign Document
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserInfoResponse, HTTP status code, HTTP response headers (array of strings)
healthCheck()
Operation healthCheck
public
healthCheck([TspHealthCheckRequest $tsp_health_check_request = null ]) : mixed
Report status from the TSP to DocuSign
Parameters
- $tsp_health_check_request : TspHealthCheckRequest = null
-
(optional)
Tags
Return values
mixed —healthCheckWithHttpInfo()
Operation healthCheckWithHttpInfo
public
healthCheckWithHttpInfo([TspHealthCheckRequest $tsp_health_check_request = null ]) : array<string|int, mixed>
Report status from the TSP to DocuSign
Parameters
- $tsp_health_check_request : TspHealthCheckRequest = null
-
(optional)
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 —signHashSessionInfo()
Operation signHashSessionInfo
public
signHashSessionInfo([SignSessionInfoRequest $sign_session_info_request = null ]) : SignHashSessionInfoResponse
Get Signature Session Info To Sign Document Hash
Parameters
- $sign_session_info_request : SignSessionInfoRequest = null
-
(optional)
Tags
Return values
SignHashSessionInfoResponse —signHashSessionInfoWithHttpInfo()
Operation signHashSessionInfoWithHttpInfo
public
signHashSessionInfoWithHttpInfo([SignSessionInfoRequest $sign_session_info_request = null ]) : array<string|int, mixed>
Get Signature Session Info To Sign Document Hash
Parameters
- $sign_session_info_request : SignSessionInfoRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SignHashSessionInfoResponse, 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
- $baseName : string
- $paramName : string
Return values
string —updateTransaction()
Operation updateTransaction
public
updateTransaction([UpdateTransactionRequest $update_transaction_request = null ]) : UpdateTransactionResponse
Report an error from the tsp to docusign
Parameters
- $update_transaction_request : UpdateTransactionRequest = null
-
(optional)
Tags
Return values
UpdateTransactionResponse —updateTransactionWithHttpInfo()
Operation updateTransactionWithHttpInfo
public
updateTransactionWithHttpInfo([UpdateTransactionRequest $update_transaction_request = null ]) : array<string|int, mixed>
Report an error from the tsp to docusign
Parameters
- $update_transaction_request : UpdateTransactionRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UpdateTransactionResponse, HTTP status code, HTTP response headers (array of strings)