discorb 0.17.1 → 0.18.0

data/sig/discorb/permissions.rbs

@@ -0,0 +1,149 @@
+module Discorb
+  #
+  # Represents a permission per guild.
+  # ## Flag fields
+  #
+  # | Field | Value |
+  # |-------|-------|
+  # |`1 << 0`|`:create_instant_invite`|
+  # |`1 << 1`|`:kick_members`|
+  # |`1 << 2`|`:ban_members`|
+  # |`1 << 3`|`:administrator`|
+  # |`1 << 4`|`:manage_channels`|
+  # |`1 << 5`|`:manage_guild`|
+  # |`1 << 6`|`:add_reactions`|
+  # |`1 << 7`|`:view_audit_log`|
+  # |`1 << 8`|`:priority_speaker`|
+  # |`1 << 9`|`:stream`|
+  # |`1 << 10`|`:view_channel`|
+  # |`1 << 11`|`:send_messages`|
+  # |`1 << 12`|`:send_tts_messages`|
+  # |`1 << 13`|`:manage_messages`|
+  # |`1 << 14`|`:embed_links`|
+  # |`1 << 15`|`:attach_files`|
+  # |`1 << 16`|`:read_message_history`|
+  # |`1 << 17`|`:mention_everyone`|
+  # |`1 << 18`|`:use_external_emojis`|
+  # |`1 << 19`|`:view_guild_insights`|
+  # |`1 << 20`|`:connect`|
+  # |`1 << 21`|`:speak`|
+  # |`1 << 22`|`:mute_members`|
+  # |`1 << 23`|`:deafen_members`|
+  # |`1 << 24`|`:move_members`|
+  # |`1 << 25`|`:use_vad`|
+  # |`1 << 26`|`:change_nickname`|
+  # |`1 << 27`|`:manage_nicknames`|
+  # |`1 << 28`|`:manage_roles`|
+  # |`1 << 29`|`:manage_webhooks`|
+  # |`1 << 30`|`:manage_emojis`|
+  # |`1 << 31`|`:use_slash_commands`|
+  # |`1 << 32`|`:request_to_speak`|
+  # |`1 << 34`|`:manage_threads`|
+  # |`1 << 35`|`:use_public_threads`|
+  # |`1 << 36`|`:use_private_threads`|
+  class Permission < Discorb::Flag
+    attr_accessor create_instant_invite: bool
+    attr_accessor kick_members: bool
+    attr_accessor ban_members: bool
+    attr_accessor administrator: bool
+    attr_accessor manage_channels: bool
+    attr_accessor manage_guild: bool
+    attr_accessor add_reactions: bool
+    attr_accessor view_audit_log: bool
+    attr_accessor priority_speaker: bool
+    attr_accessor stream: bool
+    attr_accessor view_channel: bool
+    attr_accessor send_messages: bool
+    attr_accessor send_tts_messages: bool
+    attr_accessor manage_messages: bool
+    attr_accessor embed_links: bool
+    attr_accessor attach_files: bool
+    attr_accessor read_message_history: bool
+    attr_accessor mention_everyone: bool
+    attr_accessor use_external_emojis: bool
+    attr_accessor view_guild_insights: bool
+    attr_accessor connect: bool
+    attr_accessor speak: bool
+    attr_accessor mute_members: bool
+    attr_accessor deafen_members: bool
+    attr_accessor move_members: bool
+    attr_accessor use_vad: bool
+    attr_accessor change_nickname: bool
+    attr_accessor manage_nicknames: bool
+    attr_accessor manage_roles: bool
+    attr_accessor manage_webhooks: bool
+    attr_accessor manage_emojis: bool
+    attr_accessor use_slash_commands: bool
+    attr_accessor request_to_speak: bool
+    attr_accessor manage_threads: bool
+    attr_accessor use_public_threads: bool
+    attr_accessor use_private_threads: bool
+  end
+
+  #
+  # Represents a permission per channel.
+  class PermissionOverwrite
+    #
+    # Initializes a new PermissionOverwrite.
+    # @private
+    #
+    # @param allow [Integer] The allowed permissions.
+    # @param deny [Integer] The denied permissions.
+    def initialize: (Integer allow, Integer deny) -> void
+
+    def allow: -> Discorb::Permission
+
+    def deny: -> Discorb::Permission
+
+    def allow_value: -> Integer
+
+    def deny_value: -> Integer
+
+    def inspect: -> String
+
+    #
+    # Converts the permission overwrite to a hash.
+    #
+    # @return [Hash] The permission overwrite as a hash.
+    def to_hash: -> Hash[Symbol, bool]
+
+    #
+    # Union of the permission overwrites.
+    #
+    # @param [Discorb::PermissionOverwrite] other The other permission overwrite.
+    #
+    # @return [Discorb::PermissionOverwrite] The union of the permission overwrites.
+    def +: (Discorb::PermissionOverwrite other) -> Discorb::PermissionOverwrite
+
+    #
+    # Returns whether overwrite of the given field.
+    #
+    # @param [Symbol] field The field to check.
+    #
+    # @return [true, false, nil] Whether the field is allowed, denied or not set.
+    def []: (Symbol field) -> bool?
+
+    #
+    # Sets the given field to the given value.
+    #
+    # @param [Symbol] key The field to set.
+    # @param [Boolean] bool The value to set.
+    def []=: (Symbol key, bool `bool`) -> untyped
+
+    #
+    # Returns the value of the flag.
+    def method_missing: (untyped method, ?untyped `bool`) -> untyped
+
+    def respond_to_missing?: (untyped method, untyped _arg) -> bool
+
+    #
+    # Initializes a permission overwrite from a hash.
+    #
+    # @param [Hash] hash The hash to initialize the permission overwrite from.
+    #
+    # @return [Discorb::PermissionOverwrite] The permission overwrite.
+    def self.from_hash: (
+      ::Hash[Symbol, bool] hash
+    ) -> Discorb::PermissionOverwrite
+  end
+end

