slack-ruby-client 0.14.5 → 0.17.0

data/bin/commands/dnd.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Dnd methods.'
+desc 'Adjust and view Do Not Disturb settings for team members.'
 command 'dnd' do |g|
   g.desc "Ends the current user's Do Not Disturb session immediately."
   g.long_desc %( Ends the current user's Do Not Disturb session immediately. )
@@ -22,6 +22,7 @@ command 'dnd' do |g|
   g.desc "Retrieves a user's current Do Not Disturb status."
   g.long_desc %( Retrieves a user's current Do Not Disturb status. )
   g.command 'info' do |c|
+    c.flag 'team_id', desc: 'Encoded team id where passed in user param belongs, required if org token is used. If no user param is passed, then a team which has access to the app should be passed.'
     c.flag 'user', desc: 'User to fetch status for (defaults to current user).'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.dnd_info(options))
@@ -41,6 +42,7 @@ command 'dnd' do |g|
   g.long_desc %( Retrieves the Do Not Disturb status for up to 50 users on a team. )
   g.command 'teamInfo' do |c|
     c.flag 'users', desc: 'Comma-separated list of users to fetch Do Not Disturb status for.'
+    c.flag 'team_id', desc: 'Encoded team id where passed in users belong, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.dnd_teamInfo(options))
     end

data/bin/commands/files.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Files methods.'
+desc 'Get info on files uploaded to Slack, upload new files to Slack.'
 command 'files' do |g|
   g.desc 'Deletes a file.'
   g.long_desc %( Deletes a file. )
@@ -23,8 +23,8 @@ command 'files' do |g|
     end
   end
 
-  g.desc 'Gets information about a team file.'
-  g.long_desc %( Gets information about a team file. )
+  g.desc 'Gets information about a file.'
+  g.long_desc %( Gets information about a file. )
   g.command 'info' do |c|
     c.flag 'file', desc: 'Specify a file by providing its ID.'
     c.flag 'cursor', desc: "Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection of comments. See pagination for more details."
@@ -34,10 +34,12 @@ command 'files' do |g|
     end
   end
 
-  g.desc 'Lists & filters team files.'
-  g.long_desc %( Lists & filters team files. )
+  g.desc 'List for a team, in a channel, or from a user with applied filters.'
+  g.long_desc %( List for a team, in a channel, or from a user with applied filters. )
   g.command 'list' do |c|
     c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
+    c.flag 'show_files_hidden_by_limit', desc: 'Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.'
+    c.flag 'team_id', desc: 'encoded team id to list files in, required if org token is used.'
     c.flag 'ts_from', desc: 'Filter files created after this timestamp (inclusive).'
     c.flag 'ts_to', desc: 'Filter files created before this timestamp (inclusive).'
     c.flag 'types', desc: 'Filter files by type (see below). You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.'

data/bin/commands/files_remote.rb

@@ -10,7 +10,7 @@ command 'files_remote' do |g|
     c.flag 'external_url', desc: 'URL of the remote file.'
     c.flag 'title', desc: 'Title of the file being shared.'
     c.flag 'filetype', desc: 'type of file.'
-    c.flag 'indexable_file_contents', desc: 'File containing contents that can be used to improve searchability for the remote file.'
+    c.flag 'indexable_file_contents', desc: 'A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.'
     c.flag 'preview_image', desc: 'Preview of the document via multipart/form-data.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_remote_add(options))
@@ -54,8 +54,8 @@ command 'files_remote' do |g|
   g.long_desc %( Share a remote file into a channel. )
   g.command 'share' do |c|
     c.flag 'channels', desc: 'Comma-separated list of channel IDs where the file will be shared.'
-    c.flag 'external_id', desc: 'Creator defined GUID for the file.'
-    c.flag 'file', desc: 'Specify a file by providing its ID.'
+    c.flag 'external_id', desc: 'The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack.  Either this field or file or both are required.'
+    c.flag 'file', desc: 'Specify a file registered with Slack by providing its ID. Either this field or external_id or both are required.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_remote_share(options))
     end

data/bin/commands/groups.rb

@@ -1,49 +1,8 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Groups methods.'
+desc "Get info on your team's private channels."
 command 'groups' do |g|
-  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|
-      puts JSON.dump($client.groups_archive(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_create(options))
-    end
-  end
-
-  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|
-      puts JSON.dump($client.groups_createChild(options))
-    end
-  end
-
-  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 '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 the ID of a group.'
   g.long_desc %( This method returns the ID of a group. )
   g.command 'id' do |c|
@@ -52,124 +11,4 @@ command 'groups' do |g|
       puts JSON.dump($client.groups_id(options))
     end
   end
-
-  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.flag 'include_locale', desc: 'Set this to true to receive the locale for this group. Defaults to false.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_info(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_invite(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_kick(options))
-    end
-  end
-
-  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|
-      puts JSON.dump($client.groups_leave(options))
-    end
-  end
-
-  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 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
-    c.flag 'exclude_archived', desc: "Don't return archived private channels."
-    c.flag 'exclude_members', desc: 'Exclude the members from each group.'
-    c.flag 'limit', desc: "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."
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_list(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_mark(options))
-    end
-  end
-
-  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|
-      puts JSON.dump($client.groups_open(options))
-    end
-  end
-
-  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.'
-    c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_rename(options))
-    end
-  end
-
-  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."
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_replies(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_setPurpose(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_setTopic(options))
-    end
-  end
-
-  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|
-      puts JSON.dump($client.groups_unarchive(options))
-    end
-  end
 end

data/bin/commands/im.rb

@@ -1,68 +1,6 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Im methods.'
+desc 'Get info on your direct messages.'
 command 'im' do |g|
-  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|
-      puts JSON.dump($client.im_close(options))
-    end
-  end
-
-  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 '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 '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.flag 'cursor', desc: "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."
-    c.flag 'limit', desc: "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."
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.im_list(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.im_mark(options))
-    end
-  end
-
-  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 'include_locale', desc: 'Set this to true to receive the locale for this im. Defaults to false.'
-    c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.im_open(options))
-    end
-  end
-
-  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."
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.im_replies(options))
-    end
-  end
 end

