docusign-esign
Version:
Docusign Node.js API client.
140 lines (125 loc) • 4.82 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.BulkEnvelope = factory(root.Docusign.ApiClient, root.Docusign.ErrorDetails);
}
}(this, function(ApiClient, ErrorDetails) {
'use strict';
/**
* The BulkEnvelope model module.
* @module model/BulkEnvelope
*/
/**
* Constructs a new <code>BulkEnvelope</code>.
* @alias module:model/BulkEnvelope
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>BulkEnvelope</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/BulkEnvelope} obj Optional instance to populate.
* @return {module:model/BulkEnvelope} The populated <code>BulkEnvelope</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('bulkRecipientRow')) {
obj['bulkRecipientRow'] = ApiClient.convertToType(data['bulkRecipientRow'], 'String');
}
if (data.hasOwnProperty('bulkStatus')) {
obj['bulkStatus'] = ApiClient.convertToType(data['bulkStatus'], 'String');
}
if (data.hasOwnProperty('email')) {
obj['email'] = ApiClient.convertToType(data['email'], 'String');
}
if (data.hasOwnProperty('envelopeId')) {
obj['envelopeId'] = ApiClient.convertToType(data['envelopeId'], 'String');
}
if (data.hasOwnProperty('envelopeUri')) {
obj['envelopeUri'] = ApiClient.convertToType(data['envelopeUri'], 'String');
}
if (data.hasOwnProperty('errorDetails')) {
obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
}
if (data.hasOwnProperty('name')) {
obj['name'] = ApiClient.convertToType(data['name'], 'String');
}
if (data.hasOwnProperty('submittedDateTime')) {
obj['submittedDateTime'] = ApiClient.convertToType(data['submittedDateTime'], 'String');
}
if (data.hasOwnProperty('transactionId')) {
obj['transactionId'] = ApiClient.convertToType(data['transactionId'], 'String');
}
}
return obj;
}
/**
* Reserved: TBD
* @member {String} bulkRecipientRow
*/
exports.prototype['bulkRecipientRow'] = undefined;
/**
* Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed
* @member {String} bulkStatus
*/
exports.prototype['bulkStatus'] = undefined;
/**
*
* @member {String} email
*/
exports.prototype['email'] = undefined;
/**
* The envelope ID of the envelope status that failed to post.
* @member {String} envelopeId
*/
exports.prototype['envelopeId'] = undefined;
/**
* Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
* @member {String} envelopeUri
*/
exports.prototype['envelopeUri'] = undefined;
/**
* Array or errors.
* @member {module:model/ErrorDetails} errorDetails
*/
exports.prototype['errorDetails'] = undefined;
/**
*
* @member {String} name
*/
exports.prototype['name'] = undefined;
/**
*
* @member {String} submittedDateTime
*/
exports.prototype['submittedDateTime'] = 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;
}));