docspring 4.0.0 → 4.2.0

package/dist/model/TemplatePreview.js

@@ -0,0 +1,211 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _PageImage = _interopRequireDefault(require("./PageImage"));
+var _TemplatePreviewState = _interopRequireDefault(require("./TemplatePreviewState"));
+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 programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or 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 TemplatePreview model module.
+ * @module model/TemplatePreview
+ * @version 4.2.0
+ */
+var TemplatePreview = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplatePreview</code>.
+   * PNG images of a template's pages filled in with data you send (not a PDF), to check how an HTML or PDF template prints with your data before you publish a version or send live data. A preview makes no submission and uses no credits. Its pages are watermarked like a test submission's PDF, and it's deleted an hour after it's created.
+   * @alias module:model/TemplatePreview
+   * @extends Object
+   * @param id {String} The preview's ID.
+   * @param template_id {String} The template's ID.
+   * @param version {String} The published version that was rendered, such as `1.2.0`. Null for the draft.
+   * @param state {module:model/TemplatePreviewState} `pending` while it renders (usually a few seconds), then `processed`, or `error` with an `error_message`.
+   * @param error_message {String} Why the preview couldn't be rendered, such as an error in an HTML template's Liquid, or a value in the data that a field can't print.
+   * @param page_count {Number} How many pages the template printed, once it's processed.
+   * @param pages {Array.<module:model/PageImage>} A PNG image of each page once it's processed, in order: `pages[0]` is page 1. A preview has no PDF. Their `download_url`s expire, so get the preview again when you need them.
+   * @param expires_at {Date} When the preview and its images are deleted.
+   */
+  function TemplatePreview(id, template_id, version, state, error_message, page_count, pages, expires_at) {
+    _classCallCheck(this, TemplatePreview);
+    TemplatePreview.initialize(this, id, template_id, version, state, error_message, page_count, pages, expires_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(TemplatePreview, null, [{
+    key: "initialize",
+    value: function initialize(obj, id, template_id, version, state, error_message, page_count, pages, expires_at) {
+      obj['id'] = id;
+      obj['template_id'] = template_id;
+      obj['version'] = version;
+      obj['state'] = state;
+      obj['error_message'] = error_message;
+      obj['page_count'] = page_count;
+      obj['pages'] = pages;
+      obj['expires_at'] = expires_at;
+    }
+
+    /**
+     * Constructs a <code>TemplatePreview</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/TemplatePreview} obj Optional instance to populate.
+     * @return {module:model/TemplatePreview} The populated <code>TemplatePreview</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplatePreview();
+        _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('version')) {
+          obj['version'] = _ApiClient["default"].convertToType(data['version'], 'String');
+        }
+        if (data.hasOwnProperty('state')) {
+          obj['state'] = _ApiClient["default"].convertToType(data['state'], _TemplatePreviewState["default"]);
+        }
+        if (data.hasOwnProperty('error_message')) {
+          obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
+        }
+        if (data.hasOwnProperty('page_count')) {
+          obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
+        }
+        if (data.hasOwnProperty('pages')) {
+          obj['pages'] = _ApiClient["default"].convertToType(data['pages'], [_PageImage["default"]]);
+        }
+        if (data.hasOwnProperty('expires_at')) {
+          obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplatePreview</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>TemplatePreview</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(TemplatePreview.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 a string
+      if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
+        throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
+      }
+      // ensure the json data is a string
+      if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
+        throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['pages'])) {
+        throw new Error("Expected the field `pages` to be an array in the JSON data but got " + data['pages']);
+      }
+      return true;
+    }
+  }]);
+}();
+TemplatePreview.RequiredProperties = ["id", "template_id", "version", "state", "error_message", "page_count", "pages", "expires_at"];
+
+/**
+ * The preview's ID.
+ * @member {String} id
+ */
+TemplatePreview.prototype['id'] = undefined;
+
+/**
+ * The template's ID.
+ * @member {String} template_id
+ */
+TemplatePreview.prototype['template_id'] = undefined;
+
+/**
+ * The published version that was rendered, such as `1.2.0`. Null for the draft.
+ * @member {String} version
+ */
+TemplatePreview.prototype['version'] = undefined;
+
+/**
+ * `pending` while it renders (usually a few seconds), then `processed`, or `error` with an `error_message`.
+ * @member {module:model/TemplatePreviewState} state
+ */
+TemplatePreview.prototype['state'] = undefined;
+
+/**
+ * Why the preview couldn't be rendered, such as an error in an HTML template's Liquid, or a value in the data that a field can't print.
+ * @member {String} error_message
+ */
+TemplatePreview.prototype['error_message'] = undefined;
+
+/**
+ * How many pages the template printed, once it's processed.
+ * @member {Number} page_count
+ */
+TemplatePreview.prototype['page_count'] = undefined;
+
+/**
+ * A PNG image of each page once it's processed, in order: `pages[0]` is page 1. A preview has no PDF. Their `download_url`s expire, so get the preview again when you need them.
+ * @member {Array.<module:model/PageImage>} pages
+ */
+TemplatePreview.prototype['pages'] = undefined;
+
+/**
+ * When the preview and its images are deleted.
+ * @member {Date} expires_at
+ */
+TemplatePreview.prototype['expires_at'] = undefined;
+var _default = exports["default"] = TemplatePreview;

package/dist/model/TemplatePreviewState.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 programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or 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 TemplatePreviewState.
+* @enum {}
+* @readonly
+*/
+var TemplatePreviewState = exports["default"] = /*#__PURE__*/function () {
+  function TemplatePreviewState() {
+    _classCallCheck(this, TemplatePreviewState);
+  }
+  return _createClass(TemplatePreviewState, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>TemplatePreviewState</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/TemplatePreviewState} The enum <code>TemplatePreviewState</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "pending"
+ * @const
+ */
+_defineProperty(TemplatePreviewState, "pending", "pending");
+/**
+ * value: "processed"
+ * @const
+ */
+_defineProperty(TemplatePreviewState, "processed", "processed");
+/**
+ * value: "error"
+ * @const
+ */
+_defineProperty(TemplatePreviewState, "error", "error");

package/dist/model/TemplateSourcePdf.js

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