discorb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae7ec3df7c6da178e1ce924879cbda686fa17b1a3ad3858419ef2bf6f4bc9ada
+  data.tar.gz: f23eb8f8bc6acceacb33b555f38283297ff04140051c273a2ee26cf4c0fc50d4
+SHA512:
+  metadata.gz: f43d25457a75adadc96f6d3d3304ea38956006888a03ef1159f6b1ce2e956167e283e540cf1e64dcb43c40774b6a8fcc63b0b1f76b2d2da1ebf574a16869153c
+  data.tar.gz: a6726842c6049171b02113947d430e96364021fbdcc5057d97feecb1d2a3f7866540c8327c2ad82e425a82cb8539ed7e2aa0a54ac4c1013593d2196630761fbb

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.yardopts

@@ -0,0 +1,6 @@
+--protected
+--no-private
+--markup markdown
+--tag flags:"Flags"
+-
+docs/*.md

data/Changelog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.0.1 - Initial release
+
+- Initial release

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in discorb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "async"
+gem "async-http"
+gem "async-websocket"
+
+gem "mime-types", "~> 3.3"
+
+group :debug, optional: true do
+  gem "rufo", "~> 0.13.0"
+end
+
+group :docs, optional: true do
+  gem "redcarpet"
+  gem "yard", "~> 0.9.26"
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    discorb (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    async (1.30.0)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.56.5)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.22.0)
+      protocol-http1 (~> 0.14.0)
+      protocol-http2 (~> 0.14.0)
+    async-io (1.32.2)
+      async
+    async-pool (0.3.8)
+      async (>= 1.25)
+    async-websocket (0.19.0)
+      async-http (~> 0.54)
+      async-io (~> 1.23)
+      protocol-websocket (~> 0.7.0)
+    colorize (0.8.1)
+    console (1.13.1)
+      fiber-local
+    fiber-local (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    nio4r (2.5.7)
+    protocol-hpack (1.4.2)
+    protocol-http (0.22.5)
+    protocol-http1 (0.14.1)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    protocol-websocket (0.7.5)
+      protocol-http (~> 0.2)
+      protocol-http1 (~> 0.2)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    ricecream (0.2.0)
+    rufo (0.13.0)
+    timers (4.3.3)
+    yard (0.9.26)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  async
+  async-http
+  async-websocket
+  colorize (~> 0.8.1)
+  discorb!
+  mime-types (~> 3.3)
+  rake (~> 13.0)
+  redcarpet
+  ricecream (~> 0.2.0)
+  rufo (~> 0.13.0)
+  yard (~> 0.9.26)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 sevenc-nanashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# discorb
+[![rubydoc](https://img.shields.io/badge/Document-rubydoc.info-blue.svg)](https://rubydoc.info/gems/discorb)
+[![Gem](https://img.shields.io/gem/dt/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)
+[![Gem](https://img.shields.io/gem/v/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)  
+
+discorb is a Discord API wrapper for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'discorb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install discorb
+
+## Usage
+
+### Simple ping-pong
+
+```ruby
+require "discorb"
+
+client = Discorb::Client.new
+
+client.once :ready do
+  puts "Logged in as #{client.user}"
+end
+
+client.on :message do |_task, message|
+  next if message.author.bot?
+  next unless message.content == "ping"
+
+  message.channel.post("Pong!")
+end
+
+client.run(ENV["DISCORD_BOT_TOKEN"])
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sevenc-nanashi/discorb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]
+
+task :emoji_table do
+  require_relative "lib/discorb"
+
+  res = {}
+  Discorb::EmojiTable::DISCORD_TO_UNICODE.each do |discord, unicode|
+    res[unicode] ||= []
+    res[unicode] << discord
+  end
+
+  res_text = +""
+  res.each do |unicode, discord|
+    res_text << %(#{unicode.unpack("C*").pack("C*").inspect} => %w[#{discord.join(" ")}],\n)
+  end
+
+  table_script = File.read("lib/discorb/emoji_table.rb")
+
+  table_script.gsub!(/(?<=UNICODE_TO_DISCORD = {\n)[\s\S]+(?=}\.freeze)/, res_text)
+
+  File.open("lib/discorb/emoji_table.rb", "w") do |f|
+    f.print(table_script)
+  end
+  `rubocop -A lib/discorb/emoji_table.rb`
+  puts "Successfully made emoji_table.rb"
+end
+
+task :format do
+  Dir.glob("**/*.rb").each do |file|
+    next if file.start_with?("vendor")
+
+    puts "Formatting #{file}"
+    `rufo ./#{file}`
+    content = ""
+    File.open(file, "rb") do |f|
+      content = f.read
+    end
+    content.gsub!("\r\n", "\n")
+    File.open(file, "wb") do |f|
+      f.print(content)
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'discorb'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/discorb.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/discorb/common"
+
+Gem::Specification.new do |spec|
+  spec.name = "discorb"
+  spec.version = Discorb::VERSION
+  spec.authors = ["sevenc-nanashi"]
+  spec.email = ["sevenc-nanashi@sevenbot.jp"]
+
+  spec.summary = "discorb is a Discord API wrapper for Ruby."
+  spec.description = File.read(File.join(__dir__, "README.md"))
+  spec.homepage = "https://github.com/sevenc-nanashi/discorb"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sevenc-nanashi/discorb"
+  spec.metadata["changelog_uri"] = "https://github.com/sevenc-nanashi/discorb/blob/main/Changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/docs/Examples.md

