slack-ruby-client 0.9.0 → 0.9.1

data/bin/commands/emoji.rb

@@ -2,8 +2,8 @@
 
 desc 'Emoji methods.'
 command 'emoji' do |g|
-  g.desc 'This method lists the custom emoji for a team.'
-  g.long_desc %( This method lists the custom emoji for a team. )
+  g.desc 'Lists custom emoji for a team.'
+  g.long_desc %( Lists custom emoji for a team. )
   g.command 'list' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.emoji_list(options))

data/bin/commands/files.rb

@@ -2,8 +2,8 @@
 
 desc 'Get info on files uploaded to Slack, upload new files to Slack.'
 command 'files' do |g|
-  g.desc 'This method deletes a file from your team.'
-  g.long_desc %( This method deletes a file from your team. )
+  g.desc 'Deletes a file.'
+  g.long_desc %( Deletes a file. )
   g.command 'delete' do |c|
     c.flag 'file', desc: 'ID of file to delete.'
     c.action do |_global_options, options, _args|
@@ -11,8 +11,8 @@ command 'files' do |g|
     end
   end
 
-  g.desc 'This method returns information about a file in your team.'
-  g.long_desc %( This method returns information about a file in your team. )
+  g.desc 'Gets information about a team file.'
+  g.long_desc %( Gets information about a team file. )
   g.command 'info' do |c|
     c.flag 'file', desc: 'Specify a file by providing its ID.'
     c.action do |_global_options, options, _args|
@@ -20,10 +20,9 @@ command 'files' do |g|
     end
   end
 
-  g.desc 'This method returns a list of files within the team. It can be filtered and sliced in various ways.'
-  g.long_desc %( This method returns a list of files within the team. It can be filtered and sliced in various ways. )
+  g.desc 'Lists & filters team files.'
+  g.long_desc %( Lists & filters team files. )
   g.command 'list' do |c|
-    c.flag 'user', desc: 'Filter files created by a single user.'
     c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
     c.flag 'ts_from', desc: 'Filter files created after this timestamp (inclusive).'
     c.flag 'ts_to', desc: 'Filter files created before this timestamp (inclusive).'
@@ -40,13 +39,14 @@ pdfs - PDF files
 
 You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.
 .'
+    c.flag 'user', desc: 'Filter files created by a single user.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_list(options))
     end
   end
 
-  g.desc 'This method disables public/external sharing for a file.'
-  g.long_desc %( This method disables public/external sharing for a file. )
+  g.desc 'Revokes public/external sharing access for a file'
+  g.long_desc %( Revokes public/external sharing access for a file )
   g.command 'revokePublicURL' do |c|
     c.flag 'file', desc: 'File to revoke.'
     c.action do |_global_options, options, _args|
@@ -54,8 +54,8 @@ You can pass multiple values in the types argument, like types=spaces,snippets.T
     end
   end
 
-  g.desc 'This method enables public/external sharing for a file.'
-  g.long_desc %( This method enables public/external sharing for a file. )
+  g.desc 'Enables a file for public/external sharing.'
+  g.long_desc %( Enables a file for public/external sharing. )
   g.command 'sharedPublicURL' do |c|
     c.flag 'file', desc: 'File to share.'
     c.action do |_global_options, options, _args|
@@ -63,16 +63,16 @@ You can pass multiple values in the types argument, like types=spaces,snippets.T
     end
   end
 
-  g.desc 'This method allows you to create or upload an existing file.'
-  g.long_desc %( This method allows you to create or upload an existing file. )
+  g.desc 'Uploads or creates a file.'
+  g.long_desc %( Uploads or creates a file. )
   g.command 'upload' do |c|
-    c.flag 'file', desc: 'File contents via multipart/form-data. If omitting this parameter, you must submit content.'
+    c.flag 'channels', desc: 'Comma-separated list of channel names or IDs where the file will be shared.'
     c.flag 'content', desc: 'File contents via a POST variable. If omitting this parameter, you must provide a file.'
-    c.flag 'filetype', desc: 'A file type identifier.'
+    c.flag 'file', desc: 'File contents via multipart/form-data. If omitting this parameter, you must submit content.'
     c.flag 'filename', desc: 'Filename of file.'
-    c.flag 'title', desc: 'Title of file.'
+    c.flag 'filetype', desc: 'A file type identifier.'
     c.flag 'initial_comment', desc: 'Initial comment to add to file.'
-    c.flag 'channels', desc: 'Comma-separated list of channel names or IDs where the file will be shared.'
+    c.flag 'title', desc: 'Title of file.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_upload(options))
     end

data/bin/commands/files_comments.rb

@@ -5,15 +5,15 @@ command 'files_comments' do |g|
   g.desc 'Add a comment to an existing file.'
   g.long_desc %( Add a comment to an existing file. )
   g.command 'add' do |c|
