Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RestClient

Hierarchy

  • RestClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly client

client: ShardClient

Readonly raw

raw: Client

Accessors

isBot

  • get isBot(): boolean

isUser

  • get isUser(): boolean

Methods

acceptAgreements

  • acceptAgreements(privacy?: boolean, terms?: boolean): Promise<any>

  • Parameters

    • privacy: boolean = true
    • terms: boolean = true

    Returns Promise<any>

acceptInvite

  • acceptInvite(code: string): Promise<any>

acceptTeamInvite

  • acceptTeamInvite(token: string): Promise<any>

acceptTemplate

  • acceptTemplate(templateId: string, options: AcceptTemplate): Promise<Guild>

ackChannelMessage

  • ackChannelMessage(channelId: string, messageId: string, token: string): Promise<any>

  • Parameters

    • channelId: string
    • messageId: string
    • token: string

    Returns Promise<any>

ackChannelPins

  • ackChannelPins(channelId: string): Promise<any>

ackGuild

  • ackGuild(guildId: string): Promise<any>

activateOauth2ApplicationLicense

  • activateOauth2ApplicationLicense(applicationId: string, options: ActivateOauth2ApplicationLicense): Promise<any>

  • Parameters

    • applicationId: string
    • options: ActivateOauth2ApplicationLicense

    Returns Promise<any>

addConnection

  • addConnection(platform: string, accountId: string, options: AddConnection): Promise<any>

  • Parameters

    • platform: string
    • accountId: string
    • options: AddConnection

    Returns Promise<any>

addGuildMember

  • addGuildMember(guildId: string, userId: string, options: AddGuildMember): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • options: AddGuildMember

    Returns Promise<any>

addGuildMemberRole

  • addGuildMemberRole(guildId: string, userId: string, roleId: string, options?: AddGuildMemberRole): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • roleId: string
    • options: AddGuildMemberRole = {}

    Returns Promise<any>

addOauth2ApplicationWhitelistUser

  • addOauth2ApplicationWhitelistUser(applicationId: string, options: AddOauth2ApplicationWhitelistUser): Promise<any>

  • Parameters

    • applicationId: string
    • options: AddOauth2ApplicationWhitelistUser

    Returns Promise<any>

addPinnedMessage

  • addPinnedMessage(channelId: string, messageId: string): Promise<any>

addRecipient

  • addRecipient(channelId: string, userId: string): Promise<any>

addTeamMember

  • addTeamMember(teamId: string, options: AddTeamMember): Promise<any>

addThreadMember

  • addThreadMember(channelId: string, userId: string): Promise<any>

authorizeIpAddress

  • authorizeIpAddress(options: AuthorizeIpAddress): Promise<any>

beginGuildPrune

  • beginGuildPrune(guildId: string, options?: BeginGuildPrune): Promise<any>

  • Parameters

    • guildId: string
    • options: BeginGuildPrune = {}

    Returns Promise<any>

bulkDeleteMessages

  • bulkDeleteMessages(channelId: string, messageIds: string[]): Promise<any>

bulkOverwriteApplicationCommands

bulkOverwriteApplicationGuildCommands

  • bulkOverwriteApplicationGuildCommands(applicationId: string, guildId: string, commands: CreateApplicationGuildCommand[]): Promise<BaseCollection<string, ApplicationCommand>>

bulkOverwriteApplicationGuildCommandsPermissions

  • bulkOverwriteApplicationGuildCommandsPermissions(applicationId: string, guildId: string, permissions: BulkOverwriteApplicationGuildCommandsPermissions): Promise<BaseCollection<string, ApplicationCommandPermissions>>

connectionCallback

  • connectionCallback(platform: string, options: ConnectionCallback): Promise<any>

  • Parameters

    • platform: string
    • options: ConnectionCallback

    Returns Promise<any>

createApplicationCommand

  • createApplicationCommand(applicationId: string, options: CreateApplicationCommand): Promise<any>

  • Parameters

    • applicationId: string
    • options: CreateApplicationCommand

    Returns Promise<any>

createApplicationGuildCommand

  • createApplicationGuildCommand(applicationId: string, guildId: string, options: CreateApplicationCommand): Promise<any>

  • Parameters

    • applicationId: string
    • guildId: string
    • options: CreateApplicationCommand

    Returns Promise<any>

createApplicationNews

  • createApplicationNews(options: CreateApplicationNews): Promise<ApplicationNews>

createChannelInvite

  • createChannelInvite(channelId: string, options?: CreateChannelInvite): Promise<Invite>