@@ -0,0 +1,26 @@
+# @title Examples
+
+# Examples
+
+## Simple ping pong
+
+{include:file:examples/simple/ping_pong.rb}
+
+## Wait for a message
+
+{include:file:examples/simple/wait_for_message.rb}
+
+## Use components
+
+### Authorization button
+
+{include:file:examples/components/authorization_button.rb}
+
+### Pagination with select menu
+
+{include:file:examples/components/select_menu.rb}
+
+#### Note
+
+This example is not shown correctly in the docs.
+[Read this example on GitHub](https://github.com/discorb-lib/discorb/blob/main/examples/components/select_menu.rb).

data/docs/events.md

@@ -0,0 +1,480 @@
+# @title Events
+
+# Events
+
+## How to use events
+
+discorb uses event driven programming.
+You can register event handlers with {Client#on}.
+Alternatively, you can use {Client#once} to register a one-time event handler.
+
+```ruby
+client.on :message do |_task, event|
+  puts event.message.content
+end
+```
+
+This example will print the content of every message received.
+
+## Event reference
+
+### Note
+
+`Async::Task` object will be passed to the event handler in the first argument: `task`.
+
+### Client events
+
+#### `event_receive(task, event_name, data)`
+Fires when a event is received.  
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event_name`| Symbol | The name of the event. |
+|`data`      | Hash   | The data of the event. |
+
+#### `ready(task)`
+
+Fires when the client is ready.
+
+#### `resumed(task)`
+
+Fires when the client is resumed connection.
+
+### Guild events
+
+#### `guild_join(task, guild)`
+
+Fires when client joins a guild.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild} | The guild that was joined. |
+
+#### `guild_available(task, guild)`
+
+Fires when a guild becomes available.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild} | The guild that became available. |
+
+#### `guild_update(task, before, after)`
+
+Fires when client updates a guild.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`before`    | {Discorb::Guild} | The guild before the update. |
+|`after`     | {Discorb::Guild} | The guild after the update. |
+
+#### `guild_leave(task, guild)`
+
+Fires when client leaves a guild.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild} | The guild that was left. |
+
+#### `guild_destroy(task, guild)`
+
+Fires when guild is destroyed.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild} | The guild that was destroyed. |
+
+#### `guild_integrations_update(task, guild)`
+
+Fires when guild integrations are updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild} | The guild that integrations were updated for. |
+
+#### `guild_ban_add(task, guild, user)`
+
+Fires when a user is banned from a guild.
+
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild} | The guild that the user was banned from. |
+|`user`      | {Discorb::User}  | The user that was banned. |
+
+#### `guild_ban_remove(task, guild, user)`
+
+Fires when a user is unbanned from a guild.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild} | The guild that the user was unbanned from. |
+|`user`      | {Discorb::User}  | The user that was unbanned. |
+
+### Channel events
+
+#### `channel_create(task, channel)`
+
+Fires when a channel is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`channel`   | {Discorb::Channel} | The channel that was created. |
+
+#### `channel_update(task, before, after)`
+
+Fires when a channel is updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`before`    | {Discorb::Channel} | The channel before the update. |
+|`after`     | {Discorb::Channel} | The channel after the update. |
+
+#### `channel_delete(task, channel)`
+
+Fires when a channel is deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`channel`   | {Discorb::Channel} | The channel that was deleted. |
+
+#### `webhooks_update(task, event)`
+
+Fires when a webhook is updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event`     | {Discorb::WebhooksUpdateEvent} | The webhook update event. |
+
+#### `thread_new(task, thread)`
+
+Fires when a thread is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`thread`    | {Discorb::ThreadChannel} | The thread that was created. |
+
+#### `thread_join(task, thread)`
+
+Fires when client joins a thread.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`thread`    | {Discorb::ThreadChannel} | The thread that was joined. |
+
+
+#### `thread_delete(task, thread)`
+
+Fires when a thread is deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`thread`    | {Discorb::ThreadChannel} | The thread that was deleted. |
+
+#### `thread_update(task, before, after)`
+
+Fires when a thread is updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`before`    | {Discorb::ThreadChannel} | The thread before the update. |
+|`after`     | {Discorb::ThreadChannel} | The thread after the update. |
+
+#### `thread_members_update(task, thread, added, removed)`
+
+Fires when a thread's members are updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`thread`    | {Discorb::ThreadChannel} | The thread that the members were updated for. |
+|`added`     | Array<{ThreadChannel::Member}> | An array of {Discorb::ThreadChannel::Member} objects that were added to the thread. |
+|`removed`   | Array<{ThreadChannel::Member}> | An array of {Discorb::ThreadChannel::Member} objects that were removed from the thread. |
+
+#### `thread_member_update(task, before, after)`
+
+Fires when a thread member is updated.
+
+| Parameter | Type  | Description |
+| --------- | ----- | ----------- |
+|`thread`   | {Discorb::ThreadChannel} | The thread that the member was updated for. |
+|`before`   | {Discorb::ThreadChannel::Member} | The thread member before the update. |
+|`after`    | {Discorb::ThreadChannel::Member} | The thread member after the update. |
+
+### Integration events
+
+#### `integration_create(task, integration)`
+
+Fires when a guild integration is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`integration`| {Discorb::Integration}| The created integration. |
+
+#### `integration_update(task, before, after)`
+
+Fires when a guild integration is updated.
+
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`before`    | {Discorb::Integration}| The integration before the update. |
+|`after`     | {Discorb::Integration}| The integration after the update. |
+
+#### `integration_delete(task, integration)`
+
+Fires when a guild integration is deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`integration`| {Discorb::Integration}| The deleted integration. |
+
+### Message events
+
+#### `message(task, message)`
+
+Fires when a message is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`message`   | {Discorb::Message}| The created message. |
+
+#### `message_update(task, event)`
+
+Fires when a message is updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event`     | {Discorb::GatewayHandler::MessageUpdateEvent}| The message after the update. |
+
+#### `message_delete(task, message, channel, guild)`
+
+Fires when a message is deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`message`   | {Discorb::Message}| The deleted message. |
+|`channel`   | {Discorb::Channel}| The channel the message was deleted from. |
+|`guild`     | ?{Discorb::Guild} | The guild the message was deleted from. |
+
+##### Note
+
+This will fire when cached messages are deleted.
+
+#### `message_delete_id(task, message_id, channel, guild)`
+
+Fires when a message is deleted.
+Not like {#message_delete} this will fire even message is not cached.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`message_id`| {Discorb::Snowflake} | The deleted message ID. |
+|`channel`   | {Discorb::Channel}| The channel the message was deleted from. |
+|`guild`     | ?{Discorb::Guild} | The guild the message was deleted from. |
+
+#### `message_delete_bulk(task, messages)`
+
+Fires when a bulk of messages are deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`messages`  | Array<{Discorb::Message}, {Discorb::GatewayHandler::UnknownDeleteBulkMessage}> | The deleted messages. |
+
+#### `message_pin_update(task, event)`
+
+Fires when a message is pinned or unpinned.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event`     | {Discorb::GatewayHandler::MessagePinUpdateEvent}| The event object. |
+
+#### `typing_start(task, event)`
+
+Fires when a user starts typing.
+
+| Parameter | Type  | Description |
+| --------- | ----- | ----------- |
+|`event`    | {Discorb::GatewayHandler::TypingStartEvent}| The event object. |
+
+### Reaction events
+
+#### `reaction_add(task, event)`
+
+Fires when a reaction is added to a message.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event`     | {Discorb::GatewayHandler::ReactionEvent}| The event object. |
+
+#### `reaction_remove(task, event)`
+
+Fires when someone removes a reaction from a message.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event`     | {Discorb::GatewayHandler::ReactionEvent}| The event object. |
+
+#### `reaction_remove_all(task, event)`
+
+Fires when all reactions are removed from a message.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event`     | {Discorb::GatewayHandler::ReactionRemoveAllEvent}| The event object. |
+
+#### `reaction_remove_emoji(task, event)`
+
+Fires when a reaction is removed from a message.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`event`     | {Discorb::GatewayHandler::ReactionRemoveEmojiEvent}| The event object. |
+
+### Role events
+
+#### `role_create(task, role)`
+
+Fires when a role is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`role`      | {Discorb::Role}| The created role. |
+
+#### `role_update(task, before, after)`
+
+Fires when a role is updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`before`    | {Discorb::Role}| The role before the update. |
+|`after`     | {Discorb::Role}| The role after the update. |
+
+#### `role_remove(task, role)`
+
+Fires when a role is deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`role`      | {Discorb::Role}| The deleted role. |
+
+### Member events
+
+#### Note
+
+These events requires the `guild_members` intent.
+
+#### `member_add(task, member)`
+
+Fires when a member joins a guild.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`member`    | {Discorb::Member}| The member that joined. |
+
+#### `member_update(task, before, after)`
+
+Fires when a member is updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`before`    | {Discorb::Member}| The member before the update. |
+|`after`     | {Discorb::Member}| The member after the update. |
+
+#### `member_remove(task, member)`
+
+Fires when a member is removed from a guild.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`member`    | {Discorb::Member}| The member that left. |
+
+### Role events
+
+#### `role_create(task, role)`
+
+Fires when a role is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`role`      | {Discorb::Role}| The created role. |
+
+#### `role_update(task, before, after)`
+
+Fires when a role is updated.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`before`    | {Discorb::Role}| The role before the update. |
+|`after`     | {Discorb::Role}| The role after the update. |
+
+#### `role_remove(task, role)`
+
+Fires when a role is deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`role`      | {Discorb::Role}| The deleted role. |
+
+### Invite events
+
+#### `invite_create(task, invite)`
+
+Fires when a invite is created.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`invite`    | {Discorb::Invite}| The created invite. |
+
+#### `invite_delete(task, invite)`
+
+Fires when a invite is deleted.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`invite`    | {Discorb::Invite}| The deleted invite. |
+
+### Interaction events
+
+#### `button_click(task, interaction)`
+
+Fires when a button is clicked.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`interaction`| {Discorb::MessageComponentInteraction::Button}| The interaction object. |
+
+#### `select_menu_select(task, interaction)`
+
+Fires when a select menu is selected.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`interaction`| {Discorb::MessageComponentInteraction::SelectMenu}| The interaction object. |
+
+### Voice events
+
+It's too big, so they're documented in {file:docs/voice_events.md}
+
+### Low-level events
+
+#### `guild_create(task, guild)`
+
+Fires when `GUILD_CREATE` is received.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild}| The guild of the event. |
+
+#### `guild_delete(task, guild)`
+
+Fires when `GUILD_DELETE` is received.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`guild`     | {Discorb::Guild}| The guild of the event. |
+
+#### `thread_create(task, thread)`
+
+Fires when `THREAD_CREATE` is received.
+
+| Parameter  | Type  | Description |
+| ---------- | ----- | ----------- |
+|`thread`    | {Discorb::ThreadChannel}| The thread of the event. |