discorb 0.16.0 → 0.18.0

data/sig/discorb/interaction/message_component.rbs

@@ -0,0 +1,140 @@
+module Discorb
+  #
+  # Represents a message component interaction.
+  # @abstract
+  class MessageComponentInteraction < Discorb::Interaction
+    include Discorb::Interaction::SourceResponder
+    include Discorb::Interaction::UpdateResponder
+    include Discorb::Interaction::ModalResponder
+
+    #
+    # Initialize a new message component interaction.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    #
+    # Create a MessageComponentInteraction instance for the given data.
+    # @private
+    def self.make_interaction: (untyped client, untyped data) -> untyped
+
+    #
+    # Returns the classes under this class.
+    # @private
+    def self.nested_classes: -> untyped
+
+    #
+    # Response with `MODAL`(`9`).
+    #
+    # @param [String] title The title of the modal.
+    # @param [String] custom_id The custom id of the modal.
+    # @param [Array<Discorb::TextInput>] components The text inputs to send.
+    #
+    # @return [Async::Task<void>] The task.
+    def show_modal: (
+      String title,
+      String custom_id,
+      ::Array[Discorb::TextInput] components
+    ) -> Async::Task[void]
+
+    #
+    # Response with `DEFERRED_UPDATE_MESSAGE`(`6`).
+    # @async
+    #
+    # @param [Boolean] ephemeral Whether to make the response ephemeral.
+    #
+    # @return [Async::Task<void>] The task.
+    def defer_update: (?ephemeral: bool) -> Async::Task[void]
+
+    #
+    # Response with `UPDATE_MESSAGE`(`7`).
+    #
+    # @async
+    #
+    # @param [String] content The content of the response.
+    # @param [Boolean] tts Whether to send the message as text-to-speech.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discorb::Embed>] embeds The embeds to send. (max: 10)
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Boolean] ephemeral Whether to make the response ephemeral.
+    #
+    # @return [Async::Task<void>] The task.
+    def edit: (
+      String content,
+      ?tts: bool,
+      ?embed: Discorb::Embed?,
+      ?embeds: ::Array[Discorb::Embed]?,
+      ?allowed_mentions: Discorb::AllowedMentions?,
+      ?components: (::Array[Discorb::Component]
+      | ::Array[::Array[Discorb::Component]])?,
+      ?ephemeral: bool
+    ) -> Async::Task[void]
+
+    #
+    # Response with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`(`5`).
+    #
+    # @async
+    #
+    # @param [Boolean] ephemeral Whether to make the response ephemeral.
+    #
+    # @return [Async::Task<void>] The task.
+    def defer_source: (?ephemeral: bool) -> Async::Task[void]
+
+    #
+    # Response with `CHANNEL_MESSAGE_WITH_SOURCE`(`4`).
+    #
+    # @async
+    #
+    # @param [String] content The content of the response.
+    # @param [Boolean] tts Whether to send the message as text-to-speech.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discorb::Embed>] embeds The embeds to send. (max: 10)
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Boolean] ephemeral Whether to make the response ephemeral.
+    #
+    # @return [Discorb::Interaction::SourceResponder::CallbackMessage, Discorb::Webhook::Message]
+    #   The callback message.
+    def post: (
+      ?String? content,
+      ?tts: bool,
+      ?embed: Discorb::Embed?,
+      ?embeds: ::Array[Discorb::Embed]?,
+      ?allowed_mentions: Discorb::AllowedMentions?,
+      ?components: (::Array[Discorb::Component]
+      | ::Array[::Array[Discorb::Component]])?,
+      ?ephemeral: bool
+    ) -> (Discorb::Interaction::SourceResponder::CallbackMessage
+    | Discorb::Webhook::Message)
+
+    # @return [String] The content of the response.
+    attr_reader custom_id: String
+
+    # @return [Discorb::Message] The target message.
+    attr_reader message: Discorb::Message
+
+    #
+    # Represents a button interaction.
+    class Button < Discorb::MessageComponentInteraction
+      # @return [String] The custom id of the button.
+      attr_reader custom_id: String
+    end
+
+    #
+    # Represents a select menu interaction.
+    class SelectMenu < Discorb::MessageComponentInteraction
+      # @return [String] The custom id of the select menu.
+      attr_reader custom_id: String
+
+      # @return [Array<String>] The selected options.
+      attr_reader values: ::Array[String]
+
+      # @!attribute [r] value
+      #   @return [String] The first selected value.
+      attr_reader value: untyped
+    end
+  end
+end

