slack-ruby-client 0.13.0 → 0.17.0

data/bin/commands/chat_scheduledMessages.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'ChatScheduledmessages methods.'
+command 'chat_scheduledMessages' do |g|
+  g.desc 'Returns a list of scheduled messages.'
+  g.long_desc %( Returns a list of scheduled messages. )
+  g.command 'list' do |c|
+    c.flag 'channel', desc: 'The channel of the scheduled messages.'
+    c.flag 'cursor', desc: 'For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.'
+    c.flag 'latest', desc: 'A UNIX timestamp of the latest value in the time range.'
+    c.flag 'limit', desc: 'Maximum number of original entries to return.'
+    c.flag 'oldest', desc: 'A UNIX timestamp of the oldest value in the time range.'
+    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.chat_scheduledMessages_list(options))
+    end
+  end
+end

data/bin/commands/conversations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc "Interface with all kinds of conversations the same way, whether they're public or private channels, direct messages, or otherwise."
@@ -25,7 +26,7 @@ command 'conversations' do |g|
   g.command 'create' do |c|
     c.flag 'name', desc: 'Name of the public or private channel to create.'
     c.flag 'is_private', desc: 'Create a private channel instead of a public one.'
-    c.flag 'user_ids', desc: 'Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.'
+    c.flag 'team_id', desc: 'encoded team id to create the channel in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_create(options))
     end
@@ -50,6 +51,7 @@ command 'conversations' do |g|
   g.command 'info' do |c|
     c.flag 'channel', desc: 'Conversation ID to learn more about.'
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for this conversation. Defaults to false.'
+    c.flag 'include_num_members', desc: 'Set to true to include the member count for the specified conversation. Defaults to false.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_info(options))
     end
@@ -59,7 +61,7 @@ command 'conversations' do |g|
   g.long_desc %( Invites users to a channel. )
   g.command 'invite' do |c|
     c.flag 'channel', desc: 'The ID of the public or private channel to invite user(s) to.'
-    c.flag 'users', desc: 'A comma separated list of user IDs. Up to 30 users may be listed.'
+    c.flag 'users', desc: 'A comma separated list of user IDs. Up to 1000 users may be listed.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_invite(options))
     end
@@ -99,12 +101,23 @@ command 'conversations' do |g|
     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.'
     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. Must be an integer no larger than 1000."
+    c.flag 'team_id', desc: 'encoded team id to list channels in, required if token belongs to org-wide app.'
     c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_list(options))
     end
   end
 
+  g.desc 'Sets the read cursor in a channel.'
+  g.long_desc %( Sets the read cursor in a channel. )
+  g.command 'mark' do |c|
+    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.conversations_mark(options))
+    end
+  end
+
   g.desc 'Retrieve members of a conversation.'
   g.long_desc %( Retrieve members of a conversation. )
   g.command 'members' do |c|
@@ -141,7 +154,7 @@ command 'conversations' do |g|
   g.long_desc %( Retrieve a thread of messages posted to a conversation )
   g.command 'replies' do |c|
     c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
-    c.flag 'ts', desc: "Unique identifier of a thread's parent message."
+    c.flag 'ts', desc: "Unique identifier of either a thread's parent message or a message in the thread. ts must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message."
     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 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
     c.flag 'latest', desc: 'End of time range of messages to include in results.'

data/bin/commands/dialog.rb

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

data/bin/commands/dnd.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Adjust and view Do Not Disturb settings for team members.'
@@ -21,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))
@@ -36,10 +38,11 @@ command 'dnd' do |g|
     end
   end
 
-  g.desc 'Retrieves the Do Not Disturb status for users on a team.'
-  g.long_desc %( Retrieves the Do Not Disturb status for users on a team. )
+  g.desc 'Retrieves the Do Not Disturb status for up to 50 users on a team.'
+  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/emoji.rb

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

data/bin/commands/files.rb

@@ -1,3 +1,4 @@
+# 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.'
@@ -22,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."
@@ -33,25 +34,15 @@ 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:
-
-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))

data/bin/commands/files_comments.rb

@@ -1,17 +1,8 @@
+# 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 '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 'Deletes an existing comment on a file.'
   g.long_desc %( Deletes an existing comment on a file. )
   g.command 'delete' do |c|
@@ -21,15 +12,4 @@ command 'files_comments' do |g|
       puts JSON.dump($client.files_comments_delete(options))
     end
   end
-
-  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.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,48 +1,8 @@
+# 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 '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|
@@ -51,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