module:api/SignatureApi

module:api/SignatureApi

new module:api/SignatureApi(apiClient)

Source:

Constructs a new SignatureApi.

Parameters:
Name Type Description
apiClient module:ApiClient

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

Methods

completeSignHash(optsOrCallback, callback)

Source:

Complete Sign Hash

Parameters:
Name Type Description
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
completeSignRequest module:model/CompleteSignRequest
callback module:api/SignatureApi~completeSignHashCallback

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

getUserInfo(callback)

Source:

Get User Info To Sign Document

Parameters:
Name Type Description
callback module:api/SignatureApi~getUserInfoCallback

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

healthCheck(optsOrCallback, callback)

Source:

Report status from the TSP to DocuSign

Parameters:
Name Type Description
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
tspHealthCheckRequest module:model/TspHealthCheckRequest
callback module:api/SignatureApi~healthCheckCallback

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

signHashSessionInfo(optsOrCallback, callback)

Source:

Get Signature Session Info To Sign Document Hash

Parameters:
Name Type Description
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
signSessionInfoRequest module:model/SignSessionInfoRequest
callback module:api/SignatureApi~signHashSessionInfoCallback

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

updateTransaction(optsOrCallback, callback)

Source:

Report an error from the tsp to docusign

Parameters:
Name Type Description
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
updateTransactionRequest module:model/UpdateTransactionRequest
callback module:api/SignatureApi~updateTransactionCallback

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

Type Definitions

completeSignHashCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

getUserInfoCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

healthCheckCallback(error, data, If)

Source:

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

signHashSessionInfoCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.

updateTransactionCallback(error, data, If)

Source:

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

Parameters:
Name Type Description
error String

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

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.