conversations.rb in slack-ruby-client-0.14.2

- old
+ new

@@ -4,11 +4,11 @@
   module Web
     module Api
       module Endpoints
         module Conversations
           #
-          # Archives a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   ID of conversation to archive.
           # @see https://api.slack.com/methods/conversations.archive
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.archive.json
@@ -17,11 +17,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.archive', options)
           end
 
           #
-          # Closes a direct message or multi-person direct message.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Conversation to close.
           # @see https://api.slack.com/methods/conversations.close
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.close.json
@@ -30,11 +30,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.close', options)
           end
 
           #
-          # Initiates a public or private channel-based conversation
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @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.
@@ -46,11 +46,11 @@
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
             post('conversations.create', options)
           end
 
           #
-          # Fetches a conversation's history of messages and events.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Conversation ID to fetch history for.
           # @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.
@@ -75,11 +75,11 @@
               post('conversations.history', options)
             end
           end
 
           #
-          # Retrieve information about a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Conversation ID to learn more about.
           # @option options [Object] :include_locale
           #   Set this to true to receive the locale for this conversation. Defaults to false.
@@ -92,11 +92,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.info', options)
           end
 
           #
-          # Invites users to a channel.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @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.
@@ -108,11 +108,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.invite', options)
           end
 
           #
-          # Joins an existing conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   ID of conversation to join.
           # @see https://api.slack.com/methods/conversations.join
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.join.json
@@ -121,11 +121,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.join', options)
           end
 
           #
-          # Removes a user from a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   ID of conversation to remove user from.
           # @option options [user] :user
           #   User ID to be removed.
@@ -138,11 +138,11 @@
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('conversations.kick', options)
           end
 
           #
-          # Leaves a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Conversation to leave.
           # @see https://api.slack.com/methods/conversations.leave
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.leave.json
@@ -151,11 +151,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.leave', options)
           end
 
           #
-          # Lists all channels in a Slack team.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @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.
           # @option options [Object] :exclude_archived
           #   Set to true to exclude archived channels from the list.
@@ -174,11 +174,11 @@
               post('conversations.list', options)
             end
           end
 
           #
-          # Retrieve members of a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   ID of the conversation to retrieve members for.
           # @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.
@@ -197,11 +197,11 @@
               post('conversations.members', options)
             end
           end
 
           #
-          # Opens or resumes a direct message or multi-person direct message.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
           # @option options [Object] :return_im
           #   Boolean, indicates you want the full IM channel definition in the response.
@@ -213,11 +213,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.open', options)
           end
 
           #
-          # Renames a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   ID of conversation to rename.
           # @option options [Object] :name
           #   New name for conversation.
@@ -229,11 +229,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.rename', options)
           end
 
           #
-          # Retrieve a thread of messages posted to a conversation
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Conversation ID to fetch thread from.
           # @option options [timestamp] :ts
           #   Unique identifier of a thread's parent message.
@@ -261,11 +261,11 @@
               post('conversations.replies', options)
             end
           end
 
           #
-          # Sets the purpose for a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Conversation to set the purpose of.
           # @option options [Object] :purpose
           #   A new, specialer purpose.
@@ -277,11 +277,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.setPurpose', options)
           end
 
           #
-          # Sets the topic for a conversation.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   Conversation to set the topic of.
           # @option options [Object] :topic
           #   The new topic string. Does not support formatting or linkification.
@@ -293,10 +293,10 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('conversations.setTopic', options)
           end
 
           #
-          # Reverses conversation archival.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [channel] :channel
           #   ID of conversation to unarchive.
           # @see https://api.slack.com/methods/conversations.unarchive
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.unarchive.json