model/PowerForm.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/Envelope', 'model/ErrorDetails', 'model/PowerFormRecipient'], 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('./Envelope'), require('./ErrorDetails'), require('./PowerFormRecipient'));
  18. } else {
  19. // Browser globals (root is window)
  20. if (!root.Docusign) {
  21. root.Docusign = {};
  22. }
  23. root.Docusign.PowerForm = factory(root.Docusign.ApiClient, root.Docusign.Envelope, root.Docusign.ErrorDetails, root.Docusign.PowerFormRecipient);
  24. }
  25. }(this, function(ApiClient, Envelope, ErrorDetails, PowerFormRecipient) {
  26. 'use strict';
  27. /**
  28. * The PowerForm model module.
  29. * @module model/PowerForm
  30. */
  31. /**
  32. * Constructs a new <code>PowerForm</code>.
  33. * Contains details about a PowerForm.
  34. * @alias module:model/PowerForm
  35. * @class
  36. */
  37. var exports = function() {
  38. var _this = this;
  39. };
  40. /**
  41. * Constructs a <code>PowerForm</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/PowerForm} obj Optional instance to populate.
  45. * @return {module:model/PowerForm} The populated <code>PowerForm</code> instance.
  46. */
  47. exports.constructFromObject = function(data, obj) {
  48. if (data) {
  49. obj = obj || new exports();
  50. if (data.hasOwnProperty('createdBy')) {
  51. obj['createdBy'] = ApiClient.convertToType(data['createdBy'], 'String');
  52. }
  53. if (data.hasOwnProperty('createdDateTime')) {
  54. obj['createdDateTime'] = ApiClient.convertToType(data['createdDateTime'], 'String');
  55. }
  56. if (data.hasOwnProperty('emailBody')) {
  57. obj['emailBody'] = ApiClient.convertToType(data['emailBody'], 'String');
  58. }
  59. if (data.hasOwnProperty('emailSubject')) {
  60. obj['emailSubject'] = ApiClient.convertToType(data['emailSubject'], 'String');
  61. }
  62. if (data.hasOwnProperty('envelopes')) {
  63. obj['envelopes'] = ApiClient.convertToType(data['envelopes'], [Envelope]);
  64. }
  65. if (data.hasOwnProperty('errorDetails')) {
  66. obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
  67. }
  68. if (data.hasOwnProperty('instructions')) {
  69. obj['instructions'] = ApiClient.convertToType(data['instructions'], 'String');
  70. }
  71. if (data.hasOwnProperty('isActive')) {
  72. obj['isActive'] = ApiClient.convertToType(data['isActive'], 'String');
  73. }
  74. if (data.hasOwnProperty('lastUsed')) {
  75. obj['lastUsed'] = ApiClient.convertToType(data['lastUsed'], 'String');
  76. }
  77. if (data.hasOwnProperty('limitUseInterval')) {
  78. obj['limitUseInterval'] = ApiClient.convertToType(data['limitUseInterval'], 'String');
  79. }
  80. if (data.hasOwnProperty('limitUseIntervalEnabled')) {
  81. obj['limitUseIntervalEnabled'] = ApiClient.convertToType(data['limitUseIntervalEnabled'], 'String');
  82. }
  83. if (data.hasOwnProperty('limitUseIntervalUnits')) {
  84. obj['limitUseIntervalUnits'] = ApiClient.convertToType(data['limitUseIntervalUnits'], 'String');
  85. }
  86. if (data.hasOwnProperty('maxUseEnabled')) {
  87. obj['maxUseEnabled'] = ApiClient.convertToType(data['maxUseEnabled'], 'String');
  88. }
  89. if (data.hasOwnProperty('name')) {
  90. obj['name'] = ApiClient.convertToType(data['name'], 'String');
  91. }
  92. if (data.hasOwnProperty('powerFormId')) {
  93. obj['powerFormId'] = ApiClient.convertToType(data['powerFormId'], 'String');
  94. }
  95. if (data.hasOwnProperty('powerFormUrl')) {
  96. obj['powerFormUrl'] = ApiClient.convertToType(data['powerFormUrl'], 'String');
  97. }
  98. if (data.hasOwnProperty('recipients')) {
  99. obj['recipients'] = ApiClient.convertToType(data['recipients'], [PowerFormRecipient]);
  100. }
  101. if (data.hasOwnProperty('senderName')) {
  102. obj['senderName'] = ApiClient.convertToType(data['senderName'], 'String');
  103. }
  104. if (data.hasOwnProperty('senderUserId')) {
  105. obj['senderUserId'] = ApiClient.convertToType(data['senderUserId'], 'String');
  106. }
  107. if (data.hasOwnProperty('signingMode')) {
  108. obj['signingMode'] = ApiClient.convertToType(data['signingMode'], 'String');
  109. }
  110. if (data.hasOwnProperty('templateId')) {
  111. obj['templateId'] = ApiClient.convertToType(data['templateId'], 'String');
  112. }
  113. if (data.hasOwnProperty('templateName')) {
  114. obj['templateName'] = ApiClient.convertToType(data['templateName'], 'String');
  115. }
  116. if (data.hasOwnProperty('timesUsed')) {
  117. obj['timesUsed'] = ApiClient.convertToType(data['timesUsed'], 'String');
  118. }
  119. if (data.hasOwnProperty('uri')) {
  120. obj['uri'] = ApiClient.convertToType(data['uri'], 'String');
  121. }
  122. if (data.hasOwnProperty('usesRemaining')) {
  123. obj['usesRemaining'] = ApiClient.convertToType(data['usesRemaining'], 'String');
  124. }
  125. }
  126. return obj;
  127. }
  128. /**
  129. *
  130. * @member {String} createdBy
  131. */
  132. exports.prototype['createdBy'] = undefined;
  133. /**
  134. * Indicates the date and time the item was created.
  135. * @member {String} createdDateTime
  136. */
  137. exports.prototype['createdDateTime'] = undefined;
  138. /**
  139. * Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters.
  140. * @member {String} emailBody
  141. */
  142. exports.prototype['emailBody'] = undefined;
  143. /**
  144. * Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
  145. * @member {String} emailSubject
  146. */
  147. exports.prototype['emailSubject'] = undefined;
  148. /**
  149. *
  150. * @member {Array.<module:model/Envelope>} envelopes
  151. */
  152. exports.prototype['envelopes'] = undefined;
  153. /**
  154. * Array or errors.
  155. * @member {module:model/ErrorDetails} errorDetails
  156. */
  157. exports.prototype['errorDetails'] = undefined;
  158. /**
  159. *
  160. * @member {String} instructions
  161. */
  162. exports.prototype['instructions'] = undefined;
  163. /**
  164. *
  165. * @member {String} isActive
  166. */
  167. exports.prototype['isActive'] = undefined;
  168. /**
  169. *
  170. * @member {String} lastUsed
  171. */
  172. exports.prototype['lastUsed'] = undefined;
  173. /**
  174. *
  175. * @member {String} limitUseInterval
  176. */
  177. exports.prototype['limitUseInterval'] = undefined;
  178. /**
  179. *
  180. * @member {String} limitUseIntervalEnabled
  181. */
  182. exports.prototype['limitUseIntervalEnabled'] = undefined;
  183. /**
  184. *
  185. * @member {String} limitUseIntervalUnits
  186. */
  187. exports.prototype['limitUseIntervalUnits'] = undefined;
  188. /**
  189. *
  190. * @member {String} maxUseEnabled
  191. */
  192. exports.prototype['maxUseEnabled'] = undefined;
  193. /**
  194. *
  195. * @member {String} name
  196. */
  197. exports.prototype['name'] = undefined;
  198. /**
  199. *
  200. * @member {String} powerFormId
  201. */
  202. exports.prototype['powerFormId'] = undefined;
  203. /**
  204. *
  205. * @member {String} powerFormUrl
  206. */
  207. exports.prototype['powerFormUrl'] = undefined;
  208. /**
  209. * An array of powerform recipients.
  210. * @member {Array.<module:model/PowerFormRecipient>} recipients
  211. */
  212. exports.prototype['recipients'] = undefined;
  213. /**
  214. *
  215. * @member {String} senderName
  216. */
  217. exports.prototype['senderName'] = undefined;
  218. /**
  219. *
  220. * @member {String} senderUserId
  221. */
  222. exports.prototype['senderUserId'] = undefined;
  223. /**
  224. *
  225. * @member {String} signingMode
  226. */
  227. exports.prototype['signingMode'] = undefined;
  228. /**
  229. * The unique identifier of the template. If this is not provided, DocuSign will generate a value.
  230. * @member {String} templateId
  231. */
  232. exports.prototype['templateId'] = undefined;
  233. /**
  234. *
  235. * @member {String} templateName
  236. */
  237. exports.prototype['templateName'] = undefined;
  238. /**
  239. *
  240. * @member {String} timesUsed
  241. */
  242. exports.prototype['timesUsed'] = undefined;
  243. /**
  244. *
  245. * @member {String} uri
  246. */
  247. exports.prototype['uri'] = undefined;
  248. /**
  249. *
  250. * @member {String} usesRemaining
  251. */
  252. exports.prototype['usesRemaining'] = undefined;
  253. return exports;
  254. }));