docspring 4.2.0 → 4.4.0

package/dist/model/UpdateEmailActionCustomizationRequest.js

@@ -0,0 +1,258 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _EmailActionConditionsInput = _interopRequireDefault(require("./EmailActionConditionsInput"));
+var _EmailActionDelivery = _interopRequireDefault(require("./EmailActionDelivery"));
+var _EmailActionFileFormats = _interopRequireDefault(require("./EmailActionFileFormats"));
+var _EmailActionSubmissionType = _interopRequireDefault(require("./EmailActionSubmissionType"));
+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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
+ * DocSpring API
+ * Use DocSpring's API to 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The UpdateEmailActionCustomizationRequest model module.
+ * @module model/UpdateEmailActionCustomizationRequest
+ * @version 4.4.0
+ */
+var UpdateEmailActionCustomizationRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>UpdateEmailActionCustomizationRequest</code>.
+   * The template's changes to the account email action, replacing any it had. Each setting you send is changed for this template, and the ones you leave out follow the account email action. `enabled: false` stops it sending for this template; left out, it sends.
+   * @alias module:model/UpdateEmailActionCustomizationRequest
+   */
+  function UpdateEmailActionCustomizationRequest() {
+    _classCallCheck(this, UpdateEmailActionCustomizationRequest);
+    UpdateEmailActionCustomizationRequest.initialize(this);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(UpdateEmailActionCustomizationRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>UpdateEmailActionCustomizationRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/UpdateEmailActionCustomizationRequest} obj Optional instance to populate.
+     * @return {module:model/UpdateEmailActionCustomizationRequest} The populated <code>UpdateEmailActionCustomizationRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new UpdateEmailActionCustomizationRequest();
+        if (data.hasOwnProperty('enabled')) {
+          obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
+        }
+        if (data.hasOwnProperty('to')) {
+          obj['to'] = _ApiClient["default"].convertToType(data['to'], ['String']);
+        }
+        if (data.hasOwnProperty('cc')) {
+          obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
+        }
+        if (data.hasOwnProperty('bcc')) {
+          obj['bcc'] = _ApiClient["default"].convertToType(data['bcc'], ['String']);
+        }
+        if (data.hasOwnProperty('from_name')) {
+          obj['from_name'] = _ApiClient["default"].convertToType(data['from_name'], 'String');
+        }
+        if (data.hasOwnProperty('from_address')) {
+          obj['from_address'] = _ApiClient["default"].convertToType(data['from_address'], 'String');
+        }
+        if (data.hasOwnProperty('reply_to')) {
+          obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
+        }
+        if (data.hasOwnProperty('subject')) {
+          obj['subject'] = _ApiClient["default"].convertToType(data['subject'], 'String');
+        }
+        if (data.hasOwnProperty('message')) {
+          obj['message'] = _ApiClient["default"].convertToType(data['message'], 'String');
+        }
+        if (data.hasOwnProperty('file_name')) {
+          obj['file_name'] = _ApiClient["default"].convertToType(data['file_name'], 'String');
+        }
+        if (data.hasOwnProperty('file_formats')) {
+          obj['file_formats'] = _ApiClient["default"].convertToType(data['file_formats'], _EmailActionFileFormats["default"]);
+        }
+        if (data.hasOwnProperty('delivery')) {
+          obj['delivery'] = _ApiClient["default"].convertToType(data['delivery'], _EmailActionDelivery["default"]);
+        }
+        if (data.hasOwnProperty('max_attachment_mb')) {
+          obj['max_attachment_mb'] = _ApiClient["default"].convertToType(data['max_attachment_mb'], 'Number');
+        }
+        if (data.hasOwnProperty('submission_type')) {
+          obj['submission_type'] = _ApiClient["default"].convertToType(data['submission_type'], _EmailActionSubmissionType["default"]);
+        }
+        if (data.hasOwnProperty('send_when')) {
+          obj['send_when'] = _ApiClient["default"].convertToType(data['send_when'], _EmailActionConditionsInput["default"]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpdateEmailActionCustomizationRequest</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateEmailActionCustomizationRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is an array
+      if (!Array.isArray(data['to'])) {
+        throw new Error("Expected the field `to` to be an array in the JSON data but got " + data['to']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['cc'])) {
+        throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['bcc'])) {
+        throw new Error("Expected the field `bcc` to be an array in the JSON data but got " + data['bcc']);
+      }
+      // ensure the json data is a string
+      if (data['from_name'] && !(typeof data['from_name'] === 'string' || data['from_name'] instanceof String)) {
+        throw new Error("Expected the field `from_name` to be a primitive type in the JSON string but got " + data['from_name']);
+      }
+      // ensure the json data is a string
+      if (data['from_address'] && !(typeof data['from_address'] === 'string' || data['from_address'] instanceof String)) {
+        throw new Error("Expected the field `from_address` to be a primitive type in the JSON string but got " + data['from_address']);
+      }
+      // ensure the json data is a string
+      if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
+        throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
+      }
+      // ensure the json data is a string
+      if (data['subject'] && !(typeof data['subject'] === 'string' || data['subject'] instanceof String)) {
+        throw new Error("Expected the field `subject` to be a primitive type in the JSON string but got " + data['subject']);
+      }
+      // ensure the json data is a string
+      if (data['message'] && !(typeof data['message'] === 'string' || data['message'] instanceof String)) {
+        throw new Error("Expected the field `message` to be a primitive type in the JSON string but got " + data['message']);
+      }
+      // ensure the json data is a string
+      if (data['file_name'] && !(typeof data['file_name'] === 'string' || data['file_name'] instanceof String)) {
+        throw new Error("Expected the field `file_name` to be a primitive type in the JSON string but got " + data['file_name']);
+      }
+      // validate the optional field `send_when`
+      if (data['send_when']) {
+        // data not null
+        _EmailActionConditionsInput["default"].validateJSON(data['send_when']);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam.
+ * @member {Boolean} enabled
+ */
+UpdateEmailActionCustomizationRequest.prototype['enabled'] = undefined;
+
+/**
+ * Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them.
+ * @member {Array.<String>} to
+ */
+UpdateEmailActionCustomizationRequest.prototype['to'] = undefined;
+
+/**
+ * Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
+ * @member {Array.<String>} cc
+ */
+UpdateEmailActionCustomizationRequest.prototype['cc'] = undefined;
+
+/**
+ * Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
+ * @member {Array.<String>} bcc
+ */
+UpdateEmailActionCustomizationRequest.prototype['bcc'] = undefined;
+
+/**
+ * The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".
+ * @member {String} from_name
+ */
+UpdateEmailActionCustomizationRequest.prototype['from_name'] = undefined;
+
+/**
+ * The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.
+ * @member {String} from_address
+ */
+UpdateEmailActionCustomizationRequest.prototype['from_address'] = undefined;
+
+/**
+ * Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address.
+ * @member {String} reply_to
+ */
+UpdateEmailActionCustomizationRequest.prototype['reply_to'] = undefined;
+
+/**
+ * The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.<field name>` (`data["field name"]` for a name with spaces) and its metadata as `metadata.<key>`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several.
+ * @member {String} subject
+ */
+UpdateEmailActionCustomizationRequest.prototype['subject'] = undefined;
+
+/**
+ * The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download.
+ * @member {String} message
+ */
+UpdateEmailActionCustomizationRequest.prototype['message'] = undefined;
+
+/**
+ * The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID.
+ * @member {String} file_name
+ */
+UpdateEmailActionCustomizationRequest.prototype['file_name'] = undefined;
+
+/**
+ * Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
+ * @member {module:model/EmailActionFileFormats} file_formats
+ */
+UpdateEmailActionCustomizationRequest.prototype['file_formats'] = undefined;
+
+/**
+ * `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
+ * @member {module:model/EmailActionDelivery} delivery
+ */
+UpdateEmailActionCustomizationRequest.prototype['delivery'] = undefined;
+
+/**
+ * With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
+ * @member {Number} max_attachment_mb
+ */
+UpdateEmailActionCustomizationRequest.prototype['max_attachment_mb'] = undefined;
+
+/**
+ * Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.
+ * @member {module:model/EmailActionSubmissionType} submission_type
+ */
+UpdateEmailActionCustomizationRequest.prototype['submission_type'] = undefined;
+
+/**
+ * Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission.
+ * @member {module:model/EmailActionConditionsInput} send_when
+ */
+UpdateEmailActionCustomizationRequest.prototype['send_when'] = undefined;
+var _default = exports["default"] = UpdateEmailActionCustomizationRequest;

package/dist/model/UpdateEmailActionRequest.js

@@ -0,0 +1,280 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _EmailActionConditionsInput = _interopRequireDefault(require("./EmailActionConditionsInput"));
+var _EmailActionDelivery = _interopRequireDefault(require("./EmailActionDelivery"));
+var _EmailActionFileFormats = _interopRequireDefault(require("./EmailActionFileFormats"));
+var _EmailActionSubmissionType = _interopRequireDefault(require("./EmailActionSubmissionType"));
+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 _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
+ * DocSpring API
+ * Use DocSpring's API to 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The UpdateEmailActionRequest model module.
+ * @module model/UpdateEmailActionRequest
+ * @version 4.4.0
+ */
+var UpdateEmailActionRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>UpdateEmailActionRequest</code>.
+   * The settings to change. Properties left out keep their values.
+   * @alias module:model/UpdateEmailActionRequest
+   */
+  function UpdateEmailActionRequest() {
+    _classCallCheck(this, UpdateEmailActionRequest);
+    UpdateEmailActionRequest.initialize(this);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(UpdateEmailActionRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>UpdateEmailActionRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/UpdateEmailActionRequest} obj Optional instance to populate.
+     * @return {module:model/UpdateEmailActionRequest} The populated <code>UpdateEmailActionRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new UpdateEmailActionRequest();
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+        }
+        if (data.hasOwnProperty('enabled')) {
+          obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
+        }
+        if (data.hasOwnProperty('to')) {
+          obj['to'] = _ApiClient["default"].convertToType(data['to'], ['String']);
+        }
+        if (data.hasOwnProperty('cc')) {
+          obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
+        }
+        if (data.hasOwnProperty('bcc')) {
+          obj['bcc'] = _ApiClient["default"].convertToType(data['bcc'], ['String']);
+        }
+        if (data.hasOwnProperty('from_name')) {
+          obj['from_name'] = _ApiClient["default"].convertToType(data['from_name'], 'String');
+        }
+        if (data.hasOwnProperty('from_address')) {
+          obj['from_address'] = _ApiClient["default"].convertToType(data['from_address'], 'String');
+        }
+        if (data.hasOwnProperty('reply_to')) {
+          obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
+        }
+        if (data.hasOwnProperty('subject')) {
+          obj['subject'] = _ApiClient["default"].convertToType(data['subject'], 'String');
+        }
+        if (data.hasOwnProperty('message')) {
+          obj['message'] = _ApiClient["default"].convertToType(data['message'], 'String');
+        }
+        if (data.hasOwnProperty('file_name')) {
+          obj['file_name'] = _ApiClient["default"].convertToType(data['file_name'], 'String');
+        }
+        if (data.hasOwnProperty('file_formats')) {
+          obj['file_formats'] = _ApiClient["default"].convertToType(data['file_formats'], _EmailActionFileFormats["default"]);
+        }
+        if (data.hasOwnProperty('delivery')) {
+          obj['delivery'] = _ApiClient["default"].convertToType(data['delivery'], _EmailActionDelivery["default"]);
+        }
+        if (data.hasOwnProperty('max_attachment_mb')) {
+          obj['max_attachment_mb'] = _ApiClient["default"].convertToType(data['max_attachment_mb'], 'Number');
+        }
+        if (data.hasOwnProperty('submission_type')) {
+          obj['submission_type'] = _ApiClient["default"].convertToType(data['submission_type'], _EmailActionSubmissionType["default"]);
+        }
+        if (data.hasOwnProperty('send_when')) {
+          obj['send_when'] = _ApiClient["default"].convertToType(data['send_when'], _EmailActionConditionsInput["default"]);
+        }
+        if (data.hasOwnProperty('failure_notifications_enabled')) {
+          obj['failure_notifications_enabled'] = _ApiClient["default"].convertToType(data['failure_notifications_enabled'], 'Boolean');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpdateEmailActionRequest</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateEmailActionRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
+        throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['to'])) {
+        throw new Error("Expected the field `to` to be an array in the JSON data but got " + data['to']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['cc'])) {
+        throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['bcc'])) {
+        throw new Error("Expected the field `bcc` to be an array in the JSON data but got " + data['bcc']);
+      }
+      // ensure the json data is a string
+      if (data['from_name'] && !(typeof data['from_name'] === 'string' || data['from_name'] instanceof String)) {
+        throw new Error("Expected the field `from_name` to be a primitive type in the JSON string but got " + data['from_name']);
+      }
+      // ensure the json data is a string
+      if (data['from_address'] && !(typeof data['from_address'] === 'string' || data['from_address'] instanceof String)) {
+        throw new Error("Expected the field `from_address` to be a primitive type in the JSON string but got " + data['from_address']);
+      }
+      // ensure the json data is a string
+      if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
+        throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
+      }
+      // ensure the json data is a string
+      if (data['subject'] && !(typeof data['subject'] === 'string' || data['subject'] instanceof String)) {
+        throw new Error("Expected the field `subject` to be a primitive type in the JSON string but got " + data['subject']);
+      }
+      // ensure the json data is a string
+      if (data['message'] && !(typeof data['message'] === 'string' || data['message'] instanceof String)) {
+        throw new Error("Expected the field `message` to be a primitive type in the JSON string but got " + data['message']);
+      }
+      // ensure the json data is a string
+      if (data['file_name'] && !(typeof data['file_name'] === 'string' || data['file_name'] instanceof String)) {
+        throw new Error("Expected the field `file_name` to be a primitive type in the JSON string but got " + data['file_name']);
+      }
+      // validate the optional field `send_when`
+      if (data['send_when']) {
+        // data not null
+        _EmailActionConditionsInput["default"].validateJSON(data['send_when']);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * A name for the email action, shown in the dashboard. Null shows its recipients instead.
+ * @member {String} name
+ */
+UpdateEmailActionRequest.prototype['name'] = undefined;
+
+/**
+ * Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam.
+ * @member {Boolean} enabled
+ */
+UpdateEmailActionRequest.prototype['enabled'] = undefined;
+
+/**
+ * Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them.
+ * @member {Array.<String>} to
+ */
+UpdateEmailActionRequest.prototype['to'] = undefined;
+
+/**
+ * Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
+ * @member {Array.<String>} cc
+ */
+UpdateEmailActionRequest.prototype['cc'] = undefined;
+
+/**
+ * Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
+ * @member {Array.<String>} bcc
+ */
+UpdateEmailActionRequest.prototype['bcc'] = undefined;
+
+/**
+ * The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".
+ * @member {String} from_name
+ */
+UpdateEmailActionRequest.prototype['from_name'] = undefined;
+
+/**
+ * The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.
+ * @member {String} from_address
+ */
+UpdateEmailActionRequest.prototype['from_address'] = undefined;
+
+/**
+ * Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address.
+ * @member {String} reply_to
+ */
+UpdateEmailActionRequest.prototype['reply_to'] = undefined;
+
+/**
+ * The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.<field name>` (`data["field name"]` for a name with spaces) and its metadata as `metadata.<key>`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several.
+ * @member {String} subject
+ */
+UpdateEmailActionRequest.prototype['subject'] = undefined;
+
+/**
+ * The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download.
+ * @member {String} message
+ */
+UpdateEmailActionRequest.prototype['message'] = undefined;
+
+/**
+ * The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID.
+ * @member {String} file_name
+ */
+UpdateEmailActionRequest.prototype['file_name'] = undefined;
+
+/**
+ * Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
+ * @member {module:model/EmailActionFileFormats} file_formats
+ */
+UpdateEmailActionRequest.prototype['file_formats'] = undefined;
+
+/**
+ * `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
+ * @member {module:model/EmailActionDelivery} delivery
+ */
+UpdateEmailActionRequest.prototype['delivery'] = undefined;
+
+/**
+ * With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
+ * @member {Number} max_attachment_mb
+ */
+UpdateEmailActionRequest.prototype['max_attachment_mb'] = undefined;
+
+/**
+ * Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.
+ * @member {module:model/EmailActionSubmissionType} submission_type
+ */
+UpdateEmailActionRequest.prototype['submission_type'] = undefined;
+
+/**
+ * Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission.
+ * @member {module:model/EmailActionConditionsInput} send_when
+ */
+UpdateEmailActionRequest.prototype['send_when'] = undefined;
+
+/**
+ * Whether the account's owner gets an email when the email action's emails keep failing.
+ * @member {Boolean} failure_notifications_enabled
+ */
+UpdateEmailActionRequest.prototype['failure_notifications_enabled'] = undefined;
+var _default = exports["default"] = UpdateEmailActionRequest;

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

package/dist/model/UpdateTemplateDocumentRequest.js

@@ -13,7 +13,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
  * 
@@ -26,12 +26,12 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The UpdateTemplateDocumentRequest model module.
  * @module model/UpdateTemplateDocumentRequest
- * @version 4.2.0
+ * @version 4.4.0
  */
 var UpdateTemplateDocumentRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>UpdateTemplateDocumentRequest</code>.
-   * The new PDF, as one of `cache_id`, `document_url` and `document_base64`.
+   * The new PDF, or a Word template's new Word document, as one of `cache_id`, `document_url` and `document_base64`.
    * @alias module:model/UpdateTemplateDocumentRequest
    */
   function UpdateTemplateDocumentRequest() {
@@ -108,31 +108,31 @@ var UpdateTemplateDocumentRequest = /*#__PURE__*/function () {
   }]);
 }();
 /**
- * The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign).
+ * The `fields.key` of the new PDF or Word document (.docx or .odt), uploaded with the presigned upload (GET /uploads/presign).
  * @member {String} cache_id
  */
 UpdateTemplateDocumentRequest.prototype['cache_id'] = undefined;
 
 /**
- * An https:// link to the template's PDF (up to 100 MB), instead of `cache_id`. DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then (sync.api hosts wait for it). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
+ * An https:// link to the template's document, instead of `cache_id`: a PDF template's PDF (up to 100 MB) or a Word template's Word document (.docx or .odt, up to 50 MB). DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then, and `converting` while an .odt is converted (sync.api hosts wait for both). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
  * @member {String} document_url
  */
 UpdateTemplateDocumentRequest.prototype['document_url'] = undefined;
 
 /**
- * The template's PDF, encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
+ * The template's document (a PDF, or a Word template's Word document), encoded as base64 (a `data:` URI works too), instead of `cache_id`. Line breaks and spaces in it are ignored. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
  * @member {String} document_base64
  */
 UpdateTemplateDocumentRequest.prototype['document_base64'] = undefined;
 
 /**
- * The PDF's file name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
+ * The file's name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
  * @member {String} filename
  */
 UpdateTemplateDocumentRequest.prototype['filename'] = undefined;
 
 /**
- * Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields.
+ * Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
  * @member {Boolean} reimport_fields
  */
 UpdateTemplateDocumentRequest.prototype['reimport_fields'] = undefined;

package/dist/model/UpdateTemplateFieldsRequest.js

@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
  * DocSpring API
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v2
  * 
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The UpdateTemplateFieldsRequest model module.
  * @module model/UpdateTemplateFieldsRequest
- * @version 4.2.0
+ * @version 4.4.0
  */
 var UpdateTemplateFieldsRequest = /*#__PURE__*/function () {
   /**