discorb 0.18.0 → 0.20.0

data/lib/discorb.rb

@@ -1,56 +1,62 @@
-# frozen_string_literal: true
-
-# A new wrapper for the Discorb API.
-#
-# @author sevenc-nanashi
-module Discorb
-  #
-  # Method to define a macro for YARD.
-  # @private
-  #
-  # @!macro [new] async
-  #   @note This is an asynchronous method, it will return a `Async::Task` object.
-  #     Use `Async::Task#wait` to get the result.
-  #
-  # @!macro [new] client_cache
-  #   @note This method returns an object from client cache. it will return `nil` if the object is not in cache.
-  #   @return [nil] The object wasn't cached.
-  #
-  # @!macro members_intent
-  #   @note You must enable `GUILD_MEMBERS` intent to use this method.
-  #
-  # @!macro edit
-  #   @note The arguments of this method are defaultly set to `Discorb::Unset`.
-  #     Specify value to set the value, if not don't specify or specify `Discorb::Unset`.
-  #
-  # @!macro http
-  #   @note This method calls HTTP request.
-  #   @raise [Discorb::HTTPError] HTTP request failed.
-  #
-  def macro
-    puts "Wow, You found the easter egg!\n"
-    red = "\e[31m"
-    reset = "\e[m"
-    puts <<~"EASTEREGG"
-                 .               #{red}         #{reset}
-               |                 #{red}   |     #{reset}
-             __| |  __   __  _   #{red} _ |__    #{reset}
-            /  | | (__  /   / \\ #{red}|/  |  \\ #{reset}
-            \\__| |  __) \\__ \\_/ #{red}|   |__/  #{reset}
-
-           Thank you for using this library!
-         EASTEREGG
-  end
-end
-
-require_order = %w[common flag dictionary error rate_limit http intents emoji_table modules] +
-                %w[channel/container message_meta allowed_mentions] +
-                %w[user member guild emoji channel embed message] +
-                %w[application audit_logs color components event event_handler automod] +
-                %w[attachment guild_template image integration interaction invite permission] +
-                %w[presence reaction role sticker utils voice_state webhook] +
-                %w[gateway_requests gateway_events gateway app_command] +
-                %w[asset extension shard client extend]
-require_order.each do |name|
-  require_relative "discorb/#{name}.rb"
-end
+# frozen_string_literal: true
+
+# A new wrapper for the Discorb API.
+#
+# @author sevenc-nanashi
+module Discorb
+  #
+  # Method to define a macro for YARD.
+  # @private
+  #
+  # @!macro [new] async
+  #   @note This is an asynchronous method, it will return a `Async::Task` object.
+  #     Use `Async::Task#wait` to get the result.
+  #
+  # @!macro [new] client_cache
+  #   @note This method returns an object from client cache. it will return `nil` if the object is not in cache.
+  #   @return [nil] The object wasn't cached.
+  #
+  # @!macro members_intent
+  #   @note You must enable `GUILD_MEMBERS` intent to use this method.
+  #
+  # @!macro edit
+  #   @note The arguments of this method are defaultly set to `Discorb::Unset`.
+  #     Specify value to set the value, if not don't specify or specify `Discorb::Unset`.
+  #
+  # @!macro http
+  #   @note This method calls HTTP request.
+  #   @raise [Discorb::HTTPError] HTTP request failed.
+  #
+  def macro
+    puts "Wow, You found the easter egg!\n"
+    red = "\e[31m"
+    reset = "\e[m"
+    puts <<~"EASTEREGG"
+                 .               #{red}         #{reset}
+               |                 #{red}   |     #{reset}
+             __| |  __   __  _   #{red} _ |__    #{reset}
+            /  | | (__  /   / \\ #{red}|/  |  \\ #{reset}
+            \\__| |  __) \\__ \\_/ #{red}|   |__/  #{reset}
+
+           Thank you for using this library!
+         EASTEREGG
+  end
+end
+
+require_order =
+  %w[common flag dictionary error rate_limit http intents emoji_table modules] +
+    %w[channel/container message_meta allowed_mentions] +
+    %w[user member guild emoji channel embed message] +
+    %w[application audit_logs color components event event_handler automod] +
+    %w[
+      attachment
+      guild_template
+      image
+      integration
+      interaction
+      invite
+      permission
+    ] + %w[presence reaction role sticker utils voice_state webhook] +
+    %w[gateway_requests gateway_events gateway app_command] +
+    %w[asset extension shard client extend]
+require_order.each { |name| require_relative "discorb/#{name}.rb" }

