(** Used to store dispatch callbacks. Each event can only have one callback registered at a time.
    These should be accessed through their re-export in {!Client}.
    {3 Examples}
    [Client.ready := (fun _ -> print_endline "Shard is Ready!")]

    [Client.guild_create := (fun guild -> print_endline guild.name)]

    {[
        open Core
        open Disml

        let check_command (msg : Message.t) =
            if String.is_prefix ~prefix:"!ping" msg.content then
                Message.reply msg "Pong!" >>> ignore
        
        Client.message_create := check_command
    ]}
*)

open Event_models

(** Dispatched when each shard receives READY from discord after identifying on the gateway. Other event dispatch is received after this. *)
val ready : (Ready.t -> unit) ref

(** Dispatched when successfully reconnecting to the gateway. *)
val resumed : (Resumed.t -> unit) ref

(** Dispatched when a channel is created which is visible to the bot. *)
val channel_create : (ChannelCreate.t -> unit) ref

(** Dispatched when a channel visible to the bot is changed. *)
val channel_update : (ChannelUpdate.t -> unit) ref

(** Dispatched when a channel visible to the bot is deleted. *)
val channel_delete : (ChannelDelete.t -> unit) ref

(** Dispatched when messages are pinned or unpinned from a a channel. *)
val channel_pins_update : (ChannelPinsUpdate.t -> unit) ref

(** Dispatched when the bot joins a guild, and during startup. *)
val guild_create : (GuildCreate.t -> unit) ref

(** Dispatched when a guild the bot is in is edited. *)
val guild_update : (GuildUpdate.t -> unit) ref

(** Dispatched when the bot is removed from a guild. *)
val guild_delete : (GuildDelete.t -> unit) ref

(** Dispatched when a member is banned. *)
val member_ban : (GuildBanAdd.t -> unit) ref

(** Dispatched when a member is unbanned. *)
val member_unban : (GuildBanRemove.t -> unit) ref

(** Dispatched when emojis are added or removed from a guild. *)
val guild_emojis_update : (GuildEmojisUpdate.t -> unit) ref

(** Dispatched when a guild's integrations are updated. *)
(* val integrations_update : (Yojson.Safe.json -> unit) ref *)

(** Dispatched when a member joins a guild. *)
val member_join : (GuildMemberAdd.t -> unit) ref

(** Dispatched when a member leaves a guild. Is Dispatched alongside {!Client.member_ban} when a user is banned. *)
val member_leave : (GuildMemberRemove.t -> unit) ref

(** Dispatched when a member object is updated. *)
val member_update : (GuildMemberUpdate.t -> unit) ref

(** Dispatched when requesting guild members through {!Client.request_guild_members} *)
val members_chunk : (GuildMembersChunk.t -> unit) ref

(** Dispatched when a role is created. *)
val role_create : (GuildRoleCreate.t -> unit) ref

(** Dispatched when a role is edited. *)
val role_update : (GuildRoleUpdate.t -> unit) ref

(** Dispatched when a role is deleted. *)
val role_delete : (GuildRoleDelete.t -> unit) ref

(** Dispatched when a message is sent. *)
val message_create : (MessageCreate.t -> unit) ref

(** Dispatched when a message is edited. This does not necessarily mean the content changed. *)
val message_update : (MessageUpdate.t -> unit) ref

(** Dispatched when a message is deleted. *)
val message_delete : (MessageDelete.t -> unit) ref

(** Dispatched when messages are bulk deleted. *)
val message_delete_bulk : (MessageDeleteBulk.t -> unit) ref

(** Dispatched when a rection is added to a message. *)
val reaction_add : (ReactionAdd.t -> unit) ref

(** Dispatched when a reaction is removed from a message. *)
val reaction_remove : (ReactionRemove.t -> unit) ref

(** Dispatched when all reactions are cleared from a message. *)
val reaction_remove_all : (ReactionRemoveAll.t -> unit) ref

(** Dispatched when a user updates their presence. *)
val presence_update : (PresenceUpdate.t -> unit) ref

(** Dispatched when a typing indicator is displayed. *)
val typing_start : (TypingStart.t -> unit) ref

(** Dispatched when the current user is updated. You most likely want {!Client.member_update} or {!Client.presence_update} instead. *)
val user_update : (UserUpdate.t -> unit) ref

(** Dispatched when a webhook is updated. *)
val webhook_update : (WebhookUpdate.t -> unit) ref

(** Dispatched as a fallback for unknown events. *)
val unknown : (Unknown.t -> unit) ref

(**/**)
(* val voice_state_update : (Yojson.Safe.json -> unit) ref *)
(* val voice_server_update : (Yojson.Safe.json -> unit) ref *)