docspring 3.2.0 → 3.3.0

package/README.md

@@ -6,7 +6,7 @@ templates with your data, generates PDFs from HTML templates, combines PDFs and
 [Documentation](https://docspring.com/docs/) · [API reference](https://docspring.com/docs/api/) ·
 [npm](https://www.npmjs.com/package/docspring) · [Changelog](https://github.com/DocSpring/docspring-javascript/blob/main/CHANGELOG.md)
 
-Version 3.2.0. 
+Version 3.3.0. 
 
 ## Install and configure
 

package/dist/ApiClient.js

@@ -13,7 +13,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -25,7 +25,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  */
 /**
 * @module ApiClient
-* @version 3.2.0
+* @version 3.3.0
 */
 /**
 * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
@@ -66,7 +66,7 @@ var ApiClient = /*#__PURE__*/function () {
             * @default {}
             */
     this.defaultHeaders = {
-      'User-Agent': 'docspring-javascript-3.2.0'
+      'User-Agent': 'docspring-javascript-3.3.0'
     };
 
     /**

package/dist/api/Client.js

@@ -26,6 +26,7 @@ var _CreateWebhookData = _interopRequireDefault(require("../model/CreateWebhookD
 var _ErrorOrMultipleErrorsResponse = _interopRequireDefault(require("../model/ErrorOrMultipleErrorsResponse"));
 var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
 var _Folder = _interopRequireDefault(require("../model/Folder"));
+var _ForbiddenErrorResponse = _interopRequireDefault(require("../model/ForbiddenErrorResponse"));
 var _JsonSchema = _interopRequireDefault(require("../model/JsonSchema"));
 var _ListSubmissionsResponse = _interopRequireDefault(require("../model/ListSubmissionsResponse"));
 var _MoveFolderData = _interopRequireDefault(require("../model/MoveFolderData"));
@@ -62,7 +63,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -75,7 +76,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
 * Client service.
 * @module api/Client
-* @version 3.2.0
+* @version 3.3.0
 */
 var Client = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -171,7 +172,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Generate multiple PDFs
-     * Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs.  See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits 
+     * Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs.  Live PDFs use credits. If any live submission is waiting for credits, the API returns 402 and the others are still processed: check each submission's `state`. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).  See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits 
      * @param {module:model/SubmissionBatchData} data 
      * @param {Object} opts Optional parameters
      * @param {Boolean} [wait = true)] Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
@@ -210,7 +211,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Merge submission PDFs, template PDFs, or custom files
-     * Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided. 
+     * Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided.  Combining uses credits (4 per source PDF, plus 4 per unit of the combined PDF), even with a test API token or watermarked source PDFs. If your balance can't cover it, the API returns 402 and the combined submission waits in the `insufficient_credits` state until you add credits. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/). 
      * @param {module:model/CombinePdfsData} data 
      * @param {module:api/Client~combinePdfsCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CreateCombinedSubmissionResponse}
@@ -771,7 +772,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Generate a PDF
-     * Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the `wait=false` query parameter to return immediately.  See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn't fit in fields 
+     * Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the `wait=false` query parameter to return immediately.  Live PDFs use credits; test PDFs (`test: true`) are free and watermarked. If your balance can't cover a live PDF, the API returns 402 and the submission waits in the `insufficient_credits` state until you add credits. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).  See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn't fit in fields 
      * @param {String} template_id 
      * @param {module:model/CreatePdfSubmissionData} submission 
      * @param {Object} opts Optional parameters
@@ -853,7 +854,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Check the status of a combined submission (merged PDFs)
-     * Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads). 
+     * Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads).  `insufficient_credits` means the combined submission is waiting for credits and is processed once you add them. If it's still waiting after 30 days, it moves to `error`. 
      * @param {String} combined_submission_id 
      * @param {module:api/Client~getCombinedSubmissionCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CombinedSubmission}
@@ -990,7 +991,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Check the status of a PDF
-     * Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing. 
+     * Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing.  `insufficient_credits` means the submission is waiting for credits and is processed once you add them. If it's still waiting after 30 days, it moves to `error`. 
      * @param {String} submission_id 
      * @param {Object} opts Optional parameters
      * @param {Boolean} [include_data] 
@@ -1031,7 +1032,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Check the status of a submission batch job
-     * Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing. 
+     * Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing.  Submissions waiting for credits are in the `insufficient_credits` state and count as pending, so the batch stays `pending` until you add credits or they stop waiting after 30 days. 
      * @param {String} submission_batch_id 
      * @param {Object} opts Optional parameters
      * @param {Boolean} [include_submissions] 

package/dist/index.js

@@ -159,6 +159,12 @@ Object.defineProperty(exports, "Folder", {
     return _Folder["default"];
   }
 });
