docspring 4.1.0 → 4.3.0

package/dist/model/Submission.js

@@ -24,7 +24,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
  * DocSpring API
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -37,43 +37,43 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The Submission model module.
  * @module model/Submission
- * @version 4.1.0
+ * @version 4.3.0
  */
 var Submission = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>Submission</code>.
-   * Data submitted to a template, and the PDF generated from it.
+   * Data submitted to a template, and the files generated from it (a PDF, a Word document, an OpenDocument file, or more than one of them).
    * @alias module:model/Submission
    * @extends Object
    * @param id {String} The submission's ID.
    * @param template_id {String} Null once the template has been permanently deleted.
-   * @param template_type {module:model/TemplateType} The template's type: `pdf` or `html`.
+   * @param template_type {module:model/TemplateType} The template's type: `pdf`, `html` or `docx`.
    * @param template_version {String} The published version of the template the submission used. Null for the draft.
    * @param batch_id {String} The ID of the batch the submission was created in.
    * @param source {module:model/SubmissionSource} `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
-   * @param state {module:model/SubmissionState} `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+   * @param state {module:model/SubmissionState} `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
    * @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
    * @param editable {Boolean} `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
-   * @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired.
+   * @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data.
    * @param data_errors {Array.<module:model/ErrorDetail>} Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
    * @param error_message {String} Why the PDF couldn't be generated, when `state` is `error`.
-   * @param metadata {Object.<String, Object>} Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
-   * @param has_password {Boolean} Whether the PDF needs a password to open (`password`).
-   * @param signature_requests {Array.<module:model/SignatureRequest>} The people asked to sign the submission (and fill in their fields), in order.
-   * @param actions {Array.<module:model/SubmissionAction>} The uploads of the submission's PDF to your storage (account integrations).
-   * @param truncated_text {Object.<String, Array.<String>>} The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
-   * @param output_formats {Array.<module:model/OutputFormat>} What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
-   * @param files {module:model/SubmissionFiles} The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
-   * @param preview_generated_at {Date} When the preview PDF was generated. Null if there is no preview.
+   * @param metadata {Object.<String, Object>} Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
+   * @param files {module:model/SubmissionFiles} The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
    * @param expired {Boolean} An expired submission's data, metadata, password and PDF have been deleted.
    * @param expires_at {Date} When the submission expires. Null if it's kept until you delete it.
    * @param processed_at {Date} When the PDF was generated. Null until then.
    * @param created_at {Date} When the submission was created.
    * @param updated_at {Date} When the submission was last updated.
+   * @param has_password {Boolean} Whether the PDF needs a password to open (`password`).
+   * @param signature_requests {Array.<module:model/SignatureRequest>} The people asked to sign the submission (and fill in their fields), in order.
+   * @param actions {Array.<module:model/SubmissionAction>} The uploads of the submission's PDF to your storage (account integrations).
+   * @param truncated_text {Object.<String, Array.<String>>} The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
+   * @param output_formats {Array.<module:model/OutputFormat>} What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
+   * @param preview_generated_at {Date} When the preview PDF was generated. Null if there is no preview.
    */
-  function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at) {
+  function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at) {
     _classCallCheck(this, Submission);
-    Submission.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at);
+    Submission.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at);
   }
 
   /**
@@ -83,7 +83,7 @@ var Submission = /*#__PURE__*/function () {
    */
   return _createClass(Submission, null, [{
     key: "initialize",
-    value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, output_formats, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at) {
+    value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at) {
       obj['id'] = id;
       obj['template_id'] = template_id;
       obj['template_type'] = template_type;
@@ -97,18 +97,18 @@ var Submission = /*#__PURE__*/function () {
       obj['data_errors'] = data_errors;
       obj['error_message'] = error_message;
       obj['metadata'] = metadata;
-      obj['has_password'] = has_password;
-      obj['signature_requests'] = signature_requests;
-      obj['actions'] = actions;
-      obj['truncated_text'] = truncated_text;
-      obj['output_formats'] = output_formats;
       obj['files'] = files;
-      obj['preview_generated_at'] = preview_generated_at;
       obj['expired'] = expired;
       obj['expires_at'] = expires_at;
       obj['processed_at'] = processed_at;
       obj['created_at'] = created_at;
       obj['updated_at'] = updated_at;
+      obj['has_password'] = has_password;
+      obj['signature_requests'] = signature_requests;
+      obj['actions'] = actions;
+      obj['truncated_text'] = truncated_text;
+      obj['output_formats'] = output_formats;
+      obj['preview_generated_at'] = preview_generated_at;
     }
 
     /**
@@ -167,6 +167,24 @@ var Submission = /*#__PURE__*/function () {
             'String': Object
           });
         }
+        if (data.hasOwnProperty('files')) {
+          obj['files'] = _ApiClient["default"].convertToType(data['files'], _SubmissionFiles["default"]);
+        }
+        if (data.hasOwnProperty('expired')) {
+          obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
+        }
+        if (data.hasOwnProperty('expires_at')) {
+          obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
+        }
+        if (data.hasOwnProperty('processed_at')) {
+          obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_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('has_password')) {
           obj['has_password'] = _ApiClient["default"].convertToType(data['has_password'], 'Boolean');
         }
@@ -184,27 +202,9 @@ var Submission = /*#__PURE__*/function () {
         if (data.hasOwnProperty('output_formats')) {
           obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
         }
-        if (data.hasOwnProperty('files')) {
-          obj['files'] = _ApiClient["default"].convertToType(data['files'], _SubmissionFiles["default"]);
-        }
         if (data.hasOwnProperty('preview_generated_at')) {
           obj['preview_generated_at'] = _ApiClient["default"].convertToType(data['preview_generated_at'], 'Date');
         }
-        if (data.hasOwnProperty('expired')) {
-          obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
-        }
-        if (data.hasOwnProperty('expires_at')) {
-          obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
-        }
-        if (data.hasOwnProperty('processed_at')) {
-          obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_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');
-        }
       }
       return obj;
     }
@@ -272,7 +272,7 @@ var Submission = /*#__PURE__*/function () {
     }
   }]);
 }();
