files.com 1.0.70 → 1.0.75

data/docs/site.md

@@ -83,6 +83,7 @@
   "session": "",
   "session_pinned_by_ip": true,
   "sftp_user_root_enabled": true,
+  "sharing_enabled": true,
   "show_request_access_link": true,
   "site_footer": "",
   "site_header": "",
@@ -193,6 +194,7 @@
 * `session`: Current session
 * `session_pinned_by_ip` (boolean): Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
 * `sftp_user_root_enabled` (boolean): Use user FTP roots also for SFTP?
+* `sharing_enabled` (boolean): Allow bundle creation
 * `show_request_access_link` (boolean): Show request access link for users without access?  Currently unused.
 * `site_footer` (string): Custom site footer text
 * `site_header` (string): Custom site header text
@@ -295,6 +297,7 @@ Files::Site.update(
   disable_users_from_inactivity_period_days: 1, 
   non_sso_groups_allowed: true, 
   non_sso_users_allowed: true, 
+  sharing_enabled: true, 
   allowed_2fa_method_sms: true, 
   allowed_2fa_method_u2f: true, 
   allowed_2fa_method_totp: true, 
@@ -385,6 +388,7 @@ Files::Site.update(
 * `disable_users_from_inactivity_period_days` (int64): If greater than zero, users will unable to login if they do not show activity within this number of days.
 * `non_sso_groups_allowed` (boolean): If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
 * `non_sso_users_allowed` (boolean): If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
+* `sharing_enabled` (boolean): Allow bundle creation
 * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
 * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
 * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?

data/docs/user.md

@@ -26,6 +26,7 @@
   "group_ids": [
 
   ],
+  "header_text": "User-specific message.",
   "language": "en",
   "last_login_at": "2000-01-01T01:00:00Z",
   "last_protocol_cipher": "",
@@ -72,6 +73,7 @@
 * `email` (email): User email address
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
 * `group_ids` (array): Comma-separated list of group IDs of which this user is a member
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `last_login_at` (date-time): User's last login time
 * `last_protocol_cipher` (string): The last protocol and cipher used
@@ -169,6 +171,7 @@ Files::User.create(
   dav_permission: true, 
   disabled: true, 
   ftp_permission: true, 
+  header_text: "User-specific message.", 
   language: "en", 
   notification_daily_send_time: 18, 
   name: "John Doe", 
@@ -212,6 +215,7 @@ Files::User.create(
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
 * `name` (string): User's full name
@@ -291,6 +295,7 @@ Files::User.update(id,
   dav_permission: true, 
   disabled: true, 
   ftp_permission: true, 
+  header_text: "User-specific message.", 
   language: "en", 
   notification_daily_send_time: 18, 
   name: "John Doe", 
@@ -335,6 +340,7 @@ Files::User.update(id,
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
 * `name` (string): User's full name
@@ -435,6 +441,7 @@ user.update(
   dav_permission: true,
   disabled: true,
   ftp_permission: true,
+  header_text: "User-specific message.",
   language: "en",
   notification_daily_send_time: 18,
   name: "John Doe",
@@ -479,6 +486,7 @@ user.update(
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
 * `name` (string): User's full name

data/files.com.gemspec

@@ -10,11 +10,11 @@ Gem::Specification.new do |s|
   s.summary     = "Files.com Ruby client."
   s.description = "The Files.com Ruby client."
   s.license     = "MIT"
-  s.required_ruby_version = ">= 2.3"
-  s.add_dependency 'faraday', ">= 1.0.1"
-  s.add_dependency 'net-http-persistent'
+  s.required_ruby_version = ">= 2.5"
   s.add_dependency 'addressable', ">= 2.7.0"
   s.add_dependency 'concurrent-ruby', ">= 1.1.3"
+  s.add_dependency 'faraday', ">= 1.0.1"
+  s.add_dependency 'net-http-persistent'
 
   s.files         = `find *`.split("\n").uniq.sort.reject(&:empty?)
   s.executables   = [ "files", "files-console" ]

data/lib/files.com.rb

@@ -34,6 +34,7 @@ require "files.com/models/auto"
 require "files.com/models/automation"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
+require "files.com/models/clickwrap"
 require "files.com/models/dns_record"
 require "files.com/models/errors"
 require "files.com/models/file"
@@ -94,7 +95,7 @@ module Files
   @read_timeout = 80
 
   class << self
-    attr_accessor :api_key, :base_url, :initial_network_retry_delay, :max_network_retries, :max_network_retry_delay, :open_timeout, :read_timeout, :proxy, :session_id
+    attr_accessor :api_key, :base_url, :initial_network_retry_delay, :max_network_retry_delay, :open_timeout, :read_timeout, :proxy, :session_id
   end
 
   # map to the same values as the standard library's logger

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

@@ -201,9 +201,9 @@ module Files
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
-      raise InvalidParameterError.new("Bad parameter: id must be one of String, Integer, Hash") if params.dig(:id) and [String, Integer, Hash].none? { |klass| params.dig(:id).is_a?(klass) }
+      raise InvalidParameterError.new("Bad parameter: id must be one of String, Integer, Hash") if params.dig(:id) and [ String, Integer, Hash ].none? { |klass| params.dig(:id).is_a?(klass) }
       raise InvalidParameterError.new("Bad parameter: value must be an String") if params.dig(:value) and !params.dig(:value).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: attachment_file must be one of String, Integer, Hash") if params.dig(:attachment_file) and [String, Integer, Hash].none? { |klass| params.dig(:attachment_file).is_a?(klass) }
+      raise InvalidParameterError.new("Bad parameter: attachment_file must be one of String, Integer, Hash") if params.dig(:attachment_file) and [ String, Integer, Hash ].none? { |klass| params.dig(:attachment_file).is_a?(klass) }
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       response, options = Api.send_request("/behaviors/#{params[:id]}", :patch, params, options)

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

@@ -54,6 +54,15 @@ module Files
       @attributes[:require_registration] = value
     end
 
+    # string - Legal text that must be agreed to prior to accessing Bundle.
+    def clickwrap_body
+      @attributes[:clickwrap_body]
+    end
+
+    def clickwrap_body=(value)
+      @attributes[:clickwrap_body] = value
+    end
+
     # int64 - Bundle ID
     def id
       @attributes[:id]
@@ -104,6 +113,15 @@ module Files
       @attributes[:username] = value
     end
 
+    # int64 - ID of the clickwrap to use with this bundle.
+    def clickwrap_id
+      @attributes[:clickwrap_id]
+    end
+
+    def clickwrap_id=(value)
+      @attributes[:clickwrap_id] = value
+    end
+
     # array - A list of paths in this bundle
     def paths
       @attributes[:paths]
@@ -147,6 +165,7 @@ module Files
     #   note - string - Bundle internal note
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
+    #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -157,6 +176,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       Api.send_request("/bundles/#{@attributes[:id]}", :patch, params, @options)
@@ -231,6 +251,7 @@ module Files
     #   note - string - Bundle internal note
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
+    #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
@@ -239,6 +260,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: paths") unless params.dig(:paths)
 
       response, options = Api.send_request("/bundles", :post, params, options)
@@ -270,6 +292,7 @@ module Files
     #   note - string - Bundle internal note
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
+    #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -279,6 +302,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       response, options = Api.send_request("/bundles/#{params[:id]}", :patch, params, options)

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

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module Files
+  class Clickwrap
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - Body text of Clickwrap (supports Markdown formatting).
+    def body
+      @attributes[:body]
+    end
+
+    def body=(value)
+      @attributes[:body] = value
+    end
+
+    # string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+    def use_with_users
+      @attributes[:use_with_users]
+    end
+
+    def use_with_users=(value)
+      @attributes[:use_with_users] = value
+    end
+
+    # string - Use this Clickwrap for Bundles?
+    def use_with_bundles
+      @attributes[:use_with_bundles]
+    end
+
+    def use_with_bundles=(value)
+      @attributes[:use_with_bundles] = value
+    end
+
+    # string - Use this Clickwrap for Inboxes?
+    def use_with_inboxes
+      @attributes[:use_with_inboxes]
+    end
+
+    def use_with_inboxes=(value)
+      @attributes[:use_with_inboxes] = value
+    end
+
+    # int64 - Clickwrap ID.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # Parameters:
+    #   name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+    #   body - string - Body text of Clickwrap (supports Markdown formatting).
+    #   use_with_bundles - string - Use this Clickwrap for Bundles?
+    #   use_with_inboxes - string - Use this Clickwrap for Inboxes?
+    #   use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+    def update(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.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: body must be an String") if params.dig(:body) and !params.dig(:body).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_bundles must be an String") if params.dig(:use_with_bundles) and !params.dig(:use_with_bundles).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_inboxes must be an String") if params.dig(:use_with_inboxes) and !params.dig(:use_with_inboxes).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_users must be an String") if params.dig(:use_with_users) and !params.dig(:use_with_users).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/clickwraps/#{@attributes[:id]}", :patch, params, @options)
+    end
+
+    def delete(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.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/clickwraps/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = Clickwrap.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+
+      response, options = Api.send_request("/clickwraps", :get, params, options)
+      response.data.map do |entity_data|
+        Clickwrap.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Clickwrap ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/clickwraps/#{params[:id]}", :get, params, options)
+      Clickwrap.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+    #   body - string - Body text of Clickwrap (supports Markdown formatting).
+    #   use_with_bundles - string - Use this Clickwrap for Bundles?
+    #   use_with_inboxes - string - Use this Clickwrap for Inboxes?
+    #   use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: body must be an String") if params.dig(:body) and !params.dig(:body).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_bundles must be an String") if params.dig(:use_with_bundles) and !params.dig(:use_with_bundles).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_inboxes must be an String") if params.dig(:use_with_inboxes) and !params.dig(:use_with_inboxes).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_users must be an String") if params.dig(:use_with_users) and !params.dig(:use_with_users).is_a?(String)
+
+      response, options = Api.send_request("/clickwraps", :post, params, options)
+      Clickwrap.new(response.data, options)
+    end
+
+    # Parameters:
+    #   name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+    #   body - string - Body text of Clickwrap (supports Markdown formatting).
+    #   use_with_bundles - string - Use this Clickwrap for Bundles?
+    #   use_with_inboxes - string - Use this Clickwrap for Inboxes?
+    #   use_with_users - string - Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: body must be an String") if params.dig(:body) and !params.dig(:body).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_bundles must be an String") if params.dig(:use_with_bundles) and !params.dig(:use_with_bundles).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_inboxes must be an String") if params.dig(:use_with_inboxes) and !params.dig(:use_with_inboxes).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: use_with_users must be an String") if params.dig(:use_with_users) and !params.dig(:use_with_users).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/clickwraps/#{params[:id]}", :patch, params, options)
+      Clickwrap.new(response.data, options)
+    end
+
+    def self.delete(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, _options = Api.send_request("/clickwraps/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end

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

@@ -90,7 +90,7 @@ module Files
       new(path).mtime
     end
 
-    def self.open(path, mode = "r", options={}, &block)
+    def self.open(path, mode = "r", options = {}, &block)
       file = new(path, mode, options)
       if block
         yield file
@@ -306,7 +306,7 @@ module Files
     end
 
     def download_content(io)
-      Files::ApiClient::download_client.stream_download(download_uri_with_load, io)
+      Files::ApiClient.download_client.stream_download(download_uri_with_load, io)
     end
 
     def each(*args, &block)
@@ -571,13 +571,13 @@ module Files
     end
 
     def upload_file(local_file)
-      File.upload_file(local_file. path)
+      File.upload_file(local_file.path)
     end
 
     def write(*args)
       @mode ||= 'w'
       if args[0].respond_to?(:read)
-        flush if @write_io.size > 0
+        flush if @write_io.size > 0 # rubocop:disable Style/ZeroLengthPredicate
         @write_io = args[0]
       else
         @write_io.write *args

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

@@ -116,7 +116,9 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
       response, options = Api.send_request("/file_actions/begin_upload/#{Addressable::URI.encode_component(params[:path])}", :post, params, options)
-      FilePartUpload.new(response.data, options)
+      response.data.map do |entity_data|
+        FilePartUpload.new(entity_data, options)
+      end
     end
   end
 end