docspring 3.3.0 → 4.0.0

package/dist/model/Submission.js

@@ -5,8 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _ErrorDetail = _interopRequireDefault(require("./ErrorDetail"));
+var _SignatureRequest = _interopRequireDefault(require("./SignatureRequest"));
 var _SubmissionAction = _interopRequireDefault(require("./SubmissionAction"));
-var _SubmissionDataRequest = _interopRequireDefault(require("./SubmissionDataRequest"));
+var _SubmissionFiles = _interopRequireDefault(require("./SubmissionFiles"));
+var _SubmissionSource = _interopRequireDefault(require("./SubmissionSource"));
+var _SubmissionState = _interopRequireDefault(require("./SubmissionState"));
+var _TemplateType = _interopRequireDefault(require("./TemplateType"));
 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; } } }; }
@@ -18,9 +23,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).
@@ -31,41 +36,42 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The Submission model module.
  * @module model/Submission
- * @version 3.3.0
+ * @version 4.0.0
  */
 var Submission = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>Submission</code>.
+   * Data submitted to a template, and the PDF generated from it.
    * @alias module:model/Submission
    * @extends Object
-   * @param batch_id {String} 
-   * @param data_requests {Array.<module:model/SubmissionDataRequest>} 
-   * @param editable {Boolean} 
-   * @param error_message {String} 
-   * @param expired {Boolean} 
-   * @param expires_at {String} 
-   * @param id {String} 
-   * @param json_schema_errors {Array.<String>} 
-   * @param metadata {Object} 
-   * @param password {String} 
-   * @param processed_at {String} 
-   * @param state {module:model/Submission.StateEnum} 
-   * @param template_id {String} 
-   * @param template_type {module:model/Submission.TemplateTypeEnum} 
-   * @param template_version {String} 
-   * @param test {Boolean} 
-   * @param truncated_text {Object} 
-   * @param pdf_hash {String} 
-   * @param download_url {String} 
-   * @param permanent_download_url {String} 
-   * @param preview_download_url {String} 
-   * @param preview_generated_at {String} 
-   * @param audit_trail_download_url {String} 
-   * @param actions {Array.<module:model/SubmissionAction>} 
+   * @param id {String} The submission's ID.
+   * @param template_id {String} Null once the template has been permanently deleted.
+   * @param template_type {module:model/TemplateType} The template's type: `pdf` or `html`.
+   * @param template_version {String} The published version of the template the submission used. Null for the draft.
+   * @param batch_id {String} The ID of the batch the submission was created in.
+   * @param source {module:model/SubmissionSource} `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
+   * @param state {module:model/SubmissionState} `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `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. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+   * @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+   * @param editable {Boolean} `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+   * @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired.
+   * @param data_errors {Array.<module:model/ErrorDetail>} Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
+   * @param error_message {String} Why the PDF couldn't be generated, when `state` is `error`.
+   * @param metadata {Object.<String, Object>} Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+   * @param has_password {Boolean} Whether the PDF needs a password to open (`password`).
+   * @param signature_requests {Array.<module:model/SignatureRequest>} The people asked to sign the submission (and fill in their fields), in order.
+   * @param actions {Array.<module:model/SubmissionAction>} The uploads of the submission's PDF to your storage (account integrations).
+   * @param truncated_text {Object.<String, Array.<String>>} The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
+   * @param files {module:model/SubmissionFiles} The generated files: `pdf` once the submission has been processed, `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
+   * @param preview_generated_at {Date} When the preview PDF was generated. Null if there is no preview.
+   * @param expired {Boolean} An expired submission's data, metadata, password and PDF have been deleted.
+   * @param expires_at {Date} When the submission expires. Null if it's kept until you delete it.
+   * @param processed_at {Date} When the PDF was generated. Null until then.
+   * @param created_at {Date} When the submission was created.
+   * @param updated_at {Date} When the submission was last updated.
    */
-  function Submission(batch_id, data_requests, editable, error_message, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions) {
+  function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at) {
     _classCallCheck(this, Submission);
-    Submission.initialize(this, batch_id, data_requests, editable, error_message, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions);
+    Submission.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at);
   }
 
   /**
@@ -75,31 +81,31 @@ var Submission = /*#__PURE__*/function () {
    */
   return _createClass(Submission, null, [{
     key: "initialize",
-    value: function initialize(obj, batch_id, data_requests, editable, error_message, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions) {
-      obj['batch_id'] = batch_id;
-      obj['data_requests'] = data_requests;
-      obj['editable'] = editable;
-      obj['error_message'] = error_message;
-      obj['expired'] = expired;
-      obj['expires_at'] = expires_at;
+    value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, has_password, signature_requests, actions, truncated_text, files, preview_generated_at, expired, expires_at, processed_at, created_at, updated_at) {
       obj['id'] = id;
-      obj['json_schema_errors'] = json_schema_errors;
-      obj['metadata'] = metadata;
-      obj['password'] = password;
-      obj['processed_at'] = processed_at;
-      obj['state'] = state;
       obj['template_id'] = template_id;
       obj['template_type'] = template_type;
       obj['template_version'] = template_version;
+      obj['batch_id'] = batch_id;
+      obj['source'] = source;
+      obj['state'] = state;
       obj['test'] = test;
+      obj['editable'] = editable;
+      obj['data'] = data;
+      obj['data_errors'] = data_errors;
+      obj['error_message'] = error_message;
+      obj['metadata'] = metadata;
+      obj['has_password'] = has_password;
+      obj['signature_requests'] = signature_requests;
+      obj['actions'] = actions;
       obj['truncated_text'] = truncated_text;
-      obj['pdf_hash'] = pdf_hash;
-      obj['download_url'] = download_url;
-      obj['permanent_download_url'] = permanent_download_url;
-      obj['preview_download_url'] = preview_download_url;
+      obj['files'] = files;
       obj['preview_generated_at'] = preview_generated_at;
-      obj['audit_trail_download_url'] = audit_trail_download_url;
-      obj['actions'] = actions;
+      obj['expired'] = expired;
+      obj['expires_at'] = expires_at;
+      obj['processed_at'] = processed_at;
+      obj['created_at'] = created_at;
+      obj['updated_at'] = updated_at;
     }
 
     /**
@@ -115,86 +121,83 @@ var Submission = /*#__PURE__*/function () {
       if (data) {
         obj = obj || new Submission();
         _ApiClient["default"].constructFromObject(data, obj, 'Object');
-        if (data.hasOwnProperty('batch_id')) {
-          obj['batch_id'] = _ApiClient["default"].convertToType(data['batch_id'], 'String');
-        }
-        if (data.hasOwnProperty('data_requests')) {
-          obj['data_requests'] = _ApiClient["default"].convertToType(data['data_requests'], [_SubmissionDataRequest["default"]]);
-        }
-        if (data.hasOwnProperty('editable')) {
-          obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
-        }
-        if (data.hasOwnProperty('error_message')) {
-          obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
-        }
-        if (data.hasOwnProperty('expired')) {
-          obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
-        }
-        if (data.hasOwnProperty('expires_at')) {
-          obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'String');
-        }
         if (data.hasOwnProperty('id')) {
           obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
         }
-        if (data.hasOwnProperty('json_schema_errors')) {
-          obj['json_schema_errors'] = _ApiClient["default"].convertToType(data['json_schema_errors'], ['String']);
-        }
-        if (data.hasOwnProperty('metadata')) {
-          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
-        }
-        if (data.hasOwnProperty('password')) {
-          obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
-        }
-        if (data.hasOwnProperty('processed_at')) {
-          obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'String');
-        }
-        if (data.hasOwnProperty('state')) {
-          obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
-        }
         if (data.hasOwnProperty('template_id')) {
           obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
         }
         if (data.hasOwnProperty('template_type')) {
-          obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], 'String');
+          obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], _TemplateType["default"]);
         }
         if (data.hasOwnProperty('template_version')) {
           obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
         }
+        if (data.hasOwnProperty('batch_id')) {
+          obj['batch_id'] = _ApiClient["default"].convertToType(data['batch_id'], 'String');
+        }
+        if (data.hasOwnProperty('source')) {
+          obj['source'] = _ApiClient["default"].convertToType(data['source'], _SubmissionSource["default"]);
+        }
+        if (data.hasOwnProperty('state')) {
+          obj['state'] = _ApiClient["default"].convertToType(data['state'], _SubmissionState["default"]);
+        }
         if (data.hasOwnProperty('test')) {
           obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
         }
-        if (data.hasOwnProperty('truncated_text')) {
-          obj['truncated_text'] = _ApiClient["default"].convertToType(data['truncated_text'], Object);
+        if (data.hasOwnProperty('editable')) {
+          obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
         }
-        if (data.hasOwnProperty('pdf_hash')) {
-          obj['pdf_hash'] = _ApiClient["default"].convertToType(data['pdf_hash'], 'String');
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], {
+            'String': Object
+          });
         }
-        if (data.hasOwnProperty('download_url')) {
-          obj['download_url'] = _ApiClient["default"].convertToType(data['download_url'], 'String');
+        if (data.hasOwnProperty('data_errors')) {
+          obj['data_errors'] = _ApiClient["default"].convertToType(data['data_errors'], [_ErrorDetail["default"]]);
         }
-        if (data.hasOwnProperty('permanent_download_url')) {
-          obj['permanent_download_url'] = _ApiClient["default"].convertToType(data['permanent_download_url'], 'String');
+        if (data.hasOwnProperty('error_message')) {
+          obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
         }
-        if (data.hasOwnProperty('preview_download_url')) {
-          obj['preview_download_url'] = _ApiClient["default"].convertToType(data['preview_download_url'], 'String');
+        if (data.hasOwnProperty('metadata')) {
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
+            'String': Object
+          });
         }
-        if (data.hasOwnProperty('preview_generated_at')) {
-          obj['preview_generated_at'] = _ApiClient["default"].convertToType(data['preview_generated_at'], 'String');
+        if (data.hasOwnProperty('has_password')) {
+          obj['has_password'] = _ApiClient["default"].convertToType(data['has_password'], 'Boolean');
         }
-        if (data.hasOwnProperty('audit_trail_download_url')) {
-          obj['audit_trail_download_url'] = _ApiClient["default"].convertToType(data['audit_trail_download_url'], 'String');
+        if (data.hasOwnProperty('signature_requests')) {
+          obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequest["default"]]);
         }
         if (data.hasOwnProperty('actions')) {
           obj['actions'] = _ApiClient["default"].convertToType(data['actions'], [_SubmissionAction["default"]]);
         }
-        if (data.hasOwnProperty('source')) {
-          obj['source'] = _ApiClient["default"].convertToType(data['source'], 'String');
+        if (data.hasOwnProperty('truncated_text')) {
+          obj['truncated_text'] = _ApiClient["default"].convertToType(data['truncated_text'], {
+            'String': ['String']
+          });
         }
-        if (data.hasOwnProperty('referrer')) {
-          obj['referrer'] = _ApiClient["default"].convertToType(data['referrer'], 'String');
+        if (data.hasOwnProperty('files')) {
+          obj['files'] = _ApiClient["default"].convertToType(data['files'], _SubmissionFiles["default"]);
         }
-        if (data.hasOwnProperty('data')) {
-          obj['data'] = _ApiClient["default"].convertToType(data['data'], Object);
+        if (data.hasOwnProperty('preview_generated_at')) {
+          obj['preview_generated_at'] = _ApiClient["default"].convertToType(data['preview_generated_at'], 'Date');
+        }
+        if (data.hasOwnProperty('expired')) {
+          obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
+        }
+        if (data.hasOwnProperty('expires_at')) {
+          obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
+        }
+        if (data.hasOwnProperty('processed_at')) {
+          obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'Date');
+        }
+        if (data.hasOwnProperty('created_at')) {
+          obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
+        }
+        if (data.hasOwnProperty('updated_at')) {
+          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
         }
       }
       return obj;
@@ -224,346 +227,184 @@ var Submission = /*#__PURE__*/function () {
       } finally {
         _iterator.f();
       }
-      if (data['batch_id'] && !(typeof data['batch_id'] === 'string' || data['batch_id'] instanceof String)) {
-        throw new Error("Expected the field `batch_id` to be a primitive type in the JSON string but got " + data['batch_id']);
-      }
-      // ensure the json data is an array
-      if (!Array.isArray(data['data_requests'])) {
-        throw new Error("Expected the field `data_requests` to be an array in the JSON data but got " + data['data_requests']);
-      }
-      // ensure the json data is a string
-      if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
-        throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
-      }
-      // ensure the json data is a string
-      if (data['expires_at'] && !(typeof data['expires_at'] === 'string' || data['expires_at'] instanceof String)) {
-        throw new Error("Expected the field `expires_at` to be a primitive type in the JSON string but got " + data['expires_at']);
-      }
-      // ensure the json data is a string
       if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
         throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
       }
-      // ensure the json data is an array
-      if (!Array.isArray(data['json_schema_errors'])) {
-        throw new Error("Expected the field `json_schema_errors` to be an array in the JSON data but got " + data['json_schema_errors']);
-      }
-      // ensure the json data is a string
-      if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
-        throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
-      }
-      // ensure the json data is a string
-      if (data['processed_at'] && !(typeof data['processed_at'] === 'string' || data['processed_at'] instanceof String)) {
-        throw new Error("Expected the field `processed_at` to be a primitive type in the JSON string but got " + data['processed_at']);
-      }
-      // ensure the json data is a string
-      if (data['state'] && !(typeof data['state'] === 'string' || data['state'] instanceof String)) {
-        throw new Error("Expected the field `state` to be a primitive type in the JSON string but got " + data['state']);
-      }
       // ensure the json data is a string
       if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
         throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
       }
       // ensure the json data is a string
-      if (data['template_type'] && !(typeof data['template_type'] === 'string' || data['template_type'] instanceof String)) {
-        throw new Error("Expected the field `template_type` to be a primitive type in the JSON string but got " + data['template_type']);
-      }
-      // ensure the json data is a string
       if (data['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
         throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
       }
       // ensure the json data is a string
-      if (data['pdf_hash'] && !(typeof data['pdf_hash'] === 'string' || data['pdf_hash'] instanceof String)) {
-        throw new Error("Expected the field `pdf_hash` to be a primitive type in the JSON string but got " + data['pdf_hash']);
-      }
-      // ensure the json data is a string
-      if (data['download_url'] && !(typeof data['download_url'] === 'string' || data['download_url'] instanceof String)) {
-        throw new Error("Expected the field `download_url` to be a primitive type in the JSON string but got " + data['download_url']);
-      }
-      // ensure the json data is a string
-      if (data['permanent_download_url'] && !(typeof data['permanent_download_url'] === 'string' || data['permanent_download_url'] instanceof String)) {
-        throw new Error("Expected the field `permanent_download_url` to be a primitive type in the JSON string but got " + data['permanent_download_url']);
+      if (data['batch_id'] && !(typeof data['batch_id'] === 'string' || data['batch_id'] instanceof String)) {
+        throw new Error("Expected the field `batch_id` to be a primitive type in the JSON string but got " + data['batch_id']);
       }
-      // ensure the json data is a string
-      if (data['preview_download_url'] && !(typeof data['preview_download_url'] === 'string' || data['preview_download_url'] instanceof String)) {
-        throw new Error("Expected the field `preview_download_url` to be a primitive type in the JSON string but got " + data['preview_download_url']);
+      // ensure the json data is an array
+      if (!Array.isArray(data['data_errors'])) {
+        throw new Error("Expected the field `data_errors` to be an array in the JSON data but got " + data['data_errors']);
       }
       // ensure the json data is a string
-      if (data['preview_generated_at'] && !(typeof data['preview_generated_at'] === 'string' || data['preview_generated_at'] instanceof String)) {
-        throw new Error("Expected the field `preview_generated_at` to be a primitive type in the JSON string but got " + data['preview_generated_at']);
+      if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
+        throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
       }
-      // ensure the json data is a string
-      if (data['audit_trail_download_url'] && !(typeof data['audit_trail_download_url'] === 'string' || data['audit_trail_download_url'] instanceof String)) {
-        throw new Error("Expected the field `audit_trail_download_url` to be a primitive type in the JSON string but got " + data['audit_trail_download_url']);
+      // ensure the json data is an array
+      if (!Array.isArray(data['signature_requests'])) {
+        throw new Error("Expected the field `signature_requests` to be an array in the JSON data but got " + data['signature_requests']);
       }
       // ensure the json data is an array
       if (!Array.isArray(data['actions'])) {
         throw new Error("Expected the field `actions` to be an array in the JSON data but got " + data['actions']);
       }
-      // ensure the json data is a string
-      if (data['source'] && !(typeof data['source'] === 'string' || data['source'] instanceof String)) {
-        throw new Error("Expected the field `source` to be a primitive type in the JSON string but got " + data['source']);
-      }
-      // ensure the json data is a string
-      if (data['referrer'] && !(typeof data['referrer'] === 'string' || data['referrer'] instanceof String)) {
-        throw new Error("Expected the field `referrer` to be a primitive type in the JSON string but got " + data['referrer']);
-      }
       return true;
     }
   }]);
 }();
-Submission.RequiredProperties = ["batch_id", "data_requests", "editable", "error_message", "expired", "expires_at", "id", "json_schema_errors", "metadata", "password", "processed_at", "state", "template_id", "template_type", "template_version", "test", "truncated_text", "pdf_hash", "download_url", "permanent_download_url", "preview_download_url", "preview_generated_at", "audit_trail_download_url", "actions"];
-
-/**
- * @member {String} batch_id
- */
-Submission.prototype['batch_id'] = undefined;
-
-/**
- * @member {Array.<module:model/SubmissionDataRequest>} data_requests
- */
-Submission.prototype['data_requests'] = undefined;
-
-/**
- * @member {Boolean} editable
- */
-Submission.prototype['editable'] = undefined;
-
-/**
- * @member {String} error_message
- */
-Submission.prototype['error_message'] = undefined;
-
-/**
- * @member {Boolean} expired
- */
-Submission.prototype['expired'] = undefined;
-
-/**
- * @member {String} expires_at
- */
-Submission.prototype['expires_at'] = undefined;
+Submission.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "has_password", "signature_requests", "actions", "truncated_text", "files", "preview_generated_at", "expired", "expires_at", "processed_at", "created_at", "updated_at"];
 
 /**
+ * The submission's ID.
  * @member {String} id
  */
 Submission.prototype['id'] = undefined;
 
 /**
- * @member {Array.<String>} json_schema_errors
+ * Null once the template has been permanently deleted.
+ * @member {String} template_id
  */
-Submission.prototype['json_schema_errors'] = undefined;
+Submission.prototype['template_id'] = undefined;
 
 /**
- * @member {Object} metadata
+ * The template's type: `pdf` or `html`.
+ * @member {module:model/TemplateType} template_type
  */
-Submission.prototype['metadata'] = undefined;
+Submission.prototype['template_type'] = undefined;
 
 /**
- * @member {String} password
+ * The published version of the template the submission used. Null for the draft.
+ * @member {String} template_version
  */
-Submission.prototype['password'] = undefined;
+Submission.prototype['template_version'] = undefined;
 
 /**
- * @member {String} processed_at
+ * The ID of the batch the submission was created in.
+ * @member {String} batch_id
  */
-Submission.prototype['processed_at'] = undefined;
+Submission.prototype['batch_id'] = undefined;
 
 /**
- * @member {module:model/Submission.StateEnum} state
+ * `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
+ * @member {module:model/SubmissionSource} source
  */
