slack-ruby-client 0.14.3 → 0.15.1

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -18,13 +19,13 @@ module Slack
           def chat_command(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :command missing') if options[:command].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             logger.warn('The chat.command method is undocumented.')
             post('chat.command', options)
           end
 
           #
-          # This method deletes a message from a channel.
+          # Deletes a message.
           #
           # @option options [channel] :channel
           #   Channel containing the message to be deleted.
@@ -37,12 +38,12 @@ module Slack
           def chat_delete(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('chat.delete', options)
           end
 
           #
-          # This method deletes a pending scheduled message before it is sent.
+          # Deletes a pending scheduled message from the queue.
           #
           # @option options [channel] :channel
           #   The channel the scheduled_message is posting to.
@@ -55,12 +56,12 @@ module Slack
           def chat_deleteScheduledMessage(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :scheduled_message_id missing') if options[:scheduled_message_id].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('chat.deleteScheduledMessage', options)
           end
 
           #
-          # Easily exchange a message timestamp and a channel ID for a friendly HTTP-based permalink to that message. Handles message threads and all conversation types.
+          # Retrieve a permalink URL for a specific extant message
           #
           # @option options [channel] :channel
           #   The ID of the conversation or channel containing the message.
@@ -71,12 +72,12 @@ module Slack
           def chat_getPermalink(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :message_ts missing') if options[:message_ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('chat.getPermalink', options)
           end
 
           #
-          # This method sends a me message to a channel from the calling user.
+          # Share a me message into a channel.
           #
           # @option options [channel] :channel
           #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
@@ -91,14 +92,14 @@ module Slack
           end
 
           #
-          # This method posts an ephemeral message, which is visible only to the assigned user in a specific public channel, private channel, or private conversation.
+          # Sends an ephemeral message to a user in a channel.
           #
           # @option options [Object] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
           # @option options [channel] :channel
           #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
           # @option options [Object] :text
-          #   Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead.
+          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
           # @option options [user] :user
           #   id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
           # @option options [Object] :as_user
@@ -140,22 +141,22 @@ module Slack
           end
 
           #
-          # This method posts a message to a public channel, private channel, or direct message/IM channel.
+          # Sends a message to a channel.
           #
           # @option options [channel] :channel
           #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
           # @option options [Object] :text
-          #   Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.
+          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
           # @option options [Object] :as_user
-          #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
+          #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below. This argument may not be used with newer bot tokens.
           # @option options [Object] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
           # @option options [Object] :blocks
           #   A JSON-based array of structured blocks, presented as a URL-encoded string.
           # @option options [Object] :icon_emoji
-          #   Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
+          #   Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. This argument may not be used with newer bot tokens.
           # @option options [Object] :icon_url
-          #   URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
+          #   URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. This argument may not be used with newer bot tokens.
           # @option options [Object] :link_names
           #   Find and link channel names and usernames.
           # @option options [Object] :mrkdwn
@@ -193,16 +194,16 @@ module Slack
           end
 
           #
-          # This method schedules a message for delivery to a public channel, private channel, or direct message/IM channel at a specified time in the future.
+          # Schedules a message to be sent to a channel.
           #
           # @option options [channel] :channel
           #   Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.
           # @option options [Object] :post_at
           #   Unix EPOCH timestamp of time in future to send the message.
           # @option options [Object] :text
-          #   Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.
+          #   How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
           # @option options [Object] :as_user
-          #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
+          #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage.
           # @option options [Object] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string.
           # @option options [Object] :blocks
@@ -210,7 +211,7 @@ module Slack
           # @option options [Object] :link_names
           #   Find and link channel names and usernames.
           # @option options [Object] :parse
-          #   Change how messages are treated. Defaults to none. See below.
+          #   Change how messages are treated. Defaults to none. See chat.postMessage.
           # @option options [Object] :reply_broadcast
           #   Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
           # @option options [Object] :thread_ts
@@ -229,7 +230,7 @@ module Slack
           end
 
           #
-          # This method attaches Slack app unfurl behavior to a specified and relevant message. A user token is required as this method does not support bot user tokens.
+          # Provide custom unfurl behavior for user-posted URLs
           #
           # @option options [channel] :channel
           #   Channel ID of the message.
@@ -249,36 +250,36 @@ module Slack
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
             throw ArgumentError.new('Required arguments :unfurls missing') if options[:unfurls].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('chat.unfurl', options)
           end
 
           #
-          # This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.
+          # Updates a message.
           #
           # @option options [channel] :channel
           #   Channel containing the message to be updated.
-          # @option options [Object] :text
-          #   New text for the message, using the default formatting rules. It's not required when presenting attachments.
           # @option options [timestamp] :ts
           #   Timestamp of the message to be updated.
           # @option options [Object] :as_user
           #   Pass true to update the message as the authed user. Bot users in this context are considered authed users.
           # @option options [Object] :attachments
-          #   A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.
+          #   A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text. If you don't include this field, the message's previous attachments will be retained. To remove previous attachments, include an empty array for this field.
           # @option options [Object] :blocks
-          #   A JSON-based array of structured blocks, presented as a URL-encoded string.
+          #   A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous blocks will be retained. To remove previous blocks, include an empty array for this field.
           # @option options [Object] :link_names
-          #   Find and link channel names and usernames. Defaults to none. See below.
+          #   Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.
           # @option options [Object] :parse
-          #   Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
+          #   Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.
+          # @option options [Object] :text
+          #   New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments.
           # @see https://api.slack.com/methods/chat.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.update.json
           def chat_update(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :text, :attachments or :blocks missing') if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             # attachments must be passed as an encoded JSON string
             if options.key?(:attachments)
               attachments = options[:attachments]

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module ChatScheduledmessages
           #
-          # This method returns a list of pending scheduled messages.
+          # Returns a list of scheduled messages.
           #
           # @option options [channel] :channel
           #   The channel of the scheduled messages.
@@ -21,7 +22,7 @@ module Slack
           # @see https://api.slack.com/methods/chat.scheduledMessages.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat.scheduledMessages/chat.scheduledMessages.list.json
           def chat_scheduledMessages_list(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             if block_given?
               Pagination::Cursor.new(self, :chat_scheduledMessages_list, options).each do |page|
                 yield page

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -6,7 +7,7 @@ module Slack
       module Endpoints
         module Conversations
           #
-          # This method archives a conversation. Not all types of conversations can be archived.
+          # Archives a conversation.
           #
           # @option options [channel] :channel
           #   ID of conversation to archive.
@@ -14,12 +15,12 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.archive.json
           def conversations_archive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.archive', options)
           end
 
           #
-          # This Conversations API method closes direct messages, multi-person or 1:1 or otherwise.
+          # Closes a direct message or multi-person direct message.
           #
           # @option options [channel] :channel
           #   Conversation to close.
@@ -27,19 +28,17 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.close.json
           def conversations_close(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.close', options)
           end
 
           #
-          # Create a public or private channel using this Conversations API method.
+          # Initiates a public or private channel-based conversation
           #
           # @option options [Object] :name
           #   Name of the public or private channel to create.
           # @option options [Object] :is_private
           #   Create a private channel instead of a public one.
-          # @option options [Object] :user_ids
-          #   Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.
           # @see https://api.slack.com/methods/conversations.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.create.json
           def conversations_create(options = {})
@@ -48,7 +47,7 @@ module Slack
           end
 
           #
-          # This method returns a portion of message events from the specified conversation.
+          # Fetches a conversation's history of messages and events.
           #
           # @option options [channel] :channel
           #   Conversation ID to fetch history for.
@@ -66,7 +65,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.history.json
           def conversations_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             if block_given?
               Pagination::Cursor.new(self, :conversations_history, options).each do |page|
                 yield page
@@ -77,7 +76,7 @@ module Slack
           end
 
           #
-          # This Conversations API method returns information about a workspace conversation.
+          # Retrieve information about a conversation.
           #
           # @option options [channel] :channel
           #   Conversation ID to learn more about.
@@ -89,28 +88,28 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.info.json
           def conversations_info(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.info', options)
           end
 
           #
-          # This Conversations API method invites 1-30 users to a public or private channel. The calling user must be a member of the channel.
+          # Invites users to a channel.
           #
           # @option options [channel] :channel
           #   The ID of the public or private channel to invite user(s) to.
           # @option options [Object] :users
-          #   A comma separated list of user IDs. Up to 30 users may be listed.
+          #   A comma separated list of user IDs. Up to 1000 users may be listed.
           # @see https://api.slack.com/methods/conversations.invite
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.invite.json
           def conversations_invite(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.invite', options)
           end
 
           #
-          # This Conversations API method joins a user to an existing conversation.
+          # Joins an existing conversation.
           #
           # @option options [channel] :channel
           #   ID of conversation to join.
@@ -118,12 +117,12 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.join.json
           def conversations_join(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.join', options)
           end
 
           #
-          # This Conversations API method allows a user to remove another member from a channel.
+          # Removes a user from a conversation.
           #
           # @option options [channel] :channel
           #   ID of conversation to remove user from.
@@ -134,13 +133,13 @@ module Slack
           def conversations_kick(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('conversations.kick', options)
           end
 
           #
-          # This Conversations API method makes like a tree and leaves a conversation.
+          # Leaves a conversation.
           #
           # @option options [channel] :channel
           #   Conversation to leave.
@@ -148,12 +147,12 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.leave.json
           def conversations_leave(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.leave', options)
           end
 
           #
-          # This Conversations API method returns a list of all channel-like conversations in a workspace. The "channels" returned depend on what the calling token has access to and the directives placed in the types parameter.
+          # Lists all channels in a Slack team.
           #
           # @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.
@@ -176,7 +175,7 @@ module Slack
           end
 
           #
-          # This Conversations API method returns a paginated list of members party to a conversation.
+          # Retrieve members of a conversation.
           #
           # @option options [channel] :channel
           #   ID of the conversation to retrieve members for.
@@ -188,7 +187,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.members.json
           def conversations_members(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             if block_given?
               Pagination::Cursor.new(self, :conversations_members, options).each do |page|
                 yield page
@@ -199,7 +198,7 @@ module Slack
           end
 
           #
-          # This Conversations API method opens a multi-person direct message or just a 1:1 direct message.
+          # Opens or resumes a direct message or multi-person direct message.
           #
           # @option options [channel] :channel
           #   Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
@@ -210,12 +209,12 @@ module Slack
           # @see https://api.slack.com/methods/conversations.open
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.open.json
           def conversations_open(options = {})
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.open', options)
           end
 
           #
-          # This method renames a conversation. Some types of conversations cannot be renamed.
+          # Renames a conversation.
           #
           # @option options [channel] :channel
           #   ID of conversation to rename.
@@ -226,12 +225,12 @@ module Slack
           def conversations_rename(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.rename', options)
           end
 
           #
-          # This Conversations API method returns an entire thread (a message plus all the messages in reply to it), while conversations.history method returns only parent messages.
+          # Retrieve a thread of messages posted to a conversation
           #
           # @option options [channel] :channel
           #   Conversation ID to fetch thread from.
@@ -252,7 +251,7 @@ module Slack
           def conversations_replies(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             if block_given?
               Pagination::Cursor.new(self, :conversations_replies, options).each do |page|
                 yield page
@@ -263,7 +262,7 @@ module Slack
           end
 
           #
-          # This method is used to change the purpose of a conversation. The calling user must be a member of the conversation. Not all conversation types may have a purpose set.
+          # Sets the purpose for a conversation.
           #
           # @option options [channel] :channel
           #   Conversation to set the purpose of.
@@ -274,12 +273,12 @@ module Slack
           def conversations_setPurpose(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.setPurpose', options)
           end
 
           #
-          # This method is used to change the topic of a conversation. The calling user must be a member of the conversation. Not all conversation types support a new topic.
+          # Sets the topic for a conversation.
           #
           # @option options [channel] :channel
           #   Conversation to set the topic of.
@@ -290,12 +289,12 @@ module Slack
           def conversations_setTopic(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.setTopic', options)
           end
 
           #
-          # This method unarchives a conversation. The calling user is added to the conversation.
+          # Reverses conversation archival.
           #
           # @option options [channel] :channel
           #   ID of conversation to unarchive.
@@ -303,7 +302,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.unarchive.json
           def conversations_unarchive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
             post('conversations.unarchive', options)
           end
         end