model/AccountSignature.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/DateStampProperties', 'model/ErrorDetails', 'model/SignatureGroup', 'model/SignatureUser'], 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('./DateStampProperties'), require('./ErrorDetails'), require('./SignatureGroup'), require('./SignatureUser'));
  18. } else {
  19. // Browser globals (root is window)
  20. if (!root.Docusign) {
  21. root.Docusign = {};
  22. }
  23. root.Docusign.AccountSignature = factory(root.Docusign.ApiClient, root.Docusign.DateStampProperties, root.Docusign.ErrorDetails, root.Docusign.SignatureGroup, root.Docusign.SignatureUser);
  24. }
  25. }(this, function(ApiClient, DateStampProperties, ErrorDetails, SignatureGroup, SignatureUser) {
  26. 'use strict';
  27. /**
  28. * The AccountSignature model module.
  29. * @module model/AccountSignature
  30. */
  31. /**
  32. * Constructs a new <code>AccountSignature</code>.
  33. * @alias module:model/AccountSignature
  34. * @class
  35. */
  36. var exports = function() {
  37. var _this = this;
  38. };
  39. /**
  40. * Constructs a <code>AccountSignature</code> from a plain JavaScript object, optionally creating a new instance.
  41. * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
  42. * @param {Object} data The plain JavaScript object bearing properties of interest.
  43. * @param {module:model/AccountSignature} obj Optional instance to populate.
  44. * @return {module:model/AccountSignature} The populated <code>AccountSignature</code> instance.
  45. */
  46. exports.constructFromObject = function(data, obj) {
  47. if (data) {
  48. obj = obj || new exports();
  49. if (data.hasOwnProperty('adoptedDateTime')) {
  50. obj['adoptedDateTime'] = ApiClient.convertToType(data['adoptedDateTime'], 'String');
  51. }
  52. if (data.hasOwnProperty('createdDateTime')) {
  53. obj['createdDateTime'] = ApiClient.convertToType(data['createdDateTime'], 'String');
  54. }
  55. if (data.hasOwnProperty('customField')) {
  56. obj['customField'] = ApiClient.convertToType(data['customField'], 'String');
  57. }
  58. if (data.hasOwnProperty('dateStampProperties')) {
  59. obj['dateStampProperties'] = DateStampProperties.constructFromObject(data['dateStampProperties']);
  60. }
  61. if (data.hasOwnProperty('disallowUserResizeStamp')) {
  62. obj['disallowUserResizeStamp'] = ApiClient.convertToType(data['disallowUserResizeStamp'], 'String');
  63. }
  64. if (data.hasOwnProperty('errorDetails')) {
  65. obj['errorDetails'] = ErrorDetails.constructFromObject(data['errorDetails']);
  66. }
  67. if (data.hasOwnProperty('externalID')) {
  68. obj['externalID'] = ApiClient.convertToType(data['externalID'], 'String');
  69. }
  70. if (data.hasOwnProperty('imageBase64')) {
  71. obj['imageBase64'] = ApiClient.convertToType(data['imageBase64'], 'String');
  72. }
  73. if (data.hasOwnProperty('imageType')) {
  74. obj['imageType'] = ApiClient.convertToType(data['imageType'], 'String');
  75. }
  76. if (data.hasOwnProperty('initials150ImageId')) {
  77. obj['initials150ImageId'] = ApiClient.convertToType(data['initials150ImageId'], 'String');
  78. }
  79. if (data.hasOwnProperty('initialsImageUri')) {
  80. obj['initialsImageUri'] = ApiClient.convertToType(data['initialsImageUri'], 'String');
  81. }
  82. if (data.hasOwnProperty('isDefault')) {
  83. obj['isDefault'] = ApiClient.convertToType(data['isDefault'], 'String');
  84. }
  85. if (data.hasOwnProperty('lastModifiedDateTime')) {
  86. obj['lastModifiedDateTime'] = ApiClient.convertToType(data['lastModifiedDateTime'], 'String');
  87. }
  88. if (data.hasOwnProperty('nrdsId')) {
  89. obj['nrdsId'] = ApiClient.convertToType(data['nrdsId'], 'String');
  90. }
  91. if (data.hasOwnProperty('nrdsLastName')) {
  92. obj['nrdsLastName'] = ApiClient.convertToType(data['nrdsLastName'], 'String');
  93. }
  94. if (data.hasOwnProperty('nrdsStatus')) {
  95. obj['nrdsStatus'] = ApiClient.convertToType(data['nrdsStatus'], 'String');
  96. }
  97. if (data.hasOwnProperty('phoneticName')) {
  98. obj['phoneticName'] = ApiClient.convertToType(data['phoneticName'], 'String');
  99. }
  100. if (data.hasOwnProperty('signature150ImageId')) {
  101. obj['signature150ImageId'] = ApiClient.convertToType(data['signature150ImageId'], 'String');
  102. }
  103. if (data.hasOwnProperty('signatureFont')) {
  104. obj['signatureFont'] = ApiClient.convertToType(data['signatureFont'], 'String');
  105. }
  106. if (data.hasOwnProperty('signatureGroups')) {
  107. obj['signatureGroups'] = ApiClient.convertToType(data['signatureGroups'], [SignatureGroup]);
  108. }
  109. if (data.hasOwnProperty('signatureId')) {
  110. obj['signatureId'] = ApiClient.convertToType(data['signatureId'], 'String');
  111. }
  112. if (data.hasOwnProperty('signatureImageUri')) {
  113. obj['signatureImageUri'] = ApiClient.convertToType(data['signatureImageUri'], 'String');
  114. }
  115. if (data.hasOwnProperty('signatureInitials')) {
  116. obj['signatureInitials'] = ApiClient.convertToType(data['signatureInitials'], 'String');
  117. }
  118. if (data.hasOwnProperty('signatureName')) {
  119. obj['signatureName'] = ApiClient.convertToType(data['signatureName'], 'String');
  120. }
  121. if (data.hasOwnProperty('signatureRights')) {
  122. obj['signatureRights'] = ApiClient.convertToType(data['signatureRights'], 'String');
  123. }
  124. if (data.hasOwnProperty('signatureType')) {
  125. obj['signatureType'] = ApiClient.convertToType(data['signatureType'], 'String');
  126. }
  127. if (data.hasOwnProperty('signatureUsers')) {
  128. obj['signatureUsers'] = ApiClient.convertToType(data['signatureUsers'], [SignatureUser]);
  129. }
  130. if (data.hasOwnProperty('stampFormat')) {
  131. obj['stampFormat'] = ApiClient.convertToType(data['stampFormat'], 'String');
  132. }
  133. if (data.hasOwnProperty('stampImageUri')) {
  134. obj['stampImageUri'] = ApiClient.convertToType(data['stampImageUri'], 'String');
  135. }
  136. if (data.hasOwnProperty('stampSizeMM')) {
  137. obj['stampSizeMM'] = ApiClient.convertToType(data['stampSizeMM'], 'String');
  138. }
  139. if (data.hasOwnProperty('stampType')) {
  140. obj['stampType'] = ApiClient.convertToType(data['stampType'], 'String');
  141. }
  142. if (data.hasOwnProperty('status')) {
  143. obj['status'] = ApiClient.convertToType(data['status'], 'String');
  144. }
  145. }
  146. return obj;
  147. }
  148. /**
  149. *
  150. * @member {String} adoptedDateTime
  151. */
  152. exports.prototype['adoptedDateTime'] = undefined;
  153. /**
  154. * Indicates the date and time the item was created.
  155. * @member {String} createdDateTime
  156. */
  157. exports.prototype['createdDateTime'] = undefined;
  158. /**
  159. *
  160. * @member {String} customField
  161. */
  162. exports.prototype['customField'] = undefined;
  163. /**
  164. * Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.
  165. * @member {module:model/DateStampProperties} dateStampProperties
  166. */
  167. exports.prototype['dateStampProperties'] = undefined;
  168. /**
  169. *
  170. * @member {String} disallowUserResizeStamp
  171. */
  172. exports.prototype['disallowUserResizeStamp'] = undefined;
  173. /**
  174. * Array or errors.
  175. * @member {module:model/ErrorDetails} errorDetails
  176. */
  177. exports.prototype['errorDetails'] = undefined;
  178. /**
  179. *
  180. * @member {String} externalID
  181. */
  182. exports.prototype['externalID'] = undefined;
  183. /**
  184. *
  185. * @member {String} imageBase64
  186. */
  187. exports.prototype['imageBase64'] = undefined;
  188. /**
  189. *
  190. * @member {String} imageType
  191. */
  192. exports.prototype['imageType'] = undefined;
  193. /**
  194. *
  195. * @member {String} initials150ImageId
  196. */
  197. exports.prototype['initials150ImageId'] = undefined;
  198. /**
  199. * Contains the URI for an endpoint that you can use to retrieve the initials image.
  200. * @member {String} initialsImageUri
  201. */
  202. exports.prototype['initialsImageUri'] = undefined;
  203. /**
  204. *
  205. * @member {String} isDefault
  206. */
  207. exports.prototype['isDefault'] = undefined;
  208. /**
  209. * The date and time the item was last modified.
  210. * @member {String} lastModifiedDateTime
  211. */
  212. exports.prototype['lastModifiedDateTime'] = undefined;
  213. /**
  214. *
  215. * @member {String} nrdsId
  216. */
  217. exports.prototype['nrdsId'] = undefined;
  218. /**
  219. *
  220. * @member {String} nrdsLastName
  221. */
  222. exports.prototype['nrdsLastName'] = undefined;
  223. /**
  224. *
  225. * @member {String} nrdsStatus
  226. */
  227. exports.prototype['nrdsStatus'] = undefined;
  228. /**
  229. *
  230. * @member {String} phoneticName
  231. */
  232. exports.prototype['phoneticName'] = undefined;
  233. /**
  234. *
  235. * @member {String} signature150ImageId
  236. */
  237. exports.prototype['signature150ImageId'] = undefined;
  238. /**
  239. *
  240. * @member {String} signatureFont
  241. */
  242. exports.prototype['signatureFont'] = undefined;
  243. /**
  244. *
  245. * @member {Array.<module:model/SignatureGroup>} signatureGroups
  246. */
  247. exports.prototype['signatureGroups'] = undefined;
  248. /**
  249. * Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.
  250. * @member {String} signatureId
  251. */
  252. exports.prototype['signatureId'] = undefined;
  253. /**
  254. * Contains the URI for an endpoint that you can use to retrieve the signature image.
  255. * @member {String} signatureImageUri
  256. */
  257. exports.prototype['signatureImageUri'] = undefined;
  258. /**
  259. *
  260. * @member {String} signatureInitials
  261. */
  262. exports.prototype['signatureInitials'] = undefined;
  263. /**
  264. * Specifies the user signature name.
  265. * @member {String} signatureName
  266. */
  267. exports.prototype['signatureName'] = undefined;
  268. /**
  269. *
  270. * @member {String} signatureRights
  271. */
  272. exports.prototype['signatureRights'] = undefined;
  273. /**
  274. *
  275. * @member {String} signatureType
  276. */
  277. exports.prototype['signatureType'] = undefined;
  278. /**
  279. *
  280. * @member {Array.<module:model/SignatureUser>} signatureUsers
  281. */
  282. exports.prototype['signatureUsers'] = undefined;
  283. /**
  284. *
  285. * @member {String} stampFormat
  286. */
  287. exports.prototype['stampFormat'] = undefined;
  288. /**
  289. *
  290. * @member {String} stampImageUri
  291. */
  292. exports.prototype['stampImageUri'] = undefined;
  293. /**
  294. *
  295. * @member {String} stampSizeMM
  296. */
  297. exports.prototype['stampSizeMM'] = undefined;
  298. /**
  299. *
  300. * @member {String} stampType
  301. */
  302. exports.prototype['stampType'] = undefined;
  303. /**
  304. * 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.
  305. * @member {String} status
  306. */
  307. exports.prototype['status'] = undefined;
  308. return exports;
  309. }));