slack-ruby-client 0.2.1 → 0.3.0

data/lib/slack/web/api/endpoints/emoji.rb

@@ -6,11 +6,10 @@ module Slack
       module Endpoints
         module Emoji
           #
-          # Lists custom emoji for a team.
+          # This method lists the custom emoji for a team.
           #
           # @see https://api.slack.com/methods/emoji.list
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/emoji.list.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/emoji.list.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/emoji.list.json
           def emoji_list(options = {})
             post('emoji.list', options)
           end

data/lib/slack/web/api/endpoints/files.rb

@@ -6,22 +6,33 @@ module Slack
       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).
@@ -30,27 +41,28 @@ module Slack
           # @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
@@ -61,11 +73,10 @@ module Slack
           #   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

data/lib/slack/web/api/endpoints/groups.rb

@@ -6,86 +6,94 @@ module Slack
       module Endpoints
         module Groups
           #
-          # Archives a private group.
+          # This method archives a private group.
           #
-          # @option options [group] :channel
-          #   Private group to archive
+          # @option options [Object] :channel
+          #   Private group to archive.
           # @see https://api.slack.com/methods/groups.archive
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.archive.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.archive.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.archive.json
           def groups_archive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('groups.archive', options)
           end
 
           #
-          # Closes a private group.
+          # This method closes a private group.
           #
