class GuildsAPI

export declare class GuildsAPI
addMember
addRoleToMember
banUser
beginPrune
bulkBanUsers
createAutoModerationRule
createChannel
createEmoji
createRole
createScheduledEvent
createSoundboardSound
createSticker
createTemplate
deleteAutoModerationRule
deleteEmoji
deleteIntegration
deleteRole
deleteScheduledEvent
deleteSoundboardSound
deleteSticker
deleteTemplate
edit
editAutoModerationRule
editEmoji
editIncidentActions
editMember
editOnboarding
editRole
editScheduledEvent
editSoundboardSound
editSticker
editTemplate
editWelcomeScreen
editWidgetSettings
get
getActiveThreads
getAuditLogs
getAutoModerationRule
getAutoModerationRules
getChannels
getEmoji
getEmojis
getIntegrations
getInvites
getMember
getMemberBan
getMemberBans
getMembers
getOnboarding
getPreview
getPruneCount
getRole
getRoles
getScheduledEvent
getScheduledEvents
getScheduledEventUsers
getSoundboardSound
getSoundboardSounds
getSticker
getStickers
getTemplate
getTemplates
getVanityURL
getVoiceRegions
getWebhooks
getWelcomeScreen
getWidget
getWidgetImage
getWidgetSettings
removeMember
removeRoleFromMember
searchForMembers
setChannelPositions
setRolePositions
syncTemplate
unbanUser

Constructors

constructor(
rest: REST
)

Constructs a new instance of the GuildsAPI class

