Guild Scheduled Events

esm.mjs

@@ -26,6 +26,7 @@ export const {
   GuildChannel,
   GuildIntegration,
   GuildPreview,
+  GuildScheduledEvent,
   GuildTemplate,
   Interaction,
   Invite,
@@ -59,5 +60,5 @@ export const {
   VoiceChannel,
   VoiceConnection,
   VoiceConnectionManager,
-  VoiceState
+  VoiceState,
 } = Eris;

index.js

@@ -27,6 +27,7 @@ Eris.Guild = require("./lib/structures/Guild");
 Eris.GuildChannel = require("./lib/structures/GuildChannel");
 Eris.GuildIntegration = require("./lib/structures/GuildIntegration");
 Eris.GuildPreview = require("./lib/structures/GuildPreview");
+Eris.GuildScheduledEvent = require("./lib/structures/GuildScheduledEvent");
 Eris.GuildTemplate = require("./lib/structures/GuildTemplate");
 Eris.Interaction = require("./lib/structures/Interaction");
 Eris.Invite = require("./lib/structures/Invite");

lib/Client.js

@@ -12,6 +12,7 @@ const GuildAuditLogEntry = require("./structures/GuildAuditLogEntry");
 const GuildIntegration = require("./structures/GuildIntegration");
 const GuildPreview = require("./structures/GuildPreview");
 const GuildTemplate = require("./structures/GuildTemplate");
+const GuildScheduledEvent = require("./structures/GuildScheduledEvent");
 const Invite = require("./structures/Invite");
 const Member = require("./structures/Member");
 const Message = require("./structures/Message");
@@ -354,7 +355,7 @@ class Client extends EventEmitter {
     /**
     * Edits command permissions for a multiple commands in a guild.
     * Note: You can only add up to 10 permission overwrites for a command.
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @arg {Array<Object>} permissions An array of [partial guild command permissions](https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure)
     * @returns {Promise<Array<Object>>} Returns an array of [GuildApplicationCommandPermissions](https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) objects.
     */
@@ -680,6 +681,38 @@ class Client extends EventEmitter {
         }).then((guild) => new Guild(guild, this));
     }
 
+    /**
+    * Create a guild scheduled event
+    * @arg {String} guildID The guild ID where the event will be created
+    * @arg {Object} event The event to be created
+    * @arg {String} [event.channelID] The channel ID of the event. This is optional if `entityType` is `3` (external)
+    * @arg {String} [event.description] The description of the event
+    * @arg {Object} [event.entityMetadata] The entity metadata for the scheduled event. This is required if `entityType` is `3` (external)
+    * @arg {String} [event.entityMetadata.location] Location of the event
+    * @arg {Number} event.entityType The [entity type](https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types) of the scheduled event
+    * @arg {String} [event.image] Base 64 encoded image for the scheduled event
+    * @arg {String} event.name The name of the event
+    * @arg {String} event.privacyLevel The privacy level of the event
+    * @arg {Date} [event.scheduledEndTime] The time when the event is scheduled to end. This is required if `entityType` is `3` (external)
+    * @arg {Date} event.scheduledStartTime The time the event will start
+    * @arg {String} [reason] The reason to be displayed in audit logs
+    * @returns {Promise<GuildScheduledEvent>}
+    */
+    createGuildScheduledEvent(guildID, event, reason) {
+        return this.requestHandler.request("POST", Endpoints.GUILD_SCHEDULED_EVENTS(guildID), true, {
+            channel_id: event.channelID,
+            description: event.description,
+            entity_metadata: event.entityMetadata,
+            entity_type: event.entityType,
+            image: event.image,
+            name: event.name,
+            privacy_level: event.privacyLevel,
+            scheduled_end_time: event.scheduledEndTime,
+            scheduled_start_time: event.scheduledStartTime,
+            reason: reason
+        }).then((data) => new GuildScheduledEvent(data, this));
+    }
+
     /**
     * Create a guild sticker
     * @arg {Object} options Sticker options
@@ -996,7 +1029,7 @@ class Client extends EventEmitter {
 
     /**
     * Delete a guild application command
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @arg {String} commandID The command id
     * @returns {Promise}
     */
@@ -1044,6 +1077,16 @@ class Client extends EventEmitter {
         return this.requestHandler.request("DELETE", Endpoints.GUILD_INTEGRATION(guildID, integrationID), true);
     }
 
