Class RestClient

acceptAgreements

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

• Parameters

  • Default value privacy: boolean = true

  • Default value terms: boolean = true

  Returns Promise<any>

acceptInvite

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

• Parameters

  • code: string

  Returns Promise<any>

acceptTeamInvite

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

• Parameters

  • token: string

  Returns Promise<any>

acceptTemplate

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

• Parameters

  • templateId: string

  • options: AcceptTemplate

  Returns 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>

• Parameters

  • channelId: string

  Returns Promise<any>

ackGuild

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

• Parameters

  • guildId: string

  Returns 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

  • Default value 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>

• Parameters

  • channelId: string

  • messageId: string

  Returns Promise<any>

addRecipient

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

• Parameters

  • channelId: string

  • userId: string

  Returns Promise<any>

addTeamMember

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

• Parameters

  • teamId: string

  • options: AddTeamMember

  Returns Promise<any>

authorizeIpAddress

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

• Parameters

  • options: AuthorizeIpAddress

  Returns Promise<any>

beginGuildPrune

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

• Parameters

  • guildId: string

  • Default value options: BeginGuildPrune = {}

  Returns Promise<any>

bulkDeleteMessages

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

• Parameters

  • channelId: string

  • messageIds: Array<string>

  Returns Promise<any>

connectionCallback

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

• Parameters

  • platform: string

  • options: ConnectionCallback

  Returns Promise<any>

createApplicationNews

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

• Parameters

  • options: CreateApplicationNews

  Returns Promise<ApplicationNews>

createChannelInvite

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

• Parameters

  • channelId: string

  • Default value options: CreateChannelInvite = {}

  Returns Promise<Invite>

createChannelStoreListingGrantEntitlement

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

• Parameters

  • channelId: string

  Returns Promise<any>

createDm

• createDm(options?: CreateDm): Promise<ChannelDM>

• Parameters

  • Default value options: CreateDm = {}

  Returns Promise<ChannelDM>

createGuild

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

• Parameters

  • options: CreateGuild

  Returns Promise<Guild>

createGuildBan

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

• Parameters

  • guildId: string

  • userId: string

  • Default value options: CreateGuildBan = {}

  Returns Promise<any>

createGuildChannel

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

• Parameters

  • guildId: string

  • options: CreateGuildChannel

  Returns Promise<Channel>

createGuildEmoji

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

• Parameters

  • guildId: string

  • options: CreateGuildEmoji

  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>

• Parameters

  • guildId: string

  • Default value options: CreateGuildRole = {}

  Returns Promise<Role>

createGuildTemplate

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

• Parameters

  • guildId: string

  • options: CreateGuildTemplate

  Returns Promise<Template>

createLobby

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

• Parameters

  • applicationId: string

  • Default value options: CreateLobby = {}

  Returns Promise<any>

createMeBillingPaymentSource

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

• Parameters

  • options: CreateMeBillingPaymentSource

  Returns Promise<any>

createMeBillingSubscription

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

• Parameters

  • options: CreateMeBillingSubscription

  Returns Promise<any>

createMessage

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

• Parameters

  • channelId: string

  • Default value options: CreateMessage | string = {}

  Returns Promise<Message>

createOauth2Application

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

• Parameters

  • options: CreateOauth2Application

  Returns Promise<any>

createOauth2ApplicationAsset

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

• Parameters

  • applicationId: string

  • options: CreateOauth2ApplicationAsset

  Returns Promise<Oauth2ApplicationAsset>

createOauth2ApplicationBot

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

• Parameters

  • applicationId: string

  Returns Promise<any>

createReaction

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

• Parameters

  • channelId: string

  • messageId: string

  • emoji: string

  Returns Promise<any>

createStoreApplicationAsset

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

• Parameters

  • applicationId: string

  • options: CreateStoreApplicationAsset

  Returns Promise<StoreApplicationAsset>

createTeam

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

• Parameters

  • Default value options: CreateTeam = {}

  Returns Promise<any>

createWebhook

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

• Parameters

  • channelId: string

  • options: CreateWebhook

  Returns Promise<Webhook>

delete

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

• Parameters

  • info: Options | string | URL

  • Optional init: RequestTypes.Options

  Returns Promise<Response>

deleteAccount

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

• Parameters

  • options: DeleteAccount

  Returns Promise<any>

