fix: docs bot param name should be rest

This commit is contained in:
Skillz
2022-12-10 20:42:33 -06:00
parent 5e1daed9ef
commit acd9eec99c
154 changed files with 156 additions and 156 deletions

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Follows an announcement channel, allowing messages posted within it to be cross-posted into the target channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param sourceChannelId - The ID of the announcement channel to follow.
* @param targetChannelId - The ID of the target channel - the channel to cross-post to.
* @returns An instance of {@link DiscordFollowedChannel}.

View File

@@ -15,7 +15,7 @@ import { snakeToCamelCaseNested } from '../../transformer.js'
/**
* Creates a channel within a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to create the channel within.
* @param options - The parameters for the creation of the channel.
* @returns An instance of the created {@link DiscordChannel}.

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Deletes a channel from within a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to delete.
* @returns An instance of the deleted {@link Channel}.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Deletes a permission override for a user or role in a channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to delete the permission override of.
* @param overwriteId - The ID of the permission override to delete.
*

View File

@@ -16,7 +16,7 @@ import { snakeToCamelCaseNested } from '../../transformer.js'
/**
* Edits a channel's settings.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to edit.
* @param options - The parameters for the edit of the channel.
* @returns An instance of the edited {@link DiscordChannel}.

View File

@@ -10,7 +10,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Edits the permission overrides for a user or role in a channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to edit the permission overrides of.
* @param options - The permission override.
*

View File

@@ -6,7 +6,7 @@ export const swapChannels = editChannelPositions
/**
* Edits the positions of a set of channels in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild in which to edit the positions of the channels.
* @param channelPositions - A set of objects defining the updated positions of the channels.
*

View File

@@ -15,7 +15,7 @@ import type { Embed } from '../../../transformers/embed.js'
/**
* Creates a new thread in a forum channel, and sends a message within the created thread.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the forum channel to create the thread within.
* @param options - The parameters for the creation of the thread.
* @returns An instance of {@link DiscordChannel} with a nested {@link Message} object.

View File

@@ -9,7 +9,7 @@ import { snakeToCamelCaseNested } from '../../transformer.js'
/**
* Gets a channel by its ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to get.
* @returns An instance of {@link DiscordChannel}.
*

View File

@@ -10,7 +10,7 @@ import { snakeToCamelCaseNested } from '../../transformer.js'
/**
* Gets the list of invites for a channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to get the invites of.
* @returns A collection of {@link DiscordInviteMetadata} objects assorted by invite code.
*

View File

@@ -10,7 +10,7 @@ import { snakeToCamelCaseNested } from '../../transformer.js'
/**
* Gets the list of channels for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the channels of.
* @returns A collection of {@link DiscordChannel} objects assorted by channel ID.
*

View File

@@ -10,7 +10,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Creates a stage instance associated with a stage channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param options - The parameters for the creation of the stage instance.
* @returns An instance of the created {@link DiscordStageInstance}.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes the stage instance associated with a stage channel, if one exists.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the stage channel the stage instance is associated with.
*
* @remarks

View File

@@ -10,7 +10,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Edits a stage instance.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the stage channel the stage instance is associated with.
* @returns An instance of the updated {@link DiscordStageInstance}.
*

View File

@@ -9,7 +9,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Gets the stage instance associated with a stage channel, if one exists.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the stage channel the stage instance is associated with.
* @returns An instance of {@link DiscordStageInstance}.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Adds a member to a thread.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the thread to add the member to.
* @param userId - The user ID of the member to add to the thread.
*

View File

@@ -12,7 +12,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Gets the list of all active threads for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the threads of.
* @returns An instance of {@link DiscordActiveThreads}.
*

View File

@@ -10,7 +10,7 @@ import type {
/**
* Gets the list of private archived threads for a channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to get the archived threads for.
* @param options - The parameters for the fetching of threads.
* @returns An instance of {@link DiscordArchivedThreads}.

View File

@@ -10,7 +10,7 @@ import type {
/**
* Gets the list of private archived threads the bot is a member of for a channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to get the archived threads for.
* @param options - The parameters for the fetching of threads.
* @returns An instance of {@link DiscordArchivedThreads}.

View File

@@ -7,7 +7,7 @@ import type { DiscordActiveThreads } from './getActiveThreads.js'
/**
* Gets the list of public archived threads for a channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to get the archived threads for.
* @param options - The parameters for the fetching of threads.
* @returns An instance of {@link ArchivedThreads}.

View File

@@ -9,7 +9,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Gets a thread member by their user ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the thread to get the thread member of.
* @param userId - The user ID of the thread member to get.
* @returns An instance of {@link DiscordThreadMember}.

View File

@@ -10,7 +10,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Gets the list of thread members for a thread.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the thread to get the thread members of.
* @returns A collection of {@link DiscordThreadMember} assorted by user ID.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Adds the bot user to a thread.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the thread to add the bot user to.
*
* @remarks

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Removes the bot user from a thread.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the thread to remove the bot user from.
*
* @remarks

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Removes a member from a thread.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the thread to remove the thread member of.
* @param userId - The user ID of the thread member to remove.
*

View File

@@ -11,7 +11,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Creates a thread, using an existing message as its point of origin.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel in which to create the thread.
* @param messageId - The ID of the message to use as the thread's point of origin.
* @param options - The parameters to use for the creation of the thread.

View File

@@ -12,7 +12,7 @@ import { snakeToCamelCaseNested } from '../../../transformer.js'
/**
* Creates a thread without using a message as the thread's point of origin.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel in which to create the thread.
* @param options - The parameters to use for the creation of the thread.
* @returns An instance of the created {@link DiscordChannel | Thread}.

View File

@@ -6,7 +6,7 @@ export const startTyping = triggerTypingIndicator
/**
* Triggers a typing indicator for the bot user.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel in which to trigger the typing indicator.
*
* @remarks

View File

@@ -11,7 +11,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Creates an emoji in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild in which to create the emoji.
* @param options - The parameters for the creation of the emoji.
* @returns An instance of the created {@link DiscordEmoji}.

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Deletes an emoji from a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild from which to delete the emoji.
* @param id - The ID of the emoji to delete.
*

View File

@@ -10,7 +10,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Edits an emoji.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild in which to edit the emoji.
* @param id - The ID of the emoji to edit.
* @param options - The parameters for the edit of the emoji.

View File

@@ -8,7 +8,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Gets an emoji by its ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild from which to get the emoji.
* @param emojiId - The ID of the emoji to get.
* @returns An instance of {@link DiscordEmoji}.

View File

@@ -9,7 +9,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Gets the list of emojis for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild which to get the emojis of.
* @returns A collection of {@link DiscordEmoji} objects assorted by emoji ID.
*

View File

@@ -14,7 +14,7 @@ import type { AutoModerationRule } from '../../../transformers/automodRule.js'
/**
* Creates an automod rule in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to create the rule in.
* @param options - The parameters for the creation of the rule.
* @returns An instance of the created {@link AutoModerationRule}.

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes an automod rule.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to delete the rule from.
* @param ruleId - The ID of the automod rule to delete.
*

View File

@@ -13,7 +13,7 @@ import type { AutoModerationRule } from '../../../transformers/automodRule.js'
/**
* Edits an automod rule.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to edit the rule in.
* @param ruleId - The ID of the rule to edit.
* @param options - The parameters for the edit of the rule.

View File

@@ -5,7 +5,7 @@ import type { AutoModerationRule } from '../../../transformers/automodRule.js'
/**
* Gets an automod rule by its ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the rule of.
* @param ruleId - The ID of the rule to get.
* @returns An instance of {@link AutoModerationRule}.

View File

@@ -6,7 +6,7 @@ import type { AutoModerationRule } from '../../../transformers/automodRule.js'
/**
* Gets the list of automod rules for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the rules from.
* @returns A collection of {@link AutoModerationRule} objects assorted by rule ID.
*

View File

@@ -14,7 +14,7 @@ import type { Role } from '../../transformers/role.js'
/**
* Creates a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param options - The parameters for the creation of the guild.
* @returns An instance of the created {@link Guild}.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Deletes a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to delete.
*
* @remarks

View File

@@ -17,7 +17,7 @@ import type { Guild } from '../../transformers/guild.js'
/**
* Edits a guild's settings.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to edit.
* @param shardId - The ID of the shard the guild is in.
* @param options - The parameters for the edit of the guild.

View File

@@ -5,7 +5,7 @@ import type { WelcomeScreen } from '../../transformers/welcomeScreen.js'
/**
* Edits a guild's welcome screen.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to edit the welcome screen of.
* @param options - The parameters for the edit of the welcome screen.
* @returns An instance of the edited {@link WelcomeScreen}.

View File

@@ -15,7 +15,7 @@ import type { ScheduledEvent } from '../../../transformers/scheduledEvent.js'
/**
* Creates a scheduled event in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to create the scheduled event in.
* @param options - The parameters for the creation of the scheduled event.
* @returns An instance of the created {@link ScheduledEvent}.

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes a scheduled event from a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to delete the scheduled event from.
* @param eventId - The ID of the scheduled event to delete.
*

View File

@@ -14,7 +14,7 @@ import type { ScheduledEvent } from '../../../transformers/scheduledEvent.js'
/**
* Edits a scheduled event.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to edit the scheduled event in.
* @param eventId - The ID of the scheduled event to edit.
* @returns An instance of the edited {@link ScheduledEvent}.

View File

@@ -5,7 +5,7 @@ import type { ScheduledEvent } from '../../../transformers/scheduledEvent.js'
/**
* Gets a scheduled event by its ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the scheduled event from.
* @param eventId - The ID of the scheduled event to get.
* @param options - The parameters for the fetching of the scheduled event.

View File

@@ -9,7 +9,7 @@ import type { Member, User } from '../../../transformers/member.js'
/**
* Gets the list of subscribers to a scheduled event from a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the subscribers to the scheduled event from.
* @param eventId - The ID of the scheduled event to get the subscribers of.
* @param options - The parameters for the fetching of the subscribers.

View File

@@ -6,7 +6,7 @@ import type { ScheduledEvent } from '../../../transformers/scheduledEvent.js'
/**
* Gets the list of scheduled events for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the scheduled events from.
* @param options - The parameters for the fetching of the scheduled events.
* @returns A collection of {@link ScheduledEvent} objects assorted by event ID.

View File

@@ -30,7 +30,7 @@ export interface AuditLog {
/**
* Gets a guild's audit log.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the audit log of.
* @param options - The parameters for the fetching of the audit log.
* @returns An instance of {@link AuditLog}.

View File

@@ -12,7 +12,7 @@ export interface Ban {
/**
* Gets a ban by user ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the ban from.
* @param userId - The ID of the user to get the ban for.
* @returns An instance of {@link Ban}.

View File

@@ -6,7 +6,7 @@ import type { Ban } from './getBan.js'
/**
* Gets the list of bans for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the list of bans for.
* @param options - The parameters for the fetching of the list of bans.
* @returns A collection of {@link Ban} objects assorted by user ID.

View File

@@ -7,7 +7,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Builds a URL to the guild banner stored in the Discord CDN.
*
* @param bot - The bot instance to use to build the URL.
* @param rest - The rest manager to use to build the URL.
* @param guildId - The ID of the guild to get the link to the banner for.
* @param options - The parameters for the building of the URL.
* @returns The link to the resource or `undefined` if no banner has been set.

View File

@@ -5,7 +5,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Builds a URL to the guild icon stored in the Discord CDN.
*
* @param bot - The bot instance to use to build the URL.
* @param rest - The rest manager to use to build the URL.
* @param guildId - The ID of the guild to get the link to the banner for.
* @param options - The parameters for the building of the URL.
* @returns The link to the resource or `undefined` if no banner has been set.

View File

@@ -26,7 +26,7 @@ export interface GuildPreview {
/**
* Gets the preview of a guild by a guild's ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the preview of.
* @returns An instance of {@link GuildPreview}.
*

View File

@@ -5,7 +5,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Builds the URL to a guild splash stored in the Discord CDN.
*
* @param bot - The bot instance to use to build the URL.
* @param rest - The rest manager to use to build the URL.
* @param guildId - The ID of the guild to get the splash of.
* @param imageHash - The hash identifying the splash image.
* @param options - The parameters for the building of the URL.

View File

@@ -8,7 +8,7 @@ interface DiscordPrunedCount {
/**
* Gets the number of members that would be kicked from a guild during pruning.
*
* @param bot - The bot instance used to make the request
* @param rest - The rest manager used to make the request
* @param guildId - The ID of the guild to get the prune count of.
* @param options - The parameters for the fetching of the prune count.
* @returns A number indicating the number of members that would be kicked.

View File

@@ -11,7 +11,7 @@ export interface VanityUrl {
/**
* Gets information about the vanity url of a guild.
*
* @param bot - The bot instance used to make the request
* @param rest - The rest manager used to make the request
* @param guildId - The ID of the guild to get the vanity url information for.
* @returns An instance of {@link VanityUrl}.
*

View File

@@ -5,7 +5,7 @@ import type { WelcomeScreen } from '../../transformers/welcomeScreen.js'
/**
* Gets the welcome screen for a guild.
*
* @param bot - The bot instance used to make the request
* @param rest - The rest manager used to make the request
* @param guildId - The ID of the guild to get the welcome screen for.
* @returns An instance of {@link WelcomeScreen}.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes an integration attached to a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild from which to delete the integration.
* @param integrationId - The ID of the integration to delete from the guild.
*

View File

@@ -6,7 +6,7 @@ import type { Integration } from '../../../transformers/integration.js'
/**
* Gets the list of integrations attached to a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the list of integrations from.
* @returns A collection of {@link Integration} objects assorted by integration ID.
*

View File

@@ -11,7 +11,7 @@ import type { BaseInvite } from './getInvite.js'
/**
* Creates an invite to a channel in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param channelId - The ID of the channel to create the invite to.
* @param options - The parameters for the creation of the invite.
* @returns An instance of the created {@link BaseInvite | Invite}.

View File

@@ -3,7 +3,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes an invite to a channel.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param inviteCode - The invite code of the invite to delete.
*
* @remarks

View File

@@ -29,7 +29,7 @@ export type InviteMetadata = BaseInvite & {
/**
* Gets an invite to a channel by its invite code.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param inviteCode - The invite code of the invite to get.
* @param options - The parameters for the fetching of the invite.
* @returns An instance of {@link BaseInvite | Invite}.

View File

@@ -7,7 +7,7 @@ import type { InviteMetadata } from './getInvite.js'
/**
* Gets the list of invites for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the invites from.
* @returns A collection of {@link InviteMetadata | Invite} objects assorted by invite code.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Leaves a guild.
*
* @param bot - The bot instance used to make the request
* @param rest - The rest manager used to make the request
* @param guildId - The ID of the guild to leave.
*
* @remarks

View File

@@ -6,7 +6,7 @@ export const updateBotVoiceState = editOwnVoiceState
/**
* Edits the voice state of the bot user.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild in which to edit the voice state of the bot user.
* @param options - The parameters for the edit of the voice state.
*
@@ -45,7 +45,7 @@ export async function editOwnVoiceState (
/**
* Edits the voice state of another user.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild in which to edit the voice state of the bot user.
* @param options - The parameters for the edit of the voice state.
*

View File

@@ -6,7 +6,7 @@ import type { VoiceRegions } from '../../../transformers/voiceRegion.js'
/**
* Gets the list of available voice regions.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @returns A collection of {@link VoiceRegions | VoiceRegion} objects assorted by voice region ID.
*/
export async function getAvailableVoiceRegions (

View File

@@ -6,7 +6,7 @@ import type { VoiceRegions } from '../../../transformers/voiceRegion.js'
/**
* Gets the list of voice regions for a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the voice regions for.
* @returns A collection of {@link VoiceRegions | VoiceRegion} objects assorted by voice region ID.
*

View File

@@ -7,7 +7,7 @@ import type { GuildWidgetSettings } from '../../../transformers/widgetSettings.j
/**
* Edits the settings of a guild's widget.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to edit the settings of the widget of.
* @returns An instance of the edited {@link GuildWidgetSettings}.
*

View File

@@ -5,7 +5,7 @@ import type { GuildWidget } from '../../../transformers/widget.js'
/**
* Gets the guild widget by guild ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the widget of.
* @returns An instance of {@link GuildWidget}.
*

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Builds a URL to the guild widget image stored in the Discord CDN.
*
* @param bot - The bot instance to use to build the URL.
* @param rest - The rest manager to use to build the URL.
* @param guildId - The ID of the guild to get the link to the widget image for.
* @param options - The parameters for the building of the URL.
* @returns The link to the resource.

View File

@@ -5,7 +5,7 @@ import type { GuildWidgetSettings } from '../../../transformers/widgetSettings.j
/**
* Gets the settings of a guild's widget.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the widget of.
* @returns An instance of {@link GuildWidgetSettings}.
*

View File

@@ -6,7 +6,7 @@ import type { CreateApplicationCommand } from '../../../types.js'
/**
* Creates an application command accessible globally; across different guilds and channels.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param command - The command to create.
* @returns An instance of the created {@link ApplicationCommand}.
*

View File

@@ -6,7 +6,7 @@ import type { CreateApplicationCommand } from '../../../types.js'
/**
* Creates an application command only accessible in a specific guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param command - The command to create.
* @param guildId - The ID of the guild to create the command for.
* @returns An instance of the created {@link ApplicationCommand}.

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes an application command registered globally.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param commandId - The ID of the command to delete.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#delete-global-application-command}

View File

@@ -6,7 +6,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes an application command registered in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to delete the command from.
* @param commandId - The ID of the command to delete from the guild.
*

View File

@@ -11,7 +11,7 @@ import type { ApplicationCommandPermission } from '../../../transformers/applica
/**
* Edits the permissions for a guild application command.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild the command is registered in.
* @param commandId - The ID of the command to edit the permissions of.
* @param bearerToken - The bearer token to use to make the request.

View File

@@ -6,7 +6,7 @@ import type { CreateApplicationCommand } from '../../../types'
/**
* Edits a global application command.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param commandId - The ID of the command to edit.
* @param options - The parameters for the edit of the command.
* @returns An instance of the edited {@link ApplicationCommand}.

View File

@@ -8,7 +8,7 @@ import type { CreateApplicationCommand } from '../../../types'
/**
* Edits an application command registered in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild the command is registered in.
* @param commandId - The ID of the command to edit.
* @param options - The parameters for the edit of the command.

View File

@@ -8,7 +8,7 @@ import type { ApplicationCommandPermission } from '../../../transformers/applica
/**
* Gets the permissions of a guild application command.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild the command is registered in.
* @param commandId - The ID of the command to get the permissions of.
* @returns An instance of {@link ApplicationCommandPermission}.

View File

@@ -9,7 +9,7 @@ import type { ApplicationCommandPermission } from '../../../transformers/applica
/**
* Gets the permissions of all application commands registered in a guild by the ID of the guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to get the permissions objects of.
* @returns A collection of {@link ApplicationCommandPermission} objects assorted by command ID.
*

View File

@@ -5,7 +5,7 @@ import type { ApplicationCommand } from '../../../transformers/applicationComman
/**
* Gets a global application command by its ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param commandId - The ID of the command to get.
* @returns An instance of {@link ApplicationCommand}.
*

View File

@@ -8,7 +8,7 @@ import type { ApplicationCommand } from '../../../transformers/applicationComman
/**
* Gets the list of your bot's global application commands.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.
*
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands}

View File

@@ -7,7 +7,7 @@ import type { ApplicationCommand } from '../../../transformers/applicationComman
/**
* Gets a guild application command by its ID.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild the command is registered in.
* @param commandId - The ID of the command to get.
* @returns An instance of {@link ApplicationCommand}.

View File

@@ -6,7 +6,7 @@ import type { ApplicationCommand } from '../../../transformers/applicationComman
/**
* Gets the list of application commands registered by your bot in a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild the commands are registered in.
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.
*

View File

@@ -7,7 +7,7 @@ import type { CreateApplicationCommand } from '../../../types'
/**
* Re-registers the list of global application commands, overwriting the previous commands completely.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param commands - The list of commands to use to overwrite the previous list.
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.
*

View File

@@ -7,7 +7,7 @@ import type { CreateApplicationCommand } from '../../../types'
/**
* Re-registers the list of application commands registered in a guild, overwriting the previous commands completely.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild whose list of commands to overwrite.
* @param commands - The list of commands to use to overwrite the previous list.
* @returns A collection of {@link ApplicationCommand} objects assorted by command ID.

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes a follow-up message to an interaction.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param token - The interaction token to use, provided in the original interaction.
* @param messageId - The ID of the message to delete.
*

View File

@@ -3,7 +3,7 @@ import type { RestManager } from '../../../restManager.js'
/**
* Deletes the initial message response to an interaction.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param token - The interaction token to use, provided in the original interaction.
*
* @remarks

View File

@@ -7,7 +7,7 @@ import type { InteractionCallbackData } from '../../../types.js'
/**
* Edits a follow-up message to an interaction.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param token - The interaction token to use, provided in the original interaction.
* @param messageId - The ID of the message to edit.
* @param options - The parameters for the edit of the message.

View File

@@ -7,7 +7,7 @@ import type { InteractionCallbackData } from '../../../types'
/**
* Edits the initial message response to an interaction.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param token - The interaction token to use, provided in the original interaction.
* @param options - The parameters for the edit of the response.
* @returns An instance of the edited {@link Message}.

View File

@@ -5,7 +5,7 @@ import type { Message } from '../../../transformers/message.js'
/**
* Gets a follow-up message to an interaction by the ID of the message.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param token - The interaction token to use, provided in the original interaction.
* @param messageId - The ID of the message to get.
* @returns An instance of {@link Message}.

View File

@@ -5,7 +5,7 @@ import type { Message } from '../../../transformers/message.js'
/**
* Gets the initial message response to an interaction.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param token - The interaction token to use, provided in the original interaction.
* @returns An instance of {@link Message}.
*

View File

@@ -6,7 +6,7 @@ import type { InteractionResponse } from '../../../types.js'
/**
* Sends a follow-up message to an interaction.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param token - The interaction token to use, provided in the original interaction.
* @param options - The parameters for the creation of the message.
* @returns An instance of the created {@link Message}.

View File

@@ -5,7 +5,7 @@ import type { InteractionResponse } from '../../../types'
/**
* Sends a response to an interaction.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param interactionId - The ID of the interaction to respond to.
* @param token - The interaction token to use, provided in the original interaction.
* @param options - The parameters for the creation of the message.

View File

@@ -4,7 +4,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Bans a user from a guild.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to ban the user from.
* @param userId - The ID of the user to ban from the guild.
* @param options - The parameters for the creation of the ban.

View File

@@ -5,7 +5,7 @@ import type { Member } from '../../transformers/member.js'
/**
* Edits the nickname of the bot user.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to edit the nickname of the bot user in.
* @param options - The parameters for the edit of the nickname.
* @returns An instance of the edited {@link Member}

View File

@@ -5,7 +5,7 @@ import type { Member } from '../../transformers/member.js'
/**
* Edits a member's properties.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param guildId - The ID of the guild to edit the member of.
* @param userId - The user ID of the member to edit.
* @param options - The parameters for the edit of the user.

View File

@@ -5,7 +5,7 @@ import type { RestManager } from '../../restManager.js'
/**
* Builds a URL to a user's avatar stored in the Discord CDN.
*
* @param bot - The bot instance to use to build the URL.
* @param rest - The rest manager to use to build the URL.
* @param userId - The ID of the user to get the avatar of.
* @param discriminator - The user's discriminator. (4-digit tag after the hashtag.)
* @param options - The parameters for the building of the URL.

View File

@@ -5,7 +5,7 @@ import type { Channel } from '../../transformers/channel.js'
/**
* Gets or creates a DM channel with a user.
*
* @param bot - The bot instance to use to make the request.
* @param rest - The rest manager to use to make the request.
* @param userId - The ID of the user to create the DM channel with.
* @returns An instance of {@link Channel}.
*

Some files were not shown because too many files have changed in this diff Show More