discorb 0.17.1 → 0.18.0

data/sig/discorb/shard.rbs

@@ -0,0 +1,62 @@
+module Discorb
+  #
+  # Represents a shard.
+  class Shard
+    #
+    # Initializes a new shard.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Integer] id The ID of the shard.
+    # @param [Integer] count The number of shards.
+    # @param [Integer] index The index of the shard.
+    def initialize: (
+      Discorb::Client client,
+      Integer id,
+      Integer count,
+      Integer index
+    ) -> void
+
+    #
+    # Starts the shard.
+    #
+    # @return [void]
+    def start: -> void
+
+    #
+    # Stops the shard.
+    #
+    # @return [void]
+    def close!: -> void
+
+    def inspect: -> String
+
+    # @return [Integer] The ID of the shard.
+    attr_reader id: Integer
+
+    # @return [Thread] The thread of the shard.
+    attr_reader thread: Thread
+
+    # @return [Logger] The logger of the shard.
+    attr_reader logger: Logger
+
+    # @private
+    # @return [Integer] The internal index of the shard.
+    attr_reader index: Integer
+
+    # @private
+    attr_accessor status: untyped
+
+    # @private
+    attr_accessor connection: untyped
+
+    # @private
+    attr_accessor session_id: untyped
+
+    # @private
+    attr_accessor next_shard: untyped
+
+    # @private
+    attr_accessor main_task: untyped
+  end
+end

data/sig/discorb/snowflake.rbs

@@ -0,0 +1,56 @@
+module Discorb
+  #
+  # Represents Snowflake of Discord.
+  #
+  # @see https://discord.com/developers/docs/reference#snowflakes Official Discord API docs
+  class Snowflake < String
+    #
+    # Initialize new snowflake.
+    # @private
+    #
+    # @param [#to_s] value The value of the snowflake.
+    def initialize: (untyped value) -> void
+
+    #
+    # Compares snowflake with other object.
+    #
+    # @param [#to_s] other Object to compare with.
+    #
+    # @return [Boolean] True if snowflake is equal to other object.
+    def ==: (untyped other) -> bool
+
+    #
+    # Alias of {#==}.
+    def eql?: (untyped other) -> bool
+
+    # Return hash of snowflake.
+    def hash: -> untyped
+
+    def inspect: -> String
+
+    # Timestamp of snowflake.
+    #
+    # @return [Time] Timestamp of snowflake.
+    attr_reader timestamp: Time
+
+    # Worker ID of snowflake.
+    #
+    # @return [Integer] Worker ID of snowflake.
+    attr_reader worker_id: Integer
+
+    # Process ID of snowflake.
+    #
+    # @return [Integer] Process ID of snowflake.
+    attr_reader process_id: Integer
+
+    # Increment of snowflake.
+    #
+    # @return [Integer] Increment of snowflake.
+    attr_reader increment: Integer
+
+    # Alias of to_s.
+    #
+    # @return [String] The snowflake.
+    attr_reader id: String
+  end
+end

data/sig/discorb/stage_instance.rbs

@@ -0,0 +1,63 @@
+module Discorb
+  #
+  # Represents a stage instance of a voice state.
+  class StageInstance < Discorb::DiscordModel
+    #
+    # Initialize a new instance of the StageInstance class.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The data of the stage instance.
+    # @param [Boolean] no_cache Whether to disable caching.
+    def initialize: (
+      Discorb::Client client,
+      Discorb::json data,
+      ?no_cache: bool
+    ) -> void
+
+    def guild: -> untyped
+
+    def channel: -> untyped
+
+    def discoverable?: -> bool
+
+    def public?: -> bool
+
+    def guild_only?: -> bool
+
+    def inspect: -> String
+
+    #
+    # Edits the stage instance.
+    # @async
+    # @macro edit
+    #
+    # @param [String] topic The new topic of the stage instance.
+    # @param [:public, :guild_only] privacy_level The new privacy level of the stage instance.
+    # @param [String] reason The reason for editing the stage instance.
+    #
+    # @return [Async::Task<void>] The task.
+    def edit: (
+      ?topic: String,
+      ?privacy_level: Symbol,
+      ?reason: String?
+    ) -> Async::Task[void]
+
+    #
+    # Deletes the stage instance.
+    #
+    # @param [String] reason The reason for deleting the stage instance.
+    #
+    # @return [Async::Task<void>] The task.
+    def delete!: (?reason: String?) -> Async::Task[void]
+
+    # @return [Discorb::Snowflake] The ID of the guild this voice state is for.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The topic of the stage instance.
+    attr_reader topic: String
+
+    # @return [:public, :guild_only] The privacy level of the stage instance.
+    attr_reader privacy_level: Symbol
+  end
+end

