docspring 4.3.0 → 4.4.0

package/dist/model/DnsRecordType.js

@@ -0,0 +1,64 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+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 _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, 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.
+ *
+ */
+/**
+* Enum class DnsRecordType.
+* @enum {}
+* @readonly
+*/
+var DnsRecordType = exports["default"] = /*#__PURE__*/function () {
+  function DnsRecordType() {
+    _classCallCheck(this, DnsRecordType);
+  }
+  return _createClass(DnsRecordType, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>DnsRecordType</code> enum value from a Javascript object name.
+    * @param {Object} data The plain JavaScript object containing the name of the enum value.
+    * @return {module:model/DnsRecordType} The enum <code>DnsRecordType</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "CNAME"
+ * @const
+ */
+_defineProperty(DnsRecordType, "CNAME", "CNAME");
+/**
+ * value: "MX"
+ * @const
+ */
+_defineProperty(DnsRecordType, "MX", "MX");
+/**
+ * value: "TXT"
+ * @const
+ */
+_defineProperty(DnsRecordType, "TXT", "TXT");

package/dist/model/EmailAction.js

@@ -0,0 +1,510 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _EmailActionConditions = _interopRequireDefault(require("./EmailActionConditions"));
+var _EmailActionCustomization = _interopRequireDefault(require("./EmailActionCustomization"));
+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 _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; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+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 EmailAction model module.
+ * @module model/EmailAction
+ * @version 4.4.0
+ */
+var EmailAction = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>EmailAction</code>.
+   * Emails each submission's files (its PDF, and a Word template's Word document and OpenDocument file) to people when the submission has been processed. An email action belongs to a template's draft, or to your account (an account email action, with no `template_id`), which sends for every template or for the templates and folders it lists. Each template can turn an account email action off or change its settings for that template only (`customization`). Email actions email anyone on a paid plan (Starter or higher); without one, they only email your team (test emails, and test submissions). They send from DocSpring's shared address or from one of your verified email domains.
+   * @alias module:model/EmailAction
+   * @extends Object
+   * @param id {String} The email action's ID.
+   * @param template_id {String} The ID of the template it belongs to. Null for an account email action, which sends for many templates.
+   * @param template_ids {Array.<String>} For an account email action: the IDs of the templates it sends for. With `folder_ids`, it sends for a template that either list includes. Both empty sends for every template. Always empty for a template's own email action.
+   * @param folder_ids {Array.<String>} For an account email action: the IDs of folders whose templates it sends for, including the templates in the folders inside them. Always empty for a template's own email action.
+   * @param name {String} A name for the email action, shown in the dashboard. Null shows its recipients instead.
+   * @param enabled {Boolean} 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.
+   * @param to {Array.<String>} 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.
+   * @param cc {Array.<String>} Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
+   * @param bcc {Array.<String>} Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
+   * @param from_name {String} The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".
+   * @param from_address {String} The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.
+   * @param reply_to {String} 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.
+   * @param subject {String} 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.
+   * @param message {String} 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.
+   * @param file_name {String} 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.
+   * @param file_formats {module:model/EmailActionFileFormats} 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`.
+   * @param delivery {module:model/EmailActionDelivery} `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`.
+   * @param max_attachment_mb {Number} 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).
+   * @param submission_type {module:model/EmailActionSubmissionType} Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.
+   * @param send_when {module:model/EmailActionConditions} 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.
+   * @param failure_notifications_enabled {Boolean} Whether the account's owner gets an email when the email action's emails keep failing.
+   * @param consecutive_failures {Number} How many emails in a row have failed.
+   * @param failing_since {Date} When the current run of failures started. Null when the last email was sent.
+   * @param last_failure_at {Date} When an email last failed.
+   * @param last_failure_message {String} Why the last failed email failed.
+   * @param disabled_at {Date} When the email action was turned off. Null while it is on.
+   * @param disabled_reason {String} Why DocSpring turned the email action off, such as after 3 days of failed emails or an address that bounced.
+   * @param customization {module:model/EmailActionCustomization} In a template's list of email actions, its changes to an account email action, or null when it changes nothing. The email action's settings are then the ones it sends for that template. Null everywhere else.
+   * @param created_at {Date} When the email action was created.
+   * @param updated_at {Date} When the email action was last changed.
+   */
+  function EmailAction(id, template_id, template_ids, folder_ids, name, enabled, to, cc, bcc, from_name, from_address, reply_to, subject, message, file_name, file_formats, delivery, max_attachment_mb, submission_type, send_when, failure_notifications_enabled, consecutive_failures, failing_since, last_failure_at, last_failure_message, disabled_at, disabled_reason, customization, created_at, updated_at) {
+    _classCallCheck(this, EmailAction);
+    EmailAction.initialize(this, id, template_id, template_ids, folder_ids, name, enabled, to, cc, bcc, from_name, from_address, reply_to, subject, message, file_name, file_formats, delivery, max_attachment_mb, submission_type, send_when, failure_notifications_enabled, consecutive_failures, failing_since, last_failure_at, last_failure_message, disabled_at, disabled_reason, customization, created_at, updated_at);
+  }
+
+  /**
+   * 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(EmailAction, null, [{
+    key: "initialize",
+    value: function initialize(obj, id, template_id, template_ids, folder_ids, name, enabled, to, cc, bcc, from_name, from_address, reply_to, subject, message, file_name, file_formats, delivery, max_attachment_mb, submission_type, send_when, failure_notifications_enabled, consecutive_failures, failing_since, last_failure_at, last_failure_message, disabled_at, disabled_reason, customization, created_at, updated_at) {
+      obj['id'] = id;
+      obj['template_id'] = template_id;
+      obj['template_ids'] = template_ids;
+      obj['folder_ids'] = folder_ids;
+      obj['name'] = name;
+      obj['enabled'] = enabled;
+      obj['to'] = to;
+      obj['cc'] = cc;
+      obj['bcc'] = bcc;
+      obj['from_name'] = from_name;
+      obj['from_address'] = from_address;
+      obj['reply_to'] = reply_to;
+      obj['subject'] = subject;
+      obj['message'] = message;
+      obj['file_name'] = file_name;
+      obj['file_formats'] = file_formats;
+      obj['delivery'] = delivery;
+      obj['max_attachment_mb'] = max_attachment_mb;
+      obj['submission_type'] = submission_type;
+      obj['send_when'] = send_when;
+      obj['failure_notifications_enabled'] = failure_notifications_enabled;
+      obj['consecutive_failures'] = consecutive_failures;
+      obj['failing_since'] = failing_since;
+      obj['last_failure_at'] = last_failure_at;
+      obj['last_failure_message'] = last_failure_message;
+      obj['disabled_at'] = disabled_at;
+      obj['disabled_reason'] = disabled_reason;
+      obj['customization'] = customization;
+      obj['created_at'] = created_at;
+      obj['updated_at'] = updated_at;
+    }
+
+    /**
+     * Constructs a <code>EmailAction</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/EmailAction} obj Optional instance to populate.
+     * @return {module:model/EmailAction} The populated <code>EmailAction</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new EmailAction();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
+        }
+        if (data.hasOwnProperty('template_id')) {
+          obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
+        }
+        if (data.hasOwnProperty('template_ids')) {
+          obj['template_ids'] = _ApiClient["default"].convertToType(data['template_ids'], ['String']);
+        }
+        if (data.hasOwnProperty('folder_ids')) {
+          obj['folder_ids'] = _ApiClient["default"].convertToType(data['folder_ids'], ['String']);
+        }
+        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'], _EmailActionConditions["default"]);
+        }
+        if (data.hasOwnProperty('failure_notifications_enabled')) {
+          obj['failure_notifications_enabled'] = _ApiClient["default"].convertToType(data['failure_notifications_enabled'], 'Boolean');
+        }
+        if (data.hasOwnProperty('consecutive_failures')) {
+          obj['consecutive_failures'] = _ApiClient["default"].convertToType(data['consecutive_failures'], 'Number');
+        }
+        if (data.hasOwnProperty('failing_since')) {
+          obj['failing_since'] = _ApiClient["default"].convertToType(data['failing_since'], 'Date');
+        }
+        if (data.hasOwnProperty('last_failure_at')) {
+          obj['last_failure_at'] = _ApiClient["default"].convertToType(data['last_failure_at'], 'Date');
+        }
+        if (data.hasOwnProperty('last_failure_message')) {
+          obj['last_failure_message'] = _ApiClient["default"].convertToType(data['last_failure_message'], 'String');
+        }
+        if (data.hasOwnProperty('disabled_at')) {
+          obj['disabled_at'] = _ApiClient["default"].convertToType(data['disabled_at'], 'Date');
+        }
+        if (data.hasOwnProperty('disabled_reason')) {
+          obj['disabled_reason'] = _ApiClient["default"].convertToType(data['disabled_reason'], 'String');
+        }
+        if (data.hasOwnProperty('customization')) {
+          obj['customization'] = _ApiClient["default"].convertToType(data['customization'], _EmailActionCustomization["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');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>EmailAction</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>EmailAction</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(EmailAction.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
+        throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
+      }
+      // ensure the json data is a string
+      if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
+        throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['template_ids'])) {
+        throw new Error("Expected the field `template_ids` to be an array in the JSON data but got " + data['template_ids']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['folder_ids'])) {
+        throw new Error("Expected the field `folder_ids` to be an array in the JSON data but got " + data['folder_ids']);
+      }
+      // 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
+        _EmailActionConditions["default"].validateJSON(data['send_when']);
+      }
+      // ensure the json data is a string
+      if (data['last_failure_message'] && !(typeof data['last_failure_message'] === 'string' || data['last_failure_message'] instanceof String)) {
+        throw new Error("Expected the field `last_failure_message` to be a primitive type in the JSON string but got " + data['last_failure_message']);
+      }
+      // ensure the json data is a string
+      if (data['disabled_reason'] && !(typeof data['disabled_reason'] === 'string' || data['disabled_reason'] instanceof String)) {
+        throw new Error("Expected the field `disabled_reason` to be a primitive type in the JSON string but got " + data['disabled_reason']);
+      }
+      // validate the optional field `customization`
+      if (data['customization']) {
+        // data not null
+        _EmailActionCustomization["default"].validateJSON(data['customization']);
+      }
+      return true;
+    }
+  }]);
+}();
+EmailAction.RequiredProperties = ["id", "template_id", "template_ids", "folder_ids", "name", "enabled", "to", "cc", "bcc", "from_name", "from_address", "reply_to", "subject", "message", "file_name", "file_formats", "delivery", "max_attachment_mb", "submission_type", "send_when", "failure_notifications_enabled", "consecutive_failures", "failing_since", "last_failure_at", "last_failure_message", "disabled_at", "disabled_reason", "customization", "created_at", "updated_at"];
+
+/**
+ * The email action's ID.
+ * @member {String} id
+ */
+EmailAction.prototype['id'] = undefined;
+
+/**
+ * The ID of the template it belongs to. Null for an account email action, which sends for many templates.
+ * @member {String} template_id
+ */
+EmailAction.prototype['template_id'] = undefined;
+
+/**
+ * For an account email action: the IDs of the templates it sends for. With `folder_ids`, it sends for a template that either list includes. Both empty sends for every template. Always empty for a template's own email action.
+ * @member {Array.<String>} template_ids
+ */
+EmailAction.prototype['template_ids'] = undefined;
+
+/**
+ * For an account email action: the IDs of folders whose templates it sends for, including the templates in the folders inside them. Always empty for a template's own email action.
+ * @member {Array.<String>} folder_ids
+ */
+EmailAction.prototype['folder_ids'] = undefined;
+
+/**
+ * A name for the email action, shown in the dashboard. Null shows its recipients instead.
+ * @member {String} name
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.prototype['to'] = undefined;
+
+/**
+ * Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
+ * @member {Array.<String>} cc
+ */
+EmailAction.prototype['cc'] = undefined;
+
+/**
+ * Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
+ * @member {Array.<String>} bcc
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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
+ */
+EmailAction.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/EmailActionConditions} send_when
+ */
+EmailAction.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
+ */
+EmailAction.prototype['failure_notifications_enabled'] = undefined;
+
+/**
+ * How many emails in a row have failed.
+ * @member {Number} consecutive_failures
+ */
+EmailAction.prototype['consecutive_failures'] = undefined;
+
+/**
+ * When the current run of failures started. Null when the last email was sent.
+ * @member {Date} failing_since
+ */
+EmailAction.prototype['failing_since'] = undefined;
+
+/**
+ * When an email last failed.
+ * @member {Date} last_failure_at
+ */
+EmailAction.prototype['last_failure_at'] = undefined;
+
+/**
+ * Why the last failed email failed.
+ * @member {String} last_failure_message
+ */
+EmailAction.prototype['last_failure_message'] = undefined;
+
+/**
+ * When the email action was turned off. Null while it is on.
+ * @member {Date} disabled_at
+ */
+EmailAction.prototype['disabled_at'] = undefined;
+
+/**
+ * Why DocSpring turned the email action off, such as after 3 days of failed emails or an address that bounced.
+ * @member {String} disabled_reason
+ */
+EmailAction.prototype['disabled_reason'] = undefined;
+
+/**
+ * In a template's list of email actions, its changes to an account email action, or null when it changes nothing. The email action's settings are then the ones it sends for that template. Null everywhere else.
+ * @member {module:model/EmailActionCustomization} customization
+ */
+EmailAction.prototype['customization'] = undefined;
+
+/**
+ * When the email action was created.
+ * @member {Date} created_at
+ */
+EmailAction.prototype['created_at'] = undefined;
+
+/**
+ * When the email action was last changed.
+ * @member {Date} updated_at
+ */
+EmailAction.prototype['updated_at'] = undefined;
+var _default = exports["default"] = EmailAction;