files.com 1.0.92

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Files
+  class FileAction
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # Copy file/folder
+    #
+    # Parameters:
+    #   destination (required) - string - Copy destination path.
+    #   structure - boolean - Copy structure only?
+    def copy(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+      raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
+
+      Api.send_request("/file_actions/copy/#{@attributes[:path]}", :post, params, @options)
+    end
+
+    # Move file/folder
+    #
+    # Parameters:
+    #   destination (required) - string - Move destination path.
+    def move(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+      raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
+
+      Api.send_request("/file_actions/move/#{@attributes[:path]}", :post, params, @options)
+    end
+
+    # Begin file upload
+    #
+    # Parameters:
+    #   mkdir_parents - boolean - Create parent directories if they do not exist?
+    #   part - int64 - Part if uploading a part.
+    #   parts - int64 - How many parts to fetch?
+    #   ref - string -
+    #   restart - int64 - File byte offset to restart from.
+    #   with_rename - boolean - Allow file rename instead of overwrite?
+    def begin_upload(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: part must be an Integer") if params.dig(:part) and !params.dig(:part).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: parts must be an Integer") if params.dig(:parts) and !params.dig(:parts).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: ref must be an String") if params.dig(:ref) and !params.dig(:ref).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params.dig(:restart) and !params.dig(:restart).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      Api.send_request("/file_actions/begin_upload/#{@attributes[:path]}", :post, params, @options)
+    end
+
+    # Copy file/folder
+    #
+    # Parameters:
+    #   destination (required) - string - Copy destination path.
+    #   structure - boolean - Copy structure only?
+    def self.copy(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+      raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
+
+      response, _options = Api.send_request("/file_actions/copy/#{params[:path]}", :post, params, options)
+      response.data
+    end
+
+    # Move file/folder
+    #
+    # Parameters:
+    #   destination (required) - string - Move destination path.
+    def self.move(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+      raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
+
+      response, _options = Api.send_request("/file_actions/move/#{params[:path]}", :post, params, options)
+      response.data
+    end
+
+    # Begin file upload
+    #
+    # Parameters:
+    #   mkdir_parents - boolean - Create parent directories if they do not exist?
+    #   part - int64 - Part if uploading a part.
+    #   parts - int64 - How many parts to fetch?
+    #   ref - string -
+    #   restart - int64 - File byte offset to restart from.
+    #   with_rename - boolean - Allow file rename instead of overwrite?
+    def self.begin_upload(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: part must be an Integer") if params.dig(:part) and !params.dig(:part).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: parts must be an Integer") if params.dig(:parts) and !params.dig(:parts).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: ref must be an String") if params.dig(:ref) and !params.dig(:ref).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params.dig(:restart) and !params.dig(:restart).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      response, options = Api.send_request("/file_actions/begin_upload/#{params[:path]}", :post, params, options)
+      response.data.map do |entity_data|
+        FilePartUpload.new(entity_data, options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module Files
+  class FileComment
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - File Comment ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Comment body.
+    def body
+      @attributes[:body]
+    end
+
+    def body=(value)
+      @attributes[:body] = value
+    end
+
+    # array - Reactions to this comment.
+    def reactions
+      @attributes[:reactions]
+    end
+
+    def reactions=(value)
+      @attributes[:reactions] = value
+    end
+
+    # string - File path.
+    def path
+      @attributes[:path]
+    end
+
+    def path=(value)
+      @attributes[:path] = value
+    end
+
+    # Parameters:
+    #   body (required) - string - Comment body.
+    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: body must be an String") if params.dig(:body) and !params.dig(:body).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+      raise MissingParameterError.new("Parameter missing: body") unless params.dig(:body)
+
+      Api.send_request("/file_comments/#{@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("/file_comments/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = FileComment.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.
+    #   path (required) - string - Path to operate on.
+    def self.list_for(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      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: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      response, options = Api.send_request("/file_comments/files/#{params[:path]}", :get, params, options)
+      response.data.map do |entity_data|
+        FileComment.new(entity_data, options)
+      end
+    end
+
+    # Parameters:
+    #   body (required) - string - Comment body.
+    #   path (required) - string - File path.
+    def self.create(params = {}, options = {})
+      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: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: body") unless params.dig(:body)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      response, options = Api.send_request("/file_comments", :post, params, options)
+      FileComment.new(response.data, options)
+    end
+
+    # Parameters:
+    #   body (required) - string - Comment body.
+    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: body must be an String") if params.dig(:body) and !params.dig(:body).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+      raise MissingParameterError.new("Parameter missing: body") unless params.dig(:body)
+
+      response, options = Api.send_request("/file_comments/#{params[:id]}", :patch, params, options)
+      FileComment.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("/file_comments/#{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_comment_reaction.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Files
+  class FileCommentReaction
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Reaction ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Emoji used in the reaction.
+    def emoji
+      @attributes[:emoji]
+    end
+
+    def emoji=(value)
+      @attributes[:emoji] = value
+    end
+
+    # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # int64 - ID of file comment to attach reaction to.
+    def file_comment_id
+      @attributes[:file_comment_id]
+    end
+
+    def file_comment_id=(value)
+      @attributes[:file_comment_id] = value
+    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("/file_comment_reactions/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The FileCommentReaction object doesn't support updates.")
+      else
+        new_obj = FileCommentReaction.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   file_comment_id (required) - int64 - ID of file comment to attach reaction to.
+    #   emoji (required) - string - Emoji to react with.
+    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: file_comment_id must be an Integer") if params.dig(:file_comment_id) and !params.dig(:file_comment_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: emoji must be an String") if params.dig(:emoji) and !params.dig(:emoji).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: file_comment_id") unless params.dig(:file_comment_id)
+      raise MissingParameterError.new("Parameter missing: emoji") unless params.dig(:emoji)
+
+      response, options = Api.send_request("/file_comment_reactions", :post, params, options)
+      FileCommentReaction.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("/file_comment_reactions/#{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_part_upload.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Files
+  class FilePartUpload
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # object - Content-Type and File to send
+    def send
+      @attributes[:send]
+    end
+
+    # string - Type of upload
+    def action
+      @attributes[:action]
+    end
+
+    # boolean - If false, rename conflicting files instead of asking for overwrite confirmation
+    def ask_about_overwrites
+      @attributes[:ask_about_overwrites]
+    end
+
+    # string - Currently unused
+    def available_parts
+      @attributes[:available_parts]
+    end
+
+    # string - Currently unused
+    def expires
+      @attributes[:expires]
+    end
+
+    # object - Additional upload headers
+    def headers
+      @attributes[:headers]
+    end
+
+    # string - Upload method, usually POST
+    def http_method
+      @attributes[:http_method]
+    end
+
+    # string - Currently unused
+    def next_partsize
+      @attributes[:next_partsize]
+    end
+
+    # string - Additional upload parameters
+    def parameters
+      @attributes[:parameters]
+    end
+
+    # string - Currently unused
+    def part_number
+      @attributes[:part_number]
+    end
+
+    # string - Currently unused
+    def partsize
+      @attributes[:partsize]
+    end
+
+    # string - Upload 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
+
+    # string - Reference name for this upload part
+    def ref
+      @attributes[:ref]
+    end
+
+    # string - URI to upload this part to
+    def upload_uri
+      @attributes[:upload_uri]
+    end
+  end
+end