diff --git a/README.md b/README.md index dd299b0e..2272d86f 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ The exports of each API version is split into three main parts: - Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `RESTOAuth2` - If a type ends with `Result`, then it represents the expected result by calling its accompanying route. - - Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors. + - Types for a Result that will be a `204 No Content` will be typed as `undefined`. This does **not** account for errors - Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object). diff --git a/deno/README.md b/deno/README.md index dd299b0e..2272d86f 100644 --- a/deno/README.md +++ b/deno/README.md @@ -88,7 +88,7 @@ The exports of each API version is split into three main parts: - Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `RESTOAuth2` - If a type ends with `Result`, then it represents the expected result by calling its accompanying route. - - Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors. + - Types for a Result that will be a `204 No Content` will be typed as `undefined`. This does **not** account for errors - Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object). diff --git a/deno/gateway/v10.ts b/deno/gateway/v10.ts index b980e445..fbfaf272 100644 --- a/deno/gateway/v10.ts +++ b/deno/gateway/v10.ts @@ -441,7 +441,7 @@ export interface GatewayHelloData { */ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { op: GatewayOpcodes.Heartbeat; - d: never; + d: undefined; } /** @@ -449,7 +449,7 @@ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { */ export interface GatewayHeartbeatAck extends _NonDispatchPayload { op: GatewayOpcodes.HeartbeatAck; - d: never; + d: undefined; } /** @@ -470,7 +470,7 @@ export type GatewayInvalidSessionData = boolean; */ export interface GatewayReconnect extends _NonDispatchPayload { op: GatewayOpcodes.Reconnect; - d: never; + d: undefined; } /** @@ -525,7 +525,7 @@ export interface GatewayReadyDispatchData { /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#resumed} */ -export type GatewayResumedDispatch = _DataPayload; +export type GatewayResumedDispatch = _DataPayload; /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} diff --git a/deno/gateway/v9.ts b/deno/gateway/v9.ts index 5bc55dea..fdea91f6 100644 --- a/deno/gateway/v9.ts +++ b/deno/gateway/v9.ts @@ -440,7 +440,7 @@ export interface GatewayHelloData { */ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { op: GatewayOpcodes.Heartbeat; - d: never; + d: undefined; } /** @@ -448,7 +448,7 @@ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { */ export interface GatewayHeartbeatAck extends _NonDispatchPayload { op: GatewayOpcodes.HeartbeatAck; - d: never; + d: undefined; } /** @@ -469,7 +469,7 @@ export type GatewayInvalidSessionData = boolean; */ export interface GatewayReconnect extends _NonDispatchPayload { op: GatewayOpcodes.Reconnect; - d: never; + d: undefined; } /** @@ -524,7 +524,7 @@ export interface GatewayReadyDispatchData { /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#resumed} */ -export type GatewayResumedDispatch = _DataPayload; +export type GatewayResumedDispatch = _DataPayload; /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} diff --git a/deno/payloads/v10/_interactions/ping.ts b/deno/payloads/v10/_interactions/ping.ts index 3e03a620..676464b0 100644 --- a/deno/payloads/v10/_interactions/ping.ts +++ b/deno/payloads/v10/_interactions/ping.ts @@ -1,4 +1,4 @@ import type { APIBaseInteraction } from './base.ts'; import type { InteractionType } from './responses.ts'; -export type APIPingInteraction = Omit, 'locale'>; +export type APIPingInteraction = Omit, 'locale'>; diff --git a/deno/payloads/v10/invite.ts b/deno/payloads/v10/invite.ts index 3f04e91c..8220755b 100644 --- a/deno/payloads/v10/invite.ts +++ b/deno/payloads/v10/invite.ts @@ -90,7 +90,7 @@ export interface APIInvite { * @deprecated This has been removed from the documentation. * {@link https://github.com/discord/discord-api-docs/pull/7779 | discord-api-docs#7779} */ - stage_instance?: never; + stage_instance?: undefined; /** * The guild scheduled event data, returned from the `GET /invites/` endpoint when `guild_scheduled_event_id` is a valid guild scheduled event id */ diff --git a/deno/payloads/v10/webhook.ts b/deno/payloads/v10/webhook.ts index f9003b15..611b9b77 100644 --- a/deno/payloads/v10/webhook.ts +++ b/deno/payloads/v10/webhook.ts @@ -76,7 +76,7 @@ export interface APIWebhook { */ export type APIWebhookEvent = | APIWebhookEventBase - | APIWebhookEventBase; + | APIWebhookEventBase; /** * @see {@link https://discord.com/developers/docs/events/webhook-events#event-body-object} @@ -127,7 +127,7 @@ export type APIWebhookEventEntitlementDeleteData = APIEntitlement; export type APIWebhookEventEntitlementUpdateData = APIEntitlement; -export type APIWebhookEventQuestUserEnrollmentData = never; +export type APIWebhookEventQuestUserEnrollmentData = undefined; export interface APIWebhookEventBase { /** diff --git a/deno/payloads/v9/_interactions/ping.ts b/deno/payloads/v9/_interactions/ping.ts index 3e03a620..676464b0 100644 --- a/deno/payloads/v9/_interactions/ping.ts +++ b/deno/payloads/v9/_interactions/ping.ts @@ -1,4 +1,4 @@ import type { APIBaseInteraction } from './base.ts'; import type { InteractionType } from './responses.ts'; -export type APIPingInteraction = Omit, 'locale'>; +export type APIPingInteraction = Omit, 'locale'>; diff --git a/deno/payloads/v9/invite.ts b/deno/payloads/v9/invite.ts index 3f04e91c..8220755b 100644 --- a/deno/payloads/v9/invite.ts +++ b/deno/payloads/v9/invite.ts @@ -90,7 +90,7 @@ export interface APIInvite { * @deprecated This has been removed from the documentation. * {@link https://github.com/discord/discord-api-docs/pull/7779 | discord-api-docs#7779} */ - stage_instance?: never; + stage_instance?: undefined; /** * The guild scheduled event data, returned from the `GET /invites/` endpoint when `guild_scheduled_event_id` is a valid guild scheduled event id */ diff --git a/deno/payloads/v9/webhook.ts b/deno/payloads/v9/webhook.ts index f9003b15..611b9b77 100644 --- a/deno/payloads/v9/webhook.ts +++ b/deno/payloads/v9/webhook.ts @@ -76,7 +76,7 @@ export interface APIWebhook { */ export type APIWebhookEvent = | APIWebhookEventBase - | APIWebhookEventBase; + | APIWebhookEventBase; /** * @see {@link https://discord.com/developers/docs/events/webhook-events#event-body-object} @@ -127,7 +127,7 @@ export type APIWebhookEventEntitlementDeleteData = APIEntitlement; export type APIWebhookEventEntitlementUpdateData = APIEntitlement; -export type APIWebhookEventQuestUserEnrollmentData = never; +export type APIWebhookEventQuestUserEnrollmentData = undefined; export interface APIWebhookEventBase { /** diff --git a/deno/rest/v10/autoModeration.ts b/deno/rest/v10/autoModeration.ts index a885f23d..d034d1d2 100644 --- a/deno/rest/v10/autoModeration.ts +++ b/deno/rest/v10/autoModeration.ts @@ -80,4 +80,4 @@ export type RESTPatchAPIAutoModerationRuleResult = APIAutoModerationRule; /** * @see {@link https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule} */ -export type RESTDeleteAPIAutoModerationRuleResult = never; +export type RESTDeleteAPIAutoModerationRuleResult = undefined; diff --git a/deno/rest/v10/channel.ts b/deno/rest/v10/channel.ts index 005e6662..38483c78 100644 --- a/deno/rest/v10/channel.ts +++ b/deno/rest/v10/channel.ts @@ -369,12 +369,12 @@ export type RESTPostAPIChannelMessageCrosspostResult = APIMessage; /** * @see {@link https://discord.com/developers/docs/resources/channel#create-reaction} */ -export type RESTPutAPIChannelMessageReactionResult = never; +export type RESTPutAPIChannelMessageReactionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-own-reaction} */ -export type RESTDeleteAPIChannelMessageOwnReactionResult = never; +export type RESTDeleteAPIChannelMessageOwnReactionResult = undefined; /** * @deprecated Use {@link RESTDeleteAPIChannelMessageOwnReactionResult} instead @@ -384,7 +384,7 @@ export type RESTDeleteAPIChannelMessageOwnReaction = RESTDeleteAPIChannelMessage /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-user-reaction} */ -export type RESTDeleteAPIChannelMessageUserReactionResult = never; +export type RESTDeleteAPIChannelMessageUserReactionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#get-reactions} @@ -428,12 +428,12 @@ export type RESTGetAPIChannelMessageReactionUsersResult = APIUser[]; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions} */ -export type RESTDeleteAPIChannelAllMessageReactionsResult = never; +export type RESTDeleteAPIChannelAllMessageReactionsResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji} */ -export type RESTDeleteAPIChannelMessageReactionResult = never; +export type RESTDeleteAPIChannelMessageReactionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#edit-message} @@ -500,7 +500,7 @@ export type RESTPatchAPIChannelMessageResult = APIMessage; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-message} */ -export type RESTDeleteAPIChannelMessageResult = never; +export type RESTDeleteAPIChannelMessageResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages} @@ -515,7 +515,7 @@ export interface RESTPostAPIChannelMessagesBulkDeleteJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages} */ -export type RESTPostAPIChannelMessagesBulkDeleteResult = never; +export type RESTPostAPIChannelMessagesBulkDeleteResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#edit-channel-permissions} @@ -544,7 +544,7 @@ export interface RESTPutAPIChannelPermissionJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/channel#edit-channel-permissions} */ -export type RESTPutAPIChannelPermissionResult = never; +export type RESTPutAPIChannelPermissionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-invites} @@ -632,7 +632,7 @@ export type RESTPostAPIChannelInviteResult = APIExtendedInvite; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-channel-permission} */ -export type RESTDeleteAPIChannelPermissionResult = never; +export type RESTDeleteAPIChannelPermissionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#follow-news-channel} @@ -652,7 +652,7 @@ export type RESTPostAPIChannelFollowersResult = APIFollowedChannel; /** * @see {@link https://discord.com/developers/docs/resources/channel#trigger-typing-indicator} */ -export type RESTPostAPIChannelTypingResult = never; +export type RESTPostAPIChannelTypingResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#get-channel-pins} @@ -687,12 +687,12 @@ export interface RESTGetAPIChannelMessagesPinsResult { /** * @see {@link https://discord.com/developers/docs/resources/message#pin-message} */ -export type RESTPutAPIChannelMessagesPinResult = never; +export type RESTPutAPIChannelMessagesPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#unpin-message} */ -export type RESTDeleteAPIChannelMessagesPinResult = never; +export type RESTDeleteAPIChannelMessagesPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#get-pinned-messages-deprecated} @@ -704,13 +704,13 @@ export type RESTGetAPIChannelPinsResult = APIMessage[]; * @see {@link https://discord.com/developers/docs/resources/message#pin-message-deprecated} * @deprecated */ -export type RESTPutAPIChannelPinResult = never; +export type RESTPutAPIChannelPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#unpin-message-deprecated} * @deprecated */ -export type RESTDeleteAPIChannelPinResult = never; +export type RESTDeleteAPIChannelPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#group-dm-add-recipient} @@ -816,12 +816,12 @@ export type RESTPostAPIChannelThreadsResult = /** * @see {@link https://discord.com/developers/docs/resources/channel#join-thread} */ -export type RESTPutAPIChannelThreadMembersResult = never; +export type RESTPutAPIChannelThreadMembersResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#leave-thread} */ -export type RESTDeleteAPIChannelThreadMembersResult = never; +export type RESTDeleteAPIChannelThreadMembersResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#get-thread-member} diff --git a/deno/rest/v10/emoji.ts b/deno/rest/v10/emoji.ts index 15580519..9b812ee1 100644 --- a/deno/rest/v10/emoji.ts +++ b/deno/rest/v10/emoji.ts @@ -58,7 +58,7 @@ export type RESTPatchAPIGuildEmojiResult = APIEmoji; /** * @see {@link https://discord.com/developers/docs/resources/emoji#delete-guild-emoji} */ -export type RESTDeleteAPIGuildEmojiResult = never; +export type RESTDeleteAPIGuildEmojiResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/emoji#list-application-emojis} @@ -95,4 +95,4 @@ export type RESTPatchAPIApplicationEmojiResult = APIApplicationEmoji; /** * @see {@link https://discord.com/developers/docs/resources/emoji#delete-application-emoji} */ -export type RESTDeleteAPIApplicationEmojiResult = never; +export type RESTDeleteAPIApplicationEmojiResult = undefined; diff --git a/deno/rest/v10/guild.ts b/deno/rest/v10/guild.ts index e79ddece..17b9c9c0 100644 --- a/deno/rest/v10/guild.ts +++ b/deno/rest/v10/guild.ts @@ -360,7 +360,7 @@ export type RESTPatchAPIGuildResult = APIGuild; * @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation} * @deprecated */ -export type RESTDeleteAPIGuildResult = never; +export type RESTDeleteAPIGuildResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-channels} @@ -402,7 +402,7 @@ export type RESTPatchAPIGuildChannelPositionsJSONBody = { /** * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions} */ -export type RESTPatchAPIGuildChannelPositionsResult = never; +export type RESTPatchAPIGuildChannelPositionsResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#list-active-guild-threads} @@ -739,17 +739,17 @@ export type RESTPatchAPICurrentGuildMemberResult = APIGuildMember; /** * @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member-role} */ -export type RESTPutAPIGuildMemberRoleResult = never; +export type RESTPutAPIGuildMemberRoleResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-member-role} */ -export type RESTDeleteAPIGuildMemberRoleResult = never; +export type RESTDeleteAPIGuildMemberRoleResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-member} */ -export type RESTDeleteAPIGuildMemberResult = never; +export type RESTDeleteAPIGuildMemberResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-bans} @@ -800,12 +800,12 @@ export interface RESTPutAPIGuildBanJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-ban} */ -export type RESTPutAPIGuildBanResult = never; +export type RESTPutAPIGuildBanResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-ban} */ -export type RESTDeleteAPIGuildBanResult = never; +export type RESTDeleteAPIGuildBanResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#bulk-guild-ban} @@ -969,7 +969,7 @@ export type RESTPatchAPIGuildRoleResult = APIRole; /** * @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-role} */ -export type RESTDeleteAPIGuildRoleResult = never; +export type RESTDeleteAPIGuildRoleResult = undefined; /** * A record mapping role IDs to the number of members that have that role. @@ -1054,7 +1054,7 @@ export type RESTGetAPIGuildIntegrationsResult = APIGuildIntegration[]; /** * @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-integration} */ -export type RESTDeleteAPIGuildIntegrationResult = never; +export type RESTDeleteAPIGuildIntegrationResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-settings} diff --git a/deno/rest/v10/guildScheduledEvent.ts b/deno/rest/v10/guildScheduledEvent.ts index 44d0d740..e9ebc74f 100644 --- a/deno/rest/v10/guildScheduledEvent.ts +++ b/deno/rest/v10/guildScheduledEvent.ts @@ -118,7 +118,7 @@ export type RESTPatchAPIGuildScheduledEventResult = APIGuildScheduledEvent; /** * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event} */ -export type RESTDeleteAPIGuildScheduledEventResult = never; +export type RESTDeleteAPIGuildScheduledEventResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users} diff --git a/deno/rest/v10/interactions.ts b/deno/rest/v10/interactions.ts index a0f8eb74..fd7478bf 100644 --- a/deno/rest/v10/interactions.ts +++ b/deno/rest/v10/interactions.ts @@ -212,7 +212,7 @@ export type RESTPostAPIInteractionCallbackFormDataBody = /** * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response} */ -export type RESTPostAPIInteractionCallbackResult = never; +export type RESTPostAPIInteractionCallbackResult = undefined; /** * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object} diff --git a/deno/rest/v10/monetization.ts b/deno/rest/v10/monetization.ts index 55fb3898..c2e3eb2b 100644 --- a/deno/rest/v10/monetization.ts +++ b/deno/rest/v10/monetization.ts @@ -95,7 +95,7 @@ export enum EntitlementOwnerType { /** * @see {@link https://discord.com/developers/docs/resources/entitlement#delete-test-entitlement} */ -export type RESTDeleteAPIEntitlementResult = never; +export type RESTDeleteAPIEntitlementResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/sku#list-skus} @@ -105,7 +105,7 @@ export type RESTGetAPISKUsResult = APISKU[]; /** * @see {@link https://discord.com/developers/docs/resources/entitlement#consume-an-entitlement} */ -export type RESTPostAPIEntitlementConsumeResult = never; +export type RESTPostAPIEntitlementConsumeResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/subscription#query-string-params} diff --git a/deno/rest/v10/soundboard.ts b/deno/rest/v10/soundboard.ts index b44b075e..098cd11d 100644 --- a/deno/rest/v10/soundboard.ts +++ b/deno/rest/v10/soundboard.ts @@ -4,7 +4,7 @@ import type { APISoundboardSound } from '../../payloads/v10/mod.ts'; /** * @see {@link https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound} */ -export type RESTPostAPISendSoundboardSoundResult = never; +export type RESTPostAPISendSoundboardSoundResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound-json-params} @@ -104,4 +104,4 @@ export type RESTPatchAPIGuildSoundboardSoundResult = APISoundboardSound; /** * @see {@link https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound} */ -export type RESTDeleteAPIGuildSoundboardSoundResult = never; +export type RESTDeleteAPIGuildSoundboardSoundResult = undefined; diff --git a/deno/rest/v10/stageInstance.ts b/deno/rest/v10/stageInstance.ts index ca54564c..9ff9bdce 100644 --- a/deno/rest/v10/stageInstance.ts +++ b/deno/rest/v10/stageInstance.ts @@ -61,4 +61,4 @@ export type RESTPatchAPIStageInstanceResult = APIStageInstance; /** * @see {@link https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance} */ -export type RESTDeleteAPIStageInstanceResult = never; +export type RESTDeleteAPIStageInstanceResult = undefined; diff --git a/deno/rest/v10/sticker.ts b/deno/rest/v10/sticker.ts index a8546bea..3ae09566 100644 --- a/deno/rest/v10/sticker.ts +++ b/deno/rest/v10/sticker.ts @@ -93,4 +93,4 @@ export type RESTPatchAPIGuildStickerResult = APISticker; /** * @see {@link https://discord.com/developers/docs/resources/sticker#delete-guild-sticker} */ -export type RESTDeleteAPIGuildStickerResult = never; +export type RESTDeleteAPIGuildStickerResult = undefined; diff --git a/deno/rest/v10/user.ts b/deno/rest/v10/user.ts index 53e7bd8c..a92c6230 100644 --- a/deno/rest/v10/user.ts +++ b/deno/rest/v10/user.ts @@ -92,7 +92,7 @@ export type RESTGetAPICurrentUserGuildsResult = RESTAPIPartialCurrentUserGuild[] /** * @see {@link https://discord.com/developers/docs/resources/user#leave-guild} */ -export type RESTDeleteAPICurrentUserGuildResult = never; +export type RESTDeleteAPICurrentUserGuildResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/user#create-dm} diff --git a/deno/rest/v10/voice.ts b/deno/rest/v10/voice.ts index 382ad552..de8e11ce 100644 --- a/deno/rest/v10/voice.ts +++ b/deno/rest/v10/voice.ts @@ -42,7 +42,7 @@ export interface RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state} */ -export type RESTPatchAPIGuildVoiceStateCurrentMemberResult = never; +export type RESTPatchAPIGuildVoiceStateCurrentMemberResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state} @@ -61,4 +61,4 @@ export interface RESTPatchAPIGuildVoiceStateUserJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state} */ -export type RESTPatchAPIGuildVoiceStateUserResult = never; +export type RESTPatchAPIGuildVoiceStateUserResult = undefined; diff --git a/deno/rest/v10/webhook.ts b/deno/rest/v10/webhook.ts index 681b42fc..695ad40f 100644 --- a/deno/rest/v10/webhook.ts +++ b/deno/rest/v10/webhook.ts @@ -89,12 +89,12 @@ export type RESTPatchAPIWebhookWithTokenResult = RESTGetAPIWebhookWithTokenResul /** * @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook} */ -export type RESTDeleteAPIWebhookResult = never; +export type RESTDeleteAPIWebhookResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token} */ -export type RESTDeleteAPIWebhookWithTokenResult = never; +export type RESTDeleteAPIWebhookWithTokenResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook} @@ -201,7 +201,7 @@ export interface RESTPostAPIWebhookWithTokenQuery { /** * @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook} */ -export type RESTPostAPIWebhookWithTokenResult = never; +export type RESTPostAPIWebhookWithTokenResult = undefined; /** * Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives @@ -219,7 +219,7 @@ export type RESTPostAPIWebhookWithTokenSlackQuery = Pick; +export type RPCSubscribeActivityInviteArgs = Record; -export type RPCSubscribeActivityJoinArgs = Record; +export type RPCSubscribeActivityJoinArgs = Record; -export type RPCSubscribeActivityJoinRequestArgs = Record; +export type RPCSubscribeActivityJoinRequestArgs = Record; -export type RPCSubscribeActivitySpectateArgs = Record; +export type RPCSubscribeActivitySpectateArgs = Record; -export type RPCSubscribeChannelCreateArgs = Record; +export type RPCSubscribeChannelCreateArgs = Record; /** * @unstable */ -export type RPCSubscribeCurrentUserUpdateArgs = Record; +export type RPCSubscribeCurrentUserUpdateArgs = Record; /** * @unstable */ -export type RPCSubscribeEntitlementCreateArgs = Record; +export type RPCSubscribeEntitlementCreateArgs = Record; /** * @unstable */ -export type RPCSubscribeEntitlementDeleteArgs = Record; +export type RPCSubscribeEntitlementDeleteArgs = Record; /** * @unstable */ -export type RPCSubscribeGameJoinArgs = Record; +export type RPCSubscribeGameJoinArgs = Record; /** * @unstable */ -export type RPCSubscribeGameSpectateArgs = Record; +export type RPCSubscribeGameSpectateArgs = Record; -export type RPCSubscribeGuildCreateArgs = Record; +export type RPCSubscribeGuildCreateArgs = Record; /** * @see {@link https://discord.com/developers/docs/topics/rpc#guildstatus-guild-status-argument-structure} @@ -1310,22 +1310,22 @@ export interface RPCSubscribeMessageUpdateArgs { channel_id: Snowflake; } -export type RPCSubscribeNotificationCreateArgs = Record; +export type RPCSubscribeNotificationCreateArgs = Record; /** * @unstable */ -export type RPCSubscribeOverlayArgs = Record; +export type RPCSubscribeOverlayArgs = Record; /** * @unstable */ -export type RPCSubscribeOverlayUpdateArgs = Record; +export type RPCSubscribeOverlayUpdateArgs = Record; /** * @unstable */ -export type RPCSubscribeRelationshipUpdateArgs = Record; +export type RPCSubscribeRelationshipUpdateArgs = Record; /** * @see {@link https://discord.com/developers/docs/topics/rpc#speakingstartspeakingstop-speaking-argument-structure} @@ -1347,19 +1347,19 @@ export interface RPCSubscribeSpeakingStopArgs { channel_id: Snowflake; } -export type RPCSubscribeVoiceChannelSelectArgs = Record; +export type RPCSubscribeVoiceChannelSelectArgs = Record; /** * @unstable */ -export type RPCSubscribeVoiceConnectionStatusArgs = Record; +export type RPCSubscribeVoiceConnectionStatusArgs = Record; -export type RPCSubscribeVoiceSettingsUpdateArgs = Record; +export type RPCSubscribeVoiceSettingsUpdateArgs = Record; /** * @unstable */ -export type RPCSubscribeVoiceSettingsUpdate2Args = Record; +export type RPCSubscribeVoiceSettingsUpdate2Args = Record; /** * @see {@link https://discord.com/developers/docs/topics/rpc#voicestatecreatevoicestateupdatevoicestatedelete-voice-state-argument-structure} diff --git a/gateway/v10.ts b/gateway/v10.ts index 37c98302..4ed367b2 100644 --- a/gateway/v10.ts +++ b/gateway/v10.ts @@ -441,7 +441,7 @@ export interface GatewayHelloData { */ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { op: GatewayOpcodes.Heartbeat; - d: never; + d: undefined; } /** @@ -449,7 +449,7 @@ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { */ export interface GatewayHeartbeatAck extends _NonDispatchPayload { op: GatewayOpcodes.HeartbeatAck; - d: never; + d: undefined; } /** @@ -470,7 +470,7 @@ export type GatewayInvalidSessionData = boolean; */ export interface GatewayReconnect extends _NonDispatchPayload { op: GatewayOpcodes.Reconnect; - d: never; + d: undefined; } /** @@ -525,7 +525,7 @@ export interface GatewayReadyDispatchData { /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#resumed} */ -export type GatewayResumedDispatch = _DataPayload; +export type GatewayResumedDispatch = _DataPayload; /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} diff --git a/gateway/v9.ts b/gateway/v9.ts index c0edf6d1..12b14e82 100644 --- a/gateway/v9.ts +++ b/gateway/v9.ts @@ -440,7 +440,7 @@ export interface GatewayHelloData { */ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { op: GatewayOpcodes.Heartbeat; - d: never; + d: undefined; } /** @@ -448,7 +448,7 @@ export interface GatewayHeartbeatRequest extends _NonDispatchPayload { */ export interface GatewayHeartbeatAck extends _NonDispatchPayload { op: GatewayOpcodes.HeartbeatAck; - d: never; + d: undefined; } /** @@ -469,7 +469,7 @@ export type GatewayInvalidSessionData = boolean; */ export interface GatewayReconnect extends _NonDispatchPayload { op: GatewayOpcodes.Reconnect; - d: never; + d: undefined; } /** @@ -524,7 +524,7 @@ export interface GatewayReadyDispatchData { /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#resumed} */ -export type GatewayResumedDispatch = _DataPayload; +export type GatewayResumedDispatch = _DataPayload; /** * @see {@link https://discord.com/developers/docs/topics/gateway-events#auto-moderation-rule-create} diff --git a/payloads/v10/_interactions/ping.ts b/payloads/v10/_interactions/ping.ts index 55784f43..ee1606fc 100644 --- a/payloads/v10/_interactions/ping.ts +++ b/payloads/v10/_interactions/ping.ts @@ -1,4 +1,4 @@ import type { APIBaseInteraction } from './base'; import type { InteractionType } from './responses'; -export type APIPingInteraction = Omit, 'locale'>; +export type APIPingInteraction = Omit, 'locale'>; diff --git a/payloads/v10/invite.ts b/payloads/v10/invite.ts index c382c3e9..a65cddc4 100644 --- a/payloads/v10/invite.ts +++ b/payloads/v10/invite.ts @@ -90,7 +90,7 @@ export interface APIInvite { * @deprecated This has been removed from the documentation. * {@link https://github.com/discord/discord-api-docs/pull/7779 | discord-api-docs#7779} */ - stage_instance?: never; + stage_instance?: undefined; /** * The guild scheduled event data, returned from the `GET /invites/` endpoint when `guild_scheduled_event_id` is a valid guild scheduled event id */ diff --git a/payloads/v10/webhook.ts b/payloads/v10/webhook.ts index 26dc436c..54dd2832 100644 --- a/payloads/v10/webhook.ts +++ b/payloads/v10/webhook.ts @@ -76,7 +76,7 @@ export interface APIWebhook { */ export type APIWebhookEvent = | APIWebhookEventBase - | APIWebhookEventBase; + | APIWebhookEventBase; /** * @see {@link https://discord.com/developers/docs/events/webhook-events#event-body-object} @@ -127,7 +127,7 @@ export type APIWebhookEventEntitlementDeleteData = APIEntitlement; export type APIWebhookEventEntitlementUpdateData = APIEntitlement; -export type APIWebhookEventQuestUserEnrollmentData = never; +export type APIWebhookEventQuestUserEnrollmentData = undefined; export interface APIWebhookEventBase { /** diff --git a/payloads/v9/_interactions/ping.ts b/payloads/v9/_interactions/ping.ts index 55784f43..ee1606fc 100644 --- a/payloads/v9/_interactions/ping.ts +++ b/payloads/v9/_interactions/ping.ts @@ -1,4 +1,4 @@ import type { APIBaseInteraction } from './base'; import type { InteractionType } from './responses'; -export type APIPingInteraction = Omit, 'locale'>; +export type APIPingInteraction = Omit, 'locale'>; diff --git a/payloads/v9/invite.ts b/payloads/v9/invite.ts index c382c3e9..a65cddc4 100644 --- a/payloads/v9/invite.ts +++ b/payloads/v9/invite.ts @@ -90,7 +90,7 @@ export interface APIInvite { * @deprecated This has been removed from the documentation. * {@link https://github.com/discord/discord-api-docs/pull/7779 | discord-api-docs#7779} */ - stage_instance?: never; + stage_instance?: undefined; /** * The guild scheduled event data, returned from the `GET /invites/` endpoint when `guild_scheduled_event_id` is a valid guild scheduled event id */ diff --git a/payloads/v9/webhook.ts b/payloads/v9/webhook.ts index 26dc436c..54dd2832 100644 --- a/payloads/v9/webhook.ts +++ b/payloads/v9/webhook.ts @@ -76,7 +76,7 @@ export interface APIWebhook { */ export type APIWebhookEvent = | APIWebhookEventBase - | APIWebhookEventBase; + | APIWebhookEventBase; /** * @see {@link https://discord.com/developers/docs/events/webhook-events#event-body-object} @@ -127,7 +127,7 @@ export type APIWebhookEventEntitlementDeleteData = APIEntitlement; export type APIWebhookEventEntitlementUpdateData = APIEntitlement; -export type APIWebhookEventQuestUserEnrollmentData = never; +export type APIWebhookEventQuestUserEnrollmentData = undefined; export interface APIWebhookEventBase { /** diff --git a/rest/v10/autoModeration.ts b/rest/v10/autoModeration.ts index 4b0ed452..74ca2c12 100644 --- a/rest/v10/autoModeration.ts +++ b/rest/v10/autoModeration.ts @@ -80,4 +80,4 @@ export type RESTPatchAPIAutoModerationRuleResult = APIAutoModerationRule; /** * @see {@link https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule} */ -export type RESTDeleteAPIAutoModerationRuleResult = never; +export type RESTDeleteAPIAutoModerationRuleResult = undefined; diff --git a/rest/v10/channel.ts b/rest/v10/channel.ts index 9601c9ed..a1a55578 100644 --- a/rest/v10/channel.ts +++ b/rest/v10/channel.ts @@ -369,12 +369,12 @@ export type RESTPostAPIChannelMessageCrosspostResult = APIMessage; /** * @see {@link https://discord.com/developers/docs/resources/channel#create-reaction} */ -export type RESTPutAPIChannelMessageReactionResult = never; +export type RESTPutAPIChannelMessageReactionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-own-reaction} */ -export type RESTDeleteAPIChannelMessageOwnReactionResult = never; +export type RESTDeleteAPIChannelMessageOwnReactionResult = undefined; /** * @deprecated Use {@link RESTDeleteAPIChannelMessageOwnReactionResult} instead @@ -384,7 +384,7 @@ export type RESTDeleteAPIChannelMessageOwnReaction = RESTDeleteAPIChannelMessage /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-user-reaction} */ -export type RESTDeleteAPIChannelMessageUserReactionResult = never; +export type RESTDeleteAPIChannelMessageUserReactionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#get-reactions} @@ -428,12 +428,12 @@ export type RESTGetAPIChannelMessageReactionUsersResult = APIUser[]; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions} */ -export type RESTDeleteAPIChannelAllMessageReactionsResult = never; +export type RESTDeleteAPIChannelAllMessageReactionsResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji} */ -export type RESTDeleteAPIChannelMessageReactionResult = never; +export type RESTDeleteAPIChannelMessageReactionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#edit-message} @@ -500,7 +500,7 @@ export type RESTPatchAPIChannelMessageResult = APIMessage; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-message} */ -export type RESTDeleteAPIChannelMessageResult = never; +export type RESTDeleteAPIChannelMessageResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages} @@ -515,7 +515,7 @@ export interface RESTPostAPIChannelMessagesBulkDeleteJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages} */ -export type RESTPostAPIChannelMessagesBulkDeleteResult = never; +export type RESTPostAPIChannelMessagesBulkDeleteResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#edit-channel-permissions} @@ -544,7 +544,7 @@ export interface RESTPutAPIChannelPermissionJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/channel#edit-channel-permissions} */ -export type RESTPutAPIChannelPermissionResult = never; +export type RESTPutAPIChannelPermissionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-invites} @@ -632,7 +632,7 @@ export type RESTPostAPIChannelInviteResult = APIExtendedInvite; /** * @see {@link https://discord.com/developers/docs/resources/channel#delete-channel-permission} */ -export type RESTDeleteAPIChannelPermissionResult = never; +export type RESTDeleteAPIChannelPermissionResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#follow-news-channel} @@ -652,7 +652,7 @@ export type RESTPostAPIChannelFollowersResult = APIFollowedChannel; /** * @see {@link https://discord.com/developers/docs/resources/channel#trigger-typing-indicator} */ -export type RESTPostAPIChannelTypingResult = never; +export type RESTPostAPIChannelTypingResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#get-channel-pins} @@ -687,12 +687,12 @@ export interface RESTGetAPIChannelMessagesPinsResult { /** * @see {@link https://discord.com/developers/docs/resources/message#pin-message} */ -export type RESTPutAPIChannelMessagesPinResult = never; +export type RESTPutAPIChannelMessagesPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#unpin-message} */ -export type RESTDeleteAPIChannelMessagesPinResult = never; +export type RESTDeleteAPIChannelMessagesPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#get-pinned-messages-deprecated} @@ -704,13 +704,13 @@ export type RESTGetAPIChannelPinsResult = APIMessage[]; * @see {@link https://discord.com/developers/docs/resources/message#pin-message-deprecated} * @deprecated */ -export type RESTPutAPIChannelPinResult = never; +export type RESTPutAPIChannelPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/message#unpin-message-deprecated} * @deprecated */ -export type RESTDeleteAPIChannelPinResult = never; +export type RESTDeleteAPIChannelPinResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#group-dm-add-recipient} @@ -816,12 +816,12 @@ export type RESTPostAPIChannelThreadsResult = /** * @see {@link https://discord.com/developers/docs/resources/channel#join-thread} */ -export type RESTPutAPIChannelThreadMembersResult = never; +export type RESTPutAPIChannelThreadMembersResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#leave-thread} */ -export type RESTDeleteAPIChannelThreadMembersResult = never; +export type RESTDeleteAPIChannelThreadMembersResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/channel#get-thread-member} diff --git a/rest/v10/emoji.ts b/rest/v10/emoji.ts index b4aef35b..09b6987b 100644 --- a/rest/v10/emoji.ts +++ b/rest/v10/emoji.ts @@ -58,7 +58,7 @@ export type RESTPatchAPIGuildEmojiResult = APIEmoji; /** * @see {@link https://discord.com/developers/docs/resources/emoji#delete-guild-emoji} */ -export type RESTDeleteAPIGuildEmojiResult = never; +export type RESTDeleteAPIGuildEmojiResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/emoji#list-application-emojis} @@ -95,4 +95,4 @@ export type RESTPatchAPIApplicationEmojiResult = APIApplicationEmoji; /** * @see {@link https://discord.com/developers/docs/resources/emoji#delete-application-emoji} */ -export type RESTDeleteAPIApplicationEmojiResult = never; +export type RESTDeleteAPIApplicationEmojiResult = undefined; diff --git a/rest/v10/guild.ts b/rest/v10/guild.ts index ce2460a4..3198c6c0 100644 --- a/rest/v10/guild.ts +++ b/rest/v10/guild.ts @@ -360,7 +360,7 @@ export type RESTPatchAPIGuildResult = APIGuild; * @see {@link https://discord.com/developers/docs/change-log#guild-create-deprecation} * @deprecated */ -export type RESTDeleteAPIGuildResult = never; +export type RESTDeleteAPIGuildResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-channels} @@ -402,7 +402,7 @@ export type RESTPatchAPIGuildChannelPositionsJSONBody = { /** * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions} */ -export type RESTPatchAPIGuildChannelPositionsResult = never; +export type RESTPatchAPIGuildChannelPositionsResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#list-active-guild-threads} @@ -739,17 +739,17 @@ export type RESTPatchAPICurrentGuildMemberResult = APIGuildMember; /** * @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member-role} */ -export type RESTPutAPIGuildMemberRoleResult = never; +export type RESTPutAPIGuildMemberRoleResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-member-role} */ -export type RESTDeleteAPIGuildMemberRoleResult = never; +export type RESTDeleteAPIGuildMemberRoleResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-member} */ -export type RESTDeleteAPIGuildMemberResult = never; +export type RESTDeleteAPIGuildMemberResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-bans} @@ -800,12 +800,12 @@ export interface RESTPutAPIGuildBanJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-ban} */ -export type RESTPutAPIGuildBanResult = never; +export type RESTPutAPIGuildBanResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-ban} */ -export type RESTDeleteAPIGuildBanResult = never; +export type RESTDeleteAPIGuildBanResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#bulk-guild-ban} @@ -969,7 +969,7 @@ export type RESTPatchAPIGuildRoleResult = APIRole; /** * @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-role} */ -export type RESTDeleteAPIGuildRoleResult = never; +export type RESTDeleteAPIGuildRoleResult = undefined; /** * A record mapping role IDs to the number of members that have that role. @@ -1054,7 +1054,7 @@ export type RESTGetAPIGuildIntegrationsResult = APIGuildIntegration[]; /** * @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-integration} */ -export type RESTDeleteAPIGuildIntegrationResult = never; +export type RESTDeleteAPIGuildIntegrationResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-settings} diff --git a/rest/v10/guildScheduledEvent.ts b/rest/v10/guildScheduledEvent.ts index bf3445ff..cfc428c5 100644 --- a/rest/v10/guildScheduledEvent.ts +++ b/rest/v10/guildScheduledEvent.ts @@ -118,7 +118,7 @@ export type RESTPatchAPIGuildScheduledEventResult = APIGuildScheduledEvent; /** * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event} */ -export type RESTDeleteAPIGuildScheduledEventResult = never; +export type RESTDeleteAPIGuildScheduledEventResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users} diff --git a/rest/v10/interactions.ts b/rest/v10/interactions.ts index a421ff0b..1016379e 100644 --- a/rest/v10/interactions.ts +++ b/rest/v10/interactions.ts @@ -212,7 +212,7 @@ export type RESTPostAPIInteractionCallbackFormDataBody = /** * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response} */ -export type RESTPostAPIInteractionCallbackResult = never; +export type RESTPostAPIInteractionCallbackResult = undefined; /** * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object} diff --git a/rest/v10/monetization.ts b/rest/v10/monetization.ts index cd1b66db..40f071c3 100644 --- a/rest/v10/monetization.ts +++ b/rest/v10/monetization.ts @@ -95,7 +95,7 @@ export enum EntitlementOwnerType { /** * @see {@link https://discord.com/developers/docs/resources/entitlement#delete-test-entitlement} */ -export type RESTDeleteAPIEntitlementResult = never; +export type RESTDeleteAPIEntitlementResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/sku#list-skus} @@ -105,7 +105,7 @@ export type RESTGetAPISKUsResult = APISKU[]; /** * @see {@link https://discord.com/developers/docs/resources/entitlement#consume-an-entitlement} */ -export type RESTPostAPIEntitlementConsumeResult = never; +export type RESTPostAPIEntitlementConsumeResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/subscription#query-string-params} diff --git a/rest/v10/soundboard.ts b/rest/v10/soundboard.ts index 10f30efc..2af0714a 100644 --- a/rest/v10/soundboard.ts +++ b/rest/v10/soundboard.ts @@ -4,7 +4,7 @@ import type { APISoundboardSound } from '../../payloads/v10/index'; /** * @see {@link https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound} */ -export type RESTPostAPISendSoundboardSoundResult = never; +export type RESTPostAPISendSoundboardSoundResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound-json-params} @@ -104,4 +104,4 @@ export type RESTPatchAPIGuildSoundboardSoundResult = APISoundboardSound; /** * @see {@link https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound} */ -export type RESTDeleteAPIGuildSoundboardSoundResult = never; +export type RESTDeleteAPIGuildSoundboardSoundResult = undefined; diff --git a/rest/v10/stageInstance.ts b/rest/v10/stageInstance.ts index c10b6c18..a7270196 100644 --- a/rest/v10/stageInstance.ts +++ b/rest/v10/stageInstance.ts @@ -61,4 +61,4 @@ export type RESTPatchAPIStageInstanceResult = APIStageInstance; /** * @see {@link https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance} */ -export type RESTDeleteAPIStageInstanceResult = never; +export type RESTDeleteAPIStageInstanceResult = undefined; diff --git a/rest/v10/sticker.ts b/rest/v10/sticker.ts index f457f4fd..28acd60b 100644 --- a/rest/v10/sticker.ts +++ b/rest/v10/sticker.ts @@ -93,4 +93,4 @@ export type RESTPatchAPIGuildStickerResult = APISticker; /** * @see {@link https://discord.com/developers/docs/resources/sticker#delete-guild-sticker} */ -export type RESTDeleteAPIGuildStickerResult = never; +export type RESTDeleteAPIGuildStickerResult = undefined; diff --git a/rest/v10/user.ts b/rest/v10/user.ts index ad1f57df..3f4406eb 100644 --- a/rest/v10/user.ts +++ b/rest/v10/user.ts @@ -92,7 +92,7 @@ export type RESTGetAPICurrentUserGuildsResult = RESTAPIPartialCurrentUserGuild[] /** * @see {@link https://discord.com/developers/docs/resources/user#leave-guild} */ -export type RESTDeleteAPICurrentUserGuildResult = never; +export type RESTDeleteAPICurrentUserGuildResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/user#create-dm} diff --git a/rest/v10/voice.ts b/rest/v10/voice.ts index de6d7084..e5aeff41 100644 --- a/rest/v10/voice.ts +++ b/rest/v10/voice.ts @@ -42,7 +42,7 @@ export interface RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state} */ -export type RESTPatchAPIGuildVoiceStateCurrentMemberResult = never; +export type RESTPatchAPIGuildVoiceStateCurrentMemberResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state} @@ -61,4 +61,4 @@ export interface RESTPatchAPIGuildVoiceStateUserJSONBody { /** * @see {@link https://discord.com/developers/docs/resources/voice#modify-user-voice-state} */ -export type RESTPatchAPIGuildVoiceStateUserResult = never; +export type RESTPatchAPIGuildVoiceStateUserResult = undefined; diff --git a/rest/v10/webhook.ts b/rest/v10/webhook.ts index 97b64739..256a7e38 100644 --- a/rest/v10/webhook.ts +++ b/rest/v10/webhook.ts @@ -89,12 +89,12 @@ export type RESTPatchAPIWebhookWithTokenResult = RESTGetAPIWebhookWithTokenResul /** * @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook} */ -export type RESTDeleteAPIWebhookResult = never; +export type RESTDeleteAPIWebhookResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token} */ -export type RESTDeleteAPIWebhookWithTokenResult = never; +export type RESTDeleteAPIWebhookWithTokenResult = undefined; /** * @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook} @@ -201,7 +201,7 @@ export interface RESTPostAPIWebhookWithTokenQuery { /** * @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook} */ -export type RESTPostAPIWebhookWithTokenResult = never; +export type RESTPostAPIWebhookWithTokenResult = undefined; /** * Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives @@ -219,7 +219,7 @@ export type RESTPostAPIWebhookWithTokenSlackQuery = Pick; +export type RPCSubscribeActivityInviteArgs = Record; -export type RPCSubscribeActivityJoinArgs = Record; +export type RPCSubscribeActivityJoinArgs = Record; -export type RPCSubscribeActivityJoinRequestArgs = Record; +export type RPCSubscribeActivityJoinRequestArgs = Record; -export type RPCSubscribeActivitySpectateArgs = Record; +export type RPCSubscribeActivitySpectateArgs = Record; -export type RPCSubscribeChannelCreateArgs = Record; +export type RPCSubscribeChannelCreateArgs = Record; /** * @unstable */ -export type RPCSubscribeCurrentUserUpdateArgs = Record; +export type RPCSubscribeCurrentUserUpdateArgs = Record; /** * @unstable */ -export type RPCSubscribeEntitlementCreateArgs = Record; +export type RPCSubscribeEntitlementCreateArgs = Record; /** * @unstable */ -export type RPCSubscribeEntitlementDeleteArgs = Record; +export type RPCSubscribeEntitlementDeleteArgs = Record; /** * @unstable */ -export type RPCSubscribeGameJoinArgs = Record; +export type RPCSubscribeGameJoinArgs = Record; /** * @unstable */ -export type RPCSubscribeGameSpectateArgs = Record; +export type RPCSubscribeGameSpectateArgs = Record; -export type RPCSubscribeGuildCreateArgs = Record; +export type RPCSubscribeGuildCreateArgs = Record; /** * @see {@link https://discord.com/developers/docs/topics/rpc#guildstatus-guild-status-argument-structure} @@ -1310,22 +1310,22 @@ export interface RPCSubscribeMessageUpdateArgs { channel_id: Snowflake; } -export type RPCSubscribeNotificationCreateArgs = Record; +export type RPCSubscribeNotificationCreateArgs = Record; /** * @unstable */ -export type RPCSubscribeOverlayArgs = Record; +export type RPCSubscribeOverlayArgs = Record; /** * @unstable */ -export type RPCSubscribeOverlayUpdateArgs = Record; +export type RPCSubscribeOverlayUpdateArgs = Record; /** * @unstable */ -export type RPCSubscribeRelationshipUpdateArgs = Record; +export type RPCSubscribeRelationshipUpdateArgs = Record; /** * @see {@link https://discord.com/developers/docs/topics/rpc#speakingstartspeakingstop-speaking-argument-structure} @@ -1347,19 +1347,19 @@ export interface RPCSubscribeSpeakingStopArgs { channel_id: Snowflake; } -export type RPCSubscribeVoiceChannelSelectArgs = Record; +export type RPCSubscribeVoiceChannelSelectArgs = Record; /** * @unstable */ -export type RPCSubscribeVoiceConnectionStatusArgs = Record; +export type RPCSubscribeVoiceConnectionStatusArgs = Record; -export type RPCSubscribeVoiceSettingsUpdateArgs = Record; +export type RPCSubscribeVoiceSettingsUpdateArgs = Record; /** * @unstable */ -export type RPCSubscribeVoiceSettingsUpdate2Args = Record; +export type RPCSubscribeVoiceSettingsUpdate2Args = Record; /** * @see {@link https://discord.com/developers/docs/topics/rpc#voicestatecreatevoicestateupdatevoicestatedelete-voice-state-argument-structure} diff --git a/website/docs/Contributing.mdx b/website/docs/Contributing.mdx index 10157168..2a3de365 100644 --- a/website/docs/Contributing.mdx +++ b/website/docs/Contributing.mdx @@ -179,7 +179,7 @@ They must also follow the following structure: `REST{http_method}{type_name}{Que - If a route doesn't take in any parameters, be it query, JSON or FormData, it shouldn't define any of those types - A route should always define a `Result` type, and should reference an `API*` type unless the data returned is only received through a REST call - - If a route returns a `204 No Content` response, it should define a `Result` type with `never` as its value (this + - If a route returns a `204 No Content` response, it should define a `Result` type with `undefined` as its value (this does not account for errors) This structure should be followed whenever possible, however that might not always be doable. Specifically, types for diff --git a/website/docs/Introduction.mdx b/website/docs/Introduction.mdx index 7d4af090..7cd78660 100644 --- a/website/docs/Introduction.mdx +++ b/website/docs/Introduction.mdx @@ -181,8 +181,8 @@ The exports of each API version is split into three main parts: the fields. They will start with either `RESTOAuth2` or with something similar to `RESTOAuth2` - If a type ends with `Result`, then it represents the expected result by calling its accompanying route. - - Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore - it. This does **not** account for errors. + - Types for a Result that will be a `204 No Content` will be typed as `undefined`. This does **not** account for + errors - Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).