docspring 2.1.0 → 3.1.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 (63) hide show
  1. package/README.md +59 -48
  2. package/dist/ApiClient.js +4 -4
  3. package/dist/api/{PDFApi.js → Client.js} +698 -384
  4. package/dist/index.js +56 -21
  5. package/dist/model/AddFieldsData.js +3 -3
  6. package/dist/model/BatchGeneratePdfs201Response.js +8 -8
  7. package/dist/model/CombinePdfsData.js +10 -8
  8. package/dist/model/CombinedSubmission.js +22 -22
  9. package/dist/model/CombinedSubmissionAction.js +29 -15
  10. package/dist/model/CopyTemplateOptions.js +19 -30
  11. package/dist/model/CreateCombinedSubmissionResponse.js +8 -8
  12. package/dist/model/CreateCustomFileData.js +8 -8
  13. package/dist/model/CreateCustomFileResponse.js +8 -8
  14. package/dist/model/CreateFolderData.js +3 -3
  15. package/dist/model/CreateHtmlTemplate.js +3 -3
  16. package/dist/model/CreatePdfSubmissionData.js +3 -3
  17. package/dist/model/CreatePdfTemplate.js +3 -3
  18. package/dist/model/CreateSubmissionDataRequestData.js +107 -3
  19. package/dist/model/CreateSubmissionDataRequestEventRequest.js +32 -8
  20. package/dist/model/CreateSubmissionDataRequestEventResponse.js +3 -3
  21. package/dist/model/CreateSubmissionDataRequestResponse.js +8 -8
  22. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +3 -3
  23. package/dist/model/CreateSubmissionResponse.js +3 -3
  24. package/dist/model/{CombinedSubmissionData.js → CreateWebhookData.js} +28 -68
  25. package/dist/model/CustomFile.js +3 -3
  26. package/dist/model/ErrorOrMultipleErrorsResponse.js +151 -0
  27. package/dist/model/ErrorResponse.js +3 -3
  28. package/dist/model/Folder.js +8 -8
  29. package/dist/model/JsonSchema.js +35 -3
  30. package/dist/model/ListSubmissionsResponse.js +8 -8
  31. package/dist/model/MoveFolderData.js +3 -3
  32. package/dist/model/MoveTemplateData.js +20 -8
  33. package/dist/model/MultipleErrorsResponse.js +3 -3
  34. package/dist/model/PublishVersionData.js +8 -8
  35. package/dist/model/RenameFolderData.js +3 -3
  36. package/dist/model/RestoreVersionData.js +3 -3
  37. package/dist/model/Submission.js +57 -44
  38. package/dist/model/Submission422Response.js +165 -0
  39. package/dist/model/SubmissionAction.js +29 -15
  40. package/dist/model/SubmissionBatch.js +16 -16
  41. package/dist/model/SubmissionBatchData.js +27 -3
  42. package/dist/model/SubmissionBatchWithSubmissions.js +16 -16
  43. package/dist/model/SubmissionDataRequest.js +53 -34
  44. package/dist/model/SubmissionDataRequestEvent.js +18 -18
  45. package/dist/model/SubmissionDataRequestShow.js +55 -36
  46. package/dist/model/SubmissionDataRequestToken.js +10 -10
  47. package/dist/model/SubmissionPreview.js +57 -38
  48. package/dist/model/SuccessErrorResponse.js +3 -3
  49. package/dist/model/SuccessMultipleErrorsResponse.js +3 -3
  50. package/dist/model/Template.js +203 -90
  51. package/dist/model/TemplateAddFieldsResponse.js +3 -3
  52. package/dist/model/TemplateDeleteResponse.js +3 -3
  53. package/dist/model/TemplateModelCodeResponse.js +193 -0
  54. package/dist/model/TemplatePreview.js +167 -78
  55. package/dist/model/TemplatePublishVersionResponse.js +3 -3
  56. package/dist/model/UpdateHtmlTemplate.js +3 -3
  57. package/dist/model/UpdatePdfTemplate.js +108 -0
  58. package/dist/model/UpdateSubmissionDataRequestData.js +154 -3
  59. package/dist/model/UpdateWebhookData.js +108 -0
  60. package/dist/model/UploadPresignResponse.js +3 -3
  61. package/dist/model/Webhook.js +378 -0
  62. package/package.json +2 -2
  63. package/dist/model/CreateHtmlSubmissionData.js +0 -173
