docspring 4.0.0 → 4.2.0

package/dist/model/PageImage.js

@@ -0,0 +1,220 @@
+"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 _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 PageImage model module.
+ * @module model/PageImage
+ * @version 4.2.0
+ */
+var PageImage = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>PageImage</code>.
+   * An image of one page of a PDF, a PNG of a submission's page or a JPEG of a template's.
+   * @alias module:model/PageImage
+   * @extends Object
+   * @param page {Number} The page number, from 1.
+   * @param width {Number} The image's width in pixels.
+   * @param height {Number} The image's height in pixels.
+   * @param download_url {String} A temporary link to download the image. A submission's is null when your account turns off download links for submissions.
+   * @param permanent_url {String} A link to download a submission's image that doesn't expire: it redirects to a new temporary link. It needs your API token or a signed-in session, except for a submission of a template that makes its submissions public. Null for a template's page images.
+   * @param filename {String} The image's file name, such as `sub_123_page_1.png`.
+   * @param content_type {String} The image's media type, `image/png` for a submission's pages or `image/jpeg` for a template's.
+   * @param size {Number} The image's size in bytes.
+   * @param sha256 {String} The SHA-256 hash of the image. Null for a template's page images.
+   */
+  function PageImage(page, width, height, download_url, permanent_url, filename, content_type, size, sha256) {
+    _classCallCheck(this, PageImage);
+    PageImage.initialize(this, page, width, height, download_url, permanent_url, filename, content_type, size, sha256);
+  }
+
+  /**
+   * 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(PageImage, null, [{
+    key: "initialize",
+    value: function initialize(obj, page, width, height, download_url, permanent_url, filename, content_type, size, sha256) {
+      obj['page'] = page;
+      obj['width'] = width;
+      obj['height'] = height;
+      obj['download_url'] = download_url;
+      obj['permanent_url'] = permanent_url;
+      obj['filename'] = filename;
+      obj['content_type'] = content_type;
+      obj['size'] = size;
+      obj['sha256'] = sha256;
+    }
+
+    /**
+     * Constructs a <code>PageImage</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/PageImage} obj Optional instance to populate.
+     * @return {module:model/PageImage} The populated <code>PageImage</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new PageImage();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('page')) {
+          obj['page'] = _ApiClient["default"].convertToType(data['page'], 'Number');
+        }
+        if (data.hasOwnProperty('width')) {
+          obj['width'] = _ApiClient["default"].convertToType(data['width'], 'Number');
+        }
+        if (data.hasOwnProperty('height')) {
+          obj['height'] = _ApiClient["default"].convertToType(data['height'], 'Number');
+        }
+        if (data.hasOwnProperty('download_url')) {
+          obj['download_url'] = _ApiClient["default"].convertToType(data['download_url'], 'String');
+        }
+        if (data.hasOwnProperty('permanent_url')) {
+          obj['permanent_url'] = _ApiClient["default"].convertToType(data['permanent_url'], 'String');
+        }
+        if (data.hasOwnProperty('filename')) {
+          obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
+        }
+        if (data.hasOwnProperty('content_type')) {
+          obj['content_type'] = _ApiClient["default"].convertToType(data['content_type'], 'String');
+        }
+        if (data.hasOwnProperty('size')) {
+          obj['size'] = _ApiClient["default"].convertToType(data['size'], 'Number');
+        }
+        if (data.hasOwnProperty('sha256')) {
+          obj['sha256'] = _ApiClient["default"].convertToType(data['sha256'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>PageImage</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>PageImage</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(PageImage.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      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_url'] && !(typeof data['permanent_url'] === 'string' || data['permanent_url'] instanceof String)) {
+        throw new Error("Expected the field `permanent_url` to be a primitive type in the JSON string but got " + data['permanent_url']);
+      }
+      // ensure the json data is a string
+      if (data['filename'] && !(typeof data['filename'] === 'string' || data['filename'] instanceof String)) {
+        throw new Error("Expected the field `filename` to be a primitive type in the JSON string but got " + data['filename']);
+      }
+      // ensure the json data is a string
+      if (data['content_type'] && !(typeof data['content_type'] === 'string' || data['content_type'] instanceof String)) {
+        throw new Error("Expected the field `content_type` to be a primitive type in the JSON string but got " + data['content_type']);
+      }
+      // ensure the json data is a string
+      if (data['sha256'] && !(typeof data['sha256'] === 'string' || data['sha256'] instanceof String)) {
+        throw new Error("Expected the field `sha256` to be a primitive type in the JSON string but got " + data['sha256']);
+      }
+      return true;
+    }
+  }]);
+}();
+PageImage.RequiredProperties = ["page", "width", "height", "download_url", "permanent_url", "filename", "content_type", "size", "sha256"];
+
+/**
+ * The page number, from 1.
+ * @member {Number} page
+ */
+PageImage.prototype['page'] = undefined;
+
+/**
+ * The image's width in pixels.
+ * @member {Number} width
+ */
+PageImage.prototype['width'] = undefined;
+
+/**
+ * The image's height in pixels.
+ * @member {Number} height
+ */
+PageImage.prototype['height'] = undefined;
+
+/**
+ * A temporary link to download the image. A submission's is null when your account turns off download links for submissions.
+ * @member {String} download_url
+ */
+PageImage.prototype['download_url'] = undefined;
+
+/**
+ * A link to download a submission's image that doesn't expire: it redirects to a new temporary link. It needs your API token or a signed-in session, except for a submission of a template that makes its submissions public. Null for a template's page images.
+ * @member {String} permanent_url
+ */
+PageImage.prototype['permanent_url'] = undefined;
+
+/**
+ * The image's file name, such as `sub_123_page_1.png`.
+ * @member {String} filename
+ */
+PageImage.prototype['filename'] = undefined;
+
+/**
+ * The image's media type, `image/png` for a submission's pages or `image/jpeg` for a template's.
+ * @member {String} content_type
+ */
+PageImage.prototype['content_type'] = undefined;
+
+/**
+ * The image's size in bytes.
+ * @member {Number} size
+ */
+PageImage.prototype['size'] = undefined;
+
+/**
+ * The SHA-256 hash of the image. Null for a template's page images.
+ * @member {String} sha256
+ */
+PageImage.prototype['sha256'] = undefined;
+var _default = exports["default"] = PageImage;

