fix(RESTPostAPIChannelMessageJSONBody): number for attachment ids (#811)

2026-05-30 23:40:09 +00:00 · 2023-08-25 00:52:43 +01:00
parent 31c8549fe3
commit 1eb01618a3
8 changed files with 92 additions and 24 deletions
--- a/deno/rest/v10/channel.ts
+++ b/deno/rest/v10/channel.ts
@@ -2,7 +2,6 @@ import type { Permissions, Snowflake } from '../../globals.ts';
 import type {
 	APIActionRowComponent,
 	APIAllowedMentions,
-	APIAttachment,
 	APIChannel,
 	APIEmbed,
 	APIExtendedInvite,
@@ -240,6 +239,24 @@ export type APIMessageReferenceSend = StrictPartial<APIMessageReference> &
 		fail_if_not_exists?: boolean | undefined;
 	};

+/**
+ * https://discord.com/developers/docs/resources/channel#attachment-object
+ */
+export interface RESTAPIAttachment {
+	/**
+	 * Attachment id or a number that matches `n` in `files[n]`
+	 */
+	id: Snowflake | number;
+	/**
+	 * Name of the file
+	 */
+	filename?: string | undefined;
+	/**
+	 * Description of the file
+	 */
+	description?: string | undefined;
+}
+
 /**
 * https://discord.com/developers/docs/resources/channel#create-message
 */
@@ -289,7 +306,7 @@ export interface RESTPostAPIChannelMessageJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -400,7 +417,7 @@ export interface RESTPatchAPIChannelMessageJSONBody {
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * The components to include with the message
 	 *
--- a/deno/rest/v10/webhook.ts
+++ b/deno/rest/v10/webhook.ts
@@ -5,11 +5,11 @@ import type {
 	APIEmbed,
 	APIMessage,
 	APIWebhook,
-	APIAttachment,
 	MessageFlags,
 	APIMessageActionRowComponent,
 } from '../../payloads/v10/mod.ts';
 import type { AddUndefinedToPossiblyUndefinedPropertiesOfInterface, Nullable } from '../../utils/internals.ts';
+import type { RESTAPIAttachment } from './channel.ts';
 /**
 * https://discord.com/developers/docs/resources/webhook#create-webhook
 */
@@ -139,7 +139,7 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -257,7 +257,7 @@ export type RESTPatchAPIWebhookWithTokenMessageJSONBody = AddUndefinedToPossibly
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 };

 /**
--- a/deno/rest/v9/channel.ts
+++ b/deno/rest/v9/channel.ts
@@ -2,7 +2,6 @@ import type { Permissions, Snowflake } from '../../globals.ts';
 import type {
 	APIActionRowComponent,
 	APIAllowedMentions,
-	APIAttachment,
 	APIChannel,
 	APIEmbed,
 	APIExtendedInvite,
@@ -240,6 +239,24 @@ export type APIMessageReferenceSend = StrictPartial<APIMessageReference> &
 		fail_if_not_exists?: boolean | undefined;
 	};

+/**
+ * https://discord.com/developers/docs/resources/channel#attachment-object
+ */
+export interface RESTAPIAttachment {
+	/**
+	 * Attachment id or a number that matches `n` in `files[n]`
+	 */
+	id: Snowflake | number;
+	/**
+	 * Name of the file
+	 */
+	filename?: string | undefined;
+	/**
+	 * Description of the file
+	 */
+	description?: string | undefined;
+}
+
 /**
 * https://discord.com/developers/docs/resources/channel#create-message
 */
@@ -297,7 +314,7 @@ export interface RESTPostAPIChannelMessageJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -416,7 +433,7 @@ export interface RESTPatchAPIChannelMessageJSONBody {
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * The components to include with the message
 	 *
--- a/deno/rest/v9/webhook.ts
+++ b/deno/rest/v9/webhook.ts
@@ -5,11 +5,11 @@ import type {
 	APIEmbed,
 	APIMessage,
 	APIWebhook,
-	APIAttachment,
 	MessageFlags,
 	APIMessageActionRowComponent,
 } from '../../payloads/v9/mod.ts';
 import type { AddUndefinedToPossiblyUndefinedPropertiesOfInterface, Nullable } from '../../utils/internals.ts';
+import type { RESTAPIAttachment } from './channel.ts';
 /**
 * https://discord.com/developers/docs/resources/webhook#create-webhook
 */
@@ -139,7 +139,7 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -257,7 +257,7 @@ export type RESTPatchAPIWebhookWithTokenMessageJSONBody = AddUndefinedToPossibly
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 };

 /**
--- a/rest/v10/channel.ts
+++ b/rest/v10/channel.ts
@@ -2,7 +2,6 @@ import type { Permissions, Snowflake } from '../../globals';
 import type {
 	APIActionRowComponent,
 	APIAllowedMentions,
-	APIAttachment,
 	APIChannel,
 	APIEmbed,
 	APIExtendedInvite,
@@ -240,6 +239,24 @@ export type APIMessageReferenceSend = StrictPartial<APIMessageReference> &
 		fail_if_not_exists?: boolean | undefined;
 	};

+/**
+ * https://discord.com/developers/docs/resources/channel#attachment-object
+ */
+export interface RESTAPIAttachment {
+	/**
+	 * Attachment id or a number that matches `n` in `files[n]`
+	 */
+	id: Snowflake | number;
+	/**
+	 * Name of the file
+	 */
+	filename?: string | undefined;
+	/**
+	 * Description of the file
+	 */
+	description?: string | undefined;
+}
+
 /**
 * https://discord.com/developers/docs/resources/channel#create-message
 */
@@ -289,7 +306,7 @@ export interface RESTPostAPIChannelMessageJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -400,7 +417,7 @@ export interface RESTPatchAPIChannelMessageJSONBody {
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * The components to include with the message
 	 *
--- a/rest/v10/webhook.ts
+++ b/rest/v10/webhook.ts
@@ -5,11 +5,11 @@ import type {
 	APIEmbed,
 	APIMessage,
 	APIWebhook,
-	APIAttachment,
 	MessageFlags,
 	APIMessageActionRowComponent,
 } from '../../payloads/v10/index';
 import type { AddUndefinedToPossiblyUndefinedPropertiesOfInterface, Nullable } from '../../utils/internals';
+import type { RESTAPIAttachment } from './channel';
 /**
 * https://discord.com/developers/docs/resources/webhook#create-webhook
 */
@@ -139,7 +139,7 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -257,7 +257,7 @@ export type RESTPatchAPIWebhookWithTokenMessageJSONBody = AddUndefinedToPossibly
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 };

 /**
--- a/rest/v9/channel.ts
+++ b/rest/v9/channel.ts
@@ -2,7 +2,6 @@ import type { Permissions, Snowflake } from '../../globals';
 import type {
 	APIActionRowComponent,
 	APIAllowedMentions,
-	APIAttachment,
 	APIChannel,
 	APIEmbed,
 	APIExtendedInvite,
@@ -240,6 +239,24 @@ export type APIMessageReferenceSend = StrictPartial<APIMessageReference> &
 		fail_if_not_exists?: boolean | undefined;
 	};

+/**
+ * https://discord.com/developers/docs/resources/channel#attachment-object
+ */
+export interface RESTAPIAttachment {
+	/**
+	 * Attachment id or a number that matches `n` in `files[n]`
+	 */
+	id: Snowflake | number;
+	/**
+	 * Name of the file
+	 */
+	filename?: string | undefined;
+	/**
+	 * Description of the file
+	 */
+	description?: string | undefined;
+}
+
 /**
 * https://discord.com/developers/docs/resources/channel#create-message
 */
@@ -297,7 +314,7 @@ export interface RESTPostAPIChannelMessageJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -416,7 +433,7 @@ export interface RESTPatchAPIChannelMessageJSONBody {
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * The components to include with the message
 	 *
--- a/rest/v9/webhook.ts
+++ b/rest/v9/webhook.ts
@@ -5,11 +5,11 @@ import type {
 	APIEmbed,
 	APIMessage,
 	APIWebhook,
-	APIAttachment,
 	MessageFlags,
 	APIMessageActionRowComponent,
 } from '../../payloads/v9/index';
 import type { AddUndefinedToPossiblyUndefinedPropertiesOfInterface, Nullable } from '../../utils/internals';
+import type { RESTAPIAttachment } from './channel';
 /**
 * https://discord.com/developers/docs/resources/webhook#create-webhook
 */
@@ -139,7 +139,7 @@ export interface RESTPostAPIWebhookWithTokenJSONBody {
 	/**
 	 * Attachment objects with filename and description
 	 */
-	attachments?: (Pick<APIAttachment, 'id' | 'description'> & Partial<Pick<APIAttachment, 'filename'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 	/**
 	 * Message flags combined as a bitfield
 	 */
@@ -257,7 +257,7 @@ export type RESTPatchAPIWebhookWithTokenMessageJSONBody = AddUndefinedToPossibly
 	 *
 	 * See https://discord.com/developers/docs/resources/channel#attachment-object
 	 */
-	attachments?: (Pick<APIAttachment, 'id'> & Partial<Pick<APIAttachment, 'filename' | 'description'>>)[] | undefined;
+	attachments?: RESTAPIAttachment[] | undefined;
 };

 /**