-Submission.prototype['state'] = undefined;
+Submission.prototype['source'] = undefined;
 
 /**
- * @member {String} template_id
+ * `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `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. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+ * @member {module:model/SubmissionState} state
  */
-Submission.prototype['template_id'] = undefined;
+Submission.prototype['state'] = undefined;
 
 /**
- * @member {module:model/Submission.TemplateTypeEnum} template_type
+ * Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+ * @member {Boolean} test
  */
-Submission.prototype['template_type'] = undefined;
+Submission.prototype['test'] = undefined;
 
 /**
- * @member {String} template_version
+ * `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+ * @member {Boolean} editable
  */
-Submission.prototype['template_version'] = undefined;
+Submission.prototype['editable'] = undefined;
 
 /**
- * @member {Boolean} test
+ * The submission's data, with the values entered in completed signature requests. Lists leave it out (null) unless you pass `include_data=true`. Empty once the submission has expired.
+ * @member {Object.<String, Object>} data
  */
-Submission.prototype['test'] = undefined;
+Submission.prototype['data'] = undefined;
 
 /**
- * @member {Object} truncated_text
+ * Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
+ * @member {Array.<module:model/ErrorDetail>} data_errors
  */
-Submission.prototype['truncated_text'] = undefined;
+Submission.prototype['data_errors'] = undefined;
 
 /**
- * @member {String} pdf_hash
+ * Why the PDF couldn't be generated, when `state` is `error`.
+ * @member {String} error_message
  */
