discorb 0.16.0 → 0.18.0

data/sig/discorb/app_command/handler.rbs

@@ -0,0 +1,171 @@
+module Discorb
+  module ApplicationCommand
+    #
+    # Module to handle application commands.
+    module Handler
+      #
+      # Add new top-level command.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      #  If hash is passed, it must be a pair of Language code and Command name, and `:default` key is required.
+      #  You can use `_` instead of `-` in language code.
+      # @param [String, Hash{Symbol => String}] description Command description.
+      #   If hash is passed, it must be a pair of Language code and Command description, and `:default` key is required.
+      #  You can use `_` instead of `-` in language code.
+      # @param [Hash{String => Hash{:description => String, :optional => Boolean, :type => Object}}] options
+      #  Command options.
+      #   The key is the option name, the value is a hash with the following keys:
+      #
+      #   | Key | Type | Description |
+      #   | --- | --- | --- |
+      #   | `:name_localizations` | Hash{Symbol => String} | Localizations of option name. |
+      #   | `:description` | `String` \| `Hash{Symbol => String}` |
+      #     Description of the option. If hash is passed, it must be a pair of Language code and description,
+      #     and `:default` key is required. You can use `_` instead of `-` in language code. |
+      #   | `:required` | Boolean(true | false) |
+      #     Whether the argument is required. `optional` will be used if not specified. |
+      #   | `:optional` | Boolean(true | false) |
+      #     Whether the argument is optional. `required` will be used if not specified. |
+      #   | `:type` | `Object` | Type of the option. |
+      #   | `:choices` | `Hash{String => String, Integer, Float}` | Type of the option. |
+      #   | `:choices_localizations` | `Hash{String => Hash{Symbol => String}}` |
+      #      Localization of the choice. Key must be the name of a choice. |
+      #   | `:default` | `Object` | Default value of the option. |
+      #   | `:channel_types` | `Array<Class<Discorb::Channel>>` | Type of the channel option. |
+      #   | `:autocomplete` | `Proc` | Autocomplete function. |
+      #   | `:range` | `Range` | Range of the option. Only valid for numeric options. (`:int`, `:float`) |
+      #
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      # @param [Proc] block Command block.
+      #
+      # @return [Discorb::ApplicationCommand::Command::ChatInputCommand] Command object.
+      #
+      # @see file:docs/application_command.md#register-slash-command Application Comamnds: Register Slash Command
+      # @see file:docs/cli/setup.md CLI: setup
+      def slash: (
+        Discorb::ApplicationCommand::localizable command_name,
+        Discorb::ApplicationCommand::localizable description,
+        ?Discorb::ApplicationCommand::options options,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) {
+        (
+          Discorb::CommandInteraction::ChatInputCommand interaction,
+          *untyped
+        ) -> void
+      } -> Discorb::ApplicationCommand::Command::ChatInputCommand
+
+      #
+      # Add new command with group.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      # @param [String, Hash{Symbol => String}] description Command description.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      #
+      # @yield Block to yield with the command.
+      # @yieldparam [Discorb::ApplicationCommand::Command::GroupCommand] group Group command.
+      #
+      # @return [Discorb::ApplicationCommand::Command::GroupCommand] Command object.
+      #
+      # @see file:docs/application_command.md Application Commands
+      # @see file:docs/cli/setup.md CLI: setup
+      def slash_group: (
+        Discorb::ApplicationCommand::localizable command_name,
+        Discorb::ApplicationCommand::localizable description,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) ?{
+        (Discorb::ApplicationCommand::Command::GroupCommand group) -> void
+      } -> Discorb::ApplicationCommand::Command::GroupCommand
+
+      #
+      # Add message context menu command.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      # @param [Proc] block Command block.
+      # @yield [interaction, message] Block to execute.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::Message] message Message object.
+      #
+      # @return [Discorb::ApplicationCommand::Command] Command object.
+      def message_command: (
+        Discorb::ApplicationCommand::localizable command_name,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) {
+        (
+          Discorb::CommandInteraction::UserMenuCommand interaction,
+          Discorb::Message message
+        ) -> void
+      } -> Discorb::ApplicationCommand::Command
+
+      #
+      # Add user context menu command.
+      #
+      # @param [String, Hash{Symbol => String}] command_name Command name.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to set the command to. `false` to global command, `nil` to use default.
+      # @param [Boolean] dm_permission Whether the command is available in DM.
+      # @param [Discorb::Permission] default_permission The default permission of the command.
+      # @param [Proc] block Command block.
+      # @yield [interaction, user] Block to execute.
+      # @yieldparam [Discorb::CommandInteraction::UserMenuCommand] interaction Interaction object.
+      # @yieldparam [Discorb::User] user User object.
+      #
+      # @return [Discorb::ApplicationCommand::Command] Command object.
+      def user_command: (
+        Discorb::ApplicationCommand::localizable command_name,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?,
+        ?dm_permission: bool,
+        ?default_permission: Discorb::Permission?
+      ) ?{
+        (
+          Discorb::CommandInteraction::UserMenuCommand interaction,
+          Discorb::User user
+        ) -> void
+      } -> Discorb::ApplicationCommand::Command
+
+      #
+      # Setup commands.
+      # @async
+      # @see Client#initialize
+      #
+      # @param [String] token Bot token.
+      # @param [Array<#to_s>, false, nil] guild_ids
+      #  Guild IDs to use as default. If `false` is given, it will be global command.
+      #
+      # @note `token` parameter only required if you don't run client.
+      def setup_commands: (
+        ?String? token,
+        ?guild_ids: Discorb::ApplicationCommand::guild_ids?
+      ) -> untyped
+
+      #
+      # Claer commands in specified guilds.
+      # @async
+      # @see Client#initialize
+      #
+      # @param [String] token Bot token.
+      # @param [Array<#to_s>, false, nil] guild_ids Guild IDs to clear.
+      #
+      # @note `token` parameter only required if you don't run client.
+      def clear_commands: (
+        String token,
+        Discorb::ApplicationCommand::guild_ids guild_ids
+      ) -> untyped
+    end
+  end
+end

