docspring 3.3.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +65 -63
  3. package/dist/ApiClient.js +63 -28
  4. package/dist/RequestSchemas.js +2297 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1346 -948
  7. package/dist/index.js +651 -154
  8. package/dist/model/AiFieldNamingLanguage.js +64 -0
  9. package/dist/model/{CreateWebhookData.js → AuthenticationCheck.js} +32 -28
  10. package/dist/model/BarcodeSymbology.js +89 -0
  11. package/dist/model/CheckCharacter.js +74 -0
  12. package/dist/model/CombinedFieldType.js +59 -0
  13. package/dist/model/CombinedPdf.js +294 -0
  14. package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +27 -27
  15. package/dist/model/CombinedPdfList.js +132 -0
  16. package/dist/model/{ForbiddenErrorResponse.js → CombinedPdfSource.js} +59 -73
  17. package/dist/model/CombinedPdfSourceInput.js +270 -0
  18. package/dist/model/CombinedPdfSourcePdf.js +130 -0
  19. package/dist/model/CombinedPdfSourceType.js +74 -0
  20. package/dist/model/CombinedPdfState.js +74 -0
  21. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +26 -22
  22. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +69 -53
  23. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +25 -23
  24. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +47 -28
  25. package/dist/model/{TemplateDeleteResponse.js → CreateSignatureRequestEventRequest.js} +49 -74
  26. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  27. package/dist/model/{SubmissionBatchData.js → CreateSubmissionBatchRequest.js} +67 -42
  28. package/dist/model/CreateSubmissionRequest.js +212 -0
  29. package/dist/model/CreateTemplateRequest.js +545 -0
  30. package/dist/model/CreateWebhookRequest.js +234 -0
  31. package/dist/model/CustomFile.js +67 -16
  32. package/dist/model/CustomFileList.js +132 -0
  33. package/dist/model/CustomFileSourcePdf.js +130 -0
  34. package/dist/model/ErrorCode.js +154 -0
  35. package/dist/model/{CreateSubmissionResponse.js → ErrorDetail.js} +65 -75
  36. package/dist/model/ErrorInfo.js +211 -0
  37. package/dist/model/ErrorResponse.js +12 -41
  38. package/dist/model/ExpirationInterval.js +64 -0
  39. package/dist/model/FieldComparisonCondition.js +137 -0
  40. package/dist/model/FieldComparisonOperator.js +69 -0
  41. package/dist/model/FieldDisplayType.js +79 -0
  42. package/dist/model/{MultipleErrorsResponse.js → FieldEqualsCondition.js} +48 -52
  43. package/dist/model/FieldEqualsOperator.js +59 -0
  44. package/dist/model/{SuccessMultipleErrorsResponse.js → FieldInCondition.js} +54 -53
  45. package/dist/model/FieldOverride.js +722 -0
  46. package/dist/model/FieldPresenceCondition.js +126 -0
  47. package/dist/model/FieldPresenceOperator.js +59 -0
  48. package/dist/model/FieldRangeCondition.js +148 -0
  49. package/dist/model/FieldReimportState.js +69 -0
  50. package/dist/model/FieldSetupLogic.js +59 -0
  51. package/dist/model/FieldSetupNaming.js +59 -0
  52. package/dist/model/FieldSetupSource.js +64 -0
  53. package/dist/model/Folder.js +38 -11
  54. package/dist/model/FolderList.js +132 -0
  55. package/dist/model/GeneratedFile.js +214 -0
  56. package/dist/model/GeneratedFileState.js +64 -0
  57. package/dist/model/HtmlEngineOptions.js +230 -0
  58. package/dist/model/HtmlEngineOptionsInput.js +193 -0
  59. package/dist/model/ImageGravity.js +94 -0
  60. package/dist/model/ImageScaleType.js +64 -0
  61. package/dist/model/ModelCodeLanguage.js +94 -0
  62. package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +34 -28
  63. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +25 -35
  64. package/dist/model/NumberConditionType.js +79 -0
  65. package/dist/model/PageFormat.js +114 -0
  66. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +33 -33
  67. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +25 -23
  68. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +25 -23
  69. package/dist/model/ShapeType.js +79 -0
  70. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +165 -240
  71. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  72. package/dist/model/SignatureRequestAuthType.js +84 -0
  73. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +67 -149
  74. package/dist/model/SignatureRequestEventType.js +79 -0
  75. package/dist/model/SignatureRequestInput.js +278 -0
  76. package/dist/model/SignatureRequestMessageType.js +94 -0
  77. package/dist/model/SignatureRequestState.js +64 -0
  78. package/dist/model/SignatureRequestToken.js +195 -0
  79. package/dist/model/SignatureRequestTokenType.js +59 -0
  80. package/dist/model/StringConditionType.js +74 -0
  81. package/dist/model/Submission.js +186 -345
  82. package/dist/model/SubmissionAction.js +30 -115
  83. package/dist/model/SubmissionActionState.js +69 -0
  84. package/dist/model/SubmissionActionType.js +84 -0
  85. package/dist/model/SubmissionBatch.js +74 -55
  86. package/dist/model/SubmissionBatchState.js +64 -0
  87. package/dist/model/SubmissionFiles.js +108 -0
  88. package/dist/model/SubmissionInput.js +204 -0
  89. package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +35 -42
  90. package/dist/model/SubmissionSource.js +69 -0
  91. package/dist/model/SubmissionSourcePdf.js +130 -0
  92. package/dist/model/SubmissionState.js +114 -0
  93. package/dist/model/Template.js +310 -573
  94. package/dist/model/TemplateActor.js +171 -0
  95. package/dist/model/TemplateActorType.js +64 -0
  96. package/dist/model/TemplateDefaults.js +307 -0
  97. package/dist/model/TemplateDefaultsInput.js +305 -0
  98. package/dist/model/TemplateDocument.js +280 -0
  99. package/dist/model/TemplateDocumentState.js +74 -0
  100. package/dist/model/{CreatePdfSubmissionData.js → TemplateFieldDependency.js} +70 -89
  101. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  102. package/dist/model/{TemplatePublishVersionResponse.js → TemplateFieldDependencyCondition.js} +51 -61
  103. package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
  104. package/dist/model/TemplateFieldDependencyInput.js +182 -0
  105. package/dist/model/TemplateFieldDependencyMatch.js +59 -0
  106. package/dist/model/TemplateFieldDependencyOperator.js +99 -0
  107. package/dist/model/TemplateFieldLogicStatus.js +74 -0
  108. package/dist/model/TemplateFormMode.js +64 -0
  109. package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +34 -86
  110. package/dist/model/TemplatePageAiError.js +69 -0
  111. package/dist/model/TemplatePageAiNamingStatus.js +59 -0
  112. package/dist/model/TemplatePageFieldsStatus.js +74 -0
  113. package/dist/model/TemplatePageImageStatus.js +59 -0
  114. package/dist/model/TemplatePageProcessingStatus.js +162 -0
  115. package/dist/model/{SubmissionDataRequestToken.js → TemplateSourcePdf.js} +52 -56
  116. package/dist/model/TemplateSummary.js +560 -0
  117. package/dist/model/{SuccessErrorResponse.js → TemplateSummaryList.js} +43 -55
  118. package/dist/model/TemplateType.js +59 -0
  119. package/dist/model/{Submission422Response.js → TemplateVersion.js} +60 -63
  120. package/dist/model/TemplateVersionType.js +64 -0
  121. package/dist/model/TextAlignment.js +69 -0
  122. package/dist/model/TextOverflow.js +59 -0
  123. package/dist/model/TextVerticalAlignment.js +64 -0
  124. package/dist/model/Typeface.js +134 -0
  125. package/dist/model/UpdateSignatureRequestRequest.js +183 -0
  126. package/dist/model/UpdateTemplateDocumentRequest.js +136 -0
  127. package/dist/model/UpdateTemplateRequest.js +450 -0
  128. package/dist/model/UpdateWebhookRequest.js +209 -0
  129. package/dist/model/UploadMethod.js +54 -0
  130. package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +53 -58
  131. package/dist/model/{AddFieldsData.js → UrlSourcePdf.js} +49 -31
  132. package/dist/model/Webhook.js +58 -73
  133. package/dist/model/WebhookEventType.js +174 -0
  134. package/dist/model/WebhookList.js +132 -0
  135. package/dist/model/WebhookMode.js +59 -0
  136. package/package.json +1 -1
  137. package/dist/model/BatchGeneratePdfs201Response.js +0 -194
  138. package/dist/model/CombinedSubmission.js +0 -313
  139. package/dist/model/CombinedSubmissionAction.js +0 -268
  140. package/dist/model/CreateCombinedSubmissionResponse.js +0 -180
  141. package/dist/model/CreateCustomFileResponse.js +0 -167
  142. package/dist/model/CreateHtmlTemplate.js +0 -108
  143. package/dist/model/CreatePdfTemplate.js +0 -108
  144. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  145. package/dist/model/CreateSubmissionDataRequestEventRequest.js +0 -239
  146. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -167
  147. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -167
  148. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -167
  149. package/dist/model/ErrorOrMultipleErrorsResponse.js +0 -153
  150. package/dist/model/JsonSchema.js +0 -205
  151. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  152. package/dist/model/SubmissionDataRequest.js +0 -496
  153. package/dist/model/SubmissionPreview.js +0 -509
  154. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  155. package/dist/model/TemplatePreview.js +0 -796
  156. package/dist/model/UpdateHtmlTemplate.js +0 -108
  157. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  158. package/dist/model/UpdateWebhookData.js +0 -108