data/sig/discorb/interaction/modal.rbs

@@ -0,0 +1,50 @@
+module Discorb
+  #
+  # Represents a modal interaction.
+  class ModalInteraction < Discorb::Interaction
+    include Discorb::Interaction::SourceResponder
+
+    #
+    # Response with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`(`5`).
+    #
+    # @async
+    #
+    # @param [Boolean] ephemeral Whether to make the response ephemeral.
+    #
+    # @return [Async::Task<void>] The task.
+    def defer_source: (?ephemeral: bool) -> Async::Task[void]
+
+    #
+    # Response with `CHANNEL_MESSAGE_WITH_SOURCE`(`4`).
+    #
+    # @async
+    #
+    # @param [String] content The content of the response.
+    # @param [Boolean] tts Whether to send the message as text-to-speech.
+    # @param [Discorb::Embed] embed The embed to send.
+    # @param [Array<Discorb::Embed>] embeds The embeds to send. (max: 10)
+    # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
+    # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+    # @param [Boolean] ephemeral Whether to make the response ephemeral.
+    #
+    # @return [Discorb::Interaction::SourceResponder::CallbackMessage, Discorb::Webhook::Message]
+    #   The callback message.
+    def post: (
+      ?String? content,
+      ?tts: bool,
+      ?embed: Discorb::Embed?,
+      ?embeds: ::Array[Discorb::Embed]?,
+      ?allowed_mentions: Discorb::AllowedMentions?,
+      ?components: (::Array[Discorb::Component]
+      | ::Array[::Array[Discorb::Component]])?,
+      ?ephemeral: bool
+    ) -> (Discorb::Interaction::SourceResponder::CallbackMessage
+    | Discorb::Webhook::Message)
+
+    # @return [String] The custom id of the modal.
+    attr_reader custom_id: String
+
+    # @return [{String => String}] The contents of the modal.
+    attr_reader contents: ::Hash[String, String]
+  end
+end

data/sig/discorb/interaction/responder.rbs

