docspring 4.1.0 → 4.2.0

package/dist/model/Template.js

@@ -41,7 +41,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The Template model module.
  * @module model/Template
- * @version 4.1.0
+ * @version 4.2.0
  */
 var Template = /*#__PURE__*/function () {
   /**
@@ -53,21 +53,24 @@ var Template = /*#__PURE__*/function () {
    * @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 ready {Boolean} Whether the template can generate PDFs. 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.
    * @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 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 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.
@@ -82,10 +85,7 @@ var Template = /*#__PURE__*/function () {
    * @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/~`.
@@ -96,12 +96,13 @@ var Template = /*#__PURE__*/function () {
    * @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_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, 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, 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,7 +112,7 @@ var Template = /*#__PURE__*/function () {
    */
   return _createClass(Template, null, [{
     key: "initialize",
-    value: function initialize(obj, id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_at, last_changed_by, created_at, updated_at, defaults, field_dependencies, 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, 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;
@@ -120,10 +121,13 @@ var Template = /*#__PURE__*/function () {
       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 +149,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 +160,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;
     }
@@ -200,9 +202,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 +211,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 +286,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 +321,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 +383,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 +465,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", "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.
@@ -487,7 +492,7 @@ Template.prototype['description'] = undefined;
 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`).
+ * Whether the template can generate PDFs. 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.
  * @member {Boolean} ready
  */
 Template.prototype['ready'] = undefined;
@@ -510,12 +515,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 +533,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
@@ -571,7 +594,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;
@@ -660,30 +683,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
  */
@@ -743,6 +748,12 @@ Template.prototype['footer_html'] = undefined;
  */
 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

@@ -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.2.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/TemplateDefaults.js

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

package/dist/model/TemplateDefaultsInput.js

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

package/dist/model/TemplateDiff.js

@@ -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.2.0
  */
 var TemplateDiff = /*#__PURE__*/function () {
   /**

package/dist/model/TemplateDiffSummary.js

@@ -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.2.0
  */
 var TemplateDiffSummary = /*#__PURE__*/function () {
   /**

package/dist/model/TemplateDocument.js

@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The TemplateDocument model module.
  * @module model/TemplateDocument
- * @version 4.1.0
+ * @version 4.2.0
  */
 var TemplateDocument = /*#__PURE__*/function () {
   /**
@@ -41,11 +41,11 @@ var TemplateDocument = /*#__PURE__*/function () {
    * A PDF template's PDF.
    * @alias module:model/TemplateDocument
    * @param filename {String} The PDF's file name. Null until a `document_url` has been downloaded.
-   * @param md5 {String} The MD5 hash of the PDF.
-   * @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed`. `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
+   * @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
    * @param error_message {String} Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
-   * @param field_reimport_state {module:model/FieldReimportState} Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
    * @param page_count {Number} 0 until the PDF has been processed.
+   * @param md5 {String} The MD5 hash of the PDF.
+   * @param field_reimport_state {module:model/FieldReimportState} Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
    * @param page_dimensions {Array.<Array.<Number>>} Each page's width and height in PDF points. Null until the PDF has been processed.
    * @param has_fillable_fields {Boolean} Whether the PDF has fillable form fields. Null until DocSpring has read the PDF.
    * @param page_processing_statuses {Array.<module:model/TemplatePageProcessingStatus>} How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, and for PDFs uploaded before DocSpring recorded page statuses.
@@ -53,9 +53,9 @@ var TemplateDocument = /*#__PURE__*/function () {
    * @param download_url {String} A temporary link to download the PDF.
    * @param permanent_url {String} A link to download the PDF that doesn't expire. Null until the PDF has been processed.
    */
-  function TemplateDocument(filename, md5, state, error_message, field_reimport_state, page_count, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url) {
+  function TemplateDocument(filename, state, error_message, page_count, md5, field_reimport_state, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url) {
     _classCallCheck(this, TemplateDocument);
-    TemplateDocument.initialize(this, filename, md5, state, error_message, field_reimport_state, page_count, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url);
+    TemplateDocument.initialize(this, filename, state, error_message, page_count, md5, field_reimport_state, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url);
   }
 
   /**
@@ -65,13 +65,13 @@ var TemplateDocument = /*#__PURE__*/function () {
    */
   return _createClass(TemplateDocument, null, [{
     key: "initialize",
-    value: function initialize(obj, filename, md5, state, error_message, field_reimport_state, page_count, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url) {
+    value: function initialize(obj, filename, state, error_message, page_count, md5, field_reimport_state, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url) {
       obj['filename'] = filename;
-      obj['md5'] = md5;
       obj['state'] = state;
       obj['error_message'] = error_message;
-      obj['field_reimport_state'] = field_reimport_state;
       obj['page_count'] = page_count;
+      obj['md5'] = md5;
+      obj['field_reimport_state'] = field_reimport_state;
       obj['page_dimensions'] = page_dimensions;
       obj['has_fillable_fields'] = has_fillable_fields;
       obj['page_processing_statuses'] = page_processing_statuses;
@@ -95,21 +95,21 @@ var TemplateDocument = /*#__PURE__*/function () {
         if (data.hasOwnProperty('filename')) {
           obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
         }
-        if (data.hasOwnProperty('md5')) {
-          obj['md5'] = _ApiClient["default"].convertToType(data['md5'], 'String');
-        }
         if (data.hasOwnProperty('state')) {
           obj['state'] = _ApiClient["default"].convertToType(data['state'], _TemplateDocumentState["default"]);
         }
         if (data.hasOwnProperty('error_message')) {
           obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
         }
-        if (data.hasOwnProperty('field_reimport_state')) {
-          obj['field_reimport_state'] = _ApiClient["default"].convertToType(data['field_reimport_state'], _FieldReimportState["default"]);
-        }
         if (data.hasOwnProperty('page_count')) {
           obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
         }
+        if (data.hasOwnProperty('md5')) {
+          obj['md5'] = _ApiClient["default"].convertToType(data['md5'], 'String');
+        }
+        if (data.hasOwnProperty('field_reimport_state')) {
+          obj['field_reimport_state'] = _ApiClient["default"].convertToType(data['field_reimport_state'], _FieldReimportState["default"]);
+        }
         if (data.hasOwnProperty('page_dimensions')) {
           obj['page_dimensions'] = _ApiClient["default"].convertToType(data['page_dimensions'], [['Number']]);
         }
@@ -160,13 +160,13 @@ var TemplateDocument = /*#__PURE__*/function () {
         throw new Error("Expected the field `filename` to be a primitive type in the JSON string but got " + data['filename']);
       }
       // ensure the json data is a string
-      if (data['md5'] && !(typeof data['md5'] === 'string' || data['md5'] instanceof String)) {
-        throw new Error("Expected the field `md5` to be a primitive type in the JSON string but got " + data['md5']);
-      }
-      // ensure the json data is a string
       if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
         throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
       }
+      // ensure the json data is a string
+      if (data['md5'] && !(typeof data['md5'] === 'string' || data['md5'] instanceof String)) {
+        throw new Error("Expected the field `md5` to be a primitive type in the JSON string but got " + data['md5']);
+      }
       // ensure the json data is an array
       if (!Array.isArray(data['page_dimensions'])) {
         throw new Error("Expected the field `page_dimensions` to be an array in the JSON data but got " + data['page_dimensions']);
@@ -204,7 +204,7 @@ var TemplateDocument = /*#__PURE__*/function () {
     }
   }]);
 }();
-TemplateDocument.RequiredProperties = ["filename", "md5", "state", "error_message", "field_reimport_state", "page_count", "page_dimensions", "has_fillable_fields", "page_processing_statuses", "field_logic_status", "download_url", "permanent_url"];
+TemplateDocument.RequiredProperties = ["filename", "state", "error_message", "page_count", "md5", "field_reimport_state", "page_dimensions", "has_fillable_fields", "page_processing_statuses", "field_logic_status", "download_url", "permanent_url"];
 
 /**
  * The PDF's file name. Null until a `document_url` has been downloaded.
@@ -213,13 +213,7 @@ TemplateDocument.RequiredProperties = ["filename", "md5", "state", "error_messag
 TemplateDocument.prototype['filename'] = undefined;
 
 /**
- * The MD5 hash of the PDF.
- * @member {String} md5
- */
-TemplateDocument.prototype['md5'] = undefined;
-
-/**
- * `pending` while DocSpring processes the PDF, then `processed`. `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
+ * `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
  * @member {module:model/TemplateDocumentState} state
  */
 TemplateDocument.prototype['state'] = undefined;
@@ -230,18 +224,24 @@ TemplateDocument.prototype['state'] = undefined;
  */
 TemplateDocument.prototype['error_message'] = undefined;
 
-/**
- * Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
- * @member {module:model/FieldReimportState} field_reimport_state
- */
-TemplateDocument.prototype['field_reimport_state'] = undefined;
-
 /**
  * 0 until the PDF has been processed.
  * @member {Number} page_count
  */
 TemplateDocument.prototype['page_count'] = undefined;
 
+/**
+ * The MD5 hash of the PDF.
+ * @member {String} md5
+ */
+TemplateDocument.prototype['md5'] = undefined;
+
+/**
+ * Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
+ * @member {module:model/FieldReimportState} field_reimport_state
+ */
+TemplateDocument.prototype['field_reimport_state'] = undefined;
+
 /**
  * Each page's width and height in PDF points. Null until the PDF has been processed.
  * @member {Array.<Array.<Number>>} page_dimensions