docspring 4.1.0 → 4.2.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 (111) hide show
  1. package/AGENTS.md +3 -2
  2. package/README.md +4 -1
  3. package/dist/ApiClient.js +2 -2
  4. package/dist/RequestSchemas.js +75 -8
  5. package/dist/WebhookSignature.js +86 -0
  6. package/dist/api/Client.js +147 -15
  7. package/dist/index.js +42 -0
  8. package/dist/model/AddTemplateFieldsRequest.js +1 -1
  9. package/dist/model/AuthenticationCheck.js +1 -1
  10. package/dist/model/CombinedPdf.js +3 -3
  11. package/dist/model/CombinedPdfFiles.js +1 -1
  12. package/dist/model/CombinedPdfList.js +1 -1
  13. package/dist/model/CombinedPdfSource.js +1 -1
  14. package/dist/model/CombinedPdfSourceInput.js +1 -1
  15. package/dist/model/CombinedPdfSourcePdf.js +1 -1
  16. package/dist/model/CopyTemplateRequest.js +1 -1
  17. package/dist/model/CreateCombinedPdfRequest.js +2 -2
  18. package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
  19. package/dist/model/CreateFolderRequest.js +1 -1
  20. package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
  21. package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
  22. package/dist/model/CreateSubmissionBatchRequest.js +1 -1
  23. package/dist/model/CreateSubmissionRequest.js +3 -3
  24. package/dist/model/CreateTemplatePreviewRequest.js +112 -0
  25. package/dist/model/CreateTemplateRequest.js +11 -2
  26. package/dist/model/CreateWebhookRequest.js +1 -1
  27. package/dist/model/CustomFile.js +1 -1
  28. package/dist/model/CustomFileList.js +1 -1
  29. package/dist/model/CustomFileSourcePdf.js +1 -1
  30. package/dist/model/ErrorCode.js +11 -1
  31. package/dist/model/ErrorDetail.js +2 -2
  32. package/dist/model/ErrorInfo.js +6 -6
  33. package/dist/model/ErrorResponse.js +1 -1
  34. package/dist/model/Field.js +1 -1
  35. package/dist/model/FieldComparisonCondition.js +1 -1
  36. package/dist/model/FieldDependency.js +1 -1
  37. package/dist/model/FieldDependencyInput.js +1 -1
  38. package/dist/model/FieldEqualsCondition.js +1 -1
  39. package/dist/model/FieldGroup.js +1 -1
  40. package/dist/model/FieldGroupInput.js +1 -1
  41. package/dist/model/FieldInCondition.js +1 -1
  42. package/dist/model/FieldInput.js +1 -1
  43. package/dist/model/FieldOverride.js +1 -1
  44. package/dist/model/FieldPresenceCondition.js +1 -1
  45. package/dist/model/FieldRangeCondition.js +1 -1
  46. package/dist/model/Folder.js +1 -1
  47. package/dist/model/FolderList.js +1 -1
  48. package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
  49. package/dist/model/GeneratedFile.js +1 -1
  50. package/dist/model/HtmlEngineOptions.js +1 -1
  51. package/dist/model/HtmlEngineOptionsInput.js +1 -1
  52. package/dist/model/MoveFolderRequest.js +1 -1
  53. package/dist/model/MoveTemplateRequest.js +1 -1
  54. package/dist/model/PageImage.js +1 -1
  55. package/dist/model/PageImages.js +1 -1
  56. package/dist/model/PredefinedField.js +1 -1
  57. package/dist/model/PredefinedFieldInput.js +1 -1
  58. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  59. package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
  60. package/dist/model/RenameFolderRequest.js +1 -1
  61. package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
  62. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  63. package/dist/model/SignatureRequest.js +1 -1
  64. package/dist/model/SignatureRequestEvent.js +1 -1
  65. package/dist/model/SignatureRequestInput.js +1 -1
  66. package/dist/model/SignatureRequestToken.js +1 -1
  67. package/dist/model/Submission.js +75 -75
  68. package/dist/model/SubmissionAction.js +1 -1
  69. package/dist/model/SubmissionBatch.js +1 -1
  70. package/dist/model/SubmissionFiles.js +1 -1
  71. package/dist/model/SubmissionInput.js +3 -3
  72. package/dist/model/SubmissionList.js +5 -5
  73. package/dist/model/SubmissionSourcePdf.js +1 -1
  74. package/dist/model/SubmissionSummary.js +343 -0
  75. package/dist/model/SubmissionValidation.js +1 -1
  76. package/dist/model/Template.js +68 -57
  77. package/dist/model/TemplateActor.js +3 -3
  78. package/dist/model/TemplateDefaults.js +1 -1
  79. package/dist/model/TemplateDefaultsInput.js +1 -1
  80. package/dist/model/TemplateDiff.js +1 -1
  81. package/dist/model/TemplateDiffSummary.js +1 -1
  82. package/dist/model/TemplateDocument.js +33 -33
  83. package/dist/model/TemplateDocumentSummary.js +152 -0
  84. package/dist/model/TemplateFieldChange.js +1 -1
  85. package/dist/model/TemplateFieldChanges.js +1 -1
  86. package/dist/model/TemplateFieldDependency.js +1 -1
  87. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  88. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  89. package/dist/model/TemplateFieldDependencyInput.js +1 -1
  90. package/dist/model/TemplateFieldMove.js +1 -1
  91. package/dist/model/TemplateFields.js +1 -1
  92. package/dist/model/TemplateModelCode.js +1 -1
  93. package/dist/model/TemplatePageImages.js +1 -1
  94. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  95. package/dist/model/TemplatePreview.js +211 -0
  96. package/dist/model/TemplatePreviewState.js +64 -0
  97. package/dist/model/TemplateSourcePdf.js +1 -1
  98. package/dist/model/TemplateSummary.js +14 -288
  99. package/dist/model/TemplateSummaryList.js +1 -1
  100. package/dist/model/TemplateVersion.js +1 -1
  101. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  102. package/dist/model/UpdateTemplateDocumentRequest.js +1 -1
  103. package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
  104. package/dist/model/UpdateTemplateRequest.js +11 -2
  105. package/dist/model/UpdateWebhookRequest.js +1 -1
  106. package/dist/model/UploadPresign.js +1 -1
  107. package/dist/model/UrlSourcePdf.js +1 -1
  108. package/dist/model/ValidateSubmissionRequest.js +3 -3
  109. package/dist/model/Webhook.js +1 -1
  110. package/dist/model/WebhookList.js +1 -1
  111. package/package.json +3 -2
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The CreateSignatureRequestEventRequest model module.
33
33
  * @module model/CreateSignatureRequestEventRequest
