discorb 0.17.1 → 0.18.0

data/sig/discorb/guild_template.rbs

@@ -0,0 +1,174 @@
+module Discorb
+  #
+  # Represents a guild template.
+  class GuildTemplate < Discorb::DiscordModel
+    #
+    # Initialize a new template.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data from Discord.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    #
+    # Edit the template.
+    # @async
+    # @macro edit
+    #
+    # @param [String] name The new name of the template.
+    # @param [String] description The new description of the template.
+    #
+    # @return [Async::Task<void>] The task.
+    def edit: (?String? name, ?String description) -> Async::Task[void]
+
+    #
+    # Update the template.
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
+    def update: -> Async::Task[void]
+
+    #
+    # Delete the template.
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
+    def delete!: -> Async::Task[void]
+
+    # @return [String] The code of the template.
+    attr_reader code: String
+
+    # @return [String] The name of the template.
+    attr_reader name: String
+
+    # @return [String] The description of the template.
+    attr_reader description: String
+
+    # @return [Integer] The number of times this template has been used.
+    attr_reader usage_count: Integer
+
+    # @return [Discorb::User] The user who created this template.
+    attr_reader creator: Discorb::User
+
+    # @return [Time] The time this template was created.
+    attr_reader created_at: Time
+
+    # @return [Time] The time this template was last updated.
+    attr_reader updated_at: Time
+
+    # @return [Discorb::Snowflake] The ID of guild where the template was created.
+    attr_reader source_guild_id: Discorb::Snowflake
+
+    # @return [Discorb::GuildTemplate::TemplateGuild] The guild where the template was created.
+    attr_reader serialized_source_guild: Discorb::GuildTemplate::TemplateGuild
+
+    # @return [Boolean] Whether this template is dirty.
+    attr_reader is_dirty: bool
+
+    # @macro client_cache
+    # @return [Discorb::Guild] The guild this template is based on.
+    # @return [nil] Client wasn't able to find the guild this template is based on.
+    attr_reader source_guild: Discorb::Guild?
+
+    #
+    # Represents a guild in guild template.
+    class TemplateGuild < Discorb::DiscordModel
+      #
+      # Initialize a new guild in guild template.
+      # @private
+      #
+      # @param [Hash] data The data from Discord.
+      def initialize: (Discorb::json data) -> void
+
+      # @return [String] The name of the guild.
+      attr_reader name: String
+
+      # @return [Integer] The AFK timeout of the guild.
+      attr_reader afk_timeout: Integer
+
+      # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::Role}] A dictionary of roles in the guild.
+      attr_reader roles: Discorb::Dictionary[Discorb::Snowflake, Discorb::Role]
+
+      # @return [Discorb::SystemChannelFlag] The flag for the system channel.
+      attr_reader system_channel_flags: Discorb::SystemChannelFlag
+
+      # @return [Discorb::Dictionary{Discorb::Snowflake => Discorb::GuildChannel}]
+      #   A dictionary of channels in the guild.
+      attr_reader channels: Discorb::Dictionary[Discorb::Snowflake, Discorb::GuildChannel]
+
+      # @return [String] The description of the guild.
+      attr_reader description: String
+
+      # @return [Symbol] The preffered language of the guild.
+      # @note This modifies the language code, `-` will be replaced with `_`.
+      attr_reader preferred_locale: Symbol
+
+      # @return [:none, :low, :medium, :high, :very_high] The verification level of the guild.
+      attr_reader verification_level: Symbol
+
+      # @return [:all_messages, :only_mentions] The default message notification level of the guild.
+      attr_reader default_message_notifications: Symbol
+
+      # @return [:disabled_in_text, :members_without_roles, :all_members] The explict content filter level of the guild.
+      attr_reader explicit_content_filter: Symbol
+
+      # @return [Boolean] Whether the guild enabled the widget.
+      attr_reader widget_enabled: bool
+
+      #
+      # Represents a role in guild template.
+      class Role < Discorb::DiscordModel
+        #
+        # Initialize a new role in guild template.
+        # @private
+        #
+        # @param [Hash] data The data from Discord.
+        def initialize: (Discorb::json data) -> void
+
+        # @return [String] The name of the role.
+        attr_reader name: String
+
+        # @return [Discorb::Permission] The permissions of the role.
+        attr_reader permissions: Discorb::Permission
+
+        # @return [Discorb::Color] The color of the role.
+        attr_reader color: Discorb::Color
+      end
+
+      #
+      # Represents a channel in guild template.
+      class Channel < Discorb::DiscordModel
+        #
+        # Initialize a new channel in guild template.
+        # @private
+        #
+        # @param [Hash] data The data from Discord.
+        def initialize: (Discorb::json data) -> void
+
+        # @return [String] The name of the channel.
+        attr_reader name: String
+
+        # @return [Integer] The position of the channel.
+        attr_reader position: Integer
+
+        # @return [String] The type of the channel.
+        attr_reader topic: String
+
+        # @return [Integer] The bitrate of the channel.
+        attr_reader bitrate: Integer
+
+        # @return [Integer] The user limit of the channel.
+        attr_reader user_limit: Integer
+
+        # @return [Boolean] Whether the channel is nsfw.
+        attr_reader nsfw: bool
+
+        # @return [Integer] The rate limit of the channel.
+        attr_reader rate_limit_per_user: Integer
+
+        # @return [Class] The class of the channel.
+        attr_reader type: Class
+      end
+    end
+  end
+end