data/sig/discorb/activity.rbs

@@ -18,6 +18,7 @@ module Discorb
     # @return [Hash] A hash representation of the activity.
     def to_hash: -> Discorb::json
 
+    %a{pure}
     def inspect: -> String
   end
 end

data/sig/discorb/allowed_mentions.rbs

@@ -16,6 +16,7 @@ module Discorb
       ?replied_user: bool?
     ) -> void
 
+    %a{pure}
     def inspect: -> String
 
     #

data/sig/discorb/app_command/base.rbs

@@ -35,7 +35,7 @@ module Discorb
         choices: Hash[String, (String | Integer | Float)]?,
         choices_localizations: Hash[String, Hash[(Symbol | String), String]]?,
         channel_types: Array[Class]?,
-        autocomplete: ^(Discorb::CommandInteraction) -> Hash[String, String]?,
+        autocomplete: (^(Discorb::CommandInteraction) -> Hash[String, String])?,
         range: Range[(Integer | Float)]?
       }
     type options = ::Hash[String, option]
@@ -83,6 +83,7 @@ module Discorb
       # @private
       #
       # @return [Hash] The hash represents the object.
+      %a{pure}
       def to_hash: -> Discorb::json
 
       # @return [Hash{String => String}] The name of the command.
@@ -143,6 +144,7 @@ module Discorb
         # Returns the commands name.
         #
         # @return [String] The name of the command.
+        %a{pure}
         def to_s: -> String
 
         #
@@ -150,6 +152,7 @@ module Discorb
         # @private
         #
         # @return [Hash] The hash represents the object.
+        %a{pure}
         def to_hash: -> Discorb::json
 
         # @return [Hash{String => String}] The description of the command.
@@ -219,6 +222,7 @@ module Discorb
         # Returns the command name.
         #
         # @return [String] The command name.
+        %a{pure}
         def to_s: -> String
 
         #
@@ -233,6 +237,7 @@ module Discorb
         # @private
         #
         # @return [Hash] The hash represents the object.
+        %a{pure}
         def to_hash: -> Discorb::json
 
         # @return [Array<Discorb::ApplicationCommand::Command>] The subcommands of the command.
@@ -260,6 +265,7 @@ module Discorb
           Discorb::Client client
         ) -> void
 
+        %a{pure}
         def to_s: -> untyped
 
         #

data/sig/discorb/application.rbs

@@ -10,6 +10,7 @@ module Discorb
     # @param [Hash] data The data of the object.
     def initialize: (Discorb::Client client, Discorb::json data) -> void
 
+    %a{pure}
     def inspect: -> String
 
     # @return [Discorb::Snowflake] The application's ID.
@@ -59,6 +60,7 @@ module Discorb
     # | `1 << 17` | `:embedded` |
     # | `1 << 18` | `:gateway_message_content` |
     # | `1 << 19` | `:gateway_message_content_limited` |
+    # | `1 << 23` | `:application_command_badge` |
     class Flag < Discorb::Flag
       attr_accessor gateway_presence: bool
       attr_accessor gateway_presence_limited: bool
@@ -68,6 +70,7 @@ module Discorb
       attr_accessor embedded: bool
       attr_accessor gateway_message_content: bool
       attr_accessor gateway_message_content_limited: bool
+      attr_accessor application_command_badge: bool
     end
 
     #
@@ -85,8 +88,10 @@ module Discorb
       # The team's owner.
       #
       # @return [Discorb::Application::Team::Member] The team's owner.
