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,8 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _SubmissionActionState = _interopRequireDefault(require("./SubmissionActionState"));
9
+ var _SubmissionActionType = _interopRequireDefault(require("./SubmissionActionType"));
8
10
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
11
  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
12
  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 +18,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
18
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
19
  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
20
  * 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/).
21
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
22
  *
21
- * The version of the OpenAPI document: v1
23
+ * The version of the OpenAPI document: v2
22
24
  *
23
25
  *
24
26
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,24 +31,24 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
31
  /**
30
32
  * The SubmissionAction model module.
31
33
  * @module model/SubmissionAction
32
- * @version 3.3.0
34
+ * @version 4.0.0
33
35
  */
34
36
  var SubmissionAction = /*#__PURE__*/function () {
35
37
  /**
36
38
  * Constructs a new <code>SubmissionAction</code>.
39
+ * An upload of a PDF to your storage, such as an S3 bucket.
37
40
  * @alias module:model/SubmissionAction
38
41
  * @extends Object
39
- * @param id {String}
40
- * @param integration_id {String}
41
- * @param state {module:model/SubmissionAction.StateEnum}
42
- * @param action_type {module:model/SubmissionAction.ActionTypeEnum}
43
- * @param action_category {module:model/SubmissionAction.ActionCategoryEnum}
44
- * @param result_data {Object}
45
- * @param error_message {String}
42
+ * @param id {String} The upload's ID.
43
+ * @param integration_id {String} The ID of the account integration it used.
44
+ * @param state {module:model/SubmissionActionState} `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring.
45
+ * @param action_type {module:model/SubmissionActionType} The kind of storage, such as `aws_s3_upload` for an S3 bucket.
46
+ * @param result_data {Object.<String, Object>} Where the PDF was uploaded, such as the S3 bucket and key.
47
+ * @param error_message {String} Why the upload failed, when `state` is `failed` or `error`.
46
48
  */
47
- function SubmissionAction(id, integration_id, state, action_type, action_category, result_data, error_message) {
49
+ function SubmissionAction(id, integration_id, state, action_type, result_data, error_message) {
48
50
  _classCallCheck(this, SubmissionAction);
49
- SubmissionAction.initialize(this, id, integration_id, state, action_type, action_category, result_data, error_message);
51
+ SubmissionAction.initialize(this, id, integration_id, state, action_type, result_data, error_message);
50
52
  }
51
53
 
52
54
  /**
@@ -56,12 +58,11 @@ var SubmissionAction = /*#__PURE__*/function () {
56
58
  */
57
59
  return _createClass(SubmissionAction, null, [{
58
60
  key: "initialize",
59
- value: function initialize(obj, id, integration_id, state, action_type, action_category, result_data, error_message) {
61
+ value: function initialize(obj, id, integration_id, state, action_type, result_data, error_message) {
60
62
  obj['id'] = id;
61
63
  obj['integration_id'] = integration_id;
62
64
  obj['state'] = state;
63
65
  obj['action_type'] = action_type;
64
- obj['action_category'] = action_category;
65
66
  obj['result_data'] = result_data;
66
67
  obj['error_message'] = error_message;
67
68
  }
@@ -86,16 +87,15 @@ var SubmissionAction = /*#__PURE__*/function () {
86
87
  obj['integration_id'] = _ApiClient["default"].convertToType(data['integration_id'], 'String');
87
88
  }
88
89
  if (data.hasOwnProperty('state')) {
89
- obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
90
+ obj['state'] = _ApiClient["default"].convertToType(data['state'], _SubmissionActionState["default"]);
90
91
  }
91
92
  if (data.hasOwnProperty('action_type')) {
92
- obj['action_type'] = _ApiClient["default"].convertToType(data['action_type'], 'String');
93
- }
94
- if (data.hasOwnProperty('action_category')) {
95
- obj['action_category'] = _ApiClient["default"].convertToType(data['action_category'], 'String');
93
+ obj['action_type'] = _ApiClient["default"].convertToType(data['action_type'], _SubmissionActionType["default"]);
96
94
  }
97
95
  if (data.hasOwnProperty('result_data')) {
98
- obj['result_data'] = _ApiClient["default"].convertToType(data['result_data'], Object);
96
+ obj['result_data'] = _ApiClient["default"].convertToType(data['result_data'], {
97
+ 'String': Object
98
+ });
99
99
  }
100
100
  if (data.hasOwnProperty('error_message')) {
101
101
  obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
@@ -136,18 +136,6 @@ var SubmissionAction = /*#__PURE__*/function () {
136
136
  throw new Error("Expected the field `integration_id` to be a primitive type in the JSON string but got " + data['integration_id']);
137
137
  }
138
138
  // ensure the json data is a string
139
- if (data['state'] && !(typeof data['state'] === 'string' || data['state'] instanceof String)) {
140
- throw new Error("Expected the field `state` to be a primitive type in the JSON string but got " + data['state']);
141
- }
142
- // ensure the json data is a string
143
- if (data['action_type'] && !(typeof data['action_type'] === 'string' || data['action_type'] instanceof String)) {
144
- throw new Error("Expected the field `action_type` to be a primitive type in the JSON string but got " + data['action_type']);
145
- }
146
- // ensure the json data is a string
147
- if (data['action_category'] && !(typeof data['action_category'] === 'string' || data['action_category'] instanceof String)) {
148
- throw new Error("Expected the field `action_category` to be a primitive type in the JSON string but got " + data['action_category']);
149
- }
150
- // ensure the json data is a string
151
139
  if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
152
140
  throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
153
141
  }
@@ -155,114 +143,41 @@ var SubmissionAction = /*#__PURE__*/function () {
155
143
  }
156
144
  }]);
157
145
  }();
158
- SubmissionAction.RequiredProperties = ["id", "integration_id", "state", "action_type", "action_category", "result_data", "error_message"];
146
+ SubmissionAction.RequiredProperties = ["id", "integration_id", "state", "action_type", "result_data", "error_message"];
159
147
 
160
148
  /**
149
+ * The upload's ID.
161
150
  * @member {String} id
162
151
  */
163
152
  SubmissionAction.prototype['id'] = undefined;
164
153
 
165
154
  /**
155
+ * The ID of the account integration it used.
166
156
  * @member {String} integration_id
167
157
  */
168
158
  SubmissionAction.prototype['integration_id'] = undefined;
169
159
 
170
160
  /**
171
- * @member {module:model/SubmissionAction.StateEnum} state
161
+ * `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring.
162
+ * @member {module:model/SubmissionActionState} state
172
163
  */
173
164
  SubmissionAction.prototype['state'] = undefined;
174
165
 
175
166
  /**
176
- * @member {module:model/SubmissionAction.ActionTypeEnum} action_type
167
+ * The kind of storage, such as `aws_s3_upload` for an S3 bucket.
168
+ * @member {module:model/SubmissionActionType} action_type
177
169
  */
178
170
  SubmissionAction.prototype['action_type'] = undefined;
179
171
 
180
172
  /**
181
- * @member {module:model/SubmissionAction.ActionCategoryEnum} action_category
182
- */
183
- SubmissionAction.prototype['action_category'] = undefined;
184
-
185
- /**
186
- * @member {Object} result_data
173
+ * Where the PDF was uploaded, such as the S3 bucket and key.
174
+ * @member {Object.<String, Object>} result_data
187
175
  */
188
176
  SubmissionAction.prototype['result_data'] = undefined;
189
177
 
190
178
  /**
179
+ * Why the upload failed, when `state` is `failed` or `error`.
191
180
  * @member {String} error_message
192
181
  */
193
182
  SubmissionAction.prototype['error_message'] = undefined;
194
-
195
- /**
196
- * Allowed values for the <code>state</code> property.
197
- * @enum {String}
198
- * @readonly
199
- */
200
- SubmissionAction['StateEnum'] = {
201
- /**
202
- * value: "pending"
203
- * @const
204
- */
205
- "pending": "pending",
206
- /**
207
- * value: "processed"
208
- * @const
209
- */
210
- "processed": "processed",
211
- /**
212
- * value: "failed"
213
- * @const
214
- */
215
- "failed": "failed",
216
- /**
217
- * value: "error"
218
- * @const
219
- */
220
- "error": "error"
221
- };
222
-
223
- /**
224
- * Allowed values for the <code>action_type</code> property.
225
- * @enum {String}
226
- * @readonly
227
- */
228
- SubmissionAction['ActionTypeEnum'] = {
229
- /**
230
- * value: "webhook"
231
- * @const
232
- */
233
- "webhook": "webhook",
234
- /**
235
- * value: "slack_webhook"
236
- * @const
237
- */
238
- "slack_webhook": "slack_webhook",
239
- /**
240
- * value: "email"
241
- * @const
242
- */
243
- "email": "email",
244
- /**
245
- * value: "aws_s3_upload"
246
- * @const
247
- */
248
- "aws_s3_upload": "aws_s3_upload"
249
- };
250
-
251
- /**
252
- * Allowed values for the <code>action_category</code> property.
253
- * @enum {String}
254
- * @readonly
255
- */
256
- SubmissionAction['ActionCategoryEnum'] = {
257
- /**
258
- * value: "notification"
259
- * @const
260
- */
261
- "notification": "notification",
262
- /**
263
- * value: "file_upload"
264
- * @const
265
- */
266
- "file_upload": "file_upload"
267
- };
268
183
  var _default = exports["default"] = SubmissionAction;
@@ -0,0 +1,69 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ 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
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ 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); } /**
16
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * Enum class SubmissionActionState.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var SubmissionActionState = exports["default"] = /*#__PURE__*/function () {
33
+ function SubmissionActionState() {
34
+ _classCallCheck(this, SubmissionActionState);
35
+ }
36
+ return _createClass(SubmissionActionState, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>SubmissionActionState</code> enum value from a Javascript object name.
41
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
42
+ * @return {module:model/SubmissionActionState} The enum <code>SubmissionActionState</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "pending"
52
+ * @const
53
+ */
54
+ _defineProperty(SubmissionActionState, "pending", "pending");
55
+ /**
56
+ * value: "processed"
57
+ * @const
58
+ */
59
+ _defineProperty(SubmissionActionState, "processed", "processed");
60
+ /**
61
+ * value: "failed"
62
+ * @const
63
+ */
64
+ _defineProperty(SubmissionActionState, "failed", "failed");
65
+ /**
66
+ * value: "error"
67
+ * @const
68
+ */
69
+ _defineProperty(SubmissionActionState, "error", "error");
@@ -0,0 +1,84 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ 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
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ 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); } /**
16
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * Enum class SubmissionActionType.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var SubmissionActionType = exports["default"] = /*#__PURE__*/function () {
33
+ function SubmissionActionType() {
34
+ _classCallCheck(this, SubmissionActionType);
35
+ }
36
+ return _createClass(SubmissionActionType, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>SubmissionActionType</code> enum value from a Javascript object name.
41
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
42
+ * @return {module:model/SubmissionActionType} The enum <code>SubmissionActionType</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "webhook"
52
+ * @const
53
+ */
54
+ _defineProperty(SubmissionActionType, "webhook", "webhook");
55
+ /**
56
+ * value: "slack_webhook"
57
+ * @const
58
+ */
59
+ _defineProperty(SubmissionActionType, "slack_webhook", "slack_webhook");
60
+ /**
61
+ * value: "email"
62
+ * @const
63
+ */
64
+ _defineProperty(SubmissionActionType, "email", "email");
65
+ /**
66
+ * value: "aws_s3_upload"
67
+ * @const
68
+ */
69
+ _defineProperty(SubmissionActionType, "aws_s3_upload", "aws_s3_upload");
70
+ /**
71
+ * value: "dropbox_upload"
72
+ * @const
73
+ */
74
+ _defineProperty(SubmissionActionType, "dropbox_upload", "dropbox_upload");
75
+ /**
76
+ * value: "google_drive_upload"
77
+ * @const
78
+ */
79
+ _defineProperty(SubmissionActionType, "google_drive_upload", "google_drive_upload");
80
+ /**
81
+ * value: "box_upload"
82
+ * @const
83
+ */
84
+ _defineProperty(SubmissionActionType, "box_upload", "box_upload");
@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _Submission = _interopRequireDefault(require("./Submission"));
9
+ var _SubmissionBatchState = _interopRequireDefault(require("./SubmissionBatchState"));
8
10
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
11
  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
12
  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 +18,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
18
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
19
  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
20
  * 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/).
21
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
22
  *
21
- * The version of the OpenAPI document: v1
23
+ * The version of the OpenAPI document: v2
22
24
  *
23
25
  *
24
26
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,25 +31,29 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
31
  /**
30
32
  * The SubmissionBatch model module.
31
33
  * @module model/SubmissionBatch
32
- * @version 3.3.0
34
+ * @version 4.0.0
33
35
  */
34
36
  var SubmissionBatch = /*#__PURE__*/function () {
35
37
  /**
36
38
  * Constructs a new <code>SubmissionBatch</code>.
39
+ * Submissions created together in one request. Their PDFs are only generated when every submission in the batch is valid.
37
40
  * @alias module:model/SubmissionBatch
38
41
  * @extends Object
39
- * @param id {String}
40
- * @param state {module:model/SubmissionBatch.StateEnum}
41
- * @param metadata {Object}
42
- * @param processed_at {String}
43
- * @param total_count {Number}
44
- * @param pending_count {Number}
45
- * @param error_count {Number}
46
- * @param completion_percentage {Number}
42
+ * @param id {String} The batch's ID.
43
+ * @param state {module:model/SubmissionBatchState} `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
44
+ * @param metadata {Object.<String, Object>} Your own data about the batch, such as an ID from your app.
45
+ * @param total_count {Number} The number of submissions in the request.
46
+ * @param pending_count {Number} The submissions whose PDFs haven't been generated yet.
47
+ * @param error_count {Number} The submissions that were invalid or whose PDFs couldn't be generated.
48
+ * @param completion_percentage {Number} The percentage of the batch's submissions that have finished, from 0 to 100.
49
+ * @param submissions {Array.<module:model/Submission>} The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`.
50
+ * @param processed_at {Date} When every submission had finished.
51
+ * @param created_at {Date} When the batch was created.
52
+ * @param updated_at {Date} When the batch was last updated.
47
53
  */
48
- function SubmissionBatch(id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage) {
54
+ function SubmissionBatch(id, state, metadata, total_count, pending_count, error_count, completion_percentage, submissions, processed_at, created_at, updated_at) {
49
55
  _classCallCheck(this, SubmissionBatch);
50
- SubmissionBatch.initialize(this, id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage);
56
+ SubmissionBatch.initialize(this, id, state, metadata, total_count, pending_count, error_count, completion_percentage, submissions, processed_at, created_at, updated_at);
51
57
  }
52
58
 
53
59
  /**
@@ -57,15 +63,18 @@ var SubmissionBatch = /*#__PURE__*/function () {
57
63
  */
58
64
  return _createClass(SubmissionBatch, null, [{
59
65
  key: "initialize",
60
- value: function initialize(obj, id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage) {
66
+ value: function initialize(obj, id, state, metadata, total_count, pending_count, error_count, completion_percentage, submissions, processed_at, created_at, updated_at) {
61
67
  obj['id'] = id;
62
68
  obj['state'] = state;
63
69
  obj['metadata'] = metadata;
64
- obj['processed_at'] = processed_at;
65
70
  obj['total_count'] = total_count;
66
71
  obj['pending_count'] = pending_count;
67
72
  obj['error_count'] = error_count;
68
73
  obj['completion_percentage'] = completion_percentage;
74
+ obj['submissions'] = submissions;
75
+ obj['processed_at'] = processed_at;
76
+ obj['created_at'] = created_at;
77
+ obj['updated_at'] = updated_at;
69
78
  }
70
79
 
71
80
  /**
@@ -85,13 +94,12 @@ var SubmissionBatch = /*#__PURE__*/function () {
85
94
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
86
95
  }
87
96
  if (data.hasOwnProperty('state')) {
88
- obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
97
+ obj['state'] = _ApiClient["default"].convertToType(data['state'], _SubmissionBatchState["default"]);
89
98
  }
90
99
  if (data.hasOwnProperty('metadata')) {
91
- obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
92
- }
93
- if (data.hasOwnProperty('processed_at')) {
94
- obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'String');
100
+ obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
101
+ 'String': Object
102
+ });
95
103
  }
96
104
  if (data.hasOwnProperty('total_count')) {
97
105
  obj['total_count'] = _ApiClient["default"].convertToType(data['total_count'], 'Number');
@@ -105,6 +113,18 @@ var SubmissionBatch = /*#__PURE__*/function () {
105
113
  if (data.hasOwnProperty('completion_percentage')) {
106
114
  obj['completion_percentage'] = _ApiClient["default"].convertToType(data['completion_percentage'], 'Number');
107
115
  }
116
+ if (data.hasOwnProperty('submissions')) {
117
+ obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_Submission["default"]]);
118
+ }
119
+ if (data.hasOwnProperty('processed_at')) {
120
+ obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'Date');
121
+ }
122
+ if (data.hasOwnProperty('created_at')) {
123
+ obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
124
+ }
125
+ if (data.hasOwnProperty('updated_at')) {
126
+ obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
127
+ }
108
128
  }
109
129
  return obj;
110
130
  }
@@ -136,80 +156,79 @@ var SubmissionBatch = /*#__PURE__*/function () {
136
156
  if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
137
157
  throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
138
158
  }
139
- // ensure the json data is a string
140
- if (data['state'] && !(typeof data['state'] === 'string' || data['state'] instanceof String)) {
141
- throw new Error("Expected the field `state` to be a primitive type in the JSON string but got " + data['state']);
142
- }
143
- // ensure the json data is a string
144
- if (data['processed_at'] && !(typeof data['processed_at'] === 'string' || data['processed_at'] instanceof String)) {
145
- throw new Error("Expected the field `processed_at` to be a primitive type in the JSON string but got " + data['processed_at']);
159
+ // ensure the json data is an array
160
+ if (!Array.isArray(data['submissions'])) {
161
+ throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
146
162
  }
147
163
  return true;
148
164
  }
149
165
  }]);
