@discordjs/core 0.1.1-dev.1670415672-976b234.0 → 0.1.1-dev.1670890198-b14604a.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -12,6 +12,7 @@ declare class ApplicationCommandsAPI {
12
12
  /**
13
13
  * Fetches all global commands for a application
14
14
  *
15
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands}
15
16
  * @param applicationId - The application id to fetch commands for
16
17
  * @param options - The options to use when fetching commands
17
18
  */
@@ -19,6 +20,7 @@ declare class ApplicationCommandsAPI {
19
20
  /**
20
21
  * Creates a new global command
21
22
  *
23
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#create-global-application-command}
22
24
  * @param applicationId - The application id to create the command for
23
25
  * @param data - The data to use when creating the command
24
26
  */
@@ -26,6 +28,7 @@ declare class ApplicationCommandsAPI {
26
28
  /**
27
29
  * Fetches a global command
28
30
  *
31
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-global-application-command}
29
32
  * @param applicationId - The application id to fetch the command from
30
33
  * @param commandId - The command id to fetch
31
34
  */
@@ -33,6 +36,7 @@ declare class ApplicationCommandsAPI {
33
36
  /**
34
37
  * Edits a global command
35
38
  *
39
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command}
36
40
  * @param applicationId - The application id of the command
37
41
  * @param commandId - The id of the command to edit
38
42
  * @param data - The data to use when editing the command
@@ -41,6 +45,7 @@ declare class ApplicationCommandsAPI {
41
45
  /**
42
46
  * Deletes a global command
43
47
  *
48
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#delete-global-application-command}
44
49
  * @param applicationId - The application id of the command
45
50
  * @param commandId - The id of the command to delete
46
51
  */
@@ -48,6 +53,7 @@ declare class ApplicationCommandsAPI {
48
53
  /**
49
54
  * Overwrites global commands
50
55
  *
56
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands}
51
57
  * @param applicationId - The application id to overwrite commands for
52
58
  * @param data - The data to use when overwriting commands
53
59
  */
@@ -55,6 +61,7 @@ declare class ApplicationCommandsAPI {
55
61
  /**
56
62
  * Fetches all commands for a guild
57
63
  *
64
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands}
58
65
  * @param applicationId - The application id to fetch commands for
59
66
  * @param guildId - The guild id to fetch commands for
60
67
  * @param data - The data to use when fetching commands
@@ -63,6 +70,7 @@ declare class ApplicationCommandsAPI {
63
70
  /**
64
71
  * Creates a new command for a guild
65
72
  *
73
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command}
66
74
  * @param applicationId - The application id to create the command for
67
75
  * @param guildId - The guild id to create the command for
68
76
  * @param data - The data to use when creating the command
@@ -71,6 +79,7 @@ declare class ApplicationCommandsAPI {
71
79
  /**
72
80
  * Fetches a guild command
73
81
  *
82
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command}
74
83
  * @param applicationId - The application id to fetch the command from
75
84
  * @param guildId - The guild id to fetch the command from
76
85
  * @param commandId - The command id to fetch
@@ -79,6 +88,7 @@ declare class ApplicationCommandsAPI {
79
88
  /**
80
89
  * Edits a guild command
81
90
  *
91
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command}
82
92
  * @param applicationId - The application id of the command
83
93
  * @param guildId - The guild id of the command
84
94
  * @param commandId - The command id to edit
@@ -88,6 +98,7 @@ declare class ApplicationCommandsAPI {
88
98
  /**
89
99
  * Deletes a guild command
90
100
  *
101
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#delete-guild-application-command}
91
102
  * @param applicationId - The application id of the command
92
103
  * @param guildId - The guild id of the command
93
104
  * @param commandId - The id of the command to delete
@@ -96,6 +107,7 @@ declare class ApplicationCommandsAPI {
96
107
  /**
97
108
  * Bulk overwrites guild commands
98
109
  *
110
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands}
99
111
  * @param applicationId - The application id to overwrite commands for
100
112
  * @param guildId - The guild id to overwrite commands for
101
113
  * @param data - The data to use when overwriting commands
@@ -104,6 +116,7 @@ declare class ApplicationCommandsAPI {
104
116
  /**
105
117
  * Fetches the permissions for a guild command
106
118
  *
119
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions}
107
120
  * @param applicationId - The application id to get the permissions for
108
121
  * @param guildId - The guild id of the command
109
122
  * @param commandId - The command id to get the permissions for
@@ -112,6 +125,7 @@ declare class ApplicationCommandsAPI {
112
125
  /**
113
126
  * Fetches all permissions for all commands in a guild
114
127
  *
128
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions}
115
129
  * @param applicationId - The application id to get the permissions for
116
130
  * @param guildId - The guild id to get the permissions for
117
131
  */
@@ -119,6 +133,7 @@ declare class ApplicationCommandsAPI {
119
133
  /**
120
134
  * Edits the permissions for a guild command
121
135
  *
136
+ * @see {@link https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions}
122
137
  * @param userToken - The token of the user to edit permissions on behalf of
123
138
  * @param applicationId - The application id to edit the permissions for
124
139
  * @param guildId - The guild id to edit the permissions for
@@ -134,6 +149,7 @@ declare class ChannelsAPI {
134
149
  /**
135
150
  * Sends a message in a channel
136
151
  *
152
+ * @see {@link https://discord.com/developers/docs/resources/channel#create-message}
137
153
  * @param channelId - The id of the channel to send the message in
138
154
  * @param data - The data to use when sending the message
139
155
  */
@@ -143,6 +159,7 @@ declare class ChannelsAPI {
143
159
  /**
144
160
  * Edits a message
145
161
  *
162
+ * @see {@link https://discord.com/developers/docs/resources/channel#edit-message}
146
163
  * @param channelId - The id of the channel the message is in
147
164
  * @param messageId - The id of the message to edit
148
165
  * @param data - The data to use when editing the message
@@ -153,6 +170,7 @@ declare class ChannelsAPI {
153
170
  /**
154
171
  * Fetches the reactions for a message
155
172
  *
173
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-reactions}
156
174
  * @param channelId - The id of the channel the message is in
157
175
  * @param messageId - The id of the message to get the reactions for
158
176
  * @param emoji - The emoji to get the reactions for
@@ -162,6 +180,7 @@ declare class ChannelsAPI {
162
180
  /**
163
181
  * Deletes a reaction for the current user
164
182
  *
183
+ * @see {@link https://discord.com/developers/docs/resources/channel#delete-own-reaction}
165
184
  * @param channelId - The id of the channel the message is in
166
185
  * @param messageId - The id of the message to delete the reaction for
167
186
  * @param emoji - The emoji to delete the reaction for
@@ -170,6 +189,7 @@ declare class ChannelsAPI {
170
189
  /**
171
190
  * Deletes a reaction for a user
172
191
  *
192
+ * @see {@link https://discord.com/developers/docs/resources/channel#delete-user-reaction}
173
193
  * @param channelId - The id of the channel the message is in
174
194
  * @param messageId - The id of the message to delete the reaction for
175
195
  * @param emoji - The emoji to delete the reaction for
@@ -179,6 +199,7 @@ declare class ChannelsAPI {
179
199
  /**
180
200
  * Deletes all reactions for a message
181
201
  *
202
+ * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions}
182
203
  * @param channelId - The id of the channel the message is in
183
204
  * @param messageId - The id of the message to delete the reactions for
184
205
  */
@@ -186,6 +207,7 @@ declare class ChannelsAPI {
186
207
  /**
187
208
  * Deletes all reactions of an emoji for a message
188
209
  *
210
+ * @see {@link https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji}
189
211
  * @param channelId - The id of the channel the message is in
190
212
  * @param messageId - The id of the message to delete the reactions for
191
213
  * @param emoji - The emoji to delete the reactions for
@@ -194,6 +216,7 @@ declare class ChannelsAPI {
194
216
  /**
195
217
  * Adds a reaction to a message
196
218
  *
219
+ * @see {@link https://discord.com/developers/docs/resources/channel#create-reaction}
197
220
  * @param channelId - The id of the channel the message is in
198
221
  * @param messageId - The id of the message to add the reaction to
199
222
  * @param emoji - The emoji to add the reaction with
@@ -202,12 +225,14 @@ declare class ChannelsAPI {
202
225
  /**
203
226
  * Fetches a channel
204
227
  *
228
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-channel}
205
229
  * @param channelId - The id of the channel
206
230
  */
207
231
  get(channelId: Snowflake): Promise<discord_api_types_v10.APIChannel>;
208
232
  /**
209
233
  * Edits a channel
210
234
  *
235
+ * @see {@link https://discord.com/developers/docs/resources/channel#modify-channel}
211
236
  * @param channelId - The id of the channel to edit
212
237
  * @param data - The new channel data
213
238
  */
@@ -215,12 +240,14 @@ declare class ChannelsAPI {
215
240
  /**
216
241
  * Deletes a channel
217
242
  *
243
+ * @see {@link https://discord.com/developers/docs/resources/channel#deleteclose-channel}
218
244
  * @param channelId - The id of the channel to delete
219
245
  */
220
246
  delete(channelId: Snowflake): Promise<discord_api_types_v10.APIChannel>;
221
247
  /**
222
248
  * Fetches the messages of a channel
223
249
  *
250
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-messages}
224
251
  * @param channelId - The id of the channel to fetch messages from
225
252
  * @param options - The options to use when fetching messages
226
253
  */
@@ -228,18 +255,21 @@ declare class ChannelsAPI {
228
255
  /**
229
256
  * Shows a typing indicator in a channel
230
257
  *
258
+ * @see {@link https://discord.com/developers/docs/resources/channel#trigger-typing-indicator}
231
259
  * @param channelId - The id of the channel to show the typing indicator in
232
260
  */
233
261
  showTyping(channelId: Snowflake): Promise<void>;
234
262
  /**
235
263
  * Fetches the pinned messages of a channel
236
264
  *
265
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-pinned-messages}
237
266
  * @param channelId - The id of the channel to fetch pinned messages from
238
267
  */
239
268
  getPins(channelId: Snowflake): Promise<RESTGetAPIChannelPinsResult>;
240
269
  /**
241
270
  * Pins a message in a channel
242
271
  *
272
+ * @see {@link https://discord.com/developers/docs/resources/channel#pin-message}
243
273
  * @param channelId - The id of the channel to pin the message in
244
274
  * @param messageId - The id of the message to pin
245
275
  * @param reason - The reason for pinning the message
@@ -248,6 +278,7 @@ declare class ChannelsAPI {
248
278
  /**
249
279
  * Deletes a message
250
280
  *
281
+ * @see {@link https://discord.com/developers/docs/resources/channel#delete-message}
251
282
  * @param channelId - The id of the channel the message is in
252
283
  * @param messageId - The id of the message to delete
253
284
  * @param reason - The reason for deleting the message
@@ -256,6 +287,7 @@ declare class ChannelsAPI {
256
287
  /**
257
288
  * Bulk deletes messages
258
289
  *
290
+ * @see {@link https://discord.com/developers/docs/resources/channel#bulk-delete-messages}
259
291
  * @param channelId - The id of the channel the messages are in
260
292
  * @param messageIds - The ids of the messages to delete
261
293
  */
@@ -263,6 +295,7 @@ declare class ChannelsAPI {
263
295
  /**
264
296
  * Fetches a message
265
297
  *
298
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-message}
266
299
  * @param channelId - The id of the channel the message is in
267
300
  * @param messageId - The id of the message to fetch
268
301
  */
@@ -270,6 +303,7 @@ declare class ChannelsAPI {
270
303
  /**
271
304
  * Crossposts a message
272
305
  *
306
+ * @see {@link https://discord.com/developers/docs/resources/channel#crosspost-message}
273
307
  * @param channelId - The id of the channel the message is in
274
308
  * @param messageId - The id of the message to crosspost
275
309
  */
@@ -277,6 +311,7 @@ declare class ChannelsAPI {
277
311
  /**
278
312
  * Unpins a message in a channel
279
313
  *
314
+ * @see {@link https://discord.com/developers/docs/resources/channel#unpin-message}
280
315
  * @param channelId - The id of the channel to unpin the message in
281
316
  * @param messageId - The id of the message to unpin
282
317
  * @param reason - The reason for unpinning the message
@@ -285,6 +320,7 @@ declare class ChannelsAPI {
285
320
  /**
286
321
  * Follows an announcement channel
287
322
  *
323
+ * @see {@link https://discord.com/developers/docs/resources/channel#follow-announcement-channel}
288
324
  * @param channelId - The id of the announcement channel to follow
289
325
  * @param webhookChannelId - The id of the webhook channel to follow the announcements in
290
326
  */
@@ -292,6 +328,7 @@ declare class ChannelsAPI {
292
328
  /**
293
329
  * Creates a new invite for a channel
294
330
  *
331
+ * @see {@link https://discord.com/developers/docs/resources/channel#create-channel-invite}
295
332
  * @param channelId - The id of the channel to create an invite for
296
333
  * @param data - The data to use when creating the invite
297
334
  */
@@ -299,12 +336,15 @@ declare class ChannelsAPI {
299
336
  /**
300
337
  * Fetches the invites of a channel
301
338
  *
339
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-channel-invites}
302
340
  * @param channelId - The id of the channel to fetch invites from
303
341
  */
304
342
  getInvites(channelId: Snowflake): Promise<RESTGetAPIChannelInvitesResult>;
305
343
  /**
306
344
  * Fetches the archived threads of a channel
307
345
  *
346
+ * @see {@link https://discord.com/developers/docs/resources/channel#list-public-archived-threads}
347
+ * @see {@link https://discord.com/developers/docs/resources/channel#list-private-archived-threads}
308
348
  * @param channelId - The id of the channel to fetch archived threads from
309
349
  * @param archivedStatus - The archived status of the threads to fetch
310
350
  * @param options - The options to use when fetching archived threads
@@ -313,6 +353,7 @@ declare class ChannelsAPI {
313
353
  /**
314
354
  * Fetches the private joined archived threads of a channel
315
355
  *
356
+ * @see {@link https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads}
316
357
  * @param channelId - The id of the channel to fetch joined archived threads from
317
358
  * @param options - The options to use when fetching joined archived threads
318
359
  */
@@ -325,24 +366,28 @@ declare class GuildsAPI {
325
366
  /**
326
367
  * Fetches a guild
327
368
  *
369
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild}
328
370
  * @param guildId - The id of the guild
329
371
  */
330
372
  get(guildId: string): Promise<discord_api_types_v10.APIGuild>;
331
373
  /**
332
374
  * Fetches a guild preview
333
375
  *
376
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-preview}
334
377
  * @param guildId - The id of the guild to fetch the preview from
335
378
  */
336
379
  getPreview(guildId: Snowflake): Promise<discord_api_types_v10.APIGuildPreview>;
337
380
  /**
338
381
  * Creates a guild
339
382
  *
383
+ * @see {@link https://discord.com/developers/docs/resources/guild#create-guild}
340
384
  * @param data - The guild to create
341
385
  */
342
386
  create(data: RESTPostAPIGuildsJSONBody): Promise<discord_api_types_v10.APIGuild>;
343
387
  /**
344
388
  * Edits a guild
345
389
  *
390
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild}
346
391
  * @param guildId - The id of the guild to edit
347
392
  * @param data - The new guild data
348
393
  * @param reason - The reason for editing this guild
@@ -351,6 +396,7 @@ declare class GuildsAPI {
351
396
  /**
352
397
  * Deletes a guild
353
398
  *
399
+ * @see {@link https://discord.com/developers/docs/resources/guild#delete-guild}
354
400
  * @param guildId - The id of the guild to delete
355
401
  * @param reason - The reason for deleting this guild
356
402
  */
@@ -358,6 +404,7 @@ declare class GuildsAPI {
358
404
  /**
359
405
  * Fetches all the members of a guild
360
406
  *
407
+ * @see {@link https://discord.com/developers/docs/resources/guild#list-guild-members}
361
408
  * @param guildId - The id of the guild
362
409
  * @param options - The options to use when fetching the guild members
363
410
  */
@@ -365,12 +412,14 @@ declare class GuildsAPI {
365
412
  /**
366
413
  * Fetches a guild's channels
367
414
  *
415
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-channels}
368
416
  * @param guildId - The id of the guild to fetch the channels from
369
417
  */
370
418
  getChannels(guildId: Snowflake): Promise<RESTGetAPIGuildChannelsResult>;
371
419
  /**
372
420
  * Creates a guild channel
373
421
  *
422
+ * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-channel}
374
423
  * @param guildId - The id of the guild to create the channel in
375
424
  * @param data - The data to create the new channel
376
425
  * @param reason - The reason for creating this channel
@@ -379,6 +428,7 @@ declare class GuildsAPI {
379
428
  /**
380
429
  * Edits a guild channel's positions
381
430
  *
431
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions}
382
432
  * @param guildId - The id of the guild to edit the channel positions from
383
433
  * @param data - The data to edit the channel positions with
384
434
  * @param reason - The reason for editing the channel positions
@@ -387,18 +437,21 @@ declare class GuildsAPI {
387
437
  /**
388
438
  * Fetches the active threads in a guild
389
439
  *
440
+ * @see {@link https://discord.com/developers/docs/resources/guild#list-active-guild-threads}
390
441
  * @param guildId - The id of the guild to fetch the active threads from
391
442
  */
392
443
  getActiveThreads(guildId: Snowflake): Promise<discord_api_types_v10.APIThreadList>;
393
444
  /**
394
445
  * Fetches a guild member ban
395
446
  *
447
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-bans}
396
448
  * @param guildId - The id of the guild to fetch the ban from
397
449
  */
398
450
  getMemberBans(guildId: Snowflake): Promise<RESTGetAPIGuildBansResult>;
399
451
  /**
400
452
  * Bans a user from a guild
401
453
  *
454
+ * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-ban}
402
455
  * @param guildId - The id of the guild to ban the member in
403
456
  * @param userId - The id of the user to ban
404
457
  * @param options - Options for banning the user
@@ -408,6 +461,7 @@ declare class GuildsAPI {
408
461
  /**
409
462
  * Unbans a user from a guild
410
463
  *
464
+ * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-ban}
411
465
  * @param guildId - The id of the guild to unban the member in
412
466
  * @param userId - The id of the user to unban
413
467
  * @param reason - The reason for unbanning the user
@@ -416,12 +470,14 @@ declare class GuildsAPI {
416
470
  /**
417
471
  * Gets all the roles in a guild
418
472
  *
473
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-roles}
419
474
  * @param guildId - The id of the guild to fetch the roles from
420
475
  */
421
476
  getRoles(guildId: Snowflake): Promise<RESTGetAPIGuildRolesResult>;
422
477
  /**
423
478
  * Creates a guild role
424
479
  *
480
+ * @see {@link https://discord.com/developers/docs/resources/guild#create-guild-role}
425
481
  * @param guildId - The id of the guild to create the role in
426
482
  * @param data - The data to create the role with
427
483
  * @param reason - The reason for creating the role
@@ -430,6 +486,7 @@ declare class GuildsAPI {
430
486
  /**
431
487
  * Sets role positions in a guild
432
488
  *
489
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role-positions}
433
490
  * @param guildId - The id of the guild to set role positions for
434
491
  * @param data - The data for setting a role position
435
492
  * @param reason - The reason for setting the role position
@@ -438,6 +495,7 @@ declare class GuildsAPI {
438
495
  /**
439
496
  * Edits a guild role
440
497
  *
498
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-role}
441
499
  * @param guildId - The id of the guild to edit the role in
442
500
  * @param roleId - The id of the role to edit
443
501
  * @param data - data for editing the role
@@ -447,6 +505,7 @@ declare class GuildsAPI {
447
505
  /**
448
506
  * Deletes a guild role
449
507
  *
508
+ * @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-role}
450
509
  * @param guildId - The id of the guild to delete the role in
451
510
  * @param roleId - The id of the role to delete
452
511
  * @param reason - The reason for deleting the role
@@ -455,6 +514,7 @@ declare class GuildsAPI {
455
514
  /**
456
515
  * Edits the multi-factor-authentication (MFA) level of a guild
457
516
  *
517
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level}
458
518
  * @param guildId - The id of the guild to edit the MFA level for
459
519
  * @param level - The new MFA level
460
520
  * @param reason - The reason for editing the MFA level
@@ -463,6 +523,7 @@ declare class GuildsAPI {
463
523
  /**
464
524
  * Fetch the number of members that can be pruned from a guild
465
525
  *
526
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-prune-count}
466
527
  * @param guildId - The id of the guild to fetch the number of pruned members from
467
528
  * @param options - The options for fetching the number of pruned members
468
529
  */
@@ -470,6 +531,7 @@ declare class GuildsAPI {
470
531
  /**
471
532
  * Prunes members in a guild
472
533
  *
534
+ * @see {@link https://discord.com/developers/docs/resources/guild#begin-guild-prune}
473
535
  * @param guildId - The id of the guild to prune members in
474
536
  * @param options - The options for pruning members
475
537
  * @param reason - The reason for pruning members
@@ -478,24 +540,28 @@ declare class GuildsAPI {
478
540
  /**
479
541
  * Fetches voice regions for a guild
480
542
  *
543
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-voice-regions}
481
544
  * @param guildId - The id of the guild to fetch the voice regions from
482
545
  */
483
546
  getVoiceRegions(guildId: Snowflake): Promise<RESTGetAPIGuildVoiceRegionsResult>;
484
547
  /**
485
548
  * Fetches the invites for a guild
486
549
  *
550
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-invites}
487
551
  * @param guildId - The id of the guild to fetch the invites from
488
552
  */
489
553
  getInvites(guildId: Snowflake): Promise<RESTGetAPIGuildInvitesResult>;
490
554
  /**
491
555
  * Fetches the integrations for a guild
492
556
  *
557
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-integrations}
493
558
  * @param guildId - The id of the guild to fetch the integrations from
494
559
  */
495
560
  getIntegrations(guildId: Snowflake): Promise<RESTGetAPIGuildIntegrationsResult>;
496
561
  /**
497
562
  * Deletes an integration from a guild
498
563
  *
564
+ * @see {@link https://discord.com/developers/docs/resources/guild#delete-guild-integration}
499
565
  * @param guildId - The id of the guild to delete the integration from
500
566
  * @param integrationId - The id of the integration to delete
501
567
  * @param reason - The reason for deleting the integration
@@ -504,12 +570,14 @@ declare class GuildsAPI {
504
570
  /**
505
571
  * Fetches the widget settings for a guild
506
572
  *
573
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-settings}
507
574
  * @param guildId - The id of the guild to fetch the widget settings from
508
575
  */
509
576
  getWidgetSettings(guildId: Snowflake): Promise<ArrayBuffer>;
510
577
  /**
511
578
  * Edits the widget settings for a guild
512
579
  *
580
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-widget}
513
581
  * @param guildId - The id of the guild to edit the widget settings from
514
582
  * @param data - The new widget settings data
515
583
  * @param reason - The reason for editing the widget settings
@@ -518,18 +586,21 @@ declare class GuildsAPI {
518
586
  /**
519
587
  * Fetches the widget for a guild
520
588
  *
589
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget}
521
590
  * @param guildId - The id of the guild to fetch the widget from
522
591
  */
523
592
  getWidget(guildId: Snowflake): Promise<discord_api_types_v10.APIGuildWidget>;
524
593
  /**
525
594
  * Fetches the vanity url for a guild
526
595
  *
596
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-vanity-url}
527
597
  * @param guildId - The id of the guild to fetch the vanity url from
528
598
  */
529
599
  getVanityURL(guildId: Snowflake): Promise<RESTGetAPIGuildVanityUrlResult>;
530
600
  /**
531
601
  * Fetches the widget image for a guild
532
602
  *
603
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-widget-image}
533
604
  * @param guildId - The id of the guild to fetch the widget image from
534
605
  * @param style - The style of the widget image
535
606
  */
@@ -537,12 +608,14 @@ declare class GuildsAPI {
537
608
  /**
538
609
  * Fetches the welcome screen for a guild
539
610
  *
611
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen}
540
612
  * @param guildId - The id of the guild to fetch the welcome screen from
541
613
  */
542
614
  getWelcomeScreen(guildId: Snowflake): Promise<discord_api_types_v10.APIGuildWelcomeScreen>;
543
615
  /**
544
616
  * Edits the welcome screen for a guild
545
617
  *
618
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen}
546
619
  * @param guildId - The id of the guild to edit the welcome screen for
547
620
  * @param data - The new welcome screen data
548
621
  * @param reason - The reason for editing the welcome screen
@@ -551,6 +624,7 @@ declare class GuildsAPI {
551
624
  /**
552
625
  * Edits a user's voice state in a guild
553
626
  *
627
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-user-voice-state}
554
628
  * @param guildId - The id of the guild to edit the current user's voice state in
555
629
  * @param userId - The id of the user to edit the voice state for
556
630
  * @param data - The data for editing the voice state
@@ -560,12 +634,14 @@ declare class GuildsAPI {
560
634
  /**
561
635
  * Fetches all emojis for a guild
562
636
  *
637
+ * @see {@link https://discord.com/developers/docs/resources/emoji#list-guild-emojis}
563
638
  * @param guildId - The id of the guild to fetch the emojis from
564
639
  */
565
640
  getEmojis(guildId: Snowflake): Promise<RESTGetAPIGuildEmojisResult>;
566
641
  /**
567
642
  * Fetches an emoji for a guild
568
643
  *
644
+ * @see {@link https://discord.com/developers/docs/resources/emoji#get-guild-emoji}
569
645
  * @param guildId - The id of the guild to fetch the emoji from
570
646
  * @param emojiId - The id of the emoji to fetch
571
647
  */
@@ -573,6 +649,7 @@ declare class GuildsAPI {
573
649
  /**
574
650
  * Creates a new emoji for a guild
575
651
  *
652
+ * @see {@link https://discord.com/developers/docs/resources/emoji#create-guild-emoji}
576
653
  * @param guildId - The id of the guild to create the emoji from
577
654
  * @param data - The data for creating the emoji
578
655
  * @param reason - The reason for creating the emoji
@@ -581,6 +658,7 @@ declare class GuildsAPI {
581
658
  /**
582
659
  * Edits an emoji for a guild
583
660
  *
661
+ * @see {@link https://discord.com/developers/docs/resources/emoji#modify-guild-emoji}
584
662
  * @param guildId - The id of the guild to edit the emoji from
585
663
  * @param emojiId - The id of the emoji to edit
586
664
  * @param data - The data for editing the emoji
@@ -590,6 +668,7 @@ declare class GuildsAPI {
590
668
  /**
591
669
  * Deletes an emoji for a guild
592
670
  *
671
+ * @see {@link https://discord.com/developers/docs/resources/emoji#delete-guild-emoji}
593
672
  * @param guildId - The id of the guild to delete the emoji from
594
673
  * @param emojiId - The id of the emoji to delete
595
674
  * @param reason - The reason for deleting the emoji
@@ -598,6 +677,7 @@ declare class GuildsAPI {
598
677
  /**
599
678
  * Fetches all scheduled events for a guild
600
679
  *
680
+ * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild}
601
681
  * @param guildId - The id of the guild to fetch the scheduled events from
602
682
  * @param options - The options for fetching the scheduled events
603
683
  */
@@ -605,6 +685,7 @@ declare class GuildsAPI {
605
685
  /**
606
686
  * Creates a new scheduled event for a guild
607
687
  *
688
+ * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event}
608
689
  * @param guildId - The id of the guild to create the scheduled event from
609
690
  * @param data - The data to create the event with
610
691
  * @param reason - The reason for creating the scheduled event
@@ -613,6 +694,7 @@ declare class GuildsAPI {
613
694
  /**
614
695
  * Fetches a scheduled event for a guild
615
696
  *
697
+ * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event}
616
698
  * @param guildId - The id of the guild to fetch the scheduled event from
617
699
  * @param eventId - The id of the scheduled event to fetch
618
700
  * @param options - The options for fetching the scheduled event
@@ -621,6 +703,7 @@ declare class GuildsAPI {
621
703
  /**
622
704
  * Edits a scheduled event for a guild
623
705
  *
706
+ * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event}
624
707
  * @param guildId - The id of the guild to edit the scheduled event from
625
708
  * @param eventId - The id of the scheduled event to edit
626
709
  * @param data - The new event data
@@ -630,6 +713,7 @@ declare class GuildsAPI {
630
713
  /**
631
714
  * Deletes a scheduled event for a guild
632
715
  *
716
+ * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event}
633
717
  * @param guildId - The id of the guild to delete the scheduled event from
634
718
  * @param eventId - The id of the scheduled event to delete
635
719
  * @param reason - The reason for deleting the scheduled event
@@ -638,6 +722,7 @@ declare class GuildsAPI {
638
722
  /**
639
723
  * Gets all users that are interested in a scheduled event
640
724
  *
725
+ * @see {@link https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users}
641
726
  * @param guildId - The id of the guild to fetch the scheduled event users from
642
727
  * @param eventId - The id of the scheduled event to fetch the users for
643
728
  * @param options - The options for fetching the scheduled event users
@@ -646,12 +731,14 @@ declare class GuildsAPI {
646
731
  /**
647
732
  * Fetches all the templates for a guild
648
733
  *
734
+ * @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-templates}
649
735
  * @param guildId - The id of the guild to fetch the templates from
650
736
  */
651
737
  getTemplates(guildId: Snowflake): Promise<RESTGetAPIGuildTemplatesResult>;
652
738
  /**
653
739
  * Syncs a template for a guild
654
740
  *
741
+ * @see {@link https://discord.com/developers/docs/resources/guild-template#sync-guild-template}
655
742
  * @param guildId - The id of the guild to sync the template from
656
743
  * @param templateCode - The code of the template to sync
657
744
  */
@@ -659,6 +746,7 @@ declare class GuildsAPI {
659
746
  /**
660
747
  * Edits a template for a guild
661
748
  *
749
+ * @see {@link https://discord.com/developers/docs/resources/guild-template#modify-guild-template}
662
750
  * @param guildId - The id of the guild to edit the template from
663
751
  * @param templateCode - The code of the template to edit
664
752
  * @param data - The data for editing the template
@@ -667,6 +755,7 @@ declare class GuildsAPI {
667
755
  /**
668
756
  * Deletes a template for a guild
669
757
  *
758
+ * @see {@link https://discord.com/developers/docs/resources/guild-template#delete-guild-template}
670
759
  * @param guildId - The id of the guild to delete the template from
671
760
  * @param templateCode - The code of the template to delete
672
761
  */
@@ -674,12 +763,14 @@ declare class GuildsAPI {
674
763
  /**
675
764
  * Fetches all the stickers for a guild
676
765
  *
766
+ * @see {@link https://discord.com/developers/docs/resources/sticker#list-guild-stickers}
677
767
  * @param guildId - The id of the guild to fetch the stickers from
678
768
  */
679
769
  getStickers(guildId: Snowflake): Promise<RESTGetAPIGuildStickersResult>;
680
770
  /**
681
771
  * Fetches a sticker for a guild
682
772
  *
773
+ * @see {@link https://discord.com/developers/docs/resources/sticker#get-guild-sticker}
683
774
  * @param guildId - The id of the guild to fetch the sticker from
684
775
  * @param stickerId - The id of the sticker to fetch
685
776
  */
@@ -687,6 +778,7 @@ declare class GuildsAPI {
687
778
  /**
688
779
  * Creates a sticker for a guild
689
780
  *
781
+ * @see {@link https://discord.com/developers/docs/resources/sticker#create-guild-sticker}
690
782
  * @param guildId - The id of the guild to create the sticker for
691
783
  * @param data - The data for creating the sticker
692
784
  * @param reason - The reason for creating the sticker
@@ -697,6 +789,7 @@ declare class GuildsAPI {
697
789
  /**
698
790
  * Edits a sticker for a guild
699
791
  *
792
+ * @see {@link https://discord.com/developers/docs/resources/sticker#modify-guild-sticker}
700
793
  * @param guildId - The id of the guild to edit the sticker from
701
794
  * @param stickerId - The id of the sticker to edit
702
795
  * @param data - The data for editing the sticker
@@ -706,6 +799,7 @@ declare class GuildsAPI {
706
799
  /**
707
800
  * Deletes a sticker for a guild
708
801
  *
802
+ * @see {@link https://discord.com/developers/docs/resources/sticker#delete-guild-sticker}
709
803
  * @param guildId - The id of the guild to delete the sticker from
710
804
  * @param stickerId - The id of the sticker to delete
711
805
  * @param reason - The reason for deleting the sticker
@@ -714,6 +808,7 @@ declare class GuildsAPI {
714
808
  /**
715
809
  * Fetches the audit logs for a guild
716
810
  *
811
+ * @see {@link https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log}
717
812
  * @param guildId - The id of the guild to fetch the audit logs from
718
813
  * @param options - The options for fetching the audit logs
719
814
  */
@@ -721,12 +816,14 @@ declare class GuildsAPI {
721
816
  /**
722
817
  * Fetches all auto moderation rules for a guild
723
818
  *
819
+ * @see {@link https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild}
724
820
  * @param guildId - The id of the guild to fetch the auto moderation rules from
725
821
  */
726
822
  getAutoModerationRules(guildId: Snowflake): Promise<RESTGetAPIAutoModerationRulesResult>;
727
823
  /**
728
824
  * Fetches an auto moderation rule for a guild
729
825
  *
826
+ * @see {@link https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule}
730
827
  * @param guildId - The id of the guild to fetch the auto moderation rule from
731
828
  * @param ruleId - The id of the auto moderation rule to fetch
732
829
  */
@@ -734,6 +831,7 @@ declare class GuildsAPI {
734
831
  /**
735
832
  * Creates a new auto moderation rule for a guild
736
833
  *
834
+ * @see {@link https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule}
737
835
  * @param guildId - The id of the guild to create the auto moderation rule from
738
836
  * @param data - The data for creating the auto moderation rule
739
837
  */
@@ -741,6 +839,7 @@ declare class GuildsAPI {
741
839
  /**
742
840
  * Edits an auto moderation rule for a guild
743
841
  *
842
+ * @see {@link https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule}
744
843
  * @param guildId - The id of the guild to edit the auto moderation rule from
745
844
  * @param ruleId - The id of the auto moderation rule to edit
746
845
  * @param data - The data for editing the auto moderation rule
@@ -750,6 +849,7 @@ declare class GuildsAPI {
750
849
  /**
751
850
  * Deletes an auto moderation rule for a guild
752
851
  *
852
+ * @see {@link https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule}
753
853
  * @param guildId - The id of the guild to delete the auto moderation rule from
754
854
  * @param ruleId - The id of the auto moderation rule to delete
755
855
  * @param reason - The reason for deleting the auto moderation rule
@@ -758,6 +858,7 @@ declare class GuildsAPI {
758
858
  /**
759
859
  * Fetches a guild member
760
860
  *
861
+ * @see {@link https://discord.com/developers/docs/resources/guild#get-guild-member}
761
862
  * @param guildId - The id of the guild
762
863
  * @param userId - The id of the user
763
864
  */
@@ -765,6 +866,7 @@ declare class GuildsAPI {
765
866
  /**
766
867
  * Searches for guild members
767
868
  *
869
+ * @see {@link https://discord.com/developers/docs/resources/guild#search-guild-members}
768
870
  * @param guildId - The id of the guild to search in
769
871
  * @param query - The query to search for
770
872
  * @param limit - The maximum number of members to return
@@ -773,6 +875,7 @@ declare class GuildsAPI {
773
875
  /**
774
876
  * Edits a guild member
775
877
  *
878
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-guild-member}
776
879
  * @param guildId - The id of the guild
777
880
  * @param userId - The id of the user
778
881
  * @param data - The data to use when editing the guild member
@@ -782,6 +885,7 @@ declare class GuildsAPI {
782
885
  /**
783
886
  * Adds a role to a guild member
784
887
  *
888
+ * @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member-role}
785
889
  * @param guildId - The id of the guild
786
890
  * @param userId - The id of the user
787
891
  * @param roleId - The id of the role
@@ -791,6 +895,7 @@ declare class GuildsAPI {
791
895
  /**
792
896
  * Removes a role from a guild member
793
897
  *
898
+ * @see {@link https://discord.com/developers/docs/resources/guild#remove-guild-member-role}
794
899
  * @param guildId - The id of the guild
795
900
  * @param userId - The id of the user
796
901
  * @param roleId - The id of the role
@@ -800,12 +905,14 @@ declare class GuildsAPI {
800
905
  /**
801
906
  * Fetches a guild template
802
907
  *
908
+ * @see {@link https://discord.com/developers/docs/resources/guild-template#get-guild-template}
803
909
  * @param templateCode - The code of the template
804
910
  */
805
911
  getTemplate(templateCode: string): Promise<discord_api_types_v10.APITemplate>;
806
912
  /**
807
913
  * Creates a new template
808
914
  *
915
+ * @see {@link https://discord.com/developers/docs/resources/guild-template#create-guild-template}
809
916
  * @param templateCode - The code of the template
810
917
  * @param data - The data to use when creating the template
811
918
  */
@@ -818,6 +925,8 @@ declare class WebhooksAPI {
818
925
  /**
819
926
  * Fetches a webhook
820
927
  *
928
+ * @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook}
929
+ * @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook-with-token}
821
930
  * @param id - The id of the webhook
822
931
  * @param token - The token of the webhook
823
932
  */
@@ -825,6 +934,7 @@ declare class WebhooksAPI {
825
934
  /**
826
935
  * Creates a new webhook
827
936
  *
937
+ * @see {@link https://discord.com/developers/docs/resources/webhook#create-webhook}
828
938
  * @param channelId - The id of the channel to create the webhook in
829
939
  * @param data - The data to use when creating the webhook
830
940
  * @param reason - The reason for creating the webhook
@@ -833,6 +943,8 @@ declare class WebhooksAPI {
833
943
  /**
834
944
  * Edits a webhook
835
945
  *
946
+ * @see {@link https://discord.com/developers/docs/resources/webhook#modify-webhook}
947
+ * @see {@link https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token}
836
948
  * @param id - The id of the webhook to edit
837
949
  * @param webhook - The new webhook data
838
950
  * @param options - The options to use when editing the webhook
@@ -844,6 +956,8 @@ declare class WebhooksAPI {
844
956
  /**
845
957
  * Deletes a webhook
846
958
  *
959
+ * @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook}
960
+ * @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token}
847
961
  * @param id - The id of the webhook to delete
848
962
  * @param options - The options to use when deleting the webhook
849
963
  */
@@ -854,6 +968,7 @@ declare class WebhooksAPI {
854
968
  /**
855
969
  * Executes a webhook and returns the created message
856
970
  *
971
+ * @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook}
857
972
  * @param id - The id of the webhook
858
973
  * @param token - The token of the webhook
859
974
  * @param data - The data to use when executing the webhook
@@ -865,6 +980,7 @@ declare class WebhooksAPI {
865
980
  /**
866
981
  * Executes a webhook
867
982
  *
983
+ * @see {@link https://discord.com/developers/docs/resources/webhook#execute-webhook}
868
984
  * @param id - The id of the webhook
869
985
  * @param token - The token of the webhook
870
986
  * @param data - The data to use when executing the webhook
@@ -876,6 +992,7 @@ declare class WebhooksAPI {
876
992
  /**
877
993
  * Executes a slack webhook
878
994
  *
995
+ * @see {@link https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook}
879
996
  * @param id - The id of the webhook
880
997
  * @param token - The token of the webhook
881
998
  * @param options - The options to use when executing the webhook
@@ -884,6 +1001,7 @@ declare class WebhooksAPI {
884
1001
  /**
885
1002
  * Executes a github webhook
886
1003
  *
1004
+ * @see {@link https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook}
887
1005
  * @param id - The id of the webhook
888
1006
  * @param token - The token of the webhook
889
1007
  * @param options - The options to use when executing the webhook
@@ -892,6 +1010,7 @@ declare class WebhooksAPI {
892
1010
  /**
893
1011
  * Fetches an associated message from a webhook
894
1012
  *
1013
+ * @see {@link https://discord.com/developers/docs/resources/webhook#get-webhook-message}
895
1014
  * @param id - The id of the webhook
896
1015
  * @param token - The token of the webhook
897
1016
  * @param messageId - The id of the message to fetch
@@ -903,6 +1022,7 @@ declare class WebhooksAPI {
903
1022
  /**
904
1023
  * Edits an associated message from a webhook
905
1024
  *
1025
+ * @see {@link https://discord.com/developers/docs/resources/webhook#edit-webhook-message}
906
1026
  * @param id - The id of the webhook
907
1027
  * @param token - The token of the webhook
908
1028
  * @param messageId - The id of the message to edit
@@ -914,6 +1034,7 @@ declare class WebhooksAPI {
914
1034
  /**
915
1035
  * Deletes an associated message from a webhook
916
1036
  *
1037
+ * @see {@link https://discord.com/developers/docs/resources/webhook#delete-webhook-message}
917
1038
  * @param id - The id of the webhook
918
1039
  * @param token - The token of the webhook
919
1040
  * @param messageId - The id of the message to delete
@@ -931,6 +1052,7 @@ declare class InteractionsAPI {
931
1052
  /**
932
1053
  * Replies to an interaction
933
1054
  *
1055
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
934
1056
  * @param interactionId - The id of the interaction
935
1057
  * @param interactionToken - The token of the interaction
936
1058
  * @param data - The data to use when replying
@@ -941,6 +1063,7 @@ declare class InteractionsAPI {
941
1063
  /**
942
1064
  * Defers the reply to an interaction
943
1065
  *
1066
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
944
1067
  * @param interactionId - The id of the interaction
945
1068
  * @param interactionToken - The token of the interaction
946
1069
  */
@@ -948,6 +1071,7 @@ declare class InteractionsAPI {
948
1071
  /**
949
1072
  * Defers an update from a message component interaction
950
1073
  *
1074
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
951
1075
  * @param interactionId - The id of the interaction
952
1076
  * @param interactionToken - The token of the interaction
953
1077
  */
@@ -955,6 +1079,7 @@ declare class InteractionsAPI {
955
1079
  /**
956
1080
  * Reply to a deferred interaction
957
1081
  *
1082
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message}
958
1083
  * @param applicationId - The application id of the interaction
959
1084
  * @param interactionToken - The token of the interaction
960
1085
  * @param data - The data to use when replying
@@ -965,6 +1090,8 @@ declare class InteractionsAPI {
965
1090
  /**
966
1091
  * Edits the initial reply to an interaction
967
1092
  *
1093
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response}
1094
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message}
968
1095
  * @param applicationId - The application id of the interaction
969
1096
  * @param interactionToken - The token of the interaction
970
1097
  * @param data - The data to use when editing the reply
@@ -972,10 +1099,11 @@ declare class InteractionsAPI {
972
1099
  */
973
1100
  editReply(applicationId: Snowflake, interactionToken: string, data: APIInteractionResponseCallbackData & {
974
1101
  files?: RawFile[];
975
- }, messageId?: string): Promise<discord_api_types_v10.APIMessage>;
1102
+ }, messageId?: Snowflake | '@original'): Promise<discord_api_types_v10.APIMessage>;
976
1103
  /**
977
1104
  * Fetches the initial reply to an interaction
978
1105
  *
1106
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response}
979
1107
  * @param applicationId - The application id of the interaction
980
1108
  * @param interactionToken - The token of the interaction
981
1109
  */
@@ -983,13 +1111,17 @@ declare class InteractionsAPI {
983
1111
  /**
984
1112
  * Deletes the initial reply to an interaction
985
1113
  *
1114
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response}
1115
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#delete-followup-message}
986
1116
  * @param applicationId - The application id of the interaction
987
1117
  * @param interactionToken - The token of the interaction
1118
+ * @param messageId - The id of the message to delete. If omitted, the original reply will be deleted
988
1119
  */
989
- deleteReply(applicationId: Snowflake, interactionToken: string): Promise<void>;
1120
+ deleteReply(applicationId: Snowflake, interactionToken: string, messageId?: Snowflake | '@original'): Promise<void>;
990
1121
  /**
991
1122
  * Updates the the message the component interaction was triggered on
992
1123
  *
1124
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
993
1125
  * @param interactionId - The id of the interaction
994
1126
  * @param interactionToken - The token of the interaction
995
1127
  * @param data - The data to use when updating the interaction
@@ -1000,6 +1132,7 @@ declare class InteractionsAPI {
1000
1132
  /**
1001
1133
  * Sends an autocomplete response to an interaction
1002
1134
  *
1135
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
1003
1136
  * @param interactionId - The id of the interaction
1004
1137
  * @param interactionToken - The token of the interaction
1005
1138
  * @param data - Data for the autocomplete response
@@ -1008,6 +1141,7 @@ declare class InteractionsAPI {
1008
1141
  /**
1009
1142
  * Sends a modal response to an interaction
1010
1143
  *
1144
+ * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response}
1011
1145
  * @param interactionId - The id of the interaction
1012
1146
  * @param interactionToken - The token of the interaction
1013
1147
  * @param data - The modal to send
@@ -1021,12 +1155,14 @@ declare class InvitesAPI {
1021
1155
  /**
1022
1156
  * Fetches an invite
1023
1157
  *
1158
+ * @see {@link https://discord.com/developers/docs/resources/invite#get-invite}
1024
1159
  * @param code - The invite code
1025
1160
  */
1026
1161
  get(code: string, options?: RESTGetAPIInviteQuery): Promise<discord_api_types_v10.APIInvite>;
1027
1162
  /**
1028
1163
  * Deletes an invite
1029
1164
  *
1165
+ * @see {@link https://discord.com/developers/docs/resources/invite#delete-invite}
1030
1166
  * @param code - The invite code
1031
1167
  * @param reason - The reason for deleting the invite
1032
1168
  */
@@ -1038,11 +1174,14 @@ declare class StickersAPI {
1038
1174
  constructor(rest: REST);
1039
1175
  /**
1040
1176
  * Fetches all of the nitro sticker packs
1177
+ *
1178
+ * @see {@link https://discord.com/developers/docs/resources/sticker#list-nitro-sticker-packs}
1041
1179
  */
1042
1180
  getNitroStickers(): Promise<RESTGetNitroStickerPacksResult>;
1043
1181
  /**
1044
1182
  * Fetches a sticker
1045
1183
  *
1184
+ * @see {@link https://discord.com/developers/docs/resources/sticker#get-sticker}
1046
1185
  * @param stickerId - The id of the sticker
1047
1186
  */
1048
1187
  get(stickerId: Snowflake): Promise<discord_api_types_v10.APISticker>;
@@ -1062,13 +1201,15 @@ declare class ThreadsAPI {
1062
1201
  /**
1063
1202
  * Fetches a thread
1064
1203
  *
1065
- * @param channelId - The id of the channel to fetch the thread from
1204
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-channel}
1066
1205
  * @param threadId - The id of the thread
1067
1206
  */
1068
- get(channelId: Snowflake, threadId: Snowflake): Promise<APIThreadChannel>;
1207
+ get(threadId: Snowflake): Promise<APIThreadChannel>;
1069
1208
  /**
1070
1209
  * Creates a new thread
1071
1210
  *
1211
+ * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-from-message}
1212
+ * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-without-message}
1072
1213
  * @param channelId - The id of the channel to start the thread in
1073
1214
  * @param data - The data to use when starting the thread
1074
1215
  */
@@ -1076,6 +1217,7 @@ declare class ThreadsAPI {
1076
1217
  /**
1077
1218
  * Creates a new forum post
1078
1219
  *
1220
+ * @see {@link https://discord.com/developers/docs/resources/channel#start-thread-in-forum-channel}
1079
1221
  * @param channelId - The id of the forum channel to start the thread in
1080
1222
  * @param data - The data to use when starting the thread
1081
1223
  */
@@ -1083,12 +1225,14 @@ declare class ThreadsAPI {
1083
1225
  /**
1084
1226
  * Adds the current user to a thread
1085
1227
  *
1228
+ * @see {@link https://discord.com/developers/docs/resources/channel#join-thread}
1086
1229
  * @param threadId - The id of the thread to join
1087
1230
  */
1088
1231
  join(threadId: Snowflake): Promise<void>;
1089
1232
  /**
1090
1233
  * Adds a member to a thread
1091
1234
  *
1235
+ * @see {@link https://discord.com/developers/docs/resources/channel#add-thread-member}
1092
1236
  * @param threadId - The id of the thread to add the member to
1093
1237
  * @param userId - The id of the user to add to the thread
1094
1238
  */
@@ -1096,12 +1240,14 @@ declare class ThreadsAPI {
1096
1240
  /**
1097
1241
  * Removes the current user from a thread
1098
1242
  *
1243
+ * @see {@link https://discord.com/developers/docs/resources/channel#leave-thread}
1099
1244
  * @param threadId - The id of the thread to leave
1100
1245
  */
1101
1246
  leave(threadId: Snowflake): Promise<void>;
1102
1247
  /**
1103
1248
  * Removes a member from a thread
1104
1249
  *
1250
+ * @see {@link https://discord.com/developers/docs/resources/channel#remove-thread-member}
1105
1251
  * @param threadId - The id of the thread to remove the member from
1106
1252
  * @param userId - The id of the user to remove from the thread
1107
1253
  */
@@ -1109,6 +1255,7 @@ declare class ThreadsAPI {
1109
1255
  /**
1110
1256
  * Fetches a member of a thread
1111
1257
  *
1258
+ * @see {@link https://discord.com/developers/docs/resources/channel#get-thread-member}
1112
1259
  * @param threadId - The id of the thread to fetch the member from
1113
1260
  * @param userId - The id of the user
1114
1261
  */
@@ -1116,6 +1263,7 @@ declare class ThreadsAPI {
1116
1263
  /**
1117
1264
  * Fetches all members of a thread
1118
1265
  *
1266
+ * @see {@link https://discord.com/developers/docs/resources/channel#list-thread-members}
1119
1267
  * @param threadId - The id of the thread to fetch the members from
1120
1268
  */
1121
1269
  getAllMembers(threadId: Snowflake): Promise<RESTGetAPIChannelThreadMembersResult>;
@@ -1127,40 +1275,48 @@ declare class UsersAPI {
1127
1275
  /**
1128
1276
  * Fetches a user by their id
1129
1277
  *
1278
+ * @see {@link https://discord.com/developers/docs/resources/user#get-user}
1130
1279
  * @param userId - The id of the user to fetch
1131
1280
  */
1132
1281
  get(userId: Snowflake): Promise<discord_api_types_v10.APIUser>;
1133
1282
  /**
1134
1283
  * Returns the user object of the requester's account
1284
+ *
1285
+ * @see {@link https://discord.com/developers/docs/resources/user#get-current-user}
1135
1286
  */
1136
1287
  getCurrent(): Promise<discord_api_types_v10.APIUser>;
1137
1288
  /**
1138
1289
  * Returns a list of partial guild objects the current user is a member of
1139
1290
  *
1291
+ * @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guilds}
1140
1292
  * @param options - The options to use when fetching the current user's guilds
1141
1293
  */
1142
1294
  getGuilds(options?: RESTGetAPICurrentUserGuildsQuery): Promise<RESTGetAPICurrentUserGuildsResult>;
1143
1295
  /**
1144
1296
  * Leaves the guild with the given id
1145
1297
  *
1298
+ * @see {@link https://discord.com/developers/docs/resources/user#leave-guild}
1146
1299
  * @param guildId - The id of the guild
1147
1300
  */
1148
1301
  leaveGuild(guildId: Snowflake): Promise<void>;
1149
1302
  /**
1150
1303
  * Edits the current user
1151
1304
  *
1305
+ * @see {@link https://discord.com/developers/docs/resources/user#modify-current-user}
1152
1306
  * @param user - The new data for the current user
1153
1307
  */
1154
1308
  edit(user: RESTPatchAPICurrentUserJSONBody): Promise<discord_api_types_v10.APIUser>;
1155
1309
  /**
1156
1310
  * Fetches the guild member for the current user
1157
1311
  *
1312
+ * @see {@link https://discord.com/developers/docs/resources/user#get-current-user-guild-member}
1158
1313
  * @param guildId - The id of the guild
1159
1314
  */
1160
1315
  getGuildMember(guildId: Snowflake): Promise<discord_api_types_v10.APIGuildMember>;
1161
1316
  /**
1162
1317
  * Edits the guild member for the current user
1163
1318
  *
1319
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-current-member}
1164
1320
  * @param guildId - The id of the guild
1165
1321
  * @param member - The new data for the guild member
1166
1322
  * @param reason - The reason for editing this guild member
@@ -1169,6 +1325,7 @@ declare class UsersAPI {
1169
1325
  /**
1170
1326
  * Sets the voice state for the current user
1171
1327
  *
1328
+ * @see {@link https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state}
1172
1329
  * @param guildId - The id of the guild
1173
1330
  * @param options - The options to use when setting the voice state
1174
1331
  */
@@ -1176,6 +1333,7 @@ declare class UsersAPI {
1176
1333
  /**
1177
1334
  * Opens a new DM channel with a user
1178
1335
  *
1336
+ * @see {@link https://discord.com/developers/docs/resources/user#create-dm}
1179
1337
  * @param userId - The id of the user to open a DM channel with
1180
1338
  */
1181
1339
  createDM(userId: Snowflake): Promise<discord_api_types_v10.APIChannel>;
@@ -1186,6 +1344,8 @@ declare class VoiceAPI {
1186
1344
  constructor(rest: REST);
1187
1345
  /**
1188
1346
  * Fetches all voice regions
1347
+ *
1348
+ * @see {@link https://discord.com/developers/docs/resources/voice#list-voice-regions}
1189
1349
  */
1190
1350
  getVoiceRegions(): Promise<discord_api_types_v10.RESTGetAPIVoiceRegionsResult>;
1191
1351
  }