-Submission.prototype['pdf_hash'] = undefined;
+Submission.prototype['error_message'] = undefined;
 
 /**
- * @member {String} download_url
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+ * @member {Object.<String, Object>} metadata
  */
-Submission.prototype['download_url'] = undefined;
+Submission.prototype['metadata'] = undefined;
 
 /**
- * @member {String} permanent_download_url
+ * Whether the PDF needs a password to open (`password`).
+ * @member {Boolean} has_password
  */
-Submission.prototype['permanent_download_url'] = undefined;
+Submission.prototype['has_password'] = undefined;
 
 /**
- * @member {String} preview_download_url
+ * The people asked to sign the submission (and fill in their fields), in order.
+ * @member {Array.<module:model/SignatureRequest>} signature_requests
  */
-Submission.prototype['preview_download_url'] = undefined;
+Submission.prototype['signature_requests'] = undefined;
 
 /**
- * @member {String} preview_generated_at
+ * The uploads of the submission's PDF to your storage (account integrations).
+ * @member {Array.<module:model/SubmissionAction>} actions
  */
-Submission.prototype['preview_generated_at'] = undefined;
+Submission.prototype['actions'] = undefined;
 
 /**
- * @member {String} audit_trail_download_url
+ * The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
+ * @member {Object.<String, Array.<String>>} truncated_text
  */
