discorb 0.16.0 → 0.18.0

data/sig/discorb/automod.rbs

@@ -0,0 +1,128 @@
+module Discorb
+  class AutoModRule < DiscordModel
+    type trigger_type = :keyword | :harmful_link | :spam | :keyword_preset
+    type preset_type = :profanity | :sexual_content | :slurs
+
+    # @return [Hash{Integer => Symbol}] The mapping of trigger types.
+    # @private
+    TRIGGER_TYPES: Hash[Integer, trigger_type]
+
+    # @return [Hash{Integer => Symbol}] The mapping of preset types.
+    # @private
+    PRESET_TYPES: Hash[Integer, preset_type]
+
+    # @return [Hash{Integer => Symbol}] The mapping of event types.
+    # @private
+    EVENT_TYPES: Hash[Integer, :message_send]
+
+    # @return [Discorb::Snowflake] The ID of the rule.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The name of the rule.
+    attr_reader name: String
+
+    # @return [Boolean] Whether the rule is enabled.
+    attr_reader enabled: bool
+    alias enabled? enabled
+
+    # @return [Array<Discorb::AutoModRule::Action>] The actions of the rule.
+    attr_reader actions: Array[Discorb::AutoModRule::Action]
+
+    # @return [Array<String>] The keywords that the rule is triggered by.
+    # @note This is only available if the trigger type is `:keyword`.
+    attr_reader keyword_filter: Array[String]?
+
+    # @return [Symbol] Returns the type of the preset.
+    # @note This is only available if the trigger type is `:keyword_preset`.
+    def preset_type: -> preset_type
+
+    # @return [Symbol] Returns the type of the trigger.
+    def trigger_type: -> trigger_type
+
+    # @return [Symbol] Returns the type of the event.
+    def event_type: -> :message_send
+
+    def creator: -> Discorb::Member
+
+    def guild: -> Discorb::Guild
+
+    def exempt_roles: -> Array[Discorb::Role]
+
+    def exempt_channels: -> Array[Discorb::Channel]
+
+    #
+    # Initialize a new auto mod.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The auto mod data.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    #
+    # Edit the rule.
+    # @async
+    # @edit
+    #
+    # @param [String] name The name of the rule.
+    # @param [Symbol] event_type The event type of the rule. See {Discorb::AutoModRule::EVENT_TYPES}.
+    # @param [Array<Discorb::AutoModRule::Action>] actions The actions of the rule.
+    # @param [Boolean] enabled Whether the rule is enabled or not.
+    # @param [Array<Discorb::Role>] exempt_roles The roles that are exempt from the rule.
+    # @param [Array<Discorb::Channel>] exempt_channels The channels that are exempt from the rule.
+    # @param [Array<String>] keyword_filter The keywords to filter.
+    # @param [Symbol] presets The preset of the rule. See {Discorb::AutoModRule::PRESET_TYPES}.
+    # @param [String] reason The reason for creating the rule.
+    #
+    # @return [Async::Task<void>] The task.
+    def edit: (
+      ?name: String,
+      ?event_type: :send_message,
+      ?actions: Array[Discorb::AutoModRule::Action],
+      ?enabled: bool,
+      ?exempt_roles: Array[Discorb::Role],
+      ?exempt_channels: Array[Discorb::Channel],
+      ?keyword_filter: Array[String]?,
+      ?presets: :profanity | :sexual_content | :slurs,
+      ?reason: nil
+    ) -> Async::Task[void]
+
+    #
+    # Delete the rule.
+    #
+    # @param [String] reason The reason for deleting the rule.
+    #
+    # @return [Async::Task<void>] The task.
+    def delete!: (?reason: nil) -> Async::Task[void]
+
+    class Action < Discorb::DiscordModel
+      # @return [Hash{Integer => Symbol}] The mapping of action types.
+      # @private
+      ACTION_TYPES: Hash[Integer, Symbol]
+
+      # @return [Symbol] Returns the type of the action.
+      attr_reader type: :ban | :kick | :mute | :warn
+
+      # @return [Integer] The duration of the timeout.
+      # @note This is only available if the action type is `:timeout`.
+      attr_reader duration_seconds: Integer?
+
+      #
+      # Initialize a new action.
+      #
+      # @param [Symbol] type The type of the action.
+      # @param [Integer] duration_seconds The duration of the timeout.
+      #   This is only available if the action type is `:timeout`.
+      # @param [Discorb::Channel] channel The channel that the alert message is sent to.
+      #   This is only available if the action type is `:send_alert_message`.
+      def initialize: (
+        Symbol `type`,
+        ?duration_seconds: Integer?,
+        ?channel: Discorb::Channel?
+      ) -> void
+
+      # @return [Discorb::Channel] The channel that the alert message is sent to.
+      # @note This is only available if the action type is `:send_alert_message`.
+      def channel: -> Discorb::Channel?
+    end
+  end
+end