+      %a{pure}
       def owner: -> Discorb::Application::Team::Member
 
+      %a{pure}
       def inspect: -> String
 
       # @return [Discorb::Snowflake] The team's ID.
@@ -111,6 +116,7 @@ module Discorb
 
         def initialize: (untyped client, untyped team, untyped data) -> void
 
+        %a{pure}
         def inspect: -> String
 
         def ==: (untyped other) -> untyped

data/sig/discorb/asset.rbs

@@ -19,8 +19,10 @@ module Discorb
     # @return [String] URL of the asset.
     def url: (?image_format: String?, ?size: Integer) -> String
 
+    %a{pure}
     def inspect: -> String
 
+    %a{pure}
     def endpoint: -> untyped
 
     # @return [String] The hash of asset.

data/sig/discorb/attachment.rbs

@@ -24,8 +24,16 @@ module Discorb
     # @private
     def initialize_hash: (untyped data) -> untyped
 
+    %a{pure}
     def inspect: -> String
 
+    #
+    # Convert the attachment to hash.
+    #
+    # @return [Hash] The action hash.
+    %a{pure}
+    def to_hash: -> Discorb::json
+
     #
     # Creates a new file from a hash.
     # @private

data/sig/discorb/audit_log.rbs

@@ -7,6 +7,7 @@ module Discorb
     # @private
     def initialize: (untyped client, untyped data, untyped guild) -> void
 
+    %a{pure}
     def inspect: -> String
 
     #
@@ -50,6 +51,7 @@ module Discorb
       # @return [nil] The change with the given key does not exist.
       def []: (Symbol key) -> Discorb::AuditLog::Entry::Change
 
+      %a{pure}
       def inspect: -> String
 
       # @return [Discorb::Snowflake] The ID of the entry.
@@ -145,12 +147,14 @@ module Discorb
 
         #
         # Formats the changes into a string.
+        %a{pure}
         def inspect: -> String
 
         #
         # Get keys of changes.
         #
         # @return [Array<Symbol>] The keys of the changes.
+        %a{pure}
         def keys: -> ::Array[Symbol]
 
         #
@@ -160,6 +164,7 @@ module Discorb
         #
         # @return [Discorb::AuditLog::Entry::Change] The change with the given key.
         # @return [nil] The change with the given key does not exist.
+        %a{pure}
         def []: (Symbol key) -> Discorb::AuditLog::Entry::Change
 
         # Returns the value of attribute data.
@@ -183,6 +188,7 @@ module Discorb
         # Format the change into a string.
         #
         # @return [String] The string representation of the change.
+        %a{pure}
         def inspect: -> String
 
         #
@@ -213,6 +219,7 @@ module Discorb
       # @private
       def initialize: (untyped data) -> void
 
+      %a{pure}
       def inspect: -> String
 
       # @return [Discorb::Snowflake] The ID of the integration.

data/sig/discorb/automod.rbs

@@ -1,6 +1,7 @@
 module Discorb
   class AutoModRule < DiscordModel
-    type trigger_type = :keyword | :harmful_link | :spam | :keyword_preset
+    type trigger_type =
+      :keyword | :harmful_link | :spam | :keyword_preset | :mention_spam
     type preset_type = :profanity | :sexual_content | :slurs
 
     # @return [Hash{Integer => Symbol}] The mapping of trigger types.
@@ -28,26 +29,41 @@ module Discorb
     # @return [Array<Discorb::AutoModRule::Action>] The actions of the rule.
     attr_reader actions: Array[Discorb::AutoModRule::Action]
 
+    # @return [Array<String>] Substrings which will be exempt from triggering the preset trigger type.
+    # @note This is only available if the trigger type is `:keyword_preset`.
+    attr_reader allow_list: Array[String]?
+
     # @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 [Integer] Total number of mentions allowed per message.
+    # @note This is only available if the trigger type is `:mention_spam`.
+    attr_reader mention_total_limit: Integer?
+
     # @return [Symbol] Returns the type of the preset.
     # @note This is only available if the trigger type is `:keyword_preset`.