deleteChannel

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

• Parameters

  • channelId: string

  • Default value options: DeleteChannel = {}

  Returns Promise<Channel>

deleteChannelOverwrite

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

• Parameters

  • channelId: string

  • overwriteId: string

  • Default value options: DeleteChannelOverwrite = {}

  Returns Promise<any>

deleteConnection

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

• Parameters

  • platform: string

  • accountId: string

  Returns Promise<any>

deleteGuild

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

• Parameters

  • guildId: string

  • Default value options: DeleteGuild = {}

  Returns Promise<any>

deleteGuildEmoji

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

• Parameters

  • guildId: string

  • emojiId: string

  • Default value options: DeleteGuildEmoji = {}

  Returns Promise<any>

deleteGuildIntegration

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

• Parameters

  • guildId: string

  • integrationId: string

  • Default value options: DeleteGuildIntegration = {}

  Returns Promise<any>

deleteGuildPremiumSubscription

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

• Parameters

  • guildId: string

  • subscriptionId: string

  Returns Promise<any>

deleteGuildRole

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

• Parameters

  • guildId: string

  • roleId: string

  • Default value options: DeleteGuildRole = {}

  Returns Promise<any>

deleteGuildTemplate

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

• Parameters

  • guildId: string

  • templateId: string

  Returns Promise<any>

deleteInvite

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

• Parameters

  • code: string

  • Default value options: DeleteInvite = {}

  Returns Promise<Invite>

deleteLobby

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

• Parameters

  • lobbyId: string

  Returns Promise<any>

deleteMeBillingPaymentSource

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

• Parameters

  • paymentSourceId: string

  Returns Promise<any>

deleteMeBillingSubscription

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

• Parameters

  • subscriptionId: string

  Returns Promise<any>

deleteMessage

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

• Parameters

  • channelId: string

  • messageId: string

  • Default value options: DeleteMessage = {}

  Returns Promise<any>

deleteOauth2Application

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

• Parameters

  • applicationId: string

  • Default value options: DeleteOauth2Application = {}

  Returns Promise<any>

deleteOauth2ApplicationAsset

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

• Parameters

  • applicationId: string

  • assetId: string

  Returns Promise<any>

deletePinnedMessage

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

• Parameters

  • channelId: string

  • messageId: string

  Returns Promise<any>

deleteReaction

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

• Parameters

  • channelId: string

  • messageId: string

  • emoji: string

  • Default value userId: string = "@me"

  Returns Promise<any>

deleteReactions

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

• Parameters

  • channelId: string

  • messageId: string

  Returns 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>

• Parameters

  • userId: string

  Returns Promise<any>

deleteStoreApplicationAsset

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

• Parameters

  • applicationId: string

  • assetId: string

  Returns Promise<any>

deleteTeam

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

• Parameters

  • teamId: string

  • Default value options: DeleteTeam = {}

  Returns Promise<any>

deleteWebhook

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

• Parameters

  • webhookId: string

  • Default value options: DeleteWebhook = {}

  Returns Promise<any>

deleteWebhookToken

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

• Parameters

  • webhookId: string

  • token: string

  • Default value options: DeleteWebhook = {}

  Returns Promise<any>

disableAccount

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

• Parameters

  • options: DisableAccount

  Returns Promise<any>

editApplicationNews

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

• Parameters

  • newsId: string

  • Default value options: EditApplicationNews = {}

  Returns Promise<any>

editChannel

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

• Parameters

  • channelId: string

  • Default value options: EditChannel = {}

  Returns Promise<Channel>

editChannelOverwrite

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

• Parameters

  • channelId: string

  • overwriteId: string

  • Default value options: EditChannelOverwrite = {}

  Returns Promise<any>

editConnection

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

• Parameters

  • platform: string

  • accountId: string

  • Default value options: EditConnection = {}

  Returns Promise<any>

editGuild

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

• Parameters

  • guildId: string

  • Default value options: EditGuild = {}

  Returns Promise<Guild>

editGuildChannels

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

• Parameters

  • guildId: string

  • channels: EditGuildChannels

  • Default value options: EditGuildChannelsExtra = {}

  Returns Promise<any>

editGuildEmbed

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

• Parameters

  • guildId: string

  • options: EditGuildEmbed

  Returns Promise<any>

