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
@@ -1,228 +0,0 @@
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 _SubmissionPreview = _interopRequireDefault(require("./SubmissionPreview"));
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. 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
- *
22
- * The version of the OpenAPI document: v1
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 SubmissionBatchWithSubmissions model module.
32
- * @module model/SubmissionBatchWithSubmissions
33
- * @version 3.3.0
34
- */
35
- var SubmissionBatchWithSubmissions = /*#__PURE__*/function () {
36
- /**
37
- * Constructs a new <code>SubmissionBatchWithSubmissions</code>.
38
- * @alias module:model/SubmissionBatchWithSubmissions
39
- * @extends Object
40
- * @param id {String}
41
- * @param state {module:model/SubmissionBatchWithSubmissions.StateEnum}
42
- * @param metadata {Object}
43
- * @param processed_at {String}
44
- * @param total_count {Number}
45
- * @param pending_count {Number}
46
- * @param error_count {Number}
47
- * @param completion_percentage {Number}
48
- */
49
- function SubmissionBatchWithSubmissions(id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage) {
50
- _classCallCheck(this, SubmissionBatchWithSubmissions);
51
- SubmissionBatchWithSubmissions.initialize(this, id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage);
52
- }
53
-
54
- /**
55
- * Initializes the fields of this object.
56
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
57
- * Only for internal use.
58
- */
59
- return _createClass(SubmissionBatchWithSubmissions, null, [{
60
- key: "initialize",
61
- value: function initialize(obj, id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage) {
62
- obj['id'] = id;
63
- obj['state'] = state;
64
- obj['metadata'] = metadata;
65
- obj['processed_at'] = processed_at;
66
- obj['total_count'] = total_count;
67
- obj['pending_count'] = pending_count;
68
- obj['error_count'] = error_count;
69
- obj['completion_percentage'] = completion_percentage;
70
- }
71
-
72
- /**
73
- * Constructs a <code>SubmissionBatchWithSubmissions</code> from a plain JavaScript object, optionally creating a new instance.
74
- * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
75
- * @param {Object} data The plain JavaScript object bearing properties of interest.
76
- * @param {module:model/SubmissionBatchWithSubmissions} obj Optional instance to populate.
77
- * @return {module:model/SubmissionBatchWithSubmissions} The populated <code>SubmissionBatchWithSubmissions</code> instance.
78
- */
79
- }, {
80
- key: "constructFromObject",
81
- value: function constructFromObject(data, obj) {
82
- if (data) {
83
- obj = obj || new SubmissionBatchWithSubmissions();
84
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
85
- if (data.hasOwnProperty('id')) {
86
- obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
87
- }
88
- if (data.hasOwnProperty('state')) {
89
- obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
90
- }
91
- if (data.hasOwnProperty('metadata')) {
92
- obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
93
- }
94
- if (data.hasOwnProperty('processed_at')) {
95
- obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'String');
96
- }
97
- if (data.hasOwnProperty('total_count')) {
98
- obj['total_count'] = _ApiClient["default"].convertToType(data['total_count'], 'Number');
99
- }
100
- if (data.hasOwnProperty('pending_count')) {
101
- obj['pending_count'] = _ApiClient["default"].convertToType(data['pending_count'], 'Number');
102
- }
103
- if (data.hasOwnProperty('error_count')) {
104
- obj['error_count'] = _ApiClient["default"].convertToType(data['error_count'], 'Number');
105
- }
106
- if (data.hasOwnProperty('completion_percentage')) {
107
- obj['completion_percentage'] = _ApiClient["default"].convertToType(data['completion_percentage'], 'Number');
108
- }
109
- if (data.hasOwnProperty('submissions')) {
110
- obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_SubmissionPreview["default"]]);
111
- }
112
- }
113
- return obj;
114
- }
115
-
116
- /**
117
- * Validates the JSON data with respect to <code>SubmissionBatchWithSubmissions</code>.
118
- * @param {Object} data The plain JavaScript object bearing properties of interest.
119
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SubmissionBatchWithSubmissions</code>.
120
- */
121
- }, {
122
- key: "validateJSON",
123
- value: function validateJSON(data) {
124
- // check to make sure all required properties are present in the JSON string
125
- var _iterator = _createForOfIteratorHelper(SubmissionBatchWithSubmissions.RequiredProperties),
126
- _step;
127
- try {
128
- for (_iterator.s(); !(_step = _iterator.n()).done;) {
129
- var property = _step.value;
130
- if (!data.hasOwnProperty(property)) {
131
- throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
132
- }
133
- }
134
- // ensure the json data is a string
135
- } catch (err) {
136
- _iterator.e(err);
137
- } finally {
138
- _iterator.f();
139
- }
140
- if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
141
- throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
142
- }
143
- // ensure the json data is a string
144
- if (data['state'] && !(typeof data['state'] === 'string' || data['state'] instanceof String)) {
145
- throw new Error("Expected the field `state` to be a primitive type in the JSON string but got " + data['state']);
146
- }
147
- // ensure the json data is a string
148
- if (data['processed_at'] && !(typeof data['processed_at'] === 'string' || data['processed_at'] instanceof String)) {
149
- throw new Error("Expected the field `processed_at` to be a primitive type in the JSON string but got " + data['processed_at']);
150
- }
151
- // ensure the json data is an array
152
- if (!Array.isArray(data['submissions'])) {
153
- throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
154
- }
155
- return true;
156
- }
157
- }]);
158
- }();
159
- SubmissionBatchWithSubmissions.RequiredProperties = ["id", "state", "metadata", "processed_at", "total_count", "pending_count", "error_count", "completion_percentage"];
160
-
161
- /**
162
- * @member {String} id
163
- */
164
- SubmissionBatchWithSubmissions.prototype['id'] = undefined;
165
-
166
- /**
167
- * @member {module:model/SubmissionBatchWithSubmissions.StateEnum} state
168
- */
169
- SubmissionBatchWithSubmissions.prototype['state'] = undefined;
170
-
171
- /**
172
- * @member {Object} metadata
173
- */
174
- SubmissionBatchWithSubmissions.prototype['metadata'] = undefined;
175
-
176
- /**
177
- * @member {String} processed_at
178
- */
179
- SubmissionBatchWithSubmissions.prototype['processed_at'] = undefined;
180
-
181
- /**
182
- * @member {Number} total_count
183
- */
184
- SubmissionBatchWithSubmissions.prototype['total_count'] = undefined;
185
-
186
- /**
187
- * @member {Number} pending_count
188
- */
189
- SubmissionBatchWithSubmissions.prototype['pending_count'] = undefined;
190
-
191
- /**
192
- * @member {Number} error_count
193
- */
194
- SubmissionBatchWithSubmissions.prototype['error_count'] = undefined;
195
-
196
- /**
197
- * @member {Number} completion_percentage
198
- */
199
- SubmissionBatchWithSubmissions.prototype['completion_percentage'] = undefined;
200
-
201
- /**
202
- * @member {Array.<module:model/SubmissionPreview>} submissions
203
- */
204
- SubmissionBatchWithSubmissions.prototype['submissions'] = undefined;
205
-
206
- /**
207
- * Allowed values for the <code>state</code> property.
208
- * @enum {String}
209
- * @readonly
210
- */
211
- SubmissionBatchWithSubmissions['StateEnum'] = {
212
- /**
213
- * value: "pending"
214
- * @const
215
- */
216
- "pending": "pending",
217
- /**
218
- * value: "processed"
219
- * @const
220
- */
221
- "processed": "processed",
222
- /**
223
- * value: "error"
224
- * @const
225
- */
226
- "error": "error"
227
- };
228
- var _default = exports["default"] = SubmissionBatchWithSubmissions;