docspring 3.0.0 → 3.2.0

package/dist/model/Webhook.js

@@ -0,0 +1,380 @@
+"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: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The Webhook model module.
+ * @module model/Webhook
+ * @version 3.2.0
+ */
+var Webhook = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>Webhook</code>.
+   * @alias module:model/Webhook
+   * @extends Object
+   * @param id {String} 
+   * @param name {String} 
+   * @param url {String} 
+   * @param enabled {Boolean} 
+   * @param event_types {Array.<String>} 
+   * @param mode {module:model/Webhook.ModeEnum} 
+   * @param version {Number} 
+   * @param api_token_ids {Array.<String>} 
+   * @param template_ids {Array.<String>} 
+   * @param folder_ids {Array.<String>} 
+   * @param include_submission_data {Boolean} 
+   * @param strip_fields {Array.<String>} 
+   * @param headers {Object.<String, String>} 
+   * @param consecutive_failures {Number} 
+   * @param last_failure_at {String} 
+   * @param disabled_at {String} 
+   * @param disabled_reason {String} 
+   * @param secret {String} 
+   * @param created_at {String} 
+   * @param updated_at {String} 
+   */
+  function Webhook(id, name, url, enabled, event_types, mode, version, api_token_ids, template_ids, folder_ids, include_submission_data, strip_fields, headers, consecutive_failures, last_failure_at, disabled_at, disabled_reason, secret, created_at, updated_at) {
+    _classCallCheck(this, Webhook);
+    Webhook.initialize(this, id, name, url, enabled, event_types, mode, version, api_token_ids, template_ids, folder_ids, include_submission_data, strip_fields, headers, consecutive_failures, last_failure_at, disabled_at, disabled_reason, secret, 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(Webhook, null, [{
+    key: "initialize",
+    value: function initialize(obj, id, name, url, enabled, event_types, mode, version, api_token_ids, template_ids, folder_ids, include_submission_data, strip_fields, headers, consecutive_failures, last_failure_at, disabled_at, disabled_reason, secret, created_at, updated_at) {
+      obj['id'] = id;
+      obj['name'] = name;
+      obj['url'] = url;
+      obj['enabled'] = enabled;
+      obj['event_types'] = event_types;
+      obj['mode'] = mode;
+      obj['version'] = version;
+      obj['api_token_ids'] = api_token_ids;
+      obj['template_ids'] = template_ids;
+      obj['folder_ids'] = folder_ids;
+      obj['include_submission_data'] = include_submission_data;
+      obj['strip_fields'] = strip_fields;
+      obj['headers'] = headers;
+      obj['consecutive_failures'] = consecutive_failures;
+      obj['last_failure_at'] = last_failure_at;
+      obj['disabled_at'] = disabled_at;
+      obj['disabled_reason'] = disabled_reason;
+      obj['secret'] = secret;
+      obj['created_at'] = created_at;
+      obj['updated_at'] = updated_at;
+    }
+
+    /**
+     * Constructs a <code>Webhook</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/Webhook} obj Optional instance to populate.
+     * @return {module:model/Webhook} The populated <code>Webhook</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new Webhook();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
+        }
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+        }
+        if (data.hasOwnProperty('url')) {
+          obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
+        }
+        if (data.hasOwnProperty('enabled')) {
+          obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
+        }
+        if (data.hasOwnProperty('event_types')) {
+          obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], ['String']);
+        }
+        if (data.hasOwnProperty('mode')) {
+          obj['mode'] = _ApiClient["default"].convertToType(data['mode'], 'String');
+        }
+        if (data.hasOwnProperty('version')) {
+          obj['version'] = _ApiClient["default"].convertToType(data['version'], 'Number');
+        }
+        if (data.hasOwnProperty('api_token_ids')) {
+          obj['api_token_ids'] = _ApiClient["default"].convertToType(data['api_token_ids'], ['String']);
+        }
+        if (data.hasOwnProperty('template_ids')) {
+          obj['template_ids'] = _ApiClient["default"].convertToType(data['template_ids'], ['String']);
+        }
+        if (data.hasOwnProperty('folder_ids')) {
+          obj['folder_ids'] = _ApiClient["default"].convertToType(data['folder_ids'], ['String']);
+        }
+        if (data.hasOwnProperty('include_submission_data')) {
+          obj['include_submission_data'] = _ApiClient["default"].convertToType(data['include_submission_data'], 'Boolean');
+        }
+        if (data.hasOwnProperty('strip_fields')) {
+          obj['strip_fields'] = _ApiClient["default"].convertToType(data['strip_fields'], ['String']);
+        }
+        if (data.hasOwnProperty('headers')) {
+          obj['headers'] = _ApiClient["default"].convertToType(data['headers'], {
+            'String': 'String'
+          });
+        }
+        if (data.hasOwnProperty('consecutive_failures')) {
+          obj['consecutive_failures'] = _ApiClient["default"].convertToType(data['consecutive_failures'], 'Number');
+        }
+        if (data.hasOwnProperty('last_failure_at')) {
+          obj['last_failure_at'] = _ApiClient["default"].convertToType(data['last_failure_at'], 'String');
+        }
+        if (data.hasOwnProperty('disabled_at')) {
+          obj['disabled_at'] = _ApiClient["default"].convertToType(data['disabled_at'], 'String');
+        }
+        if (data.hasOwnProperty('disabled_reason')) {
+          obj['disabled_reason'] = _ApiClient["default"].convertToType(data['disabled_reason'], 'String');
+        }
+        if (data.hasOwnProperty('secret')) {
+          obj['secret'] = _ApiClient["default"].convertToType(data['secret'], 'String');
+        }
+        if (data.hasOwnProperty('created_at')) {
+          obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'String');
+        }
+        if (data.hasOwnProperty('updated_at')) {
+          obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>Webhook</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>Webhook</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(Webhook.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['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
+        throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
+      }
+      // ensure the json data is a string
+      if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
+        throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['event_types'])) {
+        throw new Error("Expected the field `event_types` to be an array in the JSON data but got " + data['event_types']);
+      }
+      // ensure the json data is a string
+      if (data['mode'] && !(typeof data['mode'] === 'string' || data['mode'] instanceof String)) {
+        throw new Error("Expected the field `mode` to be a primitive type in the JSON string but got " + data['mode']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['api_token_ids'])) {
+        throw new Error("Expected the field `api_token_ids` to be an array in the JSON data but got " + data['api_token_ids']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['template_ids'])) {
+        throw new Error("Expected the field `template_ids` to be an array in the JSON data but got " + data['template_ids']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['folder_ids'])) {
+        throw new Error("Expected the field `folder_ids` to be an array in the JSON data but got " + data['folder_ids']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['strip_fields'])) {
+        throw new Error("Expected the field `strip_fields` to be an array in the JSON data but got " + data['strip_fields']);
+      }
+      // ensure the json data is a string
+      if (data['last_failure_at'] && !(typeof data['last_failure_at'] === 'string' || data['last_failure_at'] instanceof String)) {
+        throw new Error("Expected the field `last_failure_at` to be a primitive type in the JSON string but got " + data['last_failure_at']);
+      }
+      // ensure the json data is a string
+      if (data['disabled_at'] && !(typeof data['disabled_at'] === 'string' || data['disabled_at'] instanceof String)) {
+        throw new Error("Expected the field `disabled_at` to be a primitive type in the JSON string but got " + data['disabled_at']);
+      }
+      // ensure the json data is a string
+      if (data['disabled_reason'] && !(typeof data['disabled_reason'] === 'string' || data['disabled_reason'] instanceof String)) {
+        throw new Error("Expected the field `disabled_reason` to be a primitive type in the JSON string but got " + data['disabled_reason']);
+      }
+      // ensure the json data is a string
+      if (data['secret'] && !(typeof data['secret'] === 'string' || data['secret'] instanceof String)) {
+        throw new Error("Expected the field `secret` to be a primitive type in the JSON string but got " + data['secret']);
+      }
+      // ensure the json data is a string
+      if (data['created_at'] && !(typeof data['created_at'] === 'string' || data['created_at'] instanceof String)) {
+        throw new Error("Expected the field `created_at` to be a primitive type in the JSON string but got " + data['created_at']);
+      }
+      // ensure the json data is a string
+      if (data['updated_at'] && !(typeof data['updated_at'] === 'string' || data['updated_at'] instanceof String)) {
+        throw new Error("Expected the field `updated_at` to be a primitive type in the JSON string but got " + data['updated_at']);
+      }
+      return true;
+    }
+  }]);
+}();
+Webhook.RequiredProperties = ["id", "name", "url", "enabled", "event_types", "mode", "version", "api_token_ids", "template_ids", "folder_ids", "include_submission_data", "strip_fields", "headers", "consecutive_failures", "last_failure_at", "disabled_at", "disabled_reason", "secret", "created_at", "updated_at"];
+
+/**
+ * @member {String} id
+ */
+Webhook.prototype['id'] = undefined;
+
+/**
+ * @member {String} name
+ */
+Webhook.prototype['name'] = undefined;
+
+/**
+ * @member {String} url
+ */
+Webhook.prototype['url'] = undefined;
+
+/**
+ * @member {Boolean} enabled
+ */
+Webhook.prototype['enabled'] = undefined;
+
+/**
+ * @member {Array.<String>} event_types
+ */
+Webhook.prototype['event_types'] = undefined;
+
+/**
+ * @member {module:model/Webhook.ModeEnum} mode
+ */
+Webhook.prototype['mode'] = undefined;
+
+/**
+ * @member {Number} version
+ */
+Webhook.prototype['version'] = undefined;
+
+/**
+ * @member {Array.<String>} api_token_ids
+ */
+Webhook.prototype['api_token_ids'] = undefined;
+
+/**
+ * @member {Array.<String>} template_ids
+ */
+Webhook.prototype['template_ids'] = undefined;
+
+/**
+ * @member {Array.<String>} folder_ids
+ */
+Webhook.prototype['folder_ids'] = undefined;
+
+/**
+ * @member {Boolean} include_submission_data
+ */
+Webhook.prototype['include_submission_data'] = undefined;
+
+/**
+ * @member {Array.<String>} strip_fields
+ */
+Webhook.prototype['strip_fields'] = undefined;
+
+/**
+ * @member {Object.<String, String>} headers
+ */
+Webhook.prototype['headers'] = undefined;
+
+/**
+ * @member {Number} consecutive_failures
+ */
+Webhook.prototype['consecutive_failures'] = undefined;
+
+/**
+ * @member {String} last_failure_at
+ */
+Webhook.prototype['last_failure_at'] = undefined;
+
+/**
+ * @member {String} disabled_at
+ */
+Webhook.prototype['disabled_at'] = undefined;
+
+/**
+ * @member {String} disabled_reason
+ */
+Webhook.prototype['disabled_reason'] = undefined;
+
+/**
+ * @member {String} secret
+ */
+Webhook.prototype['secret'] = undefined;
+
+/**
+ * @member {String} created_at
+ */
+Webhook.prototype['created_at'] = undefined;
+
+/**
+ * @member {String} updated_at
+ */
+Webhook.prototype['updated_at'] = undefined;
+
+/**
+ * Allowed values for the <code>mode</code> property.
+ * @enum {String}
+ * @readonly
+ */
+Webhook['ModeEnum'] = {
+  /**
+   * value: "test"
+   * @const
+   */
+  "test": "test",
+  /**
+   * value: "live"
+   * @const
+   */
+  "live": "live"
+};
+var _default = exports["default"] = Webhook;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "docspring",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "An API client for the DocSpring PDF generation service",
-  "license": "Unlicense",
+  "license": "MIT",
   "main": "dist/index.js",
   "scripts": {
     "build": "babel src -d dist",
@@ -41,6 +41,16 @@
     "sinon": "^7.2.0"
   },
   "files": [
-    "dist"
-  ]
+    "dist",
+    "AGENTS.md"
+  ],
+  "homepage": "https://github.com/DocSpring/docspring-javascript#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DocSpring/docspring-javascript.git"
+  },
+  "bugs": {
+    "url": "https://github.com/DocSpring/docspring-javascript/issues"
+  },
+  "author": "DocSpring"
 }