slack-api 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2891cd4a06dfc68f65ba2ad8628980ddc008ddba
-  data.tar.gz: ff8a862175ad65f0a76d18a1d46f07470f07fa49
+  metadata.gz: d733fd2e54c01346b1bf784ee5a840708b04a27a
+  data.tar.gz: 29d36932c6af2272be8af07c1bb4246332070759
 SHA512:
-  metadata.gz: 07de10a285ece0080aa4b47309c0432298da56d942c96cdb6407b3c0007525e95fd2f97ff6e08fee6894fa04cbed2fb3dc1c70915fff043763be5b918d3e90d7
-  data.tar.gz: 2611525bec9c74a89b939bf6ecc7b9fa6757f83054345b818b9b28c48b73c7b6b5caf2118cb257f3caa28d0884e89d7b1e7326a8169fc27925a963b849768e93
+  metadata.gz: 515445957b4cf4cab76231b70ca9bd0b94461ba7c3a0b24fd94b468f6ca7518f493b290ad3e7794b44fd281c9c92c538a0d346cf4c65f930b0d7ed13f7aa6f8a
+  data.tar.gz: fb4a93bfb759610fb23b27a27abd4b69c142e4232bb478c08b6573bdba7bcfb5bc361cb6009174305ade1bc07122670e4d0d2f1396cae42a612a6bda7534636b

data/lib/slack/endpoint.rb

@@ -1,10 +1,13 @@
 # This file was auto-generated by lib/generators/tasks/generate.rb
 #
 require_relative 'endpoint/api'
+require_relative 'endpoint/apps'
 require_relative 'endpoint/auth'
 require_relative 'endpoint/bots'
 require_relative 'endpoint/channels'
 require_relative 'endpoint/chat'
+require_relative 'endpoint/conversations'
+require_relative 'endpoint/dialog'
 require_relative 'endpoint/discovery'
 require_relative 'endpoint/dnd'
 require_relative 'endpoint/emoji'
@@ -12,6 +15,7 @@ require_relative 'endpoint/files'
 require_relative 'endpoint/groups'
 require_relative 'endpoint/idpgroups'
 require_relative 'endpoint/im'
+require_relative 'endpoint/migration'
 require_relative 'endpoint/mpim'
 require_relative 'endpoint/oauth'
 require_relative 'endpoint/pins'
@@ -27,10 +31,13 @@ require_relative 'endpoint/users'
 module Slack
   module Endpoint
     include Api
+    include Apps
     include Auth
     include Bots
     include Channels
     include Chat
+    include Conversations
+    include Dialog
     include Discovery
     include Dnd
     include Emoji
@@ -38,6 +45,7 @@ module Slack
     include Groups
     include Idpgroups
     include Im
+    include Migration
     include Mpim
     include Oauth
     include Pins

data/lib/slack/endpoint/api.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Api
       #
-      # This method helps you test your calling code.
+      # Checks API calling code.
       #
       # @option options [Object] :error
       #   Error response to return

data/lib/slack/endpoint/apps.rb

