docspring 3.3.0 → 4.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 (184) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +74 -63
  3. package/dist/ApiClient.js +63 -28
  4. package/dist/RequestSchemas.js +3452 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1769 -921
  7. package/dist/index.js +847 -154
  8. package/dist/model/AddTemplateFieldsRequest.js +132 -0
  9. package/dist/model/AiFieldNamingLanguage.js +64 -0
  10. package/dist/model/{CreateWebhookData.js → AuthenticationCheck.js} +32 -28
  11. package/dist/model/BarcodeSymbology.js +89 -0
  12. package/dist/model/CheckCharacter.js +74 -0
  13. package/dist/model/CombinedFieldType.js +59 -0
  14. package/dist/model/CombinedPdf.js +294 -0
  15. package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +27 -27
  16. package/dist/model/CombinedPdfList.js +132 -0
  17. package/dist/model/{ForbiddenErrorResponse.js → CombinedPdfSource.js} +59 -73
  18. package/dist/model/CombinedPdfSourceInput.js +270 -0
  19. package/dist/model/CombinedPdfSourcePdf.js +130 -0
  20. package/dist/model/CombinedPdfSourceType.js +74 -0
  21. package/dist/model/CombinedPdfState.js +74 -0
  22. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +26 -22
  23. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +69 -53
  24. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +25 -23
  25. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +47 -28
  26. package/dist/model/{CreateCustomFileResponse.js → CreateSignatureRequestEventRequest.js} +49 -73
  27. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  28. package/dist/model/CreateSubmissionBatchRequest.js +192 -0
  29. package/dist/model/CreateSubmissionRequest.js +226 -0
  30. package/dist/model/CreateTemplateRequest.js +613 -0
  31. package/dist/model/CreateWebhookRequest.js +234 -0
  32. package/dist/model/CustomFile.js +67 -16
  33. package/dist/model/CustomFileList.js +132 -0
  34. package/dist/model/CustomFileSourcePdf.js +130 -0
  35. package/dist/model/ErrorCode.js +154 -0
  36. package/dist/model/{CreateSubmissionResponse.js → ErrorDetail.js} +65 -75
  37. package/dist/model/ErrorInfo.js +211 -0
  38. package/dist/model/ErrorResponse.js +12 -41
  39. package/dist/model/ExpirationInterval.js +64 -0
  40. package/dist/model/Field.js +1230 -0
  41. package/dist/model/FieldComparisonCondition.js +137 -0
  42. package/dist/model/FieldComparisonOperator.js +69 -0
  43. package/dist/model/FieldDependency.js +154 -0
  44. package/dist/model/FieldDependencyInput.js +154 -0
  45. package/dist/model/FieldDisplayType.js +79 -0
  46. package/dist/model/{MultipleErrorsResponse.js → FieldEqualsCondition.js} +48 -52
  47. package/dist/model/FieldEqualsOperator.js +59 -0
  48. package/dist/model/FieldGroup.js +206 -0
  49. package/dist/model/FieldGroupInput.js +180 -0
  50. package/dist/model/FieldGroupType.js +59 -0
  51. package/dist/model/{SuccessMultipleErrorsResponse.js → FieldInCondition.js} +54 -53
  52. package/dist/model/FieldInput.js +1012 -0
  53. package/dist/model/FieldOverride.js +722 -0
  54. package/dist/model/FieldPresenceCondition.js +126 -0
  55. package/dist/model/FieldPresenceOperator.js +59 -0
  56. package/dist/model/FieldRangeCondition.js +148 -0
  57. package/dist/model/FieldReimportState.js +69 -0
  58. package/dist/model/FieldSetupLogic.js +59 -0
  59. package/dist/model/FieldSetupNaming.js +59 -0
  60. package/dist/model/FieldSetupSource.js +64 -0
  61. package/dist/model/FieldType.js +124 -0
  62. package/dist/model/Folder.js +38 -11
  63. package/dist/model/FolderList.js +132 -0
  64. package/dist/model/GenerateFilesFormat.js +54 -0
  65. package/dist/model/GenerateSubmissionFilesRequest.js +115 -0
  66. package/dist/model/GeneratedFile.js +214 -0
  67. package/dist/model/GeneratedFileState.js +64 -0
  68. package/dist/model/HtmlEngineOptions.js +230 -0
  69. package/dist/model/HtmlEngineOptionsInput.js +193 -0
  70. package/dist/model/ImageGravity.js +94 -0
  71. package/dist/model/ImageScaleType.js +64 -0
  72. package/dist/model/ModelCodeLanguage.js +94 -0
  73. package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +34 -28
  74. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +25 -35
  75. package/dist/model/NumberConditionType.js +79 -0
  76. package/dist/model/OutputFormat.js +59 -0
  77. package/dist/model/PageFormat.js +114 -0
  78. package/dist/model/PageImage.js +220 -0
  79. package/dist/model/{TemplateDeleteResponse.js → PageImages.js} +57 -70
  80. package/dist/model/PredefinedField.js +183 -0
  81. package/dist/model/PredefinedFieldInput.js +183 -0
  82. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +33 -33
  83. package/dist/model/{AddFieldsData.js → RemoveTemplateFieldsRequest.js} +32 -30
  84. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +25 -23
  85. package/dist/model/ReorderTemplateFieldsRequest.js +114 -0
  86. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +25 -23
  87. package/dist/model/ShapeType.js +79 -0
  88. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +165 -240
  89. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  90. package/dist/model/SignatureRequestAuthType.js +84 -0
  91. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +67 -149
  92. package/dist/model/SignatureRequestEventType.js +79 -0
  93. package/dist/model/SignatureRequestInput.js +278 -0
  94. package/dist/model/SignatureRequestMessageType.js +94 -0
  95. package/dist/model/SignatureRequestState.js +64 -0
  96. package/dist/model/SignatureRequestToken.js +195 -0
  97. package/dist/model/SignatureRequestTokenType.js +59 -0
  98. package/dist/model/StringConditionType.js +74 -0
  99. package/dist/model/Submission.js +198 -341
  100. package/dist/model/SubmissionAction.js +30 -115
  101. package/dist/model/SubmissionActionState.js +69 -0
  102. package/dist/model/SubmissionActionType.js +84 -0
  103. package/dist/model/SubmissionBatch.js +74 -55
  104. package/dist/model/SubmissionBatchState.js +64 -0
  105. package/dist/model/SubmissionFiles.js +117 -0
  106. package/dist/model/SubmissionInput.js +218 -0
  107. package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +35 -42
  108. package/dist/model/SubmissionSource.js +69 -0
  109. package/dist/model/SubmissionSourcePdf.js +130 -0
  110. package/dist/model/SubmissionState.js +114 -0
  111. package/dist/model/{SubmissionBatchData.js → SubmissionValidation.js} +46 -48
  112. package/dist/model/Template.js +359 -560
  113. package/dist/model/TemplateActor.js +171 -0
  114. package/dist/model/TemplateActorType.js +64 -0
  115. package/dist/model/TemplateDefaults.js +307 -0
  116. package/dist/model/TemplateDefaultsInput.js +305 -0
  117. package/dist/model/TemplateDiff.js +206 -0
  118. package/dist/model/TemplateDiffSummary.js +165 -0
  119. package/dist/model/TemplateDocument.js +280 -0
  120. package/dist/model/TemplateDocumentState.js +84 -0
  121. package/dist/model/TemplateFieldChange.js +146 -0
  122. package/dist/model/TemplateFieldChanges.js +196 -0
  123. package/dist/model/{CreatePdfSubmissionData.js → TemplateFieldDependency.js} +70 -89
  124. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  125. package/dist/model/{TemplatePublishVersionResponse.js → TemplateFieldDependencyCondition.js} +51 -61
  126. package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
  127. package/dist/model/TemplateFieldDependencyInput.js +182 -0
  128. package/dist/model/TemplateFieldDependencyMatch.js +59 -0
  129. package/dist/model/TemplateFieldDependencyOperator.js +99 -0
  130. package/dist/model/TemplateFieldLogicStatus.js +74 -0
  131. package/dist/model/{CreatePdfTemplate.js → TemplateFieldMove.js} +52 -28
  132. package/dist/model/TemplateFields.js +147 -0
  133. package/dist/model/TemplateFormMode.js +64 -0
  134. package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +34 -86
  135. package/dist/model/TemplatePageAiError.js +69 -0
  136. package/dist/model/TemplatePageAiNamingStatus.js +59 -0
  137. package/dist/model/TemplatePageFieldsStatus.js +74 -0
  138. package/dist/model/TemplatePageImageStatus.js +59 -0
  139. package/dist/model/TemplatePageImages.js +158 -0
  140. package/dist/model/TemplatePageProcessingStatus.js +162 -0
  141. package/dist/model/{SubmissionDataRequestToken.js → TemplateSourcePdf.js} +52 -56
  142. package/dist/model/TemplateSummary.js +560 -0
  143. package/dist/model/{SuccessErrorResponse.js → TemplateSummaryList.js} +43 -55
  144. package/dist/model/TemplateType.js +59 -0
  145. package/dist/model/{Submission422Response.js → TemplateVersion.js} +60 -63
  146. package/dist/model/TemplateVersionType.js +64 -0
  147. package/dist/model/TextAlignment.js +69 -0
  148. package/dist/model/TextOverflow.js +59 -0
  149. package/dist/model/TextVerticalAlignment.js +64 -0
  150. package/dist/model/Typeface.js +134 -0
  151. package/dist/model/UpdateSignatureRequestRequest.js +183 -0
  152. package/dist/model/UpdateTemplateDocumentRequest.js +139 -0
  153. package/dist/model/UpdateTemplateFieldsRequest.js +132 -0
  154. package/dist/model/UpdateTemplateRequest.js +523 -0
  155. package/dist/model/UpdateWebhookRequest.js +209 -0
  156. package/dist/model/UploadMethod.js +54 -0
  157. package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +53 -58
  158. package/dist/model/UrlSourcePdf.js +130 -0
  159. package/dist/model/ValidateSubmissionRequest.js +226 -0
  160. package/dist/model/Webhook.js +58 -73
  161. package/dist/model/WebhookEventType.js +174 -0
  162. package/dist/model/WebhookList.js +132 -0
  163. package/dist/model/WebhookMode.js +59 -0
  164. package/package.json +1 -1
  165. package/dist/model/BatchGeneratePdfs201Response.js +0 -194
  166. package/dist/model/CombinedSubmission.js +0 -313
  167. package/dist/model/CombinedSubmissionAction.js +0 -268
  168. package/dist/model/CreateCombinedSubmissionResponse.js +0 -180
  169. package/dist/model/CreateHtmlTemplate.js +0 -108
  170. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  171. package/dist/model/CreateSubmissionDataRequestEventRequest.js +0 -239
  172. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -167
  173. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -167
  174. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -167
  175. package/dist/model/ErrorOrMultipleErrorsResponse.js +0 -153
  176. package/dist/model/JsonSchema.js +0 -205
  177. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  178. package/dist/model/SubmissionDataRequest.js +0 -496
  179. package/dist/model/SubmissionPreview.js +0 -509
  180. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  181. package/dist/model/TemplatePreview.js +0 -796
  182. package/dist/model/UpdateHtmlTemplate.js +0 -108
  183. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  184. package/dist/model/UpdateWebhookData.js +0 -108
