Skip to content

Commit

Permalink
feat: onboarding updates, mode field, and error codes (#773)
Browse files Browse the repository at this point in the history
  • Loading branch information
@almeidx
almeidx committed Jul 19, 2023
1 parent 06ee564 commit 773556a
Show file tree
Hide file tree
Showing 14 changed files with 134 additions and 0 deletions.
18 changes: 18 additions & 0 deletions deno/payloads/v10/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1028,6 +1028,10 @@ export interface APIGuildOnboarding {
* Whether onboarding is enabled in the guild
*/
enabled: boolean;
/**
* Current mode of onboarding
*/
mode: GuildOnboardingMode;
}

/**
Expand Down Expand Up @@ -1095,6 +1099,20 @@ export interface APIGuildOnboardingPromptOption {
description: string | null;
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
*/
export enum GuildOnboardingMode {
/**
* Counts only Default Channels towards constraints
*/
OnboardingDefault,
/**
* Counts Default Channels and Questions towards constraints
*/
OnboardingAdvanced,
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
*/
Expand Down
18 changes: 18 additions & 0 deletions deno/payloads/v9/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1020,6 +1020,10 @@ export interface APIGuildOnboarding {
* Whether onboarding is enabled in the guild
*/
enabled: boolean;
/**
* Current mode of onboarding
*/
mode: GuildOnboardingMode;
}

/**
Expand Down Expand Up @@ -1087,6 +1091,20 @@ export interface APIGuildOnboardingPromptOption {
description: string | null;
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
*/
export enum GuildOnboardingMode {
/**
* Counts only Default Channels towards constraints
*/
OnboardingDefault,
/**
* Counts Default Channels and Questions towards constraints
*/
OnboardingAdvanced,
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
*/
Expand Down
3 changes: 3 additions & 0 deletions deno/rest/common.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,9 @@ export enum RESTJSONErrorCodes {
WebhookServicesCannotBeUsedInForumChannels,

MessageBlockedByHarmfulLinksFilter = 240_000,

CannotEnableOnboardingRequirementsAreNotMet = 350_000,
CannotUpdateOnboardingWhileBelowRequirements,
}

/**
Expand Down
13 changes: 13 additions & 0 deletions deno/rest/v10/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -926,3 +926,16 @@ export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
* https://discord.com/developers/docs/resources/guild#get-guild-onboarding
*/
export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingJSONBody = Pick<
APIGuildOnboarding,
'default_channel_ids' | 'enabled' | 'mode' | 'prompts'
>;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingResult = APIGuildOnboarding;
1 change: 1 addition & 0 deletions deno/rest/v10/mod.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,7 @@ export const Routes = {
/**
* Route for:
* - GET `/guilds/${guild.id}/onboarding`
* - PUT `/guilds/${guild.id}/onboarding`
*/
guildOnboarding(guildId: Snowflake) {
return `/guilds/${guildId}/onboarding` as const;
Expand Down
13 changes: 13 additions & 0 deletions deno/rest/v9/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -932,3 +932,16 @@ export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
* https://discord.com/developers/docs/resources/guild#get-guild-onboarding
*/
export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingJSONBody = Pick<
APIGuildOnboarding,
'default_channel_ids' | 'enabled' | 'mode' | 'prompts'
>;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingResult = APIGuildOnboarding;
1 change: 1 addition & 0 deletions deno/rest/v9/mod.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,7 @@ export const Routes = {
/**
* Route for:
* - GET `/guilds/${guild.id}/onboarding`
* - PUT `/guilds/${guild.id}/onboarding`
*/
guildOnboarding(guildId: Snowflake) {
return `/guilds/${guildId}/onboarding` as const;
Expand Down
18 changes: 18 additions & 0 deletions payloads/v10/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1028,6 +1028,10 @@ export interface APIGuildOnboarding {
* Whether onboarding is enabled in the guild
*/
enabled: boolean;
/**
* Current mode of onboarding
*/
mode: GuildOnboardingMode;
}

/**
Expand Down Expand Up @@ -1095,6 +1099,20 @@ export interface APIGuildOnboardingPromptOption {
description: string | null;
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
*/
export enum GuildOnboardingMode {
/**
* Counts only Default Channels towards constraints
*/
OnboardingDefault,
/**
* Counts Default Channels and Questions towards constraints
*/
OnboardingAdvanced,
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
*/
Expand Down
18 changes: 18 additions & 0 deletions payloads/v9/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1020,6 +1020,10 @@ export interface APIGuildOnboarding {
* Whether onboarding is enabled in the guild
*/
enabled: boolean;
/**
* Current mode of onboarding
*/
mode: GuildOnboardingMode;
}

/**
Expand Down Expand Up @@ -1087,6 +1091,20 @@ export interface APIGuildOnboardingPromptOption {
description: string | null;
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
*/
export enum GuildOnboardingMode {
/**
* Counts only Default Channels towards constraints
*/
OnboardingDefault,
/**
* Counts Default Channels and Questions towards constraints
*/
OnboardingAdvanced,
}

/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
*/
Expand Down
3 changes: 3 additions & 0 deletions rest/common.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,9 @@ export enum RESTJSONErrorCodes {
WebhookServicesCannotBeUsedInForumChannels,

MessageBlockedByHarmfulLinksFilter = 240_000,

CannotEnableOnboardingRequirementsAreNotMet = 350_000,
CannotUpdateOnboardingWhileBelowRequirements,
}

/**
Expand Down
13 changes: 13 additions & 0 deletions rest/v10/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -926,3 +926,16 @@ export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
* https://discord.com/developers/docs/resources/guild#get-guild-onboarding
*/
export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingJSONBody = Pick<
APIGuildOnboarding,
'default_channel_ids' | 'enabled' | 'mode' | 'prompts'
>;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingResult = APIGuildOnboarding;
1 change: 1 addition & 0 deletions rest/v10/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,7 @@ export const Routes = {
/**
* Route for:
* - GET `/guilds/${guild.id}/onboarding`
* - PUT `/guilds/${guild.id}/onboarding`
*/
guildOnboarding(guildId: Snowflake) {
return `/guilds/${guildId}/onboarding` as const;
Expand Down
13 changes: 13 additions & 0 deletions rest/v9/guild.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -932,3 +932,16 @@ export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
* https://discord.com/developers/docs/resources/guild#get-guild-onboarding
*/
export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingJSONBody = Pick<
APIGuildOnboarding,
'default_channel_ids' | 'enabled' | 'mode' | 'prompts'
>;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
*/
export type RESTPutAPIGuildOnboardingResult = APIGuildOnboarding;
1 change: 1 addition & 0 deletions rest/v9/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,7 @@ export const Routes = {
/**
* Route for:
* - GET `/guilds/${guild.id}/onboarding`
* - PUT `/guilds/${guild.id}/onboarding`
*/
guildOnboarding(guildId: Snowflake) {
return `/guilds/${guildId}/onboarding` as const;
Expand Down

1 comment on commit 773556a

@vercel
Copy link

@vercel vercel bot commented on 773556a Jul 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

discord-api-types – ./

discord-api-types.dev
discord-api-types-discordjs.vercel.app
discord-api-types.vercel.app
discord-api-types-git-main-discordjs.vercel.app
www.discord-api-types.dev

Please sign in to comment.