docspring 3.2.0 → 4.0.0

package/dist/model/{CreateFolderData.js → CreateFolderRequest.js}

@@ -18,7 +18,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).
@@ -27,19 +27,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  *
  */
 /**
- * The CreateFolderData model module.
- * @module model/CreateFolderData
- * @version 3.2.0
+ * The CreateFolderRequest model module.
+ * @module model/CreateFolderRequest
+ * @version 4.0.0
  */
-var CreateFolderData = /*#__PURE__*/function () {
+var CreateFolderRequest = /*#__PURE__*/function () {
   /**
-   * Constructs a new <code>CreateFolderData</code>.
-   * @alias module:model/CreateFolderData
-   * @param folder {Object} 
+   * Constructs a new <code>CreateFolderRequest</code>.
+   * The folder to create.
+   * @alias module:model/CreateFolderRequest
+   * @param name {String} The folder's name. It can't contain `/`, and is unique within its parent folder.
    */
-  function CreateFolderData(folder) {
-    _classCallCheck(this, CreateFolderData);
-    CreateFolderData.initialize(this, folder);
+  function CreateFolderRequest(name) {
+    _classCallCheck(this, CreateFolderRequest);
+    CreateFolderRequest.initialize(this, name);
   }
 
   /**
@@ -47,41 +48,44 @@ var CreateFolderData = /*#__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(CreateFolderData, null, [{
+  return _createClass(CreateFolderRequest, null, [{
     key: "initialize",
-    value: function initialize(obj, folder) {
-      obj['folder'] = folder;
+    value: function initialize(obj, name) {
+      obj['name'] = name;
     }
 
     /**
-     * Constructs a <code>CreateFolderData</code> from a plain JavaScript object, optionally creating a new instance.
+     * Constructs a <code>CreateFolderRequest</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/CreateFolderData} obj Optional instance to populate.
-     * @return {module:model/CreateFolderData} The populated <code>CreateFolderData</code> instance.
+     * @param {module:model/CreateFolderRequest} obj Optional instance to populate.
+     * @return {module:model/CreateFolderRequest} The populated <code>CreateFolderRequest</code> instance.
      */
   }, {
     key: "constructFromObject",
     value: function constructFromObject(data, obj) {
       if (data) {
-        obj = obj || new CreateFolderData();
-        if (data.hasOwnProperty('folder')) {
-          obj['folder'] = _ApiClient["default"].convertToType(data['folder'], Object);
+        obj = obj || new CreateFolderRequest();
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+        }
+        if (data.hasOwnProperty('parent_folder_id')) {
+          obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
         }
       }
       return obj;
     }
 
     /**
-     * Validates the JSON data with respect to <code>CreateFolderData</code>.
+     * Validates the JSON data with respect to <code>CreateFolderRequest</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>CreateFolderData</code>.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateFolderRequest</code>.
      */
   }, {
     key: "validateJSON",
     value: function validateJSON(data) {
       // check to make sure all required properties are present in the JSON string
-      var _iterator = _createForOfIteratorHelper(CreateFolderData.RequiredProperties),
+      var _iterator = _createForOfIteratorHelper(CreateFolderRequest.RequiredProperties),
         _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -90,19 +94,34 @@ var CreateFolderData = /*#__PURE__*/function () {
             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['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['parent_folder_id'] && !(typeof data['parent_folder_id'] === 'string' || data['parent_folder_id'] instanceof String)) {
+        throw new Error("Expected the field `parent_folder_id` to be a primitive type in the JSON string but got " + data['parent_folder_id']);
+      }
       return true;
     }
   }]);
 }();
-CreateFolderData.RequiredProperties = ["folder"];
+CreateFolderRequest.RequiredProperties = ["name"];
+
+/**
+ * The folder's name. It can't contain `/`, and is unique within its parent folder.
+ * @member {String} name
+ */
+CreateFolderRequest.prototype['name'] = undefined;
 
 /**
- * @member {Object} folder
+ * The ID of the folder this folder is in. Null for a folder at the root.
+ * @member {String} parent_folder_id
  */
