mirror of
https://github.com/discordjs/discord-api-types.git
synced 2026-06-01 08:20:10 +00:00
feat: add RateLimited gateway event (#1334)
This commit is contained in:
Almeida
69
deno/gateway/v10.ts
generated
69
deno/gateway/v10.ts
generated
@@ -286,6 +286,7 @@ export enum GatewayDispatchEvents {
|
||||
MessageReactionRemoveEmoji = 'MESSAGE_REACTION_REMOVE_EMOJI',
|
||||
MessageUpdate = 'MESSAGE_UPDATE',
|
||||
PresenceUpdate = 'PRESENCE_UPDATE',
|
||||
RateLimited = 'RATE_LIMITED',
|
||||
Ready = 'READY',
|
||||
Resumed = 'RESUMED',
|
||||
StageInstanceCreate = 'STAGE_INSTANCE_CREATE',
|
||||
@@ -374,6 +375,7 @@ export type GatewayDispatchPayload =
|
||||
| GatewayMessageReactionRemoveEmojiDispatch
|
||||
| GatewayMessageUpdateDispatch
|
||||
| GatewayPresenceUpdateDispatch
|
||||
| GatewayRateLimitedDispatch
|
||||
| GatewayReadyDispatch
|
||||
| GatewayResumedDispatch
|
||||
| GatewaySoundboardSoundsDispatch
|
||||
@@ -2217,6 +2219,73 @@ export interface GatewayMessagePollVoteDispatchData {
|
||||
answer_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedDispatch<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> = _DataPayload<GatewayDispatchEvents.RateLimited, GatewayRateLimitedDispatchData<Opcode>>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatch =
|
||||
GatewayRateLimitedDispatch<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export interface GatewayRateLimitedDispatchData<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> {
|
||||
/**
|
||||
* {@link GatewayOpcodes | Gateway opcode} of the event that was rate limited
|
||||
*/
|
||||
opcode: Opcode;
|
||||
/**
|
||||
* The number of seconds to wait before submitting another request
|
||||
*/
|
||||
retry_after: number;
|
||||
/**
|
||||
* Metadata for the event that was rate limited
|
||||
*/
|
||||
meta: GatewayOpcodeRateLimitMetadataMap[Opcode];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatchData =
|
||||
GatewayRateLimitedDispatchData<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* Map of gateway opcodes to their rate limit metadata types
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited-rate-limit-metadata-for-opcode-structure}
|
||||
*/
|
||||
export interface GatewayOpcodeRateLimitMetadataMap {
|
||||
[GatewayOpcodes.RequestGuildMembers]: GatewayRequestGuildMemberRateLimitMetadata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Types of metadata that can be received in a {@link GatewayRateLimitedDispatchData.meta} field
|
||||
*/
|
||||
export type GatewayRateLimitedMetadata = GatewayOpcodeRateLimitMetadataMap[keyof GatewayOpcodeRateLimitMetadataMap];
|
||||
|
||||
/**
|
||||
* Rate limit metadata for the {@link GatewayOpcodes.RequestGuildMembers} opcode
|
||||
*/
|
||||
export interface GatewayRequestGuildMemberRateLimitMetadata {
|
||||
/**
|
||||
* Id of the guild members were requested for
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
/**
|
||||
* Nonce used to identify the {@link GatewayGuildMembersChunkDispatch} response
|
||||
*/
|
||||
nonce?: string;
|
||||
}
|
||||
|
||||
// #endregion Dispatch Payloads
|
||||
|
||||
// #region Sendable Payloads
|
||||
|
||||
69
deno/gateway/v9.ts
generated
69
deno/gateway/v9.ts
generated
@@ -285,6 +285,7 @@ export enum GatewayDispatchEvents {
|
||||
MessageReactionRemoveEmoji = 'MESSAGE_REACTION_REMOVE_EMOJI',
|
||||
MessageUpdate = 'MESSAGE_UPDATE',
|
||||
PresenceUpdate = 'PRESENCE_UPDATE',
|
||||
RateLimited = 'RATE_LIMITED',
|
||||
Ready = 'READY',
|
||||
Resumed = 'RESUMED',
|
||||
StageInstanceCreate = 'STAGE_INSTANCE_CREATE',
|
||||
@@ -373,6 +374,7 @@ export type GatewayDispatchPayload =
|
||||
| GatewayMessageReactionRemoveEmojiDispatch
|
||||
| GatewayMessageUpdateDispatch
|
||||
| GatewayPresenceUpdateDispatch
|
||||
| GatewayRateLimitedDispatch
|
||||
| GatewayReadyDispatch
|
||||
| GatewayResumedDispatch
|
||||
| GatewaySoundboardSoundsDispatch
|
||||
@@ -2216,6 +2218,73 @@ export interface GatewayMessagePollVoteDispatchData {
|
||||
answer_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedDispatch<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> = _DataPayload<GatewayDispatchEvents.RateLimited, GatewayRateLimitedDispatchData<Opcode>>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatch =
|
||||
GatewayRateLimitedDispatch<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export interface GatewayRateLimitedDispatchData<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> {
|
||||
/**
|
||||
* {@link GatewayOpcodes | Gateway opcode} of the event that was rate limited
|
||||
*/
|
||||
opcode: Opcode;
|
||||
/**
|
||||
* The number of seconds to wait before submitting another request
|
||||
*/
|
||||
retry_after: number;
|
||||
/**
|
||||
* Metadata for the event that was rate limited
|
||||
*/
|
||||
meta: GatewayOpcodeRateLimitMetadataMap[Opcode];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatchData =
|
||||
GatewayRateLimitedDispatchData<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* Map of gateway opcodes to their rate limit metadata types
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited-rate-limit-metadata-for-opcode-structure}
|
||||
*/
|
||||
export interface GatewayOpcodeRateLimitMetadataMap {
|
||||
[GatewayOpcodes.RequestGuildMembers]: GatewayRequestGuildMemberRateLimitMetadata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Types of metadata that can be received in a {@link GatewayRateLimitedDispatchData.meta} field
|
||||
*/
|
||||
export type GatewayRateLimitedMetadata = GatewayOpcodeRateLimitMetadataMap[keyof GatewayOpcodeRateLimitMetadataMap];
|
||||
|
||||
/**
|
||||
* Rate limit metadata for the {@link GatewayOpcodes.RequestGuildMembers} opcode
|
||||
*/
|
||||
export interface GatewayRequestGuildMemberRateLimitMetadata {
|
||||
/**
|
||||
* Id of the guild members were requested for
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
/**
|
||||
* Nonce used to identify the {@link GatewayGuildMembersChunkDispatch} response
|
||||
*/
|
||||
nonce?: string;
|
||||
}
|
||||
|
||||
// #endregion Dispatch Payloads
|
||||
|
||||
// #region Sendable Payloads
|
||||
|
||||
@@ -286,6 +286,7 @@ export enum GatewayDispatchEvents {
|
||||
MessageReactionRemoveEmoji = 'MESSAGE_REACTION_REMOVE_EMOJI',
|
||||
MessageUpdate = 'MESSAGE_UPDATE',
|
||||
PresenceUpdate = 'PRESENCE_UPDATE',
|
||||
RateLimited = 'RATE_LIMITED',
|
||||
Ready = 'READY',
|
||||
Resumed = 'RESUMED',
|
||||
StageInstanceCreate = 'STAGE_INSTANCE_CREATE',
|
||||
@@ -374,6 +375,7 @@ export type GatewayDispatchPayload =
|
||||
| GatewayMessageReactionRemoveEmojiDispatch
|
||||
| GatewayMessageUpdateDispatch
|
||||
| GatewayPresenceUpdateDispatch
|
||||
| GatewayRateLimitedDispatch
|
||||
| GatewayReadyDispatch
|
||||
| GatewayResumedDispatch
|
||||
| GatewaySoundboardSoundsDispatch
|
||||
@@ -2217,6 +2219,73 @@ export interface GatewayMessagePollVoteDispatchData {
|
||||
answer_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedDispatch<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> = _DataPayload<GatewayDispatchEvents.RateLimited, GatewayRateLimitedDispatchData<Opcode>>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatch =
|
||||
GatewayRateLimitedDispatch<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export interface GatewayRateLimitedDispatchData<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> {
|
||||
/**
|
||||
* {@link GatewayOpcodes | Gateway opcode} of the event that was rate limited
|
||||
*/
|
||||
opcode: Opcode;
|
||||
/**
|
||||
* The number of seconds to wait before submitting another request
|
||||
*/
|
||||
retry_after: number;
|
||||
/**
|
||||
* Metadata for the event that was rate limited
|
||||
*/
|
||||
meta: GatewayOpcodeRateLimitMetadataMap[Opcode];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatchData =
|
||||
GatewayRateLimitedDispatchData<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* Map of gateway opcodes to their rate limit metadata types
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited-rate-limit-metadata-for-opcode-structure}
|
||||
*/
|
||||
export interface GatewayOpcodeRateLimitMetadataMap {
|
||||
[GatewayOpcodes.RequestGuildMembers]: GatewayRequestGuildMemberRateLimitMetadata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Types of metadata that can be received in a {@link GatewayRateLimitedDispatchData.meta} field
|
||||
*/
|
||||
export type GatewayRateLimitedMetadata = GatewayOpcodeRateLimitMetadataMap[keyof GatewayOpcodeRateLimitMetadataMap];
|
||||
|
||||
/**
|
||||
* Rate limit metadata for the {@link GatewayOpcodes.RequestGuildMembers} opcode
|
||||
*/
|
||||
export interface GatewayRequestGuildMemberRateLimitMetadata {
|
||||
/**
|
||||
* Id of the guild members were requested for
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
/**
|
||||
* Nonce used to identify the {@link GatewayGuildMembersChunkDispatch} response
|
||||
*/
|
||||
nonce?: string;
|
||||
}
|
||||
|
||||
// #endregion Dispatch Payloads
|
||||
|
||||
// #region Sendable Payloads
|
||||
|
||||
@@ -285,6 +285,7 @@ export enum GatewayDispatchEvents {
|
||||
MessageReactionRemoveEmoji = 'MESSAGE_REACTION_REMOVE_EMOJI',
|
||||
MessageUpdate = 'MESSAGE_UPDATE',
|
||||
PresenceUpdate = 'PRESENCE_UPDATE',
|
||||
RateLimited = 'RATE_LIMITED',
|
||||
Ready = 'READY',
|
||||
Resumed = 'RESUMED',
|
||||
StageInstanceCreate = 'STAGE_INSTANCE_CREATE',
|
||||
@@ -373,6 +374,7 @@ export type GatewayDispatchPayload =
|
||||
| GatewayMessageReactionRemoveEmojiDispatch
|
||||
| GatewayMessageUpdateDispatch
|
||||
| GatewayPresenceUpdateDispatch
|
||||
| GatewayRateLimitedDispatch
|
||||
| GatewayReadyDispatch
|
||||
| GatewayResumedDispatch
|
||||
| GatewaySoundboardSoundsDispatch
|
||||
@@ -2216,6 +2218,73 @@ export interface GatewayMessagePollVoteDispatchData {
|
||||
answer_id: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedDispatch<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> = _DataPayload<GatewayDispatchEvents.RateLimited, GatewayRateLimitedDispatchData<Opcode>>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatch =
|
||||
GatewayRateLimitedDispatch<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export interface GatewayRateLimitedDispatchData<
|
||||
Opcode extends keyof GatewayOpcodeRateLimitMetadataMap = keyof GatewayOpcodeRateLimitMetadataMap,
|
||||
> {
|
||||
/**
|
||||
* {@link GatewayOpcodes | Gateway opcode} of the event that was rate limited
|
||||
*/
|
||||
opcode: Opcode;
|
||||
/**
|
||||
* The number of seconds to wait before submitting another request
|
||||
*/
|
||||
retry_after: number;
|
||||
/**
|
||||
* Metadata for the event that was rate limited
|
||||
*/
|
||||
meta: GatewayOpcodeRateLimitMetadataMap[Opcode];
|
||||
}
|
||||
|
||||
/**
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited}
|
||||
*/
|
||||
export type GatewayRateLimitedRequestGuildMembersDispatchData =
|
||||
GatewayRateLimitedDispatchData<GatewayOpcodes.RequestGuildMembers>;
|
||||
|
||||
/**
|
||||
* Map of gateway opcodes to their rate limit metadata types
|
||||
*
|
||||
* @see {@link https://discord.com/developers/docs/events/gateway-events#rate-limited-rate-limit-metadata-for-opcode-structure}
|
||||
*/
|
||||
export interface GatewayOpcodeRateLimitMetadataMap {
|
||||
[GatewayOpcodes.RequestGuildMembers]: GatewayRequestGuildMemberRateLimitMetadata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Types of metadata that can be received in a {@link GatewayRateLimitedDispatchData.meta} field
|
||||
*/
|
||||
export type GatewayRateLimitedMetadata = GatewayOpcodeRateLimitMetadataMap[keyof GatewayOpcodeRateLimitMetadataMap];
|
||||
|
||||
/**
|
||||
* Rate limit metadata for the {@link GatewayOpcodes.RequestGuildMembers} opcode
|
||||
*/
|
||||
export interface GatewayRequestGuildMemberRateLimitMetadata {
|
||||
/**
|
||||
* Id of the guild members were requested for
|
||||
*/
|
||||
guild_id: Snowflake;
|
||||
/**
|
||||
* Nonce used to identify the {@link GatewayGuildMembersChunkDispatch} response
|
||||
*/
|
||||
nonce?: string;
|
||||
}
|
||||
|
||||
// #endregion Dispatch Payloads
|
||||
|
||||
// #region Sendable Payloads
|
||||
|
||||
Reference in New Issue
Block a user