addMember(
guildId: Snowflake
userId: Snowflake
body: RESTPutAPIGuildMemberJSONBody
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTPutAPIGuildMemberResult>

Adds user to the guild

See also: https://discord.com/developers/docs/resources/guild#add-guild-member

addRoleToMember(
guildId: Snowflake
userId: Snowflake
roleId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Adds a role to a guild member

See also: https://discord.com/developers/docs/resources/guild#add-guild-member-role

banUser(
guildId: Snowflake
userId: Snowflake
body?: RESTPutAPIGuildBanJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Bans a user from a guild

See also: https://discord.com/developers/docs/resources/guild#create-guild-ban

beginPrune(
guildId: Snowflake
body?: RESTPostAPIGuildPruneJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<RESTPostAPIGuildPruneResult>

Prunes members in a guild

See also: https://discord.com/developers/docs/resources/guild#begin-guild-prune

bulkBanUsers(
guildId: Snowflake
body: RESTPostAPIGuildBulkBanJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<RESTPostAPIGuildBulkBanResult>

Bulk ban users from a guild

See also: https://discord.com/developers/docs/resources/guild#bulk-guild-ban

createAutoModerationRule(
guildId: Snowflake
body: RESTPostAPIAutoModerationRuleJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIAutoModerationRule>

Creates a new auto moderation rule for a guild

See also: https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule

createChannel(
guildId: Snowflake
body: RESTPostAPIGuildChannelJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIChannel>

Creates a guild channel

See also: https://discord.com/developers/docs/resources/guild#create-guild-channel

createEmoji(
guildId: Snowflake
body: RESTPostAPIGuildEmojiJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIEmoji>

Creates a new emoji for a guild

See also: https://discord.com/developers/docs/resources/emoji#create-guild-emoji

createRole(
guildId: Snowflake
body: RESTPostAPIGuildRoleJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIRole>

Creates a guild role

See also: https://discord.com/developers/docs/resources/guild#create-guild-role

createScheduledEvent(
guildId: Snowflake
body: RESTPostAPIGuildScheduledEventJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIGuildScheduledEvent>

Creates a new scheduled event for a guild

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

createSoundboardSound(
guildId: Snowflake
body: RESTPostAPIGuildSoundboardSoundJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APISoundboardSound>

Creates a new soundboard sound for a guild

See also: https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound

createSticker(
guildId: Snowflake
body: CreateStickerOptions
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APISticker>

Creates a sticker for a guild

See also: https://discord.com/developers/docs/resources/sticker#create-guild-sticker

createTemplate(
guildId: Snowflake
body: RESTPostAPIGuildTemplatesJSONBody
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APITemplate>

Creates a new template

See also: https://discord.com/developers/docs/resources/guild-template#create-guild-template

deleteAutoModerationRule(
guildId: Snowflake
ruleId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes an auto moderation rule for a guild

See also: https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule

deleteEmoji(
guildId: Snowflake
emojiId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes an emoji for a guild

See also: https://discord.com/developers/docs/resources/emoji#delete-guild-emoji

deleteIntegration(
guildId: Snowflake
integrationId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes an integration from a guild

See also: https://discord.com/developers/docs/resources/guild#delete-guild-integration

deleteRole(
guildId: Snowflake
roleId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes a guild role

See also: https://discord.com/developers/docs/resources/guild#delete-guild-role

deleteScheduledEvent(
guildId: Snowflake
eventId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes a scheduled event for a guild

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event

deleteSoundboardSound(
guildId: Snowflake
soundId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes a soundboard sound for a guild

See also: https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound

deleteSticker(
guildId: Snowflake
stickerId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes a sticker for a guild

See also: https://discord.com/developers/docs/resources/sticker#delete-guild-sticker

deleteTemplate(
guildId: Snowflake
templateCode: string
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Deletes a template for a guild

See also: https://discord.com/developers/docs/resources/guild-template#delete-guild-template

edit(
guildId: Snowflake
body: RESTPatchAPIGuildJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIGuild>

Edits a guild

See also: https://discord.com/developers/docs/resources/guild#modify-guild

editAutoModerationRule(
guildId: Snowflake
ruleId: Snowflake
body: RESTPatchAPIAutoModerationRuleJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIAutoModerationRule>

Edits an auto moderation rule for a guild

See also: https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule

editEmoji(
guildId: Snowflake
emojiId: Snowflake
body: RESTPatchAPIGuildEmojiJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIEmoji>

Edits an emoji for a guild

See also: https://discord.com/developers/docs/resources/emoji#modify-guild-emoji

editIncidentActions(
guildId: Snowflake
body: RESTPutAPIGuildIncidentActionsJSONBody
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIIncidentsData>

Modifies incident actions for a guild.

See also: https://discord.com/developers/docs/resources/guild#modify-guild-incident-actions

editMember(
guildId: Snowflake
userId: Snowflake
body?: RESTPatchAPIGuildMemberJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIGuildMember>

Edits a guild member

See also: https://discord.com/developers/docs/resources/guild#modify-guild-member

editOnboarding(
guildId: Snowflake
body: RESTPutAPIGuildOnboardingJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIGuildOnboarding>

Edits a guild onboarding

See also: https://discord.com/developers/docs/resources/guild#modify-guild-onboarding

editRole(
guildId: Snowflake
roleId: Snowflake
body: RESTPatchAPIGuildRoleJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIRole>

Edits a guild role

See also: https://discord.com/developers/docs/resources/guild#modify-guild-role

editScheduledEvent(
guildId: Snowflake
eventId: Snowflake
body: RESTPatchAPIGuildScheduledEventJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIGuildScheduledEvent>

Edits a scheduled event for a guild

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

editSoundboardSound(
guildId: Snowflake
soundId: Snowflake
body: RESTPatchAPIGuildSoundboardSoundJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APISoundboardSound>

Edits a soundboard sound for a guild

See also: https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound

editSticker(
guildId: Snowflake
stickerId: Snowflake
body: RESTPatchAPIGuildStickerJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APISticker>

Edits a sticker for a guild

See also: https://discord.com/developers/docs/resources/sticker#modify-guild-sticker

editTemplate(
guildId: Snowflake
templateCode: string
body: RESTPatchAPIGuildTemplateJSONBody
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APITemplate>

Edits a template for a guild

See also: https://discord.com/developers/docs/resources/guild-template#modify-guild-template

editWelcomeScreen(
guildId: Snowflake
body?: RESTPatchAPIGuildWelcomeScreenJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIGuildWelcomeScreen>

Edits the welcome screen for a guild

See also: https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

editWidgetSettings(
guildId: Snowflake
body: RESTPatchAPIGuildWidgetSettingsJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIGuildWidgetSettings>

Edits the widget settings for a guild

See also: https://discord.com/developers/docs/resources/guild#modify-guild-widget

get(
guildId: Snowflake
query?: RESTGetAPIGuildQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuild>

Fetches a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild

getActiveThreads(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIThreadList>

Fetches the active threads in a guild

See also: https://discord.com/developers/docs/resources/guild#list-active-guild-threads

getAuditLogs(
guildId: Snowflake
query?: RESTGetAPIAuditLogQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIAuditLog>

Fetches the audit logs for a guild

See also: https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log

getAutoModerationRule(
guildId: Snowflake
ruleId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIAutoModerationRule>

Fetches an auto moderation rule for a guild

See also: https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule

getAutoModerationRules(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIAutoModerationRulesResult>

Fetches all auto moderation rules for a guild

See also: https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild

getChannels(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildChannelsResult>

Fetches a guild's channels

See also: https://discord.com/developers/docs/resources/guild#get-guild-channels

getEmoji(
guildId: Snowflake
emojiId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIEmoji>

Fetches an emoji for a guild

See also: https://discord.com/developers/docs/resources/emoji#get-guild-emoji

getEmojis(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildEmojisResult>

Fetches all emojis for a guild

See also: https://discord.com/developers/docs/resources/emoji#list-guild-emojis

getIntegrations(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildIntegrationsResult>

Fetches the integrations for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-integrations

getInvites(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildInvitesResult>

Fetches the invites for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-invites

getMember(
guildId: Snowflake
userId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuildMember>

Fetches a guild member

See also: https://discord.com/developers/docs/resources/guild#get-guild-member

getMemberBan(
guildId: Snowflake
userId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIBan>

Fetches a guild member ban

See also: https://discord.com/developers/docs/resources/guild#get-guild-ban

getMemberBans(
guildId: Snowflake
query?: RESTGetAPIGuildBansQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildBansResult>

Fetches guild member bans

See also: https://discord.com/developers/docs/resources/guild#get-guild-bans

getMembers(
guildId: Snowflake
query?: RESTGetAPIGuildMembersQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildMembersResult>

Fetches members of a guild.

See also: https://discord.com/developers/docs/resources/guild#list-guild-members

getOnboarding(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuildOnboarding>

Fetches a guild onboarding

See also: https://discord.com/developers/docs/resources/guild#get-guild-onboarding

getPreview(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuildPreview>

Fetches a guild preview

See also: https://discord.com/developers/docs/resources/guild#get-guild-preview

getPruneCount(
guildId: Snowflake
query?: RESTGetAPIGuildPruneCountQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildPruneCountResult>

Fetch the number of members that can be pruned from a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-prune-count

getRole(
guildId: Snowflake
roleId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIRole>

Get a role in a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-role

getRoles(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildRolesResult>

Gets all the roles in a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-roles

getScheduledEvent(
guildId: Snowflake
eventId: Snowflake
query?: RESTGetAPIGuildScheduledEventQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuildScheduledEvent>

Fetches a scheduled event for a guild

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event

getScheduledEvents(
guildId: Snowflake
query?: RESTGetAPIGuildScheduledEventsQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildScheduledEventsResult>

Fetches all scheduled events for a guild

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild

getScheduledEventUsers(
guildId: Snowflake
eventId: Snowflake
query?: RESTGetAPIGuildScheduledEventUsersQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildScheduledEventUsersResult>

Gets all users that are interested in a scheduled event

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users

getSoundboardSound(
guildId: Snowflake
soundId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APISoundboardSound>

Fetches a soundboard sound for a guild

See also: https://discord.com/developers/docs/resources/soundboard#get-guild-soundboard-sound

getSoundboardSounds(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildSoundboardSoundsResult>

Fetches all the soundboard sounds for a guild

See also: https://discord.com/developers/docs/resources/soundboard#list-guild-soundboard-sounds

getSticker(
guildId: Snowflake
stickerId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APISticker>

Fetches a sticker for a guild

See also: https://discord.com/developers/docs/resources/sticker#get-guild-sticker

getStickers(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildStickersResult>

Fetches all the stickers for a guild

See also: https://discord.com/developers/docs/resources/sticker#list-guild-stickers

getTemplate(
templateCode: string
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APITemplate>

Fetches a guild template

See also: https://discord.com/developers/docs/resources/guild-template#get-guild-template

getTemplates(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildTemplatesResult>

Fetches all the templates for a guild

See also: https://discord.com/developers/docs/resources/guild-template#get-guild-templates

getVanityURL(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildVanityUrlResult>

Fetches the vanity url for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-vanity-url

getVoiceRegions(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildVoiceRegionsResult>

Fetches voice regions for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

getWebhooks(
id: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildWebhooksResult>

Fetches webhooks for a guild

See also: https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

getWelcomeScreen(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuildWelcomeScreen>

Fetches the welcome screen for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen

getWidget(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuildWidget>

Fetches the widget for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-widget

getWidgetImage(
guildId: Snowflake
style?: GuildWidgetStyle
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<ArrayBuffer>

Fetches the widget image for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-widget-image

getWidgetSettings(
guildId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIGuildWidgetSettings>

Fetches the widget settings for a guild

See also: https://discord.com/developers/docs/resources/guild#get-guild-widget-settings

removeMember(
guildId: Snowflake
userId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<unknown>

Removes a member from a guild

See also: https://discord.com/developers/docs/resources/guild#remove-guild-member

removeRoleFromMember(
guildId: Snowflake
userId: Snowflake
roleId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Removes a role from a guild member

See also: https://discord.com/developers/docs/resources/guild#remove-guild-member-role

searchForMembers(
guildId: Snowflake
query: RESTGetAPIGuildMembersSearchQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIGuildMembersSearchResult>

Searches for guild members

See also: https://discord.com/developers/docs/resources/guild#search-guild-members

setChannelPositions(
guildId: Snowflake
body: RESTPatchAPIGuildChannelPositionsJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Edits a guild channel's positions

See also: https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

setRolePositions(
guildId: Snowflake
body: RESTPatchAPIGuildRolePositionsJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<RESTPatchAPIGuildRolePositionsResult>

Sets role positions in a guild

See also: https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

syncTemplate(
guildId: Snowflake
templateCode: string
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APITemplate>

Syncs a template for a guild

See also: https://discord.com/developers/docs/resources/guild-template#sync-guild-template

unbanUser(
guildId: Snowflake
userId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Unbans a user from a guild

See also: https://discord.com/developers/docs/resources/guild#remove-guild-ban