data/sig/discorb/http.rbs

@@ -0,0 +1,147 @@
+module Discorb
+  type json =
+    ::Hash[Symbol | String, json]
+    | ::Array[json]
+    | ::String
+    | ::Symbol
+    | ::Numeric
+    | bool
+    | nil
+
+  #
+  # A class to handle http requests.
+  # @private
+  class HTTP
+    #
+    # Initializes the http client.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    def initialize: (Discorb::Client client) -> void
+
+    #
+    # Execute a request.
+    # @async
+    #
+    # @param [Discorb::Route] path The path to the resource.
+    # @param [String, Hash] body The body of the request. Defaults to an empty string.
+    # @param [String] audit_log_reason The audit log reason to send with the request.
+    # @param [Hash] kwargs The keyword arguments.
+    #
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
+    #
+    # @raise [Discorb::HTTPError] The request was failed.
+    def request: (
+      Discorb::Route path,
+      ?json | String body,
+      ?audit_log_reason: String?,
+      **String kwargs
+    ) -> Async::Task[[Net::HTTPResponse, json]]
+
+    #
+    # Execute a multipart request.
+    # @async
+    #
+    # @param [Discorb::Route] path The path to the resource.
+    # @param [String, Hash] body The body of the request.
+    # @param [Array<Discorb::Attachment>] files The files to upload.
+    # @param [Hash] headers The headers to send with the request.
+    # @param [String] audit_log_reason The audit log reason to send with the request.
+    # @param [Hash] kwargs The keyword arguments.
+    #
+    # @return [Async::Task<Array(Net::HTTPResponse, Hash)>] The response and as JSON.
+    # @return [Async::Task<Array(Net::HTTPResponse, nil)>] The response was 204.
+    #
+    # @raise [Discorb::HTTPError] The request was failed.
+    def multipart_request: (
+      Discorb::Route path,
+      json | String body,
+      ::Array[Discorb::Attachment] files,
+      ?audit_log_reason: String?,
+      **untyped kwargs
+    ) -> Async::Task[[Net::HTTPResponse, json]]
+
+    def inspect: -> String
+
+    private
+
+    def handle_response: (
+      Net::HTTPResponse resp,
+      json data,
+      Discorb::Route path,
+      json | String body,
+      ::Array[Discorb::Attachment]? files,
+      String? audit_log_reason,
+      untyped kwargs
+    ) -> [Net::HTTPResponse, json]
+
+    def get_headers: (
+      ?String | json body,
+      ?String? audit_log_reason
+    ) -> ::Hash[String, String]
+
+    def get_body: (nil | String | json body) -> String
+
+    def get_path: (Discorb::Route path) -> String
+
+    def get_response_data: (Net::HTTPResponse resp) -> json?
+
+    def http: -> Net::HTTP
+
+    def cdn_http: -> Net::HTTP
+
+    def recr_utf8: [O] (O data) -> O
+  end
+
+  #
+  # Represents an endpoint.
+  # @private
+  class Route
+    def initialize: (untyped url, untyped key, untyped method) -> void
+
+    def inspect: -> String
+
+    def hash: -> untyped
+
+    def identifier: -> untyped
+
+    def major_param: -> untyped
+
+    # Returns the value of attribute url.
+    attr_reader url: untyped
+
+    # Returns the value of attribute key.
+    attr_reader key: untyped
+
+    # Returns the value of attribute method.
+    attr_reader method: untyped
+  end
+
+  #
+  # Class to handle rate limiting.
+  # @private
+  class RatelimitHandler
+    #
+    # Initialize a rate limit handler.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    def initialize: (Discorb::Client client) -> void
+
+    def inspect: -> String
+
+    #
+    # Wait for the rate limit to reset.
+    #
+    # @param [Discorb::Route] path The path.
+    def wait: (Discorb::Route path) -> untyped
+
+    #
+    # Save the rate limit.
+    #
+    # @param [String] path The path.
+    # @param [Net::HTTPResponse] resp The response.
+    def save: (String path, Net::HTTPResponse resp) -> untyped
+  end
+end