@@ -0,0 +1,157 @@
+module Discorb
+  class Interaction < Discorb::DiscordModel
+    #
+    # A module for response with source.
+    module SourceResponder
+      #
+      # Response with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`(`5`).
+      #
+      # @async
+      #
+      # @param [Boolean] ephemeral Whether to make the response ephemeral.
+      #
+      # @return [Async::Task<void>] The task.
+      def defer_source: (?ephemeral: bool) -> Async::Task[void]
+
+      #
+      # Response with `CHANNEL_MESSAGE_WITH_SOURCE`(`4`).
+      #
+      # @async
+      #
+      # @param [String] content The content of the response.
+      # @param [Boolean] tts Whether to send the message as text-to-speech.
+      # @param [Discorb::Embed] embed The embed to send.
+      # @param [Array<Discorb::Embed>] embeds The embeds to send. (max: 10)
+      # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
+      # @param [Discorb::Attachment] attachment The attachment to send.
+      # @param [Array<Discorb::Attachment>] attachments The attachments to send. (max: 10)
+      # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+      # @param [Boolean] ephemeral Whether to make the response ephemeral.
+      #
+      # @return [Discorb::Interaction::SourceResponder::CallbackMessage, Discorb::Webhook::Message]
+      #   The callback message.
+      def post: (
+        ?String? content,
+        ?tts: bool,
+        ?embed: Discorb::Embed?,
+        ?embeds: ::Array[Discorb::Embed]?,
+        ?allowed_mentions: Discorb::AllowedMentions?,
+        ?attachment: Discorb::Attachment?,
+        ?attachments: ::Array[Discorb::Attachment]?,
+        ?components: (::Array[Discorb::Component]
+        | ::Array[::Array[Discorb::Component]])?,
+        ?ephemeral: bool
+      ) -> (Discorb::Interaction::SourceResponder::CallbackMessage
+      | Discorb::Webhook::Message)
+
+      #
+      # Represents of a callback message of interaction.
+      class CallbackMessage
+        #
+        # Initializes a new instance of CallbackMessage.
+        # @private
+        #
+        # @param [Client] client The client.
+        # @param [Hash] data The payload.
+        # @param [String] application_id The application ID.
+        # @param [String] token The token.
+        def initialize: (
+          Client client,
+          Discorb::json data,
+          String application_id,
+          String token
+        ) -> void
+
+        #
+        # Edits the callback message.
+        # @async
+        # @macro edit
+        #
+        # @param [String] content The new content of the message.
+        # @param [Discorb::Embed] embed The new embed of the message.
+        # @param [Array<Discorb::Embed>] embeds The new embeds of the message.
+        # @param [Array<Discorb::Attachment>] attachments The attachments to remain.
+        # @param [Discorb::Attachment] file The file to send.
+        # @param [Array<Discorb::Attachment>] files The files to send.
+        #
+        # @return [Async::Task<void>] The task.
+        def edit: (
+          ?String content,
+          ?embed: Discorb::Embed,
+          ?embeds: ::Array[Discorb::Embed],
+          ?file: Discorb::Attachment,
+          ?files: ::Array[Discorb::Attachment],
+          ?attachments: ::Array[Discorb::Attachment]
+        ) -> Async::Task[void]
+
+        #
+        # Deletes the callback message.
+        # @async
+        # @note This will fail if the message is ephemeral.
+        #
+        # @return [Async::Task<void>] The task.
+        def delete!: -> Async::Task[void]
+
+        def inspect: -> String
+      end
+    end
+
+    #
+    # A module for response with update.
+    module UpdateResponder
+      #
+      # Response with `DEFERRED_UPDATE_MESSAGE`(`6`).
+      # @async
+      #
+      # @param [Boolean] ephemeral Whether to make the response ephemeral.
+      #
+      # @return [Async::Task<void>] The task.
+      def defer_update: (?ephemeral: bool) -> Async::Task[void]
+
+      #
+      # Response with `UPDATE_MESSAGE`(`7`).
+      #
+      # @async
+      #
+      # @param [String] content The content of the response.
+      # @param [Boolean] tts Whether to send the message as text-to-speech.
+      # @param [Discorb::Embed] embed The embed to send.
+      # @param [Array<Discorb::Embed>] embeds The embeds to send. (max: 10)
+      # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions to send.
+      # @param [Array<Discorb::Component>, Array<Array<Discorb::Component>>] components The components to send.
+      # @param [Boolean] ephemeral Whether to make the response ephemeral.
+      #
+      # @return [Async::Task<void>] The task.
+      def edit: (
+        String content,
+        ?tts: bool,
+        ?embed: Discorb::Embed?,
+        ?embeds: ::Array[Discorb::Embed]?,
+        ?allowed_mentions: Discorb::AllowedMentions?,
+        ?attachment: Discorb::Attachment?,
+        ?attachments: ::Array[Discorb::Attachment]?,
+        ?components: (::Array[Discorb::Component]
+        | ::Array[::Array[Discorb::Component]])?,
+        ?ephemeral: bool
+      ) -> Async::Task[void]
+    end
+
+    #
+    # A module for response with modal.
+    module ModalResponder
+      #
+      # Response with `MODAL`(`9`).
+      #
+      # @param [String] title The title of the modal.
+      # @param [String] custom_id The custom id of the modal.
+      # @param [Array<Discorb::TextInput>] components The text inputs to send.
+      #
+      # @return [Async::Task<void>] The task.
+      def show_modal: (
+        String title,
+        String custom_id,
+        ::Array[Discorb::TextInput] components
+      ) -> Async::Task[void]
+    end
+  end
+end

data/sig/discorb/invite.rbs

