docspring 3.2.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 (157) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +65 -63
  3. package/dist/ApiClient.js +62 -27
  4. package/dist/RequestSchemas.js +2297 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1345 -946
  7. package/dist/index.js +655 -151
  8. package/dist/model/AiFieldNamingLanguage.js +64 -0
  9. package/dist/model/{AddFieldsData.js → AuthenticationCheck.js} +31 -31
  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} +26 -26
  15. package/dist/model/CombinedPdfList.js +132 -0
  16. package/dist/model/{SubmissionDataRequestToken.js → CombinedPdfSource.js} +55 -52
  17. package/dist/model/CombinedPdfSourceInput.js +270 -0
  18. package/dist/model/{SuccessErrorResponse.js → CombinedPdfSourcePdf.js} +41 -55
  19. package/dist/model/CombinedPdfSourceType.js +74 -0
  20. package/dist/model/CombinedPdfState.js +74 -0
  21. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +25 -21
  22. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +68 -52
  23. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +24 -22
  24. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +46 -27
  25. package/dist/model/{CreateSubmissionDataRequestEventRequest.js → CreateSignatureRequestEventRequest.js} +41 -137
  26. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  27. package/dist/model/{CreatePdfSubmissionData.js → CreateSubmissionBatchRequest.js} +63 -87
  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 +66 -15
  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/{BatchGeneratePdfs201Response.js → ErrorDetail.js} +65 -76
  36. package/dist/model/ErrorInfo.js +211 -0
  37. package/dist/model/ErrorResponse.js +11 -40
  38. package/dist/model/ExpirationInterval.js +64 -0
  39. package/dist/model/{CreateSubmissionResponse.js → FieldComparisonCondition.js} +46 -64
  40. package/dist/model/FieldComparisonOperator.js +69 -0
  41. package/dist/model/FieldDisplayType.js +79 -0
  42. package/dist/model/FieldEqualsCondition.js +137 -0
  43. package/dist/model/FieldEqualsOperator.js +59 -0
  44. package/dist/model/FieldInCondition.js +145 -0
  45. package/dist/model/FieldOverride.js +722 -0
  46. package/dist/model/{MultipleErrorsResponse.js → FieldPresenceCondition.js} +39 -54
  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 +37 -10
  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} +33 -27
  63. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +24 -34
  64. package/dist/model/NumberConditionType.js +79 -0
  65. package/dist/model/PageFormat.js +114 -0
  66. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +32 -32
  67. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +24 -22
  68. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +24 -22
  69. package/dist/model/ShapeType.js +79 -0
  70. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +164 -239
  71. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  72. package/dist/model/SignatureRequestAuthType.js +84 -0
  73. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +66 -148
  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 +185 -339
  82. package/dist/model/SubmissionAction.js +29 -114
  83. package/dist/model/SubmissionActionState.js +69 -0
  84. package/dist/model/SubmissionActionType.js +84 -0
  85. package/dist/model/SubmissionBatch.js +73 -54
  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} +34 -41
  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 +309 -572
  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/TemplateFieldDependency.js +184 -0
  101. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  102. package/dist/model/{CreateCombinedSubmissionResponse.js → TemplateFieldDependencyCondition.js} +50 -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} +33 -85
  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/{SubmissionBatchData.js → TemplateSourcePdf.js} +49 -49
  116. package/dist/model/TemplateSummary.js +560 -0
  117. package/dist/model/{SuccessMultipleErrorsResponse.js → TemplateSummaryList.js} +43 -55
  118. package/dist/model/TemplateType.js +59 -0
  119. package/dist/model/{Submission422Response.js → TemplateVersion.js} +59 -62
  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/{ErrorOrMultipleErrorsResponse.js → UpdateTemplateDocumentRequest.js} +43 -60
  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} +52 -57
  131. package/dist/model/UrlSourcePdf.js +130 -0
  132. package/dist/model/Webhook.js +57 -72
  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/CombinedSubmission.js +0 -308
  138. package/dist/model/CombinedSubmissionAction.js +0 -268
  139. package/dist/model/CreateCustomFileResponse.js +0 -155
  140. package/dist/model/CreateHtmlTemplate.js +0 -108
  141. package/dist/model/CreatePdfTemplate.js +0 -108
  142. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  143. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -155
  144. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -155
  145. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -155
  146. package/dist/model/CreateWebhookData.js +0 -108
  147. package/dist/model/JsonSchema.js +0 -205
  148. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  149. package/dist/model/SubmissionDataRequest.js +0 -496
  150. package/dist/model/SubmissionPreview.js +0 -504
  151. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  152. package/dist/model/TemplateDeleteResponse.js +0 -168
  153. package/dist/model/TemplatePreview.js +0 -796
  154. package/dist/model/TemplatePublishVersionResponse.js +0 -154
  155. package/dist/model/UpdateHtmlTemplate.js +0 -108
  156. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  157. package/dist/model/UpdateWebhookData.js +0 -108