data/sig/discorb/image.rbs

@@ -0,0 +1,20 @@
+module Discorb
+  #
+  # Represents an image.
+  class Image
+    #
+    # Initializes a new Image.
+    #
+    # @param [#read, String] source The IO source or path of the image.
+    # @param [String] type The MIME type of the image.
+    def initialize: (untyped | String source, ?String? `type`) -> void
+
+    #
+    # Formats the image as a Discord style.
+    #
+    # @return [String] The image as a Discord style.
+    def to_s: -> String
+
+    def inspect: -> String
+  end
+end

data/sig/discorb/integration.rbs

@@ -0,0 +1,118 @@
+module Discorb
+  #
+  # Represents a integration.
+  class Integration < Discorb::DiscordModel
+    EXPIRE_BEHAVIOR: Hash[Integer, Symbol]
+
+    #
+    # Initialize a new integration.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the welcome screen.
+    # @param [Discorb::Guild] guild The guild this integration is in.
+    def initialize: (
+      Discorb::Client client,
+      Discorb::json data,
+      _ToS guild_id
+    ) -> void
+
+    #
+    # Delete the integration.
+    # @async
+    #
+    # @param [String] reason The reason for deleting the integration.
+    #
+    # @return [Async::Task<void>] The task.
+    def delete!: (?reason: String?) -> Async::Task[void]
+
+    # @return [Discorb::Snowflake] The ID of the integration.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [Symbol] The type of integration.
+    attr_reader type: Symbol
+
+    # @return [Boolean] Whether the integration is enabled.
+    attr_reader enabled: bool
+
+    # @return [Boolean] Whether the integration is syncing.
+    attr_reader syncing: bool
+
+    # @return [Boolean] Whether the integration is enabled emoticons.
+    attr_reader enable_emoticons: bool
+
+    # @return [:remove_role, :kick] The behavior of the integration when it expires.
+    attr_reader expire_behavior: Symbol
+
+    # @return [Integer] The grace period of the integration.
+    attr_reader expire_grace_period: Integer
+
+    # @return [Discorb::User] The user for the integration.
+    attr_reader user: Discorb::User
+
+    # @return [Discorb::Integration::Account] The account for the integration.
+    attr_reader account: Discorb::Integration::Account
+
+    # @return [Integer] The number of subscribers for the integration.
+    attr_reader subscriber_count: Integer
+
+    # @return [Boolean] Whether the integration is revoked.
+    attr_reader revoked: bool
+
+    # @return [Discorb::Application] The application for the integration.
+    attr_reader application: Discorb::Application
+
+    # @macro client_cache
+    # @return [Discorb::Guild] The guild this integration is in.
+    attr_reader guild: Discorb::Guild?
+
+    #
+    # Represents an account for an integration.
+    class Account < Discorb::DiscordModel
+      #
+      # Initialize a new account.
+      # @private
+      #
+      # @param [Hash] data The data from Discord.
+      def initialize: (Discorb::json data) -> void
+
+      # @return [String] The ID of the account.
+      attr_reader id: String
+
+      # @return [String] The name of the account.
+      attr_reader name: String
+    end
+
+    #
+    # Represents an application for an integration.
+    class Application < Discorb::DiscordModel
+      #
+      # Initialize a new application.
+      # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The data from Discord.
+      def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+      # @return [Discorb::Snowflake] The ID of the application.
+      attr_reader id: Discorb::Snowflake
+
+      # @return [String] The name of the application.
+      attr_reader name: String
+
+      # @return [Asset] The icon of the application.
+      # @return [nil] If the application has no icon.
+      attr_reader icon: Asset?
+
+      # @return [String] The description of the application.
+      attr_reader description: String
+
+      # @return [String] The summary of the application.
+      attr_reader summary: String
+
+      # @return [Discorb::User] The bot user associated with the application.
+      # @return [nil] If the application has no bot user.
+      attr_reader bot: Discorb::User?
+    end
+  end
+end