data/bin/commands/migration.rb

@@ -7,6 +7,7 @@ command 'migration' do |g|
   g.long_desc %( For Enterprise Grid workspaces, map local user IDs to global user IDs )
   g.command 'exchange' do |c|
     c.flag 'users', desc: 'A comma-separated list of user ids, up to 400 per request.'
+    c.flag 'team_id', desc: 'Specify team_id starts with T in case of Org Token.'
     c.flag 'to_old', desc: 'Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.migration_exchange(options))

data/bin/commands/mpim.rb

@@ -1,66 +1,6 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Mpim methods.'
+desc 'Get info on your multiparty direct messages.'
 command 'mpim' do |g|
-  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|
-      puts JSON.dump($client.mpim_close(options))
-    end
-  end
-
-  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 '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 '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.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
-    c.flag 'limit', desc: "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."
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.mpim_list(options))
-    end
-  end
-
-  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.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.mpim_mark(options))
-    end
-  end
-
-  g.desc 'This method opens a multiparty direct message.'
-  g.long_desc %( This method opens a multiparty direct message. )
-  g.command 'open' do |c|
-    c.flag 'users', desc: 'Comma separated lists of users.  The ordering of the users is preserved whenever a MPIM group is returned.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.mpim_open(options))
-    end
-  end
-
-  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."
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.mpim_replies(options))
-    end
-  end
 end

data/bin/commands/oauth.rb

@@ -10,7 +10,7 @@ command 'oauth' do |g|
     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.flag 'single_channel', desc: 'Request the user to add your app only to a single channel. Only valid with a legacy workspace app.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.oauth_access(options))
     end

data/bin/commands/pins.rb

@@ -26,8 +26,6 @@ command 'pins' do |g|
   g.long_desc %( Un-pins an item from a channel. )
   g.command 'remove' do |c|
     c.flag 'channel', desc: 'Channel where the item is pinned to.'
-    c.flag 'file', desc: 'File to un-pin.'
-    c.flag 'file_comment', desc: 'File comment to un-pin.'
     c.flag 'timestamp', desc: 'Timestamp of the message to un-pin.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.pins_remove(options))

data/bin/commands/reactions.rb

@@ -33,6 +33,7 @@ command 'reactions' do |g|
     c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
     c.flag 'full', desc: 'If true always return the complete reaction list.'
     c.flag 'limit', desc: "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."
+    c.flag 'team_id', desc: 'encoded team id to list reactions in, required if org token is used.'
     c.flag 'user', desc: 'Show reactions made by this user. Defaults to the authed user.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.reactions_list(options))

data/bin/commands/search.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Search methods.'
+desc "Search your team's files and messages."
 command 'search' do |g|
   g.desc 'Searches for messages and files matching a query.'
   g.long_desc %( Searches for messages and files matching a query. )
@@ -10,6 +10,7 @@ command 'search' do |g|
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
+    c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.search_all(options))
     end
@@ -22,6 +23,7 @@ command 'search' do |g|
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
+    c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.search_files(options))
     end
@@ -34,6 +36,7 @@ command 'search' do |g|
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
+    c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.search_messages(options))
     end