files.com 1.0.72 → 1.0.77

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,8 @@ require "files.com/models/auto"
 require "files.com/models/automation"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
+require "files.com/models/bundle_download"
+require "files.com/models/clickwrap"
 require "files.com/models/dns_record"
 require "files.com/models/errors"
 require "files.com/models/file"
@@ -94,7 +96,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/list.rb

@@ -77,7 +77,7 @@ module Files
     end
 
     def set_cursor
-      params[:cursor] ||= @current_options[:client].cursor
+      params[:cursor] = @current_options[:client].cursor
     end
 
     def cursor

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]
@@ -77,6 +86,15 @@ module Files
       @attributes[:expires_at] = value
     end
 
+    # int64 - Maximum number of times bundle can be accessed
+    def max_uses
+      @attributes[:max_uses]
+    end
+
+    def max_uses=(value)
+      @attributes[:max_uses] = value
+    end
+
     # string - Bundle internal note
     def note
       @attributes[:note]
@@ -104,6 +122,24 @@ 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
+
+    # int64 - ID of the associated inbox, if available.
+    def inbox_id
+      @attributes[:inbox_id]
+    end
+
+    def inbox_id=(value)
+      @attributes[:inbox_id] = value
+    end
+
     # array - A list of paths in this bundle
     def paths
       @attributes[:paths]
@@ -143,10 +179,13 @@ module Files
     # Parameters:
     #   password - string - Password for this bundle.
     #   expires_at - string - Bundle expiration date/time
+    #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   description - string - Public description
     #   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.
+    #   inbox_id - int64 - ID of the associated inbox, if available.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -154,9 +193,12 @@ module Files
       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: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer)
       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 InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       Api.send_request("/bundles/#{@attributes[:id]}", :patch, params, @options)
@@ -227,18 +269,24 @@ module Files
     #   paths (required) - array(string) - A list of paths to include in this bundle.
     #   password - string - Password for this bundle.
     #   expires_at - string - Bundle expiration date/time
+    #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   description - string - Public description
     #   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.
+    #   inbox_id - int64 - ID of the associated inbox, if available.
     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)
       raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer)
       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 InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: paths") unless params.dig(:paths)
 
       response, options = Api.send_request("/bundles", :post, params, options)
@@ -266,19 +314,25 @@ module Files
     # Parameters:
     #   password - string - Password for this bundle.
     #   expires_at - string - Bundle expiration date/time
+    #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   description - string - Public description
     #   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.
+    #   inbox_id - int64 - ID of the associated inbox, if available.
     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: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer)
       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 InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_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/bundle_download.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Files
+  class BundleDownload
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Download method (file or full_zip)
+    def download_method
+      @attributes[:download_method]
+    end
+
+    # string - Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    def path
+      @attributes[:path]
+    end
+
+    # date-time - Download date/time
+    def created_at
+      @attributes[:created_at]
+    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.
+    #   bundle_registration_id (required) - int64 - BundleRegistration ID
+    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)
+      raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params.dig(:bundle_registration_id) and !params.dig(:bundle_registration_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: bundle_registration_id") unless params.dig(:bundle_registration_id)
+
+      response, options = Api.send_request("/bundle_downloads", :get, params, options)
+      response.data.map do |entity_data|
+        BundleDownload.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

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