34
- * @version 4.1.0
34
+ * @version 4.2.0
35
35
  */
36
36
  var CreateSignatureRequestEventRequest = /*#__PURE__*/function () {
37
37
  /**
@@ -27,7 +27,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
27
  /**
28
28
  * The CreateSignatureRequestTokenRequest model module.
29
29
  * @module model/CreateSignatureRequestTokenRequest
30
- * @version 4.1.0
30
+ * @version 4.2.0
31
31
  */
32
32
  var CreateSignatureRequestTokenRequest = /*#__PURE__*/function () {
33
33
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The CreateSubmissionBatchRequest model module.
33
33
  * @module model/CreateSubmissionBatchRequest
34
- * @version 4.1.0
34
+ * @version 4.2.0
35
35
  */
36
36
  var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
37
37
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The CreateSubmissionRequest model module.
34
34
  * @module model/CreateSubmissionRequest
35
- * @version 4.1.0
35
+ * @version 4.2.0
36
36
  */
37
37
  var CreateSubmissionRequest = /*#__PURE__*/function () {
38
38
  /**
@@ -177,7 +177,7 @@ CreateSubmissionRequest.prototype['editable'] = undefined;
177
177
  CreateSubmissionRequest.prototype['data'] = undefined;
178
178
 
179
179
  /**
180
- * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
180
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
181
181
  * @member {Object.<String, Object>} metadata
182
182
  */
183
183
  CreateSubmissionRequest.prototype['metadata'] = undefined;
@@ -213,7 +213,7 @@ CreateSubmissionRequest.prototype['field_overrides'] = undefined;
213
213
  CreateSubmissionRequest.prototype['html'] = undefined;
214
214
 
215
215
  /**
216
- * For an HTML template, CSS to use instead of the template's.
216
+ * For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity.
217
217
  * @member {String} css
218
218
  */
219
219
  CreateSubmissionRequest.prototype['css'] = undefined;
@@ -0,0 +1,112 @@
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 CreateTemplatePreviewRequest model module.
31
+ * @module model/CreateTemplatePreviewRequest
32
+ * @version 4.2.0
33
+ */
34
+ var CreateTemplatePreviewRequest = /*#__PURE__*/function () {
35
+ /**
36
+ * Constructs a new <code>CreateTemplatePreviewRequest</code>.
37
+ * The data to render the template with.
38
+ * @alias module:model/CreateTemplatePreviewRequest
39
+ * @param data {Object.<String, Object>} The values of the template's fields, by field name, as you'd send them to create a submission. They're rendered as they are: they aren't checked against the template's fields. A value that a field can't print, such as an image URL that doesn't download, makes the preview's `state` `error`, with an `error_message`.
40
+ */
41
+ function CreateTemplatePreviewRequest(data) {
42
+ _classCallCheck(this, CreateTemplatePreviewRequest);
43
+ CreateTemplatePreviewRequest.initialize(this, data);
44
+ }
45
+
46
+ /**
47
+ * Initializes the fields of this object.
48
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
49
+ * Only for internal use.
50
+ */
51
+ return _createClass(CreateTemplatePreviewRequest, null, [{
52
+ key: "initialize",
53
+ value: function initialize(obj, data) {
54
+ obj['data'] = data;
55
+ }
56
+
57
+ /**
58
+ * Constructs a <code>CreateTemplatePreviewRequest</code> from a plain JavaScript object, optionally creating a new instance.
59
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
60
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
61
+ * @param {module:model/CreateTemplatePreviewRequest} obj Optional instance to populate.
62
+ * @return {module:model/CreateTemplatePreviewRequest} The populated <code>CreateTemplatePreviewRequest</code> instance.
63
+ */
64
+ }, {
65
+ key: "constructFromObject",
66
+ value: function constructFromObject(data, obj) {
67
+ if (data) {
68
+ obj = obj || new CreateTemplatePreviewRequest();
69
+ if (data.hasOwnProperty('data')) {
70
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], {
71
+ 'String': Object
72
+ });
73
+ }
74
+ }
75
+ return obj;
76
+ }
77
+
78
+ /**
79
+ * Validates the JSON data with respect to <code>CreateTemplatePreviewRequest</code>.
80
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
81
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateTemplatePreviewRequest</code>.
82
+ */
83
+ }, {
84
+ key: "validateJSON",
85
+ value: function validateJSON(data) {
86
+ // check to make sure all required properties are present in the JSON string
87
+ var _iterator = _createForOfIteratorHelper(CreateTemplatePreviewRequest.RequiredProperties),
88
+ _step;
89
+ try {
90
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
91
+ var property = _step.value;
92
+ if (!data.hasOwnProperty(property)) {
93
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
94
+ }
95
+ }
96
+ } catch (err) {
97
+ _iterator.e(err);
98
+ } finally {
99
+ _iterator.f();
100
+ }
101
+ return true;
102
+ }
103
+ }]);
104
+ }();
105
+ CreateTemplatePreviewRequest.RequiredProperties = ["data"];
106
+
107
+ /**
108
+ * The values of the template's fields, by field name, as you'd send them to create a submission. They're rendered as they are: they aren't checked against the template's fields. A value that a field can't print, such as an image URL that doesn't download, makes the preview's `state` `error`, with an `error_message`.
109
+ * @member {Object.<String, Object>} data
110
+ */
111
+ CreateTemplatePreviewRequest.prototype['data'] = undefined;
112
+ var _default = exports["default"] = CreateTemplatePreviewRequest;
@@ -40,7 +40,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
40
40
  /**
41
41
  * The CreateTemplateRequest model module.
42
42
  * @module model/CreateTemplateRequest
43
- * @version 4.1.0
43
+ * @version 4.2.0
44
44
  */
