docspring 3.2.0 → 4.0.0

package/dist/model/SubmissionAction.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _SubmissionActionState = _interopRequireDefault(require("./SubmissionActionState"));
+var _SubmissionActionType = _interopRequireDefault(require("./SubmissionActionType"));
 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,7 +20,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  * DocSpring API
  * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
  *
- * The version of the OpenAPI document: v1
+ * The version of the OpenAPI document: v2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,24 +31,24 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionAction model module.
  * @module model/SubmissionAction
- * @version 3.2.0
+ * @version 4.0.0
  */
 var SubmissionAction = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>SubmissionAction</code>.
+   * An upload of a PDF to your storage, such as an S3 bucket.
    * @alias module:model/SubmissionAction
    * @extends Object
-   * @param id {String} 
-   * @param integration_id {String} 
-   * @param state {module:model/SubmissionAction.StateEnum} 
-   * @param action_type {module:model/SubmissionAction.ActionTypeEnum} 
-   * @param action_category {module:model/SubmissionAction.ActionCategoryEnum} 
-   * @param result_data {Object} 
-   * @param error_message {String} 
+   * @param id {String} The upload's ID.
+   * @param integration_id {String} The ID of the account integration it used.
+   * @param state {module:model/SubmissionActionState} `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring.
+   * @param action_type {module:model/SubmissionActionType} The kind of storage, such as `aws_s3_upload` for an S3 bucket.
+   * @param result_data {Object.<String, Object>} Where the PDF was uploaded, such as the S3 bucket and key.
+   * @param error_message {String} Why the upload failed, when `state` is `failed` or `error`.
    */
-  function SubmissionAction(id, integration_id, state, action_type, action_category, result_data, error_message) {
+  function SubmissionAction(id, integration_id, state, action_type, result_data, error_message) {
     _classCallCheck(this, SubmissionAction);
-    SubmissionAction.initialize(this, id, integration_id, state, action_type, action_category, result_data, error_message);
+    SubmissionAction.initialize(this, id, integration_id, state, action_type, result_data, error_message);
   }
 
   /**
@@ -56,12 +58,11 @@ var SubmissionAction = /*#__PURE__*/function () {
    */
   return _createClass(SubmissionAction, null, [{
     key: "initialize",
-    value: function initialize(obj, id, integration_id, state, action_type, action_category, result_data, error_message) {
+    value: function initialize(obj, id, integration_id, state, action_type, result_data, error_message) {
       obj['id'] = id;
       obj['integration_id'] = integration_id;
       obj['state'] = state;
       obj['action_type'] = action_type;
-      obj['action_category'] = action_category;
       obj['result_data'] = result_data;
       obj['error_message'] = error_message;
     }
@@ -86,16 +87,15 @@ var SubmissionAction = /*#__PURE__*/function () {
           obj['integration_id'] = _ApiClient["default"].convertToType(data['integration_id'], 'String');
         }
         if (data.hasOwnProperty('state')) {
-          obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
+          obj['state'] = _ApiClient["default"].convertToType(data['state'], _SubmissionActionState["default"]);
         }
         if (data.hasOwnProperty('action_type')) {
-          obj['action_type'] = _ApiClient["default"].convertToType(data['action_type'], 'String');
-        }
-        if (data.hasOwnProperty('action_category')) {
-          obj['action_category'] = _ApiClient["default"].convertToType(data['action_category'], 'String');
+          obj['action_type'] = _ApiClient["default"].convertToType(data['action_type'], _SubmissionActionType["default"]);
         }
         if (data.hasOwnProperty('result_data')) {
-          obj['result_data'] = _ApiClient["default"].convertToType(data['result_data'], Object);
+          obj['result_data'] = _ApiClient["default"].convertToType(data['result_data'], {
+            'String': Object
+          });
         }
         if (data.hasOwnProperty('error_message')) {
           obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
@@ -136,18 +136,6 @@ var SubmissionAction = /*#__PURE__*/function () {
         throw new Error("Expected the field `integration_id` to be a primitive type in the JSON string but got " + data['integration_id']);
       }
       // 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['action_type'] && !(typeof data['action_type'] === 'string' || data['action_type'] instanceof String)) {
-        throw new Error("Expected the field `action_type` to be a primitive type in the JSON string but got " + data['action_type']);
-      }
-      // ensure the json data is a string
-      if (data['action_category'] && !(typeof data['action_category'] === 'string' || data['action_category'] instanceof String)) {
-        throw new Error("Expected the field `action_category` to be a primitive type in the JSON string but got " + data['action_category']);
-      }
-      // 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']);
       }
@@ -155,114 +143,41 @@ var SubmissionAction = /*#__PURE__*/function () {
     }
   }]);
 }();
-SubmissionAction.RequiredProperties = ["id", "integration_id", "state", "action_type", "action_category", "result_data", "error_message"];
+SubmissionAction.RequiredProperties = ["id", "integration_id", "state", "action_type", "result_data", "error_message"];
 
 /**
+ * The upload's ID.
  * @member {String} id
  */
 SubmissionAction.prototype['id'] = undefined;
 
 /**
+ * The ID of the account integration it used.
  * @member {String} integration_id
  */
 SubmissionAction.prototype['integration_id'] = undefined;
 
 /**
- * @member {module:model/SubmissionAction.StateEnum} state
+ * `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring.
+ * @member {module:model/SubmissionActionState} state
  */
 SubmissionAction.prototype['state'] = undefined;
 
 /**
- * @member {module:model/SubmissionAction.ActionTypeEnum} action_type
+ * The kind of storage, such as `aws_s3_upload` for an S3 bucket.
+ * @member {module:model/SubmissionActionType} action_type
  */
 SubmissionAction.prototype['action_type'] = undefined;
 
 /**
- * @member {module:model/SubmissionAction.ActionCategoryEnum} action_category
- */
-SubmissionAction.prototype['action_category'] = undefined;
-
-/**
- * @member {Object} result_data
+ * Where the PDF was uploaded, such as the S3 bucket and key.
+ * @member {Object.<String, Object>} result_data
  */
 SubmissionAction.prototype['result_data'] = undefined;
 
 /**
+ * Why the upload failed, when `state` is `failed` or `error`.
  * @member {String} error_message
  */
 SubmissionAction.prototype['error_message'] = undefined;