data/sig/discorb/avatar.rbs

@@ -0,0 +1,26 @@
+module Discorb
+  #
+  # Represents a default avatar.
+  class DefaultAvatar < Discorb::DiscordModel
+    #
+    # Initialize a new instance of the DefaultAvatar class.
+    # @private
+    def initialize: (untyped discriminator) -> void
+
+    #
+    # Returns the URL of the avatar.
+    #
+    # @param [String] image_format The image format. This is compatible with {Asset#url}, will be ignored.
+    # @param [Integer] size The size of the image. This is compatible with {Asset#url}, will be ignored.
+    #
+    # @return [String] URL of the avatar.
+    #
+    # rubocop: disable Lint/UnusedMethodArgument
+    def url: (?image_format: String?, ?size: Integer) -> String
+
+    def inspect: -> String
+
+    # @return [false] For compatibility with {Asset}, always `false`.
+    attr_reader animated?: bool
+  end
+end

data/sig/discorb/channel/base.rbs

@@ -0,0 +1,179 @@
+module Discorb
+  #
+  # Represents a channel of Discord.
+  # @abstract
+  class Channel < Discorb::DiscordModel
+    #
+    # Initializes a new instance of the Channel class.
+    # @private
+    def initialize: (untyped client, untyped data, ?no_cache: untyped) -> void
+
+    #
+    # Checks if the channel is other channel.
+    #
+    # @param [Discorb::Channel] other The channel to check.
+    #
+    # @return [Boolean] True if the channel is other channel.
+    def ==: (Discorb::Channel other) -> bool
+
+    def inspect: -> String
+
+    #
+    # Returns the descendants of the Channel class.
+    # @private
+    def self.descendants: -> untyped
+
+    #
+    # Creates a new instance of the Channel class or instance of its descendants.
+    # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    # @param [Boolean] no_cache Whether to disable cache the object.
+    def self.make_channel: (
+      Discorb::Client client,
+      Discorb::json data,
+      ?no_cache: bool
+    ) -> untyped
+
+    def `type`: -> String
+
+    #
+    # Returns the channel id to request.
+    # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    def channel_id: -> Async::Task[Discorb::Snowflake]
+
+    # @return [Discorb::Snowflake] The ID of the channel.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The name of the channel.
+    attr_reader name: String
+  end
+
+  #
+  # Represents a channel in guild.
+  # @abstract
+  class GuildChannel < Discorb::Channel
+    include Comparable
+
+    #
+    # Compares position of two channels.
+    #
+    # @param [Discorb::GuildChannel] other The channel to compare.
+    #
+    # @return [-1, 0, 1] -1 if the channel is at lower than the other, 1 if the channel is at highter than the other.
+    def <=>: (Discorb::GuildChannel other) -> Integer?
+
+    #
+    # Checks if the channel is same as another.
+    #
+    # @param [Discorb::GuildChannel] other The channel to check.
+    #
+    # @return [Boolean] `true` if the channel is same as another.
+    def ==: (Discorb::GuildChannel other) -> bool
+
+    #
+    # Stringifies the channel.
+    #
+    # @return [String] The name of the channel with `#`.
+    def to_s: -> String
+
+    def mention: -> String
+
+    def parent: -> Discorb::CategoryChannel?
+
+    def guild: -> Discorb::Guild
+
+    def inspect: -> String
+
+    #
+    # Deletes the channel.
+    # @async
+    #
+    # @param [String] reason The reason of deleting the channel.
+    #
+    # @return [Async::Task<self>] The deleted channel.
+    def delete!: (?reason: String?) -> Async::Task[self]
+
+    #
+    # Moves the channel to another position.
+    # @async
+    #
+    # @param [Integer] position The position to move the channel.
+    # @param [Boolean] lock_permissions Whether to lock the permissions of the channel.
+    # @param [Discorb::CategoryChannel] parent The parent of channel.
+    # @param [String] reason The reason of moving the channel.
+    #
+    # @return [Async::Task<self>] The moved channel.
+    def move: (
+      Integer position,
+      ?lock_permissions: bool,
+      ?parent: Discorb::CategoryChannel,
+      ?reason: String?
+    ) -> Async::Task[self]
+
+    #
+    # Set the channel's permission overwrite.
+    # @async
+    #
+    # @param [Discorb::Role, Discorb::Member] target The target of the overwrite.
+    # @param [String] reason The reason of setting the overwrite.
+    # @param [{Symbol => Boolean}] perms The permission overwrites to replace.
+    #
+    # @return [Async::Task<void>] The task.
+    def set_permissions: (
+      Discorb::Role | Discorb::Member target,
+      ?reason: String?,
+      **bool perms
+    ) -> Async::Task[void]
+
+    #
+    # Delete the channel's permission overwrite.
+    # @async
+    #
+    # @param [Discorb::Role, Discorb::Member] target The target of the overwrite.
+    # @param [String] reason The reason of deleting the overwrite.
+    #
+    # @return [Async::Task<void>] The task.
+    def delete_permissions: (
+      Discorb::Role | Discorb::Member target,
+      ?reason: String?
+    ) -> Async::Task[void]
+
+    #
+    # Fetch the channel's invites.
+    # @async
+    #
+    # @return [Async::Task<Array<Discorb::Invite>>] The invites in the channel.
+    def fetch_invites: -> Async::Task[::Array[Discorb::Invite]]
+
+    #
+    # Create an invite in the channel.
+    # @async
+    #
+    # @param [Integer] max_age The max age of the invite.
+    # @param [Integer] max_uses The max uses of the invite.
+    # @param [Boolean] temporary Whether the invite is temporary.
+    # @param [Boolean] unique Whether the invite is unique.
+    #   @note if it's `false` it may return existing invite.
+    # @param [String] reason The reason of creating the invite.
+    #
+    # @return [Async::Task<Invite>] The created invite.
+    def create_invite: (
+      ?max_age: Integer?,
+      ?max_uses: Integer?,
+      ?temporary: bool,
+      ?unique: bool,
+      ?reason: String?
+    ) -> Async::Task[Invite]
+
+    # @return [Integer] The position of the channel as integer.
+    attr_reader position: Integer
+
+    # @return [Hash{Discorb::Role, Discorb::Member => PermissionOverwrite}] The permission overwrites of the channel.
+    attr_reader permission_overwrites: Hash[Discorb::Role
+    | Discorb::Member, Discorb::PermissionOverwrite]
+  end
+end

