docspring 4.0.0 → 4.1.0

package/dist/model/UpdateTemplateFieldsRequest.js

@@ -0,0 +1,132 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _FieldInput = _interopRequireDefault(require("./FieldInput"));
+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 UpdateTemplateFieldsRequest model module.
+ * @module model/UpdateTemplateFieldsRequest
+ * @version 4.1.0
+ */
+var UpdateTemplateFieldsRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>UpdateTemplateFieldsRequest</code>.
+   * The fields to change in the template's draft.
+   * @alias module:model/UpdateTemplateFieldsRequest
+   * @param fields {Array.<module:model/FieldInput>} The changes, each with the `id` of the field it changes. Settings left out keep their values. Changing a shared setting changes it for every field with the same name. Renaming a field moves it to the shared settings of its new name, and conditional logic and formulas that use the old name follow it when no other field has that name.
+   */
+  function UpdateTemplateFieldsRequest(fields) {
+    _classCallCheck(this, UpdateTemplateFieldsRequest);
+    UpdateTemplateFieldsRequest.initialize(this, fields);
+  }
+
+  /**
+   * 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(UpdateTemplateFieldsRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj, fields) {
+      obj['fields'] = fields;
+    }
+
+    /**
+     * Constructs a <code>UpdateTemplateFieldsRequest</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/UpdateTemplateFieldsRequest} obj Optional instance to populate.
+     * @return {module:model/UpdateTemplateFieldsRequest} The populated <code>UpdateTemplateFieldsRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new UpdateTemplateFieldsRequest();
+        if (data.hasOwnProperty('fields')) {
+          obj['fields'] = _ApiClient["default"].convertToType(data['fields'], [_FieldInput["default"]]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpdateTemplateFieldsRequest</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>UpdateTemplateFieldsRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(UpdateTemplateFieldsRequest.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();
+      }
+      if (data['fields']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['fields'])) {
+          throw new Error("Expected the field `fields` to be an array in the JSON data but got " + data['fields']);
+        }
+        // validate the optional field `fields` (array)
+        var _iterator2 = _createForOfIteratorHelper(data['fields']),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var item = _step2.value;
+            _FieldInput["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+        ;
+      }
+      return true;
+    }
+  }]);
+}();
+UpdateTemplateFieldsRequest.RequiredProperties = ["fields"];
+
+/**
+ * The changes, each with the `id` of the field it changes. Settings left out keep their values. Changing a shared setting changes it for every field with the same name. Renaming a field moves it to the shared settings of its new name, and conditional logic and formulas that use the old name follow it when no other field has that name.
+ * @member {Array.<module:model/FieldInput>} fields
+ */
+UpdateTemplateFieldsRequest.prototype['fields'] = undefined;
+var _default = exports["default"] = UpdateTemplateFieldsRequest;

package/dist/model/UpdateTemplateRequest.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 _FieldGroupInput = _interopRequireDefault(require("./FieldGroupInput"));
 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"));
@@ -35,7 +37,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The UpdateTemplateRequest model module.
  * @module model/UpdateTemplateRequest
- * @version 4.0.0
+ * @version 4.1.0
  */
 var UpdateTemplateRequest = /*#__PURE__*/function () {
   /**
@@ -150,6 +152,17 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('field_dependencies')) {
           obj['field_dependencies'] = _ApiClient["default"].convertToType(data['field_dependencies'], [_TemplateFieldDependencyInput["default"]]);
         }
+        if (data.hasOwnProperty('field_groups')) {
+          obj['field_groups'] = _ApiClient["default"].convertToType(data['field_groups'], [_FieldGroupInput["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');
         }
@@ -231,6 +244,48 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
         }
         ;
       }
+      if (data['field_groups']) {
+        // data not null
+        // 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']);
+        }
+        // validate the optional field `field_groups` (array)
+        var _iterator2 = _createForOfIteratorHelper(data['field_groups']),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var _item = _step2.value;
+            _FieldGroupInput["default"].validateJSON(_item);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+        ;
+      }
+      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 _item2 = _step3.value;
+            _PredefinedFieldInput["default"].validateJSON(_item2);
+          }
+        } 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']);
@@ -418,6 +473,24 @@ UpdateTemplateRequest.prototype['defaults'] = undefined;
  */
 UpdateTemplateRequest.prototype['field_dependencies'] = undefined;
 
+/**
+ * Changes to the settings of the template's field groups, each with the `name` of the group it changes. Settings left out keep their values, and groups left out are unchanged.
+ * @member {Array.<module:model/FieldGroupInput>} field_groups
+ */
+UpdateTemplateRequest.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/PredefinedFieldInput>} predefined_fields
+ */
+UpdateTemplateRequest.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
+ */
+UpdateTemplateRequest.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/UpdateWebhookRequest.js

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