data/sig/discorb/sticker.rbs

@@ -0,0 +1,116 @@
+module Discorb
+  #
+  # Represents a sticker.
+  class Sticker < Discorb::DiscordModel
+    STICKER_TYPE: untyped
+    STICKER_FORMAT: untyped
+
+    #
+    # Initialize a new sticker.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The sticker data.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    # @return [Discorb::Snowflake] The ID of the sticker.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The name of the sticker.
+    attr_reader name: String
+
+    # @return [Array<String>] The tags of the sticker.
+    attr_reader tags: ::Array[String]
+
+    # @return [:official, :guild] The type of sticker.
+    attr_reader type: Symbol
+
+    # @return [:png, :apng, :lottie] The format of the sticker.
+    attr_reader format: Symbol
+
+    # @return [String] The URL of the sticker.
+    attr_reader description: String
+
+    # @return [Discorb::Snowflake] The ID of the sticker pack.
+    attr_reader pack_id: Discorb::Snowflake
+
+    # @return [Integer] The sort value of the sticker.
+    attr_reader sort_value: Integer
+
+    # @return [Discorb::Snowflake] The ID of the guild the sticker is in.
+    attr_reader guild_id: Discorb::Snowflake
+
+    # @return [Discorb::User] The user who created the sticker.
+    attr_reader user: Discorb::User
+
+    # @return [Boolean] Whether the sticker is available.
+    attr_reader available: bool
+
+    #
+    # Represents a sticker of guilds.
+    class GuildSticker < Discorb::Sticker
+      STICKER_TYPE: untyped
+      STICKER_FORMAT: untyped
+
+      #
+      # Edits the sticker.
+      # @async
+      # @macro edit
+      #
+      # @param [String] name The new name of the sticker.
+      # @param [String] description The new description of the sticker.
+      # @param [Discorb::emoji] tag The new tags of the sticker.
+      # @param [String] reason The reason for the edit.
+      #
+      # @return [Async::Task<void>] The task.
+      def edit: (
+        ?name: String,
+        ?description: String,
+        ?tag: Discorb::emoji,
+        ?reason: String
+      ) -> Async::Task[void]
+
+      #
+      # Deletes the sticker.
+      # @async
+      #
+      # @param [String] reason The reason for the deletion.
+      def delete!: (?reason: String?) -> untyped
+
+      # @!attribute [r] guild
+      #   @macro client_cache
+      #   @return [Discorb::Guild] The guild the sticker is in.
+      attr_reader guild: untyped
+    end
+
+    #
+    # Represents a sticker pack.
+    class Pack < Discorb::DiscordModel
+      #
+      # Initialize a new sticker pack.
+      # @private
+      #
+      # @param [Discorb::Client] client The client.
+      # @param [Hash] data The sticker pack data.
+      def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+      # @return [Discorb::Snowflake] The ID of the sticker pack.
+      attr_reader id: Discorb::Snowflake
+
+      # @return [String] The name of the sticker pack.
+      attr_reader name: String
+
+      # @return [Discorb::Snowflake] The cover sticker of the pack.
+      attr_reader cover_sticker_id: Discorb::Snowflake
+
+      # @return [String] The description of the pack.
+      attr_reader description: String
+
+      # @return [Array<Discorb::Sticker>] The stickers in the pack.
+      attr_reader stickers: ::Array[Discorb::Sticker]
+
+      # @return [Discorb::Asset] The banner of the pack.
+      attr_reader banner: Discorb::Asset
+    end
+  end
+end

data/sig/discorb/system_channel_flag.rbs

@@ -0,0 +1,17 @@
+module Discorb
+  #
+  # Represents a system channel flag.
+  # ## Flag fields
+  # |Field|Value|
+  # |-|-|
+  # |`1 << 0`|`:member_join`|
+  # |`1 << 1`|`:server_boost`|
+  # |`1 << 2`|`:setup_tips`|
+  # |`1 << 3`|`:join_stickers`|
+  class SystemChannelFlag < Discorb::Flag
+    attr_accessor member_join: bool
+    attr_accessor server_boost: bool
+    attr_accessor setup_tips: bool
+    attr_accessor join_stickers: bool
+  end
+end

