docspring 3.3.0 → 4.1.0

package/dist/model/CreateSubmissionRequest.js

@@ -0,0 +1,226 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
+var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
+ * DocSpring API
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+ *
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The CreateSubmissionRequest model module.
+ * @module model/CreateSubmissionRequest
+ * @version 4.1.0
+ */
+var CreateSubmissionRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>CreateSubmissionRequest</code>.
+   * The submission's data and settings.
+   * @alias module:model/CreateSubmissionRequest
+   */
+  function CreateSubmissionRequest() {
+    _classCallCheck(this, CreateSubmissionRequest);
+    CreateSubmissionRequest.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(CreateSubmissionRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>CreateSubmissionRequest</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/CreateSubmissionRequest} obj Optional instance to populate.
+     * @return {module:model/CreateSubmissionRequest} The populated <code>CreateSubmissionRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new CreateSubmissionRequest();
+        if (data.hasOwnProperty('test')) {
+          obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
+        }
+        if (data.hasOwnProperty('editable')) {
+          obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
+        }
+        if (data.hasOwnProperty('data')) {
+          obj['data'] = _ApiClient["default"].convertToType(data['data'], {
+            'String': Object
+          });
+        }
+        if (data.hasOwnProperty('metadata')) {
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
+            'String': Object
+          });
+        }
+        if (data.hasOwnProperty('password')) {
+          obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
+        }
+        if (data.hasOwnProperty('output_formats')) {
+          obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
+        }
+        if (data.hasOwnProperty('expires_in')) {
+          obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
+        }
+        if (data.hasOwnProperty('field_overrides')) {
+          obj['field_overrides'] = _ApiClient["default"].convertToType(data['field_overrides'], {
+            'String': _FieldOverride["default"]
+          });
+        }
+        if (data.hasOwnProperty('html')) {
+          obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
+        }
+        if (data.hasOwnProperty('css')) {
+          obj['css'] = _ApiClient["default"].convertToType(data['css'], 'String');
+        }
+        if (data.hasOwnProperty('signature_requests')) {
+          obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequestInput["default"]]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>CreateSubmissionRequest</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>CreateSubmissionRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
+        throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['output_formats'])) {
+        throw new Error("Expected the field `output_formats` to be an array in the JSON data but got " + data['output_formats']);
+      }
+      // ensure the json data is a string
+      if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
+        throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
+      }
+      // ensure the json data is a string
+      if (data['css'] && !(typeof data['css'] === 'string' || data['css'] instanceof String)) {
+        throw new Error("Expected the field `css` to be a primitive type in the JSON string but got " + data['css']);
+      }
+      if (data['signature_requests']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['signature_requests'])) {
+          throw new Error("Expected the field `signature_requests` to be an array in the JSON data but got " + data['signature_requests']);
+        }
+        // validate the optional field `signature_requests` (array)
+        var _iterator = _createForOfIteratorHelper(data['signature_requests']),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+            _SignatureRequestInput["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+        ;
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+ * @member {Boolean} test
+ */
+CreateSubmissionRequest.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
+ */
+CreateSubmissionRequest.prototype['editable'] = undefined;
+
+/**
+ * The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values.
+ * @member {Object.<String, Object>} data
+ */
+CreateSubmissionRequest.prototype['data'] = undefined;
+
+/**
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+ * @member {Object.<String, Object>} metadata
+ */
+CreateSubmissionRequest.prototype['metadata'] = undefined;
+
+/**
+ * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
+ * @member {String} password
+ */
+CreateSubmissionRequest.prototype['password'] = undefined;
+
+/**
+ * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+ * @member {Array.<module:model/OutputFormat>} output_formats
+ */
+CreateSubmissionRequest.prototype['output_formats'] = undefined;
+
+/**
+ * Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
+ * @member {Number} expires_in
+ */
+CreateSubmissionRequest.prototype['expires_in'] = undefined;
+
+/**
+ * Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
+ * @member {Object.<String, module:model/FieldOverride>} field_overrides
+ */
+CreateSubmissionRequest.prototype['field_overrides'] = undefined;
+
+/**
+ * For an HTML template, HTML to use instead of the template's.
+ * @member {String} html
+ */
+CreateSubmissionRequest.prototype['html'] = undefined;
+
+/**
+ * For an HTML template, CSS to use instead of the template's.
+ * @member {String} css
+ */
+CreateSubmissionRequest.prototype['css'] = undefined;
+
+/**
+ * The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`.
+ * @member {Array.<module:model/SignatureRequestInput>} signature_requests
+ */
+CreateSubmissionRequest.prototype['signature_requests'] = undefined;
+var _default = exports["default"] = CreateSubmissionRequest;