files.com 1.2.245 → 1.2.246

package/_VERSION

@@ -1 +1 @@
-1.2.245
+1.2.246

package/docs/models/UserLifecycleRule.md

@@ -73,6 +73,44 @@ await UserLifecycleRule.create({
 
 ---
 
+## Update User Lifecycle Rule
+
+```
+const user_lifecycle_rule = await UserLifecycleRule.find(id)
+
+await user_lifecycle_rule.update({
+  'authentication_method': "password",
+  'inactivity_days': 12,
+  'include_site_admins': true,
+  'include_folder_admins': true,
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - User Lifecycle Rule ID.
+* `action` (string): Required - Action to take on inactive users (disable or delete)
+* `authentication_method` (string): Required - User authentication method for the rule
+* `inactivity_days` (int64): Required - Number of days of inactivity before the rule applies
+* `include_site_admins` (boolean): Include site admins in the rule
+* `include_folder_admins` (boolean): Include folder admins in the rule
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "authentication_method": "password",
+  "inactivity_days": 12,
+  "include_folder_admins": true,
+  "include_site_admins": true,
+  "action": "disable",
+  "site_id": 1
+}
+```
+
+---
+
 ## Delete User Lifecycle Rule
 
 ```

package/lib/Files.js

@@ -12,7 +12,7 @@ var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
 var language = null;
-var version = '1.2.245';
+var version = '1.2.246';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/UserLifecycleRule.js

@@ -81,8 +81,15 @@ var UserLifecycleRule = /*#__PURE__*/(0, _createClass2.default)(function UserLif
   (0, _defineProperty2.default)(this, "setSiteId", function (value) {
     _this.attributes.site_id = value;
   });
-  (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
+  // Parameters:
+  //   action (required) - string - Action to take on inactive users (disable or delete)
+  //   authentication_method (required) - string - User authentication method for the rule
+  //   inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
+  //   include_site_admins - boolean - Include site admins in the rule
+  //   include_folder_admins - boolean - Include folder admins in the rule
+  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
+      response,
       _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
@@ -107,59 +114,175 @@ var UserLifecycleRule = /*#__PURE__*/(0, _createClass2.default)(function UserLif
           }
           throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
         case 8:
-          if (params.id) {
+          if (!(params.action && !(0, _utils.isString)(params.action))) {
+            _context.next = 10;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: action must be of type String, received ".concat((0, _utils.getType)(params.action)));
+        case 10:
+          if (!(params.authentication_method && !(0, _utils.isString)(params.authentication_method))) {
+            _context.next = 12;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: authentication_method must be of type String, received ".concat((0, _utils.getType)(params.authentication_method)));
+        case 12:
+          if (!(params.inactivity_days && !(0, _utils.isInt)(params.inactivity_days))) {
             _context.next = 14;
             break;
           }
+          throw new errors.InvalidParameterError("Bad parameter: inactivity_days must be of type Int, received ".concat((0, _utils.getType)(params.inactivity_days)));
+        case 14:
+          if (params.id) {
+            _context.next = 20;
+            break;
+          }
+          if (!_this.attributes.id) {
+            _context.next = 19;
+            break;
+          }
+          params.id = _this.id;
+          _context.next = 20;
+          break;
+        case 19:
+          throw new errors.MissingParameterError('Parameter missing: id');
+        case 20:
+          if (params.action) {
+            _context.next = 26;
+            break;
+          }
+          if (!_this.attributes.action) {
+            _context.next = 25;
+            break;
+          }
+          params.action = _this.action;
+          _context.next = 26;
+          break;
+        case 25:
+          throw new errors.MissingParameterError('Parameter missing: action');
+        case 26:
+          if (params.authentication_method) {
+            _context.next = 32;
+            break;
+          }
+          if (!_this.attributes.authentication_method) {
+            _context.next = 31;
+            break;
+          }
+          params.authentication_method = _this.authentication_method;
+          _context.next = 32;
+          break;
+        case 31:
+          throw new errors.MissingParameterError('Parameter missing: authentication_method');
+        case 32:
+          if (params.inactivity_days) {
+            _context.next = 38;
+            break;
+          }
+          if (!_this.attributes.inactivity_days) {
+            _context.next = 37;
+            break;
+          }
+          params.inactivity_days = _this.inactivity_days;
+          _context.next = 38;
+          break;
+        case 37:
+          throw new errors.MissingParameterError('Parameter missing: inactivity_days');
+        case 38:
+          _context.next = 40;
+          return _Api.default.sendRequest("/user_lifecycle_rules/".concat(encodeURIComponent(params.id)), 'PATCH', params, _this.options);
+        case 40:
+          response = _context.sent;
+          return _context.abrupt("return", new UserLifecycleRule(response === null || response === void 0 ? void 0 : response.data, _this.options));
+        case 42:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2() {
+    var params,
+      _args2 = arguments;
+    return _regenerator.default.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          params = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
+          if (_this.attributes.id) {
+            _context2.next = 3;
+            break;
+          }
+          throw new errors.EmptyPropertyError('Current object has no id');
+        case 3:
+          if ((0, _utils.isObject)(params)) {
+            _context2.next = 5;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
+        case 5:
+          params.id = _this.attributes.id;
+          if (!(params.id && !(0, _utils.isInt)(params.id))) {
+            _context2.next = 8;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
+        case 8:
+          if (params.id) {
+            _context2.next = 14;
+            break;
+          }
           if (!_this.attributes.id) {
-            _context.next = 13;
+            _context2.next = 13;
             break;
           }
           params.id = _this.id;
-          _context.next = 14;
+          _context2.next = 14;
           break;
         case 13:
           throw new errors.MissingParameterError('Parameter missing: id');
         case 14:
-          _context.next = 16;
+          _context2.next = 16;
           return _Api.default.sendRequest("/user_lifecycle_rules/".concat(encodeURIComponent(params.id)), 'DELETE', params, _this.options);
         case 16:
         case "end":
-          return _context.stop();
+          return _context2.stop();
       }
-    }, _callee);
+    }, _callee2);
   })));
   (0, _defineProperty2.default)(this, "destroy", function () {
     var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     return _this.delete(params);
   });
-  (0, _defineProperty2.default)(this, "save", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2() {
-    var newObject;
-    return _regenerator.default.wrap(function _callee2$(_context2) {
-      while (1) switch (_context2.prev = _context2.next) {
+  (0, _defineProperty2.default)(this, "save", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee3() {
+    var _newObject, newObject;
+    return _regenerator.default.wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
         case 0:
           if (!_this.attributes.id) {
-            _context2.next = 4;
+            _context3.next = 6;
             break;
           }
-          throw new errors.NotImplementedError('The UserLifecycleRule object doesn\'t support updates.');
-        case 4:
-          _context2.next = 6;
-          return UserLifecycleRule.create(_this.attributes, _this.options);
+          _context3.next = 3;
+          return _this.update(_this.attributes);
+        case 3:
+          _newObject = _context3.sent;
+          _this.attributes = _objectSpread({}, _newObject.attributes);
+          return _context3.abrupt("return", true);
         case 6:
-          newObject = _context2.sent;
+          _context3.next = 8;
+          return UserLifecycleRule.create(_this.attributes, _this.options);
+        case 8:
+          newObject = _context3.sent;
           _this.attributes = _objectSpread({}, newObject.attributes);
-          return _context2.abrupt("return", true);
-        case 9:
+          return _context3.abrupt("return", true);
+        case 11:
         case "end":
-          return _context2.stop();
+          return _context3.stop();
       }
-    }, _callee2);
+    }, _callee3);
   })));
-  Object.entries(attributes).forEach(function (_ref3) {
-    var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
-      key = _ref4[0],
-      value = _ref4[1];
+  Object.entries(attributes).forEach(function (_ref4) {
+    var _ref5 = (0, _slicedToArray2.default)(_ref4, 2),
+      key = _ref5[0],
+      value = _ref5[1];
     var normalizedKey = key.replace('?', '');
     _this.attributes[normalizedKey] = value;
     Object.defineProperty(_this, normalizedKey, {
@@ -173,41 +296,41 @@ _UserLifecycleRule = UserLifecycleRule;
 // Parameters:
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-(0, _defineProperty2.default)(UserLifecycleRule, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee3() {
+(0, _defineProperty2.default)(UserLifecycleRule, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var _response$data;
   var params,
     options,
     response,
-    _args3 = arguments;
-  return _regenerator.default.wrap(function _callee3$(_context3) {
-    while (1) switch (_context3.prev = _context3.next) {
+    _args4 = arguments;
+  return _regenerator.default.wrap(function _callee4$(_context4) {
+    while (1) switch (_context4.prev = _context4.next) {
       case 0:
-        params = _args3.length > 0 && _args3[0] !== undefined ? _args3[0] : {};
-        options = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
+        params = _args4.length > 0 && _args4[0] !== undefined ? _args4[0] : {};
+        options = _args4.length > 1 && _args4[1] !== undefined ? _args4[1] : {};
         if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
-          _context3.next = 4;
+          _context4.next = 4;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params.cursor)));
       case 4:
         if (!(params.per_page && !(0, _utils.isInt)(params.per_page))) {
-          _context3.next = 6;
+          _context4.next = 6;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params.per_page)));
       case 6:
-        _context3.next = 8;
+        _context4.next = 8;
         return _Api.default.sendRequest('/user_lifecycle_rules', 'GET', params, options);
       case 8:
-        response = _context3.sent;
-        return _context3.abrupt("return", (response === null || response === void 0 || (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
+        response = _context4.sent;
+        return _context4.abrupt("return", (response === null || response === void 0 || (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
           return new _UserLifecycleRule(obj, options);
         })) || []);
       case 10:
       case "end":
-        return _context3.stop();
+        return _context4.stop();
     }
-  }, _callee3);
+  }, _callee4);
 })));
 (0, _defineProperty2.default)(UserLifecycleRule, "all", function () {
   var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -217,48 +340,48 @@ _UserLifecycleRule = UserLifecycleRule;
 // Parameters:
 //   id (required) - int64 - User Lifecycle Rule ID.
 (0, _defineProperty2.default)(UserLifecycleRule, "find", /*#__PURE__*/function () {
-  var _ref6 = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
+  var _ref7 = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee5(id) {
     var params,
       options,
       response,
-      _args4 = arguments;
-    return _regenerator.default.wrap(function _callee4$(_context4) {
-      while (1) switch (_context4.prev = _context4.next) {
+      _args5 = arguments;
+    return _regenerator.default.wrap(function _callee5$(_context5) {
+      while (1) switch (_context5.prev = _context5.next) {
         case 0:
-          params = _args4.length > 1 && _args4[1] !== undefined ? _args4[1] : {};
-          options = _args4.length > 2 && _args4[2] !== undefined ? _args4[2] : {};
+          params = _args5.length > 1 && _args5[1] !== undefined ? _args5[1] : {};
+          options = _args5.length > 2 && _args5[2] !== undefined ? _args5[2] : {};
           if ((0, _utils.isObject)(params)) {
-            _context4.next = 4;
+            _context5.next = 4;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
         case 4:
           params.id = id;
           if (params.id) {
-            _context4.next = 7;
+            _context5.next = 7;
             break;
           }
           throw new errors.MissingParameterError('Parameter missing: id');
         case 7:
           if (!(params.id && !(0, _utils.isInt)(params.id))) {
-            _context4.next = 9;
+            _context5.next = 9;
             break;
           }
           throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
         case 9:
-          _context4.next = 11;
+          _context5.next = 11;
           return _Api.default.sendRequest("/user_lifecycle_rules/".concat(encodeURIComponent(params.id)), 'GET', params, options);
         case 11:
-          response = _context4.sent;
-          return _context4.abrupt("return", new _UserLifecycleRule(response === null || response === void 0 ? void 0 : response.data, options));
+          response = _context5.sent;
+          return _context5.abrupt("return", new _UserLifecycleRule(response === null || response === void 0 ? void 0 : response.data, options));
         case 13:
         case "end":
-          return _context4.stop();
+          return _context5.stop();
       }
-    }, _callee4);
+    }, _callee5);
   }));
   return function (_x) {
-    return _ref6.apply(this, arguments);
+    return _ref7.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(UserLifecycleRule, "get", function (id) {
@@ -272,62 +395,62 @@ _UserLifecycleRule = UserLifecycleRule;
 //   inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
 //   include_site_admins - boolean - Include site admins in the rule
 //   include_folder_admins - boolean - Include folder admins in the rule
-(0, _defineProperty2.default)(UserLifecycleRule, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee5() {
+(0, _defineProperty2.default)(UserLifecycleRule, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee6() {
   var params,
     options,
     response,
-    _args5 = arguments;
-  return _regenerator.default.wrap(function _callee5$(_context5) {
-    while (1) switch (_context5.prev = _context5.next) {
+    _args6 = arguments;
+  return _regenerator.default.wrap(function _callee6$(_context6) {
+    while (1) switch (_context6.prev = _context6.next) {
       case 0:
-        params = _args5.length > 0 && _args5[0] !== undefined ? _args5[0] : {};
-        options = _args5.length > 1 && _args5[1] !== undefined ? _args5[1] : {};
+        params = _args6.length > 0 && _args6[0] !== undefined ? _args6[0] : {};
+        options = _args6.length > 1 && _args6[1] !== undefined ? _args6[1] : {};
         if (params.action) {
-          _context5.next = 4;
+          _context6.next = 4;
           break;
         }
         throw new errors.MissingParameterError('Parameter missing: action');
       case 4:
         if (params.authentication_method) {
-          _context5.next = 6;
+          _context6.next = 6;
           break;
         }
         throw new errors.MissingParameterError('Parameter missing: authentication_method');
       case 6:
         if (params.inactivity_days) {
-          _context5.next = 8;
+          _context6.next = 8;
           break;
         }
         throw new errors.MissingParameterError('Parameter missing: inactivity_days');
       case 8:
         if (!(params.action && !(0, _utils.isString)(params.action))) {
-          _context5.next = 10;
+          _context6.next = 10;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: action must be of type String, received ".concat((0, _utils.getType)(params.action)));
       case 10:
         if (!(params.authentication_method && !(0, _utils.isString)(params.authentication_method))) {
-          _context5.next = 12;
+          _context6.next = 12;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: authentication_method must be of type String, received ".concat((0, _utils.getType)(params.authentication_method)));
       case 12:
         if (!(params.inactivity_days && !(0, _utils.isInt)(params.inactivity_days))) {
-          _context5.next = 14;
+          _context6.next = 14;
           break;
         }
         throw new errors.InvalidParameterError("Bad parameter: inactivity_days must be of type Int, received ".concat((0, _utils.getType)(params.inactivity_days)));
       case 14:
-        _context5.next = 16;
+        _context6.next = 16;
         return _Api.default.sendRequest('/user_lifecycle_rules', 'POST', params, options);
       case 16:
-        response = _context5.sent;
-        return _context5.abrupt("return", new _UserLifecycleRule(response === null || response === void 0 ? void 0 : response.data, options));
+        response = _context6.sent;
+        return _context6.abrupt("return", new _UserLifecycleRule(response === null || response === void 0 ? void 0 : response.data, options));
       case 18:
       case "end":
-        return _context5.stop();
+        return _context6.stop();
     }
-  }, _callee5);
+  }, _callee6);
 })));
 var _default = exports.default = UserLifecycleRule;
 module.exports = UserLifecycleRule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.245",
+  "version": "1.2.246",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/Files.js

@@ -6,7 +6,7 @@ let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
 let language = null
-const version = '1.2.245'
+const version = '1.2.246'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/UserLifecycleRule.js

@@ -77,6 +77,75 @@ class UserLifecycleRule {
     this.attributes.site_id = value
   }
 
+  // Parameters:
+  //   action (required) - string - Action to take on inactive users (disable or delete)
+  //   authentication_method (required) - string - User authentication method for the rule
+  //   inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
+  //   include_site_admins - boolean - Include site admins in the rule
+  //   include_folder_admins - boolean - Include folder admins in the rule
+  update = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new errors.EmptyPropertyError('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params.id && !isInt(params.id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
+    }
+
+    if (params.action && !isString(params.action)) {
+      throw new errors.InvalidParameterError(`Bad parameter: action must be of type String, received ${getType(params.action)}`)
+    }
+
+    if (params.authentication_method && !isString(params.authentication_method)) {
+      throw new errors.InvalidParameterError(`Bad parameter: authentication_method must be of type String, received ${getType(params.authentication_method)}`)
+    }
+
+    if (params.inactivity_days && !isInt(params.inactivity_days)) {
+      throw new errors.InvalidParameterError(`Bad parameter: inactivity_days must be of type Int, received ${getType(params.inactivity_days)}`)
+    }
+
+    if (!params.id) {
+      if (this.attributes.id) {
+        params.id = this.id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: id')
+      }
+    }
+
+    if (!params.action) {
+      if (this.attributes.action) {
+        params.action = this.action
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: action')
+      }
+    }
+
+    if (!params.authentication_method) {
+      if (this.attributes.authentication_method) {
+        params.authentication_method = this.authentication_method
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: authentication_method')
+      }
+    }
+
+    if (!params.inactivity_days) {
+      if (this.attributes.inactivity_days) {
+        params.inactivity_days = this.inactivity_days
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: inactivity_days')
+      }
+    }
+
+    const response = await Api.sendRequest(`/user_lifecycle_rules/${encodeURIComponent(params.id)}`, 'PATCH', params, this.options)
+
+    return new UserLifecycleRule(response?.data, this.options)
+  }
+
   delete = async (params = {}) => {
     if (!this.attributes.id) {
       throw new errors.EmptyPropertyError('Current object has no id')
@@ -107,12 +176,14 @@ class UserLifecycleRule {
 
   save = async () => {
     if (this.attributes.id) {
-      throw new errors.NotImplementedError('The UserLifecycleRule object doesn\'t support updates.')
-    } else {
-      const newObject = await UserLifecycleRule.create(this.attributes, this.options)
+      const newObject = await this.update(this.attributes)
       this.attributes = { ...newObject.attributes }
       return true
     }
+
+    const newObject = await UserLifecycleRule.create(this.attributes, this.options)
+    this.attributes = { ...newObject.attributes }
+    return true
   }
 
   // Parameters: