lib/slack/web/api/endpoints/chat.rb
# frozen_string_literal: true
# This file was auto-generated by lib/tasks/web.rake
module Slack
module Web
module Api
module Endpoints
module Chat
#
# Execute a slash command in a public channel (undocumented)
#
# @option options [channel] :channel
# Channel to execute the command in.
# @option options [Object] :command
# Slash command to be executed. Leading backslash is required.
# @option options [Object] :text
# Additional parameters provided to the slash command.
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/chat/chat.command.json
def chat_command(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'Required arguments :command missing' if options[:command].nil?
options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
logger.warn('The chat.command method is undocumented.')
post('chat.command', options)
end
#
# Deletes a message.
#
# @option options [channel] :channel
# Channel containing the message to be deleted.
# @option options [timestamp] :ts
# Timestamp of the message to be deleted.
# @option options [boolean] :as_user
# Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
# @see https://api.slack.com/methods/chat.delete
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.delete.json
def chat_delete(options = {})
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('chat.delete', options)
end
#
# Deletes a pending scheduled message from the queue.
#
# @option options [channel] :channel
# The channel the scheduled_message is posting to.
# @option options [string] :scheduled_message_id
# scheduled_message_id returned from call to chat.scheduleMessage.
# @option options [boolean] :as_user
# Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.
# @see https://api.slack.com/methods/chat.deleteScheduledMessage
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.deleteScheduledMessage.json
def chat_deleteScheduledMessage(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'Required arguments :scheduled_message_id missing' if options[:scheduled_message_id].nil?
options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
post('chat.deleteScheduledMessage', options)
end
#
# Retrieve a permalink URL for a specific extant message
#
# @option options [channel] :channel
# The ID of the conversation or channel containing the message.
# @option options [string] :message_ts
# A message's ts value, uniquely identifying it within a channel.
# @see https://api.slack.com/methods/chat.getPermalink
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.getPermalink.json
def chat_getPermalink(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'Required arguments :message_ts missing' if options[:message_ts].nil?
options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
post('chat.getPermalink', options)
end
#
# Share a me message into a channel.
#
# @option options [channel] :channel
# Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
# @option options [string] :text
# Text of the message to send.
# @see https://api.slack.com/methods/chat.meMessage
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.meMessage.json
def chat_meMessage(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
post('chat.meMessage', options)
end
#
# Sends an ephemeral message to a user in a channel.
#
# @option options [channel] :channel
# Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
# @option options [string] :text
# How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
# @option options [user] :user
# id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
# @option options [boolean] :as_user
# (Legacy) Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
# @option options [string] :attachments
# A JSON-based array of structured attachments, presented as a URL-encoded string.
# @option options [blocks[] as string] :blocks
# A JSON-based array of structured blocks, presented as a URL-encoded string.
# @option options [string] :icon_emoji
# Emoji to use as the icon for this message. Overrides icon_url.
# @option options [string] :icon_url
# URL to an image to use as the icon for this message.
# @option options [boolean] :link_names
# Find and link channel names and usernames.
# @option options [string] :parse
# Change how messages are treated. Defaults to none. See below.
# @option options [string] :thread_ts
# Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.
# @option options [string] :username
# Set your bot's user name.
# @see https://api.slack.com/methods/chat.postEphemeral
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postEphemeral.json
def chat_postEphemeral(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'At least one of :attachments, :blocks, :text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil?
raise ArgumentError, 'Required arguments :user missing' if options[:user].nil?
options = options.merge(user: users_id(options)['user']['id']) if options[:user]
options = encode_options_as_json(options, %i[attachments blocks])
post('chat.postEphemeral', options)
end
#
# Sends a message to a channel.
#
# @option options [channel] :channel
# Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
# @option options [string] :attachments
# A JSON-based array of structured attachments, presented as a URL-encoded string.
# @option options [blocks[] as string] :blocks
# A JSON-based array of structured blocks, presented as a URL-encoded string.
# @option options [string] :text
# The formatted text of the message to be published. If blocks are included, this will become the fallback text used in notifications.
# @option options [boolean] :as_user
# (Legacy) Pass true to post the message as the authed user instead of as a bot. Defaults to false. Can only be used by classic Slack apps. See authorship below.
# @option options [string] :icon_emoji
# Emoji to use as the icon for this message. Overrides icon_url.
# @option options [string] :icon_url
# URL to an image to use as the icon for this message.
# @option options [boolean] :link_names
# Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
# @option options [string] :metadata
# JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.
# @option options [boolean] :mrkdwn
# Disable Slack markup parsing by setting to false. Enabled by default.
# @option options [string] :parse
# Change how messages are treated. See below.
# @option options [boolean] :reply_broadcast
# Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
# @option options [string] :thread_ts
# Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
# @option options [boolean] :unfurl_links
# Pass true to enable unfurling of primarily text-based content.
# @option options [boolean] :unfurl_media
# Pass false to disable unfurling of media content.
# @option options [string] :username
# Set your bot's user name.
# @see https://api.slack.com/methods/chat.postMessage
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
def chat_postMessage(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'At least one of :attachments, :blocks, :text is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil?
options = encode_options_as_json(options, %i[attachments blocks metadata])
post('chat.postMessage', options)
end
#
# Schedules a message to be sent to a channel.
#
# @option options [channel] :channel
# Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.
# @option options [integer] :post_at
# Unix EPOCH timestamp of time in future to send the message.
# @option options [string] :text
# How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
# @option options [boolean] :as_user
# Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.
# @option options [string] :attachments
# A JSON-based array of structured attachments, presented as a URL-encoded string.
# @option options [blocks[] as string] :blocks
# A JSON-based array of structured blocks, presented as a URL-encoded string.
# @option options [boolean] :link_names
# Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
# @option options [string] :metadata
# JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.
# @option options [string] :parse
# Change how messages are treated. See chat.postMessage.
# @option options [boolean] :reply_broadcast
# Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
# @option options [string] :thread_ts
# Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
# @option options [boolean] :unfurl_links
# Pass true to enable unfurling of primarily text-based content.
# @option options [boolean] :unfurl_media
# Pass false to disable unfurling of media content.
# @see https://api.slack.com/methods/chat.scheduleMessage
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.scheduleMessage.json
def chat_scheduleMessage(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'Required arguments :post_at missing' if options[:post_at].nil?
raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
options = encode_options_as_json(options, %i[attachments blocks metadata])
post('chat.scheduleMessage', options)
end
#
# Provide custom unfurl behavior for user-posted URLs
#
# @option options [channel] :channel
# Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together.
# @option options [timestamp] :ts
# Timestamp of the message to add unfurl behavior to.
# @option options [string] :unfurls
# URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.
# @option options [string] :source
# The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation.
# @option options [string] :unfurl_id
# The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.
# @option options [Object] :user_auth_blocks
# Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.
# @option options [Object] :user_auth_message
# Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.
# @option options [boolean] :user_auth_required
# Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.
# @option options [Object] :user_auth_url
# Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
# @see https://api.slack.com/methods/chat.unfurl
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.unfurl.json
def chat_unfurl(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
raise ArgumentError, 'Required arguments :unfurls missing' if options[:unfurls].nil?
options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
options = encode_options_as_json(options, %i[unfurls user_auth_blocks])
post('chat.unfurl', options)
end
#
# Updates a message.
#
# @option options [channel] :channel
# Channel containing the message to be updated.
# @option options [timestamp] :ts
# Timestamp of the message to be updated.
# @option options [boolean] :as_user
# Pass true to update the message as the authed user. Bot users in this context are considered authed users.
# @option options [string] :attachments
# A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text. If you don't include this field, the message's previous attachments will be retained. To remove previous attachments, include an empty array for this field.
# @option options [blocks[] as string] :blocks
# A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous blocks will be retained. To remove previous blocks, include an empty array for this field.
# @option options [array] :file_ids
# Array of new file ids that will be sent with this message.
# @option options [boolean] :link_names
# Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.
# @option options [string] :metadata
# JSON object with event_type and event_payload fields, presented as a URL-encoded string. If you don't include this field, the message's previous metadata will be retained. To remove previous metadata, include an empty object for this field. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.
# @option options [string] :parse
# Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.
# @option options [boolean] :reply_broadcast
# Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.
# @option options [string] :text
# New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments.
# @see https://api.slack.com/methods/chat.update
# @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.update.json
def chat_update(options = {})
raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
raise ArgumentError, 'At least one of :attachments, :blocks, :text, :reply_broadcast is required' if options[:attachments].nil? && options[:blocks].nil? && options[:text].nil? && options[:reply_broadcast].nil?
options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
options = encode_options_as_json(options, %i[attachments blocks metadata])
post('chat.update', options)
end
end
end
end
end
end