data/sig/discorb/channel/category.rbs

@@ -0,0 +1,56 @@
+module Discorb
+  #
+  # Represents a category in a guild.
+  class CategoryChannel < Discorb::GuildChannel
+    include Discorb::ChannelContainer
+
+    def channels: -> Array[Discorb::GuildChannel]
+
+    def create_text_channel: (
+      String name,
+      ?topic: String?,
+      ?rate_limit_per_user: Integer?,
+      ?slowmode: Integer?,
+      ?position: Integer?,
+      ?nsfw: bool?,
+      ?permission_overwrites: Hash[(Discorb::Role
+      | Discorb::Member), Discorb::PermissionOverwrite]?,
+      ?parent: Discorb::CategoryChannel?,
+      ?reason: String?
+    ) -> Async::Task[Discorb::TextChannel]
+
+    def create_voice_channel: (
+      String name,
+      ?bitrate: Integer,
+      ?user_limit: Integer?,
+      ?position: Integer?,
+      ?permission_overwrites: Hash[(Discorb::Role
+      | Discorb::Member), Discorb::PermissionOverwrite]?,
+      ?parent: Discorb::CategoryChannel?,
+      ?reason: String?
+    ) -> Async::Task[Discorb::VoiceChannel]
+
+    def create_news_channel: (
+      String name,
+      ?topic: String?,
+      ?rate_limit_per_user: Integer?,
+      ?slowmode: Integer?,
+      ?position: Integer?,
+      ?nsfw: bool?,
+      ?permission_overwrites: Hash[(Discorb::Role
+      | Discorb::Member), Discorb::PermissionOverwrite]?,
+      ?parent: Discorb::CategoryChannel?,
+      ?reason: String?
+    ) -> Async::Task[Discorb::NewsChannel]
+
+    def create_stage_channel: (
+      String name,
+      ?bitrate: Integer,
+      ?position: Integer?,
+      ?permission_overwrites: Hash[(Discorb::Role
+      | Discorb::Member), Discorb::PermissionOverwrite]?,
+      ?parent: Discorb::CategoryChannel?,
+      ?reason: String?
+    ) -> Async::Task[Discorb::StageChannel]
+  end
+end