@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _WebhookEventType = _interopRequireDefault(require("./WebhookEventType"));
9
+ var _WebhookMode = _interopRequireDefault(require("./WebhookMode"));
8
10
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
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); }
10
12
  function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
@@ -18,7 +20,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
18
20
  * DocSpring API
19
21
  * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
22
  *
21
- * The version of the OpenAPI document: v1
23
+ * The version of the OpenAPI document: v2
22
24
  *
23
25
  *
24
26
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,33 +31,34 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
31
  /**
30
32
  * The Webhook model module.
31
33
  * @module model/Webhook
32
- * @version 3.2.0
34
+ * @version 4.0.0
33
35
  */
34
36
  var Webhook = /*#__PURE__*/function () {
35
37
  /**
36
38
  * Constructs a new <code>Webhook</code>.
39
+ * An endpoint that DocSpring sends a POST request to when a subscribed event happens.
37
40
  * @alias module:model/Webhook
38
41
  * @extends Object
39
- * @param id {String}
40
- * @param name {String}
41
- * @param url {String}
42
- * @param enabled {Boolean}
43
- * @param event_types {Array.<String>}
44
- * @param mode {module:model/Webhook.ModeEnum}
45
- * @param version {Number}
46
- * @param api_token_ids {Array.<String>}
47
- * @param template_ids {Array.<String>}
48
- * @param folder_ids {Array.<String>}
49
- * @param include_submission_data {Boolean}
50
- * @param strip_fields {Array.<String>}
51
- * @param headers {Object.<String, String>}
52
- * @param consecutive_failures {Number}
53
- * @param last_failure_at {String}
54
- * @param disabled_at {String}
55
- * @param disabled_reason {String}
56
- * @param secret {String}
57
- * @param created_at {String}
58
- * @param updated_at {String}
42
+ * @param id {String} The webhook's ID.
43
+ * @param name {String} A name for the webhook, shown in the dashboard.
44
+ * @param url {String} The endpoint that receives webhook POST requests.
45
+ * @param enabled {Boolean} Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
46
+ * @param event_types {Array.<module:model/WebhookEventType>} 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.
47
+ * @param mode {module:model/WebhookMode} Only send events for test or live submissions. Null sends both.
48
+ * @param version {Number} The format of the requests DocSpring sends. Webhooks created with API v2 use 4: each event's `data` is the resource as API v2 returns it. Webhooks made in the dashboard or with API v1 use 3, which has API v1's resources and names (`combined_submission`, `submission_data_request`). Versions 1 and 2 are legacy formats for submission events.
49
+ * @param api_token_ids {Array.<String>} 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.
50
+ * @param template_ids {Array.<String>} Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
51
+ * @param folder_ids {Array.<String>} 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.
52
+ * @param include_submission_data {Boolean} 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.
53
+ * @param strip_fields {Array.<String>} 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).
54
+ * @param headers {Object.<String, String>} Headers to send with each request.
55
+ * @param consecutive_failures {Number} How many deliveries in a row have failed.
56
+ * @param last_failure_at {Date} When a delivery last failed.
57
+ * @param disabled_at {Date} When the webhook was disabled. Null while it is enabled.
58
+ * @param disabled_reason {String} Why the webhook was disabled, such as after repeated failures.
59
+ * @param secret {String} The key that signs each request (the X-DocSpring-Signature header), so you can check that a request came from DocSpring. Null for some webhooks created before signing existed.
60
+ * @param created_at {Date} When the webhook was created.
61
+ * @param updated_at {Date} When the webhook was last updated.
59
62
  */
60
63
  function Webhook(id, name, url, enabled, event_types, mode, version, api_token_ids, template_ids, folder_ids, include_submission_data, strip_fields, headers, consecutive_failures, last_failure_at, disabled_at, disabled_reason, secret, created_at, updated_at) {
61
64
  _classCallCheck(this, Webhook);
@@ -118,10 +121,10 @@ var Webhook = /*#__PURE__*/function () {
118
121
  obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
119
122
  }
120
123
  if (data.hasOwnProperty('event_types')) {
121
- obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], ['String']);
124
+ obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], [_WebhookEventType["default"]]);
122
125
  }
