Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add NoContent generic #798

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,6 @@ The exports of each API version is split into three main parts:

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

- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).

- There may be types exported that are identical for all versions. These will be exported as is and can be found in the `globals` file. They will still be prefixed accordingly as described above.
Expand Down
2 changes: 0 additions & 2 deletions deno/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,6 @@ The exports of each API version is split into three main parts:

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

- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).

- There may be types exported that are identical for all versions. These will be exported as is and can be found in the `globals` file. They will still be prefixed accordingly as described above.
Expand Down
2 changes: 1 addition & 1 deletion deno/rest/v10/autoModeration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ export type RESTPatchAPIAutoModerationRuleResult = APIAutoModerationRule;
/**
* https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule
*/
export type RESTDeleteAPIAutoModerationRuleResult = never;
export type RESTDeleteAPIAutoModerationRuleResult<NoContent extends unknown = never> = NoContent;
28 changes: 14 additions & 14 deletions deno/rest/v10/channel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -316,17 +316,17 @@ export type RESTPostAPIChannelMessageCrosspostResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/channel#create-reaction
*/
export type RESTPutAPIChannelMessageReactionResult = never;
export type RESTPutAPIChannelMessageReactionResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#delete-own-reaction
*/
export type RESTDeleteAPIChannelMessageOwnReaction = never;
export type RESTDeleteAPIChannelMessageOwnReaction<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#delete-user-reaction
*/
export type RESTDeleteAPIChannelMessageUserReactionResult = never;
export type RESTDeleteAPIChannelMessageUserReactionResult<NoContent extends unknown = never> = NoContent;

