files.com 1.1.141 → 1.1.142

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b77edd04efc6c1da8fef4acf1fb5e9afa83104e6d93468032a3e3105034f52e3
-  data.tar.gz: e9a8b187095561b8cdd7f795abad690059b66fa74fecc7c08f78a8ea33673f99
+  metadata.gz: c9c439963bc3f757605322acd4e3a3c87bdc161fc9cb1304b3b0434327adcb09
+  data.tar.gz: e24ad0310e20f6b8464efd63403a81bcb3c6795698c3ae6c1be700cd6174b054
 SHA512:
-  metadata.gz: 0f9283ee0adf583c5868961365e923a6988295759f729f076a0d278e08b23ca07ee1c23581c32eb2428868519d209dcee5af2d473907f352fe1d8b07c3cc28a0
-  data.tar.gz: e781ec4025134754637cd08d38d7cbff4625c330aedfb8c584290ce40491d06c697d5dcf62a8e4356c9287658382bfd3e9397c34440e93ca28d438985af29d15
+  metadata.gz: 9d6ea89af7f64985907a0fa58290d1a1a1c226a3937593a99a671281962d3fd9be35740be51952335ee30ccafa4a012d76f9fc04f9788d5ff04d010d309652b7
+  data.tar.gz: 5f5fdbd0bfa4bf7bec1ea23e7185273d2dbf03062ee932b76c6539f9f481383b69fe728930204bdcae58ce4da8ab021dca2b418030ec7d2e2218f52e8ecc6c5f

data/_VERSION

@@ -1 +1 @@
-1.1.141
+1.1.142

data/docs/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"
   },

data/docs/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.
@@ -227,6 +229,7 @@ Files::User.create(
   require_2fa: "always_require", 
   time_zone: "Pacific Time (US & Canada)", 
   user_root: "example", 
+  user_home: "example", 
   username: "user"
 )
 ```
@@ -277,7 +280,8 @@ Files::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
 
 
@@ -364,6 +368,7 @@ Files::User.update(id,
   require_2fa: "always_require", 
   time_zone: "Pacific Time (US & Canada)", 
   user_root: "example", 
+  user_home: "example", 
   username: "user"
 )
 ```
@@ -415,7 +420,8 @@ Files::User.update(id,
 * `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
 
 
@@ -523,6 +529,7 @@ user.update(
   require_2fa: "always_require",
   time_zone: "Pacific Time (US & Canada)",
   user_root: "example",
+  user_home: "example",
   username: "user"
 )
 ```
@@ -574,7 +581,8 @@ 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
 
 

data/lib/files.com/models/user.rb

@@ -545,7 +545,7 @@ module Files
       @attributes[:type_of_2fa_for_display] = value
     end
 
-    # 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.
     def user_root
       @attributes[:user_root]
     end
@@ -554,6 +554,15 @@ module Files
       @attributes[:user_root] = value
     end
 
+    # string - Home folder for FTP/SFTP.  Note that this is not used for API, Desktop, or Web interface.
+    def user_home
+      @attributes[:user_home]
+    end
+
+    def user_home=(value)
+      @attributes[:user_home] = value
+    end
+
     # int64 - Number of days remaining until password expires
     def days_remaining_until_password_expire
       @attributes[:days_remaining_until_password_expire]
@@ -740,7 +749,8 @@ module Files
     #   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
     def update(params = {})
       params ||= {}
@@ -772,6 +782,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: require_2fa must be an String") if params[:require_2fa] and !params[:require_2fa].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: user_home must be an String") if params[:user_home] and !params[:user_home].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 
@@ -899,7 +910,8 @@ module Files
     #   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
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: change_password must be an String") if params[:change_password] and !params[:change_password].is_a?(String)
@@ -927,6 +939,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: require_2fa must be an String") if params[:require_2fa] and !params[:require_2fa].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: user_home must be an String") if params[:user_home] and !params[:user_home].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
       raise MissingParameterError.new("Parameter missing: username") unless params[:username]
 
@@ -1012,7 +1025,8 @@ module Files
     #   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
     def self.update(id, params = {}, options = {})
       params ||= {}
@@ -1043,6 +1057,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: require_2fa must be an String") if params[:require_2fa] and !params[:require_2fa].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: time_zone must be an String") if params[:time_zone] and !params[:time_zone].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: user_home must be an String") if params[:user_home] and !params[:user_home].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.141"
+  VERSION = "1.1.142"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.141
+  version: 1.1.142
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable