docspring 3.3.0 → 4.1.0

package/dist/model/ValidateSubmissionRequest.js

@@ -0,0 +1,226 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
+var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
+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; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+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 _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.
+ *
+ */
+/**
+ * The ValidateSubmissionRequest model module.
+ * @module model/ValidateSubmissionRequest
+ * @version 4.1.0
+ */
+var ValidateSubmissionRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>ValidateSubmissionRequest</code>.
+   * The submission's data and settings.
+   * @alias module:model/ValidateSubmissionRequest
+   */
+  function ValidateSubmissionRequest() {
+    _classCallCheck(this, ValidateSubmissionRequest);
+    ValidateSubmissionRequest.initialize(this);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(ValidateSubmissionRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>ValidateSubmissionRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/ValidateSubmissionRequest} obj Optional instance to populate.
+     * @return {module:model/ValidateSubmissionRequest} The populated <code>ValidateSubmissionRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new ValidateSubmissionRequest();
+        if (data.hasOwnProperty('test')) {
+          obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
+        }
+        if (data.hasOwnProperty('editable')) {
+          obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
+        }
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], {
+            'String': Object
+          });
+        }
+        if (data.hasOwnProperty('metadata')) {
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
+            'String': Object
+          });
+        }
+        if (data.hasOwnProperty('password')) {
+          obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
+        }
+        if (data.hasOwnProperty('output_formats')) {
+          obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
+        }
+        if (data.hasOwnProperty('expires_in')) {
+          obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
+        }
+        if (data.hasOwnProperty('field_overrides')) {
+          obj['field_overrides'] = _ApiClient["default"].convertToType(data['field_overrides'], {
+            'String': _FieldOverride["default"]
+          });
+        }
+        if (data.hasOwnProperty('html')) {
+          obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
+        }
+        if (data.hasOwnProperty('css')) {
+          obj['css'] = _ApiClient["default"].convertToType(data['css'], 'String');
+        }
+        if (data.hasOwnProperty('signature_requests')) {
+          obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequestInput["default"]]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>ValidateSubmissionRequest</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ValidateSubmissionRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // 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 an array
+      if (!Array.isArray(data['output_formats'])) {
+        throw new Error("Expected the field `output_formats` to be an array in the JSON data but got " + data['output_formats']);
+      }
+      // ensure the json data is a string
+      if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
+        throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
+      }
+      // ensure the json data is a string
+      if (data['css'] && !(typeof data['css'] === 'string' || data['css'] instanceof String)) {
+        throw new Error("Expected the field `css` to be a primitive type in the JSON string but got " + data['css']);
+      }
+      if (data['signature_requests']) {
+        // data not null
+        // 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']);
+        }
+        // validate the optional field `signature_requests` (array)
+        var _iterator = _createForOfIteratorHelper(data['signature_requests']),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+            _SignatureRequestInput["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+        ;
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * 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
+ */
+ValidateSubmissionRequest.prototype['test'] = undefined;
+
+/**
+ * `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
+ */
+ValidateSubmissionRequest.prototype['editable'] = undefined;
+
+/**
+ * The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values.
+ * @member {Object.<String, Object>} data
+ */
+ValidateSubmissionRequest.prototype['data'] = undefined;
+
+/**
+ * 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
+ */
+ValidateSubmissionRequest.prototype['metadata'] = undefined;
+
+/**
+ * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
+ * @member {String} password
+ */
+ValidateSubmissionRequest.prototype['password'] = undefined;
+
+/**
+ * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+ * @member {Array.<module:model/OutputFormat>} output_formats
+ */
+ValidateSubmissionRequest.prototype['output_formats'] = undefined;
+
+/**
+ * Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
+ * @member {Number} expires_in
+ */
+ValidateSubmissionRequest.prototype['expires_in'] = undefined;
+
+/**
+ * Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
+ * @member {Object.<String, module:model/FieldOverride>} field_overrides
+ */
+ValidateSubmissionRequest.prototype['field_overrides'] = undefined;
+
+/**
+ * For an HTML template, HTML to use instead of the template's.
+ * @member {String} html
+ */
+ValidateSubmissionRequest.prototype['html'] = undefined;
+
+/**
+ * For an HTML template, CSS to use instead of the template's.
+ * @member {String} css
+ */
+ValidateSubmissionRequest.prototype['css'] = undefined;
+
+/**
+ * The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`.
+ * @member {Array.<module:model/SignatureRequestInput>} signature_requests
+ */
+ValidateSubmissionRequest.prototype['signature_requests'] = undefined;
+var _default = exports["default"] = ValidateSubmissionRequest;

package/dist/model/Webhook.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _WebhookEventType = _interopRequireDefault(require("./WebhookEventType"));
+var _WebhookMode = _interopRequireDefault(require("./WebhookMode"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
@@ -16,9 +18,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).
@@ -29,33 +31,34 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The Webhook model module.
  * @module model/Webhook
- * @version 3.3.0
+ * @version 4.1.0
  */
 var Webhook = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>Webhook</code>.
+   * An endpoint that DocSpring sends a POST request to when a subscribed event happens.
    * @alias module:model/Webhook
    * @extends Object
-   * @param id {String} 
-   * @param name {String} 
-   * @param url {String} 
-   * @param enabled {Boolean} 
-   * @param event_types {Array.<String>} 
-   * @param mode {module:model/Webhook.ModeEnum} 
-   * @param version {Number} 
-   * @param api_token_ids {Array.<String>} 
-   * @param template_ids {Array.<String>} 
-   * @param folder_ids {Array.<String>} 
-   * @param include_submission_data {Boolean} 
-   * @param strip_fields {Array.<String>} 
-   * @param headers {Object.<String, String>} 
-   * @param consecutive_failures {Number} 
-   * @param last_failure_at {String} 
-   * @param disabled_at {String} 
-   * @param disabled_reason {String} 
-   * @param secret {String} 
-   * @param created_at {String} 
-   * @param updated_at {String} 
+   * @param id {String} The webhook's ID.
+   * @param name {String} A name for the webhook, shown in the dashboard.
+   * @param url {String} The endpoint that receives webhook POST requests.
+   * @param enabled {Boolean} Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
+   * @param event_types {Array.<module:model/WebhookEventType>} The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
+   * @param mode {module:model/WebhookMode} Only send events for test or live submissions. Null sends both.
+   * @param version {Number} The format of the requests DocSpring sends. Webhooks created with API v2 use 4: each event's `data` is the resource as API v2 returns it. Webhooks made in the dashboard or with API v1 use 3, which has API v1's resources and names (`combined_submission`, `submission_data_request`). Versions 1 and 2 are legacy formats for submission events.
+   * @param api_token_ids {Array.<String>} Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events.
+   * @param template_ids {Array.<String>} Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
+   * @param folder_ids {Array.<String>} Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events.
+   * @param include_submission_data {Boolean} Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null.
+   * @param strip_fields {Array.<String>} Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object).
+   * @param headers {Object.<String, String>} Headers to send with each request.
+   * @param consecutive_failures {Number} How many deliveries in a row have failed.
+   * @param last_failure_at {Date} When a delivery last failed.
+   * @param disabled_at {Date} When the webhook was disabled. Null while it is enabled.
+   * @param disabled_reason {String} Why the webhook was disabled, such as after repeated failures.
+   * @param secret {String} The key that signs each request (the X-DocSpring-Signature header), so you can check that a request came from DocSpring. Null for some webhooks created before signing existed.
+   * @param created_at {Date} When the webhook was created.
+   * @param updated_at {Date} When the webhook was last updated.
    */
   function Webhook(id, name, url, enabled, event_types, mode, version, api_token_ids, template_ids, folder_ids, include_submission_data, strip_fields, headers, consecutive_failures, last_failure_at, disabled_at, disabled_reason, secret, created_at, updated_at) {
     _classCallCheck(this, Webhook);
@@ -118,10 +121,10 @@ var Webhook = /*#__PURE__*/function () {
           obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
         }
         if (data.hasOwnProperty('event_types')) {
-          obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], ['String']);
+          obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], [_WebhookEventType["default"]]);
         }
         if (data.hasOwnProperty('mode')) {
-          obj['mode'] = _ApiClient["default"].convertToType(data['mode'], 'String');
+          obj['mode'] = _ApiClient["default"].convertToType(data['mode'], _WebhookMode["default"]);
         }
         if (data.hasOwnProperty('version')) {
           obj['version'] = _ApiClient["default"].convertToType(data['version'], 'Number');
@@ -150,10 +153,10 @@ var Webhook = /*#__PURE__*/function () {
           obj['consecutive_failures'] = _ApiClient["default"].convertToType(data['consecutive_failures'], 'Number');
         }
         if (data.hasOwnProperty('last_failure_at')) {
-          obj['last_failure_at'] = _ApiClient["default"].convertToType(data['last_failure_at'], 'String');
+          obj['last_failure_at'] = _ApiClient["default"].convertToType(data['last_failure_at'], 'Date');
         }
         if (data.hasOwnProperty('disabled_at')) {
-          obj['disabled_at'] = _ApiClient["default"].convertToType(data['disabled_at'], 'String');
+          obj['disabled_at'] = _ApiClient["default"].convertToType(data['disabled_at'], 'Date');
         }
         if (data.hasOwnProperty('disabled_reason')) {
           obj['disabled_reason'] = _ApiClient["default"].convertToType(data['disabled_reason'], 'String');
@@ -162,10 +165,10 @@ var Webhook = /*#__PURE__*/function () {
           obj['secret'] = _ApiClient["default"].convertToType(data['secret'], 'String');
         }
         if (data.hasOwnProperty('created_at')) {
-          obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'String');
+          obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
         }
         if (data.hasOwnProperty('updated_at')) {
-          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'String');
+          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
         }
       }
       return obj;
