docspring 4.1.0 → 4.2.0

package/dist/model/SubmissionSummary.js

@@ -0,0 +1,343 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _ErrorDetail = _interopRequireDefault(require("./ErrorDetail"));
+var _SubmissionFiles = _interopRequireDefault(require("./SubmissionFiles"));
+var _SubmissionSource = _interopRequireDefault(require("./SubmissionSource"));
+var _SubmissionState = _interopRequireDefault(require("./SubmissionState"));
+var _TemplateType = _interopRequireDefault(require("./TemplateType"));
+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 SubmissionSummary model module.
+ * @module model/SubmissionSummary
+ * @version 4.2.0
+ */
+var SubmissionSummary = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>SubmissionSummary</code>.
+   * A submission in a list: its template, state, test or live, metadata and timestamps, with its data and files when you ask for them. Get a submission by its ID for its signature requests, uploads and page images.
+   * @alias module:model/SubmissionSummary
+   * @extends Object
+   * @param id {String} The submission's ID.
+   * @param template_id {String} Null once the template has been permanently deleted.
+   * @param template_type {module:model/TemplateType} The template's type: `pdf` or `html`.
+   * @param template_version {String} The published version of the template the submission used. Null for the draft.
+   * @param batch_id {String} The ID of the batch the submission was created in.
+   * @param source {module:model/SubmissionSource} `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
+   * @param state {module:model/SubmissionState} `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+   * @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+   * @param editable {Boolean} `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+   * @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Null unless you pass `include_data=true`. Empty once the submission has expired.
+   * @param data_errors {Array.<module:model/ErrorDetail>} Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
+   * @param error_message {String} Why the PDF couldn't be generated, when `state` is `error`.
+   * @param metadata {Object.<String, Object>} Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
+   * @param files {module:model/SubmissionFiles} Empty unless you pass `include_files=true`: then the generated files, as when you get the submission, without the `png` pages' links (`files.png.pages` is null). Get the submission for its page images.
+   * @param expired {Boolean} An expired submission's data, metadata, password and PDF have been deleted.
+   * @param expires_at {Date} When the submission expires. Null if it's kept until you delete it.
+   * @param processed_at {Date} When the PDF was generated. Null until then.
+   * @param created_at {Date} When the submission was created.
+   * @param updated_at {Date} When the submission was last updated.
+   */
+  function SubmissionSummary(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at) {
+    _classCallCheck(this, SubmissionSummary);
+    SubmissionSummary.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at);
+  }
+
+  /**
+   * 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(SubmissionSummary, null, [{
+    key: "initialize",
+    value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at) {
+      obj['id'] = id;
+      obj['template_id'] = template_id;
+      obj['template_type'] = template_type;
+      obj['template_version'] = template_version;
+      obj['batch_id'] = batch_id;
+      obj['source'] = source;
+      obj['state'] = state;
+      obj['test'] = test;
+      obj['editable'] = editable;
+      obj['data'] = data;
+      obj['data_errors'] = data_errors;
+      obj['error_message'] = error_message;
+      obj['metadata'] = metadata;
+      obj['files'] = files;
+      obj['expired'] = expired;
+      obj['expires_at'] = expires_at;
+      obj['processed_at'] = processed_at;
+      obj['created_at'] = created_at;
+      obj['updated_at'] = updated_at;
+    }
+
+    /**
+     * Constructs a <code>SubmissionSummary</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/SubmissionSummary} obj Optional instance to populate.
+     * @return {module:model/SubmissionSummary} The populated <code>SubmissionSummary</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new SubmissionSummary();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
+        }
+        if (data.hasOwnProperty('template_id')) {
+          obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
+        }
+        if (data.hasOwnProperty('template_type')) {
+          obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], _TemplateType["default"]);
+        }
+        if (data.hasOwnProperty('template_version')) {
+          obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
+        }
+        if (data.hasOwnProperty('batch_id')) {
+          obj['batch_id'] = _ApiClient["default"].convertToType(data['batch_id'], 'String');
+        }
+        if (data.hasOwnProperty('source')) {
+          obj['source'] = _ApiClient["default"].convertToType(data['source'], _SubmissionSource["default"]);
+        }
+        if (data.hasOwnProperty('state')) {
+          obj['state'] = _ApiClient["default"].convertToType(data['state'], _SubmissionState["default"]);
+        }
+        if (data.hasOwnProperty('test')) {
+          obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
+        }
+        if (data.hasOwnProperty('editable')) {
+          obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
+        }
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], {
+            'String': Object
+          });
+        }
+        if (data.hasOwnProperty('data_errors')) {
+          obj['data_errors'] = _ApiClient["default"].convertToType(data['data_errors'], [_ErrorDetail["default"]]);
+        }
+        if (data.hasOwnProperty('error_message')) {
+          obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
+        }
+        if (data.hasOwnProperty('metadata')) {
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
+            'String': Object
+          });
+        }
+        if (data.hasOwnProperty('files')) {
+          obj['files'] = _ApiClient["default"].convertToType(data['files'], _SubmissionFiles["default"]);
+        }
+        if (data.hasOwnProperty('expired')) {
+          obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
+        }
+        if (data.hasOwnProperty('expires_at')) {
+          obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'Date');
+        }
+        if (data.hasOwnProperty('processed_at')) {
+          obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'Date');
+        }
+        if (data.hasOwnProperty('created_at')) {
+          obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
+        }
+        if (data.hasOwnProperty('updated_at')) {
+          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>SubmissionSummary</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>SubmissionSummary</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(SubmissionSummary.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['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
+        throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
+      }
+      // ensure the json data is a string
+      if (data['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['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
+        throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
+      }
+      // ensure the json data is a string
+      if (data['batch_id'] && !(typeof data['batch_id'] === 'string' || data['batch_id'] instanceof String)) {
+        throw new Error("Expected the field `batch_id` to be a primitive type in the JSON string but got " + data['batch_id']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['data_errors'])) {
+        throw new Error("Expected the field `data_errors` to be an array in the JSON data but got " + data['data_errors']);
+      }
+      // 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']);
+      }
+      return true;
+    }
+  }]);
+}();
+SubmissionSummary.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "files", "expired", "expires_at", "processed_at", "created_at", "updated_at"];
+
+/**
+ * The submission's ID.
+ * @member {String} id
+ */
+SubmissionSummary.prototype['id'] = undefined;
+
+/**
+ * Null once the template has been permanently deleted.
+ * @member {String} template_id
+ */
+SubmissionSummary.prototype['template_id'] = undefined;
+
+/**
+ * The template's type: `pdf` or `html`.
+ * @member {module:model/TemplateType} template_type
+ */
+SubmissionSummary.prototype['template_type'] = undefined;
+
+/**
+ * The published version of the template the submission used. Null for the draft.
+ * @member {String} template_version
+ */
+SubmissionSummary.prototype['template_version'] = undefined;
+
+/**
+ * The ID of the batch the submission was created in.
+ * @member {String} batch_id
+ */
+SubmissionSummary.prototype['batch_id'] = undefined;
+
+/**
+ * `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
+ * @member {module:model/SubmissionSource} source
+ */
+SubmissionSummary.prototype['source'] = undefined;
+
+/**
+ * `pending` until the PDF has been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no PDF: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the PDF failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
+ * @member {module:model/SubmissionState} state
+ */
+SubmissionSummary.prototype['state'] = undefined;
+
+/**
+ * Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+ * @member {Boolean} test
+ */
+SubmissionSummary.prototype['test'] = undefined;
+
+/**
+ * `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
+ * @member {Boolean} editable
+ */
+SubmissionSummary.prototype['editable'] = undefined;
+
+/**
+ * The submission's data, with the values entered in completed signature requests. Null unless you pass `include_data=true`. Empty once the submission has expired.
+ * @member {Object.<String, Object>} data
+ */
+SubmissionSummary.prototype['data'] = undefined;
+
+/**
+ * Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
+ * @member {Array.<module:model/ErrorDetail>} data_errors
+ */
+SubmissionSummary.prototype['data_errors'] = undefined;
+
+/**
+ * Why the PDF couldn't be generated, when `state` is `error`.
+ * @member {String} error_message
+ */
+SubmissionSummary.prototype['error_message'] = undefined;
+
+/**
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
+ * @member {Object.<String, Object>} metadata
+ */
+SubmissionSummary.prototype['metadata'] = undefined;
+
+/**
+ * Empty unless you pass `include_files=true`: then the generated files, as when you get the submission, without the `png` pages' links (`files.png.pages` is null). Get the submission for its page images.
+ * @member {module:model/SubmissionFiles} files
+ */
+SubmissionSummary.prototype['files'] = undefined;
+
+/**
+ * An expired submission's data, metadata, password and PDF have been deleted.
+ * @member {Boolean} expired
+ */
+SubmissionSummary.prototype['expired'] = undefined;
+
+/**
+ * When the submission expires. Null if it's kept until you delete it.
+ * @member {Date} expires_at
+ */
+SubmissionSummary.prototype['expires_at'] = undefined;
+
+/**
+ * When the PDF was generated. Null until then.
+ * @member {Date} processed_at
+ */
+SubmissionSummary.prototype['processed_at'] = undefined;
+
+/**
+ * When the submission was created.
+ * @member {Date} created_at
+ */
+SubmissionSummary.prototype['created_at'] = undefined;
+
+/**
+ * When the submission was last updated.
+ * @member {Date} updated_at
+ */
+SubmissionSummary.prototype['updated_at'] = undefined;
+var _default = exports["default"] = SubmissionSummary;

package/dist/model/SubmissionValidation.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The SubmissionValidation model module.
  * @module model/SubmissionValidation
- * @version 4.1.0
+ * @version 4.2.0
  */
 var SubmissionValidation = /*#__PURE__*/function () {
   /**