feat: support guild onboarding (#65)

* Initial guild onboarding support * link to guild onboarding structure in the JSDoc
projectdysnomia · May 11, 2023 · b15d968 · b15d968
1 parent 8b8a0ac
commit b15d968
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -117,6 +117,7 @@ declare namespace Dysnomia {
   type GuildScheduledEventPrivacyLevel = Constants["GuildScheduledEventPrivacyLevel"][keyof Constants["GuildScheduledEventPrivacyLevel"]];
   type GuildScheduledEventStatus = Constants["GuildScheduledEventStatus"][keyof Constants["GuildScheduledEventStatus"]];
   type NSFWLevel = Constants["GuildNSFWLevels"][keyof Constants["GuildNSFWLevels"]];
+  type OnboardingPromptTypes = Constants["OnboardingPromptTypes"][keyof Constants["OnboardingPromptTypes"]];
   type PossiblyUncachedGuild = Guild | Uncached;
   type PossiblyUncachedGuildScheduledEvent = GuildScheduledEvent | Uncached;
   type PremiumTier = Constants["PremiumTiers"][keyof Constants["PremiumTiers"]];
@@ -1064,6 +1065,29 @@ declare namespace Dysnomia {
     reason?: string;
     user: User;
   }
+  interface GuildOnboarding {
+    enabled: boolean;
+    default_channel_ids: string[];
+    guild_id: string;
+    prompts: GuildOnboardingPrompt[];
+  }
+  interface GuildOnboardingPrompt {
+    id: string;
+    in_onboarding: boolean;
+    options: GuildOnboardingPromptOption[];
+    required: boolean;
+    single_select: boolean;
+    type: OnboardingPromptTypes;
+    title: string;
+  }
+  interface GuildOnboardingPromptOption {
+    channel_ids: string[];
+    description: string | null;
+    emoji: PartialEmoji;
+    id: string;
+    role_ids: string[];
+    title: string;
+  }
   interface GuildOptions {
     afkChannelID?: string;
     afkTimeout?: number;
@@ -2251,6 +2275,10 @@ declare namespace Dysnomia {
       INVITED: 1;
       ACCEPTED: 2;
     };
+    OnboardingPromptTypes: {
+      MULTIPLE_CHOICE: 0;
+      DROPDOWN:        1;
+    };
     PermissionOverwriteTypes: {
       ROLE: 0;
       USER: 1;
@@ -2791,6 +2819,7 @@ declare namespace Dysnomia {
     getGuildDiscovery(guildID: string): Promise<DiscoveryMetadata>;
     getGuildIntegrations(guildID: string): Promise<GuildIntegration[]>;
     getGuildInvites(guildID: string): Promise<Invite[]>;
+    getGuildOnboarding(guildID: string): Promise<GuildOnboarding>;
     getGuildPreview(guildID: string): Promise<GuildPreview>;
     getGuildScheduledEvents(guildID: string, options?: GetGuildScheduledEventOptions): Promise<GuildScheduledEvent[]>;
     getGuildScheduledEventUsers(guildID: string, eventID: string, options?: GetGuildScheduledEventUsersOptions): Promise<GuildScheduledEventUser[]>;
@@ -3177,6 +3206,7 @@ declare namespace Dysnomia {
     getDiscovery(): Promise<DiscoveryMetadata>;
     getIntegrations(): Promise<GuildIntegration>;
     getInvites(): Promise<Invite[]>;
+    getOnboarding(): Promise<GuildOnboarding>;
     getPruneCount(options?: GetPruneOptions): Promise<number>;
     getRESTChannels(): Promise<AnyGuildChannel[]>;
     getRESTEmoji(emojiID: string): Promise<Emoji>;

diff --git a/lib/Client.js b/lib/Client.js
@@ -2417,6 +2417,15 @@ class Client extends EventEmitter {
         return this.requestHandler.request("GET", Endpoints.GUILD_INVITES(guildID), true).then((invites) => invites.map((invite) => new Invite(invite, this)));
     }
 
+    /**
+     * Get the onboarding flow of a guild, shown to new members
+     * @param {String} guildID The ID of the guild
+     * @returns {Promise<Object>} Resolves with the [guild onboarding object](https://discord.com/developers/docs/resources/guild#guild-onboarding-object)
+     */
+    getGuildOnboarding(guildID) {
+        return this.requestHandler.request("GET", Endpoints.GUILD_ONBOARDING(guildID), true);
+    }
+
     /**
     * Get a guild preview for a guild. Only available for community guilds.
     * @arg {String} guildID The ID of the guild

diff --git a/lib/Constants.js b/lib/Constants.js
@@ -449,6 +449,11 @@ module.exports.MembershipState = {
     ACCEPTED: 2
 };
 
+module.exports.OnboardingPromptTypes = {
+    MULTIPLE_CHOICE: 0,
+    DROPDOWN:        1
+};
+
 module.exports.PermissionOverwriteTypes = {
     ROLE: 0,
     USER: 1

diff --git a/lib/rest/Endpoints.js b/lib/rest/Endpoints.js
@@ -51,6 +51,7 @@ module.exports.GUILD_MEMBER_ROLE =                   (guildID, memberID, roleID)
 module.exports.GUILD_MEMBERS =                                         (guildID) => `/guilds/${guildID}/members`;
 module.exports.GUILD_MEMBERS_SEARCH =                                  (guildID) => `/guilds/${guildID}/members/search`;
 module.exports.GUILD_MFA_LEVEL =                                       (guildID) => `/guilds/${guildID}/mfa`;
+module.exports.GUILD_ONBOARDING =                                      (guildID) => `/guilds/${guildID}/onboarding`;
 module.exports.GUILD_PREVIEW =                                         (guildID) => `/guilds/${guildID}/preview`;
 module.exports.GUILD_PRUNE =                                           (guildID) => `/guilds/${guildID}/prune`;
 module.exports.GUILD_ROLE =                                    (guildID, roleID) => `/guilds/${guildID}/roles/${roleID}`;

diff --git a/lib/structures/Guild.js b/lib/structures/Guild.js
@@ -1046,6 +1046,14 @@ class Guild extends Base {
         return this._client.getGuildInvites.call(this._client, this.id);
     }
 
+    /**
+     * Get the onboarding flow of the guild, shown to new members
+     * @returns {Promise<Object>} Resolves with the [guild onboarding object](https://discord.com/developers/docs/resources/guild#guild-onboarding-object)
+     */
+    getOnboarding() {
+        return this._client.getGuildOnboarding.call(this._client, this.id);
+    }
+
     /**
     * Get the prune count for the guild
     * @arg {Number} [options] The options to use to get number of prune members