lib/slack/web/api/endpoints/conversations.rb in slack-ruby-client-1.1.0 vs lib/slack/web/api/endpoints/conversations.rb in slack-ruby-client-2.0.0

- old
+ new

@@ -22,11 +22,11 @@ # @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? + raise ArgumentError, 'Required arguments :channel_name missing' if options[:channel_name].nil? post('conversations.acceptSharedInvite', options) end # # Approves an invitation to a Slack Connect channel @@ -36,11 +36,11 @@ # @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? + raise ArgumentError, 'Required arguments :invite_id missing' if options[:invite_id].nil? post('conversations.approveSharedInvite', options) end # # Archives a conversation. @@ -48,11 +48,11 @@ # @option options [channel] :channel # ID of conversation to archive. # @see https://api.slack.com/methods/conversations.archive # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.archive.json def conversations_archive(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.archive', options) end # @@ -61,11 +61,11 @@ # @option options [channel] :channel # Conversation to close. # @see https://api.slack.com/methods/conversations.close # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.close.json def conversations_close(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.close', options) end # @@ -78,11 +78,11 @@ # @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 = {}) - throw ArgumentError.new('Required arguments :name missing') if options[:name].nil? + raise ArgumentError, 'Required arguments :name missing' if options[:name].nil? post('conversations.create', options) end # # Declines a Slack Connect channel invite. @@ -92,33 +92,35 @@ # @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? + raise ArgumentError, '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 [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 [boolean] :include_all_metadata + # Return all metadata associated with this message. # @option options [boolean] :inclusive - # Include messages with latest or oldest timestamp in results only when either timestamp is specified. + # Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified. # @option options [timestamp] :latest - # End of time range of messages to include in results. Default is the current time. + # Only messages before this Unix timestamp will be included 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. + # Only messages after this Unix timestamp will be included in results. # @see https://api.slack.com/methods/conversations.history # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.history.json def conversations_history(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] if block_given? Pagination::Cursor.new(self, :conversations_history, options).each do |page| yield page end @@ -137,11 +139,11 @@ # @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 def conversations_info(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.info', options) end # @@ -152,12 +154,12 @@ # @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 def conversations_invite(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? - throw ArgumentError.new('Required arguments :users missing') if options[:users].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? + raise ArgumentError, 'Required arguments :users missing' if options[:users].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.invite', options) end # @@ -172,11 +174,11 @@ # @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? + raise ArgumentError, '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 # @@ -185,11 +187,11 @@ # @option options [channel] :channel # ID of conversation to join. # @see https://api.slack.com/methods/conversations.join # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.join.json def conversations_join(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.join', options) end # @@ -200,12 +202,12 @@ # @option options [user] :user # User ID to be removed. # @see https://api.slack.com/methods/conversations.kick # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.kick.json def conversations_kick(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? - throw ArgumentError.new('Required arguments :user missing') if options[:user].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? + raise ArgumentError, 'Required arguments :user missing' if options[:user].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] options = options.merge(user: users_id(options)['user']['id']) if options[:user] post('conversations.kick', options) end @@ -215,11 +217,11 @@ # @option options [channel] :channel # Conversation to leave. # @see https://api.slack.com/methods/conversations.leave # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.leave.json def conversations_leave(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.leave', options) end # @@ -274,12 +276,12 @@ # @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? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? + raise ArgumentError, '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 # @@ -292,11 +294,11 @@ # @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 def conversations_members(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] if block_given? Pagination::Cursor.new(self, :conversations_members, options).each do |page| yield page end @@ -331,12 +333,12 @@ # @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 def conversations_rename(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? - throw ArgumentError.new('Required arguments :name missing') if options[:name].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? + raise ArgumentError, 'Required arguments :name missing' if options[:name].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.rename', options) end # @@ -346,23 +348,25 @@ # Conversation ID to fetch thread from. # @option options [timestamp] :ts # 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 [boolean] :include_all_metadata + # Return all metadata associated with this message. # @option options [boolean] :inclusive - # Include messages with latest or oldest timestamp in results only when either timestamp is specified. + # Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified. # @option options [timestamp] :latest - # End of time range of messages to include in results. + # Only messages before this Unix timestamp will be included in results. # @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. + # Only messages after this Unix timestamp will be included in results. # @see https://api.slack.com/methods/conversations.replies # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.replies.json def conversations_replies(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? - throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? + raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] if block_given? Pagination::Cursor.new(self, :conversations_replies, options).each do |page| yield page end @@ -379,12 +383,12 @@ # @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 def conversations_setPurpose(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? - throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? + raise ArgumentError, 'Required arguments :purpose missing' if options[:purpose].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.setPurpose', options) end # @@ -395,12 +399,12 @@ # @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 def conversations_setTopic(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? - throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? + raise ArgumentError, 'Required arguments :topic missing' if options[:topic].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.setTopic', options) end # @@ -409,10 +413,10 @@ # @option options [channel] :channel # ID of conversation to unarchive. # @see https://api.slack.com/methods/conversations.unarchive # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.unarchive.json def conversations_unarchive(options = {}) - throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? + raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('conversations.unarchive', options) end end end