package/dist/model/PageImages.js

@@ -0,0 +1,155 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _GeneratedFileState = _interopRequireDefault(require("./GeneratedFileState"));
+var _PageImage = _interopRequireDefault(require("./PageImage"));
+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 PageImages model module.
+ * @module model/PageImages
+ * @version 4.2.0
+ */
+var PageImages = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>PageImages</code>.
+   * A PNG image of each page of the submission's PDF (the `png` output format), at 140 DPI: a US Letter page is 1190 x 1540 pixels.
+   * @alias module:model/PageImages
+   * @extends Object
+   * @param state {module:model/GeneratedFileState} `processed` once the images have been made, with the PDF or by POST /submissions/{submission_id}/generate_files. `pending` until then, and `error` if they couldn't be made (see `error_message`).
+   * @param error_message {String} Why the images couldn't be made, when `state` is `error`.
+   * @param page_count {Number} How many pages have an image. Null until the images have been made.
+   * @param pages {Array.<module:model/PageImage>} An image of each page, in order: `pages[0]` is page 1. Lists of submissions leave it out (null): get the submission to see them. Empty until the images have been made.
+   */
+  function PageImages(state, error_message, page_count, pages) {
+    _classCallCheck(this, PageImages);
+    PageImages.initialize(this, state, error_message, page_count, pages);
+  }
+
+  /**
+   * 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(PageImages, null, [{
+    key: "initialize",
+    value: function initialize(obj, state, error_message, page_count, pages) {
+      obj['state'] = state;
+      obj['error_message'] = error_message;
+      obj['page_count'] = page_count;
+      obj['pages'] = pages;
+    }
+
+    /**
+     * Constructs a <code>PageImages</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/PageImages} obj Optional instance to populate.
+     * @return {module:model/PageImages} The populated <code>PageImages</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new PageImages();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('state')) {
+          obj['state'] = _ApiClient["default"].convertToType(data['state'], _GeneratedFileState["default"]);
+        }
+        if (data.hasOwnProperty('error_message')) {
+          obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
+        }
+        if (data.hasOwnProperty('page_count')) {
+          obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
+        }
+        if (data.hasOwnProperty('pages')) {
+          obj['pages'] = _ApiClient["default"].convertToType(data['pages'], [_PageImage["default"]]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>PageImages</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>PageImages</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(PageImages.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      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 an array
+      if (!Array.isArray(data['pages'])) {
+        throw new Error("Expected the field `pages` to be an array in the JSON data but got " + data['pages']);
+      }
+      return true;
+    }
+  }]);
+}();
+PageImages.RequiredProperties = ["state", "error_message", "page_count", "pages"];
+
+/**
+ * `processed` once the images have been made, with the PDF or by POST /submissions/{submission_id}/generate_files. `pending` until then, and `error` if they couldn't be made (see `error_message`).
+ * @member {module:model/GeneratedFileState} state
+ */
+PageImages.prototype['state'] = undefined;
+
+/**
+ * Why the images couldn't be made, when `state` is `error`.
+ * @member {String} error_message
+ */
+PageImages.prototype['error_message'] = undefined;
+
+/**
+ * How many pages have an image. Null until the images have been made.
+ * @member {Number} page_count
+ */
+PageImages.prototype['page_count'] = undefined;
+
+/**
+ * An image of each page, in order: `pages[0]` is page 1. Lists of submissions leave it out (null): get the submission to see them. Empty until the images have been made.
+ * @member {Array.<module:model/PageImage>} pages
+ */
+PageImages.prototype['pages'] = undefined;
+var _default = exports["default"] = PageImages;

