slack-ruby-client 0.7.9 → 0.16.0

data/bin/commands/emoji.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 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

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 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,42 +12,45 @@ 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 'Change the properties of a file (undocumented)'
+  g.long_desc %( Change the properties of a file )
+  g.command 'edit' do |c|
+    c.flag 'file', desc: 'ID of the file to be edited'
+    c.flag 'title', desc: 'New title of the file'
+    c.flag 'filetype', desc: 'New filetype of the file. See https://api.slack.com/types/file#file_types for a list of all supported types.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_edit(options))
+    end
+  end
+
+  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."
+    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.files_info(options))
     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 '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 '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 '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:
-
-all - All files
-spaces - Posts
-snippets - Snippets
-images - Image files
-gdocs - Google docs
-zips - Zip files
-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 '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.'
+    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 +58,18 @@ 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 'Share an existing file in a channel (undocumented)'
+  g.long_desc %( Share an existing file in a channel )
+  g.command 'share' do |c|
+    c.flag 'file', desc: 'ID of the file to be shared'
+    c.flag 'channel', desc: 'Channel to share the file in. Works with both public (channel ID) and private channels (group ID).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_share(options))
+    end
+  end
+
+  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 +77,17 @@ 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 'filetype', desc: 'A file type identifier.'
+    c.flag 'initial_comment', desc: 'The message text introducing the file in specified channels.'
+    c.flag 'thread_ts', desc: "Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead."
     c.flag 'title', desc: 'Title of file.'
-    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.action do |_global_options, options, _args|
       puts JSON.dump($client.files_upload(options))
     end

data/bin/commands/files_comments.rb

@@ -1,20 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'FilesComments methods.'
 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 'channel', desc: 'Channel id (encoded) of which location to associate with the new comment.'
-    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,15 +12,4 @@ command 'files_comments' do |g|
       puts JSON.dump($client.files_comments_delete(options))
     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.command 'edit' do |c|
-    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
-  end
 end

data/bin/commands/files_remote.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'FilesRemote methods.'
+command 'files_remote' do |g|
+  g.desc 'Adds a file from a remote service'
+  g.long_desc %( Adds a file from a remote service )
+  g.command 'add' do |c|
+    c.flag 'external_id', desc: 'Creator defined GUID for the file.'
+    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: '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))
+    end
+  end
+
+  g.desc 'Retrieve information about a remote file added to Slack'
+  g.long_desc %( Retrieve information about a remote file added to Slack )
+  g.command 'info' do |c|
+    c.flag 'external_id', desc: 'Creator defined GUID for the file.'
+    c.flag 'file', desc: 'Specify a file by providing its ID.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_remote_info(options))
+    end
+  end
+
+  g.desc 'Retrieve information about a remote file added to Slack'
+  g.long_desc %( Retrieve information about a remote file added to Slack )
+  g.command 'list' do |c|
+    c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
+    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.'
+    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.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_remote_list(options))
+    end
+  end
+
+  g.desc 'Remove a remote file.'
+  g.long_desc %( Remove a remote file. )
+  g.command 'remove' do |c|
+    c.flag 'external_id', desc: 'Creator defined GUID for the file.'
+    c.flag 'file', desc: 'Specify a file by providing its ID.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_remote_remove(options))
+    end
+  end
+
+  g.desc 'Share a remote file into a channel.'
+  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: '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
+  end
+
+  g.desc 'Updates an existing remote file.'
+  g.long_desc %( Updates an existing remote file. )
+  g.command 'update' do |c|
+    c.flag 'external_id', desc: 'Creator defined GUID for the file.'
+    c.flag 'external_url', desc: 'URL of the remote file.'
+    c.flag 'file', desc: 'Specify a file by providing its ID.'
+    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 'preview_image', desc: 'Preview of the document via multipart/form-data.'
+    c.flag 'title', desc: 'Title of the file being shared.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_remote_update(options))
+    end
+  end
+end

data/bin/commands/groups.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 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,26 +12,19 @@ command 'groups' do |g|
     end
   end
 
-  g.desc 'This method closes a private channel.'
-  g.long_desc %( This method closes a private channel. )
-  g.command 'close' do |c|
-    c.flag 'channel', desc: 'Private channel to close.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_close(options))
-    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 'team_id', desc: 'encoded team id to create the channel in, required if org token is used.'
+    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 '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|
@@ -38,30 +32,40 @@ 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 'This method returns the ID of a group.'
+  g.long_desc %( This method returns the ID of a group. )
+  g.command 'id' do |c|
+    c.flag 'channel', desc: 'Group channel to get ID for, prefixed with #.'
+    c.action do |_global_options, options, _args|
+      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 '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.'
@@ -70,8 +74,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.'
@@ -80,8 +84,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|
@@ -89,27 +93,31 @@ 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 '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.flag 'team_id', desc: 'encoded team id to list channels in, required if org token is used.'
     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.'
+    c.flag 'channel', desc: 'Channel or conversation to set the read cursor for.'
+    c.flag 'ts', desc: 'Unique identifier of message you want marked as most recently seen in this conversation.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.groups_mark(options))
     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|
@@ -117,18 +125,19 @@ 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.'
+    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 '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."
@@ -137,8 +146,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.'
@@ -147,8 +156,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.'
@@ -157,21 +166,12 @@ 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|
       puts JSON.dump($client.groups_unarchive(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|
-    c.flag 'channel', desc: 'Group channel to get ID for, prefixed with #.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_id(options))
-    end
-  end
 end