files.com 1.1.37 → 1.1.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41d35795768860fe1d590f1be18f2c3f326996b832a4e1a5f514f3952186e815
-  data.tar.gz: 4c6dfc3b110e69683a00a4b37f976dd5f5fdfdf52b11e6cb30c0cb702a2603be
+  metadata.gz: 5bdca7f14a144ff45297087058c8be5ee936fd2419096460f79c73a8c09dd8f9
+  data.tar.gz: 6c7040f50656da1582b28f53d2f93305a175f594fc9de8f9f0aa28921ac83afa
 SHA512:
-  metadata.gz: 3b0276c0ee2a443e689c0eb0d3900a985e5d3c47f3503ebcaa8af72dc30265b6793fe9e995319716ff981e1145f1df0b59bd91ddca4eae4c419ca041b7585248
-  data.tar.gz: b43fe18a0d2e007ae71cfe6df77b8e8d9fb3ca7364fc09a7f162ee712ed931aed348c5596c6dcd96b05e485338da9399b60c51450bd2cc794b83a6f096e7fcfb
+  metadata.gz: 2cff61499d332d6edcfb9d8884b1b2783aa2328d414a580d42548a66b44e2bebc851bc56c2a04bba0b6d06b168e0600f47d153fc0d222cd109ba22dbfaa8be05
+  data.tar.gz: 7d9da42c1520b5bd91058d665c1c80e31cd165b72cfaf68fafb2b55ee8e395fdf17e2840d526b27f56b6a923399bea84d00d87521cd11c0cd2e9612bbc63cdc2

data/_VERSION

@@ -1 +1 @@
-1.1.37
+1.1.38

data/docs/remote_server.md

