slack-ruby-client 0.14.5 → 0.17.0

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

@@ -6,107 +6,6 @@ module Slack
     module Api
       module Endpoints
         module Im
-          #
-          # Close a direct message channel.
-          #
-          # @option options [im] :channel
-          #   Direct message channel to close.
-          # @see https://api.slack.com/methods/im.close
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.close.json
-          def im_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]
-            post('im.close', options)
-          end
-
-          #
-          # Fetches history of messages and events from direct message channel.
-          #
-          # @option options [im] :channel
-          #   Direct message channel to fetch history for.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
-          # @option options [timestamp] :latest
-          #   End of time range of messages to include in results.
-          # @option options [timestamp] :oldest
-          #   Start of time range of messages to include in results.
-          # @option options [Object] :unreads
-          #   Include unread_count_display in the output?.
-          # @see https://api.slack.com/methods/im.history
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.history.json
-          def im_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]
-            post('im.history', options)
-          end
-
-          #
-          # Lists direct message channels for the calling user.
-          #
-          # @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. 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/im.list
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.list.json
-          def im_list(options = {})
-            if block_given?
-              Pagination::Cursor.new(self, :im_list, options).each do |page|
-                yield page
-              end
-            else
-              post('im.list', options)
-            end
-          end
-
-          #
-          # Sets the read cursor in a direct message channel.
-          #
-          # @option options [im] :channel
-          #   Direct message channel to set reading cursor in.
-          # @option options [timestamp] :ts
-          #   Timestamp of the most recently seen message.
-          # @see https://api.slack.com/methods/im.mark
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.mark.json
-          def im_mark(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]
-            post('im.mark', options)
-          end
-
-          #
-          # Opens a direct message channel.
-          #
-          # @option options [user] :user
-          #   User to open a direct message channel with.
-          # @option options [Object] :include_locale
-          #   Set this to true to receive the locale for this im. Defaults to false.
-          # @option options [Object] :return_im
-          #   Boolean, indicates you want the full IM channel definition in the response.
-          # @see https://api.slack.com/methods/im.open
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.open.json
-          def im_open(options = {})
-            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
-            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-            post('im.open', options)
-          end
-
-          #
-          # Retrieve a thread of messages posted to a direct message conversation
-          #
-          # @option options [im] :channel
-          #   Direct message channel to fetch thread from.
-          # @option options [Object] :thread_ts
-          #   Unique identifier of a thread's parent message.
-          # @see https://api.slack.com/methods/im.replies
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/im/im.replies.json
-          def im_replies(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :thread_ts missing') if options[:thread_ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('im.replies', options)
-          end
         end
       end
     end

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

@@ -11,6 +11,8 @@ module Slack
           #
           # @option options [Object] :users
           #   A comma-separated list of user ids, up to 400 per request.
+          # @option options [Object] :team_id
+          #   Specify team_id starts with T in case of Org Token.
           # @option options [Object] :to_old
           #   Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.
           # @see https://api.slack.com/methods/migration.exchange

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

@@ -6,102 +6,6 @@ module Slack
     module Api
       module Endpoints
         module Mpim
-          #
-          # Closes a multiparty direct message channel.
-          #
-          # @option options [channel] :channel
-          #   MPIM to close.
-          # @see https://api.slack.com/methods/mpim.close
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.close.json
-          def mpim_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]
-            post('mpim.close', options)
-          end
-
-          #
-          # Fetches history of messages and events from a multiparty direct message.
-          #
-          # @option options [channel] :channel
-          #   Multiparty direct message to fetch history for.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
-          # @option options [timestamp] :latest
-          #   End of time range of messages to include in results.
-          # @option options [timestamp] :oldest
-          #   Start of time range of messages to include in results.
-          # @option options [Object] :unreads
-          #   Include unread_count_display in the output?.
-          # @see https://api.slack.com/methods/mpim.history
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.history.json
-          def mpim_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]
-            post('mpim.history', options)
-          end
-
-          #
-          # Lists multiparty direct message channels for the calling user.
-          #
-          # @option options [Object] :cursor
-          #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
-          # @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 list hasn't been reached.
-          # @see https://api.slack.com/methods/mpim.list
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.list.json
-          def mpim_list(options = {})
-            if block_given?
-              Pagination::Cursor.new(self, :mpim_list, options).each do |page|
-                yield page
-              end
-            else
-              post('mpim.list', options)
-            end
-          end
-
-          #
-          # Sets the read cursor in a multiparty direct message channel.
-          #
-          # @option options [channel] :channel
-          #   multiparty direct message channel to set reading cursor in.
-          # @option options [timestamp] :ts
-          #   Timestamp of the most recently seen message.
-          # @see https://api.slack.com/methods/mpim.mark
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.mark.json
-          def mpim_mark(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]
-            post('mpim.mark', options)
-          end
-
-          #
-          # This method opens a multiparty direct message.
-          #
-          # @option options [Object] :users
-          #   Comma separated lists of users.  The ordering of the users is preserved whenever a MPIM group is returned.
-          # @see https://api.slack.com/methods/mpim.open
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.open.json
-          def mpim_open(options = {})
-            throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
-            post('mpim.open', options)
-          end
-
-          #
-          # Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.
-          #
-          # @option options [channel] :channel
-          #   Multiparty direct message channel to fetch thread from.
-          # @option options [Object] :thread_ts
-          #   Unique identifier of a thread's parent message.
-          # @see https://api.slack.com/methods/mpim.replies
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.replies.json
-          def mpim_replies(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :thread_ts missing') if options[:thread_ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('mpim.replies', options)
-          end
         end
       end
     end

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

@@ -18,13 +18,10 @@ module Slack
           # @option options [Object] :redirect_uri
           #   This must match the originally submitted URI (if one was sent).
           # @option options [Object] :single_channel
-          #   Request the user to add your app only to a single channel.
+          #   Request the user to add your app only to a single channel. Only valid with a legacy workspace app.
           # @see https://api.slack.com/methods/oauth.access
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/oauth/oauth.access.json
           def oauth_access(options = {})
-            throw ArgumentError.new('Required arguments :client_id missing') if options[:client_id].nil?
-            throw ArgumentError.new('Required arguments :client_secret missing') if options[:client_secret].nil?
-            throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
             post('oauth.access', options)
           end
 

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

@@ -17,8 +17,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/pins/pins.add.json
           def pins_add(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :timestamp missing') if options[:timestamp].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('pins.add', options)
           end
 
@@ -31,7 +30,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/pins/pins.list.json
           def pins_list(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('pins.list', options)
           end
 
@@ -40,17 +39,13 @@ module Slack
           #
           # @option options [channel] :channel
           #   Channel where the item is pinned to.
-          # @option options [file] :file
-          #   File to un-pin.
-          # @option options [Object] :file_comment
-          #   File comment to un-pin.
           # @option options [Object] :timestamp
           #   Timestamp of the message to un-pin.
           # @see https://api.slack.com/methods/pins.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/pins/pins.remove.json
           def pins_remove(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('pins.remove', options)
           end
         end

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

@@ -21,7 +21,7 @@ module Slack
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
             throw ArgumentError.new('Required arguments :timestamp missing') if options[:timestamp].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('reactions.add', options)
           end
 
@@ -41,7 +41,7 @@ module Slack
           # @see https://api.slack.com/methods/reactions.get
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.get.json
           def reactions_get(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('reactions.get', options)
           end
 
@@ -54,6 +54,8 @@ module Slack
           #   If true always return the complete reaction list.
           # @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 list hasn't been reached.
+          # @option options [Object] :team_id
+          #   encoded team id to list reactions in, required if org token is used.
           # @option options [user] :user
           #   Show reactions made by this user. Defaults to the authed user.
           # @see https://api.slack.com/methods/reactions.list
@@ -86,7 +88,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.remove.json
           def reactions_remove(options = {})
             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('reactions.remove', options)
           end
         end

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

@@ -17,6 +17,8 @@ module Slack
           #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
+          # @option options [Object] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.all
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.all.json
           def search_all(options = {})
@@ -35,6 +37,8 @@ module Slack
           #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
+          # @option options [Object] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.files
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.files.json
           def search_files(options = {})
@@ -53,6 +57,8 @@ module Slack
           #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
+          # @option options [Object] :team_id
+          #   encoded team id to search in, required if org token is used.
           # @see https://api.slack.com/methods/search.messages
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/search/search.messages.json
           def search_messages(options = {})

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

@@ -20,7 +20,7 @@ module Slack
           # @see https://api.slack.com/methods/stars.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.add.json
           def stars_add(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('stars.add', options)
           end
 
@@ -57,7 +57,7 @@ module Slack
           # @see https://api.slack.com/methods/stars.remove
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.remove.json
           def stars_remove(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('stars.remove', options)
           end
         end

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

@@ -11,6 +11,8 @@ module Slack
           #
           # @option options [Object] :before
           #   End of time range of logs to include in results (inclusive).
+          # @option options [Object] :team_id
+          #   encoded team id to get logs from, required if org token is used.
           # @see https://api.slack.com/methods/team.accessLogs
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.accessLogs.json
           def team_accessLogs(options = {})
@@ -20,6 +22,8 @@ module Slack
           #
           # Gets billable users information for the current team.
           #
+          # @option options [Object] :team_id
+          #   encoded team id to get the billable information from, required if org token is used.
           # @option options [user] :user
           #   A user to retrieve the billable information for. Defaults to all users.
           # @see https://api.slack.com/methods/team.billableInfo
@@ -49,6 +53,8 @@ module Slack
           #   Filter logs with this change type. Defaults to all logs.
           # @option options [Object] :service_id
           #   Filter logs to this service. Defaults to all logs.
+          # @option options [Object] :team_id
+          #   encoded team id to get logs from, required if org token is used.
           # @option options [user] :user
           #   Filter logs generated by this user's actions. Defaults to all logs.
           # @see https://api.slack.com/methods/team.integrationLogs

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

@@ -19,6 +19,8 @@ module Slack
           #   A mention handle. Must be unique among channels, users and User Groups.
           # @option options [Object] :include_count
           #   Include the number of users in each User Group.
+          # @option options [Object] :team_id
+          #   Encoded team id where the user group has to be created, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.create.json
           def usergroups_create(options = {})
@@ -33,6 +35,8 @@ module Slack
           #   The encoded ID of the User Group to disable.
           # @option options [Object] :include_count
           #   Include the number of users in the User Group.
+          # @option options [Object] :team_id
+          #   Encoded team id where the user group is, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.disable
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.disable.json
           def usergroups_disable(options = {})
@@ -47,6 +51,8 @@ module Slack
           #   The encoded ID of the User Group to enable.
           # @option options [Object] :include_count
           #   Include the number of users in the User Group.
+          # @option options [Object] :team_id
+          #   Encoded team id where the user group is, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.enable
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.enable.json
           def usergroups_enable(options = {})
@@ -63,6 +69,8 @@ module Slack
           #   Include disabled User Groups.
           # @option options [Object] :include_users
           #   Include the list of users for each User Group.
+          # @option options [Object] :team_id
+          #   encoded team id to list user groups in, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.list.json
           def usergroups_list(options = {})
@@ -84,6 +92,8 @@ module Slack
           #   Include the number of users in the User Group.
           # @option options [Object] :name
           #   A name for the User Group. Must be unique among User Groups.
+          # @option options [Object] :team_id
+          #   encoded team id where the user group exists, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
           def usergroups_update(options = {})

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

@@ -13,6 +13,8 @@ module Slack
           #   The encoded ID of the User Group to update.
           # @option options [Object] :include_disabled
           #   Allow results that involve disabled User Groups.
+          # @option options [Object] :team_id
+          #   encoded team id where the user group exists, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.list.json
           def usergroups_users_list(options = {})
@@ -29,6 +31,8 @@ module Slack
           #   A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
           # @option options [Object] :include_count
           #   Include the number of users in the User Group.
+          # @option options [Object] :team_id
+          #   encoded team id where the user group exists, required if org token is used.
           # @see https://api.slack.com/methods/usergroups.users.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.update.json
           def usergroups_users_update(options = {})

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

@@ -15,6 +15,8 @@ module Slack
           #   Set to true to exclude archived channels from the list.
           # @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 list hasn't been reached. Must be an integer no larger than 1000.
+          # @option options [Object] :team_id
+          #   encoded team id to list conversations in, required if org token is used.
           # @option options [Object] :types
           #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
           # @option options [user] :user
@@ -49,7 +51,6 @@ module Slack
           # @see https://api.slack.com/methods/users.getPresence
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.getPresence.json
           def users_getPresence(options = {})
-            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.getPresence', options)
           end
@@ -86,7 +87,9 @@ module Slack
           # @option options [Object] :include_locale
           #   Set this to true to receive the locale for users. Defaults to false.
           # @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.
+          #   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. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.
+          # @option options [Object] :team_id
+          #   encoded team id to list users in, required if org token is used.
           # @see https://api.slack.com/methods/users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.list.json
           def users_list(options = {})
@@ -123,18 +126,17 @@ module Slack
           #
           # Set the user profile photo
           #
-          # @option options [Object] :image
-          #   File contents via multipart/form-data.
           # @option options [Object] :crop_w
           #   Width/height of crop box (always square).
           # @option options [Object] :crop_x
           #   X coordinate of top-left corner of crop box.
           # @option options [Object] :crop_y
           #   Y coordinate of top-left corner of crop box.
+          # @option options [Object] :image
+          #   File contents via multipart/form-data.
           # @see https://api.slack.com/methods/users.setPhoto
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setPhoto.json
           def users_setPhoto(options = {})
-            throw ArgumentError.new('Required arguments :image missing') if options[:image].nil?
             post('users.setPhoto', options)
           end