mirror of
https://github.com/discordeno/discordeno.git
synced 2026-09-17 16:57:22 +00:00
Dorian OszczędaandSkillz4Killz
c9659bca4c
* feat: Add return types to forum channel helpers. * fix: Use Discord-defined property names. Add `flags` property. * feat: Add return types to thread channel helpers. * feat: Add return types to channel helpers. * feat: Add return types to server discovery helpers. * misc!: Consistency: 'remove' -> 'delete'. * misc!: Add `get` keyword to function and file name. * feat: Add return types to emoji helpers. * misc!: Remove unused `bot` parameter. Capitalise 'URL'. * feat: Add return types to guild automod helpers. * feat: Add return types to guild scheduled event helpers. * misc!: Consistency: Rename `emojiURL` to `getEmojiURL`. * feat: Add return types to guild helpers. * misc!: Consistency: Add 'get' keyword to function and file names. * feat: Add return types to invite helpers. * feat: Add return types to integration helpers. * feat: Add return types to application command helpers. * feat: Add return types to followup message helpers. * feat: Add return types to interaction response helpers. * feat: Add return type to `createInvite()`. * feat: Add return types to member helpers. * misc!: Consistency: Add 'get' keyword to function and file names. * feat: Add return types to message helpers. * misc!: Consistency: 'remove' -> 'delete'. * fix: Use `slice()` to prevent unwanted side effects. * feat: Add return types to miscellaneous helpers. * misc!: Consistency: Add 'get' keyword to function and file names. * feat: Add return types to role helpers. * feat: Add return types to oauth helpers. * feat: Add return types to template helpers. * misc!: Consistency: Add 'guild' keyword to name. * feat: Add return types to voice helpers. * fix: Name function correctly. * feat: Add return types to webhook helpers. * misc!: Consistency: Rename `sendWebhook` to `sendWebhookMessage`. * misc: Update exports. * fix: Imports. * fix: Change return collection key type from `string` to `bigint`. Remove redundant code. * misc: Remove `undefined` from `runMethod()` return type. * style: Remove redundant types. * style: Rename endpoint call result variables to `result` and `results`. * misc: Reintroduce `bot` as first parameter. * misc: Adapt tests to changes made to helpers. * fix: Object being transformed twice. * style: Improve naming consistency of remaining files. * misc: `bigint` -> `number`. * style: Remove explicit `undefined` return. * style: Remove `void` operator in favour of generic type. * misc: Add missing `await` keyword. Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com> * style: Make `reason` property optional instead of `undefined`-able. * misc: Write out properties manually instead of using the spread operator. Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com>
49 lines
1.6 KiB
TypeScript
49 lines
1.6 KiB
TypeScript
import type { Bot } from "../../bot.ts";
|
|
import { WelcomeScreen } from "../../transformers/welcomeScreen.ts";
|
|
import { DiscordWelcomeScreen } from "../../types/discord.ts";
|
|
|
|
export async function editWelcomeScreen(
|
|
bot: Bot,
|
|
guildId: bigint,
|
|
options: ModifyGuildWelcomeScreen,
|
|
): Promise<WelcomeScreen> {
|
|
const result = await bot.rest.runMethod<DiscordWelcomeScreen>(
|
|
bot.rest,
|
|
"PATCH",
|
|
bot.constants.routes.GUILD_WELCOME_SCREEN(guildId),
|
|
{
|
|
enabled: options.enabled,
|
|
welcome_screen: options.welcomeScreen?.map((welcomeScreen) => ({
|
|
channel_id: welcomeScreen.channelId,
|
|
description: welcomeScreen.description,
|
|
emoji_id: welcomeScreen.emojiId,
|
|
emoji_name: welcomeScreen.emojiName,
|
|
})),
|
|
description: options.description,
|
|
},
|
|
);
|
|
|
|
return bot.transformers.welcomeScreen(bot, result);
|
|
}
|
|
|
|
/** https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen */
|
|
export interface ModifyGuildWelcomeScreen {
|
|
/** Whether the welcome screen is enabled */
|
|
enabled?: boolean | null;
|
|
/** Channels linked in the welcome screen and their display options */
|
|
welcomeScreen?: WelcomeScreenChannel[] | null;
|
|
/** The server description to show in the welcome screen */
|
|
description?: string | null;
|
|
}
|
|
|
|
export interface WelcomeScreenChannel {
|
|
/** The channel's id */
|
|
channelId: bigint;
|
|
/** The emoji id, if the emoji is custom */
|
|
emojiId?: bigint;
|
|
/** The emoji name if custom, the unicode character if standard, or `null` if no emoji is set */
|
|
emojiName?: string;
|
|
/** The description shown for the channel */
|
|
description: string;
|
|
}
|