docspring 4.0.0 → 4.2.0

package/dist/model/TemplateDiff.js

@@ -0,0 +1,206 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _TemplateDiffSummary = _interopRequireDefault(require("./TemplateDiffSummary"));
+var _TemplateFieldChanges = _interopRequireDefault(require("./TemplateFieldChanges"));
+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 TemplateDiff model module.
+ * @module model/TemplateDiff
+ * @version 4.2.0
+ */
+var TemplateDiff = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplateDiff</code>.
+   * What changed in a version of a template since the version before it: the draft since the latest published version, or a published version since the one before it. Fields are compared with all their settings, so `y` is measured from the top of each field's page.
+   * @alias module:model/TemplateDiff
+   * @extends Object
+   * @param template_id {String} The template's ID.
+   * @param from_version {String} The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added.
+   * @param to_version {String} The later version, such as `1.2.0`. Null for the draft.
+   * @param summary {module:model/TemplateDiffSummary} How many changes of each kind there are.
+   * @param fields {module:model/TemplateFieldChanges} The fields that changed.
+   * @param changed_settings {Array.<String>} The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change.
+   * @param document_changed {Boolean} The template's PDF was replaced (or added, when there's no `from_version`).
+   */
+  function TemplateDiff(template_id, from_version, to_version, summary, fields, changed_settings, document_changed) {
+    _classCallCheck(this, TemplateDiff);
+    TemplateDiff.initialize(this, template_id, from_version, to_version, summary, fields, changed_settings, document_changed);
+  }
+
+  /**
+   * 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(TemplateDiff, null, [{
+    key: "initialize",
+    value: function initialize(obj, template_id, from_version, to_version, summary, fields, changed_settings, document_changed) {
+      obj['template_id'] = template_id;
+      obj['from_version'] = from_version;
+      obj['to_version'] = to_version;
+      obj['summary'] = summary;
+      obj['fields'] = fields;
+      obj['changed_settings'] = changed_settings;
+      obj['document_changed'] = document_changed;
+    }
+
+    /**
+     * Constructs a <code>TemplateDiff</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/TemplateDiff} obj Optional instance to populate.
+     * @return {module:model/TemplateDiff} The populated <code>TemplateDiff</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplateDiff();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('template_id')) {
+          obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
+        }
+        if (data.hasOwnProperty('from_version')) {
+          obj['from_version'] = _ApiClient["default"].convertToType(data['from_version'], 'String');
+        }
+        if (data.hasOwnProperty('to_version')) {
+          obj['to_version'] = _ApiClient["default"].convertToType(data['to_version'], 'String');
+        }
+        if (data.hasOwnProperty('summary')) {
+          obj['summary'] = _ApiClient["default"].convertToType(data['summary'], _TemplateDiffSummary["default"]);
+        }
+        if (data.hasOwnProperty('fields')) {
+          obj['fields'] = _ApiClient["default"].convertToType(data['fields'], _TemplateFieldChanges["default"]);
+        }
+        if (data.hasOwnProperty('changed_settings')) {
+          obj['changed_settings'] = _ApiClient["default"].convertToType(data['changed_settings'], ['String']);
+        }
+        if (data.hasOwnProperty('document_changed')) {
+          obj['document_changed'] = _ApiClient["default"].convertToType(data['document_changed'], 'Boolean');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplateDiff</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>TemplateDiff</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(TemplateDiff.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['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
+        throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
+      }
+      // ensure the json data is a string
+      if (data['from_version'] && !(typeof data['from_version'] === 'string' || data['from_version'] instanceof String)) {
+        throw new Error("Expected the field `from_version` to be a primitive type in the JSON string but got " + data['from_version']);
+      }
+      // ensure the json data is a string
+      if (data['to_version'] && !(typeof data['to_version'] === 'string' || data['to_version'] instanceof String)) {
+        throw new Error("Expected the field `to_version` to be a primitive type in the JSON string but got " + data['to_version']);
+      }
+      // validate the optional field `summary`
+      if (data['summary']) {
+        // data not null
+        _TemplateDiffSummary["default"].validateJSON(data['summary']);
+      }
+      // validate the optional field `fields`
+      if (data['fields']) {
+        // data not null
+        _TemplateFieldChanges["default"].validateJSON(data['fields']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['changed_settings'])) {
+        throw new Error("Expected the field `changed_settings` to be an array in the JSON data but got " + data['changed_settings']);
+      }
+      return true;
+    }
+  }]);
+}();
+TemplateDiff.RequiredProperties = ["template_id", "from_version", "to_version", "summary", "fields", "changed_settings", "document_changed"];
+
+/**
+ * The template's ID.
+ * @member {String} template_id
+ */
+TemplateDiff.prototype['template_id'] = undefined;
+
+/**
+ * The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added.
+ * @member {String} from_version
+ */
+TemplateDiff.prototype['from_version'] = undefined;
+
+/**
+ * The later version, such as `1.2.0`. Null for the draft.
+ * @member {String} to_version
+ */
+TemplateDiff.prototype['to_version'] = undefined;
+
+/**
+ * How many changes of each kind there are.
+ * @member {module:model/TemplateDiffSummary} summary
+ */
+TemplateDiff.prototype['summary'] = undefined;
+
+/**
+ * The fields that changed.
+ * @member {module:model/TemplateFieldChanges} fields
+ */
+TemplateDiff.prototype['fields'] = undefined;
+
+/**
+ * The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change.
+ * @member {Array.<String>} changed_settings
+ */
+TemplateDiff.prototype['changed_settings'] = undefined;
+
+/**
+ * The template's PDF was replaced (or added, when there's no `from_version`).
+ * @member {Boolean} document_changed
+ */
+TemplateDiff.prototype['document_changed'] = undefined;
+var _default = exports["default"] = TemplateDiff;