data/sig/discorb/channel/container.rbs

@@ -0,0 +1,29 @@
+module Discorb
+  #
+  # Module for container of channels.
+  module ChannelContainer
+    #
+    # Returns text channels.
+    #
+    # @return [Array<Discorb::TextChannel>] The text channels.
+    def text_channels: -> ::Array[Discorb::TextChannel]
+
+    #
+    # Returns voice channels.
+    #
+    # @return [Array<Discorb::VoiceChannel>] The voice channels.
+    def voice_channels: -> ::Array[Discorb::VoiceChannel]
+
+    #
+    # Returns news channels.
+    #
+    # @return [Array<Discorb::NewsChannel>] The news channels.
+    def news_channels: -> ::Array[Discorb::NewsChannel]
+
+    #
+    # Returns stage channels.
+    #
+    # @return [Array<Discorb::StageChannel>] The stage channels.
+    def stage_channels: -> ::Array[Discorb::StageChannel]
+  end
+end

data/sig/discorb/channel/dm.rbs

@@ -0,0 +1,14 @@
+module Discorb
+  #
+  # Represents a DM channel.
+  class DMChannel < Discorb::Channel
+    include Discorb::Messageable
+
+    #
+    # Returns the channel id to request.
+    # @private
+    #
+    # @return [Async::Task<Discorb::Snowflake>] A task that resolves to the channel id.
+    def channel_id: -> Async::Task[Discorb::Snowflake]
+  end
+end

data/sig/discorb/channel/news.rbs

@@ -0,0 +1,20 @@
+module Discorb
+  #
+  # Represents a news channel (announcement channel).
+  class NewsChannel < Discorb::TextChannel
+    DEFAULT_AUTO_ARCHIVE_DURATION: untyped
+
+    #
+    # Follow the existing announcement channel from self.
+    # @async
+    #
+    # @param [Discorb::TextChannel] target The channel to follow to.
+    # @param [String] reason The reason of following the channel.
+    #
+    # @return [Async::Task<void>] The task.
+    def follow_to: (
+      Discorb::TextChannel target,
+      ?reason: String?
+    ) -> Async::Task[void]
+  end
+end

data/sig/discorb/channel/stage.rbs

