slack-ruby-client-bhe 0.5.4

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

@@ -0,0 +1,84 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Mpim
+          #
+          # This method 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/dblock/slack-api-ref/blob/master/methods/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
+
+          #
+          # This method returns a portion of messages/events from the specified multiparty direct message channel.
+          # To read the entire history for a multiparty direct message, call the method with no latest or
+          # oldest arguments, and then continue paging using the instructions below.
+          #
+          # @option options [channel] :channel
+          #   Multiparty direct message to fetch history for.
+          # @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] :inclusive
+          #   Include messages with latest or oldest timestamp 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/dblock/slack-api-ref/blob/master/methods/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
+
+          #
+          # This method returns a list of all multiparty direct message channels that the user has.
+          #
+          # @see https://api.slack.com/methods/mpim.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim.list.json
+          def mpim_list(options = {})
+            post('mpim.list', options)
+          end
+
+          #
+          # This method moves 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/dblock/slack-api-ref/blob/master/methods/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/dblock/slack-api-ref/blob/master/methods/mpim.open.json
+          def mpim_open(options = {})
+            throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
+            post('mpim.open', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Oauth
+          #
+          # This method allows you to exchange a temporary OAuth code for an API access token.
+          # This is used as part of the OAuth authentication flow.
+          #
+          # @option options [Object] :client_id
+          #   Issued when you created your application.
+          # @option options [Object] :client_secret
+          #   Issued when you created your application.
+          # @option options [Object] :code
+          #   The code param returned via the OAuth callback.
+          # @option options [Object] :redirect_uri
+          #   This must match the originally submitted URI (if one was sent).
+          # @see https://api.slack.com/methods/oauth.access
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Pins
+          #
+          # This method pins an item (file, file comment, channel message, or group message) to a particular channel.
+          # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
+          #
+          # @option options [channel] :channel
+          #   Channel to pin the item in.
+          # @option options [file] :file
+          #   File to pin.
+          # @option options [Object] :file_comment
+          #   File comment to pin.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to pin.
+          # @see https://api.slack.com/methods/pins.add
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/pins.add.json
+          def pins_add(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('pins.add', options)
+          end
+
+          #
+          # This method lists the items pinned to a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to get pinned items for.
+          # @see https://api.slack.com/methods/pins.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/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]
+            post('pins.list', options)
+          end
+
+          #
+          # This method un-pins an item (file, file comment, channel message, or group message) from a channel.
+          # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
+          #
+          # @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/dblock/slack-api-ref/blob/master/methods/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]
+            post('pins.remove', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Presence
+          #
+          # Manually set user presence.
+          #
+          # @option options [Object] :presence
+          #   Either `active` or `away`.
+          # @see https://api.slack.com/methods/presence.set
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/presence.set.json
+          def presence_set(options = {})
+            throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
+            post('presence.set', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Reactions
+          #
+          # This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message).
+          # One of file, file_comment, or the combination of channel and timestamp must be specified.
+          #
+          # @option options [Object] :name
+          #   Reaction (emoji) name.
+          # @option options [file] :file
+          #   File to add reaction to.
+          # @option options [Object] :file_comment
+          #   File comment to add reaction to.
+          # @option options [channel] :channel
+          #   Channel where the message to add reaction to was posted.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to add reaction to.
+          # @see https://api.slack.com/methods/reactions.add
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions.add.json
+          def reactions_add(options = {})
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            post('reactions.add', options)
+          end
+
+          #
+          # This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).
+          #
+          # @option options [file] :file
+          #   File to get reactions for.
+          # @option options [Object] :file_comment
+          #   File comment to get reactions for.
+          # @option options [channel] :channel
+          #   Channel where the message to get reactions for was posted.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to get reactions for.
+          # @option options [Object] :full
+          #   If true always return the complete reaction list.
+          # @see https://api.slack.com/methods/reactions.get
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions.get.json
+          def reactions_get(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            post('reactions.get', options)
+          end
+
+          #
+          # This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.
+          #
+          # @option options [user] :user
+          #   Show reactions made by this user. Defaults to the authed user.
+          # @option options [Object] :full
+          #   If true always return the complete reaction list.
+          # @see https://api.slack.com/methods/reactions.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions.list.json
+          def reactions_list(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            post('reactions.list', options)
+          end
+
+          #
+          # This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).
+          # One of file, file_comment, or the combination of channel and timestamp must be specified.
+          #
+          # @option options [Object] :name
+          #   Reaction (emoji) name.
+          # @option options [file] :file
+          #   File to remove reaction from.
+          # @option options [Object] :file_comment
+          #   File comment to remove reaction from.
+          # @option options [channel] :channel
+          #   Channel where the message to remove reaction from was posted.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to remove reaction from.
+          # @see https://api.slack.com/methods/reactions.remove
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/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]
+            post('reactions.remove', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Rtm
+          #
+          # This method starts a Real Time Messaging API session. Refer to the
+          # RTM API documentation for full details on how to use the RTM API.
+          #
+          # @option options [Object] :simple_latest
+          #   Return timestamp only for latest message object of each channel (improves performance).
+          # @option options [Object] :no_unreads
+          #   Skip unread counts for each channel (improves performance).
+          # @option options [Object] :mpim_aware
+          #   Returns MPIMs to the client in the API response.
+          # @see https://api.slack.com/methods/rtm.start
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/rtm.start.json
+          def rtm_start(options = {})
+            post('rtm.start', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Search
+          #
+          # This method allows to to search both messages and files in a single call.
+          #
+          # @option options [Object] :query
+          #   Search query. May contains booleans, etc.
+          # @option options [Object] :sort
+          #   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] :highlight
+          #   Pass a value of 1 to enable query highlight markers (see below).
+          # @see https://api.slack.com/methods/search.all
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search.all.json
+          def search_all(options = {})
+            throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
+            post('search.all', options)
+          end
+
+          #
+          # This method returns files matching a search query.
+          #
+          # @option options [Object] :query
+          #   Search query. May contain booleans, etc.
+          # @option options [Object] :sort
+          #   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] :highlight
+          #   Pass a value of 1 to enable query highlight markers (see below).
+          # @see https://api.slack.com/methods/search.files
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search.files.json
+          def search_files(options = {})
+            throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
+            post('search.files', options)
+          end
+
+          #
+          # This method returns messages matching a search query.
+          #
+          # @option options [Object] :query
+          #   Search query. May contains booleans, etc.
+          # @option options [Object] :sort
+          #   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] :highlight
+          #   Pass a value of 1 to enable query highlight markers (see below).
+          # @see https://api.slack.com/methods/search.messages
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search.messages.json
+          def search_messages(options = {})
+            throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
+            post('search.messages', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Stars
+          #
+          # This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
+          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+          #
+          # @option options [file] :file
+          #   File to add star to.
+          # @option options [Object] :file_comment
+          #   File comment to add star to.
+          # @option options [channel] :channel
+          #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to add star to.
+          # @see https://api.slack.com/methods/stars.add
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars.add.json
+          def stars_add(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            post('stars.add', options)
+          end
+
+          #
+          # This method lists the items starred by a user.
+          #
+          # @option options [user] :user
+          #   Show stars by this user. Defaults to the authed user.
+          # @see https://api.slack.com/methods/stars.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars.list.json
+          def stars_list(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            post('stars.list', options)
+          end
+
+          #
+          # This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
+          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
+          #
+          # @option options [file] :file
+          #   File to remove star from.
+          # @option options [Object] :file_comment
+          #   File comment to remove star from.
+          # @option options [channel] :channel
+          #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to remove star from.
+          # @see https://api.slack.com/methods/stars.remove
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars.remove.json
+          def stars_remove(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            post('stars.remove', options)
+          end
+        end
+      end
+    end
+  end
+end