@@ -0,0 +1,34 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Apps
+      #
+      # Returns list of permissions this app has on a team.
+      #
+      # @see https://api.slack.com/methods/apps.permissions.info
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/apps.permissions.info.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/apps.permissions.info.json
+      def apps_permissions_info(options={})
+        post("apps.permissions.info", options)
+      end
+
+      #
+      # Allows an app to request additional scopes
+      #
+      # @option options [Object] :scopes
+      #   A comma separated list of scopes to request for
+      # @option options [Object] :trigger_id
+      #   Token used to trigger the permissions API
+      # @see https://api.slack.com/methods/apps.permissions.request
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/apps.permissions.request.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/apps.permissions.request.json
+      def apps_permissions_request(options={})
+        throw ArgumentError.new("Required arguments :scopes missing") if options[:scopes].nil?
+        throw ArgumentError.new("Required arguments :trigger_id missing") if options[:trigger_id].nil?
+        post("apps.permissions.request", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/auth.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Auth
       #
-      # This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.
+      # Revokes a token.
       #
       # @option options [Object] :test
       #   Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
@@ -16,7 +16,7 @@ module Slack
       end
 
       #
-      # This method checks authentication and tells you who you are.
+      # Checks authentication & identity.
       #
       # @see https://api.slack.com/methods/auth.test
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/auth.test.md

data/lib/slack/endpoint/bots.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Bots
       #
-      # This method returns information about a bot user.
+      # Gets information about a bot user.
       #
       # @option options [Object] :bot
       #   Bot user to get info on

data/lib/slack/endpoint/channels.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Channels
       #
-      # This method archives a channel.
+      # Archives a channel.
       #
       # @option options [Object] :channel
       #   Channel to archive
@@ -17,7 +17,7 @@ module Slack
       end
 
       #
-      # This method is used to create a channel.
+      # Creates a channel.
       #
       # @option options [Object] :name
       #   Name of channel to create
@@ -32,18 +32,18 @@ module Slack
       end
 
       #
-      # This method returns a portion of message events from the specified public channel.
+      # Fetches history of messages and events from a channel.
       #
       # @option options [Object] :channel
       #   Channel to fetch history for.
+      # @option options [Object] :count
+      #   Number of messages to return, between 1 and 1000.
+      # @option options [Object] :inclusive
+      #   Include messages with latest or oldest timestamp in results.
       # @option options [Object] :latest
       #   End of time range of messages to include in results.
       # @option options [Object] :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] :count
-      #   Number of messages to return, between 1 and 1000.
       # @option options [Object] :unreads
       #   Include unread_count_display in the output?
       # @see https://api.slack.com/methods/channels.history
@@ -55,10 +55,12 @@ module Slack
       end
 
       #
-      # This method returns information about a team channel.
+      # Gets information about a channel.
       #
       # @option options [Object] :channel
       #   Channel to get info on
+      # @option options [Object] :include_locale
+      #   Set this to true to receive the locale for this channel. Defaults to false
       # @see https://api.slack.com/methods/channels.info
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.info.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.info.json
@@ -68,7 +70,7 @@ module Slack
       end
 
       #
-      # This method is used to invite a user to a channel. The calling user must be a member of the channel.
+      # Invites a user to a channel.
       #
       # @option options [Object] :channel
       #   Channel to invite user to.
@@ -84,8 +86,7 @@ module Slack
       end
 
       #
-      # This method is used to join a channel. If the channel does not exist, it is
-      # created.
+      # Joins a channel, creating it if needed.
       #
       # @option options [Object] :name
       #   Name of channel to join
@@ -100,7 +101,7 @@ module Slack
       end
 
       #
-      # This method allows a user to remove another member from a team channel.
+      # Removes a user from a channel.
       #
       # @option options [Object] :channel
       #   Channel to remove user from.
@@ -116,7 +117,7 @@ module Slack
       end
 
       #
-      # This method is used to leave a channel.
+      # Leaves a channel.
       #
       # @option options [Object] :channel
       #   Channel to leave
@@ -129,12 +130,16 @@ module Slack
       end
 
       #
-      # This method returns a list of all channels in the team. This includes channels the caller is in, channels they are not currently in, and archived channels but does not include private channels. The number of (non-deactivated) members in each channel is also returned.
+      # 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.
       # @option options [Object] :exclude_archived
       #   Exclude archived channels from the list
       # @option options [Object] :exclude_members
       #   Exclude the members collection from each channel
+      # @option options [Object] :limit
+      #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
       # @see https://api.slack.com/methods/channels.list
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.list.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.list.json
@@ -143,7 +148,7 @@ module Slack
       end
 
       #
-      # This method moves the read cursor in a channel.
+      # Sets the read cursor in a channel.
       #
       # @option options [Object] :channel
       #   Channel to set reading cursor in.
@@ -159,7 +164,7 @@ module Slack
       end
 
       #
-      # This method renames a team channel.
+      # Renames a channel.
       #
       # @option options [Object] :channel
       #   Channel to rename
@@ -177,7 +182,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 channel
       #
       # @option options [Object] :channel
       #   Channel to fetch thread from
@@ -193,7 +198,7 @@ module Slack
       end
 
       #
-      # This method is used to change the purpose of a channel. The calling user must be a member of the channel.
+      # Sets the purpose for a channel.
       #
       # @option options [Object] :channel
       #   Channel to set the purpose of
@@ -209,7 +214,7 @@ module Slack
       end
 
       #
-      # This method is used to change the topic of a channel. The calling user must be a member of the channel.
+      # Sets the topic for a channel.
       #
       # @option options [Object] :channel
       #   Channel to set the topic of
@@ -225,7 +230,7 @@ module Slack
       end
 
       #
-      # This method unarchives a channel. The calling user is added to the channel.
+      # Unarchives a channel.
       #
       # @option options [Object] :channel
       #   Channel to unarchive

data/lib/slack/endpoint/chat.rb

@@ -4,25 +4,41 @@ module Slack
   module Endpoint
     module Chat
       #
-      # This method deletes a message from a channel.
+      # Deletes a message.
       #
-      # @option options [Object] :ts
-      #   Timestamp of the message to be deleted.
       # @option options [Object] :channel
       #   Channel containing the message to be deleted.
+      # @option options [Object] :ts
+      #   Timestamp of the message to be deleted.
       # @option options [Object] :as_user
-      #   Pass true to delete the message as the authed user. Bot users in this context are considered authed users.
+      #   Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
       # @see https://api.slack.com/methods/chat.delete
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.delete.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.delete.json
       def chat_delete(options={})
-        throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
         throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
         post("chat.delete", options)
       end
 
       #
-      # This method sends a me message to a channel from the calling user.
+      # Retrieve a permalink URL for a specific extant message
+      #
+      # @option options [Object] :channel
+      #   The ID of the conversation or channel containing the message
+      # @option options [Object] :message_ts
+      #   A message's ts value, uniquely identifying it within a channel
+      # @see https://api.slack.com/methods/chat.getPermalink
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.getPermalink.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.getPermalink.json
+      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?
+        post("chat.getPermalink", options)
+      end
+
+      #
+      # Share a me message into a channel.
       #
       # @option options [Object] :channel
       #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
@@ -38,34 +54,62 @@ module Slack
       end
 
       #
-      # This method posts a message to a public channel, private channel, or direct message/IM channel.
+      # Sends an ephemeral message to a user in a channel.
       #
       # @option options [Object] :channel
-      #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
+      #   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.
+      # @option options [Object] :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
+      #   Pass true to post the message as the authed bot. Defaults to false.
+      # @option options [Object] :attachments
+      #   A JSON-based array of structured attachments, presented as a URL-encoded string.
+      # @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.
+      # @see https://api.slack.com/methods/chat.postEphemeral
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.postEphemeral.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.postEphemeral.json
+      def chat_postEphemeral(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :text missing") if options[:text].nil?
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        options[:attachments] = options[:attachments].to_json if options[:attachments].is_a?(Array) || options[:attachments].is_a?(Hash)
+        post("chat.postEphemeral", options)
+      end
+
+      #
+      # Sends a message to a channel.
+      #
+      # @option options [Object] :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.
+      # @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.
+      # @option options [Object] :attachments
+      #   A JSON-based array of structured attachments, 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.
+      # @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.
       # @option options [Object] :link_names
       #   Find and link channel names and usernames.
-      # @option options [Object] :attachments
-      #   Structured message attachments.
+      # @option options [Object] :parse
+      #   Change how messages are treated. Defaults to none. See below.
+      # @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
+      #   Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
       # @option options [Object] :unfurl_links
       #   Pass true to enable unfurling of primarily text-based content.
       # @option options [Object] :unfurl_media
       #   Pass false to disable unfurling of media content.
       # @option options [Object] :username
       #   Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
-      # @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.
-      # @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.
-      # @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.
-      # @option options [Object] :thread_ts
-      #   Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
-      # @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.
       # @see https://api.slack.com/methods/chat.postMessage
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.postMessage.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.postMessage.json
@@ -77,16 +121,20 @@ 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 [Object] :channel
       #   Channel ID of the message
       # @option options [Object] :ts
-      #   Timestamp of the message to add unfurl behavior to
+      #   Timestamp of the message to add unfurl behavior to.
       # @option options [Object] :unfurls
-      #   JSON mapping a set of URLs from the message to their unfurl attachments
+      #   URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments.
+      # @option options [Object] :user_auth_message
+      #   Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
       # @option options [Object] :user_auth_required
       #   Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain
+      # @option options [Object] :user_auth_url
+      #   Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
       # @see https://api.slack.com/methods/chat.unfurl
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.unfurl.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.unfurl.json
@@ -98,29 +146,29 @@ 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 [Object] :ts
-      #   Timestamp of the message to be updated.
       # @option options [Object] :channel
       #   Channel containing the message to be updated.
       # @option options [Object] :text
-      #   New text for the message, using the default formatting rules.
+      #   New text for the message, using the default formatting rules. It's not required when presenting attachments.
+      # @option options [Object] :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
-      #   Structured message attachments.
-      # @option options [Object] :parse
-      #   Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
+      #   A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.
       # @option options [Object] :link_names
       #   Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.
-      # @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] :parse
+      #   Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
       # @see https://api.slack.com/methods/chat.update
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.update.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/chat.update.json
       def chat_update(options={})
-        throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
         throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
         throw ArgumentError.new("Required arguments :text missing") if options[:text].nil?
+        throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
         options[:attachments] = options[:attachments].to_json if options[:attachments].is_a?(Array) || options[:attachments].is_a?(Hash)
         post("chat.update", options)
       end