editGuildEmoji

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

• Parameters

  • guildId: string

  • emojiId: string

  • Default value options: EditGuildEmoji = {}

  Returns Promise<Emoji>

editGuildIntegration

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

• Parameters

  • guildId: string

  • integrationId: string

  • Default value options: EditGuildIntegration = {}

  Returns Promise<any>

editGuildMember

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

• Parameters

  • guildId: string

  • userId: string

  • Default value options: EditGuildMember = {}

  Returns Promise<any>

editGuildMfaLevel

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

• Parameters

  • guildId: string

  • options: EditGuildMfaLevel

  Returns Promise<any>

editGuildNick

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

• Parameters

  • guildId: string

  • nick: string

  • Default value options: EditGuildNick = {}

  Returns Promise<any>

editGuildRole

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

• Parameters

  • guildId: string

  • roleId: string

  • Default value options: EditGuildRole = {}

  Returns Promise<Role>

editGuildRolePositions

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

• Parameters

  • guildId: string

  • roles: EditGuildRolePositions

  • Default value options: EditGuildRolePositionsExtra = {}

  Returns Promise<BaseCollection<string, Role>>

editGuildVanity

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

• Parameters

  • guildId: string

  • code: string

  • Default value options: EditGuildVanity = {}

  Returns Promise<any>

editLobby

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

• Parameters

  • lobbyId: string

  • Default value options: EditLobby = {}

  Returns Promise<any>

editLobbyMember

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

• Parameters

  • lobbyId: string

  • userId: string

  • Default value options: EditLobbyMember = {}

  Returns Promise<any>

editMe

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

• Parameters

  • Default value options: EditMe = {}

  Returns Promise<UserMe>

editMeBillingPaymentSource

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

• Parameters

  • paymentSourceId: string

  • Default value options: EditMeBillingPaymentSource = {}

  Returns Promise<any>

editMeBillingSubscription

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

• Parameters

  • subscriptionId: string

  • Default value options: EditMeBillingSubscription = {}

  Returns Promise<any>

editMessage

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

• Parameters

  • channelId: string

  • messageId: string

  • Default value options: EditMessage | string = {}

  Returns Promise<Message>

editNote

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

• Parameters

  • userId: string

  • note: string

  Returns Promise<any>

editOauth2Application

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

• Parameters

  • applicationId: string

  • Default value options: EditOauth2Application = {}

  Returns Promise<any>

editRelationship

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

• Parameters

  • userId: string

  • type: number

  Returns Promise<any>

editSettings

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

• Parameters

  • Default value options: EditSettings = {}

  Returns Promise<any>

editTeam

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

• Parameters

  • teamId: string

  • Default value options: EditTeam = {}

  Returns Promise<any>

editUser

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

• Parameters

  • Default value options: EditMe = {}

  Returns Promise<UserMe>

editWebhook

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

• Parameters

  • webhookId: string

  • Default value options: EditWebhook = {}

  Returns Promise<Webhook>

editWebhookToken

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

• Parameters

  • webhookId: string

  • token: string

  • Default value options: EditWebhook = {}

  Returns Promise<Webhook>

enableOauth2ApplicationAssets

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

• Parameters

  • applicationId: string

  Returns Promise<any>

enableOauth2ApplicationRpc

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

• Parameters

  • applicationId: string

  Returns Promise<any>

executeWebhook

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

• Parameters

  • webhookId: string

  • token: string

  • Default value options: ExecuteWebhook | string = {}

  • Optional compatibleType: undefined | string

  Returns Promise<Message | null>

fetchActivities

• fetchActivities(): Promise<any>

• Returns Promise<any>

fetchApplication

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

• Parameters

  • applicationId: string

  Returns Promise<Application>

fetchApplicationNews

• fetchApplicationNews(applicationIds?: Array<string> | string): Promise<BaseCollection<string, ApplicationNews>>

• Parameters

  • Optional applicationIds: Array<string> | string

  Returns Promise<BaseCollection<string, ApplicationNews>>

fetchApplicationNewsId

• fetchApplicationNewsId(newsId: string): Promise<ApplicationNews>

• Parameters

  • newsId: string

  Returns Promise<ApplicationNews>

fetchApplications

• fetchApplications(): Promise<any>

• Returns Promise<any>

