docspring 4.1.0 → 4.2.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 (111) hide show
  1. package/AGENTS.md +3 -2
  2. package/README.md +4 -1
  3. package/dist/ApiClient.js +2 -2
  4. package/dist/RequestSchemas.js +75 -8
  5. package/dist/WebhookSignature.js +86 -0
  6. package/dist/api/Client.js +147 -15
  7. package/dist/index.js +42 -0
  8. package/dist/model/AddTemplateFieldsRequest.js +1 -1
  9. package/dist/model/AuthenticationCheck.js +1 -1
  10. package/dist/model/CombinedPdf.js +3 -3
  11. package/dist/model/CombinedPdfFiles.js +1 -1
  12. package/dist/model/CombinedPdfList.js +1 -1
  13. package/dist/model/CombinedPdfSource.js +1 -1
  14. package/dist/model/CombinedPdfSourceInput.js +1 -1
  15. package/dist/model/CombinedPdfSourcePdf.js +1 -1
  16. package/dist/model/CopyTemplateRequest.js +1 -1
  17. package/dist/model/CreateCombinedPdfRequest.js +2 -2
  18. package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
  19. package/dist/model/CreateFolderRequest.js +1 -1
  20. package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
  21. package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
  22. package/dist/model/CreateSubmissionBatchRequest.js +1 -1
  23. package/dist/model/CreateSubmissionRequest.js +3 -3
  24. package/dist/model/CreateTemplatePreviewRequest.js +112 -0
  25. package/dist/model/CreateTemplateRequest.js +11 -2
  26. package/dist/model/CreateWebhookRequest.js +1 -1
  27. package/dist/model/CustomFile.js +1 -1
  28. package/dist/model/CustomFileList.js +1 -1
  29. package/dist/model/CustomFileSourcePdf.js +1 -1
  30. package/dist/model/ErrorCode.js +11 -1
  31. package/dist/model/ErrorDetail.js +2 -2
  32. package/dist/model/ErrorInfo.js +6 -6
  33. package/dist/model/ErrorResponse.js +1 -1
  34. package/dist/model/Field.js +1 -1
  35. package/dist/model/FieldComparisonCondition.js +1 -1
  36. package/dist/model/FieldDependency.js +1 -1
  37. package/dist/model/FieldDependencyInput.js +1 -1
  38. package/dist/model/FieldEqualsCondition.js +1 -1
  39. package/dist/model/FieldGroup.js +1 -1
  40. package/dist/model/FieldGroupInput.js +1 -1
  41. package/dist/model/FieldInCondition.js +1 -1
  42. package/dist/model/FieldInput.js +1 -1
  43. package/dist/model/FieldOverride.js +1 -1
  44. package/dist/model/FieldPresenceCondition.js +1 -1
  45. package/dist/model/FieldRangeCondition.js +1 -1
  46. package/dist/model/Folder.js +1 -1
  47. package/dist/model/FolderList.js +1 -1
  48. package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
  49. package/dist/model/GeneratedFile.js +1 -1
  50. package/dist/model/HtmlEngineOptions.js +1 -1
  51. package/dist/model/HtmlEngineOptionsInput.js +1 -1
  52. package/dist/model/MoveFolderRequest.js +1 -1
  53. package/dist/model/MoveTemplateRequest.js +1 -1
  54. package/dist/model/PageImage.js +1 -1
  55. package/dist/model/PageImages.js +1 -1
  56. package/dist/model/PredefinedField.js +1 -1
  57. package/dist/model/PredefinedFieldInput.js +1 -1
  58. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  59. package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
  60. package/dist/model/RenameFolderRequest.js +1 -1
  61. package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
  62. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  63. package/dist/model/SignatureRequest.js +1 -1
  64. package/dist/model/SignatureRequestEvent.js +1 -1
  65. package/dist/model/SignatureRequestInput.js +1 -1
  66. package/dist/model/SignatureRequestToken.js +1 -1
  67. package/dist/model/Submission.js +75 -75
  68. package/dist/model/SubmissionAction.js +1 -1
  69. package/dist/model/SubmissionBatch.js +1 -1
  70. package/dist/model/SubmissionFiles.js +1 -1
  71. package/dist/model/SubmissionInput.js +3 -3
  72. package/dist/model/SubmissionList.js +5 -5
  73. package/dist/model/SubmissionSourcePdf.js +1 -1
  74. package/dist/model/SubmissionSummary.js +343 -0
  75. package/dist/model/SubmissionValidation.js +1 -1
  76. package/dist/model/Template.js +68 -57
  77. package/dist/model/TemplateActor.js +3 -3
  78. package/dist/model/TemplateDefaults.js +1 -1
  79. package/dist/model/TemplateDefaultsInput.js +1 -1
  80. package/dist/model/TemplateDiff.js +1 -1
  81. package/dist/model/TemplateDiffSummary.js +1 -1
  82. package/dist/model/TemplateDocument.js +33 -33
  83. package/dist/model/TemplateDocumentSummary.js +152 -0
  84. package/dist/model/TemplateFieldChange.js +1 -1
  85. package/dist/model/TemplateFieldChanges.js +1 -1
  86. package/dist/model/TemplateFieldDependency.js +1 -1
  87. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  88. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  89. package/dist/model/TemplateFieldDependencyInput.js +1 -1
  90. package/dist/model/TemplateFieldMove.js +1 -1
  91. package/dist/model/TemplateFields.js +1 -1
  92. package/dist/model/TemplateModelCode.js +1 -1
  93. package/dist/model/TemplatePageImages.js +1 -1
  94. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  95. package/dist/model/TemplatePreview.js +211 -0
  96. package/dist/model/TemplatePreviewState.js +64 -0
  97. package/dist/model/TemplateSourcePdf.js +1 -1
  98. package/dist/model/TemplateSummary.js +14 -288
  99. package/dist/model/TemplateSummaryList.js +1 -1
  100. package/dist/model/TemplateVersion.js +1 -1
  101. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  102. package/dist/model/UpdateTemplateDocumentRequest.js +1 -1
  103. package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
  104. package/dist/model/UpdateTemplateRequest.js +11 -2
  105. package/dist/model/UpdateWebhookRequest.js +1 -1
  106. package/dist/model/UploadPresign.js +1 -1
  107. package/dist/model/UrlSourcePdf.js +1 -1
  108. package/dist/model/ValidateSubmissionRequest.js +3 -3
  109. package/dist/model/Webhook.js +1 -1
  110. package/dist/model/WebhookList.js +1 -1
  111. package/package.json +3 -2