data/sig/discorb/intents.rbs

@@ -0,0 +1,97 @@
+module Discorb
+  # Represents intents.
+  class Intents
+    INTENT_BITS: Hash[Symbol, Integer]
+
+    #
+    # Create new intents object with default (no members and presence) intents.
+    #
+    # @param guilds [Boolean] Whether guild related events are enabled.
+    # @param members [Boolean] Whether guild members related events are enabled.
+    # @param bans [Boolean] Whether guild ban related events are enabled.
+    # @param emojis [Boolean] Whether guild emojis related events are enabled.
+    # @param integrations [Boolean] Whether guild integration related events are enabled.
+    # @param webhooks [Boolean] Whether guild webhooks related events are enabled.
+    # @param invites [Boolean] Whether guild invite related events are enabled.
+    # @param voice_states [Boolean] Whether guild voice state related events are enabled.
+    # @param presences [Boolean] Whether guild presences related events are enabled.
+    # @param messages [Boolean] Whether guild messages related events are enabled.
+    # @param reactions [Boolean] Whether guild reaction related events are enabled.
+    # @param dm_messages [Boolean] Whether dm messages related events are enabled.
+    # @param dm_reactions [Boolean] Whether dm reactions related events are enabled.
+    # @param dm_typing [Boolean] Whether dm typing related events are enabled.
+    # @param message_content [Boolean] Whether message content will be sent with events.
+    # @param scheduled_events [Boolean] Whether events related scheduled events are enabled.
+    # @param automod_configuration [Boolean] Whether automod configuration related events are enabled.
+    # @param automod_execution [Boolean] Whether automod execution related events are enabled.
+    #
+    # @note You must enable privileged intents to use `members` and/or `presences` intents.
+    # @note Message Content Intent is not required to use `message_content` intents for now,
+    #   this will be required in September 1, 2022. [Learn More](https://support-dev.discord.com/hc/en-us/articles/4404772028055).
+    #   You should specify `message_content` intent for preventing unexpected changes in the future.
+    def initialize: (
+      automod_configuration: bool,
+      automod_execution: bool,
+      ?guilds: bool,
+      ?members: bool,
+      ?bans: bool,
+      ?emojis: bool,
+      ?integrations: bool,
+      ?webhooks: bool,
+      ?invites: bool,
+      ?voice_states: bool,
+      ?presences: bool,
+      ?messages: bool,
+      ?reactions: bool,
+      ?typing: bool,
+      ?dm_messages: bool,
+      ?dm_reactions: bool,
+      ?dm_typing: bool,
+      ?message_content: bool?,
+      ?scheduled_events: bool
+    ) -> void
+
+    #
+    # Returns the value of the flag.
+    def method_missing: (untyped name, ?untyped args) -> untyped
+
+    def respond_to_missing?: (untyped name, untyped include_private) -> bool
+
+    # Returns value of the intent.
+    # @return [Integer] The value of the intent.
+    def value: -> Integer
+
+    def inspect: -> String
+
+    def to_h: -> Hash[Symbol, bool]
+
+    # Create new intent object from raw value.
+    # @param value [Integer] The value of the intent.
+    def self.from_value: (Integer value) -> Intents
+
+    # Create new intent object with all intents.
+    def self.all: -> Discorb::Intents
+
+    # Create new intent object with no intents.
+    def self.none: -> Discorb::Intents
+
+    attr_accessor guilds: bool
+    attr_accessor members: bool
+    attr_accessor bans: bool
+    attr_accessor emojis: bool
+    attr_accessor integrations: bool
+    attr_accessor webhooks: bool
+    attr_accessor invites: bool
+    attr_accessor voice_states: bool
+    attr_accessor presences: bool
+    attr_accessor messages: bool
+    attr_accessor reactions: bool
+    attr_accessor dm_messages: bool
+    attr_accessor dm_reactions: bool
+    attr_accessor dm_typing: bool
+    attr_accessor message_content: bool
+    attr_accessor scheduled_events: bool
+    attr_accessor automod_configuration: bool
+    attr_accessor automod_execution: bool
+  end
+end

data/sig/discorb/interaction/autocomplete.rbs

