docspring 4.2.0 → 4.4.0

package/dist/model/UpdateTemplateRequest.js

@@ -9,7 +9,9 @@ var _AiFieldNamingLanguage = _interopRequireDefault(require("./AiFieldNamingLang
 var _ExpirationInterval = _interopRequireDefault(require("./ExpirationInterval"));
 var _FieldGroupInput = _interopRequireDefault(require("./FieldGroupInput"));
 var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
+var _SignatureRequestEmailAttachments = _interopRequireDefault(require("./SignatureRequestEmailAttachments"));
 var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
 var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
 var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
@@ -24,7 +26,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -37,7 +39,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The UpdateTemplateRequest model module.
  * @module model/UpdateTemplateRequest
- * @version 4.2.0
+ * @version 4.4.0
  */
 var UpdateTemplateRequest = /*#__PURE__*/function () {
   /**
@@ -77,6 +79,9 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('description')) {
           obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
         }
+        if (data.hasOwnProperty('output_format')) {
+          obj['output_format'] = _ApiClient["default"].convertToType(data['output_format'], _OutputFormat["default"]);
+        }
         if (data.hasOwnProperty('parent_folder_id')) {
           obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
         }
@@ -143,6 +148,27 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('redirect_url')) {
           obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
         }
+        if (data.hasOwnProperty('signature_request_email_attachments')) {
+          obj['signature_request_email_attachments'] = _ApiClient["default"].convertToType(data['signature_request_email_attachments'], _SignatureRequestEmailAttachments["default"]);
+        }
+        if (data.hasOwnProperty('signature_request_from_address')) {
+          obj['signature_request_from_address'] = _ApiClient["default"].convertToType(data['signature_request_from_address'], 'String');
+        }
+        if (data.hasOwnProperty('signature_request_include_signing_token')) {
+          obj['signature_request_include_signing_token'] = _ApiClient["default"].convertToType(data['signature_request_include_signing_token'], 'Boolean');
+        }
+        if (data.hasOwnProperty('signature_request_from_name')) {
+          obj['signature_request_from_name'] = _ApiClient["default"].convertToType(data['signature_request_from_name'], 'String');
+        }
+        if (data.hasOwnProperty('signature_request_notification_emails')) {
+          obj['signature_request_notification_emails'] = _ApiClient["default"].convertToType(data['signature_request_notification_emails'], ['String']);
+        }
+        if (data.hasOwnProperty('signature_request_reply_to')) {
+          obj['signature_request_reply_to'] = _ApiClient["default"].convertToType(data['signature_request_reply_to'], 'String');
+        }
+        if (data.hasOwnProperty('signature_request_signing_url')) {
+          obj['signature_request_signing_url'] = _ApiClient["default"].convertToType(data['signature_request_signing_url'], 'String');
+        }
         if (data.hasOwnProperty('slack_webhook_url')) {
           obj['slack_webhook_url'] = _ApiClient["default"].convertToType(data['slack_webhook_url'], 'String');
         }
@@ -181,6 +207,11 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('html_escape_data')) {
           obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
         }
+        if (data.hasOwnProperty('layout')) {
+          obj['layout'] = _ApiClient["default"].convertToType(data['layout'], {
+            'String': Object
+          });
+        }
       }
       return obj;
     }
@@ -218,6 +249,26 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
         throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
       }
       // ensure the json data is a string
+      if (data['signature_request_from_address'] && !(typeof data['signature_request_from_address'] === 'string' || data['signature_request_from_address'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_from_address` to be a primitive type in the JSON string but got " + data['signature_request_from_address']);
+      }
+      // ensure the json data is a string
+      if (data['signature_request_from_name'] && !(typeof data['signature_request_from_name'] === 'string' || data['signature_request_from_name'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_from_name` to be a primitive type in the JSON string but got " + data['signature_request_from_name']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['signature_request_notification_emails'])) {
+        throw new Error("Expected the field `signature_request_notification_emails` to be an array in the JSON data but got " + data['signature_request_notification_emails']);
+      }
+      // ensure the json data is a string
+      if (data['signature_request_reply_to'] && !(typeof data['signature_request_reply_to'] === 'string' || data['signature_request_reply_to'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_reply_to` to be a primitive type in the JSON string but got " + data['signature_request_reply_to']);
+      }
+      // ensure the json data is a string
+      if (data['signature_request_signing_url'] && !(typeof data['signature_request_signing_url'] === 'string' || data['signature_request_signing_url'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_signing_url` to be a primitive type in the JSON string but got " + data['signature_request_signing_url']);
+      }
+      // ensure the json data is a string
       if (data['slack_webhook_url'] && !(typeof data['slack_webhook_url'] === 'string' || data['slack_webhook_url'] instanceof String)) {
         throw new Error("Expected the field `slack_webhook_url` to be a primitive type in the JSON string but got " + data['slack_webhook_url']);
       }
@@ -326,6 +377,12 @@ UpdateTemplateRequest.prototype['name'] = undefined;
  */
 UpdateTemplateRequest.prototype['description'] = undefined;
 
+/**
+ * What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; other templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
+ * @member {module:model/OutputFormat} output_format
+ */
+UpdateTemplateRequest.prototype['output_format'] = undefined;
+
 /**
  * The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions.
  * @member {String} parent_folder_id
@@ -363,7 +420,7 @@ UpdateTemplateRequest.prototype['allow_additional_properties'] = undefined;
 UpdateTemplateRequest.prototype['allow_skipping_optional_fields'] = undefined;
 
 /**
- * The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). HTML templates have no visual form, so `web` is the only value they accept.
+ * The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). Only PDF templates have a visual form, so other templates accept only `web`.
  * @member {module:model/TemplateFormMode} default_form_mode
  */
 UpdateTemplateRequest.prototype['default_form_mode'] = undefined;
@@ -375,7 +432,7 @@ UpdateTemplateRequest.prototype['default_form_mode'] = undefined;
 UpdateTemplateRequest.prototype['editable_submissions'] = undefined;
 
 /**
- * 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.
+ * 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), without a path. 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
  */
 UpdateTemplateRequest.prototype['embed_domains'] = undefined;
@@ -399,7 +456,7 @@ UpdateTemplateRequest.prototype['embed_edit_allow_versioning'] = undefined;
 UpdateTemplateRequest.prototype['embed_edit_allow_document_replacement'] = undefined;
 
 /**
- * Encrypt generated PDFs with `encrypt_pdfs_password`.
+ * Encrypt generated PDFs with `encrypt_pdfs_password`. A Word template can only encrypt its PDFs when its `output_format` is `pdf`, because Word documents and OpenDocument files can't be password-protected.
  * @member {Boolean} encrypt_pdfs
  */
 UpdateTemplateRequest.prototype['encrypt_pdfs'] = undefined;
@@ -435,7 +492,7 @@ UpdateTemplateRequest.prototype['expiration_interval'] = undefined;
 UpdateTemplateRequest.prototype['merge_audit_trail_pdf'] = undefined;
 
 /**
- * Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
+ * Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML or Word template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
  * @member {Boolean} parse_dates_using_template_date_format
  */
 UpdateTemplateRequest.prototype['parse_dates_using_template_date_format'] = undefined;
@@ -458,6 +515,48 @@ UpdateTemplateRequest.prototype['public_web_form'] = undefined;
  */
 UpdateTemplateRequest.prototype['redirect_url'] = undefined;
 
+/**
+ * How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. PDF templates only. A signature request uses the value it had when the request was created.
+ * @member {module:model/SignatureRequestEmailAttachments} signature_request_email_attachments
+ */
+UpdateTemplateRequest.prototype['signature_request_email_attachments'] = undefined;
+
+/**
+ * The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name. PDF templates only.
+ * @member {String} signature_request_from_address
+ */
+UpdateTemplateRequest.prototype['signature_request_from_address'] = undefined;
+
+/**
+ * Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign. PDF templates only.
+ * @member {Boolean} signature_request_include_signing_token
+ */
+UpdateTemplateRequest.prototype['signature_request_include_signing_token'] = undefined;
+
+/**
+ * The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name. PDF templates only.
+ * @member {String} signature_request_from_name
+ */
+UpdateTemplateRequest.prototype['signature_request_from_name'] = undefined;
+
+/**
+ * Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them. PDF templates only.
+ * @member {Array.<String>} signature_request_notification_emails
+ */
+UpdateTemplateRequest.prototype['signature_request_notification_emails'] = undefined;
+
+/**
+ * Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it. PDF templates only.
+ * @member {String} signature_request_reply_to
+ */
+UpdateTemplateRequest.prototype['signature_request_reply_to'] = undefined;
+
+/**
+ * A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page. PDF templates only.
+ * @member {String} signature_request_signing_url
+ */
+UpdateTemplateRequest.prototype['signature_request_signing_url'] = undefined;
+
 /**
  * A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set.
  * @member {String} slack_webhook_url
@@ -495,7 +594,7 @@ UpdateTemplateRequest.prototype['predefined_fields'] = undefined;
 UpdateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
 
 /**
- * The HTML of an HTML template, as a Liquid template. Null for PDF templates.
+ * The HTML of an HTML template, as a Liquid template. Null for other templates.
  * @member {String} html
  */
 UpdateTemplateRequest.prototype['html'] = undefined;
@@ -525,8 +624,14 @@ UpdateTemplateRequest.prototype['footer_html'] = undefined;
 UpdateTemplateRequest.prototype['html_engine_options'] = undefined;
 
 /**
- * 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.
+ * 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 other templates.
  * @member {Boolean} html_escape_data
  */
 UpdateTemplateRequest.prototype['html_escape_data'] = undefined;
+
+/**
+ * A page design's layout: its page setup, its sections and the elements placed in them, in the Page Designer layout format (https://docspring.com/docs/page-designer/layout-format/). Its JSON Schema is at https://docspring.com/schemas/page-designer/layout.v1.json. Null for other templates. Setting it replaces the whole layout, and DocSpring adds a field for each value it reads. Left out when a page design is created, it starts with an empty page.
+ * @member {Object.<String, Object>} layout
+ */
+UpdateTemplateRequest.prototype['layout'] = undefined;
 var _default = exports["default"] = UpdateTemplateRequest;

package/dist/model/UpdateWebhookRequest.js

@@ -15,7 +15,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -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.2.0
+ * @version 4.4.0
  */
 var UpdateWebhookRequest = /*#__PURE__*/function () {
   /**

package/dist/model/UploadMethod.js

@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 

package/dist/model/UploadPresign.js

@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -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.2.0
+ * @version 4.4.0
  */
 var UploadPresign = /*#__PURE__*/function () {
   /**

package/dist/model/UrlSourcePdf.js

@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -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.2.0
+ * @version 4.4.0
  */
 var UrlSourcePdf = /*#__PURE__*/function () {
   /**

package/dist/model/ValidateSubmissionRequest.js

@@ -8,6 +8,8 @@ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
 var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
+var _SignatureRequestReminders = _interopRequireDefault(require("./SignatureRequestReminders"));
+var _SigningOrder = _interopRequireDefault(require("./SigningOrder"));
 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; } } }; }
@@ -19,7 +21,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -32,7 +34,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The ValidateSubmissionRequest model module.
  * @module model/ValidateSubmissionRequest
- * @version 4.2.0
+ * @version 4.4.0
  */
 var ValidateSubmissionRequest = /*#__PURE__*/function () {
   /**
@@ -105,6 +107,33 @@ var ValidateSubmissionRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('signature_requests')) {
           obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequestInput["default"]]);
         }
+        if (data.hasOwnProperty('send_email')) {
+          obj['send_email'] = _ApiClient["default"].convertToType(data['send_email'], 'Boolean');
+        }
+        if (data.hasOwnProperty('signing_order')) {
+          obj['signing_order'] = _ApiClient["default"].convertToType(data['signing_order'], _SigningOrder["default"]);
+        }
+        if (data.hasOwnProperty('email_subject')) {
+          obj['email_subject'] = _ApiClient["default"].convertToType(data['email_subject'], 'String');
+        }
+        if (data.hasOwnProperty('email_message')) {
+          obj['email_message'] = _ApiClient["default"].convertToType(data['email_message'], 'String');
+        }
+        if (data.hasOwnProperty('cc')) {
+          obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
+        }
+        if (data.hasOwnProperty('reply_to')) {
+          obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
+        }
+        if (data.hasOwnProperty('notification_emails')) {
+          obj['notification_emails'] = _ApiClient["default"].convertToType(data['notification_emails'], ['String']);
+        }
+        if (data.hasOwnProperty('notify_when_signed')) {
+          obj['notify_when_signed'] = _ApiClient["default"].convertToType(data['notify_when_signed'], 'Boolean');
+        }
+        if (data.hasOwnProperty('reminders')) {
+          obj['reminders'] = _ApiClient["default"].convertToType(data['reminders'], _SignatureRequestReminders["default"]);
+        }
       }
       return obj;
     }
@@ -154,12 +183,37 @@ var ValidateSubmissionRequest = /*#__PURE__*/function () {
         }
         ;
       }
+      // ensure the json data is a string
+      if (data['email_subject'] && !(typeof data['email_subject'] === 'string' || data['email_subject'] instanceof String)) {
+        throw new Error("Expected the field `email_subject` to be a primitive type in the JSON string but got " + data['email_subject']);
+      }
+      // ensure the json data is a string
+      if (data['email_message'] && !(typeof data['email_message'] === 'string' || data['email_message'] instanceof String)) {
+        throw new Error("Expected the field `email_message` to be a primitive type in the JSON string but got " + data['email_message']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['cc'])) {
+        throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
+      }
+      // ensure the json data is a string
+      if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
+        throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['notification_emails'])) {
+        throw new Error("Expected the field `notification_emails` to be an array in the JSON data but got " + data['notification_emails']);
+      }
+      // validate the optional field `reminders`
+      if (data['reminders']) {
+        // data not null
+        _SignatureRequestReminders["default"].validateJSON(data['reminders']);
+      }
       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.
+ * Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
  * @member {Boolean} test
  */
 ValidateSubmissionRequest.prototype['test'] = undefined;
@@ -171,7 +225,7 @@ ValidateSubmissionRequest.prototype['test'] = undefined;
 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.
+ * The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them (PDF templates only).
  * @member {Object.<String, Object>} data
  */
 ValidateSubmissionRequest.prototype['data'] = undefined;
@@ -183,19 +237,19 @@ ValidateSubmissionRequest.prototype['data'] = undefined;
 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.
+ * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
  * @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.
+ * What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, 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.
+ * 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. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
  * @member {Number} expires_in
  */
 ValidateSubmissionRequest.prototype['expires_in'] = undefined;
@@ -223,4 +277,58 @@ ValidateSubmissionRequest.prototype['css'] = undefined;
  * @member {Array.<module:model/SignatureRequestInput>} signature_requests
  */
 ValidateSubmissionRequest.prototype['signature_requests'] = undefined;
+
+/**
+ * Whether DocSpring emails the signers their signing links, and sends the reminders and the completed document. Default true. Each signature request's own `send_email` overrides it. A test submission only emails your DocSpring team: every other address is a 422. `true` needs `signature_requests`. DocSpring doesn't email the signers of a form library template: leave `send_email` out, and send them their links yourself.
+ * @member {Boolean} send_email
+ */
+ValidateSubmissionRequest.prototype['send_email'] = undefined;
+
+/**
+ * `parallel` (the default): everyone can sign at once. `sequential`: people sign one step at a time (`signing_step`), and DocSpring emails each step when the one before it is done. Needs `signature_requests`.
+ * @member {module:model/SigningOrder} signing_order
+ */
+ValidateSubmissionRequest.prototype['signing_order'] = undefined;
+
+/**
+ * The subject of the emails that ask people to sign. You can use `{{ signer.name }}`, `{{ signer.email }}`, `{{ document.name }}`, `{{ sender.name }}` and `{{ account.name }}`. Default "<sender> sent you <document> to sign" when you leave it out (a blank subject is a 422). Links and web addresses are shown as plain text (`example[.]com`).
+ * @member {String} email_subject
+ */
+ValidateSubmissionRequest.prototype['email_subject'] = undefined;
+
+/**
+ * A message for the people who sign, shown above the signing button. It takes the same variables as `email_subject`. Links and web addresses are shown as plain text. Leave it out for none: a blank message is a 422.
+ * @member {String} email_message
+ */
+ValidateSubmissionRequest.prototype['email_message'] = undefined;
+
+/**
+ * People who get a copy of the completed document. They don't sign.
+ * @member {Array.<String>} cc
+ */
+ValidateSubmissionRequest.prototype['cc'] = undefined;
+
+/**
+ * Where replies to the emails go: a member of your DocSpring team, or an address at one of your verified email domains. Leave it out for the template's reply-to address (the account owner when it has none).
+ * @member {String} reply_to
+ */
+ValidateSubmissionRequest.prototype['reply_to'] = undefined;
+
+/**
+ * Who DocSpring tells when the document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Leave it out for the template's notification addresses (the account owner when it has none); an empty list means the account owner.
+ * @member {Array.<String>} notification_emails
+ */
+ValidateSubmissionRequest.prototype['notification_emails'] = undefined;
+
+/**
+ * Also email `notification_emails` each time someone signs. Default false.
+ * @member {Boolean} notify_when_signed
+ */
+ValidateSubmissionRequest.prototype['notify_when_signed'] = undefined;
+
+/**
+ * Remind people who haven't signed: every `interval_days` days, up to `max_count` times. Each reminder has a new signing link. Without it, DocSpring sends no reminders.
+ * @member {module:model/SignatureRequestReminders} reminders
+ */
+ValidateSubmissionRequest.prototype['reminders'] = undefined;
 var _default = exports["default"] = ValidateSubmissionRequest;

package/dist/model/Webhook.js

@@ -18,7 +18,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -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.2.0
+ * @version 4.4.0
  */
 var Webhook = /*#__PURE__*/function () {
   /**

package/dist/model/WebhookEventType.js

@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -62,6 +62,11 @@ _defineProperty(WebhookEventType, "submission.failed", "submission.failed");
  * @const
  */
 _defineProperty(WebhookEventType, "submission.declined", "submission.declined");
+/**
+ * value: "signature_request.sent"
+ * @const
+ */
+_defineProperty(WebhookEventType, "signature_request.sent", "signature_request.sent");
 /**
  * value: "signature_request.viewed"
  * @const
@@ -77,6 +82,11 @@ _defineProperty(WebhookEventType, "signature_request.completed", "signature_requ
  * @const
  */
 _defineProperty(WebhookEventType, "signature_request.declined", "signature_request.declined");
+/**
+ * value: "signature_request.email_bounced"
+ * @const
+ */
+_defineProperty(WebhookEventType, "signature_request.email_bounced", "signature_request.email_bounced");
 /**
  * value: "combined_pdf.processed"
  * @const

package/dist/model/WebhookList.js

@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -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.2.0
+ * @version 4.4.0
  */
 var WebhookList = /*#__PURE__*/function () {
   /**

package/dist/model/WebhookMode.js

@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
 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.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docspring",
-  "version": "4.2.0",
-  "description": "An API client for the DocSpring PDF generation service",
+  "version": "4.4.0",
+  "description": "An API client for DocSpring: fill PDF forms, generate PDFs and Word documents, and collect e-signatures",
   "license": "MIT",
   "main": "dist/index.js",
   "scripts": {