-
-/**
- * Allowed values for the <code>state</code> property.
- * @enum {String}
- * @readonly
- */
-SubmissionAction['StateEnum'] = {
-  /**
-   * value: "pending"
-   * @const
-   */
-  "pending": "pending",
-  /**
-   * value: "processed"
-   * @const
-   */
-  "processed": "processed",
-  /**
-   * value: "failed"
-   * @const
-   */
-  "failed": "failed",
-  /**
-   * value: "error"
-   * @const
-   */
-  "error": "error"
-};
-
-/**
- * Allowed values for the <code>action_type</code> property.
- * @enum {String}
- * @readonly
- */
-SubmissionAction['ActionTypeEnum'] = {
-  /**
-   * value: "webhook"
-   * @const
-   */
-  "webhook": "webhook",
-  /**
-   * value: "slack_webhook"
-   * @const
-   */
-  "slack_webhook": "slack_webhook",
-  /**
-   * value: "email"
-   * @const
-   */
-  "email": "email",
-  /**
-   * value: "aws_s3_upload"
-   * @const
-   */
-  "aws_s3_upload": "aws_s3_upload"
-};
-
-/**
- * Allowed values for the <code>action_category</code> property.
- * @enum {String}
- * @readonly
- */
-SubmissionAction['ActionCategoryEnum'] = {
-  /**
-   * value: "notification"
-   * @const
-   */
-  "notification": "notification",
-  /**
-   * value: "file_upload"
-   * @const
-   */
-  "file_upload": "file_upload"
-};
 var _default = exports["default"] = SubmissionAction;