@@ -0,0 +1,77 @@
+module Discorb
+  #
+  # Represents a stage channel.
+  class StageChannel < Discorb::GuildChannel
+    include Discorb::Connectable
+
+    #
+    # Initialize a new stage channel.
+    # @private
+    def initialize: -> void
+
+    def stage_instance: -> untyped
+
+    #
+    # Edit the stage channel.
+    # @async
+    # @macro edit
+    #
+    # @param [String] name The name of the stage channel.
+    # @param [Integer] position The position of the stage channel.
+    # @param [Integer] bitrate The bitrate of the stage channel.
+    # @param [Symbol] rtc_region The region of the stage channel.
+    # @param [String] reason The reason of editing the stage channel.
+    #
+    # @return [Async::Task<self>] The edited stage channel.
+    def edit: (
+      ?name: String,
+      ?position: Integer,
+      ?bitrate: Integer,
+      ?rtc_region: Symbol,
+      ?reason: String?
+    ) -> Async::Task[self]
+
+    #
+    # Start a stage instance.
+    # @async
+    #
+    # @param [String] topic The topic of the stage instance.
+    # @param [Boolean] public Whether the stage instance is public or not.
+    # @param [String] reason The reason of starting the stage instance.
+    #
+    # @return [Async::Task<Discorb::StageInstance>] The started stage instance.
+    def start: (
+      String topic,
+      ?public: bool,
+      ?reason: String?
+    ) -> Async::Task[Discorb::StageInstance]
+
+    #
+    # Fetch a current stage instance.
+    # @async
+    #
+    # @return [Async::Task<StageInstance>] The current stage instance.
+    # @return [Async::Task<nil>] If there is no current stage instance.
+    def fetch_stage_instance: -> Async::Task[StageInstance]
+
+    def voice_states: -> Array[Discorb::VoiceState]
+
+    def members: -> Array[Discorb::Member]
+
+    def speakers: -> Array[Discorb::Member]
+
+    def audiences: -> Array[Discorb::Member]
+
+    # @return [Integer] The bitrate of the voice channel.
+    attr_reader bitrate: Integer
+
+    # @return [Integer] The user limit of the voice channel.
+    attr_reader user_limit: Integer
+
+    #
+    # @private
+    # @return [Discorb::Dictionary{Discorb::Snowflake => StageInstance}]
+    #   The stage instances associated with the stage channel.
+    attr_reader stage_instances: Discorb::Dictionary[Discorb::Snowflake, StageInstance]
+  end
+end

data/sig/discorb/channel/text.rbs

