Skip to content

Commit 773556a

Browse files
almeidxalmeidx
authored
feat: onboarding updates, mode field, and error codes (#773)
1 parent 06ee564 commit 773556a

File tree

14 files changed

+134
-0
lines changed

14 files changed

+134
-0
lines changed

‎deno/payloads/v10/guild.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,6 +1028,10 @@ export interface APIGuildOnboarding {
10281028
* Whether onboarding is enabled in the guild
10291029
*/
10301030
enabled: boolean;
1031+
/**
1032+
* Current mode of onboarding
1033+
*/
1034+
mode: GuildOnboardingMode;
10311035
}
10321036

10331037
/**
@@ -1095,6 +1099,20 @@ export interface APIGuildOnboardingPromptOption {
10951099
description: string | null;
10961100
}
10971101

1102+
/**
1103+
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
1104+
*/
1105+
export enum GuildOnboardingMode {
1106+
/**
1107+
* Counts only Default Channels towards constraints
1108+
*/
1109+
OnboardingDefault,
1110+
/**
1111+
* Counts Default Channels and Questions towards constraints
1112+
*/
1113+
OnboardingAdvanced,
1114+
}
1115+
10981116
/**
10991117
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
11001118
*/

‎deno/payloads/v9/guild.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1020,6 +1020,10 @@ export interface APIGuildOnboarding {
10201020
* Whether onboarding is enabled in the guild
10211021
*/
10221022
enabled: boolean;
1023+
/**
1024+
* Current mode of onboarding
1025+
*/
1026+
mode: GuildOnboardingMode;
10231027
}
10241028

10251029
/**
@@ -1087,6 +1091,20 @@ export interface APIGuildOnboardingPromptOption {
10871091
description: string | null;
10881092
}
10891093

1094+
/**
1095+
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
1096+
*/
1097+
export enum GuildOnboardingMode {
1098+
/**
1099+
* Counts only Default Channels towards constraints
1100+
*/
1101+
OnboardingDefault,
1102+
/**
1103+
* Counts Default Channels and Questions towards constraints
1104+
*/
1105+
OnboardingAdvanced,
1106+
}
1107+
10901108
/**
10911109
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
10921110
*/

‎deno/rest/common.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,9 @@ export enum RESTJSONErrorCodes {
285285
WebhookServicesCannotBeUsedInForumChannels,
286286

287287
MessageBlockedByHarmfulLinksFilter = 240_000,
288+
289+
CannotEnableOnboardingRequirementsAreNotMet = 350_000,
290+
CannotUpdateOnboardingWhileBelowRequirements,
288291
}
289292

290293
/**

‎deno/rest/v10/guild.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -926,3 +926,16 @@ export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
926926
* https://discord.com/developers/docs/resources/guild#get-guild-onboarding
927927
*/
928928
export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;
929+
930+
/**
931+
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
932+
*/
933+
export type RESTPutAPIGuildOnboardingJSONBody = Pick<
934+
APIGuildOnboarding,
935+
'default_channel_ids' | 'enabled' | 'mode' | 'prompts'
936+
>;
937+
938+
/**
939+
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
940+
*/
941+
export type RESTPutAPIGuildOnboardingResult = APIGuildOnboarding;

‎deno/rest/v10/mod.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -883,6 +883,7 @@ export const Routes = {
883883
/**
884884
* Route for:
885885
* - GET `/guilds/${guild.id}/onboarding`
886+
* - PUT `/guilds/${guild.id}/onboarding`
886887
*/
887888
guildOnboarding(guildId: Snowflake) {
888889
return `/guilds/${guildId}/onboarding` as const;

‎deno/rest/v9/guild.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -932,3 +932,16 @@ export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
932932
* https://discord.com/developers/docs/resources/guild#get-guild-onboarding
933933
*/
934934
export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;
935+
936+
/**
937+
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
938+
*/
939+
export type RESTPutAPIGuildOnboardingJSONBody = Pick<
940+
APIGuildOnboarding,
941+
'default_channel_ids' | 'enabled' | 'mode' | 'prompts'
942+
>;
943+
944+
/**
945+
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
946+
*/
947+
export type RESTPutAPIGuildOnboardingResult = APIGuildOnboarding;

‎deno/rest/v9/mod.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -892,6 +892,7 @@ export const Routes = {
892892
/**
893893
* Route for:
894894
* - GET `/guilds/${guild.id}/onboarding`
895+
* - PUT `/guilds/${guild.id}/onboarding`
895896
*/
896897
guildOnboarding(guildId: Snowflake) {
897898
return `/guilds/${guildId}/onboarding` as const;

‎payloads/v10/guild.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,6 +1028,10 @@ export interface APIGuildOnboarding {
10281028
* Whether onboarding is enabled in the guild
10291029
*/
10301030
enabled: boolean;
1031+
/**
1032+
* Current mode of onboarding
1033+
*/
1034+
mode: GuildOnboardingMode;
10311035
}
10321036

10331037
/**
@@ -1095,6 +1099,20 @@ export interface APIGuildOnboardingPromptOption {
10951099
description: string | null;
10961100
}
10971101

1102+
/**
1103+
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
1104+
*/
1105+
export enum GuildOnboardingMode {
1106+
/**
1107+
* Counts only Default Channels towards constraints
1108+
*/
1109+
OnboardingDefault,
1110+
/**
1111+
* Counts Default Channels and Questions towards constraints
1112+
*/
1113+
OnboardingAdvanced,
1114+
}
1115+
10981116
/**
10991117
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
11001118
*/

‎payloads/v9/guild.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1020,6 +1020,10 @@ export interface APIGuildOnboarding {
10201020
* Whether onboarding is enabled in the guild
10211021
*/
10221022
enabled: boolean;
1023+
/**
1024+
* Current mode of onboarding
1025+
*/
1026+
mode: GuildOnboardingMode;
10231027
}
10241028

10251029
/**
@@ -1087,6 +1091,20 @@ export interface APIGuildOnboardingPromptOption {
10871091
description: string | null;
10881092
}
10891093

1094+
/**
1095+
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
1096+
*/
1097+
export enum GuildOnboardingMode {
1098+
/**
1099+
* Counts only Default Channels towards constraints
1100+
*/
1101+
OnboardingDefault,
1102+
/**
1103+
* Counts Default Channels and Questions towards constraints
1104+
*/
1105+
OnboardingAdvanced,
1106+
}
1107+
10901108
/**
10911109
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
10921110
*/

‎rest/common.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,9 @@ export enum RESTJSONErrorCodes {
285285
WebhookServicesCannotBeUsedInForumChannels,
286286

287287
MessageBlockedByHarmfulLinksFilter = 240_000,
288+
289+
CannotEnableOnboardingRequirementsAreNotMet = 350_000,
290+
CannotUpdateOnboardingWhileBelowRequirements,
288291
}
289292

290293
/**

0 commit comments

Comments
 (0)