-    c.flag 'file', desc: 'File to add a comment to.'
     c.flag 'comment', desc: 'Text of the comment to add.'
+    c.flag 'file', desc: 'File to add a comment to.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_comments_add(options))
     end
   end
 
-  g.desc 'Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment.'
-  g.long_desc %( Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment. )
+  g.desc 'Deletes an existing comment on a file.'
+  g.long_desc %( Deletes an existing comment on a file. )
   g.command 'delete' do |c|
     c.flag 'file', desc: 'File to delete a comment from.'
     c.flag 'id', desc: 'The comment to delete.'
@@ -22,12 +22,12 @@ command 'files_comments' do |g|
     end
   end
 
-  g.desc '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.'
-  g.long_desc %( 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. )
+  g.desc 'Edit an existing file comment.'
+  g.long_desc %( Edit an existing file comment. )
   g.command 'edit' do |c|
+    c.flag 'comment', desc: 'Text of the comment to edit.'
     c.flag 'file', desc: 'File containing the comment to edit.'
     c.flag 'id', desc: 'The comment to edit.'
-    c.flag 'comment', desc: 'Text of the comment to edit.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_comments_edit(options))
     end

data/bin/commands/groups.rb

@@ -2,8 +2,8 @@
 
 desc "Get info on your team's private channels."
 command 'groups' do |g|
-  g.desc 'This method archives a private channel.'
-  g.long_desc %( This method archives a private channel. )
+  g.desc 'Archives a private channel.'
+  g.long_desc %( Archives a private channel. )
   g.command 'archive' do |c|
     c.flag 'channel', desc: 'Private channel to archive.'
     c.action do |_global_options, options, _args|
@@ -11,8 +11,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method closes a private channel.'
-  g.long_desc %( This method closes a private channel. )
+  g.desc 'Closes a private channel.'
+  g.long_desc %( Closes a private channel. )
   g.command 'close' do |c|
     c.flag 'channel', desc: 'Private channel to close.'
     c.action do |_global_options, options, _args|
@@ -20,8 +20,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method creates a private channel.'
-  g.long_desc %( This method creates a private channel. )
+  g.desc 'Creates a private channel.'
+  g.long_desc %( Creates a private channel. )
   g.command 'create' do |c|
     c.flag 'name', desc: 'Name of private channel to create.'
     c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
@@ -30,8 +30,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method takes an existing private channel and performs the following steps:'
-  g.long_desc %( This method takes an existing private channel and performs the following steps: )
+  g.desc 'Clones and archives a private channel.'
+  g.long_desc %( Clones and archives a private channel. )
   g.command 'createChild' do |c|
     c.flag 'channel', desc: 'Private channel to clone and archive.'
     c.action do |_global_options, options, _args|
@@ -39,21 +39,21 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method returns a portion of messages/events from the specified private channel.'
-  g.long_desc %( This method returns a portion of messages/events from the specified private channel. To read the entire history for a private channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below. )
+  g.desc 'Fetches history of messages and events from a private channel.'
+  g.long_desc %( Fetches history of messages and events from a private channel. )
   g.command 'history' do |c|
     c.flag 'channel', desc: 'Private channel to fetch history for.'
+    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
     c.flag 'latest', desc: 'End of time range of messages to include in results.'
     c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
-    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
     c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.groups_history(options))
     end
   end
 
-  g.desc 'This method returns information about a private channel.'
-  g.long_desc %( This method returns information about a private channel. )
+  g.desc 'Gets information about a private channel.'
+  g.long_desc %( Gets information about a private channel. )
   g.command 'info' do |c|
     c.flag 'channel', desc: 'Private channel to get info on.'
     c.action do |_global_options, options, _args|
@@ -61,8 +61,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method is used to invite a user to a private channel. The calling user must be a member of the private channel.'
-  g.long_desc %( This method is used to invite a user to a private channel. The calling user must be a member of the private channel. )
+  g.desc 'Invites a user to a private channel.'
+  g.long_desc %( Invites a user to a private channel. )
   g.command 'invite' do |c|
     c.flag 'channel', desc: 'Private channel to invite user to.'
     c.flag 'user', desc: 'User to invite.'
@@ -71,8 +71,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method allows a user to remove another member from a private channel.'
-  g.long_desc %( This method allows a user to remove another member from a private channel. )
+  g.desc 'Removes a user from a private channel.'
+  g.long_desc %( Removes a user from a private channel. )
   g.command 'kick' do |c|
     c.flag 'channel', desc: 'Private channel to remove user from.'
     c.flag 'user', desc: 'User to remove from private channel.'
@@ -81,8 +81,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method is used to leave a private channel.'
-  g.long_desc %( This method is used to leave a private channel. )
+  g.desc 'Leaves a private channel.'
+  g.long_desc %( Leaves a private channel. )
   g.command 'leave' do |c|
     c.flag 'channel', desc: 'Private channel to leave.'
     c.action do |_global_options, options, _args|