@@ -14,9 +14,9 @@ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Can
14
14
  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); } }
15
15
  function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
- function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
17
+ 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
18
  * DocSpring API
19
- * DocSpring provides an API that helps you fill out and sign PDF templates.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
29
29
  /**
30
30
  * The SubmissionDataRequestShow model module.
31
31
  * @module model/SubmissionDataRequestShow
32
- * @version 2.1.0
32
+ * @version 3.1.0
33
33
  */
34
34
  var SubmissionDataRequestShow = /*#__PURE__*/function () {
35
35
  /**
@@ -39,28 +39,29 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
39
39
  * @param email {String}
40
40
  * @param name {String}
41
41
  * @param order {Number}
42
- * @param sortOrder {Number}
42
+ * @param sort_order {Number}
43
43
  * @param fields {Array.<String>}
44
44
  * @param metadata {Object}
45
45
  * @param state {module:model/SubmissionDataRequestShow.StateEnum}
46
- * @param viewedAt {String}
47
- * @param completedAt {String}
46
+ * @param viewed_at {String}
47
+ * @param completed_at {String}
48
+ * @param declined_at {String}
48
49
  * @param data {Object}
49
- * @param authType {module:model/SubmissionDataRequestShow.AuthTypeEnum}
50
- * @param authSecondFactorType {module:model/SubmissionDataRequestShow.AuthSecondFactorTypeEnum}
51
- * @param authProvider {String}
52
- * @param authSessionStartedAt {String}
53
- * @param authSessionIdHash {String}
54
- * @param authUserIdHash {String}
55
- * @param authUsernameHash {String}
56
- * @param authPhoneNumberHash {String}
57
- * @param ipAddress {String}
58
- * @param userAgent {String}
59
- * @param submissionId {String}
50
+ * @param auth_type {module:model/SubmissionDataRequestShow.AuthTypeEnum}
51
+ * @param auth_second_factor_type {module:model/SubmissionDataRequestShow.AuthSecondFactorTypeEnum}
52
+ * @param auth_provider {String}
53
+ * @param auth_session_started_at {String}
54
+ * @param auth_session_id_hash {String}
55
+ * @param auth_user_id_hash {String}
56
+ * @param auth_username_hash {String}
57
+ * @param auth_phone_number_hash {String}
58
+ * @param ip_address {String}
59
+ * @param user_agent {String}
60
+ * @param submission_id {String}
60
61
  */
61
- function SubmissionDataRequestShow(id, email, name, order, sortOrder, fields, metadata, state, viewedAt, completedAt, data, authType, authSecondFactorType, authProvider, authSessionStartedAt, authSessionIdHash, authUserIdHash, authUsernameHash, authPhoneNumberHash, ipAddress, userAgent, submissionId) {
62
+ 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) {
62
63
  _classCallCheck(this, SubmissionDataRequestShow);
63
- SubmissionDataRequestShow.initialize(this, id, email, name, order, sortOrder, fields, metadata, state, viewedAt, completedAt, data, authType, authSecondFactorType, authProvider, authSessionStartedAt, authSessionIdHash, authUserIdHash, authUsernameHash, authPhoneNumberHash, ipAddress, userAgent, submissionId);
64
+ 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);
64
65
  }
65
66
 
66
67
  /**
@@ -70,29 +71,30 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
70
71
  */
