docspring 3.3.0 → 4.0.0

package/dist/model/UploadMethod.js

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

package/dist/model/{UploadPresignResponse.js → UploadPresign.js}

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _UploadMethod = _interopRequireDefault(require("./UploadMethod"));
 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,22 +28,24 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  *
  */
 /**
- * The UploadPresignResponse model module.
- * @module model/UploadPresignResponse
- * @version 3.3.0
+ * The UploadPresign model module.
+ * @module model/UploadPresign
+ * @version 4.0.0
  */
-var UploadPresignResponse = /*#__PURE__*/function () {
+var UploadPresign = /*#__PURE__*/function () {
   /**
-   * Constructs a new <code>UploadPresignResponse</code>.
-   * @alias module:model/UploadPresignResponse
+   * Constructs a new <code>UploadPresign</code>.
+   * A presigned S3 form for uploading a file. POST `fields` and the file (as `file`, last) to `url` as multipart/form-data. Then use `fields.key` as the `cache_id` when you create a custom file.
+   * @alias module:model/UploadPresign
    * @extends Object
-   * @param fields {Object} 
-   * @param headers {Object} 
-   * @param url {String} 
+   * @param url {String} The S3 URL to upload the file to.
+   * @param method {module:model/UploadMethod} The HTTP method for the upload.
+   * @param fields {Object.<String, String>} Form fields to send with the file. Send them all, as they are. `key` is the uploaded file's ID: pass it as `cache_id`.
+   * @param headers {Object.<String, String>} Headers to send with the upload.
    */
-  function UploadPresignResponse(fields, headers, url) {
-    _classCallCheck(this, UploadPresignResponse);
-    UploadPresignResponse.initialize(this, fields, headers, url);
+  function UploadPresign(url, method, fields, headers) {
+    _classCallCheck(this, UploadPresign);
+    UploadPresign.initialize(this, url, method, fields, headers);
   }
 
   /**
@@ -50,53 +53,58 @@ var UploadPresignResponse = /*#__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(UploadPresignResponse, null, [{
+  return _createClass(UploadPresign, null, [{
     key: "initialize",
-    value: function initialize(obj, fields, headers, url) {
+    value: function initialize(obj, url, method, fields, headers) {
+      obj['url'] = url;
+      obj['method'] = method;
       obj['fields'] = fields;
       obj['headers'] = headers;
-      obj['url'] = url;
     }
 
     /**
-     * Constructs a <code>UploadPresignResponse</code> from a plain JavaScript object, optionally creating a new instance.
+     * Constructs a <code>UploadPresign</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/UploadPresignResponse} obj Optional instance to populate.
-     * @return {module:model/UploadPresignResponse} The populated <code>UploadPresignResponse</code> instance.
+     * @param {module:model/UploadPresign} obj Optional instance to populate.
+     * @return {module:model/UploadPresign} The populated <code>UploadPresign</code> instance.
      */
   }, {
     key: "constructFromObject",
     value: function constructFromObject(data, obj) {
       if (data) {
-        obj = obj || new UploadPresignResponse();
+        obj = obj || new UploadPresign();
         _ApiClient["default"].constructFromObject(data, obj, 'Object');
-        if (data.hasOwnProperty('fields')) {
-          obj['fields'] = _ApiClient["default"].convertToType(data['fields'], Object);
-        }
-        if (data.hasOwnProperty('headers')) {
-          obj['headers'] = _ApiClient["default"].convertToType(data['headers'], Object);
-        }
         if (data.hasOwnProperty('url')) {
           obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
         }
         if (data.hasOwnProperty('method')) {
-          obj['method'] = _ApiClient["default"].convertToType(data['method'], 'String');
+          obj['method'] = _ApiClient["default"].convertToType(data['method'], _UploadMethod["default"]);
+        }
+        if (data.hasOwnProperty('fields')) {
+          obj['fields'] = _ApiClient["default"].convertToType(data['fields'], {
+            'String': 'String'
+          });
+        }
+        if (data.hasOwnProperty('headers')) {
+          obj['headers'] = _ApiClient["default"].convertToType(data['headers'], {
+            'String': 'String'
+          });
         }
       }
       return obj;
     }
 
     /**
-     * Validates the JSON data with respect to <code>UploadPresignResponse</code>.
+     * Validates the JSON data with respect to <code>UploadPresign</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>UploadPresignResponse</code>.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UploadPresign</code>.
      */
   }, {
     key: "validateJSON",
     value: function validateJSON(data) {
       // check to make sure all required properties are present in the JSON string
-      var _iterator = _createForOfIteratorHelper(UploadPresignResponse.RequiredProperties),
+      var _iterator = _createForOfIteratorHelper(UploadPresign.RequiredProperties),
         _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -114,46 +122,33 @@ var UploadPresignResponse = /*#__PURE__*/function () {
       if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
         throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
       }
-      // ensure the json data is a string
-      if (data['method'] && !(typeof data['method'] === 'string' || data['method'] instanceof String)) {
-        throw new Error("Expected the field `method` to be a primitive type in the JSON string but got " + data['method']);
-      }
       return true;
     }
   }]);
 }();
-UploadPresignResponse.RequiredProperties = ["fields", "headers", "url"];
-
-/**
- * @member {Object} fields
- */
-UploadPresignResponse.prototype['fields'] = undefined;
+UploadPresign.RequiredProperties = ["url", "method", "fields", "headers"];
 
 /**
- * @member {Object} headers
+ * The S3 URL to upload the file to.
+ * @member {String} url
  */