createChannelMessageThread

  • createChannelMessageThread(channelId: string, messageId: string, options: CreateChannelMessageThread): Promise<ChannelGuildThread>

createChannelStoreListingGrantEntitlement

  • createChannelStoreListingGrantEntitlement(channelId: string): Promise<any>

createChannelThread

  • createChannelThread(channelId: string, options: CreateChannelThread): Promise<ChannelGuildThread>

createDm

createGuild

  • createGuild(options: CreateGuild): Promise<Guild>

createGuildBan

  • createGuildBan(guildId: string, userId: string, options?: CreateGuildBan): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • options: CreateGuildBan = {}

    Returns Promise<any>

createGuildChannel

  • createGuildChannel(guildId: string, options: CreateGuildChannel, updateCache?: boolean): Promise<Channel>

createGuildEmoji

  • createGuildEmoji(guildId: string, options: CreateGuildEmoji, updateCache?: boolean): Promise<Emoji>

  • Parameters

    • guildId: string
    • options: CreateGuildEmoji
    • updateCache: boolean = true

    Returns Promise<Emoji>

createGuildIntegration

  • createGuildIntegration(guildId: string, options: CreateGuildIntegration): Promise<any>

  • Parameters

    • guildId: string
    • options: CreateGuildIntegration

    Returns Promise<any>

createGuildRole

  • createGuildRole(guildId: string, options?: CreateGuildRole): Promise<Role>

createGuildSticker

  • createGuildSticker(guildId: string, options: CreateGuildSticker): Promise<Sticker>

createGuildTemplate

  • createGuildTemplate(guildId: string, options: CreateGuildTemplate): Promise<Template>

createInteractionResponse

  • createInteractionResponse(interactionId: string, token: string, options: number | (CreateInteractionResponse & { data?: { listenerId?: string } }), data?: string | (CreateInteractionResponseInnerPayload & { listenerId?: string })): Promise<any>

  • Parameters

    • interactionId: string
    • token: string
    • options: number | (CreateInteractionResponse & { data?: { listenerId?: string } })
    • Optional data: string | (CreateInteractionResponseInnerPayload & { listenerId?: string })

    Returns Promise<any>

createLobby

  • createLobby(applicationId: string, options?: CreateLobby): Promise<any>

  • Parameters

    • applicationId: string
    • options: CreateLobby = {}

    Returns Promise<any>

createMeBillingPaymentSource

  • createMeBillingPaymentSource(options: CreateMeBillingPaymentSource): Promise<any>

createMeBillingSubscription

  • createMeBillingSubscription(options: CreateMeBillingSubscription): Promise<any>

createMessage

  • createMessage(channelId: string, options?: string | CreateMessage): Promise<Message>

createOauth2Application

  • createOauth2Application(options: CreateOauth2Application): Promise<any>

createOauth2ApplicationAsset

  • createOauth2ApplicationAsset(applicationId: string, options: CreateOauth2ApplicationAsset): Promise<Oauth2ApplicationAsset>

createOauth2ApplicationBot

  • createOauth2ApplicationBot(applicationId: string): Promise<any>

createReaction

  • createReaction(channelId: string, messageId: string, emoji: string): Promise<any>

  • Parameters

    • channelId: string
    • messageId: string
    • emoji: string

    Returns Promise<any>

createStageInstance

  • createStageInstance(options: CreateStageInstance): Promise<StageInstance>

createStoreApplicationAsset

  • createStoreApplicationAsset(applicationId: string, options: CreateStoreApplicationAsset): Promise<StoreApplicationAsset>

createTeam

  • createTeam(options?: CreateTeam): Promise<any>

createWebhook

  • createWebhook(channelId: string, options: CreateWebhook): Promise<Webhook>

crosspostMessage

  • crosspostMessage(channelId: string, messageId: string): Promise<Message>

