discorb 0.17.1 → 0.18.0

data/sig/discorb/attachment.rbs

@@ -0,0 +1,91 @@
+module Discorb
+  #
+  # Represents a attachment file.
+  class Attachment
+    #
+    # Creates a new attachment.
+    #
+    # @param [#read, String] source The Source of the attachment.
+    # @param [String] filename The filename of the attachment. If not set, path or object_id of the IO is used.
+    # @param [String] description The description of the attachment.
+    # @param [String] content_type The content type of the attachment. If not set, it is guessed from the filename.
+    #   If failed to guess, it is set to `application/octet-stream`.
+    # @param [Boolean] will_close Whether the IO will be closed after the attachment is sent.
+    def initialize: (
+      untyped | String source,
+      ?String? filename,
+      ?description: String?,
+      ?content_type: String?,
+      ?will_close: bool
+    ) -> void
+
+    #
+    # Initializes the object from a hash.
+    # @private
+    def initialize_hash: (untyped data) -> untyped
+
+    def inspect: -> String
+
+    #
+    # Creates a new file from a hash.
+    # @private
+    def self.from_hash: (untyped data) -> untyped
+
+    #
+    # Creates a new file from a string.
+    #
+    # @param [String] string The string to create the file from.
+    # @param [String] filename The filename of the file. object_id of the string is used if not set.
+    # @param [String] content_type The content type of the file. If not set, it is guessed from the filename.
+    #
+    # @return [Discorb::Attachment] The new file.
+    def self.from_string: (
+      String string,
+      ?String? filename,
+      ?content_type: String?,
+      ?description: untyped
+    ) -> Discorb::Attachment
+
+    # @return [#read] The file content.
+    attr_reader io: untyped
+
+    # @return [String] The attachment filename.
+    attr_reader filename: String
+
+    # @return [String] The attachment content type.
+    attr_reader content_type: String
+
+    # @return [String] The attachment description.
+    attr_reader description: String?
+
+    # @return [Discorb::Snowflake] The attachment id.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [Integer] The attachment size in bytes.
+    attr_reader size: Integer
+
+    # @return [String] The attachment url.
+    attr_reader url: String
+
+    # @return [String] The attachment proxy url.
+    attr_reader proxy_url: String
+
+    # @return [Integer] The image height.
+    # @return [nil] If the attachment is not an image.
+    attr_reader height: Integer?
+
+    # @return [Integer] The image width.
+    # @return [nil] If the attachment is not an image.
+    attr_reader width: Integer?
+
+    # @return [:client, :discord] The attachment was created by.
+    attr_reader created_by: :client | :discord
+
+    # @private
+    # @return [Boolean] Whether the attachment will be closed after it is sent.
+    attr_reader will_close: bool
+
+    # @return [Boolean] whether the file is an image.
+    attr_reader image?: bool
+  end
+end

data/sig/discorb/audit_log.rbs

