new Client
src/client.ts:102new Client(token?: string, options?: ClientOptions)Clientclass
The REST client: one method per Discord endpoint, with automatic ratelimit handling. Methods resolve with the raw JSON Discord sends back.
On this page
import { Client } from 'detritus-client-rest';Hierarchy
Constructor
Properties
readonly
Accessors
Methods
acceptAgreements()
async src/client.ts:359acceptAgreements(privacy?: boolean, terms?: boolean): Promise<any>Parameters
privacy?
boolean
terms?
boolean
acceptInvite()
async src/client.ts:372acceptInvite(code: string): Promise<any>acceptTeamInvite()
async src/client.ts:388acceptTeamInvite(token: string): Promise<any>acceptTemplate()
async src/client.ts:402acceptTemplate(templateId: string, options: AcceptTemplate): Promise<any>ackChannelMessage()
async src/client.ts:421ackChannelMessage(channelId: string, messageId: string, token: string): Promise<any>ackChannelPins()
async src/client.ts:447ackChannelPins(channelId: string): Promise<any>ackGuild()
async src/client.ts:463ackGuild(guildId: string): Promise<any>activateOauth2ApplicationLicense()
async src/client.ts:479activateOauth2ApplicationLicense(
applicationId: string,
options: ActivateOauth2ApplicationLicense,
): Promise<any>addConnection()
async src/client.ts:501addConnection(platform: string, accountId: string, options: AddConnection): Promise<any>addGuildMember()
async src/client.ts:524addGuildMember(guildId: string, userId: string, options: AddGuildMember): Promise<any>addGuildMemberRole()
async src/client.ts:550addGuildMemberRole(
guildId: string,
userId: string,
roleId: string,
options?: AddGuildMemberRole,
): Promise<any>addInvalidRequest()
src/client.ts:178addInvalidRequest(): voidaddInviteTargetUser()
async src/client.ts:589addInviteTargetUser(code: string, userId: string): Promise<any>addOauth2ApplicationWhitelistUser()
async src/client.ts:653addOauth2ApplicationWhitelistUser(
applicationId: string,
options: AddOauth2ApplicationWhitelistUser,
): Promise<any>addPinnedMessage()
async src/client.ts:609addPinnedMessage(channelId: string, messageId: string, options?: PinMessage): Promise<any>addRecipient()
async src/client.ts:630addRecipient(channelId: string, userId: string, options?: AddRecipient): Promise<any>addTeamMember()
async src/client.ts:676addTeamMember(teamId: string, options: AddTeamMember): Promise<any>addThreadMember()
async src/client.ts:572addThreadMember(channelId: string, userId: string): Promise<any>authorizeIpAddress()
async src/client.ts:698authorizeIpAddress(options: AuthorizeIpAddress): Promise<any>beginGuildPrune()
async src/client.ts:716beginGuildPrune(guildId: string, options?: BeginGuildPrune): Promise<any>bulkAddInviteTargetUsers()
async src/client.ts:742bulkAddInviteTargetUsers(code: string, options: BulkAddInviteTargetUsers): Promise<any>bulkDeleteInviteTargetUsers()
async src/client.ts:768bulkDeleteInviteTargetUsers(
code: string,
options: BulkDeleteInviteTargetUsers,
): Promise<any>bulkDeleteMessages()
async src/client.ts:794bulkDeleteMessages(
channelId: string,
messageIds: string[],
options?: BulkDeleteMessages,
): Promise<any>bulkGuildBan()
async src/client.ts:822bulkGuildBan(guildId: string, options: BulkGuildBan): Promise<any>bulkOverwriteApplicationCommands()
async src/client.ts:855bulkOverwriteApplicationCommands(
applicationId: string,
commands: (CreateApplicationCommand | toJSON<CreateApplicationCommandData>)[],
): Promise<any>bulkOverwriteApplicationGuildCommands()
async src/client.ts:874bulkOverwriteApplicationGuildCommands(
applicationId: string,
guildId: string,
commands: (CreateApplicationGuildCommand | toJSON<CreateApplicationGuildCommandData>)[],
): Promise<any>bulkOverwriteApplicationGuildCommandsPermissions()
async src/client.ts:894bulkOverwriteApplicationGuildCommandsPermissions(
applicationId: string,
guildId: string,
permissions: BulkOverwriteApplicationGuildCommandsPermissions,
): Promise<any>bulkOverwriteApplicationRoleConnectionsMetadata()
async src/client.ts:919bulkOverwriteApplicationRoleConnectionsMetadata(
applicationId: string,
metadata: (BulkOverwriteApplicationRoleConnectionsMetadataRecord | toJSON<BulkOverwriteApplicationRoleConnectionsMetadataRecordData>)[],
): Promise<any>connectionCallback()
async src/client.ts:941connectionCallback(platform: string, options: ConnectionCallback): Promise<any>consumeApplicationEntitlement()
async src/client.ts:964consumeApplicationEntitlement(applicationId: string, entitlementId: string): Promise<any>createApplicationCommand()
async src/client.ts:982createApplicationCommand(
applicationId: string,
options: CreateApplicationCommand | toJSON<CreateApplicationCommandData>,
): Promise<any>createApplicationEmoji()
async src/client.ts:1001createApplicationEmoji(
applicationId: string,
options: CreateApplicationEmoji,
): Promise<any>createApplicationEntitlement()
async src/client.ts:1024createApplicationEntitlement(
applicationId: string,
options: CreateApplicationEntitlement,
): Promise<any>createApplicationGuildCommand()
async src/client.ts:1047createApplicationGuildCommand(
applicationId: string,
guildId: string,
options: CreateApplicationGuildCommand | toJSON<CreateApplicationGuildCommandData>,
): Promise<any>createApplicationNews()
async src/client.ts:1067createApplicationNews(options: CreateApplicationNews): Promise<any>createChannelAttachments()
async src/client.ts:1091createChannelAttachments(
channelId: string,
options: CreateChannelAttachments,
): Promise<any>createChannelInvite()
async src/client.ts:1120createChannelInvite(channelId: string, options?: CreateChannelInvite): Promise<any>createChannelMessageThread()
async src/client.ts:1166createChannelMessageThread(
channelId: string,
messageId: string,
options: CreateChannelMessageThread,
): Promise<any>createChannelStoreListingGrantEntitlement()
async src/client.ts:1193createChannelStoreListingGrantEntitlement(channelId: string): Promise<any>createChannelThread()
async src/client.ts:1209createChannelThread(channelId: string, options: CreateChannelThread): Promise<any>createDm()
async src/client.ts:1245createDm(options?: CreateDm): Promise<any>createGuild()
async src/client.ts:1265createGuild(options: CreateGuild): Promise<any>createGuildAutoModerationRule()
async src/client.ts:1294createGuildAutoModerationRule(
guildId: string,
options: CreateGuildAutoModerationRule,
): Promise<any>createGuildBan()
async src/client.ts:1341createGuildBan(guildId: string, userId: string, options?: CreateGuildBan): Promise<any>createGuildChannel()
async src/client.ts:1367createGuildChannel(guildId: string, options: CreateGuildChannel): Promise<any>createGuildEmoji()
async src/client.ts:1389createGuildEmoji(guildId: string, options: CreateGuildEmoji): Promise<any>createGuildIntegration()
async src/client.ts:1416createGuildIntegration(guildId: string, options: CreateGuildIntegration): Promise<any>createGuildRole()
async src/client.ts:1441createGuildRole(guildId: string, options?: CreateGuildRole): Promise<any>createGuildScheduledEvent()
async src/client.ts:1463createGuildScheduledEvent(
guildId: string,
options: CreateGuildScheduledEvent,
): Promise<any>createGuildSoundboardSound()
async src/client.ts:1496createGuildSoundboardSound(
guildId: string,
options: CreateGuildSoundboardSound,
): Promise<any>createGuildSticker()
async src/client.ts:1524createGuildSticker(guildId: string, options: CreateGuildSticker): Promise<any>createGuildTemplate()
async src/client.ts:1555createGuildTemplate(guildId: string, options: CreateGuildTemplate): Promise<any>createInteractionResponse()
async src/client.ts:1577createInteractionResponse(
interactionId: string,
token: string,
optionsOrType: number | CreateInteractionResponse,
innerData?: string | CreateInteractionResponseInnerPayload,
withResponse?: boolean,
): Promise<any>createLobby()
async src/client.ts:1643createLobby(
applicationIdOrOptions?: string | CreateLobby,
options?: CreateLobby,
): Promise<any>createLobbyChannelInvite()
async src/client.ts:1670createLobbyChannelInvite(lobbyId: string, userId?: string): Promise<any>Parameters
lobbyId
string
userId?
string
createLobbyMessage()
async src/client.ts:1687createLobbyMessage(lobbyId: string, options: CreateLobbyMessage): Promise<any>createMeBillingPaymentSource()
async src/client.ts:1731createMeBillingPaymentSource(options: CreateMeBillingPaymentSource): Promise<any>createMeBillingSubscription()
async src/client.ts:1759createMeBillingSubscription(options: CreateMeBillingSubscription): Promise<any>createMessage()
async src/client.ts:1779createMessage(channelId: string, options?: string | CreateMessage): Promise<any>createOauth2Application()
async src/client.ts:1854createOauth2Application(options: CreateOauth2Application): Promise<any>createOauth2ApplicationAsset()
async src/client.ts:1873createOauth2ApplicationAsset(
applicationId: string,
options: CreateOauth2ApplicationAsset,
): Promise<any>createOauth2ApplicationBot()
async src/client.ts:1896createOauth2ApplicationBot(applicationId: string): Promise<any>createOAuth2Token()
async src/client.ts:1913createOAuth2Token(options: CreateOauth2Token): Promise<any>createOrJoinLobby()
async src/client.ts:1710createOrJoinLobby(options: CreateOrJoinLobby): Promise<any>createReaction()
async src/client.ts:1938createReaction(channelId: string, messageId: string, emoji: string): Promise<any>createStageInstance()
async src/client.ts:1956createStageInstance(options: CreateStageInstance): Promise<any>createStoreApplicationAsset()
async src/client.ts:1981createStoreApplicationAsset(
applicationId: string,
options?: CreateStoreApplicationAsset,
): Promise<any>createTeam()
async src/client.ts:2009createTeam(options?: CreateTeam): Promise<any>createWebhook()
async src/client.ts:2028createWebhook(channelId: string, options: CreateWebhook): Promise<any>crosspostMessage()
async src/client.ts:2053crosspostMessage(channelId: string, messageId: string): Promise<any>delete()
async src/client.ts:293deleteAccount()
async src/client.ts:2070deleteAccount(options: DeleteAccount): Promise<any>deleteApplicationCommand()
async src/client.ts:2086deleteApplicationCommand(applicationId: string, commandId: string): Promise<any>deleteApplicationEmoji()
async src/client.ts:2100deleteApplicationEmoji(applicationId: string, emojiId: string): Promise<any>deleteApplicationEntitlement()
async src/client.ts:2114deleteApplicationEntitlement(applicationId: string, entitlementId: string): Promise<any>deleteApplicationGuildCommand()
async src/client.ts:2128deleteApplicationGuildCommand(
applicationId: string,
guildId: string,
commandId: string,
): Promise<any>deleteChannel()
async src/client.ts:2146deleteChannel(channelId: string, options?: DeleteChannel): Promise<any>deleteChannelOverwrite()
async src/client.ts:2166deleteChannelOverwrite(
channelId: string,
overwriteId: string,
options?: DeleteChannelOverwrite,
): Promise<any>deleteConnection()
async src/client.ts:2187deleteConnection(platform: string, accountId: string): Promise<any>deleteGuild()
async src/client.ts:2204deleteGuild(guildId: string, options?: DeleteGuild): Promise<any>deleteGuildAutoModerationRule()
async src/client.ts:2223deleteGuildAutoModerationRule(
guildId: string,
autoModerationRuleId: string,
options?: DeleteGuildAutoModerationRule,
): Promise<any>deleteGuildEmoji()
async src/client.ts:2244deleteGuildEmoji(
guildId: string,
emojiId: string,
options?: DeleteGuildEmoji,
): Promise<any>deleteGuildIntegration()
async src/client.ts:2265deleteGuildIntegration(
guildId: string,
integrationId: string,
options?: DeleteGuildIntegration,
): Promise<any>deleteGuildPremiumSubscription()
async src/client.ts:2286deleteGuildPremiumSubscription(guildId: string, subscriptionId: string): Promise<any>deleteGuildRole()
async src/client.ts:2303deleteGuildRole(guildId: string, roleId: string, options?: DeleteGuildRole): Promise<any>deleteGuildScheduledEvent()
async src/client.ts:2324deleteGuildScheduledEvent(
guildId: string,
scheduledEventId: string,
options?: DeleteGuildScheduledEvent,
): Promise<any>deleteGuildSoundboardSound()
async src/client.ts:2345deleteGuildSoundboardSound(
guildId: string,
soundId: string,
options?: DeleteGuildSoundboardSound,
): Promise<any>deleteGuildSticker()
async src/client.ts:2366deleteGuildSticker(
guildId: string,
stickerId: string,
options?: DeleteGuildSticker,
): Promise<any>deleteGuildTemplate()
async src/client.ts:2410deleteGuildTemplate(guildId: string, templateId: string): Promise<any>deleteInvite()
async src/client.ts:2427deleteInvite(code: string, options?: DeleteInvite): Promise<any>deleteLobby()
async src/client.ts:2447deleteLobby(lobbyId: string): Promise<any>deleteMeApplicationRoleConnection()
async src/client.ts:5904deleteMeApplicationRoleConnection(applicationId: string): Promise<any>deleteMeBillingPaymentSource()
async src/client.ts:2463deleteMeBillingPaymentSource(paymentSourceId: string): Promise<any>deleteMeBillingSubscription()
async src/client.ts:2479deleteMeBillingSubscription(subscriptionId: string): Promise<any>deleteMessage()
async src/client.ts:2495deleteMessage(channelId: string, messageId: string, options?: DeleteMessage): Promise<any>deleteOauth2Application()
async src/client.ts:2519deleteOauth2Application(
applicationId: string,
options?: DeleteOauth2Application,
): Promise<any>deleteOauth2ApplicationAsset()
async src/client.ts:2540deleteOauth2ApplicationAsset(applicationId: string, assetId: string): Promise<any>deletePinnedMessage()
async src/client.ts:2557deletePinnedMessage(
channelId: string,
messageId: string,
options?: PinMessage,
): Promise<any>deleteReaction()
async src/client.ts:2613deleteReaction(
channelId: string,
messageId: string,
emoji: string,
userId?: string,
): Promise<any>Parameters
channelId
string
messageId
string
emoji
string
userId?
string
deleteReactions()
async src/client.ts:2578deleteReactions(channelId: string, messageId: string): Promise<any>deleteReactionsEmoji()
async src/client.ts:2595deleteReactionsEmoji(channelId: string, messageId: string, emoji: string): Promise<any>deleteRelationship()
async src/client.ts:2632deleteRelationship(userId: string): Promise<any>deleteStageInstance()
async src/client.ts:2648deleteStageInstance(channelId: string, options?: DeleteStageInstance): Promise<any>deleteStoreApplicationAsset()
async src/client.ts:2668deleteStoreApplicationAsset(applicationId: string, assetId: string): Promise<any>deleteTeam()
async src/client.ts:2685deleteTeam(teamId: string, options?: DeleteTeam): Promise<any>deleteWebhook()
async src/client.ts:2704deleteWebhook(webhookId: string, options?: DeleteWebhook): Promise<any>deleteWebhookToken()
async src/client.ts:2724deleteWebhookToken(
webhookId: string,
webhookToken: string,
options?: DeleteWebhook,
): Promise<any>deleteWebhookTokenMessage()
async src/client.ts:2746deleteWebhookTokenMessage(
webhookId: string,
webhookToken: string,
messageId: string,
options?: DeleteWebhookTokenMessage,
): Promise<any>disableAccount()
async src/client.ts:2770disableAccount(options: DisableAccount): Promise<any>editApplication()
async src/client.ts:2786editApplication(options?: EditApplication, applicationId?: string): Promise<any>Parameters
options?
applicationId?
string
editApplicationCommand()
async src/client.ts:2827editApplicationCommand(
applicationId: string,
commandId: string,
options?: Partial<CreateApplicationCommand> | toJSON<Partial<CreateApplicationCommandData>>,
): Promise<any>editApplicationEmoji()
async src/client.ts:2847editApplicationEmoji(
applicationId: string,
emojiId: string,
options?: EditApplicationEmoji,
): Promise<any>editApplicationGuildCommand()
async src/client.ts:2869editApplicationGuildCommand(
applicationId: string,
guildId: string,
commandId: string,
options?: Partial<CreateApplicationCommand> | toJSON<Partial<CreateApplicationCommandData>>,
): Promise<any>editApplicationGuildCommandPermissions()
async src/client.ts:2890editApplicationGuildCommandPermissions(
applicationId: string,
guildId: string,
commandId: string,
options: EditApplicationGuildCommandPermissions,
): Promise<any>editApplicationNews()
async src/client.ts:2913editApplicationNews(newsId: string, options?: EditApplicationNews): Promise<any>editChannel()
async src/client.ts:2938editChannel(channelId: string, options?: EditChannel): Promise<any>editChannelOverwrite()
async src/client.ts:3021editChannelOverwrite(
channelId: string,
overwriteId: string,
options?: EditChannelOverwrite,
): Promise<any>editChannelVoiceStatus()
async src/client.ts:3000editChannelVoiceStatus(channelId: string, options: EditChannelVoiceStatus): Promise<any>editConnection()
async src/client.ts:3048editConnection(
platform: string,
accountId: string,
options?: EditConnection,
): Promise<any>editGuild()
async src/client.ts:3066editGuild(guildId: string, options?: EditGuild): Promise<any>editGuildAutoModerationRule()
async src/client.ts:3111editGuildAutoModerationRule(
guildId: string,
autoModerationRuleId: string,
options?: EditGuildAutoModerationRule,
): Promise<any>editGuildChannels()
async src/client.ts:3159editGuildChannels(
guildId: string,
channels: EditGuildChannels,
options?: EditGuildChannelsExtra,
): Promise<any>editGuildEmoji()
async src/client.ts:3196editGuildEmoji(guildId: string, emojiId: string, options?: EditGuildEmoji): Promise<any>editGuildIncidentActions()
async src/client.ts:5237editGuildIncidentActions(
guildId: string,
options?: EditGuildIncidentActions,
): Promise<any>editGuildIntegration()
async src/client.ts:3222editGuildIntegration(
guildId: string,
integrationId: string,
options?: EditGuildIntegration,
): Promise<any>editGuildMember()
async src/client.ts:3249editGuildMember(guildId: string, userId: string, options?: EditGuildMember): Promise<any>editGuildMemberVerification()
async src/client.ts:3283editGuildMemberVerification(
guildId: string,
options?: EditGuildMemberVerification,
): Promise<any>editGuildMfaLevel()
async src/client.ts:3306editGuildMfaLevel(guildId: string, options: EditGuildMfaLevel): Promise<any>editGuildNick()
async src/client.ts:3331editGuildNick(guildId: string, nick: string, options?: EditGuildNick): Promise<any>editGuildOnboarding()
async src/client.ts:5260editGuildOnboarding(guildId: string, options?: EditGuildOnboarding): Promise<any>editGuildRole()
async src/client.ts:3354editGuildRole(guildId: string, roleId: string, options?: EditGuildRole): Promise<any>editGuildRolePositions()
async src/client.ts:3386editGuildRolePositions(
guildId: string,
roles: EditGuildRolePositions,
options?: EditGuildRolePositionsExtra,
): Promise<any>editGuildScheduledEvent()
async src/client.ts:3419editGuildScheduledEvent(
guildId: string,
scheduledEventId: string,
options: EditGuildScheduledEvent,
): Promise<any>editGuildSoundboardSound()
async src/client.ts:3454editGuildSoundboardSound(
guildId: string,
soundId: string,
options?: EditGuildSoundboardSound,
): Promise<any>editGuildSticker()
async src/client.ts:3482editGuildSticker(
guildId: string,
stickerId: string,
options?: EditGuildSticker,
): Promise<any>editGuildTemplate()
async src/client.ts:2387editGuildTemplate(
guildId: string,
templateId: string,
options?: EditGuildTemplate,
): Promise<any>editGuildVanity()
async src/client.ts:3509editGuildVanity(guildId: string, code: string, options?: EditGuildVanity): Promise<any>editGuildVoiceState()
async src/client.ts:3532editGuildVoiceState(
guildId: string,
userId?: string,
options: EditGuildVoiceState,
): Promise<any>Parameters
editGuildWelcomeScreen()
async src/client.ts:5287editGuildWelcomeScreen(guildId: string, options?: EditGuildWelcomeScreen): Promise<any>editGuildWidget()
async src/client.ts:3573editGuildWidget(guildId: string, options: EditGuildWidget): Promise<any>editInviteTargetUsers()
async src/client.ts:5826editInviteTargetUsers(code: string, options: EditInviteTargetUsers): Promise<any>editLobby()
async src/client.ts:3598editLobby(lobbyId: string, options?: EditLobby): Promise<any>editLobbyChannelLinking()
async src/client.ts:3621editLobbyChannelLinking(lobbyId: string, options?: EditLobbyChannelLinking): Promise<any>editLobbyMember()
async src/client.ts:3643editLobbyMember(lobbyId: string, userId: string, options?: EditLobbyMember): Promise<any>editLobbyMembersBulk()
async src/client.ts:3667editLobbyMembersBulk(lobbyId: string, members: EditLobbyMembersBulk): Promise<any>editLobbyMessageModerationMetadata()
async src/client.ts:3688editLobbyMessageModerationMetadata(
lobbyId: string,
messageId: string,
metadata: Record<string, string>,
): Promise<any>editMe()
async src/client.ts:3772editMe(options?: EditMe): Promise<any>editMeApplicationRoleConnection()
async src/client.ts:3807editMeApplicationRoleConnection(
applicationId: string,
options?: EditMeApplicationRoleConnection,
): Promise<any>editMeBillingPaymentSource()
async src/client.ts:3830editMeBillingPaymentSource(
paymentSourceId: string,
options?: EditMeBillingPaymentSource,
): Promise<any>editMeBillingSubscription()
async src/client.ts:3860editMeBillingSubscription(
subscriptionId: string,
options?: EditMeBillingSubscription,
): Promise<any>editMessage()
async src/client.ts:3883editMessage(
channelId: string,
messageId: string,
options?: string | EditMessage,
): Promise<any>editNote()
async src/client.ts:3909editNote(userId: string, note: string): Promise<any>editOauth2Application()
async src/client.ts:3928editOauth2Application(
applicationId: string,
options?: EditOauth2Application,
): Promise<any>editRelationship()
async src/client.ts:3952editRelationship(userId: string, type: number): Promise<any>editSettings()
async src/client.ts:3971editSettings(options?: EditSettings): Promise<any>editStageInstance()
async src/client.ts:3984editStageInstance(channelId: string, options?: EditStageInstance): Promise<any>editTeam()
async src/client.ts:4009editTeam(teamId: string, options?: EditTeam): Promise<any>editUser()
async src/client.ts:4033editUser(options?: EditMe): Promise<any>editWebhook()
async src/client.ts:4037editWebhook(webhookId: string, options?: EditWebhook): Promise<any>editWebhookToken()
async src/client.ts:4063editWebhookToken(
webhookId: string,
webhookToken: string,
options?: EditWebhookToken,
): Promise<any>editWebhookTokenMessage()
async src/client.ts:4087editWebhookTokenMessage(
webhookId: string,
webhookToken: string,
messageId: string,
options?: string | EditWebhookTokenMessage,
): Promise<any>enableOauth2ApplicationAssets()
async src/client.ts:4124enableOauth2ApplicationAssets(applicationId: string): Promise<any>enableOauth2ApplicationRpc()
async src/client.ts:4141enableOauth2ApplicationRpc(applicationId: string): Promise<any>endChannelPoll()
async src/client.ts:4231endChannelPoll(channelId: string, messageId: string): Promise<any>executeWebhook()
async src/client.ts:4158executeWebhook(
webhookId: string,
webhookToken: string,
options?: string | ExecuteWebhook,
compatibleType?: string,
): Promise<any>fetchActivities()
async src/client.ts:4248fetchActivities(): Promise<any>fetchApplication()
async src/client.ts:4527fetchApplication(applicationId: string): Promise<any>fetchApplicationActivityInstance()
async src/client.ts:4543fetchApplicationActivityInstance(
applicationId: string,
instanceId: string,
): Promise<ApplicationActivityInstance>fetchApplicationCommand()
async src/client.ts:4278fetchApplicationCommand(applicationId: string, commandId: string): Promise<any>fetchApplicationCommands()
async src/client.ts:4257fetchApplicationCommands(
applicationId: string,
options?: FetchApplicationCommands,
): Promise<any>fetchApplicationEmoji()
async src/client.ts:4308fetchApplicationEmoji(applicationId: string, emojiId: string): Promise<any>fetchApplicationEmojis()
async src/client.ts:4295fetchApplicationEmojis(applicationId: string): Promise<any>fetchApplicationEntitlement()
async src/client.ts:4322fetchApplicationEntitlement(applicationId: string, entitlementId: string): Promise<any>fetchApplicationEntitlements()
async src/client.ts:4339fetchApplicationEntitlements(
applicationId: string,
options?: FetchApplicationEntitlements,
): Promise<any>fetchApplicationGuildCommand()
async src/client.ts:4414fetchApplicationGuildCommand(
applicationId: string,
guildId: string,
commandId: string,
): Promise<any>fetchApplicationGuildCommandPermissions()
async src/client.ts:4432fetchApplicationGuildCommandPermissions(
applicationId: string,
guildId: string,
commandId: string,
): Promise<any>fetchApplicationGuildCommands()
async src/client.ts:4375fetchApplicationGuildCommands(
applicationId: string,
guildId: string,
options?: FetchApplicationGuildCommands,
): Promise<any>fetchApplicationGuildCommandsPermissions()
async src/client.ts:4397fetchApplicationGuildCommandsPermissions(
applicationId: string,
guildId: string,
): Promise<any>fetchApplicationNews()
async src/client.ts:4450fetchApplicationNews(applicationIds?: string | string[]): Promise<any>fetchApplicationNewsId()
async src/client.ts:4470fetchApplicationNewsId(newsId: string): Promise<any>fetchApplicationRoleConnectionsMetadata()
async src/client.ts:4486fetchApplicationRoleConnectionsMetadata(applicationId: string): Promise<any>fetchApplications()
async src/client.ts:4518fetchApplications(): Promise<any>fetchApplicationsDetectable()
async src/client.ts:4560fetchApplicationsDetectable(): Promise<any>fetchApplicationSkus()
async src/client.ts:4502fetchApplicationSkus(applicationId: string): Promise<any>fetchApplicationsPublic()
async src/client.ts:4569fetchApplicationsPublic(applicationIds: string | string[]): Promise<any>fetchApplicationsTrendingGlobal()
async src/client.ts:4585fetchApplicationsTrendingGlobal(): Promise<any>fetchAuthConsentRequired()
async src/client.ts:4594fetchAuthConsentRequired(): Promise<any>fetchChannel()
async src/client.ts:4603fetchChannel(channelId: string): Promise<any>fetchChannelCall()
async src/client.ts:4619fetchChannelCall(channelId: string): Promise<any>fetchChannelInvites()
async src/client.ts:4636fetchChannelInvites(channelId: string): Promise<any>fetchChannelPins()
async src/client.ts:6250fetchChannelPins(channelId: string, options?: FetchChannelPins): Promise<any>fetchChannelPollAnswerVoters()
async src/client.ts:4652fetchChannelPollAnswerVoters(
channelId: string,
messageId: string,
answerId: string,
options?: FetchChannelPollAnswerVoters,
): Promise<any>fetchChannelStoreListing()
async src/client.ts:4676fetchChannelStoreListing(channelId: string): Promise<any>fetchChannelThreadsActive()
async src/client.ts:4692fetchChannelThreadsActive(
channelId: string,
options?: FetchChannelThreadsActive,
): Promise<any>fetchChannelThreadsArchivedPrivate()
async src/client.ts:4711fetchChannelThreadsArchivedPrivate(
channelId: string,
options?: FetchChannelThreadsArchivedPrivate,
): Promise<any>fetchChannelThreadsArchivedPrivateJoined()
async src/client.ts:4734fetchChannelThreadsArchivedPrivateJoined(
channelId: string,
options?: FetchChannelThreadsArchivedPrivateJoined,
): Promise<any>fetchChannelThreadsArchivedPublic()
async src/client.ts:4756fetchChannelThreadsArchivedPublic(
channelId: string,
options?: FetchChannelThreadsArchivedPublic,
): Promise<any>fetchChannelWebhooks()
async src/client.ts:4779fetchChannelWebhooks(channelId: string): Promise<any>fetchConnectionAuthorizeUrl()
async src/client.ts:4804fetchConnectionAuthorizeUrl(
platform: string,
options?: FetchConnectionAuthorizeUrl,
): Promise<any>fetchConsentRequired()
async src/client.ts:4795fetchConsentRequired(): Promise<any>fetchDiscoverableGuilds()
async src/client.ts:4825fetchDiscoverableGuilds(): Promise<any>fetchDms()
async src/client.ts:4834fetchDms(userId?: string): Promise<any>Parameters
userId?
string
fetchEmojiGuild()
async src/client.ts:4848fetchEmojiGuild(emojiId: string): Promise<any>fetchExperiments()
async src/client.ts:4861fetchExperiments(fingerprint?: string): Promise<any>fetchGateway()
async src/client.ts:4877fetchGateway(): Promise<any>fetchGatewayBot()
async src/client.ts:4886fetchGatewayBot(): Promise<any>fetchGiftCode()
async src/client.ts:4895fetchGiftCode(code: string, options?: FetchGiftCode): Promise<any>fetchGuild()
async src/client.ts:4918fetchGuild(guildId: string, options?: FetchGuild): Promise<any>fetchGuildApplications()
async src/client.ts:4939fetchGuildApplications(guildId: string, channelId?: string): Promise<any>fetchGuildAuditLogs()
async src/client.ts:4958fetchGuildAuditLogs(guildId: string, options?: FetchGuildAuditLogs): Promise<any>fetchGuildAutoModerationRule()
async src/client.ts:4999fetchGuildAutoModerationRule(guildId: string, autoModerationRuleId: string): Promise<any>fetchGuildAutoModerationRules()
async src/client.ts:4983fetchGuildAutoModerationRules(guildId: string): Promise<any>fetchGuildBan()
async src/client.ts:5046fetchGuildBan(guildId: string, userId: string): Promise<any>fetchGuildBans()
async src/client.ts:5016fetchGuildBans(guildId: string, options?: FetchGuildBans): Promise<any>fetchGuildChannels()
async src/client.ts:5063fetchGuildChannels(guildId: string): Promise<any>fetchGuildEmoji()
async src/client.ts:5095fetchGuildEmoji(guildId: string, emojiId: string): Promise<any>fetchGuildEmojis()
async src/client.ts:5079fetchGuildEmojis(guildId: string): Promise<any>fetchGuildIntegrations()
async src/client.ts:5112fetchGuildIntegrations(guildId: string): Promise<any>fetchGuildInvites()
async src/client.ts:5128fetchGuildInvites(guildId: string): Promise<any>fetchGuildMember()
async src/client.ts:5188fetchGuildMember(guildId: string, userId: string): Promise<any>fetchGuildMembers()
async src/client.ts:5144fetchGuildMembers(guildId: string, options?: FetchGuildMembers): Promise<any>fetchGuildMembersSearch()
async src/client.ts:5166fetchGuildMembersSearch(guildId: string, options: FetchGuildMembersSearch): Promise<any>fetchGuildMemberVerification()
async src/client.ts:5205fetchGuildMemberVerification(guildId: string): Promise<any>fetchGuildOnboarding()
async src/client.ts:5320fetchGuildOnboarding(guildId: string): Promise<any>fetchGuildPremiumSubscriptions()
async src/client.ts:5221fetchGuildPremiumSubscriptions(guildId: string): Promise<any>fetchGuildPreview()
async src/client.ts:5387fetchGuildPreview(guildId: string): Promise<any>fetchGuildPruneCount()
async src/client.ts:5403fetchGuildPruneCount(guildId: string, options?: FetchGuildPruneCount): Promise<any>fetchGuildRole()
async src/client.ts:5333fetchGuildRole(guildId: string, roleId: string): Promise<any>fetchGuildRoleMemberCounts()
async src/client.ts:5348fetchGuildRoleMemberCounts(guildId: string): Promise<any>fetchGuildRoles()
async src/client.ts:5425fetchGuildRoles(guildId: string): Promise<any>fetchGuildScheduledEvent()
async src/client.ts:5441fetchGuildScheduledEvent(
guildId: string,
scheduledEventId: string,
options?: FetchGuildScheduledEvent,
): Promise<any>fetchGuildScheduledEvents()
async src/client.ts:5495fetchGuildScheduledEvents(
guildId: string,
options?: FetchGuildScheduledEvents,
): Promise<any>fetchGuildScheduledEventUsers()
async src/client.ts:5463fetchGuildScheduledEventUsers(
guildId: string,
scheduledEventId: string,
options?: FetchGuildScheduledEventUsers,
): Promise<any>fetchGuildSoundboardSound()
async src/client.ts:5516fetchGuildSoundboardSound(guildId: string, soundId: string): Promise<any>fetchGuildSoundboardSounds()
async src/client.ts:5533fetchGuildSoundboardSounds(guildId: string): Promise<any>fetchGuildSticker()
async src/client.ts:5642fetchGuildSticker(guildId: string, stickerId: string): Promise<any>fetchGuildStickers()
async src/client.ts:5659fetchGuildStickers(guildId: string): Promise<any>fetchGuildTemplates()
async src/client.ts:5692fetchGuildTemplates(guildId: string): Promise<any>fetchGuildThreadsActive()
async src/client.ts:5361fetchGuildThreadsActive(guildId: string): Promise<any>fetchGuildVanityUrl()
async src/client.ts:5708fetchGuildVanityUrl(guildId: string): Promise<any>fetchGuildVoiceState()
async src/client.ts:3556fetchGuildVoiceState(guildId: string, userId?: string): Promise<any>Parameters
guildId
string
userId?
string
fetchGuildWebhooks()
async src/client.ts:5724fetchGuildWebhooks(guildId: string): Promise<any>fetchGuildWelcomeScreen()
async src/client.ts:5374fetchGuildWelcomeScreen(guildId: string): Promise<any>fetchGuildWidget()
async src/client.ts:5740fetchGuildWidget(guildId: string): Promise<any>fetchGuildWidgetJson()
async src/client.ts:5756fetchGuildWidgetJson(guildId: string): Promise<any>fetchGuildWidgetPng()
async src/client.ts:5772fetchGuildWidgetPng(guildId: string, options?: FetchGuildWidgetPng): Promise<any>fetchInvite()
async src/client.ts:5850fetchInvite(code: string, options?: FetchInvite): Promise<any>fetchInviteTargetUsers()
async src/client.ts:5793fetchInviteTargetUsers(code: string): Promise<any>fetchInviteTargetUsersJobStatus()
async src/client.ts:5810fetchInviteTargetUsersJobStatus(code: string): Promise<any>fetchLobby()
async src/client.ts:3710fetchLobby(lobbyId: string): Promise<any>fetchLobbyMessages()
async src/client.ts:3726fetchLobbyMessages(lobbyId: string, options?: FetchLobbyMessages): Promise<any>fetchMe()
async src/client.ts:5873fetchMe(options?: FetchMe): Promise<any>fetchMeApplicationRoleConnection()
async src/client.ts:5891fetchMeApplicationRoleConnection(applicationId: string): Promise<any>fetchMeBillingPayments()
async src/client.ts:5939fetchMeBillingPayments(options?: FetchMeBillingPayments): Promise<any>fetchMeBillingPaymentSources()
async src/client.ts:5930fetchMeBillingPaymentSources(): Promise<any>fetchMeBillingSubscriptions()
async src/client.ts:5958fetchMeBillingSubscriptions(): Promise<any>fetchMeChannels()
async src/client.ts:5967fetchMeChannels(): Promise<any>fetchMeConnectionAccessToken()
async src/client.ts:5983fetchMeConnectionAccessToken(platform: string, accountId: string): Promise<any>fetchMeConnections()
async src/client.ts:5975fetchMeConnections(): Promise<any>fetchMeConnectionSubreddits()
async src/client.ts:6000fetchMeConnectionSubreddits(accountId: string): Promise<any>fetchMeFeedSettings()
async src/client.ts:6016fetchMeFeedSettings(options?: FetchMeFeedSettings): Promise<any>fetchMeGuildMember()
async src/client.ts:5917fetchMeGuildMember(guildId: string): Promise<any>fetchMeGuilds()
async src/client.ts:6034fetchMeGuilds(options?: FetchMeGuilds): Promise<any>fetchMessage()
async src/client.ts:6055fetchMessage(channelId: string, messageId: string): Promise<any>fetchMessages()
async src/client.ts:6072fetchMessages(channelId: string, options?: FetchMessages): Promise<any>fetchMeStickerPacks()
async src/client.ts:6107fetchMeStickerPacks(countryCode?: string): Promise<any>fetchOauth2Application()
async src/client.ts:6138fetchOauth2Application(applicationId?: string): Promise<any>Parameters
applicationId?
string
fetchOauth2ApplicationAssets()
async src/client.ts:6154fetchOauth2ApplicationAssets(applicationId: string): Promise<any>fetchOauth2Applications()
async src/client.ts:6120fetchOauth2Applications(options?: FetchOauth2Applications): Promise<any>fetchOauth2ApplicationWhitelist()
async src/client.ts:6170fetchOauth2ApplicationWhitelist(applicationId: string): Promise<any>fetchOauth2Authorize()
async src/client.ts:6186fetchOauth2Authorize(options?: FetchOauth2Authorize): Promise<any>fetchOauth2AuthorizeWebhookChannels()
async src/client.ts:6206fetchOauth2AuthorizeWebhookChannels(guildId: string): Promise<any>fetchOauth2Token()
async src/client.ts:6233fetchOauth2Token(tokenId: string): Promise<any>fetchOauth2Tokens()
async src/client.ts:6224fetchOauth2Tokens(): Promise<any>fetchPinnedMessages()
asyncdeprecated src/client.ts:6275fetchPinnedMessages(channelId: string): Promise<any>Deprecated. use fetchChannelPins, this route is deprecated and capped at 50 pins
fetchReactions()
async src/client.ts:6291fetchReactions(
channelId: string,
messageId: string,
emoji: string,
options?: FetchReactions,
): Promise<any>fetchSkuSubscription()
async src/client.ts:5599fetchSkuSubscription(skuId: string, subscriptionId: string): Promise<any>fetchSkuSubscriptions()
async src/client.ts:5616fetchSkuSubscriptions(skuId: string, options?: FetchSkuSubscriptions): Promise<any>fetchSoundboardDefaultSounds()
async src/client.ts:5549fetchSoundboardDefaultSounds(): Promise<any>fetchStageInstance()
async src/client.ts:6324fetchStageInstance(channelId: string): Promise<any>fetchSticker()
async src/client.ts:5558fetchSticker(stickerId: string): Promise<any>fetchStickerPack()
async src/client.ts:5574fetchStickerPack(stickerPackId: string): Promise<any>fetchStickerPacks()
async src/client.ts:5590fetchStickerPacks(): Promise<any>fetchStoreApplicationAssets()
async src/client.ts:6340fetchStoreApplicationAssets(applicationId: string): Promise<any>fetchStorePublishedListingsSku()
async src/client.ts:6375fetchStorePublishedListingsSku(skuId: string): Promise<any>fetchStorePublishedListingsSkus()
async src/client.ts:6356fetchStorePublishedListingsSkus(applicationId: string): Promise<any>fetchStorePublishedListingsSkuSubscriptionPlans()
async src/client.ts:6391fetchStorePublishedListingsSkuSubscriptionPlans(skuId: string): Promise<any>fetchStreamPreview()
async src/client.ts:6407fetchStreamPreview(streamKey: string): Promise<any>fetchTeam()
async src/client.ts:6430fetchTeam(teamId: string): Promise<any>fetchTeamApplications()
async src/client.ts:6446fetchTeamApplications(teamId: string): Promise<any>fetchTeamMember()
async src/client.ts:6478fetchTeamMember(teamId: string, userId: string): Promise<any>fetchTeamMembers()
async src/client.ts:6462fetchTeamMembers(teamId: string): Promise<any>fetchTeamPayouts()
async src/client.ts:6495fetchTeamPayouts(teamId: string, options?: FetchTeamPayouts): Promise<any>fetchTeams()
async src/client.ts:6421fetchTeams(): Promise<any>fetchTemplate()
async src/client.ts:6516fetchTemplate(templateId: string): Promise<any>fetchThreadMember()
async src/client.ts:6532fetchThreadMember(
channelId: string,
userId: string,
options?: FetchThreadMember,
): Promise<any>fetchThreadMembers()
async src/client.ts:6554fetchThreadMembers(channelId: string, options?: FetchThreadMembers): Promise<any>fetchUser()
async src/client.ts:6577fetchUser(userId: string): Promise<any>fetchUserActivityMetadata()
async src/client.ts:6593fetchUserActivityMetadata(
userId: string,
sessionId: string,
activityId: string,
): Promise<any>fetchUserChannels()
async src/client.ts:6611fetchUserChannels(userId: string): Promise<any>fetchUserProfile()
async src/client.ts:6627fetchUserProfile(userId: string): Promise<any>fetchVoiceIce()
async src/client.ts:6643fetchVoiceIce(): Promise<any>fetchVoiceRegions()
async src/client.ts:6652fetchVoiceRegions(guildId?: string): Promise<any>fetchWebhook()
async src/client.ts:6676fetchWebhook(webhookId: string): Promise<any>fetchWebhookToken()
async src/client.ts:6692fetchWebhookToken(webhookId: string, webhookToken: string): Promise<any>fetchWebhookTokenMessage()
async src/client.ts:6710fetchWebhookTokenMessage(
webhookId: string,
webhookToken: string,
messageId: string,
options?: FetchWebhookTokenMessage,
): Promise<any>followChannel()
async src/client.ts:6734followChannel(channelId: string, options: FollowChannel): Promise<any>forgotPassword()
async src/client.ts:6758forgotPassword(options: ForgotPassword): Promise<any>get()
async src/client.ts:301head()
async src/client.ts:309integrationJoin()
async src/client.ts:6776integrationJoin(integrationId: string): Promise<any>joinGuild()
async src/client.ts:6788joinGuild(guildId: string, options?: JoinGuild): Promise<any>joinThread()
async src/client.ts:6810joinThread(channelId: string): Promise<any>leaveGuild()
async src/client.ts:6824leaveGuild(guildId: string): Promise<any>leaveLobby()
async src/client.ts:3766leaveLobby(lobbyId: string): Promise<any>leaveThread()
async src/client.ts:6840leaveThread(channelId: string): Promise<any>login()
async src/client.ts:6856login(options: Login): Promise<any>loginMfaSms()
async src/client.ts:6879loginMfaSms(options: LoginMfaSms): Promise<any>loginMfaSmsSend()
async src/client.ts:6900loginMfaSmsSend(options: LoginMfaSmsSend): Promise<any>loginMfaTotp()
async src/client.ts:6918loginMfaTotp(options: LoginMfaTotp): Promise<any>logout()
async src/client.ts:6939logout(options?: Logout): Promise<any>oauth2Authorize()
async src/client.ts:6960oauth2Authorize(options?: Oauth2Authorize): Promise<any>on()
src/client.ts:349on(event: string | symbol, listener: (...args: any[]) => void): thisAdds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
server.on('connection', (stream) => {
console.log('someone connected!');
});Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// aParameters
event
string | symbol
listener
(...args: any[]) => void
The callback function
on(event: "request", listener: (payload: RequestPayload) => any): thison(event: "response", listener: (payload: ResponsePayload) => any): thisOverrides EventSpewer.on
options()
async src/client.ts:317patch()
async src/client.ts:325post()
async src/client.ts:333pruneInvalidRequests()
src/client.ts:195pruneInvalidRequests(): voidput()
async src/client.ts:341redeemGiftCode()
async src/client.ts:6991redeemGiftCode(code: string, options?: RedeemGiftCode): Promise<any>register()
async src/client.ts:7012register(options: Register): Promise<any>removeGuildBan()
async src/client.ts:7037removeGuildBan(guildId: string, userId: string, options?: RemoveGuildBan): Promise<any>removeGuildMember()
async src/client.ts:7058removeGuildMember(
guildId: string,
userId: string,
options?: RemoveGuildMember,
): Promise<any>removeGuildMemberRole()
async src/client.ts:7079removeGuildMemberRole(
guildId: string,
userId: string,
roleId: string,
options?: RemoveGuildMemberRole,
): Promise<any>removeInviteTargetUser()
async src/client.ts:7101removeInviteTargetUser(code: string, userId: string): Promise<any>removeLobbyMember()
async src/client.ts:3749removeLobbyMember(lobbyId: string, userId?: string): Promise<any>Parameters
lobbyId
string
userId?
string
removeMention()
async src/client.ts:7121removeMention(messageId: string): Promise<any>removeOauth2ApplicationWhitelistUser()
async src/client.ts:7137removeOauth2ApplicationWhitelistUser(applicationId: string, userId: string): Promise<any>removeRecipient()
async src/client.ts:7154removeRecipient(channelId: string, userId: string): Promise<any>removeTeamMember()
async src/client.ts:7171removeTeamMember(teamId: string, userId: string): Promise<any>removeThreadMember()
async src/client.ts:7188removeThreadMember(channelId: string, userId: string): Promise<any>request()
async src/client.ts:218resetOauth2Application()
async src/client.ts:7205resetOauth2Application(applicationId: string): Promise<any>resetOauth2ApplicationBot()
async src/client.ts:7222resetOauth2ApplicationBot(applicationId: string): Promise<any>resetPassword()
async src/client.ts:7239resetPassword(options: ResetPassword): Promise<any>resetPasswordMfa()
async src/client.ts:7262resetPasswordMfa(options: ResetPasswordMfa): Promise<any>search()
async src/client.ts:7283search(
searchType: "channel" | "guild",
searchId: string,
options?: SearchOptions,
retry?: boolean,
retryNumber?: number,
): Promise<any>Parameters
searchChannel()
async src/client.ts:7364searchChannel(
channelId: string,
options?: SearchOptions,
retry?: boolean,
retryNumber?: number,
): Promise<any>Parameters
searchGuild()
async src/client.ts:7373searchGuild(
guildId: string,
options?: SearchOptions,
retry?: boolean,
retryNumber?: number,
): Promise<any>Parameters
searchLobbies()
asyncdeprecated src/client.ts:7383searchLobbies(applicationId: string, options?: SearchLobbies): Promise<any>Deprecated. old GameSDK lobbies, this endpoint doesn't exist anymore
sendDownloadText()
async src/client.ts:7406sendDownloadText(number: string): Promise<any>sendFriendRequest()
async src/client.ts:7424sendFriendRequest(options: SendFriendRequest): Promise<any>sendLobbyData()
asyncdeprecated src/client.ts:7466sendLobbyData(lobbyId: string, data: string): Promise<any>Deprecated. old GameSDK lobbies, use createLobbyMessage
sendSoundboardSound()
async src/client.ts:7443sendSoundboardSound(channelId: string, options: SendSoundboardSound): Promise<any>setAuthType()
src/client.ts:206setAuthType(type: string): voidstartChannelCallRinging()
async src/client.ts:7485startChannelCallRinging(
channelId: string,
options?: StartChannelCallRinging,
): Promise<any>stopChannelCallRinging()
async src/client.ts:7504stopChannelCallRinging(channelId: string, options?: StopChannelCallRinging): Promise<any>submitConnectionPinCode()
async src/client.ts:7523submitConnectionPinCode(platform: string, pin: string): Promise<any>submitOauth2ApplicationApproval()
async src/client.ts:7540submitOauth2ApplicationApproval(applicationId: string): Promise<any>syncGuildIntegration()
async src/client.ts:7556syncGuildIntegration(guildId: string, integrationId: string): Promise<any>syncGuildTemplate()
async src/client.ts:5675syncGuildTemplate(guildId: string, templateId: string): Promise<any>transferOauth2Application()
async src/client.ts:7573transferOauth2Application(
applicationId: string,
options: TransferOauth2Application,
): Promise<any>triggerTyping()
async src/client.ts:7595triggerTyping(channelId: string): Promise<any>unAckChannel()
async src/client.ts:7611unAckChannel(channelId: string): Promise<any>verify()
async src/client.ts:7629verify(options: Verify): Promise<any>verifyCaptcha()
async src/client.ts:7648verifyCaptcha(options: VerifyCaptcha): Promise<any>verifyResend()
async src/client.ts:7666verifyResend(): Promise<any>