-CreateFolderData.prototype['folder'] = undefined;
-var _default = exports["default"] = CreateFolderData;
+CreateFolderRequest.prototype['parent_folder_id'] = undefined;
+var _default = exports["default"] = CreateFolderRequest;

package/dist/model/{CreateSubmissionDataRequestEventRequest.js → CreateSignatureRequestEventRequest.js}

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _SignatureRequestEventType = _interopRequireDefault(require("./SignatureRequestEventType"));
+var _SignatureRequestMessageType = _interopRequireDefault(require("./SignatureRequestMessageType"));
 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; } } }; }
@@ -18,7 +20,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).
@@ -27,19 +29,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  *
  */
 /**
- * The CreateSubmissionDataRequestEventRequest model module.
- * @module model/CreateSubmissionDataRequestEventRequest
- * @version 3.2.0
+ * The CreateSignatureRequestEventRequest model module.
+ * @module model/CreateSignatureRequestEventRequest
+ * @version 4.0.0
  */
-var CreateSubmissionDataRequestEventRequest = /*#__PURE__*/function () {
+var CreateSignatureRequestEventRequest = /*#__PURE__*/function () {
   /**
-   * Constructs a new <code>CreateSubmissionDataRequestEventRequest</code>.
-   * @alias module:model/CreateSubmissionDataRequestEventRequest
-   * @param event_type {module:model/CreateSubmissionDataRequestEventRequest.EventTypeEnum} 
+   * Constructs a new <code>CreateSignatureRequestEventRequest</code>.
+   * The event to record.
+   * @alias module:model/CreateSignatureRequestEventRequest
+   * @param event_type {module:model/SignatureRequestEventType} `send_request`: you sent the signature request to the person (`message_type` and `message_recipient` are required). It's the only event the API records: DocSpring records everything that happens in the signing form itself, and people decline a signature request in its form.
    */
-  function CreateSubmissionDataRequestEventRequest(event_type) {
-    _classCallCheck(this, CreateSubmissionDataRequestEventRequest);
-    CreateSubmissionDataRequestEventRequest.initialize(this, event_type);
+  function CreateSignatureRequestEventRequest(event_type) {
+    _classCallCheck(this, CreateSignatureRequestEventRequest);
+    CreateSignatureRequestEventRequest.initialize(this, event_type);
   }
 
   /**
@@ -47,50 +50,50 @@ var CreateSubmissionDataRequestEventRequest = /*#__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(CreateSubmissionDataRequestEventRequest, null, [{
+  return _createClass(CreateSignatureRequestEventRequest, null, [{
     key: "initialize",
     value: function initialize(obj, event_type) {
       obj['event_type'] = event_type;
     }
 
     /**
-     * Constructs a <code>CreateSubmissionDataRequestEventRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Constructs a <code>CreateSignatureRequestEventRequest</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/CreateSubmissionDataRequestEventRequest} obj Optional instance to populate.
-     * @return {module:model/CreateSubmissionDataRequestEventRequest} The populated <code>CreateSubmissionDataRequestEventRequest</code> instance.
+     * @param {module:model/CreateSignatureRequestEventRequest} obj Optional instance to populate.
+     * @return {module:model/CreateSignatureRequestEventRequest} The populated <code>CreateSignatureRequestEventRequest</code> instance.
      */
   }, {
     key: "constructFromObject",
     value: function constructFromObject(data, obj) {
       if (data) {
-        obj = obj || new CreateSubmissionDataRequestEventRequest();
+        obj = obj || new CreateSignatureRequestEventRequest();
         if (data.hasOwnProperty('event_type')) {
-          obj['event_type'] = _ApiClient["default"].convertToType(data['event_type'], 'String');
+          obj['event_type'] = _ApiClient["default"].convertToType(data['event_type'], _SignatureRequestEventType["default"]);
+        }
+        if (data.hasOwnProperty('message_type')) {
+          obj['message_type'] = _ApiClient["default"].convertToType(data['message_type'], _SignatureRequestMessageType["default"]);
         }
         if (data.hasOwnProperty('message_recipient')) {
           obj['message_recipient'] = _ApiClient["default"].convertToType(data['message_recipient'], 'String');
         }
-        if (data.hasOwnProperty('message_type')) {
-          obj['message_type'] = _ApiClient["default"].convertToType(data['message_type'], 'String');
-        }
         if (data.hasOwnProperty('occurred_at')) {
-          obj['occurred_at'] = _ApiClient["default"].convertToType(data['occurred_at'], 'String');
+          obj['occurred_at'] = _ApiClient["default"].convertToType(data['occurred_at'], 'Date');
         }
       }
       return obj;
     }
 
     /**
-     * Validates the JSON data with respect to <code>CreateSubmissionDataRequestEventRequest</code>.
+     * Validates the JSON data with respect to <code>CreateSignatureRequestEventRequest</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>CreateSubmissionDataRequestEventRequest</code>.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateSignatureRequestEventRequest</code>.
      */
   }, {
     key: "validateJSON",
     value: function validateJSON(data) {
       // check to make sure all required properties are present in the JSON string
-      var _iterator = _createForOfIteratorHelper(CreateSubmissionDataRequestEventRequest.RequiredProperties),
+      var _iterator = _createForOfIteratorHelper(CreateSignatureRequestEventRequest.RequiredProperties),
         _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -105,135 +108,36 @@ var CreateSubmissionDataRequestEventRequest = /*#__PURE__*/function () {
       } finally {
         _iterator.f();
       }
-      if (data['event_type'] && !(typeof data['event_type'] === 'string' || data['event_type'] instanceof String)) {
-        throw new Error("Expected the field `event_type` to be a primitive type in the JSON string but got " + data['event_type']);
-      }
-      // ensure the json data is a string
       if (data['message_recipient'] && !(typeof data['message_recipient'] === 'string' || data['message_recipient'] instanceof String)) {
         throw new Error("Expected the field `message_recipient` to be a primitive type in the JSON string but got " + data['message_recipient']);
       }
-      // ensure the json data is a string
-      if (data['message_type'] && !(typeof data['message_type'] === 'string' || data['message_type'] instanceof String)) {
-        throw new Error("Expected the field `message_type` to be a primitive type in the JSON string but got " + data['message_type']);
-      }
-      // ensure the json data is a string
-      if (data['occurred_at'] && !(typeof data['occurred_at'] === 'string' || data['occurred_at'] instanceof String)) {
-        throw new Error("Expected the field `occurred_at` to be a primitive type in the JSON string but got " + data['occurred_at']);
-      }
       return true;
     }
   }]);
 }();
