slack-ruby-client 0.14.3 → 0.15.1

data/bin/commands/reactions.rb

@@ -1,22 +1,21 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Reactions methods.'
 command 'reactions' do |g|
-  g.desc 'This method adds a reaction (emoji) to a message.'
-  g.long_desc %( This method adds a reaction (emoji) to a message. Now that file threads work the way you'd expect, the file and file_comment arguments are deprecated. Specify channel and timestamp instead. )
+  g.desc 'Adds a reaction to an item.'
+  g.long_desc %( Adds a reaction to an item. )
   g.command 'add' do |c|
-    c.flag 'name', desc: 'Reaction (emoji) name.'
     c.flag 'channel', desc: 'Channel where the message to add reaction to was posted.'
-    c.flag 'file', desc: "File to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead."
-    c.flag 'file_comment', desc: "File comment to add reaction to. Now that file threads work the way you'd expect, this argument is deprecated. Specify the timestamp and channel of the message associated with a file instead."
+    c.flag 'name', desc: 'Reaction (emoji) name.'
     c.flag 'timestamp', desc: 'Timestamp of the message to add reaction to.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.reactions_add(options))
     end
   end
 
-  g.desc 'This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).'
-  g.long_desc %( This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message). )
+  g.desc 'Gets reactions for an item.'
+  g.long_desc %( Gets reactions for an item. )
   g.command 'get' do |c|
     c.flag 'channel', desc: 'Channel where the message to get reactions for was posted.'
     c.flag 'file', desc: 'File to get reactions for.'
@@ -28,8 +27,8 @@ command 'reactions' do |g|
     end
   end
 
-  g.desc 'This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.'
-  g.long_desc %( This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user. )
+  g.desc 'Lists reactions made by a user.'
+  g.long_desc %( Lists reactions made by a 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 'full', desc: 'If true always return the complete reaction list.'
@@ -40,8 +39,8 @@ command 'reactions' do |g|
     end
   end
 
-  g.desc 'This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).'
-  g.long_desc %( This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified. )
+  g.desc 'Removes a reaction from an item.'
+  g.long_desc %( Removes a reaction from an item. )
   g.command 'remove' do |c|
     c.flag 'name', desc: 'Reaction (emoji) name.'
     c.flag 'channel', desc: 'Channel where the message to remove reaction from was posted.'

data/bin/commands/reminders.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Reminders methods.'
 command 'reminders' do |g|
-  g.desc 'This method creates a reminder.'
-  g.long_desc %( This method creates a reminder. )
+  g.desc 'Creates a reminder.'
+  g.long_desc %( Creates a reminder. )
   g.command 'add' do |c|
     c.flag 'text', desc: 'The content of the reminder.'
     c.flag 'time', desc: 'When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").'
@@ -13,8 +14,8 @@ command 'reminders' do |g|
     end
   end
 
-  g.desc 'This method completes a reminder.'
-  g.long_desc %( This method completes a reminder. )
+  g.desc 'Marks a reminder as complete.'
+  g.long_desc %( Marks a reminder as complete. )
   g.command 'complete' do |c|
     c.flag 'reminder', desc: 'The ID of the reminder to be marked as complete.'
     c.action do |_global_options, options, _args|
@@ -22,8 +23,8 @@ command 'reminders' do |g|
     end
   end
 
-  g.desc 'This method deletes a reminder.'
-  g.long_desc %( This method deletes a reminder. )
+  g.desc 'Deletes a reminder.'
+  g.long_desc %( Deletes a reminder. )
   g.command 'delete' do |c|
     c.flag 'reminder', desc: 'The ID of the reminder.'
     c.action do |_global_options, options, _args|
@@ -31,8 +32,8 @@ command 'reminders' do |g|
     end
   end
 
-  g.desc 'This method returns information about a reminder.'
-  g.long_desc %( This method returns information about a reminder. )
+  g.desc 'Gets information about a reminder.'
+  g.long_desc %( Gets information about a reminder. )
   g.command 'info' do |c|
     c.flag 'reminder', desc: 'The ID of the reminder.'
     c.action do |_global_options, options, _args|
@@ -40,8 +41,8 @@ command 'reminders' do |g|
     end
   end
 
-  g.desc 'This method lists all reminders created by or for a given user.'
-  g.long_desc %( This method lists all reminders created by or for a given user. )
+  g.desc 'Lists all reminders created by or for a given user.'
+  g.long_desc %( Lists all reminders created by or for a given user. )
   g.command 'list' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.reminders_list(options))

