feat(GuildWelcomeScreen): document welcome-screen endpoint

Reference: discord/discord-api-docs@f2ccd2a
discordjs · Apr 10, 2021 · 169ecde · 169ecde
1 parent bbe56a9
commit 169ecde
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 0 deletions.
diff --git a/deno/rest/v8/guild.ts b/deno/rest/v8/guild.ts
@@ -8,6 +8,7 @@ import type {
 	APIGuildMember,
 	APIGuildMembershipScreening,
 	APIGuildPreview,
+	APIGuildWelcomeScreen,
 	APIGuildWidget,
 	APIGuildWidgetSettings,
 	APIRole,
@@ -758,3 +759,22 @@ export interface RESTPatchAPIGuildVoiceStateUserJSONBody {
 	 */
 	suppress?: boolean;
 }
+
+/**
+ * https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen
+ */
+export type RESTGetAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
+
+/**
+ * https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
+ */
+export interface RESTPatchAPIGuildWelcomeScreenJSONBody extends Nullable<Partial<APIGuildWelcomeScreen>> {
+	/**
+	 * Whether the welcome screen is enabled
+	 */
+	enabled?: boolean | null;
+}
+
+type Nullable<T> = {
+	[P in keyof T]: T[P] | null;
+};
diff --git a/deno/rest/v8/mod.ts b/deno/rest/v8/mod.ts
@@ -648,6 +648,15 @@ export const Routes = {
 	applicationCommandPermissions(applicationID: Snowflake, guildID: Snowflake, commandID: Snowflake) {
 		return `/applications/${applicationID}/guilds/${guildID}/commands/${commandID}/permissions` as const;
 	},
+
+	/**
+	 * Route for:
+	 * - GET   `/guilds/{guild.id}/welcome-screen`
+	 * - PATCH `/guilds/{guild.id}/welcome-screen`
+	 */
+	guildWelcomeScreen(guildID: Snowflake) {
+		return `/guilds/${guildID}/welcome-screen` as const;
+	},
 };
 
 export const RouteBases = {

diff --git a/rest/v8/guild.ts b/rest/v8/guild.ts
@@ -8,6 +8,7 @@ import type {
 	APIGuildMember,
 	APIGuildMembershipScreening,
 	APIGuildPreview,
+	APIGuildWelcomeScreen,
 	APIGuildWidget,
 	APIGuildWidgetSettings,
 	APIRole,
@@ -758,3 +759,22 @@ export interface RESTPatchAPIGuildVoiceStateUserJSONBody {
 	 */
 	suppress?: boolean;
 }
+
+/**
+ * https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen
+ */
+export type RESTGetAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
+
+/**
+ * https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
+ */
+export interface RESTPatchAPIGuildWelcomeScreenJSONBody extends Nullable<Partial<APIGuildWelcomeScreen>> {
+	/**
+	 * Whether the welcome screen is enabled
+	 */
+	enabled?: boolean | null;
+}
+
+type Nullable<T> = {
+	[P in keyof T]: T[P] | null;
+};
diff --git a/rest/v8/index.ts b/rest/v8/index.ts
@@ -648,6 +648,15 @@ export const Routes = {
 	applicationCommandPermissions(applicationID: Snowflake, guildID: Snowflake, commandID: Snowflake) {
 		return `/applications/${applicationID}/guilds/${guildID}/commands/${commandID}/permissions` as const;
 	},
+
+	/**
+	 * Route for:
+	 * - GET   `/guilds/{guild.id}/welcome-screen`
+	 * - PATCH `/guilds/{guild.id}/welcome-screen`
+	 */
+	guildWelcomeScreen(guildID: Snowflake) {
+		return `/guilds/${guildID}/welcome-screen` as const;
+	},
 };
 
 export const RouteBases = {