@@ -0,0 +1,9 @@
+module Discorb
+  #
+  # Represents auto complete interaction.
+  class AutoComplete < Discorb::Interaction
+    def send_complete_result: (
+      ::Hash[String, String | Integer | Float] val
+    ) -> untyped
+  end
+end

data/sig/discorb/interaction/base.rbs

@@ -0,0 +1,66 @@
+module Discorb
+  #
+  # Represents an interaction of Discord.
+  class Interaction < Discorb::DiscordModel
+    @client: Discorb::Client
+
+    #
+    # Initialize a new interaction.
+    # @private
+    #
+    # @param [Discorb::Client] client The client this interaction belongs to.
+    # @param [Hash] data The data of the interaction.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    def guild: -> Discorb::Guild?
+
+    def channel: -> Discorb::Channel
+
+    def inspect: -> String
+
+    #
+    # Create a new Interaction instance from the data.
+    # @private
+    #
+    # @param [Discorb::Client] client The client this interaction belongs to.
+    # @param [Hash] data The data of the interaction.
+    def self.make_interaction: (
+      Discorb::Client client,
+      Discorb::json data
+    ) -> untyped
+
+    #
+    # Returns the descendants of the class.
+    # @private
+    def self.descendants: -> Array[Class]
+
+    def _set_data: (untyped) -> untyped
+
+    # @return [Discorb::Snowflake] The ID of the interaction.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [Discorb::Snowflake] The ID of the application that created the interaction.
+    attr_reader application_id: Discorb::Snowflake
+
+    # @return [Symbol] The type of interaction.
+    attr_reader type: Symbol
+
+    # @return [Discorb::User, Discorb::Member] The user or member that created the interaction.
+    attr_reader user: Discorb::User | Discorb::Member
+
+    # @return [Integer] The type of interaction.
+    # @note This is always `1` for now.
+    attr_reader version: Integer
+
+    # @return [String] The token for the interaction.
+    attr_reader token: String
+
+    # @return [Symbol] The locale of the user that created the interaction.
+    # @note This modifies the language code, `-` will be replaced with `_`.
+    attr_reader locale: Symbol
+
+    # @return [Symbol] The locale of the guild that created the interaction.
+    # @note This modifies the language code, `-` will be replaced with `_`.
+    attr_reader guild_locale: Symbol
+  end
+end

data/sig/discorb/interaction/command.rbs

@@ -0,0 +1,66 @@
+module Discorb
+  #
+  # Represents a command interaction.
+  class CommandInteraction < Discorb::Interaction
+    include Discorb::Interaction::SourceResponder
+    include Discorb::Interaction::ModalResponder
+
+    #
+    # Creates a new CommandInteraction instance for the given data.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data for the command.
+    def self.make_interaction: (
+      Discorb::Client client,
+      Discorb::json data
+    ) -> untyped
+
+    #
+    # Returns the classes under this class.
+    # @private
+    def self.nested_classes: -> untyped
+
+    #
+    # Represents a slash command interaction.
+    class ChatInputCommand < Discorb::CommandInteraction
+      #
+      # Get command data from the given data.
+      # @private
+      #
+      # @param [Hash] data The data of the command.
+      def self.get_command_data: (Discorb::json data) -> untyped
+
+      #
+      # Modify the option map with the given options.
+      # @private
+      #
+      # @param [Hash] option_map The option map to modify.
+      # @param [Array<Hash>] options The options for modifying.
+      # @param [Discorb::Guild] guild The guild where the command is executed.
+      # @param [{Discorb::Snowflake => Discorb::Member}] members The cached members of the guild.
+      # @param [{Integer => Discorb::Attachment}] attachments The cached attachments of the message.
+      def self.modify_option_map: (
+        ::Hash[untyped, untyped] option_map,
+        ::Array[::Hash[untyped, untyped]] options,
+        Discorb::Guild? guild,
+        ::Hash[Discorb::Snowflake, Discorb::Member] members,
+        ::Hash[Integer, Discorb::Attachment] attachments
+      ) -> untyped
+    end
+
+    #
+    # Represents a user context menu interaction.
+    class UserMenuCommand < Discorb::CommandInteraction
+      # @return [Discorb::Member, Discorb::User] The target user.
+      attr_reader target: Discorb::Member | Discorb::User
+    end
+
+    #
+    # Represents a message context menu interaction.
+    class MessageMenuCommand < Discorb::CommandInteraction
+      # @return [Discorb::Message] The target message.
+      attr_reader target: Discorb::Message
+    end
+  end
+end