daenamnu/discordeno
1
0
Fork 0
mirror of https://github.com/discordeno/discordeno.git synced 2026-05-21 10:50:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: update documentation links to new domain (#4767)

Browse Source 
* feat: update documentation links to new domain

* fix some links in the docs
This commit is contained in:
Fleny
2026-02-16 03:16:51 +01:00
committed by GitHub
parent 0e34445d68
commit a4a5f172d4
64 changed files with 784 additions and 784 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/bot/src/transformers/toggles/guild.ts
View File

@@ -76,7 +76,7 @@ export const GuildToggle = {
invitesDisabled: 1n << 29n,
/** Whether the guild has access to set an invite splash background */
inviteSplash: 1n << 5n,
/** Whether the guild has enabled [Membership Screening](https://discord.com/developers/docs/resources/guild#membership-screening-object) */
/** Whether the guild has enabled [Membership Screening](https://docs.discord.com/developers/resources/guild#membership-screening-object) */
memberVerificationGateEnabled: 1n << 19n,
/** Whether the guild has more soundboard sound slot */
moreSoundboard: 1n << 24n,
@@ -274,7 +274,7 @@ export class GuildToggles extends ToggleBitfieldBigint {
return this.has('welcomeScreenEnabled');
}
/** Whether the guild has enabled [Membership Screening](https://discord.com/developers/docs/resources/guild#membership-screening-object) */
/** Whether the guild has enabled [Membership Screening](https://docs.discord.com/developers/resources/guild#membership-screening-object) */
get memberVerificationGateEnabled(): boolean {
return this.has('memberVerificationGateEnabled');
}

12
packages/bot/src/transformers/types.ts
View File

@@ -1734,7 +1734,7 @@ export interface InviteStageInstance {
}
export interface Sticker {
/** [Id of the sticker](https://discord.com/developers/docs/reference#image-formatting) */
/** [Id of the sticker](https://docs.discord.com/developers/reference#image-formatting) */
id: bigint;
/** Id of the pack the sticker is from */
packId?: bigint;
@@ -1744,9 +1744,9 @@ export interface Sticker {
description: string;
/** a unicode emoji representing the sticker's expression */
tags: string;
/** [type of sticker](https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types) */
/** [type of sticker](https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-types) */
type: StickerTypes;
/** [Type of sticker format](https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types) */
/** [Type of sticker format](https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-format-types) */
formatType: StickerFormatTypes;
/** Whether or not the sticker is available */
available?: boolean;
@@ -2003,7 +2003,7 @@ export interface Subscription {
country?: string;
}
/** https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object-soundboard-sound-structure */
/** https://docs.discord.com/developers/resources/soundboard#soundboard-sound-object-soundboard-sound-structure */
export interface SoundboardSound {
/** The name of this sound */
name: string;
@@ -2023,7 +2023,7 @@ export interface SoundboardSound {
user?: User;
}
/** https://discord.com/developers/docs/resources/lobby#lobby-object-lobby-structure */
/** https://docs.discord.com/developers/resources/lobby#lobby-object-lobby-structure */
export interface Lobby {
/** The id of this channel */
id: bigint;
@@ -2037,7 +2037,7 @@ export interface Lobby {
linkedChannel?: Channel;
}
/** https://discord.com/developers/docs/resources/lobby#lobby-member-object-lobby-member-structure */
/** https://docs.discord.com/developers/resources/lobby#lobby-member-object-lobby-member-structure */
export interface LobbyMember {
/** The id of the user */
id: bigint;

6
packages/gateway/src/Shard.ts
View File

@@ -693,7 +693,7 @@ export class DiscordenoShard {
this.events.invalidSession?.(this, resumable);
// We need to wait for a random amount of time between 1 and 5
// Reference: https://discord.com/developers/docs/topics/gateway#resuming
// Reference: https://docs.discord.com/developers/events/gateway#resuming
await delay(Math.floor((Math.random() * 4 + 1) * 1000));
this.resolves.get('INVALID_SESSION')?.(packet);
@@ -796,7 +796,7 @@ export class DiscordenoShard {
// The first heartbeat needs to be send with a random delay between `0` and `interval`
// Using a `setTimeout(_, jitter)` here to accomplish that.
// `Math.random()` can be `0` so we use `0.5` if this happens
// Reference: https://discord.com/developers/docs/topics/gateway#heartbeating
// Reference: https://docs.discord.com/developers/events/gateway#heartbeating
const jitter = Math.ceil(this.heart.interval * (Math.random() || 0.5));
this.heart.timeoutId = setTimeout(() => {
@@ -827,7 +827,7 @@ export class DiscordenoShard {
// The Shard did not receive a heartbeat ACK from Discord in time,
// therefore we have to assume that the connection has failed or got "zombied".
// The Shard needs to start a re-identify action accordingly.
// Reference: https://discord.com/developers/docs/topics/gateway#heartbeating-example-gateway-heartbeat-ack
// Reference: https://docs.discord.com/developers/events/gateway#heartbeating-example-gateway-heartbeat-ack
if (!this.heart.acknowledged) {
this.logger.debug(`[Shard] Heartbeat not acknowledged for Shard #${this.id}. Assuming zombied connection.`);
await this.close(ShardSocketCloseCodes.ZombiedConnection, 'Zombied connection, did not receive an heartbeat ACK in time.');

8
packages/gateway/src/manager.ts
View File

@@ -779,7 +779,7 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
*
* Fires a _Voice State Update_ gateway event.
*
* @see {@link https://discord.com/developers/docs/topics/gateway#update-voice-state}
* @see {@link https://docs.discord.com/developers/events/gateway-events#update-voice-state}
*/
joinVoiceChannel: (
guildId: BigString,
@@ -822,7 +822,7 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
*
* Fires a _Guild Members Chunk_ gateway event for every 1000 members fetched.
*
* @see {@link https://discord.com/developers/docs/topics/gateway#request-guild-members}
* @see {@link https://docs.discord.com/developers/events/gateway-events#request-guild-members}
*/
requestMembers: (guildId: BigString, options?: Omit<RequestGuildMembers, 'guildId'>) => Promise<Camelize<DiscordMemberWithUser[]>>;
/**
@@ -835,7 +835,7 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
* @remarks
* Fires a _Voice State Update_ gateway event.
*
* @see {@link https://discord.com/developers/docs/topics/gateway#update-voice-state}
* @see {@link https://docs.discord.com/developers/events/gateway-events#update-voice-state}
*/
leaveVoiceChannel: (guildId: BigString) => Promise<void>;
/**
@@ -855,7 +855,7 @@ export interface GatewayManager extends Required<CreateGatewayManagerOptions> {
*
* To avoid this Discordeno will automatically try to group the ids based on what shard they will need to be sent, but this involves sending multiple messages in multiple shards
*
* @see {@link https://discord.com/developers/docs/topics/gateway-events#request-soundboard-sounds}
* @see {@link https://docs.discord.com/developers/events/gateway-events#request-soundboard-sounds}
*/
requestSoundboardSounds: (guildIds: BigString[]) => Promise<void>;
/** This managers cache related settings. */

10
packages/gateway/src/types.ts
View File

@@ -25,7 +25,7 @@ export enum TransportCompression {
* @remarks
* Uses `node:zlib` to decompress the payloads
*
* @see https://discord.com/developers/docs/topics/gateway#zlibstream
* @see https://docs.discord.com/developers/events/gateway#zlib-stream
*/
zlib = 'zlib-stream',
/**
@@ -36,7 +36,7 @@ export enum TransportCompression {
*
* `fzstd` is an optional dependency. You will need to install it to be able to use it.
*
* @see https://discord.com/developers/docs/topics/gateway#zstdstream
* @see https://docs.discord.com/developers/events/gateway#zstd-stream
*/
zstd = 'zstd-stream',
}
@@ -50,7 +50,7 @@ export interface ShardGatewayConfig {
*
* @default false
*
* @see https://discord.com/developers/docs/topics/gateway#payload-compression
* @see https://docs.discord.com/developers/events/gateway#payload-compression
*/
compress: boolean;
/**
@@ -58,7 +58,7 @@ export interface ShardGatewayConfig {
*
* @default null
*
* @see https://discord.com/developers/docs/topics/gateway#transport-compression
* @see https://docs.discord.com/developers/events/gateway#transport-compression
*/
transportCompression: TransportCompression | null;
/** The calculated intent value of the events which the shard should receive.
@@ -177,7 +177,7 @@ export interface ShardSocketRequest {
d: unknown;
}
/** https://discord.com/developers/docs/topics/gateway#update-voice-state */
/** https://docs.discord.com/developers/events/gateway-events#update-voice-state */
export interface UpdateVoiceState {
/** id of the guild */
guildId: string;

2
packages/rest/src/manager.ts
View File

@@ -682,7 +682,7 @@ export function createRestManager(options: CreateRestManagerOptions): RestManage
error.message = `[${reason.status}] ${errorText}`;
// If discord sent us JSON, it is probably going to be an error message from which we can get and add some information about the error to the error message, the full body will be in the error.cause
// https://discord.com/developers/docs/reference#error-messages
// https://docs.discord.com/developers/reference#error-messages
if (typeof reason.body === 'object' && hasProperty(reason.body, 'code') && hasProperty(reason.body, 'message')) {
error.message += `\nDiscord error: [${reason.body.code}] ${reason.body.message}`;
}

348
packages/rest/src/types.ts
View File

File diff suppressed because it is too large Load Diff

20
packages/types/src/discord/application.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/application */
/** Types for: https://docs.discord.com/developers/resources/application */
import type { DiscordGuild } from './guild.js';
import type { OAuth2Scope } from './oauth2.js';
@@ -6,7 +6,7 @@ import type { DiscordTeam } from './teams.js';
import type { DiscordUser } from './user.js';
import type { DiscordWebhookEventType } from './webhookEvents.js';
/** https://discord.com/developers/docs/resources/application#application-object-application-structure */
/** https://docs.discord.com/developers/resources/application#application-object-application-structure */
export interface DiscordApplication {
/** ID of the app */
id: string;
@@ -74,7 +74,7 @@ export interface DiscordApplication {
custom_install_url?: string;
}
/** https://discord.com/developers/docs/resources/application#application-object-application-integration-types */
/** https://docs.discord.com/developers/resources/application#application-object-application-integration-types */
export enum DiscordApplicationIntegrationType {
/** App is installable to servers */
GuildInstall = 0,
@@ -82,13 +82,13 @@ export enum DiscordApplicationIntegrationType {
UserInstall = 1,
}
/** https://discord.com/developers/docs/resources/application#application-object-application-integration-type-configuration-object */
/** https://docs.discord.com/developers/resources/application#application-object-application-integration-type-configuration-object */
export interface DiscordApplicationIntegrationTypeConfiguration {
/** Install params for each installation context's default in-app authorization link */
oauth2_install_params?: DiscordInstallParams;
}
/** https://discord.com/developers/docs/resources/application#application-object-application-event-webhook-status */
/** https://docs.discord.com/developers/resources/application#application-object-application-event-webhook-status */
export enum DiscordApplicationEventWebhookStatus {
/** Webhook events are disabled by developer */
Disabled = 1,
@@ -98,7 +98,7 @@ export enum DiscordApplicationEventWebhookStatus {
DisabledByDiscord = 3,
}
/** https://discord.com/developers/docs/resources/application#application-object-application-flags */
/** https://docs.discord.com/developers/resources/application#application-object-application-flags */
export enum ApplicationFlags {
/** Indicates if an app uses the Auto Moderation API. */
ApplicationAutoModerationRuleCreateBadge = 1 << 6,
@@ -122,7 +122,7 @@ export enum ApplicationFlags {
ApplicationCommandBadge = 1 << 23,
}
/** https://discord.com/developers/docs/resources/application#install-params-object-install-params-structure */
/** https://docs.discord.com/developers/resources/application#install-params-object-install-params-structure */
export interface DiscordInstallParams {
/** Scopes to add the application to the server with */
scopes: OAuth2Scope[];
@@ -130,7 +130,7 @@ export interface DiscordInstallParams {
permissions: string;
}
/** https://discord.com/developers/docs/resources/application#get-application-activity-instance-activity-instance-object */
/** https://docs.discord.com/developers/resources/application#get-application-activity-instance-activity-instance-object */
export interface DiscordActivityInstance {
/** Application ID */
application_id: string;
@@ -144,7 +144,7 @@ export interface DiscordActivityInstance {
users: string[];
}
/** https://discord.com/developers/docs/resources/application#get-application-activity-instance-activity-location-object */
/** https://docs.discord.com/developers/resources/application#get-application-activity-instance-activity-location-object */
export interface DiscordActivityLocation {
/** The unique identifier for the location */
id: string;
@@ -156,7 +156,7 @@ export interface DiscordActivityLocation {
guild_id?: string | null;
}
/** https://discord.com/developers/docs/resources/application#get-application-activity-instance-activity-location-kind-enum */
/** https://docs.discord.com/developers/resources/application#get-application-activity-instance-activity-location-kind-enum */
export enum DiscordActivityLocationKind {
/** The Location is a Guild Channel */
GuildChannel = 'gc',

6
packages/types/src/discord/applicationRoleConnectionMetadata.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/application-role-connection-metadata */
/** Types for: https://docs.discord.com/developers/resources/application-role-connection-metadata */
import type { Localization } from './reference.js';
/** https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-structure */
/** https://docs.discord.com/developers/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-structure */
export interface DiscordApplicationRoleConnectionMetadata {
/** Type of metadata value */
type: DiscordApplicationRoleConnectionMetadataType;
@@ -33,7 +33,7 @@ export interface DiscordApplicationRoleConnectionMetadata {
description_localizations: Localization;
}
/** https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-type */
/** https://docs.discord.com/developers/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-type */
export enum DiscordApplicationRoleConnectionMetadataType {
/** The metadata value (integer) is less than or equal to the guild's configured value (integer) */
IntegerLessThanOrEqual = 1,

14
packages/types/src/discord/auditLog.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/audit-log */
/** Types for: https://docs.discord.com/developers/resources/audit-log */
import type { DiscordAutoModerationRule } from './autoModeration.js';
import type { DiscordChannel, DiscordOverwrite, DiscordThreadMetadata } from './channel.js';
@@ -14,7 +14,7 @@ import type { DiscordSticker } from './sticker.js';
import type { DiscordUser } from './user.js';
import type { DiscordWebhook } from './webhook.js';
/** https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure */
/** https://docs.discord.com/developers/resources/audit-log#audit-log-object-audit-log-structure */
export interface DiscordAuditLog {
/** List of application commands referenced in the audit log */
application_commands: DiscordApplicationCommand[];
@@ -39,7 +39,7 @@ export interface DiscordAuditLog {
webhooks: DiscordWebhook[];
}
/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure */
/** https://docs.discord.com/developers/resources/audit-log#audit-log-entry-object-audit-log-entry-structure */
export interface DiscordAuditLogEntry {
/** ID of the affected entity (webhook, user, role, etc.) */
target_id: string | null;
@@ -57,7 +57,7 @@ export interface DiscordAuditLogEntry {
reason?: string;
}
/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events */
/** https://docs.discord.com/developers/resources/audit-log#audit-log-entry-object-audit-log-events */
export enum AuditLogEvents {
/** Server settings were updated */
GuildUpdate = 1,
@@ -195,7 +195,7 @@ export enum AuditLogEvents {
HomeSettingsUpdate,
}
/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events */
/** https://docs.discord.com/developers/resources/audit-log#audit-log-entry-object-audit-log-events */
export type DiscordAuditLogChange =
| DiscordAuditLogChangeObject<DiscordGuild>
| DiscordAuditLogChangeObject<DiscordChannel>
@@ -218,7 +218,7 @@ export type DiscordAuditLogChange =
| DiscordAuditLogChangeObject<DiscordGuildOnboardingPrompt>
| DiscordAuditLogChangeObject<DiscordGuildOnboarding>;
/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info */
/** https://docs.discord.com/developers/resources/audit-log#audit-log-entry-object-optional-audit-entry-info */
export interface DiscordOptionalAuditEntryInfo {
/**
* ID of the app whose permissions were targeted.
@@ -306,7 +306,7 @@ export interface DiscordOptionalAuditEntryInfo {
integration_type?: string;
}
/** https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure */
/** https://docs.discord.com/developers/resources/audit-log#audit-log-change-object-audit-log-change-structure */
export type DiscordAuditLogChangeObject<T> = NonNullable<
{
[K in keyof T]: {

18
packages/types/src/discord/autoModeration.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/resources/auto-moderation */
/** Types for: https://docs.discord.com/developers/resources/auto-moderation */
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-auto-moderation-rule-structure */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-rule-object-auto-moderation-rule-structure */
export interface DiscordAutoModerationRule {
/** The id of this rule */
id: string;
@@ -26,7 +26,7 @@ export interface DiscordAutoModerationRule {
exempt_channels: string[];
}
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-rule-object-trigger-types */
export enum AutoModerationTriggerTypes {
/** Check if content contains words from a user defined list of keywords. Max 6 per guild */
Keyword = 1,
@@ -40,7 +40,7 @@ export enum AutoModerationTriggerTypes {
MemberProfile,
}
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata */
export interface DiscordAutoModerationRuleTriggerMetadata {
/**
* Substrings which will be searched for in content.
@@ -95,7 +95,7 @@ export interface DiscordAutoModerationRuleTriggerMetadata {
mention_raid_protection_enabled?: boolean;
}
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-preset-types */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-rule-object-keyword-preset-types */
export enum DiscordAutoModerationRuleTriggerMetadataPresets {
/** Words that may be considered forms of swearing or cursing */
Profanity = 1,
@@ -105,7 +105,7 @@ export enum DiscordAutoModerationRuleTriggerMetadataPresets {
Slurs,
}
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-event-types */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-rule-object-event-types */
export enum AutoModerationEventTypes {
/** When a user sends a message */
MessageSend = 1,
@@ -113,7 +113,7 @@ export enum AutoModerationEventTypes {
MemberUpdate,
}
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-auto-moderation-action-structure */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-action-object-auto-moderation-action-structure */
export interface DiscordAutoModerationAction {
/** The type of action to take when a rule is triggered */
type: AutoModerationActionType;
@@ -121,7 +121,7 @@ export interface DiscordAutoModerationAction {
metadata?: DiscordAutoModerationActionMetadata;
}
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-types */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-action-object-action-types */
export enum AutoModerationActionType {
/** Blocks the content of a message according to the rule */
BlockMessage = 1,
@@ -140,7 +140,7 @@ export enum AutoModerationActionType {
BlockMemberInteraction,
}
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-action-object-action-metadata */
export interface DiscordAutoModerationActionMetadata {
/**
* The id of channel to which user content should be logged.

36
packages/types/src/discord/channel.ts
View File

@@ -1,10 +1,10 @@
/** Types for: https://discord.com/developers/docs/resources/channel */
/** Types for: https://docs.discord.com/developers/resources/channel */
import type { DiscordThreadCreateExtra } from './gateway.js';
import type { DiscordMember } from './guild.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/channel#channel-object-channel-structure */
/** https://docs.discord.com/developers/resources/channel#channel-object-channel-structure */
export interface DiscordChannel extends Partial<DiscordThreadCreateExtra> {
/** The id of the channel */
id: string;
@@ -134,7 +134,7 @@ export interface DiscordChannel extends Partial<DiscordThreadCreateExtra> {
default_forum_layout?: ForumLayout;
}
/** https://discord.com/developers/docs/resources/channel#channel-object-channel-types */
/** https://docs.discord.com/developers/resources/channel#channel-object-channel-types */
export enum ChannelTypes {
/** A text channel within a server */
GuildText,
@@ -164,7 +164,7 @@ export enum ChannelTypes {
GuildMedia,
}
/** https://discord.com/developers/docs/resources/channel#channel-object-video-quality-modes */
/** https://docs.discord.com/developers/resources/channel#channel-object-video-quality-modes */
export enum VideoQualityModes {
/** Discord chooses the quality for optimal performance */
Auto = 1,
@@ -172,7 +172,7 @@ export enum VideoQualityModes {
Full,
}
/** https://discord.com/developers/docs/resources/channel#channel-object-channel-flags */
/** https://docs.discord.com/developers/resources/channel#channel-object-channel-flags */
export enum ChannelFlags {
None,
/** this thread is pinned to the top of its parent `GUILD_FORUM` channel */
@@ -183,7 +183,7 @@ export enum ChannelFlags {
HideMediaDownloadOptions = 1 << 15,
}
/** https://discord.com/developers/docs/resources/channel#channel-object-sort-order-types */
/** https://docs.discord.com/developers/resources/channel#channel-object-sort-order-types */
export enum SortOrderTypes {
/** Sort forum posts by activity */
LatestActivity,
@@ -191,7 +191,7 @@ export enum SortOrderTypes {
CreationDate,
}
/** https://discord.com/developers/docs/resources/channel#channel-object-forum-layout-types */
/** https://docs.discord.com/developers/resources/channel#channel-object-forum-layout-types */
export enum ForumLayout {
/** No default has been set for forum channel. */
NotSet = 0,
@@ -201,7 +201,7 @@ export enum ForumLayout {
GalleryView = 2,
}
/** https://discord.com/developers/docs/resources/channel#followed-channel-object-followed-channel-structure */
/** https://docs.discord.com/developers/resources/channel#followed-channel-object-followed-channel-structure */
export interface DiscordFollowedChannel {
/** Source message id */
channel_id: string;
@@ -209,13 +209,13 @@ export interface DiscordFollowedChannel {
webhook_id: string;
}
/** https://discord.com/developers/docs/resources/channel#overwrite-object-overwrite-structure */
/** https://docs.discord.com/developers/resources/channel#overwrite-object-overwrite-structure */
export enum OverwriteTypes {
Role,
Member,
}
/** https://discord.com/developers/docs/resources/channel#overwrite-object-overwrite-structure */
/** https://docs.discord.com/developers/resources/channel#overwrite-object-overwrite-structure */
export interface DiscordOverwrite {
/** Either 0 (role) or 1 (member) */
type: OverwriteTypes;
@@ -227,7 +227,7 @@ export interface DiscordOverwrite {
deny?: string;
}
/** https://discord.com/developers/docs/resources/channel#thread-metadata-object-thread-metadata-structure */
/** https://docs.discord.com/developers/resources/channel#thread-metadata-object-thread-metadata-structure */
export interface DiscordThreadMetadata {
/** Whether the thread is archived */
archived: boolean;
@@ -243,7 +243,7 @@ export interface DiscordThreadMetadata {
create_timestamp?: string | null;
}
/** https://discord.com/developers/docs/resources/channel#thread-member-object-thread-member-structure */
/** https://docs.discord.com/developers/resources/channel#thread-member-object-thread-member-structure */
export interface DiscordThreadMember {
/**
* The id of the thread
@@ -274,10 +274,10 @@ export interface DiscordThreadMember {
member?: DiscordMember;
}
/** https://discord.com/developers/docs/resources/channel#thread-member-object-thread-member-structure, the first asterisk */
/** https://docs.discord.com/developers/resources/channel#thread-member-object-thread-member-structure, the first asterisk */
export interface DiscordThreadMemberGuildCreate extends Omit<DiscordThreadMember, 'id' | 'user_id' | 'member'> {}
/** https://discord.com/developers/docs/resources/channel#default-reaction-object-default-reaction-structure */
/** https://docs.discord.com/developers/resources/channel#default-reaction-object-default-reaction-structure */
export interface DiscordDefaultReactionEmoji {
/** The id of a guild's custom emoji */
emoji_id: string | null;
@@ -285,7 +285,7 @@ export interface DiscordDefaultReactionEmoji {
emoji_name: string | null;
}
/** https://discord.com/developers/docs/resources/channel#forum-tag-object-forum-tag-structure */
/** https://docs.discord.com/developers/resources/channel#forum-tag-object-forum-tag-structure */
export interface DiscordForumTag {
/** The id of the tag */
id: string;
@@ -300,9 +300,9 @@ export interface DiscordForumTag {
}
/**
* https://discord.com/developers/docs/resources/channel#list-public-archived-threads
* https://discord.com/developers/docs/resources/channel#list-private-archived-threads
* https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads
* https://docs.discord.com/developers/resources/channel#list-public-archived-threads
* https://docs.discord.com/developers/resources/channel#list-private-archived-threads
* https://docs.discord.com/developers/resources/channel#list-joined-private-archived-threads
*/
export interface DiscordListArchivedThreads {
/** The archived threads */

90
packages/types/src/discord/components.ts
View File

@@ -1,11 +1,11 @@
/** Types for: https://discord.com/developers/docs/components/reference */
/** Types for: https://docs.discord.com/developers/components/reference */
import type { Require } from '../shared.js';
import type { ChannelTypes } from './channel.js';
import type { DiscordEmoji } from './emoji.js';
import type { DiscordInteractionDataResolved } from './interactions.js';
/** https://discord.com/developers/docs/components/reference#component-object-component-types */
/** https://docs.discord.com/developers/components/reference#component-object-component-types */
export enum MessageComponentTypes {
/** A container for other components */
ActionRow = 1,
@@ -71,7 +71,7 @@ export type DiscordMessageComponentFromMessageComponentInteractionResponse =
| DiscordChannelSelectInteractionResponseFromMessageComponent
| DiscordMentionableSelectInteractionResponseFromMessageComponent;
/** https://discord.com/developers/docs/components/reference#anatomy-of-a-component */
/** https://docs.discord.com/developers/components/reference#anatomy-of-a-component */
export interface DiscordBaseComponent {
/** The type of the component */
type: MessageComponentTypes;
@@ -79,7 +79,7 @@ export interface DiscordBaseComponent {
id?: number;
}
/** https://discord.com/developers/docs/components/reference#action-row-action-row-structure */
/** https://docs.discord.com/developers/components/reference#action-row-action-row-structure */
export interface DiscordActionRow extends DiscordBaseComponent {
type: MessageComponentTypes.ActionRow;
@@ -95,7 +95,7 @@ export interface DiscordActionRow extends DiscordBaseComponent {
components: (DiscordButtonComponent | DiscordSelectMenuComponent | DiscordTextInputComponent)[];
}
/** https://discord.com/developers/docs/components/reference#button-button-structure */
/** https://docs.discord.com/developers/components/reference#button-button-structure */
export interface DiscordButtonComponent extends DiscordBaseComponent {
type: MessageComponentTypes.Button;
@@ -143,7 +143,7 @@ export interface DiscordButtonComponent extends DiscordBaseComponent {
disabled?: boolean;
}
/** https://discord.com/developers/docs/components/reference#button-button-styles */
/** https://docs.discord.com/developers/components/reference#button-button-styles */
export enum ButtonStyles {
/** A blurple button */
Primary = 1,
@@ -160,11 +160,11 @@ export enum ButtonStyles {
}
/**
* https://discord.com/developers/docs/components/reference#string-select
* https://discord.com/developers/docs/components/reference#user-select
* https://discord.com/developers/docs/components/reference#role-select
* https://discord.com/developers/docs/components/reference#mentionable-select
* https://discord.com/developers/docs/components/reference#channel-select
* https://docs.discord.com/developers/components/reference#string-select
* https://docs.discord.com/developers/components/reference#user-select
* https://docs.discord.com/developers/components/reference#role-select
* https://docs.discord.com/developers/components/reference#mentionable-select
* https://docs.discord.com/developers/components/reference#channel-select
*/
export interface DiscordSelectMenuComponent extends DiscordBaseComponent {
type:
@@ -213,7 +213,7 @@ export interface DiscordSelectMenuComponent extends DiscordBaseComponent {
channel_types?: ChannelTypes[];
}
/** https://discord.com/developers/docs/components/reference#string-select-select-option-structure */
/** https://docs.discord.com/developers/components/reference#string-select-select-option-structure */
export interface DiscordSelectOption {
/** The user-facing name of the option. Maximum 25 characters. */
label: string;
@@ -227,7 +227,7 @@ export interface DiscordSelectOption {
default?: boolean;
}
/** https://discord.com/developers/docs/components/reference#string-select-strings-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#string-select-strings-select-interaction-response-structure */
export interface DiscordStringSelectInteractionResponse {
/**
* @remarks
@@ -247,15 +247,15 @@ export interface DiscordStringSelectInteractionResponse {
values: string[];
}
/** https://discord.com/developers/docs/components/reference#string-select-string-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#string-select-string-select-interaction-response-structure */
export type DiscordStringSelectInteractionResponseFromModal = Require<Omit<DiscordStringSelectInteractionResponse, 'component_type'>, 'type'>;
/** https://discord.com/developers/docs/components/reference#string-select-string-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#string-select-string-select-interaction-response-structure */
export type DiscordStringSelectInteractionResponseFromMessageComponent = Require<
Omit<DiscordStringSelectInteractionResponse, 'type'>,
'component_type'
>;
/** https://discord.com/developers/docs/components/reference#text-input-text-input-structure */
/** https://docs.discord.com/developers/components/reference#text-input-text-input-structure */
export interface DiscordTextInputComponent extends DiscordBaseComponent {
type: MessageComponentTypes.TextInput;
@@ -284,7 +284,7 @@ export interface DiscordTextInputComponent extends DiscordBaseComponent {
placeholder?: string;
}
/** https://discord.com/developers/docs/components/reference#text-input-text-input-styles */
/** https://docs.discord.com/developers/components/reference#text-input-text-input-styles */
export enum TextStyles {
/** Intended for short single-line text */
Short = 1,
@@ -292,7 +292,7 @@ export enum TextStyles {
Paragraph = 2,
}
/** https://discord.com/developers/docs/components/reference#text-input-text-input-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#text-input-text-input-interaction-response-structure */
export interface DiscordTextInputInteractionResponse {
type: MessageComponentTypes.TextInput;
/** 32 bit integer used as an optional identifier for component */
@@ -303,7 +303,7 @@ export interface DiscordTextInputInteractionResponse {
value: string;
}
/** https://discord.com/developers/docs/components/reference#user-select-select-default-value-structure */
/** https://docs.discord.com/developers/components/reference#user-select-select-default-value-structure */
export interface DiscordSelectMenuDefaultValue {
/** ID of a user, role, or channel */
id: string;
@@ -311,7 +311,7 @@ export interface DiscordSelectMenuDefaultValue {
type: 'user' | 'role' | 'channel';
}
/** https://discord.com/developers/docs/components/reference#user-select-user-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#user-select-user-select-interaction-response-structure */
export interface DiscordUserSelectInteractionResponse {
/**
* @remarks
@@ -333,12 +333,12 @@ export interface DiscordUserSelectInteractionResponse {
values: string[];
}
/** https://discord.com/developers/docs/components/reference#user-select-user-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#user-select-user-select-interaction-response-structure */
export type DiscordUserSelectInteractionResponseFromModal = Require<Omit<DiscordUserSelectInteractionResponse, 'component_type'>, 'type'>;
/** https://discord.com/developers/docs/components/reference#user-select-user-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#user-select-user-select-interaction-response-structure */
export type DiscordUserSelectInteractionResponseFromMessageComponent = Require<Omit<DiscordUserSelectInteractionResponse, 'type'>, 'component_type'>;
/** https://discord.com/developers/docs/components/reference#role-select-role-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#role-select-role-select-interaction-response-structure */
export interface DiscordRoleSelectInteractionResponse {
/**
* @remarks
@@ -360,12 +360,12 @@ export interface DiscordRoleSelectInteractionResponse {
values: string[];
}
/** https://discord.com/developers/docs/components/reference#role-select-role-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#role-select-role-select-interaction-response-structure */
export type DiscordRoleSelectInteractionResponseFromModal = Require<Omit<DiscordRoleSelectInteractionResponse, 'component_type'>, 'type'>;
/** https://discord.com/developers/docs/components/reference#role-select-role-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#role-select-role-select-interaction-response-structure */
export type DiscordRoleSelectInteractionResponseFromMessageComponent = Require<Omit<DiscordRoleSelectInteractionResponse, 'type'>, 'component_type'>;
/** https://discord.com/developers/docs/components/reference#mentionable-select-mentionable-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#mentionable-select-mentionable-select-interaction-response-structure */
export interface DiscordMentionableSelectInteractionResponse {
/**
* @remarks
@@ -387,18 +387,18 @@ export interface DiscordMentionableSelectInteractionResponse {
values: string[];
}
/** https://discord.com/developers/docs/components/reference#mentionable-select-mentionable-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#mentionable-select-mentionable-select-interaction-response-structure */
export type DiscordMentionableSelectInteractionResponseFromModal = Require<
Omit<DiscordMentionableSelectInteractionResponse, 'component_type'>,
'type'
>;
/** https://discord.com/developers/docs/components/reference#mentionable-select-mentionable-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#mentionable-select-mentionable-select-interaction-response-structure */
export type DiscordMentionableSelectInteractionResponseFromMessageComponent = Require<
Omit<DiscordMentionableSelectInteractionResponse, 'type'>,
'component_type'
>;
/** https://discord.com/developers/docs/components/reference#channel-select-channel-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#channel-select-channel-select-interaction-response-structure */
export interface DiscordChannelSelectInteractionResponse {
/**
* @remarks
@@ -420,15 +420,15 @@ export interface DiscordChannelSelectInteractionResponse {
values: string[];
}
/** https://discord.com/developers/docs/components/reference#channel-select-channel-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#channel-select-channel-select-interaction-response-structure */
export type DiscordChannelSelectInteractionResponseFromModal = Require<Omit<DiscordChannelSelectInteractionResponse, 'component_type'>, 'type'>;
/** https://discord.com/developers/docs/components/reference#channel-select-channel-select-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#channel-select-channel-select-interaction-response-structure */
export type DiscordChannelSelectInteractionResponseFromMessageComponent = Require<
Omit<DiscordChannelSelectInteractionResponse, 'type'>,
'component_type'
>;
/** https://discord.com/developers/docs/components/reference#section-section-structure */
/** https://docs.discord.com/developers/components/reference#section-section-structure */
export interface DiscordSectionComponent extends DiscordBaseComponent {
type: MessageComponentTypes.Section;
@@ -438,7 +438,7 @@ export interface DiscordSectionComponent extends DiscordBaseComponent {
accessory: DiscordButtonComponent | DiscordThumbnailComponent;
}
/** https://discord.com/developers/docs/components/reference#text-display-text-display-structure */
/** https://docs.discord.com/developers/components/reference#text-display-text-display-structure */
export interface DiscordTextDisplayComponent extends DiscordBaseComponent {
type: MessageComponentTypes.TextDisplay;
@@ -446,7 +446,7 @@ export interface DiscordTextDisplayComponent extends DiscordBaseComponent {
content: string;
}
/** https://discord.com/developers/docs/components/reference#text-display-text-display-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#text-display-text-display-interaction-response-structure */
export interface DiscordTextDisplayInteractionResponse {
type: MessageComponentTypes.TextDisplay;
/** 32 bit integer used as an optional identifier for component */
@@ -464,7 +464,7 @@ export interface DiscordThumbnailComponent extends DiscordBaseComponent {
spoiler?: boolean;
}
/** https://discord.com/developers/docs/components/reference#media-gallery-media-gallery-structure */
/** https://docs.discord.com/developers/components/reference#media-gallery-media-gallery-structure */
export interface DiscordMediaGalleryComponent extends DiscordBaseComponent {
type: MessageComponentTypes.MediaGallery;
@@ -472,7 +472,7 @@ export interface DiscordMediaGalleryComponent extends DiscordBaseComponent {
items: DiscordMediaGalleryItem[];
}
/** https://discord.com/developers/docs/components/reference#media-gallery-media-gallery-item-structure */
/** https://docs.discord.com/developers/components/reference#media-gallery-media-gallery-item-structure */
export interface DiscordMediaGalleryItem {
/** A url or attachment */
media: DiscordUnfurledMediaItem;
@@ -482,7 +482,7 @@ export interface DiscordMediaGalleryItem {
spoiler?: boolean;
}
/** https://discord.com/developers/docs/components/reference#file-file-structure */
/** https://docs.discord.com/developers/components/reference#file-file-structure */
export interface DiscordFileComponent extends DiscordBaseComponent {
type: MessageComponentTypes.File;
@@ -496,7 +496,7 @@ export interface DiscordFileComponent extends DiscordBaseComponent {
size: number;
}
/** https://discord.com/developers/docs/components/reference#separator-separator-structure */
/** https://docs.discord.com/developers/components/reference#separator-separator-structure */
export interface DiscordSeparatorComponent extends DiscordBaseComponent {
type: MessageComponentTypes.Separator;
@@ -506,13 +506,13 @@ export interface DiscordSeparatorComponent extends DiscordBaseComponent {
spacing?: SeparatorSpacingSize;
}
/** https://discord.com/developers/docs/components/reference#separator-separator-structure, spacing description */
/** https://docs.discord.com/developers/components/reference#separator-separator-structure, spacing description */
export enum SeparatorSpacingSize {
Small = 1,
Large = 2,
}
/** https://discord.com/developers/docs/components/reference#container-container-structure */
/** https://docs.discord.com/developers/components/reference#container-container-structure */
export interface DiscordContainerComponent extends DiscordBaseComponent {
type: MessageComponentTypes.Container;
@@ -531,7 +531,7 @@ export interface DiscordContainerComponent extends DiscordBaseComponent {
spoiler?: boolean;
}
/** https://discord.com/developers/docs/components/reference#label-label-structure */
/** https://docs.discord.com/developers/components/reference#label-label-structure */
export interface DiscordLabelComponent extends DiscordBaseComponent {
type: MessageComponentTypes.Label;
@@ -553,7 +553,7 @@ export interface DiscordLabelComponent extends DiscordBaseComponent {
component: DiscordTextInputComponent | DiscordSelectMenuComponent | DiscordFileUploadComponent;
}
/** https://discord.com/developers/docs/components/reference#label-label-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#label-label-interaction-response-structure */
export interface DiscordLabelInteractionResponse {
type: MessageComponentTypes.Label;
/** 32 bit integer used as an optional identifier for component */
@@ -569,7 +569,7 @@ export interface DiscordLabelInteractionResponse {
| DiscordFileUploadInteractionResponse;
}
/** https://discord.com/developers/docs/components/reference#file-upload-file-upload-structure */
/** https://docs.discord.com/developers/components/reference#file-upload-file-upload-structure */
export interface DiscordFileUploadComponent extends DiscordBaseComponent {
type: MessageComponentTypes.FileUpload;
@@ -600,7 +600,7 @@ export interface DiscordFileUploadComponent extends DiscordBaseComponent {
required?: boolean;
}
/** https://discord.com/developers/docs/components/reference#file-upload-file-upload-interaction-response-structure */
/** https://docs.discord.com/developers/components/reference#file-upload-file-upload-interaction-response-structure */
export interface DiscordFileUploadInteractionResponse {
type: MessageComponentTypes.FileUpload;
@@ -612,7 +612,7 @@ export interface DiscordFileUploadInteractionResponse {
values: string[];
}
/** https://discord.com/developers/docs/components/reference#unfurled-media-item-structure */
/** https://docs.discord.com/developers/components/reference#unfurled-media-item-structure */
export interface DiscordUnfurledMediaItem {
/** Supports arbitrary urls and attachment://<filename> references */
url: string;

4
packages/types/src/discord/emoji.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/emoji */
/** Types for: https://docs.discord.com/developers/resources/emoji */
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/emoji#emoji-object-emoji-structure */
/** https://docs.discord.com/developers/resources/emoji#emoji-object-emoji-structure */
export interface DiscordEmoji {
/** Emoji id */
id: string | null;

6
packages/types/src/discord/entitlement.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/resources/entitlement */
/** Types for: https://docs.discord.com/developers/resources/entitlement */
/** https://discord.com/developers/docs/resources/entitlement#entitlement-object-entitlement-structure */
/** https://docs.discord.com/developers/resources/entitlement#entitlement-object-entitlement-structure */
export interface DiscordEntitlement {
/** ID of the entitlement */
id: string;
@@ -24,7 +24,7 @@ export interface DiscordEntitlement {
consumed?: boolean;
}
/** https://discord.com/developers/docs/resources/entitlement#entitlement-object-entitlement-types */
/** https://docs.discord.com/developers/resources/entitlement#entitlement-object-entitlement-types */
export enum DiscordEntitlementType {
/** Entitlement was purchased by user */
Purchase = 1,

172
packages/types/src/discord/gateway.ts
View File

@@ -1,7 +1,7 @@
/**
* Types for:
* - https://discord.com/developers/docs/events/gateway
* - https://discord.com/developers/docs/events/gateway-events
* - https://docs.discord.com/developers/events/gateway
* - https://docs.discord.com/developers/events/gateway-events
*/
import type { DiscordApplication } from './application.js';
@@ -20,7 +20,7 @@ import type { DiscordSticker } from './sticker.js';
import type { DiscordAvatarDecorationData, DiscordUser } from './user.js';
import type { DiscordVoiceState } from './voice.js';
/** https://discord.com/developers/docs/events/gateway#list-of-intents */
/** https://docs.discord.com/developers/events/gateway#list-of-intents */
export enum GatewayIntents {
/**
* - GUILD_CREATE
@@ -172,9 +172,9 @@ export enum GatewayIntents {
export { GatewayIntents as Intents };
// TODO: Add TransportCompression: https://discord.com/developers/docs/events/gateway#transport-compression
// TODO: Add TransportCompression: https://docs.discord.com/developers/events/gateway#transport-compression
/** https://discord.com/developers/docs/events/gateway#get-gateway-bot */
/** https://docs.discord.com/developers/events/gateway#get-gateway-bot */
export interface DiscordGetGatewayBot {
/** The WSS URL that can be used for connecting to the gateway */
url: string;
@@ -184,7 +184,7 @@ export interface DiscordGetGatewayBot {
session_start_limit: DiscordSessionStartLimit;
}
/** https://discord.com/developers/docs/events/gateway#session-start-limit-object */
/** https://docs.discord.com/developers/events/gateway#session-start-limit-object */
export interface DiscordSessionStartLimit {
/** The total number of session starts the current user is allowed */
total: number;
@@ -196,7 +196,7 @@ export interface DiscordSessionStartLimit {
max_concurrency: number;
}
/** https://discord.com/developers/docs/events/gateway-events#receive-events */
/** https://docs.discord.com/developers/events/gateway-events#receive-events */
export type GatewayDispatchEventNames =
| 'READY'
| 'RESUMED'
@@ -275,10 +275,10 @@ export type GatewayDispatchEventNames =
| 'MESSAGE_POLL_VOTE_ADD'
| 'MESSAGE_POLL_VOTE_REMOVE';
/** https://discord.com/developers/docs/events/gateway-events#receive-events */
/** https://docs.discord.com/developers/events/gateway-events#receive-events */
export type GatewayEventNames = GatewayDispatchEventNames;
/** https://discord.com/developers/docs/events/gateway-events#payload-structure */
/** https://docs.discord.com/developers/events/gateway-events#payload-structure */
export interface DiscordGatewayPayload {
/** opcode for the payload */
op: number;
@@ -290,14 +290,14 @@ export interface DiscordGatewayPayload {
t: GatewayEventNames | null;
}
// TODO: Add Identify: https://discord.com/developers/docs/events/gateway-events#identify-identify-structure
// TODO: Add Identify Connection Properties: https://discord.com/developers/docs/events/gateway-events#identify-identify-connection-properties
// TODO: Add Resume: https://discord.com/developers/docs/events/gateway-events#resume-resume-structure
// TODO: Add Request Guild Members: https://discord.com/developers/docs/events/gateway-events#request-guild-members-request-guild-members-structure
// TODO: Add Request Soundboard Sounds: https://discord.com/developers/docs/events/gateway-events#request-soundboard-sounds-request-soundboard-sounds-structure
// TODO: Add Voice State Update: https://discord.com/developers/docs/events/gateway-events#update-voice-state-gateway-voice-state-update-structure
// TODO: Add Identify: https://docs.discord.com/developers/events/gateway-events#identify-identify-structure
// TODO: Add Identify Connection Properties: https://docs.discord.com/developers/events/gateway-events#identify-identify-connection-properties
// TODO: Add Resume: https://docs.discord.com/developers/events/gateway-events#resume-resume-structure
// TODO: Add Request Guild Members: https://docs.discord.com/developers/events/gateway-events#request-guild-members-request-guild-members-structure
// TODO: Add Request Soundboard Sounds: https://docs.discord.com/developers/events/gateway-events#request-soundboard-sounds-request-soundboard-sounds-structure
// TODO: Add Voice State Update: https://docs.discord.com/developers/events/gateway-events#update-voice-state-gateway-voice-state-update-structure
/** https://discord.com/developers/docs/events/gateway-events#update-presence-gateway-presence-update-structure */
/** https://docs.discord.com/developers/events/gateway-events#update-presence-gateway-presence-update-structure */
export interface DiscordUpdatePresence {
/** Unix time (in milliseconds) of when the client went idle, or null if the client is not idle */
since: number | null;
@@ -309,7 +309,7 @@ export interface DiscordUpdatePresence {
afk: boolean;
}
/** https://discord.com/developers/docs/events/gateway-events#update-presence-status-types */
/** https://docs.discord.com/developers/events/gateway-events#update-presence-status-types */
export enum PresenceStatus {
online,
dnd,
@@ -318,13 +318,13 @@ export enum PresenceStatus {
offline,
}
/** https://discord.com/developers/docs/events/gateway-events#hello-hello-structure */
/** https://docs.discord.com/developers/events/gateway-events#hello-hello-structure */
export interface DiscordHello {
/** The interval (in milliseconds) the client should heartbeat with */
heartbeat_interval: number;
}
/** https://discord.com/developers/docs/events/gateway-events#ready-ready-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#ready-ready-event-fields */
export interface DiscordReady {
/** Gateway version */
v: number;
@@ -342,7 +342,7 @@ export interface DiscordReady {
application: Partial<DiscordApplication> & Pick<DiscordApplication, 'id' | 'flags'>;
}
/** https://discord.com/developers/docs/events/gateway-events#auto-moderation-action-execution-auto-moderation-action-execution-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#auto-moderation-action-execution-auto-moderation-action-execution-event-fields */
export interface DiscordAutoModerationActionExecution {
/** The id of the guild */
guild_id: string;
@@ -368,7 +368,7 @@ export interface DiscordAutoModerationActionExecution {
matched_content: string | null;
}
/** https://discord.com/developers/docs/events/gateway-events#thread-create */
/** https://docs.discord.com/developers/events/gateway-events#thread-create */
export interface DiscordThreadCreateExtra {
/**
* When a thread is created this will be true on that channel payload for the thread.
@@ -379,7 +379,7 @@ export interface DiscordThreadCreateExtra {
newly_created?: boolean;
}
/** https://discord.com/developers/docs/events/gateway-events#thread-list-sync-thread-list-sync-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#thread-list-sync-thread-list-sync-event-fields */
export interface DiscordThreadListSync {
/** The id of the guild */
guild_id: string;
@@ -391,16 +391,16 @@ export interface DiscordThreadListSync {
members: DiscordThreadMember[];
}
/** https://discord.com/developers/docs/events/gateway-events#thread-member-update-thread-member-update-event-extra-fields */
/** https://docs.discord.com/developers/events/gateway-events#thread-member-update-thread-member-update-event-extra-fields */
export interface DiscordThreadMemberUpdateExtra {
/** Id of the guild */
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#thread-member-update-thread-member-update-event-extra-fields */
/** https://docs.discord.com/developers/events/gateway-events#thread-member-update-thread-member-update-event-extra-fields */
export interface DiscordThreadMemberUpdate extends DiscordThreadMember, DiscordThreadMemberUpdateExtra {}
/** https://discord.com/developers/docs/events/gateway-events#thread-members-update-thread-members-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#thread-members-update-thread-members-update-event-fields */
export interface DiscordThreadMembersUpdate {
/** The id of the thread */
id: string;
@@ -414,7 +414,7 @@ export interface DiscordThreadMembersUpdate {
removed_member_ids?: string[];
}
/** https://discord.com/developers/docs/events/gateway#channel-pins-update */
/** https://docs.discord.com/developers/events/gateway#channel-pins-update */
export interface DiscordChannelPinsUpdate {
/** The id of the guild */
guild_id?: string;
@@ -424,7 +424,7 @@ export interface DiscordChannelPinsUpdate {
last_pin_timestamp?: string | null;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-create-guild-create-extra-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-create-guild-create-extra-fields */
export interface DiscordGuildCreateExtra {
/** When this guild was joined at */
joined_at: string;
@@ -462,13 +462,13 @@ export interface DiscordGuildCreateExtra {
soundboard_sounds: DiscordSoundboardSound[];
}
/** https://discord.com/developers/docs/events/gateway-events#guild-audit-log-entry-create-guild-audit-log-entry-create-event-extra-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-audit-log-entry-create-guild-audit-log-entry-create-event-extra-fields */
export interface DiscordGuildAuditLogEntryCreateExtra {
/** The id of the guild */
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-ban-add-guild-ban-add-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-ban-add-guild-ban-add-event-fields */
export interface DiscordGuildBanAdd {
/** id of the guild */
guild_id: string;
@@ -476,7 +476,7 @@ export interface DiscordGuildBanAdd {
user: DiscordUser;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-ban-remove-guild-ban-remove-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-ban-remove-guild-ban-remove-event-fields */
export interface DiscordGuildBanRemove {
/** id of the guild */
guild_id: string;
@@ -485,15 +485,15 @@ export interface DiscordGuildBanRemove {
}
/**
* https://discord.com/developers/docs/events/gateway-events#guild-ban-add-guild-ban-add-event-fields
* https://discord.com/developers/docs/events/gateway-events#guild-ban-remove-guild-ban-remove-event-fields
* https://docs.discord.com/developers/events/gateway-events#guild-ban-add-guild-ban-add-event-fields
* https://docs.discord.com/developers/events/gateway-events#guild-ban-remove-guild-ban-remove-event-fields
*
* @deprecated
* Use {@link DiscordGuildBanAdd} and {@link DiscordGuildBanRemove} instead.
*/
export interface DiscordGuildBanAddRemove extends DiscordGuildBanAdd {}
/** https://discord.com/developers/docs/events/gateway-events#guild-emojis-update-guild-emojis-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-emojis-update-guild-emojis-update-event-fields */
export interface DiscordGuildEmojisUpdate {
/** id of the guild */
guild_id: string;
@@ -501,7 +501,7 @@ export interface DiscordGuildEmojisUpdate {
emojis: DiscordEmoji[];
}
/** https://discord.com/developers/docs/events/gateway-events#guild-stickers-update-guild-stickers-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-stickers-update-guild-stickers-update-event-fields */
export interface DiscordGuildStickersUpdate {
/** id of the guild */
guild_id: string;
@@ -509,22 +509,22 @@ export interface DiscordGuildStickersUpdate {
stickers: DiscordSticker[];
}
/** https://discord.com/developers/docs/events/gateway-events#guild-integrations-update-guild-integrations-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-integrations-update-guild-integrations-update-event-fields */
export interface DiscordGuildIntegrationsUpdate {
/** id of the guild whose integrations were updated */
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-member-add-guild-member-add-extra-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-member-add-guild-member-add-extra-fields */
export interface DiscordGuildMemberAddExtra {
/** id of the guild */
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-member-add-guild-member-add-extra-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-member-add-guild-member-add-extra-fields */
export interface DiscordGuildMemberAdd extends DiscordMemberWithUser, DiscordGuildMemberAddExtra {}
/** https://discord.com/developers/docs/events/gateway-events#guild-member-remove-guild-member-remove-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-member-remove-guild-member-remove-event-fields */
export interface DiscordGuildMemberRemove {
/** The id of the guild */
guild_id: string;
@@ -532,7 +532,7 @@ export interface DiscordGuildMemberRemove {
user: DiscordUser;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-member-update-guild-member-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-member-update-guild-member-update-event-fields */
export interface DiscordGuildMemberUpdate {
/** The id of the guild */
guild_id: string;
@@ -542,7 +542,7 @@ export interface DiscordGuildMemberUpdate {
user: DiscordUser;
/** Nickname of the user in the guild */
nick?: string | null;
/** the member's [guild avatar hash](https://discord.com/developers/docs/reference#image-formatting) */
/** the member's [guild avatar hash](https://docs.discord.com/developers/reference#image-formatting) */
avatar: string | null;
/** the member's guild banner hash */
banner: string | null;
@@ -564,7 +564,7 @@ export interface DiscordGuildMemberUpdate {
avatar_decoration_data?: DiscordAvatarDecorationData | null;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-members-chunk-guild-members-chunk-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-members-chunk-guild-members-chunk-event-fields */
export interface DiscordGuildMembersChunk {
/** The id of the guild */
guild_id: string;
@@ -582,7 +582,7 @@ export interface DiscordGuildMembersChunk {
nonce?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-role-create-guild-role-create-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-role-create-guild-role-create-event-fields */
export interface DiscordGuildRoleCreate {
/** The id of the guild */
guild_id: string;
@@ -590,7 +590,7 @@ export interface DiscordGuildRoleCreate {
role: DiscordRole;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-role-update-guild-role-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-role-update-guild-role-update-event-fields */
export interface DiscordGuildRoleUpdate {
/** The id of the guild */
guild_id: string;
@@ -598,7 +598,7 @@ export interface DiscordGuildRoleUpdate {
role: DiscordRole;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-role-delete-guild-role-delete-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-role-delete-guild-role-delete-event-fields */
export interface DiscordGuildRoleDelete {
/** id of the guild */
guild_id: string;
@@ -606,7 +606,7 @@ export interface DiscordGuildRoleDelete {
role_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-scheduled-event-user-add-guild-scheduled-event-user-add-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-scheduled-event-user-add-guild-scheduled-event-user-add-event-fields */
export interface DiscordScheduledEventUserAdd {
/** id of the guild scheduled event */
guild_scheduled_event_id: string;
@@ -616,7 +616,7 @@ export interface DiscordScheduledEventUserAdd {
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#guild-scheduled-event-user-remove-guild-scheduled-event-user-remove-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-scheduled-event-user-remove-guild-scheduled-event-user-remove-event-fields */
export interface DiscordScheduledEventUserRemove {
/** id of the guild scheduled event */
guild_scheduled_event_id: string;
@@ -626,7 +626,7 @@ export interface DiscordScheduledEventUserRemove {
guild_id: string;
}
/** https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sound-delete-guild-soundboard-sound-delete-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-soundboard-sound-delete-guild-soundboard-sound-delete-event-fields */
export interface DiscordSoundboardSoundDelete {
/** ID of the sound that was deleted */
sound_id: string;
@@ -634,7 +634,7 @@ export interface DiscordSoundboardSoundDelete {
guild_id: string;
}
/** https://discord.com/developers/docs/topics/gateway-events#guild-soundboard-sounds-update-guild-soundboard-sounds-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#guild-soundboard-sounds-update-guild-soundboard-sounds-update-event-fields */
export interface DiscordSoundboardSoundsUpdate {
/** The guild's soundboard sounds */
soundboard_sounds: DiscordSoundboardSound[];
@@ -642,7 +642,7 @@ export interface DiscordSoundboardSoundsUpdate {
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#soundboard-sounds-soundboard-sounds-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#soundboard-sounds-soundboard-sounds-event-fields */
export interface DiscordSoundboardSounds {
/** The guild's soundboard sounds */
soundboard_sounds: DiscordSoundboardSound[];
@@ -650,28 +650,28 @@ export interface DiscordSoundboardSounds {
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#integration-create-integration-create-event-additional-fields */
/** https://docs.discord.com/developers/events/gateway-events#integration-create-integration-create-event-additional-fields */
export interface DiscordIntegrationCreateExtra {
/** Id of the guild */
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#integration-update-integration-update-event-additional-fields */
/** https://docs.discord.com/developers/events/gateway-events#integration-update-integration-update-event-additional-fields */
export interface DiscordIntegrationUpdateExtra {
/** Id of the guild */
guild_id: string;
}
/**
* https://discord.com/developers/docs/events/gateway-events#integration-create-integration-create-event-additional-fields
* https://discord.com/developers/docs/events/gateway-events#integration-update-integration-update-event-additional-fields
* https://docs.discord.com/developers/events/gateway-events#integration-create-integration-create-event-additional-fields
* https://docs.discord.com/developers/events/gateway-events#integration-update-integration-update-event-additional-fields
*/
export interface DiscordIntegrationCreateUpdate extends DiscordIntegration {
/** Id of the guild */
guild_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#integration-delete-integration-delete-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#integration-delete-integration-delete-event-fields */
export interface DiscordIntegrationDelete {
/** Integration id */
id: string;
@@ -681,7 +681,7 @@ export interface DiscordIntegrationDelete {
application_id?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#invite-create-invite-create-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#invite-create-invite-create-event-fields */
export interface DiscordInviteCreate {
/** The channel the invite is for */
channel_id: string;
@@ -711,7 +711,7 @@ export interface DiscordInviteCreate {
expires_at: string;
}
/** https://discord.com/developers/docs/events/gateway-events#invite-delete-invite-delete-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#invite-delete-invite-delete-event-fields */
export interface DiscordInviteDelete {
/** The channel of the invite */
channel_id: string;
@@ -721,7 +721,7 @@ export interface DiscordInviteDelete {
code: string;
}
/** https://discord.com/developers/docs/events/gateway-events#message-create-message-create-extra-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-create-message-create-extra-fields */
export interface DiscordMessageCreateExtra {
/** ID of the guild the message was sent in - unless it is an ephemeral message */
guild_id?: string;
@@ -731,10 +731,10 @@ export interface DiscordMessageCreateExtra {
mentions: Array<DiscordUser & { member?: Partial<DiscordMember> }>;
}
/** https://discord.com/developers/docs/events/gateway-events#message-update */
/** https://docs.discord.com/developers/events/gateway-events#message-update */
export type DiscordMessageUpdateExtra = DiscordMessageCreateExtra;
/** https://discord.com/developers/docs/events/gateway-events#message-delete-message-delete-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-delete-message-delete-event-fields */
export interface DiscordMessageDelete {
/** The id of the message */
id: string;
@@ -744,7 +744,7 @@ export interface DiscordMessageDelete {
guild_id?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#message-delete-bulk-message-delete-bulk-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-delete-bulk-message-delete-bulk-event-fields */
export interface DiscordMessageDeleteBulk {
/** The ids of the messages */
ids: string[];
@@ -754,7 +754,7 @@ export interface DiscordMessageDeleteBulk {
guild_id?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#message-reaction-add-message-reaction-add-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-reaction-add-message-reaction-add-event-fields */
export interface DiscordMessageReactionAdd {
/** The id of the user */
user_id: string;
@@ -778,7 +778,7 @@ export interface DiscordMessageReactionAdd {
type: DiscordReactionType;
}
/** https://discord.com/developers/docs/events/gateway-events#message-reaction-remove-message-reaction-remove-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-reaction-remove-message-reaction-remove-event-fields */
export interface DiscordMessageReactionRemove {
/** The id of the user */
user_id: string;
@@ -796,7 +796,7 @@ export interface DiscordMessageReactionRemove {
type: DiscordReactionType;
}
/** https://discord.com/developers/docs/events/gateway-events#message-reaction-remove-all-message-reaction-remove-all-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-reaction-remove-all-message-reaction-remove-all-event-fields */
export interface DiscordMessageReactionRemoveAll {
/** The id of the channel */
channel_id: string;
@@ -806,7 +806,7 @@ export interface DiscordMessageReactionRemoveAll {
guild_id?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#message-reaction-remove-emoji-message-reaction-remove-emoji-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-reaction-remove-emoji-message-reaction-remove-emoji-event-fields */
export interface DiscordMessageReactionRemoveEmoji {
/** The id of the channel */
channel_id: string;
@@ -818,7 +818,7 @@ export interface DiscordMessageReactionRemoveEmoji {
emoji: Partial<DiscordEmoji>;
}
/** https://discord.com/developers/docs/events/gateway-events#presence-update-presence-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#presence-update-presence-update-event-fields */
export interface DiscordPresenceUpdate {
/** The user presence is being updated for */
user: DiscordUser;
@@ -832,7 +832,7 @@ export interface DiscordPresenceUpdate {
client_status: DiscordClientStatus;
}
/** https://discord.com/developers/docs/events/gateway-events#client-status-object */
/** https://docs.discord.com/developers/events/gateway-events#client-status-object */
export interface DiscordClientStatus {
/** The user's status set for an active desktop (Windows, Linux, Mac) application session */
desktop?: string;
@@ -842,7 +842,7 @@ export interface DiscordClientStatus {
web?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object */
/** https://docs.discord.com/developers/events/gateway-events#activity-object */
export interface DiscordActivity {
/** The activity's name */
name: string;
@@ -882,10 +882,10 @@ export interface DiscordActivity {
buttons?: DiscordActivityButton[];
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object - Note at the bottom */
/** https://docs.discord.com/developers/events/gateway-events#activity-object - Note at the bottom */
export type DiscordBotActivity = Pick<DiscordActivity, 'name' | 'state' | 'type' | 'url'>;
/** https://discord.com/developers/docs/events/gateway-events#activity-object-activity-types */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-activity-types */
export enum ActivityTypes {
Playing = 0,
Streaming = 1,
@@ -895,7 +895,7 @@ export enum ActivityTypes {
Competing = 5,
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object-status-display-types */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-status-display-types */
export enum DiscordStatusDisplayType {
/** Example: "Listening to Spotify" */
Name = 0,
@@ -905,7 +905,7 @@ export enum DiscordStatusDisplayType {
Details = 2,
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object-activity-timestamps */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-activity-timestamps */
export interface DiscordActivityTimestamps {
/** Unix time (in milliseconds) of when the activity started */
start?: number;
@@ -913,7 +913,7 @@ export interface DiscordActivityTimestamps {
end?: number;
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object-activity-emoji */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-activity-emoji */
export interface DiscordActivityEmoji {
/** The name of the emoji */
name: string;
@@ -923,7 +923,7 @@ export interface DiscordActivityEmoji {
id?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object-activity-party */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-activity-party */
export interface DiscordActivityParty {
/** Used to show the party's current and maximum size */
size?: [currentSize: number, maxSize: number];
@@ -931,7 +931,7 @@ export interface DiscordActivityParty {
id?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object-activity-assets */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-activity-assets */
export interface DiscordActivityAssets {
/** The id for a large asset of the activity, usually a snowflake */
large_image?: string;
@@ -949,7 +949,7 @@ export interface DiscordActivityAssets {
invite_cover_image?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object-activity-secrets */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-activity-secrets */
export interface DiscordActivitySecrets {
/** The secret for joining a party */
join?: string;
@@ -959,7 +959,7 @@ export interface DiscordActivitySecrets {
match?: string;
}
/** https://discord.com/developers/docs/events/gateway-events#activity-object-activity-flags */
/** https://docs.discord.com/developers/events/gateway-events#activity-object-activity-flags */
export enum ActivityFlags {
Instance = 1 << 0,
Join = 1 << 1,
@@ -972,7 +972,7 @@ export enum ActivityFlags {
Embedded = 1 << 8,
}
/** https://discord.com/developers/docs/events/gateway#activity-object-activity-buttons */
/** https://docs.discord.com/developers/events/gateway#activity-object-activity-buttons */
export interface DiscordActivityButton {
/** The text shown on the button (1-32 characters) */
label: string;
@@ -980,7 +980,7 @@ export interface DiscordActivityButton {
url: string;
}
/** https://discord.com/developers/docs/events/gateway-events#typing-start-typing-start-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#typing-start-typing-start-event-fields */
export interface DiscordTypingStart {
/** id of the channel */
channel_id: string;
@@ -994,7 +994,7 @@ export interface DiscordTypingStart {
member?: DiscordMember;
}
/** https://discord.com/developers/docs/events/gateway-events#voice-channel-effect-send-voice-channel-effect-send-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#voice-channel-effect-send-voice-channel-effect-send-event-fields */
export interface DiscordVoiceChannelEffectSend {
/** ID of the channel the effect was sent in */
channel_id: string;
@@ -1014,7 +1014,7 @@ export interface DiscordVoiceChannelEffectSend {
sound_volume?: number;
}
/** https://discord.com/developers/docs/events/gateway-events#voice-channel-effect-send-animation-types */
/** https://docs.discord.com/developers/events/gateway-events#voice-channel-effect-send-animation-types */
export enum DiscordVoiceChannelEffectAnimationType {
/** A fun animation, sent by a Nitro subscriber */
Premium = 0,
@@ -1022,7 +1022,7 @@ export enum DiscordVoiceChannelEffectAnimationType {
Basic = 1,
}
/** https://discord.com/developers/docs/events/gateway-events#voice-server-update-voice-server-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#voice-server-update-voice-server-update-event-fields */
export interface DiscordVoiceServerUpdate {
/** Voice connection token */
token: string;
@@ -1032,7 +1032,7 @@ export interface DiscordVoiceServerUpdate {
endpoint: string | null;
}
/** https://discord.com/developers/docs/events/gateway-events#webhooks-update-webhooks-update-event-fields */
/** https://docs.discord.com/developers/events/gateway-events#webhooks-update-webhooks-update-event-fields */
export interface DiscordWebhookUpdate {
/** id of the guild */
guild_id: string;
@@ -1040,7 +1040,7 @@ export interface DiscordWebhookUpdate {
channel_id: string;
}
/** https://discord.com/developers/docs/events/gateway-events#message-poll-vote-add-message-poll-vote-add-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-poll-vote-add-message-poll-vote-add-fields */
export interface DiscordPollVoteAdd {
/** ID of the user. Usually a snowflake */
user_id: string;
@@ -1054,7 +1054,7 @@ export interface DiscordPollVoteAdd {
answer_id: number;
}
/** https://discord.com/developers/docs/events/gateway-events#message-poll-vote-remove-message-poll-vote-remove-fields */
/** https://docs.discord.com/developers/events/gateway-events#message-poll-vote-remove-message-poll-vote-remove-fields */
export interface DiscordPollVoteRemove {
/** ID of the user. Usually a snowflake */
user_id: string;
@@ -1068,7 +1068,7 @@ export interface DiscordPollVoteRemove {
answer_id: number;
}
/** https://discord.com/developers/docs/events/gateway-events#rate-limited-rate-limited-fields */
/** https://docs.discord.com/developers/events/gateway-events#rate-limited-rate-limited-fields */
export interface DiscordRateLimited {
/** Gateway opcode of the event that was rate limited */
opcode: GatewayOpcodes;
@@ -1083,7 +1083,7 @@ export interface DiscordRateLimited {
meta: DiscordRequestGuildMemberRateLimitMetadata;
}
/** https://discord.com/developers/docs/events/gateway-events#rate-limited-request-guild-member-rate-limit-metadata-structure */
/** https://docs.discord.com/developers/events/gateway-events#rate-limited-request-guild-member-rate-limit-metadata-structure */
export interface DiscordRequestGuildMemberRateLimitMetadata {
/** ID of the guild to get members for */
guild_id: string;

70
packages/types/src/discord/guild.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/guild */
/** Types for: https://docs.discord.com/developers/resources/guild */
import type { DiscordChannel, DiscordThreadMember } from './channel.js';
import type { DiscordEmoji } from './emoji.js';
@@ -9,7 +9,7 @@ import type { DiscordRole } from './permissions.js';
import type { DiscordSticker } from './sticker.js';
import type { DiscordAvatarDecorationData, DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/guild#guild-object-guild-structure */
/** https://docs.discord.com/developers/resources/guild#guild-object-guild-structure */
export interface DiscordGuild extends Partial<DiscordGuildCreateExtra> {
/** Guild id */
id: string;
@@ -116,7 +116,7 @@ export interface DiscordGuild extends Partial<DiscordGuildCreateExtra> {
incidents_data: DiscordIncidentsData | null;
}
/** https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level */
/** https://docs.discord.com/developers/resources/guild#guild-object-default-message-notification-level */
export enum DefaultMessageNotificationLevels {
/** Members will receive notifications for all messages by default */
AllMessages,
@@ -124,7 +124,7 @@ export enum DefaultMessageNotificationLevels {
OnlyMentions,
}
/** https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level */
/** https://docs.discord.com/developers/resources/guild#guild-object-explicit-content-filter-level */
export enum ExplicitContentFilterLevels {
/** Media content will not be scanned */
Disabled,
@@ -134,7 +134,7 @@ export enum ExplicitContentFilterLevels {
AllMembers,
}
/** https://discord.com/developers/docs/resources/guild#guild-object-mfa-level */
/** https://docs.discord.com/developers/resources/guild#guild-object-mfa-level */
export enum MfaLevels {
/** Guild has no MFA/2FA requirement for moderation actions */
None,
@@ -142,7 +142,7 @@ export enum MfaLevels {
Elevated,
}
/** https://discord.com/developers/docs/resources/guild#guild-object-verification-level */
/** https://docs.discord.com/developers/resources/guild#guild-object-verification-level */
export enum VerificationLevels {
/** Unrestricted */
None,
@@ -156,7 +156,7 @@ export enum VerificationLevels {
VeryHigh,
}
/** https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level */
/** https://docs.discord.com/developers/resources/guild#guild-object-guild-nsfw-level */
export enum GuildNsfwLevel {
Default,
Explicit,
@@ -164,7 +164,7 @@ export enum GuildNsfwLevel {
AgeRestricted,
}
/** https://discord.com/developers/docs/resources/guild#guild-object-premium-tier */
/** https://docs.discord.com/developers/resources/guild#guild-object-premium-tier */
export enum PremiumTiers {
/** Guild has not unlocked any Server Boost perks */
None,
@@ -176,7 +176,7 @@ export enum PremiumTiers {
Tier3,
}
/** https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags */
/** https://docs.discord.com/developers/resources/guild#guild-object-system-channel-flags */
export enum SystemChannelFlags {
/** Suppress member join notifications */
SuppressJoinNotifications = 1 << 0,
@@ -192,7 +192,7 @@ export enum SystemChannelFlags {
SuppressRoleSubscriptionPurchaseNotificationReplies = 1 << 5,
}
/** https://discord.com/developers/docs/resources/guild#guild-object-guild-features */
/** https://docs.discord.com/developers/resources/guild#guild-object-guild-features */
export enum GuildFeatures {
/** Guild has access to set an animated guild banner image */
AnimatedBanner = 'ANIMATED_BANNER',
@@ -235,7 +235,7 @@ export enum GuildFeatures {
InvitesDisabled = 'INVITES_DISABLED',
/** Guild has access to set an invite splash background */
InviteSplash = 'INVITE_SPLASH',
/** Guild has enabled [Membership Screening](https://discord.com/developers/docs/resources/guild#membership-screening-object) */
/** Guild has enabled [Membership Screening](https://docs.discord.com/developers/resources/guild#membership-screening-object) */
MemberVerificationGateEnabled = 'MEMBER_VERIFICATION_GATE_ENABLED',
/** Guild has increased custom soundboard sound slots. */
MoreSoundboard = 'MORE_SOUNDBOARD',
@@ -280,10 +280,10 @@ export enum GuildFeatures {
EnhancedRoleColors = 'ENHANCED_ROLE_COLORS',
}
/** https://discord.com/developers/docs/resources/guild#unavailable-guild-object */
/** https://docs.discord.com/developers/resources/guild#unavailable-guild-object */
export interface DiscordUnavailableGuild extends Pick<DiscordGuild, 'id' | 'unavailable'> {}
/** https://discord.com/developers/docs/resources/guild#guild-preview-object-guild-preview-structure */
/** https://docs.discord.com/developers/resources/guild#guild-preview-object-guild-preview-structure */
export interface DiscordGuildPreview {
/** Guild id */
id: string;
@@ -309,7 +309,7 @@ export interface DiscordGuildPreview {
stickers: DiscordSticker[];
}
/** https://discord.com/developers/docs/resources/guild#guild-widget-settings-object-guild-widget-settings-structure */
/** https://docs.discord.com/developers/resources/guild#guild-widget-settings-object-guild-widget-settings-structure */
export interface DiscordGuildWidgetSettings {
/** whether the widget is enabled */
enabled: boolean;
@@ -317,7 +317,7 @@ export interface DiscordGuildWidgetSettings {
channel_id: string | null;
}
/** https://discord.com/developers/docs/resources/guild#guild-widget-object-guild-widget-structure */
/** https://docs.discord.com/developers/resources/guild#guild-widget-object-guild-widget-structure */
export interface DiscordGuildWidget {
id: string;
name: string;
@@ -327,7 +327,7 @@ export interface DiscordGuildWidget {
presence_count: number;
}
/** https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure */
/** https://docs.discord.com/developers/resources/guild#guild-member-object-guild-member-structure */
export interface DiscordMember {
/** The user this guild member represents */
user?: DiscordUser;
@@ -363,13 +363,13 @@ export interface DiscordMember {
avatar_decoration_data?: DiscordAvatarDecorationData | null;
}
/** https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure */
/** https://docs.discord.com/developers/resources/guild#guild-member-object-guild-member-structure */
export interface DiscordMemberWithUser extends DiscordMember {
/** The user object for this member */
user: DiscordUser;
}
/** https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-flags */
/** https://docs.discord.com/developers/resources/guild#guild-member-object-guild-member-flags */
export enum MemberFlags {
/**
* Member has left and rejoined the guild
@@ -438,7 +438,7 @@ export enum MemberFlags {
AutomodQuarantinedGuildTag = 1 << 10,
}
/** https://discord.com/developers/docs/resources/guild#integration-object-integration-structure */
/** https://docs.discord.com/developers/resources/guild#integration-object-integration-structure */
export interface DiscordIntegration {
/** Integration Id */
id: string;
@@ -474,13 +474,13 @@ export interface DiscordIntegration {
scopes: OAuth2Scope[];
}
/** https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors */
/** https://docs.discord.com/developers/resources/guild#integration-object-integration-expire-behaviors */
export enum IntegrationExpireBehaviors {
RemoveRole,
Kick,
}
/** https://discord.com/developers/docs/resources/guild#integration-account-object-integration-account-structure */
/** https://docs.discord.com/developers/resources/guild#integration-account-object-integration-account-structure */
export interface DiscordIntegrationAccount {
/** Id of the account */
id: string;
@@ -488,7 +488,7 @@ export interface DiscordIntegrationAccount {
name: string;
}
/** https://discord.com/developers/docs/resources/guild#integration-application-object-integration-application-structure */
/** https://docs.discord.com/developers/resources/guild#integration-application-object-integration-application-structure */
export interface DiscordIntegrationApplication {
/** The id of the app */
id: string;
@@ -502,7 +502,7 @@ export interface DiscordIntegrationApplication {
bot?: DiscordUser;
}
/** https://discord.com/developers/docs/resources/guild#ban-object-ban-structure */
/** https://docs.discord.com/developers/resources/guild#ban-object-ban-structure */
export interface DiscordBan {
/** The reason for the ban */
reason: string | null;
@@ -510,7 +510,7 @@ export interface DiscordBan {
user: DiscordUser;
}
/** https://discord.com/developers/docs/resources/guild#welcome-screen-object-welcome-screen-structure */
/** https://docs.discord.com/developers/resources/guild#welcome-screen-object-welcome-screen-structure */
export interface DiscordWelcomeScreen {
/** The server description shown in the welcome screen */
description: string | null;
@@ -518,7 +518,7 @@ export interface DiscordWelcomeScreen {
welcome_channels: DiscordWelcomeScreenChannel[];
}
/** https://discord.com/developers/docs/resources/guild#welcome-screen-object-welcome-screen-channel-structure */
/** https://docs.discord.com/developers/resources/guild#welcome-screen-object-welcome-screen-channel-structure */
export interface DiscordWelcomeScreenChannel {
/** The channel's id */
channel_id: string;
@@ -530,7 +530,7 @@ export interface DiscordWelcomeScreenChannel {
emoji_name: string | null;
}
/** https://discord.com/developers/docs/resources/guild#guild-onboarding-object-guild-onboarding-structure */
/** https://docs.discord.com/developers/resources/guild#guild-onboarding-object-guild-onboarding-structure */
export interface DiscordGuildOnboarding {
/** ID of the guild this onboarding is part of */
guild_id: string;
@@ -544,7 +544,7 @@ export interface DiscordGuildOnboarding {
mode: DiscordGuildOnboardingMode;
}
/** https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure */
/** https://docs.discord.com/developers/resources/guild#guild-onboarding-object-onboarding-prompt-structure */
export interface DiscordGuildOnboardingPrompt {
/** ID of the prompt */
id: string;
@@ -562,7 +562,7 @@ export interface DiscordGuildOnboardingPrompt {
in_onboarding: boolean;
}
/** https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-option-structure */
/** https://docs.discord.com/developers/resources/guild#guild-onboarding-object-prompt-option-structure */
export interface DiscordGuildOnboardingPromptOption {
/** ID of the prompt option */
id: string;
@@ -604,7 +604,7 @@ export interface DiscordGuildOnboardingPromptOption {
description: string | null;
}
/** https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-mode */
/** https://docs.discord.com/developers/resources/guild#guild-onboarding-object-onboarding-mode */
export enum DiscordGuildOnboardingMode {
/** Counts only Default Channels towards constraints */
OnboardingDefault,
@@ -612,13 +612,13 @@ export enum DiscordGuildOnboardingMode {
OnboardingAdvanced,
}
/** https://discord.com/developers/docs/resources/guild#guild-onboarding-object-prompt-types */
/** https://docs.discord.com/developers/resources/guild#guild-onboarding-object-prompt-types */
export enum DiscordGuildOnboardingPromptType {
MultipleChoice,
DropDown,
}
/** https://discord.com/developers/docs/resources/guild#incidents-data-object-incidents-data-structure */
/** https://docs.discord.com/developers/resources/guild#incidents-data-object-incidents-data-structure */
export interface DiscordIncidentsData {
/** When invites get enabled again */
invites_disabled_until: string | null;
@@ -630,7 +630,7 @@ export interface DiscordIncidentsData {
raid_detected_at?: string | null;
}
/** https://discord.com/developers/docs/resources/guild#list-active-guild-threads-response-body */
/** https://docs.discord.com/developers/resources/guild#list-active-guild-threads-response-body */
export interface DiscordListActiveThreads {
/** The active threads */
threads: DiscordChannel[];
@@ -638,7 +638,7 @@ export interface DiscordListActiveThreads {
members: DiscordThreadMember[];
}
/** https://discord.com/developers/docs/resources/guild#bulk-guild-ban-bulk-ban-response */
/** https://docs.discord.com/developers/resources/guild#bulk-guild-ban-bulk-ban-response */
export interface DiscordBulkBan {
/** list of user ids, that were successfully banned */
banned_users: string[];
@@ -646,12 +646,12 @@ export interface DiscordBulkBan {
failed_users: string[];
}
/** https://discord.com/developers/docs/resources/guild#get-guild-prune-count */
/** https://docs.discord.com/developers/resources/guild#get-guild-prune-count */
export interface DiscordPrunedCount {
pruned: number;
}
/** https://discord.com/developers/docs/resources/guild#get-guild-vanity-url */
/** https://docs.discord.com/developers/resources/guild#get-guild-vanity-url */
// TODO: This should provably have another name for clarity to what it really rappresent
export interface DiscordVanityUrl extends Partial<Omit<DiscordInvite, 'code'>> {
code: string | null;

24
packages/types/src/discord/guildScheduledEvent.ts
View File

@@ -1,9 +1,9 @@
/** Types for: https://discord.com/developers/docs/resources/guild-scheduled-event */
/** Types for: https://docs.discord.com/developers/resources/guild-scheduled-event */
import type { DiscordMember } from './guild.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure */
export interface DiscordScheduledEvent {
/** the id of the scheduled event */
id: string;
@@ -41,20 +41,20 @@ export interface DiscordScheduledEvent {
recurrence_rule: DiscordScheduledEventRecurrenceRule | null;
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level */
export enum ScheduledEventPrivacyLevel {
/** the scheduled event is only accessible to guild members */
GuildOnly = 2,
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types */
export enum ScheduledEventEntityType {
StageInstance = 1,
Voice,
External,
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status */
export enum ScheduledEventStatus {
Scheduled = 1,
Active,
@@ -62,13 +62,13 @@ export enum ScheduledEventStatus {
Canceled,
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata */
export interface DiscordScheduledEventEntityMetadata {
/** location of the event */
location?: string;
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure */
export interface DiscordScheduledEventUser {
/** The scheduled event id which the user subscribed to */
guild_scheduled_event_id: string;
@@ -78,7 +78,7 @@ export interface DiscordScheduledEventUser {
member?: DiscordMember;
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-structure */
export interface DiscordScheduledEventRecurrenceRule {
/** Starting time of the recurrence interval */
start: string;
@@ -102,7 +102,7 @@ export interface DiscordScheduledEventRecurrenceRule {
count: number | null;
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-frequency */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-frequency */
export enum DiscordScheduledEventRecurrenceRuleFrequency {
Yearly,
Monthly,
@@ -110,7 +110,7 @@ export enum DiscordScheduledEventRecurrenceRuleFrequency {
Daily,
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday */
export enum DiscordScheduledEventRecurrenceRuleWeekday {
Monday,
Tuesday,
@@ -121,7 +121,7 @@ export enum DiscordScheduledEventRecurrenceRuleWeekday {
Sunday,
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-nweekday-structure */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-nweekday-structure */
export interface DiscordScheduledEventRecurrenceRuleNWeekday {
/** The week to reoccur on. 1 - 5 */
n: number;
@@ -129,7 +129,7 @@ export interface DiscordScheduledEventRecurrenceRuleNWeekday {
day: DiscordScheduledEventRecurrenceRuleWeekday;
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-month */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-month */
export enum DiscordScheduledEventRecurrenceRuleMonth {
January = 1,
February,

6
packages/types/src/discord/guildTemplate.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/guild-template */
/** Types for: https://docs.discord.com/developers/resources/guild-template */
import type { PickPartial } from '../shared.js';
import type { DiscordChannel, DiscordOverwrite } from './channel.js';
@@ -6,7 +6,7 @@ import type { DiscordGuild } from './guild.js';
import type { DiscordRole } from './permissions.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/guild-template#guild-template-object-guild-template-structure */
/** https://docs.discord.com/developers/resources/guild-template#guild-template-object-guild-template-structure */
export interface DiscordTemplate {
/** The template code (unique Id) */
code: string;
@@ -31,7 +31,7 @@ export interface DiscordTemplate {
is_dirty: boolean | null;
}
/** https://discord.com/developers/docs/resources/guild-template#guild-template-object-guild-template-structure specificly the serialized_source_guild property */
/** https://docs.discord.com/developers/resources/guild-template#guild-template-object-guild-template-structure specificly the serialized_source_guild property */
export type DiscordTemplateSerializedSourceGuild = Omit<
PickPartial<
DiscordGuild,

54
packages/types/src/discord/interactions.ts
View File

@@ -1,7 +1,7 @@
/**
* Types for:
* - https://discord.com/developers/docs/interactions/receiving-and-responding
* - https://discord.com/developers/docs/interactions/application-commands
* - https://docs.discord.com/developers/interactions/receiving-and-responding
* - https://docs.discord.com/developers/interactions/application-commands
*/
import type { DiscordApplicationIntegrationType } from './application.js';
@@ -14,7 +14,7 @@ import type { DiscordRole } from './permissions.js';
import type { Localization } from './reference.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-structure */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-interaction-structure */
export interface DiscordInteraction {
/** Id of the interaction */
id: string;
@@ -69,13 +69,13 @@ export interface DiscordInteraction {
attachment_size_limit: number;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-structure (Specifically, the member propriety) */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-interaction-structure (Specifically, the member propriety) */
export interface DiscordInteractionMember extends DiscordMemberWithUser {
/** Total permissions of the member in the channel, including overwrites, returned when in the interaction object */
permissions: string;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-type */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-interaction-type */
export enum InteractionTypes {
Ping = 1,
ApplicationCommand = 2,
@@ -84,7 +84,7 @@ export enum InteractionTypes {
ModalSubmit = 5,
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-context-types */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types */
export enum DiscordInteractionContextType {
/** Interaction can be used within servers */
Guild = 0,
@@ -94,14 +94,14 @@ export enum DiscordInteractionContextType {
PrivateChannel = 2,
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object */
export type DiscordAuthorizingIntegrationOwners = Partial<Record<DiscordApplicationIntegrationType, string>>;
// Since this is a merge of 3 types, the properties appear in order of their first appearance in the 3 types
/**
* https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-application-command-data-structure
* https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-message-component-data-structure
* https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-modal-submit-data-structure
* https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-application-command-data-structure
* https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-message-component-data-structure
* https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-modal-submit-data-structure
*/
export interface DiscordInteractionData {
// Application Command Data
@@ -134,7 +134,7 @@ export interface DiscordInteractionData {
components?: DiscordMessageComponentFromModalInteractionResponse[];
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-resolved-data-structure */
export interface DiscordInteractionDataResolved {
/** The Ids and User objects */
users?: Record<string, DiscordUser>;
@@ -174,7 +174,7 @@ export interface DiscordInteractionDataResolved {
attachments: Record<string, DiscordAttachment>;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-application-command-interaction-data-option-structure */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-object-application-command-interaction-data-option-structure */
export interface DiscordInteractionDataOption {
/** Name of the parameter */
name: string;
@@ -188,7 +188,7 @@ export interface DiscordInteractionDataOption {
focused?: boolean;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#message-interaction-object-message-interaction-structure */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#message-interaction-object-message-interaction-structure */
export interface DiscordMessageInteraction {
/** Id of the interaction */
id: string;
@@ -202,7 +202,7 @@ export interface DiscordMessageInteraction {
member?: Partial<DiscordMember>;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type */
export enum InteractionResponseTypes {
/** ACK a `Ping` */
Pong = 1,
@@ -233,7 +233,7 @@ export enum InteractionResponseTypes {
LaunchActivity = 12,
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object */
export interface DiscordInteractionCallbackResponse {
/** The interaction object associated with the interaction response */
interaction: DiscordInteractionCallback;
@@ -241,7 +241,7 @@ export interface DiscordInteractionCallbackResponse {
resource?: DiscordInteractionResource;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-object */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-callback-interaction-callback-object */
export interface DiscordInteractionCallback {
/** ID of the interaction */
id: string;
@@ -257,7 +257,7 @@ export interface DiscordInteractionCallback {
response_message_ephemeral?: boolean;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-resource-object */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-callback-interaction-callback-resource-object */
export interface DiscordInteractionResource {
type: InteractionResponseTypes;
/**
@@ -276,13 +276,13 @@ export interface DiscordInteractionResource {
message?: DiscordMessage;
}
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-activity-instance-resource */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-callback-interaction-callback-activity-instance-resource */
export interface DiscordActivityInstanceResource {
/** Instance ID of the Activity if one was launched or joined. */
id: string;
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-structure */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-object-application-command-structure */
export interface DiscordApplicationCommand {
/** Unique ID of command */
id: string;
@@ -353,7 +353,7 @@ export interface DiscordApplicationCommand {
handler?: DiscordInteractionEntryPointCommandHandlerType;
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-object-application-command-types */
export enum ApplicationCommandTypes {
/** A text-based command that shows up when a user types `/` */
ChatInput = 1,
@@ -365,7 +365,7 @@ export enum ApplicationCommandTypes {
PrimaryEntryPoint,
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-object-application-command-option-structure */
export interface DiscordApplicationCommandOption {
/** Type of option */
type: ApplicationCommandOptionTypes;
@@ -457,7 +457,7 @@ export interface DiscordApplicationCommandOption {
autocomplete?: boolean;
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-object-application-command-option-type */
export enum ApplicationCommandOptionTypes {
SubCommand = 1,
SubCommandGroup,
@@ -477,7 +477,7 @@ export enum ApplicationCommandOptionTypes {
Attachment,
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-choice-structure */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-object-application-command-option-choice-structure */
export interface DiscordApplicationCommandOptionChoice {
/** 1-100 character choice name */
name: string;
@@ -487,7 +487,7 @@ export interface DiscordApplicationCommandOptionChoice {
value: string | number;
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-object-entry-point-command-handler-types */
export enum DiscordInteractionEntryPointCommandHandlerType {
/** The app handles the interaction using an interaction token */
AppHandler = 1,
@@ -495,7 +495,7 @@ export enum DiscordInteractionEntryPointCommandHandlerType {
DiscordLaunchActivity = 2,
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure */
export interface DiscordGuildApplicationCommandPermissions {
/** ID of the command or the application ID. When the `id` field is the application ID instead of a command ID, the permissions apply to all commands that do not contain explicit overwrites. */
id: string;
@@ -507,7 +507,7 @@ export interface DiscordGuildApplicationCommandPermissions {
permissions: DiscordApplicationCommandPermissions[];
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure */
export interface DiscordApplicationCommandPermissions {
/** ID of the role, user, or channel. It can also be a permission constant */
id: string;
@@ -517,7 +517,7 @@ export interface DiscordApplicationCommandPermissions {
permission: boolean;
}
/** https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permission-type */
/** https://docs.discord.com/developers/interactions/application-commands#application-command-permissions-object-application-command-permission-type */
export enum ApplicationCommandPermissionTypes {
Role = 1,
User,

18
packages/types/src/discord/invite.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/invite */
/** Types for: https://docs.discord.com/developers/resources/invite */
import type { DiscordApplication } from './application.js';
import type { DiscordChannel } from './channel.js';
@@ -7,7 +7,7 @@ import type { DiscordScheduledEvent } from './guildScheduledEvent.js';
import type { DiscordRole } from './permissions.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/invite#invite-object-invite-structure */
/** https://docs.discord.com/developers/resources/invite#invite-object-invite-structure */
export interface DiscordInvite {
/** The type of invite */
type: DiscordInviteType;
@@ -45,26 +45,26 @@ export interface DiscordInvite {
roles?: DiscordRole[];
}
/** https://discord.com/developers/docs/resources/invite#invite-object-invite-types */
/** https://docs.discord.com/developers/resources/invite#invite-object-invite-types */
export enum DiscordInviteType {
Guild,
GroupDm,
Friend,
}
/** https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types */
/** https://docs.discord.com/developers/resources/invite#invite-object-invite-target-types */
export enum TargetTypes {
Stream = 1,
EmbeddedApplication,
}
/** https://discord.com/developers/docs/resources/invite#invite-object-guild-invite-flags */
/** https://docs.discord.com/developers/resources/invite#invite-object-guild-invite-flags */
export enum DiscordGuildInviteFlags {
/** This invite is a guest invite for a voice channel */
isGuestInvite = 1 << 0,
}
/** https://discord.com/developers/docs/resources/invite#invite-metadata-object-invite-metadata-structure */
/** https://docs.discord.com/developers/resources/invite#invite-metadata-object-invite-metadata-structure */
export interface DiscordInviteMetadata extends DiscordInvite {
/** Number of times this invite has been used */
uses: number;
@@ -79,7 +79,7 @@ export interface DiscordInviteMetadata extends DiscordInvite {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-stage-instance-object-invite-stage-instance-structure
* https://docs.discord.com/developers/resources/invite#invite-stage-instance-object-invite-stage-instance-structure
* @deprecated
*/
export interface DiscordInviteStageInstance {
@@ -94,7 +94,7 @@ export interface DiscordInviteStageInstance {
}
/**
* https://discord.com/developers/docs/resources/invite#get-target-users-job-status-example-response
* https://docs.discord.com/developers/resources/invite#get-target-users-job-status-example-response
*
* @remarks
* Discord does not seem to actually document the type for this response, so this is based on the example provided
@@ -108,7 +108,7 @@ export interface DiscordTargetUsersJobStatus {
error_message: string | null;
}
/** https://discord.com/developers/docs/resources/invite#get-target-users-job-status-error-codes */
/** https://docs.discord.com/developers/resources/invite#get-target-users-job-status-error-codes */
export enum DiscordGetTargetUsersJobStatusErrorCodes {
/** The default value. */
Unspecified,

8
packages/types/src/discord/lobby.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/lobby */
/** Types for: https://docs.discord.com/developers/resources/lobby */
import type { DiscordChannel } from './channel.js';
/** https://discord.com/developers/docs/resources/lobby#lobby-object-lobby-structure */
/** https://docs.discord.com/developers/resources/lobby#lobby-object-lobby-structure */
export interface DiscordLobby {
/** The id of this channel */
id: string;
@@ -16,7 +16,7 @@ export interface DiscordLobby {
linked_channel?: DiscordChannel;
}
/** https://discord.com/developers/docs/resources/lobby#lobby-member-object-lobby-member-structure */
/** https://docs.discord.com/developers/resources/lobby#lobby-member-object-lobby-member-structure */
export interface DiscordLobbyMember {
/** The id of the user */
id: string;
@@ -26,7 +26,7 @@ export interface DiscordLobbyMember {
flags?: number;
}
/** https://discord.com/developers/docs/resources/lobby#lobby-member-object-lobby-member-flags */
/** https://docs.discord.com/developers/resources/lobby#lobby-member-object-lobby-member-flags */
export enum DiscordLobbyMemberFlags {
/** User can link a text channel to a lobby */
CanLinkLobby = 1 << 0,

68
packages/types/src/discord/message.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/message */
/** Types for: https://docs.discord.com/developers/resources/message */
import type { DiscordApplication } from './application.js';
import type { DiscordChannel, DiscordThreadMember } from './channel.js';
@@ -15,7 +15,7 @@ import type { DiscordPoll } from './poll.js';
import type { DiscordSticker, DiscordStickerItem } from './sticker.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/message#message-object-message-structure */
/** https://docs.discord.com/developers/resources/message#message-object-message-structure */
export interface DiscordMessage extends Partial<DiscordMessageCreateExtra> {
/** id of the message */
id: string;
@@ -113,7 +113,7 @@ export interface DiscordMessage extends Partial<DiscordMessageCreateExtra> {
call?: DiscordMessageCall;
}
/** https://discord.com/developers/docs/resources/message#message-object-message-types */
/** https://docs.discord.com/developers/resources/message#message-object-message-types */
export enum MessageTypes {
Default,
RecipientAdd,
@@ -154,7 +154,7 @@ export enum MessageTypes {
PollResult = 46,
}
/** https://discord.com/developers/docs/resources/message#message-object-message-activity-structure */
/** https://docs.discord.com/developers/resources/message#message-object-message-activity-structure */
export interface DiscordMessageActivity {
/** Type of message activity */
type: MessageActivityTypes;
@@ -162,7 +162,7 @@ export interface DiscordMessageActivity {
party_id?: string;
}
/** https://discord.com/developers/docs/resources/message#message-object-message-activity-types */
/** https://docs.discord.com/developers/resources/message#message-object-message-activity-types */
export enum MessageActivityTypes {
Join = 1,
Spectate = 2,
@@ -170,7 +170,7 @@ export enum MessageActivityTypes {
JoinRequest = 5,
}
/** https://discord.com/developers/docs/resources/message#message-object-message-flags */
/** https://docs.discord.com/developers/resources/message#message-object-message-flags */
export enum MessageFlags {
/** This message has been published to subscribed channels (via Channel Following) */
Crossposted = 1 << 0,
@@ -205,13 +205,13 @@ export enum MessageFlags {
IsComponentsV2 = 1 << 15,
}
/** https://discord.com/developers/docs/resources/message#message-interaction-metadata-object */
/** https://docs.discord.com/developers/resources/message#message-interaction-metadata-object */
export type DiscordMessageInteractionMetadata =
| DiscordApplicationCommandInteractionMetadata
| DiscordMessageComponentInteractionMetadata
| DiscordModalSubmitInteractionMetadata;
/** https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-application-command-interaction-metadata-structure */
/** https://docs.discord.com/developers/resources/message#message-interaction-metadata-object-application-command-interaction-metadata-structure */
export interface DiscordApplicationCommandInteractionMetadata {
/** Id of the interaction */
id: string;
@@ -229,7 +229,7 @@ export interface DiscordApplicationCommandInteractionMetadata {
target_message_id?: string;
}
/** https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-message-component-interaction-metadata-structure */
/** https://docs.discord.com/developers/resources/message#message-interaction-metadata-object-message-component-interaction-metadata-structure */
export interface DiscordMessageComponentInteractionMetadata {
/** Id of the interaction */
id: string;
@@ -245,7 +245,7 @@ export interface DiscordMessageComponentInteractionMetadata {
interacted_message_id: string;
}
/** https://discord.com/developers/docs/resources/message#message-interaction-metadata-object-modal-submit-interaction-metadata-structure */
/** https://docs.discord.com/developers/resources/message#message-interaction-metadata-object-modal-submit-interaction-metadata-structure */
export interface DiscordModalSubmitInteractionMetadata {
/** Id of the interaction */
id: string;
@@ -261,7 +261,7 @@ export interface DiscordModalSubmitInteractionMetadata {
triggering_interaction_metadata: DiscordApplicationCommandInteractionMetadata | DiscordMessageComponentInteractionMetadata;
}
/** https://discord.com/developers/docs/resources/message#message-call-object-message-call-object-structure */
/** https://docs.discord.com/developers/resources/message#message-call-object-message-call-object-structure */
export interface DiscordMessageCall {
/** Array of user object ids that participated in the call */
participants: string[];
@@ -269,7 +269,7 @@ export interface DiscordMessageCall {
ended_timestamp?: string | null;
}
/** https://discord.com/developers/docs/resources/message#message-reference-structure */
/** https://docs.discord.com/developers/resources/message#message-reference-structure */
export interface DiscordMessageReference {
/** Type of reference */
type?: DiscordMessageReferenceType;
@@ -286,7 +286,7 @@ export interface DiscordMessageReference {
fail_if_not_exists?: boolean;
}
/** https://discord.com/developers/docs/resources/message#message-reference-types */
/** https://docs.discord.com/developers/resources/message#message-reference-types */
export enum DiscordMessageReferenceType {
/**
* A standard reference used by replies.
@@ -308,7 +308,7 @@ export enum DiscordMessageReferenceType {
Forward,
}
/** https://discord.com/developers/docs/resources/message#message-snapshot-structure */
/** https://docs.discord.com/developers/resources/message#message-snapshot-structure */
export interface DiscordMessageSnapshot {
/** Minimal subset of fields in the forwarded message */
message: Pick<
@@ -328,7 +328,7 @@ export interface DiscordMessageSnapshot {
>;
}
/** https://discord.com/developers/docs/resources/message#reaction-object-reaction-structure */
/** https://docs.discord.com/developers/resources/message#reaction-object-reaction-structure */
export interface DiscordReaction {
/** Total number of times this emoji has been used to react (including super reacts) */
count: number;
@@ -344,7 +344,7 @@ export interface DiscordReaction {
burst_colors: string[];
}
/** https://discord.com/developers/docs/resources/message#reaction-count-details-object-reaction-count-details-structure */
/** https://docs.discord.com/developers/resources/message#reaction-count-details-object-reaction-count-details-structure */
export interface DiscordReactionCountDetails {
/** Count of super reactions */
burst: number;
@@ -352,7 +352,7 @@ export interface DiscordReactionCountDetails {
normal: number;
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-structure */
export interface DiscordEmbed {
/** Title of embed */
title?: string;
@@ -382,10 +382,10 @@ export interface DiscordEmbed {
fields?: DiscordEmbedField[];
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-types */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-types */
export type EmbedTypes = 'rich' | 'image' | 'video' | 'gifv' | 'article' | 'link' | 'poll_result';
/** https://discord.com/developers/docs/resources/message#embed-object-embed-thumbnail-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-thumbnail-structure */
export interface DiscordEmbedThumbnail {
/** Source url of thumbnail (only supports http(s) and attachments) */
url: string;
@@ -397,7 +397,7 @@ export interface DiscordEmbedThumbnail {
width?: number;
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-video-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-video-structure */
export interface DiscordEmbedVideo {
/** Source url of video */
url?: string;
@@ -409,7 +409,7 @@ export interface DiscordEmbedVideo {
width?: number;
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-image-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-image-structure */
export interface DiscordEmbedImage {
/** Source url of image (only supports http(s) and attachments) */
url: string;
@@ -421,7 +421,7 @@ export interface DiscordEmbedImage {
width?: number;
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-provider-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-provider-structure */
export interface DiscordEmbedProvider {
/** Name of provider */
name?: string;
@@ -429,7 +429,7 @@ export interface DiscordEmbedProvider {
url?: string;
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-author-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-author-structure */
export interface DiscordEmbedAuthor {
/** Name of author */
name: string;
@@ -441,7 +441,7 @@ export interface DiscordEmbedAuthor {
proxy_icon_url?: string;
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-footer-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-footer-structure */
export interface DiscordEmbedFooter {
/** Footer text */
text: string;
@@ -451,7 +451,7 @@ export interface DiscordEmbedFooter {
proxy_icon_url?: string;
}
/** https://discord.com/developers/docs/resources/message#embed-object-embed-field-structure */
/** https://docs.discord.com/developers/resources/message#embed-object-embed-field-structure */
export interface DiscordEmbedField {
/** Name of the field */
name: string;
@@ -461,7 +461,7 @@ export interface DiscordEmbedField {
inline?: boolean;
}
/** https://discord.com/developers/docs/resources/message#attachment-object-attachment-structure */
/** https://docs.discord.com/developers/resources/message#attachment-object-attachment-structure */
export interface DiscordAttachment {
/** Attachment id */
id: string;
@@ -493,14 +493,14 @@ export interface DiscordAttachment {
flags?: AttachmentFlags;
}
/** https://discord.com/developers/docs/resources/message#attachment-object-attachment-flags */
/** https://docs.discord.com/developers/resources/message#attachment-object-attachment-flags */
export enum AttachmentFlags {
None,
/** This attachment has been edited using the remix feature on mobile */
IsRemix = 1 << 2,
}
/** https://discord.com/developers/docs/resources/message#channel-mention-object-channel-mention-structure */
/** https://docs.discord.com/developers/resources/message#channel-mention-object-channel-mention-structure */
export interface DiscordChannelMention {
/** id of the channel */
id: string;
@@ -512,7 +512,7 @@ export interface DiscordChannelMention {
name: string;
}
/** https://discord.com/developers/docs/resources/message#allowed-mentions-object-allowed-mention-types */
/** https://docs.discord.com/developers/resources/message#allowed-mentions-object-allowed-mention-types */
export enum AllowedMentionsTypes {
/** Controls role mentions */
RoleMentions = 'roles',
@@ -522,7 +522,7 @@ export enum AllowedMentionsTypes {
EveryoneMentions = 'everyone',
}
/** https://discord.com/developers/docs/resources/message#allowed-mentions-object-allowed-mentions-structure */
/** https://docs.discord.com/developers/resources/message#allowed-mentions-object-allowed-mentions-structure */
export interface DiscordAllowedMentions {
/** An array of allowed mention types to parse from the content. */
parse?: AllowedMentionsTypes[];
@@ -534,7 +534,7 @@ export interface DiscordAllowedMentions {
replied_user?: boolean;
}
/** https://discord.com/developers/docs/resources/message#role-subscription-data-object-role-subscription-data-object-structure */
/** https://docs.discord.com/developers/resources/message#role-subscription-data-object-role-subscription-data-object-structure */
export interface DiscordRoleSubscriptionData {
/** the id of the sku and listing that the user is subscribed to */
role_subscription_listing_id: string;
@@ -546,7 +546,7 @@ export interface DiscordRoleSubscriptionData {
is_renewal: boolean;
}
/** https://discord.com/developers/docs/resources/message#message-pin-object-message-pin-object-struture */
/** https://docs.discord.com/developers/resources/message#message-pin-object-message-pin-object-struture */
export interface DiscordMessagePin {
/** the time the message was pinned */
pinned_at: string;
@@ -554,13 +554,13 @@ export interface DiscordMessagePin {
message: DiscordMessage;
}
/** https://discord.com/developers/docs/resources/message#get-reactions-reaction-types */
/** https://docs.discord.com/developers/resources/message#get-reactions-reaction-types */
export enum DiscordReactionType {
Normal,
Burst,
}
/** https://discord.com/developers/docs/resources/message#get-channel-pins-response-structure */
/** https://docs.discord.com/developers/resources/message#get-channel-pins-response-structure */
export interface DiscordGetChannelPins {
items: DiscordMessagePin[];
has_more: boolean;

36
packages/types/src/discord/oauth2.ts
View File

@@ -1,11 +1,11 @@
/** Types for: https://discord.com/developers/docs/topics/oauth2 */
/** Types for: https://docs.discord.com/developers/topics/oauth2 */
import type { DiscordApplication } from './application.js';
import type { DiscordGuild } from './guild.js';
import type { DiscordUser } from './user.js';
import type { DiscordWebhook } from './webhook.js';
/** https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes */
/** https://docs.discord.com/developers/topics/oauth2#shared-resources-oauth2-scopes */
export enum OAuth2Scope {
/**
* Allows your app to fetch data from a user's "Now Playing/Recently Played" list
@@ -36,7 +36,7 @@ export enum OAuth2Scope {
* Allows your app to update its Application Commands via this bearer token
*
* @remarks
* This scope can only be used when using a [Client Credential Grant](https://discord.com/developers/docs/topics/oauth2#client-credentials-grant)
* This scope can only be used when using a [Client Credential Grant](https://docs.discord.com/developers/topics/oauth2#client-credentials-grant)
*/
ApplicationsCommandsUpdate = 'applications.commands.update',
/** Allows your app to update permissions for its commands in a guild a user has permissions to */
@@ -47,7 +47,7 @@ export enum OAuth2Scope {
ApplicationsStoreUpdate = 'applications.store.update',
/** For oauth2 bots, this puts the bot in the user's selected guild by default */
Bot = 'bot',
/** Allows requests to [/users/@me/connections](https://discord.com/developers/docs/resources/user#get-user-connections) */
/** Allows requests to [/users/@me/connections](https://docs.discord.com/developers/resources/user#get-user-connections) */
Connections = 'connections',
/**
* Allows your app to see information about the user's DMs and group DMs
@@ -56,21 +56,21 @@ export enum OAuth2Scope {
* This scope requires Discord approval to be used
*/
DMChannelsRead = 'dm_channels.read',
/** Adds the `email` filed to [/users/@me](https://discord.com/developers/docs/resources/user#get-current-user) */
/** Adds the `email` filed to [/users/@me](https://docs.discord.com/developers/resources/user#get-current-user) */
Email = 'email',
/** Allows your app to join users to a group dm */
GroupDMJoins = 'gdm.join',
/** Allows requests to [/users/@me/guilds](https://discord.com/developers/docs/resources/user#get-current-user-guilds) */
/** Allows requests to [/users/@me/guilds](https://docs.discord.com/developers/resources/user#get-current-user-guilds) */
Guilds = 'guilds',
/** Allows requests to [/guilds/{guild.id}/members/{user.id}](https://discord.com/developers/docs/resources/guild#add-guild-member) */
/** Allows requests to [/guilds/{guild.id}/members/{user.id}](https://docs.discord.com/developers/resources/guild#add-guild-member) */
GuildsJoin = 'guilds.join',
/** Allows requests to [/users/@me/guilds/{guild.id}/member](https://discord.com/developers/docs/resources/user#get-current-user-guild-member) */
/** Allows requests to [/users/@me/guilds/{guild.id}/member](https://docs.discord.com/developers/resources/user#get-current-user-guild-member) */
GuildsMembersRead = 'guilds.members.read',
/**
* Allows requests to [/users/@me](https://discord.com/developers/docs/resources/user#get-current-user)
* Allows requests to [/users/@me](https://docs.discord.com/developers/resources/user#get-current-user)
*
* @remarks
* The return object from [/users/@me](https://discord.com/developers/docs/resources/user#get-current-user)
* The return object from [/users/@me](https://docs.discord.com/developers/resources/user#get-current-user)
* does NOT contain the `email` field unless the scope `email` is also used
*/
Identify = 'identify',
@@ -135,7 +135,7 @@ export enum OAuth2Scope {
WebhookIncoming = 'webhook.incoming',
}
/** https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-redirect-url-example */
/** https://docs.discord.com/developers/topics/oauth2#authorization-code-grant-redirect-url-example */
export interface DiscordTokenExchangeAuthorizationCode {
grant_type: 'authorization_code';
/** The code for the token exchange */
@@ -146,7 +146,7 @@ export interface DiscordTokenExchangeAuthorizationCode {
code_verifier?: string;
}
/** https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response */
/** https://docs.discord.com/developers/topics/oauth2#authorization-code-grant-access-token-response */
export interface DiscordAccessTokenResponse {
/** The access token of the user */
access_token: string;
@@ -170,19 +170,19 @@ export interface DiscordAccessTokenResponse {
}
/**
* https://discord.com/developers/docs/topics/oauth2#authorization-code-grant
* https://discord.com/developers/docs/topics/oauth2#client-credentials-grant
* https://docs.discord.com/developers/topics/oauth2#authorization-code-grant
* https://docs.discord.com/developers/topics/oauth2#client-credentials-grant
*/
export type DiscordTokenExchange = DiscordTokenExchangeAuthorizationCode | DiscordTokenExchangeRefreshToken | DiscordTokenExchangeClientCredentials;
/** https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-refresh-token-exchange-example */
/** https://docs.discord.com/developers/topics/oauth2#authorization-code-grant-refresh-token-exchange-example */
export interface DiscordTokenExchangeRefreshToken {
grant_type: 'refresh_token';
/** the user's refresh token */
refresh_token: string;
}
/** https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-token-revocation-example */
/** https://docs.discord.com/developers/topics/oauth2#authorization-code-grant-token-revocation-example */
export interface DiscordTokenRevocation {
/** The access token to revoke */
token: string;
@@ -190,14 +190,14 @@ export interface DiscordTokenRevocation {
token_type_hint?: 'access_token' | 'refresh_token';
}
/** https://discord.com/developers/docs/topics/oauth2#client-credentials-grant */
/** https://docs.discord.com/developers/topics/oauth2#client-credentials-grant */
export interface DiscordTokenExchangeClientCredentials {
grant_type: 'client_credentials';
/** The scope(s) for the access token */
scope: OAuth2Scope[];
}
/** https://discord.com/developers/docs/topics/oauth2#get-current-authorization-information-response-structure */
/** https://docs.discord.com/developers/topics/oauth2#get-current-authorization-information-response-structure */
export interface DiscordCurrentAuthorization {
application: DiscordApplication;
/** the scopes the user has authorized the application for */

26
packages/types/src/discord/opcodes.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/topics/opcodes-and-status-codes */
/** Types for: https://docs.discord.com/developers/topics/opcodes-and-status-codes */
/** https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes */
/** https://docs.discord.com/developers/topics/opcodes-and-status-codes#gateway-gateway-opcodes */
export enum GatewayOpcodes {
/** An event was dispatched. */
Dispatch,
@@ -28,7 +28,7 @@ export enum GatewayOpcodes {
RequestSoundboardSounds = 31,
}
/** https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes */
/** https://docs.discord.com/developers/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes */
export enum GatewayCloseEventCodes {
/** A normal closure of the gateway. You may attempt to reconnect. */
NormalClosure = 1000,
@@ -36,35 +36,35 @@ export enum GatewayCloseEventCodes {
GoingAway = 1001,
/** We're not sure what went wrong. Try reconnecting? */
UnknownError = 4000,
/** You sent an invalid [Gateway opcode](https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-opcodes) or an invalid payload for an opcode. Don't do that! */
/** You sent an invalid [Gateway opcode](https://docs.discord.com/developers/topics/opcodes-and-status-codes#gateway-gateway-opcodes) or an invalid payload for an opcode. Don't do that! */
UnknownOpcode,
/** You sent an invalid [payload](https://discord.com/developers/docs/topics/gateway#sending-payloads) to us. Don't do that! */
/** You sent an invalid [payload](https://docs.discord.com/developers/events/gateway#sending-events) to us. Don't do that! */
DecodeError,
/** You sent us a payload prior to [identifying](https://discord.com/developers/docs/topics/gateway-events#identify), or this session has been invalidated. */
/** You sent us a payload prior to [identifying](https://docs.discord.com/developers/events/gateway-events#identify), or this session has been invalidated. */
NotAuthenticated,
/** The account token sent with your [identify payload](https://discord.com/developers/docs/topics/gateway-events#identify) is incorrect. */
/** The account token sent with your [identify payload](https://docs.discord.com/developers/events/gateway-events#identify) is incorrect. */
AuthenticationFailed,
/** You sent more than one identify payload. Don't do that! */
AlreadyAuthenticated,
/** The sequence sent when [resuming](https://discord.com/developers/docs/topics/gateway-events#resume) the session was invalid. Reconnect and start a new session. */
/** The sequence sent when [resuming](https://docs.discord.com/developers/events/gateway-events#resume) the session was invalid. Reconnect and start a new session. */
InvalidSeq = 4007,
/** Woah nelly! You're sending payloads to us too quickly. Slow it down! You will be disconnected on receiving this. */
RateLimited,
/** Your session timed out. Reconnect and start a new one. */
SessionTimedOut,
/** You sent us an invalid [shard when identifying](https://discord.com/developers/docs/topics/gateway#sharding). */
/** You sent us an invalid [shard when identifying](https://docs.discord.com/developers/events/gateway#sharding). */
InvalidShard,
/** The session would have handled too many guilds - you are required to [shard](https://discord.com/developers/docs/topics/gateway#sharding) your connection in order to connect. */
/** The session would have handled too many guilds - you are required to [shard](https://docs.discord.com/developers/events/gateway#sharding) your connection in order to connect. */
ShardingRequired,
/** You sent an invalid version for the gateway. */
InvalidApiVersion,
/** You sent an invalid intent for a [Gateway Intent](https://discord.com/developers/docs/topics/gateway#gateway-intents). You may have incorrectly calculated the bitwise value. */
/** You sent an invalid intent for a [Gateway Intent](https://docs.discord.com/developers/events/gateway#gateway-intents). You may have incorrectly calculated the bitwise value. */
InvalidIntents,
/** You sent a disallowed intent for a [Gateway Intent](https://discord.com/developers/docs/topics/gateway#gateway-intents). You may have tried to specify an intent that you [have not enabled or are not approved for](https://discord.com/developers/docs/topics/gateway#privileged-intents). */
/** You sent a disallowed intent for a [Gateway Intent](https://docs.discord.com/developers/events/gateway#gateway-intents). You may have tried to specify an intent that you [have not enabled or are not approved for](https://docs.discord.com/developers/events/gateway#privileged-intents). */
DisallowedIntents,
}
/** https://discord.com/developers/docs/topics/opcodes-and-status-codes#json-json-error-codes */
/** https://docs.discord.com/developers/topics/opcodes-and-status-codes#json-json-error-codes */
export enum HTTPJsonErrorCodes {
/** General error (such as a malformed request body, amongst other things) */
General = 0,

14
packages/types/src/discord/permissions.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/topics/permissions */
/** Types for: https://docs.discord.com/developers/topics/permissions */
/** https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags */
/** https://docs.discord.com/developers/topics/permissions#permissions-bitwise-permission-flags */
export const BitwisePermissionFlags = {
/** Allows creation of instant invites */
CREATE_INSTANT_INVITE: 1n << 0n,
@@ -106,10 +106,10 @@ export const BitwisePermissionFlags = {
BYPASS_SLOWMODE: 1n << 52n,
} as const;
/** https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags */
/** https://docs.discord.com/developers/topics/permissions#permissions-bitwise-permission-flags */
export type PermissionStrings = keyof typeof BitwisePermissionFlags;
/** https://discord.com/developers/docs/topics/permissions#role-object-role-structure */
/** https://docs.discord.com/developers/topics/permissions#role-object-role-structure */
export interface DiscordRole {
/** Role id */
id: string;
@@ -142,7 +142,7 @@ export interface DiscordRole {
flags: RoleFlags;
}
/** https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure */
/** https://docs.discord.com/developers/topics/permissions#role-object-role-tags-structure */
export interface DiscordRoleTags {
/** The id of the bot this role belongs to */
bot_id?: string;
@@ -158,7 +158,7 @@ export interface DiscordRoleTags {
guild_connections?: null;
}
/** https://discord.com/developers/docs/topics/permissions#role-object-role-colors-object */
/** https://docs.discord.com/developers/topics/permissions#role-object-role-colors-object */
export interface DiscordRoleColors {
/** The primary color for the role */
primary_color: number;
@@ -168,7 +168,7 @@ export interface DiscordRoleColors {
tertiary_color: number | null;
}
/** https://discord.com/developers/docs/topics/permissions#role-object-role-flags */
/** https://docs.discord.com/developers/topics/permissions#role-object-role-flags */
export enum RoleFlags {
None,
/** Role can be selected by members in an onboarding prompt */

16
packages/types/src/discord/poll.ts
View File

@@ -1,9 +1,9 @@
/** Types for: https://discord.com/developers/docs/resources/poll */
/** Types for: https://docs.discord.com/developers/resources/poll */
import type { DiscordEmoji } from './emoji.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure */
/** https://docs.discord.com/developers/resources/poll#poll-object-poll-object-structure */
export interface DiscordPoll {
/** The question of the poll. Only `text` is supported. */
question: DiscordPollMedia;
@@ -30,13 +30,13 @@ export interface DiscordPoll {
results?: DiscordPollResult;
}
/** https://discord.com/developers/docs/resources/poll#layout-type */
/** https://docs.discord.com/developers/resources/poll#layout-type */
export enum DiscordPollLayoutType {
/** The default layout */
Default = 1,
}
/** https://discord.com/developers/docs/resources/poll#poll-media-object-poll-media-object-structure */
/** https://docs.discord.com/developers/resources/poll#poll-media-object-poll-media-object-structure */
export interface DiscordPollMedia {
/**
* The text of the field
@@ -55,7 +55,7 @@ export interface DiscordPollMedia {
emoji?: Partial<DiscordEmoji>;
}
/** https://discord.com/developers/docs/resources/poll#poll-answer-object-poll-answer-object-structure */
/** https://docs.discord.com/developers/resources/poll#poll-answer-object-poll-answer-object-structure */
export interface DiscordPollAnswer {
/**
* The id of the answer
@@ -68,7 +68,7 @@ export interface DiscordPollAnswer {
poll_media: DiscordPollMedia;
}
/** https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure */
/** https://docs.discord.com/developers/resources/poll#poll-results-object-poll-results-object-structure */
export interface DiscordPollResult {
/** Whether the votes have been precisely counted */
is_finalized: boolean;
@@ -76,7 +76,7 @@ export interface DiscordPollResult {
answer_counts: DiscordPollAnswerCount[];
}
/** https://discord.com/developers/docs/resources/poll#poll-results-object-poll-results-object-structure */
/** https://docs.discord.com/developers/resources/poll#poll-results-object-poll-results-object-structure */
export interface DiscordPollAnswerCount {
/** The {@link DiscordPollAnswer.answer_id | answer_id} */
id: number;
@@ -86,7 +86,7 @@ export interface DiscordPollAnswerCount {
me_voted: boolean;
}
/** https://discord.com/developers/docs/resources/poll#get-answer-voters-response-body */
/** https://docs.discord.com/developers/resources/poll#get-answer-voters-response-body */
export interface DiscordGetAnswerVotesResponse {
/** Users who voted for this answer */
users: DiscordUser[];

8
packages/types/src/discord/reference.ts
View File

@@ -1,17 +1,17 @@
/** Types for: https://discord.com/developers/docs/reference */
/** Types for: https://docs.discord.com/developers/reference */
/**
* https://discord.com/developers/docs/reference#image-formatting
* https://docs.discord.com/developers/reference#image-formatting
*
* @remarks
* json is only for stickers
*/
export type ImageFormat = 'jpg' | 'jpeg' | 'png' | 'webp' | 'gif' | 'json';
/** https://discord.com/developers/docs/reference#image-formatting */
/** https://docs.discord.com/developers/reference#image-formatting */
export type ImageSize = 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;
/** https://discord.com/developers/docs/reference#locales */
/** https://docs.discord.com/developers/reference#locales */
export enum Locales {
Indonesian = 'id',
Danish = 'da',

8
packages/types/src/discord/sku.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/resources/sku */
/** Types for: https://docs.discord.com/developers/resources/sku */
/** https://discord.com/developers/docs/resources/sku#sku-object-sku-structure */
/** https://docs.discord.com/developers/resources/sku#sku-object-sku-structure */
export interface DiscordSku {
/** ID of SKU */
id: string;
@@ -16,7 +16,7 @@ export interface DiscordSku {
flags: SkuFlags;
}
/** https://discord.com/developers/docs/resources/sku#sku-object-sku-types */
/** https://docs.discord.com/developers/resources/sku#sku-object-sku-types */
export enum DiscordSkuType {
/** Durable one-time purchase */
Durable = 2,
@@ -28,7 +28,7 @@ export enum DiscordSkuType {
SubscriptionGroup = 6,
}
/** https://discord.com/developers/docs/resources/sku#sku-object-sku-flags */
/** https://docs.discord.com/developers/resources/sku#sku-object-sku-flags */
export enum SkuFlags {
/** SKU is available for purchase */
Available = 1 << 2,

4
packages/types/src/discord/soundboard.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/soundboard */
/** Types for: https://docs.discord.com/developers/resources/soundboard */
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/soundboard#soundboard-sound-object-soundboard-sound-structure */
/** https://docs.discord.com/developers/resources/soundboard#soundboard-sound-object-soundboard-sound-structure */
export interface DiscordSoundboardSound {
/** The name of this sound */
name: string;

6
packages/types/src/discord/stageInstance.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/resources/stage-instance */
/** Types for: https://docs.discord.com/developers/resources/stage-instance */
/** https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-stage-instance-structure */
/** https://docs.discord.com/developers/resources/stage-instance#stage-instance-object-stage-instance-structure */
export interface DiscordStageInstance {
/** The id of this Stage instance */
id: string;
@@ -21,7 +21,7 @@ export interface DiscordStageInstance {
guild_scheduled_event_id: string | null;
}
/** https://discord.com/developers/docs/resources/stage-instance#stage-instance-object-privacy-level */
/** https://docs.discord.com/developers/resources/stage-instance#stage-instance-object-privacy-level */
export enum DiscordStageInstancePrivacyLevel {
Public = 1,
GuildOnly = 2,

22
packages/types/src/discord/sticker.ts
View File

@@ -1,10 +1,10 @@
/** Types for: https://discord.com/developers/docs/resources/sticker */
/** Types for: https://docs.discord.com/developers/resources/sticker */
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-structure */
/** https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-structure */
export interface DiscordSticker {
/** [Id of the sticker](https://discord.com/developers/docs/reference#image-formatting) */
/** [Id of the sticker](https://docs.discord.com/developers/reference#image-formatting) */
id: string;
/** Id of the pack the sticker is from */
pack_id?: string;
@@ -19,9 +19,9 @@ export interface DiscordSticker {
* A comma separated list of keywords is the format used in this field by standard stickers, but this is just a convention. Incidentally the client will always use a name generated from an emoji as the value of this field when creating or modifying a guild sticker.
*/
tags: string;
/** [type of sticker](https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types) */
/** [type of sticker](https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-types) */
type: StickerTypes;
/** [Type of sticker format](https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types) */
/** [Type of sticker format](https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-format-types) */
format_type: StickerFormatTypes;
/** Whether or not the sticker is available */
available?: boolean;
@@ -33,7 +33,7 @@ export interface DiscordSticker {
sort_value?: number;
}
/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types */
/** https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-types */
export enum StickerTypes {
/** an official sticker in a pack */
Standard = 1,
@@ -41,7 +41,7 @@ export enum StickerTypes {
Guild,
}
/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types */
/** https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-format-types */
export enum StickerFormatTypes {
Png = 1,
APng,
@@ -49,17 +49,17 @@ export enum StickerFormatTypes {
Gif,
}
/** https://discord.com/developers/docs/resources/sticker#sticker-item-object-sticker-item-structure */
/** https://docs.discord.com/developers/resources/sticker#sticker-item-object-sticker-item-structure */
export interface DiscordStickerItem {
/** Id of the sticker */
id: string;
/** Name of the sticker */
name: string;
/** [Type of sticker format](https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types) */
/** [Type of sticker format](https://docs.discord.com/developers/resources/sticker#sticker-object-sticker-format-types) */
format_type: StickerFormatTypes;
}
/** https://discord.com/developers/docs/resources/sticker#sticker-pack-object-sticker-pack-structure */
/** https://docs.discord.com/developers/resources/sticker#sticker-pack-object-sticker-pack-structure */
export interface DiscordStickerPack {
/** id of the sticker pack */
id: string;
@@ -73,6 +73,6 @@ export interface DiscordStickerPack {
cover_sticker_id?: string;
/** description of the sticker pack */
description: string;
/** id of the sticker pack's [banner image](https://discord.com/developers/docs/reference#image-formatting) */
/** id of the sticker pack's [banner image](https://docs.discord.com/developers/reference#image-formatting) */
banner_asset_id?: string;
}

6
packages/types/src/discord/subscription.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/resources/subscription */
/** Types for: https://docs.discord.com/developers/resources/subscription */
/** https://discord.com/developers/docs/resources/subscription#subscription-object */
/** https://docs.discord.com/developers/resources/subscription#subscription-object */
export interface DiscordSubscription {
/** ID of the subscription */
id: string;
@@ -24,7 +24,7 @@ export interface DiscordSubscription {
country?: string;
}
/** https://discord.com/developers/docs/resources/subscription#subscription-statuses */
/** https://docs.discord.com/developers/resources/subscription#subscription-statuses */
export enum DiscordSubscriptionStatus {
/** Subscription is active and scheduled to renew. */
Active,

10
packages/types/src/discord/teams.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/topics/teams */
/** Types for: https://docs.discord.com/developers/topics/teams */
import type { DiscordUser } from './user.js';
/* https://discord.com/developers/docs/topics/teams#team-member-roles-team-member-role-types */
/* https://docs.discord.com/developers/topics/teams#team-member-roles-team-member-role-types */
export enum DiscordTeamMemberRole {
/**
* Owners are the most permissiable role, and can take destructive, irreversible actions like deleting the team itself.
@@ -25,7 +25,7 @@ export enum DiscordTeamMemberRole {
ReadOnly = 'read_only',
}
/** https://discord.com/developers/docs/topics/teams#data-models-team-object */
/** https://docs.discord.com/developers/topics/teams#data-models-team-object */
export interface DiscordTeam {
/** Hash of the image of the team's icon */
icon: string | null;
@@ -39,7 +39,7 @@ export interface DiscordTeam {
owner_user_id: string;
}
/** https://discord.com/developers/docs/topics/teams#data-models-team-member-object */
/** https://docs.discord.com/developers/topics/teams#data-models-team-member-object */
export interface DiscordTeamMember {
/** The user's membership state on the team */
membership_state: TeamMembershipStates;
@@ -51,7 +51,7 @@ export interface DiscordTeamMember {
role: DiscordTeamMemberRole;
}
/** https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum */
/** https://docs.discord.com/developers/topics/teams#data-models-membership-state-enum */
export enum TeamMembershipStates {
Invited = 1,
Accepted,

24
packages/types/src/discord/user.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/user */
/** Types for: https://docs.discord.com/developers/resources/user */
import type { DiscordIntegration } from './guild.js';
/** https://discord.com/developers/docs/resources/user#user-object-user-structure */
/** https://docs.discord.com/developers/resources/user#user-object-user-structure */
export interface DiscordUser {
/** The user's id */
id: string;
@@ -44,7 +44,7 @@ export interface DiscordUser {
primary_guild?: DiscordUserPrimaryGuild | null;
}
/** https://discord.com/developers/docs/resources/user#user-object-user-flags */
/** https://docs.discord.com/developers/resources/user#user-object-user-flags */
export enum UserFlags {
DiscordEmployee = 1 << 0,
PartneredServerOwner = 1 << 1,
@@ -63,7 +63,7 @@ export enum UserFlags {
ActiveDeveloper = 1 << 22,
}
/** https://discord.com/developers/docs/resources/user#user-object-premium-types */
/** https://docs.discord.com/developers/resources/user#user-object-premium-types */
export enum PremiumTypes {
None,
NitroClassic,
@@ -71,7 +71,7 @@ export enum PremiumTypes {
NitroBasic,
}
/** https://discord.com/developers/docs/resources/user#user-object-user-primary-guild */
/** https://docs.discord.com/developers/resources/user#user-object-user-primary-guild */
export interface DiscordUserPrimaryGuild {
/** The id of the primary guild */
identity_guild_id: string | null;
@@ -89,7 +89,7 @@ export interface DiscordUserPrimaryGuild {
badge: string | null;
}
/** https://discord.com/developers/docs/resources/user#avatar-decoration-data-object-avatar-decoration-data-structure */
/** https://docs.discord.com/developers/resources/user#avatar-decoration-data-object-avatar-decoration-data-structure */
export interface DiscordAvatarDecorationData {
/** the avatar decoration hash */
asset: string;
@@ -97,13 +97,13 @@ export interface DiscordAvatarDecorationData {
sku_id: string;
}
/** https://discord.com/developers/docs/resources/user#collectibles-collectible-structure */
/** https://docs.discord.com/developers/resources/user#collectibles-collectible-structure */
export interface DiscordCollectibles {
/** object mapping of nameplate data */
nameplate?: DiscordNameplate;
}
/** https://discord.com/developers/docs/resources/user#nameplate-nameplate-structure */
/** https://docs.discord.com/developers/resources/user#nameplate-nameplate-structure */
export interface DiscordNameplate {
/** the nameplate's id */
sku_id: string;
@@ -115,7 +115,7 @@ export interface DiscordNameplate {
palette: string;
}
/** https://discord.com/developers/docs/resources/user#connection-object-connection-structure */
/** https://docs.discord.com/developers/resources/user#connection-object-connection-structure */
export interface DiscordConnection {
/** id of the connection account */
id: string;
@@ -139,7 +139,7 @@ export interface DiscordConnection {
visibility: DiscordConnectionVisibility;
}
/** https://discord.com/developers/docs/resources/user#connection-object-services */
/** https://docs.discord.com/developers/resources/user#connection-object-services */
export enum DiscordConnectionServiceType {
AmazonMusic = 'amazon-music',
BattleNet = 'battlenet',
@@ -169,7 +169,7 @@ export enum DiscordConnectionServiceType {
YouTube = 'youtube',
}
/** https://discord.com/developers/docs/resources/user#connection-object-visibility-types */
/** https://docs.discord.com/developers/resources/user#connection-object-visibility-types */
export enum DiscordConnectionVisibility {
/** invisible to everyone except the user themselves */
None = 0,
@@ -177,7 +177,7 @@ export enum DiscordConnectionVisibility {
Everyone = 1,
}
/** https://discord.com/developers/docs/resources/user#application-role-connection-object-application-role-connection-structure */
/** https://docs.discord.com/developers/resources/user#application-role-connection-object-application-role-connection-structure */
export interface DiscordApplicationRoleConnection {
/** the vanity name of the platform a bot has connected (max 50 characters) */
platform_name: string | null;

6
packages/types/src/discord/voice.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/voice */
/** Types for: https://docs.discord.com/developers/resources/voice */
import type { DiscordMemberWithUser } from './guild.js';
/** https://discord.com/developers/docs/resources/voice#voice-state-object-voice-state-structure */
/** https://docs.discord.com/developers/resources/voice#voice-state-object-voice-state-structure */
export interface DiscordVoiceState {
/** The guild id this voice state is for */
guild_id?: string;
@@ -32,7 +32,7 @@ export interface DiscordVoiceState {
request_to_speak_timestamp: string | null;
}
/** https://discord.com/developers/docs/resources/voice#voice-region-object-voice-region-structure */
/** https://docs.discord.com/developers/resources/voice#voice-region-object-voice-region-structure */
export interface DiscordVoiceRegion {
/** Unique Id for the region */
id: string;

6
packages/types/src/discord/webhook.ts
View File

@@ -1,10 +1,10 @@
/** Types for: https://discord.com/developers/docs/resources/webhook */
/** Types for: https://docs.discord.com/developers/resources/webhook */
import type { DiscordChannel } from './channel.js';
import type { DiscordGuild } from './guild.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-structure */
/** https://docs.discord.com/developers/resources/webhook#webhook-object-webhook-structure */
export interface DiscordWebhook {
/** The id of the webhook */
id: string;
@@ -32,7 +32,7 @@ export interface DiscordWebhook {
url?: string;
}
/** https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types */
/** https://docs.discord.com/developers/resources/webhook#webhook-object-webhook-types */
export enum WebhookTypes {
/** Incoming Webhooks can post messages to channels with a generated token */
Incoming = 1,

38
packages/types/src/discord/webhookEvents.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/events/webhook-events */
/** Types for: https://docs.discord.com/developers/events/webhook-events */
import type { DiscordApplicationIntegrationType } from './application.js';
import type { DiscordChannel } from './channel.js';
@@ -8,7 +8,7 @@ import type { DiscordMessage, MessageFlags, MessageTypes } from './message.js';
import type { OAuth2Scope } from './oauth2.js';
import type { DiscordUser } from './user.js';
/** https://discord.com/developers/docs/events/webhook-events#payload-structure */
/** https://docs.discord.com/developers/events/webhook-events#payload-structure */
export interface DiscordEventWebhookEvent {
/** Version scheme for the webhook event. Currently always 1 */
version: 1;
@@ -20,7 +20,7 @@ export interface DiscordEventWebhookEvent {
event?: DiscordEventWebhookEventBody;
}
/** https://discord.com/developers/docs/events/webhook-events#webhook-types */
/** https://docs.discord.com/developers/events/webhook-events#webhook-types */
export enum DiscordEventWebhookType {
/** PING event sent to verify your Webhook Event URL is active */
Ping = 0,
@@ -28,7 +28,7 @@ export enum DiscordEventWebhookType {
Event = 1,
}
/** https://discord.com/developers/docs/events/webhook-events#event-body-object */
/** https://docs.discord.com/developers/events/webhook-events#event-body-object */
export interface DiscordEventWebhookEventBody {
/** Event type */
type: DiscordWebhookEventType;
@@ -49,7 +49,7 @@ export interface DiscordEventWebhookEventBody {
| DiscordEventWebhookGameDirectMessageDeleteBody;
}
/** https://discord.com/developers/docs/events/webhook-events#event-types */
/** https://docs.discord.com/developers/events/webhook-events#event-types */
export enum DiscordWebhookEventType {
/** Sent when an app was authorized by a user to a server or their account */
ApplicationAuthorized = 'APPLICATION_AUTHORIZED',
@@ -77,7 +77,7 @@ export enum DiscordWebhookEventType {
GameDirectMessageDelete = 'GAME_DIRECT_MESSAGE_DELETE',
}
/** https://discord.com/developers/docs/events/webhook-events#application-authorized-application-authorized-structure */
/** https://docs.discord.com/developers/events/webhook-events#application-authorized-application-authorized-structure */
export interface DiscordEventWebhookApplicationAuthorizedBody {
/** Installation context for the authorization. Either guild (0) if installed to a server or user (1) if installed to a user's account */
integration_type?: DiscordApplicationIntegrationType;
@@ -89,26 +89,26 @@ export interface DiscordEventWebhookApplicationAuthorizedBody {
guild?: DiscordGuild;
}
/** https://discord.com/developers/docs/events/webhook-events#application-authorized-application-authorized-structure */
/** https://docs.discord.com/developers/events/webhook-events#application-authorized-application-authorized-structure */
export interface DiscordEventWebhookApplicationDeauthorizedBody {
/** User who deauthorized the app */
user: DiscordUser;
}
/** https://discord.com/developers/docs/events/webhook-events#entitlement-create-entitlement-create-structure */
/** https://docs.discord.com/developers/events/webhook-events#entitlement-create-entitlement-create-structure */
export type DiscordEventWebhookEntitlementCreateBody = DiscordEntitlement;
/** https://discord.com/developers/docs/events/webhook-events#entitlement-update-entitlement-update-structure */
/** https://docs.discord.com/developers/events/webhook-events#entitlement-update-entitlement-update-structure */
export type DiscordEventWebhookEntitlementUpdateBody = DiscordEntitlement;
/** https://discord.com/developers/docs/events/webhook-events#entitlement-delete-entitlement-delete-structure */
/** https://docs.discord.com/developers/events/webhook-events#entitlement-delete-entitlement-delete-structure */
export type DiscordEventWebhookEntitlementDeleteBody = DiscordEntitlement;
/** https://discord.com/developers/docs/events/webhook-events#lobby-message-create-lobby-message-create-structure */
/** https://docs.discord.com/developers/events/webhook-events#lobby-message-create-lobby-message-create-structure */
export type DiscordEventWebhookLobbyMessageCreateBody = DiscordSocialSDKLobbyMessage;
// Discord does not explicitly says what "with additional fields for message updates" means, so we rely on the example and the DiscordMessage structure
/** https://discord.com/developers/docs/events/webhook-events#lobby-message-update-lobby-message-update-structure */
/** https://docs.discord.com/developers/events/webhook-events#lobby-message-update-lobby-message-update-structure */
export interface DiscordEventWebhookLobbyMessageUpdateBody extends DiscordSocialSDKLobbyMessage {
/** ISO8601 timestamp of when the message was last edited */
edited_timestamp: string | null;
@@ -116,7 +116,7 @@ export interface DiscordEventWebhookLobbyMessageUpdateBody extends DiscordSocial
timestamp: string;
}
/** https://discord.com/developers/docs/events/webhook-events#lobby-message-delete-lobby-message-delete-structure */
/** https://docs.discord.com/developers/events/webhook-events#lobby-message-delete-lobby-message-delete-structure */
export interface DiscordEventWebhookLobbyMessageDeleteBody {
/** ID of the deleted message */
id: string;
@@ -124,16 +124,16 @@ export interface DiscordEventWebhookLobbyMessageDeleteBody {
lobby_id: string;
}
/** https://discord.com/developers/docs/events/webhook-events#game-direct-message-create-game-direct-message-create-structure */
/** https://docs.discord.com/developers/events/webhook-events#game-direct-message-create-game-direct-message-create-structure */
export type DiscordEventWebhookGameDirectMessageCreateBody = DiscordSocialSDKMessage | DiscordSocialSDKPassthroughMessage;
/** https://discord.com/developers/docs/events/webhook-events#game-direct-message-update-game-direct-message-update-structure */
/** https://docs.discord.com/developers/events/webhook-events#game-direct-message-update-game-direct-message-update-structure */
export type DiscordEventWebhookGameDirectMessageUpdateBody = DiscordSocialSDKMessage | DiscordSocialSDKPassthroughMessage;
/** https://discord.com/developers/docs/events/webhook-events#game-direct-message-delete-game-direct-message-delete-structure */
/** https://docs.discord.com/developers/events/webhook-events#game-direct-message-delete-game-direct-message-delete-structure */
export type DiscordEventWebhookGameDirectMessageDeleteBody = DiscordSocialSDKMessage | DiscordSocialSDKPassthroughMessage;
/** https://discord.com/developers/docs/events/webhook-events#lobby-message-object-lobby-message-structure */
/** https://docs.discord.com/developers/events/webhook-events#lobby-message-object-lobby-message-structure */
export interface DiscordSocialSDKLobbyMessage {
/** ID of the message */
id: string;
@@ -159,7 +159,7 @@ export interface DiscordSocialSDKLobbyMessage {
application_id?: string;
}
/** https://discord.com/developers/docs/events/webhook-events#message-object */
/** https://docs.discord.com/developers/events/webhook-events#message-object */
export interface DiscordSocialSDKMessage extends DiscordMessage {
/** ID of the lobby where the message was created (only present in Linked Channel messages) */
lobby_id?: string;
@@ -167,7 +167,7 @@ export interface DiscordSocialSDKMessage extends DiscordMessage {
channel: DiscordChannel;
}
/** https://discord.com/developers/docs/events/webhook-events#passthrough-message-object-passthrough-message-structure */
/** https://docs.discord.com/developers/events/webhook-events#passthrough-message-object-passthrough-message-structure */
export interface DiscordSocialSDKPassthroughMessage {
/** ID of the message */
id: string;

4
packages/types/src/discordeno/application.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/application */
/** Types for: https://docs.discord.com/developers/resources/application */
import type {
ApplicationFlags,
@@ -8,7 +8,7 @@ import type {
} from '../discord/application.js';
import type { DiscordWebhookEventType } from '../discord/webhookEvents.js';
/** https://discord.com/developers/docs/resources/application#edit-current-application-json-params */
/** https://docs.discord.com/developers/resources/application#edit-current-application-json-params */
export interface EditApplication {
/** Default custom authorization URL for the app, if enabled */
customInstallUrl?: string;

4
packages/types/src/discordeno/auditLog.ts
View File

@@ -1,9 +1,9 @@
/** Types for: https://discord.com/developers/docs/resources/audit-log */
/** Types for: https://docs.discord.com/developers/resources/audit-log */
import type { AuditLogEvents } from '../discord/auditLog.js';
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log-query-string-params */
/** https://docs.discord.com/developers/resources/audit-log#get-guild-audit-log-query-string-params */
export interface GetGuildAuditLog {
/** Entries from a specific user ID */
userId?: BigString;

10
packages/types/src/discordeno/autoModeration.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/auto-moderation */
/** Types for: https://docs.discord.com/developers/resources/auto-moderation */
import type {
AutoModerationActionType,
@@ -9,7 +9,7 @@ import type {
import type { BigString, Camelize } from '../shared.js';
// This needs the prefix Discordeno to avoid conflicts with the @discordeno/bot types.
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-auto-moderation-action-structure */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-action-object-auto-moderation-action-structure */
export interface DiscordenoAutoModerationAction {
/** The type of action to take when a rule is triggered */
type: AutoModerationActionType;
@@ -23,7 +23,7 @@ export interface DiscordenoAutoModerationAction {
}
// This needs the prefix Discordeno to avoid conflicts with the @discordeno/bot types.
/** https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata */
/** https://docs.discord.com/developers/resources/auto-moderation#auto-moderation-action-object-action-metadata */
export interface DiscordenoAutoModerationActionMetadata {
/**
* The id of channel to which user content should be logged.
@@ -54,7 +54,7 @@ export interface DiscordenoAutoModerationActionMetadata {
customMessage?: string;
}
/** https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule-json-params */
/** https://docs.discord.com/developers/resources/auto-moderation#create-auto-moderation-rule-json-params */
export interface CreateAutoModerationRuleOptions {
/** The name of the rule. */
name: string;
@@ -74,7 +74,7 @@ export interface CreateAutoModerationRuleOptions {
exemptChannels?: BigString[];
}
/** https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule-json-params */
/** https://docs.discord.com/developers/resources/auto-moderation#modify-auto-moderation-rule-json-params */
export interface EditAutoModerationRuleOptions {
/** The name of the rule. */
name?: string;

40
packages/types/src/discordeno/channel.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/channel */
/** Types for: https://docs.discord.com/developers/resources/channel */
import type { ChannelFlags, ChannelTypes, ForumLayout, OverwriteTypes, SortOrderTypes, VideoQualityModes } from '../discord/channel.js';
import type { TargetTypes } from '../discord/invite.js';
@@ -8,7 +8,7 @@ import type { MessageComponents } from './components.js';
import type { AllowedMentions } from './message.js';
import type { FileContent } from './reference.js';
/** https://discord.com/developers/docs/resources/channel#overwrite-object-overwrite-structure */
/** https://docs.discord.com/developers/resources/channel#overwrite-object-overwrite-structure */
export interface Overwrite {
/** Role or user id */
id: BigString;
@@ -16,7 +16,7 @@ export interface Overwrite {
type: OverwriteTypes;
// NOTE:
// - Discord says that these are always present, we keep them as optional (and allow for null) because when it is sent it can be null / not present, https://discord.com/developers/docs/resources/guild#create-guild-channel-json-params, specificly the **
// - Discord says that these are always present, we keep them as optional (and allow for null) because when it is sent it can be null / not present, https://docs.discord.com/developers/resources/guild#create-guild-channel-json-params, specificly the **
/** Permission bit set */
allow?: BigString | null;
/** Permission bit set */
@@ -24,7 +24,7 @@ export interface Overwrite {
}
// This needs the prefix Discordeno to avoid conflicts with the @discordeno/bot types.
/** https://discord.com/developers/docs/resources/channel#default-reaction-object-default-reaction-structure */
/** https://docs.discord.com/developers/resources/channel#default-reaction-object-default-reaction-structure */
export interface DiscordenoDefaultReactionEmoji {
/** The id of a guild's custom emoji */
emoji_id: BigString | null;
@@ -33,7 +33,7 @@ export interface DiscordenoDefaultReactionEmoji {
}
// This needs the prefix Discordeno to avoid conflicts with the @discordeno/bot types.
/** https://discord.com/developers/docs/resources/channel#forum-tag-object-forum-tag-structure */
/** https://docs.discord.com/developers/resources/channel#forum-tag-object-forum-tag-structure */
export interface DiscordenoForumTag {
/** The id of the tag */
id: string;
@@ -49,9 +49,9 @@ export interface DiscordenoForumTag {
// Since this is a merge of 3 types, the properties appear in order of their first appearance in the 3 types
/**
* - https://discord.com/developers/docs/resources/channel#modify-channel-json-params-group-dm
* - https://discord.com/developers/docs/resources/channel#modify-channel-json-params-guild-channel
* - https://discord.com/developers/docs/resources/channel#modify-channel-json-params-thread
* - https://docs.discord.com/developers/resources/channel#modify-channel-json-params-group-dm
* - https://docs.discord.com/developers/resources/channel#modify-channel-json-params-guild-channel
* - https://docs.discord.com/developers/resources/channel#modify-channel-json-params-thread
*/
export interface ModifyChannel {
// Group DM
@@ -269,7 +269,7 @@ export interface ModifyChannel {
appliedTags?: BigString[];
}
/** https://discord.com/developers/docs/resources/channel#edit-channel-permissions-json-params */
/** https://docs.discord.com/developers/resources/channel#edit-channel-permissions-json-params */
export interface EditChannelPermissionOverridesOptions {
// This is included in here however it is a route parameter
/** Role or user id */
@@ -284,7 +284,7 @@ export interface EditChannelPermissionOverridesOptions {
deny?: string | null;
}
/** https://discord.com/developers/docs/resources/channel#create-channel-invite-json-params */
/** https://docs.discord.com/developers/resources/channel#create-channel-invite-json-params */
export interface CreateChannelInvite {
/** Duration of invite in seconds before expiry, or 0 for never. Between 0 and 604800 (7 days). Default: 86400 (24 hours) */
maxAge?: number;
@@ -318,7 +318,7 @@ export interface CreateChannelInvite {
roleIds?: BigString[];
}
/** https://discord.com/developers/docs/resources/channel#group-dm-add-recipient-json-params */
/** https://docs.discord.com/developers/resources/channel#group-dm-add-recipient-json-params */
export interface AddDmRecipientOptions {
/** access token of a user that has granted your app the `gdm.join` scope */
accessToken: string;
@@ -326,7 +326,7 @@ export interface AddDmRecipientOptions {
nick: string;
}
/** https://discord.com/developers/docs/resources/channel#start-thread-from-message-json-params */
/** https://docs.discord.com/developers/resources/channel#start-thread-from-message-json-params */
export interface StartThreadWithMessage {
/** 1-100 character thread name */
name: string;
@@ -336,7 +336,7 @@ export interface StartThreadWithMessage {
rateLimitPerUser?: number | null;
}
/** https://discord.com/developers/docs/resources/channel#start-thread-without-message-json-params */
/** https://docs.discord.com/developers/resources/channel#start-thread-without-message-json-params */
export interface StartThreadWithoutMessage {
/** 1-100 character thread name */
name: string;
@@ -350,7 +350,7 @@ export interface StartThreadWithoutMessage {
rateLimitPerUser?: number | null;
}
/** https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel-jsonform-params*/
/** https://docs.discord.com/developers/resources/channel#start-thread-in-forum-or-media-channel-jsonform-params*/
export interface CreateForumPostWithMessage {
/** 1-100 character thread name */
name: string;
@@ -366,7 +366,7 @@ export interface CreateForumPostWithMessage {
files?: FileContent[];
}
/** https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel-forum-and-media-thread-message-params-object */
/** https://docs.discord.com/developers/resources/channel#start-thread-in-forum-or-media-channel-forum-and-media-thread-message-params-object */
export interface ForumAndMediaThreadMessage {
/** The message contents (up to 2000 characters) */
content?: string;
@@ -388,13 +388,13 @@ export interface ForumAndMediaThreadMessage {
flags?: number;
}
/** https://discord.com/developers/docs/resources/channel#get-thread-member-query-string-params */
/** https://docs.discord.com/developers/resources/channel#get-thread-member-query-string-params */
export interface GetThreadMember {
/** Whether to include a guild member object for the thread member */
withMember?: boolean;
}
/** https://discord.com/developers/docs/resources/channel#list-thread-members-query-string-params */
/** https://docs.discord.com/developers/resources/channel#list-thread-members-query-string-params */
export interface ListThreadMembers {
/** Whether to include a guild member object for the thread member */
withMember?: boolean;
@@ -405,9 +405,9 @@ export interface ListThreadMembers {
}
/**
* - https://discord.com/developers/docs/resources/channel#list-public-archived-threads-query-string-params
* - https://discord.com/developers/docs/resources/channel#list-private-archived-threads-query-string-params
* - https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads-query-string-params
* - https://docs.discord.com/developers/resources/channel#list-public-archived-threads-query-string-params
* - https://docs.discord.com/developers/resources/channel#list-private-archived-threads-query-string-params
* - https://docs.discord.com/developers/resources/channel#list-joined-private-archived-threads-query-string-params
*/
export interface ListArchivedThreads {
/** Returns threads before this timestamp */

42
packages/types/src/discordeno/components.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/components/reference */
/** Types for: https://docs.discord.com/developers/components/reference */
import type { ChannelTypes } from '../discord/channel.js';
import type {
@@ -31,7 +31,7 @@ export type MessageComponent =
| LabelComponent
| FileUploadComponent;
/** https://discord.com/developers/docs/components/reference#anatomy-of-a-component */
/** https://docs.discord.com/developers/components/reference#anatomy-of-a-component */
export interface BaseComponent {
/** The type of the component */
type: MessageComponentTypes;
@@ -39,7 +39,7 @@ export interface BaseComponent {
id?: number;
}
/** https://discord.com/developers/docs/components/reference#action-row-action-row-structure */
/** https://docs.discord.com/developers/components/reference#action-row-action-row-structure */
export interface ActionRow extends BaseComponent {
type: MessageComponentTypes.ActionRow;
@@ -63,7 +63,7 @@ export interface ActionRow extends BaseComponent {
)[];
}
/** https://discord.com/developers/docs/components/reference#button-button-structure */
/** https://docs.discord.com/developers/components/reference#button-button-structure */
export interface ButtonComponent extends BaseComponent {
type: MessageComponentTypes.Button;
@@ -97,7 +97,7 @@ export interface ButtonComponent extends BaseComponent {
disabled?: boolean;
}
/** https://discord.com/developers/docs/components/reference#string-select-string-select-structure */
/** https://docs.discord.com/developers/components/reference#string-select-string-select-structure */
export interface StringSelectComponent extends BaseComponent {
type: MessageComponentTypes.StringSelect;
@@ -131,7 +131,7 @@ export interface StringSelectComponent extends BaseComponent {
disabled?: boolean;
}
/** https://discord.com/developers/docs/components/reference#string-select-select-option-structure */
/** https://docs.discord.com/developers/components/reference#string-select-select-option-structure */
export interface SelectOption {
/** The user-facing name of the option. Maximum 25 characters. */
label: string;
@@ -153,7 +153,7 @@ export interface SelectOption {
default?: boolean;
}
/** https://discord.com/developers/docs/components/reference#text-input-text-input-structure */
/** https://docs.discord.com/developers/components/reference#text-input-text-input-structure */
export interface TextInputComponent extends BaseComponent {
type: MessageComponentTypes.TextInput;
@@ -182,7 +182,7 @@ export interface TextInputComponent extends BaseComponent {
placeholder?: string;
}
/** https://discord.com/developers/docs/components/reference#user-select-user-select-structure */
/** https://docs.discord.com/developers/components/reference#user-select-user-select-structure */
export interface UserSelectComponent extends BaseComponent {
type: MessageComponentTypes.UserSelect;
@@ -219,7 +219,7 @@ export interface UserSelectComponent extends BaseComponent {
disabled?: boolean;
}
/** https://discord.com/developers/docs/components/reference#user-select-select-default-value-structure */
/** https://docs.discord.com/developers/components/reference#user-select-select-default-value-structure */
export interface SelectMenuDefaultValue {
/** ID of a user, role, or channel */
id: BigString;
@@ -227,7 +227,7 @@ export interface SelectMenuDefaultValue {
type: 'user' | 'role' | 'channel';
}
/** https://discord.com/developers/docs/components/reference#role-select-role-select-structure */
/** https://docs.discord.com/developers/components/reference#role-select-role-select-structure */
export interface RoleSelectComponent extends BaseComponent {
type: MessageComponentTypes.RoleSelect;
@@ -264,7 +264,7 @@ export interface RoleSelectComponent extends BaseComponent {
disabled?: boolean;
}
/** https://discord.com/developers/docs/components/reference#mentionable-select-mentionable-select-structure */
/** https://docs.discord.com/developers/components/reference#mentionable-select-mentionable-select-structure */
export interface MentionableSelectComponent extends BaseComponent {
type: MessageComponentTypes.MentionableSelect;
@@ -301,7 +301,7 @@ export interface MentionableSelectComponent extends BaseComponent {
disabled?: boolean;
}
/** https://discord.com/developers/docs/components/reference#channel-select-channel-select-structure */
/** https://docs.discord.com/developers/components/reference#channel-select-channel-select-structure */
export interface ChannelSelectComponent extends BaseComponent {
type: MessageComponentTypes.ChannelSelect;
@@ -340,7 +340,7 @@ export interface ChannelSelectComponent extends BaseComponent {
disabled?: boolean;
}
/** https://discord.com/developers/docs/components/reference#section-section-structure */
/** https://docs.discord.com/developers/components/reference#section-section-structure */
export interface SectionComponent extends BaseComponent {
type: MessageComponentTypes.Section;
@@ -350,7 +350,7 @@ export interface SectionComponent extends BaseComponent {
accessory: ButtonComponent | ThumbnailComponent;
}
/** https://discord.com/developers/docs/components/reference#text-display */
/** https://docs.discord.com/developers/components/reference#text-display */
export interface TextDisplayComponent extends BaseComponent {
type: MessageComponentTypes.TextDisplay;
@@ -358,7 +358,7 @@ export interface TextDisplayComponent extends BaseComponent {
content: string;
}
/** https://discord.com/developers/docs/components/reference#thumbnail */
/** https://docs.discord.com/developers/components/reference#thumbnail */
export interface ThumbnailComponent extends BaseComponent {
type: MessageComponentTypes.Thumbnail;
@@ -370,7 +370,7 @@ export interface ThumbnailComponent extends BaseComponent {
spoiler?: boolean;
}
/** https://discord.com/developers/docs/components/reference#media-gallery */
/** https://docs.discord.com/developers/components/reference#media-gallery */
export interface MediaGalleryComponent extends BaseComponent {
type: MessageComponentTypes.MediaGallery;
@@ -378,7 +378,7 @@ export interface MediaGalleryComponent extends BaseComponent {
items: DiscordMediaGalleryItem[];
}
/** https://discord.com/developers/docs/components/reference#file */
/** https://docs.discord.com/developers/components/reference#file */
export interface FileComponent extends BaseComponent {
type: MessageComponentTypes.File;
@@ -392,7 +392,7 @@ export interface FileComponent extends BaseComponent {
size: number;
}
/** https://discord.com/developers/docs/components/reference#separator */
/** https://docs.discord.com/developers/components/reference#separator */
export interface SeparatorComponent extends BaseComponent {
type: MessageComponentTypes.Separator;
@@ -402,7 +402,7 @@ export interface SeparatorComponent extends BaseComponent {
spacing?: SeparatorSpacingSize;
}
/** https://discord.com/developers/docs/components/reference#container */
/** https://docs.discord.com/developers/components/reference#container */
export interface ContainerComponent extends BaseComponent {
type: MessageComponentTypes.Container;
@@ -414,7 +414,7 @@ export interface ContainerComponent extends BaseComponent {
spoiler?: boolean;
}
/** https://discord.com/developers/docs/components/reference#label-label-structure */
/** https://docs.discord.com/developers/components/reference#label-label-structure */
export interface LabelComponent extends BaseComponent {
type: MessageComponentTypes.Label;
@@ -443,7 +443,7 @@ export interface LabelComponent extends BaseComponent {
| FileUploadComponent;
}
/** https://discord.com/developers/docs/components/reference#file-upload-file-upload-structure */
/** https://docs.discord.com/developers/components/reference#file-upload-file-upload-structure */
export interface FileUploadComponent extends BaseComponent {
type: MessageComponentTypes.FileUpload;

10
packages/types/src/discordeno/emoji.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/emoji */
/** Types for: https://docs.discord.com/developers/resources/emoji */
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/emoji#create-guild-emoji */
/** https://docs.discord.com/developers/resources/emoji#create-guild-emoji */
export interface CreateGuildEmoji {
/** Name of the emoji */
name: string;
@@ -12,7 +12,7 @@ export interface CreateGuildEmoji {
roles: BigString[];
}
/** https://discord.com/developers/docs/resources/emoji#modify-guild-emoji */
/** https://docs.discord.com/developers/resources/emoji#modify-guild-emoji */
export interface ModifyGuildEmoji {
/** Name of the emoji */
name?: string;
@@ -20,7 +20,7 @@ export interface ModifyGuildEmoji {
roles?: BigString[] | null;
}
/** https://discord.com/developers/docs/resources/emoji#create-application-emoji */
/** https://docs.discord.com/developers/resources/emoji#create-application-emoji */
export interface CreateApplicationEmoji {
/** Name of the emoji */
name: string;
@@ -28,7 +28,7 @@ export interface CreateApplicationEmoji {
image: string;
}
/** https://discord.com/developers/docs/resources/emoji#modify-application-emoji */
/** https://docs.discord.com/developers/resources/emoji#modify-application-emoji */
export interface ModifyApplicationEmoji {
/** Name of the emoji */
name: string;

8
packages/types/src/discordeno/entitlement.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/entitlement */
/** Types for: https://docs.discord.com/developers/resources/entitlement */
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/entitlement#list-entitlements-query-string-params */
/** https://docs.discord.com/developers/resources/entitlement#list-entitlements-query-string-params */
export interface GetEntitlements {
/** User ID to look up entitlements for */
userId?: BigString;
@@ -22,7 +22,7 @@ export interface GetEntitlements {
excludeDeleted?: boolean;
}
/** https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement-json-params */
/** https://docs.discord.com/developers/monetization/entitlements#create-test-entitlement-json-params */
export interface CreateTestEntitlement {
/** ID of the SKU to grant the entitlement to */
skuId: BigString;
@@ -32,7 +32,7 @@ export interface CreateTestEntitlement {
ownerType: CreateEntitlementOwnerType;
}
/** https://discord.com/developers/docs/monetization/entitlements#create-test-entitlement-json-params - Description of ownerType */
/** https://docs.discord.com/developers/monetization/entitlements#create-test-entitlement-json-params - Description of ownerType */
export enum CreateEntitlementOwnerType {
/** Guild subscription */
GuildSubscription = 1,

6
packages/types/src/discordeno/gateway.ts
View File

@@ -1,12 +1,12 @@
/**
* Types for:
* - https://discord.com/developers/docs/events/gateway
* - https://discord.com/developers/docs/events/gateway-events
* - https://docs.discord.com/developers/events/gateway
* - https://docs.discord.com/developers/events/gateway-events
*/
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/events/gateway-events#request-guild-members */
/** https://docs.discord.com/developers/events/gateway-events#request-guild-members */
export interface RequestGuildMembers {
/** id of the guild to get members for */
guildId: BigString;

42
packages/types/src/discordeno/guild.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/guild */
/** Types for: https://docs.discord.com/developers/resources/guild */
import type { ChannelTypes, ForumLayout, SortOrderTypes, VideoQualityModes } from '../discord/channel.js';
import type {
@@ -16,7 +16,7 @@ import type { BigString, Camelize } from '../shared.js';
import type { DiscordenoDefaultReactionEmoji, DiscordenoForumTag, Overwrite } from './channel.js';
import type { GuildRoleColors } from './permissions.js';
/** https://discord.com/developers/docs/resources/guild#modify-guild-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-guild-json-params */
export interface ModifyGuild {
/** Guild name */
name?: string;
@@ -62,7 +62,7 @@ export interface ModifyGuild {
safetyAlertsChannelId?: BigString | null;
}
/** https://discord.com/developers/docs/resources/guild#create-guild-channel-json-params */
/** https://docs.discord.com/developers/resources/guild#create-guild-channel-json-params */
export interface CreateGuildChannel {
/** Channel name (1-100 characters) */
name: string;
@@ -102,7 +102,7 @@ export interface CreateGuildChannel {
defaultThreadRateLimitPerUser?: number;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-guild-channel-positions-json-params */
export interface ModifyGuildChannelPositions {
/** Channel id */
id: BigString;
@@ -114,7 +114,7 @@ export interface ModifyGuildChannelPositions {
parentId?: BigString | null;
}
/** https://discord.com/developers/docs/resources/guild#list-guild-members-query-string-params */
/** https://docs.discord.com/developers/resources/guild#list-guild-members-query-string-params */
export interface ListGuildMembers {
/** Max number of members to return (1-1000). Default: 1 */
limit?: number;
@@ -122,7 +122,7 @@ export interface ListGuildMembers {
after?: string;
}
/** https://discord.com/developers/docs/resources/guild#search-guild-members-query-string-params */
/** https://docs.discord.com/developers/resources/guild#search-guild-members-query-string-params */
export interface SearchMembers {
/** Query string to match username(s) and nickname(s) against */
query: string;
@@ -130,7 +130,7 @@ export interface SearchMembers {
limit?: number;
}
/** https://discord.com/developers/docs/resources/guild#add-guild-member-json-params */
/** https://docs.discord.com/developers/resources/guild#add-guild-member-json-params */
export interface AddGuildMemberOptions {
/** access token of a user that has granted your app the `guilds.join` scope */
accessToken: string;
@@ -144,7 +144,7 @@ export interface AddGuildMemberOptions {
deaf?: boolean;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-member-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-guild-member-json-params */
export interface ModifyGuildMember {
/** Value to set users nickname to. Requires the `MANAGE_NICKNAMES` permission */
nick?: string | null;
@@ -166,7 +166,7 @@ export interface ModifyGuildMember {
flags?: number;
}
/** https://discord.com/developers/docs/resources/guild#modify-current-member-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-current-member-json-params */
export interface EditBotMemberOptions {
/** Value to set user's nickname to */
nick?: string | null;
@@ -178,7 +178,7 @@ export interface EditBotMemberOptions {
bio?: string | null;
}
/** https://discord.com/developers/docs/resources/guild#get-guild-bans-query-string-params */
/** https://docs.discord.com/developers/resources/guild#get-guild-bans-query-string-params */
export interface GetBans {
/** Number of users to return (up to maximum 1000). Default: 1000 */
limit?: number;
@@ -188,7 +188,7 @@ export interface GetBans {
after?: BigString;
}
/** https://discord.com/developers/docs/resources/guild#create-guild-ban-json-params */
/** https://docs.discord.com/developers/resources/guild#create-guild-ban-json-params */
export interface CreateGuildBan {
/**
* Number of seconds to delete messages for, between 0 and 604800 (7 days)
@@ -198,7 +198,7 @@ export interface CreateGuildBan {
deleteMessageSeconds?: number;
}
/** https://discord.com/developers/docs/resources/guild#bulk-guild-ban-json-params */
/** https://docs.discord.com/developers/resources/guild#bulk-guild-ban-json-params */
export interface CreateGuildBulkBan {
/** list of user ids to ban (max 200) */
userIds: BigString[];
@@ -210,7 +210,7 @@ export interface CreateGuildBulkBan {
deleteMessageSeconds?: number;
}
/** https://discord.com/developers/docs/resources/guild#create-guild-role-json-params */
/** https://docs.discord.com/developers/resources/guild#create-guild-role-json-params */
export interface CreateGuildRole {
/** Name of the role, max 100 characters, default: "new role" */
name?: string;
@@ -233,7 +233,7 @@ export interface CreateGuildRole {
mentionable?: boolean;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-role-positions-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-guild-role-positions-json-params */
export interface ModifyRolePositions {
/** The role id */
id: BigString;
@@ -241,7 +241,7 @@ export interface ModifyRolePositions {
position?: number | null;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-role-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-guild-role-json-params */
export interface EditGuildRole {
/** Name of the role, max 100 characters, default: "new role" */
name?: string | null;
@@ -264,7 +264,7 @@ export interface EditGuildRole {
mentionable?: boolean | null;
}
/** https://discord.com/developers/docs/resources/guild#get-guild-prune-count */
/** https://docs.discord.com/developers/resources/guild#get-guild-prune-count */
export interface GetGuildPruneCountQuery {
/** Number of days to count prune for (1 or more), default: 7 */
days?: number;
@@ -272,7 +272,7 @@ export interface GetGuildPruneCountQuery {
includeRoles?: string | string[];
}
/** https://discord.com/developers/docs/resources/guild#begin-guild-prune */
/** https://docs.discord.com/developers/resources/guild#begin-guild-prune */
export interface BeginGuildPrune {
/** Number of days to prune (1 or more), default: 7 */
days?: number;
@@ -282,7 +282,7 @@ export interface BeginGuildPrune {
includeRoles?: string[];
}
/** https://discord.com/developers/docs/resources/guild#get-guild-widget-image-query-string-params */
/** https://docs.discord.com/developers/resources/guild#get-guild-widget-image-query-string-params */
export interface GetGuildWidgetImageQuery {
/**
* Style of the widget returned, default: shield
@@ -296,7 +296,7 @@ export interface GetGuildWidgetImageQuery {
style?: 'shield' | 'banner1' | 'banner2' | 'banner3' | 'banner4';
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-onboarding-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-guild-onboarding-json-params */
export interface EditGuildOnboarding {
/** Prompts shown during onboarding and in customize community */
prompts?: Camelize<DiscordGuildOnboardingPrompt>[];
@@ -308,7 +308,7 @@ export interface EditGuildOnboarding {
mode?: DiscordGuildOnboardingMode;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-incident-actions-json-params */
/** https://docs.discord.com/developers/resources/guild#modify-guild-incident-actions-json-params */
export interface ModifyGuildIncidentActions {
/**
* When invites will be enabled again
@@ -332,7 +332,7 @@ export interface ModifyGuildIncidentActions {
dmsDisabledUntil?: string | null;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen */
/** https://docs.discord.com/developers/resources/guild#modify-guild-welcome-screen */
export interface ModifyGuildWelcomeScreen {
/** Whether the welcome screen is enabled */
enabled?: boolean | null;

8
packages/types/src/discordeno/guildScheduledEvent.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/guild-scheduled-event */
/** Types for: https://docs.discord.com/developers/resources/guild-scheduled-event */
import type {
DiscordScheduledEventEntityMetadata,
@@ -9,13 +9,13 @@ import type {
} from '../discord/guildScheduledEvent.js';
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild-query-string-params */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#list-scheduled-events-for-guild-query-string-params */
export interface GetScheduledEvents {
/** include number of users subscribed to each event */
withUserCount?: boolean;
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event-json-params */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#create-guild-scheduled-event-json-params */
export interface CreateScheduledEvent {
/** the channel id of the scheduled event. */
channelId?: BigString;
@@ -38,7 +38,7 @@ export interface CreateScheduledEvent {
recurrenceRule?: DiscordScheduledEventRecurrenceRule;
}
/** https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params */
/** https://docs.discord.com/developers/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params */
export interface EditScheduledEvent {
/** the channel id of the scheduled event. null if switching to external event. */
channelId?: BigString | null;

6
packages/types/src/discordeno/guildTemplate.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/resources/guild-template */
/** Types for: https://docs.discord.com/developers/resources/guild-template */
/** https://discord.com/developers/docs/resources/guild-template#create-guild-template-json-params */
/** https://docs.discord.com/developers/resources/guild-template#create-guild-template-json-params */
export interface CreateTemplate {
/** Name which the template should have */
name: string;
@@ -8,7 +8,7 @@ export interface CreateTemplate {
description?: string | null;
}
/** https://discord.com/developers/docs/resources/guild-template#modify-guild-template-json-params */
/** https://docs.discord.com/developers/resources/guild-template#modify-guild-template-json-params */
export interface ModifyGuildTemplate {
/** Name of the template (1-100 characters) */
name?: string;

38
packages/types/src/discordeno/interactions.ts
View File

@@ -1,7 +1,7 @@
/**
* Types for:
* - https://discord.com/developers/docs/interactions/receiving-and-responding
* - https://discord.com/developers/docs/interactions/application-commands
* - https://docs.discord.com/developers/interactions/receiving-and-responding
* - https://docs.discord.com/developers/interactions/application-commands
*/
import type { DiscordApplicationIntegrationType } from '../discord/application.js';
@@ -21,7 +21,7 @@ import type { AllowedMentions } from './message.js';
import type { CreatePoll } from './poll.js';
import type { FileContent } from './reference.js';
/** https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-interaction-response-structure */
/** https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-response-object-interaction-response-structure */
export interface InteractionResponse {
/** The type of response */
type: InteractionResponseTypes;
@@ -31,9 +31,9 @@ export interface InteractionResponse {
// Since this is a merge of 3 types, the properties appear in order of their first appearance in the 3 types
/**
* - https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-messages
* - https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-autocomplete
* - https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-response-object-modal
* - https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-response-object-messages
* - https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-response-object-autocomplete
* - https://docs.discord.com/developers/interactions/receiving-and-responding#interaction-response-object-modal
*/
export interface InteractionCallbackData {
// Messages
@@ -72,14 +72,14 @@ export interface InteractionCallbackData {
}
/**
* - https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response-query-string-params
* - https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command-json-params
* - https://docs.discord.com/developers/interactions/receiving-and-responding#create-interaction-response-query-string-params
* - https://docs.discord.com/developers/interactions/application-commands#create-guild-application-command-json-params
*/
export interface InteractionCallbackOptions {
withResponse?: boolean;
}
/** https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands-query-string-params */
/** https://docs.discord.com/developers/interactions/application-commands#get-global-application-commands-query-string-params */
export interface GetGlobalApplicationCommandsOptions {
/**
* Whether to include full localization dictionaries (`nameLocalizations` and `descriptionLocalizations`) in the returned objects, instead of the `nameLocalized` and `descriptionLocalized` fields.
@@ -91,7 +91,7 @@ export interface GetGlobalApplicationCommandsOptions {
/**
* Documented implicitly by the description of the `applications.commands.update` Oauth2 scope
*
* @see {@link https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes}
* @see {@link https://docs.discord.com/developers/topics/oauth2#shared-resources-oauth2-scopes}
*/
export interface CreateGlobalApplicationCommandOptions {
/** The bearer token of the developer of the application */
@@ -99,8 +99,8 @@ export interface CreateGlobalApplicationCommandOptions {
}
/**
* - https://discord.com/developers/docs/interactions/application-commands#create-global-application-command-json-params
* - https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command-json-params
* - https://docs.discord.com/developers/interactions/application-commands#create-global-application-command-json-params
* - https://docs.discord.com/developers/interactions/application-commands#create-guild-application-command-json-params
*/
export interface CreateApplicationCommand {
/**
@@ -172,7 +172,7 @@ export interface CreateApplicationCommand {
/**
* Documented implicitly by the description of the `applications.commands.update` Oauth2 scope
*
* @see {@link https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes}
* @see {@link https://docs.discord.com/developers/topics/oauth2#shared-resources-oauth2-scopes}
*/
export interface UpsertGlobalApplicationCommandOptions {
/** The bearer token of the developer of the application */
@@ -182,14 +182,14 @@ export interface UpsertGlobalApplicationCommandOptions {
/**
* Documented implicitly by the description of the `applications.commands.update` Oauth2 scope
*
* @see {@link https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes}
* @see {@link https://docs.discord.com/developers/topics/oauth2#shared-resources-oauth2-scopes}
*/
export interface CreateGuildApplicationCommandOptions {
/** The bearer token of the developer of the application */
bearerToken: string;
}
/** https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands-query-string-params */
/** https://docs.discord.com/developers/interactions/application-commands#get-guild-application-commands-query-string-params */
export interface GetGuildApplicationCommandsOptions {
/**
* Whether to include full localization dictionaries (`nameLocalizations` and `descriptionLocalizations`) in the returned objects, instead of the `nameLocalized` and `descriptionLocalized` fields.
@@ -201,7 +201,7 @@ export interface GetGuildApplicationCommandsOptions {
/**
* Documented implicitly by the description of the `applications.commands.update` Oauth2 scope
*
* @see {@link https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes}
* @see {@link https://docs.discord.com/developers/topics/oauth2#shared-resources-oauth2-scopes}
*/
export interface UpsertGuildApplicationCommandOptions {
/** The bearer token of the developer of the application */
@@ -210,12 +210,12 @@ export interface UpsertGuildApplicationCommandOptions {
/**
* Additional properties for:
* - https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions
* - https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions
* - https://docs.discord.com/developers/interactions/application-commands#get-guild-application-command-permissions
* - https://docs.discord.com/developers/interactions/application-commands#edit-application-command-permissions
*
* The access token is documented implicitly by the description of the `applications.commands.update` Oauth2 scope
*
* @see {@link https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes}
* @see {@link https://docs.discord.com/developers/topics/oauth2#shared-resources-oauth2-scopes}
*/
export interface GetApplicationCommandPermissionOptions {
/** Access token of the user. Requires the `applications.commands.permissions.update` scope */

4
packages/types/src/discordeno/invite.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/invite */
/** Types for: https://docs.discord.com/developers/resources/invite */
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/invite#get-invite */
/** https://docs.discord.com/developers/resources/invite#get-invite */
export interface GetInvite {
/** Whether the invite should contain approximate member counts */
withCounts?: boolean;

12
packages/types/src/discordeno/lobby.ts
View File

@@ -1,9 +1,9 @@
/** Types for: https://discord.com/developers/docs/resources/lobby */
/** Types for: https://docs.discord.com/developers/resources/lobby */
import type { DiscordLobbyMemberFlags } from '../discord/lobby.js';
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/lobby#create-lobby */
/** https://docs.discord.com/developers/resources/lobby#create-lobby */
export interface CreateLobby {
/** Optional dictionary of string key/value pairs. The max total length is 1000. */
metadata?: Record<string, string> | null;
@@ -13,7 +13,7 @@ export interface CreateLobby {
idleTimeoutSeconds?: number;
}
/** https://discord.com/developers/docs/resources/lobby#create-lobby */
/** https://docs.discord.com/developers/resources/lobby#create-lobby */
export interface CreateLobbyMember {
/** Discord user id of the user to add to the lobby */
id: BigString;
@@ -27,7 +27,7 @@ export interface CreateLobbyMember {
flags?: number;
}
/** https://discord.com/developers/docs/resources/lobby#add-a-member-to-a-lobby */
/** https://docs.discord.com/developers/resources/lobby#add-a-member-to-a-lobby */
export interface ModifyLobby {
/** Optional dictionary of string key/value pairs. The max total length is 1000. Overwrites any existing metadata. */
metadata?: Record<string, string> | null;
@@ -37,7 +37,7 @@ export interface ModifyLobby {
idleTimeoutSeconds?: number;
}
/** https://discord.com/developers/docs/resources/lobby#add-a-member-to-a-lobby */
/** https://docs.discord.com/developers/resources/lobby#add-a-member-to-a-lobby */
export interface AddLobbyMember {
/** Optional dictionary of string key/value pairs. The max total length is 1000. */
metadata?: Record<string, string> | null;
@@ -45,7 +45,7 @@ export interface AddLobbyMember {
flags?: number;
}
/** https://discord.com/developers/docs/resources/lobby#link-channel-to-lobby */
/** https://docs.discord.com/developers/resources/lobby#link-channel-to-lobby */
export interface LinkChannelToLobby {
/** The id of the channel to link to the lobby. If not provided, will unlink any currently linked channels from the lobby. */
channelId?: BigString;

24
packages/types/src/discordeno/message.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/message */
/** Types for: https://docs.discord.com/developers/resources/message */
import type {
AllowedMentionsTypes,
@@ -14,7 +14,7 @@ import type { CreatePoll } from './poll.js';
import type { FileContent } from './reference.js';
// This needs the prefix Discordeno to avoid conflicts with the @discordeno/bot types.
/** https://discord.com/developers/docs/resources/message#message-reference-structure */
/** https://docs.discord.com/developers/resources/message#message-reference-structure */
export interface DiscordenoMessageReference {
/** Type of reference */
type?: DiscordMessageReferenceType;
@@ -31,7 +31,7 @@ export interface DiscordenoMessageReference {
failIfNotExists?: boolean;
}
/** https://discord.com/developers/docs/resources/message#allowed-mentions-object-default-settings-for-allowed-mentions */
/** https://docs.discord.com/developers/resources/message#allowed-mentions-object-default-settings-for-allowed-mentions */
export interface AllowedMentions {
/** An array of allowed mention types to parse from the content. */
parse?: AllowedMentionsTypes[];
@@ -43,34 +43,34 @@ export interface AllowedMentions {
users?: bigint[];
}
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
/** https://docs.discord.com/developers/resources/channel#get-channel-messages-query-string-params */
export interface GetMessagesLimit {
/** Max number of messages to return (1-100) default 50 */
limit?: number;
}
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
/** https://docs.discord.com/developers/resources/channel#get-channel-messages-query-string-params */
export interface GetMessagesAround extends GetMessagesLimit {
/** Get messages around this message id */
around?: BigString;
}
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
/** https://docs.discord.com/developers/resources/channel#get-channel-messages-query-string-params */
export interface GetMessagesBefore extends GetMessagesLimit {
/** Get messages before this message id */
before?: BigString;
}
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
/** https://docs.discord.com/developers/resources/channel#get-channel-messages-query-string-params */
export interface GetMessagesAfter extends GetMessagesLimit {
/** Get messages after this message id */
after?: BigString;
}
/** https://discord.com/developers/docs/resources/channel#get-channel-messages-query-string-params */
/** https://docs.discord.com/developers/resources/channel#get-channel-messages-query-string-params */
export type GetMessagesOptions = GetMessagesAfter | GetMessagesBefore | GetMessagesAround | GetMessagesLimit;
/** https://discord.com/developers/docs/resources/message#create-message-jsonform-params */
/** https://docs.discord.com/developers/resources/message#create-message-jsonform-params */
export interface CreateMessageOptions {
/** The message contents (up to 2000 characters) */
content?: string;
@@ -107,7 +107,7 @@ export interface CreateMessageOptions {
poll?: CreatePoll;
}
/** https://discord.com/developers/docs/resources/message#get-reactions-query-string-params */
/** https://docs.discord.com/developers/resources/message#get-reactions-query-string-params */
export interface GetReactions {
/** The type of reaction */
type: DiscordReactionType;
@@ -117,7 +117,7 @@ export interface GetReactions {
limit?: number;
}
/** https://discord.com/developers/docs/resources/channel#edit-message-json-params */
/** https://docs.discord.com/developers/resources/channel#edit-message-json-params */
export interface EditMessage {
/** The new message contents (up to 2000 characters) */
content?: string | null;
@@ -142,7 +142,7 @@ export interface EditMessage {
attachments?: Pick<DiscordAttachment, 'filename' | 'description' | 'id'>[];
}
/** https://discord.com/developers/docs/resources/message#get-channel-pins-query-string-params */
/** https://docs.discord.com/developers/resources/message#get-channel-pins-query-string-params */
export interface GetChannelPinsOptions {
/** Get messages pinned before this timestamp */
before?: string;

4
packages/types/src/discordeno/permissions.ts
View File

@@ -1,6 +1,6 @@
/** Types for: https://discord.com/developers/docs/topics/permissions */
/** Types for: https://docs.discord.com/developers/topics/permissions */
/** https://discord.com/developers/docs/topics/permissions#role-object-role-colors-object */
/** https://docs.discord.com/developers/topics/permissions#role-object-role-colors-object */
export interface GuildRoleColors {
/** The primary color for the role */
primaryColor: number;

6
packages/types/src/discordeno/poll.ts
View File

@@ -1,9 +1,9 @@
/** Types for: https://discord.com/developers/docs/resources/poll */
/** Types for: https://docs.discord.com/developers/resources/poll */
import type { DiscordPollAnswer, DiscordPollLayoutType, DiscordPollMedia } from '../discord/poll.js';
import type { BigString, Camelize } from '../shared.js';
/** https://discord.com/developers/docs/resources/poll#poll-create-request-object */
/** https://docs.discord.com/developers/resources/poll#poll-create-request-object */
export interface CreatePoll {
/** The question of the poll. Only `text` is supported. */
question: Pick<Camelize<DiscordPollMedia>, 'text'>;
@@ -28,7 +28,7 @@ export interface CreatePoll {
layoutType?: DiscordPollLayoutType;
}
/** https://discord.com/developers/docs/resources/poll#get-answer-voters-query-string-params */
/** https://docs.discord.com/developers/resources/poll#get-answer-voters-query-string-params */
export interface GetPollAnswerVotes {
/** Get users after this user ID */
after?: BigString;

4
packages/types/src/discordeno/reference.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/reference */
/** Types for: https://docs.discord.com/developers/reference */
/**
* This is not a mapping of any discord documented type, however there is some docs that refer to an object like this:
* https://discord.com/developers/docs/reference#uploading-files, the second paragraph
* https://docs.discord.com/developers/reference#uploading-files, the second paragraph
*
* > All files[n] parameters must include a valid `Content-Disposition` subpart header with a filename and unique name parameter.
*

8
packages/types/src/discordeno/soundboard.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/soundboard */
/** Types for: https://docs.discord.com/developers/resources/soundboard */
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound-json-params */
/** https://docs.discord.com/developers/resources/soundboard#send-soundboard-sound-json-params */
export interface SendSoundboardSound {
/** The id of the soundboard sound to play */
soundId: BigString;
@@ -10,7 +10,7 @@ export interface SendSoundboardSound {
sourceGuildId?: BigString;
}
/** https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound-json-params */
/** https://docs.discord.com/developers/resources/soundboard#create-guild-soundboard-sound-json-params */
export interface CreateGuildSoundboardSound {
/** Name of the soundboard sound (2-32 characters) */
name: string;
@@ -24,7 +24,7 @@ export interface CreateGuildSoundboardSound {
emojiName?: string | null;
}
/** https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound-json-params */
/** https://docs.discord.com/developers/resources/soundboard#modify-guild-soundboard-sound-json-params */
export interface ModifyGuildSoundboardSound {
/** Name of the soundboard sound (2-32 characters) */
name?: string;

6
packages/types/src/discordeno/stageInstance.ts
View File

@@ -1,9 +1,9 @@
/** Types for: https://discord.com/developers/docs/resources/stage-instance */
/** Types for: https://docs.discord.com/developers/resources/stage-instance */
import type { DiscordStageInstancePrivacyLevel } from '../discord/stageInstance.js';
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/stage-instance#create-stage-instance-json-params */
/** https://docs.discord.com/developers/resources/stage-instance#create-stage-instance-json-params */
export interface CreateStageInstance {
/** The id of the Stage channel */
channelId: BigString;
@@ -17,7 +17,7 @@ export interface CreateStageInstance {
guildScheduledEventId?: BigString;
}
/** https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance-json-params */
/** https://docs.discord.com/developers/resources/stage-instance#modify-stage-instance-json-params */
export interface EditStageInstanceOptions {
/** The topic of the Stage instance (1-120 characters) */
topic?: string;

6
packages/types/src/discordeno/sticker.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/sticker */
/** Types for: https://docs.discord.com/developers/resources/sticker */
import type { FileContent } from './reference.js';
/** https://discord.com/developers/docs/resources/sticker#create-guild-sticker-form-params */
/** https://docs.discord.com/developers/resources/sticker#create-guild-sticker-form-params */
export interface CreateGuildStickerOptions {
/** Name of the sticker (2-30 characters) */
name: string;
@@ -14,7 +14,7 @@ export interface CreateGuildStickerOptions {
file: FileContent;
}
/** https://discord.com/developers/docs/resources/sticker#modify-guild-sticker-json-params */
/** https://docs.discord.com/developers/resources/sticker#modify-guild-sticker-json-params */
export interface EditGuildStickerOptions {
/** Name of the sticker (2-30 characters) */
name?: string;

4
packages/types/src/discordeno/subscription.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/subscription */
/** Types for: https://docs.discord.com/developers/resources/subscription */
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/subscription#query-string-params */
/** https://docs.discord.com/developers/resources/subscription#query-string-params */
export interface ListSkuSubscriptionsOptions {
/** List subscriptions before this ID */
before?: BigString;

6
packages/types/src/discordeno/user.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/user */
/** Types for: https://docs.discord.com/developers/resources/user */
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/user#get-current-user-guilds-query-string-params */
/** https://docs.discord.com/developers/resources/user#get-current-user-guilds-query-string-params */
export interface GetUserGuilds {
/** Get guilds before this guild ID */
before?: BigString;
@@ -14,7 +14,7 @@ export interface GetUserGuilds {
withCounts?: boolean;
}
/** https://discord.com/developers/docs/resources/user#create-group-dm-json-params */
/** https://docs.discord.com/developers/resources/user#create-group-dm-json-params */
export interface CreateGroupDmOptions {
/** Access tokens of users that have granted your app the `gdm.join` scope */
accessTokens: string[];

6
packages/types/src/discordeno/voice.ts
View File

@@ -1,8 +1,8 @@
/** Types for: https://discord.com/developers/docs/resources/voice */
/** Types for: https://docs.discord.com/developers/resources/voice */
import type { BigString } from '../shared.js';
/** https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state-json-params */
/** https://docs.discord.com/developers/resources/voice#modify-current-user-voice-state-json-params */
export interface EditOwnVoiceState {
/** The id of the channel the user is currently in */
channelId?: BigString;
@@ -12,7 +12,7 @@ export interface EditOwnVoiceState {
requestToSpeakTimestamp?: number | null;
}
/** https://discord.com/developers/docs/resources/voice#modify-user-voice-state-json-params */
/** https://docs.discord.com/developers/resources/voice#modify-user-voice-state-json-params */
export interface EditUserVoiceState {
/** The id of the channel the user is currently in */
channelId?: BigString;

14
packages/types/src/discordeno/webhook.ts
View File

@@ -1,4 +1,4 @@
/** Types for: https://discord.com/developers/docs/resources/webhook */
/** Types for: https://docs.discord.com/developers/resources/webhook */
import type { DiscordAttachment, DiscordEmbed } from '../discord/message.js';
import type { BigString, Camelize } from '../shared.js';
@@ -7,7 +7,7 @@ import type { AllowedMentions } from './message.js';
import type { CreatePoll } from './poll.js';
import type { FileContent } from './reference.js';
/** https://discord.com/developers/docs/resources/webhook#create-webhook-json-params */
/** https://docs.discord.com/developers/resources/webhook#create-webhook-json-params */
export interface CreateWebhook {
/** Name of the webhook (1-80 characters) */
name: string;
@@ -15,7 +15,7 @@ export interface CreateWebhook {
avatar?: string | null;
}
/** https://discord.com/developers/docs/resources/webhook#modify-webhook-json-params */
/** https://docs.discord.com/developers/resources/webhook#modify-webhook-json-params */
export interface ModifyWebhook {
/** The default name of the webhook */
name?: string;
@@ -25,7 +25,7 @@ export interface ModifyWebhook {
channelId?: BigString;
}
/** https://discord.com/developers/docs/resources/webhook#execute-webhook */
/** https://docs.discord.com/developers/resources/webhook#execute-webhook */
export interface ExecuteWebhook {
// Query Parameters
@@ -81,13 +81,13 @@ export interface ExecuteWebhook {
poll?: CreatePoll;
}
/** https://discord.com/developers/docs/resources/webhook#get-webhook-message-query-string-params */
/** https://docs.discord.com/developers/resources/webhook#get-webhook-message-query-string-params */
export interface GetWebhookMessageOptions {
/** id of the thread the message is in */
threadId: BigString;
}
/** https://discord.com/developers/docs/resources/webhook#edit-webhook-message */
/** https://docs.discord.com/developers/resources/webhook#edit-webhook-message */
export interface EditWebhookMessageOptions {
// Query parameters
/** Id of the thread the message is in */
@@ -135,7 +135,7 @@ export interface EditWebhookMessageOptions {
poll?: CreatePoll;
}
/** https://discord.com/developers/docs/resources/webhook#delete-webhook-message-query-string-params */
/** https://docs.discord.com/developers/resources/webhook#delete-webhook-message-query-string-params */
export interface DeleteWebhookMessageOptions {
/** id of the thread the message is in */
threadId: BigString;

12
packages/utils/src/oauth2.ts
View File

@@ -60,7 +60,7 @@ export interface CreateOAuth2LinkOptions {
* The type of response
*
* @remarks
* Should be defined only if using either OAuth2 authorization, implicit or not, or [advanced bot authorization](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization)
* Should be defined only if using either OAuth2 authorization, implicit or not, or [advanced bot authorization](https://docs.discord.com/developers/topics/oauth2#advanced-bot-authorization)
*/
responseType?: 'code' | 'token';
/** The id of the application */
@@ -70,14 +70,14 @@ export interface CreateOAuth2LinkOptions {
/**
* The optional state for security
*
* @see https://discord.com/developers/docs/topics/oauth2#state-and-security
* @see https://docs.discord.com/developers/topics/oauth2#state-and-security
*/
state?: string;
/**
* The redirect uri for after the authentication
*
* @remarks
* Should be defined only if using either OAuth2 authorization, implicit or not, or [advanced bot authorization](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization)
* Should be defined only if using either OAuth2 authorization, implicit or not, or [advanced bot authorization](https://docs.discord.com/developers/topics/oauth2#advanced-bot-authorization)
*/
redirectUri?: string;
/**
@@ -92,21 +92,21 @@ export interface CreateOAuth2LinkOptions {
* The permissions of the invited bot
*
* @remarks
* Should be defined only in a [bot authorization flow](https://discord.com/developers/docs/topics/oauth2#bot-authorization-flow) or with [advanced bot authorization](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization)
* Should be defined only in a [bot authorization flow](https://docs.discord.com/developers/topics/oauth2#bot-authorization-flow) or with [advanced bot authorization](https://docs.discord.com/developers/topics/oauth2#advanced-bot-authorization)
*/
permissions?: BigString | PermissionStrings[];
/**
* Pre-fills the dropdown picker with a guild for the user
*
* @remarks
* Should be defined only in a [bot authorization flow](https://discord.com/developers/docs/topics/oauth2#bot-authorization-flow) or with [advanced bot authorization](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization) or with the `webhook.incoming` scope
* Should be defined only in a [bot authorization flow](https://docs.discord.com/developers/topics/oauth2#bot-authorization-flow) or with [advanced bot authorization](https://docs.discord.com/developers/topics/oauth2#advanced-bot-authorization) or with the `webhook.incoming` scope
*/
guildId?: BigString;
/**
* Disallows the user from changing the guild dropdown if set to true
*
* @remarks
* Should be defined only in a [bot authorization flow](https://discord.com/developers/docs/topics/oauth2#bot-authorization-flow), with [advanced bot authorization](https://discord.com/developers/docs/topics/oauth2#advanced-bot-authorization) or with the `webhook.incoming` scope
* Should be defined only in a [bot authorization flow](https://docs.discord.com/developers/topics/oauth2#bot-authorization-flow), with [advanced bot authorization](https://docs.discord.com/developers/topics/oauth2#advanced-bot-authorization) or with the `webhook.incoming` scope
*/
disableGuildSelect?: boolean;
/**