fetchApplicationsDetectable

• fetchApplicationsDetectable(): Promise<BaseCollection<string, Application>>

• Returns Promise<BaseCollection<string, Application>>

fetchApplicationsPublic

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

• Parameters

  • applicationIds: string | Array<string>

  Returns Promise<any>

fetchApplicationsTrendingGlobal

• fetchApplicationsTrendingGlobal(): Promise<any>

• Returns Promise<any>

fetchAuthConsentRequired

• fetchAuthConsentRequired(): Promise<any>

• Returns Promise<any>

fetchChannel

• fetchChannel(channelId: string): Promise<Channel>

• Parameters

  • channelId: string

  Returns Promise<Channel>

fetchChannelCall

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

• Parameters

  • channelId: string

  Returns Promise<any>

fetchChannelInvites

• fetchChannelInvites(channelId: string): Promise<BaseCollection<string, Invite>>

• Parameters

  • channelId: string

  Returns Promise<BaseCollection<string, Invite>>

fetchChannelStoreListing

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

• Parameters

  • channelId: string

  Returns Promise<StoreListing>

fetchChannelWebhooks

• fetchChannelWebhooks(channelId: string): Promise<BaseCollection<string, Webhook>>

• Parameters

  • channelId: string

  Returns Promise<BaseCollection<string, Webhook>>

fetchConnectionAuthorizeUrl

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

• Parameters

  • platform: string

  Returns Promise<any>

fetchConsentRequired

• fetchConsentRequired(): Promise<any>

• Returns Promise<any>

fetchDiscoverableGuilds

• fetchDiscoverableGuilds(): Promise<any>

• Returns Promise<any>

fetchDms

• fetchDms(userId?: string): Promise<BaseCollection<string, Channel>>

• Parameters

  • Default value userId: string = "@me"

  Returns Promise<BaseCollection<string, Channel>>

fetchExperiments

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

• Parameters

  • Optional fingerprint: undefined | string

  Returns Promise<any>

fetchGateway

• fetchGateway(): Promise<any>

• Returns Promise<any>

fetchGatewayBot

• fetchGatewayBot(): Promise<any>

• Returns Promise<any>

fetchGiftCode

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

• Parameters

  • code: string

  • Default value options: FetchGiftCode = {}

  Returns Promise<Gift>

fetchGuild

• fetchGuild(guildId: string): Promise<Guild>

• Parameters

  • guildId: string

  Returns Promise<Guild>

fetchGuildApplications

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

• Parameters

  • guildId: string

  • Optional channelId: undefined | string

  Returns Promise<any>

fetchGuildAuditLogs

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

• Parameters

  • guildId: string

  • Default value options: FetchGuildAuditLogs = {}

  Returns Promise<BaseCollection<string, AuditLog>>

fetchGuildBans

• fetchGuildBans(guildId: string): Promise<FetchGuildBans>

• Parameters

  • guildId: string

  Returns Promise<FetchGuildBans>

fetchGuildChannels

• fetchGuildChannels(guildId: string): Promise<BaseCollection<string, Channel>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, Channel>>

fetchGuildEmbed

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

• Parameters

  • guildId: string

  Returns Promise<any>

fetchGuildEmoji

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

• Parameters

  • guildId: string

  • emojiId: string

  Returns Promise<Emoji>

fetchGuildEmojis

• fetchGuildEmojis(guildId: string): Promise<BaseCollection<string, Emoji>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, Emoji>>

fetchGuildIntegrations

• fetchGuildIntegrations(guildId: string): Promise<BaseCollection<string, Integration>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, Integration>>

fetchGuildInvites

• fetchGuildInvites(guildId: string): Promise<BaseCollection<string, Invite>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, Invite>>

fetchGuildMember

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

• Parameters

  • guildId: string

  • userId: string

  Returns Promise<Member>

fetchGuildMembers

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

• Parameters

  • guildId: string

  • Default value options: FetchGuildMembers = {}

  Returns Promise<BaseCollection<string, Member>>

fetchGuildMembersSearch

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

• Parameters

  • guildId: string

  • options: FetchGuildMembersSearch

  Returns Promise<BaseCollection<string, Member>>

fetchGuildPremiumSubscriptions

• fetchGuildPremiumSubscriptions(guildId: string): Promise<BaseCollection<string, PremiumSubscription>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, PremiumSubscription>>