-          # @option options [group] :channel
+          # @option options [Object] :channel
           #   Group to open.
           # @see https://api.slack.com/methods/groups.close
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.close.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.close.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.close.json
           def groups_close(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('groups.close', options)
           end
 
           #
-          # Creates a private group.
+          # This method creates a private group.
           #
           # @option options [Object] :name
-          #   Name of group to create
+          #   Name of group to create.
           # @see https://api.slack.com/methods/groups.create
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.create.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.create.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.create.json
           def groups_create(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
             post('groups.create', options)
           end
 
           #
-          # Clones and archives a private group.
+          # This method takes an existing private group and performs the following steps:
           #
-          # @option options [group] :channel
+          # @option options [Object] :channel
           #   Group to clone and archive.
           # @see https://api.slack.com/methods/groups.createChild
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.createChild.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.createChild.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.createChild.json
           def groups_createChild(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('groups.createChild', options)
           end
 
           #
-          # Fetches history of messages and events from a private group.
+          # This method returns a portion of messages/events from the specified private group.
+          # To read the entire history for a group, call the method with no latest or
+          # oldest arguments, and then continue paging using the instructions below.
           #
-          # @option options [group] :channel
+          # @option options [Object] :channel
           #   Group to fetch history for.
-          # @option options [timestamp] :latest
-          #   Latest message timestamp to include in results.
-          # @option options [timestamp] :oldest
-          #   Oldest message timestamp to include in results.
-          # @option options [Object] :count
-          #   Number of messages to return, between 1 and 1000.
+          # @option options [Object] :latest
+          #   End of time range of messages to include in results.
+          # @option options [Object] :oldest
+          #   Start of time range of messages to include in results.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @see https://api.slack.com/methods/groups.history
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.history.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.history.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.history.json
           def groups_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('groups.history', options)
           end
 
           #
-          # Invites a user to a private group.
+          # This method returns information about a private group.
           #
-          # @option options [group] :channel
+          # @option options [Object] :channel
+          #   Group to get info on.
+          # @see https://api.slack.com/methods/groups.info
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.info.json
+          def groups_info(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            post('groups.info', options)
+          end
+
+          #
+          # This method is used to invite a user to a private group. The calling user must be a member of the group.
+          #
+          # @option options [Object] :channel
           #   Private group to invite user to.
-          # @option options [user] :user
+          # @option options [Object] :user
           #   User to invite.
           # @see https://api.slack.com/methods/groups.invite
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.invite.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.invite.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.invite.json
           def groups_invite(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
@@ -93,15 +101,14 @@ module Slack
           end
 
           #
-          # Removes a user from a private group.
+          # This method allows a user to remove another member from a private group.
           #
-          # @option options [group] :channel
+          # @option options [Object] :channel
           #   Group to remove user from.
-          # @option options [user] :user
+          # @option options [Object] :user
           #   User to remove from group.
           # @see https://api.slack.com/methods/groups.kick
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.kick.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.kick.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.kick.json
           def groups_kick(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
@@ -109,40 +116,38 @@ module Slack
           end
 
           #
-          # Leaves a private group.
+          # This method is used to leave a private group.
           #
-          # @option options [group] :channel
-          #   Group to leave
+          # @option options [Object] :channel
+          #   Group to leave.
           # @see https://api.slack.com/methods/groups.leave
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.leave.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.leave.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.leave.json
           def groups_leave(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('groups.leave', options)
           end
 
           #
-          # Lists private groups that the calling user has access to.
+          # This method returns a list of groups in the team that the caller is in and archived groups that the caller was in.
+          # The list of (non-deactivated) members in each group is also returned.
           #
           # @option options [Object] :exclude_archived
           #   Don't return archived groups.
           # @see https://api.slack.com/methods/groups.list
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.list.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.list.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.list.json
           def groups_list(options = {})
             post('groups.list', options)
           end
 
           #
-          # Sets the read cursor in a private group.
+          # This method moves the read cursor in a private group.
           #
-          # @option options [group] :channel
+          # @option options [Object] :channel
           #   Group to set reading cursor in.
-          # @option options [timestamp] :ts
+          # @option options [Object] :ts
           #   Timestamp of the most recently seen message.
           # @see https://api.slack.com/methods/groups.mark
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.mark.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.mark.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.mark.json
           def groups_mark(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
@@ -150,28 +155,26 @@ module Slack
           end
 
           #
-          # Opens a private group.
+          # This method opens a private group.
           #
-          # @option options [group] :channel
+          # @option options [Object] :channel
           #   Group to open.
           # @see https://api.slack.com/methods/groups.open
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.open.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.open.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.open.json
           def groups_open(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('groups.open', options)
           end
 
           #
-          # Renames a private group.
+          # This method renames a private group.
           #
-          # @option options [channel] :channel
-          #   Group to rename
+          # @option options [Object] :channel
+          #   Group to rename.
           # @option options [Object] :name
           #   New name for group.
           # @see https://api.slack.com/methods/groups.rename
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.rename.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.rename.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.rename.json
           def groups_rename(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
@@ -179,15 +182,14 @@ module Slack
           end
 
           #
-          # Sets the purpose for a private group.
+          # This method is used to change the purpose of a private group. The calling user must be a member of the private group.
           #
-          # @option options [channel] :channel
-          #   Private group to set the purpose of
+          # @option options [Object] :channel
+          #   Private group to set the purpose of.
           # @option options [Object] :purpose
-          #   The new purpose
+          #   The new purpose.
           # @see https://api.slack.com/methods/groups.setPurpose
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setPurpose.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setPurpose.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.setPurpose.json
           def groups_setPurpose(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
@@ -195,15 +197,14 @@ module Slack
           end
 
           #
-          # Sets the topic for a private group.
+          # This method is used to change the topic of a private group. The calling user must be a member of the private group.
           #
-          # @option options [channel] :channel
-          #   Private group to set the topic of
+          # @option options [Object] :channel
+          #   Private group to set the topic of.
           # @option options [Object] :topic
-          #   The new topic
+          #   The new topic.
           # @see https://api.slack.com/methods/groups.setTopic
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setTopic.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setTopic.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.setTopic.json
           def groups_setTopic(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
@@ -211,13 +212,12 @@ module Slack
           end
 
           #
-          # Unarchives a private group.
+          # This method unarchives a private group.
           #
-          # @option options [group] :channel
-          #   Group to unarchive
+          # @option options [Object] :channel
+          #   Group to unarchive.
           # @see https://api.slack.com/methods/groups.unarchive
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.unarchive.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.unarchive.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.unarchive.json
           def groups_unarchive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('groups.unarchive', options)

data/lib/slack/web/api/endpoints/im.rb

@@ -6,57 +6,55 @@ module Slack
       module Endpoints
         module Im
           #
-          # Close a direct message channel.
+          # This method closes a direct message channel.
           #
-          # @option options [im] :channel
+          # @option options [Object] :channel
           #   Direct message channel to close.
           # @see https://api.slack.com/methods/im.close
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.close.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.close.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.close.json
           def im_close(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('im.close', options)
           end
 
           #
-          # Fetches history of messages and events from direct message channel.
+          # This method returns a portion of messages/events from the specified direct message channel.
+          # To read the entire history for a direct message channel, call the method with no latest or
+          # oldest arguments, and then continue paging using the instructions below.
           #
-          # @option options [im] :channel
+          # @option options [Object] :channel
           #   Direct message channel to fetch history for.
-          # @option options [timestamp] :latest
-          #   Latest message timestamp to include in results.
-          # @option options [timestamp] :oldest
-          #   Oldest message timestamp to include in results.
-          # @option options [Object] :count
-          #   Number of messages to return, between 1 and 1000.
+          # @option options [Object] :latest
+          #   End of time range of messages to include in results.
+          # @option options [Object] :oldest
+          #   Start of time range of messages to include in results.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @see https://api.slack.com/methods/im.history
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.history.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.history.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.history.json
           def im_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             post('im.history', options)
           end
 
           #
-          # Lists direct message channels for the calling user.
+          # This method returns a list of all im channels that the user has.
           #
           # @see https://api.slack.com/methods/im.list
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.list.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.list.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.list.json
           def im_list(options = {})
             post('im.list', options)
           end
 
           #
-          # Sets the read cursor in a direct message channel.
+          # This method moves the read cursor in a direct message channel.
           #
-          # @option options [im] :channel
+          # @option options [Object] :channel
           #   Direct message channel to set reading cursor in.
-          # @option options [timestamp] :ts
+          # @option options [Object] :ts
           #   Timestamp of the most recently seen message.
           # @see https://api.slack.com/methods/im.mark
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.mark.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.mark.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.mark.json
           def im_mark(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
@@ -64,13 +62,12 @@ module Slack
           end
 
           #
-          # Opens a direct message channel.
+          # This method opens a direct message channel with another member of your Slack team.
           #
-          # @option options [user] :user
+          # @option options [Object] :user
           #   User to open a direct message channel with.
           # @see https://api.slack.com/methods/im.open
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.open.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.open.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.open.json
           def im_open(options = {})
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             post('im.open', options)