123
126
  if (data.hasOwnProperty('mode')) {
124
- obj['mode'] = _ApiClient["default"].convertToType(data['mode'], 'String');
127
+ obj['mode'] = _ApiClient["default"].convertToType(data['mode'], _WebhookMode["default"]);
125
128
  }
126
129
  if (data.hasOwnProperty('version')) {
127
130
  obj['version'] = _ApiClient["default"].convertToType(data['version'], 'Number');
@@ -150,10 +153,10 @@ var Webhook = /*#__PURE__*/function () {
150
153
  obj['consecutive_failures'] = _ApiClient["default"].convertToType(data['consecutive_failures'], 'Number');
151
154
  }
152
155
  if (data.hasOwnProperty('last_failure_at')) {
153
- obj['last_failure_at'] = _ApiClient["default"].convertToType(data['last_failure_at'], 'String');
156
+ obj['last_failure_at'] = _ApiClient["default"].convertToType(data['last_failure_at'], 'Date');
154
157
  }
155
158
  if (data.hasOwnProperty('disabled_at')) {
156
- obj['disabled_at'] = _ApiClient["default"].convertToType(data['disabled_at'], 'String');
159
+ obj['disabled_at'] = _ApiClient["default"].convertToType(data['disabled_at'], 'Date');
157
160
  }
158
161
  if (data.hasOwnProperty('disabled_reason')) {
159
162
  obj['disabled_reason'] = _ApiClient["default"].convertToType(data['disabled_reason'], 'String');
@@ -162,10 +165,10 @@ var Webhook = /*#__PURE__*/function () {
162
165
  obj['secret'] = _ApiClient["default"].convertToType(data['secret'], 'String');
163
166
  }
164
167
  if (data.hasOwnProperty('created_at')) {
165
- obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'String');
168
+ obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
166
169
  }
167
170
  if (data.hasOwnProperty('updated_at')) {
168
- obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'String');
171
+ obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
169
172
  }
170
173
  }
171
174
  return obj;