@@ -0,0 +1,158 @@
+module Discorb
+  #
+  # Represents a text channel.
+  class TextChannel < Discorb::GuildChannel
+    include Discorb::Messageable
+
+    #
+    # Edits the channel.
+    # @async
+    # @macro edit
+    #
+    # @param [String] name The name of the channel.
+    # @param [Integer] position The position of the channel.
+    # @param [Discorb::CategoryChannel, nil] category The parent of channel. Specify `nil` to remove the parent.
+    # @param [Discorb::CategoryChannel, nil] parent Alias of `category`.
+    # @param [String] topic The topic of the channel.
+    # @param [Boolean] nsfw Whether the channel is nsfw.
+    # @param [Boolean] announce Whether the channel is announce channel.
+    # @param [Integer] rate_limit_per_user The rate limit per user (Slowmode) in the channel.
+    # @param [Integer] slowmode Alias of `rate_limit_per_user`.
+    # @param [Integer] default_auto_archive_duration The default auto archive duration of the channel.
+    # @param [Integer] archive_in Alias of `default_auto_archive_duration`.
+    # @param [String] reason The reason of editing the channel.
+    #
+    # @return [Async::Task<self>] The edited channel.
+    def edit: (
+      ?name: String,
+      ?position: Integer,
+      ?category: Discorb::CategoryChannel?,
+      ?parent: Discorb::CategoryChannel?,
+      ?topic: String,
+      ?nsfw: bool,
+      ?announce: bool,
+      ?rate_limit_per_user: Integer,
+      ?slowmode: Integer,
+      ?default_auto_archive_duration: 60 | 1440 | 4320 | 10080,
+      ?archive_in: Integer,
+      ?reason: String?
+    ) -> Async::Task[self]
+
+    #
+    # Create webhook in the channel.
+    # @async
+    #
+    # @param [String] name The name of the webhook.
+    # @param [Discorb::Image] avatar The avatar of the webhook.
+    #
+    # @return [Async::Task<Discorb::Webhook::IncomingWebhook>] The created webhook.
+    def create_webhook: (
+      String name,
+      ?avatar: Discorb::Image?
+    ) -> Async::Task[Discorb::Webhook::IncomingWebhook]
+
+    #
+    # Fetch webhooks in the channel.
+    # @async
+    #
+    # @return [Async::Task<Array<Discorb::Webhook>>] The webhooks in the channel.
+    def fetch_webhooks: -> Async::Task[::Array[Discorb::Webhook]]
+
+    #
+    # Bulk delete messages in the channel.
+    # @async
+    #
+    # @param [Discorb::Message] messages The messages to delete.
+    # @param [Boolean] force Whether to ignore the validation for message (14 days limit).
+    #
+    # @return [Async::Task<void>] The task.
+    def delete_messages!:
+      (*Discorb::Message messages, ?force: bool) -> Async::Task[void]
+      | (*Array[Discorb::Message] messages, ?force: bool) -> Async::Task[void]
+
+    #
+    # Follow the existing announcement channel.
+    # @async
+    #
+    # @param [Discorb::NewsChannel] target The channel to follow.
+    # @param [String] reason The reason of following the channel.
+    #
+    # @return [Async::Task<void>] The task.
+    def follow_from: (
+      Discorb::NewsChannel target,
+      ?reason: String?
+    ) -> Async::Task[void]
+
+    #
+    # Start thread in the channel.
+    # @async
+    #
+    # @param [String] name The name of the thread.
+    # @param [Discorb::Message] message The message to start the thread.
+    # @param [:hour, :day, :three_days, :week] auto_archive_duration The duration of auto-archiving.
+    # @param [Boolean] public Whether the thread is public.
+    # @param [Integer] rate_limit_per_user The rate limit per user.
+    # @param [Integer] slowmode Alias of `rate_limit_per_user`.
+    # @param [String] reason The reason of starting the thread.
+    #
+    # @return [Async::Task<Discorb::ThreadChannel>] The started thread.
+    def start_thread: (
+      String name,
+      ?message: Discorb::Message?,
+      ?auto_archive_duration: Symbol?,
+      ?public: bool,
+      ?rate_limit_per_user: Integer?,
+      ?slowmode: Integer?,
+      ?reason: String?
+    ) -> Async::Task[Discorb::ThreadChannel]
+
+    #
+    # Fetch archived threads in the channel.
+    # @async
+    #
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived threads in the channel.
+    def fetch_archived_public_threads: -> Async::Task[::Array[Discorb::ThreadChannel]]
+
+    #
+    # Fetch archived private threads in the channel.
+    # @async
+    #
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The archived private threads in the channel.
+    def fetch_archived_private_threads: -> Async::Task[::Array[Discorb::ThreadChannel]]
+
+    #
+    # Fetch joined archived private threads in the channel.
+    # @async
+    #
+    # @param [Integer] limit The limit of threads to fetch.
+    # @param [Time] before <description>
+    #
+    # @return [Async::Task<Array<Discorb::ThreadChannel>>] The joined archived private threads in the channel.
+    def fetch_joined_archived_private_threads: (
+      ?limit: Integer?,
+      ?before: Time?
+    ) -> Async::Task[::Array[Discorb::ThreadChannel]]
+
+    # @return [String] The topic of the channel.
+    attr_reader topic: String
+
+    # @return [Boolean] Whether the channel is nsfw.
+    attr_reader nsfw: bool
+
+    # @return [Discorb::Snowflake] The id of the last message.
+    attr_reader last_message_id: Discorb::Snowflake
+
+    # @return [Integer] The rate limit per user (Slowmode) in the channel.
+    attr_reader rate_limit_per_user: Integer
+
+    # @return [Time] The time when the last pinned message was pinned.
+    attr_reader last_pin_timestamp: Time
+
+    # @return [Integer] The default value of duration of auto archive.
+    attr_reader default_auto_archive_duration: 60 | 1440 | 4320 | 10080
+
+    # @!attribute [r] threads
+    #   @return [Array<Discorb::ThreadChannel>] The threads in the channel.
+    attr_reader threads: untyped
+  end
+end