docspring 3.2.0 → 4.0.0

package/dist/model/TemplateFieldDependency.js

@@ -0,0 +1,184 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _TemplateFieldDependencyAction = _interopRequireDefault(require("./TemplateFieldDependencyAction"));
+var _TemplateFieldDependencyCondition = _interopRequireDefault(require("./TemplateFieldDependencyCondition"));
+var _TemplateFieldDependencyMatch = _interopRequireDefault(require("./TemplateFieldDependencyMatch"));
+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 TemplateFieldDependency model module.
+ * @module model/TemplateFieldDependency
+ * @version 4.0.0
+ */
+var TemplateFieldDependency = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>TemplateFieldDependency</code>.
+   * A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
+   * @alias module:model/TemplateFieldDependency
+   * @extends Object
+   * @param action {module:model/TemplateFieldDependencyAction} What the rule does to its targets when its conditions are met.
+   * @param conditions {Array.<module:model/TemplateFieldDependencyCondition>} The conditions on other fields' values.
+   * @param targets {Array.<String>} The names of the fields the rule shows or makes required.
+   */
+  function TemplateFieldDependency(action, conditions, targets) {
+    _classCallCheck(this, TemplateFieldDependency);
+    TemplateFieldDependency.initialize(this, action, conditions, targets);
+  }
+
+  /**
+   * 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(TemplateFieldDependency, null, [{
+    key: "initialize",
+    value: function initialize(obj, action, conditions, targets) {
+      obj['action'] = action;
+      obj['conditions'] = conditions;
+      obj['targets'] = targets;
+    }
+
+    /**
+     * Constructs a <code>TemplateFieldDependency</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/TemplateFieldDependency} obj Optional instance to populate.
+     * @return {module:model/TemplateFieldDependency} The populated <code>TemplateFieldDependency</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new TemplateFieldDependency();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('action')) {
+          obj['action'] = _ApiClient["default"].convertToType(data['action'], _TemplateFieldDependencyAction["default"]);
+        }
+        if (data.hasOwnProperty('match')) {
+          obj['match'] = _ApiClient["default"].convertToType(data['match'], _TemplateFieldDependencyMatch["default"]);
+        }
+        if (data.hasOwnProperty('conditions')) {
+          obj['conditions'] = _ApiClient["default"].convertToType(data['conditions'], [_TemplateFieldDependencyCondition["default"]]);
+        }
+        if (data.hasOwnProperty('targets')) {
+          obj['targets'] = _ApiClient["default"].convertToType(data['targets'], ['String']);
+        }
+        if (data.hasOwnProperty('group')) {
+          obj['group'] = _ApiClient["default"].convertToType(data['group'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>TemplateFieldDependency</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>TemplateFieldDependency</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(TemplateFieldDependency.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();
+      }
+      if (data['conditions']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['conditions'])) {
+          throw new Error("Expected the field `conditions` to be an array in the JSON data but got " + data['conditions']);
+        }
+        // validate the optional field `conditions` (array)
+        var _iterator2 = _createForOfIteratorHelper(data['conditions']),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var item = _step2.value;
+            _TemplateFieldDependencyCondition["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+        ;
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['targets'])) {
+        throw new Error("Expected the field `targets` to be an array in the JSON data but got " + data['targets']);
+      }
+      // ensure the json data is a string
+      if (data['group'] && !(typeof data['group'] === 'string' || data['group'] instanceof String)) {
+        throw new Error("Expected the field `group` to be a primitive type in the JSON string but got " + data['group']);
+      }
+      return true;
+    }
+  }]);
+}();
+TemplateFieldDependency.RequiredProperties = ["action", "conditions", "targets"];
+
+/**
+ * What the rule does to its targets when its conditions are met.
+ * @member {module:model/TemplateFieldDependencyAction} action
+ */
+TemplateFieldDependency.prototype['action'] = undefined;
+
+/**
+ * Whether all of the conditions (the default) or any of them must be met.
+ * @member {module:model/TemplateFieldDependencyMatch} match
+ */
+TemplateFieldDependency.prototype['match'] = undefined;
+
+/**
+ * The conditions on other fields' values.
+ * @member {Array.<module:model/TemplateFieldDependencyCondition>} conditions
+ */
+TemplateFieldDependency.prototype['conditions'] = undefined;
+
+/**
+ * The names of the fields the rule shows or makes required.
+ * @member {Array.<String>} targets
+ */
+TemplateFieldDependency.prototype['targets'] = undefined;
+
+/**
+ * Marks a rule made for a field group in the template editor. Its targets outside the group are removed when the template is saved, and the rule is removed once the group has no fields.
+ * @member {String} group
+ */
+TemplateFieldDependency.prototype['group'] = undefined;
+var _default = exports["default"] = TemplateFieldDependency;