+    %a{pure}
     def preset_type: -> preset_type
 
     # @return [Symbol] Returns the type of the trigger.
+    %a{pure}
     def trigger_type: -> trigger_type
 
     # @return [Symbol] Returns the type of the event.
+    %a{pure}
     def event_type: -> :message_send
 
+    %a{pure}
     def creator: -> Discorb::Member
 
+    %a{pure}
     def guild: -> Discorb::Guild
 
+    %a{pure}
     def exempt_roles: -> Array[Discorb::Role]
 
+    %a{pure}
     def exempt_channels: -> Array[Discorb::Channel]
 
     #
@@ -76,7 +92,7 @@ module Discorb
     # @return [Async::Task<void>] The task.
     def edit: (
       ?name: String,
-      ?event_type: :send_message,
+      ?event_type: :message_send,
       ?actions: Array[Discorb::AutoModRule::Action],
       ?enabled: bool,
       ?exempt_roles: Array[Discorb::Role],
@@ -92,20 +108,29 @@ module Discorb
     # @param [String] reason The reason for deleting the rule.
     #
     # @return [Async::Task<void>] The task.
-    def delete!: (?reason: nil) -> Async::Task[void]
+    def delete: (?reason: nil) -> Async::Task[void]
 
     class Action < Discorb::DiscordModel
+      type action_type = :ban | :kick | :mute | :warn
+
       # @return [Hash{Integer => Symbol}] The mapping of action types.
       # @private
-      ACTION_TYPES: Hash[Integer, Symbol]
+      ACTION_TYPES: Hash[Integer, action_type]
 
       # @return [Symbol] Returns the type of the action.
-      attr_reader type: :ban | :kick | :mute | :warn
+      attr_reader type: action_type
 
       # @return [Integer] The duration of the timeout.
       # @note This is only available if the action type is `:timeout`.
       attr_reader duration_seconds: Integer?
 
+      #
+      # Convert the action to hash.
+      #
+      # @return [Hash] The action hash.
+      %a{pure}
+      def to_hash: -> Discorb::json
+
       #
       # Initialize a new action.
       #
@@ -115,13 +140,14 @@ module Discorb
       # @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`,
+        action_type `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`.
+      %a{pure}
       def channel: -> Discorb::Channel?
     end
   end

data/sig/discorb/avatar.rbs

@@ -18,6 +18,7 @@ module Discorb
     # rubocop: disable Lint/UnusedMethodArgument
     def url: (?image_format: String?, ?size: Integer) -> String
 
+    %a{pure}
     def inspect: -> String
 
     # @return [false] For compatibility with {Asset}, always `false`.

data/sig/discorb/channel/base.rbs

@@ -16,6 +16,7 @@ module Discorb
     # @return [Boolean] True if the channel is other channel.
     def ==: (Discorb::Channel other) -> bool
 
+    %a{pure}
     def inspect: -> String
 
     #
@@ -36,6 +37,7 @@ module Discorb
       ?no_cache: bool
     ) -> untyped
 
+    %a{pure}
     def `type`: -> String
 
     #
@@ -78,14 +80,19 @@ module Discorb
     # Stringifies the channel.
     #
     # @return [String] The name of the channel with `#`.
+    %a{pure}
     def to_s: -> String
 
+    %a{pure}
     def mention: -> String
 
+    %a{pure}
     def parent: -> Discorb::CategoryChannel?
 
+    %a{pure}
     def guild: -> Discorb::Guild
 
+    %a{pure}
     def inspect: -> String
 
     #
@@ -95,7 +102,7 @@ module Discorb
     # @param [String] reason The reason of deleting the channel.
     #
     # @return [Async::Task<self>] The deleted channel.
-    def delete!: (?reason: String?) -> Async::Task[self]
+    def delete: (?reason: String?) -> Async::Task[self]
 
     #
     # Moves the channel to another position.

data/sig/discorb/channel/category.rbs

