docspring 3.2.0 → 4.0.0

package/dist/model/TemplatePageProcessingStatus.js

@@ -0,0 +1,162 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _TemplatePageAiError = _interopRequireDefault(require("./TemplatePageAiError"));
+var _TemplatePageAiNamingStatus = _interopRequireDefault(require("./TemplatePageAiNamingStatus"));
+var _TemplatePageFieldsStatus = _interopRequireDefault(require("./TemplatePageFieldsStatus"));
+var _TemplatePageImageStatus = _interopRequireDefault(require("./TemplatePageImageStatus"));
+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 TemplatePageProcessingStatus model module.
+ * @module model/TemplatePageProcessingStatus
+ * @version 4.0.0
+ */
+var TemplatePageProcessingStatus = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplatePageProcessingStatus</code>.
+   * How processing is going on one page of a PDF template's PDF.
+   * @alias module:model/TemplatePageProcessingStatus
+   * @param image {module:model/TemplatePageImageStatus} The page's image, which the template editor shows. `pending` until it's rendered.
+   * @param fields {module:model/TemplatePageFieldsStatus} Setting up the page's fields: `pending` while they're imported or detected, `naming` while AI names them, then `processed` or `failed`. `disabled` when DocSpring doesn't set up the page's fields.
+   * @param ai_naming {module:model/TemplatePageAiNamingStatus} `failed` or `skipped` when AI didn't name the page's fields as asked (`ai_error` says why), and the fields kept plain names. Null otherwise.
+   * @param ai_error {module:model/TemplatePageAiError} Why AI naming failed or was skipped: `unavailable` (the AI service was unavailable: set up the fields again later), `error`, `credits` (the account had no free AI pages or credits left) or `skipped` (someone skipped AI setup in the template editor). Null when `ai_naming` is.
+   * @param detected_boxes {Array.<Array.<Number>>} While AI names the page's fields, the boxes field detection found: `[x, y, width, height]` in PDF points from the page's top-left corner. Null otherwise.
+   */
+  function TemplatePageProcessingStatus(image, fields, ai_naming, ai_error, detected_boxes) {
+    _classCallCheck(this, TemplatePageProcessingStatus);
+    TemplatePageProcessingStatus.initialize(this, image, fields, ai_naming, ai_error, detected_boxes);
+  }
+
+  /**
+   * 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(TemplatePageProcessingStatus, null, [{
+    key: "initialize",
+    value: function initialize(obj, image, fields, ai_naming, ai_error, detected_boxes) {
+      obj['image'] = image;
+      obj['fields'] = fields;
+      obj['ai_naming'] = ai_naming;
+      obj['ai_error'] = ai_error;
+      obj['detected_boxes'] = detected_boxes;
+    }
+
+    /**
+     * Constructs a <code>TemplatePageProcessingStatus</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/TemplatePageProcessingStatus} obj Optional instance to populate.
+     * @return {module:model/TemplatePageProcessingStatus} The populated <code>TemplatePageProcessingStatus</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplatePageProcessingStatus();
+        if (data.hasOwnProperty('image')) {
+          obj['image'] = _ApiClient["default"].convertToType(data['image'], _TemplatePageImageStatus["default"]);
+        }
+        if (data.hasOwnProperty('fields')) {
+          obj['fields'] = _ApiClient["default"].convertToType(data['fields'], _TemplatePageFieldsStatus["default"]);
+        }
+        if (data.hasOwnProperty('ai_naming')) {
+          obj['ai_naming'] = _ApiClient["default"].convertToType(data['ai_naming'], _TemplatePageAiNamingStatus["default"]);
+        }
+        if (data.hasOwnProperty('ai_error')) {
+          obj['ai_error'] = _ApiClient["default"].convertToType(data['ai_error'], _TemplatePageAiError["default"]);
+        }
+        if (data.hasOwnProperty('detected_boxes')) {
+          obj['detected_boxes'] = _ApiClient["default"].convertToType(data['detected_boxes'], [['Number']]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplatePageProcessingStatus</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>TemplatePageProcessingStatus</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(TemplatePageProcessingStatus.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['detected_boxes'])) {
+        throw new Error("Expected the field `detected_boxes` to be an array in the JSON data but got " + data['detected_boxes']);
+      }
+      return true;
+    }
+  }]);
+}();
+TemplatePageProcessingStatus.RequiredProperties = ["image", "fields", "ai_naming", "ai_error", "detected_boxes"];
+
+/**
+ * The page's image, which the template editor shows. `pending` until it's rendered.
+ * @member {module:model/TemplatePageImageStatus} image
+ */
+TemplatePageProcessingStatus.prototype['image'] = undefined;
+
+/**
+ * Setting up the page's fields: `pending` while they're imported or detected, `naming` while AI names them, then `processed` or `failed`. `disabled` when DocSpring doesn't set up the page's fields.
+ * @member {module:model/TemplatePageFieldsStatus} fields
+ */
+TemplatePageProcessingStatus.prototype['fields'] = undefined;
+
+/**
+ * `failed` or `skipped` when AI didn't name the page's fields as asked (`ai_error` says why), and the fields kept plain names. Null otherwise.
+ * @member {module:model/TemplatePageAiNamingStatus} ai_naming
+ */
+TemplatePageProcessingStatus.prototype['ai_naming'] = undefined;
+
+/**
+ * Why AI naming failed or was skipped: `unavailable` (the AI service was unavailable: set up the fields again later), `error`, `credits` (the account had no free AI pages or credits left) or `skipped` (someone skipped AI setup in the template editor). Null when `ai_naming` is.
+ * @member {module:model/TemplatePageAiError} ai_error
+ */
+TemplatePageProcessingStatus.prototype['ai_error'] = undefined;
+
+/**
+ * While AI names the page's fields, the boxes field detection found: `[x, y, width, height]` in PDF points from the page's top-left corner. Null otherwise.
+ * @member {Array.<Array.<Number>>} detected_boxes
+ */
+TemplatePageProcessingStatus.prototype['detected_boxes'] = undefined;
+var _default = exports["default"] = TemplatePageProcessingStatus;