/*
* https://discord.com/developers/docs/resources/channel#get-reactions
Expand All @@ -352,12 +352,12 @@ export type RESTGetAPIChannelMessageReactionUsersResult = APIUser[];
/**
* https://discord.com/developers/docs/resources/channel#delete-all-reactions
*/
export type RESTDeleteAPIChannelAllMessageReactionsResult = never;
export type RESTDeleteAPIChannelAllMessageReactionsResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji
*/
export type RESTDeleteAPIChannelMessageReactionResult = never;
export type RESTDeleteAPIChannelMessageReactionResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#edit-message
Expand Down Expand Up @@ -424,7 +424,7 @@ export type RESTPatchAPIChannelMessageResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/channel#delete-message
*/
export type RESTDeleteAPIChannelMessageResult = never;
export type RESTDeleteAPIChannelMessageResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#bulk-delete-messages
Expand All @@ -439,7 +439,7 @@ export interface RESTPostAPIChannelMessagesBulkDeleteJSONBody {
/**
* https://discord.com/developers/docs/resources/channel#bulk-delete-messages
*/
export type RESTPostAPIChannelMessagesBulkDeleteResult = never;
export type RESTPostAPIChannelMessagesBulkDeleteResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#edit-channel-permissions
Expand Down Expand Up @@ -470,7 +470,7 @@ export interface RESTPutAPIChannelPermissionJSONBody {
/**
* https://discord.com/developers/docs/resources/channel#edit-channel-permissions
*/
export type RESTPutAPIChannelPermissionResult = never;
export type RESTPutAPIChannelPermissionResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#get-channel-invites
Expand Down Expand Up @@ -534,7 +534,7 @@ export type RESTPostAPIChannelInviteResult = APIExtendedInvite;
/**
* https://discord.com/developers/docs/resources/channel#delete-channel-permission
*/
export type RESTDeleteAPIChannelPermissionResult = never;
export type RESTDeleteAPIChannelPermissionResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#follow-news-channel
Expand All @@ -554,7 +554,7 @@ export type RESTPostAPIChannelFollowersResult = APIFollowedChannel;
/**
* https://discord.com/developers/docs/resources/channel#trigger-typing-indicator
*/
export type RESTPostAPIChannelTypingResult = never;
export type RESTPostAPIChannelTypingResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#get-pinned-messages
Expand All @@ -564,12 +564,12 @@ export type RESTGetAPIChannelPinsResult = APIMessage[];
/**
* https://discord.com/developers/docs/resources/channel#pin-message
*/
export type RESTPutAPIChannelPinResult = never;
export type RESTPutAPIChannelPinResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#unpin-message
*/
export type RESTDeleteAPIChannelPinResult = never;
export type RESTDeleteAPIChannelPinResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
Expand Down Expand Up @@ -671,12 +671,12 @@ export type RESTPostAPIChannelThreadsResult = APIChannel;
/**
* https://discord.com/developers/docs/resources/channel#join-thread
*/
export type RESTPutAPIChannelThreadMembersResult = never;
export type RESTPutAPIChannelThreadMembersResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#leave-thread
*/
export type RESTDeleteAPIChannelThreadMembersResult = never;
export type RESTDeleteAPIChannelThreadMembersResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#get-thread-member
Expand Down
2 changes: 1 addition & 1 deletion deno/rest/v10/emoji.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ export type RESTPatchAPIGuildEmojiResult = APIEmoji;
/**
* https://discord.com/developers/docs/resources/emoji#delete-guild-emoji
*/
export type RESTDeleteAPIGuildEmojiResult = never;
export type RESTDeleteAPIGuildEmojiResult<NoContent extends unknown = never> = NoContent;
24 changes: 12 additions & 12 deletions deno/rest/v10/guild.ts
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ export type RESTPatchAPIGuildResult = APIGuild;
/**
* https://discord.com/developers/docs/resources/guild#delete-guild
*/
export type RESTDeleteAPIGuildResult = never;
export type RESTDeleteAPIGuildResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#get-guild-channels
Expand Down Expand Up @@ -362,7 +362,7 @@ export type RESTPatchAPIGuildChannelPositionsJSONBody = {
/**
* https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions
*/
export type RESTPatchAPIGuildChannelPositionsResult = never;
export type RESTPatchAPIGuildChannelPositionsResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#list-active-guild-threads
Expand Down Expand Up @@ -449,7 +449,7 @@ export interface RESTPutAPIGuildMemberJSONBody {
deaf?: boolean | undefined;
}

export type RESTPutAPIGuildMemberResult = APIGuildMember | never;
export type RESTPutAPIGuildMemberResult<NoContent extends unknown = never> = APIGuildMember | NoContent;

/**
* https://discord.com/developers/docs/resources/guild#modify-guild-member
Expand Down Expand Up @@ -533,17 +533,17 @@ export type RESTPatchAPICurrentGuildMemberNicknameResult =
/**
* https://discord.com/developers/docs/resources/guild#add-guild-member-role
*/
export type RESTPutAPIGuildMemberRoleResult = never;
export type RESTPutAPIGuildMemberRoleResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#remove-guild-member-role
*/
export type RESTDeleteAPIGuildMemberRoleResult = never;
export type RESTDeleteAPIGuildMemberRoleResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#remove-guild-member
*/
export type RESTDeleteAPIGuildMemberResult = never;
export type RESTDeleteAPIGuildMemberResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#get-guild-bans
Expand Down Expand Up @@ -594,12 +594,12 @@ export interface RESTPutAPIGuildBanJSONBody {
/**
* https://discord.com/developers/docs/resources/guild#create-guild-ban
*/
export type RESTPutAPIGuildBanResult = never;
export type RESTPutAPIGuildBanResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#remove-guild-ban
*/
export type RESTDeleteAPIGuildBanResult = never;
export type RESTDeleteAPIGuildBanResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#get-guild-roles
Expand Down Expand Up @@ -716,7 +716,7 @@ export type RESTPatchAPIGuildRoleResult = APIRole;
/**
* https://discord.com/developers/docs/resources/guild#delete-guild-role
*/
export type RESTDeleteAPIGuildRoleResult = never;
export type RESTDeleteAPIGuildRoleResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#get-guild-prune-count
Expand Down Expand Up @@ -793,7 +793,7 @@ export type RESTGetAPIGuildIntegrationsResult = APIGuildIntegration[];
/**
* https://discord.com/developers/docs/resources/guild#delete-guild-integration
*/
export type RESTDeleteAPIGuildIntegrationResult = never;
export type RESTDeleteAPIGuildIntegrationResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#get-guild-widget-settings
Expand Down Expand Up @@ -881,7 +881,7 @@ export interface RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody {
/**
* https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state
*/
export type RESTPatchAPIGuildVoiceStateCurrentMemberResult = never;
export type RESTPatchAPIGuildVoiceStateCurrentMemberResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#modify-user-voice-state
Expand All @@ -900,7 +900,7 @@ export interface RESTPatchAPIGuildVoiceStateUserJSONBody {
/**
* https://discord.com/developers/docs/resources/guild#modify-user-voice-state
*/
export type RESTPatchAPIGuildVoiceStateUserResult = never;
export type RESTPatchAPIGuildVoiceStateUserResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen
Expand Down
2 changes: 1 addition & 1 deletion deno/rest/v10/guildScheduledEvent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export type RESTPatchAPIGuildScheduledEventResult = APIGuildScheduledEvent;
/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event
*/
export type RESTDeleteAPIGuildScheduledEventResult = never;
export type RESTDeleteAPIGuildScheduledEventResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users
Expand Down
2 changes: 1 addition & 1 deletion deno/rest/v10/stageInstance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ export type RESTPatchAPIStageInstanceResult = APIStageInstance;
/**
* https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance
*/
export type RESTDeleteAPIStageInstanceResult = never;
export type RESTDeleteAPIStageInstanceResult<NoContent extends unknown = never> = NoContent;
2 changes: 1 addition & 1 deletion deno/rest/v10/sticker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ export type RESTPatchAPIGuildStickerResult = APISticker;
/**
* https://discord.com/developers/docs/resources/sticker#delete-guild-sticker
*/
export type RESTDeleteAPIGuildStickerResult = never;
export type RESTDeleteAPIGuildStickerResult<NoContent extends unknown = never> = NoContent;
2 changes: 1 addition & 1 deletion deno/rest/v10/user.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export type RESTGetAPICurrentUserGuildsResult = RESTAPIPartialCurrentUserGuild[]
/**
* https://discord.com/developers/docs/resources/user#leave-guild
*/
export type RESTDeleteAPICurrentUserGuildResult = never;
export type RESTDeleteAPICurrentUserGuildResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/user#create-dm
Expand Down
12 changes: 6 additions & 6 deletions deno/rest/v10/webhook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,12 @@ export type RESTPatchAPIWebhookWithTokenResult = RESTGetAPIWebhookWithTokenResul
/**
* https://discord.com/developers/docs/resources/webhook#delete-webhook
*/
export type RESTDeleteAPIWebhookResult = never;
export type RESTDeleteAPIWebhookResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token
*/
export type RESTDeleteAPIWebhookWithTokenResult = never;
export type RESTDeleteAPIWebhookWithTokenResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook
Expand Down Expand Up @@ -186,7 +186,7 @@ export interface RESTPostAPIWebhookWithTokenQuery {
/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook
*/
export type RESTPostAPIWebhookWithTokenResult = never;
export type RESTPostAPIWebhookWithTokenResult<NoContent extends unknown = never> = NoContent;

/**
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
Expand All @@ -204,7 +204,7 @@ export type RESTPostAPIWebhookWithTokenSlackQuery = RESTPostAPIWebhookWithTokenQ
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
*/
export type RESTPostAPIWebhookWithTokenSlackResult = never;
export type RESTPostAPIWebhookWithTokenSlackResult<NoContent extends unknown = never> = NoContent;

/**
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
Expand All @@ -222,7 +222,7 @@ export type RESTPostAPIWebhookWithTokenGitHubQuery = RESTPostAPIWebhookWithToken
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
*/
export type RESTPostAPIWebhookWithTokenGitHubResult = never;
export type RESTPostAPIWebhookWithTokenGitHubResult<NoContent extends unknown = never> = NoContent;

/**
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
Expand Down Expand Up @@ -280,4 +280,4 @@ export type RESTPatchAPIWebhookWithTokenMessageResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#delete-webhook-message
*/
export type RESTDeleteAPIWebhookWithTokenMessageResult = never;
export type RESTDeleteAPIWebhookWithTokenMessageResult<NoContent extends unknown = never> = NoContent;
20 changes: 10 additions & 10 deletions deno/rest/v6/channel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export type RESTPatchAPIChannelMessageResult = APIMessage;
/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTDeleteAPIChannelMessageResult = never;
export type RESTDeleteAPIChannelMessageResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#get-reactions
Expand All @@ -194,17 +194,17 @@ export type RESTGetAPIChannelMessageReactionsResult = APIUser[];
/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTPutAPIChannelMessageReactionResult = never;
export type RESTPutAPIChannelMessageReactionResult<NoContent extends unknown = never> = NoContent;

/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTDeleteAPIChannelMessageReactionResult = never;
export type RESTDeleteAPIChannelMessageReactionResult<NoContent extends unknown = never> = NoContent;

/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTDeleteAPIChannelAllMessageReactionsResult = never;
export type RESTDeleteAPIChannelAllMessageReactionsResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#bulk-delete-messages
Expand All @@ -218,7 +218,7 @@ export interface RESTPostAPIChannelMessagesBulkDeleteJSONBody {
/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTPostAPIChannelMessagesBulkDeleteResult = never;
export type RESTPostAPIChannelMessagesBulkDeleteResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#edit-channel-permissions
Expand All @@ -234,12 +234,12 @@ export interface RESTPutAPIChannelPermissionsJSONBody {
/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTPutAPIChannelPermissionsResult = never;
export type RESTPutAPIChannelPermissionsResult<NoContent extends unknown = never> = NoContent;

/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTDeleteAPIChannelPermissionsResult = never;
export type RESTDeleteAPIChannelPermissionsResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#get-channel-invites
Expand All @@ -265,7 +265,7 @@ export interface RESTPostAPIChannelInviteJSONBody {
*
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTPostAPIChannelTypingResult = never;
export type RESTPostAPIChannelTypingResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#get-pinned-messages
Expand All @@ -279,12 +279,12 @@ export type RESTGetAPIChannelPinsResult = APIMessage[];
*
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTPutAPIChannelPinResult = never;
export type RESTPutAPIChannelPinResult<NoContent extends unknown = never> = NoContent;

/**
* @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8.
*/
export type RESTDeleteAPIChannelPinResult = never;
export type RESTDeleteAPIChannelPinResult<NoContent extends unknown = never> = NoContent;

/**
* https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
Expand Down