package/dist/model/UploadPresign.js

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

package/dist/model/UrlSourcePdf.js

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

package/dist/model/ValidateSubmissionRequest.js

@@ -0,0 +1,226 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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); }
+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 ValidateSubmissionRequest model module.
+ * @module model/ValidateSubmissionRequest
+ * @version 4.1.0
+ */
+var ValidateSubmissionRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>ValidateSubmissionRequest</code>.
+   * The submission's data and settings.
+   * @alias module:model/ValidateSubmissionRequest
+   */
+  function ValidateSubmissionRequest() {
+    _classCallCheck(this, ValidateSubmissionRequest);
+    ValidateSubmissionRequest.initialize(this);
+  }
+
+  /**
+   * 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(ValidateSubmissionRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>ValidateSubmissionRequest</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/ValidateSubmissionRequest} obj Optional instance to populate.
+     * @return {module:model/ValidateSubmissionRequest} The populated <code>ValidateSubmissionRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new ValidateSubmissionRequest();
+        if (data.hasOwnProperty('test')) {
+          obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
+        }
+        if (data.hasOwnProperty('editable')) {
+          obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
+        }
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], {
+            'String': Object
+          });
+        }
+        if (data.hasOwnProperty('metadata')) {
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
+            'String': Object
+          });
+        }
+        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');
+        }
+        if (data.hasOwnProperty('field_overrides')) {
+          obj['field_overrides'] = _ApiClient["default"].convertToType(data['field_overrides'], {
+            'String': _FieldOverride["default"]
+          });
+        }
+        if (data.hasOwnProperty('html')) {
+          obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
+        }
+        if (data.hasOwnProperty('css')) {
+          obj['css'] = _ApiClient["default"].convertToType(data['css'], 'String');
+        }
+        if (data.hasOwnProperty('signature_requests')) {
+          obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequestInput["default"]]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>ValidateSubmissionRequest</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>ValidateSubmissionRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      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']);
+      }
+      // ensure the json data is a string
+      if (data['css'] && !(typeof data['css'] === 'string' || data['css'] instanceof String)) {
+        throw new Error("Expected the field `css` to be a primitive type in the JSON string but got " + data['css']);
+      }
+      if (data['signature_requests']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['signature_requests'])) {
+          throw new Error("Expected the field `signature_requests` to be an array in the JSON data but got " + data['signature_requests']);
+        }
+        // validate the optional field `signature_requests` (array)
+        var _iterator = _createForOfIteratorHelper(data['signature_requests']),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+            _SignatureRequestInput["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+        ;
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+ * @member {Boolean} test
+ */
+ValidateSubmissionRequest.prototype['test'] = undefined;
+
+/**
+ * `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+ * @member {Boolean} editable
+ */
+ValidateSubmissionRequest.prototype['editable'] = undefined;
+
+/**
+ * The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values.
+ * @member {Object.<String, Object>} data
+ */
+ValidateSubmissionRequest.prototype['data'] = undefined;
+
+/**
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+ * @member {Object.<String, Object>} metadata
+ */
+ValidateSubmissionRequest.prototype['metadata'] = undefined;
+
+/**
+ * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
+ * @member {String} password
+ */
+ValidateSubmissionRequest.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
+ */
+ValidateSubmissionRequest.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
+ */
+ValidateSubmissionRequest.prototype['expires_in'] = undefined;
+
+/**
+ * Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
+ * @member {Object.<String, module:model/FieldOverride>} field_overrides
+ */
+ValidateSubmissionRequest.prototype['field_overrides'] = undefined;
+
+/**
+ * For an HTML template, HTML to use instead of the template's.
+ * @member {String} html
+ */
+ValidateSubmissionRequest.prototype['html'] = undefined;
+
+/**
+ * For an HTML template, CSS to use instead of the template's.
+ * @member {String} css
+ */
+ValidateSubmissionRequest.prototype['css'] = undefined;
+
+/**
+ * The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`.
+ * @member {Array.<module:model/SignatureRequestInput>} signature_requests
+ */
+ValidateSubmissionRequest.prototype['signature_requests'] = undefined;
+var _default = exports["default"] = ValidateSubmissionRequest;

package/dist/model/Webhook.js

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

package/dist/model/WebhookList.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docspring",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "An API client for the DocSpring PDF generation service",
   "license": "MIT",
   "main": "dist/index.js",