fetchGuildPreview

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

• Parameters

  • guildId: string

  Returns Promise<any>

fetchGuildPruneCount

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

• Parameters

  • guildId: string

  • Default value options: FetchGuildPruneCount = {}

  Returns Promise<any>

fetchGuildRoles

• fetchGuildRoles(guildId: string): Promise<BaseCollection<string, Role>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, Role>>

fetchGuildTemplates

• fetchGuildTemplates(guildId: string): Promise<BaseCollection<string, Template>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, Template>>

fetchGuildVanityUrl

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

• Parameters

  • guildId: string

  Returns Promise<any>

fetchGuildWebhooks

• fetchGuildWebhooks(guildId: string): Promise<BaseCollection<string, Webhook>>

• Parameters

  • guildId: string

  Returns Promise<BaseCollection<string, Webhook>>

fetchGuildWidget

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

• Parameters

  • guildId: string

  Returns Promise<any>

fetchGuildWidgetJson

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

• Parameters

  • guildId: string

  Returns Promise<any>

fetchGuildWidgetPng

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

• Parameters

  • guildId: string

  • Default value options: FetchGuildWidgetPng = {}

  Returns Promise<any>

fetchInvite

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

• Parameters

  • code: string

  • Default value options: FetchInvite = {}

  Returns Promise<Invite>

fetchMe

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

• Parameters

  • Default value options: FetchMe = {}

  Returns Promise<UserMe>

fetchMeBillingPaymentSources

• fetchMeBillingPaymentSources(): Promise<any>

• Returns Promise<any>

fetchMeBillingPayments

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

• Parameters

  • Default value options: FetchMeBillingPayments = {}

  Returns Promise<any>

fetchMeBillingSubscriptions

• fetchMeBillingSubscriptions(): Promise<any>

• Returns Promise<any>

fetchMeChannels

• fetchMeChannels(): Promise<BaseCollection<string, Channel>>

• Returns Promise<BaseCollection<string, Channel>>

fetchMeConnectionAccessToken

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

• Parameters

  • platform: string

  • accountId: string

  Returns Promise<any>

fetchMeConnectionSubreddits

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

• Parameters

  • accountId: string

  Returns Promise<any>

fetchMeConnections

• fetchMeConnections(): Promise<BaseCollection<string, ConnectedAccount>>

• Returns Promise<BaseCollection<string, ConnectedAccount>>

fetchMeFeedSettings

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

• Parameters

  • Default value options: FetchMeFeedSettings = {}

  Returns Promise<any>

fetchMeGuilds

• fetchMeGuilds(options?: FetchMeGuilds): Promise<BaseCollection<string, GuildMe>>

• Parameters

  • Default value options: FetchMeGuilds = {}

  Returns Promise<BaseCollection<string, GuildMe>>

fetchMentions

• fetchMentions(options?: FetchMentions): Promise<BaseCollection<string, Message>>

• Parameters

  • Default value options: FetchMentions = {}

  Returns Promise<BaseCollection<string, Message>>

fetchMessage

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

• Parameters

  • channelId: string

  • messageId: string

  Returns Promise<Message>

fetchMessages

• fetchMessages(channelId: string, options?: FetchMessages): Promise<BaseCollection<string, Message>>

• Parameters

  • channelId: string

  • Default value options: FetchMessages = {}

  Returns Promise<BaseCollection<string, Message>>

fetchOauth2Application

• fetchOauth2Application(userId?: string): Promise<Oauth2Application>

• Parameters

  • Default value userId: string = "@me"

  Returns Promise<Oauth2Application>

fetchOauth2ApplicationAssets

• fetchOauth2ApplicationAssets(applicationId: string): Promise<BaseCollection<string, Oauth2ApplicationAsset>>

• Parameters

  • applicationId: string

  Returns Promise<BaseCollection<string, Oauth2ApplicationAsset>>

fetchOauth2ApplicationWhitelist

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

• Parameters

  • applicationId: string

  Returns Promise<any>

fetchOauth2Applications

• fetchOauth2Applications(): Promise<BaseCollection<string, Oauth2Application>>

• Returns Promise<BaseCollection<string, Oauth2Application>>

fetchOauth2Authorize

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