package/dist/model/PredefinedField.js

@@ -0,0 +1,183 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _FieldType = _interopRequireDefault(require("./FieldType"));
+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 PredefinedField model module.
+ * @module model/PredefinedField
+ * @version 4.2.0
+ */
+var PredefinedField = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>PredefinedField</code>.
+   * A field name that people using the embedded template editor can choose from, with the data type and settings a field gets when it's given that name.
+   * @alias module:model/PredefinedField
+   * @param name {String} The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`).
+   * @param type {module:model/FieldType} The data type a field gets when it's given this name, as a field's `type`.
+   */
+  function PredefinedField(name, type) {
+    _classCallCheck(this, PredefinedField);
+    PredefinedField.initialize(this, name, type);
+  }
+
+  /**
+   * 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(PredefinedField, null, [{
+    key: "initialize",
+    value: function initialize(obj, name, type) {
+      obj['name'] = name;
+      obj['type'] = type;
+    }
+
+    /**
+     * Constructs a <code>PredefinedField</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/PredefinedField} obj Optional instance to populate.
+     * @return {module:model/PredefinedField} The populated <code>PredefinedField</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new PredefinedField();
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+        }
+        if (data.hasOwnProperty('display_name')) {
+          obj['display_name'] = _ApiClient["default"].convertToType(data['display_name'], 'String');
+        }
+        if (data.hasOwnProperty('title')) {
+          obj['title'] = _ApiClient["default"].convertToType(data['title'], 'String');
+        }
+        if (data.hasOwnProperty('type')) {
+          obj['type'] = _ApiClient["default"].convertToType(data['type'], _FieldType["default"]);
+        }
+        if (data.hasOwnProperty('option_list')) {
+          obj['option_list'] = _ApiClient["default"].convertToType(data['option_list'], 'String');
+        }
+        if (data.hasOwnProperty('required_in_template')) {
+          obj['required_in_template'] = _ApiClient["default"].convertToType(data['required_in_template'], 'Boolean');
+        }
+        if (data.hasOwnProperty('field_required')) {
+          obj['field_required'] = _ApiClient["default"].convertToType(data['field_required'], 'Boolean');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>PredefinedField</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>PredefinedField</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(PredefinedField.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
+        throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
+      }
+      // ensure the json data is a string
+      if (data['display_name'] && !(typeof data['display_name'] === 'string' || data['display_name'] instanceof String)) {
+        throw new Error("Expected the field `display_name` to be a primitive type in the JSON string but got " + data['display_name']);
+      }
+      // ensure the json data is a string
+      if (data['title'] && !(typeof data['title'] === 'string' || data['title'] instanceof String)) {
+        throw new Error("Expected the field `title` to be a primitive type in the JSON string but got " + data['title']);
+      }
+      // ensure the json data is a string
+      if (data['option_list'] && !(typeof data['option_list'] === 'string' || data['option_list'] instanceof String)) {
+        throw new Error("Expected the field `option_list` to be a primitive type in the JSON string but got " + data['option_list']);
+      }
+      return true;
+    }
+  }]);
+}();
+PredefinedField.RequiredProperties = ["name", "type"];
+
+/**
+ * The field's name, the key of its value in submission data. A `/` nests the key in objects and arrays (`customer/email`, `signers/0/name`).
+ * @member {String} name
+ */
+PredefinedField.prototype['name'] = undefined;
+
+/**
+ * The name the template editor shows instead of `name`, where a `/` puts it in a folder, such as `Defendant/Name`. Null shows `name`. Two names can't share a display name.
+ * @member {String} display_name
+ */
+PredefinedField.prototype['display_name'] = undefined;
+
+/**
+ * The Title setting a field gets when it's given this name. Null leaves the field's title as it is.
+ * @member {String} title
+ */
+PredefinedField.prototype['title'] = undefined;
+
+/**
+ * The data type a field gets when it's given this name, as a field's `type`.
+ * @member {module:model/FieldType} type
+ */
+PredefinedField.prototype['type'] = undefined;
+
+/**
+ * String fields only: the values allowed, separated by commas, such as `Yes,No`. Null allows any value.
+ * @member {String} option_list
+ */
+PredefinedField.prototype['option_list'] = undefined;
+
+/**
+ * Whether the template must have a field with this name. The embedded editor shows the names that are missing, and with `disableDoneButtonIfPredefinedFieldsMissing` keeps its Done button disabled until the template has them. Default false.
+ * @member {Boolean} required_in_template
+ */
+PredefinedField.prototype['required_in_template'] = undefined;
+
+/**
+ * The Required setting a field gets when it's given this name. Default true.
+ * @member {Boolean} field_required
+ */
+PredefinedField.prototype['field_required'] = undefined;
+var _default = exports["default"] = PredefinedField;