package/dist/model/TemplateFieldDependencyAction.js

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

package/dist/model/{CreateCombinedSubmissionResponse.js → TemplateFieldDependencyCondition.js}

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _CombinedSubmission = _interopRequireDefault(require("./CombinedSubmission"));
+var _TemplateFieldDependencyOperator = _interopRequireDefault(require("./TemplateFieldDependencyOperator"));
 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; } } }; }
@@ -19,7 +19,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  * 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: v1
+ * The version of the OpenAPI document: v2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,21 +28,21 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  *
  */
 /**
- * The CreateCombinedSubmissionResponse model module.
- * @module model/CreateCombinedSubmissionResponse
- * @version 3.2.0
+ * The TemplateFieldDependencyCondition model module.
+ * @module model/TemplateFieldDependencyCondition
+ * @version 4.0.0
  */
-var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
+var TemplateFieldDependencyCondition = /*#__PURE__*/function () {
   /**
-   * Constructs a new <code>CreateCombinedSubmissionResponse</code>.
-   * @alias module:model/CreateCombinedSubmissionResponse
-   * @extends Object
-   * @param status {module:model/CreateCombinedSubmissionResponse.StatusEnum} 
-   * @param combined_submission {module:model/CombinedSubmission} 
+   * Constructs a new <code>TemplateFieldDependencyCondition</code>.
+   * A condition on a field's value.
+   * @alias module:model/TemplateFieldDependencyCondition
+   * @param field {String} The name of the field whose value is compared.
+   * @param operator {module:model/TemplateFieldDependencyOperator} How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`.
    */
-  function CreateCombinedSubmissionResponse(status, combined_submission) {
-    _classCallCheck(this, CreateCombinedSubmissionResponse);
-    CreateCombinedSubmissionResponse.initialize(this, status, combined_submission);
+  function TemplateFieldDependencyCondition(field, operator) {
+    _classCallCheck(this, TemplateFieldDependencyCondition);
+    TemplateFieldDependencyCondition.initialize(this, field, operator);
   }
 
   /**
@@ -50,49 +50,51 @@ var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
    * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
    * Only for internal use.
    */
-  return _createClass(CreateCombinedSubmissionResponse, null, [{
+  return _createClass(TemplateFieldDependencyCondition, null, [{
     key: "initialize",
-    value: function initialize(obj, status, combined_submission) {
-      obj['status'] = status;
-      obj['combined_submission'] = combined_submission;
+    value: function initialize(obj, field, operator) {
+      obj['field'] = field;
+      obj['operator'] = operator;
     }
 
     /**
-     * Constructs a <code>CreateCombinedSubmissionResponse</code> from a plain JavaScript object, optionally creating a new instance.
+     * Constructs a <code>TemplateFieldDependencyCondition</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/CreateCombinedSubmissionResponse} obj Optional instance to populate.
-     * @return {module:model/CreateCombinedSubmissionResponse} The populated <code>CreateCombinedSubmissionResponse</code> instance.
+     * @param {module:model/TemplateFieldDependencyCondition} obj Optional instance to populate.
+     * @return {module:model/TemplateFieldDependencyCondition} The populated <code>TemplateFieldDependencyCondition</code> instance.
      */
   }, {
     key: "constructFromObject",
     value: function constructFromObject(data, obj) {
       if (data) {
-        obj = obj || new CreateCombinedSubmissionResponse();
-        _ApiClient["default"].constructFromObject(data, obj, 'Object');
-        if (data.hasOwnProperty('status')) {
-          obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
+        obj = obj || new TemplateFieldDependencyCondition();
+        if (data.hasOwnProperty('field')) {
+          obj['field'] = _ApiClient["default"].convertToType(data['field'], 'String');
         }
-        if (data.hasOwnProperty('combined_submission')) {
-          obj['combined_submission'] = _CombinedSubmission["default"].constructFromObject(data['combined_submission']);
+        if (data.hasOwnProperty('operator')) {
+          obj['operator'] = _ApiClient["default"].convertToType(data['operator'], _TemplateFieldDependencyOperator["default"]);
         }
-        if (data.hasOwnProperty('errors')) {
-          obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
+        if (data.hasOwnProperty('value')) {
+          obj['value'] = _ApiClient["default"].convertToType(data['value'], Object);
+        }
+        if (data.hasOwnProperty('range_max')) {
+          obj['range_max'] = _ApiClient["default"].convertToType(data['range_max'], Object);
         }
       }
       return obj;
     }
 
     /**
-     * Validates the JSON data with respect to <code>CreateCombinedSubmissionResponse</code>.
+     * Validates the JSON data with respect to <code>TemplateFieldDependencyCondition</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>CreateCombinedSubmissionResponse</code>.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateFieldDependencyCondition</code>.
      */
   }, {
     key: "validateJSON",
     value: function validateJSON(data) {
       // check to make sure all required properties are present in the JSON string
-      var _iterator = _createForOfIteratorHelper(CreateCombinedSubmissionResponse.RequiredProperties),
+      var _iterator = _createForOfIteratorHelper(TemplateFieldDependencyCondition.RequiredProperties),
         _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -107,49 +109,36 @@ var CreateCombinedSubmissionResponse = /*#__PURE__*/function () {
       } finally {
         _iterator.f();
       }
-      if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
-        throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
-      }
-      // ensure the json data is an array
-      if (!Array.isArray(data['errors'])) {
-        throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
+      if (data['field'] && !(typeof data['field'] === 'string' || data['field'] instanceof String)) {
+        throw new Error("Expected the field `field` to be a primitive type in the JSON string but got " + data['field']);
       }
       return true;
     }
   }]);
 }();
-CreateCombinedSubmissionResponse.RequiredProperties = ["status", "combined_submission"];
+TemplateFieldDependencyCondition.RequiredProperties = ["field", "operator"];
 
 /**
- * @member {module:model/CreateCombinedSubmissionResponse.StatusEnum} status
+ * The name of the field whose value is compared.
+ * @member {String} field
  */
-CreateCombinedSubmissionResponse.prototype['status'] = undefined;
+TemplateFieldDependencyCondition.prototype['field'] = undefined;
 
 /**
- * @member {module:model/CombinedSubmission} combined_submission
+ * How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`.
+ * @member {module:model/TemplateFieldDependencyOperator} operator
  */
-CreateCombinedSubmissionResponse.prototype['combined_submission'] = undefined;
+TemplateFieldDependencyCondition.prototype['operator'] = undefined;
 
 /**
- * @member {Array.<String>} errors
+ * The value to compare the field's value with.
+ * @member {Object} value
  */
-CreateCombinedSubmissionResponse.prototype['errors'] = undefined;
+TemplateFieldDependencyCondition.prototype['value'] = undefined;
 
 /**
- * Allowed values for the <code>status</code> property.
- * @enum {String}
- * @readonly
+ * The upper end of a `range`, a number (or a number as a string, as the template editor saves it).
+ * @member {Object} range_max
  */
-CreateCombinedSubmissionResponse['StatusEnum'] = {
-  /**
-   * value: "success"
-   * @const
-   */
-  "success": "success",
-  /**
-   * value: "error"
-   * @const
-   */
-  "error": "error"
-};
-var _default = exports["default"] = CreateCombinedSubmissionResponse;
+TemplateFieldDependencyCondition.prototype['range_max'] = undefined;
+var _default = exports["default"] = TemplateFieldDependencyCondition;