+    /**
+    * Delete a guild scheduled event
+    * @arg {String} guildID The ID of the guild
+    * @arg {String} eventID The ID of the event
+    * @returns {Promise}
+    */
+    deleteGuildScheduledEvent(guildID, eventID) {
+        return this.requestHandler.request("DELETE", Endpoints.GUILD_SCHEDULED_EVENT(guildID, eventID), true);
+    }
+
     /**
     * Delete a guild sticker
     * @arg {String} guildID The ID of the guild
@@ -1374,7 +1417,7 @@ class Client extends EventEmitter {
     /**
     * Edits command permissions for a specific command in a guild.
     * Note: You can only add up to 10 permission overwrites for a command.
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @arg {String} commandID The command id
     * @arg {Array<Object>} permissions An array of [permissions objects](https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure)
     * @returns {Promise<Object>} Resolves with a [GuildApplicationCommandPermissions](https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) object.
@@ -1440,7 +1483,7 @@ class Client extends EventEmitter {
 
     /**
     * Edit a guild application command
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @arg {Object} command A command object
     * @arg {String} command.name The command name
     * @arg {String} [command.description] The command description (Slash Commands Only)
@@ -1542,6 +1585,41 @@ class Client extends EventEmitter {
         }).then((member) => new Member(member, this.guilds.get(guildID), this));
     }
 
+    /**
+    * Edit a guild scheduled event
+    * @arg {String} guildID The guild ID where the event will be edited
+    * @arg {String} eventID The guild scheduled event ID to be edited
+    * @arg {Object} event The new guild scheduled event object
+    * @arg {String} [event.channelID] The channel ID of the event. If updating `entityType` to `3` (external), this **must** be set to `null`
+    * @arg {String} [event.description] The description of the event
+    * @arg {Object} [event.entityMetadata] The entity metadata for the scheduled event. This is required if updating `entityType` to `3` (external)
+    * @arg {String} [event.entityMetadata.location] Location of the event. This is required if updating `entityType` to `3` (external)
+    * @arg {Number} [event.entityType] The [entity type](https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types) of the scheduled event
+    * @arg {String} [event.image] Base 64 encoded image for the event
+    * @arg {String} [event.name] The name of the event
+    * @arg {String} [event.privacyLevel] The privacy level of the event
+    * @arg {Date} [event.scheduledEndTime] The time when the scheduled event is scheduled to end. This is required if updating `entityType` to `3` (external)
+    * @arg {Date} [event.scheduledStartTime] The time the event will start
+    * @arg {Number} [event.status] The [status](https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status) of the scheduled event
+    * @arg {String} [reason] The reason to be displayed in audit logs
+    * @returns {Promise<GuildScheduledEvent>}
+    */
+    editGuildScheduledEvent(guildID, eventID, event, reason) {
+        return this.requestHandler.request("PATCH", Endpoints.GUILD_SCHEDULED_EVENT(guildID, eventID), true, {
+            channel_id: event.channelID,
+            description: event.description,
+            entity_metadata: event.entityMetadata,
+            entity_type: event.entityType,
+            image: event.image,
+            name: event.name,
+            privacy_level: event.privacyLevel,
+            scheduled_end_time: event.scheduledEndTime,
+            scheduled_start_time: event.scheduledStartTime,
+            status: event.status,
+            reason: reason
+        });
+    }
+
     /**
     * Edit a guild sticker
     * @arg {String} stickerID The ID of the sticker
@@ -1581,6 +1659,7 @@ class Client extends EventEmitter {
             code
         });
     }
+
     /**
     * Update a user's voice state - See [caveats](https://discord.com/developers/docs/resources/guild#modify-user-voice-state-caveats)
     * @arg {String} guildID The ID of the guild
@@ -1903,9 +1982,6 @@ class Client extends EventEmitter {
         });
     }
 
-
-
-
     /**
     * Edit a webhook
     * @arg {String} webhookID The ID of the webhook
@@ -2206,7 +2282,7 @@ class Client extends EventEmitter {
 
     /**
     * Get the a guild's application command permissions
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @arg {String} commandID The command id
     * @returns {Promise<Object>} Resolves with a guild application command permissions object.
     */