@@ -210,10 +213,6 @@ var Webhook = /*#__PURE__*/function () {
       if (!Array.isArray(data['event_types'])) {
         throw new Error("Expected the field `event_types` to be an array in the JSON data but got " + data['event_types']);
       }
-      // ensure the json data is a string
-      if (data['mode'] && !(typeof data['mode'] === 'string' || data['mode'] instanceof String)) {
-        throw new Error("Expected the field `mode` to be a primitive type in the JSON string but got " + data['mode']);
-      }
       // ensure the json data is an array
       if (!Array.isArray(data['api_token_ids'])) {
         throw new Error("Expected the field `api_token_ids` to be an array in the JSON data but got " + data['api_token_ids']);
@@ -231,14 +230,6 @@ var Webhook = /*#__PURE__*/function () {
         throw new Error("Expected the field `strip_fields` to be an array in the JSON data but got " + data['strip_fields']);
       }
       // ensure the json data is a string
-      if (data['last_failure_at'] && !(typeof data['last_failure_at'] === 'string' || data['last_failure_at'] instanceof String)) {
-        throw new Error("Expected the field `last_failure_at` to be a primitive type in the JSON string but got " + data['last_failure_at']);
-      }
-      // ensure the json data is a string
-      if (data['disabled_at'] && !(typeof data['disabled_at'] === 'string' || data['disabled_at'] instanceof String)) {
-        throw new Error("Expected the field `disabled_at` to be a primitive type in the JSON string but got " + data['disabled_at']);
-      }
-      // ensure the json data is a string
       if (data['disabled_reason'] && !(typeof data['disabled_reason'] === 'string' || data['disabled_reason'] instanceof String)) {
         throw new Error("Expected the field `disabled_reason` to be a primitive type in the JSON string but got " + data['disabled_reason']);
       }
@@ -246,14 +237,6 @@ var Webhook = /*#__PURE__*/function () {
       if (data['secret'] && !(typeof data['secret'] === 'string' || data['secret'] instanceof String)) {
         throw new Error("Expected the field `secret` to be a primitive type in the JSON string but got " + data['secret']);
       }
-      // ensure the json data is a string
-      if (data['created_at'] && !(typeof data['created_at'] === 'string' || data['created_at'] instanceof String)) {
-        throw new Error("Expected the field `created_at` to be a primitive type in the JSON string but got " + data['created_at']);
-      }
-      // ensure the json data is a string
-      if (data['updated_at'] && !(typeof data['updated_at'] === 'string' || data['updated_at'] instanceof String)) {
-        throw new Error("Expected the field `updated_at` to be a primitive type in the JSON string but got " + data['updated_at']);
-      }
       return true;
     }
   }]);