data/sig/discorb/presence.rbs

@@ -0,0 +1,237 @@
+module Discorb
+  #
+  # Represents a presence of user.
+  class Presence < Discorb::DiscordModel
+    #
+    # Initialize a presence.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the presence.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    def inspect: -> String
+
+    # @return [:online, :idle, :dnd, :offline] The status of the user.
+    attr_reader status: Symbol
+
+    # @return [Array<Discorb::Presence::Activity>] The activities of the user.
+    attr_reader activities: ::Array[Discorb::Presence::Activity]
+
+    # @return [Discorb::Presence::ClientStatus] The client status of the user.
+    attr_reader client_status: Discorb::Presence::ClientStatus
+
+    # @return [Discorb::User] The user of the presence.
+    attr_reader user: Discorb::User
+
+    # @return [Discorb::Guild] The guild of the presence.
+    attr_reader guild: Discorb::Guild
+
+    # @return [Discorb::Presence::Activity] The activity of the presence.
+    attr_reader activity: Discorb::Presence::Activity
+
+    #
+    # Represents an activity of a user.
+    class Activity < Discorb::DiscordModel
+      ACTIVITY_TYPES: untyped
+
+      #
+      # Initialize the activity.
+      # @private
+      #
+      # @param [Hash] data The activity data.
+      def initialize: (Discorb::json data) -> void
+
+      #
+      # Convert the activity to a string.
+      #
+      # @return [String] The string representation of the activity.
+      def to_s: -> String
+
+      # @return [String] The name of the activity.
+      attr_reader name: String
+
+      # @return [:game, :streaming, :listening, :watching, :custom, :competing] The type of the activity.
+      attr_reader type: Symbol
+
+      # @return [String] The url of the activity.
+      attr_reader url: String
+
+      # @return [Time] The time the activity was created.
+      attr_reader created_at: Time
+
+      # @return [Discorb::Presence::Activity::Timestamps] The timestamps of the activity.
+      attr_reader timestamps: Discorb::Presence::Activity::Timestamps
+
+      # @return [Discorb::Snowflake] The application id of the activity.
+      attr_reader application_id: Discorb::Snowflake
+
+      # @return [String] The details of the activity.
+      attr_reader details: String
+
+      # @return [String] The state of party.
+      attr_reader state: String
+
+      # @return [Discorb::Emoji] The emoji of the activity.
+      attr_reader emoji: Discorb::emoji?
+
+      # @return [Discorb::Presence::Activity::Party] The party of the activity.
+      # @return [nil] If the activity is not a party activity.
+      attr_reader party: Discorb::Presence::Activity::Party?
+
+      # @return [Discorb::Presence::Activity::Asset] The assets of the activity.
+      # @return [nil] If the activity has no assets.
+      attr_reader assets: Discorb::Presence::Activity::Asset?
+
+      # @return [Discorb::StageInstance] The instance of the activity.
+      # @return [nil] If the activity is not a stage activity.
+      attr_reader instance: Discorb::StageInstance?
+
+      # @return [Array<Discorb::Presence::Activity::Button>] The buttons of the activity.
+      # @return [nil] If the activity has no buttons.
+      attr_reader buttons: ::Array[Discorb::Presence::Activity::Button]?
+
+      # @return [Discorb::Presence::Activity::Flag] The flags of the activity.
+      attr_reader flags: Discorb::Presence::Activity::Flag
+
+      #
+      # Represents the timestamps of an activity.
+      class Timestamps < Discorb::DiscordModel
+        #
+        # Initialize the timestamps.
+        # @private
+        #
+        # @param [Hash] data The timestamps data.
+        def initialize: (Discorb::json data) -> void
+
+        # @return [Time] The start time of the activity.
+        attr_reader start: Time
+
+        # @return [Time] The end time of the activity.
+        attr_reader end: Time
+      end
+
+      #
+      # Represents the party of an activity.
+      class Party < Discorb::DiscordModel
+        #
+        # Initialize the party.
+        # @private
+        #
+        # @param [Hash] data The party data.
+        def initialize: (Discorb::json data) -> void
+
+        # @return [String] The id of the party.
+        attr_reader id: String
+
+        # @return [Integer] The current size of the party.
+        attr_reader current_size: Integer
+
+        # @return [Integer] The max size of the party.
+        attr_reader max_size: Integer
+      end
+
+      #
+      # Represents the assets of an activity.
+      class Asset < Discorb::DiscordModel
+        def initialize: (untyped data) -> void
+
+        # @return [String] The large image ID or URL of the asset.
+        attr_reader large_image: String
+
+        # @return [String] The large text of the activity.
+        attr_reader large_text: String
+
+        # @return [String] The small image ID or URL of the activity.
+        attr_reader small_image: String
+
+        # @return [String] The small text of the activity.
+        attr_reader small_text: String
+      end
+
+      #
+      # Represents the flags of an activity.
+      # ## Flag fields
+      # |`1 << 0`|`:instance`|
+      # |`1 << 1`|`:join`|
+      # |`1 << 2`|`:spectate`|
+      # |`1 << 3`|`:join_request`|
+      # |`1 << 4`|`:sync`|
+      # |`1 << 5`|`:play`|
+      class Flag < Discorb::Flag
+        attr_accessor instance: bool
+        attr_accessor join: bool
+        attr_accessor spectate: bool
+        attr_accessor join_request: bool
+        attr_accessor sync: bool
+        attr_accessor play: bool
+      end
+
+      #
+      # Represents a secrets of an activity.
+      class Secrets < Discorb::DiscordModel
+        #
+        # Initialize the secrets.
+        # @private
+        #
+        # @param [Hash] data The secrets data.
+        def initialize: (Discorb::json data) -> void
+
+        # @return [String] The join secret of the activity.
+        attr_reader join: String
+
+        # @return [String] The spectate secret of the activity.
+        attr_reader spectate: String
+
+        # @return [String] The match secret of the activity.
+        attr_reader match: String
+      end
+
+      #
+      # Represents a button of an activity.
+      class Button < Discorb::DiscordModel
+        #
+        # Initialize the button.
+        # @private
+        #
+        # @param [Hash] data The button data.
+        def initialize: (Discorb::json data) -> void
+
+        # @return [String] The text of the button.
+        attr_reader label: String
+
+        # @return [String] The URL of the button.
+        attr_reader url: String
+      end
+    end
+
+    #
+    # Represents a user's client status.
+    class ClientStatus < Discorb::DiscordModel
+      #
+      # Initialize the client status.
+      # @private
+      #
+      # @param [Hash] data The client status data.
+      def initialize: (Discorb::json data) -> void
+
+      # @return [Symbol] The desktop status of the user.
+      attr_reader desktop: Symbol
+
+      # @return [Symbol] The mobile status of the user.
+      attr_reader mobile: Symbol
+
+      # @return [Symbol] The web status of the user.
+      attr_reader web: Symbol
+
+      # @return [Boolean] Whether the user is not offline on desktop.
+      attr_reader desktop?: bool
+
+      # @return [Boolean] Whether the user is not offline on mobile.
+      attr_reader mobile?: bool
+
+      # @return [Boolean] Whether the user is not offline on web.
+      attr_reader web?: bool
+    end
+  end
+end