package/dist/model/TemplateDiffSummary.js

@@ -0,0 +1,165 @@
+"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 TemplateDiffSummary model module.
+ * @module model/TemplateDiffSummary
+ * @version 4.2.0
+ */
+var TemplateDiffSummary = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplateDiffSummary</code>.
+   * How many changes of each kind a template diff has.
+   * @alias module:model/TemplateDiffSummary
+   * @param fields_added {Number} How many fields were added.
+   * @param fields_removed {Number} How many fields were removed.
+   * @param fields_changed {Number} How many fields have changed settings.
+   * @param fields_reordered {Number} How many fields moved in the template's field order.
+   * @param settings_changed {Number} How many of the template's settings changed.
+   * @param total_changes {Number} All the changes, counting a new document as one. Zero when the versions are the same.
+   */
+  function TemplateDiffSummary(fields_added, fields_removed, fields_changed, fields_reordered, settings_changed, total_changes) {
+    _classCallCheck(this, TemplateDiffSummary);
+    TemplateDiffSummary.initialize(this, fields_added, fields_removed, fields_changed, fields_reordered, settings_changed, total_changes);
+  }
+
+  /**
+   * 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(TemplateDiffSummary, null, [{
+    key: "initialize",
+    value: function initialize(obj, fields_added, fields_removed, fields_changed, fields_reordered, settings_changed, total_changes) {
+      obj['fields_added'] = fields_added;
+      obj['fields_removed'] = fields_removed;
+      obj['fields_changed'] = fields_changed;
+      obj['fields_reordered'] = fields_reordered;
+      obj['settings_changed'] = settings_changed;
+      obj['total_changes'] = total_changes;
+    }
+
+    /**
+     * Constructs a <code>TemplateDiffSummary</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/TemplateDiffSummary} obj Optional instance to populate.
+     * @return {module:model/TemplateDiffSummary} The populated <code>TemplateDiffSummary</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplateDiffSummary();
+        if (data.hasOwnProperty('fields_added')) {
+          obj['fields_added'] = _ApiClient["default"].convertToType(data['fields_added'], 'Number');
+        }
+        if (data.hasOwnProperty('fields_removed')) {
+          obj['fields_removed'] = _ApiClient["default"].convertToType(data['fields_removed'], 'Number');
+        }
+        if (data.hasOwnProperty('fields_changed')) {
+          obj['fields_changed'] = _ApiClient["default"].convertToType(data['fields_changed'], 'Number');
+        }
+        if (data.hasOwnProperty('fields_reordered')) {
+          obj['fields_reordered'] = _ApiClient["default"].convertToType(data['fields_reordered'], 'Number');
+        }
+        if (data.hasOwnProperty('settings_changed')) {
+          obj['settings_changed'] = _ApiClient["default"].convertToType(data['settings_changed'], 'Number');
+        }
+        if (data.hasOwnProperty('total_changes')) {
+          obj['total_changes'] = _ApiClient["default"].convertToType(data['total_changes'], 'Number');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplateDiffSummary</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>TemplateDiffSummary</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(TemplateDiffSummary.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));
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      return true;
+    }
+  }]);
+}();
+TemplateDiffSummary.RequiredProperties = ["fields_added", "fields_removed", "fields_changed", "fields_reordered", "settings_changed", "total_changes"];
+
+/**
+ * How many fields were added.
+ * @member {Number} fields_added
+ */
+TemplateDiffSummary.prototype['fields_added'] = undefined;
+
+/**
+ * How many fields were removed.
+ * @member {Number} fields_removed
+ */
+TemplateDiffSummary.prototype['fields_removed'] = undefined;
+
+/**
+ * How many fields have changed settings.
+ * @member {Number} fields_changed
+ */
+TemplateDiffSummary.prototype['fields_changed'] = undefined;
+
+/**
+ * How many fields moved in the template's field order.
+ * @member {Number} fields_reordered
+ */
+TemplateDiffSummary.prototype['fields_reordered'] = undefined;
+
+/**
+ * How many of the template's settings changed.
+ * @member {Number} settings_changed
+ */
+TemplateDiffSummary.prototype['settings_changed'] = undefined;
+
+/**
+ * All the changes, counting a new document as one. Zero when the versions are the same.
+ * @member {Number} total_changes
+ */
+TemplateDiffSummary.prototype['total_changes'] = undefined;
+var _default = exports["default"] = TemplateDiffSummary;