@@ -90,17 +90,18 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in.'
-  g.long_desc %( This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in. The list of (non-deactivated) members in each private channel is also returned. )
+  g.desc 'Lists private channels that the calling user has access to.'
+  g.long_desc %( Lists private channels that the calling user has access to. )
   g.command 'list' do |c|
     c.flag 'exclude_archived', desc: "Don't return archived private channels."
+    c.flag 'exclude_members', desc: 'Exlude the members from each group.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.groups_list(options))
     end
   end
 
-  g.desc 'This method moves the read cursor in a private channel.'
-  g.long_desc %( This method moves the read cursor in a private channel. )
+  g.desc 'Sets the read cursor in a private channel.'
+  g.long_desc %( Sets the read cursor in a private channel. )
   g.command 'mark' do |c|
     c.flag 'channel', desc: 'Private channel to set reading cursor in.'
     c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -109,8 +110,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method opens a private channel.'
-  g.long_desc %( This method opens a private channel. )
+  g.desc 'Opens a private channel.'
+  g.long_desc %( Opens a private channel. )
   g.command 'open' do |c|
     c.flag 'channel', desc: 'Private channel to open.'
     c.action do |_global_options, options, _args|
@@ -118,8 +119,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method renames a private channel.'
-  g.long_desc %( This method renames a private channel. )
+  g.desc 'Renames a private channel.'
+  g.long_desc %( Renames a private channel. )
   g.command 'rename' do |c|
     c.flag 'channel', desc: 'Private channel to rename.'
     c.flag 'name', desc: 'New name for private channel.'
@@ -129,8 +130,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
-  g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
+  g.desc 'Retrieve a thread of messages posted to a private channel'
+  g.long_desc %( Retrieve a thread of messages posted to a private channel )
   g.command 'replies' do |c|
     c.flag 'channel', desc: 'Private channel to fetch thread from.'
     c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -139,8 +140,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.'
-  g.long_desc %( This method is used to change the purpose of a private channel. The calling user must be a member of the private channel. )
+  g.desc 'Sets the purpose for a private channel.'
+  g.long_desc %( Sets the purpose for a private channel. )
   g.command 'setPurpose' do |c|
     c.flag 'channel', desc: 'Private channel to set the purpose of.'
     c.flag 'purpose', desc: 'The new purpose.'
@@ -149,8 +150,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method is used to change the topic of a private channel. The calling user must be a member of the private channel.'
-  g.long_desc %( This method is used to change the topic of a private channel. The calling user must be a member of the private channel. )
+  g.desc 'Sets the topic for a private channel.'
+  g.long_desc %( Sets the topic for a private channel. )
   g.command 'setTopic' do |c|
     c.flag 'channel', desc: 'Private channel to set the topic of.'
     c.flag 'topic', desc: 'The new topic.'
@@ -159,8 +160,8 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method unarchives a private channel.'
-  g.long_desc %( This method unarchives a private channel. )
+  g.desc 'Unarchives a private channel.'
+  g.long_desc %( Unarchives a private channel. )
   g.command 'unarchive' do |c|
     c.flag 'channel', desc: 'Private channel to unarchive.'
     c.action do |_global_options, options, _args|

data/bin/commands/im.rb

@@ -2,8 +2,8 @@
 
 desc 'Get info on your direct messages.'
 command 'im' do |g|
-  g.desc 'This method closes a direct message channel.'
-  g.long_desc %( This method closes a direct message channel. )
+  g.desc 'Close a direct message channel.'
+  g.long_desc %( Close a direct message channel. )
   g.command 'close' do |c|
     c.flag 'channel', desc: 'Direct message channel to close.'
     c.action do |_global_options, options, _args|
@@ -11,29 +11,29 @@ command 'im' do |g|
     end
   end
 
-  g.desc 'This method returns a portion of messages/events from the specified direct message channel.'
-  g.long_desc %( 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. )
+  g.desc 'Fetches history of messages and events from direct message channel.'
+  g.long_desc %( Fetches history of messages and events from direct message channel. )
   g.command 'history' do |c|
     c.flag 'channel', desc: 'Direct message channel to fetch history for.'
+    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
     c.flag 'latest', desc: 'End of time range of messages to include in results.'
     c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
-    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
     c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.im_history(options))
     end
   end
 
-  g.desc 'This method returns a list of all im channels that the user has.'
-  g.long_desc %( This method returns a list of all im channels that the user has. )
+  g.desc 'Lists direct message channels for the calling user.'
+  g.long_desc %( Lists direct message channels for the calling user. )
   g.command 'list' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.im_list(options))
     end
   end
 