data/sig/discorb/reaction.rbs

@@ -0,0 +1,33 @@
+module Discorb
+  #
+  # Represents a reaction to a message.
+  class Reaction < Discorb::DiscordModel
+    #
+    # Initialize a new reaction.
+    # @private
+    #
+    # @param [Discorb::Message] message The message that this reaction is on.
+    # @param [Hash] data The data of the reaction.
+    def initialize: (Discorb::Message message, Discorb::json data) -> void
+
+    #
+    # Fetch the user that reacted with this emoji.
+    #
+    # @param (see Message#fetch_reacted_users)
+    #
+    # @return [Async::Task<Array<Discorb::User>>] The users that reacted with this emoji.
+    def fetch_users: -> Async::Task[::Array[Discorb::User]]
+
+    # @return [Integer] The number of users that have reacted with this emoji.
+    attr_reader count: Integer
+
+    # @return [Discorb::Emoji, Discorb::PartialEmoji] The emoji that was reacted with.
+    attr_reader emoji: Discorb::emoji
+
+    # @return [Discorb::Message] The message that this reaction is on.
+    attr_reader message: Discorb::Message
+
+    # @return [Boolean] Whether client user reacted with this emoji.
+    attr_reader me: bool
+  end
+end

data/sig/discorb/role.rbs

