docspring 4.3.0 → 4.4.0

package/dist/model/EmailActionList.js

@@ -0,0 +1,132 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _EmailAction = _interopRequireDefault(require("./EmailAction"));
+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 EmailActionList model module.
+ * @module model/EmailActionList
+ * @version 4.4.0
+ */
+var EmailActionList = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>EmailActionList</code>.
+   * A page of a template's email actions, newest first.
+   * @alias module:model/EmailActionList
+   * @extends Object
+   * @param data {Array.<module:model/EmailAction>} The items on this page.
+   * @param next_cursor {String} Pass it as `cursor` to get the next page. Null on the last page.
+   */
+  function EmailActionList(data, next_cursor) {
+    _classCallCheck(this, EmailActionList);
+    EmailActionList.initialize(this, data, next_cursor);
+  }
+
+  /**
+   * 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(EmailActionList, null, [{
+    key: "initialize",
+    value: function initialize(obj, data, next_cursor) {
+      obj['data'] = data;
+      obj['next_cursor'] = next_cursor;
+    }
+
+    /**
+     * Constructs a <code>EmailActionList</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/EmailActionList} obj Optional instance to populate.
+     * @return {module:model/EmailActionList} The populated <code>EmailActionList</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new EmailActionList();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], [_EmailAction["default"]]);
+        }
+        if (data.hasOwnProperty('next_cursor')) {
+          obj['next_cursor'] = _ApiClient["default"].convertToType(data['next_cursor'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>EmailActionList</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>EmailActionList</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(EmailActionList.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 an array
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (!Array.isArray(data['data'])) {
+        throw new Error("Expected the field `data` to be an array in the JSON data but got " + data['data']);
+      }
+      // ensure the json data is a string
+      if (data['next_cursor'] && !(typeof data['next_cursor'] === 'string' || data['next_cursor'] instanceof String)) {
+        throw new Error("Expected the field `next_cursor` to be a primitive type in the JSON string but got " + data['next_cursor']);
+      }
+      return true;
+    }
+  }]);
+}();
+EmailActionList.RequiredProperties = ["data", "next_cursor"];
+
+/**
+ * The items on this page.
+ * @member {Array.<module:model/EmailAction>} data
+ */
+EmailActionList.prototype['data'] = undefined;
+
+/**
+ * Pass it as `cursor` to get the next page. Null on the last page.
+ * @member {String} next_cursor
+ */
+EmailActionList.prototype['next_cursor'] = undefined;
+var _default = exports["default"] = EmailActionList;

package/dist/model/EmailActionSetting.js

@@ -0,0 +1,119 @@
+"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 EmailActionSetting.
+* @enum {}
+* @readonly
+*/
+var EmailActionSetting = exports["default"] = /*#__PURE__*/function () {
+  function EmailActionSetting() {
+    _classCallCheck(this, EmailActionSetting);
+  }
+  return _createClass(EmailActionSetting, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>EmailActionSetting</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/EmailActionSetting} The enum <code>EmailActionSetting</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "to"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "to", "to");
+/**
+ * value: "cc"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "cc", "cc");
+/**
+ * value: "bcc"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "bcc", "bcc");
+/**
+ * value: "from_name"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "from_name", "from_name");
+/**
+ * value: "from_address"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "from_address", "from_address");
+/**
+ * value: "reply_to"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "reply_to", "reply_to");
+/**
+ * value: "subject"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "subject", "subject");
+/**
+ * value: "message"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "message", "message");
+/**
+ * value: "file_name"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "file_name", "file_name");
+/**
+ * value: "file_formats"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "file_formats", "file_formats");
+/**
+ * value: "delivery"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "delivery", "delivery");
+/**
+ * value: "max_attachment_mb"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "max_attachment_mb", "max_attachment_mb");
+/**
+ * value: "submission_type"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "submission_type", "submission_type");
+/**
+ * value: "send_when"
+ * @const
+ */
+_defineProperty(EmailActionSetting, "send_when", "send_when");

package/dist/model/EmailActionSubmissionType.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 EmailActionSubmissionType.
+* @enum {}
+* @readonly
+*/
+var EmailActionSubmissionType = exports["default"] = /*#__PURE__*/function () {
+  function EmailActionSubmissionType() {
+    _classCallCheck(this, EmailActionSubmissionType);
+  }
+  return _createClass(EmailActionSubmissionType, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>EmailActionSubmissionType</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/EmailActionSubmissionType} The enum <code>EmailActionSubmissionType</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "live"
+ * @const
+ */
+_defineProperty(EmailActionSubmissionType, "live", "live");
+/**
+ * value: "test"
+ * @const
+ */
+_defineProperty(EmailActionSubmissionType, "test", "test");
+/**
+ * value: "all"
+ * @const
+ */
+_defineProperty(EmailActionSubmissionType, "all", "all");

package/dist/model/EmailActionTestEmail.js

@@ -0,0 +1,116 @@
+"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 _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 EmailActionTestEmail model module.
+ * @module model/EmailActionTestEmail
+ * @version 4.4.0
+ */
+var EmailActionTestEmail = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>EmailActionTestEmail</code>.
+   * A test email that was sent.
+   * @alias module:model/EmailActionTestEmail
+   * @extends Object
+   * @param sent_to {String} The address the test email went to, the email address of the API token's user.
+   */
+  function EmailActionTestEmail(sent_to) {
+    _classCallCheck(this, EmailActionTestEmail);
+    EmailActionTestEmail.initialize(this, sent_to);
+  }
+
+  /**
+   * 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(EmailActionTestEmail, null, [{
+    key: "initialize",
+    value: function initialize(obj, sent_to) {
+      obj['sent_to'] = sent_to;
+    }
+
+    /**
+     * Constructs a <code>EmailActionTestEmail</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/EmailActionTestEmail} obj Optional instance to populate.
+     * @return {module:model/EmailActionTestEmail} The populated <code>EmailActionTestEmail</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new EmailActionTestEmail();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('sent_to')) {
+          obj['sent_to'] = _ApiClient["default"].convertToType(data['sent_to'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>EmailActionTestEmail</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>EmailActionTestEmail</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(EmailActionTestEmail.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['sent_to'] && !(typeof data['sent_to'] === 'string' || data['sent_to'] instanceof String)) {
+        throw new Error("Expected the field `sent_to` to be a primitive type in the JSON string but got " + data['sent_to']);
+      }
+      return true;
+    }
+  }]);
+}();
+EmailActionTestEmail.RequiredProperties = ["sent_to"];
+
+/**
+ * The address the test email went to, the email address of the API token's user.
+ * @member {String} sent_to
+ */
+EmailActionTestEmail.prototype['sent_to'] = undefined;
+var _default = exports["default"] = EmailActionTestEmail;