@@ -4,6 +4,7 @@ module Discorb
   class CategoryChannel < Discorb::GuildChannel
     include Discorb::ChannelContainer
 
+    %a{pure}
     def channels: -> Array[Discorb::GuildChannel]
 
     def create_text_channel: (

data/sig/discorb/channel/container.rbs

@@ -6,24 +6,28 @@ module Discorb
     # Returns text channels.
     #
     # @return [Array<Discorb::TextChannel>] The text channels.
+    %a{pure}
     def text_channels: -> ::Array[Discorb::TextChannel]
 
     #
     # Returns voice channels.
     #
     # @return [Array<Discorb::VoiceChannel>] The voice channels.
+    %a{pure}
     def voice_channels: -> ::Array[Discorb::VoiceChannel]
 
     #
     # Returns news channels.
     #
     # @return [Array<Discorb::NewsChannel>] The news channels.
+    %a{pure}
     def news_channels: -> ::Array[Discorb::NewsChannel]
 
     #
     # Returns stage channels.
     #
     # @return [Array<Discorb::StageChannel>] The stage channels.
+    %a{pure}
     def stage_channels: -> ::Array[Discorb::StageChannel]
   end
 end

data/sig/discorb/channel/stage.rbs

@@ -54,12 +54,16 @@ module Discorb
     # @return [Async::Task<nil>] If there is no current stage instance.
     def fetch_stage_instance: -> Async::Task[StageInstance]
 
+    %a{pure}
     def voice_states: -> Array[Discorb::VoiceState]
 
+    %a{pure}
     def members: -> Array[Discorb::Member]
 
+    %a{pure}
     def speakers: -> Array[Discorb::Member]
 
+    %a{pure}
     def audiences: -> Array[Discorb::Member]
 
     # @return [Integer] The bitrate of the voice channel.

data/sig/discorb/channel/text.rbs

@@ -34,7 +34,7 @@ module Discorb
       ?rate_limit_per_user: Integer,
       ?slowmode: Integer,
       ?default_auto_archive_duration: 60 | 1440 | 4320 | 10080,
-      ?archive_in: Integer,
+      ?archive_in: 60 | 1440 | 4320 | 10080,
       ?reason: String?
     ) -> Async::Task[self]
 
@@ -66,7 +66,7 @@ module Discorb
     # @param [Boolean] force Whether to ignore the validation for message (14 days limit).
     #
     # @return [Async::Task<void>] The task.
-    def delete_messages!:
+    def delete_messages:
       (*Discorb::Message messages, ?force: bool) -> Async::Task[void]
       | (*Array[Discorb::Message] messages, ?force: bool) -> Async::Task[void]
 

data/sig/discorb/channel/thread.rbs

@@ -79,16 +79,22 @@ module Discorb
     # @note This method won't unarchive the thread. Use {#unarchive} instead.
     def unlock: (?reason: String?) -> Async::Task[self]
 
+    %a{pure}
     def parent: -> untyped
 
+    %a{pure}
     def me: -> untyped
 
+    %a{pure}
     def joined?: -> bool
 
+    %a{pure}
     def guild: -> untyped
 
+    %a{pure}
     def owner: -> untyped
 
+    %a{pure}
     def inspect: -> String
 
     #
@@ -168,14 +174,19 @@ module Discorb
         _ToS guild_id
       ) -> void
 
+      %a{pure}
       def thread: -> Discorb::ThreadChannel
 
+      %a{pure}
       def member: -> Discorb::Member
 
+      %a{pure}
       def id: -> Discorb::Snowflake
 
+      %a{pure}
       def user: -> Discorb::User
 
+      %a{pure}
       def inspect: -> String
 
       # Returns the value of attribute joined_at.

data/sig/discorb/channel/voice.rbs

@@ -27,8 +27,10 @@ module Discorb
       ?reason: String?
     ) -> Async::Task[self]
 
+    %a{pure}
     def voice_states: -> Array[Discorb::VoiceState]
 
+    %a{pure}
     def members: -> Array[Discorb::Member]
 
     # @return [Integer] The bitrate of the voice channel.