slack-ruby-client 0.14.1 → 0.14.2

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Dialog
           #
-          # Open a dialog with a user
+          # Open a dialog with a user by exchanging a trigger_id received from another interaction. See the dialogs documentation to learn how to obtain triggers define form elements.
           #
           # @option options [Object] :dialog
           #   The dialog definition. This must be a JSON-encoded string.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Dnd
           #
-          # Ends the current user's Do Not Disturb session immediately.
+          # Ends the user's currently scheduled Do Not Disturb session immediately.
           #
           # @see https://api.slack.com/methods/dnd.endDnd
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.endDnd.json
@@ -24,7 +24,7 @@ module Slack
           end
 
           #
-          # Retrieves a user's current Do Not Disturb status.
+          # Provides information about a user's current Do Not Disturb settings.
           #
           # @option options [user] :user
           #   User to fetch status for (defaults to current user).
@@ -36,7 +36,7 @@ module Slack
           end
 
           #
-          # Turns on Do Not Disturb mode for the current user, or changes its duration.
+          # 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.
           #
           # @option options [Object] :num_minutes
           #   Number of minutes, from now, to snooze until.
@@ -48,7 +48,7 @@ module Slack
           end
 
           #
-          # Retrieves the Do Not Disturb status for users on a team.
+          # Provides information about the current Do Not Disturb settings for a list of users in a Slack 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
           #
-          # 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/slack-ruby/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
           #
-          # Deletes a file.
+          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
           #
           # @option options [file] :file
           #   ID of file to delete.
@@ -35,7 +35,7 @@ module Slack
           end
 
           #
-          # Gets information about a team file.
+          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
           #
           # @option options [file] :file
           #   Specify a file by providing its ID.
@@ -57,7 +57,7 @@ module Slack
           end
 
           #
-          # Lists & filters team files.
+          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
           #
           # @option options [channel] :channel
           #   Filter files appearing in a specific channel, indicated by its ID.
@@ -66,18 +66,7 @@ module Slack
           # @option options [Object] :ts_to
           #   Filter files created before this timestamp (inclusive).
           # @option options [Object] :types
-          #   Filter files by type:
-          #   * `all` - All files
-          #   * `spaces` - 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=spaces,snippets`.The default value is `all`, which does not filter the list.
-          #
-          #   .
+          #   Filter files by type (see below). 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
@@ -89,7 +78,7 @@ module Slack
           end
 
           #
-          # Revokes public/external sharing access for a file
+          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
           #
           # @option options [file] :file
           #   File to revoke.
@@ -117,7 +106,7 @@ module Slack
           end
 
           #
-          # Enables a file for public/external sharing.
+          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
           #
           # @option options [file] :file
           #   File to share.
@@ -129,7 +118,7 @@ module Slack
           end
 
           #
-          # Uploads or creates a file.
+          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
           #
           # @option options [Object] :channels
           #   Comma-separated list of channel names or IDs where the file will be shared.

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

@@ -6,22 +6,7 @@ module Slack
       module Endpoints
         module FilesComments
           #
-          # Add a comment to an existing file.
-          #
-          # @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/slack-ruby/slack-api-ref/blob/master/methods/files.comments/files.comments.add.json
-          def files_comments_add(options = {})
-            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
-
-          #
-          # Deletes an existing comment on a file.
+          # A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
           #
           # @option options [file] :file
           #   File to delete a comment from.
@@ -34,24 +19,6 @@ module Slack
             throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
             post('files.comments.delete', options)
           end
-
-          #
-          # 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.
-          # @see https://api.slack.com/methods/files.comments.edit
-          # @see https://github.com/slack-ruby/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?
-            post('files.comments.edit', options)
-          end
         end
       end
     end

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Groups
           #
-          # Archives a private channel.
+          # This method archives a private channel.
           #
           # @option options [group] :channel
           #   Private channel to archive.
@@ -19,7 +19,7 @@ module Slack
           end
 
           #
-          # Creates a private channel.
+          # This method creates a private channel.
           #
           # @option options [Object] :name
           #   Name of private channel to create.
@@ -33,7 +33,7 @@ module Slack
           end
 
           #
-          # Clones and archives a private channel.
+          # This method takes an existing private channel and performs the following steps:
           #
           # @option options [group] :channel
           #   Private channel to clone and archive.
@@ -46,7 +46,9 @@ module Slack
           end
 
           #
-          # Fetches history of messages and events from a private channel.
+          # 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.
           #
           # @option options [group] :channel
           #   Private channel to fetch history for.
@@ -67,7 +69,7 @@ module Slack
           end
 
           #
-          # Gets information about a private channel.
+          # Don't use this method. Use conversations.info instead.
           #
           # @option options [group] :channel
           #   Private channel to get info on.
@@ -82,7 +84,7 @@ module Slack
           end
 
           #
-          # Invites a user to a private channel.
+          # This method is used to invite a user to a private channel. The calling user must be a member of the private channel.
           #
           # @option options [group] :channel
           #   Private channel to invite user to.
@@ -99,7 +101,7 @@ module Slack
           end
 
           #
-          # Removes a user from a private channel.
+          # This method allows a user to remove another member from a private channel.
           #
           # @option options [group] :channel
           #   Private channel to remove user from.
@@ -116,7 +118,7 @@ module Slack
           end
 
           #