data/sig/discorb/application.rbs

@@ -0,0 +1,142 @@
+module Discorb
+  #
+  # Represents a Discord application.
+  class Application < Discorb::DiscordModel
+    #
+    # Initializes a new instance of the Application class.
+    # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    def inspect: -> String
+
+    # @return [Discorb::Snowflake] The application's ID.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The application's name.
+    attr_reader name: String
+
+    # @return [Discorb::Asset] The application's icon.
+    attr_reader icon: Discorb::Asset
+
+    # @return [String] The application's description.
+    attr_reader description: String
+
+    # @return [String] The application's summary.
+    attr_reader summary: String
+
+    # @return [String] The application's public key.
+    attr_reader verify_key: String
+
+    # @return [Discorb::User] The application's owner.
+    attr_reader owner: Discorb::User
+
+    # @return [Discorb::Application::Team] The application's team.
+    attr_reader team: Discorb::Application::Team
+
+    # @return [Boolean] Whether the application's bot is public.
+    attr_reader bot_public: bool
+
+    # @return [Boolean] Whether the application's bot requires a code grant.
+    attr_reader bot_require_code_grant: bool
+
+    # @return [Discorb::Application::Flag] The application's flags.
+    attr_reader flags: Discorb::Application::Flag
+
+    #
+    # Represents a flag for an application.
+    # ## Flag fields
+    #
+    # | Field|Value|
+    # |---|---|
+    # | `1 << 12` | `:gateway_presence` |
+    # | `1 << 13` | `:gateway_presence_limited` |
+    # | `1 << 14` | `:gateway_guild_members` |
+    # | `1 << 15` | `:gateway_guild_members_limited` |
+    # | `1 << 16` | `:verification_pending_guild_limit` |
+    # | `1 << 17` | `:embedded` |
+    # | `1 << 18` | `:gateway_message_content` |
+    # | `1 << 19` | `:gateway_message_content_limited` |
+    class Flag < Discorb::Flag
+      attr_accessor gateway_presence: bool
+      attr_accessor gateway_presence_limited: bool
+      attr_accessor gateway_guild_members: bool
+      attr_accessor gateway_guild_members_limited: bool
+      attr_accessor verification_pending_guild_limit: bool
+      attr_accessor embedded: bool
+      attr_accessor gateway_message_content: bool
+      attr_accessor gateway_message_content_limited: bool
+    end
+
+    #
+    # Represents a team for an application.
+    class Team < Discorb::DiscordModel
+      #
+      # Initializes a new instance of the Team class.
+      # @private
+      #
+      # @param [Discorb::Client] client The client that instantiated the object.
+      # @param [Hash] data The data of the object.
+      def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+      #
+      # The team's owner.
+      #
+      # @return [Discorb::Application::Team::Member] The team's owner.
+      def owner: -> Discorb::Application::Team::Member
+
+      def inspect: -> String
+
+      # @return [Discorb::Snowflake] The team's ID.
+      attr_reader id: Discorb::Snowflake
+
+      # @return [Discorb::Asset] The team's icon.
+      attr_reader icon: Discorb::Asset
+
+      # @return [String] The team's name.
+      attr_reader name: String
+
+      # @return [Discorb::Snowflake] The team's owner's ID.
+      attr_reader owner_user_id: Discorb::Snowflake
+
+      # @return [Discorb::Application::Team::Member] The team's member.
+      attr_reader members: Discorb::Application::Team::Member
+
+      #
+      # Represents a member of team.
+      class Member < Discorb::DiscordModel
+        MEMBERSHIP_STATE: untyped
+
+        def initialize: (untyped client, untyped team, untyped data) -> void
+
+        def inspect: -> String
+
+        def ==: (untyped other) -> untyped
+
+        # @return [Discorb::User] The user.
+        attr_reader user: Discorb::User
+
+        # @return [Snowflake] The ID of member's team.
+        attr_reader team_id: Snowflake
+
+        # @return [:invited, :accepted] The member's membership state.
+        attr_reader membership_state: Symbol
+
+        # @return [Array<Symbol>] The permissions of the member.
+        # @note This always return `:*`.
+        attr_reader permissions: ::Array[Symbol]
+
+        # @return [Boolean] Whether the member is not joined to the team.
+        attr_reader pending?: bool
+
+        # @return [Boolean] Whether the member accepted joining the team.
+        attr_reader accepted?: bool
+
+        # @return [Boolean] Whether the member is the team's owner.
+        attr_reader owner?: bool
+      end
+    end
+  end
+end

data/sig/discorb/asset.rbs

@@ -0,0 +1,32 @@
+module Discorb
+  #
+  # Represents a single asset.
+  class Asset < Discorb::DiscordModel
+    #
+    # Initialize a new instance of the Asset class.
+    # @private
+    #
+    # @param [Discorb::Client] client The client that instantiated the object.
+    # @param [Hash] data The data of the object.
+    def initialize: (untyped target, untyped hash, ?path: untyped) -> void
+
+    #
+    # URL of the asset.
+    #
+    # @param [String] image_format The image format.
+    # @param [Integer] size The size of the image.
+    #
+    # @return [String] URL of the asset.
+    def url: (?image_format: String?, ?size: Integer) -> String
+
+    def inspect: -> String
+
+    def endpoint: -> untyped
+
+    # @return [String] The hash of asset.
+    attr_reader hash: String
+
+    # @return [Boolean] Whether the asset is animated.
+    attr_reader animated?: bool
+  end
+end

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