docspring 4.0.0 → 4.2.0

package/dist/model/CombinedPdfSourcePdf.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinedPdfSourcePdf model module.
  * @module model/CombinedPdfSourcePdf
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CombinedPdfSourcePdf = /*#__PURE__*/function () {
   /**

package/dist/model/CopyTemplateRequest.js

@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CopyTemplateRequest model module.
  * @module model/CopyTemplateRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CopyTemplateRequest = /*#__PURE__*/function () {
   /**

package/dist/model/CreateCombinedPdfRequest.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateCombinedPdfRequest model module.
  * @module model/CreateCombinedPdfRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateCombinedPdfRequest = /*#__PURE__*/function () {
   /**
@@ -149,7 +149,7 @@ CreateCombinedPdfRequest.RequiredProperties = ["source_pdfs"];
 CreateCombinedPdfRequest.prototype['source_pdfs'] = undefined;
 
 /**
- * Your own data about the combined PDF, such as an ID from your app.
+ * Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): 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 combined PDF's ID (`com_1234567890abcdef01.pdf`).
  * @member {Object.<String, Object>} metadata
  */
 CreateCombinedPdfRequest.prototype['metadata'] = undefined;

package/dist/model/CreateCustomFileFromUploadRequest.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateCustomFileFromUploadRequest model module.
  * @module model/CreateCustomFileFromUploadRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateCustomFileFromUploadRequest = /*#__PURE__*/function () {
   /**

package/dist/model/CreateFolderRequest.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateFolderRequest model module.
  * @module model/CreateFolderRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateFolderRequest = /*#__PURE__*/function () {
   /**

package/dist/model/CreateSignatureRequestEventRequest.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSignatureRequestEventRequest model module.
  * @module model/CreateSignatureRequestEventRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateSignatureRequestEventRequest = /*#__PURE__*/function () {
   /**

package/dist/model/CreateSignatureRequestTokenRequest.js

@@ -27,7 +27,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSignatureRequestTokenRequest model module.
  * @module model/CreateSignatureRequestTokenRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateSignatureRequestTokenRequest = /*#__PURE__*/function () {
   /**

package/dist/model/CreateSubmissionBatchRequest.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _SubmissionInput = _interopRequireDefault(require("./SubmissionInput"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 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); }
@@ -30,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSubmissionBatchRequest model module.
  * @module model/CreateSubmissionBatchRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
   /**
@@ -81,6 +82,9 @@ var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('test')) {
           obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
         }
+        if (data.hasOwnProperty('output_formats')) {
+          obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
+        }
         if (data.hasOwnProperty('submissions')) {
           obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_SubmissionInput["default"]]);
         }
@@ -119,6 +123,10 @@ var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
       if (data['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
         throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
       }
+      // ensure the json data is an array
+      if (!Array.isArray(data['output_formats'])) {
+        throw new Error("Expected the field `output_formats` to be an array in the JSON data but got " + data['output_formats']);
+      }
       if (data['submissions']) {
         // data not null
         // ensure the json data is an array
@@ -170,6 +178,12 @@ CreateSubmissionBatchRequest.prototype['template_version'] = undefined;
  */
 CreateSubmissionBatchRequest.prototype['test'] = undefined;
 
+/**
+ * The default `output_formats` for each submission that doesn't set its own.
+ * @member {Array.<module:model/OutputFormat>} output_formats
+ */
+CreateSubmissionBatchRequest.prototype['output_formats'] = undefined;
+
 /**
  * Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch.
  * @member {Array.<module:model/SubmissionInput>} submissions

package/dist/model/CreateSubmissionRequest.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 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); }
@@ -31,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSubmissionRequest model module.
  * @module model/CreateSubmissionRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateSubmissionRequest = /*#__PURE__*/function () {
   /**
@@ -84,6 +85,9 @@ var CreateSubmissionRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('password')) {
           obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
         }
+        if (data.hasOwnProperty('output_formats')) {
+          obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
+        }
         if (data.hasOwnProperty('expires_in')) {
           obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
         }
@@ -117,6 +121,10 @@ var CreateSubmissionRequest = /*#__PURE__*/function () {
       if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
         throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
       }
+      // ensure the json data is an array
+      if (!Array.isArray(data['output_formats'])) {
+        throw new Error("Expected the field `output_formats` to be an array in the JSON data but got " + data['output_formats']);
+      }
       // ensure the json data is a string
       if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
         throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
@@ -169,7 +177,7 @@ CreateSubmissionRequest.prototype['editable'] = undefined;
 CreateSubmissionRequest.prototype['data'] = undefined;
 
 /**
- * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+ * 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`).
  * @member {Object.<String, Object>} metadata
  */
 CreateSubmissionRequest.prototype['metadata'] = undefined;
@@ -180,6 +188,12 @@ CreateSubmissionRequest.prototype['metadata'] = undefined;
  */
 CreateSubmissionRequest.prototype['password'] = undefined;
 
+/**
+ * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+ * @member {Array.<module:model/OutputFormat>} output_formats
+ */
+CreateSubmissionRequest.prototype['output_formats'] = undefined;
+
 /**
  * Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
  * @member {Number} expires_in
@@ -199,7 +213,7 @@ CreateSubmissionRequest.prototype['field_overrides'] = undefined;
 CreateSubmissionRequest.prototype['html'] = undefined;
 
 /**
- * For an HTML template, CSS to use instead of the template's.
+ * 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.
  * @member {String} css
  */
 CreateSubmissionRequest.prototype['css'] = undefined;

package/dist/model/CreateTemplatePreviewRequest.js

@@ -0,0 +1,112 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+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); }
+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; } } }; }
+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; } }
+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; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+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); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+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); } /**
+ * DocSpring API
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ *
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The CreateTemplatePreviewRequest model module.
+ * @module model/CreateTemplatePreviewRequest
+ * @version 4.2.0
+ */
+var CreateTemplatePreviewRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>CreateTemplatePreviewRequest</code>.
+   * The data to render the template with.
+   * @alias module:model/CreateTemplatePreviewRequest
+   * @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`.
+   */
+  function CreateTemplatePreviewRequest(data) {
+    _classCallCheck(this, CreateTemplatePreviewRequest);
+    CreateTemplatePreviewRequest.initialize(this, data);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(CreateTemplatePreviewRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj, data) {
+      obj['data'] = data;
+    }
+
+    /**
+     * Constructs a <code>CreateTemplatePreviewRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/CreateTemplatePreviewRequest} obj Optional instance to populate.
+     * @return {module:model/CreateTemplatePreviewRequest} The populated <code>CreateTemplatePreviewRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new CreateTemplatePreviewRequest();
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], {
+            'String': Object
+          });
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>CreateTemplatePreviewRequest</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateTemplatePreviewRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(CreateTemplatePreviewRequest.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      return true;
+    }
+  }]);
+}();
+CreateTemplatePreviewRequest.RequiredProperties = ["data"];
+
+/**
+ * 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`.
+ * @member {Object.<String, Object>} data
+ */
+CreateTemplatePreviewRequest.prototype['data'] = undefined;
+var _default = exports["default"] = CreateTemplatePreviewRequest;