delete

  • delete(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

deleteAccount

  • deleteAccount(options: DeleteAccount): Promise<any>

deleteApplicationCommand

  • deleteApplicationCommand(applicationId: string, commandId: string): Promise<any>

deleteApplicationGuildCommand

  • deleteApplicationGuildCommand(applicationId: string, guildId: string, commandId: string): Promise<any>

  • Parameters

    • applicationId: string
    • guildId: string
    • commandId: string

    Returns Promise<any>

deleteChannel

  • deleteChannel(channelId: string, options?: DeleteChannel): Promise<Channel>

deleteChannelOverwrite

  • deleteChannelOverwrite(channelId: string, overwriteId: string, options?: DeleteChannelOverwrite): Promise<any>

  • Parameters

    • channelId: string
    • overwriteId: string
    • options: DeleteChannelOverwrite = {}

    Returns Promise<any>

deleteConnection

  • deleteConnection(platform: string, accountId: string): Promise<any>

deleteGuild

  • deleteGuild(guildId: string, options?: DeleteGuild): Promise<any>

deleteGuildEmoji

  • deleteGuildEmoji(guildId: string, emojiId: string, options?: DeleteGuildEmoji): Promise<any>

  • Parameters

    • guildId: string
    • emojiId: string
    • options: DeleteGuildEmoji = {}

    Returns Promise<any>

deleteGuildIntegration

  • deleteGuildIntegration(guildId: string, integrationId: string, options?: DeleteGuildIntegration): Promise<any>

  • Parameters

    • guildId: string
    • integrationId: string
    • options: DeleteGuildIntegration = {}

    Returns Promise<any>

deleteGuildPremiumSubscription

  • deleteGuildPremiumSubscription(guildId: string, subscriptionId: string): Promise<any>

deleteGuildRole

  • deleteGuildRole(guildId: string, roleId: string, options?: DeleteGuildRole): Promise<any>

  • Parameters

    • guildId: string
    • roleId: string
    • options: DeleteGuildRole = {}

    Returns Promise<any>

deleteGuildSticker

  • deleteGuildSticker(guildId: string, stickerId: string, options?: DeleteGuildSticker): Promise<any>

  • Parameters

    • guildId: string
    • stickerId: string
    • options: DeleteGuildSticker = {}

    Returns Promise<any>

deleteGuildTemplate

  • deleteGuildTemplate(guildId: string, templateId: string): Promise<any>

deleteInvite

  • deleteInvite(code: string, options?: DeleteInvite): Promise<Invite>

deleteLobby

  • deleteLobby(lobbyId: string): Promise<any>

deleteMeBillingPaymentSource

  • deleteMeBillingPaymentSource(paymentSourceId: string): Promise<any>

deleteMeBillingSubscription

  • deleteMeBillingSubscription(subscriptionId: string): Promise<any>

deleteMessage

  • deleteMessage(channelId: string, messageId: string, options?: DeleteMessage): Promise<any>

  • Parameters

    • channelId: string
    • messageId: string
    • options: DeleteMessage = {}

    Returns Promise<any>

deleteOauth2Application

  • deleteOauth2Application(applicationId: string, options?: DeleteOauth2Application): Promise<any>

  • Parameters

    • applicationId: string
    • options: DeleteOauth2Application = {}

    Returns Promise<any>

deleteOauth2ApplicationAsset

  • deleteOauth2ApplicationAsset(applicationId: string, assetId: string): Promise<any>

deletePinnedMessage

  • deletePinnedMessage(channelId: string, messageId: string): Promise<any>

deleteReaction

  • deleteReaction(channelId: string, messageId: string, emoji: string, userId?: string): Promise<any>

  • Parameters

    • channelId: string
    • messageId: string
    • emoji: string
    • userId: string = '@me'

    Returns Promise<any>

deleteReactions

  • deleteReactions(channelId: string, messageId: string): Promise<any>

deleteReactionsEmoji

  • deleteReactionsEmoji(channelId: string, messageId: string, emoji: string): Promise<any>

  • Parameters

    • channelId: string
    • messageId: string
    • emoji: string

    Returns Promise<any>

deleteRelationship

  • deleteRelationship(userId: string): Promise<any>

deleteStageInstance

  • deleteStageInstance(channelId: string): Promise<any>

deleteStoreApplicationAsset

  • deleteStoreApplicationAsset(applicationId: string, assetId: string): Promise<any>

deleteTeam

  • deleteTeam(teamId: string, options?: DeleteTeam): Promise<any>

deleteWebhook

  • deleteWebhook(webhookId: string, options?: DeleteWebhook): Promise<any>

  • Parameters

    • webhookId: string
    • options: DeleteWebhook = {}

    Returns Promise<any>

deleteWebhookToken

  • deleteWebhookToken(webhookId: string, webhookToken: string, options?: DeleteWebhook): Promise<any>

  • Parameters

    • webhookId: string
    • webhookToken: string
    • options: DeleteWebhook = {}

    Returns Promise<any>

deleteWebhookTokenMessage

  • deleteWebhookTokenMessage(webhookId: string, webhookToken: string, messageId: string): Promise<any>

  • Parameters

    • webhookId: string
    • webhookToken: string
    • messageId: string

    Returns Promise<any>

disableAccount

  • disableAccount(options: DisableAccount): Promise<any>

editApplicationCommand

  • editApplicationCommand(applicationId: string, commandId: string, options?: Partial<CreateApplicationCommand>): Promise<ApplicationCommand>

editApplicationGuildCommand

  • editApplicationGuildCommand(applicationId: string, guildId: string, commandId: string, options?: Partial<CreateApplicationCommand>): Promise<ApplicationCommand>

editApplicationGuildCommandPermissions

  • editApplicationGuildCommandPermissions(applicationId: string, guildId: string, commandId: string, options: EditApplicationGuildCommandPermissions): Promise<ApplicationCommandPermissions>

editApplicationNews

  • editApplicationNews(newsId: string, options?: EditApplicationNews): Promise<any>

  • Parameters

    • newsId: string
    • options: EditApplicationNews = {}

    Returns Promise<any>

editChannel

  • editChannel(channelId: string, options?: EditChannel, updateCache?: boolean): Promise<Channel>

editChannelOverwrite

  • editChannelOverwrite(channelId: string, overwriteId: string, options?: EditChannelOverwrite): Promise<any>

  • Parameters

    • channelId: string
    • overwriteId: string
    • options: EditChannelOverwrite = {}

    Returns Promise<any>

editConnection

  • editConnection(platform: string, accountId: string, options?: EditConnection): Promise<any>

  • Parameters

    • platform: string
    • accountId: string
    • options: EditConnection = {}

    Returns Promise<any>

editGuild

  • editGuild(guildId: string, options?: EditGuild, updateCache?: boolean): Promise<Guild>

  • Parameters

    • guildId: string
    • options: EditGuild = {}
    • updateCache: boolean = true

    Returns Promise<Guild>

editGuildChannels

  • editGuildChannels(guildId: string, channels: EditGuildChannels, options?: EditGuildChannelsExtra): Promise<any>

  • Parameters

    • guildId: string
    • channels: EditGuildChannels
    • options: EditGuildChannelsExtra = {}

    Returns Promise<any>

editGuildEmbed

  • editGuildEmbed(guildId: string, options: EditGuildEmbed): Promise<any>

editGuildEmoji

  • editGuildEmoji(guildId: string, emojiId: string, options?: EditGuildEmoji, updateCache?: boolean): Promise<Emoji>

  • Parameters

    • guildId: string
    • emojiId: string
    • options: EditGuildEmoji = {}
    • updateCache: boolean = true

    Returns Promise<Emoji>

editGuildIntegration

  • editGuildIntegration(guildId: string, integrationId: string, options?: EditGuildIntegration): Promise<any>

  • Parameters

    • guildId: string
    • integrationId: string
    • options: EditGuildIntegration = {}

    Returns Promise<any>

editGuildMember

  • editGuildMember(guildId: string, userId: string, options?: EditGuildMember): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • options: EditGuildMember = {}

    Returns Promise<any>

editGuildMemberVerification

  • editGuildMemberVerification(guildId: string, options?: EditGuildMemberVerification): Promise<any>

  • Parameters

    • guildId: string
    • options: EditGuildMemberVerification = {}

    Returns Promise<any>

editGuildMfaLevel

  • editGuildMfaLevel(guildId: string, options: EditGuildMfaLevel): Promise<any>

editGuildNick

  • editGuildNick(guildId: string, nick: string, options?: EditGuildNick): Promise<any>

  • Parameters

    • guildId: string
    • nick: string
    • options: EditGuildNick = {}

    Returns Promise<any>

editGuildRole

  • editGuildRole(guildId: string, roleId: string, options?: EditGuildRole, updateCache?: boolean): Promise<Role>

  • Parameters

    • guildId: string
    • roleId: string
    • options: EditGuildRole = {}
    • updateCache: boolean = true

    Returns Promise<Role>

editGuildRolePositions

  • editGuildRolePositions(guildId: string, roles: EditGuildRolePositions, options?: EditGuildRolePositionsExtra, updateCache?: boolean): Promise<BaseCollection<string, Role>>

  • Parameters

    • guildId: string
    • roles: EditGuildRolePositions
    • options: EditGuildRolePositionsExtra = {}
    • updateCache: boolean = true

    Returns Promise<BaseCollection<string, Role>>

editGuildSticker

  • editGuildSticker(guildId: string, stickerId: string, options?: EditGuildSticker, updateCache?: boolean): Promise<Sticker>

  • Parameters

    • guildId: string
    • stickerId: string
    • options: EditGuildSticker = {}
    • updateCache: boolean = true

    Returns Promise<Sticker>

editGuildVanity

  • editGuildVanity(guildId: string, code: string, options?: EditGuildVanity): Promise<any>

  • Parameters

    • guildId: string
    • code: string
    • options: EditGuildVanity = {}

    Returns Promise<any>

editGuildVoiceState

  • editGuildVoiceState(guildId: string, userId: string, options: EditGuildVoiceState): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • options: EditGuildVoiceState

    Returns Promise<any>

editLobby

  • editLobby(lobbyId: string, options?: EditLobby): Promise<any>

editLobbyMember

  • editLobbyMember(lobbyId: string, userId: string, options?: EditLobbyMember): Promise<any>

  • Parameters

    • lobbyId: string
    • userId: string
    • options: EditLobbyMember = {}

    Returns Promise<any>

editMe

  • editMe(options?: EditMe, updateCache?: boolean): Promise<UserMe>

editMeBillingPaymentSource

  • editMeBillingPaymentSource(paymentSourceId: string, options?: EditMeBillingPaymentSource): Promise<any>

  • Parameters

    • paymentSourceId: string
    • options: EditMeBillingPaymentSource = {}

    Returns Promise<any>

editMeBillingSubscription

  • editMeBillingSubscription(subscriptionId: string, options?: EditMeBillingSubscription): Promise<any>

  • Parameters

    • subscriptionId: string
    • options: EditMeBillingSubscription = {}

    Returns Promise<any>

editMessage

  • editMessage(channelId: string, messageId: string, options?: string | EditMessage, updateCache?: boolean): Promise<Message>

  • Parameters

    • channelId: string
    • messageId: string
    • options: string | EditMessage = {}
    • updateCache: boolean = true

    Returns Promise<Message>

editNote

  • editNote(userId: string, note: string): Promise<any>

editOauth2Application

  • editOauth2Application(applicationId: string, options?: EditOauth2Application): Promise<any>

  • Parameters

    • applicationId: string
    • options: EditOauth2Application = {}

    Returns Promise<any>

editRelationship

  • editRelationship(userId: string, type: number): Promise<any>

editSettings

  • editSettings(options?: EditSettings): Promise<any>

editStageInstance

  • editStageInstance(channelId: string, options?: EditStageInstance): Promise<any>

  • Parameters

    • channelId: string
    • options: EditStageInstance = {}

    Returns Promise<any>

editTeam

  • editTeam(teamId: string, options?: EditTeam): Promise<any>

editUser

  • editUser(options?: EditMe): Promise<UserMe>

editWebhook

  • editWebhook(webhookId: string, options?: EditWebhook): Promise<Webhook>

editWebhookToken

  • editWebhookToken(webhookId: string, webhookToken: string, options?: EditWebhook): Promise<Webhook>

editWebhookTokenMessage

  • editWebhookTokenMessage(webhookId: string, webhookToken: string, messageId: string, options?: EditWebhookTokenMessage, updateCache?: boolean): Promise<Message>

  • Parameters

    • webhookId: string
    • webhookToken: string
    • messageId: string
    • options: EditWebhookTokenMessage = {}
    • updateCache: boolean = true

    Returns Promise<Message>

enableOauth2ApplicationAssets

  • enableOauth2ApplicationAssets(applicationId: string): Promise<any>

enableOauth2ApplicationRpc

  • enableOauth2ApplicationRpc(applicationId: string): Promise<any>

executeWebhook

  • executeWebhook(webhookId: string, webhookToken: string, options?: string | ExecuteWebhook, compatibleType?: string): Promise<null | Message>

  • Parameters

    • webhookId: string
    • webhookToken: string
    • options: string | ExecuteWebhook = {}
    • Optional compatibleType: string

    Returns Promise<null | Message>

fetchActivities

  • fetchActivities(): Promise<any>

fetchApplication

  • fetchApplication(applicationId: string): Promise<Application>

fetchApplicationCommand

  • fetchApplicationCommand(applicationId: string, commandId: string): Promise<ApplicationCommand>

fetchApplicationCommands

fetchApplicationGuildCommand

  • fetchApplicationGuildCommand(applicationId: string, guildId: string, commandId: string): Promise<ApplicationCommand>

fetchApplicationGuildCommandPermissions

fetchApplicationGuildCommands

fetchApplicationGuildCommandsPermissions

fetchApplicationNews

fetchApplicationNewsId

fetchApplications

  • fetchApplications(): Promise<any>

fetchApplicationsDetectable

fetchApplicationsPublic

  • fetchApplicationsPublic(applicationIds: string | string[]): Promise<any>

fetchApplicationsTrendingGlobal

  • fetchApplicationsTrendingGlobal(): Promise<any>

fetchAuthConsentRequired

  • fetchAuthConsentRequired(): Promise<any>

fetchChannel

  • fetchChannel(channelId: string, updateCache?: boolean): Promise<Channel>

fetchChannelCall

  • fetchChannelCall(channelId: string): Promise<any>

fetchChannelInvites

fetchChannelStoreListing

  • fetchChannelStoreListing(channelId: string): Promise<StoreListing>

fetchChannelThreadsActive

fetchChannelThreadsArchivedPrivate

fetchChannelThreadsArchivedPrivateJoined

fetchChannelThreadsArchivedPublic

fetchChannelWebhooks

fetchConnectionAuthorizeUrl

  • fetchConnectionAuthorizeUrl(platform: string): Promise<any>

fetchConsentRequired

  • fetchConsentRequired(): Promise<any>

fetchDiscoverableGuilds

  • fetchDiscoverableGuilds(): Promise<any>

fetchDms

fetchExperiments

  • fetchExperiments(fingerprint?: string): Promise<any>

fetchGateway

  • fetchGateway(): Promise<any>

fetchGatewayBot

  • fetchGatewayBot(): Promise<any>

fetchGiftCode

  • fetchGiftCode(code: string, options?: FetchGiftCode): Promise<Gift>

fetchGuild

  • fetchGuild(guildId: string, options?: FetchGuild, updateCache?: boolean): Promise<Guild>

fetchGuildApplications

  • fetchGuildApplications(guildId: string, channelId?: string): Promise<any>

fetchGuildAuditLogs

  • fetchGuildAuditLogs(guildId: string, options?: FetchGuildAuditLogs): Promise<BaseCollection<string, AuditLog>>

fetchGuildBans

fetchGuildChannels

fetchGuildEmbed

  • fetchGuildEmbed(guildId: string): Promise<any>

fetchGuildEmoji

  • fetchGuildEmoji(guildId: string, emojiId: string): Promise<Emoji>

fetchGuildEmojis

fetchGuildIntegrations

fetchGuildInvites

fetchGuildMember

  • fetchGuildMember(guildId: string, userId: string): Promise<Member>

fetchGuildMemberVerification

  • fetchGuildMemberVerification(guildId: string): Promise<any>

fetchGuildMembers

  • fetchGuildMembers(guildId: string, options?: FetchGuildMembers): Promise<BaseCollection<string, Member>>

fetchGuildMembersSearch

  • fetchGuildMembersSearch(guildId: string, options: FetchGuildMembersSearch): Promise<BaseCollection<string, Member>>

fetchGuildPremiumSubscriptions

fetchGuildPreview

  • fetchGuildPreview(guildId: string): Promise<any>

fetchGuildPruneCount

  • fetchGuildPruneCount(guildId: string, options?: FetchGuildPruneCount): Promise<any>

  • Parameters

    • guildId: string
    • options: FetchGuildPruneCount = {}

    Returns Promise<any>

fetchGuildRoles

fetchGuildSticker

  • fetchGuildSticker(guildId: string, stickerId: string): Promise<Sticker>

fetchGuildStickers

fetchGuildTemplates

fetchGuildVanityUrl

  • fetchGuildVanityUrl(guildId: string): Promise<any>

fetchGuildWebhooks

fetchGuildWidget

  • fetchGuildWidget(guildId: string): Promise<any>

fetchGuildWidgetJson

  • fetchGuildWidgetJson(guildId: string): Promise<any>

fetchGuildWidgetPng

  • fetchGuildWidgetPng(guildId: string, options?: FetchGuildWidgetPng): Promise<any>

  • Parameters

    • guildId: string
    • options: FetchGuildWidgetPng = {}

    Returns Promise<any>

fetchInvite

  • fetchInvite(code: string, options?: FetchInvite): Promise<Invite>

fetchMe

  • fetchMe(options?: FetchMe): Promise<UserMe>

fetchMeBillingPaymentSources

  • fetchMeBillingPaymentSources(): Promise<any>

fetchMeBillingPayments

  • fetchMeBillingPayments(options?: FetchMeBillingPayments): Promise<any>

fetchMeBillingSubscriptions

  • fetchMeBillingSubscriptions(): Promise<any>

fetchMeChannels

fetchMeConnectionAccessToken

  • fetchMeConnectionAccessToken(platform: string, accountId: string): Promise<any>

fetchMeConnectionSubreddits

  • fetchMeConnectionSubreddits(accountId: string): Promise<any>

fetchMeConnections

fetchMeFeedSettings

  • fetchMeFeedSettings(options?: FetchMeFeedSettings): Promise<any>

fetchMeGuilds

fetchMentions

fetchMessage

  • fetchMessage(channelId: string, messageId: string): Promise<Message>

fetchMessages

fetchOauth2Application

fetchOauth2ApplicationAssets

fetchOauth2ApplicationWhitelist

  • fetchOauth2ApplicationWhitelist(applicationId: string): Promise<any>

fetchOauth2Applications

fetchOauth2Authorize

  • fetchOauth2Authorize(options?: FetchOauth2Authorize): Promise<any>

fetchOauth2AuthorizeWebhookChannels

  • fetchOauth2AuthorizeWebhookChannels(guildId: string): Promise<any>

fetchOauth2Token

  • fetchOauth2Token(tokenId: string): Promise<any>

fetchOauth2Tokens

  • fetchOauth2Tokens(): Promise<any>

fetchPinnedMessages

fetchReactions

  • fetchReactions(channelId: string, messageId: string, emoji: string, options?: FetchReactions): Promise<BaseCollection<string, User>>

fetchStageInstance

fetchStoreApplicationAssets

fetchStorePublishedListingsSku

  • fetchStorePublishedListingsSku(skuId: string): Promise<any>

fetchStorePublishedListingsSkuSubscriptionPlans

  • fetchStorePublishedListingsSkuSubscriptionPlans(skuId: string): Promise<any>

fetchStorePublishedListingsSkus

  • fetchStorePublishedListingsSkus(applicationId: string): Promise<any>

fetchStreamPreview

  • fetchStreamPreview(streamKey: string): Promise<any>

fetchTeam

  • fetchTeam(teamId: string): Promise<Team>

fetchTeamApplications

  • fetchTeamApplications(teamId: string): Promise<any>

fetchTeamMember

  • fetchTeamMember(teamId: string, userId: string): Promise<TeamMember>

fetchTeamMembers

fetchTeamPayouts

  • fetchTeamPayouts(teamId: string, options?: FetchTeamPayouts): Promise<any>

fetchTeams

fetchTemplate

  • fetchTemplate(templateId: string): Promise<Template>

fetchThreadMembers

fetchUser

fetchUserActivityMetadata

  • fetchUserActivityMetadata(userId: string, sessionId: string, activityId: string): Promise<any>

  • Parameters

    • userId: string
    • sessionId: string
    • activityId: string

    Returns Promise<any>

fetchUserChannels

fetchUserProfile

  • fetchUserProfile(userId: string): Promise<Profile>

fetchVoiceIce

  • fetchVoiceIce(): Promise<any>

fetchVoiceRegions

fetchWebhook

  • fetchWebhook(webhookId: string): Promise<Webhook>

fetchWebhookToken

  • fetchWebhookToken(webhookId: string, webhookToken: string): Promise<Webhook>

fetchWebhookTokenMessage

  • fetchWebhookTokenMessage(webhookId: string, webhookToken: string, messageId: string): Promise<Message>

followChannel

  • followChannel(channelId: string, options: FollowChannel): Promise<{ channelId: string; webhookId: string }>

  • Parameters

    • channelId: string
    • options: FollowChannel

    Returns Promise<{ channelId: string; webhookId: string }>

forgotPassword

  • forgotPassword(options: ForgotPassword): Promise<any>

get

  • get(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

head

  • head(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

integrationJoin

  • integrationJoin(integrationId: string): Promise<any>

joinGuild

  • joinGuild(guildId: string, options?: JoinGuild): Promise<any>

joinThread

  • joinThread(channelId: string): Promise<any>

leaveGuild

  • leaveGuild(guildId: string): Promise<any>

leaveThread

  • leaveThread(channelId: string): Promise<any>

login

  • login(options: Login): Promise<any>

loginMfaSms

  • loginMfaSms(options: LoginMfaSms): Promise<any>

loginMfaSmsSend

  • loginMfaSmsSend(options: LoginMfaSmsSend): Promise<any>

loginMfaTotp

  • loginMfaTotp(options: LoginMfaTotp): Promise<any>

logout

  • logout(options?: Logout): Promise<any>

oauth2Authorize

  • oauth2Authorize(options?: Oauth2Authorize): Promise<any>

options

  • options(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

patch

  • patch(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

post

  • post(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

put

  • put(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

redeemGiftCode

  • redeemGiftCode(code: string, options?: RedeemGiftCode): Promise<any>

register

  • register(options: Register): Promise<any>

removeGuildBan

  • removeGuildBan(guildId: string, userId: string, options?: RemoveGuildBan): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • options: RemoveGuildBan = {}

    Returns Promise<any>

removeGuildMember

  • removeGuildMember(guildId: string, userId: string, options?: RemoveGuildMember): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • options: RemoveGuildMember = {}

    Returns Promise<any>

removeGuildMemberRole

  • removeGuildMemberRole(guildId: string, userId: string, roleId: string, options?: RemoveGuildMemberRole): Promise<any>

  • Parameters

    • guildId: string
    • userId: string
    • roleId: string
    • options: RemoveGuildMemberRole = {}

    Returns Promise<any>

removeMention

  • removeMention(messageId: string): Promise<any>

removeOauth2ApplicationWhitelistUser

  • removeOauth2ApplicationWhitelistUser(applicationId: string, userId: string): Promise<any>

removeRecipient

  • removeRecipient(channelId: string, userId: string): Promise<any>

removeTeamMember

  • removeTeamMember(teamId: string, userId: string): Promise<any>

removeThreadMember

  • removeThreadMember(channelId: string, userId: string): Promise<any>

request

  • request(info: string | Options | URL, init?: Options): Promise<any>

  • Parameters

    • info: string | Options | URL
    • Optional init: Options

    Returns Promise<any>

resetOauth2Application

  • resetOauth2Application(applicationId: string): Promise<any>

resetOauth2ApplicationBot

  • resetOauth2ApplicationBot(applicationId: string): Promise<any>

resetPassword

  • resetPassword(options: ResetPassword): Promise<any>

resetPasswordMfa

  • resetPasswordMfa(options: ResetPasswordMfa): Promise<any>

search

  • search(searchType: "channel" | "guild", searchId: string, options?: SearchOptions, retry?: boolean, retryNumber?: number): Promise<any>

  • Parameters

    • searchType: "channel" | "guild"
    • searchId: string
    • options: SearchOptions = {}
    • retry: boolean = true
    • retryNumber: number = 0

    Returns Promise<any>

searchChannel

  • searchChannel(channelId: string, options?: SearchOptions, retry?: boolean, retryNumber?: number): Promise<any>

  • Parameters

    • channelId: string
    • options: SearchOptions = {}
    • retry: boolean = true
    • retryNumber: number = 0

    Returns Promise<any>

searchGuild

  • searchGuild(guildId: string, options?: SearchOptions, retry?: boolean, retryNumber?: number): Promise<any>

  • Parameters

    • guildId: string
    • options: SearchOptions = {}
    • retry: boolean = true
    • retryNumber: number = 0

    Returns Promise<any>

searchLobbies

  • searchLobbies(applicationId: string, options?: SearchLobbies): Promise<any>

  • Parameters

    • applicationId: string
    • options: SearchLobbies = {}

    Returns Promise<any>

sendDownloadText

  • sendDownloadText(number: string): Promise<any>

sendFriendRequest

  • sendFriendRequest(options: SendFriendRequest): Promise<any>

sendLobbyData

  • sendLobbyData(lobbyId: string, data: string): Promise<any>

setAuthType

  • setAuthType(type: string): void

startChannelCallRinging

  • startChannelCallRinging(channelId: string, options?: StartChannelCallRinging): Promise<any>

  • Parameters

    • channelId: string
    • options: StartChannelCallRinging = {}

    Returns Promise<any>

stopChannelCallRinging

  • stopChannelCallRinging(channelId: string, options?: StopChannelCallRinging): Promise<any>

  • Parameters

    • channelId: string
    • options: StopChannelCallRinging = {}

    Returns Promise<any>

submitConnectionPinCode

  • submitConnectionPinCode(platform: string, pin: string): Promise<any>

submitOauth2ApplicationApproval

  • submitOauth2ApplicationApproval(applicationId: string): Promise<any>

syncGuildIntegration

  • syncGuildIntegration(guildId: string, integrationId: string): Promise<any>

transferOauth2Application

  • transferOauth2Application(applicationId: string, options: TransferOauth2Application): Promise<any>

  • Parameters

    • applicationId: string
    • options: TransferOauth2Application

    Returns Promise<any>

triggerTyping

  • triggerTyping(channelId: string): Promise<any>

unAckChannel

  • unAckChannel(channelId: string): Promise<any>

verify

  • verify(options: Verify): Promise<any>

verifyCaptcha

  • verifyCaptcha(options: VerifyCaptcha): Promise<any>

verifyResend

  • verifyResend(): Promise<any>

Generated using TypeDoc