docspring 4.1.0 → 4.2.0

package/dist/api/Client.js

@@ -18,6 +18,7 @@ var _CreateSignatureRequestEventRequest = _interopRequireDefault(require("../mod
 var _CreateSignatureRequestTokenRequest = _interopRequireDefault(require("../model/CreateSignatureRequestTokenRequest"));
 var _CreateSubmissionBatchRequest = _interopRequireDefault(require("../model/CreateSubmissionBatchRequest"));
 var _CreateSubmissionRequest = _interopRequireDefault(require("../model/CreateSubmissionRequest"));
+var _CreateTemplatePreviewRequest = _interopRequireDefault(require("../model/CreateTemplatePreviewRequest"));
 var _CreateTemplateRequest = _interopRequireDefault(require("../model/CreateTemplateRequest"));
 var _CreateWebhookRequest = _interopRequireDefault(require("../model/CreateWebhookRequest"));
 var _CustomFile = _interopRequireDefault(require("../model/CustomFile"));
@@ -43,12 +44,14 @@ var _SignatureRequestToken = _interopRequireDefault(require("../model/SignatureR
 var _Submission = _interopRequireDefault(require("../model/Submission"));
 var _SubmissionBatch = _interopRequireDefault(require("../model/SubmissionBatch"));
 var _SubmissionList = _interopRequireDefault(require("../model/SubmissionList"));
+var _SubmissionState = _interopRequireDefault(require("../model/SubmissionState"));
 var _SubmissionValidation = _interopRequireDefault(require("../model/SubmissionValidation"));
 var _Template = _interopRequireDefault(require("../model/Template"));
 var _TemplateDiff = _interopRequireDefault(require("../model/TemplateDiff"));
 var _TemplateFields = _interopRequireDefault(require("../model/TemplateFields"));
 var _TemplateModelCode = _interopRequireDefault(require("../model/TemplateModelCode"));
 var _TemplatePageImages = _interopRequireDefault(require("../model/TemplatePageImages"));
+var _TemplatePreview = _interopRequireDefault(require("../model/TemplatePreview"));
 var _TemplateSummaryList = _interopRequireDefault(require("../model/TemplateSummaryList"));
 var _TemplateVersion = _interopRequireDefault(require("../model/TemplateVersion"));
 var _UpdateSignatureRequestRequest = _interopRequireDefault(require("../model/UpdateSignatureRequestRequest"));
@@ -83,7 +86,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
 * Client service.
 * @module api/Client
-* @version 4.1.0
+* @version 4.2.0
 */
 var Client = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -238,6 +241,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/CreateCombinedPdfRequest} body The PDFs to merge, and the combined PDF's settings.
      * @param {Object} opts Optional parameters
      * @param {Boolean} [wait] Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+     * @param {String} [idempotencyKey] A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another combined PDF. Send a new key with each new combined PDF, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CombinedPdf} and HTTP response
      */
   }, {
@@ -253,7 +257,9 @@ var Client = exports["default"] = /*#__PURE__*/function () {
       var queryParams = {
         'wait': opts['wait']
       };
-      var headerParams = {};
+      var headerParams = {
+        'Idempotency-Key': opts['idempotencyKey']
+      };
       var formParams = {};
       var authNames = ['api_token_basic'];
       var contentTypes = ['application/json'];
@@ -268,6 +274,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/CreateCombinedPdfRequest} body The PDFs to merge, and the combined PDF's settings.
      * @param {Object} opts Optional parameters
      * @param {Boolean} opts.wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+     * @param {String} opts.idempotencyKey A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another combined PDF. Send a new key with each new combined PDF, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CombinedPdf}
      */
   }, {
@@ -358,7 +365,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Record a signature request event
-     * Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. 
+     * Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. A finished (completed, declined or expired) signature request's audit trail takes no more events, and a test API token can't record one for a live signature request. 
      * @param {String} signature_request_id The signature request's ID.
      * @param {module:model/CreateSignatureRequestEventRequest} body The event to record.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SignatureRequestEvent} and HTTP response
@@ -390,7 +397,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Record a signature request event
-     * Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. 
+     * Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. A finished (completed, declined or expired) signature request's audit trail takes no more events, and a test API token can't record one for a live signature request. 
      * @param {String} signature_request_id The signature request's ID.
      * @param {module:model/CreateSignatureRequestEventRequest} body The event to record.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SignatureRequestEvent}
