slack-web-api 0.0.1

data/lib/slack/endpoint/auth.rb

@@ -0,0 +1,19 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Auth
+      #
+      # This method checks authentication and tells you who you are.
+      #
+      # @see https://api.slack.com/methods/auth.test
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/auth.test.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/auth.test.json
+      def auth_test(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("auth.test", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/channels.rb

@@ -0,0 +1,236 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Channels
+      #
+      # This method archives a channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to archive
+      # @see https://api.slack.com/methods/channels.archive
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.archive.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.archive.json
+      def channels_archive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.archive", options)
+      end
+
+      #
+      # This method is used to create a channel.
+      #
+      # @option options [Object] :name
+      #   Name of channel to create
+      # @see https://api.slack.com/methods/channels.create
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.create.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.create.json
+      def channels_create(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.create", options)
+      end
+
+      #
+      # This method returns a portion of messages/events from the specified channel.
+      # To read the entire history for a channel, call the method with no latest or
+      # oldest arguments, and then continue paging using the instructions below.
+      #
+      # @option options [Object] :channel
+      #   Channel to fetch history for.
+      # @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
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.history.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.history.json
+      def channels_history(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.history", options)
+      end
+
+      #
+      # This method returns information about a team channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to get info on
+      # @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
+      def channels_info(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.info", options)
+      end
+
+      #
+      # This method is used to invite a user to a channel. The calling user must be a member of the channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to invite user to.
+      # @option options [Object] :user
+      #   User to invite to channel.
+      # @see https://api.slack.com/methods/channels.invite
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.invite.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.invite.json
+      def channels_invite(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.invite", options)
+      end
+
+      #
+      # This method is used to join a channel. If the channel does not exist, it is
+      # created.
+      #
+      # @option options [Object] :name
+      #   Name of channel to join
+      # @see https://api.slack.com/methods/channels.join
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.join.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.join.json
+      def channels_join(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.join", options)
+      end
+
+      #
+      # This method allows a user to remove another member from a team channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to remove user from.
+      # @option options [Object] :user
+      #   User to remove from channel.
+      # @see https://api.slack.com/methods/channels.kick
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.kick.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.kick.json
+      def channels_kick(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.kick", options)
+      end
+
+      #
+      # This method is used to leave a channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to leave
+      # @see https://api.slack.com/methods/channels.leave
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.leave.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.leave.json
+      def channels_leave(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.leave", options)
+      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. The number of (non-deactivated) members in each channel
+      # is also returned.
+      #
+      # @option options [Object] :exclude_archived
+      #   Don't return archived channels.
+      # @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
+      def channels_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.list", options)
+      end
+
+      #
+      # This method moves the read cursor in a channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to set reading cursor in.
+      # @option options [Object] :ts
+      #   Timestamp of the most recently seen message.
+      # @see https://api.slack.com/methods/channels.mark
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.mark.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.mark.json
+      def channels_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[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.mark", options)
+      end
+
+      #
+      # This method renames a team channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to rename
+      # @option options [Object] :name
+      #   New name for channel.
+      # @see https://api.slack.com/methods/channels.rename
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.rename.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.rename.json
+      def channels_rename(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.rename", options)
+      end
+
+      #
+      # This method is used to change the purpose of a channel. The calling user must be a member of the channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to set the purpose of
+      # @option options [Object] :purpose
+      #   The new purpose
+      # @see https://api.slack.com/methods/channels.setPurpose
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.setPurpose.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.setPurpose.json
+      def channels_setPurpose(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :purpose missing") if options[:purpose].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.setPurpose", options)
+      end
+
+      #
+      # This method is used to change the topic of a channel. The calling user must be a member of the channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to set the topic of
+      # @option options [Object] :topic
+      #   The new topic
+      # @see https://api.slack.com/methods/channels.setTopic
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.setTopic.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.setTopic.json
+      def channels_setTopic(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :topic missing") if options[:topic].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.setTopic", options)
+      end
+
+      #
+      # This method unarchives a channel. The calling user is added to the channel.
+      #
+      # @option options [Object] :channel
+      #   Channel to unarchive
+      # @see https://api.slack.com/methods/channels.unarchive
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.unarchive.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/channels.unarchive.json
+      def channels_unarchive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("channels.unarchive", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/chat.rb

@@ -0,0 +1,86 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Chat
+      #
+      # This method deletes a message from a channel.
+      #
+      # @option options [Object] :ts
+      #   Timestamp of the message to be deleted.
+      # @option options [Object] :channel
+      #   Channel containing the message to be deleted.
+      # @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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("chat.delete", options)
+      end
+
+      #
+      # This method posts a message to a public channel, private group, or IM 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.
+      # @option options [Object] :username
+      #   Name of bot.
+      # @option options [Object] :as_user
+      #   Pass true to post the message as the authed user, instead of as a bot
+      # @option options [Object] :parse
+      #   Change how messages are treated. See below.
+      # @option options [Object] :link_names
+      #   Find and link channel names and usernames.
+      # @option options [Object] :attachments
+      #   Structured message attachments.
+      # @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] :icon_url
+      #   URL to an image to use as the icon for this message
+      # @option options [Object] :icon_emoji
+      #   emoji to use as the icon for this message. Overrides icon_url.
+      # @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
+      def chat_postMessage(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :text missing") if options[:text].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("chat.postMessage", options)
+      end
+
+      #
+      # This method updates a message in a channel.
+      #
+      # @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.
+      # @option options [Object] :attachments
+      #   Structured message attachments.
+      # @option options [Object] :parse
+      #   Change how messages are treated. See below.
+      # @option options [Object] :link_names
+      #   Find and link channel names and usernames.
+      # @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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("chat.update", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/emoji.rb

@@ -0,0 +1,19 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Emoji
+      #
+      # This method lists the custom emoji for a team.
+      #
+      # @see https://api.slack.com/methods/emoji.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/emoji.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/emoji.list.json
+      def emoji_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("emoji.list", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/files.rb

@@ -0,0 +1,100 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Files
+      #
+      # This method deletes a file from your team.
+      #
+      # @option options [Object] :file
+      #   ID of file to delete.
+      # @see https://api.slack.com/methods/files.delete
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.delete.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.delete.json
+      def files_delete(options={})
+        throw ArgumentError.new("Required arguments :file missing") if options[:file].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("files.delete", options)
+      end
+
+      #
+      # This method returns information about a file in your team.
+      #
+      # @option options [Object] :file
+      #   File to fetch info for
+      # @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/files.info
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.info.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.info.json
+      def files_info(options={})
+        throw ArgumentError.new("Required arguments :file missing") if options[:file].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("files.info", options)
+      end
+
+      #
+      # This method returns a list of files within the team. It can be filtered and sliced in various ways.
+      #
+      # @option options [Object] :user
+      #   Filter files created by a single user.
+      # @option options [Object] :ts_from
+      #   Filter files created after this timestamp (inclusive).
+      # @option options [Object] :ts_to
+      #   Filter files created before this timestamp (inclusive).
+      # @option options [Object] :types
+      #   Filter files by type:
+      #   
+      #   
+      #   all - All files
+      #   posts - Posts
+      #   snippets - Snippets
+      #   images - Image files
+      #   gdocs - Google docs
+      #   zips - Zip files
+      #   pdfs - PDF files
+      #   
+      #   
+      #   You can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the 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/files.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.list.json
+      def files_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("files.list", options)
+      end
+
+      #
+      # This method allows you to create or upload an existing file.
+      #
+      # @option options [Object] :file
+      #   File contents via multipart/form-data.
+      # @option options [Object] :content
+      #   File contents via a POST var.
+      # @option options [Object] :filetype
+      #   Slack-internal file type identifier.
+      # @option options [Object] :filename
+      #   Filename of file.
+      # @option options [Object] :title
+      #   Title of file.
+      # @option options [Object] :initial_comment
+      #   Initial comment to add to file.
+      # @option options [Object] :channels
+      #   Comma separated list of channels to share the file into.
+      # @see https://api.slack.com/methods/files.upload
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.upload.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.upload.json
+      def files_upload(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("files.upload", options)
+      end
+
+    end
+  end
+end