Skip to main content

BotHelpers

@discordeno/bot • Docs

Documentation / @discordeno/bot / BotHelpers

Interface: BotHelpers<TProps, TBehavior, TBot>

Type Parameters​

• TProps extends TransformersDesiredProperties

• TBehavior extends DesiredPropertiesBehavior

• TBot extends Bot<TProps, TBehavior> = Bot<TProps, TBehavior>

Properties​

addDmRecipient()​

addDmRecipient: (channelId, userId, options) => Promise<void>

Parameters​

• channelId: BigString

• userId: BigString

• options: AddDmRecipientOptions

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1070

addGuildMember()​

addGuildMember: (guildId, userId, options) => Promise<void>

Parameters​

• guildId: BigString

• userId: BigString

• options: AddGuildMemberOptions

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1071

addReaction()​

addReaction: (channelId, messageId, reaction) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• reaction: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1066

addReactions()​

addReactions: (channelId, messageId, reactions, ordered?) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• reactions: string[]

• ordered?: boolean

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1067

addRole()​

addRole: (guildId, userId, roleId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• userId: BigString

• roleId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1068

addThreadMember()​

addThreadMember: (channelId, userId) => Promise<void>

Parameters​

• channelId: BigString

• userId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1069

banMember()​

banMember: (guildId, userId, options?, reason?) => Promise<void>

Parameters​

• guildId: BigString

• userId: BigString

• options?: CreateGuildBan

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1116

bulkBanMembers()​

bulkBanMembers: (guildId, options, reason?) => Promise<object>

Parameters​

• guildId: BigString

• options: CreateGuildBulkBan

• reason?: string

Returns​

Promise<object>

bannedUsers​

bannedUsers: bigint[]

failedUsers​

failedUsers: bigint[]

Defined in​

packages/bot/src/helpers.ts:1063

createApplicationEmoji()​

createApplicationEmoji: (options) => Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Parameters​

• options: CreateApplicationEmoji

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Defined in​

packages/bot/src/helpers.ts:807

createAutomodRule()​

createAutomodRule: (guildId, options, reason?) => Promise<AutoModerationRule>

Parameters​

• guildId: BigString

• options: CreateAutoModerationRuleOptions

• reason?: string

Returns​

Promise<AutoModerationRule>

Defined in​

packages/bot/src/helpers.ts:804

createChannel()​

createChannel: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• guildId: BigString

• options: CreateGuildChannel

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:805

createEmoji()​

createEmoji: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Parameters​

• guildId: BigString

• options: CreateGuildEmoji

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Defined in​

packages/bot/src/helpers.ts:806

createForumThread()​

createForumThread: (channelId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• channelId: BigString

• options: CreateForumPostWithMessage

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:808

createGlobalApplicationCommand()​

createGlobalApplicationCommand: (command, options?) => Promise<ApplicationCommand>

Parameters​

• command: CreateApplicationCommand

• options?: CreateGlobalApplicationCommandOptions

Returns​

Promise<ApplicationCommand>

Defined in​

packages/bot/src/helpers.ts:813

createGuild()​

createGuild: (options) => Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Parameters​

• options: CreateGuild

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Defined in​

packages/bot/src/helpers.ts:814

createGuildApplicationCommand()​

createGuildApplicationCommand: (command, guildId, options?) => Promise<ApplicationCommand>

Parameters​

• command: CreateApplicationCommand

• guildId: BigString

• options?: CreateGuildApplicationCommandOptions

Returns​

Promise<ApplicationCommand>

Defined in​

packages/bot/src/helpers.ts:815

createGuildFromTemplate()​

createGuildFromTemplate: (templateCode, options) => Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Parameters​

• templateCode: string

• options: CreateGuildFromTemplate

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Defined in​

packages/bot/src/helpers.ts:820

createGuildSoundboardSound()​

createGuildSoundboardSound: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"]>

Parameters​

• guildId: BigString

• options: CreateGuildSoundboardSound

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"]>

Defined in​

packages/bot/src/helpers.ts:1140

createGuildSticker()​

createGuildSticker: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Parameters​

• guildId: BigString

• options: CreateGuildStickerOptions

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Defined in​

packages/bot/src/helpers.ts:821

createGuildTemplate()​

createGuildTemplate: (guildId, options) => Promise<Template>

Parameters​

• guildId: BigString

• options: CreateTemplate

Returns​

Promise<Template>

Defined in​

packages/bot/src/helpers.ts:826

createInvite()​

createInvite: (channelId, options?, reason?) => Promise<object>

Parameters​

• channelId: BigString

• options?: CreateChannelInvite

• reason?: string

Returns​

Promise<object>

approximateMemberCount​

approximateMemberCount: undefined | number

approximatePresenceCount​

approximatePresenceCount: undefined | number

channel​

channel: null | object

code​

code: string

expiresAt​

expiresAt: undefined | null | string

guild​

guild: undefined | object

guildScheduledEvent​

guildScheduledEvent: undefined | object

inviter​

inviter: undefined | object

stageInstance​

stageInstance: undefined | object

targetApplication​

targetApplication: undefined | object

targetType​

targetType: undefined | TargetTypes

targetUser​

targetUser: undefined | object

type​

type: DiscordInviteType

Defined in​

packages/bot/src/helpers.ts:827

createRole()​

createRole: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["role"]>

Parameters​

• guildId: BigString

• options: CreateGuildRole

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["role"]>

Defined in​

packages/bot/src/helpers.ts:828

createScheduledEvent()​

createScheduledEvent: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"]>

Parameters​

• guildId: BigString

• options: CreateScheduledEvent

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"]>

Defined in​

packages/bot/src/helpers.ts:829

createStageInstance()​

createStageInstance: (options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["stageInstance"]>

Parameters​

• options: CreateStageInstance

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["stageInstance"]>

Defined in​

packages/bot/src/helpers.ts:834

createTestEntitlement()​

createTestEntitlement: (applicationId, body) => Promise<Partial<TBot["transformers"]["$inferredTypes"]["entitlement"]>>

Parameters​

• applicationId: BigString

• body: CreateEntitlement

Returns​

Promise<Partial<TBot["transformers"]["$inferredTypes"]["entitlement"]>>

Defined in​

packages/bot/src/helpers.ts:1128

createWebhook()​

createWebhook: (channelId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Parameters​

• channelId: BigString

• options: CreateWebhook

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Defined in​

packages/bot/src/helpers.ts:835

deleteApplicationEmoji()​

deleteApplicationEmoji: (id) => Promise<void>

Parameters​

• id: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1076

deleteAutomodRule()​

deleteAutomodRule: (guildId, ruleId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• ruleId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1072

deleteChannel()​

deleteChannel: (channelId, reason?) => Promise<void>

Parameters​

• channelId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1073

deleteChannelPermissionOverride()​

deleteChannelPermissionOverride: (channelId, overwriteId, reason?) => Promise<void>

Parameters​

• channelId: BigString

• overwriteId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1074

deleteEmoji()​

deleteEmoji: (guildId, id, reason?) => Promise<void>

Parameters​

• guildId: BigString

• id: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1075

deleteFollowupMessage()​

deleteFollowupMessage: (token, messageId) => Promise<void>

Parameters​

• token: string

• messageId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1077

deleteGlobalApplicationCommand()​

deleteGlobalApplicationCommand: (commandId) => Promise<void>

Parameters​

• commandId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1078

deleteGuild()​

deleteGuild: (guildId) => Promise<void>

Parameters​

• guildId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1079

deleteGuildApplicationCommand()​

deleteGuildApplicationCommand: (commandId, guildId) => Promise<void>

Parameters​

• commandId: BigString

• guildId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1080

deleteGuildSoundboardSound()​

deleteGuildSoundboardSound: (guildId, soundId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• soundId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1151

deleteGuildSticker()​

deleteGuildSticker: (guildId, stickerId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• stickerId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1081

deleteGuildTemplate()​

deleteGuildTemplate: (guildId, templateCode) => Promise<void>

Parameters​

• guildId: BigString

• templateCode: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1082

deleteIntegration()​

deleteIntegration: (guildId, integrationId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• integrationId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1083

deleteInvite()​

deleteInvite: (inviteCode, reason?) => Promise<void>

Parameters​

• inviteCode: string

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1084

deleteMessage()​

deleteMessage: (channelId, messageId, reason?) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1085

deleteMessages()​

deleteMessages: (channelId, messageIds, reason?) => Promise<void>

Parameters​

• channelId: BigString

• messageIds: BigString[]

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1086

deleteOriginalInteractionResponse()​

deleteOriginalInteractionResponse: (token) => Promise<void>

Parameters​

• token: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1087

deleteOwnReaction()​

deleteOwnReaction: (channelId, messageId, reaction) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• reaction: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1088

deleteReactionsAll()​

deleteReactionsAll: (channelId, messageId) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1089

deleteReactionsEmoji()​

deleteReactionsEmoji: (channelId, messageId, reaction) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• reaction: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1090

deleteRole()​

deleteRole: (guildId, roleId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• roleId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1091

deleteScheduledEvent()​

deleteScheduledEvent: (guildId, eventId) => Promise<void>

Parameters​

• guildId: BigString

• eventId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1092

deleteStageInstance()​

deleteStageInstance: (channelId, reason?) => Promise<void>

Parameters​

• channelId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1093

deleteTestEntitlement()​

deleteTestEntitlement: (applicationId, entitlementId) => Promise<void>

Parameters​

• applicationId: BigString

• entitlementId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1132

deleteUserReaction()​

deleteUserReaction: (channelId, messageId, userId, reaction) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• userId: BigString

• reaction: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1094

deleteWebhook()​

deleteWebhook: (webhookId, reason?) => Promise<void>

Parameters​

• webhookId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1095

deleteWebhookMessage()​

deleteWebhookMessage: (webhookId, token, messageId, options?) => Promise<void>

Parameters​

• webhookId: BigString

• token: string

• messageId: BigString

• options?: DeleteWebhookMessageOptions

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1096

deleteWebhookWithToken()​

deleteWebhookWithToken: (webhookId, token) => Promise<void>

Parameters​

• webhookId: BigString

• token: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1097

editApplicationCommandPermissions()​

editApplicationCommandPermissions: (guildId, commandId, bearerToken, options) => Promise<GuildApplicationCommandPermissions>

Parameters​

• guildId: BigString

• commandId: BigString

• bearerToken: string

• options: object[]

Returns​

Promise<GuildApplicationCommandPermissions>

Defined in​

packages/bot/src/helpers.ts:836

editApplicationEmoji()​

editApplicationEmoji: (id, options) => Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Parameters​

• id: BigString

• options: ModifyApplicationEmoji

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Defined in​

packages/bot/src/helpers.ts:856

editApplicationInfo()​

editApplicationInfo: (body) => Promise<Application>

Parameters​

• body: EditApplication

Returns​

Promise<Application>

Defined in​

packages/bot/src/helpers.ts:924

editAutomodRule()​

editAutomodRule: (guildId, ruleId, options, reason?) => Promise<AutoModerationRule>

Parameters​

• guildId: BigString

• ruleId: BigString

• options: Partial<EditAutoModerationRuleOptions>

• reason?: string

Returns​

Promise<AutoModerationRule>

Defined in​

packages/bot/src/helpers.ts:842

editBotMember()​

editBotMember: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Parameters​

• guildId: BigString

• options: EditBotMemberOptions

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Defined in​

packages/bot/src/helpers.ts:1047

editBotProfile()​

editBotProfile: (options) => Promise<TBot["transformers"]["$inferredTypes"]["user"]>

Parameters​

• options

• options.botAvatarURL?: null | string

• options.username?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["user"]>

Defined in​

packages/bot/src/helpers.ts:848

editChannel()​

editChannel: (channelId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• channelId: BigString

• options: ModifyChannel

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:849

editChannelPermissionOverrides()​

editChannelPermissionOverrides: (channelId, options, reason?) => Promise<void>

Parameters​

• channelId: BigString

• options: EditChannelPermissionOverridesOptions

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1098

editChannelPositions()​

editChannelPositions: (guildId, channelPositions) => Promise<void>

Parameters​

• guildId: BigString

• channelPositions: ModifyGuildChannelPositions[]

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1099

editEmoji()​

editEmoji: (guildId, id, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Parameters​

• guildId: BigString

• id: BigString

• options: ModifyGuildEmoji

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Defined in​

packages/bot/src/helpers.ts:850

editFollowupMessage()​

editFollowupMessage: (token, messageId, options) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• token: string

• messageId: BigString

• options: InteractionCallbackData

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:857

editGlobalApplicationCommand()​

editGlobalApplicationCommand: (commandId, options) => Promise<ApplicationCommand>

Parameters​

• commandId: BigString

• options: CreateApplicationCommand

Returns​

Promise<ApplicationCommand>

Defined in​

packages/bot/src/helpers.ts:862

editGuild()​

editGuild: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Parameters​

• guildId: BigString

• options: ModifyGuild

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Defined in​

packages/bot/src/helpers.ts:863

editGuildApplicationCommand()​

editGuildApplicationCommand: (commandId, guildId, options) => Promise<ApplicationCommand>

Parameters​

• commandId: BigString

• guildId: BigString

• options: CreateApplicationCommand

Returns​

Promise<ApplicationCommand>

Defined in​

packages/bot/src/helpers.ts:864

editGuildMfaLevel()​

editGuildMfaLevel: (guildId, mfaLevel, reason?) => Promise<void>

Parameters​

• guildId: BigString

• mfaLevel: MfaLevels

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1100

editGuildOnboarding()​

editGuildOnboarding: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["guildOnboarding"]>

Parameters​

• guildId: BigString

• options: EditGuildOnboarding

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["guildOnboarding"]>

Defined in​

packages/bot/src/helpers.ts:1122

editGuildSticker()​

editGuildSticker: (guildId, stickerId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Parameters​

• guildId: BigString

• stickerId: BigString

• options: AtLeastOne<EditGuildStickerOptions>

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Defined in​

packages/bot/src/helpers.ts:865

editGuildTemplate()​

editGuildTemplate: (guildId, templateCode, options) => Promise<Template>

Parameters​

• guildId: BigString

• templateCode: string

• options: ModifyGuildTemplate

Returns​

Promise<Template>

Defined in​

packages/bot/src/helpers.ts:871

editMember()​

editMember: (guildId, userId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Parameters​

• guildId: BigString

• userId: BigString

• options: ModifyGuildMember

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Defined in​

packages/bot/src/helpers.ts:1048

editMessage()​

editMessage: (channelId, messageId, options) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• channelId: BigString

• messageId: BigString

• options: EditMessage

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:872

editOriginalInteractionResponse()​

editOriginalInteractionResponse: (token, options) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• token: string

• options: InteractionCallbackData

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:873

editOriginalWebhookMessage()​

editOriginalWebhookMessage: (webhookId, token, options) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• webhookId: BigString

• token: string

• options: InteractionCallbackData & object

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:874

editOwnVoiceState()​

editOwnVoiceState: (guildId, options) => Promise<void>

Parameters​

• guildId: BigString

• options: EditOwnVoiceState

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1101

editRole()​

editRole: (guildId, roleId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["role"]>

Parameters​

• guildId: BigString

• roleId: BigString

• options: EditGuildRole

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["role"]>

Defined in​

packages/bot/src/helpers.ts:879

editRolePositions()​

editRolePositions: (guildId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["role"][]>

Parameters​

• guildId: BigString

• options: ModifyRolePositions[]

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["role"][]>

Defined in​

packages/bot/src/helpers.ts:885

editScheduledEvent()​

editScheduledEvent: (guildId, eventId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"]>

Parameters​

• guildId: BigString

• eventId: BigString

• options: Partial<EditScheduledEvent>

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"]>

Defined in​

packages/bot/src/helpers.ts:890

editStageInstance()​

editStageInstance: (channelId, topic, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["stageInstance"]>

Parameters​

• channelId: BigString

• topic: string

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["stageInstance"]>

Defined in​

packages/bot/src/helpers.ts:896

editUserApplicationRoleConnection()​

editUserApplicationRoleConnection: (bearerToken, applicationId, options) => Promise<object>

Parameters​

• bearerToken: string

• applicationId: BigString

• options

• options.metadata

• options.platformName: null | string

• options.platformUsername: null | string

Returns​

Promise<object>

metadata​

metadata: object

platformName​

platformName: null | string

platformUsername​

platformUsername: null | string

Defined in​

packages/bot/src/helpers.ts:911

editUserVoiceState()​

editUserVoiceState: (guildId, options) => Promise<void>

Parameters​

• guildId: BigString

• options: EditUserVoiceState

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1102

editWebhook()​

editWebhook: (webhookId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Parameters​

• webhookId: BigString

• options: ModifyWebhook

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Defined in​

packages/bot/src/helpers.ts:897

editWebhookMessage()​

editWebhookMessage: (webhookId, token, messageId, options) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• webhookId: BigString

• token: string

• messageId: BigString

• options: InteractionCallbackData & object

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:898

editWebhookWithToken()​

editWebhookWithToken: (webhookId, token, options) => Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Parameters​

• webhookId: BigString

• token: string

• options: Omit<ModifyWebhook, "channelId">

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Defined in​

packages/bot/src/helpers.ts:904

editWelcomeScreen()​

editWelcomeScreen: (guildId, options, reason?) => Promise<WelcomeScreen>

Parameters​

• guildId: BigString

• options

• options.description: undefined | null | string

• options.enabled?: undefined | null | boolean

• options.welcomeScreen?: undefined | null | object[]

• reason?: string

Returns​

Promise<WelcomeScreen>

Defined in​

packages/bot/src/helpers.ts:909

editWidgetSettings()​

editWidgetSettings: (guildId, options, reason?) => Promise<GuildWidgetSettings>

Parameters​

• guildId: BigString

• options

• options.channelId: null | string

• options.enabled?: boolean

• reason?: string

Returns​

Promise<GuildWidgetSettings>

Defined in​

packages/bot/src/helpers.ts:910

exchangeToken()​

exchangeToken: (clientId, clientSecret, options) => Promise<object>

Parameters​

• clientId: BigString

• clientSecret: string

• options: Camelize<DiscordTokenExchange>

Returns​

Promise<object>

accessToken​

accessToken: string

expiresIn​

expiresIn: number

guild​

guild: undefined | object

refreshToken​

refreshToken: string

scope​

scope: string

tokenType​

tokenType: string

webhook​

webhook: undefined | object

Defined in​

packages/bot/src/helpers.ts:926

executeWebhook()​

executeWebhook: (webhookId, token, options) => Promise<undefined | TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• webhookId: BigString

• token: string

• options: ExecuteWebhook

Returns​

Promise<undefined | TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:916

followAnnouncement()​

followAnnouncement: (sourceChannelId, targetChannelId) => Promise<object>

Parameters​

• sourceChannelId: BigString

• targetChannelId: BigString

Returns​

Promise<object>

channelId​

channelId: string

webhookId​

webhookId: string

Defined in​

packages/bot/src/helpers.ts:921

getActiveThreads()​

getActiveThreads: (guildId) => Promise<object>

Parameters​

• guildId: BigString

Returns​

Promise<object>

members​

members: ThreadMember[]

threads​

threads: TBot["transformers"]["$inferredTypes"]["channel"][]

Defined in​

packages/bot/src/helpers.ts:922

getApplicationActivityInstance()​

getApplicationActivityInstance: (applicationId, instanceId) => Promise<object>

Parameters​

• applicationId: BigString

• instanceId: string

Returns​

Promise<object>

applicationId​

applicationId: string

instanceId​

instanceId: string

launchId​

launchId: string

location​

location: object

location.channelId​

location.channelId: string

location.guildId​

location.guildId: undefined | null | string

location.id​

location.id: string

location.kind​

location.kind: DiscordActivityLocationKind

users​

users: string[]

Defined in​

packages/bot/src/helpers.ts:1064

getApplicationCommandPermission()​

getApplicationCommandPermission: (guildId, commandId, options?) => Promise<GuildApplicationCommandPermissions>

Parameters​

• guildId: BigString

• commandId: BigString

• options?: GetApplicationCommandPermissionOptions

Returns​

Promise<GuildApplicationCommandPermissions>

Defined in​

packages/bot/src/helpers.ts:928

getApplicationCommandPermissions()​

getApplicationCommandPermissions: (guildId, options?) => Promise<GuildApplicationCommandPermissions[]>

Parameters​

• guildId: BigString

• options?: GetApplicationCommandPermissionOptions

Returns​

Promise<GuildApplicationCommandPermissions[]>

Defined in​

packages/bot/src/helpers.ts:933

getApplicationEmoji()​

getApplicationEmoji: (emojiId) => Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Parameters​

• emojiId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Defined in​

packages/bot/src/helpers.ts:950

getApplicationEmojis()​

getApplicationEmojis: () => Promise<object>

Returns​

Promise<object>

items​

items: TBot["transformers"]["$inferredTypes"]["emoji"][]

Defined in​

packages/bot/src/helpers.ts:952

getApplicationInfo()​

getApplicationInfo: () => Promise<Application>

Returns​

Promise<Application>

Defined in​

packages/bot/src/helpers.ts:923

getAuditLog()​

getAuditLog: (guildId, options?) => Promise<object>

Parameters​

• guildId: BigString

• options?: GetGuildAuditLog

Returns​

Promise<object>

applicationCommands​

applicationCommands: object[]

auditLogEntries​

auditLogEntries: object[]

autoModerationRules​

autoModerationRules: undefined | object[]

guildScheduledEvents​

guildScheduledEvents: undefined | object[]

integrations​

integrations: object[]

threads​

threads: object[]

users​

users: object[]

webhooks​

webhooks: (object | object)[]

Defined in​

packages/bot/src/helpers.ts:937

getAutomodRule()​

getAutomodRule: (guildId, ruleId) => Promise<AutoModerationRule>

Parameters​

• guildId: BigString

• ruleId: BigString

Returns​

Promise<AutoModerationRule>

Defined in​

packages/bot/src/helpers.ts:938

getAutomodRules()​

getAutomodRules: (guildId) => Promise<AutoModerationRule[]>

Parameters​

• guildId: BigString

Returns​

Promise<AutoModerationRule[]>

Defined in​

packages/bot/src/helpers.ts:939

getAvailableVoiceRegions()​

getAvailableVoiceRegions: () => Promise<object[]>

Returns​

Promise<object[]>

Defined in​

packages/bot/src/helpers.ts:940

getBan()​

getBan: (guildId, userId) => Promise<object>

Parameters​

• guildId: BigString

• userId: BigString

Returns​

Promise<object>

reason​

reason: null | string

user​

user: object

user.accentColor​

user.accentColor: undefined | number

user.avatar​

user.avatar: null | string

user.avatarDecorationData​

user.avatarDecorationData: undefined | object

user.banner​

user.banner: undefined | string

user.bot​

user.bot: undefined | boolean

user.discriminator​

user.discriminator: string

user.email​

user.email: undefined | null | string

user.flags​

user.flags: undefined | number

user.globalName​

user.globalName: null | string

user.id​

user.id: string

user.locale​

user.locale: undefined | string

user.mfaEnabled​

user.mfaEnabled: undefined | boolean

user.premiumType​

user.premiumType: undefined | PremiumTypes

user.publicFlags​

user.publicFlags: undefined | number

user.system​

user.system: undefined | boolean

user.username​

user.username: string

user.verified​

user.verified: undefined | boolean

Defined in​

packages/bot/src/helpers.ts:941

getBans()​

getBans: (guildId, options?) => Promise<object[]>

Parameters​

• guildId: BigString

• options?: GetBans

Returns​

Promise<object[]>

Defined in​

packages/bot/src/helpers.ts:942

getChannel()​

getChannel: (channelId) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• channelId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:943

getChannelInvites()​

getChannelInvites: (channelId) => Promise<object[]>

Parameters​

• channelId: BigString

Returns​

Promise<object[]>

Defined in​

packages/bot/src/helpers.ts:944

getChannels()​

getChannels: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["channel"][]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"][]>

Defined in​

packages/bot/src/helpers.ts:945

getChannelWebhooks()​

getChannelWebhooks: (channelId) => Promise<TBot["transformers"]["$inferredTypes"]["webhook"][]>

Parameters​

• channelId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["webhook"][]>

Defined in​

packages/bot/src/helpers.ts:946

getCurrentAuthenticationInfo()​

getCurrentAuthenticationInfo: (bearerToken) => Promise<object>

Parameters​

• bearerToken: string

Returns​

Promise<object>

application​

application: object

application.approximateGuildCount​

application.approximateGuildCount: undefined | number

application.approximateUserInstallCount​

application.approximateUserInstallCount: undefined | number

application.bot​

application.bot: undefined | object

application.botPublic​

application.botPublic: boolean

application.botRequireCodeGrant​

application.botRequireCodeGrant: boolean

application.coverImage​

application.coverImage: undefined | string

application.customInstallUrl​

application.customInstallUrl: undefined | string

application.description​

application.description: string

application.eventWebhooksStatus​

application.eventWebhooksStatus: DiscordApplicationEventWebhookStatus

application.eventWebhooksTypes​

application.eventWebhooksTypes: undefined | DiscordWebhookEventType[]

application.eventWebhooksUrl​

application.eventWebhooksUrl: undefined | null | string

application.flags​

application.flags: undefined | ApplicationFlags

application.guild​

application.guild: undefined | object

application.guildId​

application.guildId: undefined | string

application.icon​

application.icon: null | string

application.id​

application.id: string

application.installParams​

application.installParams: undefined | object

application.integrationTypesConfig​

application.integrationTypesConfig: undefined | object

application.interactionsEndpointUrl​

application.interactionsEndpointUrl: undefined | null | string

application.name​

application.name: string

application.owner​

application.owner: undefined | object

application.primarySkuId​

application.primarySkuId: undefined | string

application.privacyPolicyUrl​

application.privacyPolicyUrl: undefined | string

application.redirectUris​

application.redirectUris: undefined | string[]

application.roleConnectionsVerificationUrl​

application.roleConnectionsVerificationUrl: undefined | null | string

application.rpcOrigins​

application.rpcOrigins: undefined | string[]

application.slug​

application.slug: undefined | string

application.tags​

application.tags: undefined | string[]

application.team​

application.team: null | object

application.termsOfServiceUrl​

application.termsOfServiceUrl: undefined | string

application.verifyKey​

application.verifyKey: string

expires​

expires: string

scopes​

scopes: OAuth2Scope[]

user​

user: undefined | object

Defined in​

packages/bot/src/helpers.ts:925

getCurrentMember()​

getCurrentMember: (guildId, bearerToken) => Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Parameters​

• guildId: BigString

• bearerToken: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Defined in​

packages/bot/src/helpers.ts:1055

getCurrentUser()​

getCurrentUser: (bearerToken) => Promise<TBot["transformers"]["$inferredTypes"]["user"]>

Parameters​

• bearerToken: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["user"]>

Defined in​

packages/bot/src/helpers.ts:1007

getDmChannel()​

getDmChannel: (userId) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• userId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:947

getEmoji()​

getEmoji: (guildId, emojiId) => Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Parameters​

• guildId: BigString

• emojiId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["emoji"]>

Defined in​

packages/bot/src/helpers.ts:949

getEmojis()​

getEmojis: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["emoji"][]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["emoji"][]>

Defined in​

packages/bot/src/helpers.ts:951

getFollowupMessage()​

getFollowupMessage: (token, messageId) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• token: string

• messageId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:953

getGatewayBot()​

getGatewayBot: () => Promise<object>

Returns​

Promise<object>

sessionStartLimit​

sessionStartLimit: object

sessionStartLimit.maxConcurrency​

sessionStartLimit.maxConcurrency: number

sessionStartLimit.remaining​

sessionStartLimit.remaining: number

sessionStartLimit.resetAfter​

sessionStartLimit.resetAfter: number

sessionStartLimit.total​

sessionStartLimit.total: number

shards​

shards: number

url​

url: string

Defined in​

packages/bot/src/helpers.ts:954

getGlobalApplicationCommand()​

getGlobalApplicationCommand: (commandId) => Promise<ApplicationCommand>

Parameters​

• commandId: BigString

Returns​

Promise<ApplicationCommand>

Defined in​

packages/bot/src/helpers.ts:955

getGlobalApplicationCommands()​

getGlobalApplicationCommands: () => Promise<ApplicationCommand[]>

Returns​

Promise<ApplicationCommand[]>

Defined in​

packages/bot/src/helpers.ts:956

getGroupDmChannel()​

getGroupDmChannel: (options) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• options: GetGroupDmOptions

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:948

getGuild()​

getGuild: (guildId, options?) => Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Parameters​

• guildId: BigString

• options?

• options.counts?: boolean

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["guild"]>

Defined in​

packages/bot/src/helpers.ts:957

getGuildApplicationCommand()​

getGuildApplicationCommand: (commandId, guildId) => Promise<ApplicationCommand>

Parameters​

• commandId: BigString

• guildId: BigString

Returns​

Promise<ApplicationCommand>

Defined in​

packages/bot/src/helpers.ts:959

getGuildApplicationCommands()​

getGuildApplicationCommands: (guildId) => Promise<ApplicationCommand[]>

Parameters​

• guildId: BigString

Returns​

Promise<ApplicationCommand[]>

Defined in​

packages/bot/src/helpers.ts:960

getGuildOnboarding()​

getGuildOnboarding: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["guildOnboarding"]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["guildOnboarding"]>

Defined in​

packages/bot/src/helpers.ts:1121

getGuildPreview()​

getGuildPreview: (guildId) => Promise<object>

Parameters​

• guildId: BigString

Returns​

Promise<object>

approximateMemberCount​

approximateMemberCount: number

approximatePresenceCount​

approximatePresenceCount: number

description​

description: null | string

discoverySplash​

discoverySplash: null | string

emojis​

emojis: object[]

features​

features: GuildFeatures[]

icon​

icon: null | string

id​

id: string

name​

name: string

splash​

splash: null | string

stickers​

stickers: object[]

Defined in​

packages/bot/src/helpers.ts:961

getGuilds()​

getGuilds: (bearerToken, options?) => Promise<Partial<TBot["transformers"]["$inferredTypes"]["guild"]>[]>

Parameters​

• bearerToken: string

• options?: GetUserGuilds

Returns​

Promise<Partial<TBot["transformers"]["$inferredTypes"]["guild"]>[]>

Defined in​

packages/bot/src/helpers.ts:958

getGuildSoundboardSound()​

getGuildSoundboardSound: (guildId, soundId) => Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"]>

Parameters​

• guildId: BigString

• soundId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"]>

Defined in​

packages/bot/src/helpers.ts:1139

getGuildSticker()​

getGuildSticker: (guildId, stickerId) => Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Parameters​

• guildId: BigString

• stickerId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Defined in​

packages/bot/src/helpers.ts:962

getGuildStickers()​

getGuildStickers: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["sticker"][]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["sticker"][]>

Defined in​

packages/bot/src/helpers.ts:963

getGuildTemplate()​

getGuildTemplate: (templateCode) => Promise<Template>

Parameters​

• templateCode: string

Returns​

Promise<Template>

Defined in​

packages/bot/src/helpers.ts:964

getGuildTemplates()​

getGuildTemplates: (guildId) => Promise<Template[]>

Parameters​

• guildId: BigString

Returns​

Promise<Template[]>

Defined in​

packages/bot/src/helpers.ts:965

getGuildWebhooks()​

getGuildWebhooks: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["webhook"][]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["webhook"][]>

Defined in​

packages/bot/src/helpers.ts:966

getIntegrations()​

getIntegrations: (guildId) => Promise<Integration[]>

Parameters​

• guildId: BigString

Returns​

Promise<Integration[]>

Defined in​

packages/bot/src/helpers.ts:967

getInvite()​

getInvite: (inviteCode, options?) => Promise<TBot["transformers"]["$inferredTypes"]["invite"]>

Parameters​

• inviteCode: string

• options?: GetInvite

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["invite"]>

Defined in​

packages/bot/src/helpers.ts:968

getInvites()​

getInvites: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["invite"][]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["invite"][]>

Defined in​

packages/bot/src/helpers.ts:969

getMember()​

getMember: (guildId, userId) => Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Parameters​

• guildId: BigString

• userId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["member"]>

Defined in​

packages/bot/src/helpers.ts:1054

getMembers()​

getMembers: (guildId, options) => Promise<TBot["transformers"]["$inferredTypes"]["member"][]>

Parameters​

• guildId: BigString

• options: ListGuildMembers

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["member"][]>

Defined in​

packages/bot/src/helpers.ts:1056

getMessage()​

getMessage: (channelId, messageId) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• channelId: BigString

• messageId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:970

getMessages()​

getMessages: (channelId, options?) => Promise<TBot["transformers"]["$inferredTypes"]["message"][]>

Parameters​

• channelId: BigString

• options?: GetMessagesOptions

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"][]>

Defined in​

packages/bot/src/helpers.ts:971

getOriginalInteractionResponse()​

getOriginalInteractionResponse: (token) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• token: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:974

getOwnVoiceState()​

getOwnVoiceState: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["voiceState"]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["voiceState"]>

Defined in​

packages/bot/src/helpers.ts:995

getPinnedMessages()​

getPinnedMessages: (channelId) => Promise<TBot["transformers"]["$inferredTypes"]["message"][]>

Parameters​

• channelId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"][]>

Defined in​

packages/bot/src/helpers.ts:975

getPrivateArchivedThreads()​

getPrivateArchivedThreads: (channelId, options?) => Promise<object>

Parameters​

• channelId: BigString

• options?: ListArchivedThreads

Returns​

Promise<object>

hasMore​

hasMore: boolean

members​

members: object[]

threads​

threads: object[]

Defined in​

packages/bot/src/helpers.ts:976

getPrivateJoinedArchivedThreads()​

getPrivateJoinedArchivedThreads: (channelId, options?) => Promise<object>

Parameters​

• channelId: BigString

• options?: ListArchivedThreads

Returns​

Promise<object>

hasMore​

hasMore: boolean

members​

members: object[]

threads​

threads: object[]

Defined in​

packages/bot/src/helpers.ts:977

getPruneCount()​

getPruneCount: (guildId, options?) => Promise<object>

Parameters​

• guildId: BigString

• options?: GetGuildPruneCountQuery

Returns​

Promise<object>

pruned​

pruned: number

Defined in​

packages/bot/src/helpers.ts:978

getPublicArchivedThreads()​

getPublicArchivedThreads: (channelId, options?) => Promise<object>

Parameters​

• channelId: BigString

• options?: ListArchivedThreads

Returns​

Promise<object>

hasMore​

hasMore: boolean

members​

members: object[]

threads​

threads: object[]

Defined in​

packages/bot/src/helpers.ts:979

getReactions()​

getReactions: (channelId, messageId, reaction, options?) => Promise<TBot["transformers"]["$inferredTypes"]["user"][]>

Parameters​

• channelId: BigString

• messageId: BigString

• reaction: string

• options?: GetReactions

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["user"][]>

Defined in​

packages/bot/src/helpers.ts:1000

getRole()​

getRole: (guildId, roleId) => Promise<TBot["transformers"]["$inferredTypes"]["role"]>

Parameters​

• guildId: BigString

• roleId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["role"]>

Defined in​

packages/bot/src/helpers.ts:981

getRoles()​

getRoles: (guildId) => Promise<TBot["transformers"]["$inferredTypes"]["role"][]>

Parameters​

• guildId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["role"][]>

Defined in​

packages/bot/src/helpers.ts:980

getScheduledEvent()​

getScheduledEvent: (guildId, eventId, options?) => Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"]>

Parameters​

• guildId: BigString

• eventId: BigString

• options?

• options.withUserCount?: boolean

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"]>

Defined in​

packages/bot/src/helpers.ts:982

getScheduledEvents()​

getScheduledEvents: (guildId, options?) => Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"][]>

Parameters​

• guildId: BigString

• options?: GetScheduledEvents

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["scheduledEvent"][]>

Defined in​

packages/bot/src/helpers.ts:987

getScheduledEventUsers()​

getScheduledEventUsers: (guildId, eventId, options?) => Promise<object[]>

Parameters​

• guildId: BigString

• eventId: BigString

• options?: GetScheduledEventUsers

Returns​

Promise<object[]>

Defined in​

packages/bot/src/helpers.ts:988

getSessionInfo()​

getSessionInfo: () => Promise<object>

Returns​

Promise<object>

sessionStartLimit​

sessionStartLimit: object

sessionStartLimit.maxConcurrency​

sessionStartLimit.maxConcurrency: number

sessionStartLimit.remaining​

sessionStartLimit.remaining: number

sessionStartLimit.resetAfter​

sessionStartLimit.resetAfter: number

sessionStartLimit.total​

sessionStartLimit.total: number

shards​

shards: number

url​

url: string

Defined in​

packages/bot/src/helpers.ts:993

getStageInstance()​

getStageInstance: (channelId) => Promise<TBot["transformers"]["$inferredTypes"]["stageInstance"]>

Parameters​

• channelId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["stageInstance"]>

Defined in​

packages/bot/src/helpers.ts:994

getSticker()​

getSticker: (stickerId) => Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Parameters​

• stickerId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["sticker"]>

Defined in​

packages/bot/src/helpers.ts:997

getStickerPack()​

getStickerPack: (stickerPackId) => Promise<StickerPack>

Parameters​

• stickerPackId: BigString

Returns​

Promise<StickerPack>

Defined in​

packages/bot/src/helpers.ts:972

getStickerPacks()​

getStickerPacks: () => Promise<StickerPack[]>

Returns​

Promise<StickerPack[]>

Defined in​

packages/bot/src/helpers.ts:973

getSubscription()​

getSubscription: (skuId, subscriptionId) => Promise<TBot["transformers"]["$inferredTypes"]["subscription"]>

Parameters​

• skuId: BigString

• subscriptionId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["subscription"]>

Defined in​

packages/bot/src/helpers.ts:1135

getThreadMember()​

getThreadMember: (channelId, userId) => Promise<ThreadMember>

Parameters​

• channelId: BigString

• userId: BigString

Returns​

Promise<ThreadMember>

Defined in​

packages/bot/src/helpers.ts:998

getThreadMembers()​

getThreadMembers: (channelId) => Promise<ThreadMember[]>

Parameters​

• channelId: BigString

Returns​

Promise<ThreadMember[]>

Defined in​

packages/bot/src/helpers.ts:999

getUser()​

getUser: (id) => Promise<TBot["transformers"]["$inferredTypes"]["user"]>

Parameters​

• id: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["user"]>

Defined in​

packages/bot/src/helpers.ts:1006

getUserApplicationRoleConnection()​

getUserApplicationRoleConnection: (bearerToken, applicationId) => Promise<object>

Parameters​

• bearerToken: string

• applicationId: BigString

Returns​

Promise<object>

metadata​

metadata: object

platformName​

platformName: null | string

platformUsername​

platformUsername: null | string

Defined in​

packages/bot/src/helpers.ts:1009

getUserConnections()​

getUserConnections: (bearerToken) => Promise<object[]>

Parameters​

• bearerToken: string

Returns​

Promise<object[]>

Defined in​

packages/bot/src/helpers.ts:1008

getUserVoiceState()​

getUserVoiceState: (guildId, userId) => Promise<TBot["transformers"]["$inferredTypes"]["voiceState"]>

Parameters​

• guildId: BigString

• userId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["voiceState"]>

Defined in​

packages/bot/src/helpers.ts:996

getVanityUrl()​

getVanityUrl: (guildId) => Promise<object>

Parameters​

• guildId: BigString

Returns​

Promise<object>

code​

code: null | string

uses​

uses: number

Defined in​

packages/bot/src/helpers.ts:1010

getVoiceRegions()​

getVoiceRegions: (guildId) => Promise<object[]>

Parameters​

• guildId: BigString

Returns​

Promise<object[]>

Defined in​

packages/bot/src/helpers.ts:1011

getWebhook()​

getWebhook: (webhookId) => Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Parameters​

• webhookId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Defined in​

packages/bot/src/helpers.ts:1012

getWebhookMessage()​

getWebhookMessage: (webhookId, token, messageId, options?) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• webhookId: BigString

• token: string

• messageId: BigString

• options?: GetWebhookMessageOptions

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:1013

getWebhookWithToken()​

getWebhookWithToken: (webhookId, token) => Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Parameters​

• webhookId: BigString

• token: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["webhook"]>

Defined in​

packages/bot/src/helpers.ts:1019

getWelcomeScreen()​

getWelcomeScreen: (guildId) => Promise<WelcomeScreen>

Parameters​

• guildId: BigString

Returns​

Promise<WelcomeScreen>

Defined in​

packages/bot/src/helpers.ts:1020

getWidget()​

getWidget: (guildId) => Promise<GuildWidget>

Parameters​

• guildId: BigString

Returns​

Promise<GuildWidget>

Defined in​

packages/bot/src/helpers.ts:1021

getWidgetSettings()​

getWidgetSettings: (guildId) => Promise<GuildWidgetSettings>

Parameters​

• guildId: BigString

Returns​

Promise<GuildWidgetSettings>

Defined in​

packages/bot/src/helpers.ts:1022

joinThread()​

joinThread: (channelId) => Promise<void>

Parameters​

• channelId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1103

kickMember()​

kickMember: (guildId, userId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• userId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1117

leaveGuild()​

leaveGuild: (guildId) => Promise<void>

Parameters​

• guildId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1104

leaveThread()​

leaveThread: (channelId) => Promise<void>

Parameters​

• channelId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1105

listDefaultSoundboardSounds()​

listDefaultSoundboardSounds: () => Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"][]>

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"][]>

Defined in​

packages/bot/src/helpers.ts:1137

listEntitlements()​

listEntitlements: (applicationId, options?) => Promise<TBot["transformers"]["$inferredTypes"]["entitlement"][]>

Parameters​

• applicationId: BigString

• options?: GetEntitlements

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["entitlement"][]>

Defined in​

packages/bot/src/helpers.ts:1127

listGuildSoundboardSounds()​

listGuildSoundboardSounds: (guildId) => Promise<object>

Parameters​

• guildId: BigString

Returns​

Promise<object>

items​

items: TBot["transformers"]["$inferredTypes"]["soundboardSound"][]

Defined in​

packages/bot/src/helpers.ts:1138

listSkus()​

listSkus: (applicationId) => Promise<TBot["transformers"]["$inferredTypes"]["sku"][]>

Parameters​

• applicationId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["sku"][]>

Defined in​

packages/bot/src/helpers.ts:1133

listSubscriptions()​

listSubscriptions: (skuId, options?) => Promise<TBot["transformers"]["$inferredTypes"]["subscription"][]>

Parameters​

• skuId: BigString

• options?: ListSkuSubscriptionsOptions

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["subscription"][]>

Defined in​

packages/bot/src/helpers.ts:1134

modifyGuildSoundboardSound()​

modifyGuildSoundboardSound: (guildId, soundId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"]>

Parameters​

• guildId: BigString

• soundId: BigString

• options: ModifyGuildSoundboardSound

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["soundboardSound"]>

Defined in​

packages/bot/src/helpers.ts:1145

pinMessage()​

pinMessage: (channelId, messageId, reason?) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1118

pruneMembers()​

pruneMembers: (guildId, options, reason?) => Promise<object>

Parameters​

• guildId: BigString

• options: BeginGuildPrune

• reason?: string

Returns​

Promise<object>

pruned​

pruned: null | number

Defined in​

packages/bot/src/helpers.ts:1057

publishMessage()​

publishMessage: (channelId, messageId) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• channelId: BigString

• messageId: BigString

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:1023

removeDmRecipient()​

removeDmRecipient: (channelId, userId) => Promise<void>

Parameters​

• channelId: BigString

• userId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1108

removeRole()​

removeRole: (guildId, userId, roleId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• userId: BigString

• roleId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1106

removeThreadMember()​

removeThreadMember: (channelId, userId) => Promise<void>

Parameters​

• channelId: BigString

• userId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1107

revokeToken()​

revokeToken: (clientId, clientSecret, options) => Promise<void>

Parameters​

• clientId: BigString

• clientSecret: string

• options

• options.token: string

• options.tokenTypeHint: undefined | "access_token" | "refresh_token"

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:927

searchMembers()​

searchMembers: (guildId, query, options?) => Promise<TBot["transformers"]["$inferredTypes"]["member"][]>

Parameters​

• guildId: BigString

• query: string

• options?: Omit<SearchMembers, "query">

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["member"][]>

Defined in​

packages/bot/src/helpers.ts:1058

sendFollowupMessage()​

sendFollowupMessage: (token, options) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• token: string

• options: InteractionCallbackData

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:1025

sendInteractionResponse()​

sendInteractionResponse: (interactionId, token, options, params?) => Promise<void | TBot["transformers"]["$inferredTypes"]["interactionCallbackResponse"]>

Parameters​

• interactionId: BigString

• token: string

• options: InteractionResponse

• params?: InteractionCallbackOptions

Returns​

Promise<void | TBot["transformers"]["$inferredTypes"]["interactionCallbackResponse"]>

Defined in​

packages/bot/src/helpers.ts:1109

sendMessage()​

sendMessage: (channelId, options) => Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Parameters​

• channelId: BigString

• options: CreateMessageOptions

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["message"]>

Defined in​

packages/bot/src/helpers.ts:1024

sendSoundboardSound()​

sendSoundboardSound: (channelId, options) => Promise<void>

Parameters​

• channelId: BigString

• options: SendSoundboardSound

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1136

startThreadWithMessage()​

startThreadWithMessage: (channelId, messageId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• channelId: BigString

• messageId: BigString

• options: StartThreadWithMessage

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:1026

startThreadWithoutMessage()​

startThreadWithoutMessage: (channelId, options, reason?) => Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Parameters​

• channelId: BigString

• options: StartThreadWithoutMessage

• reason?: string

Returns​

Promise<TBot["transformers"]["$inferredTypes"]["channel"]>

Defined in​

packages/bot/src/helpers.ts:1032

syncGuildTemplate()​

syncGuildTemplate: (guildId) => Promise<Template>

Parameters​

• guildId: BigString

Returns​

Promise<Template>

Defined in​

packages/bot/src/helpers.ts:1037

triggerTypingIndicator()​

triggerTypingIndicator: (channelId) => Promise<void>

Parameters​

• channelId: BigString

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1115

unbanMember()​

unbanMember: (guildId, userId, reason?) => Promise<void>

Parameters​

• guildId: BigString

• userId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1119

unpinMessage()​

unpinMessage: (channelId, messageId, reason?) => Promise<void>

Parameters​

• channelId: BigString

• messageId: BigString

• reason?: string

Returns​

Promise<void>

Defined in​

packages/bot/src/helpers.ts:1120

upsertGlobalApplicationCommands()​

upsertGlobalApplicationCommands: (commands, options?) => Promise<ApplicationCommand[]>

Parameters​

• commands: CreateApplicationCommand[]

• options?: UpsertGlobalApplicationCommandOptions

Returns​

Promise<ApplicationCommand[]>

Defined in​

packages/bot/src/helpers.ts:1038

upsertGuildApplicationCommands()​

upsertGuildApplicationCommands: (guildId, commands, options?) => Promise<ApplicationCommand[]>

Parameters​

• guildId: BigString

• commands: CreateApplicationCommand[]

• options?: UpsertGuildApplicationCommandOptions

Returns​

Promise<ApplicationCommand[]>

Defined in​

packages/bot/src/helpers.ts:1042