slack-ruby-client 0.9.0 → 0.9.1

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Dnd
           #
-          # Ends the user's currently scheduled Do Not Disturb session immediately.
+          # Ends the current user's Do Not Disturb session immediately.
           #
           # @see https://api.slack.com/methods/dnd.endDnd
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/dnd/dnd.endDnd.json
@@ -24,7 +24,7 @@ module Slack
           end
 
           #
-          # Provides information about a user's current Do Not Disturb settings.
+          # Retrieves a user's current Do Not Disturb status.
           #
           # @option options [user] :user
           #   User to fetch status for (defaults to current user).
@@ -36,7 +36,7 @@ module Slack
           end
 
           #
-          # Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration.
+          # Turns on Do Not Disturb mode for the current user, or changes its duration.
           #
           # @option options [Object] :num_minutes
           #   Number of minutes, from now, to snooze until.
@@ -48,7 +48,7 @@ module Slack
           end
 
           #
-          # Provides information about the current Do Not Disturb settings for users of a Slack team.
+          # Retrieves the Do Not Disturb status for users on a team.
           #
           # @option options [Object] :users
           #   Comma-separated list of users to fetch Do Not Disturb status for.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Emoji
           #
-          # This method lists the custom emoji for a team.
+          # Lists custom emoji for a team.
           #
           # @see https://api.slack.com/methods/emoji.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/emoji/emoji.list.json

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Files
           #
-          # This method deletes a file from your team.
+          # Deletes a file.
           #
           # @option options [file] :file
           #   ID of file to delete.
@@ -18,7 +18,7 @@ module Slack
           end
 
           #
-          # This method returns information about a file in your team.
+          # Gets information about a team file.
           #
           # @option options [file] :file
           #   Specify a file by providing its ID.
@@ -30,10 +30,8 @@ module Slack
           end
 
           #
-          # This method returns a list of files within the team. It can be filtered and sliced in various ways.
+          # Lists & filters team files.
           #
-          # @option options [user] :user
-          #   Filter files created by a single user.
           # @option options [channel] :channel
           #   Filter files appearing in a specific channel, indicated by its ID.
           # @option options [Object] :ts_from
@@ -54,6 +52,8 @@ module Slack
           #
           #   You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.
           #   .
+          # @option options [user] :user
+          #   Filter files created by a single user.
           # @see https://api.slack.com/methods/files.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files/files.list.json
           def files_list(options = {})
@@ -63,7 +63,7 @@ module Slack
           end
 
           #
-          # This method disables public/external sharing for a file.
+          # Revokes public/external sharing access for a file
           #
           # @option options [file] :file
           #   File to revoke.
@@ -75,7 +75,7 @@ module Slack
           end
 
           #
-          # This method enables public/external sharing for a file.
+          # Enables a file for public/external sharing.
           #
           # @option options [file] :file
           #   File to share.
@@ -87,26 +87,25 @@ module Slack
           end
 
           #
-          # This method allows you to create or upload an existing file.
+          # Uploads or creates a file.
           #
-          # @option options [file] :file
-          #   File contents via multipart/form-data. If omitting this parameter, you must submit content.
+          # @option options [Object] :channels
+          #   Comma-separated list of channel names or IDs where the file will be shared.
           # @option options [Object] :content
           #   File contents via a POST variable. If omitting this parameter, you must provide a file.
-          # @option options [Object] :filetype
-          #   A file type identifier.
+          # @option options [file] :file
+          #   File contents via multipart/form-data. If omitting this parameter, you must submit content.
           # @option options [Object] :filename
           #   Filename of file.
-          # @option options [Object] :title
-          #   Title of file.
+          # @option options [Object] :filetype
+          #   A file type identifier.
           # @option options [Object] :initial_comment
           #   Initial comment to add to file.
-          # @option options [Object] :channels
-          #   Comma-separated list of channel names or IDs where the file will be shared.
+          # @option options [Object] :title
+          #   Title of file.
           # @see https://api.slack.com/methods/files.upload
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files/files.upload.json
           def files_upload(options = {})