package/dist/model/TemplateDocument.js

@@ -33,19 +33,19 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The TemplateDocument model module.
  * @module model/TemplateDocument
- * @version 4.0.0
+ * @version 4.2.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 filename {String} The PDF's file name. Null until a `document_url` has been downloaded.
+   * @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `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. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
+   * @param error_message {String} Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
+   * @param page_count {Number} 0 until the PDF has been processed.
    * @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.
@@ -53,9 +53,9 @@ var TemplateDocument = /*#__PURE__*/function () {
    * @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) {
+  function TemplateDocument(filename, state, error_message, page_count, md5, field_reimport_state, 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);
+    TemplateDocument.initialize(this, filename, state, error_message, page_count, md5, field_reimport_state, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url);
   }
 
   /**
@@ -65,13 +65,13 @@ var TemplateDocument = /*#__PURE__*/function () {
    */
   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) {
+    value: function initialize(obj, filename, state, error_message, page_count, md5, field_reimport_state, 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['md5'] = md5;
+      obj['field_reimport_state'] = field_reimport_state;
       obj['page_dimensions'] = page_dimensions;
       obj['has_fillable_fields'] = has_fillable_fields;
       obj['page_processing_statuses'] = page_processing_statuses;
@@ -95,21 +95,21 @@ var TemplateDocument = /*#__PURE__*/function () {
         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('md5')) {
+          obj['md5'] = _ApiClient["default"].convertToType(data['md5'], 'String');
+        }
+        if (data.hasOwnProperty('field_reimport_state')) {
+          obj['field_reimport_state'] = _ApiClient["default"].convertToType(data['field_reimport_state'], _FieldReimportState["default"]);
+        }
         if (data.hasOwnProperty('page_dimensions')) {
           obj['page_dimensions'] = _ApiClient["default"].convertToType(data['page_dimensions'], [['Number']]);
         }
@@ -160,13 +160,13 @@ var TemplateDocument = /*#__PURE__*/function () {
         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 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 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']);
@@ -204,44 +204,44 @@ var TemplateDocument = /*#__PURE__*/function () {
     }
   }]);
 }();
-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"];
+TemplateDocument.RequiredProperties = ["filename", "state", "error_message", "page_count", "md5", "field_reimport_state", "page_dimensions", "has_fillable_fields", "page_processing_statuses", "field_logic_status", "download_url", "permanent_url"];
 
 /**
- * The PDF's file name.
+ * The PDF's file name. Null until a `document_url` has been downloaded.
  * @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.
+ * `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `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. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
  * @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.
+ * Why the PDF couldn't be processed or downloaded, 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;
 
+/**
+ * The MD5 hash of the PDF.
+ * @member {String} md5
+ */
+TemplateDocument.prototype['md5'] = 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;
+
 /**
  * Each page's width and height in PDF points. Null until the PDF has been processed.
  * @member {Array.<Array.<Number>>} page_dimensions

package/dist/model/TemplateDocumentState.js

@@ -71,4 +71,14 @@ _defineProperty(TemplateDocumentState, "malformed_pdf", "malformed_pdf");
  * value: "unknown_error"
  * @const
  */
-_defineProperty(TemplateDocumentState, "unknown_error", "unknown_error");
+_defineProperty(TemplateDocumentState, "unknown_error", "unknown_error");
+/**
+ * value: "downloading"
+ * @const
+ */
+_defineProperty(TemplateDocumentState, "downloading", "downloading");
+/**
+ * value: "download_failed"
+ * @const
+ */
+_defineProperty(TemplateDocumentState, "download_failed", "download_failed");