-Submission.prototype['audit_trail_download_url'] = undefined;
+Submission.prototype['truncated_text'] = undefined;
 
 /**
- * @member {Array.<module:model/SubmissionAction>} actions
+ * The generated files: `pdf` once the submission has been processed, `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
+ * @member {module:model/SubmissionFiles} files
  */
-Submission.prototype['actions'] = undefined;
+Submission.prototype['files'] = undefined;
 
 /**
- * @member {module:model/Submission.SourceEnum} source
+ * When the preview PDF was generated. Null if there is no preview.
+ * @member {Date} preview_generated_at
  */
-Submission.prototype['source'] = undefined;
+Submission.prototype['preview_generated_at'] = undefined;
 
 /**
- * @member {String} referrer
+ * An expired submission's data, metadata, password and PDF have been deleted.
+ * @member {Boolean} expired
  */
-Submission.prototype['referrer'] = undefined;
+Submission.prototype['expired'] = undefined;
 
 /**
- * @member {Object} data
+ * When the submission expires. Null if it's kept until you delete it.
+ * @member {Date} expires_at
  */
-Submission.prototype['data'] = undefined;
+Submission.prototype['expires_at'] = undefined;
 
 /**
- * Allowed values for the <code>state</code> property.
- * @enum {String}
- * @readonly
+ * When the PDF was generated. Null until then.
+ * @member {Date} processed_at
  */