data/sig/discorb/unicode_emoji.rbs

@@ -0,0 +1,49 @@
+module Discorb
+  #
+  # Represents a unicode emoji (default emoji) in discord.
+  class UnicodeEmoji < Discorb::Emoji
+    #
+    # Initialize a new unicode emoji.
+    #
+    # @param [String] name The name of the emoji.
+    # @param [Integer] tone The skin tone of the emoji.
+    def initialize: (String name, ?tone: Integer) -> void
+
+    # @return [String] The unicode string of the emoji.
+    def to_s: -> String
+
+    #
+    # Format the emoji for URI.
+    #
+    # @return [String] the formatted emoji.
+    def to_uri: -> String
+
+    def inspect: -> String
+
+    #
+    # Converts the object to a hash.
+    # @private
+    #
+    # @return [Hash] The hash represents the object.
+    def to_hash: -> Discorb::json
+
+    # @return [String] The name of the emoji. (e.g. :grinning:)
+    attr_reader name: String
+
+    # @return [String] The unicode value of the emoji. (e.g. U+1F600)
+    attr_reader value: String
+
+    # @return [Integer] The skin tone of the emoji.
+    attr_reader skin_tone: Integer
+
+    def self.[]: (String name, ?tone: Integer) -> UnicodeEmoji
+  end
+
+  #
+  # A table of emoji names and their unicode values.
+  module EmojiTable
+    DISCORD_TO_UNICODE: Hash[String, String]
+    UNICODE_TO_DISCORD: Hash[String, Array[String]]
+    SKIN_TONES: Array[String]
+  end
+end

data/sig/discorb/user.rbs

@@ -0,0 +1,93 @@
+module Discorb
+  #
+  # Represents a user of discord.
+  class User < Discorb::DiscordModel
+    include Discorb::Messageable
+
+    #
+    # Initializes a new user.
+    # @private
+    #
+    # @param [Discorb::Client] client The client.
+    # @param [Hash] data The user data.
+    def initialize: (Discorb::Client client, json data) -> void
+
+    #
+    # Format the user as `Username#Discriminator` style.
+    #
+    # @return [String] The formatted username.
+    def to_s: -> String
+
+    def inspect: -> String
+
+    #
+    # Whether the user is a owner of the client.
+    # @async
+    #
+    # @param [Boolean] strict Whether don't allow if the user is a member of the team.
+    #
+    # @return [Async::Task<Boolean>] Whether the user is a owner of the client.
+    def bot_owner?: (?strict: bool) -> Async::Task[bool]
+
+    # @return [Boolean] Whether the user is verified.
+    attr_reader verified: bool
+
+    # @return [String] The user's username.
+    attr_reader username: String
+
+    # @return [Discorb::Snowflake] The user's ID.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [Discorb::User::Flag] The user's flags.
+    attr_reader flag: Discorb::User::Flag
+
+    # @return [String] The user's discriminator.
+    attr_reader discriminator: String
+
+    # @return [Discorb::Asset, Discorb::DefaultAvatar] The user's avatar.
+    attr_reader avatar: Discorb::Asset | Discorb::DefaultAvatar
+
+    # @return [Boolean] Whether the user is a bot.
+    attr_reader bot: bool
+
+    alias bot? bot
+
+    # @return [Time] The time the user was created.
+    attr_reader created_at: Time
+
+    # @return [String] The user's mention.
+    attr_reader mention: String
+
+    #
+    # Represents the user's flags.
+    # ## Flag fields
+    # |`1 << 0`|`:discord_employee`|
+    # |`1 << 1`|`:partnered_server_owner`|
+    # |`1 << 2`|`:hypesquad_events`|
+    # |`1 << 3`|`:bug_hunter_level_1`|
+    # |`1 << 6`|`:house_bravery`|
+    # |`1 << 7`|`:house_brilliance`|
+    # |`1 << 8`|`:house_balance`|
+    # |`1 << 9`|`:early_supporter`|
+    # |`1 << 10`|`:team_user`|
+    # |`1 << 14`|`:bug_hunter_level_2`|
+    # |`1 << 16`|`:verified_bot`|
+    # |`1 << 17`|`:early_verified_bot_developer`|
+    # |`1 << 18`|`:discord_certified_moderator`|
+    class Flag < Discorb::Flag
+      attr_accessor discord_employee: bool
+      attr_accessor partnered_server_owner: bool
+      attr_accessor hypesquad_events: bool
+      attr_accessor bug_hunter_level_1: bool
+      attr_accessor house_bravery: bool
+      attr_accessor house_brilliance: bool
+      attr_accessor house_balance: bool
+      attr_accessor early_supporter: bool
+      attr_accessor team_user: bool
+      attr_accessor bug_hunter_level_2: bool
+      attr_accessor verified_bot: bool
+      attr_accessor early_verified_bot_developer: bool
+      attr_accessor discord_certified_moderato: bool
+    end
+  end
+end

