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

feat(webhook): add with_components query param (#1208)

Browse Source 
* feat(webhook): add `with_components` query param

* docs: use `defaultValue`

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>

---------

Co-authored-by: Jiralite <33201955+Jiralite@users.noreply.github.com>
This commit is contained in:
Danial Raza
2025-04-08 22:53:38 +02:00
committed by GitHub
parent ac4d59d17e
commit def67dbe90
4 changed files with 68 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -190,6 +190,13 @@ export interface RESTPostAPIWebhookWithTokenQuery {
* Available only if the {@link RESTPostAPIWebhookWithTokenJSONBody.thread_name} JSON body property is not specified
*/
thread_id?: Snowflake;
/**
* Whether to allow sending (non-interactive) components for non-application-owned webhooks
* (defaults to `false`; ignored for application-owned webhooks)
*
* @defaultValue `false`
*/
with_components?: boolean;
}
/**
@@ -208,7 +215,7 @@ export type RESTPostAPIWebhookWithTokenWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenSlackQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenSlackQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
@@ -226,7 +233,7 @@ export type RESTPostAPIWebhookWithTokenSlackWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenGitHubQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenGitHubQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
@@ -288,6 +295,11 @@ export type RESTPatchAPIWebhookWithTokenMessageFormDataBody =
})
| (Record<`files[${bigint}]`, unknown> & RESTPatchAPIWebhookWithTokenMessageJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message-query-string-params
*/
export type RESTPatchAPIWebhookWithTokenQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'with_components'>;
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message
*/

28
deno/rest/v9/webhook.ts
View File

@@ -174,7 +174,7 @@ export type RESTPostAPIWebhookWithTokenFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPostAPIWebhookWithTokenJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook-querystring-params
* https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params
*/
export interface RESTPostAPIWebhookWithTokenQuery {
/**
@@ -190,6 +190,13 @@ export interface RESTPostAPIWebhookWithTokenQuery {
* Available only if the {@link RESTPostAPIWebhookWithTokenJSONBody.thread_name} JSON body property is not specified
*/
thread_id?: Snowflake;
/**
* Whether to allow sending (non-interactive) components for non-application-owned webhooks
* (defaults to `false`; ignored for application-owned webhooks)
*
* @defaultValue `false`
*/
with_components?: boolean;
}
/**
@@ -201,14 +208,14 @@ export type RESTPostAPIWebhookWithTokenResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-webhook-querystring-params
* See https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-querystring-params
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenSlackQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenSlackQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
@@ -219,14 +226,14 @@ export type RESTPostAPIWebhookWithTokenSlackResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-querystring-params
* See https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenSlackWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-querystring-params
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenGitHubQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenGitHubQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
@@ -237,7 +244,7 @@ export type RESTPostAPIWebhookWithTokenGitHubResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-querystring-params
* See https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenGitHubWaitResult = APIMessage;
@@ -288,6 +295,11 @@ export type RESTPatchAPIWebhookWithTokenMessageFormDataBody =
})
| (Record<`files[${bigint}]`, unknown> & RESTPatchAPIWebhookWithTokenMessageJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message-query-string-params
*/
export type RESTPatchAPIWebhookWithTokenQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'with_components'>;
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message
*/

16
rest/v10/webhook.ts
View File

@@ -190,6 +190,13 @@ export interface RESTPostAPIWebhookWithTokenQuery {
* Available only if the {@link RESTPostAPIWebhookWithTokenJSONBody.thread_name} JSON body property is not specified
*/
thread_id?: Snowflake;
/**
* Whether to allow sending (non-interactive) components for non-application-owned webhooks
* (defaults to `false`; ignored for application-owned webhooks)
*
* @defaultValue `false`
*/
with_components?: boolean;
}
/**
@@ -208,7 +215,7 @@ export type RESTPostAPIWebhookWithTokenWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenSlackQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenSlackQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
@@ -226,7 +233,7 @@ export type RESTPostAPIWebhookWithTokenSlackWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenGitHubQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenGitHubQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
@@ -288,6 +295,11 @@ export type RESTPatchAPIWebhookWithTokenMessageFormDataBody =
})
| (Record<`files[${bigint}]`, unknown> & RESTPatchAPIWebhookWithTokenMessageJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message-query-string-params
*/
export type RESTPatchAPIWebhookWithTokenQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'with_components'>;
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message
*/

28
rest/v9/webhook.ts
View File

@@ -174,7 +174,7 @@ export type RESTPostAPIWebhookWithTokenFormDataBody =
| (Record<`files[${bigint}]`, unknown> & RESTPostAPIWebhookWithTokenJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#execute-webhook-querystring-params
* https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params
*/
export interface RESTPostAPIWebhookWithTokenQuery {
/**
@@ -190,6 +190,13 @@ export interface RESTPostAPIWebhookWithTokenQuery {
* Available only if the {@link RESTPostAPIWebhookWithTokenJSONBody.thread_name} JSON body property is not specified
*/
thread_id?: Snowflake;
/**
* Whether to allow sending (non-interactive) components for non-application-owned webhooks
* (defaults to `false`; ignored for application-owned webhooks)
*
* @defaultValue `false`
*/
with_components?: boolean;
}
/**
@@ -201,14 +208,14 @@ export type RESTPostAPIWebhookWithTokenResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-webhook-querystring-params
* See https://discord.com/developers/docs/resources/webhook#execute-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-querystring-params
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenSlackQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenSlackQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
@@ -219,14 +226,14 @@ export type RESTPostAPIWebhookWithTokenSlackResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-querystring-params
* See https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenSlackWaitResult = APIMessage;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-querystring-params
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenGitHubQuery = RESTPostAPIWebhookWithTokenQuery;
export type RESTPostAPIWebhookWithTokenGitHubQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'wait'>;
/**
* https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
@@ -237,7 +244,7 @@ export type RESTPostAPIWebhookWithTokenGitHubResult = never;
* Received when a call to https://discord.com/developers/docs/resources/webhook#execute-webhook receives
* the `wait` query parameter set to `true`
*
* See https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-querystring-params
* See https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-query-string-params
*/
export type RESTPostAPIWebhookWithTokenGitHubWaitResult = APIMessage;
@@ -288,6 +295,11 @@ export type RESTPatchAPIWebhookWithTokenMessageFormDataBody =
})
| (Record<`files[${bigint}]`, unknown> & RESTPatchAPIWebhookWithTokenMessageJSONBody);
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message-query-string-params
*/
export type RESTPatchAPIWebhookWithTokenQuery = Pick<RESTPostAPIWebhookWithTokenQuery, 'thread_id' | 'with_components'>;
/**
* https://discord.com/developers/docs/resources/webhook#edit-webhook-message
*/