@@ -210,10 +213,6 @@ var Webhook = /*#__PURE__*/function () {
210
213
  if (!Array.isArray(data['event_types'])) {
211
214
  throw new Error("Expected the field `event_types` to be an array in the JSON data but got " + data['event_types']);
212
215
  }
213
- // ensure the json data is a string
214
- if (data['mode'] && !(typeof data['mode'] === 'string' || data['mode'] instanceof String)) {
215
- throw new Error("Expected the field `mode` to be a primitive type in the JSON string but got " + data['mode']);
216
- }
217
216
  // ensure the json data is an array
218
217
  if (!Array.isArray(data['api_token_ids'])) {
219
218
  throw new Error("Expected the field `api_token_ids` to be an array in the JSON data but got " + data['api_token_ids']);
@@ -231,14 +230,6 @@ var Webhook = /*#__PURE__*/function () {
231
230
  throw new Error("Expected the field `strip_fields` to be an array in the JSON data but got " + data['strip_fields']);
232
231
  }
233
232
  // ensure the json data is a string
234
- if (data['last_failure_at'] && !(typeof data['last_failure_at'] === 'string' || data['last_failure_at'] instanceof String)) {
235
- throw new Error("Expected the field `last_failure_at` to be a primitive type in the JSON string but got " + data['last_failure_at']);
236
- }
237
- // ensure the json data is a string
238
- if (data['disabled_at'] && !(typeof data['disabled_at'] === 'string' || data['disabled_at'] instanceof String)) {
239
- throw new Error("Expected the field `disabled_at` to be a primitive type in the JSON string but got " + data['disabled_at']);
240
- }
241
- // ensure the json data is a string
242
233
  if (data['disabled_reason'] && !(typeof data['disabled_reason'] === 'string' || data['disabled_reason'] instanceof String)) {
243
234
  throw new Error("Expected the field `disabled_reason` to be a primitive type in the JSON string but got " + data['disabled_reason']);
244
235
  }
@@ -246,14 +237,6 @@ var Webhook = /*#__PURE__*/function () {
246
237
  if (data['secret'] && !(typeof data['secret'] === 'string' || data['secret'] instanceof String)) {
247
238
  throw new Error("Expected the field `secret` to be a primitive type in the JSON string but got " + data['secret']);
248
239
  }
249
- // ensure the json data is a string
250
- if (data['created_at'] && !(typeof data['created_at'] === 'string' || data['created_at'] instanceof String)) {
251
- throw new Error("Expected the field `created_at` to be a primitive type in the JSON string but got " + data['created_at']);
252
- }
253
- // ensure the json data is a string
254
- if (data['updated_at'] && !(typeof data['updated_at'] === 'string' || data['updated_at'] instanceof String)) {
255
- throw new Error("Expected the field `updated_at` to be a primitive type in the JSON string but got " + data['updated_at']);
256
- }
257
240
  return true;
258
241
  }
259
242
  }]);