150
166
  }();
151
- SubmissionBatch.RequiredProperties = ["id", "state", "metadata", "processed_at", "total_count", "pending_count", "error_count", "completion_percentage"];
167
+ SubmissionBatch.RequiredProperties = ["id", "state", "metadata", "total_count", "pending_count", "error_count", "completion_percentage", "submissions", "processed_at", "created_at", "updated_at"];
152
168
 
153
169
  /**
170
+ * The batch's ID.
154
171
  * @member {String} id
155
172
  */
156
173
  SubmissionBatch.prototype['id'] = undefined;
157
174
 
158
175
  /**
159
- * @member {module:model/SubmissionBatch.StateEnum} state
176
+ * `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
177
+ * @member {module:model/SubmissionBatchState} state
160
178
  */
161
179
  SubmissionBatch.prototype['state'] = undefined;
162
180
 
163
181
  /**
164
- * @member {Object} metadata
182
+ * Your own data about the batch, such as an ID from your app.
183
+ * @member {Object.<String, Object>} metadata
165
184
  */
166
185
  SubmissionBatch.prototype['metadata'] = undefined;
167
186
 
168
187
  /**
169
- * @member {String} processed_at
170
- */
171
- SubmissionBatch.prototype['processed_at'] = undefined;
172
-
173
- /**
188
+ * The number of submissions in the request.
174
189
  * @member {Number} total_count
175
190
  */
