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,209 @@
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 _WebhookEventType = _interopRequireDefault(require("./WebhookEventType"));
9
+ var _WebhookMode = _interopRequireDefault(require("./WebhookMode"));
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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
13
+ 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); } }
14
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
15
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
16
+ 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); } /**
17
+ * DocSpring API
18
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
19
+ *
20
+ * The version of the OpenAPI document: v2
21
+ *
22
+ *
23
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
24
+ * https://openapi-generator.tech
25
+ * Do not edit the class manually.
26
+ *
27
+ */
28
+ /**
29
+ * The UpdateWebhookRequest model module.
30
+ * @module model/UpdateWebhookRequest
31
+ * @version 4.1.0
32
+ */
33
+ var UpdateWebhookRequest = /*#__PURE__*/function () {
34
+ /**
35
+ * Constructs a new <code>UpdateWebhookRequest</code>.
36
+ * The settings to change. Properties left out keep their values.
37
+ * @alias module:model/UpdateWebhookRequest
38
+ */
39
+ function UpdateWebhookRequest() {
40
+ _classCallCheck(this, UpdateWebhookRequest);
41
+ UpdateWebhookRequest.initialize(this);
42
+ }
43
+
44
+ /**
45
+ * Initializes the fields of this object.
46
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
47
+ * Only for internal use.
48
+ */
49
+ return _createClass(UpdateWebhookRequest, null, [{
50
+ key: "initialize",
51
+ value: function initialize(obj) {}
52
+
53
+ /**
54
+ * Constructs a <code>UpdateWebhookRequest</code> from a plain JavaScript object, optionally creating a new instance.
55
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
56
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
57
+ * @param {module:model/UpdateWebhookRequest} obj Optional instance to populate.
58
+ * @return {module:model/UpdateWebhookRequest} The populated <code>UpdateWebhookRequest</code> instance.
59
+ */
60
+ }, {
61
+ key: "constructFromObject",
62
+ value: function constructFromObject(data, obj) {
63
+ if (data) {
64
+ obj = obj || new UpdateWebhookRequest();
65
+ if (data.hasOwnProperty('name')) {
66
+ obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
67
+ }
68
+ if (data.hasOwnProperty('url')) {
69
+ obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
70
+ }
71
+ if (data.hasOwnProperty('enabled')) {
72
+ obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
73
+ }
74
+ if (data.hasOwnProperty('event_types')) {
75
+ obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], [_WebhookEventType["default"]]);
76
+ }
77
+ if (data.hasOwnProperty('mode')) {
78
+ obj['mode'] = _ApiClient["default"].convertToType(data['mode'], _WebhookMode["default"]);
79
+ }
80
+ if (data.hasOwnProperty('api_token_ids')) {
81
+ obj['api_token_ids'] = _ApiClient["default"].convertToType(data['api_token_ids'], ['String']);
82
+ }
83
+ if (data.hasOwnProperty('template_ids')) {
84
+ obj['template_ids'] = _ApiClient["default"].convertToType(data['template_ids'], ['String']);
85
+ }
86
+ if (data.hasOwnProperty('folder_ids')) {
87
+ obj['folder_ids'] = _ApiClient["default"].convertToType(data['folder_ids'], ['String']);
88
+ }
89
+ if (data.hasOwnProperty('include_submission_data')) {
90
+ obj['include_submission_data'] = _ApiClient["default"].convertToType(data['include_submission_data'], 'Boolean');
91
+ }
92
+ if (data.hasOwnProperty('strip_fields')) {
93
+ obj['strip_fields'] = _ApiClient["default"].convertToType(data['strip_fields'], ['String']);
94
+ }
95
+ if (data.hasOwnProperty('headers')) {
96
+ obj['headers'] = _ApiClient["default"].convertToType(data['headers'], {
97
+ 'String': 'String'
98
+ });
99
+ }
100
+ }
101
+ return obj;
102
+ }
103
+
104
+ /**
105
+ * Validates the JSON data with respect to <code>UpdateWebhookRequest</code>.
106
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
107
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateWebhookRequest</code>.
108
+ */
109
+ }, {
110
+ key: "validateJSON",
111
+ value: function validateJSON(data) {
112
+ // ensure the json data is a string
113
+ if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
114
+ throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
115
+ }
116
+ // ensure the json data is a string
117
+ if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
118
+ throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
119
+ }
120
+ // ensure the json data is an array
121
+ if (!Array.isArray(data['event_types'])) {
122
+ throw new Error("Expected the field `event_types` to be an array in the JSON data but got " + data['event_types']);
123
+ }
124
+ // ensure the json data is an array
125
+ if (!Array.isArray(data['api_token_ids'])) {
126
+ throw new Error("Expected the field `api_token_ids` to be an array in the JSON data but got " + data['api_token_ids']);
127
+ }
128
+ // ensure the json data is an array
129
+ if (!Array.isArray(data['template_ids'])) {
130
+ throw new Error("Expected the field `template_ids` to be an array in the JSON data but got " + data['template_ids']);
131
+ }
132
+ // ensure the json data is an array
133
+ if (!Array.isArray(data['folder_ids'])) {
134
+ throw new Error("Expected the field `folder_ids` to be an array in the JSON data but got " + data['folder_ids']);
135
+ }
136
+ // ensure the json data is an array
137
+ if (!Array.isArray(data['strip_fields'])) {
138
+ throw new Error("Expected the field `strip_fields` to be an array in the JSON data but got " + data['strip_fields']);
139
+ }
140
+ return true;
141
+ }
142
+ }]);
143
+ }();
144
+ /**
145
+ * A name for the webhook, shown in the dashboard.
146
+ * @member {String} name
147
+ */
148
+ UpdateWebhookRequest.prototype['name'] = undefined;
149
+
150
+ /**
151
+ * The endpoint that receives webhook POST requests.
152
+ * @member {String} url
153
+ */
154
+ UpdateWebhookRequest.prototype['url'] = undefined;
155
+
156
+ /**
157
+ * Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
158
+ * @member {Boolean} enabled
159
+ */
160
+ UpdateWebhookRequest.prototype['enabled'] = undefined;
161
+
162
+ /**
163
+ * The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
164
+ * @member {Array.<module:model/WebhookEventType>} event_types
165
+ */
166
+ UpdateWebhookRequest.prototype['event_types'] = undefined;
167
+
168
+ /**
169
+ * Only send events for test or live submissions. Null sends both.
170
+ * @member {module:model/WebhookMode} mode
171
+ */
172
+ UpdateWebhookRequest.prototype['mode'] = undefined;
173
+
174
+ /**
175
+ * Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events.
176
+ * @member {Array.<String>} api_token_ids
177
+ */
178
+ UpdateWebhookRequest.prototype['api_token_ids'] = undefined;
179
+
180
+ /**
181
+ * Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
182
+ * @member {Array.<String>} template_ids
183
+ */
184
+ UpdateWebhookRequest.prototype['template_ids'] = undefined;
185
+
186
+ /**
187
+ * Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events.
188
+ * @member {Array.<String>} folder_ids
189
+ */
190
+ UpdateWebhookRequest.prototype['folder_ids'] = undefined;
191
+
192
+ /**
193
+ * Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null.
194
+ * @member {Boolean} include_submission_data
195
+ */
196
+ UpdateWebhookRequest.prototype['include_submission_data'] = undefined;
197
+
198
+ /**
199
+ * Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object).
200
+ * @member {Array.<String>} strip_fields
201
+ */
202
+ UpdateWebhookRequest.prototype['strip_fields'] = undefined;
203
+
204
+ /**
205
+ * Headers to send with each request.
206
+ * @member {Object.<String, String>} headers
207
+ */
208
+ UpdateWebhookRequest.prototype['headers'] = undefined;
209
+ var _default = exports["default"] = UpdateWebhookRequest;
@@ -0,0 +1,54 @@
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 UploadMethod.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var UploadMethod = exports["default"] = /*#__PURE__*/function () {
33
+ function UploadMethod() {
34
+ _classCallCheck(this, UploadMethod);
35
+ }
36
+ return _createClass(UploadMethod, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>UploadMethod</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/UploadMethod} The enum <code>UploadMethod</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: "post"
52
+ * @const
53
+ */
54
+ _defineProperty(UploadMethod, "post", "post");
@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _UploadMethod = _interopRequireDefault(require("./UploadMethod"));
8
9
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
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); }
10
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; } } }; }
@@ -16,9 +17,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
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); } /**
18
19
  * DocSpring API
19
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
21
  *
21
- * The version of the OpenAPI document: v1
22
+ * The version of the OpenAPI document: v2
22
23
  *
23
24
  *
24
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,22 +28,24 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
28
  *
28
29
  */