@@ -261,120 +244,122 @@ var Webhook = /*#__PURE__*/function () {
261
244
  Webhook.RequiredProperties = ["id", "name", "url", "enabled", "event_types", "mode", "version", "api_token_ids", "template_ids", "folder_ids", "include_submission_data", "strip_fields", "headers", "consecutive_failures", "last_failure_at", "disabled_at", "disabled_reason", "secret", "created_at", "updated_at"];
262
245
 
263
246
  /**
247
+ * The webhook's ID.
264
248
  * @member {String} id
265
249
  */
266
250
  Webhook.prototype['id'] = undefined;
267
251
 
268
252
  /**
253
+ * A name for the webhook, shown in the dashboard.
269
254
  * @member {String} name
270
255
  */
271
256
  Webhook.prototype['name'] = undefined;
272
257
 
273
258
  /**
259
+ * The endpoint that receives webhook POST requests.
274
260
  * @member {String} url
275
261
  */
276
262
  Webhook.prototype['url'] = undefined;
277
263
 
278
264
  /**
265
+ * Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
279
266
  * @member {Boolean} enabled
280
267
  */
281
268
  Webhook.prototype['enabled'] = undefined;
282
269
 
283
270
  /**
284
- * @member {Array.<String>} event_types
271
+ * 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.
272
+ * @member {Array.<module:model/WebhookEventType>} event_types
285
273
  */
286
274
  Webhook.prototype['event_types'] = undefined;
287
275
 
288
276
  /**
289
- * @member {module:model/Webhook.ModeEnum} mode
277
+ * Only send events for test or live submissions. Null sends both.
278
+ * @member {module:model/WebhookMode} mode
290
279
  */
291
280
  Webhook.prototype['mode'] = undefined;
292
281
 
293
282
  /**
283
+ * The format of the requests DocSpring sends. Webhooks created with API v2 use 4: each event's `data` is the resource as API v2 returns it. Webhooks made in the dashboard or with API v1 use 3, which has API v1's resources and names (`combined_submission`, `submission_data_request`). Versions 1 and 2 are legacy formats for submission events.
294
284
  * @member {Number} version
295
285
  */
296
286
  Webhook.prototype['version'] = undefined;
297
287
 
298
288
  /**
289
+ * 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.
299
290
  * @member {Array.<String>} api_token_ids
300
291
  */
301
292
  Webhook.prototype['api_token_ids'] = undefined;
302
293
 
303
294
  /**
295
+ * Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
304
296
  * @member {Array.<String>} template_ids
305
297
  */
306
298
  Webhook.prototype['template_ids'] = undefined;
307
299
 
308
300
  /**
301
+ * 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.
309
302
  * @member {Array.<String>} folder_ids
310
303
  */
311
304
  Webhook.prototype['folder_ids'] = undefined;
312
305
 
313
306
  /**
307
+ * 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.
314
308
  * @member {Boolean} include_submission_data
315
309
  */
316
310
  Webhook.prototype['include_submission_data'] = undefined;
317
311
 
318
312
  /**
313
+ * 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).
319
314
  * @member {Array.<String>} strip_fields
320
315
  */
321
316
  Webhook.prototype['strip_fields'] = undefined;
322
317
 
323
318
  /**
319
+ * Headers to send with each request.
324
320
  * @member {Object.<String, String>} headers
325
321
  */
326
322
  Webhook.prototype['headers'] = undefined;
327
323
 
328
324
  /**
325
+ * How many deliveries in a row have failed.
329
326
  * @member {Number} consecutive_failures
330
327
  */
331
328
  Webhook.prototype['consecutive_failures'] = undefined;
332
329
 
333
330
  /**
334
- * @member {String} last_failure_at
331
+ * When a delivery last failed.
332
+ * @member {Date} last_failure_at
335
333
  */
336
334
  Webhook.prototype['last_failure_at'] = undefined;
337
335
 
338
336
  /**
339
- * @member {String} disabled_at
337
+ * When the webhook was disabled. Null while it is enabled.
338
+ * @member {Date} disabled_at
340
339
  */
341
340
  Webhook.prototype['disabled_at'] = undefined;
342
341
 
343
342
  /**
343
+ * Why the webhook was disabled, such as after repeated failures.
344
344
  * @member {String} disabled_reason
345
345
  */
346
346
  Webhook.prototype['disabled_reason'] = undefined;
347
347
 
348
348
  /**
349
+ * The key that signs each request (the X-DocSpring-Signature header), so you can check that a request came from DocSpring. Null for some webhooks created before signing existed.
349
350
  * @member {String} secret
350
351
  */
351
352
  Webhook.prototype['secret'] = undefined;
352
353
 
353
354
  /**
354
- * @member {String} created_at
355
+ * When the webhook was created.
356
+ * @member {Date} created_at
355
357
  */
356
358
  Webhook.prototype['created_at'] = undefined;
357
359
 
358
360
  /**
359
- * @member {String} updated_at
361
+ * When the webhook was last updated.
362
+ * @member {Date} updated_at
360
363
  */
361
364
  Webhook.prototype['updated_at'] = undefined;
362
-
363
- /**
364
- * Allowed values for the <code>mode</code> property.
365
- * @enum {String}
366
- * @readonly
367
- */
368
- Webhook['ModeEnum'] = {
369
- /**
370
- * value: "test"
371
- * @const
372
- */
373
- "test": "test",
374
- /**
375
- * value: "live"
376
- * @const
377
- */
378
- "live": "live"
379
- };
380
365
  var _default = exports["default"] = Webhook;
@@ -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.0.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;