package/dist/model/SubmissionActionState.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
+ * DocSpring API
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ *
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+* Enum class SubmissionActionState.
+* @enum {}
+* @readonly
+*/
+var SubmissionActionState = exports["default"] = /*#__PURE__*/function () {
+  function SubmissionActionState() {
+    _classCallCheck(this, SubmissionActionState);
+  }
+  return _createClass(SubmissionActionState, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>SubmissionActionState</code> enum value from a Javascript object name.
+    * @param {Object} data The plain JavaScript object containing the name of the enum value.
+    * @return {module:model/SubmissionActionState} The enum <code>SubmissionActionState</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "pending"
+ * @const
+ */
+_defineProperty(SubmissionActionState, "pending", "pending");
+/**
+ * value: "processed"
+ * @const
+ */
+_defineProperty(SubmissionActionState, "processed", "processed");
+/**
+ * value: "failed"
+ * @const
+ */
+_defineProperty(SubmissionActionState, "failed", "failed");
+/**
+ * value: "error"
+ * @const
+ */
+_defineProperty(SubmissionActionState, "error", "error");

package/dist/model/SubmissionActionType.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
+ * DocSpring API
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ *
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+* Enum class SubmissionActionType.
+* @enum {}
+* @readonly
+*/
+var SubmissionActionType = exports["default"] = /*#__PURE__*/function () {
+  function SubmissionActionType() {
+    _classCallCheck(this, SubmissionActionType);
+  }
+  return _createClass(SubmissionActionType, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>SubmissionActionType</code> enum value from a Javascript object name.
+    * @param {Object} data The plain JavaScript object containing the name of the enum value.
+    * @return {module:model/SubmissionActionType} The enum <code>SubmissionActionType</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "webhook"
+ * @const
+ */
+_defineProperty(SubmissionActionType, "webhook", "webhook");
+/**
+ * value: "slack_webhook"
+ * @const
+ */
+_defineProperty(SubmissionActionType, "slack_webhook", "slack_webhook");
+/**
+ * value: "email"
+ * @const
+ */
+_defineProperty(SubmissionActionType, "email", "email");
+/**
+ * value: "aws_s3_upload"
+ * @const
+ */
+_defineProperty(SubmissionActionType, "aws_s3_upload", "aws_s3_upload");
+/**
+ * value: "dropbox_upload"
+ * @const
+ */
+_defineProperty(SubmissionActionType, "dropbox_upload", "dropbox_upload");
+/**
+ * value: "google_drive_upload"
+ * @const
+ */
+_defineProperty(SubmissionActionType, "google_drive_upload", "google_drive_upload");
+/**
+ * value: "box_upload"
+ * @const
+ */
+_defineProperty(SubmissionActionType, "box_upload", "box_upload");

package/dist/model/SubmissionBatch.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _Submission = _interopRequireDefault(require("./Submission"));
+var _SubmissionBatchState = _interopRequireDefault(require("./SubmissionBatchState"));
 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,7 +20,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  * DocSpring API
  * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
  *
- * The version of the OpenAPI document: v1
+ * The version of the OpenAPI document: v2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,25 +31,29 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionBatch model module.
  * @module model/SubmissionBatch
- * @version 3.2.0
+ * @version 4.0.0
  */
 var SubmissionBatch = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>SubmissionBatch</code>.
+   * Submissions created together in one request. Their PDFs are only generated when every submission in the batch is valid.
    * @alias module:model/SubmissionBatch
    * @extends Object
-   * @param id {String} 
-   * @param state {module:model/SubmissionBatch.StateEnum} 
-   * @param metadata {Object} 
-   * @param processed_at {String} 
-   * @param total_count {Number} 
-   * @param pending_count {Number} 
-   * @param error_count {Number} 
-   * @param completion_percentage {Number} 
+   * @param id {String} The batch's ID.
+   * @param state {module:model/SubmissionBatchState} `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
+   * @param metadata {Object.<String, Object>} Your own data about the batch, such as an ID from your app.
+   * @param total_count {Number} The number of submissions in the request.
+   * @param pending_count {Number} The submissions whose PDFs haven't been generated yet.
+   * @param error_count {Number} The submissions that were invalid or whose PDFs couldn't be generated.
+   * @param completion_percentage {Number} The percentage of the batch's submissions that have finished, from 0 to 100.
+   * @param submissions {Array.<module:model/Submission>} The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`.
+   * @param processed_at {Date} When every submission had finished.
+   * @param created_at {Date} When the batch was created.
+   * @param updated_at {Date} When the batch was last updated.
    */
-  function SubmissionBatch(id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage) {
+  function SubmissionBatch(id, state, metadata, total_count, pending_count, error_count, completion_percentage, submissions, processed_at, created_at, updated_at) {
     _classCallCheck(this, SubmissionBatch);
-    SubmissionBatch.initialize(this, id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage);
+    SubmissionBatch.initialize(this, id, state, metadata, total_count, pending_count, error_count, completion_percentage, submissions, processed_at, created_at, updated_at);
   }
 
   /**
@@ -57,15 +63,18 @@ var SubmissionBatch = /*#__PURE__*/function () {
    */
   return _createClass(SubmissionBatch, null, [{
     key: "initialize",
-    value: function initialize(obj, id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage) {
+    value: function initialize(obj, id, state, metadata, total_count, pending_count, error_count, completion_percentage, submissions, processed_at, created_at, updated_at) {
       obj['id'] = id;
       obj['state'] = state;
       obj['metadata'] = metadata;
-      obj['processed_at'] = processed_at;
       obj['total_count'] = total_count;
       obj['pending_count'] = pending_count;
       obj['error_count'] = error_count;
       obj['completion_percentage'] = completion_percentage;
+      obj['submissions'] = submissions;
+      obj['processed_at'] = processed_at;
+      obj['created_at'] = created_at;
+      obj['updated_at'] = updated_at;
     }
 
     /**
@@ -85,13 +94,12 @@ var SubmissionBatch = /*#__PURE__*/function () {
           obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
         }
         if (data.hasOwnProperty('state')) {
-          obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
+          obj['state'] = _ApiClient["default"].convertToType(data['state'], _SubmissionBatchState["default"]);
         }
         if (data.hasOwnProperty('metadata')) {
-          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
-        }
-        if (data.hasOwnProperty('processed_at')) {
-          obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'String');
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
+            'String': Object
+          });
         }
         if (data.hasOwnProperty('total_count')) {
           obj['total_count'] = _ApiClient["default"].convertToType(data['total_count'], 'Number');
@@ -105,6 +113,18 @@ var SubmissionBatch = /*#__PURE__*/function () {
         if (data.hasOwnProperty('completion_percentage')) {
           obj['completion_percentage'] = _ApiClient["default"].convertToType(data['completion_percentage'], 'Number');
         }
+        if (data.hasOwnProperty('submissions')) {
+          obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_Submission["default"]]);
+        }
+        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;
     }
@@ -136,80 +156,79 @@ var SubmissionBatch = /*#__PURE__*/function () {
       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 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['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 an array
+      if (!Array.isArray(data['submissions'])) {
+        throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
       }
       return true;
     }
   }]);
 }();
-SubmissionBatch.RequiredProperties = ["id", "state", "metadata", "processed_at", "total_count", "pending_count", "error_count", "completion_percentage"];
+SubmissionBatch.RequiredProperties = ["id", "state", "metadata", "total_count", "pending_count", "error_count", "completion_percentage", "submissions", "processed_at", "created_at", "updated_at"];
 
 /**
+ * The batch's ID.
  * @member {String} id
  */
 SubmissionBatch.prototype['id'] = undefined;
 
 /**
- * @member {module:model/SubmissionBatch.StateEnum} state
+ * `pending` while the PDFs are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
+ * @member {module:model/SubmissionBatchState} state
  */
 SubmissionBatch.prototype['state'] = undefined;
 
 /**
- * @member {Object} metadata
+ * Your own data about the batch, such as an ID from your app.
+ * @member {Object.<String, Object>} metadata
  */
 SubmissionBatch.prototype['metadata'] = undefined;
 
 /**
- * @member {String} processed_at
- */
-SubmissionBatch.prototype['processed_at'] = undefined;
-
-/**
+ * The number of submissions in the request.
  * @member {Number} total_count
  */
 SubmissionBatch.prototype['total_count'] = undefined;
 
 /**
+ * The submissions whose PDFs haven't been generated yet.
  * @member {Number} pending_count
  */
 SubmissionBatch.prototype['pending_count'] = undefined;
 
 /**
+ * The submissions that were invalid or whose PDFs couldn't be generated.
  * @member {Number} error_count
  */
 SubmissionBatch.prototype['error_count'] = undefined;
 
 /**
+ * The percentage of the batch's submissions that have finished, from 0 to 100.
  * @member {Number} completion_percentage
  */
 SubmissionBatch.prototype['completion_percentage'] = undefined;
 
 /**
- * Allowed values for the <code>state</code> property.
- * @enum {String}
- * @readonly
+ * The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`.
+ * @member {Array.<module:model/Submission>} submissions
  */
-SubmissionBatch['StateEnum'] = {
-  /**
-   * value: "pending"
-   * @const
-   */
-  "pending": "pending",
-  /**
-   * value: "processed"
-   * @const
-   */
-  "processed": "processed",
-  /**
-   * value: "error"
-   * @const
-   */
-  "error": "error"
-};
+SubmissionBatch.prototype['submissions'] = undefined;
+
+/**
+ * When every submission had finished.
+ * @member {Date} processed_at
+ */
+SubmissionBatch.prototype['processed_at'] = undefined;
+
+/**
+ * When the batch was created.
+ * @member {Date} created_at
+ */
+SubmissionBatch.prototype['created_at'] = undefined;
+
+/**
+ * When the batch was last updated.
+ * @member {Date} updated_at
+ */
+SubmissionBatch.prototype['updated_at'] = undefined;
 var _default = exports["default"] = SubmissionBatch;