files.com 1.2.131 → 1.2.133

package/_VERSION

@@ -1 +1 @@
-1.2.131
+1.2.133

package/docs/models/Automation.md

@@ -15,6 +15,7 @@
     "destination"
   ],
   "disabled": true,
+  "exclude_pattern": "example",
   "flatten_destination_structure": true,
   "group_ids": [
     1,
@@ -71,6 +72,7 @@
 * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
 * `destinations` (array(string)): Destination Paths
 * `disabled` (boolean): If true, this automation will not run.
+* `exclude_pattern` (string): If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
 * `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
 * `group_ids` (array(int64)): IDs of Groups for the Automation (i.e. who to Request File from)
 * `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
@@ -87,7 +89,7 @@
 * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
 * `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
 * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
-* `source` (string): Source Path
+* `source` (string): Source path. Supports globs, except on remote mounts.
 * `sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 * `trigger` (string): How this automation is triggered to run.
@@ -294,6 +296,7 @@ await automation.update({
     "destination"
   ],
   "disabled": true,
+  "exclude_pattern": "example",
   "flatten_destination_structure": true,
   "group_ids": [
     1,

package/docs/models/Site.md

@@ -157,6 +157,7 @@
     "multiple_regions": true,
     "read_only": true,
     "root_path": "example",
+    "home_path": "example",
     "sftp_insecure_ciphers": false,
     "site_id": 1,
     "ssl_required": true,
@@ -262,6 +263,7 @@
     "type_of_2fa_for_display": "yubi",
     "updated_at": "2000-01-01T01:00:00Z",
     "user_root": "example",
+    "user_home": "example",
     "days_remaining_until_password_expire": 1,
     "password_expire_at": "2000-01-01T01:00:00Z"
   },

package/docs/models/User.md

@@ -67,6 +67,7 @@
   "type_of_2fa": "yubi",
   "type_of_2fa_for_display": "yubi",
   "user_root": "example",
+  "user_home": "example",
   "days_remaining_until_password_expire": 1,
   "password_expire_at": "2000-01-01T01:00:00Z"
 }
@@ -132,7 +133,8 @@
 * `time_zone` (string): User time zone
 * `type_of_2fa` (string): Type(s) of 2FA methods in use, for programmatic use.  Will be either `sms`, `totp`, `webauthn`, `yubi`, `email`, or multiple values sorted alphabetically and joined by an underscore.  Does not specify whether user has more than one of a given method.
 * `type_of_2fa_for_display` (string): Type(s) of 2FA methods in use, formatted for displaying in the UI.  Unlike `type_of_2fa`, this value will make clear when a user has more than 1 of the same type of method.
-* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
+* `user_home` (string): Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
 * `days_remaining_until_password_expire` (int64): Number of days remaining until password expires
 * `password_expire_at` (date-time): Password expiration datetime
 * `avatar_file` (file): An image file for your user avatar.
@@ -226,6 +228,7 @@ await User.create({
   'require_2fa': "always_require",
   'time_zone': "Pacific Time (US & Canada)",
   'user_root': "example",
+  'user_home': "example",
   'username': "user",
 })
 ```
@@ -277,7 +280,8 @@ await User.create({
 * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
 * `require_2fa` (string): 2FA required setting
 * `time_zone` (string): User time zone
-* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
+* `user_home` (string): Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
 * `username` (string): Required - User's username
 
 ---
@@ -371,6 +375,7 @@ await user.update({
   'require_2fa': "always_require",
   'time_zone': "Pacific Time (US & Canada)",
   'user_root': "example",
+  'user_home': "example",
   'username': "user",
 })
 ```
@@ -422,7 +427,8 @@ await user.update({
 * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
 * `require_2fa` (string): 2FA required setting
 * `time_zone` (string): User time zone
-* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
+* `user_home` (string): Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
 * `username` (string): User's username
 
 ### Example Response
@@ -492,6 +498,7 @@ await user.update({
   "type_of_2fa": "yubi",
   "type_of_2fa_for_display": "yubi",
   "user_root": "example",
+  "user_home": "example",
   "days_remaining_until_password_expire": 1,
   "password_expire_at": "2000-01-01T01:00:00Z"
 }

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.131';
+var version = '1.2.133';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/Automation.js

@@ -96,6 +96,13 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setDisabled", function (value) {
     _this.attributes.disabled = value;
   });
+  // string # If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
+  (0, _defineProperty2.default)(this, "getExcludePattern", function () {
+    return _this.attributes.exclude_pattern;
+  });
+  (0, _defineProperty2.default)(this, "setExcludePattern", function (value) {
+    _this.attributes.exclude_pattern = value;
+  });
   // boolean # Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
   (0, _defineProperty2.default)(this, "getFlattenDestinationStructure", function () {
     return _this.attributes.flatten_destination_structure;
@@ -208,7 +215,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setScheduleTimeZone", function (value) {
     _this.attributes.schedule_time_zone = value;
   });
-  // string # Source Path
+  // string # Source path. Supports globs, except on remote mounts.
   (0, _defineProperty2.default)(this, "getSource", function () {
     return _this.attributes.source;
   });

package/lib/models/User.js

@@ -450,13 +450,20 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
   (0, _defineProperty2.default)(this, "setTypeOf2faForDisplay", function (value) {
     _this.attributes.type_of_2fa_for_display = value;
   });
-  // string # Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+  // string # Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
   (0, _defineProperty2.default)(this, "getUserRoot", function () {
     return _this.attributes.user_root;
   });
   (0, _defineProperty2.default)(this, "setUserRoot", function (value) {
     _this.attributes.user_root = value;
   });
+  // string # Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
+  (0, _defineProperty2.default)(this, "getUserHome", function () {
+    return _this.attributes.user_home;
+  });
+  (0, _defineProperty2.default)(this, "setUserHome", function (value) {
+    _this.attributes.user_home = value;
+  });
   // int64 # Number of days remaining until password expires
   (0, _defineProperty2.default)(this, "getDaysRemainingUntilPasswordExpire", function () {
     return _this.attributes.days_remaining_until_password_expire;
@@ -733,7 +740,8 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
   //   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
   //   require_2fa - string - 2FA required setting
   //   time_zone - string - User time zone
-  //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+  //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
+  //   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
   //   username - string - User's username
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
     var params,
@@ -912,32 +920,38 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
           }
           throw new errors.InvalidParameterError("Bad parameter: user_root must be of type String, received ".concat((0, _utils.getType)(params.user_root)));
         case 58:
-          if (!(params.username && !(0, _utils.isString)(params.username))) {
+          if (!(params.user_home && !(0, _utils.isString)(params.user_home))) {
             _context4.next = 60;
             break;
           }
-          throw new errors.InvalidParameterError("Bad parameter: username must be of type String, received ".concat((0, _utils.getType)(params.username)));
+          throw new errors.InvalidParameterError("Bad parameter: user_home must be of type String, received ".concat((0, _utils.getType)(params.user_home)));
         case 60:
+          if (!(params.username && !(0, _utils.isString)(params.username))) {
+            _context4.next = 62;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: username must be of type String, received ".concat((0, _utils.getType)(params.username)));
+        case 62:
           if (params.id) {
-            _context4.next = 66;
+            _context4.next = 68;
             break;
           }
           if (!_this.attributes.id) {
-            _context4.next = 65;
+            _context4.next = 67;
             break;
           }
           params.id = _this.id;
-          _context4.next = 66;
+          _context4.next = 68;
           break;
-        case 65:
+        case 67:
           throw new errors.MissingParameterError('Parameter missing: id');
-        case 66:
-          _context4.next = 68;
-          return _Api.default.sendRequest("/users/".concat(encodeURIComponent(params.id)), 'PATCH', params, _this.options);
         case 68:
+          _context4.next = 70;
+          return _Api.default.sendRequest("/users/".concat(encodeURIComponent(params.id)), 'PATCH', params, _this.options);
+        case 70:
           response = _context4.sent;
           return _context4.abrupt("return", new User(response === null || response === void 0 ? void 0 : response.data, _this.options));
-        case 70:
+        case 72:
         case "end":
           return _context4.stop();
       }
@@ -1199,7 +1213,8 @@ _User = User;
 //   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
 //   require_2fa - string - 2FA required setting
 //   time_zone - string - User time zone
-//   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+//   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
+//   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
 //   username (required) - string - User's username
 (0, _defineProperty2.default)(User, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee9() {
   var params,
@@ -1367,18 +1382,24 @@ _User = User;
         }
         throw new errors.InvalidParameterError("Bad parameter: user_root must be of type String, received ".concat((0, _utils.getType)(params.user_root)));
       case 54:
-        if (!(params.username && !(0, _utils.isString)(params.username))) {
+        if (!(params.user_home && !(0, _utils.isString)(params.user_home))) {
           _context9.next = 56;
           break;
         }
-        throw new errors.InvalidParameterError("Bad parameter: username must be of type String, received ".concat((0, _utils.getType)(params.username)));
+        throw new errors.InvalidParameterError("Bad parameter: user_home must be of type String, received ".concat((0, _utils.getType)(params.user_home)));
       case 56:
-        _context9.next = 58;
-        return _Api.default.sendRequest('/users', 'POST', params, options);
+        if (!(params.username && !(0, _utils.isString)(params.username))) {
+          _context9.next = 58;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: username must be of type String, received ".concat((0, _utils.getType)(params.username)));
       case 58:
+        _context9.next = 60;
+        return _Api.default.sendRequest('/users', 'POST', params, options);
+      case 60:
         response = _context9.sent;
         return _context9.abrupt("return", new _User(response === null || response === void 0 ? void 0 : response.data, options));
-      case 60:
+      case 62:
       case "end":
         return _context9.stop();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.131",
+  "version": "1.2.133",
   "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.131'
+const version = '1.2.133'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Automation.js

@@ -91,6 +91,13 @@ class Automation {
     this.attributes.disabled = value
   }
 
+  // string # If set, this glob pattern will exclude files from the automation. Supports globs, except on remote mounts.
+  getExcludePattern = () => this.attributes.exclude_pattern
+
+  setExcludePattern = value => {
+    this.attributes.exclude_pattern = value
+  }
+
   // boolean # Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination.  If this flag is `true`, the source folder structure will be flattened in the destination.  This is useful for copying or moving files from multiple folders into a single destination folder.
   getFlattenDestinationStructure = () => this.attributes.flatten_destination_structure
 
@@ -203,7 +210,7 @@ class Automation {
     this.attributes.schedule_time_zone = value
   }
 
-  // string # Source Path
+  // string # Source path. Supports globs, except on remote mounts.
   getSource = () => this.attributes.source
 
   setSource = value => {

package/src/models/User.js

@@ -444,13 +444,20 @@ class User {
     this.attributes.type_of_2fa_for_display = value
   }
 
-  // string # Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+  // string # Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
   getUserRoot = () => this.attributes.user_root
 
   setUserRoot = value => {
     this.attributes.user_root = value
   }
 
+  // string # Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
+  getUserHome = () => this.attributes.user_home
+
+  setUserHome = value => {
+    this.attributes.user_home = value
+  }
+
   // int64 # Number of days remaining until password expires
   getDaysRemainingUntilPasswordExpire = () => this.attributes.days_remaining_until_password_expire
 
@@ -658,7 +665,8 @@ class User {
   //   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
   //   require_2fa - string - 2FA required setting
   //   time_zone - string - User time zone
-  //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+  //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
+  //   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
   //   username - string - User's username
   update = async (params = {}) => {
     if (!this.attributes.id) {
@@ -774,6 +782,10 @@ class User {
       throw new errors.InvalidParameterError(`Bad parameter: user_root must be of type String, received ${getType(params.user_root)}`)
     }
 
+    if (params.user_home && !isString(params.user_home)) {
+      throw new errors.InvalidParameterError(`Bad parameter: user_home must be of type String, received ${getType(params.user_home)}`)
+    }
+
     if (params.username && !isString(params.username)) {
       throw new errors.InvalidParameterError(`Bad parameter: username must be of type String, received ${getType(params.username)}`)
     }
@@ -938,7 +950,8 @@ class User {
   //   subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
   //   require_2fa - string - 2FA required setting
   //   time_zone - string - User time zone
-  //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+  //   user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set).  Note that this is not used for API, Desktop, or Web interface.
+  //   user_home - string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
   //   username (required) - string - User's username
   static create = async (params = {}, options = {}) => {
     if (!params.username) {
@@ -1045,6 +1058,10 @@ class User {
       throw new errors.InvalidParameterError(`Bad parameter: user_root must be of type String, received ${getType(params.user_root)}`)
     }
 
+    if (params.user_home && !isString(params.user_home)) {
+      throw new errors.InvalidParameterError(`Bad parameter: user_home must be of type String, received ${getType(params.user_home)}`)
+    }
+
     if (params.username && !isString(params.username)) {
       throw new errors.InvalidParameterError(`Bad parameter: username must be of type String, received ${getType(params.username)}`)
     }