@@ -2358,7 +2434,7 @@ class Client extends EventEmitter {
 
     /**
     * Get a guild application command
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @arg {String} commandID The command id
     * @returns {Promise<Object>} Resolves with an command object.
     */
@@ -2371,7 +2447,7 @@ class Client extends EventEmitter {
 
     /**
     * Get the all of a guild's application command permissions
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @returns {Promise<Array<Object>>} Resolves with an array of guild application command permissions objects.
     */
     getGuildCommandPermissions(guildID) {
@@ -2383,7 +2459,7 @@ class Client extends EventEmitter {
 
     /**
     * Get a guild's application commands
-    * @arg {String} guildID The guild id
+    * @arg {String} guildID The guild ID
     * @returns {Promise<Array<Object>>} Resolves with an array of command objects.
     */
     getGuildCommands(guildID) {
@@ -2427,6 +2503,45 @@ class Client extends EventEmitter {
         return this.requestHandler.request("GET", Endpoints.GUILD_PREVIEW(guildID), true).then((data) => new GuildPreview(data, this));
     }
 
+    /**
+    * Get a guild's scheduled events
+    * @arg {String} guildID The ID of the guild
+    * @arg {Object} [options] Options for the request
+    * @arg {Boolean} [options.withUserCount] Whether to include the number of users subscribed to each event
+    * @returns {Promise<Array<GuildScheduledEvent>>}
+    */
+    getGuildScheduledEvents(guildID, options = {}) {
+        options.with_user_count = options.withUserCount;
+        return this.requestHandler.request("GET", Endpoints.GUILD_SCHEDULED_EVENTS(guildID), true, options).then((data) => data.map((event) => new GuildScheduledEvent(event, this)));
+    }
+
+    /**
+    * Get a list of users subscribed to a guild scheduled event
+    * @arg {String} guildID The ID of the guild
+    * @arg {String} eventID The ID of the event
+    * @arg {Object} [options] Options for the request
+    * @arg {String} [options.after] Get users after this user ID. If `options.before` is provided, this will be ignored. Fetching users in between `before` and `after` is not supported
+    * @arg {String} [options.before] Get users before this user ID
+    * @arg {Number} [options.limit=100] The number of users to get (max 100). Pagination will only work if one of `options.after` or `options.after` is also provided
+    * @arg {Boolean} [options.withMember] Include guild member data
+    * @returns {Promise<Array<{guildScheduledEventID: String, member?: Member, user: User}>>}
+    */
+    getGuildScheduledEventUsers(guildID, eventID, options = {}) {
+        const guild = this.guilds.get(guildID);
+
+        options.with_member = options.withMember;
+        return this.requestHandler.request("GET", Endpoints.GUILD_SCHEDULED_EVENT_USERS(guildID, eventID), true, options).then((data) => data.map((eventUser) => {
+            if(eventUser.member) {
+                eventUser.member.id = eventUser.user.id;
+            }
+            return {
+                guildScheduledEventID: eventUser.guild_scheduled_event_id,
+                member: eventUser.member && guild ? guild.members.update(eventUser.member) : new Member(eventUser.member),
+                user: this.users.update(eventUser.user)
+            };
+        }));
+    }
+
     /**
     * Get a guild template
     * @arg {String} code The template code
@@ -2815,6 +2930,23 @@ class Client extends EventEmitter {
         return this.requestHandler.request("GET", Endpoints.USER_GUILDS("@me"), true, options).then((guilds) => guilds.map((guild) => new Guild(guild, this)));
     }
 
+    /**
+    * Get a guild scheduled event via the REST API. REST mode is required to use this endpoint.
+    * @arg {String} guildID The ID of the guild
+    * @arg {String} eventID The ID of the guild scheduled event
+    * @arg {Object} [options] Options for the request
+    * @arg {Boolean} [options.withUserCount] Whether to include the number of users subscribed to the event
+    * @returns {Promise<GuildScheduledEvent>}
+    */
+    getRESTGuildScheduledEvent(guildID, eventID, options = {}) {
+        if(!this.options.restMode) {
+            return Promise.reject(new Error("Eris REST mode is not enabled"));
+        }
+
+        options.with_user_count = options.withUserCount;
+        return this.requestHandler.request("GET", Endpoints.GUILD_SCHEDULED_EVENT(guildID, eventID), true, options).then((data) => new GuildScheduledEvent(data, this));
+    }
+
     /**
     * Get a guild sticker via the REST API. REST mode is required to use this endpoint.
     * @arg {String} guildID The ID of the guild

lib/Constants.js

@@ -233,7 +233,9 @@ const Intents = {
     guildMessageTyping:     1 << 11,
     directMessages:         1 << 12,
     directMessageReactions: 1 << 13,
-    directMessageTyping:    1 << 14
+    directMessageTyping:    1 << 14,
+
+    guildScheduledEvents:   1 << 16
 };
 Intents.allNonPrivileged = Intents.guilds
     | Intents.guildBans
@@ -247,7 +249,8 @@ Intents.allNonPrivileged = Intents.guilds
     | Intents.guildMessageTyping
     | Intents.directMessages
     | Intents.directMessageReactions
-    | Intents.directMessageTyping;
+    | Intents.directMessageTyping
+    | Intents.guildScheduledEvents;
 Intents.allPrivileged = Intents.guildMembers
     | Intents.guildPresences;
 Intents.all = Intents.allNonPrivileged | Intents.allPrivileged;
@@ -442,6 +445,24 @@ module.exports.PremiumTiers = {
     TIER_3: 3
 };
 
+module.exports.GuildScheduledEventStatus = {
+    SCHEDULED: 1,
+    ACTIVE:    2,
+    COMPLETED: 3,
+    CANCELED:  4
+};
+
+module.exports.GuildScheduledEventEntityTypes = {
+    STAGE_INSTANCE: 1,
+    VOICE:          2,
+    EXTERNAL:       3
+};
+
+module.exports.GuildScheduledEventPrivacyLevel = {
+    PUBLIC:     1,
+    GUILD_ONLY: 2
+};
+
 module.exports.PremiumTypes = {
     NONE:          0,
     NITRO_CLASSIC: 1,