-UploadPresignResponse.prototype['headers'] = undefined;
+UploadPresign.prototype['url'] = undefined;
 
 /**
- * @member {String} url
+ * The HTTP method for the upload.
+ * @member {module:model/UploadMethod} method
  */
-UploadPresignResponse.prototype['url'] = undefined;
+UploadPresign.prototype['method'] = undefined;
 
 /**
- * @member {module:model/UploadPresignResponse.MethodEnum} method
+ * Form fields to send with the file. Send them all, as they are. `key` is the uploaded file's ID: pass it as `cache_id`.
+ * @member {Object.<String, String>} fields
  */
-UploadPresignResponse.prototype['method'] = undefined;
+UploadPresign.prototype['fields'] = undefined;
 
 /**
- * Allowed values for the <code>method</code> property.
- * @enum {String}
- * @readonly
+ * Headers to send with the upload.
+ * @member {Object.<String, String>} headers
  */
-UploadPresignResponse['MethodEnum'] = {
-  /**
-   * value: "post"
-   * @const
-   */
-  "post": "post"
-};
-var _default = exports["default"] = UploadPresignResponse;
+UploadPresign.prototype['headers'] = undefined;
+var _default = exports["default"] = UploadPresign;

package/dist/model/{AddFieldsData.js → UrlSourcePdf.js}

@@ -16,9 +16,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 +27,21 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  *
  */
 /**
- * The AddFieldsData model module.
- * @module model/AddFieldsData
- * @version 3.3.0
+ * The UrlSourcePdf model module.
+ * @module model/UrlSourcePdf
+ * @version 4.0.0
  */
-var AddFieldsData = /*#__PURE__*/function () {
+var UrlSourcePdf = /*#__PURE__*/function () {
   /**
-   * Constructs a new <code>AddFieldsData</code>.
-   * @alias module:model/AddFieldsData
-   * @param fields {Array.<Object>} 
+   * Constructs a new <code>UrlSourcePdf</code>.
+   * A PDF to download from a URL and merge.
+   * @alias module:model/UrlSourcePdf
+   * @param type {String} Must be `url`.
+   * @param url {String} For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired.
    */
-  function AddFieldsData(fields) {
-    _classCallCheck(this, AddFieldsData);
-    AddFieldsData.initialize(this, fields);
+  function UrlSourcePdf(type, url) {
+    _classCallCheck(this, UrlSourcePdf);
+    UrlSourcePdf.initialize(this, type, url);
   }
 
   /**
@@ -47,41 +49,45 @@ var AddFieldsData = /*#__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(AddFieldsData, null, [{
+  return _createClass(UrlSourcePdf, null, [{
     key: "initialize",
-    value: function initialize(obj, fields) {
-      obj['fields'] = fields;
+    value: function initialize(obj, type, url) {
+      obj['type'] = type || 'url';
+      obj['url'] = url;
     }
 
     /**
-     * Constructs a <code>AddFieldsData</code> from a plain JavaScript object, optionally creating a new instance.
+     * Constructs a <code>UrlSourcePdf</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/AddFieldsData} obj Optional instance to populate.
-     * @return {module:model/AddFieldsData} The populated <code>AddFieldsData</code> instance.
+     * @param {module:model/UrlSourcePdf} obj Optional instance to populate.
+     * @return {module:model/UrlSourcePdf} The populated <code>UrlSourcePdf</code> instance.
      */
   }, {
     key: "constructFromObject",
     value: function constructFromObject(data, obj) {
       if (data) {
-        obj = obj || new AddFieldsData();
-        if (data.hasOwnProperty('fields')) {
-          obj['fields'] = _ApiClient["default"].convertToType(data['fields'], [Object]);
+        obj = obj || new UrlSourcePdf();
+        if (data.hasOwnProperty('type')) {
+          obj['type'] = _ApiClient["default"].convertToType(data['type'], 'String');
+        }
+        if (data.hasOwnProperty('url')) {
+          obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
         }
       }
       return obj;
     }
 
     /**
-     * Validates the JSON data with respect to <code>AddFieldsData</code>.
+     * Validates the JSON data with respect to <code>UrlSourcePdf</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>AddFieldsData</code>.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UrlSourcePdf</code>.
      */
   }, {
     key: "validateJSON",
     value: function validateJSON(data) {
       // check to make sure all required properties are present in the JSON string
-      var _iterator = _createForOfIteratorHelper(AddFieldsData.RequiredProperties),
+      var _iterator = _createForOfIteratorHelper(UrlSourcePdf.RequiredProperties),
         _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -90,23 +96,35 @@ var AddFieldsData = /*#__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['fields'])) {
-        throw new Error("Expected the field `fields` to be an array in the JSON data but got " + data['fields']);
+      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['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
+        throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
       }
       return true;
     }
   }]);
 }();
-AddFieldsData.RequiredProperties = ["fields"];
+UrlSourcePdf.RequiredProperties = ["type", "url"];
+
+/**
+ * Must be `url`.
+ * @member {String} type
+ * @default 'url'
+ */
+UrlSourcePdf.prototype['type'] = 'url';
 
 /**
- * @member {Array.<Object>} fields
+ * For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired.
+ * @member {String} url
  */
-AddFieldsData.prototype['fields'] = undefined;
-var _default = exports["default"] = AddFieldsData;
+UrlSourcePdf.prototype['url'] = undefined;
+var _default = exports["default"] = UrlSourcePdf;