-            throw ArgumentError.new('Required arguments :filename missing') if options[:filename].nil?
             post('files.upload', options)
           end
         end

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

@@ -8,20 +8,20 @@ module Slack
           #
           # Add a comment to an existing file.
           #
-          # @option options [file] :file
-          #   File to add a comment to.
           # @option options [Object] :comment
           #   Text of the comment to add.
+          # @option options [file] :file
+          #   File to add a comment to.
           # @see https://api.slack.com/methods/files.comments.add
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments/files.comments.add.json
           def files_comments_add(options = {})
-            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
+            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             post('files.comments.add', options)
           end
 
           #
-          # Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment.
+          # Deletes an existing comment on a file.
           #
           # @option options [file] :file
           #   File to delete a comment from.
@@ -36,20 +36,20 @@ module Slack
           end
 
           #
-          # Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.
+          # Edit an existing file comment.
           #
+          # @option options [Object] :comment
+          #   Text of the comment to edit.
           # @option options [file] :file
           #   File containing the comment to edit.
           # @option options [Object] :id
           #   The comment to edit.
-          # @option options [Object] :comment
-          #   Text of the comment to edit.
           # @see https://api.slack.com/methods/files.comments.edit
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments/files.comments.edit.json
           def files_comments_edit(options = {})
+            throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
-            throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
             post('files.comments.edit', options)
           end
         end

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Groups
           #
-          # This method archives a private channel.
+          # Archives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to archive.
@@ -19,7 +19,7 @@ module Slack
           end
 
           #
-          # This method closes a private channel.
+          # Closes a private channel.
           #
           # @option options [group] :channel
           #   Private channel to close.
@@ -32,7 +32,7 @@ module Slack
           end
 
           #
-          # This method creates a private channel.
+          # Creates a private channel.
           #
           # @option options [Object] :name
           #   Name of private channel to create.
@@ -46,7 +46,7 @@ module Slack
           end
 
           #
-          # This method takes an existing private channel and performs the following steps:
+          # Clones and archives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to clone and archive.
@@ -59,18 +59,16 @@ module Slack
           end
 
           #
-          # This method returns a portion of messages/events from the specified private channel.
-          # To read the entire history for a private channel, call the method with no latest or
-          # oldest arguments, and then continue paging using the instructions below.
+          # Fetches history of messages and events from a private channel.
           #
           # @option options [group] :channel
           #   Private channel to fetch history for.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [timestamp] :oldest
           #   Start of time range of messages to include in results.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
           # @option options [Object] :unreads
           #   Include unread_count_display in the output?.
           # @see https://api.slack.com/methods/groups.history
@@ -82,7 +80,7 @@ module Slack
           end
 
           #
-          # This method returns information about a private channel.
+          # Gets information about a private channel.
           #
           # @option options [group] :channel
           #   Private channel to get info on.
@@ -95,7 +93,7 @@ module Slack
           end
 
           #
-          # This method is used to invite a user to a private channel. The calling user must be a member of the private channel.
+          # Invites a user to a private channel.
           #
           # @option options [group] :channel
           #   Private channel to invite user to.
@@ -112,7 +110,7 @@ module Slack
           end
 
           #
-          # This method allows a user to remove another member from a private channel.
+          # Removes a user from a private channel.
           #
           # @option options [group] :channel
           #   Private channel to remove user from.
@@ -129,7 +127,7 @@ module Slack
           end
 
           #
-          # This method is used to leave a private channel.
+          # Leaves a private channel.
           #
           # @option options [group] :channel
           #   Private channel to leave.
@@ -142,11 +140,12 @@ module Slack
           end
 
           #
-          # This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in.
-          # The list of (non-deactivated) members in each private channel is also returned.
+          # Lists private channels that the calling user has access to.
           #
           # @option options [Object] :exclude_archived
           #   Don't return archived private channels.