package/dist/model/{SubmissionBatchData.js → TemplateSourcePdf.js}

@@ -18,7 +18,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  * 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: v1
+ * The version of the OpenAPI document: v2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,19 +27,21 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  *
  */
 /**
- * The SubmissionBatchData model module.
- * @module model/SubmissionBatchData
- * @version 3.2.0
+ * The TemplateSourcePdf model module.
+ * @module model/TemplateSourcePdf
+ * @version 4.0.0
  */
-var SubmissionBatchData = /*#__PURE__*/function () {
+var TemplateSourcePdf = /*#__PURE__*/function () {
   /**
-   * Constructs a new <code>SubmissionBatchData</code>.
-   * @alias module:model/SubmissionBatchData
-   * @param submissions {Array.<Object>} 
+   * Constructs a new <code>TemplateSourcePdf</code>.
+   * A template's PDF to merge.
+   * @alias module:model/TemplateSourcePdf
+   * @param type {String} Must be `template`.
+   * @param id {String} The ID of the submission, combined PDF, template or custom file.
    */
-  function SubmissionBatchData(submissions) {
-    _classCallCheck(this, SubmissionBatchData);
-    SubmissionBatchData.initialize(this, submissions);
+  function TemplateSourcePdf(type, id) {
+    _classCallCheck(this, TemplateSourcePdf);
+    TemplateSourcePdf.initialize(this, type, id);
   }
 
   /**
@@ -47,53 +49,51 @@ var SubmissionBatchData = /*#__PURE__*/function () {
    * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
    * Only for internal use.
    */
-  return _createClass(SubmissionBatchData, null, [{
+  return _createClass(TemplateSourcePdf, null, [{
     key: "initialize",
-    value: function initialize(obj, submissions) {
-      obj['submissions'] = submissions;
+    value: function initialize(obj, type, id) {
+      obj['type'] = type || 'template';
+      obj['id'] = id;
     }
 
     /**
-     * Constructs a <code>SubmissionBatchData</code> from a plain JavaScript object, optionally creating a new instance.
+     * Constructs a <code>TemplateSourcePdf</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/SubmissionBatchData} obj Optional instance to populate.
-     * @return {module:model/SubmissionBatchData} The populated <code>SubmissionBatchData</code> instance.
+     * @param {module:model/TemplateSourcePdf} obj Optional instance to populate.
+     * @return {module:model/TemplateSourcePdf} The populated <code>TemplateSourcePdf</code> instance.
      */
   }, {
     key: "constructFromObject",
     value: function constructFromObject(data, obj) {
       if (data) {
-        obj = obj || new SubmissionBatchData();
-        if (data.hasOwnProperty('metadata')) {
-          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
+        obj = obj || new TemplateSourcePdf();
+        if (data.hasOwnProperty('type')) {
+          obj['type'] = _ApiClient["default"].convertToType(data['type'], 'String');
         }
-        if (data.hasOwnProperty('submissions')) {
-          obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [Object]);
-        }
-        if (data.hasOwnProperty('template_id')) {
-          obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
         }
         if (data.hasOwnProperty('template_version')) {
           obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
         }
-        if (data.hasOwnProperty('test')) {
-          obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
+        if (data.hasOwnProperty('processed')) {
+          obj['processed'] = _ApiClient["default"].convertToType(data['processed'], 'Boolean');
         }
       }
       return obj;
     }
 
     /**
-     * Validates the JSON data with respect to <code>SubmissionBatchData</code>.
+     * Validates the JSON data with respect to <code>TemplateSourcePdf</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>SubmissionBatchData</code>.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateSourcePdf</code>.
      */
   }, {
     key: "validateJSON",
     value: function validateJSON(data) {
       // check to make sure all required properties are present in the JSON string
-      var _iterator = _createForOfIteratorHelper(SubmissionBatchData.RequiredProperties),
+      var _iterator = _createForOfIteratorHelper(TemplateSourcePdf.RequiredProperties),
         _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -102,18 +102,18 @@ var SubmissionBatchData = /*#__PURE__*/function () {
             throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
           }
         }
-        // ensure the json data is an array
+        // ensure the json data is a string
       } catch (err) {
         _iterator.e(err);
       } finally {
         _iterator.f();
       }
-      if (!Array.isArray(data['submissions'])) {
-        throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
+      if (data['type'] && !(typeof data['type'] === 'string' || data['type'] instanceof String)) {
+        throw new Error("Expected the field `type` to be a primitive type in the JSON string but got " + data['type']);
       }
       // 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']);
+      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_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
@@ -123,30 +123,30 @@ var SubmissionBatchData = /*#__PURE__*/function () {
     }
   }]);
 }();
-SubmissionBatchData.RequiredProperties = ["submissions"];
-
-/**
- * @member {Object} metadata
- */
-SubmissionBatchData.prototype['metadata'] = undefined;
+TemplateSourcePdf.RequiredProperties = ["type", "id"];
 
 /**
- * @member {Array.<Object>} submissions
+ * Must be `template`.
+ * @member {String} type
+ * @default 'template'
  */
-SubmissionBatchData.prototype['submissions'] = undefined;
+TemplateSourcePdf.prototype['type'] = 'template';
 
 /**
- * @member {String} template_id
+ * The ID of the submission, combined PDF, template or custom file.
+ * @member {String} id
  */
-SubmissionBatchData.prototype['template_id'] = undefined;
+TemplateSourcePdf.prototype['id'] = undefined;
 
 /**
+ * For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
  * @member {String} template_version
  */
-SubmissionBatchData.prototype['template_version'] = undefined;
+TemplateSourcePdf.prototype['template_version'] = undefined;
 
 /**
- * @member {Boolean} test
+ * For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded.
+ * @member {Boolean} processed
  */
-SubmissionBatchData.prototype['test'] = undefined;
-var _default = exports["default"] = SubmissionBatchData;
+TemplateSourcePdf.prototype['processed'] = undefined;
+var _default = exports["default"] = TemplateSourcePdf;