-CreateSubmissionDataRequestEventRequest.RequiredProperties = ["event_type"];
-
-/**
- * @member {module:model/CreateSubmissionDataRequestEventRequest.EventTypeEnum} event_type
- */
-CreateSubmissionDataRequestEventRequest.prototype['event_type'] = undefined;
+CreateSignatureRequestEventRequest.RequiredProperties = ["event_type"];
 
 /**
- * @member {String} message_recipient
+ * `send_request`: you sent the signature request to the person (`message_type` and `message_recipient` are required). It's the only event the API records: DocSpring records everything that happens in the signing form itself, and people decline a signature request in its form.
+ * @member {module:model/SignatureRequestEventType} event_type
  */
-CreateSubmissionDataRequestEventRequest.prototype['message_recipient'] = undefined;
+CreateSignatureRequestEventRequest.prototype['event_type'] = undefined;
 
 /**
- * @member {module:model/CreateSubmissionDataRequestEventRequest.MessageTypeEnum} message_type
+ * How you sent the request. Required for `send_request`.
+ * @member {module:model/SignatureRequestMessageType} message_type
  */
-CreateSubmissionDataRequestEventRequest.prototype['message_type'] = undefined;
+CreateSignatureRequestEventRequest.prototype['message_type'] = undefined;
 
 /**
- * @member {String} occurred_at
+ * Where you sent the request, such as an email address or a phone number. Required for `send_request`.
+ * @member {String} message_recipient
  */