data/bin/commands/rtm.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Rtm methods.'
 command 'rtm' do |g|
-  g.desc 'This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.'
-  g.long_desc %( This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket. )
+  g.desc 'Starts a Real Time Messaging session.'
+  g.long_desc %( Starts a Real Time Messaging session. )
   g.command 'connect' do |c|
     c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
     c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
@@ -12,8 +13,8 @@ command 'rtm' do |g|
     end
   end
 
-  g.desc 'This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.'
-  g.long_desc %( This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket. )
+  g.desc 'Starts a Real Time Messaging session.'
+  g.long_desc %( Starts a Real Time Messaging session. )
   g.command 'start' do |c|
     c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'

data/bin/commands/search.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Search methods.'
 command 'search' do |g|
-  g.desc 'This method allows users and applications to search both messages and files in a single call.'
-  g.long_desc %( This method allows users and applications to search both messages and files in a single call. )
+  g.desc 'Searches for messages and files matching a query.'
+  g.long_desc %( Searches for messages and files matching a query. )
   g.command 'all' do |c|
     c.flag 'query', desc: 'Search query. May contains booleans, etc.'
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -14,8 +15,8 @@ command 'search' do |g|
     end
   end
 
-  g.desc 'This method returns files matching a search query.'
-  g.long_desc %( This method returns files matching a search query. )
+  g.desc 'Searches for files matching a query.'
+  g.long_desc %( Searches for files matching a query. )
   g.command 'files' do |c|
     c.flag 'query', desc: 'Search query.'
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
@@ -26,8 +27,8 @@ command 'search' do |g|
     end
   end
 
-  g.desc 'This method returns messages matching a search query.'
-  g.long_desc %( This method returns messages matching a search query. )
+  g.desc 'Searches for messages matching a query.'
+  g.long_desc %( Searches for messages matching a query. )
   g.command 'messages' do |c|
     c.flag 'query', desc: 'Search query.'
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'

data/bin/commands/stars.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Stars methods.'
 command 'stars' do |g|