@@ -0,0 +1,86 @@
+module Discorb
+  #
+  # Represents invite of discord.
+  class Invite < Discorb::DiscordModel
+    TARGET_TYPES: Hash[Integer?, Symbol]
+
+    #
+    # Initialize a new invite.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of invite.
+    # @param [Boolean] gateway Whether the data is from gateway.
+    def initialize: (
+      Discorb::Client client,
+      Discorb::json data,
+      bool gateway
+    ) -> void
+
+    # Delete the invite.
+    # @async
+    # @return [Async::Task<void>] The task.
+    def delete!: (?reason: String) -> Async::Task[void]
+
+    # @return [String] The code of invite.
+    attr_reader code: String
+
+    # @return [:voice, :stream, :guild] The type of invite.
+    attr_reader target_type: Symbol
+
+    # @return [User] The user of invite.
+    attr_reader target_user: User
+
+    # @return [Integer] The approximate number of online users of invite.
+    attr_reader approximate_presence_count: Integer
+
+    # @return [Integer] The approximate number of members of invite.
+    attr_reader approximate_member_count: Integer
+
+    # @return [Time] The time when invite expires.
+    # @return [nil] The invite never expires.
+    # @macro [new] nometa
+    #   @return [nil] The invite doesn't have metadata.
+    attr_reader expires_at: Time?
+
+    # @return [Integer] The number of uses of invite.
+    # @macro nometa
+    attr_reader uses: Integer?
+
+    # @return [Integer] The maximum number of uses of invite.
+    # @macro nometa
+    attr_reader max_uses: Integer?
+
+    # @return [Integer] Duration of invite in seconds.
+    # @macro nometa
+    attr_reader max_age: Integer?
+
+    # @return [Time] The time when invite was created.
+    # @macro nometa
+    attr_reader created_at: Time?
+
+    # Channel of the invite.
+    #
+    # @return [Discorb::Channel] Channel of invite.
+    # @macro client_cache
+    attr_reader channel: Discorb::Channel?
+
+    # Guild of the invite.
+    #
+    # @return [Discorb::Guild] Guild of invite.
+    # @macro client_cache
+    attr_reader guild: Discorb::Guild?
+
+    # Number of remaining uses of invite.
+    # @return [Integer] Number of remaining uses of invite.
+    attr_reader remain_uses: Integer
+
+    # Full url of invite.
+    # @return [String] Full url of invite.
+    attr_reader url: String
+
+    # Whether the invite is temporary.
+    # @return [Boolean]
+    attr_reader temporary?: bool
+  end
+end

data/sig/discorb/member.rbs