data/sig/discorb/utils.rbs

@@ -0,0 +1,8 @@
+module Discorb
+  # @private
+  module Utils
+    def try: (untyped object, untyped message) -> untyped
+
+    def self.try: (untyped object, untyped message) -> untyped
+  end
+end

data/sig/discorb/voice_region.rbs

@@ -0,0 +1,30 @@
+module Discorb
+  #
+  # Represents a voice region.
+  class VoiceRegion < Discorb::DiscordModel
+    #
+    # Initialize a new instance of the VoiceRegion class.
+    # @private
+    #
+    # @param [Hash] data The data of the voice region.
+    def initialize: (Discorb::json data) -> void
+
+    # @return [Discorb::Snowflake] The ID of the voice region.
+    attr_reader id: Discorb::Snowflake
+
+    # @return [String] The name of the voice region.
+    attr_reader name: String
+
+    # @return [Boolean] Whether the voice region is VIP.
+    attr_reader vip: bool
+
+    # @return [Boolean] Whether the voice region is optimal.
+    attr_reader optimal: bool
+
+    # @return [Boolean] Whether the voice region is deprecated.
+    attr_reader deprecated: bool
+
+    # @return [Boolean] Whether the voice region is custom.
+    attr_reader custom: bool
+  end
+end

data/sig/discorb/voice_state.rbs

@@ -0,0 +1,71 @@
+module Discorb
+  #
+  # Represents a state of user in voice channel.
+  class VoiceState < Discorb::DiscordModel
+    #
+    # Initialize a new voice state.
+    # @private
+    #
+    # @param [Discorb::Client] client The client this voice state belongs to.
+    # @param [Hash] data The data of the voice state.
+    def initialize: (Discorb::Client client, Discorb::json data) -> void
+
+    # @return [Discorb::Member] The member associated with this voice state.
+    attr_reader member: Discorb::Member
+
+    # @return [Discorb::Snowflake] The ID of the guild this voice state is for.
+    attr_reader session_id: Discorb::Snowflake
+
+    # @return [Time] The time at which the user requested to speak.
+    attr_reader request_to_speak_timestamp: Time
+
+    # @return [Boolean] Whether the user is deafened.
+    attr_reader self_deaf: bool
+
+    alias self_deaf? self_deaf
+
+    # @return [Boolean] Whether the user is muted.
+    attr_reader self_mute: bool
+
+    alias self_mute? self_mute
+
+    # @return [Boolean] Whether the user is streaming.
+    attr_reader self_stream: bool
+
+    alias self_stream? self_stream
+
+    # @return [Boolean] Whether the user is video-enabled.
+    attr_reader self_video: bool
+
+    alias self_video? self_video
+
+    # @return [Boolean] Whether the user is suppressed. (Is at audience)
+    attr_reader suppress: bool
+
+    alias suppress? suppress
+
+    # @return [Boolean] Whether the user is deafened.
+    attr_reader deaf?: bool
+
+    # @return [Boolean] Whether the user is muted.
+    attr_reader mute?: bool
+
+    # @return [Boolean] Whether the user is deafened on the server.
+    attr_reader server_deaf?: bool
+
+    # @return [Boolean] Whether the user is muted on the server.
+    attr_reader server_mute?: bool
+
+    # @macro client_cache
+    # @return [Discorb::Guild] The guild this voice state is for.
+    attr_reader guild: Discorb::Guild
+
+    # @macro client_cache
+    # @return [Discorb::Channel] The channel this voice state is for.
+    attr_reader channel: Discorb::Channel
+
+    # @macro client_cache
+    # @return [Discorb::User] The user this voice state is for.
+    attr_reader user: Discorb::User
+  end
+end