-  g.desc 'This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
-  g.long_desc %( This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
+  g.desc 'Adds a star to an item.'
+  g.long_desc %( Adds a star to an item. )
   g.command 'add' do |c|
     c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
     c.flag 'file', desc: 'File to add star to.'
@@ -14,8 +15,8 @@ command 'stars' do |g|
     end
   end
 
-  g.desc 'This method lists the items starred by the authed user.'
-  g.long_desc %( This method lists the items starred by the authed user. )
+  g.desc 'Lists stars for a user.'
+  g.long_desc %( Lists stars for a 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."
@@ -24,8 +25,8 @@ command 'stars' do |g|
     end
   end
 
-  g.desc 'This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
-  g.long_desc %( This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
+  g.desc 'Removes a star from an item.'
+  g.long_desc %( Removes a star from an item. )
   g.command 'remove' do |c|
     c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
     c.flag 'file', desc: 'File to remove star from.'

data/bin/commands/team.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Team methods.'
 command 'team' do |g|
-  g.desc 'This method is used to retrieve the "access logs" for users on a workspace.'
-  g.long_desc %( This method is used to retrieve the "access logs" for users on a workspace. )
+  g.desc 'Gets the access logs for the current team.'
+  g.long_desc %( Gets the access logs for the current team. )
   g.command 'accessLogs' do |c|
     c.flag 'before', desc: 'End of time range of logs to include in results (inclusive).'
     c.action do |_global_options, options, _args|
@@ -11,8 +12,8 @@ command 'team' do |g|
     end
   end
 
-  g.desc 'This method lists billable information for each user on the team. Currently this consists solely of whether the user is'
-  g.long_desc %( This method lists billable information for each user on the team. Currently this consists solely of whether the user is subject to billing per Slack's Fair Billing policy. )
+  g.desc 'Gets billable users information for the current team.'
+  g.long_desc %( Gets billable users information for the current team. )
   g.command 'billableInfo' do |c|
     c.flag 'user', desc: 'A user to retrieve the billable information for. Defaults to all users.'
     c.action do |_global_options, options, _args|
@@ -20,8 +21,8 @@ command 'team' do |g|
     end
   end
 
-  g.desc 'This method provides information about your team.'
-  g.long_desc %( This method provides information about your team. )
+  g.desc 'Gets information about the current team.'
+  g.long_desc %( Gets information about the current team. )
   g.command 'info' do |c|
     c.flag 'team', desc: 'Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels.'
     c.action do |_global_options, options, _args|
@@ -29,8 +30,8 @@ command 'team' do |g|
     end
   end
 
-  g.desc 'This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.'
-  g.long_desc %( This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins. )
+  g.desc 'Gets the integration logs for the current team.'
+  g.long_desc %( Gets the integration logs for the current team. )
   g.command 'integrationLogs' do |c|
     c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
     c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'

data/bin/commands/team_profile.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'TeamProfile methods.'
 command 'team_profile' do |g|
-  g.desc 'This method is used to get the profile field definitions for this team.'
-  g.long_desc %( This method is used to get the profile field definitions for this team. )
+  g.desc "Retrieve a team's profile."
+  g.long_desc %( Retrieve a team's profile. )
   g.command 'get' do |c|
     c.flag 'visibility', desc: 'Filter by visibility.'
     c.action do |_global_options, options, _args|

data/bin/commands/usergroups.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Usergroups methods.'
 command 'usergroups' do |g|
-  g.desc 'This method is used to create a User Group.'
-  g.long_desc %( This method is used to create a User Group. )
+  g.desc 'Create a User Group'
+  g.long_desc %( Create a User Group )
   g.command 'create' do |c|
     c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
     c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
@@ -15,8 +16,8 @@ command 'usergroups' do |g|
     end
   end
 
-  g.desc 'This method disables an existing User Group.'
-  g.long_desc %( This method disables an existing User Group. )
+  g.desc 'Disable an existing User Group'
+  g.long_desc %( Disable an existing User Group )
   g.command 'disable' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
     c.flag 'include_count', desc: 'Include the number of users in the User Group.'
@@ -25,8 +26,8 @@ command 'usergroups' do |g|
     end
   end
 
-  g.desc 'This method enables a User Group which was previously disabled.'
-  g.long_desc %( This method enables a User Group which was previously disabled. )
+  g.desc 'Enable a User Group'
+  g.long_desc %( Enable a User Group )
   g.command 'enable' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
     c.flag 'include_count', desc: 'Include the number of users in the User Group.'
@@ -35,8 +36,8 @@ command 'usergroups' do |g|
     end
   end
 
-  g.desc 'This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.'
-  g.long_desc %( This method returns a list of all User Groups in the team. This can optionally include disabled User Groups. )
+  g.desc 'List all User Groups for a team'
+  g.long_desc %( List all User Groups for a team )
   g.command 'list' do |c|
     c.flag 'include_count', desc: 'Include the number of users in each User Group.'
     c.flag 'include_disabled', desc: 'Include disabled User Groups.'
@@ -46,8 +47,8 @@ command 'usergroups' do |g|
     end
   end
 
-  g.desc 'This method updates the properties of an existing User Group.'
-  g.long_desc %( This method updates the properties of an existing User Group. )
+  g.desc 'Update an existing User Group'
+  g.long_desc %( Update an existing User Group )
   g.command 'update' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'

data/bin/commands/usergroups_users.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'UsergroupsUsers methods.'
 command 'usergroups_users' do |g|
-  g.desc 'This method returns a list of all users within a User Group.'
-  g.long_desc %( This method returns a list of all users within a User Group. )
+  g.desc 'List all users in a User Group'
+  g.long_desc %( List all users in a User Group )
   g.command 'list' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'include_disabled', desc: 'Allow results that involve disabled User Groups.'
@@ -12,8 +13,8 @@ command 'usergroups_users' do |g|
     end
   end
 
-  g.desc 'This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter.'
-  g.long_desc %( This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter. )
+  g.desc 'Update the list of users for a User Group'
+  g.long_desc %( Update the list of users for a User Group )
   g.command 'update' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the User Group.'

data/bin/commands/users.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Users methods.'
 command 'users' do |g|
-  g.desc 'This method helps answer questions like:'
-  g.long_desc %( This method helps answer questions like: - Which conversations am I a member of? - Which public channels is my bot user in? - Do I have any direct messages open with my friend Suzy? - Is my bot a member of any private channels? )
+  g.desc 'List conversations the calling user may access.'
+  g.long_desc %( List conversations the calling user may access. )
   g.command 'conversations' 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 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
@@ -15,16 +16,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'This method allows the user to delete their profile image. It will clear whatever image is currently set.'
-  g.long_desc %( This method allows the user to delete their profile image. It will clear whatever image is currently set. )
+  g.desc 'Delete the user profile photo'
+  g.long_desc %( Delete the user profile photo )
   g.command 'deletePhoto' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_deletePhoto(options))
     end
   end
 
-  g.desc "This method lets you find out information about a user's presence."
-  g.long_desc %( This method lets you find out information about a user's presence. Consult the presence documentation for more details. )
+  g.desc 'Gets user presence information.'
+  g.long_desc %( Gets user presence information. )
   g.command 'getPresence' do |c|
     c.flag 'user', desc: 'User to get presence info on. Defaults to the authed user.'
     c.action do |_global_options, options, _args|
@@ -41,16 +42,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc "After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity."
-  g.long_desc %( After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity. )
+  g.desc "Get a user's identity."
+  g.long_desc %( Get a user's identity. )
   g.command 'identity' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_identity(options))
     end
   end
 
-  g.desc 'This method returns information about a member of a workspace.'
-  g.long_desc %( This method returns information about a member of a workspace. )
+  g.desc 'Gets information about a user.'
+  g.long_desc %( Gets information about a user. )
   g.command 'info' do |c|
     c.flag 'user', desc: 'User to get info on.'
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for this user. Defaults to false.'
@@ -59,8 +60,8 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'This method returns a list of all users in the workspace. This includes deleted/deactivated users.'
-  g.long_desc %( This method returns a list of all users in the workspace. This includes deleted/deactivated users. )
+  g.desc 'Lists all users in a Slack team.'
+  g.long_desc %( Lists all users in a Slack team. )
   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 'include_locale', desc: 'Set this to true to receive the locale for users. Defaults to false.'
@@ -70,8 +71,8 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'Retrieve a single user by looking them up by their registered email address. Requires users:read.email.'
-  g.long_desc %( Retrieve a single user by looking them up by their registered email address. Requires users:read.email. )
+  g.desc 'Find a user with an email address.'
+  g.long_desc %( Find a user with an email address. )
   g.command 'lookupByEmail' do |c|
     c.flag 'email', desc: 'An email address belonging to a user in the workspace.'
     c.action do |_global_options, options, _args|
@@ -88,16 +89,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018.'
-  g.long_desc %( This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018. )
+  g.desc 'Marked a user as active. Deprecated and non-functional.'
+  g.long_desc %( Marked a user as active. Deprecated and non-functional. )
   g.command 'setActive' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_setActive(options))
     end
   end
 
-  g.desc 'This method allows the user to set their profile image. The caller can pass image data via image.'
-  g.long_desc %( This method allows the user to set their profile image. The caller can pass image data via image. )
+  g.desc 'Set the user profile photo'
+  g.long_desc %( Set the user profile photo )
   g.command 'setPhoto' do |c|
     c.flag 'image', desc: 'File contents via multipart/form-data.'
     c.flag 'crop_w', desc: 'Width/height of crop box (always square).'
@@ -108,8 +109,8 @@ command 'users' do |g|
     end
   end
 
-  g.desc "This method lets you set the calling user's manual presence."
-  g.long_desc %( This method lets you set the calling user's manual presence. Consult the presence documentation for more details. )
+  g.desc 'Manually sets user presence.'
+  g.long_desc %( Manually sets user presence. )
   g.command 'setPresence' do |c|
     c.flag 'presence', desc: 'Either auto or away.'
     c.action do |_global_options, options, _args|

data/bin/commands/users_admin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'UsersAdmin methods.'