+          # @option options [Object] :exclude_members
+          #   Exlude the members from each group.
           # @see https://api.slack.com/methods/groups.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.list.json
           def groups_list(options = {})
@@ -154,7 +153,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a private channel.
+          # Sets the read cursor in a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set reading cursor in.
@@ -170,7 +169,7 @@ module Slack
           end
 
           #
-          # This method opens a private channel.
+          # Opens a private channel.
           #
           # @option options [group] :channel
           #   Private channel to open.
@@ -183,7 +182,7 @@ module Slack
           end
 
           #
-          # This method renames a private channel.
+          # Renames a private channel.
           #
           # @option options [group] :channel
           #   Private channel to rename.
@@ -201,7 +200,7 @@ module Slack
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a private channel
           #
           # @option options [group] :channel
           #   Private channel to fetch thread from.
@@ -217,7 +216,7 @@ module Slack
           end
 
           #
-          # This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.
+          # Sets the purpose for a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the purpose of.
@@ -233,7 +232,7 @@ module Slack
           end
 
           #
-          # This method is used to change the topic of a private channel. The calling user must be a member of the private channel.
+          # Sets the topic for a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the topic of.
@@ -249,7 +248,7 @@ module Slack
           end
 
           #
-          # This method unarchives a private channel.
+          # Unarchives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to unarchive.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Im
           #
-          # This method closes a direct message channel.
+          # Close a direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to close.
@@ -19,18 +19,16 @@ module Slack
           end
 
           #
-          # 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.
+          # Fetches history of messages and events from direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to fetch history for.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [timestamp] :oldest
           #   Start of time range of messages to include in results.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
           # @option options [Object] :unreads
           #   Include unread_count_display in the output?.
           # @see https://api.slack.com/methods/im.history
@@ -42,7 +40,7 @@ module Slack
           end
 
           #
-          # This method returns a list of all im channels that the user has.
+          # Lists direct message channels for the calling user.
           #
           # @see https://api.slack.com/methods/im.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.list.json
@@ -51,7 +49,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a direct message channel.
+          # Sets the read cursor in a direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to set reading cursor in.
@@ -67,7 +65,7 @@ module Slack
           end
 
           #
-          # This method opens a direct message channel with another member of your Slack team.
+          # Opens a direct message channel.
           #
           # @option options [user] :user
           #   User to open a direct message channel with.
@@ -82,7 +80,7 @@ module Slack
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a direct message conversation
           #
           # @option options [im] :channel
           #   Direct message channel to fetch thread from.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Mpim
           #
-          # This method closes a multiparty direct message channel.
+          # Closes a multiparty direct message channel.
           #
           # @option options [channel] :channel
           #   MPIM to close.
@@ -19,18 +19,16 @@ module Slack
           end
 
           #
-          # This method returns a portion of messages/events from the specified multiparty direct message channel.
-          # To read the entire history for a multiparty direct message, call the method with no latest or
-          # oldest arguments, and then continue paging using the instructions below.
+          # Fetches history of messages and events from a multiparty direct message.
           #
           # @option options [channel] :channel
           #   Multiparty direct message to fetch history for.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [timestamp] :oldest
           #   Start of time range of messages to include in results.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
           # @option options [Object] :unreads
           #   Include unread_count_display in the output?.
           # @see https://api.slack.com/methods/mpim.history
@@ -42,7 +40,7 @@ module Slack
           end
 
           #
-          # This method returns a list of all multiparty direct message channels that the user has.
+          # Lists multiparty direct message channels for the calling user.
           #
           # @see https://api.slack.com/methods/mpim.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim/mpim.list.json
@@ -51,7 +49,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a multiparty direct message channel.
+          # Sets the read cursor in a multiparty direct message channel.
           #
           # @option options [channel] :channel
           #   multiparty direct message channel to set reading cursor in.
@@ -79,7 +77,7 @@ module Slack
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.
           #
           # @option options [channel] :channel
           #   Multiparty direct message channel to fetch thread from.