71
72
  return _createClass(SubmissionDataRequestShow, null, [{
72
73
  key: "initialize",
73
- value: function initialize(obj, id, email, name, order, sortOrder, fields, metadata, state, viewedAt, completedAt, data, authType, authSecondFactorType, authProvider, authSessionStartedAt, authSessionIdHash, authUserIdHash, authUsernameHash, authPhoneNumberHash, ipAddress, userAgent, submissionId) {
74
+ 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) {
74
75
  obj['id'] = id;
75
76
  obj['email'] = email;
76
77
  obj['name'] = name;
77
78
  obj['order'] = order;
78
- obj['sort_order'] = sortOrder;
79
+ obj['sort_order'] = sort_order;
79
80
  obj['fields'] = fields;
80
81
  obj['metadata'] = metadata;
81
82
  obj['state'] = state;
82
- obj['viewed_at'] = viewedAt;
83
- obj['completed_at'] = completedAt;
83
+ obj['viewed_at'] = viewed_at;
84
+ obj['completed_at'] = completed_at;
85
+ obj['declined_at'] = declined_at;
84
86
  obj['data'] = data;
85
- obj['auth_type'] = authType;
86
- obj['auth_second_factor_type'] = authSecondFactorType;
87
- obj['auth_provider'] = authProvider;
88
- obj['auth_session_started_at'] = authSessionStartedAt;
89
- obj['auth_session_id_hash'] = authSessionIdHash;
90
- obj['auth_user_id_hash'] = authUserIdHash;
91
- obj['auth_username_hash'] = authUsernameHash;
92
- obj['auth_phone_number_hash'] = authPhoneNumberHash;
93
- obj['ip_address'] = ipAddress;
94
- obj['user_agent'] = userAgent;
95
- obj['submission_id'] = submissionId;
87
+ obj['auth_type'] = auth_type;
88
+ obj['auth_second_factor_type'] = auth_second_factor_type;
89
+ obj['auth_provider'] = auth_provider;
90
+ obj['auth_session_started_at'] = auth_session_started_at;
91
+ obj['auth_session_id_hash'] = auth_session_id_hash;
92
+ obj['auth_user_id_hash'] = auth_user_id_hash;
93
+ obj['auth_username_hash'] = auth_username_hash;
94
+ obj['auth_phone_number_hash'] = auth_phone_number_hash;
95
+ obj['ip_address'] = ip_address;
96
+ obj['user_agent'] = user_agent;
97
+ obj['submission_id'] = submission_id;
96
98
  }
97
99
 
98
100
  /**
@@ -137,6 +139,9 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
137
139
  if (data.hasOwnProperty('completed_at')) {
138
140
  obj['completed_at'] = _ApiClient["default"].convertToType(data['completed_at'], 'String');
139
141
  }
142
+ if (data.hasOwnProperty('declined_at')) {
143
+ obj['declined_at'] = _ApiClient["default"].convertToType(data['declined_at'], 'String');
144
+ }
140
145
  if (data.hasOwnProperty('data')) {
141
146
  obj['data'] = _ApiClient["default"].convertToType(data['data'], Object);
142
147
  }
@@ -229,6 +234,10 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
229
234
  throw new Error("Expected the field `completed_at` to be a primitive type in the JSON string but got " + data['completed_at']);
230
235
  }
231
236
  // ensure the json data is a string
237
+ if (data['declined_at'] && !(typeof data['declined_at'] === 'string' || data['declined_at'] instanceof String)) {
238
+ throw new Error("Expected the field `declined_at` to be a primitive type in the JSON string but got " + data['declined_at']);
239
+ }
240
+ // ensure the json data is a string
232
241
  if (data['auth_type'] && !(typeof data['auth_type'] === 'string' || data['auth_type'] instanceof String)) {
233
242
  throw new Error("Expected the field `auth_type` to be a primitive type in the JSON string but got " + data['auth_type']);
234
243
  }
@@ -276,7 +285,7 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
276
285
  }
277
286
  }]);
278
287
  }();
279
- SubmissionDataRequestShow.RequiredProperties = ["id", "email", "name", "order", "sort_order", "fields", "metadata", "state", "viewed_at", "completed_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"];
288
+ 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"];
280
289
 
281
290
  /**
282
291
  * @member {String} id
@@ -328,6 +337,11 @@ SubmissionDataRequestShow.prototype['viewed_at'] = undefined;
328
337
  */
329
338
  SubmissionDataRequestShow.prototype['completed_at'] = undefined;
330
339
 
340
+ /**
341
+ * @member {String} declined_at
342
+ */
343
+ SubmissionDataRequestShow.prototype['declined_at'] = undefined;
344
+
331
345
  /**
332
346
  * @member {Object} data
333
347
  */
@@ -403,7 +417,12 @@ SubmissionDataRequestShow['StateEnum'] = {
403
417
  * value: "completed"
404
418
  * @const
405
419
  */
406
- "completed": "completed"
420
+ "completed": "completed",
421
+ /**
422
+ * value: "declined"
423
+ * @const
424
+ */
425
+ "declined": "declined"
407
426
  };
408
427
 
409
428
  /**
@@ -14,9 +14,9 @@ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Can
14
14
  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); } }
15
15
  function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
- function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
17
+ 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
18
  * DocSpring API
19
- * DocSpring provides an API that helps you fill out and sign PDF templates.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
29
29
  /**
30
30
  * The SubmissionDataRequestToken model module.
31
31
  * @module model/SubmissionDataRequestToken
32
- * @version 2.1.0
32
+ * @version 3.1.0
33
33
  */
34
34
  var SubmissionDataRequestToken = /*#__PURE__*/function () {
35
35
  /**
@@ -37,12 +37,12 @@ var SubmissionDataRequestToken = /*#__PURE__*/function () {
37
37
  * @alias module:model/SubmissionDataRequestToken
38
38
  * @param id {String}
39
39
  * @param secret {String}
40
- * @param expiresAt {String}
41
- * @param dataRequestUrl {String}
40
+ * @param expires_at {String}
41
+ * @param data_request_url {String}
42
42
  */
43
- function SubmissionDataRequestToken(id, secret, expiresAt, dataRequestUrl) {
43
+ function SubmissionDataRequestToken(id, secret, expires_at, data_request_url) {
44
44
  _classCallCheck(this, SubmissionDataRequestToken);
45
- SubmissionDataRequestToken.initialize(this, id, secret, expiresAt, dataRequestUrl);
45
+ SubmissionDataRequestToken.initialize(this, id, secret, expires_at, data_request_url);
46
46
  }
47
47
 
48
48
  /**
@@ -52,11 +52,11 @@ var SubmissionDataRequestToken = /*#__PURE__*/function () {
52
52
  */
53
53
  return _createClass(SubmissionDataRequestToken, null, [{
54
54
  key: "initialize",
55
- value: function initialize(obj, id, secret, expiresAt, dataRequestUrl) {
55
+ value: function initialize(obj, id, secret, expires_at, data_request_url) {
56
56
  obj['id'] = id;
57
57
  obj['secret'] = secret;
58
- obj['expires_at'] = expiresAt;
59
- obj['data_request_url'] = dataRequestUrl;
58
+ obj['expires_at'] = expires_at;
59
+ obj['data_request_url'] = data_request_url;
60
60
  }
61
61
 
62
62
  /**
@@ -16,9 +16,9 @@ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Can
16
16
  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); } }
17
17
  function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
18
18
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
19
- function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
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); } /**
20
20
  * DocSpring API
21
- * DocSpring provides an API that helps you fill out and sign PDF templates.
21
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
22
22
  *
23
23
  * The version of the OpenAPI document: v1
24
24
  *
@@ -31,39 +31,40 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
31
31
  /**
32
32
  * The SubmissionPreview model module.
33
33
  * @module model/SubmissionPreview
34
- * @version 2.1.0
34
+ * @version 3.1.0
35
35
  */
36
36
  var SubmissionPreview = /*#__PURE__*/function () {
37
37
  /**
38
38
  * Constructs a new <code>SubmissionPreview</code>.
39
39
  * @alias module:model/SubmissionPreview
40
- * @param batchId {String}
41
- * @param dataRequests {Array.<module:model/SubmissionDataRequest>}
40
+ * @param batch_id {String}
41
+ * @param data_requests {Array.<module:model/SubmissionDataRequest>}
42
42
  * @param editable {Boolean}
43
+ * @param error_message {String}
43
44
  * @param expired {Boolean}
44
- * @param expiresAt {String}
45
+ * @param expires_at {String}
45
46
  * @param id {String}
46
- * @param jsonSchemaErrors {Array.<String>}
47
+ * @param json_schema_errors {Array.<String>}
47
48
  * @param metadata {Object}
48
49
  * @param password {String}
49
- * @param processedAt {String}
50
+ * @param processed_at {String}
50
51
  * @param state {module:model/SubmissionPreview.StateEnum}
51
- * @param templateId {String}
52
- * @param templateType {module:model/SubmissionPreview.TemplateTypeEnum}
53
- * @param templateVersion {String}
52
+ * @param template_id {String}
53
+ * @param template_type {module:model/SubmissionPreview.TemplateTypeEnum}
54
+ * @param template_version {String}
54
55
  * @param test {Boolean}
55
- * @param truncatedText {Object}
56
- * @param pdfHash {String}
57
- * @param downloadUrl {String}
58
- * @param permanentDownloadUrl {String}
59
- * @param previewDownloadUrl {String}
60
- * @param previewGeneratedAt {String}
61
- * @param auditTrailDownloadUrl {String}
56
+ * @param truncated_text {Object}
57
+ * @param pdf_hash {String}
58
+ * @param download_url {String}
59
+ * @param permanent_download_url {String}
60
+ * @param preview_download_url {String}
61
+ * @param preview_generated_at {String}
62
+ * @param audit_trail_download_url {String}
62
63
  * @param actions {Array.<module:model/SubmissionAction>}
63
64
  */
64
- function SubmissionPreview(batchId, dataRequests, editable, expired, expiresAt, id, jsonSchemaErrors, metadata, password, processedAt, state, templateId, templateType, templateVersion, test, truncatedText, pdfHash, downloadUrl, permanentDownloadUrl, previewDownloadUrl, previewGeneratedAt, auditTrailDownloadUrl, actions) {
65
+ function SubmissionPreview(batch_id, data_requests, editable, error_message, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions) {
65
66
  _classCallCheck(this, SubmissionPreview);
66
- SubmissionPreview.initialize(this, batchId, dataRequests, editable, expired, expiresAt, id, jsonSchemaErrors, metadata, password, processedAt, state, templateId, templateType, templateVersion, test, truncatedText, pdfHash, downloadUrl, permanentDownloadUrl, previewDownloadUrl, previewGeneratedAt, auditTrailDownloadUrl, actions);
67
+ SubmissionPreview.initialize(this, batch_id, data_requests, editable, error_message, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions);
67
68
  }
68
69
 
69
70
  /**
@@ -73,29 +74,30 @@ var SubmissionPreview = /*#__PURE__*/function () {
73
74
  */
74
75
  return _createClass(SubmissionPreview, null, [{
75
76
  key: "initialize",
76
- value: function initialize(obj, batchId, dataRequests, editable, expired, expiresAt, id, jsonSchemaErrors, metadata, password, processedAt, state, templateId, templateType, templateVersion, test, truncatedText, pdfHash, downloadUrl, permanentDownloadUrl, previewDownloadUrl, previewGeneratedAt, auditTrailDownloadUrl, actions) {
77
- obj['batch_id'] = batchId;
78
- obj['data_requests'] = dataRequests;
77
+ value: function initialize(obj, batch_id, data_requests, editable, error_message, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions) {
78
+ obj['batch_id'] = batch_id;
79
+ obj['data_requests'] = data_requests;
79
80
  obj['editable'] = editable;
81
+ obj['error_message'] = error_message;
80
82
  obj['expired'] = expired;
81
- obj['expires_at'] = expiresAt;
83
+ obj['expires_at'] = expires_at;
82
84
  obj['id'] = id;
83
- obj['json_schema_errors'] = jsonSchemaErrors;
85
+ obj['json_schema_errors'] = json_schema_errors;
84
86
  obj['metadata'] = metadata;
85
87
  obj['password'] = password;
86
- obj['processed_at'] = processedAt;
88
+ obj['processed_at'] = processed_at;
87
89
  obj['state'] = state;
88
- obj['template_id'] = templateId;
89
- obj['template_type'] = templateType;
90
- obj['template_version'] = templateVersion;
90
+ obj['template_id'] = template_id;
91
+ obj['template_type'] = template_type;
92
+ obj['template_version'] = template_version;
91
93
  obj['test'] = test;
92
- obj['truncated_text'] = truncatedText;
93
- obj['pdf_hash'] = pdfHash;
94
- obj['download_url'] = downloadUrl;
95
- obj['permanent_download_url'] = permanentDownloadUrl;
96
- obj['preview_download_url'] = previewDownloadUrl;
97
- obj['preview_generated_at'] = previewGeneratedAt;
98
- obj['audit_trail_download_url'] = auditTrailDownloadUrl;
94
+ obj['truncated_text'] = truncated_text;
95
+ obj['pdf_hash'] = pdf_hash;
96
+ obj['download_url'] = download_url;
97
+ obj['permanent_download_url'] = permanent_download_url;
98
+ obj['preview_download_url'] = preview_download_url;
99
+ obj['preview_generated_at'] = preview_generated_at;
100
+ obj['audit_trail_download_url'] = audit_trail_download_url;
99
101
  obj['actions'] = actions;
100
102
  }
101
103
 
@@ -120,6 +122,9 @@ var SubmissionPreview = /*#__PURE__*/function () {
120
122
  if (data.hasOwnProperty('editable')) {
121
123
  obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
122
124
  }
125
+ if (data.hasOwnProperty('error_message')) {
126
+ obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
127
+ }
123
128
  if (data.hasOwnProperty('expired')) {
124
129
  obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
125
130
  }
@@ -233,6 +238,10 @@ var SubmissionPreview = /*#__PURE__*/function () {
233
238
  ;
234
239
  }
235
240
  // ensure the json data is a string
241
+ if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
242
+ throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
243
+ }
244
+ // ensure the json data is a string
236
245
  if (data['expires_at'] && !(typeof data['expires_at'] === 'string' || data['expires_at'] instanceof String)) {
237
246
  throw new Error("Expected the field `expires_at` to be a primitive type in the JSON string but got " + data['expires_at']);
238
247
  }
@@ -317,7 +326,7 @@ var SubmissionPreview = /*#__PURE__*/function () {
317
326
  }
318
327
  }]);
319
328
  }();
320
- SubmissionPreview.RequiredProperties = ["batch_id", "data_requests", "editable", "expired", "expires_at", "id", "json_schema_errors", "metadata", "password", "processed_at", "state", "template_id", "template_type", "template_version", "test", "truncated_text", "pdf_hash", "download_url", "permanent_download_url", "preview_download_url", "preview_generated_at", "audit_trail_download_url", "actions"];
329
+ SubmissionPreview.RequiredProperties = ["batch_id", "data_requests", "editable", "error_message", "expired", "expires_at", "id", "json_schema_errors", "metadata", "password", "processed_at", "state", "template_id", "template_type", "template_version", "test", "truncated_text", "pdf_hash", "download_url", "permanent_download_url", "preview_download_url", "preview_generated_at", "audit_trail_download_url", "actions"];
321
330
 
322
331
  /**
323
332
  * @member {String} batch_id
@@ -334,6 +343,11 @@ SubmissionPreview.prototype['data_requests'] = undefined;
334
343
  */
335
344
  SubmissionPreview.prototype['editable'] = undefined;
336
345
 
346
+ /**
347
+ * @member {String} error_message
348
+ */
349
+ SubmissionPreview.prototype['error_message'] = undefined;
350
+
337
351
  /**
338
352
  * @member {Boolean} expired
339
353
  */
@@ -494,7 +508,12 @@ SubmissionPreview['StateEnum'] = {
494
508
  * value: "accidental"
495
509
  * @const
496
510
  */
497
- "accidental": "accidental"
511
+ "accidental": "accidental",
512
+ /**
513
+ * value: "declined"
514
+ * @const
515
+ */
516
+ "declined": "declined"
498
517
  };
499
518
 
500
519
  /**
@@ -14,9 +14,9 @@ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Can
14
14
  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); } }
15
15
  function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
- function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
17
+ 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
18
  * DocSpring API
19
- * DocSpring provides an API that helps you fill out and sign PDF templates.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
29
29
  /**
30
30
  * The SuccessErrorResponse model module.
31
31
  * @module model/SuccessErrorResponse
32
- * @version 2.1.0
32
+ * @version 3.1.0
33
33
  */
34
34
  var SuccessErrorResponse = /*#__PURE__*/function () {
35
35
  /**
@@ -14,9 +14,9 @@ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Can
14
14
  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); } }
15
15
  function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
- function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
17
+ 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
18
  * DocSpring API
19
- * DocSpring provides an API that helps you fill out and sign PDF templates.
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
20
  *
21
21
  * The version of the OpenAPI document: v1
22
22
  *
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
29
29
  /**
30
30
  * The SuccessMultipleErrorsResponse model module.
31
31
  * @module model/SuccessMultipleErrorsResponse
32
- * @version 2.1.0
32
+ * @version 3.1.0
33
33
  */
34
34
  var SuccessMultipleErrorsResponse = /*#__PURE__*/function () {
35
35
  /**