@@ -261,120 +244,122 @@ var Webhook = /*#__PURE__*/function () {
 Webhook.RequiredProperties = ["id", "name", "url", "enabled", "event_types", "mode", "version", "api_token_ids", "template_ids", "folder_ids", "include_submission_data", "strip_fields", "headers", "consecutive_failures", "last_failure_at", "disabled_at", "disabled_reason", "secret", "created_at", "updated_at"];
 
 /**
+ * The webhook's ID.
  * @member {String} id
  */
 Webhook.prototype['id'] = undefined;
 
 /**
+ * A name for the webhook, shown in the dashboard.
  * @member {String} name
  */
 Webhook.prototype['name'] = undefined;
 
 /**
+ * The endpoint that receives webhook POST requests.
  * @member {String} url
  */
 Webhook.prototype['url'] = undefined;
 
 /**
+ * Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
  * @member {Boolean} enabled
  */
 Webhook.prototype['enabled'] = undefined;
 
 /**
- * @member {Array.<String>} event_types
+ * The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
+ * @member {Array.<module:model/WebhookEventType>} event_types
  */
 Webhook.prototype['event_types'] = undefined;
 
 /**
- * @member {module:model/Webhook.ModeEnum} mode
+ * Only send events for test or live submissions. Null sends both.
+ * @member {module:model/WebhookMode} mode
  */
 Webhook.prototype['mode'] = undefined;
 
 /**
+ * The format of the requests DocSpring sends. Webhooks created with API v2 use 4: each event's `data` is the resource as API v2 returns it. Webhooks made in the dashboard or with API v1 use 3, which has API v1's resources and names (`combined_submission`, `submission_data_request`). Versions 1 and 2 are legacy formats for submission events.
  * @member {Number} version
  */
 Webhook.prototype['version'] = undefined;
 
 /**
+ * Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events.
  * @member {Array.<String>} api_token_ids
  */
 Webhook.prototype['api_token_ids'] = undefined;
 
 /**
+ * Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
  * @member {Array.<String>} template_ids
  */
 Webhook.prototype['template_ids'] = undefined;
 
 /**
+ * Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events.
  * @member {Array.<String>} folder_ids
  */
 Webhook.prototype['folder_ids'] = undefined;
 
 /**
+ * Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null.
  * @member {Boolean} include_submission_data
  */
 Webhook.prototype['include_submission_data'] = undefined;
 
 /**
+ * Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object).
  * @member {Array.<String>} strip_fields
  */
 Webhook.prototype['strip_fields'] = undefined;
 
 /**
+ * Headers to send with each request.
  * @member {Object.<String, String>} headers
  */
 Webhook.prototype['headers'] = undefined;
 
 /**
+ * How many deliveries in a row have failed.
  * @member {Number} consecutive_failures
  */
 Webhook.prototype['consecutive_failures'] = undefined;
 
 /**
- * @member {String} last_failure_at
+ * When a delivery last failed.
+ * @member {Date} last_failure_at
  */
 Webhook.prototype['last_failure_at'] = undefined;
 
 /**
- * @member {String} disabled_at
+ * When the webhook was disabled. Null while it is enabled.
+ * @member {Date} disabled_at
  */
 Webhook.prototype['disabled_at'] = undefined;
 
 /**
+ * Why the webhook was disabled, such as after repeated failures.
  * @member {String} disabled_reason
  */
 Webhook.prototype['disabled_reason'] = undefined;
 
 /**
+ * The key that signs each request (the X-DocSpring-Signature header), so you can check that a request came from DocSpring. Null for some webhooks created before signing existed.
  * @member {String} secret
  */
 Webhook.prototype['secret'] = undefined;
 
 /**
- * @member {String} created_at
+ * When the webhook was created.
+ * @member {Date} created_at
  */
 Webhook.prototype['created_at'] = undefined;
 
 /**
- * @member {String} updated_at
+ * When the webhook was last updated.
+ * @member {Date} updated_at
  */
 Webhook.prototype['updated_at'] = undefined;
-
-/**
- * Allowed values for the <code>mode</code> property.
- * @enum {String}
- * @readonly
- */
-Webhook['ModeEnum'] = {
-  /**
-   * value: "test"
-   * @const
-   */
-  "test": "test",
-  /**
-   * value: "live"
-   * @const
-   */
-  "live": "live"
-};
 var _default = exports["default"] = Webhook;