From 048772d1f1fc6631ea1782d33b1884bbd82d76fd Mon Sep 17 00:00:00 2001 From: Almeida Date: Wed, 9 Apr 2025 20:54:09 +0100 Subject: [PATCH] docs: resolve api-extractor warnings (#1205) * docs: resolve api-extractor warnings * docs: solo links * fix: new changes * fix: more * fix: again --- deno/gateway/common.ts | 2 +- deno/gateway/v10.ts | 749 +++++++++--------- deno/gateway/v8.ts | 4 +- deno/gateway/v9.ts | 749 +++++++++--------- deno/globals.ts | 8 +- deno/payloads/common.ts | 10 +- .../_chatInput/integer.ts | 2 +- .../_applicationCommands/_chatInput/number.ts | 2 +- .../_applicationCommands/_chatInput/shared.ts | 4 +- .../_applicationCommands/_chatInput/string.ts | 2 +- .../_applicationCommands/chatInput.ts | 16 +- .../_applicationCommands/contextMenu.ts | 26 +- .../_applicationCommands/entryPoint.ts | 8 +- .../_applicationCommands/permissions.ts | 8 +- .../v10/_interactions/applicationCommands.ts | 25 +- .../v10/_interactions/autocomplete.ts | 4 +- deno/payloads/v10/_interactions/base.ts | 24 +- .../payloads/v10/_interactions/modalSubmit.ts | 8 +- deno/payloads/v10/_interactions/responses.ts | 13 +- deno/payloads/v10/application.ts | 30 +- deno/payloads/v10/auditLog.ts | 226 +++--- deno/payloads/v10/autoModeration.ts | 22 +- deno/payloads/v10/channel.ts | 259 +++--- deno/payloads/v10/emoji.ts | 2 +- deno/payloads/v10/gateway.ts | 69 +- deno/payloads/v10/guild.ts | 146 ++-- deno/payloads/v10/guildScheduledEvent.ts | 35 +- deno/payloads/v10/interactions.ts | 6 +- deno/payloads/v10/invite.ts | 21 +- deno/payloads/v10/monetization.ts | 16 +- deno/payloads/v10/oauth2.ts | 34 +- deno/payloads/v10/permissions.ts | 8 +- deno/payloads/v10/poll.ts | 16 +- deno/payloads/v10/soundboard.ts | 2 +- deno/payloads/v10/stageInstance.ts | 14 +- deno/payloads/v10/sticker.ts | 16 +- deno/payloads/v10/teams.ts | 16 +- deno/payloads/v10/template.ts | 4 +- deno/payloads/v10/user.ts | 53 +- deno/payloads/v10/voice.ts | 11 +- deno/payloads/v10/webhook.ts | 20 +- .../_chatInput/integer.ts | 2 +- .../_applicationCommands/_chatInput/number.ts | 2 +- .../_applicationCommands/_chatInput/shared.ts | 4 +- .../_applicationCommands/_chatInput/string.ts | 2 +- .../_applicationCommands/chatInput.ts | 16 +- .../_applicationCommands/contextMenu.ts | 26 +- .../_applicationCommands/entryPoint.ts | 8 +- .../_applicationCommands/permissions.ts | 8 +- .../v9/_interactions/applicationCommands.ts | 25 +- .../payloads/v9/_interactions/autocomplete.ts | 4 +- deno/payloads/v9/_interactions/base.ts | 26 +- deno/payloads/v9/_interactions/modalSubmit.ts | 8 +- deno/payloads/v9/_interactions/responses.ts | 13 +- deno/payloads/v9/application.ts | 30 +- deno/payloads/v9/auditLog.ts | 226 +++--- deno/payloads/v9/autoModeration.ts | 22 +- deno/payloads/v9/channel.ts | 257 +++--- deno/payloads/v9/emoji.ts | 2 +- deno/payloads/v9/gateway.ts | 69 +- deno/payloads/v9/guild.ts | 146 ++-- deno/payloads/v9/guildScheduledEvent.ts | 35 +- deno/payloads/v9/interactions.ts | 6 +- deno/payloads/v9/invite.ts | 21 +- deno/payloads/v9/monetization.ts | 16 +- deno/payloads/v9/oauth2.ts | 34 +- deno/payloads/v9/permissions.ts | 8 +- deno/payloads/v9/poll.ts | 16 +- deno/payloads/v9/soundboard.ts | 2 +- deno/payloads/v9/stageInstance.ts | 14 +- deno/payloads/v9/sticker.ts | 16 +- deno/payloads/v9/teams.ts | 16 +- deno/payloads/v9/template.ts | 4 +- deno/payloads/v9/user.ts | 53 +- deno/payloads/v9/voice.ts | 11 +- deno/payloads/v9/webhook.ts | 20 +- deno/rest/common.ts | 6 +- deno/rest/v10/application.ts | 18 +- deno/rest/v10/auditLog.ts | 4 +- deno/rest/v10/autoModeration.ts | 18 +- deno/rest/v10/channel.ts | 177 ++--- deno/rest/v10/emoji.ts | 30 +- deno/rest/v10/gateway.ts | 4 +- deno/rest/v10/guild.ts | 243 +++--- deno/rest/v10/guildScheduledEvent.ts | 30 +- deno/rest/v10/interactions.ts | 112 +-- deno/rest/v10/invite.ts | 4 +- deno/rest/v10/mod.ts | 13 +- deno/rest/v10/monetization.ts | 28 +- deno/rest/v10/oauth2.ts | 32 +- deno/rest/v10/poll.ts | 12 +- deno/rest/v10/soundboard.ts | 26 +- deno/rest/v10/stageInstance.ts | 16 +- deno/rest/v10/sticker.ts | 25 +- deno/rest/v10/template.ts | 26 +- deno/rest/v10/user.ts | 32 +- deno/rest/v10/voice.ts | 16 +- deno/rest/v10/webhook.ts | 80 +- deno/rest/v8/channel.ts | 6 +- deno/rest/v8/guild.ts | 12 +- deno/rest/v8/guildScheduledEvent.ts | 4 +- deno/rest/v8/interactions.ts | 8 +- deno/rest/v8/template.ts | 4 +- deno/rest/v8/webhook.ts | 6 +- deno/rest/v9/application.ts | 18 +- deno/rest/v9/auditLog.ts | 4 +- deno/rest/v9/autoModeration.ts | 18 +- deno/rest/v9/channel.ts | 192 +++-- deno/rest/v9/emoji.ts | 30 +- deno/rest/v9/gateway.ts | 4 +- deno/rest/v9/guild.ts | 243 +++--- deno/rest/v9/guildScheduledEvent.ts | 30 +- deno/rest/v9/interactions.ts | 112 +-- deno/rest/v9/invite.ts | 4 +- deno/rest/v9/mod.ts | 15 +- deno/rest/v9/monetization.ts | 28 +- deno/rest/v9/oauth2.ts | 32 +- deno/rest/v9/poll.ts | 12 +- deno/rest/v9/soundboard.ts | 26 +- deno/rest/v9/stageInstance.ts | 16 +- deno/rest/v9/sticker.ts | 25 +- deno/rest/v9/template.ts | 26 +- deno/rest/v9/user.ts | 32 +- deno/rest/v9/voice.ts | 16 +- deno/rest/v9/webhook.ts | 80 +- deno/rpc/common.ts | 18 +- deno/rpc/v10.ts | 125 ++- deno/utils/internals.ts | 34 +- deno/utils/v10.ts | 26 +- deno/utils/v9.ts | 26 +- deno/v10.ts | 1 + deno/v9.ts | 1 + deno/voice/v4.ts | 4 +- gateway/common.ts | 2 +- gateway/v10.ts | 749 +++++++++--------- gateway/v8.ts | 4 +- gateway/v9.ts | 749 +++++++++--------- globals.ts | 8 +- payloads/common.ts | 10 +- .../_chatInput/integer.ts | 2 +- .../_applicationCommands/_chatInput/number.ts | 2 +- .../_applicationCommands/_chatInput/shared.ts | 4 +- .../_applicationCommands/_chatInput/string.ts | 2 +- .../_applicationCommands/chatInput.ts | 16 +- .../_applicationCommands/contextMenu.ts | 26 +- .../_applicationCommands/entryPoint.ts | 8 +- .../_applicationCommands/permissions.ts | 8 +- .../v10/_interactions/applicationCommands.ts | 25 +- payloads/v10/_interactions/autocomplete.ts | 4 +- payloads/v10/_interactions/base.ts | 24 +- payloads/v10/_interactions/modalSubmit.ts | 8 +- payloads/v10/_interactions/responses.ts | 13 +- payloads/v10/application.ts | 30 +- payloads/v10/auditLog.ts | 226 +++--- payloads/v10/autoModeration.ts | 22 +- payloads/v10/channel.ts | 259 +++--- payloads/v10/emoji.ts | 2 +- payloads/v10/gateway.ts | 69 +- payloads/v10/guild.ts | 146 ++-- payloads/v10/guildScheduledEvent.ts | 35 +- payloads/v10/interactions.ts | 6 +- payloads/v10/invite.ts | 21 +- payloads/v10/monetization.ts | 16 +- payloads/v10/oauth2.ts | 34 +- payloads/v10/permissions.ts | 8 +- payloads/v10/poll.ts | 16 +- payloads/v10/soundboard.ts | 2 +- payloads/v10/stageInstance.ts | 14 +- payloads/v10/sticker.ts | 16 +- payloads/v10/teams.ts | 16 +- payloads/v10/template.ts | 4 +- payloads/v10/user.ts | 53 +- payloads/v10/voice.ts | 11 +- payloads/v10/webhook.ts | 20 +- .../_chatInput/integer.ts | 2 +- .../_applicationCommands/_chatInput/number.ts | 2 +- .../_applicationCommands/_chatInput/shared.ts | 4 +- .../_applicationCommands/_chatInput/string.ts | 2 +- .../_applicationCommands/chatInput.ts | 16 +- .../_applicationCommands/contextMenu.ts | 26 +- .../_applicationCommands/entryPoint.ts | 8 +- .../_applicationCommands/permissions.ts | 8 +- .../v9/_interactions/applicationCommands.ts | 25 +- payloads/v9/_interactions/autocomplete.ts | 4 +- payloads/v9/_interactions/base.ts | 26 +- payloads/v9/_interactions/modalSubmit.ts | 8 +- payloads/v9/_interactions/responses.ts | 13 +- payloads/v9/application.ts | 30 +- payloads/v9/auditLog.ts | 226 +++--- payloads/v9/autoModeration.ts | 22 +- payloads/v9/channel.ts | 257 +++--- payloads/v9/emoji.ts | 2 +- payloads/v9/gateway.ts | 69 +- payloads/v9/guild.ts | 146 ++-- payloads/v9/guildScheduledEvent.ts | 35 +- payloads/v9/interactions.ts | 6 +- payloads/v9/invite.ts | 21 +- payloads/v9/monetization.ts | 16 +- payloads/v9/oauth2.ts | 34 +- payloads/v9/permissions.ts | 8 +- payloads/v9/poll.ts | 16 +- payloads/v9/soundboard.ts | 2 +- payloads/v9/stageInstance.ts | 14 +- payloads/v9/sticker.ts | 16 +- payloads/v9/teams.ts | 16 +- payloads/v9/template.ts | 4 +- payloads/v9/user.ts | 53 +- payloads/v9/voice.ts | 11 +- payloads/v9/webhook.ts | 20 +- rest/common.ts | 6 +- rest/v10/application.ts | 18 +- rest/v10/auditLog.ts | 4 +- rest/v10/autoModeration.ts | 18 +- rest/v10/channel.ts | 177 ++--- rest/v10/emoji.ts | 30 +- rest/v10/gateway.ts | 4 +- rest/v10/guild.ts | 243 +++--- rest/v10/guildScheduledEvent.ts | 30 +- rest/v10/index.ts | 13 +- rest/v10/interactions.ts | 112 +-- rest/v10/invite.ts | 4 +- rest/v10/monetization.ts | 28 +- rest/v10/oauth2.ts | 32 +- rest/v10/poll.ts | 12 +- rest/v10/soundboard.ts | 26 +- rest/v10/stageInstance.ts | 16 +- rest/v10/sticker.ts | 25 +- rest/v10/template.ts | 26 +- rest/v10/user.ts | 32 +- rest/v10/voice.ts | 16 +- rest/v10/webhook.ts | 80 +- rest/v8/channel.ts | 6 +- rest/v8/guild.ts | 12 +- rest/v8/guildScheduledEvent.ts | 4 +- rest/v8/interactions.ts | 8 +- rest/v8/template.ts | 4 +- rest/v8/webhook.ts | 6 +- rest/v9/application.ts | 18 +- rest/v9/auditLog.ts | 4 +- rest/v9/autoModeration.ts | 18 +- rest/v9/channel.ts | 192 +++-- rest/v9/emoji.ts | 30 +- rest/v9/gateway.ts | 4 +- rest/v9/guild.ts | 243 +++--- rest/v9/guildScheduledEvent.ts | 30 +- rest/v9/index.ts | 15 +- rest/v9/interactions.ts | 112 +-- rest/v9/invite.ts | 4 +- rest/v9/monetization.ts | 28 +- rest/v9/oauth2.ts | 32 +- rest/v9/poll.ts | 12 +- rest/v9/soundboard.ts | 26 +- rest/v9/stageInstance.ts | 16 +- rest/v9/sticker.ts | 25 +- rest/v9/template.ts | 26 +- rest/v9/user.ts | 32 +- rest/v9/voice.ts | 16 +- rest/v9/webhook.ts | 80 +- rpc/common.ts | 18 +- rpc/v10.ts | 125 ++- utils/internals.ts | 34 +- utils/v10.ts | 26 +- utils/v9.ts | 26 +- v10.ts | 1 + v9.ts | 1 + voice/v4.ts | 4 +- 266 files changed, 6074 insertions(+), 6022 deletions(-) diff --git a/deno/gateway/common.ts b/deno/gateway/common.ts index a2181d68..1a784253 100644 --- a/deno/gateway/common.ts +++ b/deno/gateway/common.ts @@ -1,5 +1,5 @@ /** - * https://discord.com/developers/docs/topics/gateway#connecting-gateway-url-query-string-params + * @see {@link https://discord.com/developers/docs/topics/gateway#connecting-gateway-url-query-string-params} */ export interface GatewayURLQuery { v: string; diff --git a/deno/gateway/v10.ts b/deno/gateway/v10.ts index 51169073..e0ea6634 100644 --- a/deno/gateway/v10.ts +++ b/deno/gateway/v10.ts @@ -41,14 +41,14 @@ import type { ThreadChannelType, } from '../payloads/v10/mod.ts'; import type { ReactionType } from '../rest/v10/mod.ts'; -import type { Nullable } from '../utils/internals.ts'; +import type { _Nullable } from '../utils/internals.ts'; export * from './common.ts'; export const GatewayVersion = '10'; /** - * https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes + * @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes} */ export enum GatewayOpcodes { /** @@ -103,7 +103,7 @@ export enum GatewayOpcodes { } /** - * https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes + * @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes} */ export enum GatewayCloseCodes { /** @@ -113,25 +113,25 @@ export enum GatewayCloseCodes { /** * You sent an invalid Gateway opcode or an invalid payload for an opcode. Don't do that! * - * See https://discord.com/developers/docs/topics/gateway-events#payload-structure + * @see {@link https://discord.com/developers/docs/topics/gateway-events#payload-structure} */ UnknownOpcode, /** * You sent an invalid payload to us. Don't do that! * - * See https://discord.com/developers/docs/topics/gateway#sending-events + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-events} */ DecodeError, /** * You sent us a payload prior to identifying * - * See https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ NotAuthenticated, /** * The account token sent with your identify payload is incorrect * - * See https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ AuthenticationFailed, /** @@ -141,7 +141,7 @@ export enum GatewayCloseCodes { /** * The sequence sent when resuming the session was invalid. Reconnect and start a new session * - * See https://discord.com/developers/docs/topics/gateway-events#resume + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resume} */ InvalidSeq = 4_007, /** @@ -155,13 +155,13 @@ export enum GatewayCloseCodes { /** * You sent us an invalid shard when identifying * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ InvalidShard, /** * The session would have handled too many guilds - you are required to shard your connection in order to connect * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ ShardingRequired, /** @@ -171,34 +171,33 @@ export enum GatewayCloseCodes { /** * You sent an invalid intent for a Gateway Intent. You may have incorrectly calculated the bitwise value * - * See https://discord.com/developers/docs/topics/gateway#gateway-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#gateway-intents} */ InvalidIntents, /** * You sent a disallowed intent for a Gateway Intent. You may have tried to specify an intent that you have not * enabled or are not whitelisted for * - * See https://discord.com/developers/docs/topics/gateway#gateway-intents - * - * See https://discord.com/developers/docs/topics/gateway#privileged-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#gateway-intents} + * @see {@link https://discord.com/developers/docs/topics/gateway#privileged-intents} */ DisallowedIntents, } /** - * https://discord.com/developers/docs/topics/gateway#list-of-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#list-of-intents} */ export enum GatewayIntentBits { Guilds = 1 << 0, GuildMembers = 1 << 1, GuildModeration = 1 << 2, /** - * @deprecated This is the old name for {@apilink GatewayIntentBits#GuildModeration} + * @deprecated This is the old name for {@link GatewayIntentBits.GuildModeration} */ GuildBans = GuildModeration, GuildExpressions = 1 << 3, /** - * @deprecated This is the old name for {@apilink GatewayIntentBits#GuildExpressions} + * @deprecated This is the old name for {@link GatewayIntentBits.GuildExpressions} */ GuildEmojisAndStickers = GuildExpressions, GuildIntegrations = 1 << 4, @@ -221,7 +220,7 @@ export enum GatewayIntentBits { } /** - * https://discord.com/developers/docs/topics/gateway-events#receive-events + * @see {@link https://discord.com/developers/docs/topics/gateway-events#receive-events} */ export enum GatewayDispatchEvents { ApplicationCommandPermissionsUpdate = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE', @@ -390,15 +389,15 @@ export type GatewayDispatchPayload = // #region Dispatch Payloads /** - * https://discord.com/developers/docs/topics/gateway-events#hello + * @see {@link https://discord.com/developers/docs/topics/gateway-events#hello} */ -export interface GatewayHello extends NonDispatchPayload { +export interface GatewayHello extends _NonDispatchPayload { op: GatewayOpcodes.Hello; d: GatewayHelloData; } /** - * https://discord.com/developers/docs/topics/gateway-events#hello + * @see {@link https://discord.com/developers/docs/topics/gateway-events#hello} */ export interface GatewayHelloData { /** @@ -408,67 +407,67 @@ export interface GatewayHelloData { } /** - * https://discord.com/developers/docs/topics/gateway#sending-heartbeats + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-heartbeats} */ -export interface GatewayHeartbeatRequest extends NonDispatchPayload { +export interface GatewayHeartbeatRequest extends _NonDispatchPayload { op: GatewayOpcodes.Heartbeat; d: never; } /** - * https://discord.com/developers/docs/topics/gateway-events#heartbeat + * @see {@link https://discord.com/developers/docs/topics/gateway-events#heartbeat} */ -export interface GatewayHeartbeatAck extends NonDispatchPayload { +export interface GatewayHeartbeatAck extends _NonDispatchPayload { op: GatewayOpcodes.HeartbeatAck; d: never; } /** - * https://discord.com/developers/docs/topics/gateway-events#invalid-session + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invalid-session} */ -export interface GatewayInvalidSession extends NonDispatchPayload { +export interface GatewayInvalidSession extends _NonDispatchPayload { op: GatewayOpcodes.InvalidSession; d: GatewayInvalidSessionData; } /** - * https://discord.com/developers/docs/topics/gateway-events#invalid-session + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invalid-session} */ export type GatewayInvalidSessionData = boolean; /** - * https://discord.com/developers/docs/topics/gateway-events#reconnect + * @see {@link https://discord.com/developers/docs/topics/gateway-events#reconnect} */ -export interface GatewayReconnect extends NonDispatchPayload { +export interface GatewayReconnect extends _NonDispatchPayload { op: GatewayOpcodes.Reconnect; d: never; } /** - * https://discord.com/developers/docs/topics/gateway-events#ready + * @see {@link https://discord.com/developers/docs/topics/gateway-events#ready} */ -export type GatewayReadyDispatch = DataPayload; +export type GatewayReadyDispatch = _DataPayload; /** - * https://discord.com/developers/docs/topics/gateway-events#ready + * @see {@link https://discord.com/developers/docs/topics/gateway-events#ready} */ export interface GatewayReadyDispatchData { /** * Gateway version * - * See https://discord.com/developers/docs/reference#api-versioning + * @see {@link https://discord.com/developers/docs/reference#api-versioning} */ v: number; /** * Information about the user including email * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ user: APIUser; /** * The guilds the user is in * - * See https://discord.com/developers/docs/resources/guild#unavailable-guild-object + * @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object} */ guilds: APIUnavailableGuild[]; /** @@ -482,28 +481,28 @@ export interface GatewayReadyDispatchData { /** * The shard information associated with this session, if sent when identifying * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ shard?: [shard_id: number, shard_count: number]; /** * Contains `id` and `flags` * - * See https://discord.com/developers/docs/resources/application#application-object + * @see {@link https://discord.com/developers/docs/resources/application#application-object} */ application: Pick; } /** - * https://discord.com/developers/docs/topics/gateway-events#resumed + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resumed} */ -export type GatewayResumedDispatch = DataPayload; +export type GatewayResumedDispatch = _DataPayload; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ -export type GatewayAutoModerationRuleModifyDispatch = DataPayload< +export type GatewayAutoModerationRuleModifyDispatch = _DataPayload< | GatewayDispatchEvents.AutoModerationRuleCreate | GatewayDispatchEvents.AutoModerationRuleDelete | GatewayDispatchEvents.AutoModerationRuleUpdate, @@ -511,52 +510,52 @@ export type GatewayAutoModerationRuleModifyDispatch = DataPayload< >; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ export type GatewayAutoModerationRuleModifyDispatchData = APIAutoModerationRule; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} */ export type GatewayAutoModerationRuleCreateDispatch = GatewayAutoModerationRuleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} */ export type GatewayAutoModerationRuleCreateDispatchData = GatewayAutoModerationRuleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} */ export type GatewayAutoModerationRuleUpdateDispatch = GatewayAutoModerationRuleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} */ export type GatewayAutoModerationRuleUpdateDispatchData = GatewayAutoModerationRuleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ export type GatewayAutoModerationRuleDeleteDispatch = GatewayAutoModerationRuleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ export type GatewayAutoModerationRuleDeleteDispatchData = GatewayAutoModerationRuleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution} */ -export type GatewayAutoModerationActionExecutionDispatch = DataPayload< +export type GatewayAutoModerationActionExecutionDispatch = _DataPayload< GatewayDispatchEvents.AutoModerationActionExecution, GatewayAutoModerationActionExecutionDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution} */ export interface GatewayAutoModerationActionExecutionDispatchData { /** @@ -614,15 +613,15 @@ export interface GatewayAutoModerationActionExecutionDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update} */ -export type GatewayApplicationCommandPermissionsUpdateDispatch = DataPayload< +export type GatewayApplicationCommandPermissionsUpdateDispatch = _DataPayload< GatewayDispatchEvents.ApplicationCommandPermissionsUpdate, GatewayApplicationCommandPermissionsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update} */ export interface GatewayApplicationCommandPermissionsUpdateDispatchData { /** @@ -644,11 +643,11 @@ export interface GatewayApplicationCommandPermissionsUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create - * https://discord.com/developers/docs/topics/gateway-events#subscription-update - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ -export type GatewaySubscriptionModifyDispatch = DataPayload< +export type GatewaySubscriptionModifyDispatch = _DataPayload< | GatewayDispatchEvents.SubscriptionCreate | GatewayDispatchEvents.SubscriptionDelete | GatewayDispatchEvents.SubscriptionUpdate, @@ -656,56 +655,56 @@ export type GatewaySubscriptionModifyDispatch = DataPayload< >; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create - * https://discord.com/developers/docs/topics/gateway-events#subscription-update - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ export type GatewaySubscriptionModifyDispatchData = APISubscription; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} */ export type GatewaySubscriptionCreateDispatch = GatewaySubscriptionModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} */ export type GatewaySubscriptionCreateDispatchData = GatewaySubscriptionModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} */ export type GatewaySubscriptionUpdateDispatch = GatewaySubscriptionModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} */ export type GatewaySubscriptionUpdateDispatchData = GatewaySubscriptionModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ export type GatewaySubscriptionDeleteDispatch = GatewaySubscriptionModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ export type GatewaySubscriptionDeleteDispatchData = GatewaySubscriptionModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create - * https://discord.com/developers/docs/topics/gateway-events#channel-update - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ -export type GatewayChannelModifyDispatch = DataPayload< +export type GatewayChannelModifyDispatch = _DataPayload< GatewayDispatchEvents.ChannelCreate | GatewayDispatchEvents.ChannelDelete | GatewayDispatchEvents.ChannelUpdate, GatewayChannelModifyDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create - * https://discord.com/developers/docs/topics/gateway-events#channel-update - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ export type GatewayChannelModifyDispatchData = APIChannel & { type: Exclude; @@ -713,45 +712,45 @@ export type GatewayChannelModifyDispatchData = APIChannel & { }; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} */ export type GatewayChannelCreateDispatch = GatewayChannelModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} */ export type GatewayChannelCreateDispatchData = GatewayChannelModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} */ export type GatewayChannelUpdateDispatch = GatewayChannelModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} */ export type GatewayChannelUpdateDispatchData = GatewayChannelModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ export type GatewayChannelDeleteDispatch = GatewayChannelModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ export type GatewayChannelDeleteDispatchData = GatewayChannelModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-pins-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-pins-update} */ -export type GatewayChannelPinsUpdateDispatch = DataPayload< +export type GatewayChannelPinsUpdateDispatch = _DataPayload< GatewayDispatchEvents.ChannelPinsUpdate, GatewayChannelPinsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-pins-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-pins-update} */ export interface GatewayChannelPinsUpdateDispatchData { /** @@ -769,18 +768,18 @@ export interface GatewayChannelPinsUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ export type GatewayEntitlementModifyDispatchData = APIEntitlement; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ -export type GatewayEntitlementModifyDispatch = DataPayload< +export type GatewayEntitlementModifyDispatch = _DataPayload< | GatewayDispatchEvents.EntitlementCreate | GatewayDispatchEvents.EntitlementDelete | GatewayDispatchEvents.EntitlementUpdate, @@ -788,67 +787,73 @@ export type GatewayEntitlementModifyDispatch = DataPayload< >; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} */ export type GatewayEntitlementCreateDispatchData = Omit & { ends_at: GatewayEntitlementModifyDispatchData['ends_at'] | null; }; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} */ export type GatewayEntitlementCreateDispatch = GatewayEntitlementModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} */ export type GatewayEntitlementUpdateDispatchData = GatewayEntitlementModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} */ export type GatewayEntitlementUpdateDispatch = GatewayEntitlementModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ export type GatewayEntitlementDeleteDispatchData = GatewayEntitlementModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ export type GatewayEntitlementDeleteDispatch = GatewayEntitlementModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ -export type GatewayGuildModifyDispatch = DataPayload; +export type GatewayGuildModifyDispatch = _DataPayload< + GatewayDispatchEvents.GuildUpdate, + GatewayGuildModifyDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ export type GatewayGuildModifyDispatchData = APIGuild; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-create} */ -export type GatewayGuildCreateDispatch = DataPayload; +export type GatewayGuildCreateDispatch = _DataPayload< + GatewayDispatchEvents.GuildCreate, + GatewayGuildCreateDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-create - * https://discord.com/developers/docs/topics/gateway-events#guild-create-guild-create-extra-fields + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-create-guild-create-extra-fields} */ export interface GatewayGuildCreateDispatchData extends APIGuild { /** * When this guild was joined at * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** */ joined_at: string; /** * `true` if this is considered a large guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** */ large: boolean; /** @@ -858,92 +863,95 @@ export interface GatewayGuildCreateDispatchData extends APIGuild { /** * Total number of members in this guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** */ member_count: number; /** * States of members currently in voice channels; lacks the `guild_id` key * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/voice#voice-state-object + * @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object} */ voice_states: Omit[]; /** * Users in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ members: APIGuildMember[]; /** * Channels in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/channel#channel-object + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object} */ channels: (APIChannel & { type: Exclude })[]; /** * Threads in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/channel#channel-object + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object} */ threads: (APIChannel & { type: ThreadChannelType })[]; /** * Presences of the members in the guild, will only include non-offline members if the size is greater than `large_threshold` * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/topics/gateway-events#presence-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update} */ presences: GatewayPresenceUpdate[]; /** * The stage instances in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure + * @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure} */ stage_instances: APIStageInstance[]; /** * The scheduled events in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object + * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object} */ guild_scheduled_events: APIGuildScheduledEvent[]; /** * The soundboard sounds in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object + * @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object} */ soundboard_sounds: APISoundboardSound[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ export type GatewayGuildUpdateDispatch = GatewayGuildModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ export type GatewayGuildUpdateDispatchData = GatewayGuildModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-delete} */ -export type GatewayGuildDeleteDispatch = DataPayload; +export type GatewayGuildDeleteDispatch = _DataPayload< + GatewayDispatchEvents.GuildDelete, + GatewayGuildDeleteDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-delete} */ export interface GatewayGuildDeleteDispatchData extends Omit { /** @@ -955,17 +963,17 @@ export interface GatewayGuildDeleteDispatchData extends Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-add - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-add} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove} */ export interface GatewayGuildBanModifyDispatchData { /** @@ -975,41 +983,41 @@ export interface GatewayGuildBanModifyDispatchData { /** * The banned user * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ user: APIUser; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-add} */ export type GatewayGuildBanAddDispatch = GatewayGuildBanModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-add} */ export type GatewayGuildBanAddDispatchData = GatewayGuildBanModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove} */ export type GatewayGuildBanRemoveDispatch = GatewayGuildBanModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove} */ export type GatewayGuildBanRemoveDispatchData = GatewayGuildBanModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update} */ -export type GatewayGuildEmojisUpdateDispatch = DataPayload< +export type GatewayGuildEmojisUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildEmojisUpdate, GatewayGuildEmojisUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update} */ export interface GatewayGuildEmojisUpdateDispatchData { /** @@ -1019,21 +1027,21 @@ export interface GatewayGuildEmojisUpdateDispatchData { /** * Array of emojis * - * See https://discord.com/developers/docs/resources/emoji#emoji-object + * @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object} */ emojis: APIEmoji[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update} */ -export type GatewayGuildStickersUpdateDispatch = DataPayload< +export type GatewayGuildStickersUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildStickersUpdate, GatewayGuildStickersUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update} */ export interface GatewayGuildStickersUpdateDispatchData { /** @@ -1043,21 +1051,21 @@ export interface GatewayGuildStickersUpdateDispatchData { /** * Array of stickers * - * See https://discord.com/developers/docs/resources/sticker#sticker-object + * @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object} */ stickers: APISticker[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update} */ -export type GatewayGuildIntegrationsUpdateDispatch = DataPayload< +export type GatewayGuildIntegrationsUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildIntegrationsUpdate, GatewayGuildIntegrationsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update} */ export interface GatewayGuildIntegrationsUpdateDispatchData { /** @@ -1067,15 +1075,15 @@ export interface GatewayGuildIntegrationsUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-add} */ -export type GatewayGuildMemberAddDispatch = DataPayload< +export type GatewayGuildMemberAddDispatch = _DataPayload< GatewayDispatchEvents.GuildMemberAdd, GatewayGuildMemberAddDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-add} */ export interface GatewayGuildMemberAddDispatchData extends APIGuildMember { /** @@ -1085,15 +1093,15 @@ export interface GatewayGuildMemberAddDispatchData extends APIGuildMember { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-remove} */ -export type GatewayGuildMemberRemoveDispatch = DataPayload< +export type GatewayGuildMemberRemoveDispatch = _DataPayload< GatewayDispatchEvents.GuildMemberRemove, GatewayGuildMemberRemoveDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-remove} */ export interface GatewayGuildMemberRemoveDispatchData { /** @@ -1103,23 +1111,23 @@ export interface GatewayGuildMemberRemoveDispatchData { /** * The user who was removed * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ user: APIUser; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-update} */ -export type GatewayGuildMemberUpdateDispatch = DataPayload< +export type GatewayGuildMemberUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildMemberUpdate, GatewayGuildMemberUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-update} */ -export type GatewayGuildMemberUpdateDispatchData = Nullable> & +export type GatewayGuildMemberUpdateDispatchData = _Nullable> & Omit & Partial> & Required> & { @@ -1130,20 +1138,20 @@ export type GatewayGuildMemberUpdateDispatchData = Nullable; /** - * https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ export type GatewayGuildMembersChunkPresence = Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk} */ export interface GatewayGuildMembersChunkDispatchData { /** @@ -1153,7 +1161,7 @@ export interface GatewayGuildMembersChunkDispatchData { /** * Set of guild members * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ members: APIGuildMember[]; /** @@ -1171,29 +1179,29 @@ export interface GatewayGuildMembersChunkDispatchData { /** * If passing true to `REQUEST_GUILD_MEMBERS`, presences of the returned members will be here * - * See https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ presences?: GatewayGuildMembersChunkPresence[]; /** * The nonce used in the Guild Members Request * - * See https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ nonce?: string; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ -export type GatewayGuildRoleModifyDispatch = DataPayload< +export type GatewayGuildRoleModifyDispatch = _DataPayload< GatewayDispatchEvents.GuildRoleCreate | GatewayDispatchEvents.GuildRoleUpdate, GatewayGuildRoleModifyDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ export interface GatewayGuildRoleModifyDispatchData { /** @@ -1203,41 +1211,41 @@ export interface GatewayGuildRoleModifyDispatchData { /** * The role created or updated * - * See https://discord.com/developers/docs/topics/permissions#role-object + * @see {@link https://discord.com/developers/docs/topics/permissions#role-object} */ role: APIRole; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} */ export type GatewayGuildRoleCreateDispatch = GatewayGuildRoleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} */ export type GatewayGuildRoleCreateDispatchData = GatewayGuildRoleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ export type GatewayGuildRoleUpdateDispatch = GatewayGuildRoleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ export type GatewayGuildRoleUpdateDispatchData = GatewayGuildRoleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-delete} */ -export type GatewayGuildRoleDeleteDispatch = DataPayload< +export type GatewayGuildRoleDeleteDispatch = _DataPayload< GatewayDispatchEvents.GuildRoleDelete, GatewayGuildRoleDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-delete} */ export interface GatewayGuildRoleDeleteDispatchData { /** @@ -1251,54 +1259,54 @@ export interface GatewayGuildRoleDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create} */ -export type GatewayGuildScheduledEventCreateDispatch = DataPayload< +export type GatewayGuildScheduledEventCreateDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventCreate, GatewayGuildScheduledEventCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create} */ export type GatewayGuildScheduledEventCreateDispatchData = APIGuildScheduledEvent; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update} */ -export type GatewayGuildScheduledEventUpdateDispatch = DataPayload< +export type GatewayGuildScheduledEventUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventUpdate, GatewayGuildScheduledEventUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update} */ export type GatewayGuildScheduledEventUpdateDispatchData = APIGuildScheduledEvent; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete} */ -export type GatewayGuildScheduledEventDeleteDispatch = DataPayload< +export type GatewayGuildScheduledEventDeleteDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventDelete, GatewayGuildScheduledEventDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete} */ export type GatewayGuildScheduledEventDeleteDispatchData = APIGuildScheduledEvent; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add} */ -export type GatewayGuildScheduledEventUserAddDispatch = DataPayload< +export type GatewayGuildScheduledEventUserAddDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventUserAdd, GatewayGuildScheduledEventUserAddDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add} */ export interface GatewayGuildScheduledEventUserAddDispatchData { guild_scheduled_event_id: Snowflake; @@ -1307,15 +1315,15 @@ export interface GatewayGuildScheduledEventUserAddDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove} */ -export type GatewayGuildScheduledEventUserRemoveDispatch = DataPayload< +export type GatewayGuildScheduledEventUserRemoveDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventUserRemove, GatewayGuildScheduledEventUserAddDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove} */ export interface GatewayGuildScheduledEventUserRemoveDispatchData { guild_scheduled_event_id: Snowflake; @@ -1324,41 +1332,41 @@ export interface GatewayGuildScheduledEventUserRemoveDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create} */ -export type GatewayGuildSoundboardSoundCreateDispatch = DataPayload< +export type GatewayGuildSoundboardSoundCreateDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundCreate, GatewayGuildSoundboardSoundCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create} */ export type GatewayGuildSoundboardSoundCreateDispatchData = APISoundboardSound; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update} */ -export type GatewayGuildSoundboardSoundUpdateDispatch = DataPayload< +export type GatewayGuildSoundboardSoundUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundUpdate, GatewayGuildSoundboardSoundUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update} */ export type GatewayGuildSoundboardSoundUpdateDispatchData = APISoundboardSound; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete} */ -export type GatewayGuildSoundboardSoundDeleteDispatch = DataPayload< +export type GatewayGuildSoundboardSoundDeleteDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundDelete, GatewayGuildSoundboardSoundDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete} */ export interface GatewayGuildSoundboardSoundDeleteDispatchData { /** @@ -1372,15 +1380,15 @@ export interface GatewayGuildSoundboardSoundDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update} */ -export type GatewayGuildSoundboardSoundsUpdateDispatch = DataPayload< +export type GatewayGuildSoundboardSoundsUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundsUpdate, GatewayGuildSoundboardSoundsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update} */ export interface GatewayGuildSoundboardSoundsUpdateDispatchData { /** @@ -1394,15 +1402,15 @@ export interface GatewayGuildSoundboardSoundsUpdateDispatchData { } /** - * https://discord.com/developers/docs/events/gateway-events#soundboard-sounds + * @see {@link https://discord.com/developers/docs/events/gateway-events#soundboard-sounds} */ -export type GatewaySoundboardSoundsDispatch = DataPayload< +export type GatewaySoundboardSoundsDispatch = _DataPayload< GatewayDispatchEvents.SoundboardSounds, GatewaySoundboardSoundsDispatchData >; /** - * https://discord.com/developers/docs/events/gateway-events#soundboard-sounds + * @see {@link https://discord.com/developers/docs/events/gateway-events#soundboard-sounds} */ export interface GatewaySoundboardSoundsDispatchData { /** @@ -1416,41 +1424,41 @@ export interface GatewaySoundboardSoundsDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#integration-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-create} */ -export type GatewayIntegrationCreateDispatch = DataPayload< +export type GatewayIntegrationCreateDispatch = _DataPayload< GatewayDispatchEvents.IntegrationCreate, GatewayIntegrationCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-create} */ export type GatewayIntegrationCreateDispatchData = APIGuildIntegration & { guild_id: Snowflake }; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-update} */ -export type GatewayIntegrationUpdateDispatch = DataPayload< +export type GatewayIntegrationUpdateDispatch = _DataPayload< GatewayDispatchEvents.IntegrationUpdate, GatewayIntegrationUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-update} */ export type GatewayIntegrationUpdateDispatchData = APIGuildIntegration & { guild_id: Snowflake }; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-update} */ -export type GatewayIntegrationDeleteDispatch = DataPayload< +export type GatewayIntegrationDeleteDispatch = _DataPayload< GatewayDispatchEvents.IntegrationDelete, GatewayIntegrationDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-delete} */ export interface GatewayIntegrationDeleteDispatchData { /** @@ -1468,28 +1476,28 @@ export interface GatewayIntegrationDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#interaction-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#interaction-create} */ -export type GatewayInteractionCreateDispatch = DataPayload< +export type GatewayInteractionCreateDispatch = _DataPayload< GatewayDispatchEvents.InteractionCreate, GatewayInteractionCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#interaction-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#interaction-create} */ export type GatewayInteractionCreateDispatchData = APIInteraction; /** - * https://discord.com/developers/docs/topics/gateway-events#invite-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-create} */ -export type GatewayInviteCreateDispatch = DataPayload< +export type GatewayInviteCreateDispatch = _DataPayload< GatewayDispatchEvents.InviteCreate, GatewayInviteCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#invite-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-create} */ export interface GatewayInviteCreateDispatchData { /** @@ -1499,7 +1507,7 @@ export interface GatewayInviteCreateDispatchData { /** * The unique invite code * - * See https://discord.com/developers/docs/resources/invite#invite-object + * @see {@link https://discord.com/developers/docs/resources/invite#invite-object} */ code: string; /** @@ -1513,7 +1521,7 @@ export interface GatewayInviteCreateDispatchData { /** * The user that created the invite * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ inviter?: APIUser; /** @@ -1527,13 +1535,13 @@ export interface GatewayInviteCreateDispatchData { /** * The type of target for this voice channel invite * - * See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types + * @see {@link https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types} */ target_type?: InviteTargetType; /** * The user whose stream to display for this voice channel stream invite * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ target_user?: APIUser; /** @@ -1551,15 +1559,15 @@ export interface GatewayInviteCreateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#invite-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-delete} */ -export type GatewayInviteDeleteDispatch = DataPayload< +export type GatewayInviteDeleteDispatch = _DataPayload< GatewayDispatchEvents.InviteDelete, GatewayInviteDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#invite-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-delete} */ export interface GatewayInviteDeleteDispatchData { /** @@ -1573,39 +1581,39 @@ export interface GatewayInviteDeleteDispatchData { /** * The unique invite code * - * See https://discord.com/developers/docs/resources/invite#invite-object + * @see {@link https://discord.com/developers/docs/resources/invite#invite-object} */ code: string; } /** - * https://discord.com/developers/docs/topics/gateway-events#message-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create} */ -export type GatewayMessageCreateDispatch = DataPayload< +export type GatewayMessageCreateDispatch = _DataPayload< GatewayDispatchEvents.MessageCreate, GatewayMessageCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create} */ export type GatewayMessageCreateDispatchData = GatewayMessageEventExtraFields & Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#message-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update} */ -export type GatewayMessageUpdateDispatch = DataPayload< +export type GatewayMessageUpdateDispatch = _DataPayload< GatewayDispatchEvents.MessageUpdate, GatewayMessageUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update} */ export type GatewayMessageUpdateDispatchData = GatewayMessageEventExtraFields & Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#message-create-message-create-extra-fields + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create-message-create-extra-fields} */ export interface GatewayMessageEventExtraFields { /** @@ -1618,7 +1626,7 @@ export interface GatewayMessageEventExtraFields { * The member object exists in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events * from text-based guild channels * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ member?: Omit; /** @@ -1627,22 +1635,22 @@ export interface GatewayMessageEventExtraFields { * The `member` field is only present in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events * from text-based guild channels * - * See https://discord.com/developers/docs/resources/user#user-object - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ mentions: (APIUser & { member?: Omit })[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete} */ -export type GatewayMessageDeleteDispatch = DataPayload< +export type GatewayMessageDeleteDispatch = _DataPayload< GatewayDispatchEvents.MessageDelete, GatewayMessageDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete} */ export interface GatewayMessageDeleteDispatchData { /** @@ -1660,15 +1668,15 @@ export interface GatewayMessageDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk} */ -export type GatewayMessageDeleteBulkDispatch = DataPayload< +export type GatewayMessageDeleteBulkDispatch = _DataPayload< GatewayDispatchEvents.MessageDeleteBulk, GatewayMessageDeleteBulkDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk} */ export interface GatewayMessageDeleteBulkDispatchData { /** @@ -1686,53 +1694,53 @@ export interface GatewayMessageDeleteBulkDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add} */ -export type GatewayMessageReactionAddDispatch = ReactionData; +export type GatewayMessageReactionAddDispatch = GatewayMessageReactionData; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add} */ export type GatewayMessageReactionAddDispatchData = GatewayMessageReactionAddDispatch['d']; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove} */ -export type GatewayMessageReactionRemoveDispatch = ReactionData< +export type GatewayMessageReactionRemoveDispatch = GatewayMessageReactionData< GatewayDispatchEvents.MessageReactionRemove, 'burst_colors' | 'member' | 'message_author_id' >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove} */ export type GatewayMessageReactionRemoveDispatchData = GatewayMessageReactionRemoveDispatch['d']; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all} */ -export type GatewayMessageReactionRemoveAllDispatch = DataPayload< +export type GatewayMessageReactionRemoveAllDispatch = _DataPayload< GatewayDispatchEvents.MessageReactionRemoveAll, GatewayMessageReactionRemoveAllDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all} */ -export type GatewayMessageReactionRemoveAllDispatchData = MessageReactionRemoveData; +export type GatewayMessageReactionRemoveAllDispatchData = GatewayMessageReactionRemoveData; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji} */ -export type GatewayMessageReactionRemoveEmojiDispatch = DataPayload< +export type GatewayMessageReactionRemoveEmojiDispatch = _DataPayload< GatewayDispatchEvents.MessageReactionRemoveEmoji, GatewayMessageReactionRemoveEmojiDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji} */ -export interface GatewayMessageReactionRemoveEmojiDispatchData extends MessageReactionRemoveData { +export interface GatewayMessageReactionRemoveEmojiDispatchData extends GatewayMessageReactionRemoveData { /** * The emoji that was removed */ @@ -1740,120 +1748,120 @@ export interface GatewayMessageReactionRemoveEmojiDispatchData extends MessageRe } /** - * https://discord.com/developers/docs/topics/gateway-events#presence-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update} */ -export type GatewayPresenceUpdateDispatch = DataPayload< +export type GatewayPresenceUpdateDispatch = _DataPayload< GatewayDispatchEvents.PresenceUpdate, GatewayPresenceUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#presence-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update} */ export type GatewayPresenceUpdateDispatchData = RawGatewayPresenceUpdate; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-create} */ -export type GatewayStageInstanceCreateDispatch = DataPayload< +export type GatewayStageInstanceCreateDispatch = _DataPayload< GatewayDispatchEvents.StageInstanceCreate, GatewayStageInstanceCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-create} */ export type GatewayStageInstanceCreateDispatchData = APIStageInstance; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete} */ -export type GatewayStageInstanceDeleteDispatch = DataPayload< +export type GatewayStageInstanceDeleteDispatch = _DataPayload< GatewayDispatchEvents.StageInstanceDelete, GatewayStageInstanceDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete} */ export type GatewayStageInstanceDeleteDispatchData = APIStageInstance; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-update} */ -export type GatewayStageInstanceUpdateDispatch = DataPayload< +export type GatewayStageInstanceUpdateDispatch = _DataPayload< GatewayDispatchEvents.StageInstanceUpdate, GatewayStageInstanceUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-update} */ export type GatewayStageInstanceUpdateDispatchData = APIStageInstance; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-list-sync + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync} */ -export type GatewayThreadListSyncDispatch = DataPayload< +export type GatewayThreadListSyncDispatch = _DataPayload< GatewayDispatchEvents.ThreadListSync, GatewayThreadListSyncDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-list-sync + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync} */ export type GatewayThreadListSyncDispatchData = RawGatewayThreadListSync; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-members-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update} */ -export type GatewayThreadMembersUpdateDispatch = DataPayload< +export type GatewayThreadMembersUpdateDispatch = _DataPayload< GatewayDispatchEvents.ThreadMembersUpdate, GatewayThreadMembersUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-members-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update} */ export type GatewayThreadMembersUpdateDispatchData = RawGatewayThreadMembersUpdate; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-member-update} */ -export type GatewayThreadMemberUpdateDispatch = DataPayload< +export type GatewayThreadMemberUpdateDispatch = _DataPayload< GatewayDispatchEvents.ThreadMemberUpdate, GatewayThreadMemberUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-member-update} */ export type GatewayThreadMemberUpdateDispatchData = APIThreadMember & { guild_id: Snowflake }; /** * @deprecated This type doesn't accurately reflect the Discord API. - * Use {@apilink GatewayThreadCreateDispatch}, - * {@apilink GatewayThreadUpdateDispatch}, or - * {@apilink GatewayThreadDeleteDispatch} instead. - * https://discord.com/developers/docs/topics/gateway-events#thread-create - * https://discord.com/developers/docs/topics/gateway-events#thread-update - * https://discord.com/developers/docs/topics/gateway-events#thread-delete + * Use {@link GatewayThreadCreateDispatch}, + * {@link GatewayThreadUpdateDispatch}, or + * {@link GatewayThreadDeleteDispatch} instead. + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-delete} */ -export type GatewayThreadModifyDispatch = DataPayload< +export type GatewayThreadModifyDispatch = _DataPayload< GatewayDispatchEvents.ThreadCreate | GatewayDispatchEvents.ThreadDelete | GatewayDispatchEvents.ThreadUpdate, APIThreadChannel >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-create} */ -export type GatewayThreadCreateDispatch = DataPayload< +export type GatewayThreadCreateDispatch = _DataPayload< GatewayDispatchEvents.ThreadCreate, GatewayThreadCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-create} */ export interface GatewayThreadCreateDispatchData extends APIThreadChannel { /** @@ -1863,28 +1871,28 @@ export interface GatewayThreadCreateDispatchData extends APIThreadChannel { } /** - * https://discord.com/developers/docs/topics/gateway-events#thread-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-update} */ -export type GatewayThreadUpdateDispatch = DataPayload< +export type GatewayThreadUpdateDispatch = _DataPayload< GatewayDispatchEvents.ThreadUpdate, GatewayThreadUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-update} */ export type GatewayThreadUpdateDispatchData = APIThreadChannel; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-delete} */ -export type GatewayThreadDeleteDispatch = DataPayload< +export type GatewayThreadDeleteDispatch = _DataPayload< GatewayDispatchEvents.ThreadDelete, GatewayThreadDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-delete} */ export interface GatewayThreadDeleteDispatchData { /** @@ -1902,18 +1910,21 @@ export interface GatewayThreadDeleteDispatchData { /** * The type of the channel * - * See https://discord.com/developers/docs/resources/channel#channel-object-channel-types + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types} */ type: ChannelType; } /** - * https://discord.com/developers/docs/topics/gateway-events#typing-start + * @see {@link https://discord.com/developers/docs/topics/gateway-events#typing-start} */ -export type GatewayTypingStartDispatch = DataPayload; +export type GatewayTypingStartDispatch = _DataPayload< + GatewayDispatchEvents.TypingStart, + GatewayTypingStartDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#typing-start + * @see {@link https://discord.com/developers/docs/topics/gateway-events#typing-start} */ export interface GatewayTypingStartDispatchData { /** @@ -1935,31 +1946,31 @@ export interface GatewayTypingStartDispatchData { /** * The member who started typing if this happened in a guild * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ member?: APIGuildMember; } /** - * https://discord.com/developers/docs/topics/gateway-events#user-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#user-update} */ -export type GatewayUserUpdateDispatch = DataPayload; +export type GatewayUserUpdateDispatch = _DataPayload; /** - * https://discord.com/developers/docs/topics/gateway-events#user-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#user-update} */ export type GatewayUserUpdateDispatchData = APIUser; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send} */ -export type GatewayVoiceChannelEffectSendDispatch = DataPayload< +export type GatewayVoiceChannelEffectSendDispatch = _DataPayload< GatewayDispatchEvents.VoiceChannelEffectSend, GatewayVoiceChannelEffectSendDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send} */ export interface GatewayVoiceChannelEffectSendDispatchData { /** @@ -1997,7 +2008,7 @@ export interface GatewayVoiceChannelEffectSendDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send-animation-types + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send-animation-types} */ export enum VoiceChannelEffectSendAnimationType { /** @@ -2011,28 +2022,28 @@ export enum VoiceChannelEffectSendAnimationType { } /** - * https://discord.com/developers/docs/topics/gateway-events#voice-state-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-state-update} */ -export type GatewayVoiceStateUpdateDispatch = DataPayload< +export type GatewayVoiceStateUpdateDispatch = _DataPayload< GatewayDispatchEvents.VoiceStateUpdate, GatewayVoiceStateUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-state-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-state-update} */ export type GatewayVoiceStateUpdateDispatchData = APIVoiceState; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-server-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-server-update} */ -export type GatewayVoiceServerUpdateDispatch = DataPayload< +export type GatewayVoiceServerUpdateDispatch = _DataPayload< GatewayDispatchEvents.VoiceServerUpdate, GatewayVoiceServerUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-server-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-server-update} */ export interface GatewayVoiceServerUpdateDispatchData { /** @@ -2054,15 +2065,15 @@ export interface GatewayVoiceServerUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#webhooks-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#webhooks-update} */ -export type GatewayWebhooksUpdateDispatch = DataPayload< +export type GatewayWebhooksUpdateDispatch = _DataPayload< GatewayDispatchEvents.WebhooksUpdate, GatewayWebhooksUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#webhooks-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#webhooks-update} */ export interface GatewayWebhooksUpdateDispatchData { /** @@ -2076,15 +2087,15 @@ export interface GatewayWebhooksUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create} */ -export type GatewayGuildAuditLogEntryCreateDispatch = DataPayload< +export type GatewayGuildAuditLogEntryCreateDispatch = _DataPayload< GatewayDispatchEvents.GuildAuditLogEntryCreate, GatewayGuildAuditLogEntryCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create} */ export interface GatewayGuildAuditLogEntryCreateDispatchData extends APIAuditLogEntry { /** @@ -2094,24 +2105,24 @@ export interface GatewayGuildAuditLogEntryCreateDispatchData extends APIAuditLog } /** - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add} */ -export type GatewayMessagePollVoteAddDispatch = DataPayload< +export type GatewayMessagePollVoteAddDispatch = _DataPayload< GatewayDispatchEvents.MessagePollVoteAdd, GatewayMessagePollVoteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove} */ -export type GatewayMessagePollVoteRemoveDispatch = DataPayload< +export type GatewayMessagePollVoteRemoveDispatch = _DataPayload< GatewayDispatchEvents.MessagePollVoteRemove, GatewayMessagePollVoteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove} */ export interface GatewayMessagePollVoteDispatchData { /** @@ -2141,7 +2152,7 @@ export interface GatewayMessagePollVoteDispatchData { // #region Sendable Payloads /** - * https://discord.com/developers/docs/topics/gateway#sending-heartbeats + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-heartbeats} */ export interface GatewayHeartbeat { op: GatewayOpcodes.Heartbeat; @@ -2149,12 +2160,12 @@ export interface GatewayHeartbeat { } /** - * https://discord.com/developers/docs/topics/gateway#sending-heartbeats + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-heartbeats} */ export type GatewayHeartbeatData = number | null; /** - * https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ export interface GatewayIdentify { op: GatewayOpcodes.Identify; @@ -2162,7 +2173,7 @@ export interface GatewayIdentify { } /** - * https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ export interface GatewayIdentifyData { /** @@ -2172,44 +2183,44 @@ export interface GatewayIdentifyData { /** * Connection properties * - * See https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties} */ properties: GatewayIdentifyProperties; /** * Whether this connection supports compression of packets * - * @default false + * @defaultValue `false` */ compress?: boolean; /** * Value between 50 and 250, total number of members where the gateway will stop sending * offline members in the guild member list * - * @default 50 + * @defaultValue `50` */ large_threshold?: number; /** * Used for Guild Sharding * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ shard?: [shard_id: number, shard_count: number]; /** * Presence structure for initial presence information * - * See https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ presence?: GatewayPresenceUpdateData; /** * The Gateway Intents you wish to receive * - * See https://discord.com/developers/docs/topics/gateway#gateway-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#gateway-intents} */ intents: number; } /** - * https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties} */ export interface GatewayIdentifyProperties { /** @@ -2227,7 +2238,7 @@ export interface GatewayIdentifyProperties { } /** - * https://discord.com/developers/docs/topics/gateway-events#resume + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resume} */ export interface GatewayResume { op: GatewayOpcodes.Resume; @@ -2235,7 +2246,7 @@ export interface GatewayResume { } /** - * https://discord.com/developers/docs/topics/gateway-events#resume + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resume} */ export interface GatewayResumeData { /** @@ -2253,7 +2264,7 @@ export interface GatewayResumeData { } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembers { op: GatewayOpcodes.RequestGuildMembers; @@ -2261,7 +2272,7 @@ export interface GatewayRequestGuildMembers { } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembersDataBase { /** @@ -2277,13 +2288,13 @@ export interface GatewayRequestGuildMembersDataBase { * * Nonce can only be up to 32 bytes. If you send an invalid nonce it will be ignored and the reply member_chunk(s) will not have a `nonce` set. * - * See https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk} */ nonce?: string; } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembersDataWithUserIds extends GatewayRequestGuildMembersDataBase { /** @@ -2293,7 +2304,7 @@ export interface GatewayRequestGuildMembersDataWithUserIds extends GatewayReques } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembersDataWithQuery extends GatewayRequestGuildMembersDataBase { /** @@ -2308,14 +2319,14 @@ export interface GatewayRequestGuildMembersDataWithQuery extends GatewayRequestG } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export type GatewayRequestGuildMembersData = | GatewayRequestGuildMembersDataWithQuery | GatewayRequestGuildMembersDataWithUserIds; /** - * https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds} */ export interface GatewayRequestSoundboardSounds { op: GatewayOpcodes.RequestSoundboardSounds; @@ -2323,7 +2334,7 @@ export interface GatewayRequestSoundboardSounds { } /** - * https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds} */ export interface GatewayRequestSoundboardSoundsData { /** @@ -2333,7 +2344,7 @@ export interface GatewayRequestSoundboardSoundsData { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-voice-state + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-voice-state} */ export interface GatewayVoiceStateUpdate { op: GatewayOpcodes.VoiceStateUpdate; @@ -2341,7 +2352,7 @@ export interface GatewayVoiceStateUpdate { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-voice-state + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-voice-state} */ export interface GatewayVoiceStateUpdateData { /** @@ -2363,7 +2374,7 @@ export interface GatewayVoiceStateUpdateData { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ export interface GatewayUpdatePresence { op: GatewayOpcodes.PresenceUpdate; @@ -2371,7 +2382,7 @@ export interface GatewayUpdatePresence { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-presence-gateway-presence-update-structure + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence-gateway-presence-update-structure} */ export interface GatewayPresenceUpdateData { /** @@ -2381,13 +2392,13 @@ export interface GatewayPresenceUpdateData { /** * The user's activities * - * See https://discord.com/developers/docs/topics/gateway-events#activity-object + * @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object} */ activities: GatewayActivityUpdateData[]; /** * The user's new status * - * See https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types} */ status: PresenceUpdateStatus; /** @@ -2397,14 +2408,14 @@ export interface GatewayPresenceUpdateData { } /** - * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure + * @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure} */ export type GatewayActivityUpdateData = Pick; // #endregion Sendable Payloads // #region Shared -interface BasePayload { +export interface _BasePayload { /** * Opcode for the payload */ @@ -2423,18 +2434,18 @@ interface BasePayload { t?: string; } -type NonDispatchPayload = Omit & { +export type _NonDispatchPayload = Omit<_BasePayload, 's' | 't'> & { t: null; s: null; }; -interface DataPayload extends BasePayload { +export interface _DataPayload extends _BasePayload { op: GatewayOpcodes.Dispatch; t: Event; d: D; } -type ReactionData = DataPayload< +export type GatewayMessageReactionData = _DataPayload< E, Omit< { @@ -2457,13 +2468,13 @@ type ReactionData = D /** * The member who reacted if this happened in a guild * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ member?: APIGuildMember; /** * The emoji used to react * - * See https://discord.com/developers/docs/resources/emoji#emoji-object + * @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object} */ emoji: APIEmoji; /** @@ -2487,7 +2498,7 @@ type ReactionData = D > >; -interface MessageReactionRemoveData { +export interface GatewayMessageReactionRemoveData { /** * The id of the channel */ diff --git a/deno/gateway/v8.ts b/deno/gateway/v8.ts index da40e6bf..85069bfc 100644 --- a/deno/gateway/v8.ts +++ b/deno/gateway/v8.ts @@ -24,7 +24,7 @@ import type { InviteTargetType, PresenceUpdateStatus, } from '../payloads/v8/mod.ts'; -import type { Nullable } from '../utils/internals.ts'; +import type { _Nullable } from '../utils/internals.ts'; export * from './common.ts'; @@ -805,7 +805,7 @@ export type GatewayGuildMemberUpdateDispatch = DataPayload< * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ -export type GatewayGuildMemberUpdateDispatchData = Nullable> & +export type GatewayGuildMemberUpdateDispatchData = _Nullable> & Omit & Partial> & Required> & { diff --git a/deno/gateway/v9.ts b/deno/gateway/v9.ts index f5d9d1e0..6945f3e7 100644 --- a/deno/gateway/v9.ts +++ b/deno/gateway/v9.ts @@ -40,7 +40,7 @@ import type { ThreadChannelType, } from '../payloads/v9/mod.ts'; import type { ReactionType } from '../rest/v9/mod.ts'; -import type { Nullable } from '../utils/internals.ts'; +import type { _Nullable } from '../utils/internals.ts'; import type { APIEntitlement } from '../v10.ts'; export * from './common.ts'; @@ -48,7 +48,7 @@ export * from './common.ts'; export const GatewayVersion = '9'; /** - * https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes + * @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes} */ export enum GatewayOpcodes { /** @@ -103,7 +103,7 @@ export enum GatewayOpcodes { } /** - * https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes + * @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes} */ export enum GatewayCloseCodes { /** @@ -113,25 +113,25 @@ export enum GatewayCloseCodes { /** * You sent an invalid Gateway opcode or an invalid payload for an opcode. Don't do that! * - * See https://discord.com/developers/docs/topics/gateway-events#payload-structure + * @see {@link https://discord.com/developers/docs/topics/gateway-events#payload-structure} */ UnknownOpcode, /** * You sent an invalid payload to us. Don't do that! * - * See https://discord.com/developers/docs/topics/gateway#sending-events + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-events} */ DecodeError, /** * You sent us a payload prior to identifying * - * See https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ NotAuthenticated, /** * The account token sent with your identify payload is incorrect * - * See https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ AuthenticationFailed, /** @@ -141,7 +141,7 @@ export enum GatewayCloseCodes { /** * The sequence sent when resuming the session was invalid. Reconnect and start a new session * - * See https://discord.com/developers/docs/topics/gateway-events#resume + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resume} */ InvalidSeq = 4_007, /** @@ -155,13 +155,13 @@ export enum GatewayCloseCodes { /** * You sent us an invalid shard when identifying * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ InvalidShard, /** * The session would have handled too many guilds - you are required to shard your connection in order to connect * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ ShardingRequired, /** @@ -171,34 +171,33 @@ export enum GatewayCloseCodes { /** * You sent an invalid intent for a Gateway Intent. You may have incorrectly calculated the bitwise value * - * See https://discord.com/developers/docs/topics/gateway#gateway-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#gateway-intents} */ InvalidIntents, /** * You sent a disallowed intent for a Gateway Intent. You may have tried to specify an intent that you have not * enabled or are not whitelisted for * - * See https://discord.com/developers/docs/topics/gateway#gateway-intents - * - * See https://discord.com/developers/docs/topics/gateway#privileged-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#gateway-intents} + * @see {@link https://discord.com/developers/docs/topics/gateway#privileged-intents} */ DisallowedIntents, } /** - * https://discord.com/developers/docs/topics/gateway#list-of-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#list-of-intents} */ export enum GatewayIntentBits { Guilds = 1 << 0, GuildMembers = 1 << 1, GuildModeration = 1 << 2, /** - * @deprecated This is the old name for {@apilink GatewayIntentBits#GuildModeration} + * @deprecated This is the old name for {@link GatewayIntentBits.GuildModeration} */ GuildBans = GuildModeration, GuildExpressions = 1 << 3, /** - * @deprecated This is the old name for {@apilink GatewayIntentBits#GuildExpressions} + * @deprecated This is the old name for {@link GatewayIntentBits.GuildExpressions} */ GuildEmojisAndStickers = GuildExpressions, GuildIntegrations = 1 << 4, @@ -220,7 +219,7 @@ export enum GatewayIntentBits { } /** - * https://discord.com/developers/docs/topics/gateway-events#receive-events + * @see {@link https://discord.com/developers/docs/topics/gateway-events#receive-events} */ export enum GatewayDispatchEvents { ApplicationCommandPermissionsUpdate = 'APPLICATION_COMMAND_PERMISSIONS_UPDATE', @@ -389,15 +388,15 @@ export type GatewayDispatchPayload = // #region Dispatch Payloads /** - * https://discord.com/developers/docs/topics/gateway-events#hello + * @see {@link https://discord.com/developers/docs/topics/gateway-events#hello} */ -export interface GatewayHello extends NonDispatchPayload { +export interface GatewayHello extends _NonDispatchPayload { op: GatewayOpcodes.Hello; d: GatewayHelloData; } /** - * https://discord.com/developers/docs/topics/gateway-events#hello + * @see {@link https://discord.com/developers/docs/topics/gateway-events#hello} */ export interface GatewayHelloData { /** @@ -407,67 +406,67 @@ export interface GatewayHelloData { } /** - * https://discord.com/developers/docs/topics/gateway#sending-heartbeats + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-heartbeats} */ -export interface GatewayHeartbeatRequest extends NonDispatchPayload { +export interface GatewayHeartbeatRequest extends _NonDispatchPayload { op: GatewayOpcodes.Heartbeat; d: never; } /** - * https://discord.com/developers/docs/topics/gateway-events#heartbeat + * @see {@link https://discord.com/developers/docs/topics/gateway-events#heartbeat} */ -export interface GatewayHeartbeatAck extends NonDispatchPayload { +export interface GatewayHeartbeatAck extends _NonDispatchPayload { op: GatewayOpcodes.HeartbeatAck; d: never; } /** - * https://discord.com/developers/docs/topics/gateway-events#invalid-session + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invalid-session} */ -export interface GatewayInvalidSession extends NonDispatchPayload { +export interface GatewayInvalidSession extends _NonDispatchPayload { op: GatewayOpcodes.InvalidSession; d: GatewayInvalidSessionData; } /** - * https://discord.com/developers/docs/topics/gateway-events#invalid-session + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invalid-session} */ export type GatewayInvalidSessionData = boolean; /** - * https://discord.com/developers/docs/topics/gateway-events#reconnect + * @see {@link https://discord.com/developers/docs/topics/gateway-events#reconnect} */ -export interface GatewayReconnect extends NonDispatchPayload { +export interface GatewayReconnect extends _NonDispatchPayload { op: GatewayOpcodes.Reconnect; d: never; } /** - * https://discord.com/developers/docs/topics/gateway-events#ready + * @see {@link https://discord.com/developers/docs/topics/gateway-events#ready} */ -export type GatewayReadyDispatch = DataPayload; +export type GatewayReadyDispatch = _DataPayload; /** - * https://discord.com/developers/docs/topics/gateway-events#ready + * @see {@link https://discord.com/developers/docs/topics/gateway-events#ready} */ export interface GatewayReadyDispatchData { /** * Gateway version * - * See https://discord.com/developers/docs/reference#api-versioning + * @see {@link https://discord.com/developers/docs/reference#api-versioning} */ v: number; /** * Information about the user including email * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ user: APIUser; /** * The guilds the user is in * - * See https://discord.com/developers/docs/resources/guild#unavailable-guild-object + * @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object} */ guilds: APIUnavailableGuild[]; /** @@ -481,28 +480,28 @@ export interface GatewayReadyDispatchData { /** * The shard information associated with this session, if sent when identifying * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ shard?: [shard_id: number, shard_count: number]; /** * Contains `id` and `flags` * - * See https://discord.com/developers/docs/resources/application#application-object + * @see {@link https://discord.com/developers/docs/resources/application#application-object} */ application: Pick; } /** - * https://discord.com/developers/docs/topics/gateway-events#resumed + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resumed} */ -export type GatewayResumedDispatch = DataPayload; +export type GatewayResumedDispatch = _DataPayload; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ -export type GatewayAutoModerationRuleModifyDispatch = DataPayload< +export type GatewayAutoModerationRuleModifyDispatch = _DataPayload< | GatewayDispatchEvents.AutoModerationRuleCreate | GatewayDispatchEvents.AutoModerationRuleDelete | GatewayDispatchEvents.AutoModerationRuleUpdate, @@ -510,52 +509,52 @@ export type GatewayAutoModerationRuleModifyDispatch = DataPayload< >; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ export type GatewayAutoModerationRuleModifyDispatchData = APIAutoModerationRule; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} */ export type GatewayAutoModerationRuleCreateDispatch = GatewayAutoModerationRuleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} */ export type GatewayAutoModerationRuleCreateDispatchData = GatewayAutoModerationRuleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} */ export type GatewayAutoModerationRuleUpdateDispatch = GatewayAutoModerationRuleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-update} */ export type GatewayAutoModerationRuleUpdateDispatchData = GatewayAutoModerationRuleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ export type GatewayAutoModerationRuleDeleteDispatch = GatewayAutoModerationRuleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-delete} */ export type GatewayAutoModerationRuleDeleteDispatchData = GatewayAutoModerationRuleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution} */ -export type GatewayAutoModerationActionExecutionDispatch = DataPayload< +export type GatewayAutoModerationActionExecutionDispatch = _DataPayload< GatewayDispatchEvents.AutoModerationActionExecution, GatewayAutoModerationActionExecutionDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution + * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-action-execution} */ export interface GatewayAutoModerationActionExecutionDispatchData { /** @@ -613,15 +612,15 @@ export interface GatewayAutoModerationActionExecutionDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update} */ -export type GatewayApplicationCommandPermissionsUpdateDispatch = DataPayload< +export type GatewayApplicationCommandPermissionsUpdateDispatch = _DataPayload< GatewayDispatchEvents.ApplicationCommandPermissionsUpdate, GatewayApplicationCommandPermissionsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#application-command-permissions-update} */ export interface GatewayApplicationCommandPermissionsUpdateDispatchData { /** @@ -643,11 +642,11 @@ export interface GatewayApplicationCommandPermissionsUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create - * https://discord.com/developers/docs/topics/gateway-events#subscription-update - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ -export type GatewaySubscriptionModifyDispatch = DataPayload< +export type GatewaySubscriptionModifyDispatch = _DataPayload< | GatewayDispatchEvents.SubscriptionCreate | GatewayDispatchEvents.SubscriptionDelete | GatewayDispatchEvents.SubscriptionUpdate, @@ -655,56 +654,56 @@ export type GatewaySubscriptionModifyDispatch = DataPayload< >; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create - * https://discord.com/developers/docs/topics/gateway-events#subscription-update - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ export type GatewaySubscriptionModifyDispatchData = APISubscription; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} */ export type GatewaySubscriptionCreateDispatch = GatewaySubscriptionModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-create} */ export type GatewaySubscriptionCreateDispatchData = GatewaySubscriptionModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} */ export type GatewaySubscriptionUpdateDispatch = GatewaySubscriptionModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-update} */ export type GatewaySubscriptionUpdateDispatchData = GatewaySubscriptionModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ export type GatewaySubscriptionDeleteDispatch = GatewaySubscriptionModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#subscription-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#subscription-delete} */ export type GatewaySubscriptionDeleteDispatchData = GatewaySubscriptionModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create - * https://discord.com/developers/docs/topics/gateway-events#channel-update - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ -export type GatewayChannelModifyDispatch = DataPayload< +export type GatewayChannelModifyDispatch = _DataPayload< GatewayDispatchEvents.ChannelCreate | GatewayDispatchEvents.ChannelDelete | GatewayDispatchEvents.ChannelUpdate, GatewayChannelModifyDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create - * https://discord.com/developers/docs/topics/gateway-events#channel-update - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ export type GatewayChannelModifyDispatchData = APIChannel & { type: Exclude; @@ -712,45 +711,45 @@ export type GatewayChannelModifyDispatchData = APIChannel & { }; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} */ export type GatewayChannelCreateDispatch = GatewayChannelModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-create} */ export type GatewayChannelCreateDispatchData = GatewayChannelModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} */ export type GatewayChannelUpdateDispatch = GatewayChannelModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-update} */ export type GatewayChannelUpdateDispatchData = GatewayChannelModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ export type GatewayChannelDeleteDispatch = GatewayChannelModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-delete} */ export type GatewayChannelDeleteDispatchData = GatewayChannelModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-pins-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-pins-update} */ -export type GatewayChannelPinsUpdateDispatch = DataPayload< +export type GatewayChannelPinsUpdateDispatch = _DataPayload< GatewayDispatchEvents.ChannelPinsUpdate, GatewayChannelPinsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#channel-pins-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#channel-pins-update} */ export interface GatewayChannelPinsUpdateDispatchData { /** @@ -768,18 +767,18 @@ export interface GatewayChannelPinsUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ export type GatewayEntitlementModifyDispatchData = APIEntitlement; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ -export type GatewayEntitlementModifyDispatch = DataPayload< +export type GatewayEntitlementModifyDispatch = _DataPayload< | GatewayDispatchEvents.EntitlementCreate | GatewayDispatchEvents.EntitlementDelete | GatewayDispatchEvents.EntitlementUpdate, @@ -787,67 +786,73 @@ export type GatewayEntitlementModifyDispatch = DataPayload< >; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} */ export type GatewayEntitlementCreateDispatchData = Omit & { ends_at: GatewayEntitlementModifyDispatchData['ends_at'] | null; }; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-create} */ export type GatewayEntitlementCreateDispatch = GatewayEntitlementModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} */ export type GatewayEntitlementUpdateDispatchData = GatewayEntitlementModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-update} */ export type GatewayEntitlementUpdateDispatch = GatewayEntitlementModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ export type GatewayEntitlementDeleteDispatchData = GatewayEntitlementModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#entitlement-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#entitlement-delete} */ export type GatewayEntitlementDeleteDispatch = GatewayEntitlementModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ -export type GatewayGuildModifyDispatch = DataPayload; +export type GatewayGuildModifyDispatch = _DataPayload< + GatewayDispatchEvents.GuildUpdate, + GatewayGuildModifyDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ export type GatewayGuildModifyDispatchData = APIGuild; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-create} */ -export type GatewayGuildCreateDispatch = DataPayload; +export type GatewayGuildCreateDispatch = _DataPayload< + GatewayDispatchEvents.GuildCreate, + GatewayGuildCreateDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-create - * https://discord.com/developers/docs/topics/gateway-events#guild-create-guild-create-extra-fields + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-create-guild-create-extra-fields} */ export interface GatewayGuildCreateDispatchData extends APIGuild { /** * When this guild was joined at * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** */ joined_at: string; /** * `true` if this is considered a large guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** */ large: boolean; /** @@ -857,92 +862,95 @@ export interface GatewayGuildCreateDispatchData extends APIGuild { /** * Total number of members in this guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** */ member_count: number; /** * States of members currently in voice channels; lacks the `guild_id` key * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/voice#voice-state-object + * @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object} */ voice_states: Omit[]; /** * Users in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ members: APIGuildMember[]; /** * Channels in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/channel#channel-object + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object} */ channels: (APIChannel & { type: Exclude })[]; /** * Threads in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/channel#channel-object + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object} */ threads: (APIChannel & { type: ThreadChannelType })[]; /** * Presences of the members in the guild, will only include non-offline members if the size is greater than `large_threshold` * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/topics/gateway-events#presence-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update} */ presences: GatewayPresenceUpdate[]; /** * The stage instances in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure + * @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure} */ stage_instances: APIStageInstance[]; /** * The scheduled events in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object + * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object} */ guild_scheduled_events: APIGuildScheduledEvent[]; /** * The soundboard sounds in the guild * - * **This field is only sent within the [GUILD_CREATE](https://discord.com/developers/docs/topics/gateway-events#guild-create) event** + * **This field is only sent within the {@link https://discord.com/developers/docs/topics/gateway-events#guild-create | GUILD_CREATE} event** * - * See https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object + * @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object} */ soundboard_sounds: APISoundboardSound[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ export type GatewayGuildUpdateDispatch = GatewayGuildModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-update} */ export type GatewayGuildUpdateDispatchData = GatewayGuildModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-delete} */ -export type GatewayGuildDeleteDispatch = DataPayload; +export type GatewayGuildDeleteDispatch = _DataPayload< + GatewayDispatchEvents.GuildDelete, + GatewayGuildDeleteDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-delete} */ export interface GatewayGuildDeleteDispatchData extends Omit { /** @@ -954,17 +962,17 @@ export interface GatewayGuildDeleteDispatchData extends Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-add - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-add} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove} */ export interface GatewayGuildBanModifyDispatchData { /** @@ -974,41 +982,41 @@ export interface GatewayGuildBanModifyDispatchData { /** * The banned user * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ user: APIUser; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-add} */ export type GatewayGuildBanAddDispatch = GatewayGuildBanModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-add} */ export type GatewayGuildBanAddDispatchData = GatewayGuildBanModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove} */ export type GatewayGuildBanRemoveDispatch = GatewayGuildBanModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-ban-remove} */ export type GatewayGuildBanRemoveDispatchData = GatewayGuildBanModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update} */ -export type GatewayGuildEmojisUpdateDispatch = DataPayload< +export type GatewayGuildEmojisUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildEmojisUpdate, GatewayGuildEmojisUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-emojis-update} */ export interface GatewayGuildEmojisUpdateDispatchData { /** @@ -1018,21 +1026,21 @@ export interface GatewayGuildEmojisUpdateDispatchData { /** * Array of emojis * - * See https://discord.com/developers/docs/resources/emoji#emoji-object + * @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object} */ emojis: APIEmoji[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update} */ -export type GatewayGuildStickersUpdateDispatch = DataPayload< +export type GatewayGuildStickersUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildStickersUpdate, GatewayGuildStickersUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-stickers-update} */ export interface GatewayGuildStickersUpdateDispatchData { /** @@ -1042,21 +1050,21 @@ export interface GatewayGuildStickersUpdateDispatchData { /** * Array of stickers * - * See https://discord.com/developers/docs/resources/sticker#sticker-object + * @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object} */ stickers: APISticker[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update} */ -export type GatewayGuildIntegrationsUpdateDispatch = DataPayload< +export type GatewayGuildIntegrationsUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildIntegrationsUpdate, GatewayGuildIntegrationsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-integrations-update} */ export interface GatewayGuildIntegrationsUpdateDispatchData { /** @@ -1066,15 +1074,15 @@ export interface GatewayGuildIntegrationsUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-add} */ -export type GatewayGuildMemberAddDispatch = DataPayload< +export type GatewayGuildMemberAddDispatch = _DataPayload< GatewayDispatchEvents.GuildMemberAdd, GatewayGuildMemberAddDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-add} */ export interface GatewayGuildMemberAddDispatchData extends APIGuildMember { /** @@ -1084,15 +1092,15 @@ export interface GatewayGuildMemberAddDispatchData extends APIGuildMember { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-remove} */ -export type GatewayGuildMemberRemoveDispatch = DataPayload< +export type GatewayGuildMemberRemoveDispatch = _DataPayload< GatewayDispatchEvents.GuildMemberRemove, GatewayGuildMemberRemoveDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-remove} */ export interface GatewayGuildMemberRemoveDispatchData { /** @@ -1102,23 +1110,23 @@ export interface GatewayGuildMemberRemoveDispatchData { /** * The user who was removed * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ user: APIUser; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-update} */ -export type GatewayGuildMemberUpdateDispatch = DataPayload< +export type GatewayGuildMemberUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildMemberUpdate, GatewayGuildMemberUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-member-update} */ -export type GatewayGuildMemberUpdateDispatchData = Nullable> & +export type GatewayGuildMemberUpdateDispatchData = _Nullable> & Omit & Partial> & Required> & { @@ -1129,20 +1137,20 @@ export type GatewayGuildMemberUpdateDispatchData = Nullable; /** - * https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ export type GatewayGuildMembersChunkPresence = Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk} */ export interface GatewayGuildMembersChunkDispatchData { /** @@ -1152,7 +1160,7 @@ export interface GatewayGuildMembersChunkDispatchData { /** * Set of guild members * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ members: APIGuildMember[]; /** @@ -1170,29 +1178,29 @@ export interface GatewayGuildMembersChunkDispatchData { /** * If passing true to `REQUEST_GUILD_MEMBERS`, presences of the returned members will be here * - * See https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ presences?: GatewayGuildMembersChunkPresence[]; /** * The nonce used in the Guild Members Request * - * See https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ nonce?: string; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ -export type GatewayGuildRoleModifyDispatch = DataPayload< +export type GatewayGuildRoleModifyDispatch = _DataPayload< GatewayDispatchEvents.GuildRoleCreate | GatewayDispatchEvents.GuildRoleUpdate, GatewayGuildRoleModifyDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ export interface GatewayGuildRoleModifyDispatchData { /** @@ -1202,41 +1210,41 @@ export interface GatewayGuildRoleModifyDispatchData { /** * The role created or updated * - * See https://discord.com/developers/docs/topics/permissions#role-object + * @see {@link https://discord.com/developers/docs/topics/permissions#role-object} */ role: APIRole; } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} */ export type GatewayGuildRoleCreateDispatch = GatewayGuildRoleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-create} */ export type GatewayGuildRoleCreateDispatchData = GatewayGuildRoleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ export type GatewayGuildRoleUpdateDispatch = GatewayGuildRoleModifyDispatch; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-update} */ export type GatewayGuildRoleUpdateDispatchData = GatewayGuildRoleModifyDispatchData; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-delete} */ -export type GatewayGuildRoleDeleteDispatch = DataPayload< +export type GatewayGuildRoleDeleteDispatch = _DataPayload< GatewayDispatchEvents.GuildRoleDelete, GatewayGuildRoleDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-role-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-role-delete} */ export interface GatewayGuildRoleDeleteDispatchData { /** @@ -1250,54 +1258,54 @@ export interface GatewayGuildRoleDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create} */ -export type GatewayGuildScheduledEventCreateDispatch = DataPayload< +export type GatewayGuildScheduledEventCreateDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventCreate, GatewayGuildScheduledEventCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-create} */ export type GatewayGuildScheduledEventCreateDispatchData = APIGuildScheduledEvent; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update} */ -export type GatewayGuildScheduledEventUpdateDispatch = DataPayload< +export type GatewayGuildScheduledEventUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventUpdate, GatewayGuildScheduledEventUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-update} */ export type GatewayGuildScheduledEventUpdateDispatchData = APIGuildScheduledEvent; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete} */ -export type GatewayGuildScheduledEventDeleteDispatch = DataPayload< +export type GatewayGuildScheduledEventDeleteDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventDelete, GatewayGuildScheduledEventDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-delete} */ export type GatewayGuildScheduledEventDeleteDispatchData = APIGuildScheduledEvent; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add} */ -export type GatewayGuildScheduledEventUserAddDispatch = DataPayload< +export type GatewayGuildScheduledEventUserAddDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventUserAdd, GatewayGuildScheduledEventUserAddDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-add} */ export interface GatewayGuildScheduledEventUserAddDispatchData { guild_scheduled_event_id: Snowflake; @@ -1306,15 +1314,15 @@ export interface GatewayGuildScheduledEventUserAddDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove} */ -export type GatewayGuildScheduledEventUserRemoveDispatch = DataPayload< +export type GatewayGuildScheduledEventUserRemoveDispatch = _DataPayload< GatewayDispatchEvents.GuildScheduledEventUserRemove, GatewayGuildScheduledEventUserAddDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-scheduled-event-user-remove} */ export interface GatewayGuildScheduledEventUserRemoveDispatchData { guild_scheduled_event_id: Snowflake; @@ -1323,41 +1331,41 @@ export interface GatewayGuildScheduledEventUserRemoveDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create} */ -export type GatewayGuildSoundboardSoundCreateDispatch = DataPayload< +export type GatewayGuildSoundboardSoundCreateDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundCreate, GatewayGuildSoundboardSoundCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-create} */ export type GatewayGuildSoundboardSoundCreateDispatchData = APISoundboardSound; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update} */ -export type GatewayGuildSoundboardSoundUpdateDispatch = DataPayload< +export type GatewayGuildSoundboardSoundUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundUpdate, GatewayGuildSoundboardSoundUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-update} */ export type GatewayGuildSoundboardSoundUpdateDispatchData = APISoundboardSound; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete} */ -export type GatewayGuildSoundboardSoundDeleteDispatch = DataPayload< +export type GatewayGuildSoundboardSoundDeleteDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundDelete, GatewayGuildSoundboardSoundDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete} */ export interface GatewayGuildSoundboardSoundDeleteDispatchData { /** @@ -1371,15 +1379,15 @@ export interface GatewayGuildSoundboardSoundDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update} */ -export type GatewayGuildSoundboardSoundsUpdateDispatch = DataPayload< +export type GatewayGuildSoundboardSoundsUpdateDispatch = _DataPayload< GatewayDispatchEvents.GuildSoundboardSoundsUpdate, GatewayGuildSoundboardSoundsUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update} */ export interface GatewayGuildSoundboardSoundsUpdateDispatchData { /** @@ -1393,15 +1401,15 @@ export interface GatewayGuildSoundboardSoundsUpdateDispatchData { } /** - * https://discord.com/developers/docs/events/gateway-events#soundboard-sounds + * @see {@link https://discord.com/developers/docs/events/gateway-events#soundboard-sounds} */ -export type GatewaySoundboardSoundsDispatch = DataPayload< +export type GatewaySoundboardSoundsDispatch = _DataPayload< GatewayDispatchEvents.SoundboardSounds, GatewaySoundboardSoundsDispatchData >; /** - * https://discord.com/developers/docs/events/gateway-events#soundboard-sounds + * @see {@link https://discord.com/developers/docs/events/gateway-events#soundboard-sounds} */ export interface GatewaySoundboardSoundsDispatchData { /** @@ -1415,41 +1423,41 @@ export interface GatewaySoundboardSoundsDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#integration-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-create} */ -export type GatewayIntegrationCreateDispatch = DataPayload< +export type GatewayIntegrationCreateDispatch = _DataPayload< GatewayDispatchEvents.IntegrationCreate, GatewayIntegrationCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-create} */ export type GatewayIntegrationCreateDispatchData = APIGuildIntegration & { guild_id: Snowflake }; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-update} */ -export type GatewayIntegrationUpdateDispatch = DataPayload< +export type GatewayIntegrationUpdateDispatch = _DataPayload< GatewayDispatchEvents.IntegrationUpdate, GatewayIntegrationUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-update} */ export type GatewayIntegrationUpdateDispatchData = APIGuildIntegration & { guild_id: Snowflake }; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-update} */ -export type GatewayIntegrationDeleteDispatch = DataPayload< +export type GatewayIntegrationDeleteDispatch = _DataPayload< GatewayDispatchEvents.IntegrationDelete, GatewayIntegrationDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#integration-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#integration-delete} */ export interface GatewayIntegrationDeleteDispatchData { /** @@ -1467,28 +1475,28 @@ export interface GatewayIntegrationDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#interaction-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#interaction-create} */ -export type GatewayInteractionCreateDispatch = DataPayload< +export type GatewayInteractionCreateDispatch = _DataPayload< GatewayDispatchEvents.InteractionCreate, GatewayInteractionCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#interaction-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#interaction-create} */ export type GatewayInteractionCreateDispatchData = APIInteraction; /** - * https://discord.com/developers/docs/topics/gateway-events#invite-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-create} */ -export type GatewayInviteCreateDispatch = DataPayload< +export type GatewayInviteCreateDispatch = _DataPayload< GatewayDispatchEvents.InviteCreate, GatewayInviteCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#invite-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-create} */ export interface GatewayInviteCreateDispatchData { /** @@ -1498,7 +1506,7 @@ export interface GatewayInviteCreateDispatchData { /** * The unique invite code * - * See https://discord.com/developers/docs/resources/invite#invite-object + * @see {@link https://discord.com/developers/docs/resources/invite#invite-object} */ code: string; /** @@ -1512,7 +1520,7 @@ export interface GatewayInviteCreateDispatchData { /** * The user that created the invite * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ inviter?: APIUser; /** @@ -1526,13 +1534,13 @@ export interface GatewayInviteCreateDispatchData { /** * The type of target for this voice channel invite * - * See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types + * @see {@link https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types} */ target_type?: InviteTargetType; /** * The user whose stream to display for this voice channel stream invite * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ target_user?: APIUser; /** @@ -1550,15 +1558,15 @@ export interface GatewayInviteCreateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#invite-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-delete} */ -export type GatewayInviteDeleteDispatch = DataPayload< +export type GatewayInviteDeleteDispatch = _DataPayload< GatewayDispatchEvents.InviteDelete, GatewayInviteDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#invite-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#invite-delete} */ export interface GatewayInviteDeleteDispatchData { /** @@ -1572,39 +1580,39 @@ export interface GatewayInviteDeleteDispatchData { /** * The unique invite code * - * See https://discord.com/developers/docs/resources/invite#invite-object + * @see {@link https://discord.com/developers/docs/resources/invite#invite-object} */ code: string; } /** - * https://discord.com/developers/docs/topics/gateway-events#message-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create} */ -export type GatewayMessageCreateDispatch = DataPayload< +export type GatewayMessageCreateDispatch = _DataPayload< GatewayDispatchEvents.MessageCreate, GatewayMessageCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create} */ export type GatewayMessageCreateDispatchData = GatewayMessageEventExtraFields & Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#message-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update} */ -export type GatewayMessageUpdateDispatch = DataPayload< +export type GatewayMessageUpdateDispatch = _DataPayload< GatewayDispatchEvents.MessageUpdate, GatewayMessageUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-update} */ export type GatewayMessageUpdateDispatchData = GatewayMessageEventExtraFields & Omit; /** - * https://discord.com/developers/docs/topics/gateway-events#message-create-message-create-extra-fields + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-create-message-create-extra-fields} */ export interface GatewayMessageEventExtraFields { /** @@ -1617,7 +1625,7 @@ export interface GatewayMessageEventExtraFields { * The member object exists in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events * from text-based guild channels * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ member?: Omit; /** @@ -1626,22 +1634,22 @@ export interface GatewayMessageEventExtraFields { * The `member` field is only present in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events * from text-based guild channels * - * See https://discord.com/developers/docs/resources/user#user-object - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ mentions: (APIUser & { member?: Omit })[]; } /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete} */ -export type GatewayMessageDeleteDispatch = DataPayload< +export type GatewayMessageDeleteDispatch = _DataPayload< GatewayDispatchEvents.MessageDelete, GatewayMessageDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete} */ export interface GatewayMessageDeleteDispatchData { /** @@ -1659,15 +1667,15 @@ export interface GatewayMessageDeleteDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk} */ -export type GatewayMessageDeleteBulkDispatch = DataPayload< +export type GatewayMessageDeleteBulkDispatch = _DataPayload< GatewayDispatchEvents.MessageDeleteBulk, GatewayMessageDeleteBulkDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-delete-bulk} */ export interface GatewayMessageDeleteBulkDispatchData { /** @@ -1685,53 +1693,53 @@ export interface GatewayMessageDeleteBulkDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add} */ -export type GatewayMessageReactionAddDispatch = ReactionData; +export type GatewayMessageReactionAddDispatch = GatewayMessageReactionData; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-add} */ export type GatewayMessageReactionAddDispatchData = GatewayMessageReactionAddDispatch['d']; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove} */ -export type GatewayMessageReactionRemoveDispatch = ReactionData< +export type GatewayMessageReactionRemoveDispatch = GatewayMessageReactionData< GatewayDispatchEvents.MessageReactionRemove, 'burst_colors' | 'member' | 'message_author_id' >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove} */ export type GatewayMessageReactionRemoveDispatchData = GatewayMessageReactionRemoveDispatch['d']; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all} */ -export type GatewayMessageReactionRemoveAllDispatch = DataPayload< +export type GatewayMessageReactionRemoveAllDispatch = _DataPayload< GatewayDispatchEvents.MessageReactionRemoveAll, GatewayMessageReactionRemoveAllDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-all} */ -export type GatewayMessageReactionRemoveAllDispatchData = MessageReactionRemoveData; +export type GatewayMessageReactionRemoveAllDispatchData = GatewayMessageReactionRemoveData; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji} */ -export type GatewayMessageReactionRemoveEmojiDispatch = DataPayload< +export type GatewayMessageReactionRemoveEmojiDispatch = _DataPayload< GatewayDispatchEvents.MessageReactionRemoveEmoji, GatewayMessageReactionRemoveEmojiDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-reaction-remove-emoji} */ -export interface GatewayMessageReactionRemoveEmojiDispatchData extends MessageReactionRemoveData { +export interface GatewayMessageReactionRemoveEmojiDispatchData extends GatewayMessageReactionRemoveData { /** * The emoji that was removed */ @@ -1739,120 +1747,120 @@ export interface GatewayMessageReactionRemoveEmojiDispatchData extends MessageRe } /** - * https://discord.com/developers/docs/topics/gateway-events#presence-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update} */ -export type GatewayPresenceUpdateDispatch = DataPayload< +export type GatewayPresenceUpdateDispatch = _DataPayload< GatewayDispatchEvents.PresenceUpdate, GatewayPresenceUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#presence-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update} */ export type GatewayPresenceUpdateDispatchData = RawGatewayPresenceUpdate; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-create} */ -export type GatewayStageInstanceCreateDispatch = DataPayload< +export type GatewayStageInstanceCreateDispatch = _DataPayload< GatewayDispatchEvents.StageInstanceCreate, GatewayStageInstanceCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-create} */ export type GatewayStageInstanceCreateDispatchData = APIStageInstance; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete} */ -export type GatewayStageInstanceDeleteDispatch = DataPayload< +export type GatewayStageInstanceDeleteDispatch = _DataPayload< GatewayDispatchEvents.StageInstanceDelete, GatewayStageInstanceDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-delete} */ export type GatewayStageInstanceDeleteDispatchData = APIStageInstance; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-update} */ -export type GatewayStageInstanceUpdateDispatch = DataPayload< +export type GatewayStageInstanceUpdateDispatch = _DataPayload< GatewayDispatchEvents.StageInstanceUpdate, GatewayStageInstanceUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#stage-instance-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#stage-instance-update} */ export type GatewayStageInstanceUpdateDispatchData = APIStageInstance; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-list-sync + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync} */ -export type GatewayThreadListSyncDispatch = DataPayload< +export type GatewayThreadListSyncDispatch = _DataPayload< GatewayDispatchEvents.ThreadListSync, GatewayThreadListSyncDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-list-sync + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync} */ export type GatewayThreadListSyncDispatchData = RawGatewayThreadListSync; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-members-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update} */ -export type GatewayThreadMembersUpdateDispatch = DataPayload< +export type GatewayThreadMembersUpdateDispatch = _DataPayload< GatewayDispatchEvents.ThreadMembersUpdate, GatewayThreadMembersUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-members-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update} */ export type GatewayThreadMembersUpdateDispatchData = RawGatewayThreadMembersUpdate; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-member-update} */ -export type GatewayThreadMemberUpdateDispatch = DataPayload< +export type GatewayThreadMemberUpdateDispatch = _DataPayload< GatewayDispatchEvents.ThreadMemberUpdate, GatewayThreadMemberUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-member-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-member-update} */ export type GatewayThreadMemberUpdateDispatchData = APIThreadMember & { guild_id: Snowflake }; /** * @deprecated This type doesn't accurately reflect the Discord API. - * Use {@apilink GatewayThreadCreateDispatch}, - * {@apilink GatewayThreadUpdateDispatch}, or - * {@apilink GatewayThreadDeleteDispatch} instead. - * https://discord.com/developers/docs/topics/gateway-events#thread-create - * https://discord.com/developers/docs/topics/gateway-events#thread-update - * https://discord.com/developers/docs/topics/gateway-events#thread-delete + * Use {@link GatewayThreadCreateDispatch}, + * {@link GatewayThreadUpdateDispatch}, or + * {@link GatewayThreadDeleteDispatch} instead. + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-create} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-update} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-delete} */ -export type GatewayThreadModifyDispatch = DataPayload< +export type GatewayThreadModifyDispatch = _DataPayload< GatewayDispatchEvents.ThreadCreate | GatewayDispatchEvents.ThreadDelete | GatewayDispatchEvents.ThreadUpdate, APIThreadChannel >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-create} */ -export type GatewayThreadCreateDispatch = DataPayload< +export type GatewayThreadCreateDispatch = _DataPayload< GatewayDispatchEvents.ThreadCreate, GatewayThreadCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-create} */ export interface GatewayThreadCreateDispatchData extends APIThreadChannel { /** @@ -1862,28 +1870,28 @@ export interface GatewayThreadCreateDispatchData extends APIThreadChannel { } /** - * https://discord.com/developers/docs/topics/gateway-events#thread-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-update} */ -export type GatewayThreadUpdateDispatch = DataPayload< +export type GatewayThreadUpdateDispatch = _DataPayload< GatewayDispatchEvents.ThreadUpdate, GatewayThreadUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-update} */ export type GatewayThreadUpdateDispatchData = APIThreadChannel; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-delete} */ -export type GatewayThreadDeleteDispatch = DataPayload< +export type GatewayThreadDeleteDispatch = _DataPayload< GatewayDispatchEvents.ThreadDelete, GatewayThreadDeleteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#thread-delete + * @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-delete} */ export interface GatewayThreadDeleteDispatchData { /** @@ -1901,18 +1909,21 @@ export interface GatewayThreadDeleteDispatchData { /** * The type of the channel * - * See https://discord.com/developers/docs/resources/channel#channel-object-channel-types + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types} */ type: ChannelType; } /** - * https://discord.com/developers/docs/topics/gateway-events#typing-start + * @see {@link https://discord.com/developers/docs/topics/gateway-events#typing-start} */ -export type GatewayTypingStartDispatch = DataPayload; +export type GatewayTypingStartDispatch = _DataPayload< + GatewayDispatchEvents.TypingStart, + GatewayTypingStartDispatchData +>; /** - * https://discord.com/developers/docs/topics/gateway-events#typing-start + * @see {@link https://discord.com/developers/docs/topics/gateway-events#typing-start} */ export interface GatewayTypingStartDispatchData { /** @@ -1934,31 +1945,31 @@ export interface GatewayTypingStartDispatchData { /** * The member who started typing if this happened in a guild * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ member?: APIGuildMember; } /** - * https://discord.com/developers/docs/topics/gateway-events#user-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#user-update} */ -export type GatewayUserUpdateDispatch = DataPayload; +export type GatewayUserUpdateDispatch = _DataPayload; /** - * https://discord.com/developers/docs/topics/gateway-events#user-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#user-update} */ export type GatewayUserUpdateDispatchData = APIUser; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send} */ -export type GatewayVoiceChannelEffectSendDispatch = DataPayload< +export type GatewayVoiceChannelEffectSendDispatch = _DataPayload< GatewayDispatchEvents.VoiceChannelEffectSend, GatewayVoiceChannelEffectSendDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send} */ export interface GatewayVoiceChannelEffectSendDispatchData { /** @@ -1996,7 +2007,7 @@ export interface GatewayVoiceChannelEffectSendDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send-animation-types + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-channel-effect-send-animation-types} */ export enum VoiceChannelEffectSendAnimationType { /** @@ -2010,28 +2021,28 @@ export enum VoiceChannelEffectSendAnimationType { } /** - * https://discord.com/developers/docs/topics/gateway-events#voice-state-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-state-update} */ -export type GatewayVoiceStateUpdateDispatch = DataPayload< +export type GatewayVoiceStateUpdateDispatch = _DataPayload< GatewayDispatchEvents.VoiceStateUpdate, GatewayVoiceStateUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-state-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-state-update} */ export type GatewayVoiceStateUpdateDispatchData = APIVoiceState; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-server-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-server-update} */ -export type GatewayVoiceServerUpdateDispatch = DataPayload< +export type GatewayVoiceServerUpdateDispatch = _DataPayload< GatewayDispatchEvents.VoiceServerUpdate, GatewayVoiceServerUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#voice-server-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#voice-server-update} */ export interface GatewayVoiceServerUpdateDispatchData { /** @@ -2053,15 +2064,15 @@ export interface GatewayVoiceServerUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#webhooks-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#webhooks-update} */ -export type GatewayWebhooksUpdateDispatch = DataPayload< +export type GatewayWebhooksUpdateDispatch = _DataPayload< GatewayDispatchEvents.WebhooksUpdate, GatewayWebhooksUpdateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#webhooks-update + * @see {@link https://discord.com/developers/docs/topics/gateway-events#webhooks-update} */ export interface GatewayWebhooksUpdateDispatchData { /** @@ -2075,15 +2086,15 @@ export interface GatewayWebhooksUpdateDispatchData { } /** - * https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create} */ -export type GatewayGuildAuditLogEntryCreateDispatch = DataPayload< +export type GatewayGuildAuditLogEntryCreateDispatch = _DataPayload< GatewayDispatchEvents.GuildAuditLogEntryCreate, GatewayGuildAuditLogEntryCreateDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-audit-log-entry-create} */ export interface GatewayGuildAuditLogEntryCreateDispatchData extends APIAuditLogEntry { /** @@ -2093,24 +2104,24 @@ export interface GatewayGuildAuditLogEntryCreateDispatchData extends APIAuditLog } /** - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add} */ -export type GatewayMessagePollVoteAddDispatch = DataPayload< +export type GatewayMessagePollVoteAddDispatch = _DataPayload< GatewayDispatchEvents.MessagePollVoteAdd, GatewayMessagePollVoteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove} */ -export type GatewayMessagePollVoteRemoveDispatch = DataPayload< +export type GatewayMessagePollVoteRemoveDispatch = _DataPayload< GatewayDispatchEvents.MessagePollVoteRemove, GatewayMessagePollVoteDispatchData >; /** - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add - * https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-add} + * @see {@link https://discord.com/developers/docs/topics/gateway-events#message-poll-vote-remove} */ export interface GatewayMessagePollVoteDispatchData { /** @@ -2140,7 +2151,7 @@ export interface GatewayMessagePollVoteDispatchData { // #region Sendable Payloads /** - * https://discord.com/developers/docs/topics/gateway#sending-heartbeats + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-heartbeats} */ export interface GatewayHeartbeat { op: GatewayOpcodes.Heartbeat; @@ -2148,12 +2159,12 @@ export interface GatewayHeartbeat { } /** - * https://discord.com/developers/docs/topics/gateway#sending-heartbeats + * @see {@link https://discord.com/developers/docs/topics/gateway#sending-heartbeats} */ export type GatewayHeartbeatData = number | null; /** - * https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ export interface GatewayIdentify { op: GatewayOpcodes.Identify; @@ -2161,7 +2172,7 @@ export interface GatewayIdentify { } /** - * https://discord.com/developers/docs/topics/gateway-events#identify + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify} */ export interface GatewayIdentifyData { /** @@ -2171,44 +2182,44 @@ export interface GatewayIdentifyData { /** * Connection properties * - * See https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties} */ properties: GatewayIdentifyProperties; /** * Whether this connection supports compression of packets * - * @default false + * @defaultValue `false` */ compress?: boolean; /** * Value between 50 and 250, total number of members where the gateway will stop sending * offline members in the guild member list * - * @default 50 + * @defaultValue `50` */ large_threshold?: number; /** * Used for Guild Sharding * - * See https://discord.com/developers/docs/topics/gateway#sharding + * @see {@link https://discord.com/developers/docs/topics/gateway#sharding} */ shard?: [shard_id: number, shard_count: number]; /** * Presence structure for initial presence information * - * See https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ presence?: GatewayPresenceUpdateData; /** * The Gateway Intents you wish to receive * - * See https://discord.com/developers/docs/topics/gateway#gateway-intents + * @see {@link https://discord.com/developers/docs/topics/gateway#gateway-intents} */ intents: number; } /** - * https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties + * @see {@link https://discord.com/developers/docs/topics/gateway-events#identify-identify-connection-properties} */ export interface GatewayIdentifyProperties { /** @@ -2226,7 +2237,7 @@ export interface GatewayIdentifyProperties { } /** - * https://discord.com/developers/docs/topics/gateway-events#resume + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resume} */ export interface GatewayResume { op: GatewayOpcodes.Resume; @@ -2234,7 +2245,7 @@ export interface GatewayResume { } /** - * https://discord.com/developers/docs/topics/gateway-events#resume + * @see {@link https://discord.com/developers/docs/topics/gateway-events#resume} */ export interface GatewayResumeData { /** @@ -2252,7 +2263,7 @@ export interface GatewayResumeData { } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembers { op: GatewayOpcodes.RequestGuildMembers; @@ -2260,7 +2271,7 @@ export interface GatewayRequestGuildMembers { } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembersDataBase { /** @@ -2276,13 +2287,13 @@ export interface GatewayRequestGuildMembersDataBase { * * Nonce can only be up to 32 bytes. If you send an invalid nonce it will be ignored and the reply member_chunk(s) will not have a `nonce` set. * - * See https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk + * @see {@link https://discord.com/developers/docs/topics/gateway-events#guild-members-chunk} */ nonce?: string; } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembersDataWithUserIds extends GatewayRequestGuildMembersDataBase { /** @@ -2292,7 +2303,7 @@ export interface GatewayRequestGuildMembersDataWithUserIds extends GatewayReques } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export interface GatewayRequestGuildMembersDataWithQuery extends GatewayRequestGuildMembersDataBase { /** @@ -2307,14 +2318,14 @@ export interface GatewayRequestGuildMembersDataWithQuery extends GatewayRequestG } /** - * https://discord.com/developers/docs/topics/gateway-events#request-guild-members + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-guild-members} */ export type GatewayRequestGuildMembersData = | GatewayRequestGuildMembersDataWithQuery | GatewayRequestGuildMembersDataWithUserIds; /** - * https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds} */ export interface GatewayRequestSoundboardSounds { op: GatewayOpcodes.RequestSoundboardSounds; @@ -2322,7 +2333,7 @@ export interface GatewayRequestSoundboardSounds { } /** - * https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds + * @see {@link https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds} */ export interface GatewayRequestSoundboardSoundsData { /** @@ -2332,7 +2343,7 @@ export interface GatewayRequestSoundboardSoundsData { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-voice-state + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-voice-state} */ export interface GatewayVoiceStateUpdate { op: GatewayOpcodes.VoiceStateUpdate; @@ -2340,7 +2351,7 @@ export interface GatewayVoiceStateUpdate { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-voice-state + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-voice-state} */ export interface GatewayVoiceStateUpdateData { /** @@ -2362,7 +2373,7 @@ export interface GatewayVoiceStateUpdateData { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-presence + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence} */ export interface GatewayUpdatePresence { op: GatewayOpcodes.PresenceUpdate; @@ -2370,7 +2381,7 @@ export interface GatewayUpdatePresence { } /** - * https://discord.com/developers/docs/topics/gateway-events#update-presence-gateway-presence-update-structure + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence-gateway-presence-update-structure} */ export interface GatewayPresenceUpdateData { /** @@ -2380,13 +2391,13 @@ export interface GatewayPresenceUpdateData { /** * The user's activities * - * See https://discord.com/developers/docs/topics/gateway-events#activity-object + * @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object} */ activities: GatewayActivityUpdateData[]; /** * The user's new status * - * See https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types + * @see {@link https://discord.com/developers/docs/topics/gateway-events#update-presence-status-types} */ status: PresenceUpdateStatus; /** @@ -2396,14 +2407,14 @@ export interface GatewayPresenceUpdateData { } /** - * https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure + * @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-structure} */ export type GatewayActivityUpdateData = Pick; // #endregion Sendable Payloads // #region Shared -interface BasePayload { +export interface _BasePayload { /** * Opcode for the payload */ @@ -2422,18 +2433,18 @@ interface BasePayload { t?: string; } -type NonDispatchPayload = Omit & { +export type _NonDispatchPayload = Omit<_BasePayload, 's' | 't'> & { t: null; s: null; }; -interface DataPayload extends BasePayload { +export interface _DataPayload extends _BasePayload { op: GatewayOpcodes.Dispatch; t: Event; d: D; } -type ReactionData = DataPayload< +export type GatewayMessageReactionData = _DataPayload< E, Omit< { @@ -2456,13 +2467,13 @@ type ReactionData = D /** * The member who reacted if this happened in a guild * - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ member?: APIGuildMember; /** * The emoji used to react * - * See https://discord.com/developers/docs/resources/emoji#emoji-object + * @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object} */ emoji: APIEmoji; /** @@ -2486,7 +2497,7 @@ type ReactionData = D > >; -interface MessageReactionRemoveData { +export interface GatewayMessageReactionRemoveData { /** * The id of the channel */ diff --git a/deno/globals.ts b/deno/globals.ts index 5da58aed..38a27d61 100644 --- a/deno/globals.ts +++ b/deno/globals.ts @@ -1,17 +1,15 @@ /** - * https://discord.com/developers/docs/reference#snowflakes + * @see {@link https://discord.com/developers/docs/reference#snowflakes} */ export type Snowflake = string; /** - * https://discord.com/developers/docs/topics/permissions - * - * @internal + * @see {@link https://discord.com/developers/docs/topics/permissions} */ export type Permissions = string; /** - * https://discord.com/developers/docs/reference#message-formatting-formats + * @see {@link https://discord.com/developers/docs/reference#message-formatting-formats} */ export const FormattingPatterns = { /** diff --git a/deno/payloads/common.ts b/deno/payloads/common.ts index 3fb90995..824a0836 100644 --- a/deno/payloads/common.ts +++ b/deno/payloads/common.ts @@ -1,7 +1,7 @@ import type { Locale } from '../rest/common.ts'; /** - * https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags + * @see {@link https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags} * * These flags are exported as `BigInt`s and NOT numbers. Wrapping them in `Number()` * may cause issues, try to use BigInts as much as possible or modules that can @@ -178,7 +178,7 @@ export const PermissionFlagsBits = { /** * Allows management and editing of emojis, stickers, and soundboard sounds * - * @deprecated This is the old name for {@apilink PermissionFlagsBits#ManageGuildExpressions} + * @deprecated This is the old name for {@link PermissionFlagsBits.ManageGuildExpressions} */ ManageEmojisAndStickers: 1n << 30n, /** @@ -234,7 +234,7 @@ export const PermissionFlagsBits = { */ SendMessagesInThreads: 1n << 38n, /** - * Allows for using Activities (applications with the {@apilink ApplicationFlags.Embedded} flag) in a voice channel + * Allows for using Activities (applications with the {@link ApplicationFlags.Embedded} flag) in a voice channel * * Applies to channel types: Voice */ @@ -300,7 +300,7 @@ Object.freeze(PermissionFlagsBits); export type LocalizationMap = Partial>; /** - * https://discord.com/developers/docs/topics/opcodes-and-status-codes#json + * @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#json} */ export interface RESTError { code: number; @@ -320,7 +320,7 @@ export interface RESTErrorGroupWrapper { export type RESTErrorData = RESTErrorFieldInformation | RESTErrorGroupWrapper | string | { [k: string]: RESTErrorData }; /** - * https://discord.com/developers/docs/topics/rate-limits#exceeding-a-rate-limit-rate-limit-response-structure + * @see {@link https://discord.com/developers/docs/topics/rate-limits#exceeding-a-rate-limit-rate-limit-response-structure} */ export interface RESTRateLimit { /** diff --git a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/integer.ts b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/integer.ts index fb7a05b4..846d3196 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/integer.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/integer.ts @@ -6,7 +6,7 @@ import type { } from './base.ts'; import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts'; -interface APIApplicationCommandIntegerOptionBase +export interface APIApplicationCommandIntegerOptionBase extends APIApplicationCommandOptionBase { /** * If the option is an `INTEGER` or `NUMBER` type, the minimum value permitted. diff --git a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/number.ts b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/number.ts index 177670b8..d8c435ee 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/number.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/number.ts @@ -6,7 +6,7 @@ import type { } from './base.ts'; import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts'; -interface APIApplicationCommandNumberOptionBase +export interface APIApplicationCommandNumberOptionBase extends APIApplicationCommandOptionBase { /** * If the option is an `INTEGER` or `NUMBER` type, the minimum value permitted. diff --git a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/shared.ts b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/shared.ts index bc7b9e7b..7718944b 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/shared.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/shared.ts @@ -1,7 +1,7 @@ import type { LocalizationMap } from '../../../../../v10.ts'; /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type} */ export enum ApplicationCommandOptionType { Subcommand = 1, @@ -18,7 +18,7 @@ export enum ApplicationCommandOptionType { } /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-choice-structure + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-choice-structure} */ export interface APIApplicationCommandOptionChoice { name: string; diff --git a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/string.ts b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/string.ts index 48b443c8..80f9d263 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/string.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/_chatInput/string.ts @@ -5,7 +5,7 @@ import type { } from './base.ts'; import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts'; -interface APIApplicationCommandStringOptionBase +export interface APIApplicationCommandStringOptionBase extends APIApplicationCommandOptionBase { /** * For option type `STRING`, the minimum allowed length (minimum of `0`, maximum of `6000`). diff --git a/deno/payloads/v10/_interactions/_applicationCommands/chatInput.ts b/deno/payloads/v10/_interactions/_applicationCommands/chatInput.ts index 3ef9aeec..dd3aa5e9 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/chatInput.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/chatInput.ts @@ -62,7 +62,7 @@ export * from './_chatInput/subcommandGroup.ts'; export * from './_chatInput/user.ts'; /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure} */ export type APIApplicationCommandBasicOption = | APIApplicationCommandAttachmentOption @@ -76,7 +76,7 @@ export type APIApplicationCommandBasicOption = | APIApplicationCommandUserOption; /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure} */ export type APIApplicationCommandOption = | APIApplicationCommandBasicOption @@ -84,7 +84,7 @@ export type APIApplicationCommandOption = | APIApplicationCommandSubcommandOption; /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-interaction-data-option-structure + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-interaction-data-option-structure} */ export type APIApplicationCommandInteractionDataOption = | APIApplicationCommandInteractionDataBasicOption @@ -103,7 +103,7 @@ export type APIApplicationCommandInteractionDataBasicOption { @@ -112,7 +112,7 @@ export interface APIChatInputApplicationCommandInteractionData } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data} */ export interface APIAutocompleteApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData { @@ -121,19 +121,19 @@ export interface APIAutocompleteApplicationCommandInteractionData } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIChatInputApplicationCommandInteraction = APIApplicationCommandInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIChatInputApplicationCommandDMInteraction = APIDMInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIChatInputApplicationCommandGuildInteraction = APIGuildInteractionWrapper; diff --git a/deno/payloads/v10/_interactions/_applicationCommands/contextMenu.ts b/deno/payloads/v10/_interactions/_applicationCommands/contextMenu.ts index 8284769f..ea895a91 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/contextMenu.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/contextMenu.ts @@ -5,7 +5,7 @@ import type { APIDMInteractionWrapper, APIGuildInteractionWrapper, APIUserIntera import type { APIBaseApplicationCommandInteractionData } from './internals.ts'; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data} */ export interface APIUserApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData { @@ -14,7 +14,7 @@ export interface APIUserApplicationCommandInteractionData } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data} */ export interface APIMessageApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData { @@ -23,68 +23,68 @@ export interface APIMessageApplicationCommandInteractionData } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure} */ export interface APIMessageApplicationCommandInteractionDataResolved { messages: Record; } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data} */ export type APIContextMenuInteractionData = | APIMessageApplicationCommandInteractionData | APIUserApplicationCommandInteractionData; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIUserApplicationCommandInteraction = APIApplicationCommandInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIUserApplicationCommandDMInteraction = APIDMInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIUserApplicationCommandGuildInteraction = APIGuildInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIMessageApplicationCommandInteraction = APIApplicationCommandInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIMessageApplicationCommandDMInteraction = APIDMInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIMessageApplicationCommandGuildInteraction = APIGuildInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIContextMenuInteraction = APIMessageApplicationCommandInteraction | APIUserApplicationCommandInteraction; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIContextMenuDMInteraction = | APIMessageApplicationCommandDMInteraction | APIUserApplicationCommandDMInteraction; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIContextMenuGuildInteraction = | APIMessageApplicationCommandGuildInteraction diff --git a/deno/payloads/v10/_interactions/_applicationCommands/entryPoint.ts b/deno/payloads/v10/_interactions/_applicationCommands/entryPoint.ts index 2654fd07..648b6171 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/entryPoint.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/entryPoint.ts @@ -3,24 +3,24 @@ import type { APIDMInteractionWrapper, APIGuildInteractionWrapper } from '../bas import type { APIBaseApplicationCommandInteractionData } from './internals.ts'; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data} */ export type APIPrimaryEntryPointCommandInteractionData = APIBaseApplicationCommandInteractionData; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIPrimaryEntryPointCommandInteraction = APIApplicationCommandInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIPrimaryEntryPointCommandDMInteraction = APIDMInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIPrimaryEntryPointCommandGuildInteraction = APIGuildInteractionWrapper; diff --git a/deno/payloads/v10/_interactions/_applicationCommands/permissions.ts b/deno/payloads/v10/_interactions/_applicationCommands/permissions.ts index 1a425469..0d5c8dca 100644 --- a/deno/payloads/v10/_interactions/_applicationCommands/permissions.ts +++ b/deno/payloads/v10/_interactions/_applicationCommands/permissions.ts @@ -1,7 +1,7 @@ import type { Snowflake } from '../../../../globals.ts'; /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure} */ export interface APIGuildApplicationCommandPermissions { /** @@ -23,7 +23,7 @@ export interface APIGuildApplicationCommandPermissions { } /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure} */ export interface APIApplicationCommandPermission { /** @@ -41,7 +41,7 @@ export interface APIApplicationCommandPermission { } /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permission-type + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permission-type} */ export enum ApplicationCommandPermissionType { Role = 1, @@ -50,7 +50,7 @@ export enum ApplicationCommandPermissionType { } /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-constants + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-constants} */ export const APIApplicationCommandPermissionsConstant = { // eslint-disable-next-line unicorn/prefer-native-coercion-functions diff --git a/deno/payloads/v10/_interactions/applicationCommands.ts b/deno/payloads/v10/_interactions/applicationCommands.ts index 4dbdef13..b17b8682 100644 --- a/deno/payloads/v10/_interactions/applicationCommands.ts +++ b/deno/payloads/v10/_interactions/applicationCommands.ts @@ -26,9 +26,10 @@ export * from './_applicationCommands/chatInput.ts'; export * from './_applicationCommands/contextMenu.ts'; export * from './_applicationCommands/permissions.ts'; export * from './_applicationCommands/entryPoint.ts'; +export * from './_applicationCommands/internals.ts'; /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object} */ export interface APIApplicationCommand { /** @@ -82,7 +83,7 @@ export interface APIApplicationCommand { /** * Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible * - * @deprecated Use `contexts` instead + * @deprecated Use {@link APIApplicationCommand.contexts} instead */ dm_permission?: boolean; /** @@ -90,7 +91,7 @@ export interface APIApplicationCommand { * * If missing, this property should be assumed as `true` * - * @deprecated Use `dm_permission` and/or `default_member_permissions` instead + * @deprecated Use {@link APIApplicationCommand.dm_permission} and/or {@link APIApplicationCommand.default_member_permissions} instead */ default_permission?: boolean; /** @@ -119,7 +120,7 @@ export interface APIApplicationCommand { } /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types} */ export enum ApplicationCommandType { /** @@ -141,7 +142,7 @@ export enum ApplicationCommandType { } /** - * https://discord.com/developers/docs/resources/application#application-object-application-integration-types + * @see {@link https://discord.com/developers/docs/resources/application#application-object-application-integration-types} */ export enum ApplicationIntegrationType { /** @@ -155,7 +156,7 @@ export enum ApplicationIntegrationType { } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-context-types + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-context-types} */ export enum InteractionContextType { /** @@ -173,7 +174,7 @@ export enum InteractionContextType { } /** - * https://discord.com/developers/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types} */ export enum EntryPointCommandHandlerType { /** @@ -188,7 +189,7 @@ export enum EntryPointCommandHandlerType { } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data} */ export type APIApplicationCommandInteractionData = | APIChatInputApplicationCommandInteractionData @@ -196,7 +197,7 @@ export type APIApplicationCommandInteractionData = | APIPrimaryEntryPointCommandInteractionData; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIApplicationCommandInteractionWrapper = APIBaseInteraction & @@ -208,7 +209,7 @@ export type APIApplicationCommandInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIApplicationCommandInteraction = | APIChatInputApplicationCommandInteraction @@ -216,7 +217,7 @@ export type APIApplicationCommandInteraction = | APIPrimaryEntryPointCommandInteraction; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIApplicationCommandDMInteraction = | APIChatInputApplicationCommandDMInteraction @@ -224,7 +225,7 @@ export type APIApplicationCommandDMInteraction = | APIPrimaryEntryPointCommandDMInteraction; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIApplicationCommandGuildInteraction = | APIChatInputApplicationCommandGuildInteraction diff --git a/deno/payloads/v10/_interactions/autocomplete.ts b/deno/payloads/v10/_interactions/autocomplete.ts index 661142b1..eab09eb1 100644 --- a/deno/payloads/v10/_interactions/autocomplete.ts +++ b/deno/payloads/v10/_interactions/autocomplete.ts @@ -21,13 +21,13 @@ export type APIApplicationCommandAutocompleteInteraction = APIBaseInteraction< >; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIApplicationCommandAutocompleteDMInteraction = APIDMInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIApplicationCommandAutocompleteGuildInteraction = APIGuildInteractionWrapper; diff --git a/deno/payloads/v10/_interactions/base.ts b/deno/payloads/v10/_interactions/base.ts index 065be530..eca13346 100644 --- a/deno/payloads/v10/_interactions/base.ts +++ b/deno/payloads/v10/_interactions/base.ts @@ -15,14 +15,14 @@ import type { APIUser } from '../user.ts'; import type { InteractionType } from './responses.ts'; /** - * https://discord.com/developers/docs/resources/channel#message-interaction-metadata-object + * @see {@link https://discord.com/developers/docs/resources/channel#message-interaction-metadata-object} */ export type APIMessageInteractionMetadata = | APIApplicationCommandInteractionMetadata | APIMessageComponentInteractionMetadata | APIModalSubmitInteractionMetadata; -interface APIBaseInteractionMetadata { +export interface APIBaseInteractionMetadata { /** * ID of the interaction */ @@ -46,7 +46,7 @@ interface APIBaseInteractionMetadata { } /** - * https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-application-command-interaction-metadata-structure + * @see {@link https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-application-command-interaction-metadata-structure} */ export interface APIApplicationCommandInteractionMetadata extends APIBaseInteractionMetadata { @@ -62,7 +62,7 @@ export interface APIApplicationCommandInteractionMetadata } /** - * https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-message-command-interaction-metadata-structure + * @see {@link https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-message-command-interaction-metadata-structure} */ export interface APIMessageComponentInteractionMetadata extends APIBaseInteractionMetadata { @@ -73,7 +73,7 @@ export interface APIMessageComponentInteractionMetadata } /** - * https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-modal-submit-interaction-metadata-structure + * @see {@link https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-modal-submit-interaction-metadata-structure} */ export interface APIModalSubmitInteractionMetadata extends APIBaseInteractionMetadata { /** @@ -96,7 +96,7 @@ export type PartialAPIMessageInteractionGuildMember = Pick< >; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#message-interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#message-interaction-object} */ export interface APIMessageInteraction { /** @@ -122,7 +122,7 @@ export interface APIMessageInteraction { } /** - * https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ export interface APIInteractionGuildMember extends APIGuildMember { permissions: Permissions; @@ -132,7 +132,7 @@ export interface APIInteractionGuildMember extends APIGuildMember { // INTERACTIONS RECEIVED /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export interface APIBaseInteraction { /** @@ -166,7 +166,7 @@ export interface APIBaseInteraction { /** * The id of the channel it was sent from * - * @deprecated Use {@apilink APIBaseInteraction#channel} instead + * @deprecated Use {@link APIBaseInteraction.channel} instead */ channel_id?: Snowflake; /** @@ -243,7 +243,7 @@ export interface APIInteractionDataResolvedChannelBase ex } /** - * https://discord.com/developers/docs/resources/channel#channel-object + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object} */ export type APIInteractionDataResolvedChannel = | APIInteractionDataResolvedChannelBase> @@ -251,14 +251,14 @@ export type APIInteractionDataResolvedChannel = Pick); /** - * https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ export interface APIInteractionDataResolvedGuildMember extends Omit { permissions: Permissions; } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure} */ export interface APIInteractionDataResolved { users?: Record; diff --git a/deno/payloads/v10/_interactions/modalSubmit.ts b/deno/payloads/v10/_interactions/modalSubmit.ts index b2aa8aa0..c77a4fec 100644 --- a/deno/payloads/v10/_interactions/modalSubmit.ts +++ b/deno/payloads/v10/_interactions/modalSubmit.ts @@ -19,7 +19,7 @@ export interface ModalSubmitActionRowComponent } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-modal-submit-data-structure + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-modal-submit-data-structure} */ export interface APIModalSubmission { /** @@ -33,17 +33,17 @@ export interface APIModalSubmission { } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIModalSubmitInteraction = APIBaseInteraction & Required, 'data'>>; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIModalSubmitDMInteraction = APIDMInteractionWrapper; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object} */ export type APIModalSubmitGuildInteraction = APIGuildInteractionWrapper; diff --git a/deno/payloads/v10/_interactions/responses.ts b/deno/payloads/v10/_interactions/responses.ts index 344f5035..f686c3c8 100644 --- a/deno/payloads/v10/_interactions/responses.ts +++ b/deno/payloads/v10/_interactions/responses.ts @@ -3,7 +3,7 @@ import type { APIActionRowComponent, APIModalActionRowComponent } from '../chann import type { APIApplicationCommandOptionChoice } from './applicationCommands.ts'; /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-type + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-type} */ export enum InteractionType { Ping = 1, @@ -14,7 +14,7 @@ export enum InteractionType { } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object} */ export type APIInteractionResponse = | APIApplicationCommandAutocompleteResponse @@ -69,7 +69,7 @@ export interface APIInteractionResponseLaunchActivity { } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type} */ export enum InteractionResponseType { /** @@ -103,7 +103,8 @@ export enum InteractionResponseType { /** * Respond to an interaction with an upgrade button, only available for apps with monetization enabled * - * @deprecated See https://discord.com/developers/docs/change-log#premium-apps-new-premium-button-style-deep-linking-url-schemes + * @deprecated Send a button with Premium type instead. + * {@link https://discord.com/developers/docs/change-log#premium-apps-new-premium-button-style-deep-linking-url-schemes | Learn more here} */ PremiumRequired, @@ -117,7 +118,7 @@ export enum InteractionResponseType { } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-data-structure + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-data-structure} */ export type APIInteractionResponseCallbackData = Omit; @@ -126,7 +127,7 @@ export interface APICommandAutocompleteInteractionResponseCallbackData { } /** - * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-modal + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-modal} */ export interface APIModalInteractionResponseCallbackData { /** diff --git a/deno/payloads/v10/application.ts b/deno/payloads/v10/application.ts index ea373b28..888af586 100644 --- a/deno/payloads/v10/application.ts +++ b/deno/payloads/v10/application.ts @@ -12,7 +12,7 @@ import type { APIUser } from './user.ts'; import type { ApplicationWebhookEventType } from './webhook.ts'; /** - * https://discord.com/developers/docs/resources/application#application-object + * @see {@link https://discord.com/developers/docs/resources/application#application-object} */ export interface APIApplication { /** @@ -58,7 +58,7 @@ export interface APIApplication { /** * Partial user object containing info on the owner of the application * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ owner?: APIUser; /** @@ -71,13 +71,13 @@ export interface APIApplication { /** * The hexadecimal encoded key for verification in interactions and the GameSDK's GetTicket function * - * See https://discord.com/developers/docs/game-sdk/applications#getticket + * @see {@link https://discord.com/developers/docs/game-sdk/applications#getticket} */ verify_key: string; /** * The team this application belongs to * - * See https://discord.com/developers/docs/topics/teams#data-models-team-object + * @see {@link https://discord.com/developers/docs/topics/teams#data-models-team-object} */ team: APITeam | null; /** @@ -103,7 +103,7 @@ export interface APIApplication { /** * The application's public flags * - * See https://discord.com/developers/docs/resources/application#application-object-application-flags + * @see {@link https://discord.com/developers/docs/resources/application#application-object-application-flags} */ flags: ApplicationFlags; /** @@ -171,7 +171,7 @@ export type APIApplicationIntegrationTypesConfigMap = { }; /** - * https://discord.com/developers/docs/resources/application#application-object-application-flags + * @see {@link https://discord.com/developers/docs/resources/application#application-object-application-flags} */ export enum ApplicationFlags { /** @@ -208,12 +208,14 @@ export enum ApplicationFlags { GatewayPresenceLimited = 1 << 13, /** * Intent required for bots in 100 or more servers to receive member-related events like `guild_member_add`. - * See list of member-related events [under `GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents) + * + * @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`} */ GatewayGuildMembers = 1 << 14, /** * Intent required for bots in under 100 servers to receive member-related events like `guild_member_add`, found in Bot Settings. - * See list of member-related events [under `GUILD_MEMBERS`](https://discord.com/developers/docs/topics/gateway#list-of-intents) + * + * @see List of member-related events {@link https://discord.com/developers/docs/topics/gateway#list-of-intents | under `GUILD_MEMBERS`} */ GatewayGuildMembersLimited = 1 << 15, /** @@ -225,11 +227,11 @@ export enum ApplicationFlags { */ Embedded = 1 << 17, /** - * Intent required for bots in 100 or more servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055) + * Intent required for bots in 100 or more servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content} */ GatewayMessageContent = 1 << 18, /** - * Intent required for bots in under 100 servers to receive [message content](https://support-dev.discord.com/hc/en-us/articles/4404772028055), + * Intent required for bots in under 100 servers to receive {@link https://support-dev.discord.com/hc/en-us/articles/4404772028055 | message content}, * found in Bot Settings */ GatewayMessageContentLimited = 1 << 19, @@ -238,13 +240,13 @@ export enum ApplicationFlags { */ EmbeddedFirstParty = 1 << 20, /** - * Indicates if an app has registered global [application commands](https://discord.com/developers/docs/interactions/application-commands) + * Indicates if an app has registered global {@link https://discord.com/developers/docs/interactions/application-commands | application commands} */ ApplicationCommandBadge = 1 << 23, } /** - * https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-structure + * @see {@link https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-structure} */ export interface APIApplicationRoleConnectionMetadata { /** @@ -274,7 +276,7 @@ export interface APIApplicationRoleConnectionMetadata { } /** - * https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-type + * @see {@link https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-type} */ export enum ApplicationRoleConnectionMetadataType { /** @@ -312,7 +314,7 @@ export enum ApplicationRoleConnectionMetadataType { } /** - * https://discord.com/developers/docs/resources/application#application-object-application-event-webhook-status + * @see {@link https://discord.com/developers/docs/resources/application#application-object-application-event-webhook-status} */ export enum ApplicationWebhookEventStatus { /** diff --git a/deno/payloads/v10/auditLog.ts b/deno/payloads/v10/auditLog.ts index e5c8d622..6e27ad34 100644 --- a/deno/payloads/v10/auditLog.ts +++ b/deno/payloads/v10/auditLog.ts @@ -35,43 +35,43 @@ import type { APIUser } from './user.ts'; import type { APIWebhook } from './webhook.ts'; /** - * https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure} */ export interface APIAuditLog { /** * List of application commands found in the audit log * - * See https://discord.com/developers/docs/interactions/application-commands#application-command-object + * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object} */ application_commands: APIApplicationCommand[]; /** * Webhooks found in the audit log * - * See https://discord.com/developers/docs/resources/webhook#webhook-object + * @see {@link https://discord.com/developers/docs/resources/webhook#webhook-object} */ webhooks: APIWebhook[]; /** * Users found in the audit log * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ users: APIUser[]; /** * Audit log entries * - * See https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object} */ audit_log_entries: APIAuditLogEntry[]; /** * List of auto moderation rules referenced in the audit log * - * See https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object} */ auto_moderation_rules: APIAutoModerationRule[]; /** * Partial integration objects * - * See https://discord.com/developers/docs/resources/guild#integration-object + * @see {@link https://discord.com/developers/docs/resources/guild#integration-object} */ integrations: APIGuildIntegration[]; /** @@ -79,19 +79,19 @@ export interface APIAuditLog { * * Threads referenced in THREAD_CREATE and THREAD_UPDATE events are included in the threads map, since archived threads might not be kept in memory by clients. * - * See https://discord.com/developers/docs/resources/channel#channel-object + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object} */ threads: APIChannel[]; /** * The guild scheduled events in the audit log * - * See https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object + * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object} */ guild_scheduled_events: APIGuildScheduledEvent[]; } /** - * https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure} */ export interface APIAuditLogEntry { /** @@ -101,7 +101,7 @@ export interface APIAuditLogEntry { /** * Changes made to the `target_id` * - * See https://discord.com/developers/docs/resources/audit-log#audit-log-change-object + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-change-object} */ changes?: APIAuditLogChange[]; /** @@ -117,13 +117,13 @@ export interface APIAuditLogEntry { /** * Type of action that occurred * - * See https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events} */ action_type: AuditLogEvent; /** * Additional info for certain action types * - * See https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info} */ options?: APIAuditLogOptions; /** @@ -133,7 +133,7 @@ export interface APIAuditLogEntry { } /** - * https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events} */ export enum AuditLogEvent { GuildUpdate = 1, @@ -222,7 +222,7 @@ export enum AuditLogEvent { } /** - * https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info} */ export interface APIAuditLogOptions { /** @@ -325,7 +325,7 @@ export interface APIAuditLogOptions { * - CHANNEL_OVERWRITE_UPDATE * - CHANNEL_OVERWRITE_DELETE * - * **Present only if the {@link APIAuditLogOptions#type entry type} is "0"** + * **Present only if the {@link APIAuditLogOptions.type | entry type} is "0"** */ role_name?: string; @@ -347,7 +347,7 @@ export enum AuditLogOptionsType { export type AuditLogRuleTriggerType = `${AutoModerationRuleTriggerType}`; /** - * https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure + * @see {@link https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure} */ export type APIAuditLogChange = | APIAuditLogChangeKey$Add @@ -442,92 +442,92 @@ export type APIAuditLogChange = /** * Returned when an entity's name is changed */ -export type APIAuditLogChangeKeyName = AuditLogChangeData<'name', string>; +export type APIAuditLogChangeKeyName = APIAuditLogChangeData<'name', string>; /** * Returned when a guild's or sticker's or guild scheduled event's description is changed */ -export type APIAuditLogChangeKeyDescription = AuditLogChangeData<'description', string>; +export type APIAuditLogChangeKeyDescription = APIAuditLogChangeData<'description', string>; /** * Returned when a guild's icon is changed */ -export type APIAuditLogChangeKeyIconHash = AuditLogChangeData<'icon_hash', string>; +export type APIAuditLogChangeKeyIconHash = APIAuditLogChangeData<'icon_hash', string>; /** * Returned when a guild's scheduled event's cover image is changed */ -export type APIAuditLogChangeKeyImageHash = AuditLogChangeData<'image_hash', string>; +export type APIAuditLogChangeKeyImageHash = APIAuditLogChangeData<'image_hash', string>; /** * Returned when a guild's splash is changed */ -export type APIAuditLogChangeKeySplashHash = AuditLogChangeData<'splash_hash', string>; +export type APIAuditLogChangeKeySplashHash = APIAuditLogChangeData<'splash_hash', string>; /** * Returned when a guild's discovery splash is changed */ -export type APIAuditLogChangeKeyDiscoverySplashHash = AuditLogChangeData<'discovery_splash_hash', string>; +export type APIAuditLogChangeKeyDiscoverySplashHash = APIAuditLogChangeData<'discovery_splash_hash', string>; /** * Returned when a guild's banner hash is changed */ -export type APIAuditLogChangeKeyBannerHash = AuditLogChangeData<'banner_hash', string>; +export type APIAuditLogChangeKeyBannerHash = APIAuditLogChangeData<'banner_hash', string>; /** * Returned when a guild's owner_id is changed */ -export type APIAuditLogChangeKeyOwnerId = AuditLogChangeData<'owner_id', Snowflake>; +export type APIAuditLogChangeKeyOwnerId = APIAuditLogChangeData<'owner_id', Snowflake>; /** * Returned when a guild's region is changed */ -export type APIAuditLogChangeKeyRegion = AuditLogChangeData<'region', string>; +export type APIAuditLogChangeKeyRegion = APIAuditLogChangeData<'region', string>; /** * Returned when a guild's preferred_locale is changed */ -export type APIAuditLogChangeKeyPreferredLocale = AuditLogChangeData<'preferred_locale', string>; +export type APIAuditLogChangeKeyPreferredLocale = APIAuditLogChangeData<'preferred_locale', string>; /** * Returned when a guild's afk_channel_id is changed */ -export type APIAuditLogChangeKeyAFKChannelId = AuditLogChangeData<'afk_channel_id', Snowflake>; +export type APIAuditLogChangeKeyAFKChannelId = APIAuditLogChangeData<'afk_channel_id', Snowflake>; /** * Returned when a guild's afk_timeout is changed */ -export type APIAuditLogChangeKeyAFKTimeout = AuditLogChangeData<'afk_timeout', number>; +export type APIAuditLogChangeKeyAFKTimeout = APIAuditLogChangeData<'afk_timeout', number>; /** * Returned when a guild's rules_channel_id is changed */ -export type APIAuditLogChangeKeyRulesChannelId = AuditLogChangeData<'rules_channel_id', string>; +export type APIAuditLogChangeKeyRulesChannelId = APIAuditLogChangeData<'rules_channel_id', string>; /** * Returned when a guild's public_updates_channel_id is changed */ -export type APIAuditLogChangeKeyPublicUpdatesChannelId = AuditLogChangeData<'public_updates_channel_id', string>; +export type APIAuditLogChangeKeyPublicUpdatesChannelId = APIAuditLogChangeData<'public_updates_channel_id', string>; /** * Returned when a guild's safety_alerts_channel_id is changed */ -export type APIAuditLogChangeKeySafetyAlertsChannelId = AuditLogChangeData<'safety_alerts_channel_id', string>; +export type APIAuditLogChangeKeySafetyAlertsChannelId = APIAuditLogChangeData<'safety_alerts_channel_id', string>; /** * Returned when a guild's mfa_level is changed */ -export type APIAuditLogChangeKeyMFALevel = AuditLogChangeData<'mfa_level', GuildMFALevel>; +export type APIAuditLogChangeKeyMFALevel = APIAuditLogChangeData<'mfa_level', GuildMFALevel>; /** * Returned when a guild's verification_level is changed */ -export type APIAuditLogChangeKeyVerificationLevel = AuditLogChangeData<'verification_level', GuildVerificationLevel>; +export type APIAuditLogChangeKeyVerificationLevel = APIAuditLogChangeData<'verification_level', GuildVerificationLevel>; /** * Returned when a guild's explicit_content_filter is changed */ -export type APIAuditLogChangeKeyExplicitContentFilter = AuditLogChangeData< +export type APIAuditLogChangeKeyExplicitContentFilter = APIAuditLogChangeData< 'explicit_content_filter', GuildExplicitContentFilter >; @@ -535,7 +535,7 @@ export type APIAuditLogChangeKeyExplicitContentFilter = AuditLogChangeData< /** * Returned when a guild's default_message_notifications is changed */ -export type APIAuditLogChangeKeyDefaultMessageNotifications = AuditLogChangeData< +export type APIAuditLogChangeKeyDefaultMessageNotifications = APIAuditLogChangeData< 'default_message_notifications', GuildDefaultMessageNotifications >; @@ -543,42 +543,45 @@ export type APIAuditLogChangeKeyDefaultMessageNotifications = AuditLogChangeData /** * Returned when a guild's vanity_url_code is changed */ -export type APIAuditLogChangeKeyVanityURLCode = AuditLogChangeData<'vanity_url_code', string>; +export type APIAuditLogChangeKeyVanityURLCode = APIAuditLogChangeData<'vanity_url_code', string>; /** * Returned when a guild's boost progress bar is enabled */ -export type APIAuditLogChangeKeyPremiumProgressBarEnabled = AuditLogChangeData<'premium_progress_bar_enabled', boolean>; +export type APIAuditLogChangeKeyPremiumProgressBarEnabled = APIAuditLogChangeData< + 'premium_progress_bar_enabled', + boolean +>; /** * Returned when new role(s) are added */ -export type APIAuditLogChangeKey$Add = AuditLogChangeData<'$add', Pick[]>; +export type APIAuditLogChangeKey$Add = APIAuditLogChangeData<'$add', Pick[]>; /** * Returned when role(s) are removed */ -export type APIAuditLogChangeKey$Remove = AuditLogChangeData<'$remove', Pick[]>; +export type APIAuditLogChangeKey$Remove = APIAuditLogChangeData<'$remove', Pick[]>; /** * Returned when there is a change in number of days after which inactive and role-unassigned members are kicked */ -export type APIAuditLogChangeKeyPruneDeleteDays = AuditLogChangeData<'prune_delete_days', number>; +export type APIAuditLogChangeKeyPruneDeleteDays = APIAuditLogChangeData<'prune_delete_days', number>; /** * Returned when a guild's widget is enabled */ -export type APIAuditLogChangeKeyWidgetEnabled = AuditLogChangeData<'widget_enabled', boolean>; +export type APIAuditLogChangeKeyWidgetEnabled = APIAuditLogChangeData<'widget_enabled', boolean>; /** * Returned when a guild's widget_channel_id is changed */ -export type APIAuditLogChangeKeyWidgetChannelId = AuditLogChangeData<'widget_channel_id', Snowflake>; +export type APIAuditLogChangeKeyWidgetChannelId = APIAuditLogChangeData<'widget_channel_id', Snowflake>; /** * Returned when a guild's system_channel_flags is changed */ -export type APIAuditLogChangeKeySystemChannelFlags = AuditLogChangeData< +export type APIAuditLogChangeKeySystemChannelFlags = APIAuditLogChangeData< 'system_channel_flags', GuildSystemChannelFlags >; @@ -586,48 +589,48 @@ export type APIAuditLogChangeKeySystemChannelFlags = AuditLogChangeData< /** * Returned when a guild's system_channel_id is changed */ -export type APIAuditLogChangeKeySystemChannelId = AuditLogChangeData<'system_channel_id', Snowflake>; +export type APIAuditLogChangeKeySystemChannelId = APIAuditLogChangeData<'system_channel_id', Snowflake>; /** * Returned when a channel's position is changed */ -export type APIAuditLogChangeKeyPosition = AuditLogChangeData<'position', number>; +export type APIAuditLogChangeKeyPosition = APIAuditLogChangeData<'position', number>; /** * Returned when a channel's topic is changed */ -export type APIAuditLogChangeKeyTopic = AuditLogChangeData<'topic', string>; +export type APIAuditLogChangeKeyTopic = APIAuditLogChangeData<'topic', string>; /** * Returned when a voice channel's bitrate is changed */ -export type APIAuditLogChangeKeyBitrate = AuditLogChangeData<'bitrate', number>; +export type APIAuditLogChangeKeyBitrate = APIAuditLogChangeData<'bitrate', number>; /** * Returned when a channel's permission overwrites is changed */ -export type APIAuditLogChangeKeyPermissionOverwrites = AuditLogChangeData<'permission_overwrites', APIOverwrite[]>; +export type APIAuditLogChangeKeyPermissionOverwrites = APIAuditLogChangeData<'permission_overwrites', APIOverwrite[]>; /** * Returned when a channel's NSFW restriction is changed */ -export type APIAuditLogChangeKeyNSFW = AuditLogChangeData<'nsfw', boolean>; +export type APIAuditLogChangeKeyNSFW = APIAuditLogChangeData<'nsfw', boolean>; /** * The application ID of the added or removed Webhook or Bot */ -export type APIAuditLogChangeKeyApplicationId = AuditLogChangeData<'application_id', Snowflake>; +export type APIAuditLogChangeKeyApplicationId = APIAuditLogChangeData<'application_id', Snowflake>; /** * Returned when a channel's amount of seconds a user has to wait before sending another message * is changed */ -export type APIAuditLogChangeKeyRateLimitPerUser = AuditLogChangeData<'rate_limit_per_user', number>; +export type APIAuditLogChangeKeyRateLimitPerUser = APIAuditLogChangeData<'rate_limit_per_user', number>; /** - * Returned when a guild scheduled event's recurrence_rule is changed + * Returned when a guild scheduled event's recurrence_rule is changed */ -export type APIAuditLogChangeKeyRecurrenceRule = AuditLogChangeData< +export type APIAuditLogChangeKeyRecurrenceRule = APIAuditLogChangeData< 'recurrence_rule', APIGuildScheduledEventRecurrenceRule >; @@ -635,173 +638,173 @@ export type APIAuditLogChangeKeyRecurrenceRule = AuditLogChangeData< /** * Returned when a permission bitfield is changed */ -export type APIAuditLogChangeKeyPermissions = AuditLogChangeData<'permissions', string>; +export type APIAuditLogChangeKeyPermissions = APIAuditLogChangeData<'permissions', string>; /** * Returned when a role's color is changed */ -export type APIAuditLogChangeKeyColor = AuditLogChangeData<'color', number>; +export type APIAuditLogChangeKeyColor = APIAuditLogChangeData<'color', number>; /** * Represents a change where the key is a snowflake. - * Currently, the only known instance of this is returned when permissions for a command were updated () + * Currently, the only known instance of this is returned when permissions for a command were updated */ -export type APIAuditLogChangeKeySnowflake = AuditLogChangeData; +export type APIAuditLogChangeKeySnowflake = APIAuditLogChangeData; /** * Returned when a role's hoist status is changed */ -export type APIAuditLogChangeKeyHoist = AuditLogChangeData<'hoist', boolean>; +export type APIAuditLogChangeKeyHoist = APIAuditLogChangeData<'hoist', boolean>; /** * Returned when a role's mentionable status is changed */ -export type APIAuditLogChangeKeyMentionable = AuditLogChangeData<'mentionable', boolean>; +export type APIAuditLogChangeKeyMentionable = APIAuditLogChangeData<'mentionable', boolean>; /** * Returned when an overwrite's allowed permissions bitfield is changed */ -export type APIAuditLogChangeKeyAllow = AuditLogChangeData<'allow', string>; +export type APIAuditLogChangeKeyAllow = APIAuditLogChangeData<'allow', string>; /** * Returned when an overwrite's denied permissions bitfield is changed */ -export type APIAuditLogChangeKeyDeny = AuditLogChangeData<'deny', string>; +export type APIAuditLogChangeKeyDeny = APIAuditLogChangeData<'deny', string>; /** * Returned when an invite's code is changed */ -export type APIAuditLogChangeKeyCode = AuditLogChangeData<'code', string>; +export type APIAuditLogChangeKeyCode = APIAuditLogChangeData<'code', string>; /** * Returned when an invite's or guild scheduled event's channel_id is changed */ -export type APIAuditLogChangeKeyChannelId = AuditLogChangeData<'channel_id', Snowflake>; +export type APIAuditLogChangeKeyChannelId = APIAuditLogChangeData<'channel_id', Snowflake>; /** * Returned when an invite's inviter_id is changed */ -export type APIAuditLogChangeKeyInviterId = AuditLogChangeData<'inviter_id', Snowflake>; +export type APIAuditLogChangeKeyInviterId = APIAuditLogChangeData<'inviter_id', Snowflake>; /** * Returned when an invite's max_uses is changed */ -export type APIAuditLogChangeKeyMaxUses = AuditLogChangeData<'max_uses', number>; +export type APIAuditLogChangeKeyMaxUses = APIAuditLogChangeData<'max_uses', number>; /** * Returned when an invite's uses is changed */ -export type APIAuditLogChangeKeyUses = AuditLogChangeData<'uses', number>; +export type APIAuditLogChangeKeyUses = APIAuditLogChangeData<'uses', number>; /** * Returned when an invite's max_age is changed */ -export type APIAuditLogChangeKeyMaxAge = AuditLogChangeData<'max_age', number>; +export type APIAuditLogChangeKeyMaxAge = APIAuditLogChangeData<'max_age', number>; /** * Returned when an invite's temporary status is changed */ -export type APIAuditLogChangeKeyTemporary = AuditLogChangeData<'temporary', boolean>; +export type APIAuditLogChangeKeyTemporary = APIAuditLogChangeData<'temporary', boolean>; /** * Returned when a user's deaf status is changed */ -export type APIAuditLogChangeKeyDeaf = AuditLogChangeData<'deaf', boolean>; +export type APIAuditLogChangeKeyDeaf = APIAuditLogChangeData<'deaf', boolean>; /** * Returned when a user's mute status is changed */ -export type APIAuditLogChangeKeyMute = AuditLogChangeData<'mute', boolean>; +export type APIAuditLogChangeKeyMute = APIAuditLogChangeData<'mute', boolean>; /** * Returned when a user's nick is changed */ -export type APIAuditLogChangeKeyNick = AuditLogChangeData<'nick', string>; +export type APIAuditLogChangeKeyNick = APIAuditLogChangeData<'nick', string>; /** * Returned when a user's avatar_hash is changed */ -export type APIAuditLogChangeKeyAvatarHash = AuditLogChangeData<'avatar_hash', string>; +export type APIAuditLogChangeKeyAvatarHash = APIAuditLogChangeData<'avatar_hash', string>; /** * The ID of the changed entity - sometimes used in conjunction with other keys */ -export type APIAuditLogChangeKeyId = AuditLogChangeData<'id', Snowflake>; +export type APIAuditLogChangeKeyId = APIAuditLogChangeData<'id', Snowflake>; /** * The type of entity created */ -export type APIAuditLogChangeKeyType = AuditLogChangeData<'type', number | string>; +export type APIAuditLogChangeKeyType = APIAuditLogChangeData<'type', number | string>; /** * Returned when an integration's enable_emoticons is changed */ -export type APIAuditLogChangeKeyEnableEmoticons = AuditLogChangeData<'enable_emoticons', boolean>; +export type APIAuditLogChangeKeyEnableEmoticons = APIAuditLogChangeData<'enable_emoticons', boolean>; /** * Returned when an integration's expire_behavior is changed */ -export type APIAuditLogChangeKeyExpireBehavior = AuditLogChangeData<'expire_behavior', IntegrationExpireBehavior>; +export type APIAuditLogChangeKeyExpireBehavior = APIAuditLogChangeData<'expire_behavior', IntegrationExpireBehavior>; /** * Returned when an integration's expire_grace_period is changed */ -export type APIAuditLogChangeKeyExpireGracePeriod = AuditLogChangeData<'expire_grace_period', number>; +export type APIAuditLogChangeKeyExpireGracePeriod = APIAuditLogChangeData<'expire_grace_period', number>; /** * Returned when a voice channel's user_limit is changed */ -export type APIAuditLogChangeKeyUserLimit = AuditLogChangeData<'user_limit', number>; +export type APIAuditLogChangeKeyUserLimit = APIAuditLogChangeData<'user_limit', number>; /** * Returned when privacy level of a stage instance or guild scheduled event is changed */ -export type APIAuditLogChangeKeyPrivacyLevel = AuditLogChangeData<'privacy_level', StageInstancePrivacyLevel>; +export type APIAuditLogChangeKeyPrivacyLevel = APIAuditLogChangeData<'privacy_level', StageInstancePrivacyLevel>; /** * Returned when a sticker's related emoji is changed */ -export type APIAuditLogChangeKeyTags = AuditLogChangeData<'tags', string>; +export type APIAuditLogChangeKeyTags = APIAuditLogChangeData<'tags', string>; /** * Returned when a sticker's format_type is changed */ -export type APIAuditLogChangeKeyFormatType = AuditLogChangeData<'format_type', StickerFormatType>; +export type APIAuditLogChangeKeyFormatType = APIAuditLogChangeData<'format_type', StickerFormatType>; /** * Empty string */ -export type APIAuditLogChangeKeyAsset = AuditLogChangeData<'asset', ''>; +export type APIAuditLogChangeKeyAsset = APIAuditLogChangeData<'asset', ''>; /** * Returned when a sticker's availability is changed */ -export type APIAuditLogChangeKeyAvailable = AuditLogChangeData<'available', boolean>; +export type APIAuditLogChangeKeyAvailable = APIAuditLogChangeData<'available', boolean>; /** * Returned when a sticker's guild_id is changed */ -export type APIAuditLogChangeKeyGuildId = AuditLogChangeData<'guild_id', Snowflake>; +export type APIAuditLogChangeKeyGuildId = APIAuditLogChangeData<'guild_id', Snowflake>; /** * Returned when a thread's archive status is changed */ -export type APIAuditLogChangeKeyArchived = AuditLogChangeData<'archived', boolean>; +export type APIAuditLogChangeKeyArchived = APIAuditLogChangeData<'archived', boolean>; /** * Returned when a thread's lock status is changed */ -export type APIAuditLogChangeKeyLocked = AuditLogChangeData<'locked', boolean>; +export type APIAuditLogChangeKeyLocked = APIAuditLogChangeData<'locked', boolean>; /** * Returned when a thread's auto archive duration is changed */ -export type APIAuditLogChangeKeyAutoArchiveDuration = AuditLogChangeData<'auto_archive_duration', number>; +export type APIAuditLogChangeKeyAutoArchiveDuration = APIAuditLogChangeData<'auto_archive_duration', number>; /** * Returned when a channel's default auto archive duration for newly created threads is changed */ -export type APIAuditLogChangeKeyDefaultAutoArchiveDuration = AuditLogChangeData< +export type APIAuditLogChangeKeyDefaultAutoArchiveDuration = APIAuditLogChangeData< 'default_auto_archive_duration', number >; @@ -809,37 +812,40 @@ export type APIAuditLogChangeKeyDefaultAutoArchiveDuration = AuditLogChangeData< /** * Returned when entity type of a guild scheduled event is changed */ -export type APIAuditLogChangeKeyEntityType = AuditLogChangeData<'entity_type', GuildScheduledEventEntityType>; +export type APIAuditLogChangeKeyEntityType = APIAuditLogChangeData<'entity_type', GuildScheduledEventEntityType>; /** * Returned when status of a guild scheduled event is changed */ -export type APIAuditLogChangeKeyStatus = AuditLogChangeData<'status', GuildScheduledEventStatus>; +export type APIAuditLogChangeKeyStatus = APIAuditLogChangeData<'status', GuildScheduledEventStatus>; /** * Returned when location of a guild scheduled event is changed */ -export type APIAuditLogChangeKeyLocation = AuditLogChangeData<'location', string>; +export type APIAuditLogChangeKeyLocation = APIAuditLogChangeData<'location', string>; /** * Returned when a user's timeout is changed */ -export type APIAuditLogChangeKeyCommunicationDisabledUntil = AuditLogChangeData<'communication_disabled_until', string>; +export type APIAuditLogChangeKeyCommunicationDisabledUntil = APIAuditLogChangeData< + 'communication_disabled_until', + string +>; /** * Returned when an auto moderation rule's trigger type is changed (only in rule creation or deletion) */ -export type APIAuditLogChangeKeyTriggerType = AuditLogChangeData<'trigger_type', AutoModerationRuleTriggerType>; +export type APIAuditLogChangeKeyTriggerType = APIAuditLogChangeData<'trigger_type', AutoModerationRuleTriggerType>; /** * Returned when an auto moderation rule's event type is changed */ -export type APIAuditLogChangeKeyEventType = AuditLogChangeData<'event_type', AutoModerationRuleEventType>; +export type APIAuditLogChangeKeyEventType = APIAuditLogChangeData<'event_type', AutoModerationRuleEventType>; /** * Returned when an auto moderation rule's trigger metadata is changed */ -export type APIAuditLogChangeKeyTriggerMetadata = AuditLogChangeData< +export type APIAuditLogChangeKeyTriggerMetadata = APIAuditLogChangeData< 'trigger_metadata', APIAutoModerationRuleTriggerMetadata >; @@ -847,32 +853,32 @@ export type APIAuditLogChangeKeyTriggerMetadata = AuditLogChangeData< /** * Returned when an auto moderation rule's actions is changed */ -export type APIAuditLogChangeKeyActions = AuditLogChangeData<'actions', APIAutoModerationAction[]>; +export type APIAuditLogChangeKeyActions = APIAuditLogChangeData<'actions', APIAutoModerationAction[]>; /** * Returned when an auto moderation rule's enabled status is changed */ -export type APIAuditLogChangeKeyEnabled = AuditLogChangeData<'enabled', boolean>; +export type APIAuditLogChangeKeyEnabled = APIAuditLogChangeData<'enabled', boolean>; /** * Returned when an auto moderation rule's exempt roles is changed */ -export type APIAuditLogChangeKeyExemptRoles = AuditLogChangeData<'exempt_roles', Snowflake[]>; +export type APIAuditLogChangeKeyExemptRoles = APIAuditLogChangeData<'exempt_roles', Snowflake[]>; /** * Returned when an auto moderation rule's exempt channels is changed */ -export type APIAuditLogChangeKeyExemptChannels = AuditLogChangeData<'exempt_channels', Snowflake[]>; +export type APIAuditLogChangeKeyExemptChannels = APIAuditLogChangeData<'exempt_channels', Snowflake[]>; /** * Returned when a guild forum's available tags gets changed */ -export type APIAuditLogChangeKeyAvailableTags = AuditLogChangeData<'available_tags', APIGuildForumTag[]>; +export type APIAuditLogChangeKeyAvailableTags = APIAuditLogChangeData<'available_tags', APIGuildForumTag[]>; /** * Returned when a guild forum's default reaction emoji gets changed */ -export type APIAuditLogChangeKeyDefaultReactionEmoji = AuditLogChangeData< +export type APIAuditLogChangeKeyDefaultReactionEmoji = APIAuditLogChangeData< 'default_reaction_emoji', APIGuildForumDefaultReactionEmoji >; @@ -880,13 +886,13 @@ export type APIAuditLogChangeKeyDefaultReactionEmoji = AuditLogChangeData< /** * Returned when a channel flag gets changed */ -export type APIAuditLogChangeKeyFlags = AuditLogChangeData<'flags', number>; +export type APIAuditLogChangeKeyFlags = APIAuditLogChangeData<'flags', number>; /** * Returned when a thread's amount of seconds a user has to wait before creating another thread * gets changed */ -export type APIAuditLogChangeKeyDefaultThreadRateLimitPerUser = AuditLogChangeData< +export type APIAuditLogChangeKeyDefaultThreadRateLimitPerUser = APIAuditLogChangeData< 'default_thread_rate_limit_per_user', number >; @@ -894,29 +900,29 @@ export type APIAuditLogChangeKeyDefaultThreadRateLimitPerUser = AuditLogChangeDa /** * Returned when a soundboard is create or deleted */ -export type APIAuditLogChangeKeySoundId = AuditLogChangeData<'sound_id', Snowflake>; +export type APIAuditLogChangeKeySoundId = APIAuditLogChangeData<'sound_id', Snowflake>; /** * Returned when a soundboard's volume is changed */ -export type APIAuditLogChangeKeyVolume = AuditLogChangeData<'volume', number>; +export type APIAuditLogChangeKeyVolume = APIAuditLogChangeData<'volume', number>; /** * Returned when a soundboard's custom emoji is changed */ -export type APIAuditLogChangeKeyEmojiId = AuditLogChangeData<'emoji_id', Snowflake>; +export type APIAuditLogChangeKeyEmojiId = APIAuditLogChangeData<'emoji_id', Snowflake>; /** * Returned when a soundboard's unicode emoji is changed */ -export type APIAuditLogChangeKeyEmojiName = AuditLogChangeData<'emoji_name', string>; +export type APIAuditLogChangeKeyEmojiName = APIAuditLogChangeData<'emoji_name', string>; /** * Returned when a sounboard is created */ -export type APIAuditLogChangeKeyUserId = AuditLogChangeData<'user_id', Snowflake>; +export type APIAuditLogChangeKeyUserId = APIAuditLogChangeData<'user_id', Snowflake>; -interface AuditLogChangeData { +export interface APIAuditLogChangeData { key: K; /** * The new value diff --git a/deno/payloads/v10/autoModeration.ts b/deno/payloads/v10/autoModeration.ts index a20872b7..6b97625c 100644 --- a/deno/payloads/v10/autoModeration.ts +++ b/deno/payloads/v10/autoModeration.ts @@ -5,7 +5,7 @@ import type { Snowflake } from '../../globals.ts'; /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-auto-moderation-rule-structure + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-auto-moderation-rule-structure} */ export interface APIAutoModerationRule { /** @@ -55,7 +55,7 @@ export interface APIAutoModerationRule { } /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types} */ export enum AutoModerationRuleTriggerType { /** @@ -81,14 +81,15 @@ export enum AutoModerationRuleTriggerType { } /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata} */ export interface APIAutoModerationRuleTriggerMetadata { /** * Substrings which will be searched for in content (Maximum of 1000) * * A keyword can be a phrase which contains multiple words. Wildcard symbols can be used to customize how each string will be matched. Each keyword must be 60 characters or less - * See [keyword matching strategies](https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-matching-strategies) + * + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-matching-strategies | Keyword matching strategies} * * Associated trigger types: {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.MemberProfile} */ @@ -103,7 +104,8 @@ export interface APIAutoModerationRuleTriggerMetadata { * Substrings which will be exempt from triggering the preset trigger type (Maximum of 1000) * * A allowed-word can be a phrase which contains multiple words. Wildcard symbols can be used to customize how each string will be matched. Each keyword must be 60 characters or less - * See [keyword matching strategies](https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-matching-strategies) + * + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-matching-strategies | Keyword matching strategies} * * Associated trigger types: {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.KeywordPreset}, {@link AutoModerationRuleTriggerType.MemberProfile} */ @@ -131,7 +133,7 @@ export interface APIAutoModerationRuleTriggerMetadata { } /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-preset-types + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-preset-types} */ export enum AutoModerationRuleKeywordPresetType { /** @@ -149,7 +151,7 @@ export enum AutoModerationRuleKeywordPresetType { } /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-event-types + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-event-types} */ export enum AutoModerationRuleEventType { /** @@ -163,7 +165,7 @@ export enum AutoModerationRuleEventType { } /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-auto-moderation-action-structure + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-auto-moderation-action-structure} */ export interface APIAutoModerationAction { /** @@ -179,7 +181,7 @@ export interface APIAutoModerationAction { } /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-types + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-types} */ export enum AutoModerationActionType { /** @@ -202,7 +204,7 @@ export enum AutoModerationActionType { } /** - * https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata + * @see {@link https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata} */ export interface APIAutoModerationActionMetadata { /** diff --git a/deno/payloads/v10/channel.ts b/deno/payloads/v10/channel.ts index 6f0441e1..8762f15e 100644 --- a/deno/payloads/v10/channel.ts +++ b/deno/payloads/v10/channel.ts @@ -23,7 +23,7 @@ export interface APIPartialChannel { /** * The type of the channel * - * See https://discord.com/developers/docs/resources/channel#channel-object-channel-types + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types} */ type: ChannelType; /** @@ -88,7 +88,7 @@ export interface APIGuildChannel extends Omit /** * Voice region id for the voice or stage channel, automatic when set to `null` * - * See https://discord.com/developers/docs/resources/voice#voice-region-object + * @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object} */ rtc_region?: string | null; /** * The camera video quality mode of the voice or stage channel, `1` when not present * - * See https://discord.com/developers/docs/resources/channel#channel-object-video-quality-modes + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-video-quality-modes} */ video_quality_mode?: VideoQualityMode; } @@ -166,7 +166,7 @@ export interface APIDMChannelBase extends Omit; /** - * https://discord.com/developers/docs/resources/channel#channel-object-channel-structure + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-structure} */ export type APIChannel = | APIDMChannel @@ -386,7 +386,7 @@ export type APIChannel = | APIThreadChannel; /** - * https://discord.com/developers/docs/resources/channel#channel-object-channel-types + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types} */ export enum ChannelType { /** @@ -408,13 +408,13 @@ export enum ChannelType { /** * An organizational category that contains up to 50 channels * - * See https://support.discord.com/hc/articles/115001580171 + * @see {@link https://support.discord.com/hc/articles/115001580171} */ GuildCategory, /** * A channel that users can follow and crosspost into their own guild * - * See https://support.discord.com/hc/articles/360032008192 + * @see {@link https://support.discord.com/hc/articles/360032008192} */ GuildAnnouncement, /** @@ -432,13 +432,13 @@ export enum ChannelType { /** * A voice channel for hosting events with an audience * - * See https://support.discord.com/hc/articles/1500005513722 + * @see {@link https://support.discord.com/hc/articles/1500005513722} */ GuildStageVoice, /** * The channel in a Student Hub containing the listed servers * - * See https://support.discord.com/hc/articles/4406046651927 + * @see {@link https://support.discord.com/hc/articles/4406046651927} */ GuildDirectory, /** @@ -448,7 +448,7 @@ export enum ChannelType { /** * A channel like forum channels but contains media for server subscriptions * - * See https://creator-support.discord.com/hc/articles/14346342766743 + * @see {@link https://creator-support.discord.com/hc/articles/14346342766743} */ GuildMedia, @@ -457,28 +457,27 @@ export enum ChannelType { /** * A channel that users can follow and crosspost into their own guild * - * @deprecated This is the old name for {@apilink ChannelType#GuildAnnouncement} - * - * See https://support.discord.com/hc/articles/360032008192 + * @deprecated This is the old name for {@link ChannelType.GuildAnnouncement} + * @see {@link https://support.discord.com/hc/articles/360032008192} */ GuildNews = 5, /** * A temporary sub-channel within a Guild Announcement channel * - * @deprecated This is the old name for {@apilink ChannelType#AnnouncementThread} + * @deprecated This is the old name for {@link ChannelType.AnnouncementThread} */ // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values GuildNewsThread = 10, /** * A temporary sub-channel within a Guild Text channel * - * @deprecated This is the old name for {@apilink ChannelType#PublicThread} + * @deprecated This is the old name for {@link ChannelType.PublicThread} */ GuildPublicThread = 11, /** * A temporary sub-channel within a Guild Text channel that is only viewable by those invited and those with the Manage Threads permission * - * @deprecated This is the old name for {@apilink ChannelType#PrivateThread} + * @deprecated This is the old name for {@link ChannelType.PrivateThread} */ GuildPrivateThread = 12, } @@ -495,7 +494,7 @@ export enum VideoQualityMode { } /** - * https://discord.com/developers/docs/resources/channel#message-object-message-structure + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-structure} */ export interface APIMessage { /** @@ -512,7 +511,7 @@ export interface APIMessage { * If the message is generated by a webhook, the author object corresponds to the webhook's id, * username, and avatar. You can tell if a message is generated by a webhook by checking for the `webhook_id` property * - * See https://discord.com/developers/docs/resources/user#user-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} */ author: APIUser; /** @@ -520,10 +519,10 @@ export interface APIMessage { * * The `MESSAGE_CONTENT` privileged gateway intent is required for verified applications to receive a non-empty value from this field * - * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot > Privileged Gateway Intents**. + * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot \> Privileged Gateway Intents**. * You also need to specify the intent bit value (`1 << 15`) if you are connecting to the gateway * - * See https://support-dev.discord.com/hc/articles/4404772028055 + * @see {@link https://support-dev.discord.com/hc/articles/4404772028055} */ content: string; /** @@ -548,14 +547,14 @@ export interface APIMessage { * The `member` field is only present in `MESSAGE_CREATE` and `MESSAGE_UPDATE` events * from text-based guild channels * - * See https://discord.com/developers/docs/resources/user#user-object - * See https://discord.com/developers/docs/resources/guild#guild-member-object + * @see {@link https://discord.com/developers/docs/resources/user#user-object} + * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} */ mentions: APIUser[]; /** * Roles specifically mentioned in this message * - * See https://discord.com/developers/docs/topics/permissions#role-object + * @see {@link https://discord.com/developers/docs/topics/permissions#role-object} */ mention_roles: APIRole['id'][]; /** @@ -567,39 +566,37 @@ export interface APIMessage { * * If no mentions in the message meet these requirements, this field will not be sent * - * See https://discord.com/developers/docs/resources/channel#channel-mention-object + * @see {@link https://discord.com/developers/docs/resources/channel#channel-mention-object} */ mention_channels?: APIChannelMention[]; /** * Any attached files * - * See https://discord.com/developers/docs/resources/message#attachment-object-attachment-structure + * @see {@link https://discord.com/developers/docs/resources/message#attachment-object-attachment-structure} * * The `MESSAGE_CONTENT` privileged gateway intent is required for verified applications to receive a non-empty value from this field * - * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot > Privileged Gateway Intents**. + * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot \> Privileged Gateway Intents**. * You also need to specify the intent bit value (`1 << 15`) if you are connecting to the gateway - * - * See https://support-dev.discord.com/hc/articles/4404772028055 + * @see {@link https://support-dev.discord.com/hc/articles/4404772028055} */ attachments: APIAttachment[]; /** * Any embedded content * - * See https://discord.com/developers/docs/resources/channel#embed-object + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object} * * The `MESSAGE_CONTENT` privileged gateway intent is required for verified applications to receive a non-empty value from this field * - * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot > Privileged Gateway Intents**. + * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot \> Privileged Gateway Intents**. * You also need to specify the intent bit value (`1 << 15`) if you are connecting to the gateway - * - * See https://support-dev.discord.com/hc/articles/4404772028055 + * @see {@link https://support-dev.discord.com/hc/articles/4404772028055} */ embeds: APIEmbed[]; /** * Reactions to the message * - * See https://discord.com/developers/docs/resources/channel#reaction-object + * @see {@link https://discord.com/developers/docs/resources/channel#reaction-object} */ reactions?: APIReaction[]; /** @@ -620,19 +617,19 @@ export interface APIMessage { /** * Type of message * - * See https://discord.com/developers/docs/resources/channel#message-object-message-types + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-types} */ type: MessageType; /** * Sent with Rich Presence-related chat embeds * - * See https://discord.com/developers/docs/resources/channel#message-object-message-activity-structure + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-activity-structure} */ activity?: APIMessageActivity; /** * Sent with Rich Presence-related chat embeds * - * See https://discord.com/developers/docs/resources/application#application-object + * @see {@link https://discord.com/developers/docs/resources/application#application-object} */ application?: Partial; /** @@ -642,15 +639,14 @@ export interface APIMessage { /** * Reference data sent with crossposted messages, replies, pins, and thread starter messages * - * See https://discord.com/developers/docs/resources/channel#message-reference-object-message-reference-structure + * @see {@link https://discord.com/developers/docs/resources/channel#message-reference-object-message-reference-structure} */ message_reference?: APIMessageReference; /** * Message flags combined as a bitfield * - * See https://discord.com/developers/docs/resources/channel#message-object-message-flags - * - * See https://en.wikipedia.org/wiki/Bit_field + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-flags} + * @see {@link https://en.wikipedia.org/wiki/Bit_field} */ flags?: MessageFlags; /** @@ -664,7 +660,7 @@ export interface APIMessage { * * If the field exists but is `null`, the referenced message was deleted * - * See https://discord.com/developers/docs/resources/channel#message-object + * @see {@link https://discord.com/developers/docs/resources/channel#message-object} */ referenced_message?: APIMessage | null; /** @@ -686,24 +682,23 @@ export interface APIMessage { * * The `MESSAGE_CONTENT` privileged gateway intent is required for verified applications to receive a non-empty value from this field * - * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot > Privileged Gateway Intents**. + * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot \> Privileged Gateway Intents**. * You also need to specify the intent bit value (`1 << 15`) if you are connecting to the gateway * - * See https://support-dev.discord.com/hc/articles/4404772028055 + * @see {@link https://support-dev.discord.com/hc/articles/4404772028055} */ components?: APIActionRowComponent[]; /** * Sent if the message contains stickers * - * See https://discord.com/developers/docs/resources/sticker#sticker-item-object + * @see {@link https://discord.com/developers/docs/resources/sticker#sticker-item-object} */ sticker_items?: APIStickerItem[]; /** * The stickers sent with the message * - * See https://discord.com/developers/docs/resources/sticker#sticker-object - * - * @deprecated Use `sticker_items` instead + * @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object} + * @deprecated Use {@link APIMessage.sticker_items} instead */ stickers?: APISticker[]; /** @@ -719,7 +714,7 @@ export interface APIMessage { /** * Data for users, members, channels, and roles in the message's auto-populated select menus * - * See https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure + * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure} */ resolved?: APIInteractionDataResolved; /** @@ -727,10 +722,10 @@ export interface APIMessage { * * The `MESSAGE_CONTENT` privileged gateway intent is required for verified applications to receive a non-empty value from this field * - * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot > Privileged Gateway Intents**. + * In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot \> Privileged Gateway Intents**. * You also need to specify the intent bit value (`1 << 15`) if you are connecting to the gateway * - * See https://support-dev.discord.com/hc/articles/4404772028055 + * @see {@link https://support-dev.discord.com/hc/articles/4404772028055} */ poll?: APIPoll; /** @@ -744,7 +739,7 @@ export interface APIMessage { } /** - * https://discord.com/developers/docs/resources/channel#message-object-message-types + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-types} */ export enum MessageType { Default, @@ -795,25 +790,25 @@ export enum MessageType { } /** - * https://discord.com/developers/docs/resources/channel#message-object-message-activity-structure + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-activity-structure} */ export interface APIMessageActivity { /** * Type of message activity * - * See https://discord.com/developers/docs/resources/channel#message-object-message-activity-types + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-activity-types} */ type: MessageActivityType; /** * `party_id` from a Rich Presence event * - * See https://discord.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields + * @see {@link https://discord.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields} */ party_id?: string; } /** - * https://discord.com/developers/docs/resources/channel#message-reference-object-message-reference-structure + * @see {@link https://discord.com/developers/docs/resources/channel#message-reference-object-message-reference-structure} */ export interface APIMessageReference { /** @@ -835,7 +830,7 @@ export interface APIMessageReference { } /** - * https://discord.com/developers/docs/resources/channel#message-object-message-activity-types + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-activity-types} */ export enum MessageActivityType { Join = 1, @@ -845,7 +840,7 @@ export enum MessageActivityType { } /** - * https://discord.com/developers/docs/resources/channel#message-reference-types + * @see {@link https://discord.com/developers/docs/resources/channel#message-reference-types} */ export enum MessageReferenceType { /** @@ -859,7 +854,7 @@ export enum MessageReferenceType { } /** - * https://discord.com/developers/docs/resources/channel#message-object-message-flags + * @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-flags} */ export enum MessageFlags { /** @@ -917,7 +912,7 @@ export enum MessageFlags { } /** - * https://discord.com/developers/docs/resources/channel#message-call-object-message-call-object-structure + * @see {@link https://discord.com/developers/docs/resources/channel#message-call-object-message-call-object-structure} */ export interface APIMessageCall { /** @@ -931,7 +926,7 @@ export interface APIMessageCall { } /** - * https://discord.com/developers/docs/resources/channel#role-subscription-data-object-role-subscription-data-object-structure + * @see {@link https://discord.com/developers/docs/resources/channel#role-subscription-data-object-role-subscription-data-object-structure} */ export interface APIMessageRoleSubscriptionData { /** @@ -953,7 +948,7 @@ export interface APIMessageRoleSubscriptionData { } /** - * https://discord.com/developers/docs/resources/channel#followed-channel-object + * @see {@link https://discord.com/developers/docs/resources/channel#followed-channel-object} */ export interface APIFollowedChannel { /** @@ -967,7 +962,7 @@ export interface APIFollowedChannel { } /** - * https://discord.com/developers/docs/resources/channel#reaction-object-reaction-structure + * @see {@link https://discord.com/developers/docs/resources/channel#reaction-object-reaction-structure} */ export interface APIReaction { /** @@ -989,7 +984,7 @@ export interface APIReaction { /** * Emoji information * - * See https://discord.com/developers/docs/resources/emoji#emoji-object + * @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object} */ emoji: APIPartialEmoji; /** @@ -999,7 +994,7 @@ export interface APIReaction { } /** - * https://discord.com/developers/docs/resources/channel#reaction-count-details-object-reaction-count-details-structure + * @see {@link https://discord.com/developers/docs/resources/channel#reaction-count-details-object-reaction-count-details-structure} */ export interface APIReactionCountDetails { /** @@ -1013,7 +1008,7 @@ export interface APIReactionCountDetails { } /** - * https://discord.com/developers/docs/resources/channel#overwrite-object-overwrite-structure + * @see {@link https://discord.com/developers/docs/resources/channel#overwrite-object-overwrite-structure} */ export interface APIOverwrite { /** @@ -1022,24 +1017,20 @@ export interface APIOverwrite { id: Snowflake; /** * Either 0 (role) or 1 (member) - * - * {@link OverwriteType} */ type: OverwriteType; /** * Permission bit set * - * See https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags - * - * See https://en.wikipedia.org/wiki/Bit_field + * @see {@link https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags} + * @see {@link https://en.wikipedia.org/wiki/Bit_field} */ allow: Permissions; /** * Permission bit set * - * See https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags - * - * See https://en.wikipedia.org/wiki/Bit_field + * @see {@link https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags} + * @see {@link https://en.wikipedia.org/wiki/Bit_field} */ deny: Permissions; } @@ -1050,7 +1041,7 @@ export enum OverwriteType { } /** - * https://discord.com/developers/docs/resources/channel#thread-metadata-object-thread-metadata-structure + * @see {@link https://discord.com/developers/docs/resources/channel#thread-metadata-object-thread-metadata-structure} */ export interface APIThreadMetadata { /** @@ -1087,7 +1078,7 @@ export enum ThreadAutoArchiveDuration { } /** - * https://discord.com/developers/docs/resources/channel#thread-member-object-thread-member-structure + * @see {@link https://discord.com/developers/docs/resources/channel#thread-member-object-thread-member-structure} */ export interface APIThreadMember { /** @@ -1109,7 +1100,7 @@ export interface APIThreadMember { /** * Member flags combined as a bitfield * - * See https://en.wikipedia.org/wiki/Bit_field + * @see {@link https://en.wikipedia.org/wiki/Bit_field} */ flags: ThreadMemberFlags; /** @@ -1153,7 +1144,7 @@ export interface APIThreadList { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-structure} * * Length limit: 6000 characters */ @@ -1189,37 +1180,37 @@ export interface APIEmbed { /** * Footer information * - * See https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure} */ footer?: APIEmbedFooter; /** * Image information * - * See https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure} */ image?: APIEmbedImage; /** * Thumbnail information * - * See https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure} */ thumbnail?: APIEmbedThumbnail; /** * Video information * - * See https://discord.com/developers/docs/resources/channel#embed-object-embed-video-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-video-structure} */ video?: APIEmbedVideo; /** * Provider information * - * See https://discord.com/developers/docs/resources/channel#embed-object-embed-provider-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-provider-structure} */ provider?: APIEmbedProvider; /** * Author information * - * See https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure} */ author?: APIEmbedAuthor; /** @@ -1227,13 +1218,13 @@ export interface APIEmbed { * * Length limit: 25 field objects * - * See https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure} */ fields?: APIEmbedField[]; } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-types + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-types} */ export enum EmbedType { /** @@ -1273,7 +1264,7 @@ export enum EmbedType { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure} */ export interface APIEmbedThumbnail { /** @@ -1295,7 +1286,7 @@ export interface APIEmbedThumbnail { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-video-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-video-structure} */ export interface APIEmbedVideo { /** @@ -1317,7 +1308,7 @@ export interface APIEmbedVideo { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure} */ export interface APIEmbedImage { /** @@ -1339,7 +1330,7 @@ export interface APIEmbedImage { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-provider-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-provider-structure} */ export interface APIEmbedProvider { /** @@ -1353,7 +1344,7 @@ export interface APIEmbedProvider { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure} */ export interface APIEmbedAuthor { /** @@ -1377,7 +1368,7 @@ export interface APIEmbedAuthor { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure} */ export interface APIEmbedFooter { /** @@ -1397,7 +1388,7 @@ export interface APIEmbedFooter { } /** - * https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure + * @see {@link https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure} */ export interface APIEmbedField { /** @@ -1419,7 +1410,7 @@ export interface APIEmbedField { } /** - * https://discord.com/developers/docs/resources/message#attachment-object-attachment-structure + * @see {@link https://discord.com/developers/docs/resources/message#attachment-object-attachment-structure} */ export interface APIAttachment { /** @@ -1441,7 +1432,7 @@ export interface APIAttachment { /** * The attachment's media type * - * See https://en.wikipedia.org/wiki/Media_type + * @see {@link https://en.wikipedia.org/wiki/Media_type} */ content_type?: string; /** @@ -1483,7 +1474,7 @@ export interface APIAttachment { } /** - * https://discord.com/developers/docs/resources/channel#attachment-object-attachment-structure-attachment-flags + * @see {@link https://discord.com/developers/docs/resources/channel#attachment-object-attachment-structure-attachment-flags} */ export enum AttachmentFlags { /** @@ -1493,7 +1484,7 @@ export enum AttachmentFlags { } /** - * https://discord.com/developers/docs/resources/channel#channel-mention-object-channel-mention-structure + * @see {@link https://discord.com/developers/docs/resources/channel#channel-mention-object-channel-mention-structure} */ export interface APIChannelMention { /** @@ -1507,7 +1498,7 @@ export interface APIChannelMention { /** * The type of channel * - * See https://discord.com/developers/docs/resources/channel#channel-object-channel-types + * @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types} */ type: ChannelType; /** @@ -1517,11 +1508,11 @@ export interface APIChannelMention { } /** - * https://discord.com/developers/docs/resources/channel#allowed-mentions-object-allowed-mention-types + * @see {@link https://discord.com/developers/docs/resources/channel#allowed-mentions-object-allowed-mention-types} */ export enum AllowedMentionsTypes { /** - * Controls @everyone and @here mentions + * Controls `@everyone` and `@here` mentions */ Everyone = 'everyone', /** @@ -1535,13 +1526,13 @@ export enum AllowedMentionsTypes { } /** - * https://discord.com/developers/docs/resources/channel#allowed-mentions-object-allowed-mentions-structure + * @see {@link https://discord.com/developers/docs/resources/channel#allowed-mentions-object-allowed-mentions-structure} */ export interface APIAllowedMentions { /** * An array of allowed mention types to parse from the content * - * See https://discord.com/developers/docs/resources/channel#allowed-mentions-object-allowed-mention-types + * @see {@link https://discord.com/developers/docs/resources/channel#allowed-mentions-object-allowed-mention-types} */ parse?: AllowedMentionsTypes[]; /** @@ -1555,13 +1546,13 @@ export interface APIAllowedMentions { /** * For replies, whether to mention the author of the message being replied to (default false) * - * @default false + * @defaultValue `false` */ replied_user?: boolean; } /** - * https://discord.com/developers/docs/interactions/message-components#component-object + * @see {@link https://discord.com/developers/docs/interactions/message-components#component-object} */ export interface APIBaseComponent { /** @@ -1571,7 +1562,7 @@ export interface APIBaseComponent { } /** - * https://discord.com/developers/docs/interactions/message-components#component-object-component-types + * @see {@link https://discord.com/developers/docs/interactions/message-components#component-object-component-types} */ export enum ComponentType { /** @@ -1612,13 +1603,13 @@ export enum ComponentType { /** * Select menu for picking from defined text options * - * @deprecated This is the old name for {@apilink ComponentType#StringSelect} + * @deprecated This is the old name for {@link ComponentType.StringSelect} */ SelectMenu = 3, } /** - * https://discord.com/developers/docs/interactions/message-components#action-rows + * @see {@link https://discord.com/developers/docs/interactions/message-components#action-rows} */ export interface APIActionRowComponent extends APIBaseComponent { @@ -1629,7 +1620,7 @@ export interface APIActionRowComponent } /** - * https://discord.com/developers/docs/interactions/message-components#buttons + * @see {@link https://discord.com/developers/docs/interactions/message-components#buttons} */ export interface APIButtonComponentBase