files.com 1.0.161 → 1.0.164

package/README.md

@@ -136,7 +136,7 @@ You can set the following global properties using static methods on the `Files`
 #### Getting a file record by path
 
     import File from 'files.com/lib/models/File'
-    const foundFile = await File.find(remoteFilePath)
+    const foundFile = await File.findDownload(remoteFilePath)
 
 #### Download a file (not available in browser)
 

package/_VERSION

@@ -1 +1 @@
-1.0.161
+1.0.164

package/lib/models/File.js

@@ -1166,7 +1166,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     return _ref21.apply(this, arguments);
   };
 }());
-(0, _defineProperty2.default)(File, "find", /*#__PURE__*/function () {
+(0, _defineProperty2.default)(File, "findDownload", /*#__PURE__*/function () {
   var _ref22 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee20(path) {
     var response;
     return _regenerator.default.wrap(function _callee20$(_context20) {

package/lib/models/RemoteServer.js

@@ -245,6 +245,12 @@ var RemoteServer = /*#__PURE__*/(0, _createClass2.default)(function RemoteServer
   (0, _defineProperty2.default)(this, "setS3CompatibleEndpoint", function (value) {
     _this.attributes.s3_compatible_endpoint = value;
   });
+  (0, _defineProperty2.default)(this, "getS3CompatibleRegion", function () {
+    return _this.attributes.s3_compatible_region;
+  });
+  (0, _defineProperty2.default)(this, "setS3CompatibleRegion", function (value) {
+    _this.attributes.s3_compatible_region = value;
+  });
   (0, _defineProperty2.default)(this, "getS3CompatibleAccessKey", function () {
     return _this.attributes.s3_compatible_access_key;
   });
@@ -660,43 +666,51 @@ var RemoteServer = /*#__PURE__*/(0, _createClass2.default)(function RemoteServer
             throw new Error("Bad parameter: s3_compatible_endpoint must be of type String, received ".concat((0, _utils.getType)(s3_compatible_endpoint)));
 
           case 82:
-            if (!(params['s3_compatible_access_key'] && !(0, _utils.isString)(params['s3_compatible_access_key']))) {
+            if (!(params['s3_compatible_region'] && !(0, _utils.isString)(params['s3_compatible_region']))) {
               _context.next = 84;
               break;
             }
 
-            throw new Error("Bad parameter: s3_compatible_access_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_access_key)));
+            throw new Error("Bad parameter: s3_compatible_region must be of type String, received ".concat((0, _utils.getType)(s3_compatible_region)));
 
           case 84:
-            if (!(params['s3_compatible_secret_key'] && !(0, _utils.isString)(params['s3_compatible_secret_key']))) {
+            if (!(params['s3_compatible_access_key'] && !(0, _utils.isString)(params['s3_compatible_access_key']))) {
               _context.next = 86;
               break;
             }
 
-            throw new Error("Bad parameter: s3_compatible_secret_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_secret_key)));
+            throw new Error("Bad parameter: s3_compatible_access_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_access_key)));
 
           case 86:
+            if (!(params['s3_compatible_secret_key'] && !(0, _utils.isString)(params['s3_compatible_secret_key']))) {
+              _context.next = 88;
+              break;
+            }
+
+            throw new Error("Bad parameter: s3_compatible_secret_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_secret_key)));
+
+          case 88:
             if (params['id']) {
-              _context.next = 92;
+              _context.next = 94;
               break;
             }
 
             if (!_this.attributes.id) {
-              _context.next = 91;
+              _context.next = 93;
               break;
             }
 
             params['id'] = _this.id;
-            _context.next = 92;
+            _context.next = 94;
             break;
 
-          case 91:
+          case 93:
             throw new Error('Parameter missing: id');
 
-          case 92:
+          case 94:
             return _context.abrupt("return", _Api.default.sendRequest("/remote_servers/".concat(params['id']), 'PATCH', params, _this.options));
 
-          case 93:
+          case 95:
           case "end":
             return _context.stop();
         }
@@ -1214,30 +1228,38 @@ var RemoteServer = /*#__PURE__*/(0, _createClass2.default)(function RemoteServer
           throw new Error("Bad parameter: s3_compatible_endpoint must be of type String, received ".concat((0, _utils.getType)(s3_compatible_endpoint)));
 
         case 76:
-          if (!(params['s3_compatible_access_key'] && !(0, _utils.isString)(params['s3_compatible_access_key']))) {
+          if (!(params['s3_compatible_region'] && !(0, _utils.isString)(params['s3_compatible_region']))) {
             _context5.next = 78;
             break;
           }
 
-          throw new Error("Bad parameter: s3_compatible_access_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_access_key)));
+          throw new Error("Bad parameter: s3_compatible_region must be of type String, received ".concat((0, _utils.getType)(s3_compatible_region)));
 
         case 78:
-          if (!(params['s3_compatible_secret_key'] && !(0, _utils.isString)(params['s3_compatible_secret_key']))) {
+          if (!(params['s3_compatible_access_key'] && !(0, _utils.isString)(params['s3_compatible_access_key']))) {
             _context5.next = 80;
             break;
           }
 
-          throw new Error("Bad parameter: s3_compatible_secret_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_secret_key)));
+          throw new Error("Bad parameter: s3_compatible_access_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_access_key)));
 
         case 80:
-          _context5.next = 82;
-          return _Api.default.sendRequest("/remote_servers", 'POST', params, options);
+          if (!(params['s3_compatible_secret_key'] && !(0, _utils.isString)(params['s3_compatible_secret_key']))) {
+            _context5.next = 82;
+            break;
+          }
+
+          throw new Error("Bad parameter: s3_compatible_secret_key must be of type String, received ".concat((0, _utils.getType)(s3_compatible_secret_key)));
 
         case 82:
+          _context5.next = 84;
+          return _Api.default.sendRequest("/remote_servers", 'POST', params, options);
+
+        case 84:
           response = _context5.sent;
           return _context5.abrupt("return", new RemoteServer(response === null || response === void 0 ? void 0 : response.data, options));
 
-        case 84:
+        case 86:
         case "end":
           return _context5.stop();
       }

package/lib/models/SsoStrategy.js

@@ -7,10 +7,10 @@ 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 _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -170,10 +170,72 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
   (0, _defineProperty2.default)(this, "getLdapUsernameField", function () {
     return _this.attributes.ldap_username_field;
   });
-  Object.entries(attributes).forEach(function (_ref) {
-    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
-        key = _ref2[0],
-        value = _ref2[1];
+  (0, _defineProperty2.default)(this, "sync", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+    var params,
+        _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] : {};
+
+            if (_this.attributes.id) {
+              _context.next = 3;
+              break;
+            }
+
+            throw new Error('Current object has no id');
+
+          case 3:
+            if ((0, _utils.isObject)(params)) {
+              _context.next = 5;
+              break;
+            }
+
+            throw new Error("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']))) {
+              _context.next = 8;
+              break;
+            }
+
+            throw new Error("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(id)));
+
+          case 8:
+            if (params['id']) {
+              _context.next = 14;
+              break;
+            }
+
+            if (!_this.attributes.id) {
+              _context.next = 13;
+              break;
+            }
+
+            params['id'] = _this.id;
+            _context.next = 14;
+            break;
+
+          case 13:
+            throw new Error('Parameter missing: id');
+
+          case 14:
+            return _context.abrupt("return", _Api.default.sendRequest("/sso_strategies/".concat(params['id'], "/sync"), 'POST', params, _this.options));
+
+          case 15:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  })));
+  Object.entries(attributes).forEach(function (_ref2) {
+    var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
+        key = _ref3[0],
+        value = _ref3[1];
 
     var normalizedKey = key.replace('?', '');
     _this.attributes[normalizedKey] = value;
@@ -184,22 +246,22 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
   });
   this.options = _objectSpread({}, options);
 });
-(0, _defineProperty2.default)(SsoStrategy, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+(0, _defineProperty2.default)(SsoStrategy, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
   var _response$data;
 
   var params,
       options,
       response,
-      _args = arguments;
-  return _regenerator.default.wrap(function _callee$(_context) {
+      _args2 = arguments;
+  return _regenerator.default.wrap(function _callee2$(_context2) {
     while (1) {
-      switch (_context.prev = _context.next) {
+      switch (_context2.prev = _context2.next) {
         case 0:
-          params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
-          options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
+          params = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
+          options = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : {};
 
           if (!(params['cursor'] && !(0, _utils.isString)(params['cursor']))) {
-            _context.next = 4;
+            _context2.next = 4;
             break;
           }
 
@@ -207,28 +269,28 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
 
         case 4:
           if (!(params['per_page'] && !(0, _utils.isInt)(params['per_page']))) {
-            _context.next = 6;
+            _context2.next = 6;
             break;
           }
 
           throw new Error("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(per_page)));
 
         case 6:
-          _context.next = 8;
+          _context2.next = 8;
           return _Api.default.sendRequest("/sso_strategies", 'GET', params, options);
 
         case 8:
-          response = _context.sent;
-          return _context.abrupt("return", (response === null || response === void 0 ? void 0 : (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
+          response = _context2.sent;
+          return _context2.abrupt("return", (response === null || response === void 0 ? void 0 : (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
             return new SsoStrategy(obj, options);
           })) || []);
 
         case 10:
         case "end":
-          return _context.stop();
+          return _context2.stop();
       }
     }
-  }, _callee);
+  }, _callee2);
 })));
 (0, _defineProperty2.default)(SsoStrategy, "all", function () {
   var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -236,20 +298,20 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
   return SsoStrategy.list(params, options);
 });
 (0, _defineProperty2.default)(SsoStrategy, "find", /*#__PURE__*/function () {
-  var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id) {
+  var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(id) {
     var params,
         options,
         response,
-        _args2 = arguments;
-    return _regenerator.default.wrap(function _callee2$(_context2) {
+        _args3 = arguments;
+    return _regenerator.default.wrap(function _callee3$(_context3) {
       while (1) {
-        switch (_context2.prev = _context2.next) {
+        switch (_context3.prev = _context3.next) {
           case 0:
-            params = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : {};
-            options = _args2.length > 2 && _args2[2] !== undefined ? _args2[2] : {};
+            params = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
+            options = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : {};
 
             if ((0, _utils.isObject)(params)) {
-              _context2.next = 4;
+              _context3.next = 4;
               break;
             }
 
@@ -259,7 +321,7 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
             params['id'] = id;
 
             if (params['id']) {
-              _context2.next = 7;
+              _context3.next = 7;
               break;
             }
 
@@ -267,30 +329,30 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
 
           case 7:
             if (!(params['id'] && !(0, _utils.isInt)(params['id']))) {
-              _context2.next = 9;
+              _context3.next = 9;
               break;
             }
 
             throw new Error("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(id)));
 
           case 9:
-            _context2.next = 11;
+            _context3.next = 11;
             return _Api.default.sendRequest("/sso_strategies/".concat(params['id']), 'GET', params, options);
 
           case 11:
-            response = _context2.sent;
-            return _context2.abrupt("return", new SsoStrategy(response === null || response === void 0 ? void 0 : response.data, options));
+            response = _context3.sent;
+            return _context3.abrupt("return", new SsoStrategy(response === null || response === void 0 ? void 0 : response.data, options));
 
           case 13:
           case "end":
-            return _context2.stop();
+            return _context3.stop();
         }
       }
-    }, _callee2);
+    }, _callee3);
   }));
 
   return function (_x) {
-    return _ref4.apply(this, arguments);
+    return _ref5.apply(this, arguments);
   };
 }());
 (0, _defineProperty2.default)(SsoStrategy, "get", function (id) {

package/package.json

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

package/src/models/File.js

@@ -178,7 +178,7 @@ class File {
     return saveUrlToFile(this.download_uri, destinationPath)
   }
 
-  static find = async path => {
+  static findDownload = async path => {
     const response = await Api.sendRequest(`/files/${encodeURIComponent(path)}`, 'GET')
     return new File(response.data)
   }

package/src/models/RemoteServer.js

@@ -260,6 +260,13 @@ class RemoteServer {
     this.attributes.s3_compatible_endpoint = value
   }
 
+  // string # S3-compatible endpoint
+  getS3CompatibleRegion = () => this.attributes.s3_compatible_region
+
+  setS3CompatibleRegion = value => {
+    this.attributes.s3_compatible_region = value
+  }
+
   // string # S3-compatible Access Key.
   getS3CompatibleAccessKey = () => this.attributes.s3_compatible_access_key
 
@@ -398,6 +405,7 @@ class RemoteServer {
   //   azure_blob_storage_container - string - Azure Blob Storage Container name
   //   s3_compatible_bucket - string - S3-compatible Bucket name
   //   s3_compatible_endpoint - string - S3-compatible endpoint
+  //   s3_compatible_region - string - S3-compatible endpoint
   //   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
   //   s3_compatible_access_key - string - S3-compatible Access Key.
   //   s3_compatible_secret_key - string - S3-compatible secret key
@@ -525,6 +533,9 @@ class RemoteServer {
     if (params['s3_compatible_endpoint'] && !isString(params['s3_compatible_endpoint'])) {
       throw new Error(`Bad parameter: s3_compatible_endpoint must be of type String, received ${getType(s3_compatible_endpoint)}`)
     }
+    if (params['s3_compatible_region'] && !isString(params['s3_compatible_region'])) {
+      throw new Error(`Bad parameter: s3_compatible_region must be of type String, received ${getType(s3_compatible_region)}`)
+    }
     if (params['s3_compatible_access_key'] && !isString(params['s3_compatible_access_key'])) {
       throw new Error(`Bad parameter: s3_compatible_access_key must be of type String, received ${getType(s3_compatible_access_key)}`)
     }
@@ -665,6 +676,7 @@ class RemoteServer {
   //   azure_blob_storage_container - string - Azure Blob Storage Container name
   //   s3_compatible_bucket - string - S3-compatible Bucket name
   //   s3_compatible_endpoint - string - S3-compatible endpoint
+  //   s3_compatible_region - string - S3-compatible endpoint
   //   enable_dedicated_ips - boolean - `true` if remote server only accepts connections from dedicated IPs
   //   s3_compatible_access_key - string - S3-compatible Access Key.
   //   s3_compatible_secret_key - string - S3-compatible secret key
@@ -817,6 +829,10 @@ class RemoteServer {
       throw new Error(`Bad parameter: s3_compatible_endpoint must be of type String, received ${getType(s3_compatible_endpoint)}`)
     }
 
+    if (params['s3_compatible_region'] && !isString(params['s3_compatible_region'])) {
+      throw new Error(`Bad parameter: s3_compatible_region must be of type String, received ${getType(s3_compatible_region)}`)
+    }
+
     if (params['s3_compatible_access_key'] && !isString(params['s3_compatible_access_key'])) {
       throw new Error(`Bad parameter: s3_compatible_access_key must be of type String, received ${getType(s3_compatible_access_key)}`)
     }

package/src/models/SsoStrategy.js

@@ -152,6 +152,32 @@ class SsoStrategy {
   getLdapUsernameField = () => this.attributes.ldap_username_field
 
 
+  // Synchronize provisioning data with the SSO remote server
+  sync = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new Error('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new Error(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params['id'] && !isInt(params['id'])) {
+      throw new Error(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+
+    if (!params['id']) {
+      if (this.attributes.id) {
+        params['id'] = this.id
+      } else {
+        throw new Error('Parameter missing: id')
+      }
+    }
+
+    return Api.sendRequest(`/sso_strategies/${params['id']}/sync`, 'POST', params, this.options)
+  }
+
   // Parameters:
   //   cursor - string - Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

package/test/src/index.js

@@ -40,12 +40,16 @@ const testSuite = async () => {
   const nonce = new Date().getTime()
 
   const testFolderListAutoPagination = async () => {
-    Files.setAutoPaginate(false)
+    Files.configureNetwork({
+      autoPaginate: false,
+    })
     const firstPageItems = await Folder.listFor('/', { per_page: 1 })
-    assert(firstPageItems.length === 1)
 
-    Files.setAutoPaginate(true)
+    assert(firstPageItems.length === 1)
 
+    Files.configureNetwork({
+      autoPaginate: true,
+    })
     // note: this test will fail if the root folder has <= 1 file or folder
     const allPageItems = await Folder.listFor('/', { per_page: 1 })
 
@@ -66,7 +70,7 @@ const testSuite = async () => {
     assert(!!file.path)
     assert(file.display_name === displayName)
 
-    const foundFile = await File.find(destinationPath)
+    const foundFile = await File.findDownload(destinationPath)
 
     assert(foundFile.path === destinationPath)
     assert(foundFile.display_name === displayName)