-Submission.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "has_password", "signature_requests", "actions", "truncated_text", "output_formats", "files", "preview_generated_at", "expired", "expires_at", "processed_at", "created_at", "updated_at"];
+Submission.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "files", "expired", "expires_at", "processed_at", "created_at", "updated_at", "has_password", "signature_requests", "actions", "truncated_text", "output_formats", "preview_generated_at"];
 
 /**
  * The submission's ID.
@@ -287,7 +287,7 @@ Submission.prototype['id'] = undefined;
 Submission.prototype['template_id'] = undefined;
 
 /**
- * The template's type: `pdf` or `html`.
+ * The template's type: `pdf`, `html` or `docx`.
  * @member {module:model/TemplateType} template_type
  */
 Submission.prototype['template_type'] = undefined;
@@ -311,7 +311,7 @@ Submission.prototype['batch_id'] = undefined;
 Submission.prototype['source'] = undefined;
 
 /**
- * `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+ * `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
  * @member {module:model/SubmissionState} state
  */
 Submission.prototype['state'] = undefined;
@@ -329,7 +329,7 @@ Submission.prototype['test'] = undefined;
 Submission.prototype['editable'] = undefined;
 
 /**
- * The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired.
+ * The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data.
  * @member {Object.<String, Object>} data
  */
 Submission.prototype['data'] = undefined;
@@ -347,80 +347,80 @@ Submission.prototype['data_errors'] = undefined;
 Submission.prototype['error_message'] = undefined;
 
 /**
- * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
  * @member {Object.<String, Object>} metadata
  */
 Submission.prototype['metadata'] = undefined;
 
 /**
- * Whether the PDF needs a password to open (`password`).
- * @member {Boolean} has_password
+ * The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
+ * @member {module:model/SubmissionFiles} files
  */
-Submission.prototype['has_password'] = undefined;
+Submission.prototype['files'] = undefined;
 
 /**
- * The people asked to sign the submission (and fill in their fields), in order.
- * @member {Array.<module:model/SignatureRequest>} signature_requests
+ * An expired submission's data, metadata, password and PDF have been deleted.
+ * @member {Boolean} expired
  */
-Submission.prototype['signature_requests'] = undefined;
+Submission.prototype['expired'] = undefined;
 
 /**
- * The uploads of the submission's PDF to your storage (account integrations).
- * @member {Array.<module:model/SubmissionAction>} actions
+ * When the submission expires. Null if it's kept until you delete it.
+ * @member {Date} expires_at
  */
-Submission.prototype['actions'] = undefined;
+Submission.prototype['expires_at'] = undefined;
 
 /**
- * The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
- * @member {Object.<String, Array.<String>>} truncated_text
+ * When the PDF was generated. Null until then.
+ * @member {Date} processed_at
  */
-Submission.prototype['truncated_text'] = undefined;
+Submission.prototype['processed_at'] = undefined;
 
 /**
- * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
- * @member {Array.<module:model/OutputFormat>} output_formats
+ * When the submission was created.
+ * @member {Date} created_at
  */
-Submission.prototype['output_formats'] = undefined;
+Submission.prototype['created_at'] = undefined;
 
 /**
- * The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
- * @member {module:model/SubmissionFiles} files
+ * When the submission was last updated.
+ * @member {Date} updated_at
  */
