files.rb in slack-ruby-client-0.3.0

- old
+ new
@@ -4,69 +4,80 @@
   module Web
     module Api
       module Endpoints
         module Files
           #
-          # Gets information about a team file.
+          # This method deletes a file from your team.
           #
-          # @option options [file] :file
-          #   File to fetch info for
+          # @option options [Object] :file
+          #   ID of file to delete.
+          # @see https://api.slack.com/methods/files.delete
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.delete.json
+          def files_delete(options = {})
+            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
+            post('files.delete', options)
+          end
+
+          #
+          # This method returns information about a file in your team.
+          #
+          # @option options [Object] :file
+          #   File to fetch info for.
           # @see https://api.slack.com/methods/files.info
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.info.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.info.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.info.json
           def files_info(options = {})
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             post('files.info', options)
           end
 
           #
-          # Lists & filters team files.
+          # This method returns a list of files within the team. It can be filtered and sliced in various ways.
           #
-          # @option options [user] :user
+          # @option options [Object] :user
           #   Filter files created by a single user.
           # @option options [Object] :ts_from
           #   Filter files created after this timestamp (inclusive).
           # @option options [Object] :ts_to
           #   Filter files created before this timestamp (inclusive).
           # @option options [Object] :types
           #   Filter files by type:
           #
-          #   * `all` - All files
-          #   * `posts` - Posts
-          #   * `snippets` - Snippets
-          #   * `images` - Image files
-          #   * `gdocs` - Google docs
-          #   * `zips` - Zip files
-          #   * `pdfs` - PDF files
+          #   all - All files
+          #   posts - Posts
+          #   snippets - Snippets
+          #   images - Image files
+          #   gdocs - Google docs
+          #   zips - Zip files
+          #   pdfs - PDF files
           #
-          #   You can pass multiple values in the types argument, like `types=posts,snippets`.The default value is `all`, which does not filter the list.
+          #
+          #   You can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the list.
+          #   .
           # @see https://api.slack.com/methods/files.list
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.list.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.list.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.list.json
           def files_list(options = {})
             post('files.list', options)
           end
 
           #
-          # Uploads or creates a file.
+          # This method allows you to create or upload an existing file.
           #
           # @option options [Object] :file
-          #   File contents via `multipart/form-data`.
+          #   File contents via multipart/form-data.
           # @option options [Object] :content
           #   File contents via a POST var.
           # @option options [Object] :filetype
           #   Slack-internal file type identifier.
           # @option options [Object] :filename
           #   Filename of file.
           # @option options [Object] :title
           #   Title of file.
           # @option options [Object] :initial_comment
           #   Initial comment to add to file.
-          # @option options [channel] :channels
+          # @option options [Object] :channels
           #   Comma separated list of channels to share the file into.
           # @see https://api.slack.com/methods/files.upload
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.upload.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.upload.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.upload.json
           def files_upload(options = {})
             post('files.upload', options)
           end
         end
       end