discord-api-types 0.38.16 → 0.38.17-next.46bb280.1753433992

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.
@@ -0,0 +1,885 @@
1
+ import type { Snowflake } from "../../../globals";
2
+ import type { AchievementIconFormat, ApplicationAssetFormat, ApplicationCoverFormat, ApplicationIconFormat, DefaultUserAvatarAssets, EmojiFormat, GuildBannerFormat, GuildDiscoverySplashFormat, GuildIconFormat, GuildMemberAvatarFormat, GuildMemberBannerFormat, GuildScheduledEventCoverFormat, GuildSplashFormat, GuildTagBadgeFormat, ImageFormat, RoleIconFormat, StickerFormat, StickerPackBannerFormat, StorePageAssetFormat, TeamIconFormat, UserAvatarFormat, UserBannerFormat } from "../../../rest/v10/index";
3
+ export interface RoutesDeclarations {
4
+ /**
5
+ * Route for:
6
+ * - GET `/applications/{application.id}/role-connections/metadata`
7
+ * - PUT `/applications/{application.id}/role-connections/metadata`
8
+ */
9
+ applicationRoleConnectionMetadata(applicationId: Snowflake): `/applications/${string}/role-connections/metadata`;
10
+ /**
11
+ * Route for:
12
+ * - GET `/guilds/{guild.id}/auto-moderation/rules`
13
+ * - POST `/guilds/{guild.id}/auto-moderation/rules`
14
+ */
15
+ guildAutoModerationRules(guildId: Snowflake): `/guilds/${string}/auto-moderation/rules`;
16
+ /**
17
+ * Routes for:
18
+ * - GET `/guilds/{guild.id}/auto-moderation/rules/{rule.id}`
19
+ * - PATCH `/guilds/{guild.id}/auto-moderation/rules/{rule.id}`
20
+ * - DELETE `/guilds/{guild.id}/auto-moderation/rules/{rule.id}`
21
+ */
22
+ guildAutoModerationRule(guildId: Snowflake, ruleId: Snowflake): `/guilds/${string}/auto-moderation/rules/${string}`;
23
+ /**
24
+ * Route for:
25
+ * - GET `/guilds/{guild.id}/audit-logs`
26
+ */
27
+ guildAuditLog(guildId: Snowflake): `/guilds/${string}/audit-logs`;
28
+ /**
29
+ * Route for:
30
+ * - GET `/channels/{channel.id}`
31
+ * - PATCH `/channels/{channel.id}`
32
+ * - DELETE `/channels/{channel.id}`
33
+ */
34
+ channel(channelId: Snowflake): `/channels/${string}`;
35
+ /**
36
+ * Route for:
37
+ * - GET `/channels/{channel.id}/messages`
38
+ * - POST `/channels/{channel.id}/messages`
39
+ */
40
+ channelMessages(channelId: Snowflake): `/channels/${string}/messages`;
41
+ /**
42
+ * Route for:
43
+ * - GET `/channels/{channel.id}/messages/{message.id}`
44
+ * - PATCH `/channels/{channel.id}/messages/{message.id}`
45
+ * - DELETE `/channels/{channel.id}/messages/{message.id}`
46
+ */
47
+ channelMessage(channelId: Snowflake, messageId: Snowflake): `/channels/${string}/messages/${string}`;
48
+ /**
49
+ * Route for:
50
+ * - POST `/channels/{channel.id}/messages/{message.id}/crosspost`
51
+ */
52
+ channelMessageCrosspost(channelId: Snowflake, messageId: Snowflake): `/channels/${string}/messages/${string}/crosspost`;
53
+ /**
54
+ * Route for:
55
+ * - PUT `/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me`
56
+ * - DELETE `/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me`
57
+ *
58
+ * **Note**: You need to URL encode the emoji yourself
59
+ */
60
+ channelMessageOwnReaction(channelId: Snowflake, messageId: Snowflake, emoji: string): `/channels/${string}/messages/${string}/reactions/${string}/@me`;
61
+ /**
62
+ * Route for:
63
+ * - DELETE `/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/{user.id}`
64
+ *
65
+ * **Note**: You need to URL encode the emoji yourself
66
+ */
67
+ channelMessageUserReaction(channelId: Snowflake, messageId: Snowflake, emoji: string, userId: Snowflake): `/channels/${string}/messages/${string}/reactions/${string}/${string}`;
68
+ /**
69
+ * Route for:
70
+ * - GET `/channels/{channel.id}/messages/{message.id}/reactions/{emoji}`
71
+ * - DELETE `/channels/{channel.id}/messages/{message.id}/reactions/{emoji}`
72
+ *
73
+ * **Note**: You need to URL encode the emoji yourself
74
+ */
75
+ channelMessageReaction(channelId: Snowflake, messageId: Snowflake, emoji: string): `/channels/${string}/messages/${string}/reactions/${string}`;
76
+ /**
77
+ * Route for:
78
+ * - DELETE `/channels/{channel.id}/messages/{message.id}/reactions`
79
+ */
80
+ channelMessageAllReactions(channelId: Snowflake, messageId: Snowflake): `/channels/${string}/messages/${string}/reactions`;
81
+ /**
82
+ * Route for:
83
+ * - POST `/channels/{channel.id}/messages/bulk-delete`
84
+ */
85
+ channelBulkDelete(channelId: Snowflake): `/channels/${string}/messages/bulk-delete`;
86
+ /**
87
+ * Route for:
88
+ * - PUT `/channels/{channel.id}/permissions/{overwrite.id}`
89
+ * - DELETE `/channels/{channel.id}/permissions/{overwrite.id}`
90
+ */
91
+ channelPermission(channelId: Snowflake, overwriteId: Snowflake): `/channels/${string}/permissions/${string}`;
92
+ /**
93
+ * Route for:
94
+ * - GET `/channels/{channel.id}/invites`
95
+ * - POST `/channels/{channel.id}/invites`
96
+ */
97
+ channelInvites(channelId: Snowflake): `/channels/${string}/invites`;
98
+ /**
99
+ * Route for:
100
+ * - POST `/channels/{channel.id}/followers`
101
+ */
102
+ channelFollowers(channelId: Snowflake): `/channels/${string}/followers`;
103
+ /**
104
+ * Route for:
105
+ * - POST `/channels/{channel.id}/typing`
106
+ */
107
+ channelTyping(channelId: Snowflake): `/channels/${string}/typing`;
108
+ /**
109
+ * Route for:
110
+ * - GET `/channels/{channel.id}/messages/pins`
111
+ */
112
+ channelMessagesPins(channelId: Snowflake): `/channels/${string}/messages/pins`;
113
+ /**
114
+ * Route for:
115
+ * - PUT `/channels/{channel.id}/messages/pins/{message.id}`
116
+ * - DELETE `/channels/{channel.id}/messages/pins/{message.id}`
117
+ */
118
+ channelMessagesPin(channelId: Snowflake, messageId: Snowflake): `/channels/${string}/messages/pins/${string}`;
119
+ /**
120
+ * Route for:
121
+ * - GET `/channels/{channel.id}/pins`
122
+ *
123
+ * @deprecated Use {@link RoutesDeclarations.channelMessagesPins} instead.
124
+ */
125
+ channelPins(channelId: Snowflake): `/channels/${string}/pins`;
126
+ /**
127
+ * Route for:
128
+ * - PUT `/channels/{channel.id}/pins/{message.id}`
129
+ * - DELETE `/channels/{channel.id}/pins/{message.id}`
130
+ *
131
+ * @deprecated Use {@link RoutesDeclarations.channelMessagesPin} instead.
132
+ */
133
+ channelPin(channelId: Snowflake, messageId: Snowflake): `/channels/${string}/pins/${string}`;
134
+ /**
135
+ * Route for:
136
+ * - PUT `/channels/{channel.id}/recipients/{user.id}`
137
+ * - DELETE `/channels/{channel.id}/recipients/{user.id}`
138
+ */
139
+ channelRecipient(channelId: Snowflake, userId: Snowflake): `/channels/${string}/recipients/${string}`;
140
+ /**
141
+ * Route for:
142
+ * - GET `/guilds/{guild.id}/emojis`
143
+ * - POST `/guilds/{guild.id}/emojis`
144
+ */
145
+ guildEmojis(guildId: Snowflake): `/guilds/${string}/emojis`;
146
+ /**
147
+ * Route for:
148
+ * - GET `/guilds/{guild.id}/emojis/{emoji.id}`
149
+ * - PATCH `/guilds/{guild.id}/emojis/{emoji.id}`
150
+ * - DELETE `/guilds/{guild.id}/emojis/{emoji.id}`
151
+ */
152
+ guildEmoji(guildId: Snowflake, emojiId: Snowflake): `/guilds/${string}/emojis/${string}`;
153
+ /**
154
+ * Route for:
155
+ * - POST `/guilds`
156
+ */
157
+ guilds(): "/guilds";
158
+ /**
159
+ * Route for:
160
+ * - GET `/guilds/{guild.id}`
161
+ * - PATCH `/guilds/{guild.id}`
162
+ * - DELETE `/guilds/{guild.id}`
163
+ */
164
+ guild(guildId: Snowflake): `/guilds/${string}`;
165
+ /**
166
+ * Route for:
167
+ * - GET `/guilds/{guild.id}/preview`
168
+ */
169
+ guildPreview(guildId: Snowflake): `/guilds/${string}/preview`;
170
+ /**
171
+ * Route for:
172
+ * - GET `/guilds/{guild.id}/channels`
173
+ * - POST `/guilds/{guild.id}/channels`
174
+ * - PATCH `/guilds/{guild.id}/channels`
175
+ */
176
+ guildChannels(guildId: Snowflake): `/guilds/${string}/channels`;
177
+ /**
178
+ * Route for:
179
+ * - GET `/guilds/{guild.id}/members/{user.id}`
180
+ * - PUT `/guilds/{guild.id}/members/{user.id}`
181
+ * - PATCH `/guilds/{guild.id}/members/@me`
182
+ * - PATCH `/guilds/{guild.id}/members/{user.id}`
183
+ * - DELETE `/guilds/{guild.id}/members/{user.id}`
184
+ */
185
+ guildMember(guildId: Snowflake, userId?: Snowflake | '@me'): `/guilds/${string}/members/${string}`;
186
+ /**
187
+ * Route for:
188
+ * - GET `/guilds/{guild.id}/members`
189
+ */
190
+ guildMembers(guildId: Snowflake): `/guilds/${string}/members`;
191
+ /**
192
+ * Route for:
193
+ * - GET `/guilds/{guild.id}/members/search`
194
+ */
195
+ guildMembersSearch(guildId: Snowflake): `/guilds/${string}/members/search`;
196
+ /**
197
+ * Route for:
198
+ * - PATCH `/guilds/{guild.id}/members/@me/nick`
199
+ *
200
+ * @deprecated Use {@link RoutesDeclarations.guildMember} instead.
201
+ */
202
+ guildCurrentMemberNickname(guildId: Snowflake): `/guilds/${string}/members/@me/nick`;
203
+ /**
204
+ * Route for:
205
+ * - PUT `/guilds/{guild.id}/members/{user.id}/roles/{role.id}`
206
+ * - DELETE `/guilds/{guild.id}/members/{user.id}/roles/{role.id}`
207
+ */
208
+ guildMemberRole(guildId: Snowflake, memberId: Snowflake, roleId: Snowflake): `/guilds/${string}/members/${string}/roles/${string}`;
209
+ /**
210
+ * Route for:
211
+ * - POST `/guilds/{guild.id}/mfa`
212
+ */
213
+ guildMFA(guildId: Snowflake): `/guilds/${string}/mfa`;
214
+ /**
215
+ * Route for:
216
+ * - GET `/guilds/{guild.id}/bans`
217
+ */
218
+ guildBans(guildId: Snowflake): `/guilds/${string}/bans`;
219
+ /**
220
+ * Route for:
221
+ * - GET `/guilds/{guild.id}/bans/{user.id}`
222
+ * - PUT `/guilds/{guild.id}/bans/{user.id}`
223
+ * - DELETE `/guilds/{guild.id}/bans/{user.id}`
224
+ */
225
+ guildBan(guildId: Snowflake, userId: Snowflake): `/guilds/${string}/bans/${string}`;
226
+ /**
227
+ * Route for:
228
+ * - GET `/guilds/{guild.id}/roles`
229
+ * - POST `/guilds/{guild.id}/roles`
230
+ * - PATCH `/guilds/{guild.id}/roles`
231
+ */
232
+ guildRoles(guildId: Snowflake): `/guilds/${string}/roles`;
233
+ /**
234
+ * Route for:
235
+ * - GET `/guilds/{guild.id}/roles/{role.id}`
236
+ * - PATCH `/guilds/{guild.id}/roles/{role.id}`
237
+ * - DELETE `/guilds/{guild.id}/roles/{role.id}`
238
+ */
239
+ guildRole(guildId: Snowflake, roleId: Snowflake): `/guilds/${string}/roles/${string}`;
240
+ /**
241
+ * Route for:
242
+ * - GET `/guilds/{guild.id}/prune`
243
+ * - POST `/guilds/{guild.id}/prune`
244
+ */
245
+ guildPrune(guildId: Snowflake): `/guilds/${string}/prune`;
246
+ /**
247
+ * Route for:
248
+ * - GET `/guilds/{guild.id}/regions`
249
+ */
250
+ guildVoiceRegions(guildId: Snowflake): `/guilds/${string}/regions`;
251
+ /**
252
+ * Route for:
253
+ * - GET `/guilds/{guild.id}/invites`
254
+ */
255
+ guildInvites(guildId: Snowflake): `/guilds/${string}/invites`;
256
+ /**
257
+ * Route for:
258
+ * - GET `/guilds/{guild.id}/integrations`
259
+ */
260
+ guildIntegrations(guildId: Snowflake): `/guilds/${string}/integrations`;
261
+ /**
262
+ * Route for:
263
+ * - DELETE `/guilds/{guild.id}/integrations/{integration.id}`
264
+ */
265
+ guildIntegration(guildId: Snowflake, integrationId: Snowflake): `/guilds/${string}/integrations/${string}`;
266
+ /**
267
+ * Route for:
268
+ * - GET `/guilds/{guild.id}/widget`
269
+ * - PATCH `/guilds/{guild.id}/widget`
270
+ */
271
+ guildWidgetSettings(guildId: Snowflake): `/guilds/${string}/widget`;
272
+ /**
273
+ * Route for:
274
+ * - GET `/guilds/{guild.id}/widget.json`
275
+ */
276
+ guildWidgetJSON(guildId: Snowflake): `/guilds/${string}/widget.json`;
277
+ /**
278
+ * Route for:
279
+ * - GET `/guilds/{guild.id}/vanity-url`
280
+ */
281
+ guildVanityUrl(guildId: Snowflake): `/guilds/${string}/vanity-url`;
282
+ /**
283
+ * Route for:
284
+ * - GET `/guilds/{guild.id}/widget.png`
285
+ */
286
+ guildWidgetImage(guildId: Snowflake): `/guilds/${string}/widget.png`;
287
+ /**
288
+ * Route for:
289
+ * - GET `/invites/{invite.code}`
290
+ * - DELETE `/invites/{invite.code}`
291
+ */
292
+ invite(code: string): `/invites/${string}`;
293
+ /**
294
+ * Route for:
295
+ * - GET `/guilds/templates/{template.code}`
296
+ * - POST `/guilds/templates/{template.code}`
297
+ */
298
+ template(code: string): `/guilds/templates/${string}`;
299
+ /**
300
+ * Route for:
301
+ * - GET `/guilds/{guild.id}/templates`
302
+ * - POST `/guilds/{guild.id}/templates`
303
+ */
304
+ guildTemplates(guildId: Snowflake): `/guilds/${string}/templates`;
305
+ /**
306
+ * Route for:
307
+ * - PUT `/guilds/{guild.id}/templates/{template.code}`
308
+ * - PATCH `/guilds/{guild.id}/templates/{template.code}`
309
+ * - DELETE `/guilds/{guild.id}/templates/{template.code}`
310
+ */
311
+ guildTemplate(guildId: Snowflake, code: string): `/guilds/${string}/templates/${string}`;
312
+ /**
313
+ * Route for:
314
+ * - GET `/channels/{channel.id}/polls/{message.id}/answers/{answer_id}`
315
+ */
316
+ pollAnswerVoters(channelId: Snowflake, messageId: Snowflake, answerId: number): `/channels/${string}/polls/${string}/answers/${number}`;
317
+ /**
318
+ * Route for:
319
+ * - POST `/channels/{channel.id}/polls/{message.id}/expire`
320
+ */
321
+ expirePoll(channelId: Snowflake, messageId: Snowflake): `/channels/${string}/polls/${string}/expire`;
322
+ /**
323
+ * Route for:
324
+ * - POST `/channels/{channel.id}/threads`
325
+ * - POST `/channels/{channel.id}/messages/{message.id}/threads`
326
+ */
327
+ threads(parentId: Snowflake, messageId?: Snowflake): `/channels/${Snowflake}/messages/${Snowflake}/threads` | `/channels/${Snowflake}/threads`;
328
+ /**
329
+ * Route for:
330
+ * - GET `/guilds/{guild.id}/threads/active`
331
+ */
332
+ guildActiveThreads(guildId: Snowflake): `/guilds/${string}/threads/active`;
333
+ /**
334
+ * Route for:
335
+ * - GET `/channels/{channel.id}/threads/archived/public`
336
+ * - GET `/channels/{channel.id}/threads/archived/private`
337
+ */
338
+ channelThreads(channelId: Snowflake, archivedStatus: 'private' | 'public'): `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`;
339
+ /**
340
+ * Route for:
341
+ * - GET `/channels/{channel.id}/users/@me/threads/archived/private`
342
+ */
343
+ channelJoinedArchivedThreads(channelId: Snowflake): `/channels/${string}/users/@me/threads/archived/private`;
344
+ /**
345
+ * Route for:
346
+ * - GET `/channels/{thread.id}/thread-members`
347
+ * - GET `/channels/{thread.id}/thread-members/{user.id}`
348
+ * - PUT `/channels/{thread.id}/thread-members/@me`
349
+ * - PUT `/channels/{thread.id}/thread-members/{user.id}`
350
+ * - DELETE `/channels/{thread.id}/thread-members/@me`
351
+ * - DELETE `/channels/{thread.id}/thread-members/{user.id}`
352
+ */
353
+ threadMembers(threadId: Snowflake, userId?: Snowflake | '@me'): `/channels/${Snowflake}/thread-members/${Snowflake | '@me'}` | `/channels/${Snowflake}/thread-members`;
354
+ /**
355
+ * Route for:
356
+ * - GET `/users/@me`
357
+ * - GET `/users/{user.id}`
358
+ * - PATCH `/users/@me`
359
+ *
360
+ * @param userId - The user ID, defaulted to `@me`
361
+ */
362
+ user(userId?: Snowflake | '@me'): `/users/${string}`;
363
+ /**
364
+ * Route for:
365
+ * - GET `/users/@me/applications/{application.id}/role-connection`
366
+ * - PUT `/users/@me/applications/{application.id}/role-connection`
367
+ */
368
+ userApplicationRoleConnection(applicationId: Snowflake): `/users/@me/applications/${string}/role-connection`;
369
+ /**
370
+ * Route for:
371
+ * - GET `/users/@me/guilds`
372
+ */
373
+ userGuilds(): "/users/@me/guilds";
374
+ /**
375
+ * Route for:
376
+ * - GET `/users/@me/guilds/{guild.id}/member`
377
+ */
378
+ userGuildMember(guildId: Snowflake): `/users/@me/guilds/${string}/member`;
379
+ /**
380
+ * Route for:
381
+ * - DELETE `/users/@me/guilds/{guild.id}`
382
+ */
383
+ userGuild(guildId: Snowflake): `/users/@me/guilds/${string}`;
384
+ /**
385
+ * Route for:
386
+ * - POST `/users/@me/channels`
387
+ */
388
+ userChannels(): "/users/@me/channels";
389
+ /**
390
+ * Route for:
391
+ * - GET `/users/@me/connections`
392
+ */
393
+ userConnections(): "/users/@me/connections";
394
+ /**
395
+ * Route for:
396
+ * - GET `/voice/regions`
397
+ */
398
+ voiceRegions(): "/voice/regions";
399
+ /**
400
+ * Route for:
401
+ * - GET `/channels/{channel.id}/webhooks`
402
+ * - POST `/channels/{channel.id}/webhooks`
403
+ */
404
+ channelWebhooks(channelId: Snowflake): `/channels/${string}/webhooks`;
405
+ /**
406
+ * Route for:
407
+ * - GET `/guilds/{guild.id}/webhooks`
408
+ */
409
+ guildWebhooks(guildId: Snowflake): `/guilds/${string}/webhooks`;
410
+ /**
411
+ * Route for:
412
+ * - GET `/webhooks/{webhook.id}`
413
+ * - GET `/webhooks/{webhook.id}/{webhook.token}`
414
+ * - PATCH `/webhooks/{webhook.id}`
415
+ * - PATCH `/webhooks/{webhook.id}/{webhook.token}`
416
+ * - DELETE `/webhooks/{webhook.id}`
417
+ * - DELETE `/webhooks/{webhook.id}/{webhook.token}`
418
+ * - POST `/webhooks/{webhook.id}/{webhook.token}`
419
+ *
420
+ * - POST `/webhooks/{application.id}/{interaction.token}`
421
+ */
422
+ webhook(webhookId: Snowflake, webhookToken?: string): `/webhooks/${Snowflake}/${string}` | `/webhooks/${Snowflake}`;
423
+ /**
424
+ * Route for:
425
+ * - GET `/webhooks/{webhook.id}/{webhook.token}/messages/@original`
426
+ * - GET `/webhooks/{webhook.id}/{webhook.token}/messages/{message.id}`
427
+ * - PATCH `/webhooks/{webhook.id}/{webhook.token}/messages/@original`
428
+ * - PATCH `/webhooks/{webhook.id}/{webhook.token}/messages/{message.id}`
429
+ * - DELETE `/webhooks/{webhook.id}/{webhook.token}/messages/@original`
430
+ * - DELETE `/webhooks/{webhook.id}/{webhook.token}/messages/{message.id}`
431
+ *
432
+ * - PATCH `/webhooks/{application.id}/{interaction.token}/messages/@original`
433
+ * - PATCH `/webhooks/{application.id}/{interaction.token}/messages/{message.id}`
434
+ * - DELETE `/webhooks/{application.id}/{interaction.token}/messages/{message.id}`
435
+ */
436
+ webhookMessage(webhookId: Snowflake, webhookToken: string, messageId?: Snowflake | '@original'): `/webhooks/${string}/${string}/messages/${string}`;
437
+ /**
438
+ * Route for:
439
+ * - POST `/webhooks/{webhook.id}/{webhook.token}/github`
440
+ * - POST `/webhooks/{webhook.id}/{webhook.token}/slack`
441
+ */
442
+ webhookPlatform(webhookId: Snowflake, webhookToken: string, platform: 'github' | 'slack'): `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`;
443
+ /**
444
+ * Route for:
445
+ * - GET `/gateway`
446
+ */
447
+ gateway(): "/gateway";
448
+ /**
449
+ * Route for:
450
+ * - GET `/gateway/bot`
451
+ */
452
+ gatewayBot(): "/gateway/bot";
453
+ /**
454
+ * Route for:
455
+ * - GET `/oauth2/applications/@me`
456
+ */
457
+ oauth2CurrentApplication(): "/oauth2/applications/@me";
458
+ /**
459
+ * Route for:
460
+ * - GET `/oauth2/@me`
461
+ */
462
+ oauth2CurrentAuthorization(): "/oauth2/@me";
463
+ /**
464
+ * Route for:
465
+ * - GET `/oauth2/authorize`
466
+ */
467
+ oauth2Authorization(): "/oauth2/authorize";
468
+ /**
469
+ * Route for:
470
+ * - POST `/oauth2/token`
471
+ */
472
+ oauth2TokenExchange(): "/oauth2/token";
473
+ /**
474
+ * Route for:
475
+ * - POST `/oauth2/token/revoke`
476
+ */
477
+ oauth2TokenRevocation(): "/oauth2/token/revoke";
478
+ /**
479
+ * Route for:
480
+ * - GET `/applications/{application.id}/commands`
481
+ * - PUT `/applications/{application.id}/commands`
482
+ * - POST `/applications/{application.id}/commands`
483
+ */
484
+ applicationCommands(applicationId: Snowflake): `/applications/${string}/commands`;
485
+ /**
486
+ * Route for:
487
+ * - GET `/applications/{application.id}/commands/{command.id}`
488
+ * - PATCH `/applications/{application.id}/commands/{command.id}`
489
+ * - DELETE `/applications/{application.id}/commands/{command.id}`
490
+ */
491
+ applicationCommand(applicationId: Snowflake, commandId: Snowflake): `/applications/${string}/commands/${string}`;
492
+ /**
493
+ * Route for:
494
+ * - GET `/applications/{application.id}/guilds/{guild.id}/commands`
495
+ * - PUT `/applications/{application.id}/guilds/{guild.id}/commands`
496
+ * - POST `/applications/{application.id}/guilds/{guild.id}/commands`
497
+ */
498
+ applicationGuildCommands(applicationId: Snowflake, guildId: Snowflake): `/applications/${string}/guilds/${string}/commands`;
499
+ /**
500
+ * Route for:
501
+ * - GET `/applications/{application.id}/guilds/{guild.id}/commands/{command.id}`
502
+ * - PATCH `/applications/{application.id}/guilds/{guild.id}/commands/{command.id}`
503
+ * - DELETE `/applications/{application.id}/guilds/{guild.id}/commands/{command.id}`
504
+ */
505
+ applicationGuildCommand(applicationId: Snowflake, guildId: Snowflake, commandId: Snowflake): `/applications/${string}/guilds/${string}/commands/${string}`;
506
+ /**
507
+ * Route for:
508
+ * - POST `/interactions/{interaction.id}/{interaction.token}/callback`
509
+ */
510
+ interactionCallback(interactionId: Snowflake, interactionToken: string): `/interactions/${string}/${string}/callback`;
511
+ /**
512
+ * Route for:
513
+ * - GET `/guilds/{guild.id}/member-verification`
514
+ * - PATCH `/guilds/{guild.id}/member-verification`
515
+ */
516
+ guildMemberVerification(guildId: Snowflake): `/guilds/${string}/member-verification`;
517
+ /**
518
+ * Route for:
519
+ * - GET `/guilds/{guild.id}/voice-states/@me`
520
+ * - GET `/guilds/{guild.id}/voice-states/{user.id}`
521
+ * - PATCH `/guilds/{guild.id}/voice-states/@me`
522
+ * - PATCH `/guilds/{guild.id}/voice-states/{user.id}`
523
+ */
524
+ guildVoiceState(guildId: Snowflake, userId?: Snowflake | '@me'): `/guilds/${string}/voice-states/${string}`;
525
+ /**
526
+ * Route for:
527
+ * - GET `/applications/{application.id}/guilds/{guild.id}/commands/permissions`
528
+ * - PUT `/applications/{application.id}/guilds/{guild.id}/commands/permissions`
529
+ */
530
+ guildApplicationCommandsPermissions(applicationId: Snowflake, guildId: Snowflake): `/applications/${string}/guilds/${string}/commands/permissions`;
531
+ /**
532
+ * Route for:
533
+ * - GET `/applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`
534
+ * - PUT `/applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`
535
+ */
536
+ applicationCommandPermissions(applicationId: Snowflake, guildId: Snowflake, commandId: Snowflake): `/applications/${string}/guilds/${string}/commands/${string}/permissions`;
537
+ /**
538
+ * Route for:
539
+ * - GET `/guilds/{guild.id}/welcome-screen`
540
+ * - PATCH `/guilds/{guild.id}/welcome-screen`
541
+ */
542
+ guildWelcomeScreen(guildId: Snowflake): `/guilds/${string}/welcome-screen`;
543
+ /**
544
+ * Route for:
545
+ * - POST `/stage-instances`
546
+ */
547
+ stageInstances(): "/stage-instances";
548
+ /**
549
+ * Route for:
550
+ * - GET `/stage-instances/{channel.id}`
551
+ * - PATCH `/stage-instances/{channel.id}`
552
+ * - DELETE `/stage-instances/{channel.id}`
553
+ */
554
+ stageInstance(channelId: Snowflake): `/stage-instances/${string}`;
555
+ /**
556
+ * Route for:
557
+ * - GET `/stickers/{sticker.id}`
558
+ */
559
+ sticker(stickerId: Snowflake): `/stickers/${string}`;
560
+ /**
561
+ * Route for:
562
+ * - GET `/sticker-packs`
563
+ */
564
+ stickerPacks(): "/sticker-packs";
565
+ /**
566
+ * Route for:
567
+ * - GET `/sticker-packs/{pack.id}`
568
+ */
569
+ stickerPack(packId: Snowflake): `/sticker-packs/${string}`;
570
+ /**
571
+ * Route for:
572
+ * - GET `/sticker-packs`
573
+ *
574
+ * @deprecated Use {@link RoutesDeclarations.stickerPacks} instead.
575
+ */
576
+ nitroStickerPacks(): "/sticker-packs";
577
+ /**
578
+ * Route for:
579
+ * - GET `/guilds/{guild.id}/stickers`
580
+ * - POST `/guilds/{guild.id}/stickers`
581
+ */
582
+ guildStickers(guildId: Snowflake): `/guilds/${string}/stickers`;
583
+ /**
584
+ * Route for:
585
+ * - GET `/guilds/{guild.id}/stickers/{sticker.id}`
586
+ * - PATCH `/guilds/{guild.id}/stickers/{sticker.id}`
587
+ * - DELETE `/guilds/{guild.id}/stickers/{sticker.id}`
588
+ */
589
+ guildSticker(guildId: Snowflake, stickerId: Snowflake): `/guilds/${string}/stickers/${string}`;
590
+ /**
591
+ * Route for:
592
+ * - GET `/guilds/{guild.id}/scheduled-events`
593
+ * - POST `/guilds/{guild.id}/scheduled-events`
594
+ */
595
+ guildScheduledEvents(guildId: Snowflake): `/guilds/${string}/scheduled-events`;
596
+ /**
597
+ * Route for:
598
+ * - GET `/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}`
599
+ * - PATCH `/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}`
600
+ * - DELETE `/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}`
601
+ */
602
+ guildScheduledEvent(guildId: Snowflake, guildScheduledEventId: Snowflake): `/guilds/${string}/scheduled-events/${string}`;
603
+ /**
604
+ * Route for:
605
+ * - GET `/guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}/users`
606
+ */
607
+ guildScheduledEventUsers(guildId: Snowflake, guildScheduledEventId: Snowflake): `/guilds/${string}/scheduled-events/${string}/users`;
608
+ /**
609
+ * Route for:
610
+ * - GET `/guilds/{guild.id}/onboarding`
611
+ * - PUT `/guilds/{guild.id}/onboarding`
612
+ */
613
+ guildOnboarding(guildId: Snowflake): `/guilds/${string}/onboarding`;
614
+ /**
615
+ * Route for:
616
+ * - PUT `/guilds/${guild.id}/incident-actions`
617
+ */
618
+ guildIncidentActions(guildId: Snowflake): `/guilds/${string}/incident-actions`;
619
+ /**
620
+ * Route for:
621
+ * - GET `/applications/@me`
622
+ * - PATCH `/applications/@me`
623
+ */
624
+ currentApplication(): "/applications/@me";
625
+ /**
626
+ * Route for:
627
+ * - GET `/applications/{application.id}/entitlements`
628
+ * - POST `/applications/{application.id}/entitlements`
629
+ */
630
+ entitlements(applicationId: Snowflake): `/applications/${string}/entitlements`;
631
+ /**
632
+ * Route for:
633
+ * - GET `/applications/{application.id}/entitlements/{entitlement.id}`
634
+ * - DELETE `/applications/{application.id}/entitlements/{entitlement.id}`
635
+ */
636
+ entitlement(applicationId: Snowflake, entitlementId: Snowflake): `/applications/${string}/entitlements/${string}`;
637
+ /**
638
+ * Route for:
639
+ * - GET `/applications/{application.id}/skus`
640
+ */
641
+ skus(applicationId: Snowflake): `/applications/${string}/skus`;
642
+ /**
643
+ * Route for:
644
+ * - POST `/guilds/{guild.id}/bulk-ban`
645
+ */
646
+ guildBulkBan(guildId: Snowflake): `/guilds/${string}/bulk-ban`;
647
+ /**
648
+ * Route for:
649
+ * - POST `/applications/{application.id}/entitlements/{entitlement.id}/consume`
650
+ */
651
+ consumeEntitlement(applicationId: Snowflake, entitlementId: Snowflake): `/applications/${string}/entitlements/${string}/consume`;
652
+ /**
653
+ * Route for:
654
+ * - GET `/applications/{application.id}/emojis`
655
+ * - POST `/applications/{application.id}/emojis`
656
+ */
657
+ applicationEmojis(applicationId: Snowflake): `/applications/${string}/emojis`;
658
+ /**
659
+ * Route for:
660
+ * - GET `/applications/{application.id}/emojis/{emoji.id}`
661
+ * - PATCH `/applications/{application.id}/emojis/{emoji.id}`
662
+ * - DELETE `/applications/{application.id}/emojis/{emoji.id}`
663
+ */
664
+ applicationEmoji(applicationId: Snowflake, emojiId: Snowflake): `/applications/${string}/emojis/${string}`;
665
+ /**
666
+ * Route for:
667
+ * - GET `/skus/{sku.id}/subscriptions`
668
+ */
669
+ skuSubscriptions(skuId: Snowflake): `/skus/${string}/subscriptions`;
670
+ /**
671
+ * Route for:
672
+ * - GET `/skus/{sku.id}/subscriptions/{subscription.id}`
673
+ */
674
+ skuSubscription(skuId: Snowflake, subscriptionId: Snowflake): `/skus/${string}/subscriptions/${string}`;
675
+ /**
676
+ * Route for:
677
+ * - POST `/channels/{channel.id}/send-soundboard-sound`
678
+ */
679
+ sendSoundboardSound(channelId: Snowflake): `/channels/${string}/send-soundboard-sound`;
680
+ /**
681
+ * Route for:
682
+ * - GET `/soundboard-default-sounds`
683
+ */
684
+ soundboardDefaultSounds(): "/soundboard-default-sounds";
685
+ /**
686
+ * Route for:
687
+ * - GET `/guilds/{guild.id}/soundboard-sounds`
688
+ * - POST `/guilds/{guild.id}/soundboard-sounds`
689
+ */
690
+ guildSoundboardSounds(guildId: Snowflake): `/guilds/${string}/soundboard-sounds`;
691
+ /**
692
+ * Route for:
693
+ * - GET `/guilds/{guild.id}/soundboard-sounds/{sound.id}`
694
+ * - PATCH `/guilds/{guild.id}/soundboard-sounds/{sound.id}`
695
+ * - DELETE `/guilds/{guild.id}/soundboard-sounds/{sound.id}`
696
+ */
697
+ guildSoundboardSound(guildId: Snowflake, soundId: Snowflake): `/guilds/${string}/soundboard-sounds/${string}`;
698
+ }
699
+ export interface CDNRoutesDeclarations {
700
+ /**
701
+ * Route for:
702
+ * - GET `/emojis/{emoji.id}.{png|jpeg|webp|gif}`
703
+ *
704
+ * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
705
+ *
706
+ * This route supports the extensions: PNG, JPEG, WebP, GIF
707
+ */
708
+ emoji<Format extends EmojiFormat>(emojiId: Snowflake, format: Format): `/emojis/${string}.${Format}`;
709
+ /**
710
+ * Route for:
711
+ * - GET `/icons/{guild.id}/{guild.icon}.{png|jpeg|webp|gif}`
712
+ *
713
+ * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
714
+ *
715
+ * This route supports the extensions: PNG, JPEG, WebP, GIF
716
+ */
717
+ guildIcon<Format extends GuildIconFormat>(guildId: Snowflake, guildIcon: string, format: Format): `/icons/${string}/${string}.${Format}`;
718
+ /**
719
+ * Route for:
720
+ * - GET `/splashes/{guild.id}/{guild.splash}.{png|jpeg|webp}`
721
+ *
722
+ * This route supports the extensions: PNG, JPEG, WebP
723
+ */
724
+ guildSplash<Format extends GuildSplashFormat>(guildId: Snowflake, guildSplash: string, format: Format): `/splashes/${string}/${string}.${Format}`;
725
+ /**
726
+ * Route for:
727
+ * - GET `/discovery-splashes/{guild.id}/{guild.discovery_splash}.{png|jpeg|webp}`
728
+ *
729
+ * This route supports the extensions: PNG, JPEG, WebP
730
+ */
731
+ guildDiscoverySplash<Format extends GuildDiscoverySplashFormat>(guildId: Snowflake, guildDiscoverySplash: string, format: Format): `/discovery-splashes/${string}/${string}.${Format}`;
732
+ /**
733
+ * Route for:
734
+ * - GET `/banners/{guild.id}/{guild.banner}.{png|jpeg|webp|gif}`
735
+ *
736
+ * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
737
+ *
738
+ * This route supports the extensions: PNG, JPEG, WebP, GIF
739
+ */
740
+ guildBanner<Format extends GuildBannerFormat>(guildId: Snowflake, guildBanner: string, format: Format): `/banners/${string}/${string}.${Format}`;
741
+ /**
742
+ * Route for:
743
+ * - GET `/banners/{user.id}/{user.banner}.{png|jpeg|webp|gif}`
744
+ *
745
+ * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
746
+ *
747
+ * This route supports the extensions: PNG, JPEG, WebP, GIF
748
+ */
749
+ userBanner<Format extends UserBannerFormat>(userId: Snowflake, userBanner: string, format: Format): `/banners/${string}/${string}.${Format}`;
750
+ /**
751
+ * Route for:
752
+ * - GET `/embed/avatars/{index}.png`
753
+ *
754
+ * The value for `index` parameter depends on whether the user is {@link https://discord.com/developers/docs/change-log#unique-usernames-on-discord | migrated to the new username system}.
755
+ * For users on the new username system, `index` will be `(user.id >> 22) % 6`.
756
+ * For users on the legacy username system, `index` will be `user.discriminator % 5`.
757
+ *
758
+ * This route supports the extension: PNG
759
+ */
760
+ defaultUserAvatar<Index extends DefaultUserAvatarAssets>(index: Index): `/embed/avatars/${Index}.png`;
761
+ /**
762
+ * Route for:
763
+ * - GET `/avatars/{user.id}/{user.avatar}.{png|jpeg|webp|gif}`
764
+ *
765
+ * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
766
+ *
767
+ * This route supports the extensions: PNG, JPEG, WebP, GIF
768
+ */
769
+ userAvatar<Format extends UserAvatarFormat>(userId: Snowflake, userAvatar: string, format: Format): `/avatars/${string}/${string}.${Format}`;
770
+ /**
771
+ * Route for:
772
+ * - GET `/guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png|jpeg|webp|gif}`
773
+ *
774
+ * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
775
+ *
776
+ * This route supports the extensions: PNG, JPEG, WebP, GIF
777
+ */
778
+ guildMemberAvatar<Format extends GuildMemberAvatarFormat>(guildId: Snowflake, userId: Snowflake, memberAvatar: string, format: Format): `/guilds/${string}/users/${string}/avatars/${string}.${Format}`;
779
+ /**
780
+ * Route for:
781
+ * - GET `/avatar-decorations/{user.id}/{user.avatar_decoration}.png`
782
+ *
783
+ * This route supports the extension: PNG
784
+ *
785
+ * @deprecated Use {@link CDNRoutesDeclarations.avatarDecoration} instead.
786
+ */
787
+ userAvatarDecoration(userId: Snowflake, userAvatarDecoration: string): `/avatar-decorations/${string}/${string}.png`;
788
+ /**
789
+ * Route for:
790
+ * - GET `/avatar-decoration-presets/{avatar_decoration_data_asset}.png`
791
+ *
792
+ * This route supports the extension: PNG
793
+ */
794
+ avatarDecoration(avatarDecorationDataAsset: string): `/avatar-decoration-presets/${string}.png`;
795
+ /**
796
+ * Route for:
797
+ * - GET `/app-icons/{application.id}/{application.icon}.{png|jpeg|webp}`
798
+ *
799
+ * This route supports the extensions: PNG, JPEG, WebP
800
+ */
801
+ applicationIcon<Format extends ApplicationIconFormat>(applicationId: Snowflake, applicationIcon: string, format: Format): `/app-icons/${string}/${string}.${Format}`;
802
+ /**
803
+ * Route for:
804
+ * - GET `/app-icons/{application.id}/{application.cover_image}.{png|jpeg|webp}`
805
+ *
806
+ * This route supports the extensions: PNG, JPEG, WebP
807
+ */
808
+ applicationCover<Format extends ApplicationCoverFormat>(applicationId: Snowflake, applicationCoverImage: string, format: Format): `/app-icons/${string}/${string}.${Format}`;
809
+ /**
810
+ * Route for:
811
+ * - GET `/app-assets/{application.id}/{application.asset_id}.{png|jpeg|webp}`
812
+ *
813
+ * This route supports the extensions: PNG, JPEG, WebP
814
+ */
815
+ applicationAsset<Format extends ApplicationAssetFormat>(applicationId: Snowflake, applicationAssetId: string, format: Format): `/app-assets/${string}/${string}.${Format}`;
816
+ /**
817
+ * Route for:
818
+ * - GET `/app-assets/{application.id}/achievements/{achievement.id}/icons/{achievement.icon}.{png|jpeg|webp}`
819
+ *
820
+ * This route supports the extensions: PNG, JPEG, WebP
821
+ */
822
+ achievementIcon<Format extends AchievementIconFormat>(applicationId: Snowflake, achievementId: Snowflake, achievementIconHash: string, format: Format): `/app-assets/${string}/achievements/${string}/icons/${string}.${Format}`;
823
+ /**
824
+ * Route for:
825
+ * - GET `/app-assets/710982414301790216/store/{sticker_pack.banner.asset_id}.{png|jpeg|webp}`
826
+ *
827
+ * This route supports the extensions: PNG, JPEG, WebP
828
+ */
829
+ stickerPackBanner<Format extends StickerPackBannerFormat>(stickerPackBannerAssetId: Snowflake, format: Format): `/app-assets/710982414301790216/store/${string}.${Format}`;
830
+ /**
831
+ * Route for:
832
+ * - GET `/app-assets/${application.id}/store/${asset.id}.{png|jpeg|webp}}`
833
+ *
834
+ * This route supports the extensions: PNG, JPEG, WebP
835
+ */
836
+ storePageAsset<Format extends StorePageAssetFormat = ImageFormat.PNG>(applicationId: Snowflake, assetId: string, format?: Format): `/app-assets/${string}/store/${string}.${Format}`;
837
+ /**
838
+ * Route for:
839
+ * - GET `/team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
840
+ *
841
+ * This route supports the extensions: PNG, JPEG, WebP
842
+ */
843
+ teamIcon<Format extends TeamIconFormat>(teamId: Snowflake, teamIcon: string, format: Format): `/team-icons/${string}/${string}.${Format}`;
844
+ /**
845
+ * Route for:
846
+ * - GET `/stickers/{sticker.id}.{png|json}`
847
+ *
848
+ * This route supports the extensions: PNG, Lottie, GIF
849
+ */
850
+ sticker<Format extends StickerFormat>(stickerId: Snowflake, format: Format): `/stickers/${string}.${Format}`;
851
+ /**
852
+ * Route for:
853
+ * - GET `/role-icons/{role.id}/{role.icon}.{png|jpeg|webp}`
854
+ *
855
+ * This route supports the extensions: PNG, JPEG, WebP
856
+ */
857
+ roleIcon<Format extends RoleIconFormat>(roleId: Snowflake, roleIcon: string, format: Format): `/role-icons/${string}/${string}.${Format}`;
858
+ /**
859
+ * Route for:
860
+ * - GET `/guild-events/{guild_scheduled_event.id}/{guild_scheduled_event.image}.{png|jpeg|webp}`
861
+ *
862
+ * This route supports the extensions: PNG, JPEG, WebP
863
+ */
864
+ guildScheduledEventCover<Format extends GuildScheduledEventCoverFormat>(guildScheduledEventId: Snowflake, guildScheduledEventCoverImage: string, format: Format): `/guild-events/${string}/${string}.${Format}`;
865
+ /**
866
+ * Route for:
867
+ * - GET `/guilds/${guild.id}/users/${user.id}/banners/${guild_member.banner}.{png|jpeg|webp|gif}`
868
+ *
869
+ * This route supports the extensions: PNG, JPEG, WebP, GIF
870
+ */
871
+ guildMemberBanner<Format extends GuildMemberBannerFormat>(guildId: Snowflake, userId: Snowflake, guildMemberBanner: string, format: Format): `/guilds/${string}/users/${string}/banners/${string}.${Format}`;
872
+ /**
873
+ * Route for:
874
+ * - GET `/soundboard-sounds/${sound.id}`
875
+ */
876
+ soundboardSound(soundId: Snowflake): `/soundboard-sounds/${string}`;
877
+ /**
878
+ * Route for:
879
+ * - GET `/guild-tag-badges/{guild.id}/{badge}.{png|jpeg|webp}`
880
+ *
881
+ * This route supports the extensions: PNG, JPEG, WebP
882
+ */
883
+ guildTagBadge<Format extends GuildTagBadgeFormat>(guildId: Snowflake, guildTagBadge: string, format: Format): `/guild-tag-badges/${string}/${string}.${Format}`;
884
+ }
885
+ //# sourceMappingURL=interfaces.d.ts.map