@@ -0,0 +1,152 @@
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
+ var _TemplateDocumentState = _interopRequireDefault(require("./TemplateDocumentState"));
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
10
+ 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); }
11
+ 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; } } }; }
12
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
13
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ 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); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
+ 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); } /**
19
+ * DocSpring API
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The TemplateDocumentSummary model module.
32
+ * @module model/TemplateDocumentSummary
33
+ * @version 4.2.0
34
+ */
35
+ var TemplateDocumentSummary = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>TemplateDocumentSummary</code>.
38
+ * A PDF template's PDF, as template lists show it.
39
+ * @alias module:model/TemplateDocumentSummary
40
+ * @param filename {String} The PDF's file name. Null until a `document_url` has been downloaded.
41
+ * @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
42
+ * @param error_message {String} Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
43
+ * @param page_count {Number} 0 until the PDF has been processed.
44
+ */
45
+ function TemplateDocumentSummary(filename, state, error_message, page_count) {
46
+ _classCallCheck(this, TemplateDocumentSummary);
47
+ TemplateDocumentSummary.initialize(this, filename, state, error_message, page_count);
48
+ }
49
+
50
+ /**
51
+ * Initializes the fields of this object.
52
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
53
+ * Only for internal use.
54
+ */
55
+ return _createClass(TemplateDocumentSummary, null, [{
56
+ key: "initialize",
57
+ value: function initialize(obj, filename, state, error_message, page_count) {
58
+ obj['filename'] = filename;
59
+ obj['state'] = state;
60
+ obj['error_message'] = error_message;
61
+ obj['page_count'] = page_count;
62
+ }
63
+
64
+ /**
65
+ * Constructs a <code>TemplateDocumentSummary</code> from a plain JavaScript object, optionally creating a new instance.
66
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
67
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
68
+ * @param {module:model/TemplateDocumentSummary} obj Optional instance to populate.
69
+ * @return {module:model/TemplateDocumentSummary} The populated <code>TemplateDocumentSummary</code> instance.
70
+ */
71
+ }, {
72
+ key: "constructFromObject",
73
+ value: function constructFromObject(data, obj) {
74
+ if (data) {
75
+ obj = obj || new TemplateDocumentSummary();
76
+ if (data.hasOwnProperty('filename')) {
77
+ obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
78
+ }
79
+ if (data.hasOwnProperty('state')) {
80
+ obj['state'] = _ApiClient["default"].convertToType(data['state'], _TemplateDocumentState["default"]);
81
+ }
82
+ if (data.hasOwnProperty('error_message')) {
83
+ obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
84
+ }
85
+ if (data.hasOwnProperty('page_count')) {
86
+ obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
87
+ }
88
+ }
89
+ return obj;
90
+ }
91
+
92
+ /**
93
+ * Validates the JSON data with respect to <code>TemplateDocumentSummary</code>.
94
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
95
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateDocumentSummary</code>.
96
+ */
97
+ }, {
98
+ key: "validateJSON",
99
+ value: function validateJSON(data) {
100
+ // check to make sure all required properties are present in the JSON string
101
+ var _iterator = _createForOfIteratorHelper(TemplateDocumentSummary.RequiredProperties),
102
+ _step;
103
+ try {
104
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
105
+ var property = _step.value;
106
+ if (!data.hasOwnProperty(property)) {
107
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
108
+ }
109
+ }
110
+ // ensure the json data is a string
111
+ } catch (err) {
112
+ _iterator.e(err);
113
+ } finally {
114
+ _iterator.f();
115
+ }
116
+ if (data['filename'] && !(typeof data['filename'] === 'string' || data['filename'] instanceof String)) {
117
+ throw new Error("Expected the field `filename` to be a primitive type in the JSON string but got " + data['filename']);
118
+ }
119
+ // ensure the json data is a string
120
+ if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
121
+ throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
122
+ }
123
+ return true;
124
+ }
125
+ }]);
126
+ }();
127
+ TemplateDocumentSummary.RequiredProperties = ["filename", "state", "error_message", "page_count"];
128
+
129
+ /**
130
+ * The PDF's file name. Null until a `document_url` has been downloaded.
131
+ * @member {String} filename
132
+ */
133
+ TemplateDocumentSummary.prototype['filename'] = undefined;
134
+
135
+ /**
136
+ * `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
137
+ * @member {module:model/TemplateDocumentState} state
138
+ */
139
+ TemplateDocumentSummary.prototype['state'] = undefined;
140
+
141
+ /**
142
+ * Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
143
+ * @member {String} error_message
144
+ */
145
+ TemplateDocumentSummary.prototype['error_message'] = undefined;
146
+
147
+ /**
148
+ * 0 until the PDF has been processed.
149
+ * @member {Number} page_count
150
+ */
151
+ TemplateDocumentSummary.prototype['page_count'] = undefined;
152
+ var _default = exports["default"] = TemplateDocumentSummary;
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateFieldChange model module.
32
32
  * @module model/TemplateFieldChange
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var TemplateFieldChange = /*#__PURE__*/function () {
36
36
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldChanges model module.
34
34
  * @module model/TemplateFieldChanges
35
- * @version 4.1.0
35
+ * @version 4.2.0
36
36
  */
37
37
  var TemplateFieldChanges = /*#__PURE__*/function () {
38
38
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldDependency model module.
34
34
  * @module model/TemplateFieldDependency
35
- * @version 4.1.0
35
+ * @version 4.2.0
36
36
  */
37
37
  var TemplateFieldDependency = /*#__PURE__*/function () {
38
38
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateFieldDependencyCondition model module.
32
32
  * @module model/TemplateFieldDependencyCondition
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var TemplateFieldDependencyCondition = /*#__PURE__*/function () {
36
36
  /**
@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
33
33
  /**
34
34
  * The TemplateFieldDependencyConditionInput model module.
35
35
  * @module model/TemplateFieldDependencyConditionInput
36
- * @version 4.1.0
36
+ * @version 4.2.0
37
37
  */
38
38
  var TemplateFieldDependencyConditionInput = /*#__PURE__*/function () {
39
39
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldDependencyInput model module.
34
34
  * @module model/TemplateFieldDependencyInput
35
- * @version 4.1.0
35
+ * @version 4.2.0
36
36
  */
37
37
  var TemplateFieldDependencyInput = /*#__PURE__*/function () {
38
38
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplateFieldMove model module.
31
31
  * @module model/TemplateFieldMove
32
- * @version 4.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var TemplateFieldMove = /*#__PURE__*/function () {
35
35
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateFields model module.
32
32
  * @module model/TemplateFields
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var TemplateFields = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateModelCode model module.
32
32
  * @module model/TemplateModelCode
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var TemplateModelCode = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplatePageImages model module.
32
32
  * @module model/TemplatePageImages
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var TemplatePageImages = /*#__PURE__*/function () {
36
36
  /**
@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
33
33
  /**
34
34
  * The TemplatePageProcessingStatus model module.
35
35
  * @module model/TemplatePageProcessingStatus
36
- * @version 4.1.0
36
+ * @version 4.2.0
37
37
  */
38
38
  var TemplatePageProcessingStatus = /*#__PURE__*/function () {
39
39
  /**
@@ -0,0 +1,211 @@
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
+ var _PageImage = _interopRequireDefault(require("./PageImage"));
9
+ var _TemplatePreviewState = _interopRequireDefault(require("./TemplatePreviewState"));
10
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
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); }
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; } } }; }
13
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
14
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
15
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
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
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
18
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
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
+ * DocSpring API
21
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
22
+ *
23
+ * The version of the OpenAPI document: v2
24
+ *
25
+ *
26
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
27
+ * https://openapi-generator.tech
28
+ * Do not edit the class manually.
29
+ *
30
+ */
31
+ /**
32
+ * The TemplatePreview model module.
33
+ * @module model/TemplatePreview
34
+ * @version 4.2.0
35
+ */
36
+ var TemplatePreview = /*#__PURE__*/function () {
37
+ /**
38
+ * Constructs a new <code>TemplatePreview</code>.
39
+ * PNG images of a template's pages filled in with data you send (not a PDF), to check how an HTML or PDF template prints with your data before you publish a version or send live data. A preview makes no submission and uses no credits. Its pages are watermarked like a test submission's PDF, and it's deleted an hour after it's created.
40
+ * @alias module:model/TemplatePreview
41
+ * @extends Object
42
+ * @param id {String} The preview's ID.
43
+ * @param template_id {String} The template's ID.
44
+ * @param version {String} The published version that was rendered, such as `1.2.0`. Null for the draft.
45
+ * @param state {module:model/TemplatePreviewState} `pending` while it renders (usually a few seconds), then `processed`, or `error` with an `error_message`.
46
+ * @param error_message {String} Why the preview couldn't be rendered, such as an error in an HTML template's Liquid, or a value in the data that a field can't print.
47
+ * @param page_count {Number} How many pages the template printed, once it's processed.
48
+ * @param pages {Array.<module:model/PageImage>} A PNG image of each page once it's processed, in order: `pages[0]` is page 1. A preview has no PDF. Their `download_url`s expire, so get the preview again when you need them.
49
+ * @param expires_at {Date} When the preview and its images are deleted.
50
+ */
51
+ function TemplatePreview(id, template_id, version, state, error_message, page_count, pages, expires_at) {
52
+ _classCallCheck(this, TemplatePreview);
53
+ TemplatePreview.initialize(this, id, template_id, version, state, error_message, page_count, pages, expires_at);
54
+ }
55
+
56
+ /**
57
+ * Initializes the fields of this object.
58
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
59
+ * Only for internal use.
60
+ */
61
+ return _createClass(TemplatePreview, null, [{
62
+ key: "initialize",
63
+ value: function initialize(obj, id, template_id, version, state, error_message, page_count, pages, expires_at) {
64
+ obj['id'] = id;
65
+ obj['template_id'] = template_id;
66
+ obj['version'] = version;
67
+ obj['state'] = state;
68
+ obj['error_message'] = error_message;
69
+ obj['page_count'] = page_count;
70
+ obj['pages'] = pages;
71
+ obj['expires_at'] = expires_at;
72
+ }
73
+
74
+ /**
75
+ * Constructs a <code>TemplatePreview</code> from a plain JavaScript object, optionally creating a new instance.
76
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
77
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
78
+ * @param {module:model/TemplatePreview} obj Optional instance to populate.
79
+ * @return {module:model/TemplatePreview} The populated <code>TemplatePreview</code> instance.
80
+ */
81
+ }, {
82
+ key: "constructFromObject",
83
+ value: function constructFromObject(data, obj) {
84
+ if (data) {
85
+ obj = obj || new TemplatePreview();
86
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
87
+ if (data.hasOwnProperty('id')) {
88
+ obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
89
+ }
90
+ if (data.hasOwnProperty('template_id')) {
91
+ obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
92
+ }
93
+ if (data.hasOwnProperty('version')) {
94
+ obj['version'] = _ApiClient["default"].convertToType(data['version'], 'String');
95
+ }
96
+ if (data.hasOwnProperty('state')) {
97
+ obj['state'] = _ApiClient["default"].convertToType(data['state'], _TemplatePreviewState["default"]);
98
+ }
99
+ if (data.hasOwnProperty('error_message')) {
100
+ obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
101
+ }
102
+ if (data.hasOwnProperty('page_count')) {
103
+ obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
104
+ }
105
+ if (data.hasOwnProperty('pages')) {
106
+ obj['pages'] = _ApiClient["default"].convertToType(data['pages'], [_PageImage["default"]]);
107
+ }
108
+ if (data.hasOwnProperty('expires_at')) {
109
+ obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
110
+ }
111
+ }
112
+ return obj;
113
+ }
114
+
115
+ /**
116
+ * Validates the JSON data with respect to <code>TemplatePreview</code>.
117
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
118
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplatePreview</code>.
119
+ */
120
+ }, {
121
+ key: "validateJSON",
122
+ value: function validateJSON(data) {
123
+ // check to make sure all required properties are present in the JSON string
124
+ var _iterator = _createForOfIteratorHelper(TemplatePreview.RequiredProperties),
125
+ _step;
126
+ try {
127
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
128
+ var property = _step.value;
129
+ if (!data.hasOwnProperty(property)) {
130
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
131
+ }
132
+ }
133
+ // ensure the json data is a string
134
+ } catch (err) {
135
+ _iterator.e(err);
136
+ } finally {
137
+ _iterator.f();
138
+ }
139
+ if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
140
+ throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
141
+ }
142
+ // ensure the json data is a string
143
+ if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
144
+ throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
145
+ }
146
+ // ensure the json data is a string
147
+ if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
148
+ throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
149
+ }
150
+ // ensure the json data is a string
151
+ if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
152
+ throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
153
+ }
154
+ // ensure the json data is an array
155
+ if (!Array.isArray(data['pages'])) {
156
+ throw new Error("Expected the field `pages` to be an array in the JSON data but got " + data['pages']);
157
+ }
158
+ return true;
159
+ }
160
+ }]);
161
+ }();
162
+ TemplatePreview.RequiredProperties = ["id", "template_id", "version", "state", "error_message", "page_count", "pages", "expires_at"];
163
+
164
+ /**
165
+ * The preview's ID.
166
+ * @member {String} id
167
+ */
168
+ TemplatePreview.prototype['id'] = undefined;
169
+
170
+ /**
171
+ * The template's ID.
172
+ * @member {String} template_id
173
+ */
174
+ TemplatePreview.prototype['template_id'] = undefined;
175
+
176
+ /**
177
+ * The published version that was rendered, such as `1.2.0`. Null for the draft.
178
+ * @member {String} version
179
+ */
180
+ TemplatePreview.prototype['version'] = undefined;
181
+
182
+ /**
183
+ * `pending` while it renders (usually a few seconds), then `processed`, or `error` with an `error_message`.
184
+ * @member {module:model/TemplatePreviewState} state
185
+ */
186
+ TemplatePreview.prototype['state'] = undefined;
187
+
188
+ /**
189
+ * Why the preview couldn't be rendered, such as an error in an HTML template's Liquid, or a value in the data that a field can't print.
190
+ * @member {String} error_message
191
+ */
192
+ TemplatePreview.prototype['error_message'] = undefined;
193
+
194
+ /**
195
+ * How many pages the template printed, once it's processed.
196
+ * @member {Number} page_count
197
+ */
198
+ TemplatePreview.prototype['page_count'] = undefined;
199
+
200
+ /**
201
+ * A PNG image of each page once it's processed, in order: `pages[0]` is page 1. A preview has no PDF. Their `download_url`s expire, so get the preview again when you need them.
202
+ * @member {Array.<module:model/PageImage>} pages
203
+ */
204
+ TemplatePreview.prototype['pages'] = undefined;
205
+
206
+ /**
207
+ * When the preview and its images are deleted.
208
+ * @member {Date} expires_at
209
+ */
210
+ TemplatePreview.prototype['expires_at'] = undefined;
211
+ var _default = exports["default"] = TemplatePreview;
@@ -0,0 +1,64 @@
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 TemplatePreviewState.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var TemplatePreviewState = exports["default"] = /*#__PURE__*/function () {
33
+ function TemplatePreviewState() {
34
+ _classCallCheck(this, TemplatePreviewState);
35
+ }
36
+ return _createClass(TemplatePreviewState, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>TemplatePreviewState</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/TemplatePreviewState} The enum <code>TemplatePreviewState</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(TemplatePreviewState, "pending", "pending");
55
+ /**
56
+ * value: "processed"
57
+ * @const
58
+ */
59
+ _defineProperty(TemplatePreviewState, "processed", "processed");
60
+ /**
61
+ * value: "error"
62
+ * @const
63
+ */
64
+ _defineProperty(TemplatePreviewState, "error", "error");
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplateSourcePdf model module.
31
31
  * @module model/TemplateSourcePdf
32
- * @version 4.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var TemplateSourcePdf = /*#__PURE__*/function () {
35
35
  /**