docusign-esign
Version:
Docusign Node.js API client.
365 lines (350 loc) • 13.6 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/DocGenFormField', 'model/DocGenSyntaxError', 'model/ErrorDetails', 'model/NameValue', 'model/Page', 'model/PropertyMetadata', 'model/SignatureType'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./DocGenFormField'), require('./DocGenSyntaxError'), require('./ErrorDetails'), require('./NameValue'), require('./Page'), require('./PropertyMetadata'), require('./SignatureType'));
} else {
// Browser globals (root is window)
if (!root.Docusign) {
root.Docusign = {};
}
root.Docusign.EnvelopeDocument = factory(root.Docusign.ApiClient, root.Docusign.DocGenFormField, root.Docusign.DocGenSyntaxError, root.Docusign.ErrorDetails, root.Docusign.NameValue, root.Docusign.Page, root.Docusign.PropertyMetadata, root.Docusign.SignatureType);
}
}(this, function(ApiClient, DocGenFormField, DocGenSyntaxError, ErrorDetails, NameValue, Page, PropertyMetadata, SignatureType) {
'use strict';
/**
* The EnvelopeDocument model module.
* @module model/EnvelopeDocument
*/
/**
* Constructs a new <code>EnvelopeDocument</code>.
* This object contains details about the envelope document.
* @alias module:model/EnvelopeDocument
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>EnvelopeDocument</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/EnvelopeDocument} obj Optional instance to populate.
* @return {module:model/EnvelopeDocument} The populated <code>EnvelopeDocument</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('addedRecipientIds')) {
obj['addedRecipientIds'] = ApiClient.convertToType(data['addedRecipientIds'], ['String']);
}
if (data.hasOwnProperty('agreementType')) {
obj['agreementType'] = ApiClient.convertToType(data['agreementType'], 'String');
}
if (data.hasOwnProperty('agreementTypeSource')) {
obj['agreementTypeSource'] = ApiClient.convertToType(data['agreementTypeSource'], 'String');
}
if (data.hasOwnProperty('attachmentTabId')) {
obj['attachmentTabId'] = ApiClient.convertToType(data['attachmentTabId'], 'String');
}
if (data.hasOwnProperty('authoritativeCopy')) {
obj['authoritativeCopy'] = ApiClient.convertToType(data['authoritativeCopy'], 'String');
}
if (data.hasOwnProperty('authoritativeCopyMetadata')) {
obj['authoritativeCopyMetadata'] = PropertyMetadata.constructFromObject(data['authoritativeCopyMetadata']);
}
if (data.hasOwnProperty('availableDocumentTypes')) {
obj['availableDocumentTypes'] = ApiClient.convertToType(data['availableDocumentTypes'], [SignatureType]);
}
if (data.hasOwnProperty('containsPdfFormFields')) {
obj['containsPdfFormFields'] = ApiClient.convertToType(data['containsPdfFormFields'], 'String');
}
if (data.hasOwnProperty('display')) {
obj['display'] = ApiClient.convertToType(data['display'], 'String');
}
if (data.hasOwnProperty('displayMetadata')) {
obj['displayMetadata'] = PropertyMetadata.constructFromObject(data['displayMetadata']);
}
if (data.hasOwnProperty('docGenDocumentStatus')) {
obj['docGenDocumentStatus'] = ApiClient.convertToType(data['docGenDocumentStatus'], 'String');
}
if (data.hasOwnProperty('docGenErrors')) {
obj['docGenErrors'] = ApiClient.convertToType(data['docGenErrors'], [DocGenSyntaxError]);
}
if (data.hasOwnProperty('docGenFormFields')) {
obj['docGenFormFields'] = ApiClient.convertToType(data['docGenFormFields'], [DocGenFormField]);
}
if (data.hasOwnProperty('documentBase64')) {
obj['documentBase64'] = ApiClient.convertToType(data['documentBase64'], 'String');
}
if (data.hasOwnProperty('documentFields')) {
obj['documentFields'] = ApiClient.convertToType(data['documentFields'], [NameValue]);
}
if (data.hasOwnProperty('documentId')) {
obj['documentId'] = ApiClient.convertToType(data['documentId'], 'String');
}
if (data.hasOwnProperty('documentIdGuid')) {
obj['documentIdGuid'] = ApiClient.convertToType(data['documentIdGuid'], 'String');
}
if (data.hasOwnProperty('documentTemplateId')) {
obj['documentTemplateId'] = ApiClient.convertToType(data['documentTemplateId'], 'String');
}
if (data.hasOwnProperty('errorDetails')) {
obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
}
if (data.hasOwnProperty('hasDigitalSignature')) {
obj['hasDigitalSignature'] = ApiClient.convertToType(data['hasDigitalSignature'], 'String');
}
if (data.hasOwnProperty('includeInDownload')) {
obj['includeInDownload'] = ApiClient.convertToType(data['includeInDownload'], 'String');
}
if (data.hasOwnProperty('includeInDownloadMetadata')) {
obj['includeInDownloadMetadata'] = PropertyMetadata.constructFromObject(data['includeInDownloadMetadata']);
}
if (data.hasOwnProperty('isAceGenDocument')) {
obj['isAceGenDocument'] = ApiClient.convertToType(data['isAceGenDocument'], 'String');
}
if (data.hasOwnProperty('isDocGenDocument')) {
obj['isDocGenDocument'] = ApiClient.convertToType(data['isDocGenDocument'], 'String');
}
if (data.hasOwnProperty('isExternallyAvailable')) {
obj['isExternallyAvailable'] = ApiClient.convertToType(data['isExternallyAvailable'], 'String');
}
if (data.hasOwnProperty('isFlattened')) {
obj['isFlattened'] = ApiClient.convertToType(data['isFlattened'], 'String');
}
if (data.hasOwnProperty('name')) {
obj['name'] = ApiClient.convertToType(data['name'], 'String');
}
if (data.hasOwnProperty('nameMetadata')) {
obj['nameMetadata'] = PropertyMetadata.constructFromObject(data['nameMetadata']);
}
if (data.hasOwnProperty('order')) {
obj['order'] = ApiClient.convertToType(data['order'], 'String');
}
if (data.hasOwnProperty('pages')) {
obj['pages'] = ApiClient.convertToType(data['pages'], [Page]);
}
if (data.hasOwnProperty('signerMustAcknowledge')) {
obj['signerMustAcknowledge'] = ApiClient.convertToType(data['signerMustAcknowledge'], 'String');
}
if (data.hasOwnProperty('signerMustAcknowledgeMetadata')) {
obj['signerMustAcknowledgeMetadata'] = PropertyMetadata.constructFromObject(data['signerMustAcknowledgeMetadata']);
}
if (data.hasOwnProperty('sizeBytes')) {
obj['sizeBytes'] = ApiClient.convertToType(data['sizeBytes'], 'String');
}
if (data.hasOwnProperty('templateLocked')) {
obj['templateLocked'] = ApiClient.convertToType(data['templateLocked'], 'String');
}
if (data.hasOwnProperty('templateRequired')) {
obj['templateRequired'] = ApiClient.convertToType(data['templateRequired'], 'String');
}
if (data.hasOwnProperty('type')) {
obj['type'] = ApiClient.convertToType(data['type'], 'String');
}
if (data.hasOwnProperty('uri')) {
obj['uri'] = ApiClient.convertToType(data['uri'], 'String');
}
}
return obj;
}
/**
*
* @member {Array.<String>} addedRecipientIds
*/
exports.prototype['addedRecipientIds'] = undefined;
/**
*
* @member {String} agreementType
*/
exports.prototype['agreementType'] = undefined;
/**
*
* @member {String} agreementTypeSource
*/
exports.prototype['agreementTypeSource'] = undefined;
/**
*
* @member {String} attachmentTabId
*/
exports.prototype['attachmentTabId'] = undefined;
/**
* Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
* @member {String} authoritativeCopy
*/
exports.prototype['authoritativeCopy'] = undefined;
/**
* Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.
* @member {module:model/PropertyMetadata} authoritativeCopyMetadata
*/
exports.prototype['authoritativeCopyMetadata'] = undefined;
/**
*
* @member {Array.<module:model/SignatureType>} availableDocumentTypes
*/
exports.prototype['availableDocumentTypes'] = undefined;
/**
*
* @member {String} containsPdfFormFields
*/
exports.prototype['containsPdfFormFields'] = undefined;
/**
*
* @member {String} display
*/
exports.prototype['display'] = undefined;
/**
* Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.
* @member {module:model/PropertyMetadata} displayMetadata
*/
exports.prototype['displayMetadata'] = undefined;
/**
*
* @member {String} docGenDocumentStatus
*/
exports.prototype['docGenDocumentStatus'] = undefined;
/**
*
* @member {Array.<module:model/DocGenSyntaxError>} docGenErrors
*/
exports.prototype['docGenErrors'] = undefined;
/**
*
* @member {Array.<module:model/DocGenFormField>} docGenFormFields
*/
exports.prototype['docGenFormFields'] = undefined;
/**
*
* @member {String} documentBase64
*/
exports.prototype['documentBase64'] = undefined;
/**
*
* @member {Array.<module:model/NameValue>} documentFields
*/
exports.prototype['documentFields'] = undefined;
/**
* Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
* @member {String} documentId
*/
exports.prototype['documentId'] = undefined;
/**
*
* @member {String} documentIdGuid
*/
exports.prototype['documentIdGuid'] = undefined;
/**
*
* @member {String} documentTemplateId
*/
exports.prototype['documentTemplateId'] = undefined;
/**
* Array or errors.
* @member {module:model/ErrorDetails} errorDetails
*/
exports.prototype['errorDetails'] = undefined;
/**
*
* @member {String} hasDigitalSignature
*/
exports.prototype['hasDigitalSignature'] = undefined;
/**
*
* @member {String} includeInDownload
*/
exports.prototype['includeInDownload'] = undefined;
/**
* Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.
* @member {module:model/PropertyMetadata} includeInDownloadMetadata
*/
exports.prototype['includeInDownloadMetadata'] = undefined;
/**
*
* @member {String} isAceGenDocument
*/
exports.prototype['isAceGenDocument'] = undefined;
/**
*
* @member {String} isDocGenDocument
*/
exports.prototype['isDocGenDocument'] = undefined;
/**
*
* @member {String} isExternallyAvailable
*/
exports.prototype['isExternallyAvailable'] = undefined;
/**
*
* @member {String} isFlattened
*/
exports.prototype['isFlattened'] = undefined;
/**
*
* @member {String} name
*/
exports.prototype['name'] = undefined;
/**
* Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.
* @member {module:model/PropertyMetadata} nameMetadata
*/
exports.prototype['nameMetadata'] = undefined;
/**
*
* @member {String} order
*/
exports.prototype['order'] = undefined;
/**
*
* @member {Array.<module:model/Page>} pages
*/
exports.prototype['pages'] = undefined;
/**
*
* @member {String} signerMustAcknowledge
*/
exports.prototype['signerMustAcknowledge'] = undefined;
/**
* Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.
* @member {module:model/PropertyMetadata} signerMustAcknowledgeMetadata
*/
exports.prototype['signerMustAcknowledgeMetadata'] = undefined;
/**
*
* @member {String} sizeBytes
*/
exports.prototype['sizeBytes'] = undefined;
/**
* When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
* @member {String} templateLocked
*/
exports.prototype['templateLocked'] = undefined;
/**
* When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
* @member {String} templateRequired
*/
exports.prototype['templateRequired'] = undefined;
/**
*
* @member {String} type
*/
exports.prototype['type'] = undefined;
/**
*
* @member {String} uri
*/
exports.prototype['uri'] = undefined;
return exports;
}));