@@ -0,0 +1,231 @@
+module Discorb
+  #
+  # Represents a Discord audit log.
+  class AuditLog < Discorb::DiscordModel
+    #
+    # Initializes a new instance of the AuditLog class.
+    # @private
+    def initialize: (untyped client, untyped data, untyped guild) -> void
+
+    def inspect: -> String
+
+    #
+    # Gets an entry from entries.
+    #
+    # @param [Integer] index The index of the entry.
+    #
+    # @return [Discorb::AuditLog::Entry] The entry.
+    # @return [nil] If the index is out of range.
+    def []: (Integer index) -> Discorb::AuditLog::Entry
+
+    # @return [Array<Discorb::Webhook>] The webhooks in this audit log.
+    attr_reader webhooks: ::Array[Discorb::Webhook]
+
+    # @return [Array<Discorb::User>] The users in this audit log.
+    attr_reader users: ::Array[Discorb::User]
+
+    # @return [Array<Discorb::ThreadChannel>] The threads in this audit log.
+    attr_reader threads: ::Array[Discorb::ThreadChannel]
+
+    # @return [Array<Discorb::AuditLog::Entry>] The entries in this audit log.
+    attr_reader entries: ::Array[Discorb::AuditLog::Entry]
+
+    #
+    # Represents an entry in an audit log.
+    class Entry < Discorb::DiscordModel
+      EVENTS: untyped
+      CONVERTERS: untyped
+
+      #
+      # Initializes a new AuditLog entry.
+      # @private
+      def initialize: (untyped client, untyped data, _ToS guild_id) -> void
+
+      #
+      # Get a change with the given key.
+      #
+      # @param [Symbol] key The key to get.
+      #
+      # @return [Discorb::AuditLog::Entry::Change] The change with the given key.
+      # @return [nil] The change with the given key does not exist.
+      def []: (Symbol key) -> Discorb::AuditLog::Entry::Change
+
+      def inspect: -> String
+
+      # @return [Discorb::Snowflake] The ID of the entry.
+      attr_reader id: Discorb::Snowflake
+
+      # @return [Discorb::Snowflake] The ID of the user who performed the action.
+      attr_reader user_id: Discorb::Snowflake
+
+      # @return [Discorb::Snowflake] The ID of the target of the action.
+      attr_reader target_id: Discorb::Snowflake
+
+      # @return [Symbol] The type of the entry.
+      # These symbols will be used:
+      #
+      # * `:guild_update`
+      # * `:channel_create`
+      # * `:channel_update`
+      # * `:channel_delete`
+      # * `:channel_overwrite_create`
+      # * `:channel_overwrite_update`
+      # * `:channel_overwrite_delete`
+      # * `:member_kick`
+      # * `:member_prune`
+      # * `:member_ban_add`
+      # * `:member_ban_remove`
+      # * `:member_update`
+      # * `:member_role_update`
+      # * `:member_move`
+      # * `:member_disconnect`
+      # * `:bot_add`
+      # * `:role_create`
+      # * `:role_update`
+      # * `:role_delete`
+      # * `:invite_create`
+      # * `:invite_update`
+      # * `:invite_delete`
+      # * `:webhook_create`
+      # * `:webhook_update`
+      # * `:webhook_delete`
+      # * `:emoji_create`
+      # * `:emoji_update`
+      # * `:emoji_delete`
+      # * `:message_delete`
+      # * `:message_bulk_delete`
+      # * `:message_pin`
+      # * `:message_unpin`
+      # * `:integration_create`
+      # * `:integration_update`
+      # * `:integration_delete`
+      # * `:stage_instance_create`
+      # * `:stage_instance_update`
+      # * `:stage_instance_delete`
+      # * `:sticker_create`
+      # * `:sticker_update`
+      # * `:sticker_delete`
+      # * `:guild_scheduled_event_create`
+      # * `:guild_scheduled_event_update`
+      # * `:guild_scheduled_event_delete`
+      # * `:thread_create`
+      # * `:thread_update`
+      # * `:thread_delete`
+      # * `:application_command_permission_update``
+      attr_reader type: Symbol
+
+      # @return [Discorb::AuditLog::Entry::Changes] The changes in this entry.
+      attr_reader changes: Discorb::AuditLog::Entry::Changes
+
+      # @return [Discorb::Channel, Discorb::Role, Discorb::Member, Discorb::Guild, Discorb::Message]
+      #   The target of the entry.
+      attr_reader target: Discorb::Channel
+      | Discorb::Role
+      | Discorb::Member
+      | Discorb::Guild
+      | Discorb::Message
+      | Discorb::Snowflake
+
+      # @return [Hash{Symbol => Object}] The optional data for this entry.
+      # @note You can use dot notation to access the data.
+      attr_reader options: ::Hash[Symbol, Object]
+
+      # @return [Discorb::User] The user who performed the action.
+      attr_reader user: Discorb::User
+
+      #
+      # Represents the changes in an audit log entry.
+      class Changes < Discorb::DiscordModel
+        #
+        # Initializes a new changes object.
+        # @private
+        #
+        # @param [Hash] data The data to initialize with.
+        def initialize: (Discorb::json data) -> void
+
+        #
+        # Formats the changes into a string.
+        def inspect: -> String
+
+        #
+        # Get keys of changes.
+        #
+        # @return [Array<Symbol>] The keys of the changes.
+        def keys: -> ::Array[Symbol]
+
+        #
+        # Get a change with the given key.
+        #
+        # @param [Symbol] key The key to get.
+        #
+        # @return [Discorb::AuditLog::Entry::Change] The change with the given key.
+        # @return [nil] The change with the given key does not exist.
+        def []: (Symbol key) -> Discorb::AuditLog::Entry::Change
+
+        # Returns the value of attribute data.
+        attr_reader data: untyped
+      end
+
+      #
+      # Represents a change in an audit log entry.
+      # @note This instance will try to call a method of {#new_value} if the method wasn't defined.
+      class Change < Discorb::DiscordModel
+        #
+        # Initializes a new change object.
+        # @private
+        def initialize: (untyped data) -> void
+
+        #
+        # Send a message to the new value.
+        def method_missing: (untyped method) -> untyped
+
+        #
+        # Format the change into a string.
+        #
+        # @return [String] The string representation of the change.
+        def inspect: -> String
+
+        #
+        # Whether the change responds to the given method.
+        #
+        # @return [Boolean] Whether the change responds to the given method.
+        def respond_to_missing?: (
+          untyped method,
+          ?untyped include_private
+        ) -> bool
+
+        # @return [Symbol] The key of the change.
+        attr_reader key: Symbol
+
+        # @return [Object] The old value of the change.
+        attr_reader old_value: Object
+
+        # @return [Object] The new value of the change.
+        attr_reader new_value: Object
+      end
+    end
+
+    #
+    # Represents an integration in an audit log entry.
+    class Integration < Discorb::DiscordModel
+      #
+      # Initializes a new integration object.
+      # @private
+      def initialize: (untyped data) -> void
+
+      def inspect: -> String
+
+      # @return [Discorb::Snowflake] The ID of the integration.
+      attr_reader id: Discorb::Snowflake
+
+      # @return [Symbol] The type of the integration.
+      attr_reader type: Symbol
+
+      # @return [String] The name of the integration.
+      attr_reader name: String
+
+      # @return [Discorb::Integration::Account] The account of the integration.
+      attr_reader account: Discorb::Integration::Account
+    end
+  end
+end

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