@@ -0,0 +1,174 @@
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 WebhookEventType.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var WebhookEventType = exports["default"] = /*#__PURE__*/function () {
33
+ function WebhookEventType() {
34
+ _classCallCheck(this, WebhookEventType);
35
+ }
36
+ return _createClass(WebhookEventType, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>WebhookEventType</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/WebhookEventType} The enum <code>WebhookEventType</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: "submission.processed"
52
+ * @const
53
+ */
54
+ _defineProperty(WebhookEventType, "submission.processed", "submission.processed");
55
+ /**
56
+ * value: "submission.failed"
57
+ * @const
58
+ */
59
+ _defineProperty(WebhookEventType, "submission.failed", "submission.failed");
60
+ /**
61
+ * value: "submission.declined"
62
+ * @const
63
+ */
64
+ _defineProperty(WebhookEventType, "submission.declined", "submission.declined");
65
+ /**
66
+ * value: "signature_request.viewed"
67
+ * @const
68
+ */
69
+ _defineProperty(WebhookEventType, "signature_request.viewed", "signature_request.viewed");
70
+ /**
71
+ * value: "signature_request.completed"
72
+ * @const
73
+ */
74
+ _defineProperty(WebhookEventType, "signature_request.completed", "signature_request.completed");
75
+ /**
76
+ * value: "signature_request.declined"
77
+ * @const
78
+ */
79
+ _defineProperty(WebhookEventType, "signature_request.declined", "signature_request.declined");
80
+ /**
81
+ * value: "combined_pdf.processed"
82
+ * @const
83
+ */
84
+ _defineProperty(WebhookEventType, "combined_pdf.processed", "combined_pdf.processed");
85
+ /**
86
+ * value: "combined_pdf.failed"
87
+ * @const
88
+ */
89
+ _defineProperty(WebhookEventType, "combined_pdf.failed", "combined_pdf.failed");
90
+ /**
91
+ * value: "submission_batch.processed"
92
+ * @const
93
+ */
94
+ _defineProperty(WebhookEventType, "submission_batch.processed", "submission_batch.processed");
95
+ /**
96
+ * value: "submission_batch.failed"
97
+ * @const
98
+ */
99
+ _defineProperty(WebhookEventType, "submission_batch.failed", "submission_batch.failed");
100
+ /**
101
+ * value: "submission.created"
102
+ * @const
103
+ */
104
+ _defineProperty(WebhookEventType, "submission.created", "submission.created");
105
+ /**
106
+ * value: "submission.updated"
107
+ * @const
108
+ */
109
+ _defineProperty(WebhookEventType, "submission.updated", "submission.updated");
110
+ /**
111
+ * value: "submission.expired"
112
+ * @const
113
+ */
114
+ _defineProperty(WebhookEventType, "submission.expired", "submission.expired");
115
+ /**
116
+ * value: "signature_request.updated"
117
+ * @const
118
+ */
119
+ _defineProperty(WebhookEventType, "signature_request.updated", "signature_request.updated");
120
+ /**
121
+ * value: "combined_pdf.expired"
122
+ * @const
123
+ */
124
+ _defineProperty(WebhookEventType, "combined_pdf.expired", "combined_pdf.expired");
125
+ /**
126
+ * value: "template.created"
127
+ * @const
128
+ */
129
+ _defineProperty(WebhookEventType, "template.created", "template.created");
130
+ /**
131
+ * value: "template.updated"
132
+ * @const
133
+ */
134
+ _defineProperty(WebhookEventType, "template.updated", "template.updated");
135
+ /**
136
+ * value: "template.deleted"
137
+ * @const
138
+ */
139
+ _defineProperty(WebhookEventType, "template.deleted", "template.deleted");
140
+ /**
141
+ * value: "webhook.created"
142
+ * @const
143
+ */
144
+ _defineProperty(WebhookEventType, "webhook.created", "webhook.created");
145
+ /**
146
+ * value: "webhook.updated"
147
+ * @const
148
+ */
149
+ _defineProperty(WebhookEventType, "webhook.updated", "webhook.updated");
150
+ /**
151
+ * value: "webhook.deleted"
152
+ * @const
153
+ */
154
+ _defineProperty(WebhookEventType, "webhook.deleted", "webhook.deleted");
155
+ /**
156
+ * value: "custom_file.created"
157
+ * @const
158
+ */
159
+ _defineProperty(WebhookEventType, "custom_file.created", "custom_file.created");
160
+ /**
161
+ * value: "folder.created"
162
+ * @const
163
+ */
164
+ _defineProperty(WebhookEventType, "folder.created", "folder.created");
165
+ /**
166
+ * value: "folder.updated"
167
+ * @const
168
+ */
169
+ _defineProperty(WebhookEventType, "folder.updated", "folder.updated");
170
+ /**
171
+ * value: "folder.deleted"
172
+ * @const
173
+ */
174
+ _defineProperty(WebhookEventType, "folder.deleted", "folder.deleted");
@@ -0,0 +1,132 @@
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 _Webhook = _interopRequireDefault(require("./Webhook"));
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 WebhookList model module.
32
+ * @module model/WebhookList
33
+ * @version 4.1.0
34
+ */
35
+ var WebhookList = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>WebhookList</code>.
38
+ * A page of webhooks, newest first.
39
+ * @alias module:model/WebhookList
40
+ * @extends Object
41
+ * @param data {Array.<module:model/Webhook>} The items on this page.
42
+ * @param next_cursor {String} Pass it as `cursor` to get the next page. Null on the last page.
43
+ */
44
+ function WebhookList(data, next_cursor) {
45
+ _classCallCheck(this, WebhookList);
46
+ WebhookList.initialize(this, data, next_cursor);
47
+ }
48
+
49
+ /**
50
+ * Initializes the fields of this object.
51
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
52
+ * Only for internal use.
53
+ */
54
+ return _createClass(WebhookList, null, [{
55
+ key: "initialize",
56
+ value: function initialize(obj, data, next_cursor) {
57
+ obj['data'] = data;
58
+ obj['next_cursor'] = next_cursor;
59
+ }
60
+
61
+ /**
62
+ * Constructs a <code>WebhookList</code> from a plain JavaScript object, optionally creating a new instance.
63
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
64
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
65
+ * @param {module:model/WebhookList} obj Optional instance to populate.
66
+ * @return {module:model/WebhookList} The populated <code>WebhookList</code> instance.
67
+ */
68
+ }, {
69
+ key: "constructFromObject",
70
+ value: function constructFromObject(data, obj) {
71
+ if (data) {
72
+ obj = obj || new WebhookList();
73
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
74
+ if (data.hasOwnProperty('data')) {
75
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], [_Webhook["default"]]);
76
+ }
77
+ if (data.hasOwnProperty('next_cursor')) {
78
+ obj['next_cursor'] = _ApiClient["default"].convertToType(data['next_cursor'], 'String');
79
+ }
80
+ }
81
+ return obj;
82
+ }
83
+
84
+ /**
85
+ * Validates the JSON data with respect to <code>WebhookList</code>.
86
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
87
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>WebhookList</code>.
88
+ */
89
+ }, {
90
+ key: "validateJSON",
91
+ value: function validateJSON(data) {
92
+ // check to make sure all required properties are present in the JSON string
93
+ var _iterator = _createForOfIteratorHelper(WebhookList.RequiredProperties),
94
+ _step;
95
+ try {
96
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
97
+ var property = _step.value;
98
+ if (!data.hasOwnProperty(property)) {
99
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
100
+ }
101
+ }
102
+ // ensure the json data is an array
103
+ } catch (err) {
104
+ _iterator.e(err);
105
+ } finally {
106
+ _iterator.f();
107
+ }
108
+ if (!Array.isArray(data['data'])) {
109
+ throw new Error("Expected the field `data` to be an array in the JSON data but got " + data['data']);
110
+ }
111
+ // ensure the json data is a string
112
+ if (data['next_cursor'] && !(typeof data['next_cursor'] === 'string' || data['next_cursor'] instanceof String)) {
113
+ throw new Error("Expected the field `next_cursor` to be a primitive type in the JSON string but got " + data['next_cursor']);
114
+ }
115
+ return true;
116
+ }
117
+ }]);
118
+ }();
119
+ WebhookList.RequiredProperties = ["data", "next_cursor"];
120
+
121
+ /**
122
+ * The items on this page.
123
+ * @member {Array.<module:model/Webhook>} data
124
+ */
125
+ WebhookList.prototype['data'] = undefined;
126
+
127
+ /**
128
+ * Pass it as `cursor` to get the next page. Null on the last page.
129
+ * @member {String} next_cursor
130
+ */
131
+ WebhookList.prototype['next_cursor'] = undefined;
132
+ var _default = exports["default"] = WebhookList;
@@ -0,0 +1,59 @@
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 WebhookMode.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var WebhookMode = exports["default"] = /*#__PURE__*/function () {
33
+ function WebhookMode() {
34
+ _classCallCheck(this, WebhookMode);
35
+ }
36
+ return _createClass(WebhookMode, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>WebhookMode</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/WebhookMode} The enum <code>WebhookMode</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: "test"
52
+ * @const
53
+ */
54
+ _defineProperty(WebhookMode, "test", "test");
55
+ /**
56
+ * value: "live"
57
+ * @const
58
+ */
59
+ _defineProperty(WebhookMode, "live", "live");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docspring",
3
- "version": "3.3.0",
3
+ "version": "4.1.0",
4
4
  "description": "An API client for the DocSpring PDF generation service",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
@@ -1,194 +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 _SubmissionBatch = _interopRequireDefault(require("./SubmissionBatch"));
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 BatchGeneratePdfs201Response model module.
32
- * @module model/BatchGeneratePdfs201Response
33
- * @version 3.3.0
34
- */
35
- var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
36
- /**
37
- * Constructs a new <code>BatchGeneratePdfs201Response</code>.
38
- * @alias module:model/BatchGeneratePdfs201Response
39
- * @extends Object
40
- * @param status {module:model/BatchGeneratePdfs201Response.StatusEnum}
41
- * @param submission_batch {module:model/SubmissionBatch}
42
- * @param submissions {Array.<Object>}
43
- */
44
- function BatchGeneratePdfs201Response(status, submission_batch, submissions) {
45
- _classCallCheck(this, BatchGeneratePdfs201Response);
46
- BatchGeneratePdfs201Response.initialize(this, status, submission_batch, submissions);
47
- }
48
-
49
- /**
50
- * Initializes the fields of this object.
51
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
52
- * Only for internal use.
53
- */
54
- return _createClass(BatchGeneratePdfs201Response, null, [{
55
- key: "initialize",
56
- value: function initialize(obj, status, submission_batch, submissions) {
57
- obj['status'] = status;
58
- obj['submission_batch'] = submission_batch;
59
- obj['submissions'] = submissions;
60
- }
61
-
62
- /**
63
- * Constructs a <code>BatchGeneratePdfs201Response</code> from a plain JavaScript object, optionally creating a new instance.
64
- * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
65
- * @param {Object} data The plain JavaScript object bearing properties of interest.
66
- * @param {module:model/BatchGeneratePdfs201Response} obj Optional instance to populate.
67
- * @return {module:model/BatchGeneratePdfs201Response} The populated <code>BatchGeneratePdfs201Response</code> instance.
68
- */
69
- }, {
70
- key: "constructFromObject",
71
- value: function constructFromObject(data, obj) {
72
- if (data) {
73
- obj = obj || new BatchGeneratePdfs201Response();
74
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
75
- if (data.hasOwnProperty('status')) {
76
- obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
77
- }
78
- if (data.hasOwnProperty('error')) {
79
- obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
80
- }
81
- if (data.hasOwnProperty('errors')) {
82
- obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
83
- }
84
- if (data.hasOwnProperty('submission_batch')) {
85
- obj['submission_batch'] = _SubmissionBatch["default"].constructFromObject(data['submission_batch']);
86
- }
87
- if (data.hasOwnProperty('submissions')) {
88
- obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [Object]);
89
- }
90
- if (data.hasOwnProperty('code')) {
91
- obj['code'] = _ApiClient["default"].convertToType(data['code'], 'String');
92
- }
93
- }
94
- return obj;
95
- }
96
-
97
- /**
98
- * Validates the JSON data with respect to <code>BatchGeneratePdfs201Response</code>.
99
- * @param {Object} data The plain JavaScript object bearing properties of interest.
100
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>BatchGeneratePdfs201Response</code>.
101
- */
102
- }, {
103
- key: "validateJSON",
104
- value: function validateJSON(data) {
105
- // check to make sure all required properties are present in the JSON string
106
- var _iterator = _createForOfIteratorHelper(BatchGeneratePdfs201Response.RequiredProperties),
107
- _step;
108
- try {
109
- for (_iterator.s(); !(_step = _iterator.n()).done;) {
110
- var property = _step.value;
111
- if (!data.hasOwnProperty(property)) {
112
- throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
113
- }
114
- }
115
- // ensure the json data is a string
116
- } catch (err) {
117
- _iterator.e(err);
118
- } finally {
119
- _iterator.f();
120
- }
121
- if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
122
- throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
123
- }
124
- // ensure the json data is a string
125
- if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
126
- throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
127
- }
128
- // ensure the json data is an array
129
- if (!Array.isArray(data['errors'])) {
130
- throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
131
- }
132
- // ensure the json data is an array
133
- if (!Array.isArray(data['submissions'])) {
134
- throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
135
- }
136
- // ensure the json data is a string
137
- if (data['code'] && !(typeof data['code'] === 'string' || data['code'] instanceof String)) {
138
- throw new Error("Expected the field `code` to be a primitive type in the JSON string but got " + data['code']);
139
- }
140
- return true;
141
- }
142
- }]);
143
- }();
144
- BatchGeneratePdfs201Response.RequiredProperties = ["status", "submission_batch", "submissions"];
145
-
146
- /**
147
- * @member {module:model/BatchGeneratePdfs201Response.StatusEnum} status
148
- */
149
- BatchGeneratePdfs201Response.prototype['status'] = undefined;
150
-
151
- /**
152
- * @member {String} error
153
- */
154
- BatchGeneratePdfs201Response.prototype['error'] = undefined;
155
-
156
- /**
157
- * @member {Array.<String>} errors
158
- */
159
- BatchGeneratePdfs201Response.prototype['errors'] = undefined;
160
-
161
- /**
162
- * @member {module:model/SubmissionBatch} submission_batch
163
- */
164
- BatchGeneratePdfs201Response.prototype['submission_batch'] = undefined;
165
-
166
- /**
167
- * @member {Array.<Object>} submissions
168
- */
169
- BatchGeneratePdfs201Response.prototype['submissions'] = undefined;
170
-
171
- /**
172
- * `insufficient_credits` when the response is a 402.
173
- * @member {String} code
174
- */
175
- BatchGeneratePdfs201Response.prototype['code'] = undefined;
176
-
177
- /**
178
- * Allowed values for the <code>status</code> property.
179
- * @enum {String}
180
- * @readonly
181
- */
182
- BatchGeneratePdfs201Response['StatusEnum'] = {
183
- /**
184
- * value: "success"
185
- * @const
186
- */
187
- "success": "success",
188
- /**
189
- * value: "error"
190
- * @const
191
- */
192
- "error": "error"
193
- };
194
- var _default = exports["default"] = BatchGeneratePdfs201Response;