@@ -457,6 +464,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} [version] The template 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).
      * @param {Boolean} [wait] Wait until the files have been generated before responding. Default true on sync.api hosts.
+     * @param {String} [idempotencyKey] A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another submission. Send a new key with each new submission, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Submission} and HTTP response
      */
   }, {
@@ -479,7 +487,9 @@ var Client = exports["default"] = /*#__PURE__*/function () {
         'version': opts['version'],
         'wait': opts['wait']
       };
-      var headerParams = {};
+      var headerParams = {
+        'Idempotency-Key': opts['idempotencyKey']
+      };
       var formParams = {};
       var authNames = ['api_token_basic'];
       var contentTypes = ['application/json'];
@@ -496,6 +506,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @param {String} opts.version The template 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).
      * @param {Boolean} opts.wait Wait until the files have been generated before responding. Default true on sync.api hosts.
+     * @param {String} opts.idempotencyKey A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another submission. Send a new key with each new submission, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Submission}
      */
   }, {
@@ -512,6 +523,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/CreateSubmissionBatchRequest} body The submissions to create, and the settings they share.
      * @param {Object} opts Optional parameters
      * @param {Boolean} [wait] Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts.
+     * @param {String} [idempotencyKey] A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another batch. Send a new key with each new batch, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubmissionBatch} and HTTP response
      */
   }, {
@@ -527,7 +539,9 @@ var Client = exports["default"] = /*#__PURE__*/function () {
       var queryParams = {
         'wait': opts['wait']
       };
-      var headerParams = {};
+      var headerParams = {
+        'Idempotency-Key': opts['idempotencyKey']
+      };
       var formParams = {};
       var authNames = ['api_token_basic'];
       var contentTypes = ['application/json'];
@@ -542,6 +556,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/CreateSubmissionBatchRequest} body The submissions to create, and the settings they share.
      * @param {Object} opts Optional parameters
      * @param {Boolean} opts.wait Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts.
+     * @param {String} opts.idempotencyKey A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another batch. Send a new key with each new batch, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubmissionBatch}
      */
   }, {
@@ -598,6 +613,60 @@ var Client = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Preview a template with data
+     * Makes PNG images of a template's pages filled in with the data you send (not a PDF), so you can check how an HTML or PDF template prints with your data before you publish a version or send live data. It renders the template's draft, or the published `version` you ask for. A preview makes no submission and uses no credits, and its pages are watermarked like a test submission's PDF. It's `pending` while it renders: get it with GET /templates/{template_id}/previews/{preview_id} until it's `processed`, with an image of each page, or `error`. 
+     * @param {String} template_id The template's ID.
+     * @param {module:model/CreateTemplatePreviewRequest} body The data to render the template with.
+     * @param {Object} opts Optional parameters
+     * @param {String} [version] A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TemplatePreview} and HTTP response
+     */
+  }, {
+    key: "createTemplatePreviewWithHttpInfo",
+    value: function createTemplatePreviewWithHttpInfo(template_id, body, opts) {
+      opts = opts || {};
+      var postBody = body;
+      // verify the required parameter 'template_id' is set
+      if (template_id === undefined || template_id === null) {
+        throw new Error("Missing the required parameter 'template_id' when calling createTemplatePreview");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling createTemplatePreview");
+      }
+      var pathParams = {
+        'template_id': template_id
+      };
+      var queryParams = {
+        'version': opts['version']
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['api_token_basic'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _TemplatePreview["default"];
+      return this.apiClient.callApi('/templates/{template_id}/previews', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Preview a template with data
+     * Makes PNG images of a template's pages filled in with the data you send (not a PDF), so you can check how an HTML or PDF template prints with your data before you publish a version or send live data. It renders the template's draft, or the published `version` you ask for. A preview makes no submission and uses no credits, and its pages are watermarked like a test submission's PDF. It's `pending` while it renders: get it with GET /templates/{template_id}/previews/{preview_id} until it's `processed`, with an image of each page, or `error`. 
+     * @param {String} template_id The template's ID.
+     * @param {module:model/CreateTemplatePreviewRequest} body The data to render the template with.
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TemplatePreview}
+     */
+  }, {
+    key: "createTemplatePreview",
+    value: function createTemplatePreview(template_id, body, opts) {
+      return this.createTemplatePreviewWithHttpInfo(template_id, body, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Create a webhook
      * Creates a webhook that sends a POST request to your endpoint whenever a subscribed event happens. Scope it to API tokens, templates or folders to receive only their events. 
@@ -1369,11 +1438,12 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Generate typed code for a template's submission data
-     * Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
+     * Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object, and `just_types=true` leaves out the code that converts JSON to and from the types. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
      * @param {String} template_id The template's ID.
      * @param {module:model/ModelCodeLanguage} lang The language to generate the code in.
      * @param {Object} opts Optional parameters
      * @param {String} [version] The template version: 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), the version a submission uses by default.
+     * @param {Boolean} [just_types] Return only the types (interfaces, classes or structs), without the code that converts JSON to and from them. Default false. JavaScript has no types and PHP no types-only code, so theirs is the same either way.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TemplateModelCode} and HTTP response
      */
   }, {
@@ -1394,7 +1464,8 @@ var Client = exports["default"] = /*#__PURE__*/function () {
       };
       var queryParams = {
         'version': opts['version'],
-        'lang': lang
+        'lang': lang,
+        'just_types': opts['just_types']
       };
       var headerParams = {};
       var formParams = {};
@@ -1407,11 +1478,12 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Generate typed code for a template's submission data
-     * Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
+     * Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object, and `just_types=true` leaves out the code that converts JSON to and from the types. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
      * @param {String} template_id The template's ID.
      * @param {module:model/ModelCodeLanguage} lang The language to generate the code in.
      * @param {Object} opts Optional parameters
      * @param {String} opts.version The template version: 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), the version a submission uses by default.
+     * @param {Boolean} opts.just_types Return only the types (interfaces, classes or structs), without the code that converts JSON to and from them. Default false. JavaScript has no types and PHP no types-only code, so theirs is the same either way.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TemplateModelCode}
      */
   }, {
@@ -1470,6 +1542,54 @@ var Client = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Get a template preview
+     * Returns a preview made with POST /templates/{template_id}/previews. Once it's `processed`, `pages` has a PNG image of each page with a temporary link to download it: a preview has no PDF. Previews are deleted an hour after they're created. 
+     * @param {String} template_id The template's ID.
+     * @param {String} preview_id The preview's ID.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TemplatePreview} and HTTP response
+     */
+  }, {
+    key: "getTemplatePreviewWithHttpInfo",
+    value: function getTemplatePreviewWithHttpInfo(template_id, preview_id) {
+      var postBody = null;
+      // verify the required parameter 'template_id' is set
+      if (template_id === undefined || template_id === null) {
+        throw new Error("Missing the required parameter 'template_id' when calling getTemplatePreview");
+      }
+      // verify the required parameter 'preview_id' is set
+      if (preview_id === undefined || preview_id === null) {
+        throw new Error("Missing the required parameter 'preview_id' when calling getTemplatePreview");
+      }
+      var pathParams = {
+        'template_id': template_id,
+        'preview_id': preview_id
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['api_token_basic'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _TemplatePreview["default"];
+      return this.apiClient.callApi('/templates/{template_id}/previews/{preview_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Get a template preview
+     * Returns a preview made with POST /templates/{template_id}/previews. Once it's `processed`, `pages` has a PNG image of each page with a temporary link to download it: a preview has no PDF. Previews are deleted an hour after they're created. 
+     * @param {String} template_id The template's ID.
+     * @param {String} preview_id The preview's ID.
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TemplatePreview}
+     */
+  }, {
+    key: "getTemplatePreview",
+    value: function getTemplatePreview(template_id, preview_id) {
+      return this.getTemplatePreviewWithHttpInfo(template_id, preview_id).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Get the JSON Schema of a template's submission data
      * Returns the JSON Schema that a submission's `data` must match. Use it to check data before you create submissions, or to build a form for the template's fields. 
@@ -1695,7 +1815,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List submissions
-     * Returns the submissions in your account, newest first, one page at a time. Lists leave out each submission's `data` unless you pass `include_data=true`. 
+     * Returns the submissions in your account, newest first, one page at a time. Each one is a summary: its `data` is null unless you pass `include_data=true`, and its `files` are empty unless you pass `include_files=true`. Get a submission by its ID for its signature requests, uploads and page images. 
      * @param {Object} opts Optional parameters
      * @param {String} [template_id] Only list this template's submissions.
      * @param {Boolean} [test] Only list test submissions (true) or live submissions (false).
@@ -1704,6 +1824,8 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {Boolean} [include_data] Include each submission's `data` (null without it).
      * @param {Number} [limit = 50)] How many items to return (1-100, default 50).
      * @param {String} [cursor] The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+     * @param {module:model/SubmissionState} [state] Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+     * @param {Boolean} [include_files] Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubmissionList} and HTTP response
      */
   }, {
@@ -1719,7 +1841,9 @@ var Client = exports["default"] = /*#__PURE__*/function () {
         'created_before': opts['created_before'],
         'include_data': opts['include_data'],
         'limit': opts['limit'],
-        'cursor': opts['cursor']
+        'cursor': opts['cursor'],
+        'state': opts['state'],
+        'include_files': opts['include_files']
       };
       var headerParams = {};
       var formParams = {};
@@ -1732,7 +1856,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List submissions
-     * Returns the submissions in your account, newest first, one page at a time. Lists leave out each submission's `data` unless you pass `include_data=true`. 
+     * Returns the submissions in your account, newest first, one page at a time. Each one is a summary: its `data` is null unless you pass `include_data=true`, and its `files` are empty unless you pass `include_files=true`. Get a submission by its ID for its signature requests, uploads and page images. 
      * @param {Object} opts Optional parameters
      * @param {String} opts.template_id Only list this template's submissions.
      * @param {Boolean} opts.test Only list test submissions (true) or live submissions (false).
@@ -1741,6 +1865,8 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {Boolean} opts.include_data Include each submission's `data` (null without it).
      * @param {Number} opts.limit How many items to return (1-100, default 50). (default to 50)
      * @param {String} opts.cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+     * @param {module:model/SubmissionState} opts.state Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+     * @param {Boolean} opts.include_files Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubmissionList}
      */
   }, {
@@ -1810,6 +1936,8 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {Boolean} [include_data] Include each submission's `data` (null without it).
      * @param {Number} [limit = 50)] How many items to return (1-100, default 50).
      * @param {String} [cursor] The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+     * @param {module:model/SubmissionState} [state] Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+     * @param {Boolean} [include_files] Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubmissionList} and HTTP response
      */
   }, {
@@ -1830,7 +1958,9 @@ var Client = exports["default"] = /*#__PURE__*/function () {
         'created_before': opts['created_before'],
         'include_data': opts['include_data'],
         'limit': opts['limit'],
-        'cursor': opts['cursor']
+        'cursor': opts['cursor'],
+        'state': opts['state'],
+        'include_files': opts['include_files']
       };
       var headerParams = {};
       var formParams = {};
@@ -1852,6 +1982,8 @@ var Client = exports["default"] = /*#__PURE__*/function () {
      * @param {Boolean} opts.include_data Include each submission's `data` (null without it).
      * @param {Number} opts.limit How many items to return (1-100, default 50). (default to 50)
      * @param {String} opts.cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+     * @param {module:model/SubmissionState} opts.state Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+     * @param {Boolean} opts.include_files Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubmissionList}
      */
   }, {
@@ -1864,7 +1996,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List templates
-     * Returns the templates in your account (their drafts), newest first, one page at a time. Get a template by its ID for its HTML, defaults and published versions. 
+     * Returns the templates in your account (their drafts), newest first, one page at a time. Each one is a summary: get a template by its ID for its settings, its PDF in full, its HTML, defaults and published versions. 
      * @param {Object} opts Optional parameters
      * @param {String} [query] Only list templates whose name contains this text (ignoring case).
      * @param {String} [parent_folder_id] Only list the templates in this folder (not in its subfolders).
@@ -1895,7 +2027,7 @@ var Client = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List templates
-     * Returns the templates in your account (their drafts), newest first, one page at a time. Get a template by its ID for its HTML, defaults and published versions. 
+     * Returns the templates in your account (their drafts), newest first, one page at a time. Each one is a summary: get a template by its ID for its settings, its PDF in full, its HTML, defaults and published versions. 
      * @param {Object} opts Optional parameters
      * @param {String} opts.query Only list templates whose name contains this text (ignoring case).
      * @param {String} opts.parent_folder_id Only list the templates in this folder (not in its subfolders).

package/dist/index.js

@@ -147,6 +147,12 @@ Object.defineProperty(exports, "CreateSubmissionRequest", {
     return _CreateSubmissionRequest["default"];
   }
 });
