From eced39cc3fa305e336d5752827812cb790ac485d Mon Sep 17 00:00:00 2001
From: Almeida <almeidx@pm.me>
Date: Wed, 14 Jun 2023 13:12:08 +0100
Subject: [PATCH] feat: guild onboarding (#713)

---
 deno/payloads/v10/guild.ts | 97 +++++++++++++++++++++++++++++++++++++-
 deno/payloads/v9/guild.ts  | 97 +++++++++++++++++++++++++++++++++++++-
 deno/rest/v10/guild.ts     |  6 +++
 deno/rest/v10/mod.ts       |  8 ++++
 deno/rest/v9/guild.ts      |  6 +++
 deno/rest/v9/mod.ts        |  8 ++++
 payloads/v10/guild.ts      | 97 +++++++++++++++++++++++++++++++++++++-
 payloads/v9/guild.ts       | 97 +++++++++++++++++++++++++++++++++++++-
 rest/v10/guild.ts          |  6 +++
 rest/v10/index.ts          |  8 ++++
 rest/v9/guild.ts           |  6 +++
 rest/v9/index.ts           |  8 ++++
 12 files changed, 440 insertions(+), 4 deletions(-)

diff --git a/deno/payloads/v10/guild.ts b/deno/payloads/v10/guild.ts
index 4a51ca8f..e1a257eb 100644
--- a/deno/payloads/v10/guild.ts
+++ b/deno/payloads/v10/guild.ts
@@ -3,7 +3,7 @@
  */
 
 import type { Permissions, Snowflake } from '../../globals.ts';
-import type { APIEmoji } from './emoji.ts';
+import type { APIEmoji, APIPartialEmoji } from './emoji.ts';
 import type { PresenceUpdateStatus } from './gateway.ts';
 import type { OAuth2Scopes } from './oauth2.ts';
 import type { APIRole } from './permissions.ts';
@@ -999,3 +999,98 @@ export enum MembershipScreeningFieldType {
 	 */
 	Terms = 'TERMS',
 }
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure
+ */
+export interface APIGuildOnboarding {
+	/**
+	 * Id of the guild this onboarding is part of
+	 */
+	guild_id: Snowflake;
+	/**
+	 * Prompts shown during onboarding and in customize community
+	 */
+	prompts: APIGuildOnboardingPrompt[];
+	/**
+	 * Channel ids that members get opted into automatically
+	 */
+	default_channel_ids: Snowflake[];
+	/**
+	 * Whether onboarding is enabled in the guild
+	 */
+	enabled: boolean;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
+ */
+export interface APIGuildOnboardingPrompt {
+	/**
+	 * Id of the prompt
+	 */
+	id: Snowflake;
+	/**
+	 * Options available within the prompt
+	 */
+	options: APIGuildOnboardingPromptOption[];
+	/**
+	 * Title of the prompt
+	 */
+	title: string;
+	/**
+	 * Indicates whether users are limited to selecting one option for the prompt
+	 */
+	single_select: boolean;
+	/**
+	 * Indicates whether the prompt is required before a user completes the onboarding flow
+	 */
+	required: boolean;
+	/**
+	 * Indicates whether the prompt is present in the onboarding flow.
+	 * If `false`, the prompt will only appear in the Channels & Roles tab
+	 */
+	in_onboarding: boolean;
+	/**
+	 * Type of prompt
+	 */
+	type: GuildOnboardingPromptType;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure
+ */
+export interface APIGuildOnboardingPromptOption {
+	/**
+	 * Id of the prompt option
+	 */
+	id: Snowflake;
+	/**
+	 * Ids for channels a member is added to when the option is selected
+	 */
+	channel_ids: Snowflake[];
+	/**
+	 * Ids for roles assigned to a member when the option is selected
+	 */
+	role_ids: Snowflake[];
+	/**
+	 * Emoji of the option
+	 */
+	emoji: APIPartialEmoji;
+	/**
+	 * Title of the option
+	 */
+	title: string;
+	/**
+	 * Description of the option
+	 */
+	description: string | null;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
+ */
+export enum GuildOnboardingPromptType {
+	MultipleChoice,
+	Dropdown,
+}
diff --git a/deno/payloads/v9/guild.ts b/deno/payloads/v9/guild.ts
index dfa2faa5..9dcab251 100644
--- a/deno/payloads/v9/guild.ts
+++ b/deno/payloads/v9/guild.ts
@@ -3,7 +3,7 @@
  */
 
 import type { Permissions, Snowflake } from '../../globals.ts';
-import type { APIEmoji } from './emoji.ts';
+import type { APIEmoji, APIPartialEmoji } from './emoji.ts';
 import type { PresenceUpdateStatus } from './gateway.ts';
 import type { OAuth2Scopes } from './oauth2.ts';
 import type { APIRole } from './permissions.ts';
@@ -991,3 +991,98 @@ export enum MembershipScreeningFieldType {
 	 */
 	Terms = 'TERMS',
 }
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure
+ */
+export interface APIGuildOnboarding {
+	/**
+	 * Id of the guild this onboarding is part of
+	 */
+	guild_id: Snowflake;
+	/**
+	 * Prompts shown during onboarding and in customize community
+	 */
+	prompts: APIGuildOnboardingPrompt[];
+	/**
+	 * Channel ids that members get opted into automatically
+	 */
+	default_channel_ids: Snowflake[];
+	/**
+	 * Whether onboarding is enabled in the guild
+	 */
+	enabled: boolean;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
+ */
+export interface APIGuildOnboardingPrompt {
+	/**
+	 * Id of the prompt
+	 */
+	id: Snowflake;
+	/**
+	 * Options available within the prompt
+	 */
+	options: APIGuildOnboardingPromptOption[];
+	/**
+	 * Title of the prompt
+	 */
+	title: string;
+	/**
+	 * Indicates whether users are limited to selecting one option for the prompt
+	 */
+	single_select: boolean;
+	/**
+	 * Indicates whether the prompt is required before a user completes the onboarding flow
+	 */
+	required: boolean;
+	/**
+	 * Indicates whether the prompt is present in the onboarding flow.
+	 * If `false`, the prompt will only appear in the Channels & Roles tab
+	 */
+	in_onboarding: boolean;
+	/**
+	 * Type of prompt
+	 */
+	type: GuildOnboardingPromptType;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure
+ */
+export interface APIGuildOnboardingPromptOption {
+	/**
+	 * Id of the prompt option
+	 */
+	id: Snowflake;
+	/**
+	 * Ids for channels a member is added to when the option is selected
+	 */
+	channel_ids: Snowflake[];
+	/**
+	 * Ids for roles assigned to a member when the option is selected
+	 */
+	role_ids: Snowflake[];
+	/**
+	 * Emoji of the option
+	 */
+	emoji: APIPartialEmoji;
+	/**
+	 * Title of the option
+	 */
+	title: string;
+	/**
+	 * Description of the option
+	 */
+	description: string | null;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
+ */
+export enum GuildOnboardingPromptType {
+	MultipleChoice,
+	Dropdown,
+}
diff --git a/deno/rest/v10/guild.ts b/deno/rest/v10/guild.ts
index 58575a6a..208fd887 100644
--- a/deno/rest/v10/guild.ts
+++ b/deno/rest/v10/guild.ts
@@ -9,6 +9,7 @@ import type {
 	APIGuildIntegration,
 	APIGuildMember,
 	APIGuildMembershipScreening,
+	APIGuildOnboarding,
 	APIGuildPreview,
 	APIGuildWelcomeScreen,
 	APIGuildWidget,
@@ -916,3 +917,8 @@ export type RESTPatchAPIGuildWelcomeScreenJSONBody = Nullable<StrictPartial<APIG
  * https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
  */
 export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
+
+/**
+ * https://discord.com/developers/docs/resources/guild#get-guild-onboarding
+ */
+export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;
diff --git a/deno/rest/v10/mod.ts b/deno/rest/v10/mod.ts
index 1a83f2c4..ee32d725 100644
--- a/deno/rest/v10/mod.ts
+++ b/deno/rest/v10/mod.ts
@@ -879,6 +879,14 @@ export const Routes = {
 	guildScheduledEventUsers(guildId: Snowflake, guildScheduledEventId: Snowflake) {
 		return `/guilds/${guildId}/scheduled-events/${guildScheduledEventId}/users` as const;
 	},
+
+	/**
+	 * Route for:
+	 * - GET `/guilds/${guild.id}/onboarding`
+	 */
+	guildOnboarding(guildId: Snowflake) {
+		return `/guilds/${guildId}/onboarding` as const;
+	},
 };
 
 export const StickerPackApplicationId = '710982414301790216';
diff --git a/deno/rest/v9/guild.ts b/deno/rest/v9/guild.ts
index 8b94e31d..b295c38f 100644
--- a/deno/rest/v9/guild.ts
+++ b/deno/rest/v9/guild.ts
@@ -7,6 +7,7 @@ import type {
 	APIGuildIntegration,
 	APIGuildMember,
 	APIGuildMembershipScreening,
+	APIGuildOnboarding,
 	APIGuildPreview,
 	APIGuildWelcomeScreen,
 	APIGuildWidget,
@@ -922,3 +923,8 @@ export type RESTPatchAPIGuildWelcomeScreenJSONBody = Nullable<StrictPartial<APIG
  * https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
  */
 export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
+
+/**
+ * https://discord.com/developers/docs/resources/guild#get-guild-onboarding
+ */
+export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;
diff --git a/deno/rest/v9/mod.ts b/deno/rest/v9/mod.ts
index 9e58f2a7..45943470 100644
--- a/deno/rest/v9/mod.ts
+++ b/deno/rest/v9/mod.ts
@@ -888,6 +888,14 @@ export const Routes = {
 	guildScheduledEventUsers(guildId: Snowflake, guildScheduledEventId: Snowflake) {
 		return `/guilds/${guildId}/scheduled-events/${guildScheduledEventId}/users` as const;
 	},
+
+	/**
+	 * Route for:
+	 * - GET `/guilds/${guild.id}/onboarding`
+	 */
+	guildOnboarding(guildId: Snowflake) {
+		return `/guilds/${guildId}/onboarding` as const;
+	},
 };
 
 export const StickerPackApplicationId = '710982414301790216';
diff --git a/payloads/v10/guild.ts b/payloads/v10/guild.ts
index 3f1335b2..bc2c9a63 100644
--- a/payloads/v10/guild.ts
+++ b/payloads/v10/guild.ts
@@ -3,7 +3,7 @@
  */
 
 import type { Permissions, Snowflake } from '../../globals';
-import type { APIEmoji } from './emoji';
+import type { APIEmoji, APIPartialEmoji } from './emoji';
 import type { PresenceUpdateStatus } from './gateway';
 import type { OAuth2Scopes } from './oauth2';
 import type { APIRole } from './permissions';
@@ -999,3 +999,98 @@ export enum MembershipScreeningFieldType {
 	 */
 	Terms = 'TERMS',
 }
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure
+ */
+export interface APIGuildOnboarding {
+	/**
+	 * Id of the guild this onboarding is part of
+	 */
+	guild_id: Snowflake;
+	/**
+	 * Prompts shown during onboarding and in customize community
+	 */
+	prompts: APIGuildOnboardingPrompt[];
+	/**
+	 * Channel ids that members get opted into automatically
+	 */
+	default_channel_ids: Snowflake[];
+	/**
+	 * Whether onboarding is enabled in the guild
+	 */
+	enabled: boolean;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
+ */
+export interface APIGuildOnboardingPrompt {
+	/**
+	 * Id of the prompt
+	 */
+	id: Snowflake;
+	/**
+	 * Options available within the prompt
+	 */
+	options: APIGuildOnboardingPromptOption[];
+	/**
+	 * Title of the prompt
+	 */
+	title: string;
+	/**
+	 * Indicates whether users are limited to selecting one option for the prompt
+	 */
+	single_select: boolean;
+	/**
+	 * Indicates whether the prompt is required before a user completes the onboarding flow
+	 */
+	required: boolean;
+	/**
+	 * Indicates whether the prompt is present in the onboarding flow.
+	 * If `false`, the prompt will only appear in the Channels & Roles tab
+	 */
+	in_onboarding: boolean;
+	/**
+	 * Type of prompt
+	 */
+	type: GuildOnboardingPromptType;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure
+ */
+export interface APIGuildOnboardingPromptOption {
+	/**
+	 * Id of the prompt option
+	 */
+	id: Snowflake;
+	/**
+	 * Ids for channels a member is added to when the option is selected
+	 */
+	channel_ids: Snowflake[];
+	/**
+	 * Ids for roles assigned to a member when the option is selected
+	 */
+	role_ids: Snowflake[];
+	/**
+	 * Emoji of the option
+	 */
+	emoji: APIPartialEmoji;
+	/**
+	 * Title of the option
+	 */
+	title: string;
+	/**
+	 * Description of the option
+	 */
+	description: string | null;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
+ */
+export enum GuildOnboardingPromptType {
+	MultipleChoice,
+	Dropdown,
+}
diff --git a/payloads/v9/guild.ts b/payloads/v9/guild.ts
index d51ab5f7..504bebc7 100644
--- a/payloads/v9/guild.ts
+++ b/payloads/v9/guild.ts
@@ -3,7 +3,7 @@
  */
 
 import type { Permissions, Snowflake } from '../../globals';
-import type { APIEmoji } from './emoji';
+import type { APIEmoji, APIPartialEmoji } from './emoji';
 import type { PresenceUpdateStatus } from './gateway';
 import type { OAuth2Scopes } from './oauth2';
 import type { APIRole } from './permissions';
@@ -991,3 +991,98 @@ export enum MembershipScreeningFieldType {
 	 */
 	Terms = 'TERMS',
 }
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure
+ */
+export interface APIGuildOnboarding {
+	/**
+	 * Id of the guild this onboarding is part of
+	 */
+	guild_id: Snowflake;
+	/**
+	 * Prompts shown during onboarding and in customize community
+	 */
+	prompts: APIGuildOnboardingPrompt[];
+	/**
+	 * Channel ids that members get opted into automatically
+	 */
+	default_channel_ids: Snowflake[];
+	/**
+	 * Whether onboarding is enabled in the guild
+	 */
+	enabled: boolean;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
+ */
+export interface APIGuildOnboardingPrompt {
+	/**
+	 * Id of the prompt
+	 */
+	id: Snowflake;
+	/**
+	 * Options available within the prompt
+	 */
+	options: APIGuildOnboardingPromptOption[];
+	/**
+	 * Title of the prompt
+	 */
+	title: string;
+	/**
+	 * Indicates whether users are limited to selecting one option for the prompt
+	 */
+	single_select: boolean;
+	/**
+	 * Indicates whether the prompt is required before a user completes the onboarding flow
+	 */
+	required: boolean;
+	/**
+	 * Indicates whether the prompt is present in the onboarding flow.
+	 * If `false`, the prompt will only appear in the Channels & Roles tab
+	 */
+	in_onboarding: boolean;
+	/**
+	 * Type of prompt
+	 */
+	type: GuildOnboardingPromptType;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure
+ */
+export interface APIGuildOnboardingPromptOption {
+	/**
+	 * Id of the prompt option
+	 */
+	id: Snowflake;
+	/**
+	 * Ids for channels a member is added to when the option is selected
+	 */
+	channel_ids: Snowflake[];
+	/**
+	 * Ids for roles assigned to a member when the option is selected
+	 */
+	role_ids: Snowflake[];
+	/**
+	 * Emoji of the option
+	 */
+	emoji: APIPartialEmoji;
+	/**
+	 * Title of the option
+	 */
+	title: string;
+	/**
+	 * Description of the option
+	 */
+	description: string | null;
+}
+
+/**
+ * https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
+ */
+export enum GuildOnboardingPromptType {
+	MultipleChoice,
+	Dropdown,
+}
diff --git a/rest/v10/guild.ts b/rest/v10/guild.ts
index b11705d5..29431277 100644
--- a/rest/v10/guild.ts
+++ b/rest/v10/guild.ts
@@ -9,6 +9,7 @@ import type {
 	APIGuildIntegration,
 	APIGuildMember,
 	APIGuildMembershipScreening,
+	APIGuildOnboarding,
 	APIGuildPreview,
 	APIGuildWelcomeScreen,
 	APIGuildWidget,
@@ -916,3 +917,8 @@ export type RESTPatchAPIGuildWelcomeScreenJSONBody = Nullable<StrictPartial<APIG
  * https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
  */
 export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
+
+/**
+ * https://discord.com/developers/docs/resources/guild#get-guild-onboarding
+ */
+export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;
diff --git a/rest/v10/index.ts b/rest/v10/index.ts
index c2470ad0..37e9c8f9 100644
--- a/rest/v10/index.ts
+++ b/rest/v10/index.ts
@@ -879,6 +879,14 @@ export const Routes = {
 	guildScheduledEventUsers(guildId: Snowflake, guildScheduledEventId: Snowflake) {
 		return `/guilds/${guildId}/scheduled-events/${guildScheduledEventId}/users` as const;
 	},
+
+	/**
+	 * Route for:
+	 * - GET `/guilds/${guild.id}/onboarding`
+	 */
+	guildOnboarding(guildId: Snowflake) {
+		return `/guilds/${guildId}/onboarding` as const;
+	},
 };
 
 export const StickerPackApplicationId = '710982414301790216';
diff --git a/rest/v9/guild.ts b/rest/v9/guild.ts
index 81f87ff6..879636c9 100644
--- a/rest/v9/guild.ts
+++ b/rest/v9/guild.ts
@@ -7,6 +7,7 @@ import type {
 	APIGuildIntegration,
 	APIGuildMember,
 	APIGuildMembershipScreening,
+	APIGuildOnboarding,
 	APIGuildPreview,
 	APIGuildWelcomeScreen,
 	APIGuildWidget,
@@ -922,3 +923,8 @@ export type RESTPatchAPIGuildWelcomeScreenJSONBody = Nullable<StrictPartial<APIG
  * https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
  */
 export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
+
+/**
+ * https://discord.com/developers/docs/resources/guild#get-guild-onboarding
+ */
+export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;
diff --git a/rest/v9/index.ts b/rest/v9/index.ts
index 18638324..93a7e07d 100644
--- a/rest/v9/index.ts
+++ b/rest/v9/index.ts
@@ -888,6 +888,14 @@ export const Routes = {
 	guildScheduledEventUsers(guildId: Snowflake, guildScheduledEventId: Snowflake) {
 		return `/guilds/${guildId}/scheduled-events/${guildScheduledEventId}/users` as const;
 	},
+
+	/**
+	 * Route for:
+	 * - GET `/guilds/${guild.id}/onboarding`
+	 */
+	guildOnboarding(guildId: Snowflake) {
+		return `/guilds/${guildId}/onboarding` as const;
+	},
 };
 
 export const StickerPackApplicationId = '710982414301790216';