slack-web-api 0.0.1

data/lib/slack/endpoint/groups.rb

@@ -0,0 +1,262 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Groups
+      #
+      # This method archives a private group.
+      #
+      # @option options [Object] :channel
+      #   Private group to archive
+      # @see https://api.slack.com/methods/groups.archive
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.archive.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.archive.json
+      def groups_archive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.archive", options)
+      end
+
+      #
+      # This method closes a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to close.
+      # @see https://api.slack.com/methods/groups.close
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.close.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.close.json
+      def groups_close(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.close", options)
+      end
+
+      #
+      # This method 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/aki017/slack-api-docs/blob/master/methods/groups.create.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.create.json
+      def groups_create(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.create", options)
+      end
+
+      #
+      # This method takes an existing private group and performs the following steps:
+      #
+      # @option options [Object] :channel
+      #   Group to clone and archive.
+      # @see https://api.slack.com/methods/groups.createChild
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.createChild.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.createChild.json
+      def groups_createChild(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.createChild", options)
+      end
+
+      #
+      # This method returns a portion of messages/events from the specified private group.
+      # To read the entire history for a group, call the method with no latest or
+      # oldest arguments, and then continue paging using the instructions below.
+      #
+      # @option options [Object] :channel
+      #   Group 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/groups.history
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.history.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.history.json
+      def groups_history(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.history", options)
+      end
+
+      #
+      # This method returns information about a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to get info on
+      # @see https://api.slack.com/methods/groups.info
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.info.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.info.json
+      def groups_info(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.info", options)
+      end
+
+      #
+      # This method is used to invite a user to a private group. The calling user must be a member of the group.
+      #
+      # @option options [Object] :channel
+      #   Private group to invite user to.
+      # @option options [Object] :user
+      #   User to invite.
+      # @see https://api.slack.com/methods/groups.invite
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.invite.md
+      # @see https://github.com/aki017/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.invite", options)
+      end
+
+      #
+      # This method allows a user to remove another member from a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to remove user from.
+      # @option options [Object] :user
+      #   User to remove from group.
+      # @see https://api.slack.com/methods/groups.kick
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.kick.md
+      # @see https://github.com/aki017/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.kick", options)
+      end
+
+      #
+      # This method is used to leave a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to leave
+      # @see https://api.slack.com/methods/groups.leave
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.leave.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.leave.json
+      def groups_leave(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.leave", options)
+      end
+
+      #
+      # This method returns a list of groups in the team that the caller is in and archived groups that the caller was in.
+      # The list of (non-deactivated) members in each group is also returned.
+      #
+      # @option options [Object] :exclude_archived
+      #   Don't return archived groups.
+      # @see https://api.slack.com/methods/groups.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.list.json
+      def groups_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.list", options)
+      end
+
+      #
+      # This method moves the read cursor in a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to set reading cursor in.
+      # @option options [Object] :ts
+      #   Timestamp of the most recently seen message.
+      # @see https://api.slack.com/methods/groups.mark
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.mark.md
+      # @see https://github.com/aki017/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.mark", options)
+      end
+
+      #
+      # This method opens a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to open.
+      # @see https://api.slack.com/methods/groups.open
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.open.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.open.json
+      def groups_open(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.open", options)
+      end
+
+      #
+      # This method renames a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to rename
+      # @option options [Object] :name
+      #   New name for group.
+      # @see https://api.slack.com/methods/groups.rename
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.rename.md
+      # @see https://github.com/aki017/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.rename", options)
+      end
+
+      #
+      # This method is used to change the purpose of a private group. The calling user must be a member of the private group.
+      #
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/groups.setPurpose.md
+      # @see https://github.com/aki017/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.setPurpose", options)
+      end
+
+      #
+      # This method is used to change the topic of a private group. The calling user must be a member of the private group.
+      #
+      # @option options [Object] :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/aki017/slack-api-docs/blob/master/methods/groups.setTopic.md
+      # @see https://github.com/aki017/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.setTopic", options)
+      end
+
+      #
+      # This method unarchives a private group.
+      #
+      # @option options [Object] :channel
+      #   Group to unarchive
+      # @see https://api.slack.com/methods/groups.unarchive
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.unarchive.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/groups.unarchive.json
+      def groups_unarchive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("groups.unarchive", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/im.rb

@@ -0,0 +1,90 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Im
+      #
+      # This method closes a direct message channel.
+      #
+      # @option options [Object] :channel
+      #   Direct message channel to close.
+      # @see https://api.slack.com/methods/im.close
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.close.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.close.json
+      def im_close(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("im.close", options)
+      end
+
+      #
+      # This method returns a portion of messages/events from the specified direct message channel.
+      # To read the entire history for a direct message channel, call the method with no latest or
+      # oldest arguments, and then continue paging using the instructions below.
+      #
+      # @option options [Object] :channel
+      #   Direct message 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/im.history
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.history.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.history.json
+      def im_history(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("im.history", options)
+      end
+
+      #
+      # This method returns a list of all im channels that the user has.
+      #
+      # @see https://api.slack.com/methods/im.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.list.json
+      def im_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("im.list", options)
+      end
+
+      #
+      # This method moves the read cursor in a direct message channel.
+      #
+      # @option options [Object] :channel
+      #   Direct message channel to set reading cursor in.
+      # @option options [Object] :ts
+      #   Timestamp of the most recently seen message.
+      # @see https://api.slack.com/methods/im.mark
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.mark.md
+      # @see https://github.com/aki017/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("im.mark", options)
+      end
+
+      #
+      # This method opens a direct message channel with another member of your Slack team.
+      #
+      # @option options [Object] :user
+      #   User to open a direct message channel with.
+      # @see https://api.slack.com/methods/im.open
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.open.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/im.open.json
+      def im_open(options={})
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("im.open", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/mpim.rb

@@ -0,0 +1,90 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Mpim
+      #
+      # This method closes a multiparty direct message channel.
+      #
+      # @option options [Object] :channel
+      #   MPIM to close.
+      # @see https://api.slack.com/methods/mpim.close
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.close.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.close.json
+      def mpim_close(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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 [Object] :channel
+      #   Multiparty direct message 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/mpim.history
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.history.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.history.json
+      def mpim_history(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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/aki017/slack-api-docs/blob/master/methods/mpim.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.list.json
+      def mpim_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("mpim.list", options)
+      end
+
+      #
+      # This method moves the read cursor in a multiparty direct message channel.
+      #
+      # @option options [Object] :channel
+      #   multiparty direct message channel to set reading cursor in.
+      # @option options [Object] :ts
+      #   Timestamp of the most recently seen message.
+      # @see https://api.slack.com/methods/mpim.mark
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.mark.md
+      # @see https://github.com/aki017/slack-api-docs/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[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        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/aki017/slack-api-docs/blob/master/methods/mpim.open.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/mpim.open.json
+      def mpim_open(options={})
+        throw ArgumentError.new("Required arguments :users missing") if options[:users].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("mpim.open", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/oauth.rb

@@ -0,0 +1,31 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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/aki017/slack-api-docs/blob/master/methods/oauth.access.md
+      # @see https://github.com/aki017/slack-api-docs/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?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("oauth.access", options)
+      end
+
+    end
+  end
+end