Skip to main content
Module

x/discord_api_types/rest/v6/webhook.ts

Up to date Discord API Typings, versioned by the API version
Go to Latest
File
import type { APIEmbed, APIMessage, APIWebhook } from '../../payloads/v6/mod.ts';import type { APIAllowedMentionsSend } from './channel.ts';
/** * https://discord.com/developers/docs/resources/webhook#create-webhook * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export interface RESTPostAPIChannelWebhookJSONBody { name: string; avatar?: string | null | undefined;}
/** * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPostAPIChannelWebhookResult = APIWebhook;
/** * https://discord.com/developers/docs/resources/webhook#get-channel-webhooks * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTGetAPIChannelWebhooksResult = APIWebhook[];
/** * https://discord.com/developers/docs/resources/webhook#get-guild-webhooks * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTGetAPIGuildWebhooksResult = APIWebhook[];
/** * https://discord.com/developers/docs/resources/webhook#get-webhook * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTGetAPIWebhookResult = APIWebhook;
/** * https://discord.com/developers/docs/resources/webhook#get-webhook-with-token * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTGetAPIWebhookWithTokenResult = Omit<APIWebhook, 'user'>;
/** * https://discord.com/developers/docs/resources/webhook#modify-webhook * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export interface RESTPatchAPIWebhookJSONBody { name?: string | undefined; avatar?: string | null | undefined; channel_id?: string | undefined;}
/** * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPatchAPIWebhookResult = APIWebhook;
/** * https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPatchAPIWebhookWithTokenJSONBody = Omit<RESTPatchAPIWebhookJSONBody, 'channel_id'>;
/** * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPatchAPIWebhookWithTokenResult = Omit<APIWebhook, 'user'>;
/** * https://discord.com/developers/docs/resources/webhook#delete-webhook * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTDeleteAPIWebhookResult = never;
/** * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTDeleteAPIWebhookWithTokenResult = never;
/** * https://discord.com/developers/docs/resources/webhook#execute-webhook * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export interface RESTPostAPIWebhookWithTokenJSONBody { content?: string | undefined; username?: string | undefined; avatar_url?: string | undefined; tts?: boolean | undefined; embeds?: APIEmbed[] | undefined; allowed_mentions?: APIAllowedMentionsSend | undefined;}
/** * https://discord.com/developers/docs/resources/webhook#execute-webhook * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPostAPIWebhookWithTokenFormDataBody = | { /** * JSON stringified message body */ payload_json?: string | undefined; /** * The file contents */ file: unknown; } | (RESTPostAPIWebhookWithTokenJSONBody & { /** * The file contents */ file: unknown; });
/** * https://discord.com/developers/docs/resources/webhook#execute-webhook-querystring-params * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export interface RESTPostAPIWebhookWithTokenQuery { wait?: boolean;}
/** * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPostAPIWebhookWithTokenResult = never;
/** * Received when a call to POST `/webhooks/{webhook.id}/{webhook.token}` receives * the `wait` query parameter set to `true` * * @see https://discord.com/developers/docs/resources/webhook#execute-webhook-querystring-params * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPostAPIWebhookWithTokenWaitResult = APIMessage;
/** * https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook-querystring-params * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPostAPIWebhookWithTokenSlackQuery = RESTPostAPIWebhookWithTokenQuery;
/** * https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook-querystring-params * * @deprecated API v6 is deprecated and the types will not receive further updates, please update to v8. */export type RESTPostAPIWebhookWithTokenGitHubQuery = RESTPostAPIWebhookWithTokenQuery;