45
45
  var CreateTemplateRequest = /*#__PURE__*/function () {
46
46
  /**
@@ -184,6 +184,9 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
184
184
  if (data.hasOwnProperty('html_engine_options')) {
185
185
  obj['html_engine_options'] = _ApiClient["default"].convertToType(data['html_engine_options'], _HtmlEngineOptionsInput["default"]);
186
186
  }
187
+ if (data.hasOwnProperty('html_escape_data')) {
188
+ obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
189
+ }
187
190
  if (data.hasOwnProperty('cache_id')) {
188
191
  obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
189
192
  }
@@ -420,7 +423,7 @@ CreateTemplateRequest.prototype['default_form_mode'] = undefined;
420
423
  CreateTemplateRequest.prototype['editable_submissions'] = undefined;
421
424
 
422
425
  /**
423
- * The sites where the template's signature requests, forms and embedded template editor can be loaded: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
426
+ * The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and the simple form) aren't restricted.
424
427
  * @member {Array.<String>} embed_domains
425
428
  */
426
429
  CreateTemplateRequest.prototype['embed_domains'] = undefined;
@@ -563,6 +566,12 @@ CreateTemplateRequest.prototype['footer_html'] = undefined;
563
566
  */
564
567
  CreateTemplateRequest.prototype['html_engine_options'] = undefined;
565
568
 
569
+ /**
570
+ * Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for PDF templates.
571
+ * @member {Boolean} html_escape_data
572
+ */
573
+ CreateTemplateRequest.prototype['html_escape_data'] = undefined;
574
+
566
575
  /**
567
576
  * A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). A PDF template needs one of `cache_id`, `document_url` and `document_base64`. To upload the PDF with the request, use POST /templates/upload.
568
577
  * @member {String} cache_id
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The CreateWebhookRequest model module.
33
33
  * @module model/CreateWebhookRequest
34
- * @version 4.1.0
34
+ * @version 4.2.0
35
35
  */
36
36
  var CreateWebhookRequest = /*#__PURE__*/function () {
37
37
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CustomFile model module.
31
31
  * @module model/CustomFile
32
- * @version 4.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var CustomFile = /*#__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 CustomFileList model module.
32
32
  * @module model/CustomFileList
33
- * @version 4.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var CustomFileList = /*#__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 CustomFileSourcePdf model module.
31
31
  * @module model/CustomFileSourcePdf
32
- * @version 4.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var CustomFileSourcePdf = /*#__PURE__*/function () {
35
35
  /**
@@ -151,4 +151,14 @@ _defineProperty(ErrorCode, "upstream_timeout", "upstream_timeout");
151
151
  * value: "polling_timeout"
152
152
  * @const
153
153
  */
154
- _defineProperty(ErrorCode, "polling_timeout", "polling_timeout");
154
+ _defineProperty(ErrorCode, "polling_timeout", "polling_timeout");
155
+ /**
156
+ * value: "idempotency_key_in_use"
157
+ * @const
158
+ */
159
+ _defineProperty(ErrorCode, "idempotency_key_in_use", "idempotency_key_in_use");
160
+ /**
161
+ * value: "idempotency_key_reused"
162
+ * @const
163
+ */
164
+ _defineProperty(ErrorCode, "idempotency_key_reused", "idempotency_key_reused");
@@ -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.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var ErrorDetail = /*#__PURE__*/function () {
35
35
  /**
@@ -157,7 +157,7 @@ ErrorDetail.prototype['message'] = undefined;
157
157
  ErrorDetail.prototype['pointer'] = undefined;
158
158
 
159
159
  /**
160
- * The query parameter the detail is about.
160
+ * The query parameter or header the detail is about.
161
161
  * @member {String} parameter
162
162
  */
163
163
  ErrorDetail.prototype['parameter'] = undefined;
@@ -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.1.0
34
+ * @version 4.2.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 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 PDF wasn'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.
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 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 PDF wasn'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.
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.
@@ -162,7 +162,7 @@ var ErrorInfo = /*#__PURE__*/function () {
162
162
  ErrorInfo.RequiredProperties = ["code", "message", "details", "request_id"];
163
163
 
164
164
  /**
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 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 PDF wasn'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.
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 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 PDF wasn'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.
166
166
  * @member {module:model/ErrorCode} code
167
167
  */
168
168
  ErrorInfo.prototype['code'] = undefined;
@@ -186,19 +186,19 @@ ErrorInfo.prototype['details'] = undefined;
186
186
  ErrorInfo.prototype['request_id'] = undefined;
187
187
 
188
188
  /**
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`, the submission that's still being processed.
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.
190
190
  * @member {String} submission_id
191
191
  */
192
192
  ErrorInfo.prototype['submission_id'] = undefined;
193
193
 
194
194
  /**
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`, the batch that's still being processed.
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.
196
196
  * @member {String} submission_batch_id
197
197
  */
198
198
  ErrorInfo.prototype['submission_batch_id'] = undefined;
199
199
 
200
200
  /**
201
- * With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed.
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.
202
202
  * @member {String} combined_pdf_id
203
203
  */
204
204
  ErrorInfo.prototype['combined_pdf_id'] = undefined;
@@ -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.1.0
33
+ * @version 4.2.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.1.0
47
+ * @version 4.2.0
48
48
  */
49
49
  var Field = /*#__PURE__*/function () {
50
50
  /**
@@ -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.1.0
33
+ * @version 4.2.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.1.0
35
+ * @version 4.2.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.1.0
35
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
32
+ * @version 4.2.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.1.0
32
+ * @version 4.2.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.1.0
44
+ * @version 4.2.0
45
45
  */
46
46
  var FieldInput = /*#__PURE__*/function () {
47
47
  /**
@@ -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.1.0
42
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
32
+ * @version 4.2.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.1.0
32
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
33
+ * @version 4.2.0
34
34
  */
35
35
  var HtmlEngineOptions = /*#__PURE__*/function () {
36
36
  /**
@@ -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.1.0
30
+ * @version 4.2.0
31
31
  */
32
32
  var HtmlEngineOptionsInput = /*#__PURE__*/function () {
33
33
  /**
@@ -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.1.0
32
+ * @version 4.2.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.1.0
32
+ * @version 4.2.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.1.0
32
+ * @version 4.2.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.1.0
34
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
33
+ * @version 4.2.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.1.0
32
+ * @version 4.2.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.1.0
32
+ * @version 4.2.0
33
33
  */
34
34
  var RenameFolderRequest = /*#__PURE__*/function () {
35
35
  /**