slack-web-api 0.0.1

data/lib/slack/endpoint/pins.rb

@@ -0,0 +1,64 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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 [Object] :channel
+      #   Channel to pin the item in.
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/pins.add.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/pins.add.json
+      def pins_add(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("pins.add", options)
+      end
+
+      #
+      # This method lists the items pinned to a channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to get pinned items for.
+      # @see https://api.slack.com/methods/pins.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/pins.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/pins.list.json
+      def pins_list(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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 [Object] :channel
+      #   Channel where the item is pinned to.
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/pins.remove.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/pins.remove.json
+      def pins_remove(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("pins.remove", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/presence.rb

@@ -0,0 +1,22 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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/aki017/slack-api-docs/blob/master/methods/presence.set.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/presence.set.json
+      def presence_set(options={})
+        throw ArgumentError.new("Required arguments :presence missing") if options[:presence].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("presence.set", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/reactions.rb

@@ -0,0 +1,94 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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 [Object] :file
+      #   File to add reaction to.
+      # @option options [Object] :file_comment
+      #   File comment to add reaction to.
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/reactions.add.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.add.json
+      def reactions_add(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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 [Object] :file
+      #   File to get reactions for.
+      # @option options [Object] :file_comment
+      #   File comment to get reactions for.
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/reactions.get.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.get.json
+      def reactions_get(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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 [Object] :user
+      #   Show reactions made by this user. Defaults to the authed user.
+      # @option options [Object] :full
+      #   If true always return the complete reaction list.
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
+      # @see https://api.slack.com/methods/reactions.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.list.json
+      def reactions_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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 [Object] :file
+      #   File to remove reaction from.
+      # @option options [Object] :file_comment
+      #   File comment to remove reaction from.
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/reactions.remove.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/reactions.remove.json
+      def reactions_remove(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("reactions.remove", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/search.rb

@@ -0,0 +1,80 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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).
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
+      # @see https://api.slack.com/methods/search.all
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.all.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.all.json
+      def search_all(options={})
+        throw ArgumentError.new("Required arguments :query missing") if options[:query].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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).
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
+      # @see https://api.slack.com/methods/search.files
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.files.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.files.json
+      def search_files(options={})
+        throw ArgumentError.new("Required arguments :query missing") if options[:query].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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).
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
+      # @see https://api.slack.com/methods/search.messages
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.messages.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/search.messages.json
+      def search_messages(options={})
+        throw ArgumentError.new("Required arguments :query missing") if options[:query].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("search.messages", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/stars.rb

@@ -0,0 +1,65 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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 [Object] :file
+      #   File to add star to.
+      # @option options [Object] :file_comment
+      #   File comment to add star to.
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/stars.add.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/stars.add.json
+      def stars_add(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("stars.add", options)
+      end
+
+      #
+      # This method lists the items starred by a user.
+      #
+      # @option options [Object] :user
+      #   Show stars by this user. Defaults to the authed user.
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
+      # @see https://api.slack.com/methods/stars.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/stars.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/stars.list.json
+      def stars_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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 [Object] :file
+      #   File to remove star from.
+      # @option options [Object] :file_comment
+      #   File comment to remove star from.
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/stars.remove.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/stars.remove.json
+      def stars_remove(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("stars.remove", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/team.rb

@@ -0,0 +1,57 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Team
+      #
+      # This method is used to get the access logs for users on a team.
+      #
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
+      # @see https://api.slack.com/methods/team.accessLogs
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.accessLogs.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.accessLogs.json
+      def team_accessLogs(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("team.accessLogs", options)
+      end
+
+      #
+      # This method provides information about your team.
+      #
+      # @see https://api.slack.com/methods/team.info
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.info.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.info.json
+      def team_info(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("team.info", options)
+      end
+
+      #
+      # This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.
+      #
+      # @option options [Object] :service_id
+      #   Filter logs to this service. Defaults to all logs.
+      # @option options [Object] :app_id
+      #   Filter logs to this API application. Defaults to all logs.
+      # @option options [Object] :user
+      #   Filter logs generated by this user’s actions. Defaults to all logs.
+      # @option options [Object] :change_type
+      #   Filter logs with this change type. Defaults to all logs.
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
+      # @see https://api.slack.com/methods/team.integrationLogs
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.integrationLogs.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/team.integrationLogs.json
+      def team_integrationLogs(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("team.integrationLogs", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/usergroups.rb

@@ -0,0 +1,122 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Usergroups
+      #
+      # This method is used to create a user group.
+      #
+      # @option options [Object] :name
+      #   A name for the user group. Must be unique among user groups.
+      # @option options [Object] :handle
+      #   A mention handle. Must be unique among channels, users and user groups.
+      # @option options [Object] :description
+      #   A short description of the user group.
+      # @option options [Object] :channels
+      #   A comma separated string of encoded channel IDs for which the user group uses as a default.
+      # @option options [Object] :include_count
+      #   Include the number of users in each user group.
+      # @see https://api.slack.com/methods/usergroups.create
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.create.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.create.json
+      def usergroups_create(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("usergroups.create", options)
+      end
+
+      #
+      # This method disables an existing user group.
+      #
+      # @option options [Object] :usergroup
+      #   The encoded ID of the user group to disable.
+      # @option options [Object] :include_count
+      #   Include the number of users in the user group.
+      # @see https://api.slack.com/methods/usergroups.disable
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.disable.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.disable.json
+      def usergroups_disable(options={})
+        throw ArgumentError.new("Required arguments :usergroup missing") if options[:usergroup].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("usergroups.disable", options)
+      end
+
+      #
+      # This method enables a user group which was previously disabled.
+      #
+      # @option options [Object] :usergroup
+      #   The encoded ID of the user group to enable.
+      # @option options [Object] :include_count
+      #   Include the number of users in the user group.
+      # @see https://api.slack.com/methods/usergroups.enable
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.enable.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.enable.json
+      def usergroups_enable(options={})
+        throw ArgumentError.new("Required arguments :usergroup missing") if options[:usergroup].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("usergroups.enable", options)
+      end
+
+      #
+      # This method returns a list of all user groups in the team. This can optionally include disabled user groups.
+      #
+      # @option options [Object] :include_disabled
+      #   Include disabled user groups.
+      # @option options [Object] :include_count
+      #   Include the number of users in each user group.
+      # @option options [Object] :include_users
+      #   Include the list of users for each user group.
+      # @see https://api.slack.com/methods/usergroups.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.list.json
+      def usergroups_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("usergroups.list", options)
+      end
+
+      #
+      # This method updates the properties of an existing user group.
+      #
+      # @option options [Object] :usergroup
+      #   The encoded ID of the user group to update.
+      # @option options [Object] :name
+      #   A name for the user group. Must be unique among user groups.
+      # @option options [Object] :handle
+      #   A mention handle. Must be unique among channels, users and user groups.
+      # @option options [Object] :description
+      #   A short description of the user group.
+      # @option options [Object] :channels
+      #   A comma separated string of encoded channel IDs for which the user group uses as a default.
+      # @option options [Object] :include_count
+      #   Include the number of users in the user group.
+      # @see https://api.slack.com/methods/usergroups.update
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.update.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.update.json
+      def usergroups_update(options={})
+        throw ArgumentError.new("Required arguments :usergroup missing") if options[:usergroup].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("usergroups.update", options)
+      end
+
+      #
+      # This method updates the list of users that belong to a user group. This method replaces all users in a user group with the list of users provided in the users parameter.
+      #
+      # @option options [Object] :usergroup
+      #   The encoded ID of the user group to update.
+      # @option options [Object] :users
+      #   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.
+      # @see https://api.slack.com/methods/usergroups.users
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.users.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/usergroups.users.json
+      def usergroups_users(options={})
+        throw ArgumentError.new("Required arguments :usergroup missing") if options[:usergroup].nil?
+        throw ArgumentError.new("Required arguments :users missing") if options[:users].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("usergroups.users", options)
+      end
+
+    end
+  end
+end