model/CommissionNumber.js

  1. /**
  2.  * Docusign eSignature REST API
  3.  * The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
  4.  *
  5.  * OpenAPI spec version: v2.1
  6.  * Contact: devcenter@docusign.com
  7.  *
  8.  * NOTE: This class is auto generated. Do not edit the class manually and submit a new issue instead.
  9.  *
  10.  */
  12. (function(root, factory) {
  13.   if (typeof define === 'function' && define.amd) {
  14.     // AMD. Register as an anonymous module.
  15.     define(['ApiClient', 'model/ErrorDetails', 'model/LocalePolicyTab', 'model/MergeField', 'model/PropertyMetadata', 'model/SmartContractInformation'], factory);
  16.   } else if (typeof module === 'object' && module.exports) {
  17.     // CommonJS-like environments that support module.exports, like Node.
  18.     module.exports = factory(require('../ApiClient'), require('./ErrorDetails'), require('./LocalePolicyTab'), require('./MergeField'), require('./PropertyMetadata'), require('./SmartContractInformation'));
  19.   } else {
  20.     // Browser globals (root is window)
  21.     if (!root.Docusign) {
  22.       root.Docusign = {};
  23.     }
  24.     root.Docusign.CommissionNumber = factory(root.Docusign.ApiClient, root.Docusign.ErrorDetails, root.Docusign.LocalePolicyTab, root.Docusign.MergeField, root.Docusign.PropertyMetadata, root.Docusign.SmartContractInformation);
  25.   }
  26. }(this, function(ApiClient, ErrorDetails, LocalePolicyTab, MergeField, PropertyMetadata, SmartContractInformation) {
  27.   'use strict';
  30.   /**
  31.    * The CommissionNumber model module.
  32.    * @module model/CommissionNumber
  33.    */
  35.   /**
  36.    * Constructs a new <code>CommissionNumber</code>.
  37.    * A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].  [notary]: /docs/notary-api/ 
  38.    * @alias module:model/CommissionNumber
  39.    * @class
  40.    */
  41.   var exports = function() {
  42.     var _this = this;
  45.   };
  47.   /**
  48.    * Constructs a <code>CommissionNumber</code> from a plain JavaScript object, optionally creating a new instance.
  49.    * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
  50.    * @param {Object} data The plain JavaScript object bearing properties of interest.
  51.    * @param {module:model/CommissionNumber} obj Optional instance to populate.
  52.    * @return {module:model/CommissionNumber} The populated <code>CommissionNumber</code> instance.
  53.    */
  54.   exports.constructFromObject = function(data, obj) {
  55.     if (data) {
  56.       obj = obj || new exports();
  58.       if (data.hasOwnProperty('anchorAllowWhiteSpaceInCharacters')) {
  59.         obj['anchorAllowWhiteSpaceInCharacters'] = ApiClient.convertToType(data['anchorAllowWhiteSpaceInCharacters'], 'String');
  60.       }
  61.       if (data.hasOwnProperty('anchorAllowWhiteSpaceInCharactersMetadata')) {
  62.         obj['anchorAllowWhiteSpaceInCharactersMetadata'] = PropertyMetadata.constructFromObject(data['anchorAllowWhiteSpaceInCharactersMetadata']);
  63.       }
  64.       if (data.hasOwnProperty('anchorCaseSensitive')) {
  65.         obj['anchorCaseSensitive'] = ApiClient.convertToType(data['anchorCaseSensitive'], 'String');
  66.       }
  67.       if (data.hasOwnProperty('anchorCaseSensitiveMetadata')) {
  68.         obj['anchorCaseSensitiveMetadata'] = PropertyMetadata.constructFromObject(data['anchorCaseSensitiveMetadata']);
  69.       }
  70.       if (data.hasOwnProperty('anchorHorizontalAlignment')) {
  71.         obj['anchorHorizontalAlignment'] = ApiClient.convertToType(data['anchorHorizontalAlignment'], 'String');
  72.       }
  73.       if (data.hasOwnProperty('anchorHorizontalAlignmentMetadata')) {
  74.         obj['anchorHorizontalAlignmentMetadata'] = PropertyMetadata.constructFromObject(data['anchorHorizontalAlignmentMetadata']);
  75.       }
  76.       if (data.hasOwnProperty('anchorIgnoreIfNotPresent')) {
  77.         obj['anchorIgnoreIfNotPresent'] = ApiClient.convertToType(data['anchorIgnoreIfNotPresent'], 'String');
  78.       }
  79.       if (data.hasOwnProperty('anchorIgnoreIfNotPresentMetadata')) {
  80.         obj['anchorIgnoreIfNotPresentMetadata'] = PropertyMetadata.constructFromObject(data['anchorIgnoreIfNotPresentMetadata']);
  81.       }
  82.       if (data.hasOwnProperty('anchorMatchWholeWord')) {
  83.         obj['anchorMatchWholeWord'] = ApiClient.convertToType(data['anchorMatchWholeWord'], 'String');
  84.       }
  85.       if (data.hasOwnProperty('anchorMatchWholeWordMetadata')) {
  86.         obj['anchorMatchWholeWordMetadata'] = PropertyMetadata.constructFromObject(data['anchorMatchWholeWordMetadata']);
  87.       }
  88.       if (data.hasOwnProperty('anchorString')) {
  89.         obj['anchorString'] = ApiClient.convertToType(data['anchorString'], 'String');
  90.       }
  91.       if (data.hasOwnProperty('anchorStringMetadata')) {
  92.         obj['anchorStringMetadata'] = PropertyMetadata.constructFromObject(data['anchorStringMetadata']);
  93.       }
  94.       if (data.hasOwnProperty('anchorTabProcessorVersion')) {
  95.         obj['anchorTabProcessorVersion'] = ApiClient.convertToType(data['anchorTabProcessorVersion'], 'String');
  96.       }
  97.       if (data.hasOwnProperty('anchorTabProcessorVersionMetadata')) {
  98.         obj['anchorTabProcessorVersionMetadata'] = PropertyMetadata.constructFromObject(data['anchorTabProcessorVersionMetadata']);
  99.       }
  100.       if (data.hasOwnProperty('anchorUnits')) {
  101.         obj['anchorUnits'] = ApiClient.convertToType(data['anchorUnits'], 'String');
  102.       }
  103.       if (data.hasOwnProperty('anchorUnitsMetadata')) {
  104.         obj['anchorUnitsMetadata'] = PropertyMetadata.constructFromObject(data['anchorUnitsMetadata']);
  105.       }
  106.       if (data.hasOwnProperty('anchorXOffset')) {
  107.         obj['anchorXOffset'] = ApiClient.convertToType(data['anchorXOffset'], 'String');
  108.       }
  109.       if (data.hasOwnProperty('anchorXOffsetMetadata')) {
  110.         obj['anchorXOffsetMetadata'] = PropertyMetadata.constructFromObject(data['anchorXOffsetMetadata']);
  111.       }
  112.       if (data.hasOwnProperty('anchorYOffset')) {
  113.         obj['anchorYOffset'] = ApiClient.convertToType(data['anchorYOffset'], 'String');
  114.       }
  115.       if (data.hasOwnProperty('anchorYOffsetMetadata')) {
  116.         obj['anchorYOffsetMetadata'] = PropertyMetadata.constructFromObject(data['anchorYOffsetMetadata']);
  117.       }
  118.       if (data.hasOwnProperty('bold')) {
  119.         obj['bold'] = ApiClient.convertToType(data['bold'], 'String');
  120.       }
  121.       if (data.hasOwnProperty('boldMetadata')) {
  122.         obj['boldMetadata'] = PropertyMetadata.constructFromObject(data['boldMetadata']);
  123.       }
  124.       if (data.hasOwnProperty('caption')) {
  125.         obj['caption'] = ApiClient.convertToType(data['caption'], 'String');
  126.       }
  127.       if (data.hasOwnProperty('captionMetadata')) {
  128.         obj['captionMetadata'] = PropertyMetadata.constructFromObject(data['captionMetadata']);
  129.       }
  130.       if (data.hasOwnProperty('concealValueOnDocument')) {
  131.         obj['concealValueOnDocument'] = ApiClient.convertToType(data['concealValueOnDocument'], 'String');
  132.       }
  133.       if (data.hasOwnProperty('concealValueOnDocumentMetadata')) {
  134.         obj['concealValueOnDocumentMetadata'] = PropertyMetadata.constructFromObject(data['concealValueOnDocumentMetadata']);
  135.       }
  136.       if (data.hasOwnProperty('conditionalParentLabel')) {
  137.         obj['conditionalParentLabel'] = ApiClient.convertToType(data['conditionalParentLabel'], 'String');
  138.       }
  139.       if (data.hasOwnProperty('conditionalParentLabelMetadata')) {
  140.         obj['conditionalParentLabelMetadata'] = PropertyMetadata.constructFromObject(data['conditionalParentLabelMetadata']);
  141.       }
  142.       if (data.hasOwnProperty('conditionalParentValue')) {
  143.         obj['conditionalParentValue'] = ApiClient.convertToType(data['conditionalParentValue'], 'String');
  144.       }
  145.       if (data.hasOwnProperty('conditionalParentValueMetadata')) {
  146.         obj['conditionalParentValueMetadata'] = PropertyMetadata.constructFromObject(data['conditionalParentValueMetadata']);
  147.       }
  148.       if (data.hasOwnProperty('customTabId')) {
  149.         obj['customTabId'] = ApiClient.convertToType(data['customTabId'], 'String');
  150.       }
  151.       if (data.hasOwnProperty('customTabIdMetadata')) {
  152.         obj['customTabIdMetadata'] = PropertyMetadata.constructFromObject(data['customTabIdMetadata']);
  153.       }
  154.       if (data.hasOwnProperty('disableAutoSize')) {
  155.         obj['disableAutoSize'] = ApiClient.convertToType(data['disableAutoSize'], 'String');
  156.       }
  157.       if (data.hasOwnProperty('disableAutoSizeMetadata')) {
  158.         obj['disableAutoSizeMetadata'] = PropertyMetadata.constructFromObject(data['disableAutoSizeMetadata']);
  159.       }
  160.       if (data.hasOwnProperty('documentId')) {
  161.         obj['documentId'] = ApiClient.convertToType(data['documentId'], 'String');
  162.       }
  163.       if (data.hasOwnProperty('documentIdMetadata')) {
  164.         obj['documentIdMetadata'] = PropertyMetadata.constructFromObject(data['documentIdMetadata']);
  165.       }
  166.       if (data.hasOwnProperty('errorDetails')) {
  167.         obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
  168.       }
  169.       if (data.hasOwnProperty('font')) {
  170.         obj['font'] = ApiClient.convertToType(data['font'], 'String');
  171.       }
  172.       if (data.hasOwnProperty('fontColor')) {
  173.         obj['fontColor'] = ApiClient.convertToType(data['fontColor'], 'String');
  174.       }
  175.       if (data.hasOwnProperty('fontColorMetadata')) {
  176.         obj['fontColorMetadata'] = PropertyMetadata.constructFromObject(data['fontColorMetadata']);
  177.       }
  178.       if (data.hasOwnProperty('fontMetadata')) {
  179.         obj['fontMetadata'] = PropertyMetadata.constructFromObject(data['fontMetadata']);
  180.       }
  181.       if (data.hasOwnProperty('fontSize')) {
  182.         obj['fontSize'] = ApiClient.convertToType(data['fontSize'], 'String');
  183.       }
  184.       if (data.hasOwnProperty('fontSizeMetadata')) {
  185.         obj['fontSizeMetadata'] = PropertyMetadata.constructFromObject(data['fontSizeMetadata']);
  186.       }
  187.       if (data.hasOwnProperty('formOrder')) {
  188.         obj['formOrder'] = ApiClient.convertToType(data['formOrder'], 'String');
  189.       }
  190.       if (data.hasOwnProperty('formOrderMetadata')) {
  191.         obj['formOrderMetadata'] = PropertyMetadata.constructFromObject(data['formOrderMetadata']);
  192.       }
  193.       if (data.hasOwnProperty('formPageLabel')) {
  194.         obj['formPageLabel'] = ApiClient.convertToType(data['formPageLabel'], 'String');
  195.       }
  196.       if (data.hasOwnProperty('formPageLabelMetadata')) {
  197.         obj['formPageLabelMetadata'] = PropertyMetadata.constructFromObject(data['formPageLabelMetadata']);
  198.       }
  199.       if (data.hasOwnProperty('formPageNumber')) {
  200.         obj['formPageNumber'] = ApiClient.convertToType(data['formPageNumber'], 'String');
  201.       }
  202.       if (data.hasOwnProperty('formPageNumberMetadata')) {
  203.         obj['formPageNumberMetadata'] = PropertyMetadata.constructFromObject(data['formPageNumberMetadata']);
  204.       }
  205.       if (data.hasOwnProperty('height')) {
  206.         obj['height'] = ApiClient.convertToType(data['height'], 'String');
  207.       }
  208.       if (data.hasOwnProperty('heightMetadata')) {
  209.         obj['heightMetadata'] = PropertyMetadata.constructFromObject(data['heightMetadata']);
  210.       }
  211.       if (data.hasOwnProperty('italic')) {
  212.         obj['italic'] = ApiClient.convertToType(data['italic'], 'String');
  213.       }
  214.       if (data.hasOwnProperty('italicMetadata')) {
  215.         obj['italicMetadata'] = PropertyMetadata.constructFromObject(data['italicMetadata']);
  216.       }
  217.       if (data.hasOwnProperty('localePolicy')) {
  218.         obj['localePolicy'] = LocalePolicyTab.constructFromObject(data['localePolicy']);
  219.       }
  220.       if (data.hasOwnProperty('locked')) {
  221.         obj['locked'] = ApiClient.convertToType(data['locked'], 'String');
  222.       }
  223.       if (data.hasOwnProperty('lockedMetadata')) {
  224.         obj['lockedMetadata'] = PropertyMetadata.constructFromObject(data['lockedMetadata']);
  225.       }
  226.       if (data.hasOwnProperty('maxLength')) {
  227.         obj['maxLength'] = ApiClient.convertToType(data['maxLength'], 'String');
  228.       }
  229.       if (data.hasOwnProperty('maxLengthMetadata')) {
  230.         obj['maxLengthMetadata'] = PropertyMetadata.constructFromObject(data['maxLengthMetadata']);
  231.       }
  232.       if (data.hasOwnProperty('mergeField')) {
  233.         obj['mergeField'] = MergeField.constructFromObject(data['mergeField']);
  234.       }
  235.       if (data.hasOwnProperty('mergeFieldXml')) {
  236.         obj['mergeFieldXml'] = ApiClient.convertToType(data['mergeFieldXml'], 'String');
  237.       }
  238.       if (data.hasOwnProperty('name')) {
  239.         obj['name'] = ApiClient.convertToType(data['name'], 'String');
  240.       }
  241.       if (data.hasOwnProperty('nameMetadata')) {
  242.         obj['nameMetadata'] = PropertyMetadata.constructFromObject(data['nameMetadata']);
  243.       }
  244.       if (data.hasOwnProperty('originalValue')) {
  245.         obj['originalValue'] = ApiClient.convertToType(data['originalValue'], 'String');
  246.       }
  247.       if (data.hasOwnProperty('originalValueMetadata')) {
  248.         obj['originalValueMetadata'] = PropertyMetadata.constructFromObject(data['originalValueMetadata']);
  249.       }
  250.       if (data.hasOwnProperty('pageNumber')) {
  251.         obj['pageNumber'] = ApiClient.convertToType(data['pageNumber'], 'String');
  252.       }
  253.       if (data.hasOwnProperty('pageNumberMetadata')) {
  254.         obj['pageNumberMetadata'] = PropertyMetadata.constructFromObject(data['pageNumberMetadata']);
  255.       }
  256.       if (data.hasOwnProperty('recipientId')) {
  257.         obj['recipientId'] = ApiClient.convertToType(data['recipientId'], 'String');
  258.       }
  259.       if (data.hasOwnProperty('recipientIdGuid')) {
  260.         obj['recipientIdGuid'] = ApiClient.convertToType(data['recipientIdGuid'], 'String');
  261.       }
  262.       if (data.hasOwnProperty('recipientIdGuidMetadata')) {
  263.         obj['recipientIdGuidMetadata'] = PropertyMetadata.constructFromObject(data['recipientIdGuidMetadata']);
  264.       }
  265.       if (data.hasOwnProperty('recipientIdMetadata')) {
  266.         obj['recipientIdMetadata'] = PropertyMetadata.constructFromObject(data['recipientIdMetadata']);
  267.       }
  268.       if (data.hasOwnProperty('required')) {
  269.         obj['required'] = ApiClient.convertToType(data['required'], 'String');
  270.       }
  271.       if (data.hasOwnProperty('requiredMetadata')) {
  272.         obj['requiredMetadata'] = PropertyMetadata.constructFromObject(data['requiredMetadata']);
  273.       }
  274.       if (data.hasOwnProperty('smartContractInformation')) {
  275.         obj['smartContractInformation'] = SmartContractInformation.constructFromObject(data['smartContractInformation']);
  276.       }
  277.       if (data.hasOwnProperty('source')) {
  278.         obj['source'] = ApiClient.convertToType(data['source'], 'String');
  279.       }
  280.       if (data.hasOwnProperty('status')) {
  281.         obj['status'] = ApiClient.convertToType(data['status'], 'String');
  282.       }
  283.       if (data.hasOwnProperty('statusMetadata')) {
  284.         obj['statusMetadata'] = PropertyMetadata.constructFromObject(data['statusMetadata']);
  285.       }
  286.       if (data.hasOwnProperty('tabGroupLabels')) {
  287.         obj['tabGroupLabels'] = ApiClient.convertToType(data['tabGroupLabels'], ['String']);
  288.       }
  289.       if (data.hasOwnProperty('tabGroupLabelsMetadata')) {
  290.         obj['tabGroupLabelsMetadata'] = PropertyMetadata.constructFromObject(data['tabGroupLabelsMetadata']);
  291.       }
  292.       if (data.hasOwnProperty('tabId')) {
  293.         obj['tabId'] = ApiClient.convertToType(data['tabId'], 'String');
  294.       }
  295.       if (data.hasOwnProperty('tabIdMetadata')) {
  296.         obj['tabIdMetadata'] = PropertyMetadata.constructFromObject(data['tabIdMetadata']);
  297.       }
  298.       if (data.hasOwnProperty('tabLabel')) {
  299.         obj['tabLabel'] = ApiClient.convertToType(data['tabLabel'], 'String');
  300.       }
  301.       if (data.hasOwnProperty('tabLabelMetadata')) {
  302.         obj['tabLabelMetadata'] = PropertyMetadata.constructFromObject(data['tabLabelMetadata']);
  303.       }
  304.       if (data.hasOwnProperty('tabOrder')) {
  305.         obj['tabOrder'] = ApiClient.convertToType(data['tabOrder'], 'String');
  306.       }
  307.       if (data.hasOwnProperty('tabOrderMetadata')) {
  308.         obj['tabOrderMetadata'] = PropertyMetadata.constructFromObject(data['tabOrderMetadata']);
  309.       }
  310.       if (data.hasOwnProperty('tabType')) {
  311.         obj['tabType'] = ApiClient.convertToType(data['tabType'], 'String');
  312.       }
  313.       if (data.hasOwnProperty('tabTypeMetadata')) {
  314.         obj['tabTypeMetadata'] = PropertyMetadata.constructFromObject(data['tabTypeMetadata']);
  315.       }
  316.       if (data.hasOwnProperty('templateLocked')) {
  317.         obj['templateLocked'] = ApiClient.convertToType(data['templateLocked'], 'String');
  318.       }
  319.       if (data.hasOwnProperty('templateLockedMetadata')) {
  320.         obj['templateLockedMetadata'] = PropertyMetadata.constructFromObject(data['templateLockedMetadata']);
  321.       }
  322.       if (data.hasOwnProperty('templateRequired')) {
  323.         obj['templateRequired'] = ApiClient.convertToType(data['templateRequired'], 'String');
  324.       }
  325.       if (data.hasOwnProperty('templateRequiredMetadata')) {
  326.         obj['templateRequiredMetadata'] = PropertyMetadata.constructFromObject(data['templateRequiredMetadata']);
  327.       }
  328.       if (data.hasOwnProperty('tooltip')) {
  329.         obj['tooltip'] = ApiClient.convertToType(data['tooltip'], 'String');
  330.       }
  331.       if (data.hasOwnProperty('toolTipMetadata')) {
  332.         obj['toolTipMetadata'] = PropertyMetadata.constructFromObject(data['toolTipMetadata']);
  333.       }
  334.       if (data.hasOwnProperty('underline')) {
  335.         obj['underline'] = ApiClient.convertToType(data['underline'], 'String');
  336.       }
  337.       if (data.hasOwnProperty('underlineMetadata')) {
  338.         obj['underlineMetadata'] = PropertyMetadata.constructFromObject(data['underlineMetadata']);
  339.       }
  340.       if (data.hasOwnProperty('value')) {
  341.         obj['value'] = ApiClient.convertToType(data['value'], 'String');
  342.       }
  343.       if (data.hasOwnProperty('valueMetadata')) {
  344.         obj['valueMetadata'] = PropertyMetadata.constructFromObject(data['valueMetadata']);
  345.       }
  346.       if (data.hasOwnProperty('width')) {
  347.         obj['width'] = ApiClient.convertToType(data['width'], 'String');
  348.       }
  349.       if (data.hasOwnProperty('widthMetadata')) {
  350.         obj['widthMetadata'] = PropertyMetadata.constructFromObject(data['widthMetadata']);
  351.       }
  352.       if (data.hasOwnProperty('xPosition')) {
  353.         obj['xPosition'] = ApiClient.convertToType(data['xPosition'], 'String');
  354.       }
  355.       if (data.hasOwnProperty('xPositionMetadata')) {
  356.         obj['xPositionMetadata'] = PropertyMetadata.constructFromObject(data['xPositionMetadata']);
  357.       }
  358.       if (data.hasOwnProperty('yPosition')) {
  359.         obj['yPosition'] = ApiClient.convertToType(data['yPosition'], 'String');
  360.       }
  361.       if (data.hasOwnProperty('yPositionMetadata')) {
  362.         obj['yPositionMetadata'] = PropertyMetadata.constructFromObject(data['yPositionMetadata']);
  363.       }
  364.     }
  365.     return obj;
  366.   }
  368.   /**
  369.    * 
  370.    * @member {String} anchorAllowWhiteSpaceInCharacters
  371.    */
  372.   exports.prototype['anchorAllowWhiteSpaceInCharacters'] = undefined;
  373.   /**
  374.    * Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
  375.    * @member {module:model/PropertyMetadata} anchorAllowWhiteSpaceInCharactersMetadata
  376.    */
  377.   exports.prototype['anchorAllowWhiteSpaceInCharactersMetadata'] = undefined;
  378.   /**
  379.    * When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
  380.    * @member {String} anchorCaseSensitive
  381.    */
  382.   exports.prototype['anchorCaseSensitive'] = undefined;
  383.   /**
  384.    * Metadata that indicates whether the `anchorCaseSensitive` property is editable.
  385.    * @member {module:model/PropertyMetadata} anchorCaseSensitiveMetadata
  386.    */
  387.   exports.prototype['anchorCaseSensitiveMetadata'] = undefined;
  388.   /**
  389.    * Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
  390.    * @member {String} anchorHorizontalAlignment
  391.    */
  392.   exports.prototype['anchorHorizontalAlignment'] = undefined;
  393.   /**
  394.    * Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
  395.    * @member {module:model/PropertyMetadata} anchorHorizontalAlignmentMetadata
  396.    */
  397.   exports.prototype['anchorHorizontalAlignmentMetadata'] = undefined;
  398.   /**
  399.    * When set to **true**, this tab is ignored if anchorString is not found in the document.
  400.    * @member {String} anchorIgnoreIfNotPresent
  401.    */
  402.   exports.prototype['anchorIgnoreIfNotPresent'] = undefined;
  403.   /**
  404.    * Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
  405.    * @member {module:model/PropertyMetadata} anchorIgnoreIfNotPresentMetadata
  406.    */
  407.   exports.prototype['anchorIgnoreIfNotPresentMetadata'] = undefined;
  408.   /**
  409.    * 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**.
  410.    * @member {String} anchorMatchWholeWord
  411.    */
  412.   exports.prototype['anchorMatchWholeWord'] = undefined;
  413.   /**
  414.    * Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
  415.    * @member {module:model/PropertyMetadata} anchorMatchWholeWordMetadata
  416.    */
  417.   exports.prototype['anchorMatchWholeWordMetadata'] = undefined;
  418.   /**
  419.    * Anchor text information for a radio button.
  420.    * @member {String} anchorString
  421.    */
  422.   exports.prototype['anchorString'] = undefined;
  423.   /**
  424.    * Metadata that indicates whether the `anchorString` property is editable.
  425.    * @member {module:model/PropertyMetadata} anchorStringMetadata
  426.    */
  427.   exports.prototype['anchorStringMetadata'] = undefined;
  428.   /**
  429.    * 
  430.    * @member {String} anchorTabProcessorVersion
  431.    */
  432.   exports.prototype['anchorTabProcessorVersion'] = undefined;
  433.   /**
  434.    * Reserved for DocuSign.
  435.    * @member {module:model/PropertyMetadata} anchorTabProcessorVersionMetadata
  436.    */
  437.   exports.prototype['anchorTabProcessorVersionMetadata'] = undefined;
  438.   /**
  439.    * Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
  440.    * @member {String} anchorUnits
  441.    */
  442.   exports.prototype['anchorUnits'] = undefined;
  443.   /**
  444.    * Metadata that indicates whether the `anchorUnits` property is editable.
  445.    * @member {module:model/PropertyMetadata} anchorUnitsMetadata
  446.    */
  447.   exports.prototype['anchorUnitsMetadata'] = undefined;
  448.   /**
  449.    * Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
  450.    * @member {String} anchorXOffset
  451.    */
  452.   exports.prototype['anchorXOffset'] = undefined;
  453.   /**
  454.    * Metadata that indicates whether the `anchorXOffset` property is editable.
  455.    * @member {module:model/PropertyMetadata} anchorXOffsetMetadata
  456.    */
  457.   exports.prototype['anchorXOffsetMetadata'] = undefined;
  458.   /**
  459.    * Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
  460.    * @member {String} anchorYOffset
  461.    */
  462.   exports.prototype['anchorYOffset'] = undefined;
  463.   /**
  464.    * Metadata that indicates whether the `anchorYOffset` property is editable.
  465.    * @member {module:model/PropertyMetadata} anchorYOffsetMetadata
  466.    */
  467.   exports.prototype['anchorYOffsetMetadata'] = undefined;
  468.   /**
  469.    * When set to **true**, the information in the tab is bold.
  470.    * @member {String} bold
  471.    */
  472.   exports.prototype['bold'] = undefined;
  473.   /**
  474.    * Metadata that indicates whether the `bold` property is editable.
  475.    * @member {module:model/PropertyMetadata} boldMetadata
  476.    */
  477.   exports.prototype['boldMetadata'] = undefined;
  478.   /**
  479.    * 
  480.    * @member {String} caption
  481.    */
  482.   exports.prototype['caption'] = undefined;
  483.   /**
  484.    * 
  485.    * @member {module:model/PropertyMetadata} captionMetadata
  486.    */
  487.   exports.prototype['captionMetadata'] = undefined;
  488.   /**
  489.    * When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.  When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.  This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
  490.    * @member {String} concealValueOnDocument
  491.    */
  492.   exports.prototype['concealValueOnDocument'] = undefined;
  493.   /**
  494.    * Metadata that indicates whether the `concealValueOnDocument` property is editable.
  495.    * @member {module:model/PropertyMetadata} concealValueOnDocumentMetadata
  496.    */
  497.   exports.prototype['concealValueOnDocumentMetadata'] = undefined;
  498.   /**
  499.    * For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
  500.    * @member {String} conditionalParentLabel
  501.    */
  502.   exports.prototype['conditionalParentLabel'] = undefined;
  503.   /**
  504.    * Metadata that indicates whether the `conditionalParentLabel` property is editable.
  505.    * @member {module:model/PropertyMetadata} conditionalParentLabelMetadata
  506.    */
  507.   exports.prototype['conditionalParentLabelMetadata'] = undefined;
  508.   /**
  509.    * 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. 
  510.    * @member {String} conditionalParentValue
  511.    */
  512.   exports.prototype['conditionalParentValue'] = undefined;
  513.   /**
  514.    * Metadata that indicates whether the `conditionalParentValue` property is editable.
  515.    * @member {module:model/PropertyMetadata} conditionalParentValueMetadata
  516.    */
  517.   exports.prototype['conditionalParentValueMetadata'] = undefined;
  518.   /**
  519.    * 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.
  520.    * @member {String} customTabId
  521.    */
  522.   exports.prototype['customTabId'] = undefined;
  523.   /**
  524.    * Metadata that indicates whether the `customTabId` property is editable.
  525.    * @member {module:model/PropertyMetadata} customTabIdMetadata
  526.    */
  527.   exports.prototype['customTabIdMetadata'] = undefined;
  528.   /**
  529.    * When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
  530.    * @member {String} disableAutoSize
  531.    */
  532.   exports.prototype['disableAutoSize'] = undefined;
  533.   /**
  534.    * Metadata that indicates whether the `disableAutoSize` property is editable.
  535.    * @member {module:model/PropertyMetadata} disableAutoSizeMetadata
  536.    */
  537.   exports.prototype['disableAutoSizeMetadata'] = undefined;
  538.   /**
  539.    * Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
  540.    * @member {String} documentId
  541.    */
  542.   exports.prototype['documentId'] = undefined;
  543.   /**
  544.    * Metadata that indicates whether the `documentId` property is editable.
  545.    * @member {module:model/PropertyMetadata} documentIdMetadata
  546.    */
  547.   exports.prototype['documentIdMetadata'] = undefined;
  548.   /**
  549.    * Array or errors.
  550.    * @member {module:model/ErrorDetails} errorDetails
  551.    */
  552.   exports.prototype['errorDetails'] = undefined;
  553.   /**
  554.    * The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica,   LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
  555.    * @member {String} font
  556.    */
  557.   exports.prototype['font'] = undefined;
  558.   /**
  559.    * The font color used for the information in the tab.  Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
  560.    * @member {String} fontColor
  561.    */
  562.   exports.prototype['fontColor'] = undefined;
  563.   /**
  564.    * Metadata that indicates whether the `fontColor` property is editable.
  565.    * @member {module:model/PropertyMetadata} fontColorMetadata
  566.    */
  567.   exports.prototype['fontColorMetadata'] = undefined;
  568.   /**
  569.    * Metadata that indicates whether the `font` property is editable.
  570.    * @member {module:model/PropertyMetadata} fontMetadata
  571.    */
  572.   exports.prototype['fontMetadata'] = undefined;
  573.   /**
  574.    * The font size used for the information in the tab.  Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
  575.    * @member {String} fontSize
  576.    */
  577.   exports.prototype['fontSize'] = undefined;
  578.   /**
  579.    * Metadata that indicates whether the `fontSize` property is editable.
  580.    * @member {module:model/PropertyMetadata} fontSizeMetadata
  581.    */
  582.   exports.prototype['fontSizeMetadata'] = undefined;
  583.   /**
  584.    * 
  585.    * @member {String} formOrder
  586.    */
  587.   exports.prototype['formOrder'] = undefined;
  588.   /**
  589.    * Metadata that indicates whether the `formOrder` property is editable.
  590.    * @member {module:model/PropertyMetadata} formOrderMetadata
  591.    */
  592.   exports.prototype['formOrderMetadata'] = undefined;
  593.   /**
  594.    * 
  595.    * @member {String} formPageLabel
  596.    */
  597.   exports.prototype['formPageLabel'] = undefined;
  598.   /**
  599.    * Metadata that indicates whether the `formPageLabel` property is editable.
  600.    * @member {module:model/PropertyMetadata} formPageLabelMetadata
  601.    */
  602.   exports.prototype['formPageLabelMetadata'] = undefined;
  603.   /**
  604.    * 
  605.    * @member {String} formPageNumber
  606.    */
  607.   exports.prototype['formPageNumber'] = undefined;
  608.   /**
  609.    * Metadata that indicates whether the `fromPageNumber` property is editable.
  610.    * @member {module:model/PropertyMetadata} formPageNumberMetadata
  611.    */
  612.   exports.prototype['formPageNumberMetadata'] = undefined;
  613.   /**
  614.    * Height of the tab in pixels.
  615.    * @member {String} height
  616.    */
  617.   exports.prototype['height'] = undefined;
  618.   /**
  619.    * Metadata that indicates whether the `height` property is editable.
  620.    * @member {module:model/PropertyMetadata} heightMetadata
  621.    */
  622.   exports.prototype['heightMetadata'] = undefined;
  623.   /**
  624.    * When set to **true**, the information in the tab is italic.
  625.    * @member {String} italic
  626.    */
  627.   exports.prototype['italic'] = undefined;
  628.   /**
  629.    * Metadata that indicates whether the `italic` property is editable.
  630.    * @member {module:model/PropertyMetadata} italicMetadata
  631.    */
  632.   exports.prototype['italicMetadata'] = undefined;
  633.   /**
  634.    * Reserved for DocuSign.
  635.    * @member {module:model/LocalePolicyTab} localePolicy
  636.    */
  637.   exports.prototype['localePolicy'] = undefined;
  638.   /**
  639.    * When set to **true**, the signer cannot change the data of the custom tab.
  640.    * @member {String} locked
  641.    */
  642.   exports.prototype['locked'] = undefined;
  643.   /**
  644.    * Metadata that indicates whether the `locked` property is editable.
  645.    * @member {module:model/PropertyMetadata} lockedMetadata
  646.    */
  647.   exports.prototype['lockedMetadata'] = undefined;
  648.   /**
  649.    * An optional value that describes the maximum length of the property when the property is a string.
  650.    * @member {String} maxLength
  651.    */
  652.   exports.prototype['maxLength'] = undefined;
  653.   /**
  654.    * Metadata that indicates whether the `maxLength` property is editable.
  655.    * @member {module:model/PropertyMetadata} maxLengthMetadata
  656.    */
  657.   exports.prototype['maxLengthMetadata'] = undefined;
  658.   /**
  659.    * Contains the information necessary to map the tab to a field in SalesForce.
  660.    * @member {module:model/MergeField} mergeField
  661.    */
  662.   exports.prototype['mergeField'] = undefined;
  663.   /**
  664.    * 
  665.    * @member {String} mergeFieldXml
  666.    */
  667.   exports.prototype['mergeFieldXml'] = undefined;
  668.   /**
  669.    * 
  670.    * @member {String} name
  671.    */
  672.   exports.prototype['name'] = undefined;
  673.   /**
  674.    * Metadata that indicates whether the `name` property is editable. This property is read-only.
  675.    * @member {module:model/PropertyMetadata} nameMetadata
  676.    */
  677.   exports.prototype['nameMetadata'] = undefined;
  678.   /**
  679.    * The initial value of the tab when it was sent to the recipient. 
  680.    * @member {String} originalValue
  681.    */
  682.   exports.prototype['originalValue'] = undefined;
  683.   /**
  684.    * Metadata that indicates whether the `originalValue` property is editable.
  685.    * @member {module:model/PropertyMetadata} originalValueMetadata
  686.    */
  687.   exports.prototype['originalValueMetadata'] = undefined;
  688.   /**
  689.    * Specifies the page number on which the tab is located.
  690.    * @member {String} pageNumber
  691.    */
  692.   exports.prototype['pageNumber'] = undefined;
  693.   /**
  694.    * Metadata that indicates whether the `pageNumber` property is editable.
  695.    * @member {module:model/PropertyMetadata} pageNumberMetadata
  696.    */
  697.   exports.prototype['pageNumberMetadata'] = undefined;
  698.   /**
  699.    * Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
  700.    * @member {String} recipientId
  701.    */
  702.   exports.prototype['recipientId'] = undefined;
  703.   /**
  704.    * 
  705.    * @member {String} recipientIdGuid
  706.    */
  707.   exports.prototype['recipientIdGuid'] = undefined;
  708.   /**
  709.    * Metadata that indicates whether the `recipientIdGuid` property is editable.
  710.    * @member {module:model/PropertyMetadata} recipientIdGuidMetadata
  711.    */
  712.   exports.prototype['recipientIdGuidMetadata'] = undefined;
  713.   /**
  714.    * Metadata that indicates whether the `recipientId` property is editable.
  715.    * @member {module:model/PropertyMetadata} recipientIdMetadata
  716.    */
  717.   exports.prototype['recipientIdMetadata'] = undefined;
  718.   /**
  719.    * When set to **true**, the signer is required to fill out this tab
  720.    * @member {String} required
  721.    */
  722.   exports.prototype['required'] = undefined;
  723.   /**
  724.    * Metadata that indicates whether the `required` property is editable.
  725.    * @member {module:model/PropertyMetadata} requiredMetadata
  726.    */
  727.   exports.prototype['requiredMetadata'] = undefined;
  728.   /**
  729.    * Reserved for DocuSign.
  730.    * @member {module:model/SmartContractInformation} smartContractInformation
  731.    */
  732.   exports.prototype['smartContractInformation'] = undefined;
  733.   /**
  734.    * 
  735.    * @member {String} source
  736.    */
  737.   exports.prototype['source'] = undefined;
  738.   /**
  739.    * 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.
  740.    * @member {String} status
  741.    */
  742.   exports.prototype['status'] = undefined;
  743.   /**
  744.    * Metadata that indicates whether the `status` property is editable.
  745.    * @member {module:model/PropertyMetadata} statusMetadata
  746.    */
  747.   exports.prototype['statusMetadata'] = undefined;
  748.   /**
  749.    * 
  750.    * @member {Array.<String>} tabGroupLabels
  751.    */
  752.   exports.prototype['tabGroupLabels'] = undefined;
  753.   /**
  754.    * Metadata that indicates whether the `tabGroupLabels` property is editable.
  755.    * @member {module:model/PropertyMetadata} tabGroupLabelsMetadata
  756.    */
  757.   exports.prototype['tabGroupLabelsMetadata'] = undefined;
  758.   /**
  759.    * The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].     
  760.    * @member {String} tabId
  761.    */
  762.   exports.prototype['tabId'] = undefined;
  763.   /**
  764.    * Metadata that indicates whether the `tabId` property is editable.
  765.    * @member {module:model/PropertyMetadata} tabIdMetadata
  766.    */
  767.   exports.prototype['tabIdMetadata'] = undefined;
  768.   /**
  769.    * The label string associated with the tab.
  770.    * @member {String} tabLabel
  771.    */
  772.   exports.prototype['tabLabel'] = undefined;
  773.   /**
  774.    * Metadata that indicates whether the `tabLabel` property is editable.
  775.    * @member {module:model/PropertyMetadata} tabLabelMetadata
  776.    */
  777.   exports.prototype['tabLabelMetadata'] = undefined;
  778.   /**
  779.    * 
  780.    * @member {String} tabOrder
  781.    */
  782.   exports.prototype['tabOrder'] = undefined;
  783.   /**
  784.    * Metadata that indicates whether the `tabOrder` property is editable.
  785.    * @member {module:model/PropertyMetadata} tabOrderMetadata
  786.    */
  787.   exports.prototype['tabOrderMetadata'] = undefined;
  788.   /**
  789.    * 
  790.    * @member {String} tabType
  791.    */
  792.   exports.prototype['tabType'] = undefined;
  793.   /**
  794.    * Metadata that indicates whether the `tabType` property is editable.
  795.    * @member {module:model/PropertyMetadata} tabTypeMetadata
  796.    */
  797.   exports.prototype['tabTypeMetadata'] = undefined;
  798.   /**
  799.    * When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. 
  800.    * @member {String} templateLocked
  801.    */
  802.   exports.prototype['templateLocked'] = undefined;
  803.   /**
  804.    * Metadata that indicates whether the `templateLocked` property is editable.
  805.    * @member {module:model/PropertyMetadata} templateLockedMetadata
  806.    */
  807.   exports.prototype['templateLockedMetadata'] = undefined;
  808.   /**
  809.    * When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
  810.    * @member {String} templateRequired
  811.    */
  812.   exports.prototype['templateRequired'] = undefined;
  813.   /**
  814.    * Metadata that indicates whether the `templateRequired` property is editable.
  815.    * @member {module:model/PropertyMetadata} templateRequiredMetadata
  816.    */
  817.   exports.prototype['templateRequiredMetadata'] = undefined;
  818.   /**
  819.    * 
  820.    * @member {String} tooltip
  821.    */
  822.   exports.prototype['tooltip'] = undefined;
  823.   /**
  824.    * Metadata that indicates whether the `toolTip` property is editable.
  825.    * @member {module:model/PropertyMetadata} toolTipMetadata
  826.    */
  827.   exports.prototype['toolTipMetadata'] = undefined;
  828.   /**
  829.    * When set to **true**, the information in the tab is underlined.
  830.    * @member {String} underline
  831.    */
  832.   exports.prototype['underline'] = undefined;
  833.   /**
  834.    * Metadata that indicates whether the `underline` property is editable.
  835.    * @member {module:model/PropertyMetadata} underlineMetadata
  836.    */
  837.   exports.prototype['underlineMetadata'] = undefined;
  838.   /**
  839.    * Specifies the value of the tab. 
  840.    * @member {String} value
  841.    */
  842.   exports.prototype['value'] = undefined;
  843.   /**
  844.    * Metadata that indicates whether the `value` property is editable.
  845.    * @member {module:model/PropertyMetadata} valueMetadata
  846.    */
  847.   exports.prototype['valueMetadata'] = undefined;
  848.   /**
  849.    * Width of the tab in pixels.
  850.    * @member {String} width
  851.    */
  852.   exports.prototype['width'] = undefined;
  853.   /**
  854.    * Metadata that indicates whether the `width` property is editable.
  855.    * @member {module:model/PropertyMetadata} widthMetadata
  856.    */
  857.   exports.prototype['widthMetadata'] = undefined;
  858.   /**
  859.    * This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
  860.    * @member {String} xPosition
  861.    */
  862.   exports.prototype['xPosition'] = undefined;
  863.   /**
  864.    * Metadata that indicates whether the `xPosition` property is editable.
  865.    * @member {module:model/PropertyMetadata} xPositionMetadata
  866.    */
  867.   exports.prototype['xPositionMetadata'] = undefined;
  868.   /**
  869.    * This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
  870.    * @member {String} yPosition
  871.    */
  872.   exports.prototype['yPosition'] = undefined;
  873.   /**
  874.    * Metadata that indicates whether the `yPosition` property is editable.
  875.    * @member {module:model/PropertyMetadata} yPositionMetadata
  876.    */
  877.   exports.prototype['yPositionMetadata'] = undefined;
  881.   return exports;
  882. }));