docspring 4.3.0 → 4.4.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 (141) hide show
  1. package/README.md +20 -1
  2. package/dist/ApiClient.js +2 -2
  3. package/dist/RequestSchemas.js +1118 -93
  4. package/dist/RequestValidator.js +4 -0
  5. package/dist/api/Client.js +1360 -206
  6. package/dist/index.js +196 -0
  7. package/dist/model/AddTemplateFieldsRequest.js +3 -3
  8. package/dist/model/AuthenticationCheck.js +1 -1
  9. package/dist/model/CombinedPdf.js +1 -1
  10. package/dist/model/CombinedPdfFiles.js +1 -1
  11. package/dist/model/CombinedPdfList.js +1 -1
  12. package/dist/model/CombinedPdfSource.js +2 -2
  13. package/dist/model/CombinedPdfSourceInput.js +2 -2
  14. package/dist/model/CombinedPdfSourcePdf.js +1 -1
  15. package/dist/model/CopyTemplateRequest.js +1 -1
  16. package/dist/model/CreateAccountEmailActionRequest.js +306 -0
  17. package/dist/model/CreateCombinedPdfRequest.js +1 -1
  18. package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
  19. package/dist/model/CreateEmailActionRequest.js +280 -0
  20. package/dist/model/CreateEmailDomainRequest.js +114 -0
  21. package/dist/model/CreateFolderRequest.js +1 -1
  22. package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
  23. package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
  24. package/dist/model/CreateSubmissionBatchRequest.js +4 -4
  25. package/dist/model/CreateSubmissionRequest.js +112 -4
  26. package/dist/model/CreateTemplatePreviewRequest.js +1 -1
  27. package/dist/model/CreateTemplateRequest.js +103 -8
  28. package/dist/model/CreateWebhookRequest.js +1 -1
  29. package/dist/model/CustomFile.js +1 -1
  30. package/dist/model/CustomFileList.js +1 -1
  31. package/dist/model/CustomFileSourcePdf.js +1 -1
  32. package/dist/model/DnsRecordType.js +64 -0
  33. package/dist/model/EmailAction.js +510 -0
  34. package/dist/model/EmailActionConditions.js +142 -0
  35. package/dist/model/EmailActionConditionsInput.js +142 -0
  36. package/dist/model/EmailActionCustomization.js +222 -0
  37. package/dist/model/EmailActionDelivery.js +59 -0
  38. package/dist/model/EmailActionFileFormats.js +69 -0
  39. package/dist/model/EmailActionList.js +132 -0
  40. package/dist/model/EmailActionSetting.js +119 -0
  41. package/dist/model/EmailActionSubmissionType.js +64 -0
  42. package/dist/model/EmailActionTestEmail.js +116 -0
  43. package/dist/model/EmailDomain.js +245 -0
  44. package/dist/model/EmailDomainDnsRecord.js +155 -0
  45. package/dist/model/EmailDomainDnsRecordPurpose.js +64 -0
  46. package/dist/model/EmailDomainList.js +132 -0
  47. package/dist/model/EmailDomainRecordState.js +64 -0
  48. package/dist/model/EmailDomainState.js +64 -0
  49. package/dist/model/ErrorCode.js +10 -0
  50. package/dist/model/ErrorDetail.js +1 -1
  51. package/dist/model/ErrorInfo.js +46 -7
  52. package/dist/model/ErrorResponse.js +1 -1
  53. package/dist/model/Field.js +3 -3
  54. package/dist/model/FieldComparisonCondition.js +1 -1
  55. package/dist/model/FieldDependency.js +1 -1
  56. package/dist/model/FieldDependencyInput.js +1 -1
  57. package/dist/model/FieldEqualsCondition.js +1 -1
  58. package/dist/model/FieldGroup.js +1 -1
  59. package/dist/model/FieldGroupInput.js +1 -1
  60. package/dist/model/FieldInCondition.js +1 -1
  61. package/dist/model/FieldInput.js +2 -2
  62. package/dist/model/FieldOverride.js +1 -1
  63. package/dist/model/FieldPresenceCondition.js +1 -1
  64. package/dist/model/FieldRangeCondition.js +1 -1
  65. package/dist/model/Folder.js +1 -1
  66. package/dist/model/FolderList.js +1 -1
  67. package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
  68. package/dist/model/GeneratedFile.js +1 -1
  69. package/dist/model/HtmlEngineOptions.js +3 -3
  70. package/dist/model/HtmlEngineOptionsInput.js +2 -2
  71. package/dist/model/MoveFolderRequest.js +1 -1
  72. package/dist/model/MoveTemplateRequest.js +1 -1
  73. package/dist/model/PageImage.js +1 -1
  74. package/dist/model/PageImages.js +1 -1
  75. package/dist/model/PredefinedField.js +1 -1
  76. package/dist/model/PredefinedFieldInput.js +1 -1
  77. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  78. package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
  79. package/dist/model/RenameFolderRequest.js +1 -1
  80. package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
  81. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  82. package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
  83. package/dist/model/SignatureRequest.js +52 -7
  84. package/dist/model/SignatureRequestEmailAttachments.js +59 -0
  85. package/dist/model/SignatureRequestEmailStatus.js +89 -0
  86. package/dist/model/SignatureRequestEvent.js +1 -1
  87. package/dist/model/SignatureRequestEventType.js +11 -1
  88. package/dist/model/SignatureRequestInput.js +24 -8
  89. package/dist/model/SignatureRequestReminders.js +121 -0
  90. package/dist/model/SignatureRequestToken.js +1 -1
  91. package/dist/model/SigningOrder.js +59 -0
  92. package/dist/model/StringConditionType.js +36 -1
  93. package/dist/model/Submission.js +21 -9
  94. package/dist/model/SubmissionAction.js +27 -12
  95. package/dist/model/SubmissionBatch.js +1 -1
  96. package/dist/model/SubmissionFiles.js +1 -1
  97. package/dist/model/SubmissionInput.js +4 -4
  98. package/dist/model/SubmissionList.js +1 -1
  99. package/dist/model/SubmissionSourcePdf.js +1 -1
  100. package/dist/model/SubmissionSummary.js +3 -3
  101. package/dist/model/SubmissionValidation.js +1 -1
  102. package/dist/model/Template.js +130 -19
  103. package/dist/model/TemplateActor.js +1 -1
  104. package/dist/model/TemplateDefaults.js +1 -1
  105. package/dist/model/TemplateDefaultsInput.js +1 -1
  106. package/dist/model/TemplateDiff.js +1 -1
  107. package/dist/model/TemplateDiffSummary.js +1 -1
  108. package/dist/model/TemplateDocument.js +1 -1
  109. package/dist/model/TemplateDocumentSummary.js +1 -1
  110. package/dist/model/TemplateFieldChange.js +1 -1
  111. package/dist/model/TemplateFieldChanges.js +1 -1
  112. package/dist/model/TemplateFieldDependency.js +1 -1
  113. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  114. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  115. package/dist/model/TemplateFieldDependencyInput.js +1 -1
  116. package/dist/model/TemplateFieldMove.js +1 -1
  117. package/dist/model/TemplateFields.js +1 -1
  118. package/dist/model/TemplateModelCode.js +1 -1
  119. package/dist/model/TemplatePageImages.js +1 -1
  120. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  121. package/dist/model/TemplatePreview.js +1 -1
  122. package/dist/model/TemplateSourcePdf.js +2 -2
  123. package/dist/model/TemplateSummary.js +9 -9
  124. package/dist/model/TemplateSummaryList.js +1 -1
  125. package/dist/model/TemplateType.js +6 -1
  126. package/dist/model/TemplateVersion.js +1 -1
  127. package/dist/model/UpdateAccountEmailActionRequest.js +306 -0
  128. package/dist/model/UpdateEmailActionCustomizationRequest.js +258 -0
  129. package/dist/model/UpdateEmailActionRequest.js +280 -0
  130. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  131. package/dist/model/UpdateTemplateDocumentRequest.js +2 -2
  132. package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
  133. package/dist/model/UpdateTemplateRequest.js +100 -5
  134. package/dist/model/UpdateWebhookRequest.js +1 -1
  135. package/dist/model/UploadPresign.js +1 -1
  136. package/dist/model/UrlSourcePdf.js +1 -1
  137. package/dist/model/ValidateSubmissionRequest.js +112 -4
  138. package/dist/model/Webhook.js +1 -1
  139. package/dist/model/WebhookEventType.js +10 -0
  140. package/dist/model/WebhookList.js +1 -1
  141. package/package.json +1 -1
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
16
+ * DocSpring API
17
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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 EmailDomainRecordState.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var EmailDomainRecordState = exports["default"] = /*#__PURE__*/function () {
33
+ function EmailDomainRecordState() {
34
+ _classCallCheck(this, EmailDomainRecordState);
35
+ }
36
+ return _createClass(EmailDomainRecordState, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>EmailDomainRecordState</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/EmailDomainRecordState} The enum <code>EmailDomainRecordState</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "pending"
52
+ * @const
53
+ */
54
+ _defineProperty(EmailDomainRecordState, "pending", "pending");
55
+ /**
56
+ * value: "verified"
57
+ * @const
58
+ */
59
+ _defineProperty(EmailDomainRecordState, "verified", "verified");
60
+ /**
61
+ * value: "failed"
62
+ * @const
63
+ */
64
+ _defineProperty(EmailDomainRecordState, "failed", "failed");
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
16
+ * DocSpring API
17
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and 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 EmailDomainState.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var EmailDomainState = exports["default"] = /*#__PURE__*/function () {
33
+ function EmailDomainState() {
34
+ _classCallCheck(this, EmailDomainState);
35
+ }
36
+ return _createClass(EmailDomainState, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>EmailDomainState</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/EmailDomainState} The enum <code>EmailDomainState</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "pending"
52
+ * @const
53
+ */
54
+ _defineProperty(EmailDomainState, "pending", "pending");
55
+ /**
56
+ * value: "verified"
57
+ * @const
58
+ */
59
+ _defineProperty(EmailDomainState, "verified", "verified");
60
+ /**
61
+ * value: "failed"
62
+ * @const
63
+ */
64
+ _defineProperty(EmailDomainState, "failed", "failed");
@@ -67,6 +67,11 @@ _defineProperty(ErrorCode, "payment_required", "payment_required");
67
67
  * @const
68
68
  */
69
69
  _defineProperty(ErrorCode, "insufficient_credits", "insufficient_credits");
70
+ /**
71
+ * value: "insufficient_credits_to_send"
72
+ * @const
73
+ */
74
+ _defineProperty(ErrorCode, "insufficient_credits_to_send", "insufficient_credits_to_send");
70
75
  /**
71
76
  * value: "forbidden"
72
77
  * @const
@@ -127,6 +132,11 @@ _defineProperty(ErrorCode, "invalid_data", "invalid_data");
127
132
  * @const
128
133
  */
129
134
  _defineProperty(ErrorCode, "rate_limited", "rate_limited");
135
+ /**
136
+ * value: "daily_email_limit_reached"
137
+ * @const
138
+ */
139
+ _defineProperty(ErrorCode, "daily_email_limit_reached", "daily_email_limit_reached");
130
140
  /**
131
141
  * value: "internal_error"
132
142
  * @const
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The ErrorDetail model module.
31
31
  * @module model/ErrorDetail
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var ErrorDetail = /*#__PURE__*/function () {
35
35
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The ErrorInfo model module.
33
33
  * @module model/ErrorInfo
34
- * @version 4.3.0
34
+ * @version 4.4.0
35
35
  */
36
36
  var ErrorInfo = /*#__PURE__*/function () {
37
37
  /**
@@ -39,7 +39,7 @@ var ErrorInfo = /*#__PURE__*/function () {
39
39
  * What went wrong.
40
40
  * @alias module:model/ErrorInfo
41
41
  * @extends Object
42
- * @param code {module:model/ErrorCode} A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count) or the embedded template editor. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): a request with the same Idempotency-Key is still being processed. Send the request again in a few seconds; when the first request has already created its record, its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request.
42
+ * @param code {module:model/ErrorCode} A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept. When the first request created a record, its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id` or `webhook_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`).
43
43
  * @param message {String} A human-readable explanation, safe to show to developers.
44
44
  * @param details {Array.<module:model/ErrorDetail>} What was wrong with each part of the request. Empty when the error isn't about one part of it.
45
45
  * @param request_id {String} The ID of the request. Include it when you contact support.
@@ -100,6 +100,15 @@ var ErrorInfo = /*#__PURE__*/function () {
100
100
  if (data.hasOwnProperty('template_id')) {
101
101
  obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
102
102
  }
103
+ if (data.hasOwnProperty('folder_id')) {
104
+ obj['folder_id'] = _ApiClient["default"].convertToType(data['folder_id'], 'String');
105
+ }
106
+ if (data.hasOwnProperty('custom_file_id')) {
107
+ obj['custom_file_id'] = _ApiClient["default"].convertToType(data['custom_file_id'], 'String');
108
+ }
109
+ if (data.hasOwnProperty('webhook_id')) {
110
+ obj['webhook_id'] = _ApiClient["default"].convertToType(data['webhook_id'], 'String');
111
+ }
103
112
  }
104
113
  return obj;
105
114
  }
@@ -155,6 +164,18 @@ var ErrorInfo = /*#__PURE__*/function () {
155
164
  if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
156
165
  throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
157
166
  }
167
+ // ensure the json data is a string
168
+ if (data['folder_id'] && !(typeof data['folder_id'] === 'string' || data['folder_id'] instanceof String)) {
169
+ throw new Error("Expected the field `folder_id` to be a primitive type in the JSON string but got " + data['folder_id']);
170
+ }
171
+ // ensure the json data is a string
172
+ if (data['custom_file_id'] && !(typeof data['custom_file_id'] === 'string' || data['custom_file_id'] instanceof String)) {
173
+ throw new Error("Expected the field `custom_file_id` to be a primitive type in the JSON string but got " + data['custom_file_id']);
174
+ }
175
+ // ensure the json data is a string
176
+ if (data['webhook_id'] && !(typeof data['webhook_id'] === 'string' || data['webhook_id'] instanceof String)) {
177
+ throw new Error("Expected the field `webhook_id` to be a primitive type in the JSON string but got " + data['webhook_id']);
178
+ }
158
179
  return true;
159
180
  }
160
181
  }]);
@@ -162,7 +183,7 @@ var ErrorInfo = /*#__PURE__*/function () {
162
183
  ErrorInfo.RequiredProperties = ["code", "message", "details", "request_id"];
163
184
 
164
185
  /**
165
- * A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count) or the embedded template editor. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): a request with the same Idempotency-Key is still being processed. Send the request again in a few seconds; when the first request has already created its record, its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request.
186
+ * A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept. When the first request created a record, its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id` or `webhook_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`).
166
187
  * @member {module:model/ErrorCode} code
167
188
  */
168
189
  ErrorInfo.prototype['code'] = undefined;
@@ -186,26 +207,44 @@ ErrorInfo.prototype['details'] = undefined;
186
207
  ErrorInfo.prototype['request_id'] = undefined;
187
208
 
188
209
  /**
189
- * When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the submission that's still being processed.
210
+ * When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout`, the submission that's still being processed. With `idempotency_key_in_use`, the submission the first request with the key created.
190
211
  * @member {String} submission_id
191
212
  */
192
213
  ErrorInfo.prototype['submission_id'] = undefined;
193
214
 
194
215
  /**
195
- * The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout` or `idempotency_key_in_use`, the batch that's still being processed.
216
+ * The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout`, the batch that's still being processed. With `idempotency_key_in_use`, the batch the first request with the key created.
196
217
  * @member {String} submission_batch_id
197
218
  */
198
219
  ErrorInfo.prototype['submission_batch_id'] = undefined;
199
220
 
200
221
  /**
201
- * With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the combined PDF that's still being processed.
222
+ * With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed. With `idempotency_key_in_use`, the combined PDF the first request with the key created.
202
223
  * @member {String} combined_pdf_id
203
224
  */
204
225
  ErrorInfo.prototype['combined_pdf_id'] = undefined;
205
226
 
206
227
  /**
207
- * With `polling_timeout`, the template whose PDF is still being processed.
228
+ * With `polling_timeout`, the template whose PDF is still being processed. With `idempotency_key_in_use`, the template the first request with the key created.
208
229
  * @member {String} template_id
209
230
  */
210
231
  ErrorInfo.prototype['template_id'] = undefined;
232
+
233
+ /**
234
+ * With `idempotency_key_in_use`, the folder the first request with the key created.
235
+ * @member {String} folder_id
236
+ */
237
+ ErrorInfo.prototype['folder_id'] = undefined;
238
+
239
+ /**
240
+ * With `idempotency_key_in_use`, the custom file the first request with the key created.
241
+ * @member {String} custom_file_id
242
+ */
243
+ ErrorInfo.prototype['custom_file_id'] = undefined;
244
+
245
+ /**
246
+ * With `idempotency_key_in_use`, the webhook the first request with the key created.
247
+ * @member {String} webhook_id
248
+ */
249
+ ErrorInfo.prototype['webhook_id'] = undefined;
211
250
  var _default = exports["default"] = ErrorInfo;
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The ErrorResponse model module.
32
32
  * @module model/ErrorResponse
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var ErrorResponse = /*#__PURE__*/function () {
36
36
  /**
@@ -44,7 +44,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
44
44
  /**
45
45
  * The Field model module.
46
46
  * @module model/Field
47
- * @version 4.3.0
47
+ * @version 4.4.0
48
48
  */
49
49
  var Field = /*#__PURE__*/function () {
50
50
  /**
@@ -131,7 +131,7 @@ var Field = /*#__PURE__*/function () {
131
131
  * @param true_text {String} Boolean fields with text display: the text printed when the value is `true`. Empty uses the template's `true_text`; when neither is set, nothing prints.
132
132
  * @param false_text {String} Boolean fields with text display: the text printed when the value is `false`. Empty uses the template's `false_text`; when neither is set, nothing prints.
133
133
  * @param condition {String} Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value.
134
- * @param string_condition_type {module:model/StringConditionType} String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match.
134
+ * @param string_condition_type {module:model/StringConditionType} String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`.
135
135
  * @param number_condition_type {module:model/NumberConditionType} Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`.
136
136
  * @param number_condition_range_min {Number} With `number_condition_type` `range`: the lower end of the range, included unless `number_condition_range_exclusive_min` is set.
137
137
  * @param number_condition_range_max {Number} With `number_condition_type` `range`: the upper end of the range, included unless `number_condition_range_exclusive_max` is set.
@@ -1157,7 +1157,7 @@ Field.prototype['false_text'] = undefined;
1157
1157
  Field.prototype['condition'] = undefined;
1158
1158
 
1159
1159
  /**
1160
- * String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match.
1160
+ * String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`.
1161
1161
  * @member {module:model/StringConditionType} string_condition_type
1162
1162
  */
1163
1163
  Field.prototype['string_condition_type'] = undefined;
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The FieldComparisonCondition model module.
32
32
  * @module model/FieldComparisonCondition
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var FieldComparisonCondition = /*#__PURE__*/function () {
36
36
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The FieldDependency model module.
34
34
  * @module model/FieldDependency
35
- * @version 4.3.0
35
+ * @version 4.4.0
36
36
  */
37
37
  var FieldDependency = /*#__PURE__*/function () {
38
38
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The FieldDependencyInput model module.
34
34
  * @module model/FieldDependencyInput
35
- * @version 4.3.0
35
+ * @version 4.4.0
36
36
  */
37
37
  var FieldDependencyInput = /*#__PURE__*/function () {
38
38
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The FieldEqualsCondition model module.
32
32
  * @module model/FieldEqualsCondition
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var FieldEqualsCondition = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The FieldGroup model module.
32
32
  * @module model/FieldGroup
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var FieldGroup = /*#__PURE__*/function () {
36
36
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The FieldGroupInput model module.
31
31
  * @module model/FieldGroupInput
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var FieldGroupInput = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The FieldInCondition model module.
31
31
  * @module model/FieldInCondition
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var FieldInCondition = /*#__PURE__*/function () {
35
35
  /**
@@ -41,7 +41,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
41
41
  /**
42
42
  * The FieldInput model module.
43
43
  * @module model/FieldInput
44
- * @version 4.3.0
44
+ * @version 4.4.0
45
45
  */
46
46
  var FieldInput = /*#__PURE__*/function () {
47
47
  /**
@@ -933,7 +933,7 @@ FieldInput.prototype['false_text'] = undefined;
933
933
  FieldInput.prototype['condition'] = undefined;
934
934
 
935
935
  /**
936
- * String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match.
936
+ * String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`.
937
937
  * @member {module:model/StringConditionType} string_condition_type
938
938
  */
939
939
  FieldInput.prototype['string_condition_type'] = undefined;
@@ -39,7 +39,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
39
39
  /**
40
40
  * The FieldOverride model module.
41
41
  * @module model/FieldOverride
42
- * @version 4.3.0
42
+ * @version 4.4.0
43
43
  */
44
44
  var FieldOverride = /*#__PURE__*/function () {
45
45
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The FieldPresenceCondition model module.
32
32
  * @module model/FieldPresenceCondition
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var FieldPresenceCondition = /*#__PURE__*/function () {
36
36
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The FieldRangeCondition model module.
31
31
  * @module model/FieldRangeCondition
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var FieldRangeCondition = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The Folder model module.
31
31
  * @module model/Folder
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var Folder = /*#__PURE__*/function () {
35
35
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The FolderList model module.
32
32
  * @module model/FolderList
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var FolderList = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The GenerateSubmissionFilesRequest model module.
32
32
  * @module model/GenerateSubmissionFilesRequest
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var GenerateSubmissionFilesRequest = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The GeneratedFile model module.
32
32
  * @module model/GeneratedFile
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var GeneratedFile = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The HtmlEngineOptions model module.
32
32
  * @module model/HtmlEngineOptions
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var HtmlEngineOptions = /*#__PURE__*/function () {
36
36
  /**
@@ -38,7 +38,7 @@ var HtmlEngineOptions = /*#__PURE__*/function () {
38
38
  * How an HTML template's PDFs are printed.
39
39
  * @alias module:model/HtmlEngineOptions
40
40
  * @param format {module:model/PageFormat} The paper size. `Custom` uses `width` and `height`.
41
- * @param scale {Number} How much to scale the page, such as `0.8`. `1` prints it at its normal size.
41
+ * @param scale {Number} How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size.
42
42
  * @param landscape {Boolean} Print pages in landscape orientation.
43
43
  * @param print_background {Boolean} Print background colors and images.
44
44
  * @param margin_top {String} The top margin, with a unit, such as `1in` or `20mm`.
@@ -187,7 +187,7 @@ HtmlEngineOptions.prototype['width'] = undefined;
187
187
  HtmlEngineOptions.prototype['height'] = undefined;
188
188
 
189
189
  /**
190
- * How much to scale the page, such as `0.8`. `1` prints it at its normal size.
190
+ * How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size.
191
191
  * @member {Number} scale
192
192
  */
193
193
  HtmlEngineOptions.prototype['scale'] = undefined;
@@ -27,7 +27,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
27
  /**
28
28
  * The HtmlEngineOptionsInput model module.
29
29
  * @module model/HtmlEngineOptionsInput
30
- * @version 4.3.0
30
+ * @version 4.4.0
31
31
  */
32
32
  var HtmlEngineOptionsInput = /*#__PURE__*/function () {
33
33
  /**
@@ -150,7 +150,7 @@ HtmlEngineOptionsInput.prototype['width'] = undefined;
150
150
  HtmlEngineOptionsInput.prototype['height'] = undefined;
151
151
 
152
152
  /**
153
- * How much to scale the page, such as `0.8`. `1` prints it at its normal size.
153
+ * How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size.
154
154
  * @member {Number} scale
155
155
  */
156
156
  HtmlEngineOptionsInput.prototype['scale'] = undefined;
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The MoveFolderRequest model module.
31
31
  * @module model/MoveFolderRequest
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var MoveFolderRequest = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The MoveTemplateRequest model module.
31
31
  * @module model/MoveTemplateRequest
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var MoveTemplateRequest = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The PageImage model module.
31
31
  * @module model/PageImage
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var PageImage = /*#__PURE__*/function () {
35
35
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The PageImages model module.
33
33
  * @module model/PageImages
34
- * @version 4.3.0
34
+ * @version 4.4.0
35
35
  */
36
36
  var PageImages = /*#__PURE__*/function () {
37
37
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The PredefinedField model module.
32
32
  * @module model/PredefinedField
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var PredefinedField = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The PredefinedFieldInput model module.
32
32
  * @module model/PredefinedFieldInput
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var PredefinedFieldInput = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The PublishTemplateVersionRequest model module.
32
32
  * @module model/PublishTemplateVersionRequest
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var PublishTemplateVersionRequest = /*#__PURE__*/function () {
36
36
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The RemoveTemplateFieldsRequest model module.
31
31
  * @module model/RemoveTemplateFieldsRequest
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var RemoveTemplateFieldsRequest = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The RenameFolderRequest model module.
31
31
  * @module model/RenameFolderRequest
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var RenameFolderRequest = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The ReorderTemplateFieldsRequest model module.
31
31
  * @module model/ReorderTemplateFieldsRequest
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var ReorderTemplateFieldsRequest = /*#__PURE__*/function () {
35
35
  /**