class GuildsAPI

declare class GuildsAPI

Constructors

constructor(
rest: REST
)

Constructs a new instance of the GuildsAPI class

addRoleToMember(
guildId: Snowflake
userId: Snowflake
roleId: Snowflake
reason?: string
) : Promise<void>

Adds a role to a guild member

banUser(
guildId: Snowflake
userId: Snowflake
options?: RESTPutAPIGuildBanJSONBody
reason?: string
) : Promise<void>

Bans a user from a guild

beginPrune(
guildId: Snowflake
options?: RESTPostAPIGuildPruneJSONBody
reason?: string
) : Promise<RESTGetAPIGuildPruneCountResult>

Prunes members in a guild

create(
data: RESTPostAPIGuildsJSONBody
) : Promise<discord_api_types_v10.APIGuild>

Creates a guild

createAutoModerationRule(
guildId: Snowflake
data: RESTPostAPIAutoModerationRuleJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIAutoModerationRule>

Creates a new auto moderation rule for a guild

createChannel(
guildId: Snowflake
data: RESTPostAPIGuildChannelJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIChannel>

Creates a guild channel

createEmoji(
guildId: Snowflake
data: RESTPostAPIGuildEmojiJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIEmoji>

Creates a new emoji for a guild

createRole(
guildId: Snowflake
data: RESTPostAPIGuildRoleJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIRole>

Creates a guild role

createScheduledEvent(
guildId: Snowflake
data: RESTPostAPIGuildScheduledEventJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIGuildScheduledEvent>

Creates a new scheduled event for a guild

createSticker(
guildId: Snowflake
data: Omit<RESTPostAPIGuildStickerFormDataBody, 'file'> & { file: RawFile; }
reason?: string
) : Promise<discord_api_types_v10.APISticker>

Creates a sticker for a guild

createTemplate(
templateCode: string
data: RESTPostAPITemplateCreateGuildJSONBody
) : Promise<discord_api_types_v10.APITemplate>

Creates a new template

delete(
guildId: Snowflake
reason?: string
) : Promise<void>

Deletes a guild

deleteAutoModerationRule(
guildId: Snowflake
ruleId: Snowflake
reason?: string
) : Promise<void>

Deletes an auto moderation rule for a guild

deleteEmoji(
guildId: Snowflake
emojiId: Snowflake
reason?: string
) : Promise<void>

Deletes an emoji for a guild

deleteIntegration(
guildId: Snowflake
integrationId: Snowflake
reason?: string
) : Promise<void>

Deletes an integration from a guild

deleteRole(
guildId: Snowflake
roleId: Snowflake
reason?: string
) : Promise<void>

Deletes a guild role

deleteScheduledEvent(
guildId: Snowflake
eventId: Snowflake
reason?: string
) : Promise<void>

Deletes a scheduled event for a guild

deleteSticker(
guildId: Snowflake
stickerId: Snowflake
reason?: string
) : Promise<void>

Deletes a sticker for a guild

deleteTemplate(
guildId: Snowflake
templateCode: string
) : Promise<void>

Deletes a template for a guild

edit(
guildId: Snowflake
data: RESTPatchAPIGuildJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIGuild>

Edits a guild

editAutoModerationRule(
guildId: Snowflake
ruleId: Snowflake
data: RESTPatchAPIAutoModerationRuleJSONBody
reason?: string
) : Promise<RESTPatchAPIAutoModerationRuleJSONBody>

Edits an auto moderation rule for a guild

editEmoji(
guildId: Snowflake
emojiId: Snowflake
data: RESTPatchAPIGuildEmojiJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIEmoji>

Edits an emoji for a guild

editMember(
guildId: Snowflake
userId: Snowflake
data?: RESTPatchAPIGuildMemberJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIGuildMember>

Edits a guild member

editMFALevel(
guildId: Snowflake
level: GuildMFALevel
reason?: string
) : Promise<discord_api_types_v10.RESTPostAPIGuildsMFAJSONBody>

Edits the multi-factor-authentication (MFA) level of a guild

editRole(
guildId: Snowflake
roleId: Snowflake
data: RESTPatchAPIGuildRoleJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIRole>

Edits a guild role

editScheduledEvent(
guildId: Snowflake
eventId: Snowflake
data: RESTPatchAPIGuildScheduledEventJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIGuildScheduledEvent>

Edits a scheduled event for a guild

editSticker(
guildId: Snowflake
stickerId: Snowflake
data: RESTPatchAPIGuildStickerJSONBody
reason?: string
) : Promise<discord_api_types_v10.APISticker>

Edits a sticker for a guild

editTemplate(
guildId: Snowflake
templateCode: string
data: RESTPatchAPIGuildTemplateJSONBody
) : Promise<discord_api_types_v10.APITemplate>

Edits a template for a guild

editUserVoiceState(
guildId: Snowflake
userId: Snowflake
data: RESTPatchAPIGuildVoiceStateUserJSONBody
reason?: string
) : Promise<void>

Edits a user's voice state in a guild

editWelcomeScreen(
guildId: Snowflake
data?: RESTPatchAPIGuildWelcomeScreenJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIGuildWelcomeScreen>

Edits the welcome screen for a guild

editWidgetSettings(
guildId: Snowflake
data: RESTPatchAPIGuildWidgetSettingsJSONBody
reason?: string
) : Promise<discord_api_types_v10.APIGuildWidgetSettings>

Edits the widget settings for a guild

get(
guildId: string
) : Promise<discord_api_types_v10.APIGuild>

Fetches a guild

getActiveThreads(
guildId: Snowflake
) : Promise<discord_api_types_v10.APIThreadList>

Fetches the active threads in a guild

getAuditLogs(
guildId: Snowflake
options?: RESTGetAPIAuditLogQuery
) : Promise<discord_api_types_v10.APIAuditLog>

Fetches the audit logs for a guild

getAutoModerationRule(
guildId: Snowflake
ruleId: Snowflake
) : Promise<discord_api_types_v10.APIAutoModerationRule>

Fetches an auto moderation rule for a guild

getAutoModerationRules(
guildId: Snowflake
) : Promise<RESTGetAPIAutoModerationRulesResult>

Fetches all auto moderation rules for a guild

getChannels(
guildId: Snowflake
) : Promise<RESTGetAPIGuildChannelsResult>

Fetches a guild's channels

getEmoji(
guildId: Snowflake
emojiId: Snowflake
) : Promise<discord_api_types_v10.APIEmoji>

Fetches an emoji for a guild

getEmojis(
guildId: Snowflake
) : Promise<RESTGetAPIGuildEmojisResult>

Fetches all emojis for a guild

getIntegrations(
guildId: Snowflake
) : Promise<RESTGetAPIGuildIntegrationsResult>

Fetches the integrations for a guild

getInvites(
guildId: Snowflake
) : Promise<RESTGetAPIGuildInvitesResult>

Fetches the invites for a guild

getMember(
guildId: Snowflake
userId: Snowflake
) : Promise<discord_api_types_v10.APIGuildMember>

Fetches a guild member

getMemberBans(
guildId: Snowflake
) : Promise<RESTGetAPIGuildBansResult>

Fetches a guild member ban

getMembers(
guildId: Snowflake
options?: RESTGetAPIGuildMembersQuery
) : Promise<discord_api_types_v10.APIGuildMember>

Fetches all the members of a guild

getPreview(
guildId: Snowflake
) : Promise<discord_api_types_v10.APIGuildPreview>

Fetches a guild preview

getPruneCount(
guildId: Snowflake
options?: RESTGetAPIGuildPruneCountQuery
) : Promise<RESTGetAPIGuildPruneCountResult>

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

getRoles(
guildId: Snowflake
) : Promise<RESTGetAPIGuildRolesResult>

Gets all the roles in a guild

getScheduledEvent(
guildId: Snowflake
eventId: Snowflake
options?: RESTGetAPIGuildScheduledEventQuery
) : Promise<discord_api_types_v10.APIGuildScheduledEvent>

Fetches a scheduled event for a guild

getScheduledEvents(
guildId: Snowflake
options?: RESTGetAPIGuildScheduledEventsQuery
) : Promise<RESTGetAPIGuildScheduledEventsResult>

Fetches all scheduled events for a guild

getScheduledEventUsers(
guildId: Snowflake
eventId: Snowflake
options?: RESTGetAPIGuildScheduledEventUsersQuery
) : Promise<RESTGetAPIGuildScheduledEventUsersResult>

Gets all users that are interested in a scheduled event

getSticker(
guildId: Snowflake
stickerId: Snowflake
) : Promise<discord_api_types_v10.APISticker>

Fetches a sticker for a guild

getStickers(
guildId: Snowflake
) : Promise<RESTGetAPIGuildStickersResult>

Fetches all the stickers for a guild

getTemplate(
templateCode: string
) : Promise<discord_api_types_v10.APITemplate>

Fetches a guild template

getTemplates(
guildId: Snowflake
) : Promise<RESTGetAPIGuildTemplatesResult>

Fetches all the templates for a guild

getVanityURL(
guildId: Snowflake
) : Promise<RESTGetAPIGuildVanityUrlResult>

Fetches the vanity url for a guild

getVoiceRegions(
guildId: Snowflake
) : Promise<RESTGetAPIGuildVoiceRegionsResult>

Fetches voice regions for a guild

getWelcomeScreen(
guildId: Snowflake
) : Promise<discord_api_types_v10.APIGuildWelcomeScreen>

Fetches the welcome screen for a guild

getWidget(
guildId: Snowflake
) : Promise<discord_api_types_v10.APIGuildWidget>

Fetches the widget for a guild

getWidgetImage(
guildId: Snowflake
style?: GuildWidgetStyle
) : Promise<ArrayBuffer>

Fetches the widget image for a guild

getWidgetSettings(
guildId: Snowflake
) : Promise<ArrayBuffer>

Fetches the widget settings for a guild

removeRoleFromMember(
guildId: Snowflake
userId: Snowflake
roleId: Snowflake
reason?: string
) : Promise<void>

Removes a role from a guild member

searchForMembers(
guildId: Snowflake
query: RESTGetAPIGuildMembersSearchQuery
) : Promise<RESTGetAPIGuildMembersSearchResult>

Searches for guild members

setChannelPositions(
guildId: Snowflake
data: RESTPatchAPIGuildChannelPositionsJSONBody
reason?: string
) : Promise<void>

Edits a guild channel's positions

setRolePositions(
guildId: Snowflake
data: RESTPatchAPIGuildRolePositionsJSONBody
reason?: string
) : Promise<RESTPatchAPIGuildRolePositionsResult>

Sets role positions in a guild

syncTemplate(
guildId: Snowflake
templateCode: string
) : Promise<discord_api_types_v10.APITemplate>

Syncs a template for a guild

unbanUser(
guildId: Snowflake
userId: Snowflake
reason?: string
) : Promise<void>

Unbans a user from a guild