-Submission['StateEnum'] = {
-  /**
-   * value: "pending"
-   * @const
-   */
-  "pending": "pending",
-  /**
-   * value: "processed"
-   * @const
-   */
-  "processed": "processed",
-  /**
-   * value: "invalid_data"
-   * @const
-   */
-  "invalid_data": "invalid_data",
-  /**
-   * value: "error"
-   * @const
-   */
-  "error": "error",
-  /**
-   * value: "image_download_failed"
-   * @const
-   */
-  "image_download_failed": "image_download_failed",
-  /**
-   * value: "image_processing_failed"
-   * @const
-   */
-  "image_processing_failed": "image_processing_failed",
-  /**
-   * value: "waiting_for_data_requests"
-   * @const
-   */
-  "waiting_for_data_requests": "waiting_for_data_requests",
-  /**
-   * value: "syntax_error"
-   * @const
-   */
-  "syntax_error": "syntax_error",
-  /**
-   * value: "insufficient_credits"
-   * @const
-   */
-  "insufficient_credits": "insufficient_credits",
-  /**
-   * value: "account_suspended"
-   * @const
-   */
-  "account_suspended": "account_suspended",
-  /**
-   * value: "license_revoked"
-   * @const
-   */
-  "license_revoked": "license_revoked",
-  /**
-   * value: "accidental"
-   * @const
-   */
-  "accidental": "accidental",
-  /**
-   * value: "declined"
-   * @const
-   */
-  "declined": "declined"
-};
+Submission.prototype['processed_at'] = undefined;
 
 /**
- * Allowed values for the <code>template_type</code> property.
- * @enum {String}
- * @readonly
+ * When the submission was created.
+ * @member {Date} created_at
  */
-Submission['TemplateTypeEnum'] = {
-  /**
-   * value: "pdf"
-   * @const
-   */
-  "pdf": "pdf",
-  /**
-   * value: "html"
-   * @const
-   */
-  "html": "html"
-};
+Submission.prototype['created_at'] = undefined;
 
 /**
- * Allowed values for the <code>source</code> property.
- * @enum {String}
- * @readonly
+ * When the submission was last updated.
+ * @member {Date} updated_at
  */
-Submission['SourceEnum'] = {
-  /**
-   * value: "api"
-   * @const
-   */
-  "api": "api",
-  /**
-   * value: "web"
-   * @const
-   */
-  "web": "web",
-  /**
-   * value: "reprocess"
-   * @const
-   */
-  "reprocess": "reprocess",
-  /**
-   * value: "webhook"
-   * @const
-   */
-  "webhook": "webhook"
-};
+Submission.prototype['updated_at'] = undefined;
 var _default = exports["default"] = Submission;