docusign-esign
Version:
Docusign Node.js API client.
100 lines (85 loc) • 3.69 kB
JavaScript
/**
* Docusign eSignature REST API
* The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
*
* OpenAPI spec version: v2.1
* Contact: devcenter@docusign.com
*
* NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
*
*/
(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['ApiClient', 'model/ErrorDetails'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./ErrorDetails'));
} else {
// Browser globals (root is window)
if (!root.Docusign) {
root.Docusign = {};
}
root.Docusign.EnvelopeTransactionStatus = factory(root.Docusign.ApiClient, root.Docusign.ErrorDetails);
}
}(this, function(ApiClient, ErrorDetails) {
'use strict';
/**
* The EnvelopeTransactionStatus model module.
* @module model/EnvelopeTransactionStatus
*/
/**
* Constructs a new <code>EnvelopeTransactionStatus</code>.
* @alias module:model/EnvelopeTransactionStatus
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>EnvelopeTransactionStatus</code> from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
* @param {module:model/EnvelopeTransactionStatus} obj Optional instance to populate.
* @return {module:model/EnvelopeTransactionStatus} The populated <code>EnvelopeTransactionStatus</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('envelopeId')) {
obj['envelopeId'] = ApiClient.convertToType(data['envelopeId'], 'String');
}
if (data.hasOwnProperty('errorDetails')) {
obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
}
if (data.hasOwnProperty('status')) {
obj['status'] = ApiClient.convertToType(data['status'], 'String');
}
if (data.hasOwnProperty('transactionId')) {
obj['transactionId'] = ApiClient.convertToType(data['transactionId'], 'String');
}
}
return obj;
}
/**
* The envelope ID of the envelope status that failed to post.
* @member {String} envelopeId
*/
exports.prototype['envelopeId'] = undefined;
/**
* Array or errors.
* @member {module:model/ErrorDetails} errorDetails
*/
exports.prototype['errorDetails'] = undefined;
/**
* Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
* @member {String} status
*/
exports.prototype['status'] = undefined;
/**
* Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
* @member {String} transactionId
*/
exports.prototype['transactionId'] = undefined;
return exports;
}));