docspring 3.3.0 → 4.0.0

package/dist/model/TemplateDefaultsInput.js

@@ -0,0 +1,305 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _CheckCharacter = _interopRequireDefault(require("./CheckCharacter"));
+var _TextAlignment = _interopRequireDefault(require("./TextAlignment"));
+var _Typeface = _interopRequireDefault(require("./Typeface"));
+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 _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 TemplateDefaultsInput model module.
+ * @module model/TemplateDefaultsInput
+ * @version 4.0.0
+ */
+var TemplateDefaultsInput = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplateDefaultsInput</code>.
+   * The default style of the template's fields. Each field can override it.
+   * @alias module:model/TemplateDefaultsInput
+   */
+  function TemplateDefaultsInput() {
+    _classCallCheck(this, TemplateDefaultsInput);
+    TemplateDefaultsInput.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(TemplateDefaultsInput, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>TemplateDefaultsInput</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/TemplateDefaultsInput} obj Optional instance to populate.
+     * @return {module:model/TemplateDefaultsInput} The populated <code>TemplateDefaultsInput</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplateDefaultsInput();
+        if (data.hasOwnProperty('typeface')) {
+          obj['typeface'] = _ApiClient["default"].convertToType(data['typeface'], _Typeface["default"]);
+        }
+        if (data.hasOwnProperty('font_size')) {
+          obj['font_size'] = _ApiClient["default"].convertToType(data['font_size'], 'Number');
+        }
+        if (data.hasOwnProperty('character_spacing')) {
+          obj['character_spacing'] = _ApiClient["default"].convertToType(data['character_spacing'], 'Number');
+        }
+        if (data.hasOwnProperty('color')) {
+          obj['color'] = _ApiClient["default"].convertToType(data['color'], 'String');
+        }
+        if (data.hasOwnProperty('background_color')) {
+          obj['background_color'] = _ApiClient["default"].convertToType(data['background_color'], 'String');
+        }
+        if (data.hasOwnProperty('bold')) {
+          obj['bold'] = _ApiClient["default"].convertToType(data['bold'], 'Boolean');
+        }
+        if (data.hasOwnProperty('uppercase')) {
+          obj['uppercase'] = _ApiClient["default"].convertToType(data['uppercase'], 'Boolean');
+        }
+        if (data.hasOwnProperty('alignment')) {
+          obj['alignment'] = _ApiClient["default"].convertToType(data['alignment'], _TextAlignment["default"]);
+        }
+        if (data.hasOwnProperty('opacity')) {
+          obj['opacity'] = _ApiClient["default"].convertToType(data['opacity'], 'Number');
+        }
+        if (data.hasOwnProperty('date_format')) {
+          obj['date_format'] = _ApiClient["default"].convertToType(data['date_format'], 'String');
+        }
+        if (data.hasOwnProperty('date_time_format')) {
+          obj['date_time_format'] = _ApiClient["default"].convertToType(data['date_time_format'], 'String');
+        }
+        if (data.hasOwnProperty('check_color')) {
+          obj['check_color'] = _ApiClient["default"].convertToType(data['check_color'], 'String');
+        }
+        if (data.hasOwnProperty('check_character')) {
+          obj['check_character'] = _ApiClient["default"].convertToType(data['check_character'], _CheckCharacter["default"]);
+        }
+        if (data.hasOwnProperty('check_background_color')) {
+          obj['check_background_color'] = _ApiClient["default"].convertToType(data['check_background_color'], 'String');
+        }
+        if (data.hasOwnProperty('required_field_background_color')) {
+          obj['required_field_background_color'] = _ApiClient["default"].convertToType(data['required_field_background_color'], 'String');
+        }
+        if (data.hasOwnProperty('true_text')) {
+          obj['true_text'] = _ApiClient["default"].convertToType(data['true_text'], 'String');
+        }
+        if (data.hasOwnProperty('false_text')) {
+          obj['false_text'] = _ApiClient["default"].convertToType(data['false_text'], 'String');
+        }
+        if (data.hasOwnProperty('shape_fill_color')) {
+          obj['shape_fill_color'] = _ApiClient["default"].convertToType(data['shape_fill_color'], 'String');
+        }
+        if (data.hasOwnProperty('shape_border_color')) {
+          obj['shape_border_color'] = _ApiClient["default"].convertToType(data['shape_border_color'], 'String');
+        }
+        if (data.hasOwnProperty('shape_border_width')) {
+          obj['shape_border_width'] = _ApiClient["default"].convertToType(data['shape_border_width'], 'Number');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplateDefaultsInput</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>TemplateDefaultsInput</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data['color'] && !(typeof data['color'] === 'string' || data['color'] instanceof String)) {
+        throw new Error("Expected the field `color` to be a primitive type in the JSON string but got " + data['color']);
+      }
+      // ensure the json data is a string
+      if (data['background_color'] && !(typeof data['background_color'] === 'string' || data['background_color'] instanceof String)) {
+        throw new Error("Expected the field `background_color` to be a primitive type in the JSON string but got " + data['background_color']);
+      }
+      // ensure the json data is a string
+      if (data['date_format'] && !(typeof data['date_format'] === 'string' || data['date_format'] instanceof String)) {
+        throw new Error("Expected the field `date_format` to be a primitive type in the JSON string but got " + data['date_format']);
+      }
+      // ensure the json data is a string
+      if (data['date_time_format'] && !(typeof data['date_time_format'] === 'string' || data['date_time_format'] instanceof String)) {
+        throw new Error("Expected the field `date_time_format` to be a primitive type in the JSON string but got " + data['date_time_format']);
+      }
+      // ensure the json data is a string
+      if (data['check_color'] && !(typeof data['check_color'] === 'string' || data['check_color'] instanceof String)) {
+        throw new Error("Expected the field `check_color` to be a primitive type in the JSON string but got " + data['check_color']);
+      }
+      // ensure the json data is a string
+      if (data['check_background_color'] && !(typeof data['check_background_color'] === 'string' || data['check_background_color'] instanceof String)) {
+        throw new Error("Expected the field `check_background_color` to be a primitive type in the JSON string but got " + data['check_background_color']);
+      }
+      // ensure the json data is a string
+      if (data['required_field_background_color'] && !(typeof data['required_field_background_color'] === 'string' || data['required_field_background_color'] instanceof String)) {
+        throw new Error("Expected the field `required_field_background_color` to be a primitive type in the JSON string but got " + data['required_field_background_color']);
+      }
+      // ensure the json data is a string
+      if (data['true_text'] && !(typeof data['true_text'] === 'string' || data['true_text'] instanceof String)) {
+        throw new Error("Expected the field `true_text` to be a primitive type in the JSON string but got " + data['true_text']);
+      }
+      // ensure the json data is a string
+      if (data['false_text'] && !(typeof data['false_text'] === 'string' || data['false_text'] instanceof String)) {
+        throw new Error("Expected the field `false_text` to be a primitive type in the JSON string but got " + data['false_text']);
+      }
+      // ensure the json data is a string
+      if (data['shape_fill_color'] && !(typeof data['shape_fill_color'] === 'string' || data['shape_fill_color'] instanceof String)) {
+        throw new Error("Expected the field `shape_fill_color` to be a primitive type in the JSON string but got " + data['shape_fill_color']);
+      }
+      // ensure the json data is a string
+      if (data['shape_border_color'] && !(typeof data['shape_border_color'] === 'string' || data['shape_border_color'] instanceof String)) {
+        throw new Error("Expected the field `shape_border_color` to be a primitive type in the JSON string but got " + data['shape_border_color']);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * The font of text fields.
+ * @member {module:model/Typeface} typeface
+ */
+TemplateDefaultsInput.prototype['typeface'] = undefined;
+
+/**
+ * The font size in points, a whole number.
+ * @member {Number} font_size
+ */
+TemplateDefaultsInput.prototype['font_size'] = undefined;
+
+/**
+ * Extra space between characters, in points (0 to 50).
+ * @member {Number} character_spacing
+ */
+TemplateDefaultsInput.prototype['character_spacing'] = undefined;
+
+/**
+ * The text color, as 6 hex digits without `#`, such as `444444`.
+ * @member {String} color
+ */
+TemplateDefaultsInput.prototype['color'] = undefined;
+
+/**
+ * The field's background color, as 6 hex digits.
+ * @member {String} background_color
+ */
+TemplateDefaultsInput.prototype['background_color'] = undefined;
+
+/**
+ * Print text in bold.
+ * @member {Boolean} bold
+ */
+TemplateDefaultsInput.prototype['bold'] = undefined;
+
+/**
+ * Print text in capital letters.
+ * @member {Boolean} uppercase
+ */
+TemplateDefaultsInput.prototype['uppercase'] = undefined;
+
+/**
+ * How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph.
+ * @member {module:model/TextAlignment} alignment
+ */
+TemplateDefaultsInput.prototype['alignment'] = undefined;
+
+/**
+ * The opacity of the field's content, from 0 (invisible) to 1.
+ * @member {Number} opacity
+ */
+TemplateDefaultsInput.prototype['opacity'] = undefined;
+
+/**
+ * How date fields are printed, as a strftime format such as `%m/%d/%Y`.
+ * @member {String} date_format
+ */
+TemplateDefaultsInput.prototype['date_format'] = undefined;
+
+/**
+ * How date-time fields are printed, as a strftime format such as `%m/%d/%Y %H:%M:%S`.
+ * @member {String} date_time_format
+ */
+TemplateDefaultsInput.prototype['date_time_format'] = undefined;
+
+/**
+ * The color of check marks, as 6 hex digits.
+ * @member {String} check_color
+ */
+TemplateDefaultsInput.prototype['check_color'] = undefined;
+
+/**
+ * The character that a ticked check box prints.
+ * @member {module:model/CheckCharacter} check_character
+ */
+TemplateDefaultsInput.prototype['check_character'] = undefined;
+
+/**
+ * The check box's background color, as 6 hex digits.
+ * @member {String} check_background_color
+ */
+TemplateDefaultsInput.prototype['check_background_color'] = undefined;
+
+/**
+ * The background color that highlights required fields on visual forms and signature request forms, as 6 hex digits. PDFs don't print it.
+ * @member {String} required_field_background_color
+ */
+TemplateDefaultsInput.prototype['required_field_background_color'] = undefined;
+
+/**
+ * The text a boolean field prints for `true`.
+ * @member {String} true_text
+ */
+TemplateDefaultsInput.prototype['true_text'] = undefined;
+
+/**
+ * The text a boolean field prints for `false`.
+ * @member {String} false_text
+ */
+TemplateDefaultsInput.prototype['false_text'] = undefined;
+
+/**
+ * The fill color of shapes, as 6 hex digits.
+ * @member {String} shape_fill_color
+ */
+TemplateDefaultsInput.prototype['shape_fill_color'] = undefined;
+
+/**
+ * The border color of shapes, as 6 hex digits.
+ * @member {String} shape_border_color
+ */
+TemplateDefaultsInput.prototype['shape_border_color'] = undefined;
+
+/**
+ * The border width of shapes, in whole points (at least 1).
+ * @member {Number} shape_border_width
+ */
+TemplateDefaultsInput.prototype['shape_border_width'] = undefined;
+var _default = exports["default"] = TemplateDefaultsInput;

package/dist/model/TemplateDocument.js

@@ -0,0 +1,280 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _FieldReimportState = _interopRequireDefault(require("./FieldReimportState"));
+var _TemplateDocumentState = _interopRequireDefault(require("./TemplateDocumentState"));
+var _TemplateFieldLogicStatus = _interopRequireDefault(require("./TemplateFieldLogicStatus"));
+var _TemplatePageProcessingStatus = _interopRequireDefault(require("./TemplatePageProcessingStatus"));
+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 TemplateDocument model module.
+ * @module model/TemplateDocument
+ * @version 4.0.0
+ */
+var TemplateDocument = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplateDocument</code>.
+   * A PDF template's PDF.
+   * @alias module:model/TemplateDocument
+   * @param filename {String} The PDF's file name.
+   * @param md5 {String} The MD5 hash of the PDF.
+   * @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed`. `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one.
+   * @param error_message {String} Why the PDF couldn't be processed, and how to fix it. Null unless `state` is an error.
+   * @param field_reimport_state {module:model/FieldReimportState} Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
+   * @param page_count {Number} 0 until the PDF has been processed.
+   * @param page_dimensions {Array.<Array.<Number>>} Each page's width and height in PDF points. Null until the PDF has been processed.
+   * @param has_fillable_fields {Boolean} Whether the PDF has fillable form fields. Null until DocSpring has read the PDF.
+   * @param page_processing_statuses {Array.<module:model/TemplatePageProcessingStatus>} How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, and for PDFs uploaded before DocSpring recorded page statuses.
+   * @param field_logic_status {module:model/TemplateFieldLogicStatus} AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields).
+   * @param download_url {String} A temporary link to download the PDF.
+   * @param permanent_url {String} A link to download the PDF that doesn't expire. Null until the PDF has been processed.
+   */
+  function TemplateDocument(filename, md5, state, error_message, field_reimport_state, page_count, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url) {
+    _classCallCheck(this, TemplateDocument);
+    TemplateDocument.initialize(this, filename, md5, state, error_message, field_reimport_state, page_count, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url);
+  }
+
+  /**
+   * 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(TemplateDocument, null, [{
+    key: "initialize",
+    value: function initialize(obj, filename, md5, state, error_message, field_reimport_state, page_count, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url) {
+      obj['filename'] = filename;
+      obj['md5'] = md5;
+      obj['state'] = state;
+      obj['error_message'] = error_message;
+      obj['field_reimport_state'] = field_reimport_state;
+      obj['page_count'] = page_count;
+      obj['page_dimensions'] = page_dimensions;
+      obj['has_fillable_fields'] = has_fillable_fields;
+      obj['page_processing_statuses'] = page_processing_statuses;
+      obj['field_logic_status'] = field_logic_status;
+      obj['download_url'] = download_url;
+      obj['permanent_url'] = permanent_url;
+    }
+
+    /**
+     * Constructs a <code>TemplateDocument</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/TemplateDocument} obj Optional instance to populate.
+     * @return {module:model/TemplateDocument} The populated <code>TemplateDocument</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplateDocument();
+        if (data.hasOwnProperty('filename')) {
+          obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
+        }
+        if (data.hasOwnProperty('md5')) {
+          obj['md5'] = _ApiClient["default"].convertToType(data['md5'], 'String');
+        }
+        if (data.hasOwnProperty('state')) {
+          obj['state'] = _ApiClient["default"].convertToType(data['state'], _TemplateDocumentState["default"]);
+        }
+        if (data.hasOwnProperty('error_message')) {
+          obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
+        }
+        if (data.hasOwnProperty('field_reimport_state')) {
+          obj['field_reimport_state'] = _ApiClient["default"].convertToType(data['field_reimport_state'], _FieldReimportState["default"]);
+        }
+        if (data.hasOwnProperty('page_count')) {
+          obj['page_count'] = _ApiClient["default"].convertToType(data['page_count'], 'Number');
+        }
+        if (data.hasOwnProperty('page_dimensions')) {
+          obj['page_dimensions'] = _ApiClient["default"].convertToType(data['page_dimensions'], [['Number']]);
+        }
+        if (data.hasOwnProperty('has_fillable_fields')) {
+          obj['has_fillable_fields'] = _ApiClient["default"].convertToType(data['has_fillable_fields'], 'Boolean');
+        }
+        if (data.hasOwnProperty('page_processing_statuses')) {
+          obj['page_processing_statuses'] = _ApiClient["default"].convertToType(data['page_processing_statuses'], [_TemplatePageProcessingStatus["default"]]);
+        }
+        if (data.hasOwnProperty('field_logic_status')) {
+          obj['field_logic_status'] = _ApiClient["default"].convertToType(data['field_logic_status'], _TemplateFieldLogicStatus["default"]);
+        }
+        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');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplateDocument</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>TemplateDocument</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(TemplateDocument.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['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['md5'] && !(typeof data['md5'] === 'string' || data['md5'] instanceof String)) {
+        throw new Error("Expected the field `md5` to be a primitive type in the JSON string but got " + data['md5']);
+      }
+      // ensure the json data is a string
+      if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
+        throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['page_dimensions'])) {
+        throw new Error("Expected the field `page_dimensions` to be an array in the JSON data but got " + data['page_dimensions']);
+      }
+      if (data['page_processing_statuses']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['page_processing_statuses'])) {
+          throw new Error("Expected the field `page_processing_statuses` to be an array in the JSON data but got " + data['page_processing_statuses']);
+        }
+        // validate the optional field `page_processing_statuses` (array)
+        var _iterator2 = _createForOfIteratorHelper(data['page_processing_statuses']),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var item = _step2.value;
+            _TemplatePageProcessingStatus["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+        ;
+      }
+      // ensure the json data is a string
+      if (data['download_url'] && !(typeof data['download_url'] === 'string' || data['download_url'] instanceof String)) {
+        throw new Error("Expected the field `download_url` to be a primitive type in the JSON string but got " + data['download_url']);
+      }
+      // ensure the json data is a string
+      if (data['permanent_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']);
+      }
+      return true;
+    }
+  }]);
+}();
+TemplateDocument.RequiredProperties = ["filename", "md5", "state", "error_message", "field_reimport_state", "page_count", "page_dimensions", "has_fillable_fields", "page_processing_statuses", "field_logic_status", "download_url", "permanent_url"];
+
+/**
+ * The PDF's file name.
+ * @member {String} filename
+ */
+TemplateDocument.prototype['filename'] = undefined;
+
+/**
+ * The MD5 hash of the PDF.
+ * @member {String} md5
+ */
+TemplateDocument.prototype['md5'] = undefined;
+
+/**
+ * `pending` while DocSpring processes the PDF, then `processed`. `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one.
+ * @member {module:model/TemplateDocumentState} state
+ */
+TemplateDocument.prototype['state'] = undefined;
+
+/**
+ * Why the PDF couldn't be processed, and how to fix it. Null unless `state` is an error.
+ * @member {String} error_message
+ */
+TemplateDocument.prototype['error_message'] = undefined;
+
+/**
+ * Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
+ * @member {module:model/FieldReimportState} field_reimport_state
+ */
+TemplateDocument.prototype['field_reimport_state'] = undefined;
+
+/**
+ * 0 until the PDF has been processed.
+ * @member {Number} page_count
+ */
+TemplateDocument.prototype['page_count'] = undefined;
+
+/**
+ * Each page's width and height in PDF points. Null until the PDF has been processed.
+ * @member {Array.<Array.<Number>>} page_dimensions
+ */
+TemplateDocument.prototype['page_dimensions'] = undefined;
+
+/**
+ * Whether the PDF has fillable form fields. Null until DocSpring has read the PDF.
+ * @member {Boolean} has_fillable_fields
+ */
+TemplateDocument.prototype['has_fillable_fields'] = undefined;
+
+/**
+ * How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, and for PDFs uploaded before DocSpring recorded page statuses.
+ * @member {Array.<module:model/TemplatePageProcessingStatus>} page_processing_statuses
+ */
+TemplateDocument.prototype['page_processing_statuses'] = undefined;
+
+/**
+ * AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields).
+ * @member {module:model/TemplateFieldLogicStatus} field_logic_status
+ */
+TemplateDocument.prototype['field_logic_status'] = undefined;
+
+/**
+ * A temporary link to download the PDF.
+ * @member {String} download_url
+ */
+TemplateDocument.prototype['download_url'] = undefined;
+
+/**
+ * A link to download the PDF that doesn't expire. Null until the PDF has been processed.
+ * @member {String} permanent_url
+ */
+TemplateDocument.prototype['permanent_url'] = undefined;
+var _default = exports["default"] = TemplateDocument;

package/dist/model/TemplateDocumentState.js

@@ -0,0 +1,74 @@
+"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 TemplateDocumentState.
+* @enum {}
+* @readonly
+*/
+var TemplateDocumentState = exports["default"] = /*#__PURE__*/function () {
+  function TemplateDocumentState() {
+    _classCallCheck(this, TemplateDocumentState);
+  }
+  return _createClass(TemplateDocumentState, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>TemplateDocumentState</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/TemplateDocumentState} The enum <code>TemplateDocumentState</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "pending"
+ * @const
+ */
+_defineProperty(TemplateDocumentState, "pending", "pending");
+/**
+ * value: "processed"
+ * @const
+ */
+_defineProperty(TemplateDocumentState, "processed", "processed");
+/**
+ * value: "password_required"
+ * @const
+ */
+_defineProperty(TemplateDocumentState, "password_required", "password_required");
+/**
+ * value: "malformed_pdf"
+ * @const
+ */
+_defineProperty(TemplateDocumentState, "malformed_pdf", "malformed_pdf");
+/**
+ * value: "unknown_error"
+ * @const
+ */
+_defineProperty(TemplateDocumentState, "unknown_error", "unknown_error");