discordrb 3.4.3 → 3.6.0

data/lib/discordrb/data/interaction.rb

@@ -0,0 +1,937 @@
+# frozen_string_literal: true
+
+require 'discordrb/webhooks'
+
+module Discordrb
+  # Base class for interaction objects.
+  class Interaction
+    # Interaction types.
+    # @see https://discord.com/developers/docs/interactions/slash-commands#interaction-interactiontype
+    TYPES = {
+      ping: 1,
+      command: 2,
+      component: 3,
+      autocomplete: 4,
+      modal_submit: 5
+    }.freeze
+
+    # Interaction response types.
+    # @see https://discord.com/developers/docs/interactions/slash-commands#interaction-response-interactioncallbacktype
+    CALLBACK_TYPES = {
+      pong: 1,
+      channel_message: 4,
+      deferred_message: 5,
+      deferred_update: 6,
+      update_message: 7,
+      autocomplete: 8,
+      modal: 9
+    }.freeze
+
+    # @return [User, Member] The user that initiated the interaction.
+    attr_reader :user
+
+    # @return [Integer, nil] The ID of the server this interaction originates from.
+    attr_reader :server_id
+
+    # @return [Integer] The ID of the channel this interaction originates from.
+    attr_reader :channel_id
+
+    # @return [Integer] The ID of this interaction.
+    attr_reader :id
+
+    # @return [Integer] The ID of the application associated with this interaction.
+    attr_reader :application_id
+
+    # @return [String] The interaction token.
+    attr_reader :token
+
+    # @!visibility private
+    # @return [Integer] Currently pointless
+    attr_reader :version
+
+    # @return [Integer] The type of this interaction.
+    # @see TYPES
+    attr_reader :type
+
+    # @return [Hash] The interaction data.
+    attr_reader :data
+
+    # @return [Array<ActionRow>]
+    attr_reader :components
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+
+      @id = data['id'].to_i
+      @application_id = data['application_id'].to_i
+      @type = data['type']
+      @message = data['message']
+      @data = data['data']
+      @server_id = data['guild_id']&.to_i
+      @channel_id = data['channel_id']&.to_i
+      @user = if data['member']
+                data['member']['guild_id'] = @server_id
+                Discordrb::Member.new(data['member'], bot.servers[@server_id], bot)
+              else
+                bot.ensure_user(data['user'])
+              end
+      @token = data['token']
+      @version = data['version']
+      @components = @data['components']&.map { |component| Components.from_data(component, @bot) }&.compact || []
+    end
+
+    # Respond to the creation of this interaction. An interaction must be responded to or deferred,
+    # The response may be modified with {Interaction#edit_response} or deleted with {Interaction#delete_response}.
+    # Further messages can be sent with {Interaction#send_message}.
+    # @param content [String] The content of the message.
+    # @param tts [true, false]
+    # @param embeds [Array<Hash, Webhooks::Embed>] The embeds for the message.
+    # @param allowed_mentions [Hash, AllowedMentions] Mentions that can ping on this message.
+    # @param flags [Integer] Message flags.
+    # @param ephemeral [true, false] Whether this message should only be visible to the interaction initiator.
+    # @param wait [true, false] Whether this method should return a Message object of the interaction response.
+    # @param components [Array<#to_h>] An array of components.
+    # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`.
+    # @yieldparam builder [Webhooks::Builder] An optional message builder. Arguments passed to the method overwrite builder data.
+    # @yieldparam view [Webhooks::View] A builder for creating interaction components.
+    def respond(content: nil, tts: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: nil, wait: false, components: nil, attachments: nil)
+      flags |= 1 << 6 if ephemeral
+
+      builder = Discordrb::Webhooks::Builder.new
+      view = Discordrb::Webhooks::View.new
+
+      # Set builder defaults from parameters
+      prepare_builder(builder, content, embeds, allowed_mentions)
+      yield(builder, view) if block_given?
+
+      components ||= view
+      data = builder.to_json_hash
+
+      Discordrb::API::Interaction.create_interaction_response(@token, @id, CALLBACK_TYPES[:channel_message], data[:content], tts, data[:embeds], data[:allowed_mentions], flags, components.to_a, attachments)
+
+      return unless wait
+
+      response = Discordrb::API::Interaction.get_original_interaction_response(@token, @application_id)
+      Interactions::Message.new(JSON.parse(response), @bot, @interaction)
+    end
+
+    # Defer an interaction, setting a temporary response that can be later overriden by {Interaction#send_message}.
+    # This method is used when you want to use a single message for your response but require additional processing time, or to simply ack
+    # an interaction so an error is not displayed.
+    # @param flags [Integer] Message flags.
+    # @param ephemeral [true, false] Whether this message should only be visible to the interaction initiator.
+    def defer(flags: 0, ephemeral: true)
+      flags |= 1 << 6 if ephemeral
+
+      Discordrb::API::Interaction.create_interaction_response(@token, @id, CALLBACK_TYPES[:deferred_message], nil, nil, nil, nil, flags)
+      nil
+    end
+
+    # Defer an update to an interaction. This is can only currently used by Button interactions.
+    def defer_update
+      Discordrb::API::Interaction.create_interaction_response(@token, @id, CALLBACK_TYPES[:deferred_update])
+    end
+
+    # Create a modal as a response.
+    # @param title [String] The title of the modal being shown.
+    # @param custom_id [String] The custom_id used to identify the modal and store data.
+    # @param components [Array<Component, Hash>, nil] An array of components. These can be defined through the block as well.
+    # @yieldparam [Discordrb::Webhooks::Modal] A builder for the modal's components.
+    def show_modal(title:, custom_id:, components: nil)
+      if block_given?
+        modal_builder = Discordrb::Webhooks::Modal.new
+        yield modal_builder
+
+        components = modal_builder.to_a
+      end
+
+      Discordrb::API::Interaction.create_interaction_modal_response(@token, @id, custom_id, title, components.to_a) unless type == Interaction::TYPES[:modal_submit]
+      nil
+    end
+
+    # Respond to the creation of this interaction. An interaction must be responded to or deferred,
+    # The response may be modified with {Interaction#edit_response} or deleted with {Interaction#delete_response}.
+    # Further messages can be sent with {Interaction#send_message}.
+    # @param content [String] The content of the message.
+    # @param tts [true, false]
+    # @param embeds [Array<Hash, Webhooks::Embed>] The embeds for the message.
+    # @param allowed_mentions [Hash, AllowedMentions] Mentions that can ping on this message.
+    # @param flags [Integer] Message flags.
+    # @param ephemeral [true, false] Whether this message should only be visible to the interaction initiator.
+    # @param wait [true, false] Whether this method should return a Message object of the interaction response.
+    # @param components [Array<#to_h>] An array of components.
+    # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`.
+    # @yieldparam builder [Webhooks::Builder] An optional message builder. Arguments passed to the method overwrite builder data.
+    # @yieldparam view [Webhooks::View] A builder for creating interaction components.
+    def update_message(content: nil, tts: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: nil, wait: false, components: nil, attachments: nil)
+      flags |= 1 << 6 if ephemeral
+
+      builder = Discordrb::Webhooks::Builder.new
+      view = Discordrb::Webhooks::View.new
+
+      prepare_builder(builder, content, embeds, allowed_mentions)
+      yield(builder, view) if block_given?
+
+      components ||= view
+      data = builder.to_json_hash
+
+      Discordrb::API::Interaction.create_interaction_response(@token, @id, CALLBACK_TYPES[:update_message], data[:content], tts, data[:embeds], data[:allowed_mentions], flags, components.to_a, attachments)
+
+      return unless wait
+
+      response = Discordrb::API::Interaction.get_original_interaction_response(@token, @application_id)
+      Interactions::Message.new(JSON.parse(response), @bot, @interaction)
+    end
+
+    # Edit the original response to this interaction.
+    # @param content [String] The content of the message.
+    # @param embeds [Array<Hash, Webhooks::Embed>] The embeds for the message.
+    # @param allowed_mentions [Hash, AllowedMentions] Mentions that can ping on this message.
+    # @param components [Array<#to_h>] An array of components.
+    # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`.
+    # @return [InteractionMessage] The updated response message.
+    # @yieldparam builder [Webhooks::Builder] An optional message builder. Arguments passed to the method overwrite builder data.
+    def edit_response(content: nil, embeds: nil, allowed_mentions: nil, components: nil, attachments: nil)
+      builder = Discordrb::Webhooks::Builder.new
+      view = Discordrb::Webhooks::View.new
+
+      prepare_builder(builder, content, embeds, allowed_mentions)
+      yield(builder, view) if block_given?
+
+      components ||= view
+      data = builder.to_json_hash
+      resp = Discordrb::API::Interaction.edit_original_interaction_response(@token, @application_id, data[:content], data[:embeds], data[:allowed_mentions], components.to_a, attachments)
+
+      Interactions::Message.new(JSON.parse(resp), @bot, @interaction)
+    end
+
+    # Delete the original interaction response.
+    def delete_response
+      Discordrb::API::Interaction.delete_original_interaction_response(@token, @application_id)
+    end
+
+    # @param content [String] The content of the message.
+    # @param tts [true, false]
+    # @param embeds [Array<Hash, Webhooks::Embed>] The embeds for the message.
+    # @param allowed_mentions [Hash, AllowedMentions] Mentions that can ping on this message.
+    # @param flags [Integer] Message flags.
+    # @param ephemeral [true, false] Whether this message should only be visible to the interaction initiator.
+    # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`.
+    # @yieldparam builder [Webhooks::Builder] An optional message builder. Arguments passed to the method overwrite builder data.
+    def send_message(content: nil, embeds: nil, tts: false, allowed_mentions: nil, flags: 0, ephemeral: false, components: nil, attachments: nil)
+      flags |= 64 if ephemeral
+
+      builder = Discordrb::Webhooks::Builder.new
+      view = Discordrb::Webhooks::View.new
+
+      prepare_builder(builder, content, embeds, allowed_mentions)
+      yield builder, view if block_given?
+
+      components ||= view
+      data = builder.to_json_hash
+
+      resp = Discordrb::API::Webhook.token_execute_webhook(
+        @token, @application_id, true, data[:content], nil, nil, tts, nil, data[:embeds], data[:allowed_mentions], flags, components.to_a, attachments
+      )
+      Interactions::Message.new(JSON.parse(resp), @bot, @interaction)
+    end
+
+    # @param message [String, Integer, InteractionMessage, Message] The message created by this interaction to be edited.
+    # @param content [String] The message content.
+    # @param embeds [Array<Hash, Webhooks::Embed>] The embeds for the message.
+    # @param allowed_mentions [Hash, AllowedMentions] Mentions that can ping on this message.
+    # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`.
+    # @yieldparam builder [Webhooks::Builder] An optional message builder. Arguments passed to the method overwrite builder data.
+    def edit_message(message, content: nil, embeds: nil, allowed_mentions: nil, components: nil, attachments: nil)
+      builder = Discordrb::Webhooks::Builder.new
+      view = Discordrb::Webhooks::View.new
+
+      prepare_builder(builder, content, embeds, allowed_mentions)
+      yield builder, view if block_given?
+
+      components ||= view
+      data = builder.to_json_hash
+
+      resp = Discordrb::API::Webhook.token_edit_message(
+        @token, @application_id, message.resolve_id, data[:content], data[:embeds], data[:allowed_mentions], components.to_a, attachments
+      )
+      Interactions::Message.new(JSON.parse(resp), @bot, @interaction)
+    end
+
+    # @param message [Integer, String, InteractionMessage, Message] The message created by this interaction to be deleted.
+    def delete_message(message)
+      Discordrb::API::Webhook.token_delete_message(@token, @application_id, message.resolve_id)
+      nil
+    end
+
+    # Show autocomplete choices as a response.
+    # @param choices [Array<Hash>, Hash] Array of autocomplete choices to show the user.
+    def show_autocomplete_choices(choices)
+      choices = choices.map { |name, value| { name: name, value: value } } unless choices.is_a?(Array)
+      Discordrb::API::Interaction.create_interaction_response(@token, @id, CALLBACK_TYPES[:autocomplete], nil, nil, nil, nil, nil, nil, nil, choices)
+      nil
+    end
+
+    # @return [Server, nil] This will be nil for interactions that occur in DM channels or servers where the bot
+    #   does not have the `bot` scope.
+    def server
+      @bot.server(@server_id)
+    end
+
+    # @return [Channel, nil]
+    # @raise [Errors::NoPermission] When the bot is not in the server associated with this interaction.
+    def channel
+      @bot.channel(@channel_id)
+    end
+
+    # @return [Hash, nil] Returns the button that triggered this interaction if applicable, otherwise nil
+    def button
+      return unless @type == TYPES[:component]
+
+      @message['components'].each do |row|
+        Components::ActionRow.new(row, @bot).buttons.each do |button|
+          return button if button.custom_id == @data['custom_id']
+        end
+      end
+    end
+
+    # @return [Array<TextInput>]
+    def text_inputs
+      @components&.select { |component| component.is_a? TextInput } | []
+    end
+
+    # @return [TextInput, Button, SelectMenu]
+    def get_component(custom_id)
+      top_level = @components.flat_map(&:components) || []
+      message_level = (@message.instance_of?(Hash) ? Message.new(@message, @bot) : @message)&.components&.flat_map(&:components) || []
+      components = top_level.concat(message_level)
+      components.find { |component| component.custom_id == custom_id }
+    end
+
+    private
+
+    # Set builder defaults from parameters
+    # @param builder [Discordrb::Webhooks::Builder]
+    # @param content [String, nil]
+    # @param embeds [Array<Hash, Discordrb::Webhooks::Embed>, nil]
+    # @param allowed_mentions [AllowedMentions, Hash, nil]
+    def prepare_builder(builder, content, embeds, allowed_mentions)
+      builder.content = content
+      builder.allowed_mentions = allowed_mentions
+      embeds&.each { |embed| builder << embed }
+    end
+  end
+
+  # An ApplicationCommand for slash commands.
+  class ApplicationCommand
+    # Command types. `chat_input` is a command that appears in the text input field. `user` and `message` types appear as context menus
+    # for the respective resource.
+    TYPES = {
+      chat_input: 1,
+      user: 2,
+      message: 3
+    }.freeze
+
+    # @return [Integer]
+    attr_reader :application_id
+
+    # @return [Integer, nil]
+    attr_reader :server_id
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_reader :description
+
+    # @return [true, false]
+    attr_reader :default_permission
+
+    # @return [Hash]
+    attr_reader :options
+
+    # @return [Integer]
+    attr_reader :id
+
+    # @return [true, false]
+    attr_reader :nsfw
+
+    # @!visibility private
+    def initialize(data, bot, server_id = nil)
+      @bot = bot
+      @id = data['id'].to_i
+      @application_id = data['application_id'].to_i
+      @server_id = server_id&.to_i
+
+      @name = data['name']
+      @description = data['description']
+      @default_permission = data['default_permission']
+      @options = data['options']
+      @nsfw = data['nsfw'] || false
+    end
+
+    # @param subcommand [String, nil] The subcommand to mention.
+    # @param subcommand_group [String, nil] The subcommand group to mention.
+    # @return [String] the layout to mention it in a message
+    def mention(subcommand_group: nil, subcommand: nil)
+      if subcommand_group && subcommand
+        "</#{name} #{subcommand_group} #{subcommand}:#{id}>"
+      elsif subcommand_group
+        "</#{name} #{subcommand_group}:#{id}>"
+      elsif subcommand
+        "</#{name} #{subcommand}:#{id}>"
+      else
+        "</#{name}:#{id}>"
+      end
+    end
+
+    alias_method :to_s, :mention
+
+    # @param name [String] The name to use for this command.
+    # @param description [String] The description of this command.
+    # @param default_permission [true, false] Whether this command is available with default permissions.
+    # @param nsfw [true, false] Whether this command should be marked as age-restricted.
+    # @yieldparam (see Bot#edit_application_command)
+    # @return (see Bot#edit_application_command)
+    def edit(name: nil, description: nil, default_permission: nil, nsfw: nil, &block)
+      @bot.edit_application_command(@id, server_id: @server_id, name: name, description: description, default_permission: default_permission, nsfw: nsfw, &block)
+    end
+
+    # Delete this application command.
+    # @return (see Bot#delete_application_command)
+    def delete
+      @bot.delete_application_command(@id, server_id: @server_id)
+    end
+
+    # Get the permission configuration for the this application command on a specific server.
+    # @param server_id [Integer, String, nil] The ID of the server to fetch command permissions for.
+    # @return [Array<Permission>] the permissions for this application command in the given server.
+    def permissions(server_id: nil)
+      raise ArgumentError, 'A server ID must be provided for global application commands' if @server_id.nil? && server_id.nil?
+
+      response = JSON.parse(API::Application.get_application_command_permissions(@bot.token, @bot.profile.id, @server_id || server_id&.resolve_id, @id))
+      response['permissions'].map { |permission| Permission.new(permission, response, @bot) }
+    rescue Discordrb::Errors::UnknownError
+      # If there aren't any explicit overwrites configured for the command, the response is a 400.
+      []
+    end
+
+    # An application command permission for a channel, member, or a role.
+    class Permission
+      # Map of permission types.
+      TYPES = {
+        role: 1,
+        member: 2,
+        channel: 3
+      }.freeze
+
+      # @return [Integer] the type of this permission.
+      # @see TYPES
+      attr_reader :type
+
+      # @return [Integer] the ID of the thing this permission is for.
+      attr_reader :target_id
+
+      # @return [Integer] the ID of the server this permission is for.
+      attr_reader :server_id
+
+      # @!visibility private
+      def initialize(data, command, bot)
+        @bot = bot
+        @type = data['type']
+        @target_id = data['id'].to_i
+        @overwrite = data['permission']
+        @command_id = command['id'].to_i
+        @server_id = command['guild_id'].to_i
+        @application_id = command['application_id'].to_i
+      end
+
+      # Whether this permission has been allowed, e.g has a green check in the UI.
+      # @return [true, false]
+      def allowed?
+        @overwrite == true
+      end
+
+      # Whether this permission has been denied, e.g has a red check in the UI.
+      # @return [true, false]
+      def denied?
+        @overwrite == false
+      end
+
+      # Whether this permission is applied to the everyone role in the server.
+      # @return [true, false]
+      def everyone?
+        @target_id == @server_id
+      end
+
+      # Whether this permission is the default for all commands that don't
+      #  contain explicit permission oerwrites.
+      # @return [true, false]
+      def default?
+        @command_id == @application_id
+      end
+
+      # Whether this permission is applied to every channel in the server.
+      # @return [true, false]
+      def all_channels?
+        @target_id == (@server_id - 1)
+      end
+
+      # Get the user, role, or channel(s) that this permission targets.
+      # @return [Array<Channel>, Role, Member]
+      def target
+        case @type
+        when TYPES[:role]
+          @bot.server(@server_id).role(@target_id)
+        when TYPES[:member]
+          @bot.server(@server_id).member(@target_id)
+        when TYPES[:channel]
+          all_channels ? @bot.server(@server_id).channels : [@bot.channel(@target_id)]
+        end
+      end
+
+      alias_method :targets, :target
+
+      # @!method role?
+      #   @return [true, false] whether this permission is for a role.
+      # @!method member?
+      #   @return [true, false] whether this permission is for a member.
+      # @!method channel?
+      #   @return [true, false] whether this permission is for a channel.
+      TYPES.each do |name, value|
+        define_method("#{name}?") do
+          @type == value
+        end
+      end
+    end
+  end
+
+  # Objects specific to Interactions.
+  module Interactions
+    # A builder for defining slash commands options.
+    class OptionBuilder
+      # @!visibility private
+      TYPES = {
+        subcommand: 1,
+        subcommand_group: 2,
+        string: 3,
+        integer: 4,
+        boolean: 5,
+        user: 6,
+        channel: 7,
+        role: 8,
+        mentionable: 9,
+        number: 10,
+        attachment: 11
+      }.freeze
+
+      # Channel types that can be provided to #channel
+      CHANNEL_TYPES = {
+        text: 0,
+        dm: 1,
+        voice: 2,
+        group_dm: 3,
+        category: 4,
+        news: 5,
+        store: 6,
+        news_thread: 10,
+        public_thread: 11,
+        private_thread: 12,
+        stage: 13
+      }.freeze
+
+      # @return [Array<Hash>]
+      attr_reader :options
+
+      # @!visibility private
+      def initialize
+        @options = []
+      end
+
+      # @param name [String, Symbol] The name of the subcommand.
+      # @param description [String] A description of the subcommand.
+      # @yieldparam [OptionBuilder]
+      # @return (see #option)
+      # @example
+      #   bot.register_application_command(:test, 'Test command') do |cmd|
+      #     cmd.subcommand(:echo) do |sub|
+      #       sub.string('message', 'What to echo back', required: true)
+      #     end
+      #   end
+      def subcommand(name, description)
+        builder = OptionBuilder.new
+        yield builder if block_given?
+
+        option(TYPES[:subcommand], name, description, options: builder.to_a)
+      end
+
+      # @param name [String, Symbol] The name of the subcommand group.
+      # @param description [String] A description of the subcommand group.
+      # @yieldparam [OptionBuilder]
+      # @return (see #option)
+      # @example
+      #   bot.register_application_command(:test, 'Test command') do |cmd|
+      #     cmd.subcommand_group(:fun) do |group|
+      #       group.subcommand(:8ball) do |sub|
+      #         sub.string(:question, 'What do you ask the mighty 8ball?')
+      #       end
+      #     end
+      #   end
+      def subcommand_group(name, description)
+        builder = OptionBuilder.new
+        yield builder
+
+        option(TYPES[:subcommand_group], name, description, options: builder.to_a)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @param min_length [Integer] A minimum length for option value.
+      # @param max_length [Integer] A maximum length for option value.
+      # @param choices [Hash, nil] Available choices, mapped as `Name => Value`.
+      # @param autocomplete [true, false] Whether this option can dynamically show choices.
+      # @return (see #option)
+      def string(name, description, required: nil, min_length: nil, max_length: nil, choices: nil, autocomplete: nil)
+        option(TYPES[:string], name, description,
+               required: required, min_length: min_length, max_length: max_length, choices: choices, autocomplete: autocomplete)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @param min_value [Integer] A minimum value for option.
+      # @param max_value [Integer] A maximum value for option.
+      # @param choices [Hash, nil] Available choices, mapped as `Name => Value`.
+      # @param autocomplete [true, false] Whether this option can dynamically show choices.
+      # @return (see #option)
+      def integer(name, description, required: nil, min_value: nil, max_value: nil, choices: nil, autocomplete: nil)
+        option(TYPES[:integer], name, description,
+               required: required, min_value: min_value, max_value: max_value, choices: choices, autocomplete: autocomplete)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @return (see #option)
+      def boolean(name, description, required: nil)
+        option(TYPES[:boolean], name, description, required: required)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @return (see #option)
+      def user(name, description, required: nil)
+        option(TYPES[:user], name, description, required: required)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @param types [Array<Symbol, Integer>] See {CHANNEL_TYPES}
+      # @return (see #option)
+      def channel(name, description, required: nil, types: nil)
+        types = types&.collect { |type| type.is_a?(Numeric) ? type : CHANNEL_TYPES[type] }
+        option(TYPES[:channel], name, description, required: required, channel_types: types)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @return (see #option)
+      def role(name, description, required: nil)
+        option(TYPES[:role], name, description, required: required)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @return (see #option)
+      def mentionable(name, description, required: nil)
+        option(TYPES[:mentionable], name, description, required: required)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @param min_value [Float] A minimum value for option.
+      # @param max_value [Float] A maximum value for option.
+      # @param autocomplete [true, false] Whether this option can dynamically show choices.
+      # @return (see #option)
+      def number(name, description, required: nil, min_value: nil, max_value: nil, choices: nil, autocomplete: nil)
+        option(TYPES[:number], name, description,
+               required: required, min_value: min_value, max_value: max_value, choices: choices, autocomplete: autocomplete)
+      end
+
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @return (see #option)
+      def attachment(name, description, required: nil)
+        option(TYPES[:attachment], name, description, required: required)
+      end
+
+      # @!visibility private
+      # @param type [Integer] The argument type.
+      # @param name [String, Symbol] The name of the argument.
+      # @param description [String] A description of the argument.
+      # @param required [true, false] Whether this option must be provided.
+      # @param min_value [Integer, Float] A minimum value for integer and number options.
+      # @param max_value [Integer, Float] A maximum value for integer and number options.
+      # @param min_length [Integer] A minimum length for string option value.
+      # @param max_length [Integer] A maximum length for string option value.
+      # @param channel_types [Array<Integer>] Channel types that can be provides for channel options.
+      # @param autocomplete [true, false] Whether this option can dynamically show options.
+      # @return Hash
+      def option(type, name, description, required: nil, choices: nil, options: nil, min_value: nil, max_value: nil,
+                 min_length: nil, max_length: nil, channel_types: nil, autocomplete: nil)
+        opt = { type: type, name: name, description: description }
+        choices = choices.map { |option_name, value| { name: option_name, value: value } } if choices
+
+        opt.merge!({ required: required, choices: choices, options: options, min_value: min_value,
+                     max_value: max_value, min_length: min_length, max_length: max_length,
+                     channel_types: channel_types, autocomplete: autocomplete }.compact)
+
+        @options << opt
+        opt
+      end
+
+      # @return [Array<Hash>]
+      def to_a
+        @options
+      end
+    end
+
+    # Builder for creating server application command permissions.
+    # @deprecated This system is being replaced in the near future.
+    class PermissionBuilder
+      # Role permission type
+      ROLE = 1
+      # User permission type
+      USER = 2
+
+      # @!visibility hidden
+      def initialize
+        @permissions = []
+      end
+
+      # Allow a role to use this command.
+      # @param role_id [Integer]
+      # @return [PermissionBuilder]
+      def allow_role(role_id)
+        create_entry(role_id, ROLE, true)
+      end
+
+      # Deny a role usage of this command.
+      # @param role_id [Integer]
+      # @return [PermissionBuilder]
+      def deny_role(role_id)
+        create_entry(role_id, ROLE, false)
+      end
+
+      # Allow a user to use this command.
+      # @param user_id [Integer]
+      # @return [PermissionBuilder]
+      def allow_user(user_id)
+        create_entry(user_id, USER, true)
+      end
+
+      # Deny a user usage of this command.
+      # @param user_id [Integer]
+      # @return [PermissionBuilder]
+      def deny_user(user_id)
+        create_entry(user_id, USER, false)
+      end
+
+      # Allow an entity to use this command.
+      # @param object [Role, User, Member]
+      # @return [PermissionBuilder]
+      # @raise [ArgumentError]
+      def allow(object)
+        case object
+        when Discordrb::User, Discordrb::Member
+          create_entry(object.id, USER, true)
+        when Discordrb::Role
+          create_entry(object.id, ROLE, true)
+        else
+          raise ArgumentError, "Unable to create permission for unknown type: #{object.class}"
+        end
+      end
+
+      # Deny an entity usage of this command.
+      # @param object [Role, User, Member]
+      # @return [PermissionBuilder]
+      # @raise [ArgumentError]
+      def deny(object)
+        case object
+        when Discordrb::User, Discordrb::Member
+          create_entry(object.id, USER, false)
+        when Discordrb::Role
+          create_entry(object.id, ROLE, false)
+        else
+          raise ArgumentError, "Unable to create permission for unknown type: #{object.class}"
+        end
+      end
+
+      # @!visibility private
+      # @return [Array<Hash>]
+      def to_a
+        @permissions
+      end
+
+      private
+
+      def create_entry(id, type, permission)
+        @permissions << { id: id, type: type, permission: permission }
+        self
+      end
+    end
+
+    # A message partial for interactions.
+    class Message
+      include IDObject
+
+      # @return [Interaction] The interaction that created this message.
+      attr_reader :interaction
+
+      # @return [String, nil] The content of the message.
+      attr_reader :content
+
+      # @return [true, false] Whether this message is pinned in the channel it belongs to.
+      attr_reader :pinned
+
+      # @return [true, false]
+      attr_reader :tts
+
+      # @return [Time]
+      attr_reader :timestamp
+
+      # @return [Time, nil]
+      attr_reader :edited_timestamp
+
+      # @return [true, false]
+      attr_reader :edited
+
+      # @return [Integer]
+      attr_reader :id
+
+      # @return [User] The user of the application.
+      attr_reader :author
+
+      # @return [Attachment]
+      attr_reader :attachments
+
+      # @return [Array<Embed>]
+      attr_reader :embeds
+
+      # @return [Array<User>]
+      attr_reader :mentions
+
+      # @return [Integer]
+      attr_reader :flags
+
+      # @return [Integer]
+      attr_reader :channel_id
+
+      # @return [Hash, nil]
+      attr_reader :message_reference
+
+      # @return [Array<Component>]
+      attr_reader :components
+
+      # @!visibility private
+      def initialize(data, bot, interaction)
+        @data = data
+        @bot = bot
+        @interaction = interaction
+        @content = data['content']
+        @channel_id = data['channel_id'].to_i
+        @pinned = data['pinned']
+        @tts = data['tts']
+
+        @message_reference = data['message_reference']
+
+        @server_id = data['guild_id']&.to_i
+
+        @timestamp = Time.parse(data['timestamp']) if data['timestamp']
+        @edited_timestamp = data['edited_timestamp'].nil? ? nil : Time.parse(data['edited_timestamp'])
+        @edited = !@edited_timestamp.nil?
+
+        @id = data['id'].to_i
+
+        @author = bot.ensure_user(data['author'] || data['member']['user'])
+
+        @attachments = []
+        @attachments = data['attachments'].map { |e| Attachment.new(e, self, @bot) } if data['attachments']
+
+        @embeds = []
+        @embeds = data['embeds'].map { |e| Embed.new(e, self) } if data['embeds']
+
+        @mentions = []
+
+        data['mentions']&.each do |element|
+          @mentions << bot.ensure_user(element)
+        end
+
+        @mention_roles = data['mention_roles']
+        @mention_everyone = data['mention_everyone']
+        @flags = data['flags']
+        @pinned = data['pinned']
+        @components = data['components'].map { |component_data| Components.from_data(component_data, @bot) } if data['components']
+      end
+
+      # @return [Member, nil] This will return nil if the bot does not have access to the
+      #   server the interaction originated in.
+      def member
+        server&.member(@user.id)
+      end
+
+      # @return [Server, nil] This will return nil if the bot does not have access to the
+      #   server the interaction originated in.
+      def server
+        @bot.server(@server_id)
+      end
+
+      # @return [Channel] The channel the interaction originates from.
+      # @raise [Errors::NoPermission] When the bot is not in the server associated with this interaction.
+      def channel
+        @bot.channel(@channel_id)
+      end
+
+      # Respond to this message.
+      # @param (see Interaction#send_message)
+      # @yieldparam (see Interaction#send_message)
+      def respond(content: nil, embeds: nil, allowed_mentions: nil, flags: 0, ephemeral: true, components: nil, attachments: nil, &block)
+        @interaction.send_message(content: content, embeds: embeds, allowed_mentions: allowed_mentions, flags: flags, ephemeral: ephemeral, components: components, attachments: attachments, &block)
+      end
+
+      # Delete this message.
+      def delete
+        @interaction.delete_message(@id)
+      end
+
+      # Edit this message's data.
+      # @param content (see Interaction#send_message)
+      # @param embeds (see Interaction#send_message)
+      # @param allowed_mentions (see Interaction#send_message)
+      # @yieldparam (see Interaction#send_message)
+      def edit(content: nil, embeds: nil, allowed_mentions: nil, components: nil, attachments: nil, &block)
+        @interaction.edit_message(@id, content: content, embeds: embeds, allowed_mentions: allowed_mentions, components: components, attachments: attachments, &block)
+      end
+
+      # @return [Discordrb::Message]
+      def to_message
+        Discordrb::Message.new(@data, @bot)
+      end
+
+      alias_method :message, :to_message
+
+      # @!visibility private
+      def inspect
+        "<Interaction::Message content=#{@content.inspect} embeds=#{@embeds.inspect} channel_id=#{@channel_id} server_id=#{@server_id} author=#{@author.inspect}>"
+      end
+    end
+  end
+end