slack-ruby-client 0.15.0 → 1.0.0

data/lib/slack/web/api/endpoints/conversations.rb

@@ -6,6 +6,42 @@ module Slack
     module Api
       module Endpoints
         module Conversations
+          #
+          # Accepts an invitation to a Slack Connect channel.
+          #
+          # @option options [string] :channel_name
+          #   Name of the channel. If the channel does not exist already in your workspace, this name is the one that the channel will take.
+          # @option options [Object] :channel_id
+          #   ID of the channel that you'd like to accept. Must provide either invite_id or channel_id.
+          # @option options [boolean] :free_trial_accepted
+          #   Whether you'd like to use your workspace's free trial to begin using Slack Connect.
+          # @option options [Object] :invite_id
+          #   See the shared_channel_invite_received event payload for more details on how to retrieve the ID of the invitation.
+          # @option options [boolean] :is_private
+          #   Whether the channel should be private.
+          # @option options [string] :team_id
+          #   The ID of the workspace to accept the channel in. If an org-level token is used to call this method, the team_id argument is required.
+          # @see https://api.slack.com/methods/conversations.acceptSharedInvite
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.acceptSharedInvite.json
+          def conversations_acceptSharedInvite(options = {})
+            throw ArgumentError.new('Required arguments :channel_name missing') if options[:channel_name].nil?
+            post('conversations.acceptSharedInvite', options)
+          end
+
+          #
+          # Approves an invitation to a Slack Connect channel
+          #
+          # @option options [Object] :invite_id
+          #   ID of the shared channel invite to approve.
+          # @option options [Object] :target_team
+          #   The team or enterprise id of the other party involved in the invitation you are approving.
+          # @see https://api.slack.com/methods/conversations.approveSharedInvite
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.approveSharedInvite.json
+          def conversations_approveSharedInvite(options = {})
+            throw ArgumentError.new('Required arguments :invite_id missing') if options[:invite_id].nil?
+            post('conversations.approveSharedInvite', options)
+          end
+
           #
           # Archives a conversation.
           #
@@ -35,10 +71,12 @@ module Slack
           #
           # Initiates a public or private channel-based conversation
           #
-          # @option options [Object] :name
+          # @option options [string] :name
           #   Name of the public or private channel to create.
-          # @option options [Object] :is_private
+          # @option options [boolean] :is_private
           #   Create a private channel instead of a public one.
+          # @option options [string] :team_id
+          #   encoded team id to create the channel in, required if org token is used.
           # @see https://api.slack.com/methods/conversations.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.create.json
           def conversations_create(options = {})
@@ -46,18 +84,32 @@ module Slack
             post('conversations.create', options)
           end
 
+          #
+          # Declines a Slack Connect channel invite.
+          #
+          # @option options [Object] :invite_id
+          #   ID of the Slack Connect invite to decline. Subscribe to the shared_channel_invite_accepted event to receive IDs of Slack Connect channel invites that have been accepted and are awaiting approval.
+          # @option options [Object] :target_team
+          #   The team or enterprise id of the other party involved in the invitation you are declining.
+          # @see https://api.slack.com/methods/conversations.declineSharedInvite
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.declineSharedInvite.json
+          def conversations_declineSharedInvite(options = {})
+            throw ArgumentError.new('Required arguments :invite_id missing') if options[:invite_id].nil?
+            post('conversations.declineSharedInvite', options)
+          end
+
           #
           # Fetches a conversation's history of messages and events.
           #
           # @option options [channel] :channel
           #   Conversation ID to fetch history for.
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   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.
-          # @option options [Object] :inclusive
+          # @option options [boolean] :inclusive
           #   Include messages with latest or oldest timestamp in results only when either timestamp is specified.
           # @option options [timestamp] :latest
-          #   End of time range of messages to include in results.
-          # @option options [Object] :limit
+          #   End of time range of messages to include in results. Default is the current time.
+          # @option options [number] :limit
           #   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.
           # @option options [timestamp] :oldest
           #   Start of time range of messages to include in results.
@@ -80,9 +132,9 @@ module Slack
           #
           # @option options [channel] :channel
           #   Conversation ID to learn more about.
-          # @option options [Object] :include_locale
+          # @option options [boolean] :include_locale
           #   Set this to true to receive the locale for this conversation. Defaults to false.
-          # @option options [Object] :include_num_members
+          # @option options [boolean] :include_num_members
           #   Set to true to include the member count for the specified conversation. Defaults to false.
           # @see https://api.slack.com/methods/conversations.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.info.json