@@ -315,16 +315,9 @@ Files::RemoteServer.create(
 
 ```
 Files::RemoteServer.configuration_file(id, 
-  api_token: "example", 
-  permission_set: "full", 
-  root: "example", 
-  hostname: "example", 
-  port: 1, 
-  status: "example", 
-  config_version: "example", 
+  permission_set: "example", 
+  root: "C:\\Users\\", 
   private_key: "example", 
-  public_key: "example", 
-  server_host_key: "example", 
   subdomain: "example"
 )
 ```
@@ -332,17 +325,10 @@ Files::RemoteServer.configuration_file(id,
 ### Parameters
 
 * `id` (int64): Required - Remote Server ID.
-* `api_token` (string): Files Agent API Token
-* `permission_set` (string): 
-* `root` (string): Agent local root path
-* `hostname` (string): 
-* `port` (int64): Incoming port for files agent connections
-* `status` (string): either running or shutdown
-* `config_version` (string): agent config version
-* `private_key` (string): private key
-* `public_key` (string): public key
-* `server_host_key` (string): 
-* `subdomain` (string): 
+* `permission_set` (string): The permission set for the agent ['read_write', 'read_only', 'write_only']
+* `root` (string): The root directory for the agent
+* `private_key` (string): The private key for the agent
+* `subdomain` (string): Files.com subdomain site name
 
 
 ---
@@ -494,16 +480,9 @@ Files::RemoteServer.delete(id)
 remote_server = Files::RemoteServer.list.first
 
 remote_server.configuration_file(
-  api_token: "example",
-  permission_set: "full",
-  root: "example",
-  hostname: "example",
-  port: 1,
-  status: "example",
-  config_version: "example",
+  permission_set: "example",
+  root: "C:\\Users\\",
   private_key: "example",
-  public_key: "example",
-  server_host_key: "example",
   subdomain: "example"
 )
 ```
@@ -511,17 +490,10 @@ remote_server.configuration_file(
 ### Parameters
 
 * `id` (int64): Required - Remote Server ID.
-* `api_token` (string): Files Agent API Token
-* `permission_set` (string): 
-* `root` (string): Agent local root path
-* `hostname` (string): 
-* `port` (int64): Incoming port for files agent connections
-* `status` (string): either running or shutdown
-* `config_version` (string): agent config version
-* `private_key` (string): private key
-* `public_key` (string): public key
-* `server_host_key` (string): 
-* `subdomain` (string): 
+* `permission_set` (string): The permission set for the agent ['read_write', 'read_only', 'write_only']
+* `root` (string): The root directory for the agent
+* `private_key` (string): The private key for the agent
+* `subdomain` (string): Files.com subdomain site name
 
 
 ---

data/docs/remote_server_configuration_file.md

@@ -5,29 +5,49 @@
 ```
 {
   "id": 1,
-  "permission_set": "full",
+  "permission_set": "example",
   "private_key": "example",
   "subdomain": "example",
-  "root": "example",
-  "api_token": "example",
-  "port": 1,
-  "hostname": "example",
-  "public_key": "example",
-  "status": "example",
-  "server_host_key": "example",
-  "config_version": "example"
+  "root": "C:\\Users\\",
+  "follow_links": true,
+  "prefer_protocol": "example",
+  "dns": "example",
+  "proxy_all_outbound": true,
+  "endpoint_override": "example",
+  "log_file": "example",
+  "log_level": "example",
+  "log_rotate_num": 1,
+  "log_rotate_size": 1,
+  "max_concurrent_jobs": 1,
+  "graceful_shutdown_timeout": 1,
+  "transfer_rate_limit": "example"
 }
 ```
 
-* `id` (int64): Agent ID
-* `permission_set` (string): 
-* `private_key` (string): private key
-* `subdomain` (string): 
-* `root` (string): Agent local root path
-* `api_token` (string): Files Agent API Token
-* `port` (int64): Incoming port for files agent connections
-* `hostname` (string): 
-* `public_key` (string): public key
-* `status` (string): either running or shutdown
-* `server_host_key` (string): 
-* `config_version` (string): agent config version
+* `id` (int64): The remote server ID of the agent
+* `permission_set` (string): The permission set for the agent ['read_write', 'read_only', 'write_only']
+* `private_key` (string): The private key for the agent
+* `subdomain` (string): Files.com subdomain site name
+* `root` (string): The root directory for the agent
+* `follow_links` (boolean): Follow symlinks when traversing directories
+* `prefer_protocol` (string): Preferred network protocol ['udp', 'tcp']
+* `dns` (string): DNS lookup method ['auto','doh','system']
+* `proxy_all_outbound` (boolean): Proxy all outbound traffic through files.com proxy server
+* `endpoint_override` (string): Custom site endpoint URL
+* `log_file` (string): Log file name and location
+* `log_level` (string): Log level for the agent logs ['debug', 'info', 'warn', 'error', 'fatal']
+* `log_rotate_num` (int64): Log route for agent logs. (default 5)
+* `log_rotate_size` (int64): Log route size in MB for agent logs. (default 20MB)
+* `max_concurrent_jobs` (int64): Maximum number of concurrent jobs (default CPU Count * 4)
+* `graceful_shutdown_timeout` (int64): Graceful shutdown timeout in seconds
+* `transfer_rate_limit` (string): File transfer (upload/download) rate limit
+ <limit>-<period>, with the given periods:
+* 'S': second
+* 'M': minute
+* 'H': hour
+* 'D': day
+Examples:
+* 5 requests/second: '5-S'
+* 10 requests/minute: '10-M'
+* 1000 requests/hour: '1000-H'
+* 2000 requests/day: '2000-D'

data/docs/site.md

@@ -248,6 +248,7 @@
     "externally_managed": true,
     "time_zone": "Pacific Time (US & Canada)",
     "type_of_2fa": "yubi",
+    "type_of_2fa_for_display": "yubi",
     "updated_at": "2000-01-01T01:00:00Z",
     "user_root": "example",
     "days_remaining_until_password_expire": 1,

data/docs/user.md

@@ -63,6 +63,7 @@
   "externally_managed": true,
   "time_zone": "Pacific Time (US & Canada)",
   "type_of_2fa": "yubi",
+  "type_of_2fa_for_display": "yubi",
   "user_root": "example",
   "days_remaining_until_password_expire": 1,
   "password_expire_at": "2000-01-01T01:00:00Z"
@@ -125,7 +126,8 @@
 * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
 * `externally_managed` (boolean): Is this user managed by a SsoStrategy?
 * `time_zone` (string): User time zone
-* `type_of_2fa` (string): Type(s) of 2FA methods in use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore.
+* `type_of_2fa` (string): Type(s) of 2FA methods in use, for programmatic use.  Will be either `sms`, `totp`, `u2f`, `yubi`, 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.
 * `days_remaining_until_password_expire` (int64): Number of days remaining until password expires
 * `password_expire_at` (date-time): Password expiration datetime

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

@@ -678,32 +678,18 @@ module Files
     # Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
     #
     # Parameters:
-    #   api_token - string - Files Agent API Token
-    #   permission_set - string -
-    #   root - string - Agent local root path
-    #   hostname - string
-    #   port - int64 - Incoming port for files agent connections
-    #   status - string - either running or shutdown
-    #   config_version - string - agent config version
-    #   private_key - string - private key
-    #   public_key - string - public key
-    #   server_host_key - string
-    #   subdomain - string
+    #   permission_set - string - The permission set for the agent ['read_write', 'read_only', 'write_only']
+    #   root - string - The root directory for the agent
+    #   private_key - string - The private key for the agent
+    #   subdomain - string - Files.com subdomain site name
     def configuration_file(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
       raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
       raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
-      raise InvalidParameterError.new("Bad parameter: api_token must be an String") if params[:api_token] and !params[:api_token].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: root must be an String") if params[:root] and !params[:root].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
-      raise InvalidParameterError.new("Bad parameter: status must be an String") if params[:status] and !params[:status].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: config_version must be an String") if params[:config_version] and !params[:config_version].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 
@@ -1051,31 +1037,17 @@ module Files
     # Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
     #
     # Parameters:
-    #   api_token - string - Files Agent API Token
-    #   permission_set - string -
-    #   root - string - Agent local root path
-    #   hostname - string
-    #   port - int64 - Incoming port for files agent connections
-    #   status - string - either running or shutdown
-    #   config_version - string - agent config version
-    #   private_key - string - private key
-    #   public_key - string - public key
-    #   server_host_key - string
-    #   subdomain - string
+    #   permission_set - string - The permission set for the agent ['read_write', 'read_only', 'write_only']
+    #   root - string - The root directory for the agent
+    #   private_key - string - The private key for the agent
+    #   subdomain - string - Files.com subdomain site name
     def self.configuration_file(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
       raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
-      raise InvalidParameterError.new("Bad parameter: api_token must be an String") if params[:api_token] and !params[:api_token].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: root must be an String") if params[:root] and !params[:root].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
-      raise InvalidParameterError.new("Bad parameter: status must be an String") if params[:status] and !params[:status].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: config_version must be an String") if params[:config_version] and !params[:config_version].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params[:server_host_key] and !params[:server_host_key].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: subdomain must be an String") if params[:subdomain] and !params[:subdomain].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 

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

@@ -9,64 +9,99 @@ module Files
       @options = options || {}
     end
 
-    # int64 - Agent ID
+    # int64 - The remote server ID of the agent
     def id
       @attributes[:id]
     end
 
-    # string -
+    # string - The permission set for the agent ['read_write', 'read_only', 'write_only']
     def permission_set
       @attributes[:permission_set]
     end
 
-    # string - private key
+    # string - The private key for the agent
     def private_key
       @attributes[:private_key]
     end
 
-    # string
+    # string - Files.com subdomain site name
     def subdomain
       @attributes[:subdomain]
     end
 
-    # string - Agent local root path
+    # string - The root directory for the agent
     def root
       @attributes[:root]
     end
 
-    # string - Files Agent API Token
-    def api_token
-      @attributes[:api_token]
+    # boolean - Follow symlinks when traversing directories
+    def follow_links
+      @attributes[:follow_links]
     end
 
-    # int64 - Incoming port for files agent connections
-    def port
-      @attributes[:port]
+    # string - Preferred network protocol ['udp', 'tcp']
+    def prefer_protocol
+      @attributes[:prefer_protocol]
     end
 
-    # string
-    def hostname
-      @attributes[:hostname]
+    # string - DNS lookup method ['auto','doh','system']
+    def dns
+      @attributes[:dns]
     end
 
-    # string - public key
-    def public_key
-      @attributes[:public_key]
+    # boolean - Proxy all outbound traffic through files.com proxy server
+    def proxy_all_outbound
+      @attributes[:proxy_all_outbound]
     end
 
-    # string - either running or shutdown
-    def status
-      @attributes[:status]
+    # string - Custom site endpoint URL
+    def endpoint_override
+      @attributes[:endpoint_override]
     end
 
-    # string
-    def server_host_key
-      @attributes[:server_host_key]
+    # string - Log file name and location
+    def log_file
+      @attributes[:log_file]
     end
 
-    # string - agent config version
-    def config_version
-      @attributes[:config_version]
+    # string - Log level for the agent logs ['debug', 'info', 'warn', 'error', 'fatal']
+    def log_level
+      @attributes[:log_level]
+    end
+
+    # int64 - Log route for agent logs. (default 5)
+    def log_rotate_num
+      @attributes[:log_rotate_num]
+    end
+
+    # int64 - Log route size in MB for agent logs. (default 20MB)
+    def log_rotate_size
+      @attributes[:log_rotate_size]
+    end
+
+    # int64 - Maximum number of concurrent jobs (default CPU Count * 4)
+    def max_concurrent_jobs
+      @attributes[:max_concurrent_jobs]
+    end
+
+    # int64 - Graceful shutdown timeout in seconds
+    def graceful_shutdown_timeout
+      @attributes[:graceful_shutdown_timeout]
+    end
+
+    # string - File transfer (upload/download) rate limit
+    #  <limit>-<period>, with the given periods:
+    # * 'S': second
+    # * 'M': minute
+    # * 'H': hour
+    # * 'D': day
+    # Examples:
+    # * 5 requests/second: '5-S'
+    # * 10 requests/minute: '10-M'
+    # * 1000 requests/hour: '1000-H'
+    # * 2000 requests/day: '2000-D'
+    def transfer_rate_limit
+      @attributes[:transfer_rate_limit]
     end
   end
 end

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

@@ -509,7 +509,7 @@ module Files
       @attributes[:time_zone] = value
     end
 
-    # string - Type(s) of 2FA methods in use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore.
+    # string - Type(s) of 2FA methods in use, for programmatic use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore.  Does not specify whether user has more than one of a given method.
     def type_of_2fa
       @attributes[:type_of_2fa]
     end
@@ -518,6 +518,15 @@ module Files
       @attributes[:type_of_2fa] = value
     end
 
+    # 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.
+    def type_of_2fa_for_display
+      @attributes[:type_of_2fa_for_display]
+    end
+
+    def type_of_2fa_for_display=(value)
+      @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.
     def user_root
       @attributes[:user_root]

data/lib/files.com/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.37
+  version: 1.1.38
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-13 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable