docusign-esign
Version:
Docusign Node.js API client.
757 lines (742 loc) • 32.4 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/ConnectedObjectDetails', 'model/ErrorDetails', 'model/ExtensionData', 'model/GraphicsContext', 'model/MergeField', 'model/PolyLine', 'model/PropertyMetadata', 'model/SmartContractInformation'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('./ConnectedObjectDetails'), require('./ErrorDetails'), require('./ExtensionData'), require('./GraphicsContext'), require('./MergeField'), require('./PolyLine'), require('./PropertyMetadata'), require('./SmartContractInformation'));
} else {
// Browser globals (root is window)
if (!root.Docusign) {
root.Docusign = {};
}
root.Docusign.PolyLineOverlay = factory(root.Docusign.ApiClient, root.Docusign.ConnectedObjectDetails, root.Docusign.ErrorDetails, root.Docusign.ExtensionData, root.Docusign.GraphicsContext, root.Docusign.MergeField, root.Docusign.PolyLine, root.Docusign.PropertyMetadata, root.Docusign.SmartContractInformation);
}
}(this, function(ApiClient, ConnectedObjectDetails, ErrorDetails, ExtensionData, GraphicsContext, MergeField, PolyLine, PropertyMetadata, SmartContractInformation) {
'use strict';
/**
* The PolyLineOverlay model module.
* @module model/PolyLineOverlay
*/
/**
* Constructs a new <code>PolyLineOverlay</code>.
* This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.
* @alias module:model/PolyLineOverlay
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>PolyLineOverlay</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/PolyLineOverlay} obj Optional instance to populate.
* @return {module:model/PolyLineOverlay} The populated <code>PolyLineOverlay</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('agreementAttribute')) {
obj['agreementAttribute'] = ApiClient.convertToType(data['agreementAttribute'], 'String');
}
if (data.hasOwnProperty('agreementAttributeLocked')) {
obj['agreementAttributeLocked'] = ApiClient.convertToType(data['agreementAttributeLocked'], 'String');
}
if (data.hasOwnProperty('anchorAllowWhiteSpaceInCharacters')) {
obj['anchorAllowWhiteSpaceInCharacters'] = ApiClient.convertToType(data['anchorAllowWhiteSpaceInCharacters'], 'String');
}
if (data.hasOwnProperty('anchorAllowWhiteSpaceInCharactersMetadata')) {
obj['anchorAllowWhiteSpaceInCharactersMetadata'] = PropertyMetadata.constructFromObject(data['anchorAllowWhiteSpaceInCharactersMetadata']);
}
if (data.hasOwnProperty('anchorCaseSensitive')) {
obj['anchorCaseSensitive'] = ApiClient.convertToType(data['anchorCaseSensitive'], 'String');
}
if (data.hasOwnProperty('anchorCaseSensitiveMetadata')) {
obj['anchorCaseSensitiveMetadata'] = PropertyMetadata.constructFromObject(data['anchorCaseSensitiveMetadata']);
}
if (data.hasOwnProperty('anchorHorizontalAlignment')) {
obj['anchorHorizontalAlignment'] = ApiClient.convertToType(data['anchorHorizontalAlignment'], 'String');
}
if (data.hasOwnProperty('anchorHorizontalAlignmentMetadata')) {
obj['anchorHorizontalAlignmentMetadata'] = PropertyMetadata.constructFromObject(data['anchorHorizontalAlignmentMetadata']);
}
if (data.hasOwnProperty('anchorIgnoreIfNotPresent')) {
obj['anchorIgnoreIfNotPresent'] = ApiClient.convertToType(data['anchorIgnoreIfNotPresent'], 'String');
}
if (data.hasOwnProperty('anchorIgnoreIfNotPresentMetadata')) {
obj['anchorIgnoreIfNotPresentMetadata'] = PropertyMetadata.constructFromObject(data['anchorIgnoreIfNotPresentMetadata']);
}
if (data.hasOwnProperty('anchorMatchWholeWord')) {
obj['anchorMatchWholeWord'] = ApiClient.convertToType(data['anchorMatchWholeWord'], 'String');
}
if (data.hasOwnProperty('anchorMatchWholeWordMetadata')) {
obj['anchorMatchWholeWordMetadata'] = PropertyMetadata.constructFromObject(data['anchorMatchWholeWordMetadata']);
}
if (data.hasOwnProperty('anchorString')) {
obj['anchorString'] = ApiClient.convertToType(data['anchorString'], 'String');
}
if (data.hasOwnProperty('anchorStringMetadata')) {
obj['anchorStringMetadata'] = PropertyMetadata.constructFromObject(data['anchorStringMetadata']);
}
if (data.hasOwnProperty('anchorTabProcessorVersion')) {
obj['anchorTabProcessorVersion'] = ApiClient.convertToType(data['anchorTabProcessorVersion'], 'String');
}
if (data.hasOwnProperty('anchorTabProcessorVersionMetadata')) {
obj['anchorTabProcessorVersionMetadata'] = PropertyMetadata.constructFromObject(data['anchorTabProcessorVersionMetadata']);
}
if (data.hasOwnProperty('anchorUnits')) {
obj['anchorUnits'] = ApiClient.convertToType(data['anchorUnits'], 'String');
}
if (data.hasOwnProperty('anchorUnitsMetadata')) {
obj['anchorUnitsMetadata'] = PropertyMetadata.constructFromObject(data['anchorUnitsMetadata']);
}
if (data.hasOwnProperty('anchorXOffset')) {
obj['anchorXOffset'] = ApiClient.convertToType(data['anchorXOffset'], 'String');
}
if (data.hasOwnProperty('anchorXOffsetMetadata')) {
obj['anchorXOffsetMetadata'] = PropertyMetadata.constructFromObject(data['anchorXOffsetMetadata']);
}
if (data.hasOwnProperty('anchorYOffset')) {
obj['anchorYOffset'] = ApiClient.convertToType(data['anchorYOffset'], 'String');
}
if (data.hasOwnProperty('anchorYOffsetMetadata')) {
obj['anchorYOffsetMetadata'] = PropertyMetadata.constructFromObject(data['anchorYOffsetMetadata']);
}
if (data.hasOwnProperty('caption')) {
obj['caption'] = ApiClient.convertToType(data['caption'], 'String');
}
if (data.hasOwnProperty('captionMetadata')) {
obj['captionMetadata'] = PropertyMetadata.constructFromObject(data['captionMetadata']);
}
if (data.hasOwnProperty('conditionalParentLabel')) {
obj['conditionalParentLabel'] = ApiClient.convertToType(data['conditionalParentLabel'], 'String');
}
if (data.hasOwnProperty('conditionalParentLabelMetadata')) {
obj['conditionalParentLabelMetadata'] = PropertyMetadata.constructFromObject(data['conditionalParentLabelMetadata']);
}
if (data.hasOwnProperty('conditionalParentValue')) {
obj['conditionalParentValue'] = ApiClient.convertToType(data['conditionalParentValue'], 'String');
}
if (data.hasOwnProperty('conditionalParentValueMetadata')) {
obj['conditionalParentValueMetadata'] = PropertyMetadata.constructFromObject(data['conditionalParentValueMetadata']);
}
if (data.hasOwnProperty('connectedObjectDetails')) {
obj['connectedObjectDetails'] = ConnectedObjectDetails.constructFromObject(data['connectedObjectDetails']);
}
if (data.hasOwnProperty('customTabId')) {
obj['customTabId'] = ApiClient.convertToType(data['customTabId'], 'String');
}
if (data.hasOwnProperty('customTabIdMetadata')) {
obj['customTabIdMetadata'] = PropertyMetadata.constructFromObject(data['customTabIdMetadata']);
}
if (data.hasOwnProperty('documentId')) {
obj['documentId'] = ApiClient.convertToType(data['documentId'], 'String');
}
if (data.hasOwnProperty('documentIdMetadata')) {
obj['documentIdMetadata'] = PropertyMetadata.constructFromObject(data['documentIdMetadata']);
}
if (data.hasOwnProperty('errorDetails')) {
obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
}
if (data.hasOwnProperty('extensionData')) {
obj['extensionData'] = ExtensionData.constructFromObject(data['extensionData']);
}
if (data.hasOwnProperty('formOrder')) {
obj['formOrder'] = ApiClient.convertToType(data['formOrder'], 'String');
}
if (data.hasOwnProperty('formOrderMetadata')) {
obj['formOrderMetadata'] = PropertyMetadata.constructFromObject(data['formOrderMetadata']);
}
if (data.hasOwnProperty('formPageLabel')) {
obj['formPageLabel'] = ApiClient.convertToType(data['formPageLabel'], 'String');
}
if (data.hasOwnProperty('formPageLabelMetadata')) {
obj['formPageLabelMetadata'] = PropertyMetadata.constructFromObject(data['formPageLabelMetadata']);
}
if (data.hasOwnProperty('formPageNumber')) {
obj['formPageNumber'] = ApiClient.convertToType(data['formPageNumber'], 'String');
}
if (data.hasOwnProperty('formPageNumberMetadata')) {
obj['formPageNumberMetadata'] = PropertyMetadata.constructFromObject(data['formPageNumberMetadata']);
}
if (data.hasOwnProperty('graphicsContext')) {
obj['graphicsContext'] = GraphicsContext.constructFromObject(data['graphicsContext']);
}
if (data.hasOwnProperty('height')) {
obj['height'] = ApiClient.convertToType(data['height'], 'String');
}
if (data.hasOwnProperty('heightMetadata')) {
obj['heightMetadata'] = PropertyMetadata.constructFromObject(data['heightMetadata']);
}
if (data.hasOwnProperty('locked')) {
obj['locked'] = ApiClient.convertToType(data['locked'], 'String');
}
if (data.hasOwnProperty('lockedMetadata')) {
obj['lockedMetadata'] = PropertyMetadata.constructFromObject(data['lockedMetadata']);
}
if (data.hasOwnProperty('mergeField')) {
obj['mergeField'] = MergeField.constructFromObject(data['mergeField']);
}
if (data.hasOwnProperty('mergeFieldXml')) {
obj['mergeFieldXml'] = ApiClient.convertToType(data['mergeFieldXml'], 'String');
}
if (data.hasOwnProperty('overlayType')) {
obj['overlayType'] = ApiClient.convertToType(data['overlayType'], 'String');
}
if (data.hasOwnProperty('overlayTypeMetadata')) {
obj['overlayTypeMetadata'] = PropertyMetadata.constructFromObject(data['overlayTypeMetadata']);
}
if (data.hasOwnProperty('pageNumber')) {
obj['pageNumber'] = ApiClient.convertToType(data['pageNumber'], 'String');
}
if (data.hasOwnProperty('pageNumberMetadata')) {
obj['pageNumberMetadata'] = PropertyMetadata.constructFromObject(data['pageNumberMetadata']);
}
if (data.hasOwnProperty('polyLines')) {
obj['polyLines'] = ApiClient.convertToType(data['polyLines'], [PolyLine]);
}
if (data.hasOwnProperty('recipientId')) {
obj['recipientId'] = ApiClient.convertToType(data['recipientId'], 'String');
}
if (data.hasOwnProperty('recipientIdGuid')) {
obj['recipientIdGuid'] = ApiClient.convertToType(data['recipientIdGuid'], 'String');
}
if (data.hasOwnProperty('recipientIdGuidMetadata')) {
obj['recipientIdGuidMetadata'] = PropertyMetadata.constructFromObject(data['recipientIdGuidMetadata']);
}
if (data.hasOwnProperty('recipientIdMetadata')) {
obj['recipientIdMetadata'] = PropertyMetadata.constructFromObject(data['recipientIdMetadata']);
}
if (data.hasOwnProperty('shared')) {
obj['shared'] = ApiClient.convertToType(data['shared'], 'String');
}
if (data.hasOwnProperty('sharedMetadata')) {
obj['sharedMetadata'] = PropertyMetadata.constructFromObject(data['sharedMetadata']);
}
if (data.hasOwnProperty('smartContractInformation')) {
obj['smartContractInformation'] = SmartContractInformation.constructFromObject(data['smartContractInformation']);
}
if (data.hasOwnProperty('source')) {
obj['source'] = ApiClient.convertToType(data['source'], 'String');
}
if (data.hasOwnProperty('status')) {
obj['status'] = ApiClient.convertToType(data['status'], 'String');
}
if (data.hasOwnProperty('statusMetadata')) {
obj['statusMetadata'] = PropertyMetadata.constructFromObject(data['statusMetadata']);
}
if (data.hasOwnProperty('tabFullyQualifiedPath')) {
obj['tabFullyQualifiedPath'] = ApiClient.convertToType(data['tabFullyQualifiedPath'], 'String');
}
if (data.hasOwnProperty('tabGroupLabels')) {
obj['tabGroupLabels'] = ApiClient.convertToType(data['tabGroupLabels'], ['String']);
}
if (data.hasOwnProperty('tabGroupLabelsMetadata')) {
obj['tabGroupLabelsMetadata'] = PropertyMetadata.constructFromObject(data['tabGroupLabelsMetadata']);
}
if (data.hasOwnProperty('tabId')) {
obj['tabId'] = ApiClient.convertToType(data['tabId'], 'String');
}
if (data.hasOwnProperty('tabIdMetadata')) {
obj['tabIdMetadata'] = PropertyMetadata.constructFromObject(data['tabIdMetadata']);
}
if (data.hasOwnProperty('tabLabel')) {
obj['tabLabel'] = ApiClient.convertToType(data['tabLabel'], 'String');
}
if (data.hasOwnProperty('tabOrder')) {
obj['tabOrder'] = ApiClient.convertToType(data['tabOrder'], 'String');
}
if (data.hasOwnProperty('tabOrderMetadata')) {
obj['tabOrderMetadata'] = PropertyMetadata.constructFromObject(data['tabOrderMetadata']);
}
if (data.hasOwnProperty('tabType')) {
obj['tabType'] = ApiClient.convertToType(data['tabType'], 'String');
}
if (data.hasOwnProperty('tabTypeMetadata')) {
obj['tabTypeMetadata'] = PropertyMetadata.constructFromObject(data['tabTypeMetadata']);
}
if (data.hasOwnProperty('templateLocked')) {
obj['templateLocked'] = ApiClient.convertToType(data['templateLocked'], 'String');
}
if (data.hasOwnProperty('templateLockedMetadata')) {
obj['templateLockedMetadata'] = PropertyMetadata.constructFromObject(data['templateLockedMetadata']);
}
if (data.hasOwnProperty('templateRequired')) {
obj['templateRequired'] = ApiClient.convertToType(data['templateRequired'], 'String');
}
if (data.hasOwnProperty('templateRequiredMetadata')) {
obj['templateRequiredMetadata'] = PropertyMetadata.constructFromObject(data['templateRequiredMetadata']);
}
if (data.hasOwnProperty('tooltip')) {
obj['tooltip'] = ApiClient.convertToType(data['tooltip'], 'String');
}
if (data.hasOwnProperty('toolTipMetadata')) {
obj['toolTipMetadata'] = PropertyMetadata.constructFromObject(data['toolTipMetadata']);
}
if (data.hasOwnProperty('warningDetails')) {
obj['warningDetails'] = ErrorDetails.constructFromObject(data['warningDetails']);
}
if (data.hasOwnProperty('width')) {
obj['width'] = ApiClient.convertToType(data['width'], 'String');
}
if (data.hasOwnProperty('widthMetadata')) {
obj['widthMetadata'] = PropertyMetadata.constructFromObject(data['widthMetadata']);
}
if (data.hasOwnProperty('xPosition')) {
obj['xPosition'] = ApiClient.convertToType(data['xPosition'], 'String');
}
if (data.hasOwnProperty('xPositionMetadata')) {
obj['xPositionMetadata'] = PropertyMetadata.constructFromObject(data['xPositionMetadata']);
}
if (data.hasOwnProperty('yPosition')) {
obj['yPosition'] = ApiClient.convertToType(data['yPosition'], 'String');
}
if (data.hasOwnProperty('yPositionMetadata')) {
obj['yPositionMetadata'] = PropertyMetadata.constructFromObject(data['yPositionMetadata']);
}
}
return obj;
}
/**
*
* @member {String} agreementAttribute
*/
exports.prototype['agreementAttribute'] = undefined;
/**
*
* @member {String} agreementAttributeLocked
*/
exports.prototype['agreementAttributeLocked'] = undefined;
/**
*
* @member {String} anchorAllowWhiteSpaceInCharacters
*/
exports.prototype['anchorAllowWhiteSpaceInCharacters'] = undefined;
/**
* Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
* @member {module:model/PropertyMetadata} anchorAllowWhiteSpaceInCharactersMetadata
*/
exports.prototype['anchorAllowWhiteSpaceInCharactersMetadata'] = undefined;
/**
* When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
* @member {String} anchorCaseSensitive
*/
exports.prototype['anchorCaseSensitive'] = undefined;
/**
* Metadata that indicates whether the `anchorCaseSensitive` property is editable.
* @member {module:model/PropertyMetadata} anchorCaseSensitiveMetadata
*/
exports.prototype['anchorCaseSensitiveMetadata'] = undefined;
/**
* Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
* @member {String} anchorHorizontalAlignment
*/
exports.prototype['anchorHorizontalAlignment'] = undefined;
/**
* Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
* @member {module:model/PropertyMetadata} anchorHorizontalAlignmentMetadata
*/
exports.prototype['anchorHorizontalAlignmentMetadata'] = undefined;
/**
* When set to **true**, this tab is ignored if anchorString is not found in the document.
* @member {String} anchorIgnoreIfNotPresent
*/
exports.prototype['anchorIgnoreIfNotPresent'] = undefined;
/**
* Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
* @member {module:model/PropertyMetadata} anchorIgnoreIfNotPresentMetadata
*/
exports.prototype['anchorIgnoreIfNotPresentMetadata'] = undefined;
/**
* When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
* @member {String} anchorMatchWholeWord
*/
exports.prototype['anchorMatchWholeWord'] = undefined;
/**
* Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
* @member {module:model/PropertyMetadata} anchorMatchWholeWordMetadata
*/
exports.prototype['anchorMatchWholeWordMetadata'] = undefined;
/**
* Anchor text information for a radio button.
* @member {String} anchorString
*/
exports.prototype['anchorString'] = undefined;
/**
* Metadata that indicates whether the `anchorString` property is editable.
* @member {module:model/PropertyMetadata} anchorStringMetadata
*/
exports.prototype['anchorStringMetadata'] = undefined;
/**
*
* @member {String} anchorTabProcessorVersion
*/
exports.prototype['anchorTabProcessorVersion'] = undefined;
/**
* Reserved for DocuSign.
* @member {module:model/PropertyMetadata} anchorTabProcessorVersionMetadata
*/
exports.prototype['anchorTabProcessorVersionMetadata'] = undefined;
/**
* Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
* @member {String} anchorUnits
*/
exports.prototype['anchorUnits'] = undefined;
/**
* Metadata that indicates whether the `anchorUnits` property is editable.
* @member {module:model/PropertyMetadata} anchorUnitsMetadata
*/
exports.prototype['anchorUnitsMetadata'] = undefined;
/**
* Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
* @member {String} anchorXOffset
*/
exports.prototype['anchorXOffset'] = undefined;
/**
* Metadata that indicates whether the `anchorXOffset` property is editable.
* @member {module:model/PropertyMetadata} anchorXOffsetMetadata
*/
exports.prototype['anchorXOffsetMetadata'] = undefined;
/**
* Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
* @member {String} anchorYOffset
*/
exports.prototype['anchorYOffset'] = undefined;
/**
* Metadata that indicates whether the `anchorYOffset` property is editable.
* @member {module:model/PropertyMetadata} anchorYOffsetMetadata
*/
exports.prototype['anchorYOffsetMetadata'] = undefined;
/**
*
* @member {String} caption
*/
exports.prototype['caption'] = undefined;
/**
*
* @member {module:model/PropertyMetadata} captionMetadata
*/
exports.prototype['captionMetadata'] = undefined;
/**
* For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
* @member {String} conditionalParentLabel
*/
exports.prototype['conditionalParentLabel'] = undefined;
/**
* Metadata that indicates whether the `conditionalParentLabel` property is editable.
* @member {module:model/PropertyMetadata} conditionalParentLabelMetadata
*/
exports.prototype['conditionalParentLabelMetadata'] = undefined;
/**
* For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
* @member {String} conditionalParentValue
*/
exports.prototype['conditionalParentValue'] = undefined;
/**
* Metadata that indicates whether the `conditionalParentValue` property is editable.
* @member {module:model/PropertyMetadata} conditionalParentValueMetadata
*/
exports.prototype['conditionalParentValueMetadata'] = undefined;
/**
*
* @member {module:model/ConnectedObjectDetails} connectedObjectDetails
*/
exports.prototype['connectedObjectDetails'] = undefined;
/**
* The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
* @member {String} customTabId
*/
exports.prototype['customTabId'] = undefined;
/**
* Metadata that indicates whether the `customTabId` property is editable.
* @member {module:model/PropertyMetadata} customTabIdMetadata
*/
exports.prototype['customTabIdMetadata'] = 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;
/**
* Metadata that indicates whether the `documentId` property is editable.
* @member {module:model/PropertyMetadata} documentIdMetadata
*/
exports.prototype['documentIdMetadata'] = undefined;
/**
* Array or errors.
* @member {module:model/ErrorDetails} errorDetails
*/
exports.prototype['errorDetails'] = undefined;
/**
*
* @member {module:model/ExtensionData} extensionData
*/
exports.prototype['extensionData'] = undefined;
/**
*
* @member {String} formOrder
*/
exports.prototype['formOrder'] = undefined;
/**
* Metadata that indicates whether the `formOrder` property is editable.
* @member {module:model/PropertyMetadata} formOrderMetadata
*/
exports.prototype['formOrderMetadata'] = undefined;
/**
*
* @member {String} formPageLabel
*/
exports.prototype['formPageLabel'] = undefined;
/**
* Metadata that indicates whether the `formPageLabel` property is editable.
* @member {module:model/PropertyMetadata} formPageLabelMetadata
*/
exports.prototype['formPageLabelMetadata'] = undefined;
/**
*
* @member {String} formPageNumber
*/
exports.prototype['formPageNumber'] = undefined;
/**
* Metadata that indicates whether the `fromPageNumber` property is editable.
* @member {module:model/PropertyMetadata} formPageNumberMetadata
*/
exports.prototype['formPageNumberMetadata'] = undefined;
/**
* Contains details about the style used for the strike through graphic.
* @member {module:model/GraphicsContext} graphicsContext
*/
exports.prototype['graphicsContext'] = undefined;
/**
* Height of the tab in pixels.
* @member {String} height
*/
exports.prototype['height'] = undefined;
/**
* Metadata that indicates whether the `height` property is editable.
* @member {module:model/PropertyMetadata} heightMetadata
*/
exports.prototype['heightMetadata'] = undefined;
/**
* When set to **true**, the signer cannot change the data of the custom tab.
* @member {String} locked
*/
exports.prototype['locked'] = undefined;
/**
* Metadata that indicates whether the `locked` property is editable.
* @member {module:model/PropertyMetadata} lockedMetadata
*/
exports.prototype['lockedMetadata'] = undefined;
/**
* Contains the information necessary to map the tab to a field in SalesForce.
* @member {module:model/MergeField} mergeField
*/
exports.prototype['mergeField'] = undefined;
/**
*
* @member {String} mergeFieldXml
*/
exports.prototype['mergeFieldXml'] = undefined;
/**
*
* @member {String} overlayType
*/
exports.prototype['overlayType'] = undefined;
/**
* Metadata that indicates whether the `overlayType` property is editable.
* @member {module:model/PropertyMetadata} overlayTypeMetadata
*/
exports.prototype['overlayTypeMetadata'] = undefined;
/**
* Specifies the page number on which the tab is located.
* @member {String} pageNumber
*/
exports.prototype['pageNumber'] = undefined;
/**
* Metadata that indicates whether the `pageNumber` property is editable.
* @member {module:model/PropertyMetadata} pageNumberMetadata
*/
exports.prototype['pageNumberMetadata'] = undefined;
/**
*
* @member {Array.<module:model/PolyLine>} polyLines
*/
exports.prototype['polyLines'] = undefined;
/**
* Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
* @member {String} recipientId
*/
exports.prototype['recipientId'] = undefined;
/**
*
* @member {String} recipientIdGuid
*/
exports.prototype['recipientIdGuid'] = undefined;
/**
* Metadata that indicates whether the `recipientIdGuid` property is editable.
* @member {module:model/PropertyMetadata} recipientIdGuidMetadata
*/
exports.prototype['recipientIdGuidMetadata'] = undefined;
/**
* Metadata that indicates whether the `recipientId` property is editable.
* @member {module:model/PropertyMetadata} recipientIdMetadata
*/
exports.prototype['recipientIdMetadata'] = undefined;
/**
* When set to **true**, this custom tab is shared.
* @member {String} shared
*/
exports.prototype['shared'] = undefined;
/**
* Metadata that indicates whether the `shared` property is editable.
* @member {module:model/PropertyMetadata} sharedMetadata
*/
exports.prototype['sharedMetadata'] = undefined;
/**
* Reserved for DocuSign.
* @member {module:model/SmartContractInformation} smartContractInformation
*/
exports.prototype['smartContractInformation'] = undefined;
/**
*
* @member {String} source
*/
exports.prototype['source'] = 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;
/**
* Metadata that indicates whether the `status` property is editable.
* @member {module:model/PropertyMetadata} statusMetadata
*/
exports.prototype['statusMetadata'] = undefined;
/**
*
* @member {String} tabFullyQualifiedPath
*/
exports.prototype['tabFullyQualifiedPath'] = undefined;
/**
*
* @member {Array.<String>} tabGroupLabels
*/
exports.prototype['tabGroupLabels'] = undefined;
/**
* Metadata that indicates whether the `tabGroupLabels` property is editable.
* @member {module:model/PropertyMetadata} tabGroupLabelsMetadata
*/
exports.prototype['tabGroupLabelsMetadata'] = undefined;
/**
* The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
* @member {String} tabId
*/
exports.prototype['tabId'] = undefined;
/**
* Metadata that indicates whether the `tabId` property is editable.
* @member {module:model/PropertyMetadata} tabIdMetadata
*/
exports.prototype['tabIdMetadata'] = undefined;
/**
* The label string associated with the tab.
* @member {String} tabLabel
*/
exports.prototype['tabLabel'] = undefined;
/**
*
* @member {String} tabOrder
*/
exports.prototype['tabOrder'] = undefined;
/**
* Metadata that indicates whether the `tabOrder` property is editable.
* @member {module:model/PropertyMetadata} tabOrderMetadata
*/
exports.prototype['tabOrderMetadata'] = undefined;
/**
*
* @member {String} tabType
*/
exports.prototype['tabType'] = undefined;
/**
* Metadata that indicates whether the `tabType` property is editable.
* @member {module:model/PropertyMetadata} tabTypeMetadata
*/
exports.prototype['tabTypeMetadata'] = 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;
/**
* Metadata that indicates whether the `templateLocked` property is editable.
* @member {module:model/PropertyMetadata} templateLockedMetadata
*/
exports.prototype['templateLockedMetadata'] = 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;
/**
* Metadata that indicates whether the `templateRequired` property is editable.
* @member {module:model/PropertyMetadata} templateRequiredMetadata
*/
exports.prototype['templateRequiredMetadata'] = undefined;
/**
*
* @member {String} tooltip
*/
exports.prototype['tooltip'] = undefined;
/**
* Metadata that indicates whether the `toolTip` property is editable.
* @member {module:model/PropertyMetadata} toolTipMetadata
*/
exports.prototype['toolTipMetadata'] = undefined;
/**
*
* @member {module:model/ErrorDetails} warningDetails
*/
exports.prototype['warningDetails'] = undefined;
/**
* Width of the tab in pixels.
* @member {String} width
*/
exports.prototype['width'] = undefined;
/**
* Metadata that indicates whether the `width` property is editable.
* @member {module:model/PropertyMetadata} widthMetadata
*/
exports.prototype['widthMetadata'] = undefined;
/**
* This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
* @member {String} xPosition
*/
exports.prototype['xPosition'] = undefined;
/**
* Metadata that indicates whether the `xPosition` property is editable.
* @member {module:model/PropertyMetadata} xPositionMetadata
*/
exports.prototype['xPositionMetadata'] = undefined;
/**
* This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
* @member {String} yPosition
*/
exports.prototype['yPosition'] = undefined;
/**
* Metadata that indicates whether the `yPosition` property is editable.
* @member {module:model/PropertyMetadata} yPositionMetadata
*/
exports.prototype['yPositionMetadata'] = undefined;
return exports;
}));