@@ -0,0 +1,145 @@
+module Discorb
+  #
+  # Represents a role in the guild.
+  class Role < Discorb::DiscordModel
+    include Comparable
+
+    #
+    # Initializes a new role.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Discorb::Guild] guild The guild the role belongs to.
+    # @param [Hash] data The data of the role.
+    def initialize: (
+      Discorb::Client client,
+      Discorb::Guild guild,
+      Discorb::json data
+    ) -> void
+
+    def icon: -> (Discorb::Asset | Discorb::emoji | nil)
+
+    #
+    # Compares two roles by their position.
+    #
+    # @param [Discorb::Role] other The role to compare to.
+    #
+    # @return [Integer] -1 if the other role is higher, 0 if they are equal, 1 if the other role is lower.
+    def <=>: (Discorb::Role other) -> Integer?
+
+    #
+    # Formats the role as a string.
+    #
+    # @return [String] The formatted string.
+    def to_s: -> String
+
+    def mention: -> String
+
+    def color?: -> bool
+
+    def inspect: -> String
+
+    #
+    # Moves the role to a new position.
+    # @async
+    #
+    # @param [Integer] position The new position.
+    # @param [String] reason The reason for moving the role.
+    #
+    # @return [Async::Task<void>] The task.
+    def move: (Integer position, ?reason: String?) -> Async::Task[void]
+
+    #
+    # Edits the role.
+    # @async
+    # @macro edit
+    #
+    # @param [String] name The new name of the role.
+    # @param [Integer] position The new position of the role.
+    # @param [Discorb::Color] color The new color of the role.
+    # @param [Boolean] hoist Whether the role should be hoisted.
+    # @param [Boolean] mentionable Whether the role should be mentionable.
+    # @param [Discorb::Image, Discorb::UnicodeEmoji] icon The new icon or emoji of the role.
+    # @param [String] reason The reason for editing the role.
+    #
+    # @return [Async::Task<void>] The task.
+    def edit: (
+      ?name: String,
+      ?position: Integer,
+      ?color: Discorb::Color,
+      ?hoist: bool,
+      ?mentionable: bool,
+      ?icon: Discorb::Image | Discorb::UnicodeEmoji,
+      ?reason: String?
+    ) -> Async::Task[void]
+
+    #
+    # Deletes the role.
+    #
+    # @param [String] reason The reason for deleting the role.
+    #
+    # @return [Async::Task<void>] The task.
+    def delete!: (?reason: String?) -> Async::Task[void]
+
+    def tag: -> Discorb::Role::Tag
+
+    # @return [Discorb::Snowflake] The ID of the role.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The name of the role.
+    attr_reader name: String
+
+    # @return [Discorb::Color] The color of the role.
+    attr_reader color: Discorb::Color
+
+    # @return [Discorb::Permission] The permissions of the role.
+    attr_reader permissions: Discorb::Permission
+
+    # @return [Integer] The position of the role.
+    attr_reader position: Integer
+
+    # @return [Discorb::Guild] The guild this role belongs to.
+    attr_reader guild: Discorb::Guild
+
+    # @return [Boolean] Whether the role is hoisted.
+    attr_reader hoist: bool
+
+    # @return [Boolean] Whether the role is managed.
+    attr_reader managed: bool
+
+    # @return [Boolean] Whether the role is a default role.
+    attr_reader mentionable: bool
+
+    # @return [Discorb::Asset, nil] The icon of the role.
+    attr_reader custom_icon: Discorb::Asset?
+
+    # @return [Discorb::Emoji, nil] The emoji of the role.
+    attr_reader emoji: Discorb::Emoji?
+
+    #
+    # Represents a tag of a role.
+    class Tag < Discorb::DiscordModel
+      #
+      # Initializes a new tag.
+      # @private
+      #
+      # @param [Hash] data The data of the tag.
+      def initialize: (json data) -> void
+
+      # @return [Discorb::Snowflake] The ID of the bot that owns the role.
+      attr_reader bot_id: Discorb::Snowflake
+
+      # @return [Discorb::Snowflake] The ID of the integration.
+      attr_reader integration_id: Discorb::Snowflake
+
+      # @return [Boolean] Whether the tag is a premium subscriber role.
+      attr_reader premium_subscriber: bool
+
+      # @return [Boolean] Whether the role is a bot role.
+      attr_reader bot?: bool
+
+      # @return [Boolean] Whether the role is an integration role.
+      attr_reader integration?: bool
+    end
+  end
+end

