docspring 4.0.0 → 4.1.0

package/dist/model/SubmissionInput.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"));
 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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -27,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionInput model module.
  * @module model/SubmissionInput
- * @version 4.0.0
+ * @version 4.1.0
  */
 var SubmissionInput = /*#__PURE__*/function () {
   /**
@@ -80,6 +81,9 @@ var SubmissionInput = /*#__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');
         }
@@ -116,6 +120,10 @@ var SubmissionInput = /*#__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']);
@@ -166,6 +174,12 @@ SubmissionInput.prototype['metadata'] = undefined;
  */
 SubmissionInput.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
+ */
+SubmissionInput.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

package/dist/model/SubmissionList.js

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

package/dist/model/SubmissionSourcePdf.js

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

package/dist/model/SubmissionValidation.js

@@ -0,0 +1,151 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _ErrorInfo = _interopRequireDefault(require("./ErrorInfo"));
+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 SubmissionValidation model module.
+ * @module model/SubmissionValidation
+ * @version 4.1.0
+ */
+var SubmissionValidation = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>SubmissionValidation</code>.
+   * Whether creating the submission would succeed, checked without saving it or making any files. `error` is the error that creating it would return (`validation_failed`, or `invalid_data` for data that doesn't match the template's fields), and is left out when `valid` is true.
+   * @alias module:model/SubmissionValidation
+   * @extends Object
+   * @param valid {Boolean} True when creating the submission would succeed.
+   * @param template_id {String} The template's ID.
+   * @param template_version {String} The published version the request was checked against, such as `1.2.0`. Null for the draft.
+   */
+  function SubmissionValidation(valid, template_id, template_version) {
+    _classCallCheck(this, SubmissionValidation);
+    SubmissionValidation.initialize(this, valid, template_id, template_version);
+  }
+
+  /**
+   * 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(SubmissionValidation, null, [{
+    key: "initialize",
+    value: function initialize(obj, valid, template_id, template_version) {
+      obj['valid'] = valid;
+      obj['template_id'] = template_id;
+      obj['template_version'] = template_version;
+    }
+
+    /**
+     * Constructs a <code>SubmissionValidation</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/SubmissionValidation} obj Optional instance to populate.
+     * @return {module:model/SubmissionValidation} The populated <code>SubmissionValidation</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new SubmissionValidation();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('valid')) {
+          obj['valid'] = _ApiClient["default"].convertToType(data['valid'], 'Boolean');
+        }
+        if (data.hasOwnProperty('template_id')) {
+          obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
+        }
+        if (data.hasOwnProperty('template_version')) {
+          obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
+        }
+        if (data.hasOwnProperty('error')) {
+          obj['error'] = data['error'] === null ? null : _ErrorInfo["default"].constructFromObject(data['error']);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>SubmissionValidation</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>SubmissionValidation</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(SubmissionValidation.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));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
+        throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
+      }
+      // ensure the json data is a string
+      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']);
+      }
+      return true;
+    }
+  }]);
+}();
+SubmissionValidation.RequiredProperties = ["valid", "template_id", "template_version"];
+
+/**
+ * True when creating the submission would succeed.
+ * @member {Boolean} valid
+ */
+SubmissionValidation.prototype['valid'] = undefined;
+
+/**
+ * The template's ID.
+ * @member {String} template_id
+ */
+SubmissionValidation.prototype['template_id'] = undefined;
+
+/**
+ * The published version the request was checked against, such as `1.2.0`. Null for the draft.
+ * @member {String} template_version
+ */
+SubmissionValidation.prototype['template_version'] = undefined;
+
+/**
+ * @member {module:model/ErrorInfo} error
+ */
+SubmissionValidation.prototype['error'] = undefined;
+var _default = exports["default"] = SubmissionValidation;

package/dist/model/Template.js

@@ -7,7 +7,9 @@ exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _AiFieldNamingLanguage = _interopRequireDefault(require("./AiFieldNamingLanguage"));
 var _ExpirationInterval = _interopRequireDefault(require("./ExpirationInterval"));
+var _FieldGroup = _interopRequireDefault(require("./FieldGroup"));
 var _HtmlEngineOptions = _interopRequireDefault(require("./HtmlEngineOptions"));
+var _PredefinedField = _interopRequireDefault(require("./PredefinedField"));
 var _TemplateActor = _interopRequireDefault(require("./TemplateActor"));
 var _TemplateDefaults = _interopRequireDefault(require("./TemplateDefaults"));
 var _TemplateDocument = _interopRequireDefault(require("./TemplateDocument"));
@@ -39,7 +41,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The Template model module.
  * @module model/Template
- * @version 4.0.0
+ * @version 4.1.0
  */
 var Template = /*#__PURE__*/function () {
   /**
@@ -86,6 +88,9 @@ var Template = /*#__PURE__*/function () {
    * @param updated_at {Date} When the template was last updated.
    * @param defaults {module:model/TemplateDefaults} 
    * @param field_dependencies {Array.<module:model/TemplateFieldDependency>} Conditional logic: each rule shows or hides its target fields, or makes them required, depending on the values of other fields.
+   * @param field_groups {Array.<module:model/FieldGroup>} The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`.
+   * @param predefined_fields {Array.<module:model/PredefinedField>} 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.
+   * @param predefined_fields_sample_data {Object.<String, Object>} 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.
    * @param html {String} The HTML of an HTML template, as a Liquid template. Null for PDF templates.
    * @param scss {String} The SCSS of an HTML template.
    * @param header_html {String} The HTML printed at the top of each page of an HTML template.
@@ -94,9 +99,9 @@ var Template = /*#__PURE__*/function () {
    * @param embed_edit_token {String} The token that opens the template in the embedded template editor.
    * @param versions {Array.<module:model/TemplateVersion>} The template's published versions, newest first (up to 100).
    */
-  function Template(id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions) {
+  function Template(id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions) {
     _classCallCheck(this, Template);
-    Template.initialize(this, id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions);
+    Template.initialize(this, id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions);
   }
 
   /**
@@ -106,7 +111,7 @@ var Template = /*#__PURE__*/function () {
    */
   return _createClass(Template, null, [{
     key: "initialize",
-    value: function initialize(obj, id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions) {
+    value: function initialize(obj, id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions) {
       obj['id'] = id;
       obj['name'] = name;
       obj['description'] = description;
@@ -146,6 +151,9 @@ var Template = /*#__PURE__*/function () {
       obj['updated_at'] = updated_at;
       obj['defaults'] = defaults;
       obj['field_dependencies'] = field_dependencies;
+      obj['field_groups'] = field_groups;
+      obj['predefined_fields'] = predefined_fields;
+      obj['predefined_fields_sample_data'] = predefined_fields_sample_data;
       obj['html'] = html;
       obj['scss'] = scss;
       obj['header_html'] = header_html;
@@ -285,6 +293,17 @@ var Template = /*#__PURE__*/function () {
         if (data.hasOwnProperty('field_dependencies')) {
           obj['field_dependencies'] = _ApiClient["default"].convertToType(data['field_dependencies'], [_TemplateFieldDependency["default"]]);
         }
+        if (data.hasOwnProperty('field_groups')) {
+          obj['field_groups'] = _ApiClient["default"].convertToType(data['field_groups'], [_FieldGroup["default"]]);
+        }
+        if (data.hasOwnProperty('predefined_fields')) {
+          obj['predefined_fields'] = _ApiClient["default"].convertToType(data['predefined_fields'], [_PredefinedField["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');
         }
@@ -383,6 +402,31 @@ var Template = /*#__PURE__*/function () {
       if (!Array.isArray(data['field_dependencies'])) {
         throw new Error("Expected the field `field_dependencies` to be an array in the JSON data but got " + data['field_dependencies']);
       }
+      // ensure the json data is an array
+      if (!Array.isArray(data['field_groups'])) {
+        throw new Error("Expected the field `field_groups` to be an array in the JSON data but got " + data['field_groups']);
+      }
+      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 _iterator2 = _createForOfIteratorHelper(data['predefined_fields']),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var item = _step2.value;
+            _PredefinedField["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.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']);
@@ -416,7 +460,7 @@ var Template = /*#__PURE__*/function () {
     }
   }]);
 }();
-Template.RequiredProperties = ["id", "name", "description", "template_type", "ready", "document", "parent_folder_id", "path", "version", "latest_version", "version_published_at", "locked", "add_signature_request_submission_id_footers", "ai_field_naming_language", "allow_additional_properties", "allow_skipping_optional_fields", "default_form_mode", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs", "has_encrypt_pdfs_password", "expire_submissions", "expire_after", "expiration_interval", "merge_audit_trail_pdf", "parse_dates_using_template_date_format", "public_submissions", "public_web_form", "redirect_url", "has_slack_webhook_url", "last_changed_at", "last_changed_by", "created_at", "updated_at", "defaults", "field_dependencies", "html", "scss", "header_html", "footer_html", "html_engine_options", "embed_edit_token", "versions"];
+Template.RequiredProperties = ["id", "name", "description", "template_type", "ready", "document", "parent_folder_id", "path", "version", "latest_version", "version_published_at", "locked", "add_signature_request_submission_id_footers", "ai_field_naming_language", "allow_additional_properties", "allow_skipping_optional_fields", "default_form_mode", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs", "has_encrypt_pdfs_password", "expire_submissions", "expire_after", "expiration_interval", "merge_audit_trail_pdf", "parse_dates_using_template_date_format", "public_submissions", "public_web_form", "redirect_url", "has_slack_webhook_url", "last_changed_at", "last_changed_by", "created_at", "updated_at", "defaults", "field_dependencies", "field_groups", "predefined_fields", "predefined_fields_sample_data", "html", "scss", "header_html", "footer_html", "html_engine_options", "embed_edit_token", "versions"];
 
 /**
  * The template's ID.
@@ -651,6 +695,24 @@ Template.prototype['defaults'] = undefined;
  */
 Template.prototype['field_dependencies'] = undefined;
 
+/**
+ * The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`.
+ * @member {Array.<module:model/FieldGroup>} field_groups
+ */
+Template.prototype['field_groups'] = 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/PredefinedField>} predefined_fields
+ */
+Template.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
+ */
+Template.prototype['predefined_fields_sample_data'] = undefined;
+
 /**
  * The HTML of an HTML template, as a Liquid template. Null for PDF templates.
  * @member {String} html

package/dist/model/TemplateActor.js

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

package/dist/model/TemplateDefaults.js

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

package/dist/model/TemplateDefaultsInput.js

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

package/dist/model/TemplateDiff.js

@@ -0,0 +1,206 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _TemplateDiffSummary = _interopRequireDefault(require("./TemplateDiffSummary"));
+var _TemplateFieldChanges = _interopRequireDefault(require("./TemplateFieldChanges"));
+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 TemplateDiff model module.
+ * @module model/TemplateDiff
+ * @version 4.1.0
+ */
+var TemplateDiff = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplateDiff</code>.
+   * What changed in a version of a template since the version before it: the draft since the latest published version, or a published version since the one before it. Fields are compared with all their settings, so `y` is measured from the top of each field's page.
+   * @alias module:model/TemplateDiff
+   * @extends Object
+   * @param template_id {String} The template's ID.
+   * @param from_version {String} The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added.
+   * @param to_version {String} The later version, such as `1.2.0`. Null for the draft.
+   * @param summary {module:model/TemplateDiffSummary} How many changes of each kind there are.
+   * @param fields {module:model/TemplateFieldChanges} The fields that changed.
+   * @param changed_settings {Array.<String>} The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change.
+   * @param document_changed {Boolean} The template's PDF was replaced (or added, when there's no `from_version`).
+   */
+  function TemplateDiff(template_id, from_version, to_version, summary, fields, changed_settings, document_changed) {
+    _classCallCheck(this, TemplateDiff);
+    TemplateDiff.initialize(this, template_id, from_version, to_version, summary, fields, changed_settings, document_changed);
+  }
+
+  /**
+   * 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(TemplateDiff, null, [{
+    key: "initialize",
+    value: function initialize(obj, template_id, from_version, to_version, summary, fields, changed_settings, document_changed) {
+      obj['template_id'] = template_id;
+      obj['from_version'] = from_version;
+      obj['to_version'] = to_version;
+      obj['summary'] = summary;
+      obj['fields'] = fields;
+      obj['changed_settings'] = changed_settings;
+      obj['document_changed'] = document_changed;
+    }
+
+    /**
+     * Constructs a <code>TemplateDiff</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/TemplateDiff} obj Optional instance to populate.
+     * @return {module:model/TemplateDiff} The populated <code>TemplateDiff</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplateDiff();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('template_id')) {
+          obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
+        }
+        if (data.hasOwnProperty('from_version')) {
+          obj['from_version'] = _ApiClient["default"].convertToType(data['from_version'], 'String');
+        }
+        if (data.hasOwnProperty('to_version')) {
+          obj['to_version'] = _ApiClient["default"].convertToType(data['to_version'], 'String');
+        }
+        if (data.hasOwnProperty('summary')) {
+          obj['summary'] = _ApiClient["default"].convertToType(data['summary'], _TemplateDiffSummary["default"]);
+        }
+        if (data.hasOwnProperty('fields')) {
+          obj['fields'] = _ApiClient["default"].convertToType(data['fields'], _TemplateFieldChanges["default"]);
+        }
+        if (data.hasOwnProperty('changed_settings')) {
+          obj['changed_settings'] = _ApiClient["default"].convertToType(data['changed_settings'], ['String']);
+        }
+        if (data.hasOwnProperty('document_changed')) {
+          obj['document_changed'] = _ApiClient["default"].convertToType(data['document_changed'], 'Boolean');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplateDiff</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>TemplateDiff</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(TemplateDiff.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));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
+        throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
+      }
+      // ensure the json data is a string
+      if (data['from_version'] && !(typeof data['from_version'] === 'string' || data['from_version'] instanceof String)) {
+        throw new Error("Expected the field `from_version` to be a primitive type in the JSON string but got " + data['from_version']);
+      }
+      // ensure the json data is a string
+      if (data['to_version'] && !(typeof data['to_version'] === 'string' || data['to_version'] instanceof String)) {
+        throw new Error("Expected the field `to_version` to be a primitive type in the JSON string but got " + data['to_version']);
+      }
+      // validate the optional field `summary`
+      if (data['summary']) {
+        // data not null
+        _TemplateDiffSummary["default"].validateJSON(data['summary']);
+      }
+      // validate the optional field `fields`
+      if (data['fields']) {
+        // data not null
+        _TemplateFieldChanges["default"].validateJSON(data['fields']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['changed_settings'])) {
+        throw new Error("Expected the field `changed_settings` to be an array in the JSON data but got " + data['changed_settings']);
+      }
+      return true;
+    }
+  }]);
+}();
+TemplateDiff.RequiredProperties = ["template_id", "from_version", "to_version", "summary", "fields", "changed_settings", "document_changed"];
+
+/**
+ * The template's ID.
+ * @member {String} template_id
+ */
+TemplateDiff.prototype['template_id'] = undefined;
+
+/**
+ * The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added.
+ * @member {String} from_version
+ */
+TemplateDiff.prototype['from_version'] = undefined;
+
+/**
+ * The later version, such as `1.2.0`. Null for the draft.
+ * @member {String} to_version
+ */
+TemplateDiff.prototype['to_version'] = undefined;
+
+/**
+ * How many changes of each kind there are.
+ * @member {module:model/TemplateDiffSummary} summary
+ */
+TemplateDiff.prototype['summary'] = undefined;
+
+/**
+ * The fields that changed.
+ * @member {module:model/TemplateFieldChanges} fields
+ */
+TemplateDiff.prototype['fields'] = undefined;
+
+/**
+ * The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change.
+ * @member {Array.<String>} changed_settings
+ */
+TemplateDiff.prototype['changed_settings'] = undefined;
+
+/**
+ * The template's PDF was replaced (or added, when there's no `from_version`).
+ * @member {Boolean} document_changed
+ */
+TemplateDiff.prototype['document_changed'] = undefined;
+var _default = exports["default"] = TemplateDiff;