@@ -5,6 +5,9 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _SignatureRequestAuthSecondFactorType = _interopRequireDefault(require("./SignatureRequestAuthSecondFactorType"));
9
+ var _SignatureRequestAuthType = _interopRequireDefault(require("./SignatureRequestAuthType"));
10
+ var _SignatureRequestState = _interopRequireDefault(require("./SignatureRequestState"));
8
11
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
12
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
13
  function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
@@ -16,9 +19,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
19
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
20
  function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
21
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
22
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
23
  *
21
- * The version of the OpenAPI document: v1
24
+ * The version of the OpenAPI document: v2
22
25
  *
23
26
  *
24
27
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,42 +30,45 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
30
  *
28
31
  */
29
32
  /**
30
- * The SubmissionDataRequestShow model module.
31
- * @module model/SubmissionDataRequestShow
32
- * @version 3.3.0
33
+ * The SignatureRequest model module.
34
+ * @module model/SignatureRequest
35
+ * @version 4.0.0
33
36
  */
34
- var SubmissionDataRequestShow = /*#__PURE__*/function () {
37
+ var SignatureRequest = /*#__PURE__*/function () {
35
38
  /**
36
- * Constructs a new <code>SubmissionDataRequestShow</code>.
37
- * @alias module:model/SubmissionDataRequestShow
39
+ * Constructs a new <code>SignatureRequest</code>.
40
+ * A request for someone to fill in their fields of a submission and sign it. Someone who only fills in fields for the people who sign later (such as an employer's section) has a signature request too. The submission's PDF is generated once every signature request is completed.
41
+ * @alias module:model/SignatureRequest
38
42
  * @extends Object
39
- * @param id {String}
40
- * @param email {String}
41
- * @param name {String}
42
- * @param order {Number}
43
- * @param sort_order {Number}
44
- * @param fields {Array.<String>}
45
- * @param metadata {Object}
46
- * @param state {module:model/SubmissionDataRequestShow.StateEnum}
47
- * @param viewed_at {String}
48
- * @param completed_at {String}
49
- * @param declined_at {String}
50
- * @param data {Object}
51
- * @param auth_type {module:model/SubmissionDataRequestShow.AuthTypeEnum}
52
- * @param auth_second_factor_type {module:model/SubmissionDataRequestShow.AuthSecondFactorTypeEnum}
53
- * @param auth_provider {String}
54
- * @param auth_session_started_at {String}
55
- * @param auth_session_id_hash {String}
56
- * @param auth_user_id_hash {String}
57
- * @param auth_username_hash {String}
58
- * @param auth_phone_number_hash {String}
59
- * @param ip_address {String}
60
- * @param user_agent {String}
61
- * @param submission_id {String}
43
+ * @param id {String} The signature request's ID.
44
+ * @param submission_id {String} The ID of the submission the signature request belongs to.
45
+ * @param name {String} The name of the person the request is for.
46
+ * @param email {String} Their email address.
47
+ * @param fields {Array.<String>} The fields this person fills in. Null for a signature request created with API v1 without a field list: it asks for every field the submission's data doesn't have.
48
+ * @param metadata {Object.<String, Object>} Your own data about the signature request, such as an ID from your app.
49
+ * @param role {String} Which of the template's signers the person is. Until templates have roles of their own, a template's signers are `Signer 1`, `Signer 2` and so on, up to `Signer 100`: `Signer 1` is the one whose details the template's `@@signature_requests/0` fields print.
50
+ * @param sort_order {Number} The signer's position, from 0: `Signer 1` is 0. The template's `@@signature_requests/<sort_order>` fields print this signature request's details.
51
+ * @param state {module:model/SignatureRequestState} `pending` until the person completes the signature request (`completed`) or declines it (`declined`).
52
+ * @param data {Object.<String, Object>} The values this person entered for their own fields (`fields`). Null when their submission's data is left out: in lists without `include_data=true`, in the events of a webhook that leaves out submission data, and once the submission has expired.
53
+ * @param viewed_at {Date} When the person first opened the signature request.
54
+ * @param completed_at {Date} When they completed it.
55
+ * @param declined_at {Date} When they declined it.
56
+ * @param auth_type {module:model/SignatureRequestAuthType} How your app authenticated the person before it showed them the signature request.
57
+ * @param auth_second_factor_type {module:model/SignatureRequestAuthSecondFactorType} The second factor your app authenticated them with, if any.
58
+ * @param auth_provider {String} The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`.
59
+ * @param auth_session_started_at {Date} When your app authenticated them. Set for you with `email_link`.
60
+ * @param auth_session_id_hash {String} A hash of your app's session ID, for the audit trail.
61
+ * @param auth_user_id_hash {String} Their user ID in your app, or a SHA-256 hash of a salt and the user ID.
62
+ * @param auth_username_hash {String} Their username in your app, or a SHA-256 hash of a salt and the username.
63
+ * @param auth_phone_number_hash {String} The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number.
64
+ * @param ip_address {String} The IP address they completed the signature request from. Null in the events of a webhook that leaves out submission data.
65
+ * @param user_agent {String} The User-Agent header of the browser they completed the signature request with. Null in the events of a webhook that leaves out submission data.
66
+ * @param created_at {Date} When the signature request was created.
67
+ * @param updated_at {Date} When the signature request was last updated.
62
68
  */
63
- function SubmissionDataRequestShow(id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, declined_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, submission_id) {
64
- _classCallCheck(this, SubmissionDataRequestShow);
65
- SubmissionDataRequestShow.initialize(this, id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, declined_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, submission_id);
69
+ function SignatureRequest(id, submission_id, name, email, fields, metadata, role, sort_order, state, data, viewed_at, completed_at, declined_at, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, created_at, updated_at) {
70
+ _classCallCheck(this, SignatureRequest);
71
+ SignatureRequest.initialize(this, id, submission_id, name, email, fields, metadata, role, sort_order, state, data, viewed_at, completed_at, declined_at, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, created_at, updated_at);
66
72
  }
67
73
 
68
74
  /**
@@ -70,21 +76,22 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
70
76
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
71
77
  * Only for internal use.
72
78
  */
73
- return _createClass(SubmissionDataRequestShow, null, [{
79
+ return _createClass(SignatureRequest, null, [{
74
80
  key: "initialize",
75
- value: function initialize(obj, id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, declined_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, submission_id) {
81
+ value: function initialize(obj, id, submission_id, name, email, fields, metadata, role, sort_order, state, data, viewed_at, completed_at, declined_at, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, created_at, updated_at) {
76
82
  obj['id'] = id;
77
- obj['email'] = email;
83
+ obj['submission_id'] = submission_id;
78
84
  obj['name'] = name;
79
- obj['order'] = order;
80
- obj['sort_order'] = sort_order;
85
+ obj['email'] = email;
81
86
  obj['fields'] = fields;
82
87
  obj['metadata'] = metadata;
88
+ obj['role'] = role;
89
+ obj['sort_order'] = sort_order;
83
90
  obj['state'] = state;
91
+ obj['data'] = data;
84
92
  obj['viewed_at'] = viewed_at;
85
93
  obj['completed_at'] = completed_at;
86
94
  obj['declined_at'] = declined_at;
87
- obj['data'] = data;
88
95
  obj['auth_type'] = auth_type;
89
96
  obj['auth_second_factor_type'] = auth_second_factor_type;
90
97
  obj['auth_provider'] = auth_provider;
@@ -95,69 +102,77 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
95
102
  obj['auth_phone_number_hash'] = auth_phone_number_hash;
96
103
  obj['ip_address'] = ip_address;
97
104
  obj['user_agent'] = user_agent;
98
- obj['submission_id'] = submission_id;
105
+ obj['created_at'] = created_at;
106
+ obj['updated_at'] = updated_at;
99
107
  }
100
108
 
101
109
  /**
102
- * Constructs a <code>SubmissionDataRequestShow</code> from a plain JavaScript object, optionally creating a new instance.
110
+ * Constructs a <code>SignatureRequest</code> from a plain JavaScript object, optionally creating a new instance.
103
111
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
104
112
  * @param {Object} data The plain JavaScript object bearing properties of interest.
105
- * @param {module:model/SubmissionDataRequestShow} obj Optional instance to populate.
106
- * @return {module:model/SubmissionDataRequestShow} The populated <code>SubmissionDataRequestShow</code> instance.
113
+ * @param {module:model/SignatureRequest} obj Optional instance to populate.
114
+ * @return {module:model/SignatureRequest} The populated <code>SignatureRequest</code> instance.
107
115
  */
108
116
  }, {
109
117
  key: "constructFromObject",
110
118
  value: function constructFromObject(data, obj) {
111
119
  if (data) {
112
- obj = obj || new SubmissionDataRequestShow();
120
+ obj = obj || new SignatureRequest();
113
121
  _ApiClient["default"].constructFromObject(data, obj, 'Object');
114
122
  if (data.hasOwnProperty('id')) {
115
123
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
116
124
  }
117
- if (data.hasOwnProperty('email')) {
118
- obj['email'] = _ApiClient["default"].convertToType(data['email'], 'String');
125
+ if (data.hasOwnProperty('submission_id')) {
126
+ obj['submission_id'] = _ApiClient["default"].convertToType(data['submission_id'], 'String');
119
127
  }
120
128
  if (data.hasOwnProperty('name')) {
121
129
  obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
122
130
  }
123
- if (data.hasOwnProperty('order')) {
124
- obj['order'] = _ApiClient["default"].convertToType(data['order'], 'Number');
125
- }
126
- if (data.hasOwnProperty('sort_order')) {
127
- obj['sort_order'] = _ApiClient["default"].convertToType(data['sort_order'], 'Number');
131
+ if (data.hasOwnProperty('email')) {
132
+ obj['email'] = _ApiClient["default"].convertToType(data['email'], 'String');
128
133
  }
129
134
  if (data.hasOwnProperty('fields')) {
130
135
  obj['fields'] = _ApiClient["default"].convertToType(data['fields'], ['String']);
131
136
  }
132
137
  if (data.hasOwnProperty('metadata')) {
133
- obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
138
+ obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
139
+ 'String': Object
140
+ });
141
+ }
142
+ if (data.hasOwnProperty('role')) {
143
+ obj['role'] = _ApiClient["default"].convertToType(data['role'], 'String');
144
+ }
145
+ if (data.hasOwnProperty('sort_order')) {
146
+ obj['sort_order'] = _ApiClient["default"].convertToType(data['sort_order'], 'Number');
134
147
  }
135
148
  if (data.hasOwnProperty('state')) {
136
- obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
149
+ obj['state'] = _ApiClient["default"].convertToType(data['state'], _SignatureRequestState["default"]);
150
+ }
151
+ if (data.hasOwnProperty('data')) {
152
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], {
153
+ 'String': Object
154
+ });
137
155
  }
138
156
  if (data.hasOwnProperty('viewed_at')) {
139
- obj['viewed_at'] = _ApiClient["default"].convertToType(data['viewed_at'], 'String');
157
+ obj['viewed_at'] = _ApiClient["default"].convertToType(data['viewed_at'], 'Date');
140
158
  }
141
159
  if (data.hasOwnProperty('completed_at')) {
142
- obj['completed_at'] = _ApiClient["default"].convertToType(data['completed_at'], 'String');
160
+ obj['completed_at'] = _ApiClient["default"].convertToType(data['completed_at'], 'Date');
143
161
  }
144
162
  if (data.hasOwnProperty('declined_at')) {
145
- obj['declined_at'] = _ApiClient["default"].convertToType(data['declined_at'], 'String');
146
- }
147
- if (data.hasOwnProperty('data')) {
148
- obj['data'] = _ApiClient["default"].convertToType(data['data'], Object);
163
+ obj['declined_at'] = _ApiClient["default"].convertToType(data['declined_at'], 'Date');
149
164
  }
150
165
  if (data.hasOwnProperty('auth_type')) {
151
- obj['auth_type'] = _ApiClient["default"].convertToType(data['auth_type'], 'String');
166
+ obj['auth_type'] = _ApiClient["default"].convertToType(data['auth_type'], _SignatureRequestAuthType["default"]);
152
167
  }
153
168
  if (data.hasOwnProperty('auth_second_factor_type')) {
154
- obj['auth_second_factor_type'] = _ApiClient["default"].convertToType(data['auth_second_factor_type'], 'String');
169
+ obj['auth_second_factor_type'] = _ApiClient["default"].convertToType(data['auth_second_factor_type'], _SignatureRequestAuthSecondFactorType["default"]);
155
170
  }
156
171
  if (data.hasOwnProperty('auth_provider')) {
157
172
  obj['auth_provider'] = _ApiClient["default"].convertToType(data['auth_provider'], 'String');
158
173
  }
159
174
  if (data.hasOwnProperty('auth_session_started_at')) {
160
- obj['auth_session_started_at'] = _ApiClient["default"].convertToType(data['auth_session_started_at'], 'String');
175
+ obj['auth_session_started_at'] = _ApiClient["default"].convertToType(data['auth_session_started_at'], 'Date');
161
176
  }
162
177
  if (data.hasOwnProperty('auth_session_id_hash')) {
163
178
  obj['auth_session_id_hash'] = _ApiClient["default"].convertToType(data['auth_session_id_hash'], 'String');
@@ -177,23 +192,26 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
177
192
  if (data.hasOwnProperty('user_agent')) {
178
193
  obj['user_agent'] = _ApiClient["default"].convertToType(data['user_agent'], 'String');
179
194
  }
180
- if (data.hasOwnProperty('submission_id')) {
181
- obj['submission_id'] = _ApiClient["default"].convertToType(data['submission_id'], 'String');
195
+ if (data.hasOwnProperty('created_at')) {
196
+ obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
197
+ }
198
+ if (data.hasOwnProperty('updated_at')) {
199
+ obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
182
200
  }
183
201
  }
184
202
  return obj;
185
203
  }
186
204
 
187
205
  /**
188
- * Validates the JSON data with respect to <code>SubmissionDataRequestShow</code>.
206
+ * Validates the JSON data with respect to <code>SignatureRequest</code>.
189
207
  * @param {Object} data The plain JavaScript object bearing properties of interest.
190
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SubmissionDataRequestShow</code>.
208
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SignatureRequest</code>.
191
209
  */
192
210
  }, {
193
211
  key: "validateJSON",
194
212
  value: function validateJSON(data) {
195
213
  // check to make sure all required properties are present in the JSON string
196
- var _iterator = _createForOfIteratorHelper(SubmissionDataRequestShow.RequiredProperties),
214
+ var _iterator = _createForOfIteratorHelper(SignatureRequest.RequiredProperties),
197
215
  _step;
198
216
  try {
199
217
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -212,50 +230,30 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
212
230
  throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
213
231
  }
214
232
  // ensure the json data is a string
215
- if (data['email'] && !(typeof data['email'] === 'string' || data['email'] instanceof String)) {
216
- throw new Error("Expected the field `email` to be a primitive type in the JSON string but got " + data['email']);
233
+ if (data['submission_id'] && !(typeof data['submission_id'] === 'string' || data['submission_id'] instanceof String)) {
234
+ throw new Error("Expected the field `submission_id` to be a primitive type in the JSON string but got " + data['submission_id']);
217
235
  }
218
236
  // ensure the json data is a string
219
237
  if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
220
238
  throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
221
239
  }
240
+ // ensure the json data is a string
241
+ if (data['email'] && !(typeof data['email'] === 'string' || data['email'] instanceof String)) {
242
+ throw new Error("Expected the field `email` to be a primitive type in the JSON string but got " + data['email']);
243
+ }
222
244
  // ensure the json data is an array
223
245
  if (!Array.isArray(data['fields'])) {
224
246
  throw new Error("Expected the field `fields` to be an array in the JSON data but got " + data['fields']);
225
247
  }
226
248
  // ensure the json data is a string
227
- if (data['state'] && !(typeof data['state'] === 'string' || data['state'] instanceof String)) {
228
- throw new Error("Expected the field `state` to be a primitive type in the JSON string but got " + data['state']);
229
- }
230
- // ensure the json data is a string
231
- if (data['viewed_at'] && !(typeof data['viewed_at'] === 'string' || data['viewed_at'] instanceof String)) {
232
- throw new Error("Expected the field `viewed_at` to be a primitive type in the JSON string but got " + data['viewed_at']);
233
- }
234
- // ensure the json data is a string
235
- if (data['completed_at'] && !(typeof data['completed_at'] === 'string' || data['completed_at'] instanceof String)) {
236
- throw new Error("Expected the field `completed_at` to be a primitive type in the JSON string but got " + data['completed_at']);
237
- }
238
- // ensure the json data is a string
239
- if (data['declined_at'] && !(typeof data['declined_at'] === 'string' || data['declined_at'] instanceof String)) {
240
- throw new Error("Expected the field `declined_at` to be a primitive type in the JSON string but got " + data['declined_at']);
241
- }
242
- // ensure the json data is a string
243
- if (data['auth_type'] && !(typeof data['auth_type'] === 'string' || data['auth_type'] instanceof String)) {
244
- throw new Error("Expected the field `auth_type` to be a primitive type in the JSON string but got " + data['auth_type']);
245
- }
246
- // ensure the json data is a string
247
- if (data['auth_second_factor_type'] && !(typeof data['auth_second_factor_type'] === 'string' || data['auth_second_factor_type'] instanceof String)) {
248
- throw new Error("Expected the field `auth_second_factor_type` to be a primitive type in the JSON string but got " + data['auth_second_factor_type']);
249
+ if (data['role'] && !(typeof data['role'] === 'string' || data['role'] instanceof String)) {
250
+ throw new Error("Expected the field `role` to be a primitive type in the JSON string but got " + data['role']);
249
251
  }
250
252
  // ensure the json data is a string
251
253
  if (data['auth_provider'] && !(typeof data['auth_provider'] === 'string' || data['auth_provider'] instanceof String)) {
252
254
  throw new Error("Expected the field `auth_provider` to be a primitive type in the JSON string but got " + data['auth_provider']);
253
255
  }
254
256
  // ensure the json data is a string
255
- if (data['auth_session_started_at'] && !(typeof data['auth_session_started_at'] === 'string' || data['auth_session_started_at'] instanceof String)) {
256
- throw new Error("Expected the field `auth_session_started_at` to be a primitive type in the JSON string but got " + data['auth_session_started_at']);
257
- }
258
- // ensure the json data is a string
259
257
  if (data['auth_session_id_hash'] && !(typeof data['auth_session_id_hash'] === 'string' || data['auth_session_id_hash'] instanceof String)) {
260
258
  throw new Error("Expected the field `auth_session_id_hash` to be a primitive type in the JSON string but got " + data['auth_session_id_hash']);
261
259
  }
@@ -279,232 +277,159 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
279
277
  if (data['user_agent'] && !(typeof data['user_agent'] === 'string' || data['user_agent'] instanceof String)) {
280
278
  throw new Error("Expected the field `user_agent` to be a primitive type in the JSON string but got " + data['user_agent']);
281
279
  }
282
- // ensure the json data is a string
283
- if (data['submission_id'] && !(typeof data['submission_id'] === 'string' || data['submission_id'] instanceof String)) {
284
- throw new Error("Expected the field `submission_id` to be a primitive type in the JSON string but got " + data['submission_id']);
285
- }
286
280
  return true;
287
281
  }
288
282
  }]);
289
283
  }();
290
- SubmissionDataRequestShow.RequiredProperties = ["id", "email", "name", "order", "sort_order", "fields", "metadata", "state", "viewed_at", "completed_at", "declined_at", "data", "auth_type", "auth_second_factor_type", "auth_provider", "auth_session_started_at", "auth_session_id_hash", "auth_user_id_hash", "auth_username_hash", "auth_phone_number_hash", "ip_address", "user_agent", "submission_id"];
284
+ SignatureRequest.RequiredProperties = ["id", "submission_id", "name", "email", "fields", "metadata", "role", "sort_order", "state", "data", "viewed_at", "completed_at", "declined_at", "auth_type", "auth_second_factor_type", "auth_provider", "auth_session_started_at", "auth_session_id_hash", "auth_user_id_hash", "auth_username_hash", "auth_phone_number_hash", "ip_address", "user_agent", "created_at", "updated_at"];
291
285
 
292
286
  /**
287
+ * The signature request's ID.
293
288
  * @member {String} id
294
289
  */
295
- SubmissionDataRequestShow.prototype['id'] = undefined;
290
+ SignatureRequest.prototype['id'] = undefined;
296
291
 
297
292
  /**
298
- * @member {String} email
293
+ * The ID of the submission the signature request belongs to.
294
+ * @member {String} submission_id
299
295
  */
300
- SubmissionDataRequestShow.prototype['email'] = undefined;
296
+ SignatureRequest.prototype['submission_id'] = undefined;
301
297
 
302
298
  /**
299
+ * The name of the person the request is for.
303
300
  * @member {String} name
304
301
  */
305
- SubmissionDataRequestShow.prototype['name'] = undefined;
302
+ SignatureRequest.prototype['name'] = undefined;
306
303
 
307
304
  /**
308
- * @member {Number} order
305
+ * Their email address.
306
+ * @member {String} email
309
307
  */
310
- SubmissionDataRequestShow.prototype['order'] = undefined;
308
+ SignatureRequest.prototype['email'] = undefined;
311
309
 
312
310
  /**
313
- * @member {Number} sort_order
311
+ * The fields this person fills in. Null for a signature request created with API v1 without a field list: it asks for every field the submission's data doesn't have.
312
+ * @member {Array.<String>} fields
314
313
  */
315
- SubmissionDataRequestShow.prototype['sort_order'] = undefined;
314
+ SignatureRequest.prototype['fields'] = undefined;
316
315
 
317
316
  /**
318
- * @member {Array.<String>} fields
317
+ * Your own data about the signature request, such as an ID from your app.
318
+ * @member {Object.<String, Object>} metadata
319
319
  */
320
- SubmissionDataRequestShow.prototype['fields'] = undefined;
320
+ SignatureRequest.prototype['metadata'] = undefined;
321
321
 
322
322
  /**
323
- * @member {Object} metadata
323
+ * Which of the template's signers the person is. Until templates have roles of their own, a template's signers are `Signer 1`, `Signer 2` and so on, up to `Signer 100`: `Signer 1` is the one whose details the template's `@@signature_requests/0` fields print.
324
+ * @member {String} role
324
325
  */
325
- SubmissionDataRequestShow.prototype['metadata'] = undefined;
326
+ SignatureRequest.prototype['role'] = undefined;
326
327
 
327
328
  /**
328
- * @member {module:model/SubmissionDataRequestShow.StateEnum} state
329
+ * The signer's position, from 0: `Signer 1` is 0. The template's `@@signature_requests/<sort_order>` fields print this signature request's details.
330
+ * @member {Number} sort_order
331
+ */
332
+ SignatureRequest.prototype['sort_order'] = undefined;
333
+
334
+ /**
335
+ * `pending` until the person completes the signature request (`completed`) or declines it (`declined`).
336
+ * @member {module:model/SignatureRequestState} state
329
337
  */
330
- SubmissionDataRequestShow.prototype['state'] = undefined;
338
+ SignatureRequest.prototype['state'] = undefined;
331
339
 
332
340
  /**
333
- * @member {String} viewed_at
341
+ * The values this person entered for their own fields (`fields`). Null when their submission's data is left out: in lists without `include_data=true`, in the events of a webhook that leaves out submission data, and once the submission has expired.
342
+ * @member {Object.<String, Object>} data
334
343
  */
335
- SubmissionDataRequestShow.prototype['viewed_at'] = undefined;
344
+ SignatureRequest.prototype['data'] = undefined;
336
345
 
337
346
  /**
338
- * @member {String} completed_at
347
+ * When the person first opened the signature request.
348
+ * @member {Date} viewed_at
339
349
  */
340
- SubmissionDataRequestShow.prototype['completed_at'] = undefined;
350
+ SignatureRequest.prototype['viewed_at'] = undefined;
341
351
 
342
352
  /**
343
- * @member {String} declined_at
353
+ * When they completed it.
354
+ * @member {Date} completed_at
344
355
  */
345
- SubmissionDataRequestShow.prototype['declined_at'] = undefined;
356
+ SignatureRequest.prototype['completed_at'] = undefined;
346
357
 
347
358
  /**
348
- * @member {Object} data
359
+ * When they declined it.
360
+ * @member {Date} declined_at
349
361
  */
350
- SubmissionDataRequestShow.prototype['data'] = undefined;
362
+ SignatureRequest.prototype['declined_at'] = undefined;
351
363
 
352
364
  /**
353
- * @member {module:model/SubmissionDataRequestShow.AuthTypeEnum} auth_type
365
+ * How your app authenticated the person before it showed them the signature request.
366
+ * @member {module:model/SignatureRequestAuthType} auth_type
354
367
  */
355
- SubmissionDataRequestShow.prototype['auth_type'] = undefined;
368
+ SignatureRequest.prototype['auth_type'] = undefined;
356
369
 
357
370
  /**
358
- * @member {module:model/SubmissionDataRequestShow.AuthSecondFactorTypeEnum} auth_second_factor_type
371
+ * The second factor your app authenticated them with, if any.
372
+ * @member {module:model/SignatureRequestAuthSecondFactorType} auth_second_factor_type
359
373
  */
360
- SubmissionDataRequestShow.prototype['auth_second_factor_type'] = undefined;
374
+ SignatureRequest.prototype['auth_second_factor_type'] = undefined;
361
375
 
362
376
  /**
377
+ * The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`.
363
378
  * @member {String} auth_provider
364
379
  */
365
- SubmissionDataRequestShow.prototype['auth_provider'] = undefined;
380
+ SignatureRequest.prototype['auth_provider'] = undefined;
366
381
 
367
382
  /**
368
- * @member {String} auth_session_started_at
383
+ * When your app authenticated them. Set for you with `email_link`.
384
+ * @member {Date} auth_session_started_at
369
385
  */
370
- SubmissionDataRequestShow.prototype['auth_session_started_at'] = undefined;
386
+ SignatureRequest.prototype['auth_session_started_at'] = undefined;
371
387
 
372
388
  /**
389
+ * A hash of your app's session ID, for the audit trail.
373
390
  * @member {String} auth_session_id_hash
374
391
  */
375
- SubmissionDataRequestShow.prototype['auth_session_id_hash'] = undefined;
392
+ SignatureRequest.prototype['auth_session_id_hash'] = undefined;
376
393
 
377
394
  /**
395
+ * Their user ID in your app, or a SHA-256 hash of a salt and the user ID.
378
396
  * @member {String} auth_user_id_hash
379
397
  */
380
- SubmissionDataRequestShow.prototype['auth_user_id_hash'] = undefined;
398
+ SignatureRequest.prototype['auth_user_id_hash'] = undefined;
381
399
 
382
400
  /**
401
+ * Their username in your app, or a SHA-256 hash of a salt and the username.
383
402
  * @member {String} auth_username_hash
384
403
  */
385
- SubmissionDataRequestShow.prototype['auth_username_hash'] = undefined;
404
+ SignatureRequest.prototype['auth_username_hash'] = undefined;
386
405
 
387
406
  /**
407
+ * The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number.
388
408
  * @member {String} auth_phone_number_hash
389
409
  */
390
- SubmissionDataRequestShow.prototype['auth_phone_number_hash'] = undefined;
410
+ SignatureRequest.prototype['auth_phone_number_hash'] = undefined;
391
411
 
392
412
  /**
413
+ * The IP address they completed the signature request from. Null in the events of a webhook that leaves out submission data.
393
414
  * @member {String} ip_address
394
415
  */
395
- SubmissionDataRequestShow.prototype['ip_address'] = undefined;
416
+ SignatureRequest.prototype['ip_address'] = undefined;
396
417
 
397
418
  /**
419
+ * The User-Agent header of the browser they completed the signature request with. Null in the events of a webhook that leaves out submission data.
398
420
  * @member {String} user_agent
399
421
  */
400
- SubmissionDataRequestShow.prototype['user_agent'] = undefined;
422
+ SignatureRequest.prototype['user_agent'] = undefined;
401
423
 
402
424
  /**
403
- * @member {String} submission_id
425
+ * When the signature request was created.
426
+ * @member {Date} created_at
404
427
  */
405
- SubmissionDataRequestShow.prototype['submission_id'] = undefined;
406
-
407
- /**
408
- * Allowed values for the <code>state</code> property.
409
- * @enum {String}
410
- * @readonly
411
- */
412
- SubmissionDataRequestShow['StateEnum'] = {
413
- /**
414
- * value: "pending"
415
- * @const
416
- */
417
- "pending": "pending",
418
- /**
419
- * value: "completed"
420
- * @const
421
- */
422
- "completed": "completed",
423
- /**
424
- * value: "declined"
425
- * @const
426
- */
427
- "declined": "declined"
428
- };
429
-
430
- /**
431
- * Allowed values for the <code>auth_type</code> property.
432
- * @enum {String}
433
- * @readonly
434
- */
435
- SubmissionDataRequestShow['AuthTypeEnum'] = {
436
- /**
437
- * value: "none"
438
- * @const
439
- */
440
- "none": "none",
441
- /**
442
- * value: "password"
443
- * @const
444
- */
445
- "password": "password",
446
- /**
447
- * value: "oauth"
448
- * @const
449
- */
450
- "oauth": "oauth",
451
- /**
452
- * value: "email_link"
453
- * @const
454
- */
455
- "email_link": "email_link",
456
- /**
457
- * value: "phone_number"
458
- * @const
459
- */
460
- "phone_number": "phone_number",
461
- /**
462
- * value: "ldap"
463
- * @const
464
- */
465
- "ldap": "ldap",
466
- /**
467
- * value: "saml"
468
- * @const
469
- */
470
- "saml": "saml"
471
- };
428
+ SignatureRequest.prototype['created_at'] = undefined;
472
429
 
473
430
  /**
474
- * Allowed values for the <code>auth_second_factor_type</code> property.
475
- * @enum {String}
476
- * @readonly
431
+ * When the signature request was last updated.
432
+ * @member {Date} updated_at
477
433
  */
478
- SubmissionDataRequestShow['AuthSecondFactorTypeEnum'] = {
479
- /**
480
- * value: "none"
481
- * @const
482
- */
483
- "none": "none",
484
- /**
485
- * value: "phone_number"
486
- * @const
487
- */
488
- "phone_number": "phone_number",
489
- /**
490
- * value: "totp"
491
- * @const
492
- */
493
- "totp": "totp",
494
- /**
495
- * value: "mobile_push"
496
- * @const
497
- */
498
- "mobile_push": "mobile_push",
499
- /**
500
- * value: "security_key"
501
- * @const
502
- */
503
- "security_key": "security_key",
504
- /**
505
- * value: "fingerprint"
506
- * @const
507
- */
508
- "fingerprint": "fingerprint"
509
- };
510
- var _default = exports["default"] = SubmissionDataRequestShow;
434
+ SignatureRequest.prototype['updated_at'] = undefined;
435
+ var _default = exports["default"] = SignatureRequest;