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