+Object.defineProperty(exports, "CreateTemplatePreviewRequest", {
+  enumerable: true,
+  get: function get() {
+    return _CreateTemplatePreviewRequest["default"];
+  }
+});
 Object.defineProperty(exports, "CreateTemplateRequest", {
   enumerable: true,
   get: function get() {
@@ -633,6 +639,12 @@ Object.defineProperty(exports, "SubmissionState", {
     return _SubmissionState["default"];
   }
 });
+Object.defineProperty(exports, "SubmissionSummary", {
+  enumerable: true,
+  get: function get() {
+    return _SubmissionSummary["default"];
+  }
+});
 Object.defineProperty(exports, "SubmissionValidation", {
   enumerable: true,
   get: function get() {
@@ -693,6 +705,12 @@ Object.defineProperty(exports, "TemplateDocumentState", {
     return _TemplateDocumentState["default"];
   }
 });
+Object.defineProperty(exports, "TemplateDocumentSummary", {
+  enumerable: true,
+  get: function get() {
+    return _TemplateDocumentSummary["default"];
+  }
+});
 Object.defineProperty(exports, "TemplateFieldChange", {
   enumerable: true,
   get: function get() {
@@ -813,6 +831,18 @@ Object.defineProperty(exports, "TemplatePageProcessingStatus", {
     return _TemplatePageProcessingStatus["default"];
   }
 });
+Object.defineProperty(exports, "TemplatePreview", {
+  enumerable: true,
+  get: function get() {
+    return _TemplatePreview["default"];
+  }
+});
+Object.defineProperty(exports, "TemplatePreviewState", {
+  enumerable: true,
+  get: function get() {
+    return _TemplatePreviewState["default"];
+  }
+});
 Object.defineProperty(exports, "TemplateSourcePdf", {
   enumerable: true,
   get: function get() {
@@ -957,8 +987,15 @@ Object.defineProperty(exports, "WebhookMode", {
     return _WebhookMode["default"];
   }
 });
+Object.defineProperty(exports, "verifyWebhookSignature", {
+  enumerable: true,
+  get: function get() {
+    return _WebhookSignature.verifyWebhookSignature;
+  }
+});
 var _ApiClient = _interopRequireDefault(require("./ApiClient"));
 var _RequestValidator = require("./RequestValidator");
+var _WebhookSignature = require("./WebhookSignature");
 var _AddTemplateFieldsRequest = _interopRequireDefault(require("./model/AddTemplateFieldsRequest"));
 var _AiFieldNamingLanguage = _interopRequireDefault(require("./model/AiFieldNamingLanguage"));
 var _AuthenticationCheck = _interopRequireDefault(require("./model/AuthenticationCheck"));
@@ -981,6 +1018,7 @@ var _CreateSignatureRequestEventRequest = _interopRequireDefault(require("./mode
 var _CreateSignatureRequestTokenRequest = _interopRequireDefault(require("./model/CreateSignatureRequestTokenRequest"));
 var _CreateSubmissionBatchRequest = _interopRequireDefault(require("./model/CreateSubmissionBatchRequest"));
 var _CreateSubmissionRequest = _interopRequireDefault(require("./model/CreateSubmissionRequest"));
+var _CreateTemplatePreviewRequest = _interopRequireDefault(require("./model/CreateTemplatePreviewRequest"));
 var _CreateTemplateRequest = _interopRequireDefault(require("./model/CreateTemplateRequest"));
 var _CreateWebhookRequest = _interopRequireDefault(require("./model/CreateWebhookRequest"));
 var _CustomFile = _interopRequireDefault(require("./model/CustomFile"));
@@ -1062,6 +1100,7 @@ var _SubmissionList = _interopRequireDefault(require("./model/SubmissionList"));
 var _SubmissionSource = _interopRequireDefault(require("./model/SubmissionSource"));
 var _SubmissionSourcePdf = _interopRequireDefault(require("./model/SubmissionSourcePdf"));
 var _SubmissionState = _interopRequireDefault(require("./model/SubmissionState"));
+var _SubmissionSummary = _interopRequireDefault(require("./model/SubmissionSummary"));
 var _SubmissionValidation = _interopRequireDefault(require("./model/SubmissionValidation"));
 var _Template = _interopRequireDefault(require("./model/Template"));
 var _TemplateActor = _interopRequireDefault(require("./model/TemplateActor"));
@@ -1072,6 +1111,7 @@ var _TemplateDiff = _interopRequireDefault(require("./model/TemplateDiff"));
 var _TemplateDiffSummary = _interopRequireDefault(require("./model/TemplateDiffSummary"));
 var _TemplateDocument = _interopRequireDefault(require("./model/TemplateDocument"));
 var _TemplateDocumentState = _interopRequireDefault(require("./model/TemplateDocumentState"));
+var _TemplateDocumentSummary = _interopRequireDefault(require("./model/TemplateDocumentSummary"));
 var _TemplateFieldChange = _interopRequireDefault(require("./model/TemplateFieldChange"));
 var _TemplateFieldChanges = _interopRequireDefault(require("./model/TemplateFieldChanges"));
 var _TemplateFieldDependency = _interopRequireDefault(require("./model/TemplateFieldDependency"));
@@ -1092,6 +1132,8 @@ var _TemplatePageFieldsStatus = _interopRequireDefault(require("./model/Template
 var _TemplatePageImageStatus = _interopRequireDefault(require("./model/TemplatePageImageStatus"));
 var _TemplatePageImages = _interopRequireDefault(require("./model/TemplatePageImages"));
 var _TemplatePageProcessingStatus = _interopRequireDefault(require("./model/TemplatePageProcessingStatus"));
+var _TemplatePreview = _interopRequireDefault(require("./model/TemplatePreview"));
+var _TemplatePreviewState = _interopRequireDefault(require("./model/TemplatePreviewState"));
 var _TemplateSourcePdf = _interopRequireDefault(require("./model/TemplateSourcePdf"));
 var _TemplateSummary = _interopRequireDefault(require("./model/TemplateSummary"));
 var _TemplateSummaryList = _interopRequireDefault(require("./model/TemplateSummaryList"));

package/dist/model/AddTemplateFieldsRequest.js

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

package/dist/model/AuthenticationCheck.js

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

package/dist/model/CombinedPdf.js

@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinedPdf model module.
  * @module model/CombinedPdf
- * @version 4.1.0
+ * @version 4.2.0
  */
 var CombinedPdf = /*#__PURE__*/function () {
   /**
@@ -44,7 +44,7 @@ var CombinedPdf = /*#__PURE__*/function () {
    * @param id {String} The combined PDF's ID.
    * @param state {module:model/CombinedPdfState} `pending` until the PDF has been generated, then `processed`. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. `error`: the PDFs couldn't be merged (see `error_message`). Waiting ends in `error` if it's discarded or takes over 30 days.
    * @param source_pdfs {Array.<module:model/CombinedPdfSource>} The PDFs to merge, in order.
-   * @param metadata {Object.<String, Object>} Your own data about the combined PDF, such as an ID from your app.
+   * @param metadata {Object.<String, Object>} Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the combined PDF's ID (`com_1234567890abcdef01.pdf`).
    * @param has_password {Boolean} Whether the PDF needs a password to open (`password`).
    * @param delete_custom_files {Boolean} Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files.
    * @param error_message {String} Why the PDFs couldn't be merged, when `state` is `error`.
@@ -227,7 +227,7 @@ CombinedPdf.prototype['state'] = undefined;
 CombinedPdf.prototype['source_pdfs'] = undefined;
 
 /**
- * Your own data about the combined PDF, such as an ID from your app.
+ * Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the combined PDF's ID (`com_1234567890abcdef01.pdf`).
  * @member {Object.<String, Object>} metadata
  */
 CombinedPdf.prototype['metadata'] = undefined;

package/dist/model/CombinedPdfFiles.js

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

package/dist/model/CombinedPdfList.js

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

package/dist/model/CombinedPdfSource.js

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

package/dist/model/CombinedPdfSourceInput.js

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

package/dist/model/CombinedPdfSourcePdf.js

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

package/dist/model/CopyTemplateRequest.js

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

package/dist/model/CreateCombinedPdfRequest.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateCombinedPdfRequest model module.
  * @module model/CreateCombinedPdfRequest
- * @version 4.1.0
+ * @version 4.2.0
  */
 var CreateCombinedPdfRequest = /*#__PURE__*/function () {
   /**
@@ -149,7 +149,7 @@ CreateCombinedPdfRequest.RequiredProperties = ["source_pdfs"];
 CreateCombinedPdfRequest.prototype['source_pdfs'] = undefined;
 
 /**
- * Your own data about the combined PDF, such as an ID from your app.
+ * Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the combined PDF's ID (`com_1234567890abcdef01.pdf`).
  * @member {Object.<String, Object>} metadata
  */
 CreateCombinedPdfRequest.prototype['metadata'] = undefined;

package/dist/model/CreateCustomFileFromUploadRequest.js

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

package/dist/model/CreateFolderRequest.js

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