docspring 3.3.0 → 4.1.0

package/dist/model/SubmissionSourcePdf.js

@@ -0,0 +1,130 @@
+"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 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 SubmissionSourcePdf model module.
+ * @module model/SubmissionSourcePdf
+ * @version 4.1.0
+ */
+var SubmissionSourcePdf = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>SubmissionSourcePdf</code>.
+   * A submission's PDF to merge.
+   * @alias module:model/SubmissionSourcePdf
+   * @param type {String} Must be `submission`.
+   * @param id {String} The ID of the submission, combined PDF, template or custom file.
+   */
+  function SubmissionSourcePdf(type, id) {
+    _classCallCheck(this, SubmissionSourcePdf);
+    SubmissionSourcePdf.initialize(this, type, id);
+  }
+
+  /**
+   * 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(SubmissionSourcePdf, null, [{
+    key: "initialize",
+    value: function initialize(obj, type, id) {
+      obj['type'] = type || 'submission';
+      obj['id'] = id;
+    }
+
+    /**
+     * Constructs a <code>SubmissionSourcePdf</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/SubmissionSourcePdf} obj Optional instance to populate.
+     * @return {module:model/SubmissionSourcePdf} The populated <code>SubmissionSourcePdf</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new SubmissionSourcePdf();
+        if (data.hasOwnProperty('type')) {
+          obj['type'] = _ApiClient["default"].convertToType(data['type'], 'String');
+        }
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>SubmissionSourcePdf</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>SubmissionSourcePdf</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(SubmissionSourcePdf.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['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['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']);
+      }
+      return true;
+    }
+  }]);
+}();
+SubmissionSourcePdf.RequiredProperties = ["type", "id"];
+
+/**
+ * Must be `submission`.
+ * @member {String} type
+ * @default 'submission'
+ */
+SubmissionSourcePdf.prototype['type'] = 'submission';
+
+/**
+ * The ID of the submission, combined PDF, template or custom file.
+ * @member {String} id
+ */
+SubmissionSourcePdf.prototype['id'] = undefined;
+var _default = exports["default"] = SubmissionSourcePdf;

package/dist/model/SubmissionState.js

@@ -0,0 +1,114 @@
+"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 SubmissionState.
+* @enum {}
+* @readonly
+*/
+var SubmissionState = exports["default"] = /*#__PURE__*/function () {
+  function SubmissionState() {
+    _classCallCheck(this, SubmissionState);
+  }
+  return _createClass(SubmissionState, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>SubmissionState</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/SubmissionState} The enum <code>SubmissionState</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "pending"
+ * @const
+ */
+_defineProperty(SubmissionState, "pending", "pending");
+/**
+ * value: "processed"
+ * @const
+ */
+_defineProperty(SubmissionState, "processed", "processed");
+/**
+ * value: "invalid_data"
+ * @const
+ */
+_defineProperty(SubmissionState, "invalid_data", "invalid_data");
+/**
+ * value: "error"
+ * @const
+ */
+_defineProperty(SubmissionState, "error", "error");
+/**
+ * value: "image_download_failed"
+ * @const
+ */
+_defineProperty(SubmissionState, "image_download_failed", "image_download_failed");
+/**
+ * value: "image_processing_failed"
+ * @const
+ */
+_defineProperty(SubmissionState, "image_processing_failed", "image_processing_failed");
+/**
+ * value: "waiting_for_signature_requests"
+ * @const
+ */
+_defineProperty(SubmissionState, "waiting_for_signature_requests", "waiting_for_signature_requests");
+/**
+ * value: "syntax_error"
+ * @const
+ */
+_defineProperty(SubmissionState, "syntax_error", "syntax_error");
+/**
+ * value: "insufficient_credits"
+ * @const
+ */
+_defineProperty(SubmissionState, "insufficient_credits", "insufficient_credits");
+/**
+ * value: "account_suspended"
+ * @const
+ */
+_defineProperty(SubmissionState, "account_suspended", "account_suspended");
+/**
+ * value: "license_revoked"
+ * @const
+ */
+_defineProperty(SubmissionState, "license_revoked", "license_revoked");
+/**
+ * value: "accidental"
+ * @const
+ */
+_defineProperty(SubmissionState, "accidental", "accidental");
+/**
+ * value: "declined"
+ * @const
+ */
+_defineProperty(SubmissionState, "declined", "declined");

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

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _ErrorInfo = _interopRequireDefault(require("./ErrorInfo"));
 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; } } }; }
@@ -16,9 +17,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
  * DocSpring API
- * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
+ * 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 +28,23 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  *
  */
 /**
- * The SubmissionBatchData model module.
- * @module model/SubmissionBatchData
- * @version 3.3.0
+ * The SubmissionValidation model module.
+ * @module model/SubmissionValidation
+ * @version 4.1.0
  */
-var SubmissionBatchData = /*#__PURE__*/function () {
+var SubmissionValidation = /*#__PURE__*/function () {
   /**
-   * Constructs a new <code>SubmissionBatchData</code>.
-   * @alias module:model/SubmissionBatchData
-   * @param submissions {Array.<Object>} 
+   * Constructs a new <code>SubmissionValidation</code>.
+   * Whether creating the submission would succeed, checked without saving it or making any files. `error` is the error that creating it would return (`validation_failed`, or `invalid_data` for data that doesn't match the template's fields), and is left out when `valid` is true.
+   * @alias module:model/SubmissionValidation
+   * @extends Object
+   * @param valid {Boolean} True when creating the submission would succeed.
+   * @param template_id {String} The template's ID.
+   * @param template_version {String} The published version the request was checked against, such as `1.2.0`. Null for the draft.
    */
-  function SubmissionBatchData(submissions) {
-    _classCallCheck(this, SubmissionBatchData);
-    SubmissionBatchData.initialize(this, submissions);
+  function SubmissionValidation(valid, template_id, template_version) {
+    _classCallCheck(this, SubmissionValidation);
+    SubmissionValidation.initialize(this, valid, template_id, template_version);
   }
 
   /**
@@ -47,29 +52,29 @@ 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(SubmissionValidation, null, [{
     key: "initialize",
-    value: function initialize(obj, submissions) {
-      obj['submissions'] = submissions;
+    value: function initialize(obj, valid, template_id, template_version) {
+      obj['valid'] = valid;
+      obj['template_id'] = template_id;
+      obj['template_version'] = template_version;
     }
 
     /**
-     * Constructs a <code>SubmissionBatchData</code> from a plain JavaScript object, optionally creating a new instance.
+     * Constructs a <code>SubmissionValidation</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/SubmissionValidation} obj Optional instance to populate.
+     * @return {module:model/SubmissionValidation} The populated <code>SubmissionValidation</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);
-        }
-        if (data.hasOwnProperty('submissions')) {
-          obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [Object]);
+        obj = obj || new SubmissionValidation();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('valid')) {
+          obj['valid'] = _ApiClient["default"].convertToType(data['valid'], 'Boolean');
         }
         if (data.hasOwnProperty('template_id')) {
           obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
@@ -77,23 +82,23 @@ var SubmissionBatchData = /*#__PURE__*/function () {
         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('error')) {
+          obj['error'] = data['error'] === null ? null : _ErrorInfo["default"].constructFromObject(data['error']);
         }
       }
       return obj;
     }
 
     /**
-     * Validates the JSON data with respect to <code>SubmissionBatchData</code>.
+     * Validates the JSON data with respect to <code>SubmissionValidation</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>SubmissionValidation</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(SubmissionValidation.RequiredProperties),
         _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -102,16 +107,12 @@ 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']);
-      }
-      // 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']);
       }
@@ -123,31 +124,28 @@ var SubmissionBatchData = /*#__PURE__*/function () {
     }
   }]);
 }();
-SubmissionBatchData.RequiredProperties = ["submissions"];
-
-/**
- * @member {Object} metadata
- */
-SubmissionBatchData.prototype['metadata'] = undefined;
+SubmissionValidation.RequiredProperties = ["valid", "template_id", "template_version"];
 
 /**
- * @member {Array.<Object>} submissions
+ * True when creating the submission would succeed.
+ * @member {Boolean} valid
  */
-SubmissionBatchData.prototype['submissions'] = undefined;
+SubmissionValidation.prototype['valid'] = undefined;
 
 /**
+ * The template's ID.
  * @member {String} template_id
  */
-SubmissionBatchData.prototype['template_id'] = undefined;
+SubmissionValidation.prototype['template_id'] = undefined;
 
 /**
+ * The published version the request was checked against, such as `1.2.0`. Null for the draft.
  * @member {String} template_version
  */
-SubmissionBatchData.prototype['template_version'] = undefined;
+SubmissionValidation.prototype['template_version'] = undefined;
 
 /**
- * Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits.
- * @member {Boolean} test
+ * @member {module:model/ErrorInfo} error
  */
-SubmissionBatchData.prototype['test'] = undefined;
-var _default = exports["default"] = SubmissionBatchData;
+SubmissionValidation.prototype['error'] = undefined;
+var _default = exports["default"] = SubmissionValidation;