slack-api 0.0.4 → 1.0.0

data/lib/slack/endpoint/chat.rb

@@ -0,0 +1,75 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Chat
+      #
+      # Deletes a message.
+      #
+      # @option options [Object] :ts
+      #   Timestamp of the message to be deleted.
+      # @option options [channel] :channel
+      #   Channel containing the message to be deleted.
+      # @see https://api.slack.com/methods/chat.delete
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.delete.md
+      # @see https://github.com/slackhq/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?
+        post("chat.delete", options)
+      end
+
+      #
+      # Sends a message to a channel.
+      #
+      # @option options [channel] :channel
+      #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+      # @option options [Object] :text
+      #   Text of the message to send. See below for an explanation of formatting.
+      # @option options [Object] :username
+      #   Name of 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/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.md
+      # @see https://github.com/slackhq/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?
+        post("chat.postMessage", options)
+      end
+
+      #
+      # Updates a message.
+      #
+      # @option options [Object] :ts
+      #   Timestamp of the message to be updated.
+      # @option options [channel] :channel
+      #   Channel containing the message to be updated.
+      # @option options [Object] :text
+      #   New text for the message, using the [default formatting rules](/docs/formatting).
+      # @see https://api.slack.com/methods/chat.update
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.update.md
+      # @see https://github.com/slackhq/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?
+        post("chat.update", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/emoji.rb

@@ -0,0 +1,18 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Emoji
+      #
+      # Lists custom emoji for a team.
+      #
+      # @see https://api.slack.com/methods/emoji.list
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/emoji.list.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/emoji.list.json
+      def emoji_list(options={})
+        post("emoji.list", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/files.rb

@@ -0,0 +1,73 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Files
+      #
+      # Gets information about a team file.
+      #
+      # @option options [file] :file
+      #   File to fetch info for
+      # @see https://api.slack.com/methods/files.info
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.info.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.info.json
+      def files_info(options={})
+        throw ArgumentError.new("Required arguments :file missing") if options[:file].nil?
+        post("files.info", options)
+      end
+
+      #
+      # Lists & filters team files.
+      #
+      # @option options [user] :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.
+      # @see https://api.slack.com/methods/files.list
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.list.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.list.json
+      def files_list(options={})
+        post("files.list", options)
+      end
+
+      #
+      # Uploads or creates a 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 [channel] :channels
+      #   Comma separated list of channels to share the file into.
+      # @see https://api.slack.com/methods/files.upload
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.upload.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/files.upload.json
+      def files_upload(options={})
+        post("files.upload", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/groups.rb

@@ -0,0 +1,226 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Groups
+      #
+      # Archives a private group.
+      #
+      # @option options [group] :channel
+      #   Private group to archive
+      # @see https://api.slack.com/methods/groups.archive
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.archive.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.archive.json
+      def groups_archive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("groups.archive", options)
+      end
+
+      #
+      # Closes a private group.
+      #
+      # @option options [group] :channel
+      #   Group to open.
+      # @see https://api.slack.com/methods/groups.close
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.close.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.close.json
+      def groups_close(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("groups.close", options)
+      end
+
+      #
+      # Creates a private group.
+      #
+      # @option options [Object] :name
+      #   Name of group to create
+      # @see https://api.slack.com/methods/groups.create
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.create.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.create.json
+      def groups_create(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        post("groups.create", options)
+      end
+
+      #
+      # Clones and archives a private group.
+      #
+      # @option options [group] :channel
+      #   Group to clone and archive.
+      # @see https://api.slack.com/methods/groups.createChild
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.createChild.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.createChild.json
+      def groups_createChild(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("groups.createChild", options)
+      end
+
+      #
+      # Fetches history of messages and events from a private group.
+      #
+      # @option options [group] :channel
+      #   Group to fetch history for.
+      # @option options [timestamp] :latest
+      #   Latest message timestamp to include in results.
+      # @option options [timestamp] :oldest
+      #   Oldest message timestamp to include in results.
+      # @option options [Object] :count
+      #   Number of messages to return, between 1 and 1000.
+      # @see https://api.slack.com/methods/groups.history
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.history.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.history.json
+      def groups_history(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("groups.history", options)
+      end
+
+      #
+      # Invites a user to a private group.
+      #
+      # @option options [group] :channel
+      #   Private group to invite user to.
+      # @option options [user] :user
+      #   User to invite.
+      # @see https://api.slack.com/methods/groups.invite
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.invite.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.invite.json
+      def groups_invite(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        post("groups.invite", options)
+      end
+
+      #
+      # Removes a user from a private group.
+      #
+      # @option options [group] :channel
+      #   Group to remove user from.
+      # @option options [user] :user
+      #   User to remove from group.
+      # @see https://api.slack.com/methods/groups.kick
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.kick.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.kick.json
+      def groups_kick(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        post("groups.kick", options)
+      end
+
+      #
+      # Leaves a private group.
+      #
+      # @option options [group] :channel
+      #   Group to leave
+      # @see https://api.slack.com/methods/groups.leave
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.leave.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.leave.json
+      def groups_leave(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("groups.leave", options)
+      end
+
+      #
+      # Lists private groups that the calling user has access to.
+      #
+      # @option options [Object] :exclude_archived
+      #   Don't return archived groups.
+      # @see https://api.slack.com/methods/groups.list
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.list.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.list.json
+      def groups_list(options={})
+        post("groups.list", options)
+      end
+
+      #
+      # Sets the read cursor in a private group.
+      #
+      # @option options [group] :channel
+      #   Group to set reading cursor in.
+      # @option options [timestamp] :ts
+      #   Timestamp of the most recently seen message.
+      # @see https://api.slack.com/methods/groups.mark
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.mark.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.mark.json
+      def groups_mark(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
+        post("groups.mark", options)
+      end
+
+      #
+      # Opens a private group.
+      #
+      # @option options [group] :channel
+      #   Group to open.
+      # @see https://api.slack.com/methods/groups.open
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.open.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.open.json
+      def groups_open(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("groups.open", options)
+      end
+
+      #
+      # Renames a private group.
+      #
+      # @option options [channel] :channel
+      #   Group to rename
+      # @option options [Object] :name
+      #   New name for group.
+      # @see https://api.slack.com/methods/groups.rename
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.rename.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.rename.json
+      def groups_rename(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        post("groups.rename", options)
+      end
+
+      #
+      # Sets the purpose for a private group.
+      #
+      # @option options [channel] :channel
+      #   Private group to set the purpose of
+      # @option options [Object] :purpose
+      #   The new purpose
+      # @see https://api.slack.com/methods/groups.setPurpose
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setPurpose.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setPurpose.json
+      def groups_setPurpose(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :purpose missing") if options[:purpose].nil?
+        post("groups.setPurpose", options)
+      end
+
+      #
+      # Sets the topic for a private group.
+      #
+      # @option options [channel] :channel
+      #   Private group to set the topic of
+      # @option options [Object] :topic
+      #   The new topic
+      # @see https://api.slack.com/methods/groups.setTopic
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setTopic.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.setTopic.json
+      def groups_setTopic(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :topic missing") if options[:topic].nil?
+        post("groups.setTopic", options)
+      end
+
+      #
+      # Unarchives a private group.
+      #
+      # @option options [group] :channel
+      #   Group to unarchive
+      # @see https://api.slack.com/methods/groups.unarchive
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.unarchive.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/groups.unarchive.json
+      def groups_unarchive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("groups.unarchive", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/im.rb

@@ -0,0 +1,79 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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/slackhq/slack-api-docs/blob/master/methods/im.close.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.close.json
+      def im_close(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        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 [timestamp] :latest
+      #   Latest message timestamp to include in results.
+      # @option options [timestamp] :oldest
+      #   Oldest message timestamp to include in results.
+      # @option options [Object] :count
+      #   Number of messages to return, between 1 and 1000.
+      # @see https://api.slack.com/methods/im.history
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.history.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.history.json
+      def im_history(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("im.history", options)
+      end
+
+      #
+      # Lists direct message channels for the calling user.
+      #
+      # @see https://api.slack.com/methods/im.list
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.list.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.list.json
+      def im_list(options={})
+        post("im.list", options)
+      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/slackhq/slack-api-docs/blob/master/methods/im.mark.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/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?
+        post("im.mark", options)
+      end
+
+      #
+      # Opens a direct message channel.
+      #
+      # @option options [user] :user
+      #   User to open a direct message channel with.
+      # @see https://api.slack.com/methods/im.open
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.open.md
+      # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/im.open.json
+      def im_open(options={})
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        post("im.open", options)
+      end
+
+    end
+  end
+end