-Submission.prototype['files'] = undefined;
+Submission.prototype['updated_at'] = undefined;
 
 /**
- * When the preview PDF was generated. Null if there is no preview.
- * @member {Date} preview_generated_at
+ * Whether the PDF needs a password to open (`password`).
+ * @member {Boolean} has_password
  */
-Submission.prototype['preview_generated_at'] = undefined;
+Submission.prototype['has_password'] = undefined;
 
 /**
- * An expired submission's data, metadata, password and PDF have been deleted.
- * @member {Boolean} expired
+ * The people asked to sign the submission (and fill in their fields), in order.
+ * @member {Array.<module:model/SignatureRequest>} signature_requests
  */
-Submission.prototype['expired'] = undefined;
+Submission.prototype['signature_requests'] = undefined;
 
 /**
- * When the submission expires. Null if it's kept until you delete it.
- * @member {Date} expires_at
+ * The uploads of the submission's PDF to your storage (account integrations).
+ * @member {Array.<module:model/SubmissionAction>} actions
  */
-Submission.prototype['expires_at'] = undefined;
+Submission.prototype['actions'] = undefined;
 
 /**
- * When the PDF was generated. Null until then.
- * @member {Date} processed_at
+ * The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
+ * @member {Object.<String, Array.<String>>} truncated_text
  */
-Submission.prototype['processed_at'] = undefined;
+Submission.prototype['truncated_text'] = undefined;
 
 /**
- * When the submission was created.
- * @member {Date} created_at
+ * What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
+ * @member {Array.<module:model/OutputFormat>} output_formats
  */
-Submission.prototype['created_at'] = undefined;
+Submission.prototype['output_formats'] = undefined;
 
 /**
- * When the submission was last updated.
- * @member {Date} updated_at
+ * When the preview PDF was generated. Null if there is no preview.
+ * @member {Date} preview_generated_at
  */
-Submission.prototype['updated_at'] = undefined;
+Submission.prototype['preview_generated_at'] = undefined;
 var _default = exports["default"] = Submission;

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

package/dist/model/SubmissionActionState.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/SubmissionActionType.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/SubmissionBatch.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,20 +31,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionBatch model module.
  * @module model/SubmissionBatch
- * @version 4.1.0
+ * @version 4.3.0
  */
 var SubmissionBatch = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>SubmissionBatch</code>.
-   * Submissions created together in one request. Their PDFs are only generated when every submission in the batch is valid.
+   * Submissions created together in one request. Their files are only generated when every submission in the batch is valid.
    * @alias module:model/SubmissionBatch
    * @extends Object
    * @param id {String} The batch's ID.
-   * @param state {module:model/SubmissionBatchState} `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
+   * @param state {module:model/SubmissionBatchState} `pending` while the files are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
    * @param metadata {Object.<String, Object>} Your own data about the batch, such as an ID from your app.
    * @param total_count {Number} The number of submissions in the request.
-   * @param pending_count {Number} The submissions whose PDFs haven't been generated yet.
-   * @param error_count {Number} The submissions that were invalid or whose PDFs couldn't be generated.
+   * @param pending_count {Number} The submissions whose files haven't been generated yet.
+   * @param error_count {Number} The submissions that were invalid or whose files couldn't be generated.
    * @param completion_percentage {Number} The percentage of the batch's submissions that have finished, from 0 to 100.
    * @param submissions {Array.<module:model/Submission>} The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`.
    * @param processed_at {Date} When every submission had finished.