176
191
  SubmissionBatch.prototype['total_count'] = undefined;
177
192
 
178
193
  /**
194
+ * The submissions whose PDFs haven't been generated yet.
179
195
  * @member {Number} pending_count
180
196
  */
181
197
  SubmissionBatch.prototype['pending_count'] = undefined;
182
198
 
183
199
  /**
200
+ * The submissions that were invalid or whose PDFs couldn't be generated.
184
201
  * @member {Number} error_count
185
202
  */
186
203
  SubmissionBatch.prototype['error_count'] = undefined;
187
204
 
188
205
  /**
206
+ * The percentage of the batch's submissions that have finished, from 0 to 100.
189
207
  * @member {Number} completion_percentage
190
208
  */
191
209
  SubmissionBatch.prototype['completion_percentage'] = undefined;
192
210
 
193
211
  /**
194
- * Allowed values for the <code>state</code> property.
195
- * @enum {String}
196
- * @readonly
212
+ * The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`.
213
+ * @member {Array.<module:model/Submission>} submissions
197
214
  */
198
- SubmissionBatch['StateEnum'] = {
199
- /**
200
- * value: "pending"
201
- * @const
202
- */
203
- "pending": "pending",
204
- /**
205
- * value: "processed"
206
- * @const
207
- */
208
- "processed": "processed",
209
- /**
210
- * value: "error"
211
- * @const
212
- */
213
- "error": "error"
214
- };
215
+ SubmissionBatch.prototype['submissions'] = undefined;
216
+
217
+ /**
218
+ * When every submission had finished.
219
+ * @member {Date} processed_at
220
+ */
221
+ SubmissionBatch.prototype['processed_at'] = undefined;
222
+
223
+ /**
224
+ * When the batch was created.
225
+ * @member {Date} created_at
226
+ */
227
+ SubmissionBatch.prototype['created_at'] = undefined;
228
+
229
+ /**
230
+ * When the batch was last updated.
231
+ * @member {Date} updated_at
232
+ */
233
+ SubmissionBatch.prototype['updated_at'] = undefined;
215
234
  var _default = exports["default"] = SubmissionBatch;