diff --git a/packages/rest/src/types.ts b/packages/rest/src/types.ts index 9953f9309..29002526e 100644 --- a/packages/rest/src/types.ts +++ b/packages/rest/src/types.ts @@ -20,42 +20,42 @@ import type { CreateStageInstance, CreateTemplate, DeleteWebhookMessageOptions, - DiscordActiveThreads, - DiscordApplication, - DiscordApplicationCommand, - DiscordApplicationCommandPermissions, - DiscordArchivedThreads, - DiscordAuditLog, - DiscordAutoModerationRule, - DiscordBan, - DiscordChannel, - DiscordEmoji, - DiscordFollowedChannel, - DiscordGetGatewayBot, - DiscordGuild, - DiscordGuildPreview, - DiscordGuildWidget, - DiscordGuildWidgetSettings, - DiscordIntegration, - DiscordInvite, - DiscordInviteMetadata, - DiscordMember, - DiscordMemberWithUser, - DiscordMessage, - DiscordModifyGuildWelcomeScreen, - DiscordPrunedCount, - DiscordRole, - DiscordScheduledEvent, - DiscordStageInstance, - DiscordSticker, - DiscordStickerPack, - DiscordTemplate, - DiscordThreadMember, - DiscordUser, - DiscordVanityUrl, - DiscordVoiceRegion, - DiscordWebhook, - DiscordWelcomeScreen, + CamelizedDiscordActiveThreads, + CamelizedDiscordApplication, + CamelizedDiscordApplicationCommand, + CamelizedDiscordApplicationCommandPermissions, + CamelizedDiscordArchivedThreads, + CamelizedDiscordAuditLog, + CamelizedDiscordAutoModerationRule, + CamelizedDiscordBan, + CamelizedDiscordChannel, + CamelizedDiscordEmoji, + CamelizedDiscordFollowedChannel, + CamelizedDiscordGetGatewayBot, + CamelizedDiscordGuild, + CamelizedDiscordGuildPreview, + CamelizedDiscordGuildWidget, + CamelizedDiscordGuildWidgetSettings, + CamelizedDiscordIntegration, + CamelizedDiscordInvite, + CamelizedDiscordInviteMetadata, + CamelizedDiscordMember, + CamelizedDiscordMemberWithUser, + CamelizedDiscordMessage, + CamelizedDiscordModifyGuildWelcomeScreen, + CamelizedDiscordPrunedCount, + CamelizedDiscordRole, + CamelizedDiscordScheduledEvent, + CamelizedDiscordStageInstance, + CamelizedDiscordSticker, + CamelizedDiscordStickerPack, + CamelizedDiscordTemplate, + CamelizedDiscordThreadMember, + CamelizedDiscordUser, + CamelizedDiscordVanityUrl, + CamelizedDiscordVoiceRegion, + CamelizedDiscordWebhook, + CamelizedDiscordWelcomeScreen, EditAutoModerationRuleOptions, EditBotMemberOptions, EditChannelPermissionOverridesOptions, @@ -256,7 +256,7 @@ export interface RestManager { * * @param guildId - The ID of the guild to create the rule in. * @param options - The parameters for the creation of the rule. - * @returns An instance of the created {@link DiscordAutoModerationRule}. + * @returns An instance of the created {@link CamelizedDiscordAutoModerationRule}. * * @remarks * Requires the `MANAGE_GUILD` permission. @@ -265,13 +265,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule} */ - createAutomodRule: (guildId: BigString, options: CreateAutoModerationRuleOptions) => Promise> + createAutomodRule: (guildId: BigString, options: CreateAutoModerationRuleOptions) => Promise /** * Creates a channel within a guild. * * @param guildId - The ID of the guild to create the channel within. * @param options - The parameters for the creation of the channel. - * @returns An instance of the created {@link DiscordChannel}. + * @returns An instance of the created {@link CamelizedDiscordChannel}. * * @remarks * Requires the `MANAGE_CHANNELS` permission. @@ -284,13 +284,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-channel} */ - createChannel: (guildId: BigString, options: CreateGuildChannel) => Promise> + createChannel: (guildId: BigString, options: CreateGuildChannel) => Promise /** * Creates an emoji in a guild. * * @param guildId - The ID of the guild in which to create the emoji. * @param options - The parameters for the creation of the emoji. - * @returns An instance of the created {@link DiscordEmoji}. + * @returns An instance of the created {@link CamelizedDiscordEmoji}. * * @remarks * Requires the `MANAGE_EMOJIS_AND_STICKERS` permission. @@ -301,13 +301,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/emoji#create-guild-emoji} */ - createEmoji: (guildId: BigString, options: CreateGuildEmoji) => Promise> + createEmoji: (guildId: BigString, options: CreateGuildEmoji) => Promise /** * Creates a new thread in a forum channel, and sends a message within the created thread. * * @param channelId - The ID of the forum channel to create the thread within. * @param options - The parameters for the creation of the thread. - * @returns An instance of {@link DiscordChannel} with a nested {@link Message} object. + * @returns An instance of {@link CamelizedDiscordChannel} with a nested {@link Message} object. * * @remarks * Requires the `CREATE_MESSAGES` permission. @@ -319,7 +319,7 @@ export interface RestManager { * * @experimental */ - createForumThread: (channelId: BigString, options: CreateForumPostWithMessage) => Promise> + createForumThread: (channelId: BigString, options: CreateForumPostWithMessage) => Promise /** * Creates an application command accessible globally; across different guilds and channels. * @@ -333,12 +333,12 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command} */ - createGlobalApplicationCommand: (command: CreateApplicationCommand) => Promise> + createGlobalApplicationCommand: (command: CreateApplicationCommand) => Promise /** * Creates a guild. * * @param options - The parameters for the creation of the guild. - * @returns An instance of the created {@link DiscordGuild}. + * @returns An instance of the created {@link CamelizedDiscordGuild}. * * @remarks * ⚠️ This route can only be used by bots in __fewer than 10 guilds__. @@ -347,7 +347,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#create-guild} */ - createGuild: (options: CreateGuild) => Promise> + createGuild: (options: CreateGuild) => Promise /** * Creates an application command only accessible in a specific guild. * @@ -361,7 +361,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command} */ - createGuildApplicationCommand: (command: CreateApplicationCommand, guildId: BigString) => Promise> + createGuildApplicationCommand: (command: CreateApplicationCommand, guildId: BigString) => Promise /** * Creates a guild from a template. * @@ -376,12 +376,12 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template} */ - createGuildFromTemplate: (templateCode: string, options: CreateGuildFromTemplate) => Promise> + createGuildFromTemplate: (templateCode: string, options: CreateGuildFromTemplate) => Promise /** * Create a new sticker for the guild. * * @param guildId The ID of the guild to get - * @return A {@link DiscordSticker} + * @return A {@link CamelizedDiscordSticker} * * @remarks * Requires the `MANAGE_EMOJIS_AND_STICKERS` permission. @@ -391,7 +391,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/sticker#create-guild-sticker} */ - createGuildSticker: (guildId: BigString, options: CreateGuildStickerOptions) => Promise> + createGuildSticker: (guildId: BigString, options: CreateGuildStickerOptions) => Promise /** * Creates a template from a guild. * @@ -406,13 +406,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-template} */ - createGuildTemplate: (guildId: BigString, options: CreateTemplate) => Promise> + createGuildTemplate: (guildId: BigString, options: CreateTemplate) => Promise /** * Creates an invite to a channel in a guild. * * @param channelId - The ID of the channel to create the invite to. * @param options - The parameters for the creation of the invite. - * @returns An instance of the created {@link DiscordInvite}. + * @returns An instance of the created {@link CamelizedDiscordInvite}. * * @remarks * Requires the `CREATE_INSTANT_INVITE` permission. @@ -424,13 +424,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#create-channel-invite} */ - createInvite: (channelId: BigString, options?: CreateChannelInvite) => Promise> + createInvite: (channelId: BigString, options?: CreateChannelInvite) => Promise /** * Creates a role in a guild. * * @param guildId - The ID of the guild to create the role in. * @param options - The parameters for the creation of the role. - * @returns An instance of the created {@link DiscordRole}. + * @returns An instance of the created {@link CamelizedDiscordRole}. * * @remarks * Requires the `MANAGE_ROLES` permission. @@ -439,7 +439,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-role} */ - createRole: (guildId: BigString, options: CreateGuildRole, reason?: string) => Promise> + createRole: (guildId: BigString, options: CreateGuildRole, reason?: string) => Promise /** * Creates a scheduled event in a guild. * @@ -456,12 +456,12 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event} */ - createScheduledEvent: (guildId: BigString, options: CreateScheduledEvent) => Promise> + createScheduledEvent: (guildId: BigString, options: CreateScheduledEvent) => Promise /** * Creates a stage instance associated with a stage channel. * * @param options - The parameters for the creation of the stage instance. - * @returns An instance of the created {@link DiscordStageInstance}. + * @returns An instance of the created {@link CamelizedDiscordStageInstance}. * * @remarks * Requires the user to be a moderator of the stage channel. @@ -470,13 +470,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/stage-instance#create-stage-instance} */ - createStageInstance: (options: CreateStageInstance) => Promise> + createStageInstance: (options: CreateStageInstance) => Promise /** * Creates a webhook. * * @param channelId - The ID of the channel to create the webhook in. * @param options - The parameters for the creation of the webhook. - * @returns An instance of the created {@link DiscordWebhook}. + * @returns An instance of the created {@link CamelizedDiscordWebhook}. * * @remarks * Requires the `MANAGE_WEBHOOKS` permission. @@ -487,7 +487,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/webhook#create-webhook} */ - createWebhook: (channelId: BigString, options: CreateWebhook) => Promise> + createWebhook: (channelId: BigString, options: CreateWebhook) => Promise /** * Deletes an automod rule. * @@ -603,7 +603,7 @@ export interface RestManager { * Delete a new sticker for the guild. * * @param guildId The ID of the guild to get - * @return A {@link DiscordSticker} + * @return A {@link CamelizedDiscordSticker} * * @remarks * Requires the `MANAGE_EMOJIS_AND_STICKERS` permission. @@ -867,14 +867,14 @@ export interface RestManager { commandId: BigString, bearerToken: string, options: ApplicationCommandPermissions[], - ) => Promise> + ) => Promise /** * Edits an automod rule. * * @param guildId - The ID of the guild to edit the rule in. * @param ruleId - The ID of the rule to edit. * @param options - The parameters for the edit of the rule. - * @returns An instance of the edited {@link DiscordAutoModerationRule}. + * @returns An instance of the edited {@link CamelizedDiscordAutoModerationRule}. * * @remarks * Requires the `MANAGE_GUILD` permission. @@ -887,18 +887,18 @@ export interface RestManager { guildId: BigString, ruleId: BigString, options: Partial, - ) => Promise> + ) => Promise /** * Modifies the bot's username or avatar. * NOTE: username: if changed may cause the bot's discriminator to be randomized. */ - editBotProfile: (options: { username?: string; botAvatarURL?: string | null }) => Promise> + editBotProfile: (options: { username?: string; botAvatarURL?: string | null }) => Promise /** * Edits a channel's settings. * * @param channelId - The ID of the channel to edit. * @param options - The parameters for the edit of the channel. - * @returns An instance of the edited {@link DiscordChannel}. + * @returns An instance of the edited {@link CamelizedDiscordChannel}. * * @remarks * If editing a channel of type {@link ChannelTypes.GroupDm}: @@ -922,7 +922,7 @@ export interface RestManager { * - Otherwise: * - Fires a _Channel Update_ gateway event. */ - editChannel: (channelId: BigString, options: ModifyChannel) => Promise> + editChannel: (channelId: BigString, options: ModifyChannel) => Promise /** * Edits the permission overrides for a user or role in a channel. * @@ -959,7 +959,7 @@ export interface RestManager { * @param guildId - The ID of the guild in which to edit the emoji. * @param id - The ID of the emoji to edit. * @param options - The parameters for the edit of the emoji. - * @returns An instance of the updated {@link DiscordEmoji}. + * @returns An instance of the updated {@link CamelizedDiscordEmoji}. * * @remarks * Requires the `MANAGE_EMOJIS_AND_STICKERS` permission. @@ -968,7 +968,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/emoji#modify-guild-emoji} */ - editEmoji: (guildId: BigString, id: BigString, options: ModifyGuildEmoji) => Promise> + editEmoji: (guildId: BigString, id: BigString, options: ModifyGuildEmoji) => Promise /** * Edits a follow-up message to an interaction. * @@ -986,7 +986,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message} */ - editFollowupMessage: (token: string, messageId: BigString, options: InteractionCallbackData) => Promise> + editFollowupMessage: (token: string, messageId: BigString, options: InteractionCallbackData) => Promise /** * Edits a global application command. * @@ -996,7 +996,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command} */ - editGlobalApplicationCommand: (commandId: BigString, options: CreateApplicationCommand) => Promise> + editGlobalApplicationCommand: (commandId: BigString, options: CreateApplicationCommand) => Promise /** * Edits a guild's settings. * @@ -1015,7 +1015,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild} */ - editGuild: (guildId: BigString, options: ModifyGuild) => Promise> + editGuild: (guildId: BigString, options: ModifyGuild) => Promise /** * Edits an application command registered in a guild. * @@ -1030,14 +1030,14 @@ export interface RestManager { commandId: BigString, guildId: BigString, options: CreateApplicationCommand, - ) => Promise> + ) => Promise /** Modify a guild's MFA level. Requires guild ownership. */ editGuildMfaLevel: (guildId: BigString, mfaLevel: MfaLevels, reason?: string) => Promise /** * Edit the given sticker. * * @param guildId The ID of the guild to get - * @return A {@link DiscordSticker} + * @return A {@link CamelizedDiscordSticker} * * @remarks * Requires the `MANAGE_EMOJIS_AND_STICKERS` permission. @@ -1045,7 +1045,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/sticker#modify-guild-sticker} */ - editGuildSticker: (guildId: BigString, stickerId: BigString, options: AtLeastOne) => Promise> + editGuildSticker: (guildId: BigString, stickerId: BigString, options: AtLeastOne) => Promise /** * Edits a template's settings. * @@ -1061,7 +1061,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-template#modify-guild-template} */ - editGuildTemplate: (guildId: BigString, templateCode: string, options: ModifyGuildTemplate) => Promise> + editGuildTemplate: (guildId: BigString, templateCode: string, options: ModifyGuildTemplate) => Promise /** * Edits a message. * @@ -1079,7 +1079,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#edit-message} */ - editMessage: (channelId: BigString, messageId: BigString, options: EditMessage) => Promise> + editMessage: (channelId: BigString, messageId: BigString, options: EditMessage) => Promise /** * Edits the initial message response to an interaction. * @@ -1096,14 +1096,14 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response} */ - editOriginalInteractionResponse: (token: string, options: InteractionCallbackData) => Promise | undefined> + editOriginalInteractionResponse: (token: string, options: InteractionCallbackData) => Promise /** * Edits the original webhook message. * * @param webhookId - The ID of the webhook to edit the original message of. * @param token - The webhook token, used to edit the message. * @param options - The parameters for the edit of the message. - * @returns An instance of the edited {@link DiscordMessage}. + * @returns An instance of the edited {@link CamelizedDiscordMessage}. * * @remarks * Fires a _Message Update_ gateway event. @@ -1114,7 +1114,7 @@ export interface RestManager { webhookId: BigString, token: string, options: InteractionCallbackData & { threadId?: BigString }, - ) => Promise> + ) => Promise /** * Edits the voice state of the bot user. * @@ -1139,7 +1139,7 @@ export interface RestManager { * @param guildId - The ID of the guild to edit the role in. * @param roleId - The ID of the role to edit. * @param options - The parameters for the edit of the role. - * @returns An instance of the edited {@link DiscordRole}. + * @returns An instance of the edited {@link CamelizedDiscordRole}. * * @remarks * Requires the `MANAGE_ROLES` permission. @@ -1148,13 +1148,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role} */ - editRole: (guildId: BigString, roleId: BigString, options: EditGuildRole) => Promise> + editRole: (guildId: BigString, roleId: BigString, options: EditGuildRole) => Promise /** * Edits the positions of a set of roles. * * @param guildId - The ID of the guild to edit the role positions in. * @param options - The parameters for the edit of the role positions. - * @returns A collection of {@link DiscordRole} objects assorted by role ID. + * @returns A collection of {@link CamelizedDiscordRole} objects assorted by role ID. * * @remarks * Requires the `MANAGE_ROLES` permission. @@ -1163,7 +1163,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role-positions} */ - editRolePositions: (guildId: BigString, options: ModifyRolePositions[]) => Promise> + editRolePositions: (guildId: BigString, options: ModifyRolePositions[]) => Promise /** * Edits a scheduled event. * @@ -1182,12 +1182,12 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event} */ - editScheduledEvent: (guildId: BigString, eventId: BigString, options: Partial) => Promise> + editScheduledEvent: (guildId: BigString, eventId: BigString, options: Partial) => Promise /** * Edits a stage instance. * * @param channelId - The ID of the stage channel the stage instance is associated with. - * @returns An instance of the updated {@link DiscordStageInstance}. + * @returns An instance of the updated {@link CamelizedDiscordStageInstance}. * * @remarks * Requires the user to be a moderator of the stage channel. @@ -1196,7 +1196,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance} */ - editStageInstance: (channelId: BigString, data: EditStageInstanceOptions) => Promise> + editStageInstance: (channelId: BigString, data: EditStageInstanceOptions) => Promise /** * Edits the voice state of another user. * @@ -1215,7 +1215,7 @@ export interface RestManager { * Edits a webhook. * * @param webhookId - The ID of the webhook to edit. - * @returns An instance of the edited {@link DiscordWebhook}. + * @returns An instance of the edited {@link CamelizedDiscordWebhook}. * * @remarks * Requires the `MANAGE_WEBHOOKS` permission. @@ -1224,7 +1224,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook} */ - editWebhook: (webhookId: BigString, options: ModifyWebhook) => Promise> + editWebhook: (webhookId: BigString, options: ModifyWebhook) => Promise /** * Edits a webhook message. * @@ -1232,7 +1232,7 @@ export interface RestManager { * @param token - The webhook token, used to edit the message. * @param messageId - The ID of the message to edit. * @param options - The parameters for the edit of the message. - * @returns An instance of the edited {@link DiscordMessage}. + * @returns An instance of the edited {@link CamelizedDiscordMessage}. * * @remarks * Fires a _Message Update_ gateway event. @@ -1244,13 +1244,13 @@ export interface RestManager { token: string, messageId: BigString, options: InteractionCallbackData & { threadId?: BigString }, - ) => Promise> + ) => Promise /** * Edits a webhook using the webhook token, thereby bypassing the need for authentication + permissions. * * @param webhookId - The ID of the webhook to edit. * @param token - The webhook token, used to edit the webhook. - * @returns An instance of the edited {@link DiscordWebhook}. + * @returns An instance of the edited {@link CamelizedDiscordWebhook}. * * @remarks * Requires the `MANAGE_WEBHOOKS` permission. @@ -1259,7 +1259,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token} */ - editWebhookWithToken: (webhookId: BigString, token: string, options: Omit) => Promise> + editWebhookWithToken: (webhookId: BigString, token: string, options: Omit) => Promise /** * Edits a guild's welcome screen. * @@ -1274,7 +1274,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen} */ - editWelcomeScreen: (guildId: BigString, options: Camelize) => Promise> + editWelcomeScreen: (guildId: BigString, options: CamelizedDiscordModifyGuildWelcomeScreen) => Promise /** * Edits the settings of a guild's widget. * @@ -1288,27 +1288,27 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-widget} */ - editWidgetSettings: (guildId: BigString, options: Camelize) => Promise> + editWidgetSettings: (guildId: BigString, options: CamelizedDiscordGuildWidgetSettings) => Promise /** * Executes a webhook, causing a message to be posted in the channel configured for the webhook. * * @param webhookId - The ID of the webhook to execute. * @param token - The webhook token, used to execute the webhook. * @param options - The parameters for the execution of the webhook. - * @returns An instance of the created {@link DiscordMessage}, or `undefined` if the {@link ExecuteWebhook.wait | wait} property of the {@link options} object parameter is set to `false`. + * @returns An instance of the created {@link CamelizedDiscordMessage}, or `undefined` if the {@link ExecuteWebhook.wait | wait} property of the {@link options} object parameter is set to `false`. * * @remarks * If the webhook channel is a forum channel, you must provide a value for either `threadId` or `threadName`. * * @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook} */ - executeWebhook: (webhookId: BigString, token: string, options: ExecuteWebhook) => Promise | undefined> + executeWebhook: (webhookId: BigString, token: string, options: ExecuteWebhook) => Promise /** * Follows an announcement channel, allowing messages posted within it to be cross-posted into the target channel. * * @param sourceChannelId - The ID of the announcement channel to follow. * @param targetChannelId - The ID of the target channel - the channel to cross-post to. - * @returns An instance of {@link DiscordFollowedChannel}. + * @returns An instance of {@link CamelizedDiscordFollowedChannel}. * * @remarks * Requires the `MANAGE_WEBHOOKS` permission in the __target channel__. @@ -1317,12 +1317,12 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#follow-announcement-channel} */ - followAnnouncement: (sourceChannelId: BigString, targetChannelId: BigString) => Promise> + followAnnouncement: (sourceChannelId: BigString, targetChannelId: BigString) => Promise /** * Gets the list of all active threads for a guild. * * @param guildId - The ID of the guild to get the threads of. - * @returns An instance of {@link DiscordActiveThreads}. + * @returns An instance of {@link CamelizedDiscordActiveThreads}. * * @remarks * Returns both public and private threads. @@ -1331,9 +1331,9 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#list-active-guild-threads} */ - getActiveThreads: (guildId: BigString) => Promise> + getActiveThreads: (guildId: BigString) => Promise /** Get the applications info */ - getApplicationInfo: () => Promise> + getApplicationInfo: () => Promise /** * Gets the permissions of a guild application command. * @@ -1343,7 +1343,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions} */ - getApplicationCommandPermission: (guildId: BigString, commandId: BigString) => Promise> + getApplicationCommandPermission: (guildId: BigString, commandId: BigString) => Promise /** * Gets the permissions of all application commands registered in a guild by the ID of the guild. * @@ -1352,7 +1352,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions} */ - getApplicationCommandPermissions: (guildId: BigString) => Promise> + getApplicationCommandPermissions: (guildId: BigString) => Promise /** * Gets a guild's audit log. * @@ -1365,57 +1365,57 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log} */ - getAuditLog: (guildId: BigString, options?: GetGuildAuditLog) => Promise> + getAuditLog: (guildId: BigString, options?: GetGuildAuditLog) => Promise /** * Gets an automod rule by its ID. * * @param guildId - The ID of the guild to get the rule of. * @param ruleId - The ID of the rule to get. - * @returns An instance of {@link DiscordAutoModerationRule}. + * @returns An instance of {@link CamelizedDiscordAutoModerationRule}. * * @remarks * Requires the `MANAGE_GUILD` permission. * * @see {@link https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule} */ - getAutomodRule: (guildId: BigString, ruleId: BigString) => Promise> + getAutomodRule: (guildId: BigString, ruleId: BigString) => Promise /** * Gets the list of automod rules for a guild. * * @param guildId - The ID of the guild to get the rules from. - * @returns A collection of {@link DiscordAutoModerationRule} objects assorted by rule ID. + * @returns A collection of {@link CamelizedDiscordAutoModerationRule} objects assorted by rule ID. * * @remarks * Requires the `MANAGE_GUILD` permission. * * @see {@link https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild} */ - getAutomodRules: (guildId: BigString) => Promise> + getAutomodRules: (guildId: BigString) => Promise /** * Gets the list of available voice regions. * * @returns A collection of {@link VoiceRegions | VoiceRegion} objects assorted by voice region ID. */ - getAvailableVoiceRegions: () => Promise> + getAvailableVoiceRegions: () => Promise /** * Gets a ban by user ID. * * @param guildId - The ID of the guild to get the ban from. * @param userId - The ID of the user to get the ban for. - * @returns An instance of {@link DiscordBan}. + * @returns An instance of {@link CamelizedDiscordBan}. * * @remarks * Requires the `BAN_MEMBERS` permission. * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-ban} */ - getBan: (guildId: BigString, userId: BigString) => Promise> + getBan: (guildId: BigString, userId: BigString) => Promise /** * Gets the list of bans for a guild. * * @param guildId - The ID of the guild to get the list of bans for. * @param options - The parameters for the fetching of the list of bans. - * @returns A collection of {@link DiscordBan} objects assorted by user ID. + * @returns A collection of {@link CamelizedDiscordBan} objects assorted by user ID. * * @remarks * Requires the `BAN_MEMBERS` permission. @@ -1424,24 +1424,24 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-bans} */ - getBans: (guildId: BigString, options?: GetBans) => Promise> + getBans: (guildId: BigString, options?: GetBans) => Promise /** * Gets a channel by its ID. * * @param channelId - The ID of the channel to get. - * @returns An instance of {@link DiscordChannel}. + * @returns An instance of {@link CamelizedDiscordChannel}. * * @remarks * If the channel is a thread, a {@link ThreadMember} object is included in the result. * * @see {@link https://discord.com/developers/docs/resources/channel#get-channel} */ - getChannel: (channelId: BigString) => Promise> + getChannel: (channelId: BigString) => Promise /** * Gets the list of invites for a channel. * * @param channelId - The ID of the channel to get the invites of. - * @returns A collection of {@link DiscordInviteMetadata} objects assorted by invite code. + * @returns A collection of {@link CamelizedDiscordInviteMetadata} objects assorted by invite code. * * @remarks * Requires the `MANAGE_CHANNELS` permission. @@ -1450,59 +1450,59 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-invites} */ - getChannelInvites: (channelId: BigString) => Promise> + getChannelInvites: (channelId: BigString) => Promise /** * Gets the list of channels for a guild. * * @param guildId - The ID of the guild to get the channels of. - * @returns A collection of {@link DiscordChannel} objects assorted by channel ID. + * @returns A collection of {@link CamelizedDiscordChannel} objects assorted by channel ID. * * @remarks * Excludes threads. * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-channels} */ - getChannels: (guildId: BigString) => Promise> + getChannels: (guildId: BigString) => Promise /** * Gets a list of webhooks for a channel. * * @param channelId - The ID of the channel which to get the webhooks of. - * @returns A collection of {@link DiscordWebhook} objects assorted by webhook ID. + * @returns A collection of {@link CamelizedDiscordWebhook} objects assorted by webhook ID. * * @remarks * Requires the `MANAGE_WEBHOOKS` permission. * * @see {@link https://discord.com/developers/docs/resources/webhook#get-channel-webhooks} */ - getChannelWebhooks: (channelId: BigString) => Promise> + getChannelWebhooks: (channelId: BigString) => Promise /** * Gets or creates a DM channel with a user. * * @param userId - The ID of the user to create the DM channel with. - * @returns An instance of {@link DiscordChannel}. + * @returns An instance of {@link CamelizedDiscordChannel}. * * @see {@link https://discord.com/developers/docs/resources/user#create-dm} */ - getDmChannel: (userId: BigString) => Promise> + getDmChannel: (userId: BigString) => Promise /** * Gets an emoji by its ID. * * @param guildId - The ID of the guild from which to get the emoji. * @param emojiId - The ID of the emoji to get. - * @returns An instance of {@link DiscordEmoji}. + * @returns An instance of {@link CamelizedDiscordEmoji}. * * @see {@link https://discord.com/developers/docs/resources/emoji#get-guild-emoji} */ - getEmoji: (guildId: BigString, emojiId: BigString) => Promise> + getEmoji: (guildId: BigString, emojiId: BigString) => Promise /** * Gets the list of emojis for a guild. * * @param guildId - The ID of the guild which to get the emojis of. - * @returns A collection of {@link DiscordEmoji} objects assorted by emoji ID. + * @returns A collection of {@link CamelizedDiscordEmoji} objects assorted by emoji ID. * * @see {@link https://discord.com/developers/docs/resources/emoji#list-guild-emojis} */ - getEmojis: (guildId: BigString) => Promise> + getEmojis: (guildId: BigString) => Promise /** * Gets a follow-up message to an interaction by the ID of the message. * @@ -1519,9 +1519,9 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message} */ - getFollowupMessage: (token: string, messageId: BigString) => Promise> + getFollowupMessage: (token: string, messageId: BigString) => Promise /** Get the bots Gateway metadata that can help during the operation of large or sharded bots. */ - getGatewayBot: () => Promise> + getGatewayBot: () => Promise /** * Gets a global application command by its ID. * @@ -1530,7 +1530,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-command} */ - getGlobalApplicationCommand: (commandId: BigString) => Promise> + getGlobalApplicationCommand: (commandId: BigString) => Promise /** * Gets the list of your bot's global application commands. * @@ -1538,7 +1538,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands} */ - getGlobalApplicationCommands: () => Promise> + getGlobalApplicationCommands: () => Promise /** * Gets a guild by its ID. * @@ -1548,7 +1548,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild} */ - getGuild: (guildId: BigString, options?: { counts?: boolean }) => Promise> + getGuild: (guildId: BigString, options?: { counts?: boolean }) => Promise /** * Gets a guild application command by its ID. * @@ -1558,7 +1558,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command} */ - getGuildApplicationCommand: (commandId: BigString, guildId: BigString) => Promise> + getGuildApplicationCommand: (commandId: BigString, guildId: BigString) => Promise /** * Gets the list of application commands registered by your bot in a guild. * @@ -1567,7 +1567,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commandss} */ - getGuildApplicationCommands: (guildId: BigString) => Promise> + getGuildApplicationCommands: (guildId: BigString) => Promise /** * Gets the preview of a guild by a guild's ID. * @@ -1579,30 +1579,30 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-preview} */ - getGuildPreview: (guildId: BigString) => Promise> + getGuildPreview: (guildId: BigString) => Promise /** * Returns a sticker object for the given guild and sticker IDs. * * @param guildId The ID of the guild to get * @param stickerId The ID of the sticker to get - * @return A {@link DiscordSticker} + * @return A {@link CamelizedDiscordSticker} * * @remarks Includes the user field if the bot has the `MANAGE_EMOJIS_AND_STICKERS` permission. * * @see {@link https://discord.com/developers/docs/resources/sticker#get-guild-sticker} */ - getGuildSticker: (guildId: BigString, stickerId: BigString) => Promise> + getGuildSticker: (guildId: BigString, stickerId: BigString) => Promise /** * Returns an array of sticker objects for the given guild. * * @param guildId The ID of the guild to get - * @returns A collection of {@link DiscordSticker} objects assorted by sticker ID. + * @returns A collection of {@link CamelizedDiscordSticker} objects assorted by sticker ID. * * @remarks Includes user fields if the bot has the `MANAGE_EMOJIS_AND_STICKERS` permission. * * @see {@link https://discord.com/developers/docs/resources/sticker#list-guild-stickers} */ - getGuildStickers: (guildId: BigString) => Promise> + getGuildStickers: (guildId: BigString) => Promise /** * Gets a template by its code. * @@ -1614,7 +1614,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-template} */ - getGuildTemplate: (templateCode: string) => Promise> + getGuildTemplate: (templateCode: string) => Promise /** * Gets the list of templates for a guild. * @@ -1626,19 +1626,19 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-templates} */ - getGuildTemplates: (guildId: BigString) => Promise> + getGuildTemplates: (guildId: BigString) => Promise /** * Gets the list of webhooks for a guild. * * @param guildId - The ID of the guild to get the list of webhooks for. - * @returns A collection of {@link DiscordWebhook} objects assorted by webhook ID. + * @returns A collection of {@link CamelizedDiscordWebhook} objects assorted by webhook ID. * * @remarks * Requires the `MANAGE_WEBHOOKS` permission. * * @see {@link https://discord.com/developers/docs/resources/webhook#get-guild-webhooks} */ - getGuildWebhooks: (guildId: BigString) => Promise> + getGuildWebhooks: (guildId: BigString) => Promise /** * Gets the list of integrations attached to a guild. * @@ -1650,17 +1650,17 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-integrations} */ - getIntegrations: (guildId: BigString) => Promise> + getIntegrations: (guildId: BigString) => Promise /** * Gets an invite to a channel by its invite code. * * @param inviteCode - The invite code of the invite to get. * @param options - The parameters for the fetching of the invite. - * @returns An instance of {@link DiscordInviteMetadata}. + * @returns An instance of {@link CamelizedDiscordInviteMetadata}. * * @see {@link https://discord.com/developers/docs/resources/invite#get-invite} */ - getInvite: (inviteCode: string, options?: GetInvite) => Promise> + getInvite: (inviteCode: string, options?: GetInvite) => Promise /** * Gets the list of invites for a guild. * @@ -1672,7 +1672,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/invite#get-invites} */ - getInvites: (guildId: BigString) => Promise> + getInvites: (guildId: BigString) => Promise /** * Gets a message from a channel by the ID of the message. * @@ -1688,7 +1688,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-message} */ - getMessage: (channelId: BigString, messageId: BigString) => Promise> + getMessage: (channelId: BigString, messageId: BigString) => Promise /** * Gets multiple messages from a channel. * @@ -1704,7 +1704,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-messages} */ - getMessages: (channelId: BigString, options?: GetMessagesOptions) => Promise> + getMessages: (channelId: BigString, options?: GetMessagesOptions) => Promise /** * Returns the list of sticker packs available to Nitro subscribers. * @@ -1712,7 +1712,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/sticker#list-nitro-sticker-packs} */ - getNitroStickerPacks: () => Promise> + getNitroStickerPacks: () => Promise /** * Gets the initial message response to an interaction. * @@ -1728,7 +1728,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response} */ - getOriginalInteractionResponse: (token: string) => Promise> + getOriginalInteractionResponse: (token: string) => Promise /** * Gets the pinned messages for a channel. * @@ -1743,13 +1743,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#get-pinned-messages} */ - getPinnedMessages: (channelId: BigString) => Promise> + getPinnedMessages: (channelId: BigString) => Promise /** * Gets the list of private archived threads for a channel. * * @param channelId - The ID of the channel to get the archived threads for. * @param options - The parameters for the fetching of threads. - * @returns An instance of {@link DiscordArchivedThreads}. + * @returns An instance of {@link CamelizedDiscordArchivedThreads}. * * @remarks * Requires the `READ_MESSAGE_HISTORY` permission. @@ -1761,13 +1761,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#list-private-archived-threads} */ - getPrivateArchivedThreads: (channelId: BigString, options?: ListArchivedThreads) => Promise> + getPrivateArchivedThreads: (channelId: BigString, options?: ListArchivedThreads) => Promise /** * Gets the list of private archived threads the bot is a member of for a channel. * * @param channelId - The ID of the channel to get the archived threads for. * @param options - The parameters for the fetching of threads. - * @returns An instance of {@link DiscordArchivedThreads}. + * @returns An instance of {@link CamelizedDiscordArchivedThreads}. * * @remarks * Requires the `READ_MESSAGE_HISTORY` permission. @@ -1778,7 +1778,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads} */ - getPrivateJoinedArchivedThreads: (channelId: BigString, options?: ListArchivedThreads) => Promise> + getPrivateJoinedArchivedThreads: (channelId: BigString, options?: ListArchivedThreads) => Promise /** * Gets the number of members that would be kicked from a guild during pruning. * @@ -1791,7 +1791,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-prune-count} */ - getPruneCount: (guildId: BigString, options?: GetGuildPruneCountQuery) => Promise> + getPruneCount: (guildId: BigString, options?: GetGuildPruneCountQuery) => Promise /** * Gets the list of public archived threads for a channel. * @@ -1809,7 +1809,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#list-public-archived-threads} */ - getPublicArchivedThreads: (channelId: BigString, options?: ListArchivedThreads) => Promise> + getPublicArchivedThreads: (channelId: BigString, options?: ListArchivedThreads) => Promise /** * Gets the list of roles for a guild. * @@ -1821,7 +1821,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-roles} */ - getRoles: (guildId: BigString) => Promise> + getRoles: (guildId: BigString) => Promise /** * Gets a scheduled event by its ID. * @@ -1832,7 +1832,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event} */ - getScheduledEvent: (guildId: BigString, eventId: BigString, options?: { withUserCount?: boolean }) => Promise> + getScheduledEvent: (guildId: BigString, eventId: BigString, options?: { withUserCount?: boolean }) => Promise /** * Gets the list of scheduled events for a guild. * @@ -1842,7 +1842,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild} */ - getScheduledEvents: (guildId: BigString, options?: GetScheduledEvents) => Promise> + getScheduledEvents: (guildId: BigString, options?: GetScheduledEvents) => Promise /** * Gets the list of subscribers to a scheduled event from a guild. * @@ -1862,49 +1862,49 @@ export interface RestManager { guildId: BigString, eventId: BigString, options?: GetScheduledEventUsers, - ) => Promise; member?: Camelize }>> + ) => Promise> /** Get the bots Gateway metadata that can help during the operation of large or sharded bots. */ - getSessionInfo: () => Promise> + getSessionInfo: () => Promise /** * Gets the stage instance associated with a stage channel, if one exists. * * @param channelId - The ID of the stage channel the stage instance is associated with. - * @returns An instance of {@link DiscordStageInstance}. + * @returns An instance of {@link CamelizedDiscordStageInstance}. * * @see {@link https://discord.com/developers/docs/resources/stage-instance#get-stage-instance} */ - getStageInstance: (channelId: BigString) => Promise> + getStageInstance: (channelId: BigString) => Promise /** * Returns a sticker object for the given sticker ID. * * @param stickerId The ID of the sticker to get - * @returns A {@link DiscordSticker} + * @returns A {@link CamelizedDiscordSticker} * * @see {@link https://discord.com/developers/docs/resources/sticker#get-sticker} */ - getSticker: (stickerId: BigString) => Promise> + getSticker: (stickerId: BigString) => Promise /** * Gets a thread member by their user ID. * * @param channelId - The ID of the thread to get the thread member of. * @param userId - The user ID of the thread member to get. - * @returns An instance of {@link DiscordThreadMember}. + * @returns An instance of {@link CamelizedDiscordThreadMember}. * * @see {@link https://discord.com/developers/docs/resources/channel#get-thread-member} */ - getThreadMember: (channelId: BigString, userId: BigString) => Promise> + getThreadMember: (channelId: BigString, userId: BigString) => Promise /** * Gets the list of thread members for a thread. * * @param channelId - The ID of the thread to get the thread members of. - * @returns A collection of {@link DiscordThreadMember} assorted by user ID. + * @returns A collection of {@link CamelizedDiscordThreadMember} assorted by user ID. * * @remarks * Requires the application to have the `GUILD_MEMBERS` privileged intent enabled. * * @see {@link https://discord.com/developers/docs/resources/channel#list-thread-members} */ - getThreadMembers: (channelId: BigString) => Promise> + getThreadMembers: (channelId: BigString) => Promise /** * Gets the list of users that reacted with an emoji to a message. * @@ -1916,14 +1916,14 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#get-reactions} */ - getReactions: (channelId: BigString, messageId: BigString, reaction: string, options?: GetReactions) => Promise> + getReactions: (channelId: BigString, messageId: BigString, reaction: string, options?: GetReactions) => Promise /** * Get a user's data from the api * * @param id The user's id - * @returns {Camelize} + * @returns {CamelizedDiscordUser} */ - getUser: (id: BigString) => Promise> + getUser: (id: BigString) => Promise /** * Gets information about the vanity url of a guild. * @@ -1937,7 +1937,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-vanity-url} */ - getVanityUrl: (guildId: BigString) => Promise> + getVanityUrl: (guildId: BigString) => Promise /** * Gets the list of voice regions for a guild. * @@ -1946,19 +1946,19 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-voice-regions} */ - getVoiceRegions: (guildId: BigString) => Promise> + getVoiceRegions: (guildId: BigString) => Promise /** * Gets a webhook by its ID. * * @param webhookId - The ID of the webhook to get. - * @returns An instance of {@link DiscordWebhook}. + * @returns An instance of {@link CamelizedDiscordWebhook}. * * @remarks * Requires the `MANAGE_WEBHOOKS` permission. * * @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook} */ - getWebhook: (webhookId: BigString) => Promise> + getWebhook: (webhookId: BigString) => Promise /** * Gets a webhook message by its ID. * @@ -1966,7 +1966,7 @@ export interface RestManager { * @param token - The webhook token, used to get webhook messages. * @param messageId - the ID of the webhook message to get. * @param options - The parameters for the fetching of the message. - * @returns An instance of {@link DiscordMessage}. + * @returns An instance of {@link CamelizedDiscordMessage}. * * @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook-message} */ @@ -1975,17 +1975,17 @@ export interface RestManager { token: string, messageId: BigString, options?: GetWebhookMessageOptions, - ) => Promise> + ) => Promise /** * Gets a webhook using the webhook token, thereby bypassing the need for authentication + permissions. * * @param webhookId - The ID of the webhook to get. * @param token - The webhook token, used to get the webhook. - * @returns An instance of {@link DiscordWebhook}. + * @returns An instance of {@link CamelizedDiscordWebhook}. * * @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook-with-token} */ - getWebhookWithToken: (webhookId: BigString, token: string) => Promise> + getWebhookWithToken: (webhookId: BigString, token: string) => Promise /** * Gets the welcome screen for a guild. * @@ -1998,7 +1998,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen} */ - getWelcomeScreen: (guildId: BigString) => Promise> + getWelcomeScreen: (guildId: BigString) => Promise /** * Gets the guild widget by guild ID. * @@ -2007,7 +2007,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget} */ - getWidget: (guildId: BigString) => Promise> + getWidget: (guildId: BigString) => Promise /** * Gets the settings of a guild's widget. * @@ -2019,7 +2019,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-settings} */ - getWidgetSettings: (guildId: BigString) => Promise> + getWidgetSettings: (guildId: BigString) => Promise /** * Adds the bot user to a thread. * @@ -2074,7 +2074,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#crosspost-message} */ - publishMessage: (channelId: BigString, messageId: BigString) => Promise> + publishMessage: (channelId: BigString, messageId: BigString) => Promise /** * Removes a role from a member. * @@ -2112,7 +2112,7 @@ export interface RestManager { * * @param channelId - The ID of the channel to send the message in. * @param options - The parameters for the creation of the message. - * @returns An instance of the created {@link DiscordMessage}. + * @returns An instance of the created {@link CamelizedDiscordMessage}. * * @remarks * Requires that the bot user be able to see the contents of the channel the message is to be sent in. @@ -2133,7 +2133,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#create-message} */ - sendMessage: (channelId: BigString, options: CreateMessageOptions) => Promise> + sendMessage: (channelId: BigString, options: CreateMessageOptions) => Promise /** * Sends a follow-up message to an interaction. * @@ -2154,7 +2154,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message} */ - sendFollowupMessage: (token: string, options: InteractionCallbackData) => Promise> + sendFollowupMessage: (token: string, options: InteractionCallbackData) => Promise /** * Sends a response to an interaction. * @@ -2196,13 +2196,13 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-from-message} */ - startThreadWithMessage: (channelId: BigString, messageId: BigString, options: StartThreadWithMessage) => Promise> + startThreadWithMessage: (channelId: BigString, messageId: BigString, options: StartThreadWithMessage) => Promise /** * Creates a thread without using a message as the thread's point of origin. * * @param channelId - The ID of the channel in which to create the thread. * @param options - The parameters to use for the creation of the thread. - * @returns An instance of the created {@link DiscordChannel | Thread}. + * @returns An instance of the created {@link CamelizedDiscordChannel | Thread}. * * @remarks * Creating a private thread requires the server to be boosted. @@ -2211,7 +2211,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-without-message} */ - startThreadWithoutMessage: (channelId: BigString, options: StartThreadWithoutMessage) => Promise> + startThreadWithoutMessage: (channelId: BigString, options: StartThreadWithoutMessage) => Promise /** * Synchronises a template with the current state of a guild. * @@ -2225,7 +2225,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-templates} */ - syncGuildTemplate: (guildId: BigString) => Promise> + syncGuildTemplate: (guildId: BigString) => Promise /** * Triggers a typing indicator for the bot user. * @@ -2252,7 +2252,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands} */ - upsertGlobalApplicationCommands: (commands: CreateApplicationCommand[]) => Promise> + upsertGlobalApplicationCommands: (commands: CreateApplicationCommand[]) => Promise /** * Re-registers the list of application commands registered in a guild, overwriting the previous commands completely. * @@ -2267,7 +2267,7 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands} */ - upsertGuildApplicationCommands: (guildId: BigString, commands: CreateApplicationCommand[]) => Promise> + upsertGuildApplicationCommands: (guildId: BigString, commands: CreateApplicationCommand[]) => Promise /** * Bans a user from a guild. * @@ -2289,14 +2289,14 @@ export interface RestManager { * * @param guildId - The ID of the guild to edit the nickname of the bot user in. * @param options - The parameters for the edit of the nickname. - * @returns An instance of the edited {@link DiscordMember} + * @returns An instance of the edited {@link CamelizedDiscordMember} * * @remarks * Fires a _Guild Member Update_ gateway event. * * @see {@link https://discord.com/developers/docs/resources/guild#modify-current-member} */ - editBotMember: (guildId: BigString, options: EditBotMemberOptions) => Promise> + editBotMember: (guildId: BigString, options: EditBotMemberOptions) => Promise /** * Edits a member's properties. * @@ -2312,24 +2312,24 @@ export interface RestManager { * * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-member} */ - editMember: (guildId: BigString, userId: BigString, options: ModifyGuildMember) => Promise> + editMember: (guildId: BigString, userId: BigString, options: ModifyGuildMember) => Promise /** * Gets the member object by user ID. * * @param guildId - The ID of the guild to get the member object for. * @param userId - The ID of the user to get the member object for. - * @returns An instance of {@link DiscordMemberWithUser}. + * @returns An instance of {@link CamelizedDiscordMemberWithUser}. * * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-member} */ - getMember: (guildId: BigString, userId: BigString) => Promise> + getMember: (guildId: BigString, userId: BigString) => Promise /** * Gets the list of members for a guild. * * @param guildId - The ID of the guild to get the list of members for. * @param options - The parameters for the fetching of the members. - * @returns A collection of {@link DiscordMemberWithUser} objects assorted by user ID. + * @returns A collection of {@link CamelizedDiscordMemberWithUser} objects assorted by user ID. * * @remarks * Requires the `GUILD_MEMBERS` intent. @@ -2342,7 +2342,7 @@ export interface RestManager { * @see {@link https://discord.com/developers/docs/topics/gateway#request-guild-members} * @see {@link https://discord.com/developers/docs/topics/rate-limits#rate-limits} */ - getMembers: (guildId: BigString, options: ListGuildMembers) => Promise> + getMembers: (guildId: BigString, options: ListGuildMembers) => Promise /** * Kicks a member from a guild. @@ -2404,11 +2404,11 @@ export interface RestManager { * @param guildId - The ID of the guild to search in. * @param query - The string to match usernames or nicknames against. * @param options - The parameters for searching through the members. - * @returns A collection of {@link DiscordMember} objects assorted by user ID. + * @returns A collection of {@link CamelizedDiscordMember} objects assorted by user ID. * * @see {@link https://discord.com/developers/docs/resources/guild#search-guild-members} */ - searchMembers: (guildId: BigString, query: string, options?: Omit) => Promise> + searchMembers: (guildId: BigString, query: string, options?: Omit) => Promise /** * Unbans a user from a guild. * @@ -2501,7 +2501,7 @@ export interface WebhookMessageEditor { * @param token - The webhook token, used to edit the message. * @param messageId - The ID of the message to edit. * @param options - The parameters for the edit of the message. - * @returns An instance of the edited {@link DiscordMessage}. + * @returns An instance of the edited {@link CamelizedDiscordMessage}. * * @remarks * Fires a _Message Update_ gateway event. @@ -2509,7 +2509,7 @@ export interface WebhookMessageEditor { * @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook-message} */ (webhookId: BigString, token: string, messageId: BigString, options: InteractionCallbackData & { threadId?: BigString }): Promise< - Camelize + CamelizedDiscordMessage > /** * Edits the original webhook message. @@ -2517,14 +2517,14 @@ export interface WebhookMessageEditor { * @param webhookId - The ID of the webhook to edit the original message of. * @param token - The webhook token, used to edit the message. * @param options - The parameters for the edit of the message. - * @returns An instance of the edited {@link DiscordMessage}. + * @returns An instance of the edited {@link CamelizedDiscordMessage}. * * @remarks * Fires a _Message Update_ gateway event. * * @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook-message} */ - original: (webhookId: BigString, token: string, options: InteractionCallbackData & { threadId?: BigString }) => Promise> + original: (webhookId: BigString, token: string, options: InteractionCallbackData & { threadId?: BigString }) => Promise } export interface RestRequestResponse { diff --git a/packages/types/src/camel.ts b/packages/types/src/camel.ts new file mode 100644 index 000000000..08eaacc58 --- /dev/null +++ b/packages/types/src/camel.ts @@ -0,0 +1,294 @@ +import type { + DiscordActionRow, + DiscordActiveThreads, + DiscordActivity, + DiscordActivityAssets, + DiscordActivityButton, + DiscordActivityEmoji, + DiscordActivityParty, + DiscordActivitySecrets, + DiscordActivityTimestamps, + DiscordAllowedMentions, + DiscordApplication, + DiscordApplicationCommand, + DiscordApplicationCommandOption, + DiscordApplicationCommandOptionChoice, + DiscordApplicationCommandPermissions, + DiscordApplicationWebhook, + DiscordArchivedThreads, + DiscordAttachment, + DiscordAuditLog, + DiscordAuditLogChange, + DiscordAuditLogEntry, + DiscordAutoModerationAction, + DiscordAutoModerationActionExecution, + DiscordAutoModerationActionMetadata, + DiscordAutoModerationRule, + DiscordAutoModerationRuleTriggerMetadata, + DiscordBan, + DiscordButtonComponent, + DiscordChannel, + DiscordChannelMention, + DiscordChannelPinsUpdate, + DiscordClientStatus, + DiscordCreateApplicationCommand, + DiscordCreateForumPostWithMessage, + DiscordCreateGuildChannel, + DiscordCreateGuildEmoji, + DiscordCreateMessage, + DiscordCreateWebhook, + DiscordDefaultReactionEmoji, + DiscordEditChannelPermissionOverridesOptions, + DiscordEmbed, + DiscordEmbedAuthor, + DiscordEmbedField, + DiscordEmbedFooter, + DiscordEmbedImage, + DiscordEmbedProvider, + DiscordEmbedThumbnail, + DiscordEmbedVideo, + DiscordEmoji, + DiscordFollowAnnouncementChannel, + DiscordFollowedChannel, + DiscordForumTag, + DiscordGatewayPayload, + DiscordGetGatewayBot, + DiscordGuild, + DiscordGuildApplicationCommandPermissions, + DiscordGuildBanAddRemove, + DiscordGuildEmojisUpdate, + DiscordGuildIntegrationsUpdate, + DiscordGuildMemberAdd, + DiscordGuildMemberRemove, + DiscordGuildMemberUpdate, + DiscordGuildMembersChunk, + DiscordGuildPreview, + DiscordGuildRoleCreate, + DiscordGuildRoleDelete, + DiscordGuildRoleUpdate, + DiscordGuildStickersUpdate, + DiscordGuildWidget, + DiscordGuildWidgetSettings, + DiscordHello, + DiscordIncomingWebhook, + DiscordInputTextComponent, + DiscordInstallParams, + DiscordIntegration, + DiscordIntegrationAccount, + DiscordIntegrationApplication, + DiscordIntegrationCreateUpdate, + DiscordIntegrationDelete, + DiscordInteraction, + DiscordInteractionData, + DiscordInteractionDataOption, + DiscordInteractionMember, + DiscordInvite, + DiscordInviteCreate, + DiscordInviteDelete, + DiscordInviteMetadata, + DiscordInviteStageInstance, + DiscordListActiveThreads, + DiscordListArchivedThreads, + DiscordMember, + DiscordMemberWithUser, + DiscordMessage, + DiscordMessageActivity, + DiscordMessageComponents, + DiscordMessageDelete, + DiscordMessageDeleteBulk, + DiscordMessageInteraction, + DiscordMessageReactionAdd, + DiscordMessageReactionRemove, + DiscordMessageReactionRemoveAll, + DiscordMessageReactionRemoveEmoji, + DiscordMessageReference, + DiscordModifyChannel, + DiscordModifyGuildChannelPositions, + DiscordModifyGuildEmoji, + DiscordModifyGuildWelcomeScreen, + DiscordOptionalAuditEntryInfo, + DiscordOverwrite, + DiscordPresenceUpdate, + DiscordPrunedCount, + DiscordReaction, + DiscordReady, + DiscordRole, + DiscordRoleTags, + DiscordScheduledEvent, + DiscordScheduledEventEntityMetadata, + DiscordScheduledEventUserAdd, + DiscordScheduledEventUserRemove, + DiscordSelectMenuComponent, + DiscordSelectOption, + DiscordSessionStartLimit, + DiscordStageInstance, + DiscordSticker, + DiscordStickerItem, + DiscordStickerPack, + DiscordTeam, + DiscordTeamMember, + DiscordTemplate, + DiscordThreadListSync, + DiscordThreadMember, + DiscordThreadMemberUpdate, + DiscordThreadMembersUpdate, + DiscordThreadMetadata, + DiscordTypingStart, + DiscordUnavailableGuild, + DiscordUser, + DiscordVanityUrl, + DiscordVoiceRegion, + DiscordVoiceServerUpdate, + DiscordVoiceState, + DiscordWebhook, + DiscordWebhookUpdate, + DiscordWelcomeScreen, + DiscordWelcomeScreenChannel, +} from './discord.js' +import type { Camelize } from './shared.js' + +export interface CamelizedDiscordUser extends Camelize {} +export interface CamelizedDiscordIntegration extends Camelize {} +export interface CamelizedDiscordIntegrationAccount extends Camelize {} +export interface CamelizedDiscordIntegrationApplication extends Camelize {} +export interface CamelizedDiscordIntegrationCreateUpdate extends Camelize {} +export interface CamelizedDiscordIntegrationDelete extends Camelize {} +export interface CamelizedDiscordGuildIntegrationsUpdate extends Camelize {} +export interface CamelizedDiscordTypingStart extends Camelize {} +export interface CamelizedDiscordMember extends Camelize {} +export interface CamelizedDiscordApplication extends Camelize {} +export interface CamelizedDiscordTeam extends Camelize {} +export interface CamelizedDiscordTeamMember extends Camelize {} +export interface CamelizedDiscordWebhookUpdate extends Camelize {} +export interface CamelizedDiscordAllowedMentions extends Camelize {} +export interface CamelizedDiscordEmbed extends Camelize {} +export interface CamelizedDiscordEmbedAuthor extends Camelize {} +export interface CamelizedDiscordEmbedField extends Camelize {} +export interface CamelizedDiscordEmbedFooter extends Camelize {} +export interface CamelizedDiscordEmbedImage extends Camelize {} +export interface CamelizedDiscordEmbedProvider extends Camelize {} +export interface CamelizedDiscordEmbedThumbnail extends Camelize {} +export interface CamelizedDiscordEmbedVideo extends Camelize {} +export interface CamelizedDiscordAttachment extends Camelize {} +export type CamelizedDiscordWebhook = Camelize +export interface CamelizedDiscordIncomingWebhook extends Camelize {} +export interface CamelizedDiscordApplicationWebhook extends Camelize {} +export interface CamelizedDiscordGuild extends Camelize {} +export interface CamelizedDiscordRole extends Camelize {} +export interface CamelizedDiscordRoleTags extends Camelize {} +export interface CamelizedDiscordEmoji extends Camelize {} +export interface CamelizedDiscordVoiceState extends Camelize {} +export interface CamelizedDiscordChannel extends Camelize {} +export interface CamelizedDiscordPresenceUpdate extends Camelize {} +export interface CamelizedDiscordWelcomeScreen extends Camelize {} +export interface CamelizedDiscordWelcomeScreenChannel extends Camelize {} +export interface CamelizedDiscordStageInstance extends Camelize {} +export interface CamelizedDiscordThreadMetadata extends Camelize {} +export interface CamelizedDiscordThreadMember extends Camelize {} +export interface CamelizedDiscordActivity extends Camelize {} +export interface CamelizedDiscordClientStatus extends Camelize {} +export interface CamelizedDiscordActivityTimestamps extends Camelize {} +export interface CamelizedDiscordActivityEmoji extends Camelize {} +export interface CamelizedDiscordActivityParty extends Camelize {} +export interface CamelizedDiscordActivityAssets extends Camelize {} +export interface CamelizedDiscordActivitySecrets extends Camelize {} +export interface CamelizedDiscordActivityButton extends Camelize {} +export interface CamelizedDiscordOverwrite extends Camelize {} +export interface CamelizedDiscordMemberWithUser extends Camelize {} +export interface CamelizedDiscordMessage extends Camelize {} +export interface CamelizedDiscordChannelMention extends Camelize {} +export interface CamelizedDiscordReaction extends Camelize {} +export interface CamelizedDiscordMessageActivity extends Camelize {} +export interface CamelizedDiscordMessageReference extends Camelize {} +export interface CamelizedDiscordSticker extends Camelize {} +export interface CamelizedDiscordMessageInteraction extends Camelize {} +export type CamelizedDiscordMessageComponents = Camelize +export interface CamelizedDiscordActionRow extends Camelize {} +export interface CamelizedDiscordSelectMenuComponent extends Camelize {} +export interface CamelizedDiscordSelectOption extends Camelize {} +export interface CamelizedDiscordButtonComponent extends Camelize {} +export interface CamelizedDiscordInputTextComponent extends Camelize {} +export interface CamelizedDiscordStickerItem extends Camelize {} +export interface CamelizedDiscordStickerPack extends Camelize {} +export interface CamelizedDiscordInteraction extends Camelize {} +export interface CamelizedDiscordInteractionMember extends Camelize {} +export interface CamelizedDiscordInteractionData extends Camelize {} +export interface CamelizedDiscordInteractionDataOption extends Camelize {} +export interface CamelizedDiscordListActiveThreads extends Camelize {} +export interface CamelizedDiscordListArchivedThreads extends Camelize {} +export interface CamelizedDiscordThreadListSync extends Camelize {} +export interface CamelizedDiscordAuditLog extends Camelize {} +export interface CamelizedDiscordAutoModerationRule extends Camelize {} +export interface CamelizedDiscordAutoModerationRuleTriggerMetadata extends Camelize {} +export interface CamelizedDiscordAutoModerationAction extends Camelize {} +export interface CamelizedDiscordAutoModerationActionMetadata extends Camelize {} +export interface CamelizedDiscordAutoModerationActionExecution extends Camelize {} +export interface CamelizedDiscordAuditLogEntry extends Camelize {} +export type CamelizedDiscordAuditLogChange = Camelize +export interface CamelizedDiscordOptionalAuditEntryInfo extends Camelize {} +export interface CamelizedDiscordScheduledEvent extends Camelize {} +export interface CamelizedDiscordScheduledEventEntityMetadata extends Camelize {} +export interface CamelizedDiscordGetGatewayBot extends Camelize {} +export interface CamelizedDiscordSessionStartLimit extends Camelize {} +export interface CamelizedDiscordInviteMetadata extends Camelize {} +export interface CamelizedDiscordInvite extends Camelize {} +export interface CamelizedDiscordInviteStageInstance extends Camelize {} +export interface CamelizedDiscordApplicationCommand extends Camelize {} +export interface CamelizedDiscordCreateApplicationCommand extends Camelize {} +export interface CamelizedDiscordApplicationCommandOption extends Camelize {} +export interface CamelizedDiscordApplicationCommandOptionChoice extends Camelize {} +export interface CamelizedDiscordGuildApplicationCommandPermissions extends Camelize {} +export interface CamelizedDiscordApplicationCommandPermissions extends Camelize {} +export interface CamelizedDiscordGuildWidget extends Camelize {} +export interface CamelizedDiscordGuildPreview extends Camelize {} +export interface CamelizedDiscordFollowedChannel extends Camelize {} +export interface CamelizedDiscordGatewayPayload extends Camelize {} +export interface CamelizedDiscordGuildMembersChunk extends Camelize {} +export interface CamelizedDiscordChannelPinsUpdate extends Camelize {} +export interface CamelizedDiscordGuildRoleDelete extends Camelize {} +export interface CamelizedDiscordGuildBanAddRemove extends Camelize {} +export interface CamelizedDiscordMessageReactionRemove extends Camelize {} +export interface CamelizedDiscordMessageReactionAdd extends Camelize {} +export interface CamelizedDiscordVoiceServerUpdate extends Camelize {} +export interface CamelizedDiscordInviteCreate extends Camelize {} +export interface CamelizedDiscordHello extends Camelize {} +export interface CamelizedDiscordReady extends Camelize {} +export interface CamelizedDiscordUnavailableGuild extends Camelize {} +export interface CamelizedDiscordMessageDeleteBulk extends Camelize {} +export interface CamelizedDiscordTemplate extends Camelize {} +export interface CamelizedDiscordGuildMemberAdd extends Camelize {} +export interface CamelizedDiscordMessageDelete extends Camelize {} +export interface CamelizedDiscordThreadMembersUpdate extends Camelize {} +export interface CamelizedDiscordThreadMemberUpdate extends Camelize {} +export interface CamelizedDiscordGuildRoleCreate extends Camelize {} +export interface CamelizedDiscordGuildEmojisUpdate extends Camelize {} +export interface CamelizedDiscordGuildStickersUpdate extends Camelize {} +export interface CamelizedDiscordGuildMemberUpdate extends Camelize {} +export interface CamelizedDiscordMessageReactionRemoveAll extends Camelize {} +export interface CamelizedDiscordGuildRoleUpdate extends Camelize {} +export interface CamelizedDiscordScheduledEventUserAdd extends Camelize {} +export type CamelizedDiscordMessageReactionRemoveEmoji = Camelize +export interface CamelizedDiscordGuildMemberRemove extends Camelize {} +export interface CamelizedDiscordBan extends Camelize {} +export interface CamelizedDiscordScheduledEventUserRemove extends Camelize {} +export interface CamelizedDiscordInviteDelete extends Camelize {} +export interface CamelizedDiscordVoiceRegion extends Camelize {} +export interface CamelizedDiscordGuildWidgetSettings extends Camelize {} +export interface CamelizedDiscordInstallParams extends Camelize {} +export interface CamelizedDiscordForumTag extends Camelize {} +export interface CamelizedDiscordDefaultReactionEmoji extends Camelize {} +export interface CamelizedDiscordModifyChannel extends Camelize {} +export interface CamelizedDiscordCreateGuildEmoji extends Camelize {} +export interface CamelizedDiscordModifyGuildEmoji extends Camelize {} +export interface CamelizedDiscordCreateGuildChannel extends Camelize {} +export interface CamelizedDiscordCreateMessage extends Camelize {} +export interface CamelizedDiscordModifyGuildWelcomeScreen extends Camelize {} +export interface CamelizedDiscordFollowAnnouncementChannel extends Camelize {} +export interface CamelizedDiscordEditChannelPermissionOverridesOptions extends Camelize {} +export interface CamelizedDiscordModifyGuildChannelPositions extends Camelize {} +export interface CamelizedDiscordCreateWebhook extends Camelize {} +export interface CamelizedDiscordCreateForumPostWithMessage extends Camelize {} +export type CamelizedDiscordArchivedThreads = Camelize +export interface CamelizedDiscordActiveThreads extends Camelize {} +export interface CamelizedDiscordVanityUrl extends Camelize {} +export interface CamelizedDiscordPrunedCount extends Camelize {} diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts index 6bcbb2929..7b8ddd37f 100644 --- a/packages/types/src/index.ts +++ b/packages/types/src/index.ts @@ -1,3 +1,4 @@ +export * from './camel.js' export * from './discord.js' export * from './discordeno.js' -export * from './shared.js' +export * from './shared.js' \ No newline at end of file