-CreateSubmissionDataRequestEventRequest.prototype['occurred_at'] = undefined;
+CreateSignatureRequestEventRequest.prototype['message_recipient'] = undefined;
 
 /**
- * Allowed values for the <code>event_type</code> property.
- * @enum {String}
- * @readonly
+ * When it happened. Default now.
+ * @member {Date} occurred_at
  */
-CreateSubmissionDataRequestEventRequest['EventTypeEnum'] = {
-  /**
-   * value: "send_request"
-   * @const
-   */
-  "send_request": "send_request",
-  /**
-   * value: "view_request"
-   * @const
-   */
-  "view_request": "view_request",
-  /**
-   * value: "accepted_terms"
-   * @const
-   */
-  "accepted_terms": "accepted_terms",
-  /**
-   * value: "decline_request"
-   * @const
-   */
-  "decline_request": "decline_request",
-  /**
-   * value: "sign_request"
-   * @const
-   */
-  "sign_request": "sign_request",
-  /**
-   * value: "all_completed"
-   * @const
-   */
-  "all_completed": "all_completed"
-};
-
-/**
- * Allowed values for the <code>message_type</code> property.
- * @enum {String}
- * @readonly
- */
-CreateSubmissionDataRequestEventRequest['MessageTypeEnum'] = {
-  /**
-   * value: "email"
-   * @const
-   */
-  "email": "email",
-  /**
-   * value: "sms"
-   * @const
-   */
-  "sms": "sms",
-  /**
-   * value: "fax"
-   * @const
-   */
-  "fax": "fax",
-  /**
-   * value: "mail"
-   * @const
-   */
-  "mail": "mail",
-  /**
-   * value: "slack"
-   * @const
-   */
-  "slack": "slack",
-  /**
-   * value: "msteams"
-   * @const
-   */
-  "msteams": "msteams",
-  /**
-   * value: "discord"
-   * @const
-   */
-  "discord": "discord",
-  /**
-   * value: "telegram"
-   * @const
-   */
-  "telegram": "telegram",
-  /**
-   * value: "whatsapp"
-   * @const
-   */
-  "whatsapp": "whatsapp"
-};
-var _default = exports["default"] = CreateSubmissionDataRequestEventRequest;
+CreateSignatureRequestEventRequest.prototype['occurred_at'] = undefined;
+var _default = exports["default"] = CreateSignatureRequestEventRequest;

package/dist/model/CreateSignatureRequestTokenRequest.js

@@ -0,0 +1,88 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _SignatureRequestTokenType = _interopRequireDefault(require("./SignatureRequestTokenType"));
+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 _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 CreateSignatureRequestTokenRequest model module.
+ * @module model/CreateSignatureRequestTokenRequest
+ * @version 4.0.0
+ */
+var CreateSignatureRequestTokenRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>CreateSignatureRequestTokenRequest</code>.
+   * The kind of link to make. Send no body for an `api` token.
+   * @alias module:model/CreateSignatureRequestTokenRequest
+   */
+  function CreateSignatureRequestTokenRequest() {
+    _classCallCheck(this, CreateSignatureRequestTokenRequest);
+    CreateSignatureRequestTokenRequest.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(CreateSignatureRequestTokenRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>CreateSignatureRequestTokenRequest</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/CreateSignatureRequestTokenRequest} obj Optional instance to populate.
+     * @return {module:model/CreateSignatureRequestTokenRequest} The populated <code>CreateSignatureRequestTokenRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new CreateSignatureRequestTokenRequest();
+        if (data.hasOwnProperty('type')) {
+          obj['type'] = _ApiClient["default"].convertToType(data['type'], _SignatureRequestTokenType["default"]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>CreateSignatureRequestTokenRequest</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>CreateSignatureRequestTokenRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      return true;
+    }
+  }]);
+}();
+/**
+ * `api` (the default): the link opens the signature request for 24 hours, for a form your app opens or a link it gives the person right away. `email`: 7 days, for a link you send by email.
+ * @member {module:model/SignatureRequestTokenType} type
+ */
+CreateSignatureRequestTokenRequest.prototype['type'] = undefined;
+var _default = exports["default"] = CreateSignatureRequestTokenRequest;