-  g.desc 'This method moves the read cursor in a direct message channel.'
-  g.long_desc %( This method moves the read cursor in a direct message channel. )
+  g.desc 'Sets the read cursor in a direct message channel.'
+  g.long_desc %( Sets the read cursor in a direct message channel. )
   g.command 'mark' do |c|
     c.flag 'channel', desc: 'Direct message channel to set reading cursor in.'
     c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -42,8 +42,8 @@ command 'im' do |g|
     end
   end
 
-  g.desc 'This method opens a direct message channel with another member of your Slack team.'
-  g.long_desc %( This method opens a direct message channel with another member of your Slack team. )
+  g.desc 'Opens a direct message channel.'
+  g.long_desc %( Opens a direct message channel. )
   g.command 'open' do |c|
     c.flag 'user', desc: 'User to open a direct message channel with.'
     c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
@@ -52,8 +52,8 @@ command 'im' do |g|
     end
   end
 
-  g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
-  g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
+  g.desc 'Retrieve a thread of messages posted to a direct message conversation'
+  g.long_desc %( Retrieve a thread of messages posted to a direct message conversation )
   g.command 'replies' do |c|
     c.flag 'channel', desc: 'Direct message channel to fetch thread from.'
     c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."

data/bin/commands/mpim.rb

@@ -2,8 +2,8 @@
 
 desc 'Get info on your multiparty direct messages.'
 command 'mpim' do |g|
-  g.desc 'This method closes a multiparty direct message channel.'
-  g.long_desc %( This method closes a multiparty direct message channel. )
+  g.desc 'Closes a multiparty direct message channel.'
+  g.long_desc %( Closes a multiparty direct message channel. )
   g.command 'close' do |c|
     c.flag 'channel', desc: 'MPIM to close.'
     c.action do |_global_options, options, _args|
@@ -11,29 +11,29 @@ command 'mpim' do |g|
     end
   end
 
-  g.desc 'This method returns a portion of messages/events from the specified multiparty direct message channel.'
-  g.long_desc %( 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. )
+  g.desc 'Fetches history of messages and events from a multiparty direct message.'
+  g.long_desc %( Fetches history of messages and events from a multiparty direct message. )
   g.command 'history' do |c|
     c.flag 'channel', desc: 'Multiparty direct message to fetch history for.'
+    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
     c.flag 'latest', desc: 'End of time range of messages to include in results.'
     c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
-    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
     c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.mpim_history(options))
     end
   end
 
-  g.desc 'This method returns a list of all multiparty direct message channels that the user has.'
-  g.long_desc %( This method returns a list of all multiparty direct message channels that the user has. )
+  g.desc 'Lists multiparty direct message channels for the calling user.'
+  g.long_desc %( Lists multiparty direct message channels for the calling user. )
   g.command 'list' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.mpim_list(options))
     end
   end
 
-  g.desc 'This method moves the read cursor in a multiparty direct message channel.'
-  g.long_desc %( This method moves the read cursor in a multiparty direct message channel. )
+  g.desc 'Sets the read cursor in a multiparty direct message channel.'
+  g.long_desc %( Sets the read cursor in a multiparty direct message channel. )
   g.command 'mark' do |c|
     c.flag 'channel', desc: 'multiparty direct message channel to set reading cursor in.'
     c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -51,8 +51,8 @@ command 'mpim' do |g|
     end
   end
 
-  g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
-  g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
+  g.desc 'Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.'
+  g.long_desc %( Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message. )
   g.command 'replies' do |c|
     c.flag 'channel', desc: 'Multiparty direct message channel to fetch thread from.'
     c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."

data/bin/commands/oauth.rb

@@ -2,8 +2,8 @@
 
 desc 'Oauth methods.'
 command 'oauth' do |g|
-  g.desc 'This method allows you to exchange a temporary OAuth code for an API access token.'
-  g.long_desc %( 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. )
+  g.desc 'Exchanges a temporary OAuth code for an API token.'
+  g.long_desc %( Exchanges a temporary OAuth code for an API token. )
   g.command 'access' do |c|
     c.flag 'client_id', desc: 'Issued when you created your application.'
     c.flag 'client_secret', desc: 'Issued when you created your application.'
@@ -13,4 +13,17 @@ command 'oauth' do |g|
       puts JSON.dump($client.oauth_access(options))
     end
   end
+
+  g.desc 'Exchanges a temporary OAuth verifier code for a workspace token.'
+  g.long_desc %( Exchanges a temporary OAuth verifier code for a workspace token. )
+  g.command 'token' do |c|
+    c.flag 'client_id', desc: 'Issued when you created your application.'
+    c.flag 'client_secret', desc: 'Issued when you created your application.'
+    c.flag 'code', desc: 'The code param returned via the OAuth callback.'
+    c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
+    c.flag 'single_channel', desc: 'Request the user to add your app only to a single channel.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.oauth_token(options))
+    end
+  end
 end