+Object.defineProperty(exports, "ForbiddenErrorResponse", {
+  enumerable: true,
+  get: function get() {
+    return _ForbiddenErrorResponse["default"];
+  }
+});
 Object.defineProperty(exports, "JsonSchema", {
   enumerable: true,
   get: function get() {
@@ -382,6 +388,7 @@ var _CustomFile = _interopRequireDefault(require("./model/CustomFile"));
 var _ErrorOrMultipleErrorsResponse = _interopRequireDefault(require("./model/ErrorOrMultipleErrorsResponse"));
 var _ErrorResponse = _interopRequireDefault(require("./model/ErrorResponse"));
 var _Folder = _interopRequireDefault(require("./model/Folder"));
+var _ForbiddenErrorResponse = _interopRequireDefault(require("./model/ForbiddenErrorResponse"));
 var _JsonSchema = _interopRequireDefault(require("./model/JsonSchema"));
 var _ListSubmissionsResponse = _interopRequireDefault(require("./model/ListSubmissionsResponse"));
 var _MoveFolderData = _interopRequireDefault(require("./model/MoveFolderData"));

package/dist/model/AddFieldsData.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The AddFieldsData model module.
  * @module model/AddFieldsData
- * @version 3.2.0
+ * @version 3.3.0
  */
 var AddFieldsData = /*#__PURE__*/function () {
   /**

package/dist/model/BatchGeneratePdfs201Response.js

@@ -17,7 +17,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The BatchGeneratePdfs201Response model module.
  * @module model/BatchGeneratePdfs201Response
- * @version 3.2.0
+ * @version 3.3.0
  */
 var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
   /**
@@ -87,6 +87,9 @@ var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
         if (data.hasOwnProperty('submissions')) {
           obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [Object]);
         }
+        if (data.hasOwnProperty('code')) {
+          obj['code'] = _ApiClient["default"].convertToType(data['code'], 'String');
+        }
       }
       return obj;
     }
@@ -130,6 +133,10 @@ var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
       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['code'] && !(typeof data['code'] === 'string' || data['code'] instanceof String)) {
+        throw new Error("Expected the field `code` to be a primitive type in the JSON string but got " + data['code']);
+      }
       return true;
     }
   }]);
@@ -161,6 +168,12 @@ BatchGeneratePdfs201Response.prototype['submission_batch'] = undefined;
  */
 BatchGeneratePdfs201Response.prototype['submissions'] = undefined;
 
+/**
+ * `insufficient_credits` when the response is a 402.
+ * @member {String} code
+ */
+BatchGeneratePdfs201Response.prototype['code'] = undefined;
+
 /**
  * Allowed values for the <code>status</code> property.
  * @enum {String}

package/dist/model/CombinePdfsData.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinePdfsData model module.
  * @module model/CombinePdfsData
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CombinePdfsData = /*#__PURE__*/function () {
   /**
@@ -151,7 +151,7 @@ CombinePdfsData.prototype['password'] = undefined;
 CombinePdfsData.prototype['source_pdfs'] = undefined;
 
 /**
- * Deprecated, and has no effect. A combined PDF is a test or live document because of its source PDFs.
+ * Deprecated, and has no effect. Combining always uses credits, even with a test API token or watermarked source PDFs.
  * @member {Boolean} test
  */
 CombinePdfsData.prototype['test'] = undefined;

package/dist/model/CombinedSubmission.js

@@ -17,7 +17,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinedSubmission model module.
  * @module model/CombinedSubmission
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CombinedSubmission = /*#__PURE__*/function () {
   /**
@@ -303,6 +303,11 @@ CombinedSubmission['StateEnum'] = {
    * value: "error"
    * @const
    */
-  "error": "error"
+  "error": "error",
+  /**
+   * value: "insufficient_credits"
+   * @const
+   */
+  "insufficient_credits": "insufficient_credits"
 };
 var _default = exports["default"] = CombinedSubmission;

package/dist/model/CombinedSubmissionAction.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinedSubmissionAction model module.
  * @module model/CombinedSubmissionAction
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CombinedSubmissionAction = /*#__PURE__*/function () {
   /**

package/dist/model/CopyTemplateOptions.js

@@ -13,7 +13,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CopyTemplateOptions model module.
  * @module model/CopyTemplateOptions
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CopyTemplateOptions = /*#__PURE__*/function () {
   /**

package/dist/model/CreateCombinedSubmissionResponse.js

@@ -17,7 +17,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateCombinedSubmissionResponse model module.
  * @module model/CreateCombinedSubmissionResponse
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
   /**
@@ -76,9 +76,15 @@ var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
         if (data.hasOwnProperty('combined_submission')) {
           obj['combined_submission'] = _CombinedSubmission["default"].constructFromObject(data['combined_submission']);
         }
+        if (data.hasOwnProperty('error')) {
+          obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
+        }
         if (data.hasOwnProperty('errors')) {
           obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
         }
+        if (data.hasOwnProperty('code')) {
+          obj['code'] = _ApiClient["default"].convertToType(data['code'], 'String');
+        }
       }
       return obj;
     }
@@ -110,10 +116,18 @@ var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
       if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
         throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
       }
+      // ensure the json data is a string
+      if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
+        throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
+      }
       // ensure the json data is an array
       if (!Array.isArray(data['errors'])) {
         throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
       }
+      // ensure the json data is a string
+      if (data['code'] && !(typeof data['code'] === 'string' || data['code'] instanceof String)) {
+        throw new Error("Expected the field `code` to be a primitive type in the JSON string but got " + data['code']);
+      }
       return true;
     }
   }]);
@@ -130,11 +144,22 @@ CreateCombinedSubmissionResponse.prototype['status'] = undefined;
  */
 CreateCombinedSubmissionResponse.prototype['combined_submission'] = undefined;
 
+/**
+ * @member {String} error
+ */
+CreateCombinedSubmissionResponse.prototype['error'] = undefined;
+
 /**
  * @member {Array.<String>} errors
  */
 CreateCombinedSubmissionResponse.prototype['errors'] = undefined;
 
+/**
+ * `insufficient_credits` when the response is a 402.
+ * @member {String} code
+ */
+CreateCombinedSubmissionResponse.prototype['code'] = undefined;
+
 /**
  * Allowed values for the <code>status</code> property.
  * @enum {String}

package/dist/model/CreateCustomFileData.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateCustomFileData model module.
  * @module model/CreateCustomFileData
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreateCustomFileData = /*#__PURE__*/function () {
   /**

package/dist/model/CreateCustomFileResponse.js

@@ -17,7 +17,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateCustomFileResponse model module.
  * @module model/CreateCustomFileResponse
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreateCustomFileResponse = /*#__PURE__*/function () {
   /**
@@ -76,6 +76,9 @@ var CreateCustomFileResponse = /*#__PURE__*/function () {
         if (data.hasOwnProperty('custom_file')) {
           obj['custom_file'] = _CustomFile["default"].constructFromObject(data['custom_file']);
         }
+        if (data.hasOwnProperty('error')) {
+          obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
+        }
         if (data.hasOwnProperty('errors')) {
           obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
         }
@@ -110,6 +113,10 @@ var CreateCustomFileResponse = /*#__PURE__*/function () {
       if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
         throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
       }
+      // ensure the json data is a string
+      if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
+        throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
+      }
       // ensure the json data is an array
       if (!Array.isArray(data['errors'])) {
         throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
@@ -130,6 +137,11 @@ CreateCustomFileResponse.prototype['status'] = undefined;
  */
 CreateCustomFileResponse.prototype['custom_file'] = undefined;
 
+/**
+ * @member {String} error
+ */
+CreateCustomFileResponse.prototype['error'] = undefined;
+
 /**
  * @member {Array.<String>} errors
  */

package/dist/model/CreateFolderData.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateFolderData model module.
  * @module model/CreateFolderData
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreateFolderData = /*#__PURE__*/function () {
   /**

package/dist/model/CreateHtmlTemplate.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateHtmlTemplate model module.
  * @module model/CreateHtmlTemplate
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreateHtmlTemplate = /*#__PURE__*/function () {
   /**

package/dist/model/CreatePdfSubmissionData.js

@@ -17,7 +17,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreatePdfSubmissionData model module.
  * @module model/CreatePdfSubmissionData
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreatePdfSubmissionData = /*#__PURE__*/function () {
   /**
@@ -191,6 +191,7 @@ CreatePdfSubmissionData.prototype['metadata'] = undefined;
 CreatePdfSubmissionData.prototype['password'] = undefined;
 
 /**
+ * Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits.
  * @member {Boolean} test
  */
 CreatePdfSubmissionData.prototype['test'] = undefined;

package/dist/model/CreatePdfTemplate.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreatePdfTemplate model module.
  * @module model/CreatePdfTemplate
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreatePdfTemplate = /*#__PURE__*/function () {
   /**

package/dist/model/CreateSubmissionDataRequestData.js

@@ -13,7 +13,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSubmissionDataRequestData model module.
  * @module model/CreateSubmissionDataRequestData
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreateSubmissionDataRequestData = /*#__PURE__*/function () {
   /**

package/dist/model/CreateSubmissionDataRequestEventRequest.js

@@ -16,7 +16,7 @@ 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.
+ * 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/).
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSubmissionDataRequestEventRequest model module.
  * @module model/CreateSubmissionDataRequestEventRequest
- * @version 3.2.0
+ * @version 3.3.0
  */
 var CreateSubmissionDataRequestEventRequest = /*#__PURE__*/function () {
   /**