daenamnu/discord-api-types
1
0
Fork 0
mirror of https://github.com/discordjs/discord-api-types.git synced 2026-05-21 02:40:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: resolve api-extractor warnings (#1205)

Browse Source 
* docs: resolve api-extractor warnings

* docs: solo links

* fix: new changes

* fix: more

* fix: again
This commit is contained in:
Almeida
2025-04-09 20:54:09 +01:00
committed by GitHub
parent 5b6f0d43a4
commit 048772d1f1
266 changed files with 6074 additions and 6022 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
deno/gateway/common.ts
View File

@@ -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;

749
deno/gateway/v10.ts
View File

File diff suppressed because it is too large Load Diff

4
deno/gateway/v8.ts
View File

@@ -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<Pick<APIGuildMember, 'joined_at'>> &
export type GatewayGuildMemberUpdateDispatchData = _Nullable<Pick<APIGuildMember, 'joined_at'>> &
Omit<APIGuildMember, 'deaf' | 'joined_at' | 'mute' | 'user'> &
Partial<Pick<APIGuildMember, 'deaf' | 'mute'>> &
Required<Pick<APIGuildMember, 'user'>> & {

749
deno/gateway/v9.ts
View File

File diff suppressed because it is too large Load Diff

8
deno/globals.ts
View File

@@ -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 = {
/**

10
deno/payloads/common.ts
View File

@@ -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<Record<Locale, string | null>>;
/**
* 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 {
/**

2
deno/payloads/v10/_interactions/_applicationCommands/_chatInput/integer.ts
View File

@@ -6,7 +6,7 @@ import type {
} from './base.ts';
import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts';
interface APIApplicationCommandIntegerOptionBase
export interface APIApplicationCommandIntegerOptionBase
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.Integer> {
/**
* If the option is an `INTEGER` or `NUMBER` type, the minimum value permitted.

2
deno/payloads/v10/_interactions/_applicationCommands/_chatInput/number.ts
View File

@@ -6,7 +6,7 @@ import type {
} from './base.ts';
import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts';
interface APIApplicationCommandNumberOptionBase
export interface APIApplicationCommandNumberOptionBase
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.Number> {
/**
* If the option is an `INTEGER` or `NUMBER` type, the minimum value permitted.

4
deno/payloads/v10/_interactions/_applicationCommands/_chatInput/shared.ts
View File

@@ -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<ValueType = number | string> {
name: string;

2
deno/payloads/v10/_interactions/_applicationCommands/_chatInput/string.ts
View File

@@ -5,7 +5,7 @@ import type {
} from './base.ts';
import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts';
interface APIApplicationCommandStringOptionBase
export interface APIApplicationCommandStringOptionBase
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.String> {
/**
* For option type `STRING`, the minimum allowed length (minimum of `0`, maximum of `6000`).

16
deno/payloads/v10/_interactions/_applicationCommands/chatInput.ts
View File

@@ -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<Type extends InteractionType = InteractionType> =
| APIApplicationCommandInteractionDataBasicOption<Type>
@@ -103,7 +103,7 @@ export type APIApplicationCommandInteractionDataBasicOption<Type extends Interac
| APIApplicationCommandInteractionDataUserOption;
/**
* 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 APIChatInputApplicationCommandInteractionData
extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.ChatInput> {
@@ -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<ApplicationCommandType.ChatInput> {
@@ -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<APIChatInputApplicationCommandInteractionData>;
/**
* 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<APIChatInputApplicationCommandInteraction>;
/**
* 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<APIChatInputApplicationCommandInteraction>;

26
deno/payloads/v10/_interactions/_applicationCommands/contextMenu.ts
View File

@@ -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<ApplicationCommandType.User> {
@@ -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<ApplicationCommandType.Message> {
@@ -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<Snowflake, APIMessage>;
}
/**
* 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<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 APIUserApplicationCommandDMInteraction = APIDMInteractionWrapper<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 APIUserApplicationCommandGuildInteraction =
APIGuildInteractionWrapper<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 APIMessageApplicationCommandInteraction =
APIApplicationCommandInteractionWrapper<APIMessageApplicationCommandInteractionData>;
/**
* 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<APIMessageApplicationCommandInteraction>;
/**
* 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<APIMessageApplicationCommandInteraction>;
/**
* 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

8
deno/payloads/v10/_interactions/_applicationCommands/entryPoint.ts
View File

@@ -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<ApplicationCommandType.PrimaryEntryPoint>;
/**
* 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<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 APIPrimaryEntryPointCommandDMInteraction = APIDMInteractionWrapper<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 APIPrimaryEntryPointCommandGuildInteraction =
APIGuildInteractionWrapper<APIPrimaryEntryPointCommandInteraction>;

8
deno/payloads/v10/_interactions/_applicationCommands/permissions.ts
View File

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

25
deno/payloads/v10/_interactions/applicationCommands.ts
View File

@@ -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<Data extends APIApplicationCommandInteractionData> =
APIBaseInteraction<InteractionType.ApplicationCommand, Data> &
@@ -208,7 +209,7 @@ export type APIApplicationCommandInteractionWrapper<Data extends APIApplicationC
>;
/**
* 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

4
deno/payloads/v10/_interactions/autocomplete.ts
View File

@@ -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<APIApplicationCommandAutocompleteInteraction>;
/**
* 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<APIApplicationCommandAutocompleteInteraction>;

24
deno/payloads/v10/_interactions/base.ts
View File

@@ -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<Type extends InteractionType> {
export interface APIBaseInteractionMetadata<Type extends InteractionType> {
/**
* ID of the interaction
*/
@@ -46,7 +46,7 @@ interface APIBaseInteractionMetadata<Type extends InteractionType> {
}
/**
* 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<InteractionType.ApplicationCommand> {
@@ -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<InteractionType.MessageComponent> {
@@ -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<InteractionType.ModalSubmit> {
/**
@@ -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<Type extends InteractionType, Data> {
/**
@@ -166,7 +166,7 @@ export interface APIBaseInteraction<Type extends InteractionType, Data> {
/**
* 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<T extends ChannelType> 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<Exclude<ChannelType, ThreadChannelType>>
@@ -251,14 +251,14 @@ export type APIInteractionDataResolvedChannel =
Pick<APIThreadChannel, 'parent_id' | 'thread_metadata'>);
/**
* 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<APIGuildMember, 'deaf' | 'mute' | 'user'> {
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<Snowflake, APIUser>;

8
deno/payloads/v10/_interactions/modalSubmit.ts
View File

@@ -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<InteractionType.ModalSubmit, APIModalSubmission> &
Required<Pick<APIBaseInteraction<InteractionType.ModalSubmit, APIModalSubmission>, '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<APIModalSubmitInteraction>;
/**
* 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<APIModalSubmitInteraction>;

13
deno/payloads/v10/_interactions/responses.ts
View File

@@ -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<RESTPostAPIWebhookWithTokenJSONBody, 'avatar_url' | 'username'>;
@@ -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 {
/**

30
deno/payloads/v10/application.ts
View File

@@ -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 {
/**

226
deno/payloads/v10/auditLog.ts
View File

@@ -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<APIRole, 'id' | 'name'>[]>;
export type APIAuditLogChangeKey$Add = APIAuditLogChangeData<'$add', Pick<APIRole, 'id' | 'name'>[]>;
/**
* Returned when role(s) are removed
*/
export type APIAuditLogChangeKey$Remove = AuditLogChangeData<'$remove', Pick<APIRole, 'id' | 'name'>[]>;
export type APIAuditLogChangeKey$Remove = APIAuditLogChangeData<'$remove', Pick<APIRole, 'id' | 'name'>[]>;
/**
* 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 (<insert name of object here>)
* Currently, the only known instance of this is returned when permissions for a command were updated
*/
export type APIAuditLogChangeKeySnowflake = AuditLogChangeData<Snowflake, unknown>;
export type APIAuditLogChangeKeySnowflake = APIAuditLogChangeData<Snowflake, unknown>;
/**
* 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<K extends string, D> {
export interface APIAuditLogChangeData<K extends string, D> {
key: K;
/**
* The new value

22
deno/payloads/v10/autoModeration.ts
View File

@@ -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 {
/**

259
deno/payloads/v10/channel.ts
View File

@@ -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<T extends ChannelType> extends Omit<APIChannelB
/**
* Explicit permission overwrites for members and roles
*
* See https://discord.com/developers/docs/resources/channel#overwrite-object
* @see {@link https://discord.com/developers/docs/resources/channel#overwrite-object}
*/
permission_overwrites?: APIOverwrite[];
/**
@@ -147,13 +147,13 @@ export interface APIVoiceChannelBase<T extends ChannelType>
/**
* 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<T extends ChannelType> extends Omit<APITextBas
/**
* The recipients of the DM
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
recipients?: APIUser[];
}
@@ -245,7 +245,7 @@ export interface APIThreadChannel
}
/**
* https://discord.com/developers/docs/resources/channel#forum-tag-object-forum-tag-structure
* @see {@link https://discord.com/developers/docs/resources/channel#forum-tag-object-forum-tag-structure}
*/
export interface APIGuildForumTag {
/**
@@ -271,7 +271,7 @@ export interface APIGuildForumTag {
}
/**
* https://discord.com/developers/docs/resources/channel#default-reaction-object-default-reaction-structure
* @see {@link https://discord.com/developers/docs/resources/channel#default-reaction-object-default-reaction-structure}
*/
export interface APIGuildForumDefaultReactionEmoji {
/**
@@ -285,7 +285,7 @@ export interface APIGuildForumDefaultReactionEmoji {
}
/**
* https://discord.com/developers/docs/resources/channel/#channel-object-sort-order-types
* @see {@link https://discord.com/developers/docs/resources/channel/#channel-object-sort-order-types}
*/
export enum SortOrderType {
/**
@@ -299,7 +299,7 @@ export enum SortOrderType {
}
/**
* https://discord.com/developers/docs/resources/channel/#channel-object-forum-layout-types
* @see {@link https://discord.com/developers/docs/resources/channel/#channel-object-forum-layout-types}
*/
export enum ForumLayoutType {
/**
@@ -371,7 +371,7 @@ export interface APIGuildForumChannel extends APIThreadOnlyChannel<ChannelType.G
export type APIGuildMediaChannel = APIThreadOnlyChannel<ChannelType.GuildMedia>;
/**
* 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<APIApplication>;
/**
@@ -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<APIMessageActionRowComponent>[];
/**
* 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<T extends ComponentType> {
/**
@@ -1571,7 +1562,7 @@ export interface APIBaseComponent<T extends ComponentType> {
}
/**
* 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<T extends APIActionRowComponentTypes>
extends APIBaseComponent<ComponentType.ActionRow> {
@@ -1629,7 +1620,7 @@ export interface APIActionRowComponent<T extends APIActionRowComponentTypes>
}
/**
* https://discord.com/developers/docs/interactions/message-components#buttons
* @see {@link https://discord.com/developers/docs/interactions/message-components#buttons}
*/
export interface APIButtonComponentBase<Style extends ButtonStyle> extends APIBaseComponent<ComponentType.Button> {
/**
@@ -1696,7 +1687,7 @@ export type APIButtonComponent =
| APIButtonComponentWithURL;
/**
* https://discord.com/developers/docs/interactions/message-components#button-object-button-styles
* @see {@link https://discord.com/developers/docs/interactions/message-components#button-object-button-styles}
*/
export enum ButtonStyle {
Primary = 1,
@@ -1708,7 +1699,7 @@ export enum ButtonStyle {
}
/**
* https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-styles
* @see {@link https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-styles}
*/
export enum TextInputStyle {
Short = 1,
@@ -1716,7 +1707,7 @@ export enum TextInputStyle {
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export interface APIBaseSelectMenuComponent<
T extends
@@ -1737,19 +1728,19 @@ export interface APIBaseSelectMenuComponent<
/**
* The minimum number of items that must be chosen; min 0, max 25
*
* @default 1
* @defaultValue `1`
*/
min_values?: number;
/**
* The maximum number of items that can be chosen; max 25
*
* @default 1
* @defaultValue `1`
*/
max_values?: number;
/**
* Disable the select
*
* @default false
* @defaultValue `false`
*/
disabled?: boolean;
}
@@ -1769,7 +1760,7 @@ export interface APIBaseAutoPopulatedSelectMenuComponent<
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export interface APIStringSelectComponent extends APIBaseSelectMenuComponent<ComponentType.StringSelect> {
/**
@@ -1779,7 +1770,7 @@ export interface APIStringSelectComponent extends APIBaseSelectMenuComponent<Com
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APIUserSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
ComponentType.UserSelect,
@@ -1787,7 +1778,7 @@ export type APIUserSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
>;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APIRoleSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
ComponentType.RoleSelect,
@@ -1795,7 +1786,7 @@ export type APIRoleSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
>;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APIMentionableSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
ComponentType.MentionableSelect,
@@ -1803,7 +1794,7 @@ export type APIMentionableSelectComponent = APIBaseAutoPopulatedSelectMenuCompon
>;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export interface APIChannelSelectComponent
extends APIBaseAutoPopulatedSelectMenuComponent<ComponentType.ChannelSelect, SelectMenuDefaultValueType.Channel> {
@@ -1814,7 +1805,7 @@ export interface APIChannelSelectComponent
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure}
*/
export enum SelectMenuDefaultValueType {
Channel = 'channel',
@@ -1823,7 +1814,7 @@ export enum SelectMenuDefaultValueType {
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure}
*/
export interface APISelectMenuDefaultValue<T extends SelectMenuDefaultValueType> {
type: T;
@@ -1837,7 +1828,7 @@ export type APIAutoPopulatedSelectMenuComponent =
| APIUserSelectComponent;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APISelectMenuComponent =
| APIChannelSelectComponent
@@ -1847,7 +1838,7 @@ export type APISelectMenuComponent =
| APIUserSelectComponent;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure}
*/
export interface APISelectMenuOption {
/**
@@ -1873,7 +1864,7 @@ export interface APISelectMenuOption {
}
/**
* https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure}
*/
export interface APITextInputComponent extends APIBaseComponent<ComponentType.TextInput> {
/**
@@ -1911,7 +1902,7 @@ export interface APITextInputComponent extends APIBaseComponent<ComponentType.Te
}
/**
* https://discord.com/developers/docs/resources/channel#message-snapshot-object
* @see {@link https://discord.com/developers/docs/resources/channel#message-snapshot-object}
*/
export interface APIMessageSnapshot {
/**
@@ -1926,13 +1917,13 @@ export interface APIMessageSnapshot {
*
* It was added in {@link https://github.com/discord/discord-api-docs/pull/6833/commits/d18f72d06d62e6b1d51ca2c1ef308ddc29ff3348 | d18f72d}
* but was later removed before the PR ({@link https://github.com/discord/discord-api-docs/pull/6833 | discord-api-docs#6833}) was merged.
* See {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
* @see {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
*/
guild_id?: Snowflake;
}
/**
* https://discord.com/developers/docs/resources/channel#channel-object-channel-flags
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-flags}
*/
export enum ChannelFlags {
/**
@@ -1975,7 +1966,7 @@ export enum ChannelFlags {
}
/**
* https://discord.com/developers/docs/interactions/message-components#message-components
* @see {@link https://discord.com/developers/docs/interactions/message-components#message-components}
*/
export type APIMessageComponent = APIActionRowComponent<APIMessageActionRowComponent> | APIMessageActionRowComponent;
export type APIModalComponent = APIActionRowComponent<APIModalActionRowComponent> | APIModalActionRowComponent;
@@ -1983,7 +1974,7 @@ export type APIModalComponent = APIActionRowComponent<APIModalActionRowComponent
export type APIActionRowComponentTypes = APIMessageActionRowComponent | APIModalActionRowComponent;
/**
* https://discord.com/developers/docs/interactions/message-components#message-components
* @see {@link https://discord.com/developers/docs/interactions/message-components#message-components}
*/
export type APIMessageActionRowComponent = APIButtonComponent | APISelectMenuComponent;

2
deno/payloads/v10/emoji.ts
View File

@@ -25,7 +25,7 @@ export interface APIPartialEmoji {
}
/**
* https://discord.com/developers/docs/resources/emoji#emoji-object-emoji-structure
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object-emoji-structure}
*/
export interface APIEmoji extends APIPartialEmoji {
/**

69
deno/payloads/v10/gateway.ts
View File

@@ -10,7 +10,7 @@ import type { APIEmoji } from './emoji.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/topics/gateway#get-gateway
* @see {@link https://discord.com/developers/docs/topics/gateway#get-gateway}
*/
export interface APIGatewayInfo {
/**
@@ -20,25 +20,25 @@ export interface APIGatewayInfo {
}
/**
* https://discord.com/developers/docs/topics/gateway#get-gateway-bot
* @see {@link https://discord.com/developers/docs/topics/gateway#get-gateway-bot}
*/
export interface APIGatewayBotInfo extends APIGatewayInfo {
/**
* The recommended number of shards to use when connecting
*
* See https://discord.com/developers/docs/topics/gateway#sharding
* @see {@link https://discord.com/developers/docs/topics/gateway#sharding}
*/
shards: number;
/**
* Information on the current session start limit
*
* See https://discord.com/developers/docs/topics/gateway#session-start-limit-object
* @see {@link https://discord.com/developers/docs/topics/gateway#session-start-limit-object}
*/
session_start_limit: APIGatewaySessionStartLimit;
}
/**
* https://discord.com/developers/docs/topics/gateway#session-start-limit-object
* @see {@link https://discord.com/developers/docs/topics/gateway#session-start-limit-object}
*/
export interface APIGatewaySessionStartLimit {
/**
@@ -60,7 +60,7 @@ export interface APIGatewaySessionStartLimit {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields}
*/
export interface GatewayPresenceUpdate {
/**
@@ -69,7 +69,7 @@ export interface GatewayPresenceUpdate {
* **The user object within this event can be partial, the only field which must be sent is the `id` field,
* everything else is optional.**
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user: Partial<APIUser> & Pick<APIUser, 'id'>;
/**
@@ -83,19 +83,19 @@ export interface GatewayPresenceUpdate {
/**
* User's current 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?: GatewayActivity[];
/**
* User's platform-dependent status
*
* See https://discord.com/developers/docs/topics/gateway-events#client-status-object
* @see {@link https://discord.com/developers/docs/topics/gateway-events#client-status-object}
*/
client_status?: GatewayPresenceClientStatus;
}
/**
* 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}
*/
export enum PresenceUpdateStatus {
Online = 'online',
@@ -111,7 +111,7 @@ export enum PresenceUpdateStatus {
export type PresenceUpdateReceiveStatus = Exclude<PresenceUpdateStatus, PresenceUpdateStatus.Invisible>;
/**
* https://discord.com/developers/docs/topics/gateway-events#client-status-object
* @see {@link https://discord.com/developers/docs/topics/gateway-events#client-status-object}
*/
export interface GatewayPresenceClientStatus {
/**
@@ -129,7 +129,7 @@ export interface GatewayPresenceClientStatus {
}
/**
* 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 interface GatewayActivity {
/**
@@ -145,7 +145,7 @@ export interface GatewayActivity {
/**
* Activity type
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types}
*/
type: ActivityType;
/**
@@ -187,7 +187,7 @@ export interface GatewayActivity {
/**
* The emoji used for a custom status
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji}
*/
emoji?: GatewayActivityEmoji;
/**
@@ -197,19 +197,19 @@ export interface GatewayActivity {
/**
* Information for the current party of the player
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party}
*/
party?: GatewayActivityParty;
/**
* Images for the presence and their hover texts
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets}
*/
assets?: GatewayActivityAssets;
/**
* Secrets for Rich Presence joining and spectating
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets}
*/
secrets?: GatewayActivitySecrets;
/**
@@ -219,9 +219,8 @@ export interface GatewayActivity {
/**
* Activity flags `OR`d together, describes what the payload includes
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags}
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
flags?: ActivityFlags;
/**
@@ -246,37 +245,37 @@ export enum ActivityPlatform {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types}
*/
export enum ActivityType {
/**
* Playing {game}
* Playing \{game\}
*/
Playing,
/**
* Streaming {details}
* Streaming \{details\}
*/
Streaming,
/**
* Listening to {name}
* Listening to \{name\}
*/
Listening,
/**
* Watching {details}
* Watching \{details\}
*/
Watching,
/**
* {emoji} {state}
* \{emoji\} \{state\}
*/
Custom,
/**
* Competing in {name}
* Competing in \{name\}
*/
Competing,
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-timestamps
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-timestamps}
*/
export interface GatewayActivityTimestamps {
/**
@@ -290,12 +289,12 @@ export interface GatewayActivityTimestamps {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji}
*/
export type GatewayActivityEmoji = Partial<Pick<APIEmoji, 'animated' | 'id'>> & Pick<APIEmoji, 'name'>;
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party}
*/
export interface GatewayActivityParty {
/**
@@ -309,19 +308,19 @@ export interface GatewayActivityParty {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets}
*/
export type GatewayActivityAssets = Partial<
Record<'large_image' | 'large_text' | 'small_image' | 'small_text', string>
>;
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets}
*/
export type GatewayActivitySecrets = Partial<Record<'join' | 'match' | 'spectate', string>>;
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags}
*/
export enum ActivityFlags {
Instance = 1 << 0,
@@ -347,7 +346,7 @@ export interface GatewayActivityButton {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#thread-list-sync-thread-list-sync-event-fields
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync-thread-list-sync-event-fields}
*/
export interface GatewayThreadListSync {
/**
@@ -369,7 +368,7 @@ export interface GatewayThreadListSync {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#thread-members-update-thread-members-update-event-fields
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update-thread-members-update-event-fields}
*/
export interface GatewayThreadMembersUpdate {
/**

146
deno/payloads/v10/guild.ts
View File

@@ -12,7 +12,7 @@ import type { APISticker } from './sticker.ts';
import type { APIAvatarDecorationData, APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/guild#unavailable-guild-object
* @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object}
*/
export interface APIUnavailableGuild {
/**
@@ -26,7 +26,7 @@ export interface APIUnavailableGuild {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
*/
export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'>, Pick<APIGuild, 'welcome_screen'> {
/**
@@ -36,19 +36,19 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
/**
* Icon hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon: string | null;
/**
* Splash hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
splash: string | null;
/**
* Banner hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
banner?: string | null;
/**
@@ -58,13 +58,13 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
/**
* Enabled guild features
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
features?: GuildFeature[];
/**
* Verification level required for the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
verification_level?: GuildVerificationLevel;
/**
@@ -74,19 +74,19 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
*/
export interface APIGuild extends APIPartialGuild {
/**
* Icon hash, returned when in the template object
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon_hash?: string | null;
/**
* Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
discovery_splash: string | null;
/**
@@ -104,14 +104,13 @@ export interface APIGuild extends APIPartialGuild {
*
* **This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds**
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
permissions?: Permissions;
/**
* Voice region id for the guild
*
* See https://discord.com/developers/docs/resources/voice#voice-region-object
*
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
* @deprecated This field has been deprecated in favor of `rtc_region` on the channel.
*/
region: string;
@@ -134,43 +133,43 @@ export interface APIGuild extends APIPartialGuild {
/**
* Verification level required for the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
verification_level: GuildVerificationLevel;
/**
* Default message notifications level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level}
*/
default_message_notifications: GuildDefaultMessageNotifications;
/**
* Explicit content filter level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level}
*/
explicit_content_filter: GuildExplicitContentFilter;
/**
* Roles in the guild
*
* See https://discord.com/developers/docs/topics/permissions#role-object
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
roles: APIRole[];
/**
* Custom guild emojis
*
* See https://discord.com/developers/docs/resources/emoji#emoji-object
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
*/
emojis: APIEmoji[];
/**
* Enabled guild features
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
features: GuildFeature[];
/**
* Required MFA level for the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-mfa-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-mfa-level}
*/
mfa_level: GuildMFALevel;
/**
@@ -184,7 +183,7 @@ export interface APIGuild extends APIPartialGuild {
/**
* System channel flags
*
* See https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags}
*/
system_channel_flags: GuildSystemChannelFlags;
/**
@@ -210,13 +209,13 @@ export interface APIGuild extends APIPartialGuild {
/**
* Banner hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
banner: string | null;
/**
* Premium tier (Server Boost level)
*
* See https://discord.com/developers/docs/resources/guild#guild-object-premium-tier
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-premium-tier}
*/
premium_tier: GuildPremiumTier;
/**
@@ -226,7 +225,7 @@ export interface APIGuild extends APIPartialGuild {
/**
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
*
* @default "en-US"
* @defaultValue `"en-US"`
*/
preferred_locale: Locale;
/**
@@ -260,13 +259,13 @@ export interface APIGuild extends APIPartialGuild {
/**
* The nsfw level of the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level}
*/
nsfw_level: GuildNSFWLevel;
/**
* Custom guild stickers
*
* See https://discord.com/developers/docs/resources/sticker#sticker-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object}
*/
stickers: APISticker[];
/**
@@ -288,20 +287,20 @@ export interface APIGuild extends APIPartialGuild {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
*/
export interface APIPartialInteractionGuild extends Pick<APIGuild, 'features' | 'id'> {
/**
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
*
* @unstable https://github.com/discord/discord-api-docs/issues/6938
* @default "en-US"
* @defaultValue `"en-US"`
*/
locale: Locale;
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level}
*/
export enum GuildDefaultMessageNotifications {
AllMessages,
@@ -309,7 +308,7 @@ export enum GuildDefaultMessageNotifications {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level}
*/
export enum GuildExplicitContentFilter {
Disabled,
@@ -318,7 +317,7 @@ export enum GuildExplicitContentFilter {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-mfa-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-mfa-level}
*/
export enum GuildMFALevel {
None,
@@ -326,7 +325,7 @@ export enum GuildMFALevel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level}
*/
export enum GuildNSFWLevel {
Default,
@@ -336,7 +335,7 @@ export enum GuildNSFWLevel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
export enum GuildVerificationLevel {
/**
@@ -362,7 +361,7 @@ export enum GuildVerificationLevel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-premium-tier
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-premium-tier}
*/
export enum GuildPremiumTier {
None,
@@ -378,7 +377,7 @@ export enum GuildHubType {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags}
*/
export enum GuildSystemChannelFlags {
/**
@@ -408,7 +407,7 @@ export enum GuildSystemChannelFlags {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
export enum GuildFeature {
/**
@@ -422,7 +421,7 @@ export enum GuildFeature {
/**
* Guild is using the old permissions configuration behavior
*
* See https://discord.com/developers/docs/change-log#upcoming-application-command-permission-changes
* @see {@link https://discord.com/developers/docs/change-log#upcoming-application-command-permission-changes}
*/
ApplicationCommandPermissionsV2 = 'APPLICATION_COMMAND_PERMISSIONS_V2',
/**
@@ -464,8 +463,7 @@ export enum GuildFeature {
/**
* Guild is a Student Hub
*
* See https://support.discord.com/hc/articles/4406046651927
*
* @see {@link https://support.discord.com/hc/articles/4406046651927}
* @unstable This feature is currently not documented by Discord, but has known value
*/
Hub = 'HUB',
@@ -480,8 +478,7 @@ export enum GuildFeature {
/**
* Guild is in a Student Hub
*
* See https://support.discord.com/hc/articles/4406046651927
*
* @see {@link https://support.discord.com/hc/articles/4406046651927}
* @unstable This feature is currently not documented by Discord, but has known value
*/
LinkedToHub = 'LINKED_TO_HUB',
@@ -563,7 +560,7 @@ export enum GuildFeature {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-preview-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-preview-object}
*/
export interface APIGuildPreview {
/**
@@ -577,31 +574,31 @@ export interface APIGuildPreview {
/**
* Icon hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon: string | null;
/**
* Splash hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
splash: string | null;
/**
* Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
discovery_splash: string | null;
/**
* Custom guild emojis
*
* See https://discord.com/developers/docs/resources/emoji#emoji-object
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
*/
emojis: APIEmoji[];
/**
* Enabled guild features
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
features: GuildFeature[];
/**
@@ -623,7 +620,7 @@ export interface APIGuildPreview {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object}
*/
export interface APIGuildWidgetSettings {
/**
@@ -637,7 +634,7 @@ export interface APIGuildWidgetSettings {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-member-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
*/
export interface APIGuildMember {
/**
@@ -645,7 +642,7 @@ export interface APIGuildMember {
*
* **This field won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events.**
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user: APIUser;
/**
@@ -663,7 +660,7 @@ export interface APIGuildMember {
/**
* Array of role object ids
*
* See https://discord.com/developers/docs/topics/permissions#role-object
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
roles: Snowflake[];
/**
@@ -673,7 +670,7 @@ export interface APIGuildMember {
/**
* When the user started boosting the guild
*
* See https://support.discord.com/hc/articles/360028038352
* @see {@link https://support.discord.com/hc/articles/360028038352}
*/
premium_since?: string | null;
/**
@@ -701,13 +698,13 @@ export interface APIGuildMember {
/**
* The data for the member's guild avatar decoration
*
* See https://discord.com/developers/docs/resources/user#avatar-decoration-data-object
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
*/
avatar_decoration_data?: APIAvatarDecorationData | null;
}
/**
* https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags}
*/
export enum GuildMemberFlags {
/**
@@ -744,6 +741,7 @@ export enum GuildMemberFlags {
AutomodQuarantinedUsernameOrGuildNickname = 1 << 7,
/**
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/7113 | discord-api-docs#7113}
*/
AutomodQuarantinedBio = 1 << 8,
/**
@@ -753,7 +751,7 @@ export enum GuildMemberFlags {
}
/**
* https://discord.com/developers/docs/resources/guild#integration-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object}
*/
export interface APIGuildIntegration {
/**
@@ -795,7 +793,7 @@ export interface APIGuildIntegration {
*
* **This field is not provided for `discord` bot integrations.**
*
* See https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors}
*/
expire_behavior?: IntegrationExpireBehavior;
/**
@@ -809,13 +807,13 @@ export interface APIGuildIntegration {
*
* **Some older integrations may not have an attached user.**
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user?: APIUser;
/**
* Integration account information
*
* See https://discord.com/developers/docs/resources/guild#integration-account-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-account-object}
*/
account: APIIntegrationAccount;
/**
@@ -839,7 +837,7 @@ export interface APIGuildIntegration {
/**
* The bot/OAuth2 application for discord integrations
*
* See https://discord.com/developers/docs/resources/guild#integration-application-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-application-object}
*
* **This field is not provided for `discord` bot integrations.**
*/
@@ -853,7 +851,7 @@ export interface APIGuildIntegration {
export type APIGuildIntegrationType = 'discord' | 'guild_subscription' | 'twitch' | 'youtube';
/**
* https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors}
*/
export enum IntegrationExpireBehavior {
RemoveRole,
@@ -861,7 +859,7 @@ export enum IntegrationExpireBehavior {
}
/**
* https://discord.com/developers/docs/resources/guild#integration-account-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-account-object}
*/
export interface APIIntegrationAccount {
/**
@@ -875,7 +873,7 @@ export interface APIIntegrationAccount {
}
/**
* https://discord.com/developers/docs/resources/guild#integration-application-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-application-object}
*/
export interface APIGuildIntegrationApplication {
/**
@@ -889,7 +887,7 @@ export interface APIGuildIntegrationApplication {
/**
* The icon hash of the app
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon: string | null;
/**
@@ -899,13 +897,13 @@ export interface APIGuildIntegrationApplication {
/**
* The bot associated with this application
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
bot?: APIUser;
}
/**
* https://discord.com/developers/docs/resources/guild#ban-object
* @see {@link https://discord.com/developers/docs/resources/guild#ban-object}
*/
export interface APIBan {
/**
@@ -919,7 +917,7 @@ export interface APIBan {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object}
*/
export interface APIGuildWidget {
id: Snowflake;
@@ -931,7 +929,7 @@ export interface APIGuildWidget {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget}
*/
export interface APIGuildWidgetChannel {
id: Snowflake;
@@ -940,7 +938,7 @@ export interface APIGuildWidgetChannel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget}
*/
export interface APIGuildWidgetMember {
id: string;
@@ -953,7 +951,7 @@ export interface APIGuildWidgetMember {
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-widget-image-widget-style-options
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-image-widget-style-options}
*/
export enum GuildWidgetStyle {
/**
@@ -1053,7 +1051,7 @@ export enum MembershipScreeningFieldType {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure}
*/
export interface APIGuildOnboarding {
/**
@@ -1079,7 +1077,7 @@ export interface APIGuildOnboarding {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure}
*/
export interface APIGuildOnboardingPrompt {
/**
@@ -1114,7 +1112,7 @@ export interface APIGuildOnboardingPrompt {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure}
*/
export interface APIGuildOnboardingPromptOption {
/**
@@ -1144,7 +1142,7 @@ export interface APIGuildOnboardingPromptOption {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode}
*/
export enum GuildOnboardingMode {
/**
@@ -1158,7 +1156,7 @@ export enum GuildOnboardingMode {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types}
*/
export enum GuildOnboardingPromptType {
MultipleChoice,

35
deno/payloads/v10/guildScheduledEvent.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildMember } from './guild.ts';
import type { APIUser } from './user.ts';
interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType> {
export interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType> {
/**
* The id of the guild event
*/
@@ -74,7 +74,7 @@ interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure}
*/
export interface APIGuildScheduledEventRecurrenceRule {
/**
@@ -91,7 +91,7 @@ export interface APIGuildScheduledEventRecurrenceRule {
frequency: GuildScheduledEventRecurrenceRuleFrequency;
/**
* The spacing between the events, defined by `frequency`.
* For example, `frequency` of {@apilink GuildScheduledEventRecurrenceRuleFrequency#Weekly} and an `interval` of `2`
* For example, `frequency` of {@link GuildScheduledEventRecurrenceRuleFrequency.Weekly} and an `interval` of `2`
* would be "every-other week"
*/
interval: number;
@@ -102,7 +102,7 @@ export interface APIGuildScheduledEventRecurrenceRule {
/**
* List of specific days within a specific week (1-5) to recur on
*/
by_n_weekday: GuildScheduledEventRecurrenceRuleNWeekday[] | null;
by_n_weekday: APIGuildScheduledEventRecurrenceRuleNWeekday[] | null;
/**
* Set of specific months to recur on
*/
@@ -122,7 +122,7 @@ export interface APIGuildScheduledEventRecurrenceRule {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-frequency
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-frequency}
*/
export enum GuildScheduledEventRecurrenceRuleFrequency {
Yearly,
@@ -132,7 +132,7 @@ export enum GuildScheduledEventRecurrenceRuleFrequency {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday}
*/
export enum GuildScheduledEventRecurrenceRuleWeekday {
Monday,
@@ -145,7 +145,7 @@ export enum GuildScheduledEventRecurrenceRuleWeekday {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-month
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-month}
*/
export enum GuildScheduledEventRecurrenceRuleMonth {
January = 1,
@@ -163,9 +163,9 @@ export enum GuildScheduledEventRecurrenceRuleMonth {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-nweekday-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-nweekday-structure}
*/
export interface GuildScheduledEventRecurrenceRuleNWeekday {
export interface APIGuildScheduledEventRecurrenceRuleNWeekday {
/**
* The week to reoccur on.
*/
@@ -176,6 +176,11 @@ export interface GuildScheduledEventRecurrenceRuleNWeekday {
day: GuildScheduledEventRecurrenceRuleWeekday;
}
/**
* @deprecated Use {@link APIGuildScheduledEventRecurrenceRuleNWeekday} instead
*/
export type GuildScheduledEventRecurrenceRuleNWeekday = APIGuildScheduledEventRecurrenceRuleNWeekday;
export interface APIStageInstanceGuildScheduledEvent
extends APIGuildScheduledEventBase<GuildScheduledEventEntityType.StageInstance> {
channel_id: Snowflake;
@@ -194,7 +199,7 @@ export interface APIExternalGuildScheduledEvent
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure}
*/
export type APIGuildScheduledEvent =
| APIExternalGuildScheduledEvent
@@ -202,7 +207,7 @@ export type APIGuildScheduledEvent =
| APIVoiceGuildScheduledEvent;
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata}
*/
export interface APIGuildScheduledEventEntityMetadata {
/**
@@ -212,7 +217,7 @@ export interface APIGuildScheduledEventEntityMetadata {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types}
*/
export enum GuildScheduledEventEntityType {
StageInstance = 1,
@@ -221,7 +226,7 @@ export enum GuildScheduledEventEntityType {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status}
*/
export enum GuildScheduledEventStatus {
Scheduled = 1,
@@ -231,7 +236,7 @@ export enum GuildScheduledEventStatus {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level}
*/
export enum GuildScheduledEventPrivacyLevel {
/**
@@ -241,7 +246,7 @@ export enum GuildScheduledEventPrivacyLevel {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure}
*/
export interface APIGuildScheduledEventUser {
/**

6
deno/payloads/v10/interactions.ts
View File

@@ -29,7 +29,7 @@ export * from './_interactions/ping.ts';
export * from './_interactions/responses.ts';
/**
* 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 APIInteraction =
| APIApplicationCommandAutocompleteInteraction
@@ -39,7 +39,7 @@ export type APIInteraction =
| APIPingInteraction;
/**
* 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 APIDMInteraction =
| APIApplicationCommandAutocompleteDMInteraction
@@ -48,7 +48,7 @@ export type APIDMInteraction =
| APIModalSubmitDMInteraction;
/**
* 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 APIGuildInteraction =
| APIApplicationCommandAutocompleteGuildInteraction

21
deno/payloads/v10/invite.ts
View File

@@ -25,7 +25,7 @@ export type APIInviteGuild = Pick<
>;
/**
* https://discord.com/developers/docs/resources/invite#invite-object
* @see {@link https://discord.com/developers/docs/resources/invite#invite-object}
*/
export interface APIInvite {
/**
@@ -35,37 +35,37 @@ export interface APIInvite {
/**
* The guild this invite is for
*
* See https://discord.com/developers/docs/resources/guild#guild-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object}
*/
guild?: APIInviteGuild;
/**
* The channel this invite is for
*
* See https://discord.com/developers/docs/resources/channel#channel-object
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
*/
channel: Required<APIPartialChannel> | null;
/**
* The user who 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;
/**
* 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;
/**
* The embedded application to open for this voice channel embedded application invite
*
* See https://discord.com/developers/docs/resources/application#application-object
* @see {@link https://discord.com/developers/docs/resources/application#application-object}
*/
target_application?: Partial<APIApplication>;
/**
@@ -84,6 +84,7 @@ export interface APIInvite {
* The stage instance data if there is a public stage instance in the stage channel this invite is for
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
*/
stage_instance?: APIInviteStageInstance;
/**
@@ -97,7 +98,7 @@ export interface APIInvite {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-object-invite-types
* @see {@link https://discord.com/developers/docs/resources/invite#invite-object-invite-types}
*/
export enum InviteType {
Guild,
@@ -106,7 +107,7 @@ export enum InviteType {
}
/**
* 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}
*/
export enum InviteTargetType {
Stream = 1,
@@ -114,7 +115,7 @@ export enum InviteTargetType {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-metadata-object
* @see {@link https://discord.com/developers/docs/resources/invite#invite-metadata-object}
*/
export interface APIExtendedInvite extends APIInvite {
/**

16
deno/payloads/v10/monetization.ts
View File

@@ -1,7 +1,7 @@
import type { Snowflake } from '../../globals.ts';
/**
* https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-structure
* @see {@link https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-structure}
*/
export interface APIEntitlement {
/**
@@ -47,7 +47,7 @@ export interface APIEntitlement {
}
/**
* https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-types
* @see {@link https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-types}
*/
export enum EntitlementType {
/**
@@ -85,7 +85,7 @@ export enum EntitlementType {
}
/**
* https://discord.com/developers/docs/monetization/skus#sku-object-sku-structure
* @see {@link https://discord.com/developers/docs/monetization/skus#sku-object-sku-structure}
*/
export interface APISKU {
/**
@@ -111,13 +111,13 @@ export interface APISKU {
/**
* SKU flags combined as a bitfield
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
flags: SKUFlags;
}
/**
* https://discord.com/developers/docs/monetization/skus#sku-object-sku-flags
* @see {@link https://discord.com/developers/docs/monetization/skus#sku-object-sku-flags}
*/
export enum SKUFlags {
/**
@@ -136,7 +136,7 @@ export enum SKUFlags {
}
/**
* https://discord.com/developers/docs/resources/sku#sku-object-sku-types
* @see {@link https://discord.com/developers/docs/resources/sku#sku-object-sku-types}
*/
export enum SKUType {
/**
@@ -158,7 +158,7 @@ export enum SKUType {
}
/**
* https://discord.com/developers/docs/resources/subscription#subscription-object
* @see {@link https://discord.com/developers/docs/resources/subscription#subscription-object}
*/
export interface APISubscription {
/**
@@ -204,7 +204,7 @@ export interface APISubscription {
}
/**
* https://discord.com/developers/docs/resources/subscription#subscription-statuses
* @see {@link https://discord.com/developers/docs/resources/subscription#subscription-statuses}
*/
export enum SubscriptionStatus {
/**

34
deno/payloads/v10/oauth2.ts
View File

@@ -8,10 +8,10 @@ export enum OAuth2Scopes {
*/
Bot = 'bot',
/**
* Allows [/users/@me/connections](https://discord.com/developers/docs/resources/user#get-user-connections)
* Allows {@link https://discord.com/developers/docs/resources/user#get-user-connections | `/users/@me/connections`}
* to return linked third-party accounts
*
* See https://discord.com/developers/docs/resources/user#get-user-connections
* @see {@link https://discord.com/developers/docs/resources/user#get-user-connections}
*/
Connections = 'connections',
/**
@@ -19,41 +19,41 @@ export enum OAuth2Scopes {
*/
DMChannelsRead = 'dm_channels.read',
/**
* Enables [/users/@me](https://discord.com/developers/docs/resources/user#get-current-user) to return an `email`
* Enables {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} to return an `email`
*
* See https://discord.com/developers/docs/resources/user#get-current-user
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
Email = 'email',
/**
* Allows [/users/@me](https://discord.com/developers/docs/resources/user#get-current-user) without `email`
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} without `email`
*
* See https://discord.com/developers/docs/resources/user#get-current-user
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
Identify = 'identify',
/**
* Allows [/users/@me/guilds](https://discord.com/developers/docs/resources/user#get-current-user-guilds)
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds | `/users/@me/guilds`}
* to return basic information about all of a user's guilds
*
* See https://discord.com/developers/docs/resources/user#get-current-user-guilds
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
*/
Guilds = 'guilds',
/**
* Allows [/guilds/{guild.id}/members/{user.id}](https://discord.com/developers/docs/resources/guild#add-guild-member)
* Allows {@link https://discord.com/developers/docs/resources/guild#add-guild-member | `/guilds/[guild.id]/members/[user.id]`}
* to be used for joining users to a guild
*
* See https://discord.com/developers/docs/resources/guild#add-guild-member
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}
*/
GuildsJoin = 'guilds.join',
/**
* Allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
* Allows /users/\@me/guilds/\{guild.id\}/member to return a user's member information in a guild
*
* See https://discord.com/developers/docs/resources/user#get-current-user-guild-member
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guild-member}
*/
GuildsMembersRead = 'guilds.members.read',
/**
* Allows your app to join users to a group dm
*
* See https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
* @see {@link https://discord.com/developers/docs/resources/channel#group-dm-add-recipient}
*/
GroupDMJoins = 'gdm.join',
/**
@@ -120,25 +120,25 @@ export enum OAuth2Scopes {
/**
* Allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
*
* See https://discord.com/developers/docs/game-sdk/activities
* @see {@link https://discord.com/developers/docs/game-sdk/activities}
*/
ActivitiesWrite = 'activities.write',
/**
* Allows your app to use Application Commands in a guild
*
* See https://discord.com/developers/docs/interactions/application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
ApplicationsCommands = 'applications.commands',
/**
* Allows your app to update its Application Commands via this bearer token - client credentials grant only
*
* See https://discord.com/developers/docs/interactions/application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
ApplicationsCommandsUpdate = 'applications.commands.update',
/**
* Allows your app to update permissions for its commands using a Bearer token - client credentials grant only
*
* See https://discord.com/developers/docs/interactions/application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
ApplicationCommandsPermissionsUpdate = 'applications.commands.permissions.update',
}

8
deno/payloads/v10/permissions.ts
View File

@@ -5,7 +5,7 @@
import type { Permissions, Snowflake } from '../../globals.ts';
/**
* https://discord.com/developers/docs/topics/permissions#role-object
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
export interface APIRole {
/**
@@ -39,7 +39,7 @@ export interface APIRole {
/**
* Permission bit set
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
permissions: Permissions;
/**
@@ -61,7 +61,7 @@ export interface APIRole {
}
/**
* https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure}
*/
export interface APIRoleTags {
/**
@@ -91,7 +91,7 @@ export interface APIRoleTags {
}
/**
* https://discord.com/developers/docs/topics/permissions#role-object-role-flags
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object-role-flags}
*/
export enum RoleFlags {
/**

16
deno/payloads/v10/poll.ts
View File

@@ -5,7 +5,7 @@
import type { APIPartialEmoji } from './emoji.ts';
/**
* https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure}
*/
export interface APIPoll {
/**
@@ -23,13 +23,13 @@ export interface APIPoll {
/**
* Whether a user can select multiple answers
*
* @default false
* @defaultValue `false`
*/
allow_multiselect: boolean;
/**
* The layout type of the poll
*
* @default PollLayoutType.Default
* @defaultValue `PollLayoutType.Default`
*/
layout_type: PollLayoutType;
/**
@@ -39,7 +39,7 @@ export interface APIPoll {
}
/**
* https://discord.com/developers/docs/resources/poll#layout-type
* @see {@link https://discord.com/developers/docs/resources/poll#layout-type}
*/
export enum PollLayoutType {
/**
@@ -49,7 +49,7 @@ export enum PollLayoutType {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-media-object-poll-media-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-media-object-poll-media-object-structure}
*/
export interface APIPollMedia {
/**
@@ -65,7 +65,7 @@ export interface APIPollMedia {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure}
*/
export interface APIPollAnswer {
/**
@@ -79,7 +79,7 @@ export interface APIPollAnswer {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure}
*/
export interface APIPollResults {
/**
@@ -93,7 +93,7 @@ export interface APIPollResults {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-results-object-poll-answer-count-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-results-object-poll-answer-count-object-structure}
*/
export interface APIPollAnswerCount {
/**

2
deno/payloads/v10/soundboard.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object
* @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object}
*/
export interface APISoundboardSound {
/**

14
deno/payloads/v10/stageInstance.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildMember } from './guild.ts';
/**
* https://discord.com/developers/docs/resources/stage-instance#stage-instance-object
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object}
*/
export interface APIStageInstance {
/**
@@ -24,13 +24,14 @@ export interface APIStageInstance {
/**
* The privacy level of the stage instance
*
* See https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level}
*/
privacy_level: StageInstancePrivacyLevel;
/**
* Whether or not stage discovery is disabled
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
*/
discoverable_disabled: boolean;
/**
@@ -40,13 +41,14 @@ export interface APIStageInstance {
}
/**
* https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level}
*/
export enum StageInstancePrivacyLevel {
/**
* The stage instance is visible publicly, such as on stage discovery
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
*/
Public = 1,
/**
@@ -56,7 +58,9 @@ export enum StageInstancePrivacyLevel {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure
* @see {@link https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure}
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
*/
export interface APIInviteStageInstance {
/**
@@ -74,7 +78,7 @@ export interface APIInviteStageInstance {
/**
* The members speaking in the stage
*
* See https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure}
*/
members: APIGuildMember[];
}

16
deno/payloads/v10/sticker.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/sticker#sticker-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object}
*/
export interface APISticker {
/**
@@ -32,20 +32,20 @@ export interface APISticker {
/**
* Previously the sticker asset hash, now an empty string
*
* @deprecated
* @deprecated This field is no longer documented by Discord and will be removed in v11
* @unstable This field is no longer documented by Discord and will be removed in v11
*/
asset?: '';
/**
* Type of sticker
*
* See https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types}
*/
type: StickerType;
/**
* Type of sticker format
*
* See https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types}
*/
format_type: StickerFormatType;
/**
@@ -67,7 +67,7 @@ export interface APISticker {
}
/**
* https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types}
*/
export enum StickerType {
/**
@@ -81,7 +81,7 @@ export enum StickerType {
}
/**
* https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types}
*/
export enum StickerFormatType {
PNG = 1,
@@ -91,12 +91,12 @@ export enum StickerFormatType {
}
/**
* https://discord.com/developers/docs/resources/sticker#sticker-item-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-item-object}
*/
export type APIStickerItem = Pick<APISticker, 'format_type' | 'id' | 'name'>;
/**
* https://discord.com/developers/docs/resources/sticker#sticker-pack-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-pack-object}
*/
export interface APIStickerPack {
/**

16
deno/payloads/v10/teams.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/topics/teams#data-models-team-object
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-team-object}
*/
export interface APITeam {
/**
@@ -32,19 +32,19 @@ export interface APITeam {
}
/**
* https://discord.com/developers/docs/topics/teams#data-models-team-member-object
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-team-member-object}
*/
export interface APITeamMember {
/**
* The user's membership state on the team
*
* See https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum}
*/
membership_state: TeamMemberMembershipState;
/**
* Will always be `["*"]`
*
* @deprecated Use `role` instead
* @deprecated Use {@link APITeamMember.role} instead.
*/
permissions: ['*'];
/**
@@ -54,19 +54,19 @@ export interface APITeamMember {
/**
* The avatar, discriminator, id, and username of the user
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user: APIUser;
/**
* The user's role in the team.
*
* See https://discord.com/developers/docs/topics/teams#team-member-roles
* @see {@link https://discord.com/developers/docs/topics/teams#team-member-roles}
*/
role: TeamMemberRole;
}
/**
* https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum}
*/
export enum TeamMemberMembershipState {
Invited = 1,
@@ -74,7 +74,7 @@ export enum TeamMemberMembershipState {
}
/**
* https://discord.com/developers/docs/topics/teams#team-member-roles-team-member-role-types
* @see {@link https://discord.com/developers/docs/topics/teams#team-member-roles-team-member-role-types}
*/
export enum TeamMemberRole {
Admin = 'admin',

4
deno/payloads/v10/template.ts
View File

@@ -8,7 +8,7 @@ import type { RESTPostAPIGuildsJSONBody } from '../../rest/v10/mod.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/guild-template#guild-template-object
* @see {@link https://discord.com/developers/docs/resources/guild-template#guild-template-object}
*/
export interface APITemplate {
/**
@@ -34,7 +34,7 @@ export interface APITemplate {
/**
* The user who created the template
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
creator: APIUser;
/**

53
deno/payloads/v10/user.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildIntegration } from './guild.ts';
/**
* https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
export interface APIUser {
/**
@@ -28,7 +28,7 @@ export interface APIUser {
/**
* The user's avatar hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
avatar: string | null;
/**
@@ -46,7 +46,7 @@ export interface APIUser {
/**
* The user's banner hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
banner?: string | null;
/**
@@ -68,39 +68,38 @@ export interface APIUser {
/**
* The flags on a user's account
*
* See https://discord.com/developers/docs/resources/user#user-object-user-flags
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-flags}
*/
flags?: UserFlags;
/**
* The type of Nitro subscription on a user's account
*
* See https://discord.com/developers/docs/resources/user#user-object-premium-types
* @see {@link https://discord.com/developers/docs/resources/user#user-object-premium-types}
*/
premium_type?: UserPremiumType;
/**
* The public flags on a user's account
*
* See https://discord.com/developers/docs/resources/user#user-object-user-flags
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-flags}
*/
public_flags?: UserFlags;
/**
* The user's avatar decoration hash
*
* See https://discord.com/developers/docs/reference#image-formatting
*
* @deprecated Use `avatar_decoration_data` instead
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
* @deprecated Use {@link APIUser.avatar_decoration_data} instead
*/
avatar_decoration?: string | null;
/**
* The data for the user's avatar decoration
*
* See https://discord.com/developers/docs/resources/user#avatar-decoration-data-object
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
*/
avatar_decoration_data?: APIAvatarDecorationData | null;
}
/**
* https://discord.com/developers/docs/resources/user#user-object-user-flags
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-flags}
*/
export enum UserFlags {
/**
@@ -144,7 +143,7 @@ export enum UserFlags {
*/
PremiumEarlySupporter = 1 << 9,
/**
* User is a [team](https://discord.com/developers/docs/topics/teams)
* User is a {@link https://discord.com/developers/docs/topics/teams | team}
*/
TeamPseudoUser = 1 << 10,
/**
@@ -168,7 +167,7 @@ export enum UserFlags {
*/
CertifiedModerator = 1 << 18,
/**
* Bot uses only [HTTP interactions](https://discord.com/developers/docs/interactions/receiving-and-responding#receiving-an-interaction) and is shown in the online member list
* Bot uses only {@link https://discord.com/developers/docs/interactions/receiving-and-responding#receiving-an-interaction | HTTP interactions} and is shown in the online member list
*/
BotHTTPInteractions = 1 << 19,
/**
@@ -182,36 +181,36 @@ export enum UserFlags {
*/
DisablePremium = 1 << 21,
/**
* User is an [Active Developer](https://support-dev.discord.com/hc/articles/10113997751447)
* User is an {@link https://support-dev.discord.com/hc/articles/10113997751447 | Active Developer}
*/
ActiveDeveloper = 1 << 22,
/**
* User's account has been [quarantined](https://support.discord.com/hc/articles/6461420677527) based on recent activity
* User's account has been {@link https://support.discord.com/hc/articles/6461420677527 | quarantined} based on recent activity
*
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
* @privateRemarks
*
* This value would be 1 << 44, but bit shifting above 1 << 30 requires bigints
* This value would be `1 << 44`, but bit shifting above `1 << 30` requires bigints
*/
Quarantined = 17_592_186_044_416,
/**
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
* @privateRemarks
*
* This value would be 1 << 50, but bit shifting above 1 << 30 requires bigints
* This value would be `1 << 50`, but bit shifting above `1 << 30` requires bigints
*/
Collaborator = 1_125_899_906_842_624,
/**
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
* @privateRemarks
*
* This value would be 1 << 51, but bit shifting above 1 << 30 requires bigints
* This value would be `1 << 51`, but bit shifting above `1 << 30` requires bigints
*/
RestrictedCollaborator = 2_251_799_813_685_248,
}
/**
* https://discord.com/developers/docs/resources/user#user-object-premium-types
* @see {@link https://discord.com/developers/docs/resources/user#user-object-premium-types}
*/
export enum UserPremiumType {
None,
@@ -221,7 +220,7 @@ export enum UserPremiumType {
}
/**
* https://discord.com/developers/docs/resources/user#connection-object
* @see {@link https://discord.com/developers/docs/resources/user#connection-object}
*/
export interface APIConnection {
/**
@@ -235,7 +234,7 @@ export interface APIConnection {
/**
* The service of the connection
*
* See https://discord.com/developers/docs/resources/user#connection-object-services
* @see {@link https://discord.com/developers/docs/resources/user#connection-object-services}
*/
type: ConnectionService;
/**
@@ -245,7 +244,7 @@ export interface APIConnection {
/**
* An array of partial server integrations
*
* See https://discord.com/developers/docs/resources/guild#integration-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object}
*/
integrations?: Partial<APIGuildIntegration>[];
/**
@@ -267,7 +266,7 @@ export interface APIConnection {
/**
* Visibility of this connection
*
* See https://discord.com/developers/docs/resources/user#connection-object-visibility-types
* @see {@link https://discord.com/developers/docs/resources/user#connection-object-visibility-types}
*/
visibility: ConnectionVisibility;
}
@@ -298,7 +297,7 @@ export enum ConnectionService {
Twitch = 'twitch',
X = 'twitter',
/**
* @deprecated This is the old name for {@apilink ConnectionService#X}
* @deprecated This is the old name for {@link ConnectionService.X}
*/
Twitter = X,
Xbox = 'xbox',
@@ -317,7 +316,7 @@ export enum ConnectionVisibility {
}
/**
* https://discord.com/developers/docs/resources/user#application-role-connection-object-application-role-connection-structure
* @see {@link https://discord.com/developers/docs/resources/user#application-role-connection-object-application-role-connection-structure}
*/
export interface APIApplicationRoleConnection {
/**
@@ -335,13 +334,13 @@ export interface APIApplicationRoleConnection {
}
/**
* https://discord.com/developers/docs/resources/user#avatar-decoration-data-object
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
*/
export interface APIAvatarDecorationData {
/**
* The avatar decoration hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
asset: string;
/**

11
deno/payloads/v10/voice.ts
View File

@@ -6,14 +6,13 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildMember } from './guild.ts';
/**
* https://discord.com/developers/docs/resources/voice#voice-state-object
*
* @deprecated This is deprecated, use {@apilink APIVoiceState}
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
* @deprecated This is deprecated, use {@link APIVoiceState}
*/
export type GatewayVoiceState = APIVoiceState;
/**
* https://discord.com/developers/docs/resources/voice#voice-state-object
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
*/
export interface APIVoiceState {
/**
@@ -31,7 +30,7 @@ export interface APIVoiceState {
/**
* The guild member this voice state is for
*
* 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;
/**
@@ -73,7 +72,7 @@ export interface APIVoiceState {
}
/**
* https://discord.com/developers/docs/resources/voice#voice-region-object
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
*/
export interface APIVoiceRegion {
/**

20
deno/payloads/v10/webhook.ts
View File

@@ -14,7 +14,7 @@ import type {
} from './mod.ts';
/**
* https://discord.com/developers/docs/resources/webhook#webhook-object
* @see {@link https://discord.com/developers/docs/resources/webhook#webhook-object}
*/
export interface APIWebhook {
/**
@@ -24,7 +24,7 @@ export interface APIWebhook {
/**
* The type of the webhook
*
* See https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types
* @see {@link https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types}
*/
type: WebhookType;
/**
@@ -38,7 +38,7 @@ export interface APIWebhook {
/**
* The user this webhook was created by (not returned when getting a webhook with its token)
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user?: APIUser;
/**
@@ -72,14 +72,14 @@ export interface APIWebhook {
}
/**
* https://discord.com/developers/docs/events/webhook-events#webhook-event-payloads
* @see {@link https://discord.com/developers/docs/events/webhook-events#webhook-event-payloads}
*/
export type APIWebhookEvent =
| APIWebhookEventBase<ApplicationWebhookType.Event, APIWebhookEventBody>
| APIWebhookEventBase<ApplicationWebhookType.Ping, never>;
/**
* https://discord.com/developers/docs/events/webhook-events#event-body-object
* @see {@link https://discord.com/developers/docs/events/webhook-events#event-body-object}
*/
export type APIWebhookEventBody =
| APIWebhookEventEventBase<
@@ -112,7 +112,7 @@ export type APIWebhookEventEntitlementCreateData = APIEntitlement;
export type APIWebhookEventQuestUserEnrollmentData = never;
interface APIWebhookEventBase<Type extends ApplicationWebhookType, Event> {
export interface APIWebhookEventBase<Type extends ApplicationWebhookType, Event> {
/**
* Version scheme for the webhook event. Currently always `1`
*/
@@ -132,7 +132,7 @@ interface APIWebhookEventBase<Type extends ApplicationWebhookType, Event> {
}
/**
* https://discord.com/developers/docs/events/webhook-events#webhook-types
* @see {@link https://discord.com/developers/docs/events/webhook-events#webhook-types}
*/
export enum ApplicationWebhookType {
/**
@@ -145,7 +145,7 @@ export enum ApplicationWebhookType {
Event,
}
interface APIWebhookEventEventBase<Type extends ApplicationWebhookEventType, Data> {
export interface APIWebhookEventEventBase<Type extends ApplicationWebhookEventType, Data> {
/**
* Event type
*/
@@ -161,7 +161,7 @@ interface APIWebhookEventEventBase<Type extends ApplicationWebhookEventType, Dat
}
/**
* https://discord.com/developers/docs/events/webhook-events#event-types
* @see {@link https://discord.com/developers/docs/events/webhook-events#event-types}
*/
export enum ApplicationWebhookEventType {
/**
@@ -179,7 +179,7 @@ export enum ApplicationWebhookEventType {
}
/**
* https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types
* @see {@link https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types}
*/
export enum WebhookType {
/**

2
deno/payloads/v9/_interactions/_applicationCommands/_chatInput/integer.ts
View File

@@ -6,7 +6,7 @@ import type {
} from './base.ts';
import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts';
interface APIApplicationCommandIntegerOptionBase
export interface APIApplicationCommandIntegerOptionBase
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.Integer> {
/**
* If the option is an `INTEGER` or `NUMBER` type, the minimum value permitted.

2
deno/payloads/v9/_interactions/_applicationCommands/_chatInput/number.ts
View File

@@ -6,7 +6,7 @@ import type {
} from './base.ts';
import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts';
interface APIApplicationCommandNumberOptionBase
export interface APIApplicationCommandNumberOptionBase
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.Number> {
/**
* If the option is an `INTEGER` or `NUMBER` type, the minimum value permitted.

4
deno/payloads/v9/_interactions/_applicationCommands/_chatInput/shared.ts
View File

@@ -1,7 +1,7 @@
import type { LocalizationMap } from '../../../../../v9.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<ValueType = number | string> {
name: string;

2
deno/payloads/v9/_interactions/_applicationCommands/_chatInput/string.ts
View File

@@ -5,7 +5,7 @@ import type {
} from './base.ts';
import type { APIApplicationCommandOptionChoice, ApplicationCommandOptionType } from './shared.ts';
interface APIApplicationCommandStringOptionBase
export interface APIApplicationCommandStringOptionBase
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.String> {
/**
* For option type `STRING`, the minimum allowed length (minimum of `0`, maximum of `6000`).

16
deno/payloads/v9/_interactions/_applicationCommands/chatInput.ts
View File

@@ -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<Type extends InteractionType = InteractionType> =
| APIApplicationCommandInteractionDataBasicOption<Type>
@@ -103,7 +103,7 @@ export type APIApplicationCommandInteractionDataBasicOption<Type extends Interac
| APIApplicationCommandInteractionDataUserOption;
/**
* 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 APIChatInputApplicationCommandInteractionData
extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.ChatInput> {
@@ -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<ApplicationCommandType.ChatInput> {
@@ -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<APIChatInputApplicationCommandInteractionData>;
/**
* 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<APIChatInputApplicationCommandInteraction>;
/**
* 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<APIChatInputApplicationCommandInteraction>;

26
deno/payloads/v9/_interactions/_applicationCommands/contextMenu.ts
View File

@@ -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<ApplicationCommandType.User> {
@@ -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<ApplicationCommandType.Message> {
@@ -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<Snowflake, APIMessage>;
}
/**
* 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<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 APIUserApplicationCommandDMInteraction = APIDMInteractionWrapper<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 APIUserApplicationCommandGuildInteraction =
APIGuildInteractionWrapper<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 APIMessageApplicationCommandInteraction =
APIApplicationCommandInteractionWrapper<APIMessageApplicationCommandInteractionData>;
/**
* 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<APIMessageApplicationCommandInteraction>;
/**
* 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<APIMessageApplicationCommandInteraction>;
/**
* 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

8
deno/payloads/v9/_interactions/_applicationCommands/entryPoint.ts
View File

@@ -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<ApplicationCommandType.PrimaryEntryPoint>;
/**
* 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<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 APIPrimaryEntryPointCommandDMInteraction = APIDMInteractionWrapper<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 APIPrimaryEntryPointCommandGuildInteraction =
APIGuildInteractionWrapper<APIPrimaryEntryPointCommandInteraction>;

8
deno/payloads/v9/_interactions/_applicationCommands/permissions.ts
View File

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

25
deno/payloads/v9/_interactions/applicationCommands.ts
View File

@@ -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<Data extends APIApplicationCommandInteractionData> =
APIBaseInteraction<InteractionType.ApplicationCommand, Data> &
@@ -208,7 +209,7 @@ export type APIApplicationCommandInteractionWrapper<Data extends APIApplicationC
>;
/**
* 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

4
deno/payloads/v9/_interactions/autocomplete.ts
View File

@@ -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<APIApplicationCommandAutocompleteInteraction>;
/**
* 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<APIApplicationCommandAutocompleteInteraction>;

26
deno/payloads/v9/_interactions/base.ts
View File

@@ -15,7 +15,7 @@ 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
@@ -23,9 +23,9 @@ export type APIMessageInteractionMetadata =
| APIModalSubmitInteractionMetadata;
/**
* https://discord.com/developers/docs/resources/channel#message-interaction-metadata-object
* @see {@link https://discord.com/developers/docs/resources/channel#message-interaction-metadata-object}
*/
interface APIBaseInteractionMetadata<Type extends InteractionType> {
export interface APIBaseInteractionMetadata<Type extends InteractionType> {
/**
* ID of the interaction
*/
@@ -49,7 +49,7 @@ interface APIBaseInteractionMetadata<Type extends InteractionType> {
}
/**
* 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<InteractionType.ApplicationCommand> {
@@ -65,7 +65,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<InteractionType.MessageComponent> {
@@ -76,7 +76,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<InteractionType.ModalSubmit> {
/**
@@ -99,7 +99,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 {
/**
@@ -125,7 +125,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;
@@ -135,7 +135,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<Type extends InteractionType, Data> {
/**
@@ -169,7 +169,7 @@ export interface APIBaseInteraction<Type extends InteractionType, Data> {
/**
* The id of the channel it was sent from
*
* @deprecated Use {@apilink APIBaseInteraction#channel} instead
* @deprecated Use {@link APIBaseInteraction.channel} instead
*/
channel_id?: Snowflake;
/**
@@ -246,7 +246,7 @@ export interface APIInteractionDataResolvedChannelBase<T extends ChannelType> 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<Exclude<ChannelType, ThreadChannelType>>
@@ -254,14 +254,14 @@ export type APIInteractionDataResolvedChannel =
Pick<APIThreadChannel, 'parent_id' | 'thread_metadata'>);
/**
* 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<APIGuildMember, 'deaf' | 'mute' | 'user'> {
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<Snowflake, APIUser>;

8
deno/payloads/v9/_interactions/modalSubmit.ts
View File

@@ -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<InteractionType.ModalSubmit, APIModalSubmission> &
Required<Pick<APIBaseInteraction<InteractionType.ModalSubmit, APIModalSubmission>, '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<APIModalSubmitInteraction>;
/**
* 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<APIModalSubmitInteraction>;

13
deno/payloads/v9/_interactions/responses.ts
View File

@@ -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<RESTPostAPIWebhookWithTokenJSONBody, 'avatar_url' | 'username'>;
@@ -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 {
/**

30
deno/payloads/v9/application.ts
View File

@@ -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 {
/**

226
deno/payloads/v9/auditLog.ts
View File

@@ -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<APIRole, 'id' | 'name'>[]>;
export type APIAuditLogChangeKey$Add = APIAuditLogChangeData<'$add', Pick<APIRole, 'id' | 'name'>[]>;
/**
* Returned when role(s) are removed
*/
export type APIAuditLogChangeKey$Remove = AuditLogChangeData<'$remove', Pick<APIRole, 'id' | 'name'>[]>;
export type APIAuditLogChangeKey$Remove = APIAuditLogChangeData<'$remove', Pick<APIRole, 'id' | 'name'>[]>;
/**
* 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 (<insert name of object here>)
* Currently, the only known instance of this is returned when permissions for a command were updated
*/
export type APIAuditLogChangeKeySnowflake = AuditLogChangeData<Snowflake, unknown>;
export type APIAuditLogChangeKeySnowflake = APIAuditLogChangeData<Snowflake, unknown>;
/**
* 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<K extends string, D> {
export interface APIAuditLogChangeData<K extends string, D> {
key: K;
/**
* The new value

22
deno/payloads/v9/autoModeration.ts
View File

@@ -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 {
/**

257
deno/payloads/v9/channel.ts
View File

@@ -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<T extends ChannelType> extends Omit<APIChannelB
/**
* Explicit permission overwrites for members and roles
*
* See https://discord.com/developers/docs/resources/channel#overwrite-object
* @see {@link https://discord.com/developers/docs/resources/channel#overwrite-object}
*/
permission_overwrites?: APIOverwrite[];
/**
@@ -147,13 +147,13 @@ export interface APIVoiceChannelBase<T extends ChannelType>
/**
* 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<T extends ChannelType> extends Omit<APITextBas
/**
* The recipients of the DM
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
recipients?: APIUser[];
}
@@ -241,7 +241,7 @@ export interface APIThreadChannel
}
/**
* https://discord.com/developers/docs/resources/channel#forum-tag-object-forum-tag-structure
* @see {@link https://discord.com/developers/docs/resources/channel#forum-tag-object-forum-tag-structure}
*/
export interface APIGuildForumTag {
/**
@@ -267,7 +267,7 @@ export interface APIGuildForumTag {
}
/**
* https://discord.com/developers/docs/resources/channel#default-reaction-object-default-reaction-structure
* @see {@link https://discord.com/developers/docs/resources/channel#default-reaction-object-default-reaction-structure}
*/
export interface APIGuildForumDefaultReactionEmoji {
/**
@@ -281,7 +281,7 @@ export interface APIGuildForumDefaultReactionEmoji {
}
/**
* https://discord.com/developers/docs/resources/channel/#channel-object-sort-order-types
* @see {@link https://discord.com/developers/docs/resources/channel/#channel-object-sort-order-types}
*/
export enum SortOrderType {
/**
@@ -295,7 +295,7 @@ export enum SortOrderType {
}
/**
* https://discord.com/developers/docs/resources/channel/#channel-object-forum-layout-types
* @see {@link https://discord.com/developers/docs/resources/channel/#channel-object-forum-layout-types}
*/
export enum ForumLayoutType {
/**
@@ -367,7 +367,7 @@ export interface APIGuildForumChannel extends APIThreadOnlyChannel<ChannelType.G
export type APIGuildMediaChannel = APIThreadOnlyChannel<ChannelType.GuildMedia>;
/**
* 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
@@ -382,7 +382,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 {
/**
@@ -404,13 +404,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,
/**
@@ -428,13 +428,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,
/**
@@ -444,7 +444,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,
@@ -452,28 +452,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,
}
@@ -490,7 +489,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 {
/**
@@ -507,7 +506,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;
/**
@@ -515,9 +514,9 @@ export interface APIMessage {
*
* The `MESSAGE_CONTENT` privileged gateway intent will become required after **August 31, 2022** 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**
*
* See https://support-dev.discord.com/hc/articles/4404772028055
* @see {@link https://support-dev.discord.com/hc/articles/4404772028055}
*/
content: string;
/**
@@ -542,14 +541,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'][];
/**
@@ -561,37 +560,35 @@ 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 will become required after **August 31, 2022** 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**
*
* See https://support-dev.discord.com/hc/articles/4404772028055
* In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot \> Privileged Gateway Intents**
* @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 will become required after **August 31, 2022** 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**
*
* See https://support-dev.discord.com/hc/articles/4404772028055
* In the Discord Developers Portal, you need to enable the toggle of this intent of your application in **Bot \> Privileged Gateway Intents**
* @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[];
/**
@@ -612,19 +609,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<APIApplication>;
/**
@@ -634,15 +631,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;
/**
@@ -656,7 +652,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;
/**
@@ -676,23 +672,22 @@ export interface APIMessage {
*
* The `MESSAGE_CONTENT` privileged gateway intent will become required after **August 31, 2022** 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**
*
* See https://support-dev.discord.com/hc/articles/4404772028055
* @see {@link https://support-dev.discord.com/hc/articles/4404772028055}
*/
components?: APIActionRowComponent<APIMessageActionRowComponent>[];
/**
* 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[];
/**
@@ -704,7 +699,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;
/**
@@ -712,10 +707,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;
/**
@@ -729,7 +724,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,
@@ -780,25 +775,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 {
/**
@@ -820,7 +815,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,
@@ -830,7 +825,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 {
/**
@@ -844,7 +839,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 {
/**
@@ -902,7 +897,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 {
/**
@@ -916,7 +911,7 @@ export interface APIMessageCall {
}
/**
* 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 {
/**
@@ -930,7 +925,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 {
/**
@@ -952,7 +947,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;
/**
@@ -962,7 +957,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 {
/**
@@ -976,7 +971,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 {
/**
@@ -985,24 +980,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;
}
@@ -1013,7 +1004,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 {
/**
@@ -1050,7 +1041,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 {
/**
@@ -1072,7 +1063,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;
/**
@@ -1120,7 +1111,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
*/
@@ -1156,37 +1147,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;
/**
@@ -1194,13 +1185,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 {
/**
@@ -1240,7 +1231,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 {
/**
@@ -1262,7 +1253,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 {
/**
@@ -1284,7 +1275,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 {
/**
@@ -1306,7 +1297,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 {
/**
@@ -1320,7 +1311,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 {
/**
@@ -1344,7 +1335,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 {
/**
@@ -1364,7 +1355,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 {
/**
@@ -1386,7 +1377,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 {
/**
@@ -1408,7 +1399,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;
/**
@@ -1450,7 +1441,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 {
/**
@@ -1460,7 +1451,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 {
/**
@@ -1474,7 +1465,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;
/**
@@ -1484,11 +1475,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',
/**
@@ -1502,13 +1493,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[];
/**
@@ -1522,13 +1513,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<T extends ComponentType> {
/**
@@ -1538,7 +1529,7 @@ export interface APIBaseComponent<T extends ComponentType> {
}
/**
* 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 {
/**
@@ -1579,13 +1570,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<T extends APIActionRowComponentTypes>
extends APIBaseComponent<ComponentType.ActionRow> {
@@ -1596,7 +1587,7 @@ export interface APIActionRowComponent<T extends APIActionRowComponentTypes>
}
/**
* https://discord.com/developers/docs/interactions/message-components#buttons
* @see {@link https://discord.com/developers/docs/interactions/message-components#buttons}
*/
export interface APIButtonComponentBase<Style extends ButtonStyle> extends APIBaseComponent<ComponentType.Button> {
/**
@@ -1663,7 +1654,7 @@ export type APIButtonComponent =
| APIButtonComponentWithURL;
/**
* https://discord.com/developers/docs/interactions/message-components#button-object-button-styles
* @see {@link https://discord.com/developers/docs/interactions/message-components#button-object-button-styles}
*/
export enum ButtonStyle {
Primary = 1,
@@ -1675,7 +1666,7 @@ export enum ButtonStyle {
}
/**
* https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-styles
* @see {@link https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-styles}
*/
export enum TextInputStyle {
Short = 1,
@@ -1683,7 +1674,7 @@ export enum TextInputStyle {
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export interface APIBaseSelectMenuComponent<
T extends
@@ -1704,19 +1695,19 @@ export interface APIBaseSelectMenuComponent<
/**
* The minimum number of items that must be chosen; min 0, max 25
*
* @default 1
* @defaultValue `1`
*/
min_values?: number;
/**
* The maximum number of items that can be chosen; max 25
*
* @default 1
* @defaultValue `1`
*/
max_values?: number;
/**
* Disable the select
*
* @default false
* @defaultValue `false`
*/
disabled?: boolean;
}
@@ -1736,7 +1727,7 @@ export interface APIBaseAutoPopulatedSelectMenuComponent<
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export interface APIStringSelectComponent extends APIBaseSelectMenuComponent<ComponentType.StringSelect> {
/**
@@ -1746,7 +1737,7 @@ export interface APIStringSelectComponent extends APIBaseSelectMenuComponent<Com
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APIUserSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
ComponentType.UserSelect,
@@ -1754,7 +1745,7 @@ export type APIUserSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
>;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APIRoleSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
ComponentType.RoleSelect,
@@ -1762,7 +1753,7 @@ export type APIRoleSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
>;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APIMentionableSelectComponent = APIBaseAutoPopulatedSelectMenuComponent<
ComponentType.MentionableSelect,
@@ -1770,7 +1761,7 @@ export type APIMentionableSelectComponent = APIBaseAutoPopulatedSelectMenuCompon
>;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export interface APIChannelSelectComponent
extends APIBaseAutoPopulatedSelectMenuComponent<ComponentType.ChannelSelect, SelectMenuDefaultValueType.Channel> {
@@ -1781,7 +1772,7 @@ export interface APIChannelSelectComponent
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure}
*/
export enum SelectMenuDefaultValueType {
Channel = 'channel',
@@ -1790,7 +1781,7 @@ export enum SelectMenuDefaultValueType {
}
/**
* https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-default-value-structure}
*/
export interface APISelectMenuDefaultValue<T extends SelectMenuDefaultValueType> {
type: T;
@@ -1804,7 +1795,7 @@ export type APIAutoPopulatedSelectMenuComponent =
| APIUserSelectComponent;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menus
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menus}
*/
export type APISelectMenuComponent =
| APIChannelSelectComponent
@@ -1814,7 +1805,7 @@ export type APISelectMenuComponent =
| APIUserSelectComponent;
/**
* https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object-select-option-structure}
*/
export interface APISelectMenuOption {
/**
@@ -1840,7 +1831,7 @@ export interface APISelectMenuOption {
}
/**
* https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure
* @see {@link https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure}
*/
export interface APITextInputComponent extends APIBaseComponent<ComponentType.TextInput> {
/**
@@ -1878,7 +1869,7 @@ export interface APITextInputComponent extends APIBaseComponent<ComponentType.Te
}
/**
* https://discord.com/developers/docs/resources/channel#message-snapshot-object
* @see {@link https://discord.com/developers/docs/resources/channel#message-snapshot-object}
*/
export interface APIMessageSnapshot {
/**
@@ -1893,13 +1884,13 @@ export interface APIMessageSnapshot {
*
* It was added in {@link https://github.com/discord/discord-api-docs/pull/6833/commits/d18f72d06d62e6b1d51ca2c1ef308ddc29ff3348 | d18f72d}
* but was later removed before the PR ({@link https://github.com/discord/discord-api-docs/pull/6833 | discord-api-docs#6833}) was merged.
* See {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
* @see {@link https://github.com/discordjs/discord-api-types/pull/1084 | discord-api-types#1084} for more information.
*/
guild_id?: Snowflake;
}
/**
* https://discord.com/developers/docs/resources/channel#channel-object-channel-flags
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-flags}
*/
export enum ChannelFlags {
/**
@@ -1942,7 +1933,7 @@ export enum ChannelFlags {
}
/**
* https://discord.com/developers/docs/interactions/message-components#message-components
* @see {@link https://discord.com/developers/docs/interactions/message-components#message-components}
*/
export type APIMessageComponent = APIActionRowComponent<APIMessageActionRowComponent> | APIMessageActionRowComponent;
export type APIModalComponent = APIActionRowComponent<APIModalActionRowComponent> | APIModalActionRowComponent;
@@ -1950,7 +1941,7 @@ export type APIModalComponent = APIActionRowComponent<APIModalActionRowComponent
export type APIActionRowComponentTypes = APIMessageActionRowComponent | APIModalActionRowComponent;
/**
* https://discord.com/developers/docs/interactions/message-components#message-components
* @see {@link https://discord.com/developers/docs/interactions/message-components#message-components}
*/
export type APIMessageActionRowComponent = APIButtonComponent | APISelectMenuComponent;

2
deno/payloads/v9/emoji.ts
View File

@@ -25,7 +25,7 @@ export interface APIPartialEmoji {
}
/**
* https://discord.com/developers/docs/resources/emoji#emoji-object-emoji-structure
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object-emoji-structure}
*/
export interface APIEmoji extends APIPartialEmoji {
/**

69
deno/payloads/v9/gateway.ts
View File

@@ -10,7 +10,7 @@ import type { APIEmoji } from './emoji.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/topics/gateway#get-gateway
* @see {@link https://discord.com/developers/docs/topics/gateway#get-gateway}
*/
export interface APIGatewayInfo {
/**
@@ -20,25 +20,25 @@ export interface APIGatewayInfo {
}
/**
* https://discord.com/developers/docs/topics/gateway#get-gateway-bot
* @see {@link https://discord.com/developers/docs/topics/gateway#get-gateway-bot}
*/
export interface APIGatewayBotInfo extends APIGatewayInfo {
/**
* The recommended number of shards to use when connecting
*
* See https://discord.com/developers/docs/topics/gateway#sharding
* @see {@link https://discord.com/developers/docs/topics/gateway#sharding}
*/
shards: number;
/**
* Information on the current session start limit
*
* See https://discord.com/developers/docs/topics/gateway#session-start-limit-object
* @see {@link https://discord.com/developers/docs/topics/gateway#session-start-limit-object}
*/
session_start_limit: APIGatewaySessionStartLimit;
}
/**
* https://discord.com/developers/docs/topics/gateway#session-start-limit-object
* @see {@link https://discord.com/developers/docs/topics/gateway#session-start-limit-object}
*/
export interface APIGatewaySessionStartLimit {
/**
@@ -60,7 +60,7 @@ export interface APIGatewaySessionStartLimit {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields
* @see {@link https://discord.com/developers/docs/topics/gateway-events#presence-update-presence-update-event-fields}
*/
export interface GatewayPresenceUpdate {
/**
@@ -69,7 +69,7 @@ export interface GatewayPresenceUpdate {
* **The user object within this event can be partial, the only field which must be sent is the `id` field,
* everything else is optional.**
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user: Partial<APIUser> & Pick<APIUser, 'id'>;
/**
@@ -83,19 +83,19 @@ export interface GatewayPresenceUpdate {
/**
* User's current 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?: GatewayActivity[];
/**
* User's platform-dependent status
*
* See https://discord.com/developers/docs/topics/gateway-events#client-status-object
* @see {@link https://discord.com/developers/docs/topics/gateway-events#client-status-object}
*/
client_status?: GatewayPresenceClientStatus;
}
/**
* 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}
*/
export enum PresenceUpdateStatus {
Online = 'online',
@@ -111,7 +111,7 @@ export enum PresenceUpdateStatus {
export type PresenceUpdateReceiveStatus = Exclude<PresenceUpdateStatus, PresenceUpdateStatus.Invisible>;
/**
* https://discord.com/developers/docs/topics/gateway-events#client-status-object
* @see {@link https://discord.com/developers/docs/topics/gateway-events#client-status-object}
*/
export interface GatewayPresenceClientStatus {
/**
@@ -129,7 +129,7 @@ export interface GatewayPresenceClientStatus {
}
/**
* 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 interface GatewayActivity {
/**
@@ -143,7 +143,7 @@ export interface GatewayActivity {
/**
* Activity type
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types}
*/
type: ActivityType;
/**
@@ -178,26 +178,26 @@ export interface GatewayActivity {
/**
* The emoji used for a custom status
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji}
*/
emoji?: GatewayActivityEmoji;
session_id?: string;
/**
* Information for the current party of the player
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party}
*/
party?: GatewayActivityParty;
/**
* Images for the presence and their hover texts
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets}
*/
assets?: GatewayActivityAssets;
/**
* Secrets for Rich Presence joining and spectating
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets}
*/
secrets?: GatewayActivitySecrets;
/**
@@ -207,9 +207,8 @@ export interface GatewayActivity {
/**
* Activity flags `OR`d together, describes what the payload includes
*
* See https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags}
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
flags?: ActivityFlags;
/**
@@ -234,37 +233,37 @@ export enum ActivityPlatform {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-types}
*/
export enum ActivityType {
/**
* Playing {game}
* Playing \{game\}
*/
Playing,
/**
* Streaming {details}
* Streaming \{details\}
*/
Streaming,
/**
* Listening to {name}
* Listening to \{name\}
*/
Listening,
/**
* Watching {details}
* Watching \{details\}
*/
Watching,
/**
* {emoji} {state}
* \{emoji\} \{state\}
*/
Custom,
/**
* Competing in {name}
* Competing in \{name\}
*/
Competing,
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-timestamps
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-timestamps}
*/
export interface GatewayActivityTimestamps {
/**
@@ -278,12 +277,12 @@ export interface GatewayActivityTimestamps {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-emoji}
*/
export type GatewayActivityEmoji = Partial<Pick<APIEmoji, 'animated' | 'id'>> & Pick<APIEmoji, 'name'>;
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-party}
*/
export interface GatewayActivityParty {
/**
@@ -297,19 +296,19 @@ export interface GatewayActivityParty {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-assets}
*/
export type GatewayActivityAssets = Partial<
Record<'large_image' | 'large_text' | 'small_image' | 'small_text', string>
>;
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-secrets}
*/
export type GatewayActivitySecrets = Partial<Record<'join' | 'match' | 'spectate', string>>;
/**
* https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags
* @see {@link https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-flags}
*/
export enum ActivityFlags {
Instance = 1 << 0,
@@ -335,7 +334,7 @@ export interface GatewayActivityButton {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#thread-list-sync-thread-list-sync-event-fields
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-list-sync-thread-list-sync-event-fields}
*/
export interface GatewayThreadListSync {
/**
@@ -357,7 +356,7 @@ export interface GatewayThreadListSync {
}
/**
* https://discord.com/developers/docs/topics/gateway-events#thread-members-update-thread-members-update-event-fields
* @see {@link https://discord.com/developers/docs/topics/gateway-events#thread-members-update-thread-members-update-event-fields}
*/
export interface GatewayThreadMembersUpdate {
/**

146
deno/payloads/v9/guild.ts
View File

@@ -12,7 +12,7 @@ import type { APISticker } from './sticker.ts';
import type { APIAvatarDecorationData, APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/guild#unavailable-guild-object
* @see {@link https://discord.com/developers/docs/resources/guild#unavailable-guild-object}
*/
export interface APIUnavailableGuild {
/**
@@ -26,7 +26,7 @@ export interface APIUnavailableGuild {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
*/
export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'>, Pick<APIGuild, 'welcome_screen'> {
/**
@@ -36,19 +36,19 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
/**
* Icon hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon: string | null;
/**
* Splash hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
splash: string | null;
/**
* Banner hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
banner?: string | null;
/**
@@ -58,13 +58,13 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
/**
* Enabled guild features
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
features?: GuildFeature[];
/**
* Verification level required for the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
verification_level?: GuildVerificationLevel;
/**
@@ -74,19 +74,19 @@ export interface APIPartialGuild extends Omit<APIUnavailableGuild, 'unavailable'
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
*/
export interface APIGuild extends APIPartialGuild {
/**
* Icon hash, returned when in the template object
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon_hash?: string | null;
/**
* Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
discovery_splash: string | null;
/**
@@ -104,14 +104,13 @@ export interface APIGuild extends APIPartialGuild {
*
* **This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds**
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
permissions?: Permissions;
/**
* Voice region id for the guild
*
* See https://discord.com/developers/docs/resources/voice#voice-region-object
*
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
* @deprecated This field has been deprecated in favor of `rtc_region` on the channel.
*/
region: string;
@@ -134,43 +133,43 @@ export interface APIGuild extends APIPartialGuild {
/**
* Verification level required for the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
verification_level: GuildVerificationLevel;
/**
* Default message notifications level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level}
*/
default_message_notifications: GuildDefaultMessageNotifications;
/**
* Explicit content filter level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level}
*/
explicit_content_filter: GuildExplicitContentFilter;
/**
* Roles in the guild
*
* See https://discord.com/developers/docs/topics/permissions#role-object
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
roles: APIRole[];
/**
* Custom guild emojis
*
* See https://discord.com/developers/docs/resources/emoji#emoji-object
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
*/
emojis: APIEmoji[];
/**
* Enabled guild features
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
features: GuildFeature[];
/**
* Required MFA level for the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-mfa-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-mfa-level}
*/
mfa_level: GuildMFALevel;
/**
@@ -184,7 +183,7 @@ export interface APIGuild extends APIPartialGuild {
/**
* System channel flags
*
* See https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags}
*/
system_channel_flags: GuildSystemChannelFlags;
/**
@@ -210,13 +209,13 @@ export interface APIGuild extends APIPartialGuild {
/**
* Banner hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
banner: string | null;
/**
* Premium tier (Server Boost level)
*
* See https://discord.com/developers/docs/resources/guild#guild-object-premium-tier
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-premium-tier}
*/
premium_tier: GuildPremiumTier;
/**
@@ -226,7 +225,7 @@ export interface APIGuild extends APIPartialGuild {
/**
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
*
* @default "en-US"
* @defaultValue `"en-US"`
*/
preferred_locale: Locale;
/**
@@ -260,13 +259,13 @@ export interface APIGuild extends APIPartialGuild {
/**
* The nsfw level of the guild
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level}
*/
nsfw_level: GuildNSFWLevel;
/**
* Custom guild stickers
*
* See https://discord.com/developers/docs/resources/sticker#sticker-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object}
*/
stickers: APISticker[];
/**
@@ -288,20 +287,20 @@ export interface APIGuild extends APIPartialGuild {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-structure}
*/
export interface APIPartialInteractionGuild extends Pick<APIGuild, 'features' | 'id'> {
/**
* The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"
*
* @unstable https://github.com/discord/discord-api-docs/issues/6938
* @default "en-US"
* @defaultValue `"en-US"`
*/
locale: Locale;
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level}
*/
export enum GuildDefaultMessageNotifications {
AllMessages,
@@ -309,7 +308,7 @@ export enum GuildDefaultMessageNotifications {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level}
*/
export enum GuildExplicitContentFilter {
Disabled,
@@ -318,7 +317,7 @@ export enum GuildExplicitContentFilter {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-mfa-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-mfa-level}
*/
export enum GuildMFALevel {
None,
@@ -326,7 +325,7 @@ export enum GuildMFALevel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level}
*/
export enum GuildNSFWLevel {
Default,
@@ -336,7 +335,7 @@ export enum GuildNSFWLevel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
export enum GuildVerificationLevel {
/**
@@ -362,7 +361,7 @@ export enum GuildVerificationLevel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-premium-tier
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-premium-tier}
*/
export enum GuildPremiumTier {
None,
@@ -378,7 +377,7 @@ export enum GuildHubType {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags}
*/
export enum GuildSystemChannelFlags {
/**
@@ -400,7 +399,7 @@ export enum GuildSystemChannelFlags {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
export enum GuildFeature {
/**
@@ -414,7 +413,7 @@ export enum GuildFeature {
/**
* Guild is using the old permissions configuration behavior
*
* See https://discord.com/developers/docs/change-log#upcoming-application-command-permission-changes
* @see {@link https://discord.com/developers/docs/change-log#upcoming-application-command-permission-changes}
*/
ApplicationCommandPermissionsV2 = 'APPLICATION_COMMAND_PERMISSIONS_V2',
/**
@@ -456,8 +455,7 @@ export enum GuildFeature {
/**
* Guild is a Student Hub
*
* See https://support.discord.com/hc/articles/4406046651927
*
* @see {@link https://support.discord.com/hc/articles/4406046651927}
* @unstable This feature is currently not documented by Discord, but has known value
*/
Hub = 'HUB',
@@ -472,8 +470,7 @@ export enum GuildFeature {
/**
* Guild is in a Student Hub
*
* See https://support.discord.com/hc/articles/4406046651927
*
* @see {@link https://support.discord.com/hc/articles/4406046651927}
* @unstable This feature is currently not documented by Discord, but has known value
*/
LinkedToHub = 'LINKED_TO_HUB',
@@ -555,7 +552,7 @@ export enum GuildFeature {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-preview-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-preview-object}
*/
export interface APIGuildPreview {
/**
@@ -569,31 +566,31 @@ export interface APIGuildPreview {
/**
* Icon hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon: string | null;
/**
* Splash hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
splash: string | null;
/**
* Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
discovery_splash: string | null;
/**
* Custom guild emojis
*
* See https://discord.com/developers/docs/resources/emoji#emoji-object
* @see {@link https://discord.com/developers/docs/resources/emoji#emoji-object}
*/
emojis: APIEmoji[];
/**
* Enabled guild features
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
features: GuildFeature[];
/**
@@ -615,7 +612,7 @@ export interface APIGuildPreview {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object}
*/
export interface APIGuildWidgetSettings {
/**
@@ -629,7 +626,7 @@ export interface APIGuildWidgetSettings {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-member-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object}
*/
export interface APIGuildMember {
/**
@@ -637,7 +634,7 @@ export interface APIGuildMember {
*
* **This field won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events.**
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user: APIUser;
/**
@@ -655,7 +652,7 @@ export interface APIGuildMember {
/**
* Array of role object ids
*
* See https://discord.com/developers/docs/topics/permissions#role-object
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
roles: Snowflake[];
/**
@@ -665,7 +662,7 @@ export interface APIGuildMember {
/**
* When the user started boosting the guild
*
* See https://support.discord.com/hc/articles/360028038352
* @see {@link https://support.discord.com/hc/articles/360028038352}
*/
premium_since?: string | null;
/**
@@ -693,13 +690,13 @@ export interface APIGuildMember {
/**
* The data for the member's guild avatar decoration
*
* See https://discord.com/developers/docs/resources/user#avatar-decoration-data-object
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
*/
avatar_decoration_data?: APIAvatarDecorationData | null;
}
/**
* https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags}
*/
export enum GuildMemberFlags {
/**
@@ -736,6 +733,7 @@ export enum GuildMemberFlags {
AutomodQuarantinedUsernameOrGuildNickname = 1 << 7,
/**
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/7113 | discord-api-docs#7113}
*/
AutomodQuarantinedBio = 1 << 8,
/**
@@ -745,7 +743,7 @@ export enum GuildMemberFlags {
}
/**
* https://discord.com/developers/docs/resources/guild#integration-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object}
*/
export interface APIGuildIntegration {
/**
@@ -787,7 +785,7 @@ export interface APIGuildIntegration {
*
* **This field is not provided for `discord` bot integrations.**
*
* See https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors}
*/
expire_behavior?: IntegrationExpireBehavior;
/**
@@ -801,13 +799,13 @@ export interface APIGuildIntegration {
*
* **Some older integrations may not have an attached user.**
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user?: APIUser;
/**
* Integration account information
*
* See https://discord.com/developers/docs/resources/guild#integration-account-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-account-object}
*/
account: APIIntegrationAccount;
/**
@@ -831,7 +829,7 @@ export interface APIGuildIntegration {
/**
* The bot/OAuth2 application for discord integrations
*
* See https://discord.com/developers/docs/resources/guild#integration-application-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-application-object}
*
* **This field is not provided for `discord` bot integrations.**
*/
@@ -845,7 +843,7 @@ export interface APIGuildIntegration {
export type APIGuildIntegrationType = 'discord' | 'guild_subscription' | 'twitch' | 'youtube';
/**
* https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors}
*/
export enum IntegrationExpireBehavior {
RemoveRole,
@@ -853,7 +851,7 @@ export enum IntegrationExpireBehavior {
}
/**
* https://discord.com/developers/docs/resources/guild#integration-account-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-account-object}
*/
export interface APIIntegrationAccount {
/**
@@ -867,7 +865,7 @@ export interface APIIntegrationAccount {
}
/**
* https://discord.com/developers/docs/resources/guild#integration-application-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-application-object}
*/
export interface APIGuildIntegrationApplication {
/**
@@ -881,7 +879,7 @@ export interface APIGuildIntegrationApplication {
/**
* The icon hash of the app
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
icon: string | null;
/**
@@ -891,13 +889,13 @@ export interface APIGuildIntegrationApplication {
/**
* The bot associated with this application
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
bot?: APIUser;
}
/**
* https://discord.com/developers/docs/resources/guild#ban-object
* @see {@link https://discord.com/developers/docs/resources/guild#ban-object}
*/
export interface APIBan {
/**
@@ -911,7 +909,7 @@ export interface APIBan {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object}
*/
export interface APIGuildWidget {
id: Snowflake;
@@ -923,7 +921,7 @@ export interface APIGuildWidget {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget}
*/
export interface APIGuildWidgetChannel {
id: Snowflake;
@@ -932,7 +930,7 @@ export interface APIGuildWidgetChannel {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
* @see {@link https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget}
*/
export interface APIGuildWidgetMember {
id: string;
@@ -945,7 +943,7 @@ export interface APIGuildWidgetMember {
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-widget-image-widget-style-options
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-image-widget-style-options}
*/
export enum GuildWidgetStyle {
/**
@@ -1045,7 +1043,7 @@ export enum MembershipScreeningFieldType {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure}
*/
export interface APIGuildOnboarding {
/**
@@ -1071,7 +1069,7 @@ export interface APIGuildOnboarding {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure}
*/
export interface APIGuildOnboardingPrompt {
/**
@@ -1106,7 +1104,7 @@ export interface APIGuildOnboardingPrompt {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure}
*/
export interface APIGuildOnboardingPromptOption {
/**
@@ -1136,7 +1134,7 @@ export interface APIGuildOnboardingPromptOption {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode}
*/
export enum GuildOnboardingMode {
/**
@@ -1150,7 +1148,7 @@ export enum GuildOnboardingMode {
}
/**
* https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types
* @see {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types}
*/
export enum GuildOnboardingPromptType {
MultipleChoice,

35
deno/payloads/v9/guildScheduledEvent.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildMember } from './guild.ts';
import type { APIUser } from './user.ts';
interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType> {
export interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType> {
/**
* The id of the guild event
*/
@@ -74,7 +74,7 @@ interface APIGuildScheduledEventBase<Type extends GuildScheduledEventEntityType>
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure}
*/
export interface APIGuildScheduledEventRecurrenceRule {
/**
@@ -91,7 +91,7 @@ export interface APIGuildScheduledEventRecurrenceRule {
frequency: GuildScheduledEventRecurrenceRuleFrequency;
/**
* The spacing between the events, defined by `frequency`.
* For example, `frequency` of {@apilink GuildScheduledEventRecurrenceRuleFrequency#Weekly} and an `interval` of `2`
* For example, `frequency` of {@link GuildScheduledEventRecurrenceRuleFrequency.Weekly} and an `interval` of `2`
* would be "every-other week"
*/
interval: number;
@@ -102,7 +102,7 @@ export interface APIGuildScheduledEventRecurrenceRule {
/**
* List of specific days within a specific week (1-5) to recur on
*/
by_n_weekday: GuildScheduledEventRecurrenceRuleNWeekday[] | null;
by_n_weekday: APIGuildScheduledEventRecurrenceRuleNWeekday[] | null;
/**
* Set of specific months to recur on
*/
@@ -122,7 +122,7 @@ export interface APIGuildScheduledEventRecurrenceRule {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-frequency
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-frequency}
*/
export enum GuildScheduledEventRecurrenceRuleFrequency {
Yearly,
@@ -132,7 +132,7 @@ export enum GuildScheduledEventRecurrenceRuleFrequency {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday}
*/
export enum GuildScheduledEventRecurrenceRuleWeekday {
Monday,
@@ -145,7 +145,7 @@ export enum GuildScheduledEventRecurrenceRuleWeekday {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-month
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-month}
*/
export enum GuildScheduledEventRecurrenceRuleMonth {
January = 1,
@@ -163,9 +163,9 @@ export enum GuildScheduledEventRecurrenceRuleMonth {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-nweekday-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-nweekday-structure}
*/
export interface GuildScheduledEventRecurrenceRuleNWeekday {
export interface APIGuildScheduledEventRecurrenceRuleNWeekday {
/**
* The week to reoccur on.
*/
@@ -176,6 +176,11 @@ export interface GuildScheduledEventRecurrenceRuleNWeekday {
day: GuildScheduledEventRecurrenceRuleWeekday;
}
/**
* @deprecated Use {@link APIGuildScheduledEventRecurrenceRuleNWeekday} instead
*/
export type GuildScheduledEventRecurrenceRuleNWeekday = APIGuildScheduledEventRecurrenceRuleNWeekday;
export interface APIStageInstanceGuildScheduledEvent
extends APIGuildScheduledEventBase<GuildScheduledEventEntityType.StageInstance> {
channel_id: Snowflake;
@@ -194,7 +199,7 @@ export interface APIExternalGuildScheduledEvent
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure}
*/
export type APIGuildScheduledEvent =
| APIExternalGuildScheduledEvent
@@ -202,7 +207,7 @@ export type APIGuildScheduledEvent =
| APIVoiceGuildScheduledEvent;
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata}
*/
export interface APIGuildScheduledEventEntityMetadata {
/**
@@ -212,7 +217,7 @@ export interface APIGuildScheduledEventEntityMetadata {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types}
*/
export enum GuildScheduledEventEntityType {
StageInstance = 1,
@@ -221,7 +226,7 @@ export enum GuildScheduledEventEntityType {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status}
*/
export enum GuildScheduledEventStatus {
Scheduled = 1,
@@ -231,7 +236,7 @@ export enum GuildScheduledEventStatus {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level}
*/
export enum GuildScheduledEventPrivacyLevel {
/**
@@ -241,7 +246,7 @@ export enum GuildScheduledEventPrivacyLevel {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure}
*/
export interface APIGuildScheduledEventUser {
/**

6
deno/payloads/v9/interactions.ts
View File

@@ -29,7 +29,7 @@ export * from './_interactions/ping.ts';
export * from './_interactions/responses.ts';
/**
* 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 APIInteraction =
| APIApplicationCommandAutocompleteInteraction
@@ -39,7 +39,7 @@ export type APIInteraction =
| APIPingInteraction;
/**
* 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 APIDMInteraction =
| APIApplicationCommandAutocompleteDMInteraction
@@ -48,7 +48,7 @@ export type APIDMInteraction =
| APIModalSubmitDMInteraction;
/**
* 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 APIGuildInteraction =
| APIApplicationCommandAutocompleteGuildInteraction

21
deno/payloads/v9/invite.ts
View File

@@ -25,7 +25,7 @@ export type APIInviteGuild = Pick<
>;
/**
* https://discord.com/developers/docs/resources/invite#invite-object
* @see {@link https://discord.com/developers/docs/resources/invite#invite-object}
*/
export interface APIInvite {
/**
@@ -35,37 +35,37 @@ export interface APIInvite {
/**
* The guild this invite is for
*
* See https://discord.com/developers/docs/resources/guild#guild-object
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object}
*/
guild?: APIInviteGuild;
/**
* The channel this invite is for
*
* See https://discord.com/developers/docs/resources/channel#channel-object
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
*/
channel: Required<APIPartialChannel> | null;
/**
* The user who 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;
/**
* 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;
/**
* The embedded application to open for this voice channel embedded application invite
*
* See https://discord.com/developers/docs/resources/application#application-object
* @see {@link https://discord.com/developers/docs/resources/application#application-object}
*/
target_application?: Partial<APIApplication>;
/**
@@ -84,6 +84,7 @@ export interface APIInvite {
* The stage instance data if there is a public stage instance in the stage channel this invite is for
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
*/
stage_instance?: APIInviteStageInstance;
/**
@@ -97,7 +98,7 @@ export interface APIInvite {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-object-invite-types
* @see {@link https://discord.com/developers/docs/resources/invite#invite-object-invite-types}
*/
export enum InviteType {
Guild,
@@ -106,7 +107,7 @@ export enum InviteType {
}
/**
* 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}
*/
export enum InviteTargetType {
Stream = 1,
@@ -114,7 +115,7 @@ export enum InviteTargetType {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-metadata-object
* @see {@link https://discord.com/developers/docs/resources/invite#invite-metadata-object}
*/
export interface APIExtendedInvite extends APIInvite {
/**

16
deno/payloads/v9/monetization.ts
View File

@@ -1,7 +1,7 @@
import type { Snowflake } from '../../globals.ts';
/**
* https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-structure
* @see {@link https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-structure}
*/
export interface APIEntitlement {
/**
@@ -47,7 +47,7 @@ export interface APIEntitlement {
}
/**
* https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-types
* @see {@link https://discord.com/developers/docs/monetization/entitlements#entitlement-object-entitlement-types}
*/
export enum EntitlementType {
/**
@@ -85,7 +85,7 @@ export enum EntitlementType {
}
/**
* https://discord.com/developers/docs/monetization/skus#sku-object-sku-structure
* @see {@link https://discord.com/developers/docs/monetization/skus#sku-object-sku-structure}
*/
export interface APISKU {
/**
@@ -111,13 +111,13 @@ export interface APISKU {
/**
* SKU flags combined as a bitfield
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
flags: SKUFlags;
}
/**
* https://discord.com/developers/docs/monetization/skus#sku-object-sku-flags
* @see {@link https://discord.com/developers/docs/monetization/skus#sku-object-sku-flags}
*/
export enum SKUFlags {
/**
@@ -136,7 +136,7 @@ export enum SKUFlags {
}
/**
* https://discord.com/developers/docs/resources/sku#sku-object-sku-types
* @see {@link https://discord.com/developers/docs/resources/sku#sku-object-sku-types}
*/
export enum SKUType {
/**
@@ -158,7 +158,7 @@ export enum SKUType {
}
/**
* https://discord.com/developers/docs/resources/subscription#subscription-object
* @see {@link https://discord.com/developers/docs/resources/subscription#subscription-object}
*/
export interface APISubscription {
/**
@@ -204,7 +204,7 @@ export interface APISubscription {
}
/**
* https://discord.com/developers/docs/resources/subscription#subscription-statuses
* @see {@link https://discord.com/developers/docs/resources/subscription#subscription-statuses}
*/
export enum SubscriptionStatus {
/**

34
deno/payloads/v9/oauth2.ts
View File

@@ -8,10 +8,10 @@ export enum OAuth2Scopes {
*/
Bot = 'bot',
/**
* Allows [/users/@me/connections](https://discord.com/developers/docs/resources/user#get-user-connections)
* Allows {@link https://discord.com/developers/docs/resources/user#get-user-connections | `/users/@me/connections`}
* to return linked third-party accounts
*
* See https://discord.com/developers/docs/resources/user#get-user-connections
* @see {@link https://discord.com/developers/docs/resources/user#get-user-connections}
*/
Connections = 'connections',
/**
@@ -19,41 +19,41 @@ export enum OAuth2Scopes {
*/
DMChannelsRead = 'dm_channels.read',
/**
* Enables [/users/@me](https://discord.com/developers/docs/resources/user#get-current-user) to return an `email`
* Enables {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} to return an `email`
*
* See https://discord.com/developers/docs/resources/user#get-current-user
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
Email = 'email',
/**
* Allows [/users/@me](https://discord.com/developers/docs/resources/user#get-current-user) without `email`
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user | `/users/@me`} without `email`
*
* See https://discord.com/developers/docs/resources/user#get-current-user
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
Identify = 'identify',
/**
* Allows [/users/@me/guilds](https://discord.com/developers/docs/resources/user#get-current-user-guilds)
* Allows {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds | `/users/@me/guilds`}
* to return basic information about all of a user's guilds
*
* See https://discord.com/developers/docs/resources/user#get-current-user-guilds
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
*/
Guilds = 'guilds',
/**
* Allows [/guilds/{guild.id}/members/{user.id}](https://discord.com/developers/docs/resources/guild#add-guild-member)
* Allows {@link https://discord.com/developers/docs/resources/guild#add-guild-member | `/guilds/[guild.id]/members/[user.id]`}
* to be used for joining users to a guild
*
* See https://discord.com/developers/docs/resources/guild#add-guild-member
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}
*/
GuildsJoin = 'guilds.join',
/**
* Allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
* Allows /users/\@me/guilds/\{guild.id\}/member to return a user's member information in a guild
*
* See https://discord.com/developers/docs/resources/user#get-current-user-guild-member
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guild-member}
*/
GuildsMembersRead = 'guilds.members.read',
/**
* Allows your app to join users to a group dm
*
* See https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
* @see {@link https://discord.com/developers/docs/resources/channel#group-dm-add-recipient}
*/
GroupDMJoins = 'gdm.join',
/**
@@ -108,25 +108,25 @@ export enum OAuth2Scopes {
/**
* Allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
*
* See https://discord.com/developers/docs/game-sdk/activities
* @see {@link https://discord.com/developers/docs/game-sdk/activities}
*/
ActivitiesWrite = 'activities.write',
/**
* Allows your app to use Application Commands in a guild
*
* See https://discord.com/developers/docs/interactions/application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
ApplicationsCommands = 'applications.commands',
/**
* Allows your app to update its Application Commands via this bearer token - client credentials grant only
*
* See https://discord.com/developers/docs/interactions/application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
ApplicationsCommandsUpdate = 'applications.commands.update',
/**
* Allows your app to update permissions for its commands using a Bearer token - client credentials grant only
*
* See https://discord.com/developers/docs/interactions/application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands}
*/
ApplicationCommandsPermissionsUpdate = 'applications.commands.permissions.update',
}

8
deno/payloads/v9/permissions.ts
View File

@@ -5,7 +5,7 @@
import type { Permissions, Snowflake } from '../../globals.ts';
/**
* https://discord.com/developers/docs/topics/permissions#role-object
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
export interface APIRole {
/**
@@ -39,7 +39,7 @@ export interface APIRole {
/**
* Permission bit set
*
* See https://en.wikipedia.org/wiki/Bit_field
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
*/
permissions: Permissions;
/**
@@ -61,7 +61,7 @@ export interface APIRole {
}
/**
* https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure}
*/
export interface APIRoleTags {
/**
@@ -91,7 +91,7 @@ export interface APIRoleTags {
}
/**
* https://discord.com/developers/docs/topics/permissions#role-object-role-flags
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object-role-flags}
*/
export enum RoleFlags {
/**

16
deno/payloads/v9/poll.ts
View File

@@ -5,7 +5,7 @@
import type { APIPartialEmoji } from './emoji.ts';
/**
* https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure}
*/
export interface APIPoll {
/**
@@ -23,13 +23,13 @@ export interface APIPoll {
/**
* Whether a user can select multiple answers
*
* @default false
* @defaultValue `false`
*/
allow_multiselect: boolean;
/**
* The layout type of the poll
*
* @default PollLayoutType.Default
* @defaultValue `PollLayoutType.Default`
*/
layout_type: PollLayoutType;
/**
@@ -39,7 +39,7 @@ export interface APIPoll {
}
/**
* https://discord.com/developers/docs/resources/poll#layout-type
* @see {@link https://discord.com/developers/docs/resources/poll#layout-type}
*/
export enum PollLayoutType {
/**
@@ -49,7 +49,7 @@ export enum PollLayoutType {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-media-object-poll-media-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-media-object-poll-media-object-structure}
*/
export interface APIPollMedia {
/**
@@ -65,7 +65,7 @@ export interface APIPollMedia {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure}
*/
export interface APIPollAnswer {
/**
@@ -79,7 +79,7 @@ export interface APIPollAnswer {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure}
*/
export interface APIPollResults {
/**
@@ -93,7 +93,7 @@ export interface APIPollResults {
}
/**
* https://discord.com/developers/docs/resources/poll#poll-results-object-poll-answer-count-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-results-object-poll-answer-count-object-structure}
*/
export interface APIPollAnswerCount {
/**

2
deno/payloads/v9/soundboard.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object
* @see {@link https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object}
*/
export interface APISoundboardSound {
/**

14
deno/payloads/v9/stageInstance.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildMember } from './guild.ts';
/**
* https://discord.com/developers/docs/resources/stage-instance#stage-instance-object
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object}
*/
export interface APIStageInstance {
/**
@@ -24,13 +24,14 @@ export interface APIStageInstance {
/**
* The privacy level of the stage instance
*
* See https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level}
*/
privacy_level: StageInstancePrivacyLevel;
/**
* Whether or not stage discovery is disabled
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
*/
discoverable_disabled: boolean;
/**
@@ -40,13 +41,14 @@ export interface APIStageInstance {
}
/**
* https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level
* @see {@link https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level}
*/
export enum StageInstancePrivacyLevel {
/**
* The stage instance is visible publicly, such as on stage discovery
*
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4296 | discord-api-docs#4296}
*/
Public = 1,
/**
@@ -56,9 +58,9 @@ export enum StageInstancePrivacyLevel {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure
*
* @see {@link https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure}
* @deprecated
* {@link https://github.com/discord/discord-api-docs/pull/4479 | discord-api-docs#4479}
*/
export interface APIInviteStageInstance {
/**
@@ -76,7 +78,7 @@ export interface APIInviteStageInstance {
/**
* The members speaking in the stage
*
* See https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure
* @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure}
*/
members: APIGuildMember[];
}

16
deno/payloads/v9/sticker.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/sticker#sticker-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object}
*/
export interface APISticker {
/**
@@ -32,20 +32,20 @@ export interface APISticker {
/**
* Previously the sticker asset hash, now an empty string
*
* @deprecated
* @deprecated This field is no longer documented by Discord and will be removed in v11
* @unstable This field is no longer documented by Discord and will be removed in v11
*/
asset?: '';
/**
* Type of sticker
*
* See https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types}
*/
type: StickerType;
/**
* Type of sticker format
*
* See https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types}
*/
format_type: StickerFormatType;
/**
@@ -67,7 +67,7 @@ export interface APISticker {
}
/**
* https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types}
*/
export enum StickerType {
/**
@@ -81,7 +81,7 @@ export enum StickerType {
}
/**
* https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types}
*/
export enum StickerFormatType {
PNG = 1,
@@ -91,12 +91,12 @@ export enum StickerFormatType {
}
/**
* https://discord.com/developers/docs/resources/sticker#sticker-item-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-item-object}
*/
export type APIStickerItem = Pick<APISticker, 'format_type' | 'id' | 'name'>;
/**
* https://discord.com/developers/docs/resources/sticker#sticker-pack-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-pack-object}
*/
export interface APIStickerPack {
/**

16
deno/payloads/v9/teams.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/topics/teams#data-models-team-object
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-team-object}
*/
export interface APITeam {
/**
@@ -32,19 +32,19 @@ export interface APITeam {
}
/**
* https://discord.com/developers/docs/topics/teams#data-models-team-member-object
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-team-member-object}
*/
export interface APITeamMember {
/**
* The user's membership state on the team
*
* See https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum}
*/
membership_state: TeamMemberMembershipState;
/**
* Will always be `["*"]`
*
* @deprecated Use `role` instead
* @deprecated Use {@link APITeamMember.role} instead.
*/
permissions: ['*'];
/**
@@ -54,19 +54,19 @@ export interface APITeamMember {
/**
* The avatar, discriminator, id, and username of the user
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user: APIUser;
/**
* The user's role in the team.
*
* See https://discord.com/developers/docs/topics/teams#team-member-roles
* @see {@link https://discord.com/developers/docs/topics/teams#team-member-roles}
*/
role: TeamMemberRole;
}
/**
* https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum}
*/
export enum TeamMemberMembershipState {
Invited = 1,
@@ -74,7 +74,7 @@ export enum TeamMemberMembershipState {
}
/**
* https://discord.com/developers/docs/topics/teams#team-member-roles-team-member-role-types
* @see {@link https://discord.com/developers/docs/topics/teams#team-member-roles-team-member-role-types}
*/
export enum TeamMemberRole {
Admin = 'admin',

4
deno/payloads/v9/template.ts
View File

@@ -8,7 +8,7 @@ import type { RESTPostAPIGuildsJSONBody } from '../../rest/v9/mod.ts';
import type { APIUser } from './user.ts';
/**
* https://discord.com/developers/docs/resources/guild-template#template-object
* @see {@link https://discord.com/developers/docs/resources/guild-template#template-object}
*/
export interface APITemplate {
/**
@@ -34,7 +34,7 @@ export interface APITemplate {
/**
* The user who created the template
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
creator: APIUser;
/**

53
deno/payloads/v9/user.ts
View File

@@ -6,7 +6,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildIntegration } from './guild.ts';
/**
* https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
export interface APIUser {
/**
@@ -28,7 +28,7 @@ export interface APIUser {
/**
* The user's avatar hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
avatar: string | null;
/**
@@ -46,7 +46,7 @@ export interface APIUser {
/**
* The user's banner hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
banner?: string | null;
/**
@@ -68,39 +68,38 @@ export interface APIUser {
/**
* The flags on a user's account
*
* See https://discord.com/developers/docs/resources/user#user-object-user-flags
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-flags}
*/
flags?: UserFlags;
/**
* The type of Nitro subscription on a user's account
*
* See https://discord.com/developers/docs/resources/user#user-object-premium-types
* @see {@link https://discord.com/developers/docs/resources/user#user-object-premium-types}
*/
premium_type?: UserPremiumType;
/**
* The public flags on a user's account
*
* See https://discord.com/developers/docs/resources/user#user-object-user-flags
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-flags}
*/
public_flags?: UserFlags;
/**
* The user's avatar decoration hash
*
* See https://discord.com/developers/docs/reference#image-formatting
*
* @deprecated Use `avatar_decoration_data` instead
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
* @deprecated Use {@link APIUser.avatar_decoration_data} instead
*/
avatar_decoration?: string | null;
/**
* The data for the user's avatar decoration
*
* See https://discord.com/developers/docs/resources/user#avatar-decoration-data-object
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
*/
avatar_decoration_data?: APIAvatarDecorationData | null;
}
/**
* https://discord.com/developers/docs/resources/user#user-object-user-flags
* @see {@link https://discord.com/developers/docs/resources/user#user-object-user-flags}
*/
export enum UserFlags {
/**
@@ -144,7 +143,7 @@ export enum UserFlags {
*/
PremiumEarlySupporter = 1 << 9,
/**
* User is a [team](https://discord.com/developers/docs/topics/teams)
* User is a {@link https://discord.com/developers/docs/topics/teams | team}
*/
TeamPseudoUser = 1 << 10,
/**
@@ -168,7 +167,7 @@ export enum UserFlags {
*/
CertifiedModerator = 1 << 18,
/**
* Bot uses only [HTTP interactions](https://discord.com/developers/docs/interactions/receiving-and-responding#receiving-an-interaction) and is shown in the online member list
* Bot uses only {@link https://discord.com/developers/docs/interactions/receiving-and-responding#receiving-an-interaction | HTTP interactions} and is shown in the online member list
*/
BotHTTPInteractions = 1 << 19,
/**
@@ -182,36 +181,36 @@ export enum UserFlags {
*/
DisablePremium = 1 << 21,
/**
* User is an [Active Developer](https://support-dev.discord.com/hc/articles/10113997751447)
* User is an {@link https://support-dev.discord.com/hc/articles/10113997751447 | Active Developer}
*/
ActiveDeveloper = 1 << 22,
/**
* User's account has been [quarantined](https://support.discord.com/hc/articles/6461420677527) based on recent activity
* User's account has been {@link https://support.discord.com/hc/articles/6461420677527 | quarantined} based on recent activity
*
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
* @privateRemarks
*
* This value would be 1 << 44, but bit shifting above 1 << 30 requires bigints
* This value would be `1 << 44`, but bit shifting above `1 << 30` requires bigints
*/
Quarantined = 17_592_186_044_416,
/**
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
* @privateRemarks
*
* This value would be 1 << 50, but bit shifting above 1 << 30 requires bigints
* This value would be `1 << 50`, but bit shifting above `1 << 30` requires bigints
*/
Collaborator = 1_125_899_906_842_624,
/**
* @unstable This user flag is currently not documented by Discord but has a known value which we will try to keep up to date.
* @privateRemarks
*
* This value would be 1 << 51, but bit shifting above 1 << 30 requires bigints
* This value would be `1 << 51`, but bit shifting above `1 << 30` requires bigints
*/
RestrictedCollaborator = 2_251_799_813_685_248,
}
/**
* https://discord.com/developers/docs/resources/user#user-object-premium-types
* @see {@link https://discord.com/developers/docs/resources/user#user-object-premium-types}
*/
export enum UserPremiumType {
None,
@@ -221,7 +220,7 @@ export enum UserPremiumType {
}
/**
* https://discord.com/developers/docs/resources/user#connection-object
* @see {@link https://discord.com/developers/docs/resources/user#connection-object}
*/
export interface APIConnection {
/**
@@ -235,7 +234,7 @@ export interface APIConnection {
/**
* The service of the connection
*
* See https://discord.com/developers/docs/resources/user#connection-object-services
* @see {@link https://discord.com/developers/docs/resources/user#connection-object-services}
*/
type: ConnectionService;
/**
@@ -245,7 +244,7 @@ export interface APIConnection {
/**
* An array of partial server integrations
*
* See https://discord.com/developers/docs/resources/guild#integration-object
* @see {@link https://discord.com/developers/docs/resources/guild#integration-object}
*/
integrations?: Partial<APIGuildIntegration>[];
/**
@@ -267,7 +266,7 @@ export interface APIConnection {
/**
* Visibility of this connection
*
* See https://discord.com/developers/docs/resources/user#connection-object-visibility-types
* @see {@link https://discord.com/developers/docs/resources/user#connection-object-visibility-types}
*/
visibility: ConnectionVisibility;
}
@@ -298,7 +297,7 @@ export enum ConnectionService {
Twitch = 'twitch',
X = 'twitter',
/**
* @deprecated This is the old name for {@apilink ConnectionService#X}
* @deprecated This is the old name for {@link ConnectionService.X}
*/
Twitter = X,
Xbox = 'xbox',
@@ -317,7 +316,7 @@ export enum ConnectionVisibility {
}
/**
* https://discord.com/developers/docs/resources/user#application-role-connection-object-application-role-connection-structure
* @see {@link https://discord.com/developers/docs/resources/user#application-role-connection-object-application-role-connection-structure}
*/
export interface APIApplicationRoleConnection {
/**
@@ -335,13 +334,13 @@ export interface APIApplicationRoleConnection {
}
/**
* https://discord.com/developers/docs/resources/user#avatar-decoration-data-object
* @see {@link https://discord.com/developers/docs/resources/user#avatar-decoration-data-object}
*/
export interface APIAvatarDecorationData {
/**
* The avatar decoration hash
*
* See https://discord.com/developers/docs/reference#image-formatting
* @see {@link https://discord.com/developers/docs/reference#image-formatting}
*/
asset: string;
/**

11
deno/payloads/v9/voice.ts
View File

@@ -6,14 +6,13 @@ import type { Snowflake } from '../../globals.ts';
import type { APIGuildMember } from './guild.ts';
/**
* https://discord.com/developers/docs/resources/voice#voice-state-object
*
* @deprecated This is deprecated, use {@apilink APIVoiceState}
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
* @deprecated This is deprecated, use {@link APIVoiceState}
*/
export type GatewayVoiceState = APIVoiceState;
/**
* https://discord.com/developers/docs/resources/voice#voice-state-object
* @see {@link https://discord.com/developers/docs/resources/voice#voice-state-object}
*/
export interface APIVoiceState {
/**
@@ -31,7 +30,7 @@ export interface APIVoiceState {
/**
* The guild member this voice state is for
*
* 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;
/**
@@ -73,7 +72,7 @@ export interface APIVoiceState {
}
/**
* https://discord.com/developers/docs/resources/voice#voice-region-object
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
*/
export interface APIVoiceRegion {
/**

20
deno/payloads/v9/webhook.ts
View File

@@ -14,7 +14,7 @@ import type {
} from './mod.ts';
/**
* https://discord.com/developers/docs/resources/webhook#webhook-object
* @see {@link https://discord.com/developers/docs/resources/webhook#webhook-object}
*/
export interface APIWebhook {
/**
@@ -24,7 +24,7 @@ export interface APIWebhook {
/**
* The type of the webhook
*
* See https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types
* @see {@link https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types}
*/
type: WebhookType;
/**
@@ -38,7 +38,7 @@ export interface APIWebhook {
/**
* The user this webhook was created by (not returned when getting a webhook with its token)
*
* See https://discord.com/developers/docs/resources/user#user-object
* @see {@link https://discord.com/developers/docs/resources/user#user-object}
*/
user?: APIUser;
/**
@@ -72,14 +72,14 @@ export interface APIWebhook {
}
/**
* https://discord.com/developers/docs/events/webhook-events#webhook-event-payloads
* @see {@link https://discord.com/developers/docs/events/webhook-events#webhook-event-payloads}
*/
export type APIWebhookEvent =
| APIWebhookEventBase<ApplicationWebhookType.Event, APIWebhookEventBody>
| APIWebhookEventBase<ApplicationWebhookType.Ping, never>;
/**
* https://discord.com/developers/docs/events/webhook-events#event-body-object
* @see {@link https://discord.com/developers/docs/events/webhook-events#event-body-object}
*/
export type APIWebhookEventBody =
| APIWebhookEventEventBase<
@@ -112,7 +112,7 @@ export type APIWebhookEventEntitlementCreateData = APIEntitlement;
export type APIWebhookEventQuestUserEnrollmentData = never;
interface APIWebhookEventBase<Type extends ApplicationWebhookType, Event> {
export interface APIWebhookEventBase<Type extends ApplicationWebhookType, Event> {
/**
* Version scheme for the webhook event. Currently always `1`
*/
@@ -132,7 +132,7 @@ interface APIWebhookEventBase<Type extends ApplicationWebhookType, Event> {
}
/**
* https://discord.com/developers/docs/events/webhook-events#webhook-types
* @see {@link https://discord.com/developers/docs/events/webhook-events#webhook-types}
*/
export enum ApplicationWebhookType {
/**
@@ -145,7 +145,7 @@ export enum ApplicationWebhookType {
Event,
}
interface APIWebhookEventEventBase<Type extends ApplicationWebhookEventType, Data> {
export interface APIWebhookEventEventBase<Type extends ApplicationWebhookEventType, Data> {
/**
* Event type
*/
@@ -161,7 +161,7 @@ interface APIWebhookEventEventBase<Type extends ApplicationWebhookEventType, Dat
}
/**
* https://discord.com/developers/docs/events/webhook-events#event-types
* @see {@link https://discord.com/developers/docs/events/webhook-events#event-types}
*/
export enum ApplicationWebhookEventType {
/**
@@ -179,7 +179,7 @@ export enum ApplicationWebhookEventType {
}
/**
* https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types
* @see {@link https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types}
*/
export enum WebhookType {
/**

6
deno/rest/common.ts
View File

@@ -1,5 +1,5 @@
/**
* https://discord.com/developers/docs/topics/opcodes-and-status-codes#json-json-error-codes
* @see {@link https://discord.com/developers/docs/topics/opcodes-and-status-codes#json-json-error-codes}
*/
export enum RESTJSONErrorCodes {
GeneralError,
@@ -325,7 +325,7 @@ export enum RESTJSONErrorCodes {
}
/**
* https://discord.com/developers/docs/reference#locales
* @see {@link https://discord.com/developers/docs/reference#locales}
*/
export enum Locale {
Indonesian = 'id',
@@ -363,6 +363,6 @@ export enum Locale {
}
/**
* @deprecated Use {@apilink Locale} instead.
* @deprecated Use {@link Locale} instead.
*/
export type LocaleString = `${Locale}`;

18
deno/rest/v10/application.ts
View File

@@ -1,31 +1,31 @@
import type { APIApplication, APIApplicationRoleConnectionMetadata } from '../../payloads/v10/application.ts';
import type { Nullable, StrictPartial } from '../../utils/internals.ts';
import type { _Nullable, _StrictPartial } from '../../utils/internals.ts';
/**
* https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records
* @see {@link https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records}
*/
export type RESTGetAPIApplicationRoleConnectionMetadataResult = APIApplicationRoleConnectionMetadata[];
/**
* https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records
* @see {@link https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records}
*/
export type RESTPutAPIApplicationRoleConnectionMetadataJSONBody = APIApplicationRoleConnectionMetadata[];
/**
* https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records
* @see {@link https://discord.com/developers/docs/resources/application-role-connection-metadata#update-application-role-connection-metadata-records}
*/
export type RESTPutAPIApplicationRoleConnectionMetadataResult = APIApplicationRoleConnectionMetadata[];
/**
* https://discord.com/developers/docs/resources/application#get-current-application
* @see {@link https://discord.com/developers/docs/resources/application#get-current-application}
*/
export type RESTGetCurrentApplicationResult = APIApplication;
/**
* https://discord.com/developers/docs/resources/application#edit-current-application
* @see {@link https://discord.com/developers/docs/resources/application#edit-current-application}
*/
export type RESTPatchCurrentApplicationJSONBody = StrictPartial<
Nullable<Pick<APIApplication, 'cover_image' | 'icon'>> &
export type RESTPatchCurrentApplicationJSONBody = _StrictPartial<
_Nullable<Pick<APIApplication, 'cover_image' | 'icon'>> &
Pick<
APIApplication,
| 'custom_install_url'
@@ -40,6 +40,6 @@ export type RESTPatchCurrentApplicationJSONBody = StrictPartial<
>;
/**
* https://discord.com/developers/docs/resources/application#edit-current-application
* @see {@link https://discord.com/developers/docs/resources/application#edit-current-application}
*/
export type RESTPatchCurrentApplicationResult = APIApplication;

4
deno/rest/v10/auditLog.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIAuditLog, AuditLogEvent } from '../../payloads/v10/auditLog.ts';
/**
* https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log
* @see {@link https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log}
*/
export interface RESTGetAPIAuditLogQuery {
/**
@@ -24,7 +24,7 @@ export interface RESTGetAPIAuditLogQuery {
/**
* How many entries are returned (default 50, minimum 1, maximum 100)
*
* @default 50
* @defaultValue `50`
*/
limit?: number;
}

18
deno/rest/v10/autoModeration.ts
View File

@@ -8,17 +8,17 @@ import type {
} from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild
* @see {@link https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild}
*/
export type RESTGetAPIAutoModerationRulesResult = APIAutoModerationRule[];
/**
* https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule
* @see {@link https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule}
*/
export type RESTGetAPIAutoModerationRuleResult = APIAutoModerationRule;
/**
* https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule
* @see {@link https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule}
*/
export interface RESTPostAPIAutoModerationRuleJSONBody {
/**
@@ -36,7 +36,7 @@ export interface RESTPostAPIAutoModerationRuleJSONBody {
/**
* The rule trigger metadata
*
* Can be omitted if the trigger type is {@link AutoModerationRuleTriggerType.HarmfulLink} or {@link AutoModerationRuleTriggerType.Spam}
* Can be omitted if the trigger type is {@link AutoModerationRuleTriggerType.Spam}
*/
trigger_metadata?: APIAutoModerationRuleTriggerMetadata | undefined;
/**
@@ -46,7 +46,7 @@ export interface RESTPostAPIAutoModerationRuleJSONBody {
/**
* Whether this rule is enabled
*
* @default false
* @defaultValue `false`
*/
enabled?: boolean | undefined;
/**
@@ -60,12 +60,12 @@ export interface RESTPostAPIAutoModerationRuleJSONBody {
}
/**
* https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule
* @see {@link https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule}
*/
export type RESTPostAPIAutoModerationRuleResult = APIAutoModerationRule;
/**
* https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule
* @see {@link https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule}
*/
export type RESTPatchAPIAutoModerationRuleJSONBody = Omit<
Partial<RESTPostAPIAutoModerationRuleJSONBody>,
@@ -73,11 +73,11 @@ export type RESTPatchAPIAutoModerationRuleJSONBody = Omit<
>;
/**
* https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule
* @see {@link https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule}
*/
export type RESTPatchAPIAutoModerationRuleResult = APIAutoModerationRule;
/**
* https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule
* @see {@link https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule}
*/
export type RESTDeleteAPIAutoModerationRuleResult = never;

177
deno/rest/v10/channel.ts
View File

@@ -26,7 +26,7 @@ import type {
ChannelFlags,
APIAttachment,
} from '../../payloads/v10/mod.ts';
import type { AddUndefinedToPossiblyUndefinedPropertiesOfInterface, StrictPartial } from '../../utils/internals.ts';
import type { _AddUndefinedToPossiblyUndefinedPropertiesOfInterface, _StrictPartial } from '../../utils/internals.ts';
import type { RESTAPIPoll } from './poll.ts';
export interface RESTAPIChannelPatchOverwrite extends RESTPutAPIChannelPermissionJSONBody {
@@ -39,12 +39,12 @@ export interface RESTAPIChannelPatchOverwrite extends RESTPutAPIChannelPermissio
export type APIChannelPatchOverwrite = RESTAPIChannelPatchOverwrite;
/**
* https://discord.com/developers/docs/resources/channel#get-channel
* @see {@link https://discord.com/developers/docs/resources/channel#get-channel}
*/
export type RESTGetAPIChannelResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/channel#modify-channel
* @see {@link https://discord.com/developers/docs/resources/channel#modify-channel}
*/
export interface RESTPatchAPIChannelJSONBody {
/**
@@ -114,13 +114,13 @@ export interface RESTPatchAPIChannelJSONBody {
/**
* 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 | undefined;
/**
* The camera video quality mode of the voice channel
*
* 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 | null | undefined;
/**
@@ -197,17 +197,17 @@ export interface RESTPatchAPIChannelJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#modify-channel
* @see {@link https://discord.com/developers/docs/resources/channel#modify-channel}
*/
export type RESTPatchAPIChannelResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/channel#deleteclose-channel
* @see {@link https://discord.com/developers/docs/resources/channel#deleteclose-channel}
*/
export type RESTDeleteAPIChannelResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/channel#get-channel-messages
* @see {@link https://discord.com/developers/docs/resources/channel#get-channel-messages}
*/
export interface RESTGetAPIChannelMessagesQuery {
/**
@@ -225,32 +225,32 @@ export interface RESTGetAPIChannelMessagesQuery {
/**
* Max number of messages to return (1-100)
*
* @default 50
* @defaultValue `50`
*/
limit?: number;
}
/**
* https://discord.com/developers/docs/resources/channel#get-channel-messages
* @see {@link https://discord.com/developers/docs/resources/channel#get-channel-messages}
*/
export type RESTGetAPIChannelMessagesResult = APIMessage[];
/**
* https://discord.com/developers/docs/resources/channel#get-channel-message
* @see {@link https://discord.com/developers/docs/resources/channel#get-channel-message}
*/
export type RESTGetAPIChannelMessageResult = APIMessage;
/**
* 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 type RESTAPIMessageReference = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
export type RESTAPIMessageReference = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
Required<Pick<APIMessageReference, 'message_id'>>
> &
StrictPartial<APIMessageReference> & {
_StrictPartial<APIMessageReference> & {
/**
* Whether to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message
*
* @default true
* @defaultValue `true`
*/
fail_if_not_exists?: boolean | undefined;
};
@@ -261,7 +261,7 @@ export type RESTAPIMessageReference = AddUndefinedToPossiblyUndefinedPropertiesO
export type APIMessageReferenceSend = RESTAPIMessageReference;
/**
* 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 type RESTAPIAttachment = Partial<
Pick<APIAttachment, 'description' | 'duration_secs' | 'filename' | 'title' | 'waveform'>
@@ -273,7 +273,7 @@ export type RESTAPIAttachment = Partial<
};
/**
* https://discord.com/developers/docs/resources/channel#create-message
* @see {@link https://discord.com/developers/docs/resources/channel#create-message}
*/
export interface RESTPostAPIChannelMessageJSONBody {
/**
@@ -291,31 +291,31 @@ export interface RESTPostAPIChannelMessageJSONBody {
/**
* Embedded `rich` content (up to 6000 characters)
*
* See https://discord.com/developers/docs/resources/channel#embed-object
* @see {@link https://discord.com/developers/docs/resources/channel#embed-object}
*/
embeds?: APIEmbed[] | undefined;
/**
* Allowed mentions for a message
*
* See https://discord.com/developers/docs/resources/channel#allowed-mentions-object
* @see {@link https://discord.com/developers/docs/resources/channel#allowed-mentions-object}
*/
allowed_mentions?: APIAllowedMentions | undefined;
/**
* Include to make your message a reply or a forward
*
* 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?: RESTAPIMessageReference | undefined;
/**
* The components to include with the message
*
* See https://discord.com/developers/docs/interactions/message-components#component-object
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
*/
components?: APIActionRowComponent<APIMessageActionRowComponent>[] | undefined;
/**
* IDs of up to 3 stickers in the server to send in the message
*
* See https://discord.com/developers/docs/resources/sticker#sticker-object
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object}
*/
sticker_ids?: [Snowflake, Snowflake, Snowflake] | [Snowflake, Snowflake] | [Snowflake] | undefined;
/**
@@ -338,7 +338,7 @@ export interface RESTPostAPIChannelMessageJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#create-message
* @see {@link https://discord.com/developers/docs/resources/channel#create-message}
*/
export type RESTPostAPIChannelMessageFormDataBody =
| (Record<`files[${bigint}]`, unknown> & {
@@ -350,22 +350,22 @@ export type RESTPostAPIChannelMessageFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPostAPIChannelMessageJSONBody);
/**
* https://discord.com/developers/docs/resources/channel#create-message
* @see {@link https://discord.com/developers/docs/resources/channel#create-message}
*/
export type RESTPostAPIChannelMessageResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/channel#crosspost-message
* @see {@link https://discord.com/developers/docs/resources/channel#crosspost-message}
*/
export type RESTPostAPIChannelMessageCrosspostResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/channel#create-reaction
* @see {@link https://discord.com/developers/docs/resources/channel#create-reaction}
*/
export type RESTPutAPIChannelMessageReactionResult = never;
/**
* https://discord.com/developers/docs/resources/channel#delete-own-reaction
* @see {@link https://discord.com/developers/docs/resources/channel#delete-own-reaction}
*/
export type RESTDeleteAPIChannelMessageOwnReactionResult = never;
@@ -375,12 +375,12 @@ export type RESTDeleteAPIChannelMessageOwnReactionResult = never;
export type RESTDeleteAPIChannelMessageOwnReaction = RESTDeleteAPIChannelMessageOwnReactionResult;
/**
* https://discord.com/developers/docs/resources/channel#delete-user-reaction
* @see {@link https://discord.com/developers/docs/resources/channel#delete-user-reaction}
*/
export type RESTDeleteAPIChannelMessageUserReactionResult = never;
/**
* https://discord.com/developers/docs/resources/channel#get-reactions
* @see {@link https://discord.com/developers/docs/resources/channel#get-reactions}
*/
export interface RESTGetAPIChannelMessageReactionUsersQuery {
/**
@@ -394,13 +394,13 @@ export interface RESTGetAPIChannelMessageReactionUsersQuery {
/**
* Max number of users to return (1-100)
*
* @default 25
* @defaultValue `25`
*/
limit?: number;
}
/**
* https://discord.com/developers/docs/resources/channel#get-reactions-reaction-types
* @see {@link https://discord.com/developers/docs/resources/channel#get-reactions-reaction-types}
*/
export enum ReactionType {
Normal,
@@ -408,22 +408,22 @@ export enum ReactionType {
}
/**
* https://discord.com/developers/docs/resources/channel#get-reactions
* @see {@link https://discord.com/developers/docs/resources/channel#get-reactions}
*/
export type RESTGetAPIChannelMessageReactionUsersResult = APIUser[];
/**
* https://discord.com/developers/docs/resources/channel#delete-all-reactions
* @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions}
*/
export type RESTDeleteAPIChannelAllMessageReactionsResult = never;
/**
* https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji
* @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji}
*/
export type RESTDeleteAPIChannelMessageReactionResult = never;
/**
* https://discord.com/developers/docs/resources/channel#edit-message
* @see {@link https://discord.com/developers/docs/resources/channel#edit-message}
*/
export interface RESTPatchAPIChannelMessageJSONBody {
/**
@@ -433,7 +433,7 @@ export interface RESTPatchAPIChannelMessageJSONBody {
/**
* Embedded `rich` content (up to 6000 characters)
*
* See https://discord.com/developers/docs/resources/channel#embed-object
* @see {@link https://discord.com/developers/docs/resources/channel#embed-object}
*/
embeds?: APIEmbed[] | null | undefined;
/**
@@ -442,13 +442,13 @@ export interface RESTPatchAPIChannelMessageJSONBody {
* When specifying flags, ensure to include all previously set flags/bits
* in addition to ones that you are modifying
*
* See https://discord.com/developers/docs/resources/channel#message-object-message-flags
* @see {@link https://discord.com/developers/docs/resources/channel#message-object-message-flags}
*/
flags?: MessageFlags | null | undefined;
/**
* Allowed mentions for the message
*
* See https://discord.com/developers/docs/resources/channel#allowed-mentions-object
* @see {@link https://discord.com/developers/docs/resources/channel#allowed-mentions-object}
*/
allowed_mentions?: APIAllowedMentions | null | undefined;
/**
@@ -456,19 +456,19 @@ export interface RESTPatchAPIChannelMessageJSONBody {
*
* Starting with API v10, the `attachments` array must contain all attachments that should be present after edit, including **retained and new** attachments provided in the request body.
*
* 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}
*/
attachments?: RESTAPIAttachment[] | undefined;
/**
* The components to include with the message
*
* See https://discord.com/developers/docs/interactions/message-components#component-object
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
*/
components?: APIActionRowComponent<APIMessageActionRowComponent>[] | null | undefined;
}
/**
* https://discord.com/developers/docs/resources/channel#edit-message
* @see {@link https://discord.com/developers/docs/resources/channel#edit-message}
*/
export type RESTPatchAPIChannelMessageFormDataBody =
| (Record<`files[${bigint}]`, unknown> & {
@@ -480,17 +480,17 @@ export type RESTPatchAPIChannelMessageFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPatchAPIChannelMessageJSONBody);
/**
* https://discord.com/developers/docs/resources/channel#edit-message
* @see {@link https://discord.com/developers/docs/resources/channel#edit-message}
*/
export type RESTPatchAPIChannelMessageResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/channel#delete-message
* @see {@link https://discord.com/developers/docs/resources/channel#delete-message}
*/
export type RESTDeleteAPIChannelMessageResult = never;
/**
* https://discord.com/developers/docs/resources/channel#bulk-delete-messages
* @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages}
*/
export interface RESTPostAPIChannelMessagesBulkDeleteJSONBody {
/**
@@ -500,28 +500,26 @@ export interface RESTPostAPIChannelMessagesBulkDeleteJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#bulk-delete-messages
* @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages}
*/
export type RESTPostAPIChannelMessagesBulkDeleteResult = never;
/**
* https://discord.com/developers/docs/resources/channel#edit-channel-permissions
* @see {@link https://discord.com/developers/docs/resources/channel#edit-channel-permissions}
*/
export interface RESTPutAPIChannelPermissionJSONBody {
/**
* The bitwise value of all allowed permissions
*
* See https://en.wikipedia.org/wiki/Bit_field
*
* @default "0"
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
* @defaultValue `"0"`
*/
allow?: Permissions | null | undefined;
/**
* The bitwise value of all disallowed permissions
*
* See https://en.wikipedia.org/wiki/Bit_field
*
* @default "0"
* @see {@link https://en.wikipedia.org/wiki/Bit_field}
* @defaultValue `"0"`
*/
deny?: Permissions | null | undefined;
/**
@@ -531,48 +529,48 @@ export interface RESTPutAPIChannelPermissionJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#edit-channel-permissions
* @see {@link https://discord.com/developers/docs/resources/channel#edit-channel-permissions}
*/
export type RESTPutAPIChannelPermissionResult = never;
/**
* https://discord.com/developers/docs/resources/channel#get-channel-invites
* @see {@link https://discord.com/developers/docs/resources/channel#get-channel-invites}
*/
export type RESTGetAPIChannelInvitesResult = APIExtendedInvite[];
/**
* https://discord.com/developers/docs/resources/channel#create-channel-invite
* @see {@link https://discord.com/developers/docs/resources/channel#create-channel-invite}
*/
export interface RESTPostAPIChannelInviteJSONBody {
/**
* Duration of invite in seconds before expiry, or 0 for never
*
* @default 86400 (24 hours)
* @defaultValue `86400` (24 hours)
*/
max_age?: number | undefined;
/**
* Max number of uses or 0 for unlimited
*
* @default 0
* @defaultValue `0`
*/
max_uses?: number | undefined;
/**
* Whether this invite only grants temporary membership
*
* @default false
* @defaultValue `false`
*/
temporary?: boolean | undefined;
/**
* If true, don't try to reuse a similar invite
* (useful for creating many unique one time use invites)
*
* @default false
* @defaultValue `false`
*/
unique?: boolean | undefined;
/**
* 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 | undefined;
/**
@@ -590,17 +588,17 @@ export interface RESTPostAPIChannelInviteJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#create-channel-invite
* @see {@link https://discord.com/developers/docs/resources/channel#create-channel-invite}
*/
export type RESTPostAPIChannelInviteResult = APIExtendedInvite;
/**
* https://discord.com/developers/docs/resources/channel#delete-channel-permission
* @see {@link https://discord.com/developers/docs/resources/channel#delete-channel-permission}
*/
export type RESTDeleteAPIChannelPermissionResult = never;
/**
* https://discord.com/developers/docs/resources/channel#follow-news-channel
* @see {@link https://discord.com/developers/docs/resources/channel#follow-news-channel}
*/
export interface RESTPostAPIChannelFollowersJSONBody {
/**
@@ -610,32 +608,32 @@ export interface RESTPostAPIChannelFollowersJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#follow-news-channel
* @see {@link https://discord.com/developers/docs/resources/channel#follow-news-channel}
*/
export type RESTPostAPIChannelFollowersResult = APIFollowedChannel;
/**
* https://discord.com/developers/docs/resources/channel#trigger-typing-indicator
* @see {@link https://discord.com/developers/docs/resources/channel#trigger-typing-indicator}
*/
export type RESTPostAPIChannelTypingResult = never;
/**
* https://discord.com/developers/docs/resources/channel#get-pinned-messages
* @see {@link https://discord.com/developers/docs/resources/channel#get-pinned-messages}
*/
export type RESTGetAPIChannelPinsResult = APIMessage[];
/**
* https://discord.com/developers/docs/resources/channel#pin-message
* @see {@link https://discord.com/developers/docs/resources/channel#pin-message}
*/
export type RESTPutAPIChannelPinResult = never;
/**
* https://discord.com/developers/docs/resources/channel#unpin-message
* @see {@link https://discord.com/developers/docs/resources/channel#unpin-message}
*/
export type RESTDeleteAPIChannelPinResult = never;
/**
* https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
* @see {@link https://discord.com/developers/docs/resources/channel#group-dm-add-recipient}
*/
export interface RESTPutAPIChannelRecipientJSONBody {
/**
@@ -649,17 +647,17 @@ export interface RESTPutAPIChannelRecipientJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
* @see {@link https://discord.com/developers/docs/resources/channel#group-dm-add-recipient}
*/
export type RESTPutAPIChannelRecipientResult = unknown;
/**
* https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient
* @see {@link https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient}
*/
export type RESTDeleteAPIChannelRecipientResult = unknown;
/**
* https://discord.com/developers/docs/resources/channel#start-thread-from-message
* @see {@link https://discord.com/developers/docs/resources/channel#start-thread-from-message}
*/
export interface RESTPostAPIChannelMessagesThreadsJSONBody {
/**
@@ -677,7 +675,7 @@ export interface RESTPostAPIChannelMessagesThreadsJSONBody {
}
/**
* https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel
* @see {@link https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel}
*/
export type RESTPostAPIGuildForumThreadsJSONBody = RESTPostAPIChannelMessagesThreadsJSONBody & {
/**
@@ -691,7 +689,7 @@ export type RESTPostAPIGuildForumThreadsJSONBody = RESTPostAPIChannelMessagesThr
};
/**
* https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel
* @see {@link https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel}
*/
export type RESTPostAPIGuildForumThreadsFormDataBody = RESTPostAPIChannelMessagesThreadsJSONBody & {
/**
@@ -701,12 +699,12 @@ export type RESTPostAPIGuildForumThreadsFormDataBody = RESTPostAPIChannelMessage
};
/**
* https://discord.com/developers/docs/resources/channel#start-thread-from-message
* @see {@link https://discord.com/developers/docs/resources/channel#start-thread-from-message}
*/
export type RESTPostAPIChannelMessagesThreadsResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/channel#start-thread-without-message
* @see {@link https://discord.com/developers/docs/resources/channel#start-thread-without-message}
*/
export interface RESTPostAPIChannelThreadsJSONBody extends RESTPostAPIChannelMessagesThreadsJSONBody {
/**
@@ -715,9 +713,8 @@ export interface RESTPostAPIChannelThreadsJSONBody extends RESTPostAPIChannelMes
* In API v9 and v10, `type` defaults to `PRIVATE_THREAD`.
* In a future API version this will be changed to be a required field, with no default.
*
* See https://discord.com/developers/docs/resources/channel#channel-object-channel-types
*
* @default ChannelType.PrivateThread
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object-channel-types}
* @defaultValue `ChannelType.PrivateThread`
*/
type?: ThreadChannelType | undefined;
/**
@@ -727,22 +724,22 @@ export interface RESTPostAPIChannelThreadsJSONBody extends RESTPostAPIChannelMes
}
/**
* https://discord.com/developers/docs/resources/channel#start-thread-without-message
* @see {@link https://discord.com/developers/docs/resources/channel#start-thread-without-message}
*/
export type RESTPostAPIChannelThreadsResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/channel#join-thread
* @see {@link https://discord.com/developers/docs/resources/channel#join-thread}
*/
export type RESTPutAPIChannelThreadMembersResult = never;
/**
* https://discord.com/developers/docs/resources/channel#leave-thread
* @see {@link https://discord.com/developers/docs/resources/channel#leave-thread}
*/
export type RESTDeleteAPIChannelThreadMembersResult = never;
/**
* https://discord.com/developers/docs/resources/channel#get-thread-member
* @see {@link https://discord.com/developers/docs/resources/channel#get-thread-member}
*/
export interface RESTGetAPIChannelThreadMemberQuery {
/**
@@ -752,12 +749,12 @@ export interface RESTGetAPIChannelThreadMemberQuery {
}
/**
* https://discord.com/developers/docs/resources/channel#get-thread-member
* @see {@link https://discord.com/developers/docs/resources/channel#get-thread-member}
*/
export type RESTGetAPIChannelThreadMemberResult = APIThreadMember;
/**
* https://discord.com/developers/docs/resources/channel#list-thread-members
* @see {@link https://discord.com/developers/docs/resources/channel#list-thread-members}
*/
export interface RESTGetAPIChannelThreadMembersQuery {
/**
@@ -775,12 +772,12 @@ export interface RESTGetAPIChannelThreadMembersQuery {
}
/**
* https://discord.com/developers/docs/resources/channel#list-thread-members
* @see {@link https://discord.com/developers/docs/resources/channel#list-thread-members}
*/
export type RESTGetAPIChannelThreadMembersResult = APIThreadMember[];
/**
* https://discord.com/developers/docs/resources/channel#list-public-archived-threads
* @see {@link https://discord.com/developers/docs/resources/channel#list-public-archived-threads}
*/
export interface RESTGetAPIChannelThreadsArchivedQuery {
/**
@@ -794,17 +791,17 @@ export interface RESTGetAPIChannelThreadsArchivedQuery {
}
/**
* https://discord.com/developers/docs/resources/channel#list-public-archived-threads
* @see {@link https://discord.com/developers/docs/resources/channel#list-public-archived-threads}
*/
export type RESTGetAPIChannelThreadsArchivedPublicResult = RESTGetAPIChannelUsersThreadsArchivedResult;
/**
* https://discord.com/developers/docs/resources/channel#list-private-archived-threads
* @see {@link https://discord.com/developers/docs/resources/channel#list-private-archived-threads}
*/
export type RESTGetAPIChannelThreadsArchivedPrivateResult = RESTGetAPIChannelUsersThreadsArchivedResult;
/**
* https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads
* @see {@link https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads}
*/
export interface RESTGetAPIChannelUsersThreadsArchivedResult extends APIThreadList {
/**

30
deno/rest/v10/emoji.ts
View File

@@ -2,17 +2,17 @@ import type { Snowflake } from '../../globals.ts';
import type { APIEmoji } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/emoji#list-guild-emojis
* @see {@link https://discord.com/developers/docs/resources/emoji#list-guild-emojis}
*/
export type RESTGetAPIGuildEmojisResult = APIEmoji[];
/**
* https://discord.com/developers/docs/resources/emoji#get-guild-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#get-guild-emoji}
*/
export type RESTGetAPIGuildEmojiResult = APIEmoji;
/**
* https://discord.com/developers/docs/resources/emoji#create-guild-emoji-json-params
* @see {@link https://discord.com/developers/docs/resources/emoji#create-guild-emoji-json-params}
*/
export interface RESTPostAPIGuildEmojiJSONBody {
/**
@@ -22,7 +22,7 @@ export interface RESTPostAPIGuildEmojiJSONBody {
/**
* The 128x128 emoji image
*
* https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
image: string;
/**
@@ -32,12 +32,12 @@ export interface RESTPostAPIGuildEmojiJSONBody {
}
/**
* https://discord.com/developers/docs/resources/emoji#create-guild-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#create-guild-emoji}
*/
export type RESTPostAPIGuildEmojiResult = APIEmoji;
/**
* https://discord.com/developers/docs/resources/emoji#modify-guild-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-guild-emoji}
*/
export interface RESTPatchAPIGuildEmojiJSONBody {
/**
@@ -51,48 +51,48 @@ export interface RESTPatchAPIGuildEmojiJSONBody {
}
/**
* https://discord.com/developers/docs/resources/emoji#modify-guild-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-guild-emoji}
*/
export type RESTPatchAPIGuildEmojiResult = APIEmoji;
/**
* https://discord.com/developers/docs/resources/emoji#delete-guild-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#delete-guild-emoji}
*/
export type RESTDeleteAPIGuildEmojiResult = never;
/**
* https://discord.com/developers/docs/resources/emoji#list-application-emojis
* @see {@link https://discord.com/developers/docs/resources/emoji#list-application-emojis}
*/
export interface RESTGetAPIApplicationEmojisResult {
items: APIEmoji[];
}
/**
* https://discord.com/developers/docs/resources/emoji#get-application-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#get-application-emoji}
*/
export type RESTGetAPIApplicationEmojiResult = APIEmoji;
/**
* https://discord.com/developers/docs/resources/emoji#create-application-emoji-json-params
* @see {@link https://discord.com/developers/docs/resources/emoji#create-application-emoji-json-params}
*/
export type RESTPostAPIApplicationEmojiJSONBody = Pick<RESTPostAPIGuildEmojiJSONBody, 'image' | 'name'>;
/**
* https://discord.com/developers/docs/resources/emoji#create-application-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#create-application-emoji}
*/
export type RESTPostAPIApplicationEmojiResult = APIEmoji;
/**
* https://discord.com/developers/docs/resources/emoji#modify-application-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-application-emoji}
*/
export type RESTPatchAPIApplicationEmojiJSONBody = Pick<RESTPatchAPIGuildEmojiJSONBody, 'name'>;
/**
* https://discord.com/developers/docs/resources/emoji#modify-application-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#modify-application-emoji}
*/
export type RESTPatchAPIApplicationEmojiResult = APIEmoji;
/**
* https://discord.com/developers/docs/resources/emoji#delete-application-emoji
* @see {@link https://discord.com/developers/docs/resources/emoji#delete-application-emoji}
*/
export type RESTDeleteAPIApplicationEmojiResult = never;

4
deno/rest/v10/gateway.ts
View File

@@ -1,11 +1,11 @@
import type { APIGatewayBotInfo, APIGatewayInfo } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/topics/gateway#get-gateway
* @see {@link https://discord.com/developers/docs/topics/gateway#get-gateway}
*/
export type RESTGetAPIGatewayResult = APIGatewayInfo;
/**
* https://discord.com/developers/docs/topics/gateway#get-gateway-bot
* @see {@link https://discord.com/developers/docs/topics/gateway#get-gateway-bot}
*/
export type RESTGetAPIGatewayBotResult = APIGatewayBotInfo;

243
deno/rest/v10/guild.ts
View File

@@ -28,12 +28,12 @@ import type {
APIGuildOnboardingPromptOption,
} from '../../payloads/v10/mod.ts';
import type {
AddUndefinedToPossiblyUndefinedPropertiesOfInterface,
DistributiveOmit,
DistributivePick,
Nullable,
StrictPartial,
StrictRequired,
_AddUndefinedToPossiblyUndefinedPropertiesOfInterface,
_DistributiveOmit,
_DistributivePick,
_Nullable,
_StrictPartial,
_StrictRequired,
} from '../../utils/internals.ts';
import type { Locale } from '../common.ts';
import type { RESTPutAPIChannelPermissionJSONBody } from './channel.ts';
@@ -54,8 +54,8 @@ export type RESTAPIGuildChannelResolvable = Exclude<APIChannel, APIDMChannel | A
*/
export type APIGuildChannelResolvable = RESTAPIGuildChannelResolvable;
export type RESTAPIGuildCreatePartialChannel = StrictPartial<
DistributivePick<
export type RESTAPIGuildCreatePartialChannel = _StrictPartial<
_DistributivePick<
RESTAPIGuildChannelResolvable,
| 'available_tags'
| 'bitrate'
@@ -96,7 +96,7 @@ export interface RESTAPIGuildCreateRole extends RESTPostAPIGuildRoleJSONBody {
export type APIGuildCreateRole = RESTAPIGuildCreateRole;
/**
* https://discord.com/developers/docs/resources/guild#create-guild
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild}
*/
export interface RESTPostAPIGuildsJSONBody {
/**
@@ -106,31 +106,31 @@ export interface RESTPostAPIGuildsJSONBody {
/**
* Voice region id
*
* See https://discord.com/developers/docs/resources/voice#voice-region-object
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
*/
region?: string | undefined;
/**
* base64 1024x1024 png/jpeg image for the guild icon
*
* See https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
icon?: string | undefined;
/**
* Verification level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
verification_level?: GuildVerificationLevel | undefined;
/**
* Default message notification level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level}
*/
default_message_notifications?: GuildDefaultMessageNotifications | undefined;
/**
* Explicit content filter level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level}
*/
explicit_content_filter?: GuildExplicitContentFilter | undefined;
/**
@@ -143,8 +143,7 @@ export interface RESTPostAPIGuildsJSONBody {
* Also, the required `id` field within each role object is an integer placeholder,
* and will be replaced by the API upon consumption. Its purpose is to allow you to overwrite a role's permissions
* in a channel when also passing in channels with the channels array.
*
* See https://discord.com/developers/docs/topics/permissions#role-object
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
roles?: RESTAPIGuildCreateRole[] | undefined;
/**
@@ -157,8 +156,7 @@ export interface RESTPostAPIGuildsJSONBody {
* and will be replaced by the API upon consumption. Its purpose is to allow you to create `GUILD_CATEGORY` channels
* by setting the `parent_id` field on any children to the category's id field.
* Category channels must be listed before any children.
*
* See https://discord.com/developers/docs/resources/channel#channel-object
* @see {@link https://discord.com/developers/docs/resources/channel#channel-object}
*/
channels?: RESTAPIGuildCreatePartialChannel[] | undefined;
/**
@@ -176,7 +174,7 @@ export interface RESTPostAPIGuildsJSONBody {
/**
* System channel flags
*
* See https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags}
*/
system_channel_flags?: GuildSystemChannelFlags | undefined;
/**
@@ -186,51 +184,51 @@ export interface RESTPostAPIGuildsJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#create-guild
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild}
*/
export type RESTPostAPIGuildsResult = APIGuild;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level}
*/
export interface RESTPostAPIGuildsMFAJSONBody {
/**
* MFA level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-mfa-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-mfa-level}
*/
level: GuildMFALevel;
}
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level}
*/
export type RESTPostAPIGuildsMFAResult = RESTPostAPIGuildsMFAJSONBody;
/**
* https://discord.com/developers/docs/resources/guild#get-guild
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild}
*/
export interface RESTGetAPIGuildQuery {
/**
* When `true`, will return approximate member and presence counts for the guild
*
* @default false
* @defaultValue `false`
*/
with_counts?: boolean;
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild}
*/
export type RESTGetAPIGuildResult = APIGuild;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-preview
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-preview}
*/
export type RESTGetAPIGuildPreviewResult = APIGuildPreview;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild}
*/
export interface RESTPatchAPIGuildJSONBody {
/**
@@ -240,25 +238,25 @@ export interface RESTPatchAPIGuildJSONBody {
/**
* Voice region id
*
* See https://discord.com/developers/docs/resources/voice#voice-region-object
* @see {@link https://discord.com/developers/docs/resources/voice#voice-region-object}
*/
region?: string | null | undefined;
/**
* Verification level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-verification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-verification-level}
*/
verification_level?: GuildVerificationLevel | null | undefined;
/**
* Default message notification level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level}
*/
default_message_notifications?: GuildDefaultMessageNotifications | null | undefined;
/**
* Explicit content filter level
*
* See https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level}
*/
explicit_content_filter?: GuildExplicitContentFilter | null | undefined;
/**
@@ -272,7 +270,7 @@ export interface RESTPatchAPIGuildJSONBody {
/**
* base64 1024x1024 png/jpeg/gif image for the guild icon (can be animated gif when the guild has `ANIMATED_ICON` feature)
*
* See https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
icon?: string | null | undefined;
/**
@@ -282,7 +280,7 @@ export interface RESTPatchAPIGuildJSONBody {
/**
* base64 16:9 png/jpeg image for the guild splash (when the guild has `INVITE_SPLASH` feature)
*
* See https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
splash?: string | null | undefined;
/**
@@ -300,7 +298,7 @@ export interface RESTPatchAPIGuildJSONBody {
/**
* System channel flags
*
* See https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags}
*/
system_channel_flags?: GuildSystemChannelFlags | undefined;
/**
@@ -314,13 +312,13 @@ export interface RESTPatchAPIGuildJSONBody {
/**
* The preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US"
*
* @default "en-US" (if the value is set to `null`)
* @defaultValue `"en-US"` (if the value is set to `null`)
*/
preferred_locale?: Locale | null | undefined;
/**
* Enabled guild features
*
* See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-guild-features}
*/
features?: GuildFeature[] | undefined;
/**
@@ -338,32 +336,32 @@ export interface RESTPatchAPIGuildJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#modify-guild
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild}
*/
export type RESTPatchAPIGuildResult = APIGuild;
/**
* https://discord.com/developers/docs/resources/guild#delete-guild
* @see {@link https://discord.com/developers/docs/resources/guild#delete-guild}
*/
export type RESTDeleteAPIGuildResult = never;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-channels
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-channels}
*/
export type RESTGetAPIGuildChannelsResult = APIChannel[];
/**
* https://discord.com/developers/docs/resources/guild#create-guild-channel
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild-channel}
*/
export type RESTPostAPIGuildChannelJSONBody = DistributiveOmit<RESTAPIGuildCreatePartialChannel, 'id'>;
export type RESTPostAPIGuildChannelJSONBody = _DistributiveOmit<RESTAPIGuildCreatePartialChannel, 'id'>;
/**
* https://discord.com/developers/docs/resources/guild#create-guild-channel
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild-channel}
*/
export type RESTPostAPIGuildChannelResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions}
*/
export type RESTPatchAPIGuildChannelPositionsJSONBody = {
/**
@@ -385,45 +383,45 @@ export type RESTPatchAPIGuildChannelPositionsJSONBody = {
}[];
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions}
*/
export type RESTPatchAPIGuildChannelPositionsResult = never;
/**
* https://discord.com/developers/docs/resources/guild#list-active-guild-threads
* @see {@link https://discord.com/developers/docs/resources/guild#list-active-guild-threads}
*/
export type RESTGetAPIGuildThreadsResult = APIThreadList;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-member
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-member}
*/
export type RESTGetAPIGuildMemberResult = APIGuildMember;
/**
* https://discord.com/developers/docs/resources/guild#list-guild-members
* @see {@link https://discord.com/developers/docs/resources/guild#list-guild-members}
*/
export interface RESTGetAPIGuildMembersQuery {
/**
* Max number of members to return (1-1000)
*
* @default 1
* @defaultValue `1`
*/
limit?: number;
/**
* The highest user id in the previous page
*
* @default 0
* @defaultValue `0`
*/
after?: Snowflake;
}
/**
* https://discord.com/developers/docs/resources/guild#list-guild-members
* @see {@link https://discord.com/developers/docs/resources/guild#list-guild-members}
*/
export type RESTGetAPIGuildMembersResult = APIGuildMember[];
/**
* https://discord.com/developers/docs/resources/guild#search-guild-members
* @see {@link https://discord.com/developers/docs/resources/guild#search-guild-members}
*/
export interface RESTGetAPIGuildMembersSearchQuery {
/**
@@ -433,7 +431,7 @@ export interface RESTGetAPIGuildMembersSearchQuery {
/**
* Max number of members to return (1-1000)
*
* @default 1
* @defaultValue `1`
*/
limit?: number;
}
@@ -441,7 +439,7 @@ export interface RESTGetAPIGuildMembersSearchQuery {
export type RESTGetAPIGuildMembersSearchResult = APIGuildMember[];
/**
* https://discord.com/developers/docs/resources/guild#add-guild-member
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}
*/
export interface RESTPutAPIGuildMemberJSONBody {
/**
@@ -477,7 +475,7 @@ export interface RESTPutAPIGuildMemberJSONBody {
export type RESTPutAPIGuildMemberResult = APIGuildMember | undefined;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-member
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-member}
*/
export interface RESTPatchAPIGuildMemberJSONBody {
/**
@@ -517,14 +515,13 @@ export interface RESTPatchAPIGuildMemberJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#add-guild-member
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}
*/
export type RESTPatchAPIGuildMemberResult = APIGuildMember;
/**
* https://discord.com/developers/docs/resources/guild#modify-current-user-nick
*
* @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead.
* @see {@link https://discord.com/developers/docs/resources/guild#modify-current-user-nick}
* @deprecated Use {@link https://discord.com/developers/docs/resources/guild#modify-current-member | Modify Current Member} instead.
*/
export interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
/**
@@ -536,7 +533,7 @@ export interface RESTPatchAPICurrentGuildMemberNicknameJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#modify-current-member
* @see {@link https://discord.com/developers/docs/resources/guild#modify-current-member}
*/
export interface RESTPatchAPICurrentGuildMemberJSONBody {
/**
@@ -548,35 +545,34 @@ export interface RESTPatchAPICurrentGuildMemberJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#modify-current-user-nick
*
* @deprecated Use [Modify Current Member](https://discord.com/developers/docs/resources/guild#modify-current-member) instead.
* @see {@link https://discord.com/developers/docs/resources/guild#modify-current-user-nick}
* @deprecated Use {@link https://discord.com/developers/docs/resources/guild#modify-current-member | Modify Current Member} instead.
*/
export type RESTPatchAPICurrentGuildMemberNicknameResult =
StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;
_StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;
/**
* https://discord.com/developers/docs/resources/guild#add-guild-member-role
* @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member-role}
*/
export type RESTPutAPIGuildMemberRoleResult = never;
/**
* https://discord.com/developers/docs/resources/guild#remove-guild-member-role
* @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-member-role}
*/
export type RESTDeleteAPIGuildMemberRoleResult = never;
/**
* https://discord.com/developers/docs/resources/guild#remove-guild-member
* @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-member}
*/
export type RESTDeleteAPIGuildMemberResult = never;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-bans
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-bans}
*/
export type RESTGetAPIGuildBansResult = APIBan[];
/**
* https://discord.com/developers/docs/resources/guild#get-guild-bans
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-bans}
*/
export interface RESTGetAPIGuildBansQuery {
/**
@@ -590,24 +586,24 @@ export interface RESTGetAPIGuildBansQuery {
/**
* Number of users to return (1-1000)
*
* @default 1000
* @defaultValue `1000`
*/
limit?: number;
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-ban
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-ban}
*/
export type RESTGetAPIGuildBanResult = APIBan;
/**
* https://discord.com/developers/docs/resources/guild#create-guild-ban
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild-ban}
*/
export interface RESTPutAPIGuildBanJSONBody {
/**
* Number of days to delete messages for (0-7)
*
* @deprecated use `delete_message_seconds` instead
* @deprecated Use {@link RESTPutAPIGuildBanJSONBody.delete_message_seconds} instead
*/
delete_message_days?: number | undefined;
/**
@@ -617,17 +613,17 @@ export interface RESTPutAPIGuildBanJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#create-guild-ban
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild-ban}
*/
export type RESTPutAPIGuildBanResult = never;
/**
* https://discord.com/developers/docs/resources/guild#remove-guild-ban
* @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-ban}
*/
export type RESTDeleteAPIGuildBanResult = never;
/**
* https://discord.com/developers/docs/resources/guild#bulk-guild-ban
* @see {@link https://discord.com/developers/docs/resources/guild#bulk-guild-ban}
*/
export interface RESTPostAPIGuildBulkBanJSONBody {
/**
@@ -641,7 +637,7 @@ export interface RESTPostAPIGuildBulkBanJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#bulk-guild-ban
* @see {@link https://discord.com/developers/docs/resources/guild#bulk-guild-ban}
*/
export interface RESTPostAPIGuildBulkBanResult {
/**
@@ -655,36 +651,37 @@ export interface RESTPostAPIGuildBulkBanResult {
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-roles
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-roles}
*/
export type RESTGetAPIGuildRolesResult = APIRole[];
/**
* https://discord.com/developers/docs/resources/guild#create-guild-role
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild-role}
*/
export interface RESTPostAPIGuildRoleJSONBody {
/**
* Name of the role
*
* @default "new role"
* @defaultValue `"new role"`
*/
name?: string | null | undefined;
/**
* Bitwise value of the enabled/disabled permissions
*
* @default "default role permissions in guild"
* @defaultValue
* Default role permissions in guild
*/
permissions?: Permissions | null | undefined;
/**
* RGB color value
*
* @default 0
* @defaultValue `0`
*/
color?: number | null | undefined;
/**
* Whether the role should be displayed separately in the sidebar
*
* @default false
* @defaultValue `false`
*/
hoist?: boolean | null | undefined;
/**
@@ -698,18 +695,18 @@ export interface RESTPostAPIGuildRoleJSONBody {
/**
* Whether the role should be mentionable
*
* @default false
* @defaultValue `false`
*/
mentionable?: boolean | null | undefined;
}
/**
* https://discord.com/developers/docs/resources/guild#create-guild-role
* @see {@link https://discord.com/developers/docs/resources/guild#create-guild-role}
*/
export type RESTPostAPIGuildRoleResult = APIRole;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-role-positions
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role-positions}
*/
export type RESTPatchAPIGuildRolePositionsJSONBody = {
/**
@@ -723,12 +720,12 @@ export type RESTPatchAPIGuildRolePositionsJSONBody = {
}[];
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-role-positions
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role-positions}
*/
export type RESTPatchAPIGuildRolePositionsResult = APIRole[];
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-role
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role}
*/
export interface RESTPatchAPIGuildRoleJSONBody {
/**
@@ -762,28 +759,28 @@ export interface RESTPatchAPIGuildRoleJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-role
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-role}
*/
export type RESTGetAPIGuildRoleResult = APIRole;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-role
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role}
*/
export type RESTPatchAPIGuildRoleResult = APIRole;
/**
* https://discord.com/developers/docs/resources/guild#delete-guild-role
* @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-role}
*/
export type RESTDeleteAPIGuildRoleResult = never;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-prune-count
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-prune-count}
*/
export interface RESTGetAPIGuildPruneCountQuery {
/**
* Number of days to count prune for (1 or more)
*
* @default 7
* @defaultValue `7`
*/
days?: number;
/**
@@ -792,32 +789,32 @@ export interface RESTGetAPIGuildPruneCountQuery {
* While this is typed as a string, it represents an array of
* role IDs delimited by commas
*
* See https://discord.com/developers/docs/resources/guild#get-guild-prune-count-query-string-params
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-prune-count-query-string-params}
*/
include_roles?: string;
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-prune-count
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-prune-count}
*/
export interface RESTGetAPIGuildPruneCountResult {
pruned: number;
}
/**
* https://discord.com/developers/docs/resources/guild#begin-guild-prune
* @see {@link https://discord.com/developers/docs/resources/guild#begin-guild-prune}
*/
export interface RESTPostAPIGuildPruneJSONBody {
/**
* Number of days to count prune for (1 or more)
*
* @default 7
* @defaultValue `7`
*/
days?: number | undefined;
/**
* Whether `pruned is returned, discouraged for large guilds
* Whether `pruned` is returned, discouraged for large guilds
*
* @default true
* @defaultValue `true`
*/
compute_prune_count?: boolean | undefined;
/**
@@ -827,54 +824,54 @@ export interface RESTPostAPIGuildPruneJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild#begin-guild-prune
* @see {@link https://discord.com/developers/docs/resources/guild#begin-guild-prune}
*/
export interface RESTPostAPIGuildPruneResult {
pruned: number | null;
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-voice-regions
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-voice-regions}
*/
export type RESTGetAPIGuildVoiceRegionsResult = APIVoiceRegion[];
/**
* https://discord.com/developers/docs/resources/guild#get-guild-invites
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-invites}
*/
export type RESTGetAPIGuildInvitesResult = APIExtendedInvite[];
/**
* https://discord.com/developers/docs/resources/guild#get-guild-integrations
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-integrations}
*/
export type RESTGetAPIGuildIntegrationsResult = APIGuildIntegration[];
/**
* https://discord.com/developers/docs/resources/guild#delete-guild-integration
* @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-integration}
*/
export type RESTDeleteAPIGuildIntegrationResult = never;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-widget-settings
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-settings}
*/
export type RESTGetAPIGuildWidgetSettingsResult = APIGuildWidgetSettings;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-widget
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-widget}
*/
export type RESTPatchAPIGuildWidgetSettingsJSONBody = StrictPartial<APIGuildWidgetSettings>;
export type RESTPatchAPIGuildWidgetSettingsJSONBody = _StrictPartial<APIGuildWidgetSettings>;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-widget
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-widget}
*/
export type RESTPatchAPIGuildWidgetSettingsResult = APIGuildWidgetSettings;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-widget
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget}
*/
export type RESTGetAPIGuildWidgetJSONResult = APIGuildWidget;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-vanity-url
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-vanity-url}
*/
export interface RESTGetAPIGuildVanityUrlResult {
code: string | null;
@@ -882,13 +879,13 @@ export interface RESTGetAPIGuildVanityUrlResult {
}
/**
* https://discord.com/developers/docs/resources/guild#get-guild-widget-image
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-image}
*/
export interface RESTGetAPIGuildWidgetImageQuery {
/**
* Style of the widget image returned
*
* @default "shield"
* @defaultValue `"shield"`
*/
style?: GuildWidgetStyle;
}
@@ -919,14 +916,14 @@ export interface RESTPatchAPIGuildMemberVerificationJSONBody {
export type RESTPatchAPIGuildMemberVerificationResult = APIGuildMembershipScreening;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen}
*/
export type RESTGetAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen}
*/
export type RESTPatchAPIGuildWelcomeScreenJSONBody = Nullable<StrictPartial<APIGuildWelcomeScreen>> & {
export type RESTPatchAPIGuildWelcomeScreenJSONBody = _Nullable<_StrictPartial<APIGuildWelcomeScreen>> & {
/**
* Whether the welcome screen is enabled
*/
@@ -934,19 +931,19 @@ export type RESTPatchAPIGuildWelcomeScreenJSONBody = Nullable<StrictPartial<APIG
};
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen}
*/
export type RESTPatchAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
/**
* https://discord.com/developers/docs/resources/guild#get-guild-onboarding
* @see {@link https://discord.com/developers/docs/resources/guild#get-guild-onboarding}
*/
export type RESTGetAPIGuildOnboardingResult = APIGuildOnboarding;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-onboarding}
*/
export type RESTPutAPIGuildOnboardingJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
export type RESTPutAPIGuildOnboardingJSONBody = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
Partial<Pick<APIGuildOnboarding, 'default_channel_ids' | 'enabled' | 'mode'>>
> & {
/**
@@ -955,7 +952,7 @@ export type RESTPutAPIGuildOnboardingJSONBody = AddUndefinedToPossiblyUndefinedP
prompts?: RESTAPIGuildOnboardingPrompt[] | undefined;
};
export type RESTAPIGuildOnboardingPrompt = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
export type RESTAPIGuildOnboardingPrompt = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
Partial<Omit<APIGuildOnboardingPrompt, 'guild_id' | 'id' | 'options' | 'title'>>
> &
Pick<APIGuildOnboardingPrompt, 'id' | 'title'> & {
@@ -970,7 +967,7 @@ export type RESTAPIGuildOnboardingPrompt = AddUndefinedToPossiblyUndefinedProper
*/
export type RESTAPIModifyGuildOnboardingPromptData = RESTAPIGuildOnboardingPrompt;
export type RESTAPIGuildOnboardingPromptOption = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
export type RESTAPIGuildOnboardingPromptOption = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
Partial<Omit<APIGuildOnboardingPromptOption, 'emoji' | 'guild_id' | 'title'>>
> &
Pick<APIGuildOnboardingPromptOption, 'title'> & {
@@ -994,12 +991,12 @@ export type RESTAPIGuildOnboardingPromptOption = AddUndefinedToPossiblyUndefined
export type RESTAPIModifyGuildOnboardingPromptOptionData = RESTAPIGuildOnboardingPromptOption;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-onboarding
* @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-onboarding}
*/
export type RESTPutAPIGuildOnboardingResult = APIGuildOnboarding;
/**
* https://discord.com/developers/docs/resources/guild#modify-incidents-actions
* @see {@link https://discord.com/developers/docs/resources/guild#modify-incidents-actions}
*/
export interface RESTPutAPIGuildIncidentActionsJSONBody {
/**

30
deno/rest/v10/guildScheduledEvent.ts
View File

@@ -1,5 +1,5 @@
import type { Snowflake } from '../../globals.ts';
import type { Nullable, StrictPartial } from '../../utils/internals.ts';
import type { _Nullable, _StrictPartial } from '../../utils/internals.ts';
import type {
APIGuildScheduledEvent,
APIGuildScheduledEventEntityMetadata,
@@ -11,7 +11,7 @@ import type {
} from '../../v10.ts';
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild}
*/
export interface RESTGetAPIGuildScheduledEventsQuery {
/**
@@ -21,12 +21,12 @@ export interface RESTGetAPIGuildScheduledEventsQuery {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild}
*/
export type RESTGetAPIGuildScheduledEventsResult = APIGuildScheduledEvent[];
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event}
*/
export interface RESTPostAPIGuildScheduledEventJSONBody {
/**
@@ -72,12 +72,12 @@ export interface RESTPostAPIGuildScheduledEventJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event}
*/
export type RESTPostAPIGuildScheduledEventResult = APIGuildScheduledEvent;
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event}
*/
export interface RESTGetAPIGuildScheduledEventQuery {
/**
@@ -87,17 +87,17 @@ export interface RESTGetAPIGuildScheduledEventQuery {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event}
*/
export type RESTGetAPIGuildScheduledEventResult = APIGuildScheduledEvent;
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event}
*/
export type RESTPatchAPIGuildScheduledEventJSONBody = Nullable<
export type RESTPatchAPIGuildScheduledEventJSONBody = _Nullable<
Pick<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
> &
StrictPartial<
_StrictPartial<
Omit<RESTPostAPIGuildScheduledEventJSONBody, 'description' | 'entity_metadata' | 'recurrence_rule'>
> & {
/**
@@ -107,23 +107,23 @@ export type RESTPatchAPIGuildScheduledEventJSONBody = Nullable<
};
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event}
*/
export type RESTPatchAPIGuildScheduledEventResult = APIGuildScheduledEvent;
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event}
*/
export type RESTDeleteAPIGuildScheduledEventResult = never;
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users}
*/
export interface RESTGetAPIGuildScheduledEventUsersQuery {
/**
* Number of users to receive from the event
*
* @default 100
* @defaultValue `100`
*/
limit?: number;
/**
@@ -141,6 +141,6 @@ export interface RESTGetAPIGuildScheduledEventUsersQuery {
}
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users
* @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users}
*/
export type RESTGetAPIGuildScheduledEventUsersResult = APIGuildScheduledEventUser[];

112
deno/rest/v10/interactions.ts
View File

@@ -11,9 +11,9 @@ import type {
InteractionType,
} from '../../payloads/v10/mod.ts';
import type {
AddUndefinedToPossiblyUndefinedPropertiesOfInterface,
NonNullableFields,
StrictPartial,
_AddUndefinedToPossiblyUndefinedPropertiesOfInterface,
_NonNullableFields,
_StrictPartial,
} from '../../utils/internals.ts';
import type {
RESTDeleteAPIWebhookWithTokenMessageResult,
@@ -25,29 +25,29 @@ import type {
} from './webhook.ts';
/**
* https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands}
*/
export interface RESTGetAPIApplicationCommandsQuery {
/**
* Whether to include full localization dictionaries (name_localizations and description_localizations)
* in the returned objects, instead of the name_localized and description_localized fields.
*
* @default false
* @defaultValue `false`
*/
with_localizations?: boolean;
}
/**
* https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands}
*/
export type RESTGetAPIApplicationCommandsResult = APIApplicationCommand[];
/**
* https://discord.com/developers/docs/interactions/application-commands#get-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-command}
*/
export type RESTGetAPIApplicationCommandResult = APIApplicationCommand;
type RESTPostAPIBaseApplicationCommandsJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
export type RESTPostAPIBaseApplicationCommandsJSONBody = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
Omit<
APIApplicationCommand,
| 'application_id'
@@ -63,13 +63,13 @@ type RESTPostAPIBaseApplicationCommandsJSONBody = AddUndefinedToPossiblyUndefine
| 'version'
> &
Partial<
NonNullableFields<Pick<APIApplicationCommand, 'contexts'>> &
_NonNullableFields<Pick<APIApplicationCommand, 'contexts'>> &
Pick<APIApplicationCommand, 'default_member_permissions' | 'integration_types'>
>
>;
/**
* https://discord.com/developers/docs/interactions/application-commands#create-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
*/
export interface RESTPostAPIChatInputApplicationCommandsJSONBody extends RESTPostAPIBaseApplicationCommandsJSONBody {
type?: ApplicationCommandType.ChatInput | undefined;
@@ -77,14 +77,14 @@ export interface RESTPostAPIChatInputApplicationCommandsJSONBody extends RESTPos
}
/**
* https://discord.com/developers/docs/interactions/application-commands#create-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
*/
export interface RESTPostAPIContextMenuApplicationCommandsJSONBody extends RESTPostAPIBaseApplicationCommandsJSONBody {
type: ApplicationCommandType.Message | ApplicationCommandType.User;
}
/**
* https://discord.com/developers/docs/interactions/application-commands#create-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
*/
export interface RESTPostAPIPrimaryEntryPointApplicationCommandJSONBody
extends RESTPostAPIBaseApplicationCommandsJSONBody {
@@ -92,7 +92,7 @@ export interface RESTPostAPIPrimaryEntryPointApplicationCommandJSONBody
}
/**
* https://discord.com/developers/docs/interactions/application-commands#create-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
*/
export type RESTPostAPIApplicationCommandsJSONBody =
| RESTPostAPIChatInputApplicationCommandsJSONBody
@@ -100,72 +100,72 @@ export type RESTPostAPIApplicationCommandsJSONBody =
| RESTPostAPIPrimaryEntryPointApplicationCommandJSONBody;
/**
* https://discord.com/developers/docs/interactions/application-commands#create-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
*/
export type RESTPostAPIApplicationCommandsResult = APIApplicationCommand;
/**
* https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command}
*/
export type RESTPatchAPIApplicationCommandJSONBody = StrictPartial<RESTPostAPIApplicationCommandsJSONBody>;
export type RESTPatchAPIApplicationCommandJSONBody = _StrictPartial<RESTPostAPIApplicationCommandsJSONBody>;
/**
* https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command}
*/
export type RESTPatchAPIApplicationCommandResult = APIApplicationCommand;
/**
* https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands}
*/
export type RESTPutAPIApplicationCommandsJSONBody = RESTPostAPIApplicationCommandsJSONBody[];
/**
* https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands}
*/
export type RESTPutAPIApplicationCommandsResult = APIApplicationCommand[];
/**
* https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands}
*/
export type RESTGetAPIApplicationGuildCommandsQuery = RESTGetAPIApplicationCommandsQuery;
/**
* https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands}
*/
export type RESTGetAPIApplicationGuildCommandsResult = Omit<APIApplicationCommand, 'dm_permission'>[];
/**
* https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands}
*/
export type RESTGetAPIApplicationGuildCommandResult = Omit<APIApplicationCommand, 'dm_permission'>;
/**
* https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command}
*/
export type RESTPostAPIApplicationGuildCommandsJSONBody =
| Omit<RESTPostAPIChatInputApplicationCommandsJSONBody, 'dm_permission'>
| Omit<RESTPostAPIContextMenuApplicationCommandsJSONBody, 'dm_permission'>;
/**
* https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command}
*/
export type RESTPostAPIApplicationGuildCommandsResult = Omit<APIApplicationCommand, 'dm_permission'>;
/**
* https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command}
*/
export type RESTPatchAPIApplicationGuildCommandJSONBody = StrictPartial<
export type RESTPatchAPIApplicationGuildCommandJSONBody = _StrictPartial<
| Omit<RESTPostAPIChatInputApplicationCommandsJSONBody, 'dm_permission'>
| Omit<RESTPostAPIContextMenuApplicationCommandsJSONBody, 'dm_permission'>
>;
/**
* https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command}
*/
export type RESTPatchAPIApplicationGuildCommandResult = Omit<APIApplicationCommand, 'dm_permission'>;
/**
* https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands}
*/
export type RESTPutAPIApplicationGuildCommandsJSONBody = (
| (Omit<RESTPostAPIChatInputApplicationCommandsJSONBody, 'dm_permission'> &
@@ -175,17 +175,17 @@ export type RESTPutAPIApplicationGuildCommandsJSONBody = (
)[];
/**
* https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands
* @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands}
*/
export type RESTPutAPIApplicationGuildCommandsResult = Omit<APIApplicationCommand, 'dm_permission'>[];
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
*/
export type RESTPostAPIInteractionCallbackJSONBody = APIInteractionResponse;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
*/
export interface RESTPostAPIInteractionCallbackQuery {
/**
@@ -195,7 +195,7 @@ export interface RESTPostAPIInteractionCallbackQuery {
}
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
*/
export type RESTPostAPIInteractionCallbackFormDataBody =
| (Record<`files[${bigint}]`, unknown> & {
@@ -207,12 +207,12 @@ export type RESTPostAPIInteractionCallbackFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPostAPIInteractionCallbackJSONBody);
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
*/
export type RESTPostAPIInteractionCallbackResult = never;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object}
*/
export interface RESTPostAPIInteractionCallbackWithResponseResult {
/**
@@ -226,7 +226,7 @@ export interface RESTPostAPIInteractionCallbackWithResponseResult {
}
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-object
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-object}
*/
export interface RESTAPIInteractionCallbackObject {
/**
@@ -256,7 +256,7 @@ export interface RESTAPIInteractionCallbackObject {
}
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-resource-object
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-resource-object}
*/
export interface RESTAPIInteractionCallbackResourceObject {
/**
@@ -281,7 +281,7 @@ export interface RESTAPIInteractionCallbackResourceObject {
}
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-activity-instance-resource
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-activity-instance-resource}
*/
export interface RESTAPIInteractionCallbackActivityInstanceResource {
/**
@@ -291,37 +291,37 @@ export interface RESTAPIInteractionCallbackActivityInstanceResource {
}
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response}
*/
export type RESTGetAPIInteractionOriginalResponseResult = RESTGetAPIWebhookWithTokenMessageResult;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response}
*/
export type RESTPatchAPIInteractionOriginalResponseJSONBody = RESTPatchAPIWebhookWithTokenMessageJSONBody;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response}
*/
export type RESTPatchAPIInteractionOriginalResponseFormDataBody = RESTPatchAPIWebhookWithTokenMessageFormDataBody;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response}
*/
export type RESTPatchAPIInteractionOriginalResponseResult = RESTPatchAPIWebhookWithTokenMessageResult;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response}
*/
export type RESTDeleteAPIInteractionOriginalResponseResult = RESTDeleteAPIWebhookWithTokenMessageResult;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message}
*/
export type RESTPostAPIInteractionFollowupJSONBody = APIInteractionResponseCallbackData;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message}
*/
export type RESTPostAPIInteractionFollowupFormDataBody =
| (Record<`files[${bigint}]`, unknown> & {
@@ -333,59 +333,59 @@ export type RESTPostAPIInteractionFollowupFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPostAPIInteractionFollowupJSONBody);
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message}
*/
export type RESTPostAPIInteractionFollowupResult = RESTPostAPIWebhookWithTokenWaitResult;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message}
*/
export type RESTGetAPIInteractionFollowupResult = RESTGetAPIWebhookWithTokenMessageResult;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message}
*/
export type RESTPatchAPIInteractionFollowupJSONBody = RESTPatchAPIWebhookWithTokenMessageJSONBody;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message}
*/
export type RESTPatchAPIInteractionFollowupFormDataBody = RESTPatchAPIWebhookWithTokenMessageFormDataBody;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message}
*/
export type RESTPatchAPIInteractionFollowupResult = RESTPatchAPIWebhookWithTokenMessageResult;
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#delete-followup-message
* @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#delete-followup-message}
*/
export type RESTDeleteAPIInteractionFollowupResult = RESTDeleteAPIWebhookWithTokenMessageResult;
/**
* https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions}
*/
export type RESTGetAPIGuildApplicationCommandsPermissionsResult = APIGuildApplicationCommandPermissions[];
/**
* https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions
* @see {@link https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions}
*/
export type RESTGetAPIApplicationCommandPermissionsResult = APIGuildApplicationCommandPermissions;
/**
* https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions}
*/
export interface RESTPutAPIApplicationCommandPermissionsJSONBody {
permissions: APIApplicationCommandPermission[];
}
/**
* https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions
* @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions}
*/
export type RESTPutAPIApplicationCommandPermissionsResult = APIGuildApplicationCommandPermissions;
/**
* https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions
* @see {@link https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions}
*/
export type RESTPutAPIGuildApplicationCommandsPermissionsJSONBody = Pick<
APIGuildApplicationCommandPermissions,
@@ -393,6 +393,6 @@ export type RESTPutAPIGuildApplicationCommandsPermissionsJSONBody = Pick<
>[];
/**
* https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions
* @see {@link https://discord.com/developers/docs/interactions/application-commands#batch-edit-application-command-permissions}
*/
export type RESTPutAPIGuildApplicationCommandsPermissionsResult = APIGuildApplicationCommandPermissions[];

4
deno/rest/v10/invite.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIInvite } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/invite#get-invite
* @see {@link https://discord.com/developers/docs/resources/invite#get-invite}
*/
export interface RESTGetAPIInviteQuery {
/**
@@ -22,6 +22,6 @@ export interface RESTGetAPIInviteQuery {
export type RESTGetAPIInviteResult = APIInvite;
/**
* https://discord.com/developers/docs/resources/invite#delete-invite
* @see {@link https://discord.com/developers/docs/resources/invite#delete-invite}
*/
export type RESTDeleteAPIInviteResult = APIInvite;

13
deno/rest/v10/mod.ts
View File

@@ -549,7 +549,7 @@ export const Routes = {
* - GET `/users/{user.id}`
* - PATCH `/users/@me`
*
* @param [userId] The user ID, defaulted to `@me`
* @param [userId] - The user ID, defaulted to `@me`
*/
user(userId: Snowflake | '@me' = '@me') {
return `/users/${userId}` as const;
@@ -1172,7 +1172,7 @@ export const CDNRoutes = {
* Route for:
* - GET `/embed/avatars/{index}.png`
*
* The value for `index` parameter depends on whether the user is [migrated to the new username system](https://discord.com/developers/docs/change-log#unique-usernames-on-discord).
* The value for `index` parameter depends on whether the user is {@link https://discord.com/developers/docs/change-log#unique-usernames-on-discord | migrated to the new username system}.
* For users on the new username system, `index` will be `(user.id >> 22) % 6`.
* For users on the legacy username system, `index` will be `user.discriminator % 5`.
*
@@ -1412,7 +1412,7 @@ export type GuildSplashFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageForm
export type GuildDiscoverySplashFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
export type GuildBannerFormat = Exclude<ImageFormat, ImageFormat.Lottie>;
export type UserBannerFormat = Exclude<ImageFormat, ImageFormat.Lottie>;
export type DefaultUserAvatar = Extract<ImageFormat, ImageFormat.PNG>;
export type DefaultUserAvatarFormat = Extract<ImageFormat, ImageFormat.PNG>;
export type UserAvatarFormat = Exclude<ImageFormat, ImageFormat.Lottie>;
export type GuildMemberAvatarFormat = Exclude<ImageFormat, ImageFormat.Lottie>;
export type ApplicationIconFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
@@ -1427,6 +1427,11 @@ export type RoleIconFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.
export type GuildScheduledEventCoverFormat = Exclude<ImageFormat, ImageFormat.GIF | ImageFormat.Lottie>;
export type GuildMemberBannerFormat = Exclude<ImageFormat, ImageFormat.Lottie>;
/**
* @deprecated Use {@link DefaultUserAvatarFormat} instead.
*/
export type DefaultUserAvatar = DefaultUserAvatarFormat;
export interface CDNQuery {
/**
* The returned image can have the size changed by using this query parameter
@@ -1453,7 +1458,7 @@ export const OAuth2Routes = {
authorizationURL: `${RouteBases.api}${Routes.oauth2Authorization()}`,
tokenURL: `${RouteBases.api}${Routes.oauth2TokenExchange()}`,
/**
* See https://tools.ietf.org/html/rfc7009
* @see {@link https://tools.ietf.org/html/rfc7009}
*/
tokenRevocationURL: `${RouteBases.api}${Routes.oauth2TokenRevocation()}`,
} as const;

28
deno/rest/v10/monetization.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIEntitlement, APISKU, APISubscription } from '../../v10.ts';
/**
* https://discord.com/developers/docs/resources/entitlement#list-entitlements
* @see {@link https://discord.com/developers/docs/resources/entitlement#list-entitlements}
*/
export interface RESTGetAPIEntitlementsQuery {
/**
@@ -25,7 +25,7 @@ export interface RESTGetAPIEntitlementsQuery {
/**
* Number of entitlements to return (1-100)
*
* @default 100
* @defaultValue `100`
*/
limit?: number | undefined;
/**
@@ -43,17 +43,17 @@ export interface RESTGetAPIEntitlementsQuery {
}
/**
* https://discord.com/developers/docs/resources/entitlement#list-entitlements
* @see {@link https://discord.com/developers/docs/resources/entitlement#list-entitlements}
*/
export type RESTGetAPIEntitlementsResult = APIEntitlement[];
/**
* https://discord.com/developers/docs/resources/entitlement#get-entitlement
* @see {@link https://discord.com/developers/docs/resources/entitlement#get-entitlement}
*/
export type RESTGetAPIEntitlementResult = APIEntitlement;
/**
* https://discord.com/developers/docs/resources/entitlement#create-test-entitlement
* @see {@link https://discord.com/developers/docs/resources/entitlement#create-test-entitlement}
*/
export interface RESTPostAPIEntitlementJSONBody {
/**
@@ -76,12 +76,12 @@ export interface RESTPostAPIEntitlementJSONBody {
export type RESTPostAPIEntitlementBody = RESTPostAPIEntitlementJSONBody;
/**
* https://discord.com/developers/docs/resources/entitlement#create-test-entitlement
* @see {@link https://discord.com/developers/docs/resources/entitlement#create-test-entitlement}
*/
export type RESTPostAPIEntitlementResult = Partial<Omit<APIEntitlement, 'ends_at' | 'starts_at'>>;
/**
* https://discord.com/developers/docs/resources/entitlement#create-test-entitlement
* @see {@link https://discord.com/developers/docs/resources/entitlement#create-test-entitlement}
*/
export enum EntitlementOwnerType {
Guild = 1,
@@ -89,22 +89,22 @@ export enum EntitlementOwnerType {
}
/**
* https://discord.com/developers/docs/resources/entitlement#delete-test-entitlement
* @see {@link https://discord.com/developers/docs/resources/entitlement#delete-test-entitlement}
*/
export type RESTDeleteAPIEntitlementResult = never;
/**
* https://discord.com/developers/docs/resources/sku#list-skus
* @see {@link https://discord.com/developers/docs/resources/sku#list-skus}
*/
export type RESTGetAPISKUsResult = APISKU[];
/**
* https://discord.com/developers/docs/resources/entitlement#consume-an-entitlement
* @see {@link https://discord.com/developers/docs/resources/entitlement#consume-an-entitlement}
*/
export type RESTPostAPIEntitlementConsumeResult = never;
/**
* https://discord.com/developers/docs/resources/subscription#query-string-params
* @see {@link https://discord.com/developers/docs/resources/subscription#query-string-params}
*/
export interface RESTGetAPISKUSubscriptionsQuery {
/**
@@ -118,7 +118,7 @@ export interface RESTGetAPISKUSubscriptionsQuery {
/**
* Number of subscriptions to return (1-100)
*
* @default 50
* @defaultValue `50`
*/
limit?: number | undefined;
/**
@@ -128,11 +128,11 @@ export interface RESTGetAPISKUSubscriptionsQuery {
}
/**
* https://discord.com/developers/docs/resources/subscription#list-sku-subscriptions
* @see {@link https://discord.com/developers/docs/resources/subscription#list-sku-subscriptions}
*/
export type RESTGetAPISKUSubscriptionsResult = APISubscription[];
/**
* https://discord.com/developers/docs/resources/subscription#get-sku-subscription
* @see {@link https://discord.com/developers/docs/resources/subscription#get-sku-subscription}
*/
export type RESTGetAPISKUSubscriptionResult = APISubscription;

32
deno/rest/v10/oauth2.ts
View File

@@ -2,12 +2,12 @@ import type { Permissions, Snowflake } from '../../globals.ts';
import type { APIApplication, APIGuild, APIUser, APIWebhook, OAuth2Scopes } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information
* @see {@link https://discord.com/developers/docs/topics/oauth2#get-current-bot-application-information}
*/
export type RESTGetAPIOAuth2CurrentApplicationResult = Omit<APIApplication, 'flags'>;
/**
* https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information
* @see {@link https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information}
*/
export interface RESTGetAPIOAuth2CurrentAuthorizationResult {
/**
@@ -29,7 +29,7 @@ export interface RESTGetAPIOAuth2CurrentAuthorizationResult {
}
/**
* https://discord.com/developers/docs/topics/oauth2#authorization-code-grant
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant}
*/
export interface RESTOAuth2AuthorizationQuery {
response_type: 'code';
@@ -41,7 +41,7 @@ export interface RESTOAuth2AuthorizationQuery {
}
/**
* https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-token-revocation-example
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-token-revocation-example}
*/
export interface RESTPostOAuth2TokenRevocationQuery {
token: string;
@@ -49,7 +49,7 @@ export interface RESTPostOAuth2TokenRevocationQuery {
}
/**
* https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
*/
export interface RESTPostOAuth2AuthorizationQueryResult {
code: string;
@@ -62,7 +62,7 @@ export interface RESTPostOAuth2AuthorizationQueryResult {
export type RESTOAuth2AuthorizationQueryResult = RESTPostOAuth2AuthorizationQueryResult;
/**
* https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example}
*/
export interface RESTPostOAuth2AccessTokenURLEncodedData {
client_id: Snowflake;
@@ -73,7 +73,7 @@ export interface RESTPostOAuth2AccessTokenURLEncodedData {
}
/**
* https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response}
*/
export interface RESTPostOAuth2AccessTokenResult {
access_token: string;
@@ -84,7 +84,7 @@ export interface RESTPostOAuth2AccessTokenResult {
}
/**
* https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example
* @see {@link https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example}
*/
export interface RESTPostOAuth2RefreshTokenURLEncodedData {
client_id: Snowflake;
@@ -96,7 +96,7 @@ export interface RESTPostOAuth2RefreshTokenURLEncodedData {
export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;
/**
* https://discord.com/developers/docs/topics/oauth2#implicit-grant
* @see {@link https://discord.com/developers/docs/topics/oauth2#implicit-grant}
*/
export interface RESTOAuth2ImplicitAuthorizationQuery {
response_type: 'token';
@@ -108,12 +108,12 @@ export interface RESTOAuth2ImplicitAuthorizationQuery {
}
/**
* https://discord.com/developers/docs/topics/oauth2#implicit-grant-redirect-url-example
* @see {@link https://discord.com/developers/docs/topics/oauth2#implicit-grant-redirect-url-example}
*/
export type RESTOAuth2ImplicitAuthorizationURLFragmentResult = Omit<RESTPostOAuth2AccessTokenResult, 'refresh_token'>;
/**
* https://discord.com/developers/docs/topics/oauth2#client-credentials-grant
* @see {@link https://discord.com/developers/docs/topics/oauth2#client-credentials-grant}
*/
export interface RESTPostOAuth2ClientCredentialsURLEncodedData {
grant_type: 'client_credentials';
@@ -123,7 +123,7 @@ export interface RESTPostOAuth2ClientCredentialsURLEncodedData {
export type RESTPostOAuth2ClientCredentialsResult = RESTOAuth2ImplicitAuthorizationURLFragmentResult;
/**
* https://discord.com/developers/docs/topics/oauth2#bot-authorization-flow-bot-auth-parameters
* @see {@link https://discord.com/developers/docs/topics/oauth2#bot-authorization-flow-bot-auth-parameters}
*/
export interface RESTOAuth2BotAuthorizationQuery {
/**
@@ -141,7 +141,7 @@ export interface RESTOAuth2BotAuthorizationQuery {
/**
* The permissions you're requesting
*
* See https://discord.com/developers/docs/topics/permissions
* @see {@link https://discord.com/developers/docs/topics/permissions}
*/
permissions?: Permissions;
/**
@@ -155,7 +155,7 @@ export interface RESTOAuth2BotAuthorizationQuery {
}
/**
* https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization
* @see {@link https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization}
*/
export interface RESTOAuth2AdvancedBotAuthorizationQuery {
client_id: Snowflake;
@@ -185,7 +185,7 @@ export interface RESTOAuth2AdvancedBotAuthorizationQueryResult {
}
/**
* https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization-extended-bot-authorization-access-token-example
* @see {@link https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization-extended-bot-authorization-access-token-example}
*/
export interface RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult {
access_token: string;
@@ -197,7 +197,7 @@ export interface RESTPostOAuth2AccessTokenWithBotAndGuildsScopeResult {
}
/**
* https://discord.com/developers/docs/topics/oauth2#webhooks-webhook-token-response-example
* @see {@link https://discord.com/developers/docs/topics/oauth2#webhooks-webhook-token-response-example}
*/
export interface RESTPostOAuth2AccessTokenWithBotAndWebhookIncomingScopeResult {
access_token: string;

12
deno/rest/v10/poll.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIMessage, APIPoll, APIPollAnswer, APIUser } from '../../v10.ts';
/**
* https://discord.com/developers/docs/resources/poll#get-answer-voters
* @see {@link https://discord.com/developers/docs/resources/poll#get-answer-voters}
*/
export interface RESTGetAPIPollAnswerVotersQuery {
/**
@@ -12,13 +12,13 @@ export interface RESTGetAPIPollAnswerVotersQuery {
/**
* Max number of users to return (1-100)
*
* @default 25
* @defaultValue `25`
*/
limit?: number;
}
/**
* https://discord.com/developers/docs/resources/poll#poll-create-request-object-poll-create-request-object-structure
* @see {@link https://discord.com/developers/docs/resources/poll#poll-create-request-object-poll-create-request-object-structure}
*/
export interface RESTAPIPoll
extends Omit<APIPoll, 'allow_multiselect' | 'answers' | 'expiry' | 'layout_type' | 'results'>,
@@ -30,7 +30,7 @@ export interface RESTAPIPoll
/**
* Number of hours the poll should be open for, up to 32 days
*
* @default 24
* @defaultValue `24`
*/
duration?: number;
}
@@ -41,7 +41,7 @@ export interface RESTAPIPoll
export type RESTAPIPollCreate = RESTAPIPoll;
/**
* https://discord.com/developers/docs/resources/poll#get-answer-voters
* @see {@link https://discord.com/developers/docs/resources/poll#get-answer-voters}
*/
export interface RESTGetAPIPollAnswerVotersResult {
/**
@@ -51,6 +51,6 @@ export interface RESTGetAPIPollAnswerVotersResult {
}
/**
* https://discord.com/developers/docs/resources/poll#expire-poll
* @see {@link https://discord.com/developers/docs/resources/poll#expire-poll}
*/
export type RESTPostAPIPollExpireResult = APIMessage;

26
deno/rest/v10/soundboard.ts
View File

@@ -2,12 +2,12 @@ import type { Snowflake } from '../../globals.ts';
import type { APISoundboardSound } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound
* @see {@link https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound}
*/
export type RESTPostAPISendSoundboardSoundResult = APISoundboardSound;
/**
* https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound-json-params
* @see {@link https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound-json-params}
*/
export interface RESTPostAPISoundboardSendSoundJSONBody {
/**
@@ -21,24 +21,24 @@ export interface RESTPostAPISoundboardSendSoundJSONBody {
}
/**
* https://discord.com/developers/docs/resources/soundboard#list-soundboard-default-sounds
* @see {@link https://discord.com/developers/docs/resources/soundboard#list-soundboard-default-sounds}
*/
export type RESTGetAPISoundboardDefaultSoundsResult = APISoundboardSound[];
/**
* https://discord.com/developers/docs/resources/soundboard#list-guild-soundboard-sounds
* @see {@link https://discord.com/developers/docs/resources/soundboard#list-guild-soundboard-sounds}
*/
export interface RESTGetAPIGuildSoundboardSoundsResult {
items: APISoundboardSound[];
}
/**
* https://discord.com/developers/docs/resources/soundboard#get-guild-soundboard-sound
* @see {@link https://discord.com/developers/docs/resources/soundboard#get-guild-soundboard-sound}
*/
export type RESTGetAPIGuildSoundboardSoundResult = APISoundboardSound;
/**
* https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound-json-params
* @see {@link https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound-json-params}
*/
export interface RESTPostAPIGuildSoundboardSoundJSONBody {
/**
@@ -48,13 +48,13 @@ export interface RESTPostAPIGuildSoundboardSoundJSONBody {
/**
* The data uri of the mp3 or ogg sound data, base64 encoded, similar to image data
*
* See https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
sound: string;
/**
* The volume of the soundboard sound, from 0 to 1
*
* @default 1
* @defaultValue `1`
*/
volume?: number | null | undefined;
/**
@@ -68,12 +68,12 @@ export interface RESTPostAPIGuildSoundboardSoundJSONBody {
}
/**
* https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound
* @see {@link https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound}
*/
export type RESTPostAPIGuildSoundboardSoundResult = APISoundboardSound;
/**
* https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound-json-params
* @see {@link https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound-json-params}
*/
export interface RESTPatchAPIGuildSoundboardSoundJSONBody {
/**
@@ -83,7 +83,7 @@ export interface RESTPatchAPIGuildSoundboardSoundJSONBody {
/**
* The volume of the soundboard sound, from 0 to 1
*
* @default 1
* @defaultValue `1`
*/
volume?: number | null | undefined;
/**
@@ -97,11 +97,11 @@ export interface RESTPatchAPIGuildSoundboardSoundJSONBody {
}
/**
* https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound
* @see {@link https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound}
*/
export type RESTPatchAPIGuildSoundboardSoundResult = APISoundboardSound;
/**
* https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound
* @see {@link https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound}
*/
export type RESTDeleteAPIGuildSoundboardSoundResult = never;

16
deno/rest/v10/stageInstance.ts
View File

@@ -2,7 +2,7 @@ import type { Snowflake } from '../../globals.ts';
import type { APIStageInstance, StageInstancePrivacyLevel } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/stage-instance#create-stage-instance
* @see {@link https://discord.com/developers/docs/resources/stage-instance#create-stage-instance}
*/
export interface RESTPostAPIStageInstanceJSONBody {
/**
@@ -16,11 +16,11 @@ export interface RESTPostAPIStageInstanceJSONBody {
/**
* The privacy level of the stage instance
*
* @default GuildOnly
* @defaultValue `StageInstancePrivacyLevel.GuildOnly`
*/
privacy_level?: StageInstancePrivacyLevel | undefined;
/**
* Notify @everyone that a stage instance has started
* Notify `@everyone` that a stage instance has started
*/
send_start_notification?: boolean | undefined;
/**
@@ -30,17 +30,17 @@ export interface RESTPostAPIStageInstanceJSONBody {
}
/**
* https://discord.com/developers/docs/resources/stage-instance#create-stage-instance
* @see {@link https://discord.com/developers/docs/resources/stage-instance#create-stage-instance}
*/
export type RESTPostAPIStageInstanceResult = APIStageInstance;
/**
* https://discord.com/developers/docs/resources/stage-instance#get-stage-instance
* @see {@link https://discord.com/developers/docs/resources/stage-instance#get-stage-instance}
*/
export type RESTGetAPIStageInstanceResult = APIStageInstance;
/**
* https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance
* @see {@link https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance}
*/
export interface RESTPatchAPIStageInstanceJSONBody {
/**
@@ -54,11 +54,11 @@ export interface RESTPatchAPIStageInstanceJSONBody {
}
/**
* https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance
* @see {@link https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance}
*/
export type RESTPatchAPIStageInstanceResult = APIStageInstance;
/**
* https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance
* @see {@link https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance}
*/
export type RESTDeleteAPIStageInstanceResult = never;

25
deno/rest/v10/sticker.ts
View File

@@ -1,19 +1,19 @@
import type { APISticker, APIStickerPack } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/sticker#get-sticker
* @see {@link https://discord.com/developers/docs/resources/sticker#get-sticker}
*/
export type RESTGetAPIStickerResult = APISticker;
/**
* https://discord.com/developers/docs/resources/sticker#list-sticker-packs
* @see {@link https://discord.com/developers/docs/resources/sticker#list-sticker-packs}
*/
export interface RESTGetStickerPacksResult {
sticker_packs: APIStickerPack[];
}
/**
* https://discord.com/developers/docs/resources/sticker#get-sticker-pack
* @see {@link https://discord.com/developers/docs/resources/sticker#get-sticker-pack}
*/
export type RESTGetAPIStickerPackResult = APIStickerPack;
@@ -23,24 +23,23 @@ export type RESTGetAPIStickerPackResult = APIStickerPack;
export type RESTGetAPIStickerPack = RESTGetAPIStickerPackResult;
/**
* https://discord.com/developers/docs/resources/sticker#list-sticker-packs
*
* @deprecated Use `RESTGetStickerPacksResult` instead
* @see {@link https://discord.com/developers/docs/resources/sticker#list-sticker-packs}
* @deprecated Use {@link RESTGetStickerPacksResult} instead
*/
export type RESTGetNitroStickerPacksResult = RESTGetStickerPacksResult;
/**
* https://discord.com/developers/docs/resources/sticker#list-guild-stickers
* @see {@link https://discord.com/developers/docs/resources/sticker#list-guild-stickers}
*/
export type RESTGetAPIGuildStickersResult = APISticker[];
/**
* https://discord.com/developers/docs/resources/sticker#get-guild-sticker
* @see {@link https://discord.com/developers/docs/resources/sticker#get-guild-sticker}
*/
export type RESTGetAPIGuildStickerResult = APISticker;
/**
* https://discord.com/developers/docs/resources/sticker#create-guild-sticker
* @see {@link https://discord.com/developers/docs/resources/sticker#create-guild-sticker}
*/
export interface RESTPostAPIGuildStickerFormDataBody {
/**
@@ -64,12 +63,12 @@ export interface RESTPostAPIGuildStickerFormDataBody {
}
/**
* https://discord.com/developers/docs/resources/sticker#create-guild-sticker
* @see {@link https://discord.com/developers/docs/resources/sticker#create-guild-sticker}
*/
export type RESTPostAPIGuildStickerResult = APISticker;
/**
* https://discord.com/developers/docs/resources/sticker#modify-guild-sticker
* @see {@link https://discord.com/developers/docs/resources/sticker#modify-guild-sticker}
*/
export interface RESTPatchAPIGuildStickerJSONBody {
/**
@@ -87,11 +86,11 @@ export interface RESTPatchAPIGuildStickerJSONBody {
}
/**
* https://discord.com/developers/docs/resources/sticker#modify-guild-sticker
* @see {@link https://discord.com/developers/docs/resources/sticker#modify-guild-sticker}
*/
export type RESTPatchAPIGuildStickerResult = APISticker;
/**
* https://discord.com/developers/docs/resources/sticker#delete-guild-sticker
* @see {@link https://discord.com/developers/docs/resources/sticker#delete-guild-sticker}
*/
export type RESTDeleteAPIGuildStickerResult = never;

26
deno/rest/v10/template.ts
View File

@@ -1,13 +1,13 @@
import type { APIGuild, APITemplate } from '../../payloads/v10/mod.ts';
import type { StrictPartial } from '../../utils/internals.ts';
import type { _StrictPartial } from '../../utils/internals.ts';
/**
* https://discord.com/developers/docs/resources/guild-template#get-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-template}
*/
export type RESTGetAPITemplateResult = APITemplate;
/**
* https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template}
*/
export interface RESTPostAPITemplateCreateGuildJSONBody {
/**
@@ -17,23 +17,23 @@ export interface RESTPostAPITemplateCreateGuildJSONBody {
/**
* base64 1024x1024 png/jpeg image for the guild icon
*
* See https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
icon?: string | undefined;
}
/**
* https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template}
*/
export type RESTPostAPITemplateCreateGuildResult = APIGuild;
/**
* https://discord.com/developers/docs/resources/guild-template#get-guild-templates
* @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-templates}
*/
export type RESTGetAPIGuildTemplatesResult = APITemplate[];
/**
* https://discord.com/developers/docs/resources/guild-template#create-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-template}
*/
export interface RESTPostAPIGuildTemplatesJSONBody {
/**
@@ -47,26 +47,26 @@ export interface RESTPostAPIGuildTemplatesJSONBody {
}
/**
* https://discord.com/developers/docs/resources/guild-template#create-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-template}
*/
export type RESTPostAPIGuildTemplatesResult = APITemplate;
/**
* https://discord.com/developers/docs/resources/guild-template#sync-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#sync-guild-template}
*/
export type RESTPutAPIGuildTemplateSyncResult = APITemplate;
/**
* https://discord.com/developers/docs/resources/guild-template#modify-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#modify-guild-template}
*/
export type RESTPatchAPIGuildTemplateJSONBody = StrictPartial<RESTPostAPIGuildTemplatesJSONBody>;
export type RESTPatchAPIGuildTemplateJSONBody = _StrictPartial<RESTPostAPIGuildTemplatesJSONBody>;
/**
* https://discord.com/developers/docs/resources/guild-template#modify-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#modify-guild-template}
*/
export type RESTPatchAPIGuildTemplateResult = APITemplate;
/**
* https://discord.com/developers/docs/resources/guild-template#delete-guild-template
* @see {@link https://discord.com/developers/docs/resources/guild-template#delete-guild-template}
*/
export type RESTDeleteAPIGuildTemplateResult = APITemplate;

32
deno/rest/v10/user.ts
View File

@@ -9,22 +9,22 @@ import type {
} from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/user#get-current-user
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
*/
export type RESTGetAPICurrentUserResult = APIUser;
/**
* https://discord.com/developers/docs/resources/user#get-user
* @see {@link https://discord.com/developers/docs/resources/user#get-user}
*/
export type RESTGetAPIUserResult = APIUser;
/**
* https://discord.com/developers/docs/resources/user#get-current-user-guild-member
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guild-member}
*/
export type RESTGetCurrentUserGuildMemberResult = APIGuildMember;
/**
* https://discord.com/developers/docs/resources/user#modify-current-user
* @see {@link https://discord.com/developers/docs/resources/user#modify-current-user}
*/
export interface RESTPatchAPICurrentUserJSONBody {
/**
@@ -42,12 +42,12 @@ export interface RESTPatchAPICurrentUserJSONBody {
}
/**
* https://discord.com/developers/docs/resources/user#modify-current-user
* @see {@link https://discord.com/developers/docs/resources/user#modify-current-user}
*/
export type RESTPatchAPICurrentUserResult = APIUser;
/**
* https://discord.com/developers/docs/resources/user#get-current-user-guilds
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
*/
export interface RESTGetAPICurrentUserGuildsQuery {
/**
@@ -61,13 +61,13 @@ export interface RESTGetAPICurrentUserGuildsQuery {
/**
* Max number of guilds to return (1-200)
*
* @default 200
* @defaultValue `200`
*/
limit?: number;
/**
* Include approximate member and presence counts in response
*
* @default false
* @defaultValue `false`
*/
with_counts?: boolean;
}
@@ -85,17 +85,17 @@ export interface RESTAPIPartialCurrentUserGuild {
}
/**
* https://discord.com/developers/docs/resources/user#get-current-user-guilds
* @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
*/
export type RESTGetAPICurrentUserGuildsResult = RESTAPIPartialCurrentUserGuild[];
/**
* https://discord.com/developers/docs/resources/user#leave-guild
* @see {@link https://discord.com/developers/docs/resources/user#leave-guild}
*/
export type RESTDeleteAPICurrentUserGuildResult = never;
/**
* https://discord.com/developers/docs/resources/user#create-dm
* @see {@link https://discord.com/developers/docs/resources/user#create-dm}
*/
export interface RESTPostAPICurrentUserCreateDMChannelJSONBody {
/**
@@ -105,22 +105,22 @@ export interface RESTPostAPICurrentUserCreateDMChannelJSONBody {
}
/**
* https://discord.com/developers/docs/resources/user#create-dm
* @see {@link https://discord.com/developers/docs/resources/user#create-dm}
*/
export type RESTPostAPICurrentUserCreateDMChannelResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/user#get-user-connections
* @see {@link https://discord.com/developers/docs/resources/user#get-user-connections}
*/
export type RESTGetAPICurrentUserConnectionsResult = APIConnection[];
/**
* https://discord.com/developers/docs/resources/user#get-user-application-role-connection
* @see {@link https://discord.com/developers/docs/resources/user#get-user-application-role-connection}
*/
export type RESTGetAPICurrentUserApplicationRoleConnectionResult = APIApplicationRoleConnection;
/**
* https://discord.com/developers/docs/resources/user#update-user-application-role-connection
* @see {@link https://discord.com/developers/docs/resources/user#update-user-application-role-connection}
*/
export interface RESTPutAPICurrentUserApplicationRoleConnectionJSONBody {
/**
@@ -138,6 +138,6 @@ export interface RESTPutAPICurrentUserApplicationRoleConnectionJSONBody {
}
/**
* https://discord.com/developers/docs/resources/user#update-user-application-role-connection
* @see {@link https://discord.com/developers/docs/resources/user#update-user-application-role-connection}
*/
export type RESTPutAPICurrentUserApplicationRoleConnectionResult = APIApplicationRoleConnection;

16
deno/rest/v10/voice.ts
View File

@@ -2,27 +2,27 @@ import type { Snowflake } from '../../globals.ts';
import type { APIVoiceRegion, APIVoiceState } from '../../payloads/v10/mod.ts';
/**
* https://discord.com/developers/docs/resources/voice#list-voice-regions
* @see {@link https://discord.com/developers/docs/resources/voice#list-voice-regions}
*/
export type RESTGetAPIVoiceRegionsResult = APIVoiceRegion[];
/**
* @deprecated This was exported with the wrong name, use `RESTGetAPIVoiceRegionsResult` instead
* @deprecated This was exported with the wrong name, use {@link RESTGetAPIVoiceRegionsResult} instead
*/
export type GetAPIVoiceRegionsResult = RESTGetAPIVoiceRegionsResult;
/**
* https://discord.com/developers/docs/resources/voice#get-current-user-voice-state
* @see {@link https://discord.com/developers/docs/resources/voice#get-current-user-voice-state}
*/
export type RESTGetAPIGuildVoiceStateCurrentMemberResult = APIVoiceState;
/**
* https://discord.com/developers/docs/resources/voice#get-user-voice-state
* @see {@link https://discord.com/developers/docs/resources/voice#get-user-voice-state}
*/
export type RESTGetAPIGuildVoiceStateUserResult = APIVoiceState;
/**
* https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state
* @see {@link https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state}
*/
export interface RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody {
/**
@@ -40,12 +40,12 @@ export interface RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody {
}
/**
* https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state
* @see {@link https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state}
*/
export type RESTPatchAPIGuildVoiceStateCurrentMemberResult = never;
/**
* https://discord.com/developers/docs/resources/voice#modify-user-voice-state
* @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state}
*/
export interface RESTPatchAPIGuildVoiceStateUserJSONBody {
/**
@@ -59,6 +59,6 @@ export interface RESTPatchAPIGuildVoiceStateUserJSONBody {
}
/**
* https://discord.com/developers/docs/resources/voice#modify-user-voice-state
* @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state}
*/
export type RESTPatchAPIGuildVoiceStateUserResult = never;

80
deno/rest/v10/webhook.ts
View File

@@ -8,11 +8,11 @@ import type {
MessageFlags,
APIMessageActionRowComponent,
} from '../../payloads/v10/mod.ts';
import type { AddUndefinedToPossiblyUndefinedPropertiesOfInterface, Nullable } from '../../utils/internals.ts';
import type { _AddUndefinedToPossiblyUndefinedPropertiesOfInterface, _Nullable } from '../../utils/internals.ts';
import type { RESTAPIAttachment } from './channel.ts';
import type { RESTAPIPoll } from './poll.ts';
/**
* https://discord.com/developers/docs/resources/webhook#create-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#create-webhook}
*/
export interface RESTPostAPIChannelWebhookJSONBody {
/**
@@ -22,38 +22,38 @@ export interface RESTPostAPIChannelWebhookJSONBody {
/**
* Image for the default webhook avatar
*
* See https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
avatar?: string | null | undefined;
}
/**
* https://discord.com/developers/docs/resources/webhook#create-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#create-webhook}
*/
export type RESTPostAPIChannelWebhookResult = APIWebhook;
/**
* https://discord.com/developers/docs/resources/webhook#get-channel-webhooks
* @see {@link https://discord.com/developers/docs/resources/webhook#get-channel-webhooks}
*/
export type RESTGetAPIChannelWebhooksResult = APIWebhook[];
/**
* https://discord.com/developers/docs/resources/webhook#get-guild-webhooks
* @see {@link https://discord.com/developers/docs/resources/webhook#get-guild-webhooks}
*/
export type RESTGetAPIGuildWebhooksResult = APIWebhook[];
/**
* https://discord.com/developers/docs/resources/webhook#get-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook}
*/
export type RESTGetAPIWebhookResult = APIWebhook;
/**
* https://discord.com/developers/docs/resources/webhook#get-webhook-with-token
* @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook-with-token}
*/
export type RESTGetAPIWebhookWithTokenResult = Omit<APIWebhook, 'user'>;
/**
* https://discord.com/developers/docs/resources/webhook#modify-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#modify-webhook}
*/
export interface RESTPatchAPIWebhookJSONBody {
/**
@@ -63,7 +63,7 @@ export interface RESTPatchAPIWebhookJSONBody {
/**
* Image for the default webhook avatar
*
* See https://discord.com/developers/docs/reference#image-data
* @see {@link https://discord.com/developers/docs/reference#image-data}
*/
avatar?: string | null | undefined;
/**
@@ -73,32 +73,32 @@ export interface RESTPatchAPIWebhookJSONBody {
}
/**
* https://discord.com/developers/docs/resources/webhook#modify-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#modify-webhook}
*/
export type RESTPatchAPIWebhookResult = APIWebhook;
/**
* https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token
* @see {@link https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token}
*/
export type RESTPatchAPIWebhookWithTokenJSONBody = Omit<RESTPatchAPIWebhookJSONBody, 'channel_id'>;
/**
* https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token
* @see {@link https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token}
*/
export type RESTPatchAPIWebhookWithTokenResult = RESTGetAPIWebhookWithTokenResult;
/**
* https://discord.com/developers/docs/resources/webhook#delete-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook}
*/
export type RESTDeleteAPIWebhookResult = never;
/**
* https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token
* @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token}
*/
export type RESTDeleteAPIWebhookWithTokenResult = never;
/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook}
*/
export interface RESTPostAPIWebhookWithTokenJSONBody {
/**
@@ -120,13 +120,13 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
/**
* Embedded `rich` content
*
* See https://discord.com/developers/docs/resources/channel#embed-object
* @see {@link https://discord.com/developers/docs/resources/channel#embed-object}
*/
embeds?: APIEmbed[] | undefined;
/**
* Allowed mentions for the message
*
* See https://discord.com/developers/docs/resources/channel#allowed-mentions-object
* @see {@link https://discord.com/developers/docs/resources/channel#allowed-mentions-object}
*/
allowed_mentions?: APIAllowedMentions | undefined;
/**
@@ -134,7 +134,7 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
*
* Requires an application-owned webhook
*
* See https://discord.com/developers/docs/interactions/message-components#component-object
* @see {@link https://discord.com/developers/docs/interactions/message-components#component-object}
*/
components?: APIActionRowComponent<APIMessageActionRowComponent>[] | undefined;
/**
@@ -162,7 +162,7 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
}
/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook}
*/
export type RESTPostAPIWebhookWithTokenFormDataBody =
| (Record<`files[${bigint}]`, unknown> & {
@@ -174,14 +174,14 @@ export type RESTPostAPIWebhookWithTokenFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPostAPIWebhookWithTokenJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params}
*/
export interface RESTPostAPIWebhookWithTokenQuery {
/**
* Waits for server confirmation of message send before response, and returns the created message body
* (defaults to `false`; when `false` a message that is not saved does not return an error)
*
* @default false
* @defaultValue `false`
*/
wait?: boolean;
/**
@@ -200,7 +200,7 @@ export interface RESTPostAPIWebhookWithTokenQuery {
}
/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook}
*/
export type RESTPostAPIWebhookWithTokenResult = never;
@@ -208,17 +208,17 @@ export type RESTPostAPIWebhookWithTokenResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params}
*/
export type RESTPostAPIWebhookWithTokenWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params}
*/
export type RESTPostAPIWebhookWithTokenSlackQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook}
*/
export type RESTPostAPIWebhookWithTokenSlackResult = never;
@@ -226,17 +226,17 @@ export type RESTPostAPIWebhookWithTokenSlackResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params}
*/
export type RESTPostAPIWebhookWithTokenSlackWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params}
*/
export type RESTPostAPIWebhookWithTokenGitHubQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook}
*/
export type RESTPostAPIWebhookWithTokenGitHubResult = never;
@@ -244,34 +244,34 @@ export type RESTPostAPIWebhookWithTokenGitHubResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params}
*/
export type RESTPostAPIWebhookWithTokenGitHubWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#get-webhook-message
* @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook-message}
*/
export type RESTGetAPIWebhookWithTokenMessageResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#get-webhook-message-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook-message-query-string-params}
*/
export interface RESTGetAPIWebhookWithTokenMessageQuery {
thread_id?: string;
}
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message
* @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook-message}
*/
export type RESTPatchAPIWebhookWithTokenMessageJSONBody = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
Nullable<Pick<RESTPostAPIWebhookWithTokenJSONBody, 'allowed_mentions' | 'components' | 'content' | 'embeds'>>
export type RESTPatchAPIWebhookWithTokenMessageJSONBody = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
_Nullable<Pick<RESTPostAPIWebhookWithTokenJSONBody, 'allowed_mentions' | 'components' | 'content' | 'embeds'>>
> & {
/**
* Attached files to keep
*
* Starting with API v10, the `attachments` array must contain all attachments that should be present after edit, including **retained and new** attachments provided in the request body.
*
* 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}
*/
attachments?: RESTAPIAttachment[] | undefined;
/**
@@ -284,7 +284,7 @@ export type RESTPatchAPIWebhookWithTokenMessageJSONBody = AddUndefinedToPossibly
};
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message
* @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook-message}
*/
export type RESTPatchAPIWebhookWithTokenMessageFormDataBody =
| (Record<`files[${bigint}]`, unknown> & {
@@ -296,16 +296,16 @@ export type RESTPatchAPIWebhookWithTokenMessageFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPatchAPIWebhookWithTokenMessageJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message-query-string-params
* @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook-message-query-string-params}
*/
export type RESTPatchAPIWebhookWithTokenQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'with_components'>;
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message
* @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook-message}
*/
export type RESTPatchAPIWebhookWithTokenMessageResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#delete-webhook-message
* @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook-message}
*/
export type RESTDeleteAPIWebhookWithTokenMessageResult = never;

6
deno/rest/v8/channel.ts
View File

@@ -17,7 +17,7 @@ import type {
OverwriteType,
VideoQualityMode,
} from '../../payloads/v8/mod.ts';
import type { AddUndefinedToPossiblyUndefinedPropertiesOfInterface, StrictPartial } from '../../utils/internals.ts';
import type { _AddUndefinedToPossiblyUndefinedPropertiesOfInterface, _StrictPartial } from '../../utils/internals.ts';
/**
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
@@ -176,10 +176,10 @@ export type RESTGetAPIChannelMessageResult = APIMessage;
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
export type APIMessageReferenceSend = AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
export type APIMessageReferenceSend = _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<
Required<Pick<APIMessageReference, 'message_id'>>
> &
StrictPartial<APIMessageReference> & {
_StrictPartial<APIMessageReference> & {
/**
* Whether to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message
*

12
deno/rest/v8/guild.ts
View File

@@ -22,7 +22,7 @@ import type {
GuildVerificationLevel,
GuildWidgetStyle,
} from '../../payloads/v8/mod.ts';
import type { Nullable, StrictPartial, StrictRequired, UnionToIntersection } from '../../utils/internals.ts';
import type { _Nullable, _StrictPartial, _StrictRequired, _UnionToIntersection } from '../../utils/internals.ts';
import type { RESTPutAPIChannelPermissionJSONBody } from './channel.ts';
/**
@@ -40,9 +40,9 @@ export type APIGuildChannelResolvable = Exclude<APIChannel, APIDMChannel | APIGr
/**
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
export type APIGuildCreatePartialChannel = StrictPartial<
export type APIGuildCreatePartialChannel = _StrictPartial<
Pick<
UnionToIntersection<APIGuildChannelResolvable>,
_UnionToIntersection<APIGuildChannelResolvable>,
'bitrate' | 'nsfw' | 'rate_limit_per_user' | 'topic' | 'type' | 'user_limit'
>
> & {
@@ -541,7 +541,7 @@ export interface RESTPatchAPICurrentGuildMemberJSONBody {
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
export type RESTPatchAPICurrentGuildMemberNicknameResult =
StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;
_StrictRequired<RESTPatchAPICurrentGuildMemberNicknameJSONBody>;
/**
* https://discord.com/developers/docs/resources/guild#add-guild-member-role
@@ -848,7 +848,7 @@ export type RESTGetAPIGuildWidgetSettingsResult = APIGuildWidgetSettings;
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
export type RESTPatchAPIGuildWidgetSettingsJSONBody = StrictPartial<APIGuildWidgetSettings>;
export type RESTPatchAPIGuildWidgetSettingsJSONBody = _StrictPartial<APIGuildWidgetSettings>;
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-widget
@@ -968,7 +968,7 @@ export type RESTGetAPIGuildWelcomeScreenResult = APIGuildWelcomeScreen;
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
export type RESTPatchAPIGuildWelcomeScreenJSONBody = Nullable<StrictPartial<APIGuildWelcomeScreen>> & {
export type RESTPatchAPIGuildWelcomeScreenJSONBody = _Nullable<_StrictPartial<APIGuildWelcomeScreen>> & {
/**
* Whether the welcome screen is enabled
*/

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