@@ -173,7 +173,7 @@ SubmissionBatch.RequiredProperties = ["id", "state", "metadata", "total_count",
 SubmissionBatch.prototype['id'] = undefined;
 
 /**
- * `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
+ * `pending` while the files are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
  * @member {module:model/SubmissionBatchState} state
  */
 SubmissionBatch.prototype['state'] = undefined;
@@ -191,13 +191,13 @@ SubmissionBatch.prototype['metadata'] = undefined;
 SubmissionBatch.prototype['total_count'] = undefined;
 
 /**
- * The submissions whose PDFs haven't been generated yet.
+ * The submissions whose files haven't been generated yet.
  * @member {Number} pending_count
  */
 SubmissionBatch.prototype['pending_count'] = undefined;
 
 /**
- * The submissions that were invalid or whose PDFs couldn't be generated.
+ * The submissions that were invalid or whose files couldn't be generated.
  * @member {Number} error_count
  */
 SubmissionBatch.prototype['error_count'] = undefined;

package/dist/model/SubmissionBatchState.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/SubmissionFiles.js

@@ -15,7 +15,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
  * DocSpring API
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionFiles model module.
  * @module model/SubmissionFiles
- * @version 4.1.0
+ * @version 4.3.0
  */
 var SubmissionFiles = /*#__PURE__*/function () {
   /**
@@ -73,6 +73,12 @@ var SubmissionFiles = /*#__PURE__*/function () {
         if (data.hasOwnProperty('preview')) {
           obj['preview'] = _ApiClient["default"].convertToType(data['preview'], _GeneratedFile["default"]);
         }
+        if (data.hasOwnProperty('docx')) {
+          obj['docx'] = _ApiClient["default"].convertToType(data['docx'], _GeneratedFile["default"]);
+        }
+        if (data.hasOwnProperty('odt')) {
+          obj['odt'] = _ApiClient["default"].convertToType(data['odt'], _GeneratedFile["default"]);
+        }
         if (data.hasOwnProperty('png')) {
           obj['png'] = data['png'] === null ? null : _PageImages["default"].constructFromObject(data['png']);
         }
@@ -110,6 +116,18 @@ SubmissionFiles.prototype['audit_trail'] = undefined;
  */
 SubmissionFiles.prototype['preview'] = undefined;
 
+/**
+ * The Word document of a Word template's submission, when the submission makes one (`output_formats`).
+ * @member {module:model/GeneratedFile} docx
+ */
+SubmissionFiles.prototype['docx'] = undefined;
+
+/**
+ * The OpenDocument file (.odt, the format LibreOffice uses) of a Word template's submission, converted from its Word document, when the submission makes one (`output_formats`).
+ * @member {module:model/GeneratedFile} odt
+ */
+SubmissionFiles.prototype['odt'] = undefined;
+
 /**
  * @member {module:model/PageImages} png
  */

package/dist/model/SubmissionInput.js

@@ -15,7 +15,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
  * DocSpring API
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionInput model module.
  * @module model/SubmissionInput
- * @version 4.1.0
+ * @version 4.3.0
  */
 var SubmissionInput = /*#__PURE__*/function () {
   /**
@@ -157,25 +157,25 @@ SubmissionInput.prototype['test'] = undefined;
 SubmissionInput.prototype['editable'] = undefined;
 
 /**
- * The values of the template's fields, by field name. Required for a PDF template.
+ * The values of the template's fields, by field name. Required for PDF and Word templates.
  * @member {Object.<String, Object>} data
  */
 SubmissionInput.prototype['data'] = undefined;
 
 /**
- * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
  * @member {Object.<String, Object>} metadata
  */
 SubmissionInput.prototype['metadata'] = undefined;
 
 /**
- * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
+ * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
  * @member {String} password
  */
 SubmissionInput.prototype['password'] = undefined;
 
 /**
- * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+ * What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
  * @member {Array.<module:model/OutputFormat>} output_formats
  */
 SubmissionInput.prototype['output_formats'] = undefined;
@@ -199,7 +199,7 @@ SubmissionInput.prototype['field_overrides'] = undefined;
 SubmissionInput.prototype['html'] = undefined;
 
 /**
- * For an HTML template, CSS to use instead of the template's.
+ * For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity.
  * @member {String} css
  */
 SubmissionInput.prototype['css'] = undefined;

package/dist/model/SubmissionList.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _Submission = _interopRequireDefault(require("./Submission"));
+var _SubmissionSummary = _interopRequireDefault(require("./SubmissionSummary"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
  * DocSpring API
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionList model module.
  * @module model/SubmissionList
- * @version 4.1.0
+ * @version 4.3.0
  */
 var SubmissionList = /*#__PURE__*/function () {
   /**
@@ -38,7 +38,7 @@ var SubmissionList = /*#__PURE__*/function () {
    * A page of submissions, newest first.
    * @alias module:model/SubmissionList
    * @extends Object
-   * @param data {Array.<module:model/Submission>} The items on this page.
+   * @param data {Array.<module:model/SubmissionSummary>} The items on this page.
    * @param next_cursor {String} Pass it as `cursor` to get the next page. Null on the last page.
    */
   function SubmissionList(data, next_cursor) {
@@ -72,7 +72,7 @@ var SubmissionList = /*#__PURE__*/function () {
         obj = obj || new SubmissionList();
         _ApiClient["default"].constructFromObject(data, obj, 'Object');
         if (data.hasOwnProperty('data')) {
-          obj['data'] = _ApiClient["default"].convertToType(data['data'], [_Submission["default"]]);
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], [_SubmissionSummary["default"]]);
         }
         if (data.hasOwnProperty('next_cursor')) {
           obj['next_cursor'] = _ApiClient["default"].convertToType(data['next_cursor'], 'String');
@@ -120,7 +120,7 @@ SubmissionList.RequiredProperties = ["data", "next_cursor"];
 
 /**
  * The items on this page.
- * @member {Array.<module:model/Submission>} data
+ * @member {Array.<module:model/SubmissionSummary>} data
  */
 SubmissionList.prototype['data'] = undefined;
 

package/dist/model/SubmissionSource.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
  *