-          # Leaves a private channel.
+          # This method is used to leave a private channel.
           #
           # @option options [group] :channel
           #   Private channel to leave.
@@ -129,7 +131,7 @@ module Slack
           end
 
           #
-          # Lists private channels that the calling user has access to.
+          # Don't use this method. Use conversations.list instead.
           #
           # @option options [Object] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -152,7 +154,7 @@ module Slack
           end
 
           #
-          # Sets the read cursor in a private channel.
+          # This method moves the read cursor in a private channel.
           #
           # @option options [group] :channel
           #   Private channel to set reading cursor in.
@@ -168,7 +170,7 @@ module Slack
           end
 
           #
-          # Opens a private channel.
+          # This method opens a private channel.
           #
           # @option options [group] :channel
           #   Private channel to open.
@@ -181,7 +183,7 @@ module Slack
           end
 
           #
-          # Renames a private channel.
+          # This method renames a private channel.
           #
           # @option options [group] :channel
           #   Private channel to rename.
@@ -199,7 +201,7 @@ module Slack
           end
 
           #
-          # Retrieve a thread of messages posted to a private channel
+          # This method returns an entire thread (a message plus all the messages in reply to it).
           #
           # @option options [group] :channel
           #   Private channel to fetch thread from.
@@ -215,7 +217,7 @@ module Slack
           end
 
           #
-          # Sets the purpose for a private channel.
+          # This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the purpose of.
@@ -231,7 +233,7 @@ module Slack
           end
 
           #
-          # Sets the topic for a private channel.
+          # This method is used to change the topic of a private channel. The calling user must be a member of the private channel.
           #
           # @option options [group] :channel
           #   Private channel to set the topic of.
@@ -247,7 +249,7 @@ module Slack
           end
 
           #
-          # Unarchives a private channel.
+          # This method 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
           #
-          # Close a direct message channel.
+          # This method closes a direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to close.
@@ -19,7 +19,9 @@ module Slack
           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
           #   Direct message channel to fetch history for.
@@ -40,7 +42,7 @@ module Slack
           end
 
           #
-          # Lists direct message channels for the calling user.
+          # Don't use this method. Use conversations.list instead.
           #
           # @option options [Object] :cursor
           #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
@@ -59,7 +61,7 @@ module Slack
           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
           #   Direct message channel to set reading cursor in.
@@ -75,7 +77,7 @@ 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
           #   User to open a direct message channel with.
@@ -92,7 +94,7 @@ module Slack
           end
 
           #
-          # Retrieve a thread of messages posted to a direct message conversation
+          # This method returns an entire thread (a message plus all the messages in reply to it).
           #
           # @option options [im] :channel
           #   Direct message channel to fetch thread from.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Migration
           #
-          # For Enterprise Grid workspaces, map local user IDs to global user IDs
+          # Easily convert your vintage user IDs to Enterprise Grid-friendly global user IDs.
           #
           # @option options [Object] :users
           #   A comma-separated list of user ids, up to 400 per request.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Mpim
           #
-          # Closes a multiparty direct message channel.
+          # This method closes a multiparty direct message channel.
           #
           # @option options [channel] :channel
           #   MPIM to close.
@@ -19,7 +19,9 @@ module Slack
           end
 
           #
-          # Fetches history of messages and events from a multiparty direct message.
+          # 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.
           #
           # @option options [channel] :channel
           #   Multiparty direct message to fetch history for.
@@ -40,7 +42,7 @@ module Slack
           end
 
           #
-          # Lists multiparty direct message channels for the calling user.
+          # Don't use this method. Use conversations.list instead.
           #
           # @option options [Object] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -59,7 +61,7 @@ module Slack
           end
 
           #
-          # Sets the read cursor in a multiparty direct message channel.
+          # This method moves the read cursor in a multiparty direct message channel.
           #
           # @option options [channel] :channel
           #   multiparty direct message channel to set reading cursor in.
@@ -87,7 +89,7 @@ module Slack
           end
 
           #
-          # Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.
+          # This method returns an entire thread (a message plus all the messages in reply to it).
           #
           # @option options [channel] :channel
           #   Multiparty direct message channel to fetch thread from.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Oauth
           #
-          # Exchanges a temporary OAuth verifier code for an access token.
+          # This method allows you to exchange a temporary OAuth code for an API access token.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.
@@ -28,7 +28,7 @@ module Slack
           end
 
           #
-          # Exchanges a temporary OAuth verifier code for a workspace token.
+          # This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.

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

@@ -6,7 +6,8 @@ module Slack
       module Endpoints
         module Pins
           #
-          # Pins an item to a channel.
+          # This method pins an item (file, file comment, channel message, or group message) to a particular channel.
+          # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
           #
           # @option options [channel] :channel
           #   Channel to pin the item in.
@@ -25,7 +26,7 @@ module Slack
           end
 
           #
-          # Lists items pinned to a channel.
+          # This method lists the items pinned to a channel.
           #
           # @option options [channel] :channel
           #   Channel to get pinned items for.
@@ -38,7 +39,8 @@ module Slack
           end
 
           #
-          # Un-pins an item from a channel.
+          # This method un-pins an item (file, file comment, channel message, or group message) from a channel.
+          # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
           #
           # @option options [channel] :channel
           #   Channel where the item is pinned to.