data/sig/discorb/scheduled_event.rbs

@@ -0,0 +1,148 @@
+module Discorb
+  #
+  # Represents an event in guild.
+  class ScheduledEvent < Discorb::DiscordModel
+    PRIVACY_LEVEL: untyped
+    STATUS: untyped
+    ENTITY_TYPE: untyped
+
+    # @!visibility private
+    def initialize: (untyped client, untyped data) -> void
+
+    #
+    # Create a scheduled event for the guild.
+    # @async
+    #
+    # @param [:stage_instance, :voice, :external] type The type of event to create.
+    # @param [String] name The name of the event.
+    # @param [String] description The description of the event.
+    # @param [Time] start_time The start time of the event.
+    # @param [Time, nil] end_time The end time of the event. Defaults to `nil`.
+    # @param [Discorb::Channel, Discorb::Snowflake, nil] channel The channel to run the event in.
+    # @param [String, nil] location The location of the event. Defaults to `nil`.
+    # @param [:guild_only] privacy_level The privacy level of the event. This must be `:guild_only`.
+    # @param [:active, :completed, :canceled] status The status of the event.
+    #
+    # @return [Async::Task<Discorb::ScheduledEvent>] The event that was created.
+    #
+    # @see Event#start
+    # @see Event#cancel
+    # @see Event#complete
+    def edit: (
+      ?type: Symbol,
+      ?name: String,
+      ?description: String,
+      ?start_time: Time,
+      ?end_time: Time?,
+      ?privacy_level: Symbol,
+      ?location: String?,
+      ?channel: (Discorb::Channel | Discorb::Snowflake)?,
+      ?status: Symbol
+    ) -> Async::Task[Discorb::ScheduledEvent]
+
+    #
+    # Starts the event. Shortcut for `edit(status: :active)`.
+    def start: -> untyped
+
+    #
+    # Completes the event. Shortcut for `edit(status: :completed)`.
+    def complete: -> untyped
+
+    #
+    # Cancels the event. Shortcut for `edit(status: :canceled)`.
+    def cancel: -> untyped
+
+    #
+    # Deletes the event.
+    # @async
+    #
+    # @return [Async::Task<void>] The task.
+    def delete!: -> Async::Task[void]
+
+    #
+    # Fetches the event users.
+    # @async
+    #
+    # @note You can fetch all of members by not specifying a parameter.
+    #
+    # @param [Integer] limit The maximum number of users to fetch. Defaults to `100`.
+    # @param [#to_s] after The ID of the user to start fetching from. Defaults to `nil`.
+    # @param [#to_s] before The ID of the user to stop fetching at. Defaults to `nil`.
+    # @param [Boolean] with_member Whether to include the member object of the event. Defaults to `false`.
+    #   This should be used for manual fetching of members.
+    #
+    # @return [Async::Task<Array<Discorb::Member>>] The event users.
+    def fetch_users: (
+      ?Integer? limit,
+      ?before: untyped,
+      ?after: untyped,
+      ?with_member: bool
+    ) -> Async::Task[::Array[Discorb::Member]]
+
+    # @return [Discorb::Snowflake] The ID of the event.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The name of the event.
+    attr_reader name: String
+
+    # @return [String] The description of the event.
+    attr_reader description: String
+
+    # @return [Time] The time the event starts.
+    attr_reader scheduled_start_time: Time
+
+    # @return [Time] The time the event ends.
+    attr_reader scheduled_end_time: Time
+
+    # @return [:guild_only] The privacy level of the event.
+    attr_reader privacy_level: Symbol
+
+    # @return [:scheduled, :active, :completed, :canceled] The status of the event.
+    attr_reader status: Symbol
+
+    # @return [:stage_instance, :voice, :external] The type of the event.
+    attr_reader entity_type: Symbol
+
+    # @return [Discorb::Snowflake] The ID of the entity the event is for.
+    attr_reader entity_id: Discorb::Snowflake
+
+    # @return [Discorb::ScheduledEvent::Metadata] The metadata of the event.
+    attr_reader metadata: Discorb::ScheduledEvent::Metadata
+
+    # @return [Integer] The user count of the event.
+    attr_reader user_count: Integer
+
+    # @!attribute [r] guild
+    #   @return [Discorb::Guild, nil] The guild of the event.
+    # @!attribute [r] channel
+    #   @return [Discorb::Channel, nil] The channel of the event.
+    #     Only present if the event will do in stage instance or voice channel.
+    # @!attribute [r] creator
+    #   @return [Discorb::User] The user who created the event.#
+    # @!attribute [r] time
+    #   @return [Range<Time>] The time range of the event.
+    attr_reader guild: untyped
+
+    # @return [Discorb::Channel, nil] The channel of the event.
+    #   Only present if the event will do in stage instance or voice channel.
+    attr_reader channel: Discorb::Channel?
+
+    # @return [Discorb::User] The user who created the event.#
+    attr_reader creator: Discorb::User
+
+    # @return [Range<Time>] The time range of the event.
+    attr_reader time: ::Range[Time]
+
+    #
+    # Represents the metadata of the event.
+    class Metadata
+      # @!visibility private
+      def initialize: (untyped data) -> void
+
+      def inspect: -> String
+
+      # @return [String, nil] The location of the event. Only present if the event is a external event.
+      attr_reader location: String?
+    end
+  end
+end