29
30
  /**
30
- * The UploadPresignResponse model module.
31
- * @module model/UploadPresignResponse
32
- * @version 3.3.0
31
+ * The UploadPresign model module.
32
+ * @module model/UploadPresign
33
+ * @version 4.1.0
33
34
  */
34
- var UploadPresignResponse = /*#__PURE__*/function () {
35
+ var UploadPresign = /*#__PURE__*/function () {
35
36
  /**
36
- * Constructs a new <code>UploadPresignResponse</code>.
37
- * @alias module:model/UploadPresignResponse
37
+ * Constructs a new <code>UploadPresign</code>.
38
+ * A presigned S3 form for uploading a file. POST `fields` and the file (as `file`, last) to `url` as multipart/form-data. Then use `fields.key` as the `cache_id` when you create a custom file.
39
+ * @alias module:model/UploadPresign
38
40
  * @extends Object
39
- * @param fields {Object}
40
- * @param headers {Object}
41
- * @param url {String}
41
+ * @param url {String} The S3 URL to upload the file to.
42
+ * @param method {module:model/UploadMethod} The HTTP method for the upload.
43
+ * @param fields {Object.<String, String>} Form fields to send with the file. Send them all, as they are. `key` is the uploaded file's ID: pass it as `cache_id`.
44
+ * @param headers {Object.<String, String>} Headers to send with the upload.
42
45
  */
43
- function UploadPresignResponse(fields, headers, url) {
44
- _classCallCheck(this, UploadPresignResponse);
45
- UploadPresignResponse.initialize(this, fields, headers, url);
46
+ function UploadPresign(url, method, fields, headers) {
47
+ _classCallCheck(this, UploadPresign);
48
+ UploadPresign.initialize(this, url, method, fields, headers);
46
49
  }
47
50
 
48
51
  /**
@@ -50,53 +53,58 @@ var UploadPresignResponse = /*#__PURE__*/function () {
50
53
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
51
54
  * Only for internal use.
52
55
  */
53
- return _createClass(UploadPresignResponse, null, [{
56
+ return _createClass(UploadPresign, null, [{
54
57
  key: "initialize",
55
- value: function initialize(obj, fields, headers, url) {
58
+ value: function initialize(obj, url, method, fields, headers) {
59
+ obj['url'] = url;
60
+ obj['method'] = method;
56
61
  obj['fields'] = fields;
57
62
  obj['headers'] = headers;
58
- obj['url'] = url;
59
63
  }
60
64
 
61
65
  /**
62
- * Constructs a <code>UploadPresignResponse</code> from a plain JavaScript object, optionally creating a new instance.
66
+ * Constructs a <code>UploadPresign</code> from a plain JavaScript object, optionally creating a new instance.
63
67
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
64
68
  * @param {Object} data The plain JavaScript object bearing properties of interest.
65
- * @param {module:model/UploadPresignResponse} obj Optional instance to populate.
66
- * @return {module:model/UploadPresignResponse} The populated <code>UploadPresignResponse</code> instance.
69
+ * @param {module:model/UploadPresign} obj Optional instance to populate.
70
+ * @return {module:model/UploadPresign} The populated <code>UploadPresign</code> instance.
67
71
  */
68
72
  }, {
69
73
  key: "constructFromObject",
70
74
  value: function constructFromObject(data, obj) {
71
75
  if (data) {
72
- obj = obj || new UploadPresignResponse();
76
+ obj = obj || new UploadPresign();
73
77
  _ApiClient["default"].constructFromObject(data, obj, 'Object');
74
- if (data.hasOwnProperty('fields')) {
75
- obj['fields'] = _ApiClient["default"].convertToType(data['fields'], Object);
76
- }
77
- if (data.hasOwnProperty('headers')) {
78
- obj['headers'] = _ApiClient["default"].convertToType(data['headers'], Object);
79
- }
80
78
  if (data.hasOwnProperty('url')) {
81
79
  obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
82
80
  }
83
81
  if (data.hasOwnProperty('method')) {
84
- obj['method'] = _ApiClient["default"].convertToType(data['method'], 'String');
82
+ obj['method'] = _ApiClient["default"].convertToType(data['method'], _UploadMethod["default"]);
83
+ }
84
+ if (data.hasOwnProperty('fields')) {
85
+ obj['fields'] = _ApiClient["default"].convertToType(data['fields'], {
86
+ 'String': 'String'
87
+ });
88
+ }
89
+ if (data.hasOwnProperty('headers')) {
90
+ obj['headers'] = _ApiClient["default"].convertToType(data['headers'], {
91
+ 'String': 'String'
92
+ });
85
93
  }
86
94
  }
87
95
  return obj;
88
96
  }
89
97
 
90
98
  /**
91
- * Validates the JSON data with respect to <code>UploadPresignResponse</code>.
99
+ * Validates the JSON data with respect to <code>UploadPresign</code>.
92
100
  * @param {Object} data The plain JavaScript object bearing properties of interest.
93
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UploadPresignResponse</code>.
101
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UploadPresign</code>.
94
102
  */
95
103
  }, {
96
104
  key: "validateJSON",
97
105
  value: function validateJSON(data) {
98
106
  // check to make sure all required properties are present in the JSON string
99
- var _iterator = _createForOfIteratorHelper(UploadPresignResponse.RequiredProperties),
107
+ var _iterator = _createForOfIteratorHelper(UploadPresign.RequiredProperties),
100
108
  _step;
101
109
  try {
102
110
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -114,46 +122,33 @@ var UploadPresignResponse = /*#__PURE__*/function () {
114
122
  if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
115
123
  throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
116
124
  }
117
- // ensure the json data is a string
118
- if (data['method'] && !(typeof data['method'] === 'string' || data['method'] instanceof String)) {
119
- throw new Error("Expected the field `method` to be a primitive type in the JSON string but got " + data['method']);
120
- }
121
125
  return true;
122
126
  }
123
127
  }]);
124
128
  }();
125
- UploadPresignResponse.RequiredProperties = ["fields", "headers", "url"];
126
-
127
- /**
128
- * @member {Object} fields
129
- */
130
- UploadPresignResponse.prototype['fields'] = undefined;
129
+ UploadPresign.RequiredProperties = ["url", "method", "fields", "headers"];
131
130
 
132
131
  /**
133
- * @member {Object} headers
132
+ * The S3 URL to upload the file to.
133
+ * @member {String} url
134
134
  */
135
- UploadPresignResponse.prototype['headers'] = undefined;
135
+ UploadPresign.prototype['url'] = undefined;
136
136
 
137
137
  /**
138
- * @member {String} url
138
+ * The HTTP method for the upload.
139
+ * @member {module:model/UploadMethod} method
139
140
  */
140
- UploadPresignResponse.prototype['url'] = undefined;
141
+ UploadPresign.prototype['method'] = undefined;
141
142
 
142
143
  /**
143
- * @member {module:model/UploadPresignResponse.MethodEnum} method
144
+ * Form fields to send with the file. Send them all, as they are. `key` is the uploaded file's ID: pass it as `cache_id`.
145
+ * @member {Object.<String, String>} fields
144
146
  */
145
- UploadPresignResponse.prototype['method'] = undefined;
147
+ UploadPresign.prototype['fields'] = undefined;
146
148
 
147
149
  /**
148
- * Allowed values for the <code>method</code> property.
149
- * @enum {String}
150
- * @readonly
150
+ * Headers to send with the upload.
151
+ * @member {Object.<String, String>} headers
151
152
  */
152
- UploadPresignResponse['MethodEnum'] = {
153
- /**
154
- * value: "post"
155
- * @const
156
- */
157
- "post": "post"
158
- };
159
- var _default = exports["default"] = UploadPresignResponse;
153
+ UploadPresign.prototype['headers'] = undefined;
154
+ var _default = exports["default"] = UploadPresign;
@@ -0,0 +1,130 @@
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 _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; } } }; }
11
+ 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; } }
12
+ 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; }
13
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
14
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
15
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
18
+ * DocSpring API
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
+ *
21
+ * The version of the OpenAPI document: v2
22
+ *
23
+ *
24
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
25
+ * https://openapi-generator.tech
26
+ * Do not edit the class manually.
27
+ *
28
+ */
29
+ /**
30
+ * The UrlSourcePdf model module.
31
+ * @module model/UrlSourcePdf
32
+ * @version 4.1.0
33
+ */
34
+ var UrlSourcePdf = /*#__PURE__*/function () {
35
+ /**
36
+ * Constructs a new <code>UrlSourcePdf</code>.
37
+ * A PDF to download from a URL and merge.
38
+ * @alias module:model/UrlSourcePdf
39
+ * @param type {String} Must be `url`.
40
+ * @param url {String} For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired.
41
+ */
42
+ function UrlSourcePdf(type, url) {
43
+ _classCallCheck(this, UrlSourcePdf);
44
+ UrlSourcePdf.initialize(this, type, url);
45
+ }
46
+
47
+ /**
48
+ * Initializes the fields of this object.
49
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
50
+ * Only for internal use.
51
+ */
52
+ return _createClass(UrlSourcePdf, null, [{
53
+ key: "initialize",
54
+ value: function initialize(obj, type, url) {
55
+ obj['type'] = type || 'url';
56
+ obj['url'] = url;
57
+ }
58
+
59
+ /**
60
+ * Constructs a <code>UrlSourcePdf</code> from a plain JavaScript object, optionally creating a new instance.
61
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
62
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
63
+ * @param {module:model/UrlSourcePdf} obj Optional instance to populate.
64
+ * @return {module:model/UrlSourcePdf} The populated <code>UrlSourcePdf</code> instance.
65
+ */
66
+ }, {
67
+ key: "constructFromObject",
68
+ value: function constructFromObject(data, obj) {
69
+ if (data) {
70
+ obj = obj || new UrlSourcePdf();
71
+ if (data.hasOwnProperty('type')) {
72
+ obj['type'] = _ApiClient["default"].convertToType(data['type'], 'String');
73
+ }
74
+ if (data.hasOwnProperty('url')) {
75
+ obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
76
+ }
77
+ }
78
+ return obj;
79
+ }
80
+
81
+ /**
82
+ * Validates the JSON data with respect to <code>UrlSourcePdf</code>.
83
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
84
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UrlSourcePdf</code>.
85
+ */
86
+ }, {
87
+ key: "validateJSON",
88
+ value: function validateJSON(data) {
89
+ // check to make sure all required properties are present in the JSON string
90
+ var _iterator = _createForOfIteratorHelper(UrlSourcePdf.RequiredProperties),
91
+ _step;
92
+ try {
93
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
94
+ var property = _step.value;
95
+ if (!data.hasOwnProperty(property)) {
96
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
97
+ }
98
+ }
99
+ // ensure the json data is a string
100
+ } catch (err) {
101
+ _iterator.e(err);
102
+ } finally {
103
+ _iterator.f();
104
+ }
105
+ if (data['type'] && !(typeof data['type'] === 'string' || data['type'] instanceof String)) {
106
+ throw new Error("Expected the field `type` to be a primitive type in the JSON string but got " + data['type']);
107
+ }
108
+ // ensure the json data is a string
109
+ if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
110
+ throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
111
+ }
112
+ return true;
113
+ }
114
+ }]);
115
+ }();
116
+ UrlSourcePdf.RequiredProperties = ["type", "url"];
117
+
118
+ /**
119
+ * Must be `url`.
120
+ * @member {String} type
121
+ * @default 'url'
122
+ */
123
+ UrlSourcePdf.prototype['type'] = 'url';
124
+
125
+ /**
126
+ * For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired.
127
+ * @member {String} url
128
+ */
129
+ UrlSourcePdf.prototype['url'] = undefined;
130
+ var _default = exports["default"] = UrlSourcePdf;