@@ -0,0 +1,187 @@
+module Discorb
+  #
+  # Represents a member of a guild.
+  class Member < Discorb::User
+    #
+    # Initialize a new instance of the member.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Discorb::Snowflake] guild_id The ID of the guild.
+    # @param [Hash] user_data The data of the user.
+    # @param [Hash] member_data The data of the member.
+    def initialize: (
+      Discorb::Client client,
+      Discorb::Snowflake guild_id,
+      Discorb::json user_data,
+      Discorb::json member_data
+    ) -> void
+
+    #
+    # Format the member to `Username#Discriminator` style.
+    #
+    # @return [String] The formatted member.
+    def to_s: -> String
+
+    def inspect: -> String
+
+    #
+    # Add a role to the member.
+    # @async
+    #
+    # @param [Discorb::Role] role The role to add.
+    # @param [String] reason The reason for the action.
+    #
+    # @return [Async::Task<void>] The task.
+    def add_role: (Discorb::Role role, ?reason: String?) -> Async::Task[void]
+
+    #
+    # Remove a role to the member.
+    # @async
+    #
+    # @param [Discorb::Role] role The role to add.
+    # @param [String] reason The reason for the action.
+    #
+    # @return [Async::Task<void>] The task.
+    def remove_role: (Discorb::Role role, ?reason: String?) -> Async::Task[void]
+
+    #
+    # Edit the member.
+    # @async
+    # @macro edit
+    #
+    # @param [String] nick The nickname of the member.
+    # @param [Discorb::Role] role The roles of the member.
+    # @param [Boolean] mute Whether the member is muted.
+    # @param [Boolean] deaf Whether the member is deafened.
+    # @param [Discorb::StageChannel] channel The channel the member is moved to.
+    # @param [Time, nil] communication_disabled_until The time the member is timed out. Set to `nil` to end the timeout.
+    # @param [Time, nil] timeout_until Alias of `communication_disabled_until`.
+    # @param [String] reason The reason for the action.
+    #
+    # @return [Async::Task<void>] The task.
+    def edit: (
+      ?nick: String,
+      ?role: Discorb::Role,
+      ?mute: bool,
+      ?deaf: bool,
+      ?channel: Discorb::StageChannel,
+      ?communication_disabled_until: Time?,
+      ?timeout_until: Time?,
+      ?reason: String?
+    ) -> Async::Task[void]
+
+    #
+    # Timeout the member.
+    # @async
+    #
+    # @param [Time] time The time until the member is timeout.
+    # @param [String] reason The reason for the action.
+    #
+    # @return [Async::Task<void>] The task.
+    def timeout: (Time time, ?reason: String?) -> Async::Task[void]
+
+    #
+    # Kick the member.
+    # @async
+    #
+    # @param [String] reason The reason for the action.
+    #
+    # @return [Async::Task<void>] The task.
+    def kick: (?reason: String?) -> Async::Task[void]
+
+    #
+    # Ban the member.
+    # @async
+    #
+    # @param [Integer] delete_message_days The number of days to delete messages.
+    # @param [String] reason The reason for the action.
+    #
+    # @return [Async::Task<Discorb::Guild::Ban>] The ban.
+    def ban: (
+      ?delete_message_days: Integer,
+      ?reason: String?
+    ) -> Async::Task[Discorb::Guild::Ban]
+
+    #
+    # Checks if the member can manage the given role.
+    #
+    # @param [Discorb::Role] role The role.
+    #
+    # @return [Boolean] `true` if the member can manage the role.
+    def can_manage?: (Discorb::Role role) -> bool
+
+    # @return [Time] The time the member boosted the guild.
+    attr_reader premium_since: Time
+
+    # @return [String] The nickname of the member.
+    # @return [nil] If the member has no nickname.
+    attr_reader nick: String?
+
+    # @return [Time] The time the member joined the guild.
+    attr_reader joined_at: Time
+
+    # @return [Discorb::Asset] The custom avatar of the member.
+    # @return [nil] If the member has no custom avatar.
+    attr_reader custom_avatar: Discorb::Asset?
+
+    # @return [Discorb::Asset] The display avatar of the member.
+    attr_reader display_avatar: Discorb::Asset | Discorb::DefaultAvatar
+
+    # @return [Boolean] Whether the member is muted.
+    attr_reader mute: bool
+
+    # @return [Boolean] Whether the member is deafened.
+    attr_reader deaf: bool
+
+    # @return [Boolean] Whether the member is pending (Not passed member screening).
+    attr_reader pending: bool
+
+    # @return [String] The display name of the member.
+    attr_reader name: String
+
+    # @return [String] The mention of the member.
+    attr_reader mention: String
+
+    # @return [Discorb::VoiceState] The voice state of the member.
+    attr_reader voice_state: Discorb::VoiceState
+
+    # @macro client_cache
+    # @return [Array<Discorb::Role>] The roles of the member.
+    attr_reader roles: ::Array[Discorb::Role]?
+
+    # @macro client_cache
+    # @return [Discorb::Guild] The guild the member is in.
+    attr_reader guild: Discorb::Guild?
+
+    # @macro client_cache
+    # @return [Discorb::Role] The hoisted role of the member.
+    # @return [nil] If the member has no hoisted role.
+    attr_reader hoisted_role: Discorb::Role?
+
+    # @return [Boolean] Whether the member has a hoisted role.
+    attr_reader hoisted?: bool
+
+    # @return [Discorb::Permission] The permissions of the member.
+    attr_reader permissions: Discorb::Permission
+
+    # @macro client_cache
+    # @return [Discorb::Presence] The presence of the member.
+    attr_reader presence: Discorb::Presence?
+
+    # @macro client_cache
+    # @return [Discorb::Presence::Activity] The activity of the member. It's from the {#presence}.
+    attr_reader activity: Discorb::Presence::Activity?
+
+    # @macro client_cache
+    # @return [Array<Discorb::Presence::Activity>] The activities of the member. It's from the {#presence}.
+    attr_reader activities: ::Array[Discorb::Presence::Activity]?
+
+    # @macro client_cache
+    # @return [Symbol] The status of the member. It's from the {#presence}.
+    attr_reader status: Symbol?
+
+    # @return [Boolean] Whether the member is the owner of the guild.
+    attr_reader owner?: bool
+  end
+end