files.com 1.2.140 → 1.2.141

package/_VERSION

@@ -1 +1 @@
-1.2.140
+1.2.141

package/docs/models/Permission.md

@@ -62,6 +62,7 @@ await Permission.create({
   'recursive': true,
   'user_id': 1,
   'username': "user",
+  'group_name': "example",
 })
 ```
 
@@ -69,11 +70,12 @@ await Permission.create({
 ### Parameters
 
 * `path` (string): Required - Folder path
-* `group_id` (int64): Group ID
+* `group_id` (int64): Group ID. Provide `group_name` or `group_id`
 * `permission` (string): Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
 * `recursive` (boolean): Apply to subfolders recursively?
 * `user_id` (int64): User ID.  Provide `username` or `user_id`
 * `username` (string): User username.  Provide `username` or `user_id`
+* `group_name` (string): Group name.  Provide `group_name` or `group_id`
 
 ---
 

package/docs/models/UserSftpClientUse.md

@@ -0,0 +1,36 @@
+# UserSftpClientUse
+
+## Example UserSftpClientUse Object
+
+```
+{
+  "id": 1,
+  "sftp_client": "example",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z",
+  "user_id": 1
+}
+```
+
+* `id` (int64): UserSftpClientUse ID
+* `sftp_client` (string): The SFTP client used
+* `created_at` (date-time): The earliest recorded use of this SFTP client (for this user)
+* `updated_at` (date-time): The most recent use of this SFTP client (for this user)
+* `user_id` (int64): ID of the user who performed this access
+
+---
+
+## List User SFTP Client Uses
+
+```
+await UserSftpClientUse.list({
+  'user_id': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `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).

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.140';
+var version = '1.2.141';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/Permission.js

@@ -249,11 +249,12 @@ _Permission = Permission;
 });
 // Parameters:
 //   path (required) - string - Folder path
-//   group_id - int64 - Group ID
+//   group_id - int64 - Group ID. Provide `group_name` or `group_id`
 //   permission - string - Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
 //   recursive - boolean - Apply to subfolders recursively?
 //   user_id - int64 - User ID.  Provide `username` or `user_id`
 //   username - string - User username.  Provide `username` or `user_id`
+//   group_name - string - Group name.  Provide `group_name` or `group_id`
 (0, _defineProperty2.default)(Permission, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
   var params,
     options,
@@ -300,12 +301,18 @@ _Permission = Permission;
         }
         throw new errors.InvalidParameterError("Bad parameter: username must be of type String, received ".concat((0, _utils.getType)(params.username)));
       case 14:
-        _context4.next = 16;
-        return _Api.default.sendRequest('/permissions', 'POST', params, options);
+        if (!(params.group_name && !(0, _utils.isString)(params.group_name))) {
+          _context4.next = 16;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: group_name must be of type String, received ".concat((0, _utils.getType)(params.group_name)));
       case 16:
+        _context4.next = 18;
+        return _Api.default.sendRequest('/permissions', 'POST', params, options);
+      case 18:
         response = _context4.sent;
         return _context4.abrupt("return", new _Permission(response === null || response === void 0 ? void 0 : response.data, options));
-      case 18:
+      case 20:
       case "end":
         return _context4.stop();
     }

package/lib/models/UserSftpClientUse.js

@@ -0,0 +1,123 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+exports.__esModule = true;
+exports.default = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _Api = _interopRequireDefault(require("../Api"));
+var errors = _interopRequireWildcard(require("../Errors"));
+var _utils = require("../utils");
+var _UserSftpClientUse;
+/* eslint-disable no-unused-vars */
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/* eslint-enable no-unused-vars */
+/**
+ * Class UserSftpClientUse
+ */
+var UserSftpClientUse = /*#__PURE__*/(0, _createClass2.default)(function UserSftpClientUse() {
+  var _this = this;
+  var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  (0, _classCallCheck2.default)(this, UserSftpClientUse);
+  (0, _defineProperty2.default)(this, "attributes", {});
+  (0, _defineProperty2.default)(this, "options", {});
+  (0, _defineProperty2.default)(this, "isLoaded", function () {
+    return !!_this.attributes.id;
+  });
+  // int64 # UserSftpClientUse ID
+  (0, _defineProperty2.default)(this, "getId", function () {
+    return _this.attributes.id;
+  });
+  // string # The SFTP client used
+  (0, _defineProperty2.default)(this, "getSftpClient", function () {
+    return _this.attributes.sftp_client;
+  });
+  // date-time # The earliest recorded use of this SFTP client (for this user)
+  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
+    return _this.attributes.created_at;
+  });
+  // date-time # The most recent use of this SFTP client (for this user)
+  (0, _defineProperty2.default)(this, "getUpdatedAt", function () {
+    return _this.attributes.updated_at;
+  });
+  // int64 # ID of the user who performed this access
+  (0, _defineProperty2.default)(this, "getUserId", function () {
+    return _this.attributes.user_id;
+  });
+  Object.entries(attributes).forEach(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    var normalizedKey = key.replace('?', '');
+    _this.attributes[normalizedKey] = value;
+    Object.defineProperty(_this, normalizedKey, {
+      value: value,
+      writable: false
+    });
+  });
+  this.options = _objectSpread({}, options);
+});
+_UserSftpClientUse = UserSftpClientUse;
+// Parameters:
+//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+//   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)(UserSftpClientUse, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
+  var _response$data;
+  var params,
+    options,
+    response,
+    _args = arguments;
+  return _regenerator.default.wrap(function _callee$(_context) {
+    while (1) switch (_context.prev = _context.next) {
+      case 0:
+        params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+        options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
+        if (!(params.user_id && !(0, _utils.isInt)(params.user_id))) {
+          _context.next = 4;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params.user_id)));
+      case 4:
+        if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
+          _context.next = 6;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params.cursor)));
+      case 6:
+        if (!(params.per_page && !(0, _utils.isInt)(params.per_page))) {
+          _context.next = 8;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params.per_page)));
+      case 8:
+        _context.next = 10;
+        return _Api.default.sendRequest('/user_sftp_client_uses', 'GET', params, options);
+      case 10:
+        response = _context.sent;
+        return _context.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 _UserSftpClientUse(obj, options);
+        })) || []);
+      case 12:
+      case "end":
+        return _context.stop();
+    }
+  }, _callee);
+})));
+(0, _defineProperty2.default)(UserSftpClientUse, "all", function () {
+  var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return _UserSftpClientUse.list(params, options);
+});
+var _default = exports.default = UserSftpClientUse;
+module.exports = UserSftpClientUse;
+module.exports.default = UserSftpClientUse;

package/package.json

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

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.140'
+const version = '1.2.141'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Permission.js

@@ -163,11 +163,12 @@ class Permission {
 
   // Parameters:
   //   path (required) - string - Folder path
-  //   group_id - int64 - Group ID
+  //   group_id - int64 - Group ID. Provide `group_name` or `group_id`
   //   permission - string - Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
   //   recursive - boolean - Apply to subfolders recursively?
   //   user_id - int64 - User ID.  Provide `username` or `user_id`
   //   username - string - User username.  Provide `username` or `user_id`
+  //   group_name - string - Group name.  Provide `group_name` or `group_id`
   static create = async (params = {}, options = {}) => {
     if (!params.path) {
       throw new errors.MissingParameterError('Parameter missing: path')
@@ -193,6 +194,10 @@ class Permission {
       throw new errors.InvalidParameterError(`Bad parameter: username must be of type String, received ${getType(params.username)}`)
     }
 
+    if (params.group_name && !isString(params.group_name)) {
+      throw new errors.InvalidParameterError(`Bad parameter: group_name must be of type String, received ${getType(params.group_name)}`)
+    }
+
     const response = await Api.sendRequest('/permissions', 'POST', params, options)
 
     return new Permission(response?.data, options)

package/src/models/UserSftpClientUse.js

@@ -0,0 +1,75 @@
+/* eslint-disable no-unused-vars */
+import Api from '../Api'
+import * as errors from '../Errors'
+import {
+  getType, isArray, isInt, isObject, isString,
+} from '../utils'
+/* eslint-enable no-unused-vars */
+
+/**
+ * Class UserSftpClientUse
+ */
+class UserSftpClientUse {
+  attributes = {}
+
+  options = {}
+
+  constructor(attributes = {}, options = {}) {
+    Object.entries(attributes).forEach(([key, value]) => {
+      const normalizedKey = key.replace('?', '')
+
+      this.attributes[normalizedKey] = value
+
+      Object.defineProperty(this, normalizedKey, { value, writable: false })
+    })
+
+    this.options = { ...options }
+  }
+
+  isLoaded = () => !!this.attributes.id
+
+  // int64 # UserSftpClientUse ID
+  getId = () => this.attributes.id
+
+  // string # The SFTP client used
+  getSftpClient = () => this.attributes.sftp_client
+
+  // date-time # The earliest recorded use of this SFTP client (for this user)
+  getCreatedAt = () => this.attributes.created_at
+
+  // date-time # The most recent use of this SFTP client (for this user)
+  getUpdatedAt = () => this.attributes.updated_at
+
+  // int64 # ID of the user who performed this access
+  getUserId = () => this.attributes.user_id
+
+  // Parameters:
+  //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+  //   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).
+  static list = async (params = {}, options = {}) => {
+    if (params.user_id && !isInt(params.user_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params.user_id)}`)
+    }
+
+    if (params.cursor && !isString(params.cursor)) {
+      throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
+    }
+
+    if (params.per_page && !isInt(params.per_page)) {
+      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
+    }
+
+    const response = await Api.sendRequest('/user_sftp_client_uses', 'GET', params, options)
+
+    return response?.data?.map(obj => new UserSftpClientUse(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    UserSftpClientUse.list(params, options)
+}
+
+export default UserSftpClientUse
+
+module.exports = UserSftpClientUse
+module.exports.default = UserSftpClientUse