slack-ruby-client 0.14.4 → 0.14.5

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
@@ -24,7 +25,7 @@ module Slack
           end
 
           #
-          # This method deletes a message from a channel.
+          # Deletes a message.
           #
           # @option options [channel] :channel
           #   Channel containing the message to be deleted.
@@ -42,7 +43,7 @@ module Slack
           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.
@@ -60,7 +61,7 @@ module Slack
           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.
@@ -76,7 +77,7 @@ module Slack
           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,7 +92,7 @@ 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.
@@ -140,7 +141,7 @@ 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.
@@ -193,7 +194,7 @@ 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.
@@ -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.
@@ -254,7 +255,7 @@ module Slack
           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.

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.

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.
@@ -19,7 +20,7 @@ module Slack
           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.
@@ -32,7 +33,7 @@ module Slack
           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.
@@ -48,7 +49,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.
@@ -77,7 +78,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.
@@ -94,7 +95,7 @@ module Slack
           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.
@@ -110,7 +111,7 @@ module Slack
           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.
@@ -123,7 +124,7 @@ module Slack
           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.
@@ -140,7 +141,7 @@ module Slack
           end
 
           #
-          # This Conversations API method makes like a tree and leaves a conversation.
+          # Leaves a conversation.
           #
           # @option options [channel] :channel
           #   Conversation to leave.
@@ -153,7 +154,7 @@ module Slack
           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 +177,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.
@@ -199,7 +200,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.
@@ -215,7 +216,7 @@ module Slack
           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.
@@ -231,7 +232,7 @@ module Slack
           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.
@@ -263,7 +264,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.
@@ -279,7 +280,7 @@ module Slack
           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.
@@ -295,7 +296,7 @@ module Slack
           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.

data/lib/slack/web/api/endpoints/dialog.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 Dialog
           #
-          # 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.
+          # Open a dialog with a user
           #
           # @option options [Object] :dialog
           #   The dialog definition. This must be a JSON-encoded string.

data/lib/slack/web/api/endpoints/dnd.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 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/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.endDnd.json
@@ -24,7 +25,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 +37,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 +49,7 @@ module Slack
           end
 
           #
-          # Provides information about the current Do Not Disturb settings for a list of users in a Slack team.
+          # Retrieves the Do Not Disturb status for up to 50 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

@@ -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 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/slack-ruby/slack-api-ref/blob/master/methods/emoji/emoji.list.json

data/lib/slack/web/api/endpoints/files.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 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.
+          # Deletes a file.
           #
           # @option options [file] :file
           #   ID of file to delete.
@@ -35,7 +36,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Gets information about a team file.
           #
           # @option options [file] :file
           #   Specify a file by providing its ID.
@@ -57,7 +58,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Lists & filters team files.
           #
           # @option options [channel] :channel
           #   Filter files appearing in a specific channel, indicated by its ID.
@@ -78,7 +79,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Revokes public/external sharing access for a file
           #
           # @option options [file] :file
           #   File to revoke.
@@ -106,7 +107,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Enables a file for public/external sharing.
           #
           # @option options [file] :file
           #   File to share.
@@ -118,7 +119,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Uploads or creates a file.
           #
           # @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

@@ -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 FilesComments
           #
-          # 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.
+          # Deletes an existing comment on a file.
           #
           # @option options [file] :file
           #   File to delete a comment from.

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module FilesRemote
+          #
+          # Adds a file from a remote service
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [Object] :external_url
+          #   URL of the remote file.
+          # @option options [Object] :title
+          #   Title of the file being shared.
+          # @option options [Object] :filetype
+          #   type of file.
+          # @option options [Object] :indexable_file_contents
+          #   File containing contents that can be used to improve searchability for the remote file.
+          # @option options [Object] :preview_image
+          #   Preview of the document via multipart/form-data.
+          # @see https://api.slack.com/methods/files.remote.add
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.add.json
+          def files_remote_add(options = {})
+            throw ArgumentError.new('Required arguments :external_id missing') if options[:external_id].nil?
+            throw ArgumentError.new('Required arguments :external_url missing') if options[:external_url].nil?
+            throw ArgumentError.new('Required arguments :title missing') if options[:title].nil?
+            post('files.remote.add', options)
+          end
+
+          #
+          # Retrieve information about a remote file added to Slack
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
+          # @see https://api.slack.com/methods/files.remote.info
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.info.json
+          def files_remote_info(options = {})
+            post('files.remote.info', options)
+          end
+
+          #
+          # Retrieve information about a remote file added to Slack
+          #
+          # @option options [channel] :channel
+          #   Filter files appearing in a specific channel, indicated by its ID.
+          # @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] :limit
+          #   The maximum number of items to return.
+          # @option options [Object] :ts_from
+          #   Filter files created after this timestamp (inclusive).
+          # @option options [Object] :ts_to
+          #   Filter files created before this timestamp (inclusive).
+          # @see https://api.slack.com/methods/files.remote.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.list.json
+          def files_remote_list(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            if block_given?
+              Pagination::Cursor.new(self, :files_remote_list, options).each do |page|
+                yield page
+              end
+            else
+              post('files.remote.list', options)
+            end
+          end
+
+          #
+          # Remove a remote file.
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
+          # @see https://api.slack.com/methods/files.remote.remove
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.remove.json
+          def files_remote_remove(options = {})
+            post('files.remote.remove', options)
+          end
+
+          #
+          # Share a remote file into a channel.
+          #
+          # @option options [Object] :channels
+          #   Comma-separated list of channel IDs where the file will be shared.
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
+          # @see https://api.slack.com/methods/files.remote.share
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.share.json
+          def files_remote_share(options = {})
+            throw ArgumentError.new('Required arguments :channels missing') if options[:channels].nil?
+            post('files.remote.share', options)
+          end
+
+          #
+          # Updates an existing remote file.
+          #
+          # @option options [Object] :external_id
+          #   Creator defined GUID for the file.
+          # @option options [Object] :external_url
+          #   URL of the remote file.
+          # @option options [file] :file
+          #   Specify a file by providing its ID.
+          # @option options [Object] :filetype
+          #   type of file.
+          # @option options [Object] :indexable_file_contents
+          #   File containing contents that can be used to improve searchability for the remote file.
+          # @option options [Object] :preview_image
+          #   Preview of the document via multipart/form-data.
+          # @option options [Object] :title
+          #   Title of the file being shared.
+          # @see https://api.slack.com/methods/files.remote.update
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.update.json
+          def files_remote_update(options = {})
+            post('files.remote.update', options)
+          end
+        end
+      end
+    end
+  end
+end