new module:api/EnvelopeApplianceApi(apiClient)
- Source:
Constructs a new EnvelopeApplianceApi.
Parameters:
| Name | Type | Description |
|---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, |
Methods
getApplianceInfo(accountId, envelopeId, callback)
- Source:
Returns envelope and recipient information for Display Appliance
Parameters:
| Name | Type | Description |
|---|---|---|
accountId |
String | The external account number (int) or account ID Guid. |
envelopeId |
String | The envelopeId Guid of the envelope being accessed. |
callback |
module:api/EnvelopeApplianceApi~getApplianceInfoCallback | The callback function, accepting three arguments: error, data, response |
Type Definitions
getApplianceInfoCallback(error, data, If)
- Source:
(Optional)Callback function to receive the result of the getApplianceInfo operation. If none specified a Promise will be returned.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
module:model/DisplayApplianceInfo | 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. |