slack-api 1.6.0 → 1.6.1

data/lib/slack/endpoint/conversations.rb

@@ -0,0 +1,283 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Conversations
+      #
+      # Archives a conversation.
+      #
+      # @option options [Object] :channel
+      #   ID of conversation to archive
+      # @see https://api.slack.com/methods/conversations.archive
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.archive.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.archive.json
+      def conversations_archive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.archive", options)
+      end
+
+      #
+      # Closes a direct message or multi-person direct message.
+      #
+      # @option options [Object] :channel
+      #   Conversation to close.
+      # @see https://api.slack.com/methods/conversations.close
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.close.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.close.json
+      def conversations_close(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.close", options)
+      end
+
+      #
+      # Initiates a public or private channel-based conversation
+      #
+      # @option options [Object] :name
+      #   Name of the public or private channel to create
+      # @option options [Object] :is_private
+      #   Create a private channel instead of a public one
+      # @see https://api.slack.com/methods/conversations.create
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.create.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.create.json
+      def conversations_create(options={})
+        throw ArgumentError.new("Required arguments :name missing") if options[:name].nil?
+        post("conversations.create", options)
+      end
+
+      #
+      # Fetches a conversation's history of messages and events.
+      #
+      # @option options [Object] :channel
+      #   Conversation ID to fetch history for.
+      # @option options [Object] :cursor
+      #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
+      # @option options [Object] :inclusive
+      #   Include messages with latest or oldest timestamp in results only when either timestamp is specified.
+      # @option options [Object] :latest
+      #   End of time range of messages to include in results.
+      # @option options [Object] :limit
+      #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
+      # @option options [Object] :oldest
+      #   Start of time range of messages to include in results.
+      # @see https://api.slack.com/methods/conversations.history
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.history.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.history.json
+      def conversations_history(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.history", options)
+      end
+
+      #
+      # Retrieve information about a conversation.
+      #
+      # @option options [Object] :channel
+      #   Conversation ID to learn more about
+      # @option options [Object] :include_locale
+      #   Set this to true to receive the locale for this conversation. Defaults to false
+      # @see https://api.slack.com/methods/conversations.info
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.info.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.info.json
+      def conversations_info(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.info", options)
+      end
+
+      #
+      # Invites users to a channel.
+      #
+      # @option options [Object] :channel
+      #   The ID of the public or private channel to invite user(s) to.
+      # @option options [Object] :users
+      #   A comma separated list of user IDs. Up to 30 users may be listed.
+      # @see https://api.slack.com/methods/conversations.invite
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.invite.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.invite.json
+      def conversations_invite(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :users missing") if options[:users].nil?
+        post("conversations.invite", options)
+      end
+
+      #
+      # Joins an existing conversation.
+      #
+      # @option options [Object] :channel
+      #   ID of conversation to join
+      # @see https://api.slack.com/methods/conversations.join
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.join.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.join.json
+      def conversations_join(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.join", options)
+      end
+
+      #
+      # Removes a user from a conversation.
+      #
+      # @option options [Object] :channel
+      #   ID of conversation to remove user from.
+      # @option options [Object] :user
+      #   User ID to be removed.
+      # @see https://api.slack.com/methods/conversations.kick
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.kick.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.kick.json
+      def conversations_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("conversations.kick", options)
+      end
+
+      #
+      # Leaves a conversation.
+      #
+      # @option options [Object] :channel
+      #   Conversation to leave
+      # @see https://api.slack.com/methods/conversations.leave
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.leave.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.leave.json
+      def conversations_leave(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.leave", options)
+      end
+
+      #
+      # Lists all channels in a Slack team.
+      #
+      # @option options [Object] :cursor
+      #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
+      # @option options [Object] :exclude_archived
+      #   Set to true to exclude archived channels from the list
+      # @option options [Object] :limit
+      #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.
+      # @option options [Object] :types
+      #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im
+      # @see https://api.slack.com/methods/conversations.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.list.json
+      def conversations_list(options={})
+        post("conversations.list", options)
+      end
+
+      #
+      # Retrieve members of a conversation.
+      #
+      # @option options [Object] :channel
+      #   ID of the conversation to retrieve members for
+      # @option options [Object] :cursor
+      #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
+      # @option options [Object] :limit
+      #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
+      # @see https://api.slack.com/methods/conversations.members
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.members.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.members.json
+      def conversations_members(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.members", options)
+      end
+
+      #
+      # Opens or resumes a direct message or multi-person direct message.
+      #
+      # @option options [Object] :channel
+      #   Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
+      # @option options [Object] :return_im
+      #   Boolean, indicates you want the full IM channel definition in the response.
+      # @option options [Object] :users
+      #   Comma separated lists of users. If only one user is included, this creates a 1:1 DM.  The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.
+      # @see https://api.slack.com/methods/conversations.open
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.open.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.open.json
+      def conversations_open(options={})
+        post("conversations.open", options)
+      end
+
+      #
+      # Renames a conversation.
+      #
+      # @option options [Object] :channel
+      #   ID of conversation to rename
+      # @option options [Object] :name
+      #   New name for conversation.
+      # @see https://api.slack.com/methods/conversations.rename
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.rename.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.rename.json
+      def conversations_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("conversations.rename", options)
+      end
+
+      #
+      # Retrieve a thread of messages posted to a conversation
+      #
+      # @option options [Object] :channel
+      #   Conversation ID to fetch thread from.
+      # @option options [Object] :ts
+      #   Unique identifier of a thread's parent message.
+      # @option options [Object] :cursor
+      #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
+      # @option options [Object] :inclusive
+      #   Include messages with latest or oldest timestamp in results only when either timestamp is specified.
+      # @option options [Object] :latest
+      #   End of time range of messages to include in results.
+      # @option options [Object] :limit
+      #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
+      # @option options [Object] :oldest
+      #   Start of time range of messages to include in results.
+      # @see https://api.slack.com/methods/conversations.replies
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.replies.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.replies.json
+      def conversations_replies(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
+        post("conversations.replies", options)
+      end
+
+      #
+      # Sets the purpose for a conversation.
+      #
+      # @option options [Object] :channel
+      #   Conversation to set the purpose of
+      # @option options [Object] :purpose
+      #   A new, specialer purpose
+      # @see https://api.slack.com/methods/conversations.setPurpose
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.setPurpose.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.setPurpose.json
+      def conversations_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("conversations.setPurpose", options)
+      end
+
+      #
+      # Sets the topic for a conversation.
+      #
+      # @option options [Object] :channel
+      #   Conversation to set the topic of
+      # @option options [Object] :topic
+      #   The new topic string. Does not support formatting or linkification.
+      # @see https://api.slack.com/methods/conversations.setTopic
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.setTopic.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.setTopic.json
+      def conversations_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("conversations.setTopic", options)
+      end
+
+      #
+      # Reverses conversation archival.
+      #
+      # @option options [Object] :channel
+      #   ID of conversation to unarchive
+      # @see https://api.slack.com/methods/conversations.unarchive
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.unarchive.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/conversations.unarchive.json
+      def conversations_unarchive(options={})
+        throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
+        post("conversations.unarchive", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/dialog.rb

@@ -0,0 +1,24 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Dialog
+      #
+      # Open a dialog with a user
+      #
+      # @option options [Object] :dialog
+      #   The dialog definition. This must be a JSON-encoded string.
+      # @option options [Object] :trigger_id
+      #   Exchange a trigger to post to the user.
+      # @see https://api.slack.com/methods/dialog.open
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/dialog.open.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/dialog.open.json
+      def dialog_open(options={})
+        throw ArgumentError.new("Required arguments :dialog missing") if options[:dialog].nil?
+        throw ArgumentError.new("Required arguments :trigger_id missing") if options[:trigger_id].nil?
+        post("dialog.open", options)
+      end
+
+    end
+  end
+end

data/lib/slack/endpoint/dnd.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Dnd
       #
-      # Ends the user's currently scheduled Do Not Disturb session immediately.
+      # Ends the current user's Do Not Disturb session immediately.
       #
       # @see https://api.slack.com/methods/dnd.endDnd
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/dnd.endDnd.md
@@ -24,7 +24,7 @@ module Slack
       end
 
       #
-      # Provides information about a user's current Do Not Disturb settings.
+      # Retrieves a user's current Do Not Disturb status.
       #
       # @option options [Object] :user
       #   User to fetch status for (defaults to current user)
@@ -36,7 +36,7 @@ module Slack
       end
 
       #
-      # Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration.
+      # Turns on Do Not Disturb mode for the current user, or changes its duration.
       #
       # @option options [Object] :num_minutes
       #   Number of minutes, from now, to snooze until.
@@ -49,7 +49,7 @@ module Slack
       end
 
       #
-      # Provides information about the current Do Not Disturb settings for users of a Slack team.
+      # Retrieves the Do Not Disturb status for users on a team.
       #
       # @option options [Object] :users
       #   Comma-separated list of users to fetch Do Not Disturb status for

data/lib/slack/endpoint/emoji.rb

@@ -4,7 +4,7 @@ module Slack
   module Endpoint
     module Emoji
       #
-      # This method lists the custom emoji for a team.
+      # Lists 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

data/lib/slack/endpoint/files.rb

@@ -6,21 +6,21 @@ module Slack
       #
       # Add a comment to an existing file.
       #
-      # @option options [Object] :file
-      #   File to add a comment to.
       # @option options [Object] :comment
       #   Text of the comment to add.
+      # @option options [Object] :file
+      #   File to add a comment to.
       # @see https://api.slack.com/methods/files.comments.add
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.comments.add.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.comments.add.json
       def files_comments_add(options={})
-        throw ArgumentError.new("Required arguments :file missing") if options[:file].nil?
         throw ArgumentError.new("Required arguments :comment missing") if options[:comment].nil?
+        throw ArgumentError.new("Required arguments :file missing") if options[:file].nil?
         post("files.comments.add", options)
       end
 
       #
-      # Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment.
+      # Deletes an existing comment on a file.
       #
       # @option options [Object] :file
       #   File to delete a comment from.
@@ -36,26 +36,26 @@ module Slack
       end
 
       #
-      # Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.
+      # Edit an existing file comment.
       #
+      # @option options [Object] :comment
+      #   Text of the comment to edit.
       # @option options [Object] :file
       #   File containing the comment to edit.
       # @option options [Object] :id
       #   The comment to edit.
-      # @option options [Object] :comment
-      #   Text of the comment to edit.
       # @see https://api.slack.com/methods/files.comments.edit
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.comments.edit.md
       # @see https://github.com/aki017/slack-api-docs/blob/master/methods/files.comments.edit.json
       def files_comments_edit(options={})
+        throw ArgumentError.new("Required arguments :comment missing") if options[:comment].nil?
         throw ArgumentError.new("Required arguments :file missing") if options[:file].nil?
         throw ArgumentError.new("Required arguments :id missing") if options[:id].nil?
-        throw ArgumentError.new("Required arguments :comment missing") if options[:comment].nil?
         post("files.comments.edit", options)
       end
 
       #
-      # This method deletes a file from your team.
+      # Deletes a file.
       #
       # @option options [Object] :file
       #   ID of file to delete.
@@ -68,7 +68,7 @@ module Slack
       end
 
       #
-      # This method returns information about a file in your team.
+      # Gets information about a team file.
       #
       # @option options [Object] :file
       #   Specify a file by providing its ID.
@@ -85,12 +85,14 @@ module Slack
       end
 
       #
-      # This method returns a list of files within the team. It can be filtered and sliced in various ways.
+      # Lists & filters team files.
       #
-      # @option options [Object] :user
-      #   Filter files created by a single user.
       # @option options [Object] :channel
       #   Filter files appearing in a specific channel, indicated by its ID.
+      # @option options [Object] :count
+      #   Number of items to return per page.
+      # @option options [Object] :page
+      #   Page number of results to return.
       # @option options [Object] :ts_from
       #   Filter files created after this timestamp (inclusive).
       # @option options [Object] :ts_to
@@ -109,10 +111,8 @@ module Slack
       #   
       #   
       #   You can pass multiple values in the types argument, like types=spaces,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.
+      # @option options [Object] :user
+      #   Filter files created by a single user.
       # @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
@@ -121,7 +121,7 @@ module Slack
       end
 
       #
-      # This method disables public/external sharing for a file.
+      # Revokes public/external sharing access for a file
       #
       # @option options [Object] :file
       #   File to revoke
@@ -134,7 +134,7 @@ module Slack
       end
 
       #
-      # This method enables public/external sharing for a file.
+      # Enables a file for public/external sharing.
       #
       # @option options [Object] :file
       #   File to share
@@ -160,22 +160,22 @@ module Slack
       end
 
       #
-      # This method allows you to create or upload an existing file.
+      # Uploads or creates a file.
       #
-      # @option options [Object] :file
-      #   File contents via multipart/form-data. If omitting this parameter, you must submit content.
+      # @option options [Object] :channels
+      #   Comma-separated list of channel names or IDs where the file will be shared.
       # @option options [Object] :content
       #   File contents via a POST variable. If omitting this parameter, you must provide a file.
-      # @option options [Object] :filetype
-      #   A file type identifier.
+      # @option options [Object] :file
+      #   File contents via multipart/form-data. If omitting this parameter, you must submit content.
       # @option options [Object] :filename
       #   Filename of file.
-      # @option options [Object] :title
-      #   Title of file.
+      # @option options [Object] :filetype
+      #   A file type identifier.
       # @option options [Object] :initial_comment
       #   Initial comment to add to file.
-      # @option options [Object] :channels
-      #   Comma-separated list of channel names or IDs where the file will be shared.
+      # @option options [Object] :title
+      #   Title of file.
       # @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