@@ -97,7 +149,7 @@ module Slack
           #
           # @option options [channel] :channel
           #   The ID of the public or private channel to invite user(s) to.
-          # @option options [Object] :users
+          # @option options [string] :users
           #   A comma separated list of user IDs. Up to 1000 users may be listed.
           # @see https://api.slack.com/methods/conversations.invite
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.invite.json
@@ -108,6 +160,25 @@ module Slack
             post('conversations.invite', options)
           end
 
+          #
+          # Sends an invitation to a Slack Connect channel
+          #
+          # @option options [channel] :channel
+          #   ID of the channel on your team that you'd like to share.
+          # @option options [array] :emails
+          #   Optional email to receive this invite. Either emails or user_ids must be provided.
+          # @option options [boolean] :external_limited
+          #   Optional boolean on whether invite is to a external limited member. Defaults to true.
+          # @option options [array] :user_ids
+          #   Optional user_id to receive this invite. Either emails or user_ids must be provided.
+          # @see https://api.slack.com/methods/conversations.inviteShared
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.inviteShared.json
+          def conversations_inviteShared(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            post('conversations.inviteShared', options)
+          end
+
           #
           # Joins an existing conversation.
           #
@@ -154,13 +225,15 @@ module Slack
           #
           # Lists all channels in a Slack team.
           #
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   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.
-          # @option options [Object] :exclude_archived
+          # @option options [boolean] :exclude_archived
           #   Set to true to exclude archived channels from the list.
-          # @option options [Object] :limit
+          # @option options [number] :limit
           #   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.
-          # @option options [Object] :types
+          # @option options [string] :team_id
+          #   encoded team id to list channels in, required if token belongs to org-wide app.
+          # @option options [string] :types
           #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
           # @see https://api.slack.com/methods/conversations.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.list.json
@@ -174,14 +247,49 @@ module Slack
             end
           end
 
+          #
+          # Lists shared channel invites that have been generated or received but have not been approved by all parties
+          #
+          # @option options [string] :cursor
+          #   Set to next_cursor returned by previous call to list items in subsequent page.
+          # @option options [string] :team_id
+          #   Encoded team id for the workspace to retrieve invites for, required if org token is used.
+          # @see https://api.slack.com/methods/conversations.listConnectInvites
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.listConnectInvites.json
+          def conversations_listConnectInvites(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :conversations_listConnectInvites, options).each do |page|
+                yield page
+              end
+            else
+              post('conversations.listConnectInvites', options)
+            end
+          end
+
+          #
+          # Sets the read cursor in a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel or conversation to set the read cursor for.
+          # @option options [timestamp] :ts
+          #   Unique identifier of message you want marked as most recently seen in this conversation.
+          # @see https://api.slack.com/methods/conversations.mark
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.mark.json
+          def conversations_mark(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
+            post('conversations.mark', options)
+          end
+
           #
           # Retrieve members of a conversation.
           #
           # @option options [channel] :channel
           #   ID of the conversation to retrieve members for.
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   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.
-          # @option options [Object] :limit
+          # @option options [number] :limit
           #   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.
           # @see https://api.slack.com/methods/conversations.members
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.members.json
@@ -202,9 +310,11 @@ module Slack
           #
           # @option options [channel] :channel
           #   Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
-          # @option options [Object] :return_im
+          # @option options [boolean] :prevent_creation
+          #   Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.
+          # @option options [boolean] :return_im
           #   Boolean, indicates you want the full IM channel definition in the response.
-          # @option options [Object] :users
+          # @option options [string] :users
           #   Comma separated lists of users. If only one user is included, this creates a 1:1 DM.  The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.
           # @see https://api.slack.com/methods/conversations.open
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.open.json
@@ -218,7 +328,7 @@ module Slack
           #
           # @option options [channel] :channel
           #   ID of conversation to rename.
-          # @option options [Object] :name
+          # @option options [string] :name
           #   New name for conversation.
           # @see https://api.slack.com/methods/conversations.rename
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.rename.json
@@ -235,14 +345,14 @@ module Slack
           # @option options [channel] :channel
           #   Conversation ID to fetch thread from.
           # @option options [timestamp] :ts
-          #   Unique identifier of a thread's parent message.
-          # @option options [Object] :cursor
+          #   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.
+          # @option options [string] :cursor
           #   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.
-          # @option options [Object] :inclusive
+          # @option options [boolean] :inclusive
           #   Include messages with latest or oldest timestamp in results only when either timestamp is specified.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
-          # @option options [Object] :limit
+          # @option options [number] :limit
           #   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.
           # @option options [timestamp] :oldest
           #   Start of time range of messages to include in results.
@@ -266,7 +376,7 @@ module Slack
           #
           # @option options [channel] :channel
           #   Conversation to set the purpose of.
-          # @option options [Object] :purpose
+          # @option options [string] :purpose
           #   A new, specialer purpose.
           # @see https://api.slack.com/methods/conversations.setPurpose
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.setPurpose.json
@@ -282,7 +392,7 @@ module Slack
           #
           # @option options [channel] :channel
           #   Conversation to set the topic of.
-          # @option options [Object] :topic
+          # @option options [string] :topic
           #   The new topic string. Does not support formatting or linkification.
           # @see https://api.slack.com/methods/conversations.setTopic
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.setTopic.json

data/lib/slack/web/api/endpoints/dialog.rb

@@ -9,9 +9,9 @@ module Slack
           #
           # Open a dialog with a user
           #
-          # @option options [Object] :dialog
+          # @option options [string] :dialog
           #   The dialog definition. This must be a JSON-encoded string.
-          # @option options [Object] :trigger_id
+          # @option options [string] :trigger_id
           #   Exchange a trigger to post to the user.
           # @see https://api.slack.com/methods/dialog.open
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/dialog/dialog.open.json

data/lib/slack/web/api/endpoints/dnd.rb

@@ -27,6 +27,8 @@ module Slack
           #
           # Retrieves a user's current Do Not Disturb status.
           #
+          # @option options [string] :team_id
+          #   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.
           # @option options [user] :user
           #   User to fetch status for (defaults to current user).
           # @see https://api.slack.com/methods/dnd.info
@@ -39,20 +41,21 @@ module Slack
           #
           # Turns on Do Not Disturb mode for the current user, or changes its duration.
           #
-          # @option options [Object] :num_minutes
+          # @option options [string] :num_minutes
           #   Number of minutes, from now, to snooze until.
           # @see https://api.slack.com/methods/dnd.setSnooze
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.setSnooze.json
           def dnd_setSnooze(options = {})
-            throw ArgumentError.new('Required arguments :num_minutes missing') if options[:num_minutes].nil?
             post('dnd.setSnooze', options)
           end
 
           #
           # Retrieves the Do Not Disturb status for up to 50 users on a team.
           #
-          # @option options [Object] :users
+          # @option options [string] :users
           #   Comma-separated list of users to fetch Do Not Disturb status for.
+          # @option options [string] :team_id
+          #   Encoded team id where passed in users belong, required if org token is used.
           # @see https://api.slack.com/methods/dnd.teamInfo
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.teamInfo.json
           def dnd_teamInfo(options = {})

data/lib/slack/web/api/endpoints/files.rb

@@ -36,13 +36,13 @@ module Slack
           end
 
           #
-          # Gets information about a team file.
+          # Gets information about a file.
           #
           # @option options [file] :file
           #   Specify a file by providing its ID.
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   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.
-          # @option options [Object] :limit
+          # @option options [integer] :limit
           #   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.
           # @see https://api.slack.com/methods/files.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.info.json
@@ -58,17 +58,21 @@ module Slack
           end
 
           #
-          # Lists & filters team files.
+          # List for a team, in a channel, or from a user with applied filters.
           #
           # @option options [channel] :channel
           #   Filter files appearing in a specific channel, indicated by its ID.
-          # @option options [Object] :show_files_hidden_by_limit
+          # @option options [string] :files
+          #   .
+          # @option options [boolean] :show_files_hidden_by_limit
           #   Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.
-          # @option options [Object] :ts_from
+          # @option options [string] :team_id
+          #   encoded team id to list files in, required if org token is used.
+          # @option options [string] :ts_from
           #   Filter files created after this timestamp (inclusive).
-          # @option options [Object] :ts_to
+          # @option options [string] :ts_to
           #   Filter files created before this timestamp (inclusive).
-          # @option options [Object] :types
+          # @option options [string] :types
           #   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.
           # @option options [user] :user
           #   Filter files created by a single user.
@@ -123,21 +127,21 @@ module Slack
           #
           # Uploads or creates a file.
           #
-          # @option options [Object] :channels
+          # @option options [string] :channels
           #   Comma-separated list of channel names or IDs where the file will be shared.
-          # @option options [Object] :content
+          # @option options [string] :content
           #   File contents via a POST variable. If omitting this parameter, you must provide a file.
           # @option options [file] :file
           #   File contents via multipart/form-data. If omitting this parameter, you must submit content.
-          # @option options [Object] :filename
+          # @option options [string] :filename
           #   Filename of file.
-          # @option options [Object] :filetype
+          # @option options [string] :filetype
           #   A file type identifier.
-          # @option options [Object] :initial_comment
+          # @option options [string] :initial_comment
           #   The message text introducing the file in specified channels.
-          # @option options [Object] :thread_ts
+          # @option options [string] :thread_ts
           #   Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.
-          # @option options [Object] :title
+          # @option options [string] :title
           #   Title of file.
           # @see https://api.slack.com/methods/files.upload
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.upload.json

data/lib/slack/web/api/endpoints/files_comments.rb

@@ -11,7 +11,7 @@ module Slack
           #
           # @option options [file] :file
           #   File to delete a comment from.
-          # @option options [Object] :id
+          # @option options [string] :id
           #   The comment to delete.
           # @see https://api.slack.com/methods/files.comments.delete
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.comments/files.comments.delete.json

data/lib/slack/web/api/endpoints/files_remote.rb

@@ -9,17 +9,17 @@ module Slack
           #
           # Adds a file from a remote service
           #
-          # @option options [Object] :external_id
+          # @option options [string] :external_id
           #   Creator defined GUID for the file.
-          # @option options [Object] :external_url
+          # @option options [string] :external_url
           #   URL of the remote file.
-          # @option options [Object] :title
+          # @option options [string] :title
           #   Title of the file being shared.
-          # @option options [Object] :filetype
+          # @option options [string] :filetype
           #   type of file.
-          # @option options [Object] :indexable_file_contents
+          # @option options [string] :indexable_file_contents
           #   A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery of the remote file.
-          # @option options [Object] :preview_image
+          # @option options [string] :preview_image
           #   Preview of the document via multipart/form-data.
           # @see https://api.slack.com/methods/files.remote.add
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.add.json
@@ -33,7 +33,7 @@ module Slack
           #
           # Retrieve information about a remote file added to Slack
           #
-          # @option options [Object] :external_id
+          # @option options [string] :external_id
           #   Creator defined GUID for the file.
           # @option options [file] :file
           #   Specify a file by providing its ID.
@@ -48,13 +48,13 @@ module Slack
           #
           # @option options [channel] :channel
           #   Filter files appearing in a specific channel, indicated by its ID.
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   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.
-          # @option options [Object] :limit
+          # @option options [integer] :limit
           #   The maximum number of items to return.
-          # @option options [Object] :ts_from
+          # @option options [string] :ts_from
           #   Filter files created after this timestamp (inclusive).
-          # @option options [Object] :ts_to
+          # @option options [string] :ts_to
           #   Filter files created before this timestamp (inclusive).
           # @see https://api.slack.com/methods/files.remote.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.list.json
@@ -72,7 +72,7 @@ module Slack
           #
           # Remove a remote file.
           #
-          # @option options [Object] :external_id
+          # @option options [string] :external_id
           #   Creator defined GUID for the file.
           # @option options [file] :file
           #   Specify a file by providing its ID.
@@ -85,12 +85,12 @@ module Slack
           #
           # Share a remote file into a channel.
           #
-          # @option options [Object] :channels
+          # @option options [string] :channels
           #   Comma-separated list of channel IDs where the file will be shared.
-          # @option options [Object] :external_id
-          #   Creator defined GUID for the file.
+          # @option options [string] :external_id
+          #   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.
           # @option options [file] :file
-          #   Specify a file by providing its ID.
+          #   Specify a file registered with Slack by providing its ID. Either this field or external_id or both are required.
           # @see https://api.slack.com/methods/files.remote.share
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.share.json
           def files_remote_share(options = {})
@@ -101,19 +101,19 @@ module Slack
           #
           # Updates an existing remote file.
           #
-          # @option options [Object] :external_id
+          # @option options [string] :external_id
           #   Creator defined GUID for the file.
-          # @option options [Object] :external_url
+          # @option options [string] :external_url
           #   URL of the remote file.
           # @option options [file] :file
           #   Specify a file by providing its ID.
-          # @option options [Object] :filetype
+          # @option options [string] :filetype
           #   type of file.
-          # @option options [Object] :indexable_file_contents
+          # @option options [string] :indexable_file_contents
           #   File containing contents that can be used to improve searchability for the remote file.
-          # @option options [Object] :preview_image
+          # @option options [string] :preview_image
           #   Preview of the document via multipart/form-data.
-          # @option options [Object] :title
+          # @option options [string] :title
           #   Title of the file being shared.
           # @see https://api.slack.com/methods/files.remote.update
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files.remote/files.remote.update.json