• Parameters

  • Default value options: FetchOauth2Authorize = {}

  Returns Promise<any>

fetchOauth2AuthorizeWebhookChannels

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

• Parameters

  • guildId: string

  Returns Promise<any>

fetchOauth2Token

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

• Parameters

  • tokenId: string

  Returns Promise<any>

fetchOauth2Tokens

• fetchOauth2Tokens(): Promise<any>

• Returns Promise<any>

fetchPinnedMessages

• fetchPinnedMessages(channelId: string): Promise<BaseCollection<string, Message>>

• Parameters

  • channelId: string

  Returns Promise<BaseCollection<string, Message>>

fetchReactions

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

• Parameters

  • channelId: string

  • messageId: string

  • emoji: string

  • Default value options: FetchReactions = {}

  Returns Promise<BaseCollection<string, User>>

fetchStoreApplicationAssets

• fetchStoreApplicationAssets(applicationId: string): Promise<BaseCollection<string, StoreApplicationAsset>>

• Parameters

  • applicationId: string

  Returns Promise<BaseCollection<string, StoreApplicationAsset>>

fetchStorePublishedListingsSku

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

• Parameters

  • skuId: string

  Returns Promise<any>

fetchStorePublishedListingsSkuSubscriptionPlans

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

• Parameters

  • skuId: string

  Returns Promise<any>

fetchStorePublishedListingsSkus

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

• Parameters

  • applicationId: string

  Returns Promise<any>

fetchStreamPreview

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

• Parameters

  • streamKey: string

  Returns Promise<any>

fetchTeam

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

• Parameters

  • teamId: string

  Returns Promise<Team>

fetchTeamApplications

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

• Parameters

  • teamId: string

  Returns Promise<any>

fetchTeamMember

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

• Parameters

  • teamId: string

  • userId: string

  Returns Promise<TeamMember>

fetchTeamMembers

• fetchTeamMembers(teamId: string): Promise<BaseCollection<string, TeamMember>>

• Parameters

  • teamId: string

  Returns Promise<BaseCollection<string, TeamMember>>

fetchTeamPayouts

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

• Parameters

  • teamId: string

  • Default value options: FetchTeamPayouts = {}

  Returns Promise<any>

fetchTeams

• fetchTeams(): Promise<BaseCollection<string, Team>>

• Returns Promise<BaseCollection<string, Team>>

fetchTemplate

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

• Parameters

  • templateId: string

  Returns Promise<Template>

fetchUser

• fetchUser(userId: string): Promise<User>

• Parameters

  • userId: string

  Returns Promise<User>

fetchUserActivityMetadata

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

• Parameters

  • userId: string

  • sessionId: string

  • activityId: string

  Returns Promise<any>

fetchUserChannels

• fetchUserChannels(userId: string): Promise<BaseCollection<string, Channel>>

• Parameters

  • userId: string

  Returns Promise<BaseCollection<string, Channel>>

fetchUserProfile

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

• Parameters

  • userId: string

  Returns Promise<Profile>

fetchVoiceIce

• fetchVoiceIce(): Promise<any>

• Returns Promise<any>

fetchVoiceRegions

• fetchVoiceRegions(guildId?: undefined | string): Promise<BaseCollection<string, VoiceRegion>>

• Parameters

  • Optional guildId: undefined | string

  Returns Promise<BaseCollection<string, VoiceRegion>>

fetchWebhook

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

• Parameters

  • webhookId: string

  Returns Promise<Webhook>

fetchWebhookToken

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

• Parameters

  • webhookId: string

  • token: string

  Returns Promise<Webhook>

forgotPassword

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

• Parameters

  • options: ForgotPassword

  Returns Promise<any>

get

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

• Parameters

  • info: Options | string | URL

  • Optional init: RequestTypes.Options

  Returns Promise<Response>

head

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

• Parameters

  • info: Options | string | URL

  • Optional init: RequestTypes.Options

  Returns Promise<Response>

integrationJoin

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

• Parameters

  • integrationId: string

  Returns Promise<any>

joinGuild

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

• Parameters

  • guildId: string

  • Default value options: JoinGuild = {}

  Returns Promise<any>

leaveGuild

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

• Parameters

  • guildId: string

  Returns Promise<any>

login

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

• Parameters

  • options: Login

  Returns Promise<any>

loginMfaSms