package/dist/model/CreateTemplateRequest.js

@@ -11,6 +11,7 @@ var _FieldSetupLogic = _interopRequireDefault(require("./FieldSetupLogic"));
 var _FieldSetupNaming = _interopRequireDefault(require("./FieldSetupNaming"));
 var _FieldSetupSource = _interopRequireDefault(require("./FieldSetupSource"));
 var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
+var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
 var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
 var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
 var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
@@ -39,7 +40,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateTemplateRequest model module.
  * @module model/CreateTemplateRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateTemplateRequest = /*#__PURE__*/function () {
   /**
@@ -160,6 +161,14 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('field_dependencies')) {
           obj['field_dependencies'] = _ApiClient["default"].convertToType(data['field_dependencies'], [_TemplateFieldDependencyInput["default"]]);
         }
+        if (data.hasOwnProperty('predefined_fields')) {
+          obj['predefined_fields'] = _ApiClient["default"].convertToType(data['predefined_fields'], [_PredefinedFieldInput["default"]]);
+        }
+        if (data.hasOwnProperty('predefined_fields_sample_data')) {
+          obj['predefined_fields_sample_data'] = _ApiClient["default"].convertToType(data['predefined_fields_sample_data'], {
+            'String': Object
+          });
+        }
         if (data.hasOwnProperty('html')) {
           obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
         }
@@ -175,9 +184,18 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('html_engine_options')) {
           obj['html_engine_options'] = _ApiClient["default"].convertToType(data['html_engine_options'], _HtmlEngineOptionsInput["default"]);
         }
+        if (data.hasOwnProperty('html_escape_data')) {
+          obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
+        }
         if (data.hasOwnProperty('cache_id')) {
           obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
         }
+        if (data.hasOwnProperty('document_url')) {
+          obj['document_url'] = _ApiClient["default"].convertToType(data['document_url'], 'String');
+        }
+        if (data.hasOwnProperty('document_base64')) {
+          obj['document_base64'] = _ApiClient["default"].convertToType(data['document_base64'], 'String');
+        }
         if (data.hasOwnProperty('filename')) {
           obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
         }
@@ -274,6 +292,27 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         }
         ;
       }
+      if (data['predefined_fields']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['predefined_fields'])) {
+          throw new Error("Expected the field `predefined_fields` to be an array in the JSON data but got " + data['predefined_fields']);
+        }
+        // validate the optional field `predefined_fields` (array)
+        var _iterator3 = _createForOfIteratorHelper(data['predefined_fields']),
+          _step3;
+        try {
+          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+            var _item = _step3.value;
+            _PredefinedFieldInput["default"].validateJSON(_item);
+          }
+        } catch (err) {
+          _iterator3.e(err);
+        } finally {
+          _iterator3.f();
+        }
+        ;
+      }
       // ensure the json data is a string
       if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
         throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
@@ -300,6 +339,14 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         throw new Error("Expected the field `cache_id` to be a primitive type in the JSON string but got " + data['cache_id']);
       }
       // ensure the json data is a string
+      if (data['document_url'] && !(typeof data['document_url'] === 'string' || data['document_url'] instanceof String)) {
+        throw new Error("Expected the field `document_url` to be a primitive type in the JSON string but got " + data['document_url']);
+      }
+      // ensure the json data is a string
+      if (data['document_base64'] && !(typeof data['document_base64'] === 'string' || data['document_base64'] instanceof String)) {
+        throw new Error("Expected the field `document_base64` to be a primitive type in the JSON string but got " + data['document_base64']);
+      }
+      // ensure the json data is a string
       if (data['filename'] && !(typeof data['filename'] === 'string' || data['filename'] instanceof String)) {
         throw new Error("Expected the field `filename` to be a primitive type in the JSON string but got " + data['filename']);
       }
@@ -376,7 +423,7 @@ CreateTemplateRequest.prototype['default_form_mode'] = undefined;
 CreateTemplateRequest.prototype['editable_submissions'] = undefined;
 
 /**
- * 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.
+ * 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.
  * @member {Array.<String>} embed_domains
  */
 CreateTemplateRequest.prototype['embed_domains'] = undefined;
@@ -477,6 +524,18 @@ CreateTemplateRequest.prototype['defaults'] = undefined;
  */
 CreateTemplateRequest.prototype['field_dependencies'] = undefined;
 
+/**
+ * The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
+ * @member {Array.<module:model/PredefinedFieldInput>} predefined_fields
+ */
+CreateTemplateRequest.prototype['predefined_fields'] = undefined;
+
+/**
+ * Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for.
+ * @member {Object.<String, Object>} predefined_fields_sample_data
+ */
+CreateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
+
 /**
  * The HTML of an HTML template, as a Liquid template. Null for PDF templates.
  * @member {String} html
@@ -508,13 +567,31 @@ CreateTemplateRequest.prototype['footer_html'] = undefined;
 CreateTemplateRequest.prototype['html_engine_options'] = undefined;
 
 /**
- * A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). Required for a PDF template. To upload the PDF with the request, use POST /templates/upload.
+ * 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.
+ * @member {Boolean} html_escape_data
+ */
+CreateTemplateRequest.prototype['html_escape_data'] = undefined;
+
+/**
+ * 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.
  * @member {String} cache_id
  */
 CreateTemplateRequest.prototype['cache_id'] = undefined;
 
 /**
- * The PDF's file name, for a `cache_id` (presigned uploads don't send one).
+ * An https:// link to the template's PDF (up to 100 MB), instead of `cache_id`. DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then (sync.api hosts wait for it). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
+ * @member {String} document_url
+ */
+CreateTemplateRequest.prototype['document_url'] = undefined;
+
+/**
+ * The template's PDF, encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
+ * @member {String} document_base64
+ */
+CreateTemplateRequest.prototype['document_base64'] = undefined;
+
+/**
+ * The PDF's file name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
  * @member {String} filename
  */
 CreateTemplateRequest.prototype['filename'] = undefined;

package/dist/model/CreateWebhookRequest.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateWebhookRequest model module.
  * @module model/CreateWebhookRequest
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CreateWebhookRequest = /*#__PURE__*/function () {
   /**

package/dist/model/CustomFile.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CustomFile model module.
  * @module model/CustomFile
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CustomFile = /*#__PURE__*/function () {
   /**

package/dist/model/CustomFileList.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CustomFileList model module.
  * @module model/CustomFileList
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CustomFileList = /*#__PURE__*/function () {
   /**

package/dist/model/CustomFileSourcePdf.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CustomFileSourcePdf model module.
  * @module model/CustomFileSourcePdf
- * @version 4.0.0
+ * @version 4.2.0
  */
 var CustomFileSourcePdf = /*#__PURE__*/function () {
   /**

package/dist/model/ErrorCode.js

@@ -151,4 +151,14 @@ _defineProperty(ErrorCode, "upstream_timeout", "upstream_timeout");
  * value: "polling_timeout"
  * @const
  */
-_defineProperty(ErrorCode, "polling_timeout", "polling_timeout");
+_defineProperty(ErrorCode, "polling_timeout", "polling_timeout");
+/**
+ * value: "idempotency_key_in_use"
+ * @const
+ */
+_defineProperty(ErrorCode, "idempotency_key_in_use", "idempotency_key_in_use");
+/**
+ * value: "idempotency_key_reused"
+ * @const
+ */
+_defineProperty(ErrorCode, "idempotency_key_reused", "idempotency_key_reused");

package/dist/model/ErrorDetail.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The ErrorDetail model module.
  * @module model/ErrorDetail
- * @version 4.0.0
+ * @version 4.2.0
  */
 var ErrorDetail = /*#__PURE__*/function () {
   /**
@@ -157,7 +157,7 @@ ErrorDetail.prototype['message'] = undefined;
 ErrorDetail.prototype['pointer'] = undefined;
 
 /**
- * The query parameter the detail is about.
+ * The query parameter or header the detail is about.
  * @member {String} parameter
  */
 ErrorDetail.prototype['parameter'] = undefined;

package/dist/model/ErrorInfo.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The ErrorInfo model module.
  * @module model/ErrorInfo
- * @version 4.0.0
+ * @version 4.2.0
  */
 var ErrorInfo = /*#__PURE__*/function () {
   /**
@@ -39,7 +39,7 @@ var ErrorInfo = /*#__PURE__*/function () {
    * What went wrong.
    * @alias module:model/ErrorInfo
    * @extends Object
-   * @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.
+   * @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.
    * @param message {String} A human-readable explanation, safe to show to developers.
    * @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.
    * @param request_id {String} The ID of the request. Include it when you contact support.
@@ -162,7 +162,7 @@ var ErrorInfo = /*#__PURE__*/function () {
 ErrorInfo.RequiredProperties = ["code", "message", "details", "request_id"];
 
 /**
- * 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.
+ * 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.
  * @member {module:model/ErrorCode} code
  */
 ErrorInfo.prototype['code'] = undefined;
@@ -186,19 +186,19 @@ ErrorInfo.prototype['details'] = undefined;
 ErrorInfo.prototype['request_id'] = undefined;
 
 /**
- * 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.
+ * 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.
  * @member {String} submission_id
  */
 ErrorInfo.prototype['submission_id'] = undefined;
 
 /**
- * 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.
+ * 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.
  * @member {String} submission_batch_id
  */
 ErrorInfo.prototype['submission_batch_id'] = undefined;
 
 /**
- * With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed.
+ * 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.
  * @member {String} combined_pdf_id
  */
 ErrorInfo.prototype['combined_pdf_id'] = undefined;

package/dist/model/ErrorResponse.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The ErrorResponse model module.
  * @module model/ErrorResponse
- * @version 4.0.0
+ * @version 4.2.0
  */
 var ErrorResponse = /*#__PURE__*/function () {
   /**