docspring 4.1.0 → 4.3.0

package/dist/model/Template.js

@@ -9,6 +9,7 @@ var _AiFieldNamingLanguage = _interopRequireDefault(require("./AiFieldNamingLang
 var _ExpirationInterval = _interopRequireDefault(require("./ExpirationInterval"));
 var _FieldGroup = _interopRequireDefault(require("./FieldGroup"));
 var _HtmlEngineOptions = _interopRequireDefault(require("./HtmlEngineOptions"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _PredefinedField = _interopRequireDefault(require("./PredefinedField"));
 var _TemplateActor = _interopRequireDefault(require("./TemplateActor"));
 var _TemplateDefaults = _interopRequireDefault(require("./TemplateDefaults"));
@@ -28,7 +29,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
  * 
@@ -41,7 +42,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The Template model module.
  * @module model/Template
- * @version 4.1.0
+ * @version 4.3.0
  */
 var Template = /*#__PURE__*/function () {
   /**
@@ -52,56 +53,58 @@ var Template = /*#__PURE__*/function () {
    * @param id {String} The template's ID.
    * @param name {String} The template's name.
    * @param description {String} Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests.
-   * @param template_type {module:model/TemplateType} `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
-   * @param ready {Boolean} Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once its document has been processed (`document.state` is `processed`).
-   * @param document {module:model/TemplateDocument} The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet.
+   * @param template_type {module:model/TemplateType} `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
+   * @param output_format {module:model/OutputFormat} 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; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
+   * @param ready {Boolean} Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded).
+   * @param document {module:model/TemplateDocument} The PDF of a PDF template, or the Word document of a Word template. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url` has one, with no file, while it's downloaded.
    * @param parent_folder_id {String} 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.
    * @param path {String} The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root.
-   * @param version {String} The published version this is, such as `1.2.0`. Null for the draft.
    * @param latest_version {String} The template's latest published version. Null if no version has been published.
    * @param version_published_at {Date} When this version was published. Null for the draft.
    * @param locked {Boolean} A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed).
+   * @param last_changed_at {Date} When the draft was last changed.
+   * @param created_at {Date} When the template was created.
+   * @param updated_at {Date} When the template was last updated.
+   * @param version {String} The published version this is, such as `1.2.0`. Null for the draft.
    * @param add_signature_request_submission_id_footers {Boolean} Print the submission ID in the footer of each page of PDFs signed through signature requests.
    * @param ai_field_naming_language {module:model/AiFieldNamingLanguage} The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates.
    * @param allow_additional_properties {Boolean} Accept submission data with properties that aren't fields of the template.
    * @param allow_skipping_optional_fields {Boolean} Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it.
-   * @param default_form_mode {module:model/TemplateFormMode} 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.
+   * @param default_form_mode {module:model/TemplateFormMode} 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`.
    * @param editable_submissions {Boolean} Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
-   * @param embed_domains {Array.<String>} The sites where the template's signature requests, forms and embedded template editor can be loaded: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
+   * @param embed_domains {Array.<String>} 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.
    * @param embed_edit_allow_settings {Boolean} Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
    * @param embed_edit_allow_versioning {Boolean} Allow the embedded template editor to publish, restore, compare and delete published versions.
    * @param embed_edit_allow_document_replacement {Boolean} Allow the embedded template editor to replace the template's PDF.
-   * @param encrypt_pdfs {Boolean} Encrypt generated PDFs with `encrypt_pdfs_password`.
+   * @param encrypt_pdfs {Boolean} 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.
    * @param has_encrypt_pdfs_password {Boolean} Whether `encrypt_pdfs_password` is set.
    * @param expire_submissions {Boolean} Delete each submission's data and PDF after `expire_after` `expiration_interval`.
    * @param expire_after {Number} How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` is on. At most 5256000 (10 years in minutes).
    * @param expiration_interval {module:model/ExpirationInterval} The unit of `expire_after`.
    * @param merge_audit_trail_pdf {Boolean} Add the audit trail to the end of PDFs signed through signature requests.
-   * @param parse_dates_using_template_date_format {Boolean} 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.
+   * @param parse_dates_using_template_date_format {Boolean} 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.
    * @param public_submissions {Boolean} Allow anyone with a submission's ID to download its PDF.
    * @param public_web_form {Boolean} Allow anyone to fill in the template's web form.
    * @param redirect_url {String} Where the web form sends people after they submit it.
    * @param has_slack_webhook_url {Boolean} Whether `slack_webhook_url` is set.
-   * @param last_changed_at {Date} When the draft was last changed.
    * @param last_changed_by {module:model/TemplateActor} Who last changed the draft: a user in your account, an API token, or someone using the embedded template editor. Null if no change has been recorded.
-   * @param created_at {Date} When the template was created.
-   * @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 html {String} The HTML of an HTML template, as a Liquid template. Null for PDF and Word 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.
    * @param footer_html {String} The HTML printed at the bottom of each page of an HTML template.
-   * @param html_engine_options {module:model/HtmlEngineOptions} How an HTML template's PDFs are printed. Null for PDF templates. Setting it replaces the whole object: options left out use their defaults.
+   * @param html_engine_options {module:model/HtmlEngineOptions} How an HTML template's PDFs are printed. Null for PDF and Word templates. Setting it replaces the whole object: options left out use their defaults.
+   * @param html_escape_data {Boolean} 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.
    * @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, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions) {
+  function Template(id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, 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_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, 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, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions);
+    Template.initialize(this, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, 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_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions);
   }
 
   /**
@@ -111,19 +114,23 @@ 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, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, embed_edit_token, versions) {
+    value: function initialize(obj, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, 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_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions) {
       obj['id'] = id;
       obj['name'] = name;
       obj['description'] = description;
       obj['template_type'] = template_type;
+      obj['output_format'] = output_format;
       obj['ready'] = ready;
       obj['document'] = document;
       obj['parent_folder_id'] = parent_folder_id;
       obj['path'] = path;
-      obj['version'] = version;
       obj['latest_version'] = latest_version;
       obj['version_published_at'] = version_published_at;
       obj['locked'] = locked;
+      obj['last_changed_at'] = last_changed_at;
+      obj['created_at'] = created_at;
+      obj['updated_at'] = updated_at;
+      obj['version'] = version;
       obj['add_signature_request_submission_id_footers'] = add_signature_request_submission_id_footers;
       obj['ai_field_naming_language'] = ai_field_naming_language;
       obj['allow_additional_properties'] = allow_additional_properties;
@@ -145,10 +152,7 @@ var Template = /*#__PURE__*/function () {
       obj['public_web_form'] = public_web_form;
       obj['redirect_url'] = redirect_url;
       obj['has_slack_webhook_url'] = has_slack_webhook_url;
-      obj['last_changed_at'] = last_changed_at;
       obj['last_changed_by'] = last_changed_by;
-      obj['created_at'] = created_at;
-      obj['updated_at'] = updated_at;
       obj['defaults'] = defaults;
       obj['field_dependencies'] = field_dependencies;
       obj['field_groups'] = field_groups;
@@ -159,6 +163,7 @@ var Template = /*#__PURE__*/function () {
       obj['header_html'] = header_html;
       obj['footer_html'] = footer_html;
       obj['html_engine_options'] = html_engine_options;
+      obj['html_escape_data'] = html_escape_data;
       obj['embed_edit_token'] = embed_edit_token;
       obj['versions'] = versions;
     }
@@ -188,6 +193,9 @@ var Template = /*#__PURE__*/function () {
         if (data.hasOwnProperty('template_type')) {
           obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], _TemplateType["default"]);
         }
+        if (data.hasOwnProperty('output_format')) {
+          obj['output_format'] = _ApiClient["default"].convertToType(data['output_format'], _OutputFormat["default"]);
+        }
         if (data.hasOwnProperty('ready')) {
           obj['ready'] = _ApiClient["default"].convertToType(data['ready'], 'Boolean');
         }
@@ -200,9 +208,6 @@ var Template = /*#__PURE__*/function () {
         if (data.hasOwnProperty('path')) {
           obj['path'] = _ApiClient["default"].convertToType(data['path'], 'String');
         }
-        if (data.hasOwnProperty('version')) {
-          obj['version'] = _ApiClient["default"].convertToType(data['version'], 'String');
-        }
         if (data.hasOwnProperty('latest_version')) {
           obj['latest_version'] = _ApiClient["default"].convertToType(data['latest_version'], 'String');
         }
@@ -212,6 +217,18 @@ var Template = /*#__PURE__*/function () {
         if (data.hasOwnProperty('locked')) {
           obj['locked'] = _ApiClient["default"].convertToType(data['locked'], 'Boolean');
         }
+        if (data.hasOwnProperty('last_changed_at')) {
+          obj['last_changed_at'] = _ApiClient["default"].convertToType(data['last_changed_at'], 'Date');
+        }
+        if (data.hasOwnProperty('created_at')) {
+          obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
+        }
+        if (data.hasOwnProperty('updated_at')) {
+          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
+        }
+        if (data.hasOwnProperty('version')) {
+          obj['version'] = _ApiClient["default"].convertToType(data['version'], 'String');
+        }
         if (data.hasOwnProperty('add_signature_request_submission_id_footers')) {
           obj['add_signature_request_submission_id_footers'] = _ApiClient["default"].convertToType(data['add_signature_request_submission_id_footers'], 'Boolean');
         }
@@ -275,18 +292,9 @@ var Template = /*#__PURE__*/function () {
         if (data.hasOwnProperty('has_slack_webhook_url')) {
           obj['has_slack_webhook_url'] = _ApiClient["default"].convertToType(data['has_slack_webhook_url'], 'Boolean');
         }
-        if (data.hasOwnProperty('last_changed_at')) {
-          obj['last_changed_at'] = _ApiClient["default"].convertToType(data['last_changed_at'], 'Date');
-        }
         if (data.hasOwnProperty('last_changed_by')) {
           obj['last_changed_by'] = _ApiClient["default"].convertToType(data['last_changed_by'], _TemplateActor["default"]);
         }
-        if (data.hasOwnProperty('created_at')) {
-          obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
-        }
-        if (data.hasOwnProperty('updated_at')) {
-          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
-        }
         if (data.hasOwnProperty('defaults')) {
           obj['defaults'] = data['defaults'] === null ? null : _TemplateDefaults["default"].constructFromObject(data['defaults']);
         }
@@ -319,6 +327,9 @@ var Template = /*#__PURE__*/function () {
         if (data.hasOwnProperty('html_engine_options')) {
           obj['html_engine_options'] = _ApiClient["default"].convertToType(data['html_engine_options'], _HtmlEngineOptions["default"]);
         }
+        if (data.hasOwnProperty('html_escape_data')) {
+          obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
+        }
         if (data.hasOwnProperty('embed_edit_token')) {
           obj['embed_edit_token'] = _ApiClient["default"].convertToType(data['embed_edit_token'], 'String');
         }
@@ -378,13 +389,13 @@ var Template = /*#__PURE__*/function () {
         throw new Error("Expected the field `path` to be a primitive type in the JSON string but got " + data['path']);
       }
       // ensure the json data is a string
-      if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
-        throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
-      }
-      // ensure the json data is a string
       if (data['latest_version'] && !(typeof data['latest_version'] === 'string' || data['latest_version'] instanceof String)) {
         throw new Error("Expected the field `latest_version` to be a primitive type in the JSON string but got " + data['latest_version']);
       }
+      // ensure the json data is a string
+      if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
+        throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
+      }
       // ensure the json data is an array
       if (!Array.isArray(data['embed_domains'])) {
         throw new Error("Expected the field `embed_domains` to be an array in the JSON data but got " + data['embed_domains']);
@@ -460,7 +471,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", "field_groups", "predefined_fields", "predefined_fields_sample_data", "html", "scss", "header_html", "footer_html", "html_engine_options", "embed_edit_token", "versions"];
+Template.RequiredProperties = ["id", "name", "description", "template_type", "output_format", "ready", "document", "parent_folder_id", "path", "latest_version", "version_published_at", "locked", "last_changed_at", "created_at", "updated_at", "version", "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_by", "defaults", "field_dependencies", "field_groups", "predefined_fields", "predefined_fields_sample_data", "html", "scss", "header_html", "footer_html", "html_engine_options", "html_escape_data", "embed_edit_token", "versions"];
 
 /**
  * The template's ID.
@@ -481,19 +492,25 @@ Template.prototype['name'] = undefined;
 Template.prototype['description'] = undefined;
 
 /**
- * `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
+ * `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
  * @member {module:model/TemplateType} template_type
  */
 Template.prototype['template_type'] = undefined;
 
 /**
- * Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once its document has been processed (`document.state` is `processed`).
+ * 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; PDF and HTML 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
+ */
+Template.prototype['output_format'] = undefined;
+
+/**
+ * Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded).
  * @member {Boolean} ready
  */
 Template.prototype['ready'] = undefined;
 
 /**
- * The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet.
+ * The PDF of a PDF template, or the Word document of a Word template. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url` has one, with no file, while it's downloaded.
  * @member {module:model/TemplateDocument} document
  */
 Template.prototype['document'] = undefined;
@@ -510,12 +527,6 @@ Template.prototype['parent_folder_id'] = undefined;
  */
 Template.prototype['path'] = undefined;
 
-/**
- * The published version this is, such as `1.2.0`. Null for the draft.
- * @member {String} version
- */
-Template.prototype['version'] = undefined;
-
 /**
  * The template's latest published version. Null if no version has been published.
  * @member {String} latest_version
@@ -534,6 +545,30 @@ Template.prototype['version_published_at'] = undefined;
  */
 Template.prototype['locked'] = undefined;
 
+/**
+ * When the draft was last changed.
+ * @member {Date} last_changed_at
+ */
+Template.prototype['last_changed_at'] = undefined;
+
+/**
+ * When the template was created.
+ * @member {Date} created_at
+ */
+Template.prototype['created_at'] = undefined;
+
+/**
+ * When the template was last updated.
+ * @member {Date} updated_at
+ */
+Template.prototype['updated_at'] = undefined;
+
+/**
+ * The published version this is, such as `1.2.0`. Null for the draft.
+ * @member {String} version
+ */
+Template.prototype['version'] = undefined;
+
 /**
  * Print the submission ID in the footer of each page of PDFs signed through signature requests.
  * @member {Boolean} add_signature_request_submission_id_footers
@@ -559,7 +594,7 @@ Template.prototype['allow_additional_properties'] = undefined;
 Template.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
  */
 Template.prototype['default_form_mode'] = undefined;
@@ -571,7 +606,7 @@ Template.prototype['default_form_mode'] = undefined;
 Template.prototype['editable_submissions'] = undefined;
 
 /**
- * The sites where the template's signature requests, forms and embedded template editor can be loaded: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
+ * The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and the simple form) aren't restricted.
  * @member {Array.<String>} embed_domains
  */
 Template.prototype['embed_domains'] = undefined;
@@ -595,7 +630,7 @@ Template.prototype['embed_edit_allow_versioning'] = undefined;
 Template.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
  */
 Template.prototype['encrypt_pdfs'] = undefined;
@@ -631,7 +666,7 @@ Template.prototype['expiration_interval'] = undefined;
 Template.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
  */
 Template.prototype['parse_dates_using_template_date_format'] = undefined;
@@ -660,30 +695,12 @@ Template.prototype['redirect_url'] = undefined;
  */
 Template.prototype['has_slack_webhook_url'] = undefined;
 
-/**
- * When the draft was last changed.
- * @member {Date} last_changed_at
- */
-Template.prototype['last_changed_at'] = undefined;
-
 /**
  * Who last changed the draft: a user in your account, an API token, or someone using the embedded template editor. Null if no change has been recorded.
  * @member {module:model/TemplateActor} last_changed_by
  */
 Template.prototype['last_changed_by'] = undefined;
 
-/**
- * When the template was created.
- * @member {Date} created_at
- */
-Template.prototype['created_at'] = undefined;
-
-/**
- * When the template was last updated.
- * @member {Date} updated_at
- */
-Template.prototype['updated_at'] = undefined;
-
 /**
  * @member {module:model/TemplateDefaults} defaults
  */
@@ -714,7 +731,7 @@ Template.prototype['predefined_fields'] = undefined;
 Template.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 PDF and Word templates.
  * @member {String} html
  */
 Template.prototype['html'] = undefined;
@@ -738,11 +755,17 @@ Template.prototype['header_html'] = undefined;
 Template.prototype['footer_html'] = undefined;
 
 /**
- * How an HTML template's PDFs are printed. Null for PDF templates. Setting it replaces the whole object: options left out use their defaults.
+ * How an HTML template's PDFs are printed. Null for PDF and Word templates. Setting it replaces the whole object: options left out use their defaults.
  * @member {module:model/HtmlEngineOptions} html_engine_options
  */
 Template.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.
+ * @member {Boolean} html_escape_data
+ */
+Template.prototype['html_escape_data'] = undefined;
+
 /**
  * The token that opens the template in the embedded template editor.
  * @member {String} embed_edit_token

package/dist/model/TemplateActor.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,14 +30,14 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The TemplateActor model module.
  * @module model/TemplateActor
- * @version 4.1.0
+ * @version 4.3.0
  */
 var TemplateActor = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>TemplateActor</code>.
    * A user in your account, an API token, or someone using the embedded template editor.
    * @alias module:model/TemplateActor
-   * @param type {module:model/TemplateActorType} `user`: a user in your account. `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app.
+   * @param type {module:model/TemplateActorType} `user`: a user in your account, also when they make the change with an app they connected (an OAuth access token). `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app.
    * @param user_id {String} The user's ID, for `user`.
    * @param external_id {String} The ID your app gave the embedded editor's user, for `external_user`.
    * @param name {String} The user's name, or the name your app gave the embedded editor's user.
@@ -140,7 +140,7 @@ var TemplateActor = /*#__PURE__*/function () {
 TemplateActor.RequiredProperties = ["type", "user_id", "external_id", "name", "email"];
 
 /**
- * `user`: a user in your account. `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app.
+ * `user`: a user in your account, also when they make the change with an app they connected (an OAuth access token). `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app.
  * @member {module:model/TemplateActorType} type
  */
 TemplateActor.prototype['type'] = undefined;

package/dist/model/TemplateActorType.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/TemplateDefaults.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 TemplateDefaults model module.
  * @module model/TemplateDefaults
- * @version 4.1.0
+ * @version 4.3.0
  */
 var TemplateDefaults = /*#__PURE__*/function () {
   /**

package/dist/model/TemplateDefaultsInput.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 TemplateDefaultsInput model module.
  * @module model/TemplateDefaultsInput
- * @version 4.1.0
+ * @version 4.3.0
  */
 var TemplateDefaultsInput = /*#__PURE__*/function () {
   /**

package/dist/model/TemplateDiff.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 TemplateDiff model module.
  * @module model/TemplateDiff
- * @version 4.1.0
+ * @version 4.3.0
  */
 var TemplateDiff = /*#__PURE__*/function () {
   /**
@@ -44,8 +44,8 @@ var TemplateDiff = /*#__PURE__*/function () {
    * @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`).
+   * @param changed_settings {Array.<String>} The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `merge_audit_trail_pdf`, ...). Values aren't included. Settings that apply to every version, such as `webhook_url` and `encrypt_pdfs_password`, are the same on every version, so they're named only when there's no earlier version to compare with; a secret is named without its value.
+   * @param document_changed {Boolean} The template's PDF was replaced, or its Word document replaced or edited (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);
@@ -193,13 +193,13 @@ TemplateDiff.prototype['summary'] = undefined;
 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.
+ * The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `merge_audit_trail_pdf`, ...). Values aren't included. Settings that apply to every version, such as `webhook_url` and `encrypt_pdfs_password`, are the same on every version, so they're named only when there's no earlier version to compare with; a secret is named without its value.
  * @member {Array.<String>} changed_settings
  */
 TemplateDiff.prototype['changed_settings'] = undefined;
 
 /**
- * The template's PDF was replaced (or added, when there's no `from_version`).
+ * The template's PDF was replaced, or its Word document replaced or edited (or added, when there's no `from_version`).
  * @member {Boolean} document_changed
  */
 TemplateDiff.prototype['document_changed'] = undefined;

package/dist/model/TemplateDiffSummary.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 TemplateDiffSummary model module.
  * @module model/TemplateDiffSummary
- * @version 4.1.0
+ * @version 4.3.0
  */
 var TemplateDiffSummary = /*#__PURE__*/function () {
   /**