dfx 0.35.0 → 0.35.2
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/Cache/prelude.js +2 -2
- package/Cache/prelude.js.map +1 -1
- package/DiscordGateway/DiscordWS.d.ts +5 -4
- package/DiscordGateway/DiscordWS.js +7 -8
- package/DiscordGateway/DiscordWS.js.map +1 -1
- package/DiscordGateway/Shard/heartbeats.d.ts +1 -1
- package/DiscordGateway/Shard/heartbeats.js +6 -6
- package/DiscordGateway/Shard/heartbeats.js.map +1 -1
- package/DiscordGateway/Shard/invalidSession.d.ts +2 -2
- package/DiscordGateway/Shard/invalidSession.js +5 -5
- package/DiscordGateway/Shard/invalidSession.js.map +1 -1
- package/DiscordGateway/Shard.d.ts +4 -2
- package/DiscordGateway/Shard.js +27 -26
- package/DiscordGateway/Shard.js.map +1 -1
- package/DiscordGateway/Sharder.d.ts +6 -3
- package/DiscordGateway/Sharder.js +7 -6
- package/DiscordGateway/Sharder.js.map +1 -1
- package/DiscordGateway/WS.d.ts +3 -3
- package/DiscordGateway/WS.js +4 -4
- package/DiscordGateway/WS.js.map +1 -1
- package/DiscordGateway.d.ts +1 -1
- package/DiscordREST.d.ts +5 -3
- package/DiscordREST.js +6 -5
- package/DiscordREST.js.map +1 -1
- package/Helpers/intents.js +5 -5
- package/Helpers/intents.js.map +1 -1
- package/Helpers/permissions.d.ts +2 -2
- package/Helpers/permissions.js +13 -12
- package/Helpers/permissions.js.map +1 -1
- package/Interactions/context.js +10 -10
- package/Interactions/context.js.map +1 -1
- package/Interactions/gateway.d.ts +3 -3
- package/Interactions/gateway.js +3 -3
- package/Interactions/gateway.js.map +1 -1
- package/Interactions/handlers.js +2 -2
- package/Interactions/handlers.js.map +1 -1
- package/RateLimit.d.ts +3 -2
- package/RateLimit.js +2 -2
- package/RateLimit.js.map +1 -1
- package/global.d.ts +0 -8
- package/package.json +4 -3
- package/types.d.ts +1324 -1316
- package/types.js +8 -4
- package/types.js.map +1 -1
- package/webhooks.d.ts +4 -3
- package/webhooks.js +4 -3
- package/webhooks.js.map +1 -1
package/types.d.ts
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
import { RestResponse } from "dfx/DiscordREST/types";
|
|
2
2
|
export interface ActionMetadatum {
|
|
3
3
|
/** SEND_ALERT_MESSAGE */
|
|
4
|
-
channel_id: Snowflake;
|
|
4
|
+
readonly channel_id: Snowflake;
|
|
5
5
|
/** TIMEOUT */
|
|
6
|
-
duration_seconds: number;
|
|
6
|
+
readonly duration_seconds: number;
|
|
7
7
|
/** BLOCK_MESSAGE */
|
|
8
|
-
custom_message?: string;
|
|
8
|
+
readonly custom_message?: string;
|
|
9
9
|
}
|
|
10
10
|
export interface ActionRow {
|
|
11
11
|
/** component type */
|
|
12
|
-
type: ComponentType;
|
|
12
|
+
readonly type: ComponentType;
|
|
13
13
|
/** a list of child components */
|
|
14
|
-
components: Component[];
|
|
14
|
+
readonly components: Component[];
|
|
15
15
|
}
|
|
16
16
|
export declare const enum ActionType {
|
|
17
17
|
/** blocks a member's message and prevents it from being posted. A custom explanation can be specified and shown to members whenever their message is blocked. */
|
|
@@ -23,59 +23,59 @@ export declare const enum ActionType {
|
|
|
23
23
|
}
|
|
24
24
|
export interface Activity {
|
|
25
25
|
/** Activity's name */
|
|
26
|
-
name: string;
|
|
26
|
+
readonly name: string;
|
|
27
27
|
/** Activity type */
|
|
28
|
-
type: ActivityType;
|
|
28
|
+
readonly type: ActivityType;
|
|
29
29
|
/** Stream URL, is validated when type is 1 */
|
|
30
|
-
url?: string | null;
|
|
30
|
+
readonly url?: string | null;
|
|
31
31
|
/** Unix timestamp (in milliseconds) of when the activity was added to the user's session */
|
|
32
|
-
created_at: number;
|
|
32
|
+
readonly created_at: number;
|
|
33
33
|
/** Unix timestamps for start and/or end of the game */
|
|
34
|
-
timestamps?: ActivityTimestamp;
|
|
34
|
+
readonly timestamps?: ActivityTimestamp;
|
|
35
35
|
/** Application ID for the game */
|
|
36
|
-
application_id?: Snowflake;
|
|
36
|
+
readonly application_id?: Snowflake;
|
|
37
37
|
/** What the player is currently doing */
|
|
38
|
-
details?: string | null;
|
|
38
|
+
readonly details?: string | null;
|
|
39
39
|
/** User's current party status */
|
|
40
|
-
state?: string | null;
|
|
40
|
+
readonly state?: string | null;
|
|
41
41
|
/** Emoji used for a custom status */
|
|
42
|
-
emoji?: ActivityEmoji | null;
|
|
42
|
+
readonly emoji?: ActivityEmoji | null;
|
|
43
43
|
/** Information for the current party of the player */
|
|
44
|
-
party?: ActivityParty;
|
|
44
|
+
readonly party?: ActivityParty;
|
|
45
45
|
/** Images for the presence and their hover texts */
|
|
46
|
-
assets?: ActivityAsset;
|
|
46
|
+
readonly assets?: ActivityAsset;
|
|
47
47
|
/** Secrets for Rich Presence joining and spectating */
|
|
48
|
-
secrets?: ActivitySecret;
|
|
48
|
+
readonly secrets?: ActivitySecret;
|
|
49
49
|
/** Whether or not the activity is an instanced game session */
|
|
50
|
-
instance?: boolean;
|
|
50
|
+
readonly instance?: boolean;
|
|
51
51
|
/** Activity flags ORd together, describes what the payload includes */
|
|
52
|
-
flags?: number;
|
|
52
|
+
readonly flags?: number;
|
|
53
53
|
/** Custom buttons shown in the Rich Presence (max 2) */
|
|
54
|
-
buttons?: ActivityButton[];
|
|
54
|
+
readonly buttons?: ActivityButton[];
|
|
55
55
|
}
|
|
56
56
|
export interface ActivityAsset {
|
|
57
57
|
/** See Activity Asset Image */
|
|
58
|
-
large_image?: string;
|
|
58
|
+
readonly large_image?: string;
|
|
59
59
|
/** Text displayed when hovering over the large image of the activity */
|
|
60
|
-
large_text?: string;
|
|
60
|
+
readonly large_text?: string;
|
|
61
61
|
/** See Activity Asset Image */
|
|
62
|
-
small_image?: string;
|
|
62
|
+
readonly small_image?: string;
|
|
63
63
|
/** Text displayed when hovering over the small image of the activity */
|
|
64
|
-
small_text?: string;
|
|
64
|
+
readonly small_text?: string;
|
|
65
65
|
}
|
|
66
66
|
export interface ActivityButton {
|
|
67
67
|
/** Text shown on the button (1-32 characters) */
|
|
68
|
-
label: string;
|
|
68
|
+
readonly label: string;
|
|
69
69
|
/** URL opened when clicking the button (1-512 characters) */
|
|
70
|
-
url: string;
|
|
70
|
+
readonly url: string;
|
|
71
71
|
}
|
|
72
72
|
export interface ActivityEmoji {
|
|
73
73
|
/** Name of the emoji */
|
|
74
|
-
name: string;
|
|
74
|
+
readonly name: string;
|
|
75
75
|
/** ID of the emoji */
|
|
76
|
-
id?: Snowflake;
|
|
76
|
+
readonly id?: Snowflake;
|
|
77
77
|
/** Whether the emoji is animated */
|
|
78
|
-
animated?: boolean;
|
|
78
|
+
readonly animated?: boolean;
|
|
79
79
|
}
|
|
80
80
|
export declare const ActivityFlag: {
|
|
81
81
|
readonly INSTANCE: number;
|
|
@@ -90,23 +90,23 @@ export declare const ActivityFlag: {
|
|
|
90
90
|
};
|
|
91
91
|
export interface ActivityParty {
|
|
92
92
|
/** ID of the party */
|
|
93
|
-
id?: string;
|
|
93
|
+
readonly id?: string;
|
|
94
94
|
/** Used to show the party's current and maximum size */
|
|
95
|
-
size?: number[];
|
|
95
|
+
readonly size?: number[];
|
|
96
96
|
}
|
|
97
97
|
export interface ActivitySecret {
|
|
98
98
|
/** Secret for joining a party */
|
|
99
|
-
join?: string;
|
|
99
|
+
readonly join?: string;
|
|
100
100
|
/** Secret for spectating a game */
|
|
101
|
-
spectate?: string;
|
|
101
|
+
readonly spectate?: string;
|
|
102
102
|
/** Secret for a specific instanced match */
|
|
103
|
-
match?: string;
|
|
103
|
+
readonly match?: string;
|
|
104
104
|
}
|
|
105
105
|
export interface ActivityTimestamp {
|
|
106
106
|
/** Unix time (in milliseconds) of when the activity started */
|
|
107
|
-
start?: number;
|
|
107
|
+
readonly start?: number;
|
|
108
108
|
/** Unix time (in milliseconds) of when the activity ends */
|
|
109
|
-
end?: number;
|
|
109
|
+
readonly end?: number;
|
|
110
110
|
}
|
|
111
111
|
export declare const enum ActivityType {
|
|
112
112
|
GAME = 0,
|
|
@@ -118,25 +118,25 @@ export declare const enum ActivityType {
|
|
|
118
118
|
}
|
|
119
119
|
export interface AddGuildMemberParams {
|
|
120
120
|
/** an oauth2 access token granted with the guilds.join to the bot's application for the user you want to add to the guild */
|
|
121
|
-
access_token: string;
|
|
121
|
+
readonly access_token: string;
|
|
122
122
|
/** value to set user's nickname to */
|
|
123
|
-
nick: string;
|
|
123
|
+
readonly nick: string;
|
|
124
124
|
/** array of role ids the member is assigned */
|
|
125
|
-
roles: Snowflake[];
|
|
125
|
+
readonly roles: Snowflake[];
|
|
126
126
|
/** whether the user is muted in voice channels */
|
|
127
|
-
mute: boolean;
|
|
127
|
+
readonly mute: boolean;
|
|
128
128
|
/** whether the user is deafened in voice channels */
|
|
129
|
-
deaf: boolean;
|
|
129
|
+
readonly deaf: boolean;
|
|
130
130
|
}
|
|
131
131
|
export interface AllowedMention {
|
|
132
132
|
/** An array of allowed mention types to parse from the content. */
|
|
133
|
-
parse: AllowedMentionType[];
|
|
133
|
+
readonly parse: AllowedMentionType[];
|
|
134
134
|
/** Array of role_ids to mention (Max size of 100) */
|
|
135
|
-
roles: Snowflake[];
|
|
135
|
+
readonly roles: Snowflake[];
|
|
136
136
|
/** Array of user_ids to mention (Max size of 100) */
|
|
137
|
-
users: Snowflake[];
|
|
137
|
+
readonly users: Snowflake[];
|
|
138
138
|
/** For replies, whether to mention the author of the message being replied to (default false) */
|
|
139
|
-
replied_user: boolean;
|
|
139
|
+
readonly replied_user: boolean;
|
|
140
140
|
}
|
|
141
141
|
export declare const enum AllowedMentionType {
|
|
142
142
|
/** Controls role mentions */
|
|
@@ -148,145 +148,145 @@ export declare const enum AllowedMentionType {
|
|
|
148
148
|
}
|
|
149
149
|
export interface Application {
|
|
150
150
|
/** the id of the app */
|
|
151
|
-
id: Snowflake;
|
|
151
|
+
readonly id: Snowflake;
|
|
152
152
|
/** the name of the app */
|
|
153
|
-
name: string;
|
|
153
|
+
readonly name: string;
|
|
154
154
|
/** the icon hash of the app */
|
|
155
|
-
icon?: string | null;
|
|
155
|
+
readonly icon?: string | null;
|
|
156
156
|
/** the description of the app */
|
|
157
|
-
description: string;
|
|
157
|
+
readonly description: string;
|
|
158
158
|
/** an array of rpc origin urls, if rpc is enabled */
|
|
159
|
-
rpc_origins?: string[];
|
|
159
|
+
readonly rpc_origins?: string[];
|
|
160
160
|
/** when false only app owner can join the app's bot to guilds */
|
|
161
|
-
bot_public: boolean;
|
|
161
|
+
readonly bot_public: boolean;
|
|
162
162
|
/** when true the app's bot will only join upon completion of the full oauth2 code grant flow */
|
|
163
|
-
bot_require_code_grant: boolean;
|
|
163
|
+
readonly bot_require_code_grant: boolean;
|
|
164
164
|
/** the url of the app's terms of service */
|
|
165
|
-
terms_of_service_url?: string;
|
|
165
|
+
readonly terms_of_service_url?: string;
|
|
166
166
|
/** the url of the app's privacy policy */
|
|
167
|
-
privacy_policy_url?: string;
|
|
167
|
+
readonly privacy_policy_url?: string;
|
|
168
168
|
/** partial user object containing info on the owner of the application */
|
|
169
|
-
owner?: User;
|
|
169
|
+
readonly owner?: User;
|
|
170
170
|
/** deprecated and will be removed in v11. An empty string. */
|
|
171
|
-
summary: string;
|
|
171
|
+
readonly summary: string;
|
|
172
172
|
/** the hex encoded key for verification in interactions and the GameSDK's GetTicket */
|
|
173
|
-
verify_key: string;
|
|
173
|
+
readonly verify_key: string;
|
|
174
174
|
/** if the application belongs to a team, this will be a list of the members of that team */
|
|
175
|
-
team?: Team | null;
|
|
175
|
+
readonly team?: Team | null;
|
|
176
176
|
/** if this application is a game sold on Discord, this field will be the guild to which it has been linked */
|
|
177
|
-
guild_id?: Snowflake;
|
|
177
|
+
readonly guild_id?: Snowflake;
|
|
178
178
|
/** if this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists */
|
|
179
|
-
primary_sku_id?: Snowflake;
|
|
179
|
+
readonly primary_sku_id?: Snowflake;
|
|
180
180
|
/** if this application is a game sold on Discord, this field will be the URL slug that links to the store page */
|
|
181
|
-
slug?: string;
|
|
181
|
+
readonly slug?: string;
|
|
182
182
|
/** the application's default rich presence invite cover image hash */
|
|
183
|
-
cover_image?: string;
|
|
183
|
+
readonly cover_image?: string;
|
|
184
184
|
/** the application's public flags */
|
|
185
|
-
flags?: number;
|
|
185
|
+
readonly flags?: number;
|
|
186
186
|
/** up to 5 tags describing the content and functionality of the application */
|
|
187
|
-
tags?: string[];
|
|
187
|
+
readonly tags?: string[];
|
|
188
188
|
/** settings for the application's default in-app authorization link, if enabled */
|
|
189
|
-
install_params?: InstallParam;
|
|
189
|
+
readonly install_params?: InstallParam;
|
|
190
190
|
/** the application's default custom authorization link, if enabled */
|
|
191
|
-
custom_install_url?: string;
|
|
191
|
+
readonly custom_install_url?: string;
|
|
192
192
|
/** the application's role connection verification entry point, which when configured will render the app as a verification method in the guild role verification configuration */
|
|
193
|
-
role_connections_verification_url?: string;
|
|
193
|
+
readonly role_connections_verification_url?: string;
|
|
194
194
|
}
|
|
195
195
|
export interface ApplicationCommand {
|
|
196
196
|
/** Unique ID of command */
|
|
197
|
-
id: Snowflake;
|
|
197
|
+
readonly id: Snowflake;
|
|
198
198
|
/** Type of command, defaults to 1 */
|
|
199
|
-
type?: ApplicationCommandType;
|
|
199
|
+
readonly type?: ApplicationCommandType;
|
|
200
200
|
/** ID of the parent application */
|
|
201
|
-
application_id: Snowflake;
|
|
201
|
+
readonly application_id: Snowflake;
|
|
202
202
|
/** Guild ID of the command, if not global */
|
|
203
|
-
guild_id?: Snowflake;
|
|
203
|
+
readonly guild_id?: Snowflake;
|
|
204
204
|
/** Name of command, 1-32 characters */
|
|
205
|
-
name: string;
|
|
205
|
+
readonly name: string;
|
|
206
206
|
/** Localization dictionary for name field. Values follow the same restrictions as name */
|
|
207
|
-
name_localizations?: Locale | null;
|
|
207
|
+
readonly name_localizations?: Locale | null;
|
|
208
208
|
/** Description for CHAT_INPUT commands, 1-100 characters. Empty string for USER and MESSAGE commands */
|
|
209
|
-
description: string;
|
|
209
|
+
readonly description: string;
|
|
210
210
|
/** Localization dictionary for description field. Values follow the same restrictions as description */
|
|
211
|
-
description_localizations?: Locale | null;
|
|
211
|
+
readonly description_localizations?: Locale | null;
|
|
212
212
|
/** Parameters for the command, max of 25 */
|
|
213
|
-
options?: ApplicationCommandOption[];
|
|
213
|
+
readonly options?: ApplicationCommandOption[];
|
|
214
214
|
/** Set of permissions represented as a bit set */
|
|
215
|
-
default_member_permissions?: string | null;
|
|
215
|
+
readonly default_member_permissions?: string | null;
|
|
216
216
|
/** Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. */
|
|
217
|
-
dm_permission?: boolean;
|
|
217
|
+
readonly dm_permission?: boolean;
|
|
218
218
|
/** Not recommended for use as field will soon be deprecated. Indicates whether the command is enabled by default when the app is added to a guild, defaults to true */
|
|
219
|
-
default_permission?: boolean | null;
|
|
219
|
+
readonly default_permission?: boolean | null;
|
|
220
220
|
/** Indicates whether the command is age-restricted, defaults to false */
|
|
221
|
-
nsfw?: boolean;
|
|
221
|
+
readonly nsfw?: boolean;
|
|
222
222
|
/** Autoincrementing version identifier updated during substantial record changes */
|
|
223
|
-
version: Snowflake;
|
|
223
|
+
readonly version: Snowflake;
|
|
224
224
|
}
|
|
225
225
|
export interface ApplicationCommandDatum {
|
|
226
226
|
/** the ID of the invoked command */
|
|
227
|
-
id: Snowflake;
|
|
227
|
+
readonly id: Snowflake;
|
|
228
228
|
/** the name of the invoked command */
|
|
229
|
-
name: string;
|
|
229
|
+
readonly name: string;
|
|
230
230
|
/** the type of the invoked command */
|
|
231
|
-
type: number;
|
|
231
|
+
readonly type: number;
|
|
232
232
|
/** converted users + roles + channels + attachments */
|
|
233
|
-
resolved?: ResolvedDatum;
|
|
233
|
+
readonly resolved?: ResolvedDatum;
|
|
234
234
|
/** the params + values from the user */
|
|
235
|
-
options?: ApplicationCommandInteractionDataOption[];
|
|
235
|
+
readonly options?: ApplicationCommandInteractionDataOption[];
|
|
236
236
|
/** the id of the guild the command is registered to */
|
|
237
|
-
guild_id?: Snowflake;
|
|
237
|
+
readonly guild_id?: Snowflake;
|
|
238
238
|
/** id of the user or message targeted by a user or message command */
|
|
239
|
-
target_id?: Snowflake;
|
|
239
|
+
readonly target_id?: Snowflake;
|
|
240
240
|
}
|
|
241
241
|
export interface ApplicationCommandInteractionDataOption {
|
|
242
242
|
/** Name of the parameter */
|
|
243
|
-
name: string;
|
|
243
|
+
readonly name: string;
|
|
244
244
|
/** Value of application command option type */
|
|
245
|
-
type: ApplicationCommandOptionType;
|
|
245
|
+
readonly type: ApplicationCommandOptionType;
|
|
246
246
|
/** Value of the option resulting from user input */
|
|
247
|
-
value?: string;
|
|
247
|
+
readonly value?: string;
|
|
248
248
|
/** Present if this option is a group or subcommand */
|
|
249
|
-
options?: ApplicationCommandInteractionDataOption[];
|
|
249
|
+
readonly options?: ApplicationCommandInteractionDataOption[];
|
|
250
250
|
/** true if this option is the currently focused option for autocomplete */
|
|
251
|
-
focused?: boolean;
|
|
251
|
+
readonly focused?: boolean;
|
|
252
252
|
}
|
|
253
253
|
export interface ApplicationCommandOption {
|
|
254
254
|
/** Type of option */
|
|
255
|
-
type: any;
|
|
255
|
+
readonly type: any;
|
|
256
256
|
/** 1-32 character name */
|
|
257
|
-
name: string;
|
|
257
|
+
readonly name: string;
|
|
258
258
|
/** Localization dictionary for the name field. Values follow the same restrictions as name */
|
|
259
|
-
name_localizations?: Locale | null;
|
|
259
|
+
readonly name_localizations?: Locale | null;
|
|
260
260
|
/** 1-100 character description */
|
|
261
|
-
description: string;
|
|
261
|
+
readonly description: string;
|
|
262
262
|
/** Localization dictionary for the description field. Values follow the same restrictions as description */
|
|
263
|
-
description_localizations?: Locale | null;
|
|
263
|
+
readonly description_localizations?: Locale | null;
|
|
264
264
|
/** If the parameter is required or optional--default false */
|
|
265
|
-
required?: boolean;
|
|
265
|
+
readonly required?: boolean;
|
|
266
266
|
/** Choices for STRING, INTEGER, and NUMBER types for the user to pick from, max 25 */
|
|
267
|
-
choices?: ApplicationCommandOptionChoice[];
|
|
267
|
+
readonly choices?: ApplicationCommandOptionChoice[];
|
|
268
268
|
/** If the option is a subcommand or subcommand group type, these nested options will be the parameters */
|
|
269
|
-
options?: ApplicationCommandOption[];
|
|
269
|
+
readonly options?: ApplicationCommandOption[];
|
|
270
270
|
/** If the option is a channel type, the channels shown will be restricted to these types */
|
|
271
|
-
channel_types?: ChannelType[];
|
|
271
|
+
readonly channel_types?: ChannelType[];
|
|
272
272
|
/** If the option is an INTEGER or NUMBER type, the minimum value permitted */
|
|
273
|
-
min_value?: number;
|
|
273
|
+
readonly min_value?: number;
|
|
274
274
|
/** If the option is an INTEGER or NUMBER type, the maximum value permitted */
|
|
275
|
-
max_value?: number;
|
|
275
|
+
readonly max_value?: number;
|
|
276
276
|
/** For option type STRING, the minimum allowed length (minimum of 0, maximum of 6000) */
|
|
277
|
-
min_length?: number;
|
|
277
|
+
readonly min_length?: number;
|
|
278
278
|
/** For option type STRING, the maximum allowed length (minimum of 1, maximum of 6000) */
|
|
279
|
-
max_length?: number;
|
|
279
|
+
readonly max_length?: number;
|
|
280
280
|
/** If autocomplete interactions are enabled for this STRING, INTEGER, or NUMBER type option */
|
|
281
|
-
autocomplete?: boolean;
|
|
281
|
+
readonly autocomplete?: boolean;
|
|
282
282
|
}
|
|
283
283
|
export interface ApplicationCommandOptionChoice {
|
|
284
284
|
/** 1-100 character choice name */
|
|
285
|
-
name: string;
|
|
285
|
+
readonly name: string;
|
|
286
286
|
/** Localization dictionary for the name field. Values follow the same restrictions as name */
|
|
287
|
-
name_localizations?: Locale | null;
|
|
287
|
+
readonly name_localizations?: Locale | null;
|
|
288
288
|
/** Value for the choice, up to 100 characters if string */
|
|
289
|
-
value: string;
|
|
289
|
+
readonly value: string;
|
|
290
290
|
}
|
|
291
291
|
export declare const enum ApplicationCommandOptionType {
|
|
292
292
|
SUB_COMMAND = 1,
|
|
@@ -303,11 +303,11 @@ export declare const enum ApplicationCommandOptionType {
|
|
|
303
303
|
}
|
|
304
304
|
export interface ApplicationCommandPermission {
|
|
305
305
|
/** ID of the role, user, or channel. It can also be a permission constant */
|
|
306
|
-
id: Snowflake;
|
|
306
|
+
readonly id: Snowflake;
|
|
307
307
|
/** role (1), user (2), or channel (3) */
|
|
308
|
-
type: ApplicationCommandPermissionType;
|
|
308
|
+
readonly type: ApplicationCommandPermissionType;
|
|
309
309
|
/** true to allow, false, to disallow */
|
|
310
|
-
permission: boolean;
|
|
310
|
+
readonly permission: boolean;
|
|
311
311
|
}
|
|
312
312
|
export type ApplicationCommandPermissionsUpdateEvent = GuildApplicationCommandPermission;
|
|
313
313
|
export declare const enum ApplicationCommandPermissionType {
|
|
@@ -328,11 +328,11 @@ export declare const ApplicationFlag: {
|
|
|
328
328
|
readonly APPLICATION_AUTO_MODERATION_RULE_CREATE_BADGE: number;
|
|
329
329
|
/** Intent required for bots in 100 or more servers to receive presence_update events */
|
|
330
330
|
readonly GATEWAY_PRESENCE: number;
|
|
331
|
-
/** Intent required for bots in under 100 servers to receive presence_update events, found
|
|
331
|
+
/** Intent required for bots in under 100 servers to receive presence_update events, found on the Bot page in your app's settings */
|
|
332
332
|
readonly GATEWAY_PRESENCE_LIMITED: number;
|
|
333
|
-
/** Intent required for bots in 100 or more servers to receive member-related events like guild_member_add. See list of member-related events under GUILD_MEMBERS */
|
|
333
|
+
/** Intent required for bots in 100 or more servers to receive member-related events like guild_member_add. See the list of member-related events under GUILD_MEMBERS */
|
|
334
334
|
readonly GATEWAY_GUILD_MEMBERS: number;
|
|
335
|
-
/** Intent required for bots in under 100 servers to receive member-related events like guild_member_add, found
|
|
335
|
+
/** Intent required for bots in under 100 servers to receive member-related events like guild_member_add, found on the Bot page in your app's settings. See the list of member-related events under GUILD_MEMBERS */
|
|
336
336
|
readonly GATEWAY_GUILD_MEMBERS_LIMITED: number;
|
|
337
337
|
/** Indicates unusual growth of an app that prevents verification */
|
|
338
338
|
readonly VERIFICATION_PENDING_GUILD_LIMIT: number;
|
|
@@ -340,18 +340,18 @@ export declare const ApplicationFlag: {
|
|
|
340
340
|
readonly EMBEDDED: number;
|
|
341
341
|
/** Intent required for bots in 100 or more servers to receive message content */
|
|
342
342
|
readonly GATEWAY_MESSAGE_CONTENT: number;
|
|
343
|
-
/** Intent required for bots in under 100 servers to receive message content, found
|
|
343
|
+
/** Intent required for bots in under 100 servers to receive message content, found on the Bot page in your app's settings */
|
|
344
344
|
readonly GATEWAY_MESSAGE_CONTENT_LIMITED: number;
|
|
345
345
|
/** Indicates if an app has registered global application commands */
|
|
346
346
|
readonly APPLICATION_COMMAND_BADGE: number;
|
|
347
347
|
};
|
|
348
348
|
export interface ApplicationRoleConnection {
|
|
349
349
|
/** the vanity name of the platform a bot has connected (max 50 characters) */
|
|
350
|
-
platform_name?: string | null;
|
|
350
|
+
readonly platform_name?: string | null;
|
|
351
351
|
/** the username on the platform a bot has connected (max 100 characters) */
|
|
352
|
-
platform_username?: string | null;
|
|
352
|
+
readonly platform_username?: string | null;
|
|
353
353
|
/** object mapping application role connection metadata keys to their string-ified value (max 100 characters) for the user on the platform a bot has connected */
|
|
354
|
-
metadata: ApplicationRoleConnectionMetadatum;
|
|
354
|
+
readonly metadata: ApplicationRoleConnectionMetadatum;
|
|
355
355
|
}
|
|
356
356
|
export declare const enum ApplicationRoleConnectionMetadataType {
|
|
357
357
|
/** the metadata value (integer) is less than or equal to the guild's configured value (integer) */
|
|
@@ -373,105 +373,109 @@ export declare const enum ApplicationRoleConnectionMetadataType {
|
|
|
373
373
|
}
|
|
374
374
|
export interface ApplicationRoleConnectionMetadatum {
|
|
375
375
|
/** type of metadata value */
|
|
376
|
-
type: ApplicationRoleConnectionMetadataType;
|
|
376
|
+
readonly type: ApplicationRoleConnectionMetadataType;
|
|
377
377
|
/** dictionary key for the metadata field (must be a-z, 0-9, or _ characters; 1-50 characters) */
|
|
378
|
-
key: string;
|
|
378
|
+
readonly key: string;
|
|
379
379
|
/** name of the metadata field (1-100 characters) */
|
|
380
|
-
name: string;
|
|
380
|
+
readonly name: string;
|
|
381
381
|
/** translations of the name */
|
|
382
|
-
name_localizations?: Locale;
|
|
382
|
+
readonly name_localizations?: Locale;
|
|
383
383
|
/** description of the metadata field (1-200 characters) */
|
|
384
|
-
description: string;
|
|
384
|
+
readonly description: string;
|
|
385
385
|
/** translations of the description */
|
|
386
|
-
description_localizations?: Locale;
|
|
386
|
+
readonly description_localizations?: Locale;
|
|
387
387
|
}
|
|
388
388
|
export interface Attachment {
|
|
389
389
|
/** attachment id */
|
|
390
|
-
id: Snowflake;
|
|
390
|
+
readonly id: Snowflake;
|
|
391
391
|
/** name of file attached */
|
|
392
|
-
filename: string;
|
|
392
|
+
readonly filename: string;
|
|
393
393
|
/** description for the file (max 1024 characters) */
|
|
394
|
-
description?: string;
|
|
394
|
+
readonly description?: string;
|
|
395
395
|
/** the attachment's media type */
|
|
396
|
-
content_type?: string;
|
|
396
|
+
readonly content_type?: string;
|
|
397
397
|
/** size of file in bytes */
|
|
398
|
-
size: number;
|
|
398
|
+
readonly size: number;
|
|
399
399
|
/** source url of file */
|
|
400
|
-
url: string;
|
|
400
|
+
readonly url: string;
|
|
401
401
|
/** a proxied url of file */
|
|
402
|
-
proxy_url: string;
|
|
402
|
+
readonly proxy_url: string;
|
|
403
403
|
/** height of file (if image) */
|
|
404
|
-
height?: number | null;
|
|
404
|
+
readonly height?: number | null;
|
|
405
405
|
/** width of file (if image) */
|
|
406
|
-
width?: number | null;
|
|
406
|
+
readonly width?: number | null;
|
|
407
407
|
/** whether this attachment is ephemeral */
|
|
408
|
-
ephemeral?: boolean;
|
|
408
|
+
readonly ephemeral?: boolean;
|
|
409
|
+
/** the duration of the audio file (currently for voice messages) */
|
|
410
|
+
readonly duration_secs?: number;
|
|
411
|
+
/** base64 encoded bytearray representing a sampled waveform (currently for voice messages) */
|
|
412
|
+
readonly waveform?: string;
|
|
409
413
|
}
|
|
410
414
|
export interface AuditEntryInfo {
|
|
411
415
|
/** ID of the app whose permissions were targeted */
|
|
412
|
-
application_id: Snowflake;
|
|
416
|
+
readonly application_id: Snowflake;
|
|
413
417
|
/** Name of the Auto Moderation rule that was triggered */
|
|
414
|
-
auto_moderation_rule_name: string;
|
|
418
|
+
readonly auto_moderation_rule_name: string;
|
|
415
419
|
/** Trigger type of the Auto Moderation rule that was triggered */
|
|
416
|
-
auto_moderation_rule_trigger_type: string;
|
|
420
|
+
readonly auto_moderation_rule_trigger_type: string;
|
|
417
421
|
/** Channel in which the entities were targeted */
|
|
418
|
-
channel_id: Snowflake;
|
|
422
|
+
readonly channel_id: Snowflake;
|
|
419
423
|
/** Number of entities that were targeted */
|
|
420
|
-
count: string;
|
|
424
|
+
readonly count: string;
|
|
421
425
|
/** Number of days after which inactive members were kicked */
|
|
422
|
-
delete_member_days: string;
|
|
426
|
+
readonly delete_member_days: string;
|
|
423
427
|
/** ID of the overwritten entity */
|
|
424
|
-
id: Snowflake;
|
|
428
|
+
readonly id: Snowflake;
|
|
425
429
|
/** Number of members removed by the prune */
|
|
426
|
-
members_removed: string;
|
|
430
|
+
readonly members_removed: string;
|
|
427
431
|
/** ID of the message that was targeted */
|
|
428
|
-
message_id: Snowflake;
|
|
432
|
+
readonly message_id: Snowflake;
|
|
429
433
|
/** Name of the role if type is "0" (not present if type is "1") */
|
|
430
|
-
role_name: string;
|
|
434
|
+
readonly role_name: string;
|
|
431
435
|
/** Type of overwritten entity - role ("0") or member ("1") */
|
|
432
|
-
type: string;
|
|
436
|
+
readonly type: string;
|
|
433
437
|
}
|
|
434
438
|
export interface AuditLog {
|
|
435
439
|
/** List of application commands referenced in the audit log */
|
|
436
|
-
application_commands: ApplicationCommand[];
|
|
440
|
+
readonly application_commands: ApplicationCommand[];
|
|
437
441
|
/** List of audit log entries, sorted from most to least recent */
|
|
438
|
-
audit_log_entries: AuditLogEntry[];
|
|
442
|
+
readonly audit_log_entries: AuditLogEntry[];
|
|
439
443
|
/** List of auto moderation rules referenced in the audit log */
|
|
440
|
-
auto_moderation_rules: AutoModerationRule[];
|
|
444
|
+
readonly auto_moderation_rules: AutoModerationRule[];
|
|
441
445
|
/** List of guild scheduled events referenced in the audit log */
|
|
442
|
-
guild_scheduled_events: GuildScheduledEvent[];
|
|
446
|
+
readonly guild_scheduled_events: GuildScheduledEvent[];
|
|
443
447
|
/** List of partial integration objects */
|
|
444
|
-
integrations: Integration[];
|
|
448
|
+
readonly integrations: Integration[];
|
|
445
449
|
/** List of threads referenced in the audit log* */
|
|
446
|
-
threads: Channel[];
|
|
450
|
+
readonly threads: Channel[];
|
|
447
451
|
/** List of users referenced in the audit log */
|
|
448
|
-
users: User[];
|
|
452
|
+
readonly users: User[];
|
|
449
453
|
/** List of webhooks referenced in the audit log */
|
|
450
|
-
webhooks: Webhook[];
|
|
454
|
+
readonly webhooks: Webhook[];
|
|
451
455
|
}
|
|
452
456
|
export interface AuditLogChange {
|
|
453
457
|
/** New value of the key */
|
|
454
|
-
new_value?: any;
|
|
458
|
+
readonly new_value?: any;
|
|
455
459
|
/** Old value of the key */
|
|
456
|
-
old_value?: any;
|
|
460
|
+
readonly old_value?: any;
|
|
457
461
|
/** Name of the changed entity, with a few exceptions */
|
|
458
|
-
key: string;
|
|
462
|
+
readonly key: string;
|
|
459
463
|
}
|
|
460
464
|
export interface AuditLogEntry {
|
|
461
465
|
/** ID of the affected entity (webhook, user, role, etc.) */
|
|
462
|
-
target_id?: string | null;
|
|
466
|
+
readonly target_id?: string | null;
|
|
463
467
|
/** Changes made to the target_id */
|
|
464
|
-
changes?: AuditLogChange[];
|
|
468
|
+
readonly changes?: AuditLogChange[];
|
|
465
469
|
/** User or app that made the changes */
|
|
466
|
-
user_id?: Snowflake | null;
|
|
470
|
+
readonly user_id?: Snowflake | null;
|
|
467
471
|
/** ID of the entry */
|
|
468
|
-
id: Snowflake;
|
|
472
|
+
readonly id: Snowflake;
|
|
469
473
|
/** Type of action that occurred */
|
|
470
|
-
action_type: AuditLogEvent;
|
|
474
|
+
readonly action_type: AuditLogEvent;
|
|
471
475
|
/** Additional info for certain event types */
|
|
472
|
-
options?: AuditEntryInfo;
|
|
476
|
+
readonly options?: AuditEntryInfo;
|
|
473
477
|
/** Reason for the change (1-512 characters) */
|
|
474
|
-
reason?: string;
|
|
478
|
+
readonly reason?: string;
|
|
475
479
|
}
|
|
476
480
|
export declare const enum AuditLogEvent {
|
|
477
481
|
/** Server settings were updated */
|
|
@@ -585,120 +589,120 @@ export declare const enum AuditLogEvent {
|
|
|
585
589
|
}
|
|
586
590
|
export interface AutoModerationAction {
|
|
587
591
|
/** the type of action */
|
|
588
|
-
type: ActionType;
|
|
592
|
+
readonly type: ActionType;
|
|
589
593
|
/** additional metadata needed during execution for this specific action type */
|
|
590
|
-
metadata?: ActionMetadatum;
|
|
594
|
+
readonly metadata?: ActionMetadatum;
|
|
591
595
|
}
|
|
592
596
|
export interface AutoModerationActionExecutionEvent {
|
|
593
597
|
/** ID of the guild in which action was executed */
|
|
594
|
-
guild_id: Snowflake;
|
|
598
|
+
readonly guild_id: Snowflake;
|
|
595
599
|
/** Action which was executed */
|
|
596
|
-
action: AutoModerationAction;
|
|
600
|
+
readonly action: AutoModerationAction;
|
|
597
601
|
/** ID of the rule which action belongs to */
|
|
598
|
-
rule_id: Snowflake;
|
|
602
|
+
readonly rule_id: Snowflake;
|
|
599
603
|
/** Trigger type of rule which was triggered */
|
|
600
|
-
rule_trigger_type: TriggerType;
|
|
604
|
+
readonly rule_trigger_type: TriggerType;
|
|
601
605
|
/** ID of the user which generated the content which triggered the rule */
|
|
602
|
-
user_id: Snowflake;
|
|
606
|
+
readonly user_id: Snowflake;
|
|
603
607
|
/** ID of the channel in which user content was posted */
|
|
604
|
-
channel_id?: Snowflake;
|
|
608
|
+
readonly channel_id?: Snowflake;
|
|
605
609
|
/** ID of any user message which content belongs to * */
|
|
606
|
-
message_id?: Snowflake;
|
|
610
|
+
readonly message_id?: Snowflake;
|
|
607
611
|
/** ID of any system auto moderation messages posted as a result of this action ** */
|
|
608
|
-
alert_system_message_id?: Snowflake;
|
|
612
|
+
readonly alert_system_message_id?: Snowflake;
|
|
609
613
|
/** User-generated text content */
|
|
610
|
-
content: string;
|
|
614
|
+
readonly content: string;
|
|
611
615
|
/** Word or phrase configured in the rule that triggered the rule */
|
|
612
|
-
matched_keyword?: string | null;
|
|
616
|
+
readonly matched_keyword?: string | null;
|
|
613
617
|
/** Substring in content that triggered the rule */
|
|
614
|
-
matched_content?: string | null;
|
|
618
|
+
readonly matched_content?: string | null;
|
|
615
619
|
}
|
|
616
620
|
export interface AutoModerationRule {
|
|
617
621
|
/** the id of this rule */
|
|
618
|
-
id: Snowflake;
|
|
622
|
+
readonly id: Snowflake;
|
|
619
623
|
/** the id of the guild which this rule belongs to */
|
|
620
|
-
guild_id: Snowflake;
|
|
624
|
+
readonly guild_id: Snowflake;
|
|
621
625
|
/** the rule name */
|
|
622
|
-
name: string;
|
|
626
|
+
readonly name: string;
|
|
623
627
|
/** the user which first created this rule */
|
|
624
|
-
creator_id: Snowflake;
|
|
628
|
+
readonly creator_id: Snowflake;
|
|
625
629
|
/** the rule event type */
|
|
626
|
-
event_type: EventType;
|
|
630
|
+
readonly event_type: EventType;
|
|
627
631
|
/** the rule trigger type */
|
|
628
|
-
trigger_type: TriggerType;
|
|
632
|
+
readonly trigger_type: TriggerType;
|
|
629
633
|
/** the rule trigger metadata */
|
|
630
|
-
trigger_metadata: TriggerMetadatum;
|
|
634
|
+
readonly trigger_metadata: TriggerMetadatum;
|
|
631
635
|
/** the actions which will execute when the rule is triggered */
|
|
632
|
-
actions: AutoModerationAction[];
|
|
636
|
+
readonly actions: AutoModerationAction[];
|
|
633
637
|
/** whether the rule is enabled */
|
|
634
|
-
enabled: boolean;
|
|
638
|
+
readonly enabled: boolean;
|
|
635
639
|
/** the role ids that should not be affected by the rule (Maximum of 20) */
|
|
636
|
-
exempt_roles: Snowflake[];
|
|
640
|
+
readonly exempt_roles: Snowflake[];
|
|
637
641
|
/** the channel ids that should not be affected by the rule (Maximum of 50) */
|
|
638
|
-
exempt_channels: Snowflake[];
|
|
642
|
+
readonly exempt_channels: Snowflake[];
|
|
639
643
|
}
|
|
640
644
|
export type AutoModerationRuleCreateEvent = AutoModerationRule;
|
|
641
645
|
export type AutoModerationRuleDeleteEvent = AutoModerationRule;
|
|
642
646
|
export type AutoModerationRuleUpdateEvent = AutoModerationRule;
|
|
643
647
|
export interface Ban {
|
|
644
648
|
/** the reason for the ban */
|
|
645
|
-
reason?: string | null;
|
|
649
|
+
readonly reason?: string | null;
|
|
646
650
|
/** the banned user */
|
|
647
|
-
user: User;
|
|
651
|
+
readonly user: User;
|
|
648
652
|
}
|
|
649
653
|
export interface BeginGuildPruneParams {
|
|
650
654
|
/** number of days to prune (1-30) */
|
|
651
|
-
days: number;
|
|
655
|
+
readonly days: number;
|
|
652
656
|
/** whether pruned is returned, discouraged for large guilds */
|
|
653
|
-
compute_prune_count: boolean;
|
|
657
|
+
readonly compute_prune_count: boolean;
|
|
654
658
|
/** role(s) to include */
|
|
655
|
-
include_roles: Snowflake[];
|
|
659
|
+
readonly include_roles: Snowflake[];
|
|
656
660
|
/** reason for the prune (deprecated) */
|
|
657
|
-
reason?: string;
|
|
661
|
+
readonly reason?: string;
|
|
658
662
|
}
|
|
659
663
|
export interface BulkDeleteMessageParams {
|
|
660
664
|
/** an array of message ids to delete (2-100) */
|
|
661
|
-
messages: Snowflake[];
|
|
665
|
+
readonly messages: Snowflake[];
|
|
662
666
|
}
|
|
663
667
|
export interface BulkOverwriteGuildApplicationCommandParams {
|
|
664
668
|
/** ID of the command, if known */
|
|
665
|
-
id?: Snowflake;
|
|
669
|
+
readonly id?: Snowflake;
|
|
666
670
|
/** Name of command, 1-32 characters */
|
|
667
|
-
name: string;
|
|
671
|
+
readonly name: string;
|
|
668
672
|
/** Localization dictionary for the name field. Values follow the same restrictions as name */
|
|
669
|
-
name_localizations?: Locale | null;
|
|
673
|
+
readonly name_localizations?: Locale | null;
|
|
670
674
|
/** 1-100 character description */
|
|
671
|
-
description: string;
|
|
675
|
+
readonly description: string;
|
|
672
676
|
/** Localization dictionary for the description field. Values follow the same restrictions as description */
|
|
673
|
-
description_localizations?: Locale | null;
|
|
677
|
+
readonly description_localizations?: Locale | null;
|
|
674
678
|
/** Parameters for the command */
|
|
675
|
-
options?: ApplicationCommandOption[];
|
|
679
|
+
readonly options?: ApplicationCommandOption[];
|
|
676
680
|
/** Set of permissions represented as a bit set */
|
|
677
|
-
default_member_permissions?: string | null;
|
|
681
|
+
readonly default_member_permissions?: string | null;
|
|
678
682
|
/** Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. */
|
|
679
|
-
dm_permission?: boolean | null;
|
|
683
|
+
readonly dm_permission?: boolean | null;
|
|
680
684
|
/** Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true */
|
|
681
|
-
default_permission?: boolean;
|
|
685
|
+
readonly default_permission?: boolean;
|
|
682
686
|
/** Type of command, defaults 1 if not set */
|
|
683
|
-
type?: ApplicationCommandType;
|
|
687
|
+
readonly type?: ApplicationCommandType;
|
|
684
688
|
/** Indicates whether the command is age-restricted */
|
|
685
|
-
nsfw?: boolean;
|
|
689
|
+
readonly nsfw?: boolean;
|
|
686
690
|
}
|
|
687
691
|
export interface Button {
|
|
688
692
|
/** 2 for a button */
|
|
689
|
-
type: number;
|
|
693
|
+
readonly type: number;
|
|
690
694
|
/** A button style */
|
|
691
|
-
style: ButtonStyle;
|
|
695
|
+
readonly style: ButtonStyle;
|
|
692
696
|
/** Text that appears on the button; max 80 characters */
|
|
693
|
-
label?: string;
|
|
697
|
+
readonly label?: string;
|
|
694
698
|
/** name, id, and animated */
|
|
695
|
-
emoji?: Emoji;
|
|
699
|
+
readonly emoji?: Emoji;
|
|
696
700
|
/** Developer-defined identifier for the button; max 100 characters */
|
|
697
|
-
custom_id?: string;
|
|
701
|
+
readonly custom_id?: string;
|
|
698
702
|
/** URL for link-style buttons */
|
|
699
|
-
url?: string;
|
|
703
|
+
readonly url?: string;
|
|
700
704
|
/** Whether the button is disabled (defaults to false) */
|
|
701
|
-
disabled?: boolean;
|
|
705
|
+
readonly disabled?: boolean;
|
|
702
706
|
}
|
|
703
707
|
export declare const enum ButtonStyle {
|
|
704
708
|
PRIMARY = 1,
|
|
@@ -709,75 +713,75 @@ export declare const enum ButtonStyle {
|
|
|
709
713
|
}
|
|
710
714
|
export interface Channel {
|
|
711
715
|
/** the id of this channel */
|
|
712
|
-
id: Snowflake;
|
|
716
|
+
readonly id: Snowflake;
|
|
713
717
|
/** the type of channel */
|
|
714
|
-
type: ChannelType;
|
|
718
|
+
readonly type: ChannelType;
|
|
715
719
|
/** the id of the guild (may be missing for some channel objects received over gateway guild dispatches) */
|
|
716
|
-
guild_id?: Snowflake;
|
|
720
|
+
readonly guild_id?: Snowflake;
|
|
717
721
|
/** sorting position of the channel */
|
|
718
|
-
position?: number;
|
|
722
|
+
readonly position?: number;
|
|
719
723
|
/** explicit permission overwrites for members and roles */
|
|
720
|
-
permission_overwrites?: Overwrite[];
|
|
724
|
+
readonly permission_overwrites?: Overwrite[];
|
|
721
725
|
/** the name of the channel (1-100 characters) */
|
|
722
|
-
name?: string | null;
|
|
726
|
+
readonly name?: string | null;
|
|
723
727
|
/** the channel topic (0-4096 characters for GUILD_FORUM channels, 0-1024 characters for all others) */
|
|
724
|
-
topic?: string | null;
|
|
728
|
+
readonly topic?: string | null;
|
|
725
729
|
/** whether the channel is nsfw */
|
|
726
|
-
nsfw?: boolean;
|
|
730
|
+
readonly nsfw?: boolean;
|
|
727
731
|
/** the id of the last message sent in this channel (or thread for GUILD_FORUM channels) (may not point to an existing or valid message or thread) */
|
|
728
|
-
last_message_id?: Snowflake | null;
|
|
732
|
+
readonly last_message_id?: Snowflake | null;
|
|
729
733
|
/** the bitrate (in bits) of the voice channel */
|
|
730
|
-
bitrate?: number;
|
|
734
|
+
readonly bitrate?: number;
|
|
731
735
|
/** the user limit of the voice channel */
|
|
732
|
-
user_limit?: number;
|
|
736
|
+
readonly user_limit?: number;
|
|
733
737
|
/** amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages or manage_channel, are unaffected */
|
|
734
|
-
rate_limit_per_user?: number;
|
|
738
|
+
readonly rate_limit_per_user?: number;
|
|
735
739
|
/** the recipients of the DM */
|
|
736
|
-
recipients?: User[];
|
|
740
|
+
readonly recipients?: User[];
|
|
737
741
|
/** icon hash of the group DM */
|
|
738
|
-
icon?: string | null;
|
|
742
|
+
readonly icon?: string | null;
|
|
739
743
|
/** id of the creator of the group DM or thread */
|
|
740
|
-
owner_id?: Snowflake;
|
|
744
|
+
readonly owner_id?: Snowflake;
|
|
741
745
|
/** application id of the group DM creator if it is bot-created */
|
|
742
|
-
application_id?: Snowflake;
|
|
746
|
+
readonly application_id?: Snowflake;
|
|
743
747
|
/** for group DM channels: whether the channel is managed by an application via the gdm.join OAuth2 scope */
|
|
744
|
-
managed?: boolean;
|
|
748
|
+
readonly managed?: boolean;
|
|
745
749
|
/** for guild channels: id of the parent category for a channel (each parent category can contain up to 50 channels), for threads: id of the text channel this thread was created */
|
|
746
|
-
parent_id?: Snowflake | null;
|
|
750
|
+
readonly parent_id?: Snowflake | null;
|
|
747
751
|
/** when the last pinned message was pinned. This may be null in events such as GUILD_CREATE when a message is not pinned. */
|
|
748
|
-
last_pin_timestamp?: string | null;
|
|
752
|
+
readonly last_pin_timestamp?: string | null;
|
|
749
753
|
/** voice region id for the voice channel, automatic when set to null */
|
|
750
|
-
rtc_region?: string | null;
|
|
754
|
+
readonly rtc_region?: string | null;
|
|
751
755
|
/** the camera video quality mode of the voice channel, 1 when not present */
|
|
752
|
-
video_quality_mode?: VideoQualityMode;
|
|
756
|
+
readonly video_quality_mode?: VideoQualityMode;
|
|
753
757
|
/** number of messages (not including the initial message or deleted messages) in a thread. */
|
|
754
|
-
message_count?: number;
|
|
758
|
+
readonly message_count?: number;
|
|
755
759
|
/** an approximate count of users in a thread, stops counting at 50 */
|
|
756
|
-
member_count?: number;
|
|
760
|
+
readonly member_count?: number;
|
|
757
761
|
/** thread-specific fields not needed by other channels */
|
|
758
|
-
thread_metadata?: ThreadMetadatum;
|
|
762
|
+
readonly thread_metadata?: ThreadMetadatum;
|
|
759
763
|
/** thread member object for the current user, if they have joined the thread, only included on certain API endpoints */
|
|
760
|
-
member?: ThreadMember;
|
|
764
|
+
readonly member?: ThreadMember;
|
|
761
765
|
/** default duration, copied onto newly created threads, in minutes, threads will stop showing in the channel list after the specified period of inactivity, can be set to: 60, 1440, 4320, 10080 */
|
|
762
|
-
default_auto_archive_duration?: number;
|
|
766
|
+
readonly default_auto_archive_duration?: number;
|
|
763
767
|
/** computed permissions for the invoking user in the channel, including overwrites, only included when part of the resolved data received on a slash command interaction */
|
|
764
|
-
permissions?: string;
|
|
768
|
+
readonly permissions?: string;
|
|
765
769
|
/** channel flags combined as a bitfield */
|
|
766
|
-
flags?: number;
|
|
770
|
+
readonly flags?: number;
|
|
767
771
|
/** number of messages ever sent in a thread, it's similar to message_count on message creation, but will not decrement the number when a message is deleted */
|
|
768
|
-
total_message_sent?: number;
|
|
772
|
+
readonly total_message_sent?: number;
|
|
769
773
|
/** the set of tags that can be used in a GUILD_FORUM channel */
|
|
770
|
-
available_tags?: ForumTag[];
|
|
774
|
+
readonly available_tags?: ForumTag[];
|
|
771
775
|
/** the IDs of the set of tags that have been applied to a thread in a GUILD_FORUM channel */
|
|
772
|
-
applied_tags?: Snowflake[];
|
|
776
|
+
readonly applied_tags?: Snowflake[];
|
|
773
777
|
/** the emoji to show in the add reaction button on a thread in a GUILD_FORUM channel */
|
|
774
|
-
default_reaction_emoji?: DefaultReaction | null;
|
|
778
|
+
readonly default_reaction_emoji?: DefaultReaction | null;
|
|
775
779
|
/** the initial rate_limit_per_user to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update. */
|
|
776
|
-
default_thread_rate_limit_per_user?: number;
|
|
780
|
+
readonly default_thread_rate_limit_per_user?: number;
|
|
777
781
|
/** the default sort order type used to order posts in GUILD_FORUM channels. Defaults to null, which indicates a preferred sort order hasn't been set by a channel admin */
|
|
778
|
-
default_sort_order?: SortOrderType | null;
|
|
782
|
+
readonly default_sort_order?: SortOrderType | null;
|
|
779
783
|
/** the default forum layout view used to display posts in GUILD_FORUM channels. Defaults to 0, which indicates a layout view has not been set by a channel admin */
|
|
780
|
-
default_forum_layout?: ForumLayoutType;
|
|
784
|
+
readonly default_forum_layout?: ForumLayoutType;
|
|
781
785
|
}
|
|
782
786
|
export type ChannelCreateEvent = Channel;
|
|
783
787
|
export type ChannelDeleteEvent = Channel;
|
|
@@ -789,21 +793,21 @@ export declare const ChannelFlag: {
|
|
|
789
793
|
};
|
|
790
794
|
export interface ChannelMention {
|
|
791
795
|
/** id of the channel */
|
|
792
|
-
id: Snowflake;
|
|
796
|
+
readonly id: Snowflake;
|
|
793
797
|
/** id of the guild containing the channel */
|
|
794
|
-
guild_id: Snowflake;
|
|
798
|
+
readonly guild_id: Snowflake;
|
|
795
799
|
/** the type of channel */
|
|
796
|
-
type: ChannelType;
|
|
800
|
+
readonly type: ChannelType;
|
|
797
801
|
/** the name of the channel */
|
|
798
|
-
name: string;
|
|
802
|
+
readonly name: string;
|
|
799
803
|
}
|
|
800
804
|
export interface ChannelPinsUpdateEvent {
|
|
801
805
|
/** ID of the guild */
|
|
802
|
-
guild_id?: Snowflake;
|
|
806
|
+
readonly guild_id?: Snowflake;
|
|
803
807
|
/** ID of the channel */
|
|
804
|
-
channel_id: Snowflake;
|
|
808
|
+
readonly channel_id: Snowflake;
|
|
805
809
|
/** Time at which the most recent pinned message was pinned */
|
|
806
|
-
last_pin_timestamp?: string | null;
|
|
810
|
+
readonly last_pin_timestamp?: string | null;
|
|
807
811
|
}
|
|
808
812
|
export declare const enum ChannelType {
|
|
809
813
|
/** a text channel within a server */
|
|
@@ -834,11 +838,11 @@ export declare const enum ChannelType {
|
|
|
834
838
|
export type ChannelUpdateEvent = Channel;
|
|
835
839
|
export interface ClientStatus {
|
|
836
840
|
/** User's status set for an active desktop (Windows, Linux, Mac) application session */
|
|
837
|
-
desktop?: string;
|
|
841
|
+
readonly desktop?: string;
|
|
838
842
|
/** User's status set for an active mobile (iOS, Android) application session */
|
|
839
|
-
mobile?: string;
|
|
840
|
-
/** User's status set for an active web (browser, bot
|
|
841
|
-
web?: string;
|
|
843
|
+
readonly mobile?: string;
|
|
844
|
+
/** User's status set for an active web (browser, bot user) application session */
|
|
845
|
+
readonly web?: string;
|
|
842
846
|
}
|
|
843
847
|
export type Component = ActionRow | Button | TextInput | SelectMenu;
|
|
844
848
|
export declare const enum ComponentType {
|
|
@@ -861,286 +865,286 @@ export declare const enum ComponentType {
|
|
|
861
865
|
}
|
|
862
866
|
export interface Connection {
|
|
863
867
|
/** id of the connection account */
|
|
864
|
-
id: string;
|
|
868
|
+
readonly id: string;
|
|
865
869
|
/** the username of the connection account */
|
|
866
|
-
name: string;
|
|
870
|
+
readonly name: string;
|
|
867
871
|
/** the service of this connection */
|
|
868
|
-
type: string;
|
|
872
|
+
readonly type: string;
|
|
869
873
|
/** whether the connection is revoked */
|
|
870
|
-
revoked?: boolean;
|
|
874
|
+
readonly revoked?: boolean;
|
|
871
875
|
/** an array of partial server integrations */
|
|
872
|
-
integrations?: Integration[];
|
|
876
|
+
readonly integrations?: Integration[];
|
|
873
877
|
/** whether the connection is verified */
|
|
874
|
-
verified: boolean;
|
|
878
|
+
readonly verified: boolean;
|
|
875
879
|
/** whether friend sync is enabled for this connection */
|
|
876
|
-
friend_sync: boolean;
|
|
880
|
+
readonly friend_sync: boolean;
|
|
877
881
|
/** whether activities related to this connection will be shown in presence updates */
|
|
878
|
-
show_activity: boolean;
|
|
882
|
+
readonly show_activity: boolean;
|
|
879
883
|
/** whether this connection has a corresponding third party OAuth2 token */
|
|
880
|
-
two_way_link: boolean;
|
|
884
|
+
readonly two_way_link: boolean;
|
|
881
885
|
/** visibility of this connection */
|
|
882
|
-
visibility: VisibilityType;
|
|
886
|
+
readonly visibility: VisibilityType;
|
|
883
887
|
}
|
|
884
888
|
export interface CreateAutoModerationRuleParams {
|
|
885
889
|
/** the rule name */
|
|
886
|
-
name: string;
|
|
890
|
+
readonly name: string;
|
|
887
891
|
/** the event type */
|
|
888
|
-
event_type: EventType;
|
|
892
|
+
readonly event_type: EventType;
|
|
889
893
|
/** the trigger type */
|
|
890
|
-
trigger_type: TriggerType;
|
|
894
|
+
readonly trigger_type: TriggerType;
|
|
891
895
|
/** the trigger metadata */
|
|
892
|
-
trigger_metadata?: TriggerMetadatum;
|
|
896
|
+
readonly trigger_metadata?: TriggerMetadatum;
|
|
893
897
|
/** the actions which will execute when the rule is triggered */
|
|
894
|
-
actions: AutoModerationAction[];
|
|
898
|
+
readonly actions: AutoModerationAction[];
|
|
895
899
|
/** whether the rule is enabled (False by default) */
|
|
896
|
-
enabled?: boolean;
|
|
900
|
+
readonly enabled?: boolean;
|
|
897
901
|
/** the role ids that should not be affected by the rule (Maximum of 20) */
|
|
898
|
-
exempt_roles?: Snowflake[];
|
|
902
|
+
readonly exempt_roles?: Snowflake[];
|
|
899
903
|
/** the channel ids that should not be affected by the rule (Maximum of 50) */
|
|
900
|
-
exempt_channels?: Snowflake[];
|
|
904
|
+
readonly exempt_channels?: Snowflake[];
|
|
901
905
|
}
|
|
902
906
|
export interface CreateChannelInviteParams {
|
|
903
907
|
/** duration of invite in seconds before expiry, or 0 for never. between 0 and 604800 (7 days) */
|
|
904
|
-
max_age: number;
|
|
908
|
+
readonly max_age: number;
|
|
905
909
|
/** max number of uses or 0 for unlimited. between 0 and 100 */
|
|
906
|
-
max_uses: number;
|
|
910
|
+
readonly max_uses: number;
|
|
907
911
|
/** whether this invite only grants temporary membership */
|
|
908
|
-
temporary: boolean;
|
|
912
|
+
readonly temporary: boolean;
|
|
909
913
|
/** if true, don't try to reuse a similar invite (useful for creating many unique one time use invites) */
|
|
910
|
-
unique: boolean;
|
|
914
|
+
readonly unique: boolean;
|
|
911
915
|
/** the type of target for this voice channel invite */
|
|
912
|
-
target_type: InviteTargetType;
|
|
916
|
+
readonly target_type: InviteTargetType;
|
|
913
917
|
/** the id of the user whose stream to display for this invite, required if target_type is 1, the user must be streaming in the channel */
|
|
914
|
-
target_user_id: Snowflake;
|
|
918
|
+
readonly target_user_id: Snowflake;
|
|
915
919
|
/** the id of the embedded application to open for this invite, required if target_type is 2, the application must have the EMBEDDED flag */
|
|
916
|
-
target_application_id: Snowflake;
|
|
920
|
+
readonly target_application_id: Snowflake;
|
|
917
921
|
}
|
|
918
922
|
export interface CreateDmParams {
|
|
919
923
|
/** the recipient to open a DM channel with */
|
|
920
|
-
recipient_id: Snowflake;
|
|
924
|
+
readonly recipient_id: Snowflake;
|
|
921
925
|
}
|
|
922
926
|
export interface CreateGlobalApplicationCommandParams {
|
|
923
927
|
/** Name of command, 1-32 characters */
|
|
924
|
-
name: string;
|
|
928
|
+
readonly name: string;
|
|
925
929
|
/** Localization dictionary for the name field. Values follow the same restrictions as name */
|
|
926
|
-
name_localizations?: Locale | null;
|
|
930
|
+
readonly name_localizations?: Locale | null;
|
|
927
931
|
/** 1-100 character description for CHAT_INPUT commands */
|
|
928
|
-
description?: string;
|
|
932
|
+
readonly description?: string;
|
|
929
933
|
/** Localization dictionary for the description field. Values follow the same restrictions as description */
|
|
930
|
-
description_localizations?: Locale | null;
|
|
934
|
+
readonly description_localizations?: Locale | null;
|
|
931
935
|
/** the parameters for the command */
|
|
932
|
-
options?: ApplicationCommandOption[];
|
|
936
|
+
readonly options?: ApplicationCommandOption[];
|
|
933
937
|
/** Set of permissions represented as a bit set */
|
|
934
|
-
default_member_permissions?: string | null;
|
|
938
|
+
readonly default_member_permissions?: string | null;
|
|
935
939
|
/** Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. */
|
|
936
|
-
dm_permission?: boolean | null;
|
|
940
|
+
readonly dm_permission?: boolean | null;
|
|
937
941
|
/** Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true */
|
|
938
|
-
default_permission?: boolean;
|
|
942
|
+
readonly default_permission?: boolean;
|
|
939
943
|
/** Type of command, defaults 1 if not set */
|
|
940
|
-
type?: ApplicationCommandType;
|
|
944
|
+
readonly type?: ApplicationCommandType;
|
|
941
945
|
/** Indicates whether the command is age-restricted */
|
|
942
|
-
nsfw?: boolean;
|
|
946
|
+
readonly nsfw?: boolean;
|
|
943
947
|
}
|
|
944
948
|
export interface CreateGroupDmParams {
|
|
945
949
|
/** access tokens of users that have granted your app the gdm.join scope */
|
|
946
|
-
access_tokens: string[];
|
|
950
|
+
readonly access_tokens: string[];
|
|
947
951
|
/** a dictionary of user ids to their respective nicknames */
|
|
948
|
-
nicks: Record<string, string>;
|
|
952
|
+
readonly nicks: Record<string, string>;
|
|
949
953
|
}
|
|
950
954
|
export interface CreateGuildApplicationCommandParams {
|
|
951
955
|
/** Name of command, 1-32 characters */
|
|
952
|
-
name: string;
|
|
956
|
+
readonly name: string;
|
|
953
957
|
/** Localization dictionary for the name field. Values follow the same restrictions as name */
|
|
954
|
-
name_localizations?: Locale | null;
|
|
958
|
+
readonly name_localizations?: Locale | null;
|
|
955
959
|
/** 1-100 character description for CHAT_INPUT commands */
|
|
956
|
-
description?: string;
|
|
960
|
+
readonly description?: string;
|
|
957
961
|
/** Localization dictionary for the description field. Values follow the same restrictions as description */
|
|
958
|
-
description_localizations?: Locale | null;
|
|
962
|
+
readonly description_localizations?: Locale | null;
|
|
959
963
|
/** Parameters for the command */
|
|
960
|
-
options?: ApplicationCommandOption[];
|
|
964
|
+
readonly options?: ApplicationCommandOption[];
|
|
961
965
|
/** Set of permissions represented as a bit set */
|
|
962
|
-
default_member_permissions?: string | null;
|
|
966
|
+
readonly default_member_permissions?: string | null;
|
|
963
967
|
/** Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true */
|
|
964
|
-
default_permission?: boolean;
|
|
968
|
+
readonly default_permission?: boolean;
|
|
965
969
|
/** Type of command, defaults 1 if not set */
|
|
966
|
-
type?: ApplicationCommandType;
|
|
970
|
+
readonly type?: ApplicationCommandType;
|
|
967
971
|
/** Indicates whether the command is age-restricted */
|
|
968
|
-
nsfw?: boolean;
|
|
972
|
+
readonly nsfw?: boolean;
|
|
969
973
|
}
|
|
970
974
|
export interface CreateGuildBanParams {
|
|
971
975
|
/** number of days to delete messages for (0-7) (deprecated) */
|
|
972
|
-
delete_message_days?: number;
|
|
976
|
+
readonly delete_message_days?: number;
|
|
973
977
|
/** number of seconds to delete messages for, between 0 and 604800 (7 days) */
|
|
974
|
-
delete_message_seconds?: number;
|
|
978
|
+
readonly delete_message_seconds?: number;
|
|
975
979
|
}
|
|
976
980
|
export interface CreateGuildChannelParams {
|
|
977
981
|
/** channel name (1-100 characters) */
|
|
978
|
-
name: string;
|
|
982
|
+
readonly name: string;
|
|
979
983
|
/** the type of channel */
|
|
980
|
-
type: ChannelType;
|
|
984
|
+
readonly type: ChannelType;
|
|
981
985
|
/** channel topic (0-1024 characters) */
|
|
982
|
-
topic: string;
|
|
986
|
+
readonly topic: string;
|
|
983
987
|
/** the bitrate (in bits) of the voice or stage channel; min 8000 */
|
|
984
|
-
bitrate: number;
|
|
988
|
+
readonly bitrate: number;
|
|
985
989
|
/** the user limit of the voice channel */
|
|
986
|
-
user_limit: number;
|
|
990
|
+
readonly user_limit: number;
|
|
987
991
|
/** amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages or manage_channel, are unaffected */
|
|
988
|
-
rate_limit_per_user: number;
|
|
992
|
+
readonly rate_limit_per_user: number;
|
|
989
993
|
/** sorting position of the channel */
|
|
990
|
-
position: number;
|
|
994
|
+
readonly position: number;
|
|
991
995
|
/** the channel's permission overwrites */
|
|
992
|
-
permission_overwrites: Overwrite[];
|
|
996
|
+
readonly permission_overwrites: Overwrite[];
|
|
993
997
|
/** id of the parent category for a channel */
|
|
994
|
-
parent_id: Snowflake;
|
|
998
|
+
readonly parent_id: Snowflake;
|
|
995
999
|
/** whether the channel is nsfw */
|
|
996
|
-
nsfw: boolean;
|
|
1000
|
+
readonly nsfw: boolean;
|
|
997
1001
|
/** channel voice region id of the voice or stage channel, automatic when set to null */
|
|
998
|
-
rtc_region: string;
|
|
1002
|
+
readonly rtc_region: string;
|
|
999
1003
|
/** the camera video quality mode of the voice channel */
|
|
1000
|
-
video_quality_mode: VideoQualityMode;
|
|
1004
|
+
readonly video_quality_mode: VideoQualityMode;
|
|
1001
1005
|
/** the default duration that the clients use (not the API) for newly created threads in the channel, in minutes, to automatically archive the thread after recent activity */
|
|
1002
|
-
default_auto_archive_duration: number;
|
|
1006
|
+
readonly default_auto_archive_duration: number;
|
|
1003
1007
|
/** emoji to show in the add reaction button on a thread in a GUILD_FORUM channel */
|
|
1004
|
-
default_reaction_emoji: DefaultReaction;
|
|
1008
|
+
readonly default_reaction_emoji: DefaultReaction;
|
|
1005
1009
|
/** set of tags that can be used in a GUILD_FORUM channel */
|
|
1006
|
-
available_tags: ForumTag[];
|
|
1010
|
+
readonly available_tags: ForumTag[];
|
|
1007
1011
|
/** the default sort order type used to order posts in GUILD_FORUM channels */
|
|
1008
|
-
default_sort_order: SortOrderType;
|
|
1012
|
+
readonly default_sort_order: SortOrderType;
|
|
1009
1013
|
}
|
|
1010
1014
|
export interface CreateGuildEmojiParams {
|
|
1011
1015
|
/** name of the emoji */
|
|
1012
|
-
name: string;
|
|
1016
|
+
readonly name: string;
|
|
1013
1017
|
/** the 128x128 emoji image */
|
|
1014
|
-
image: string;
|
|
1018
|
+
readonly image: string;
|
|
1015
1019
|
/** roles allowed to use this emoji */
|
|
1016
|
-
roles: Snowflake[];
|
|
1020
|
+
readonly roles: Snowflake[];
|
|
1017
1021
|
}
|
|
1018
1022
|
export interface CreateGuildFromGuildTemplateParams {
|
|
1019
1023
|
/** name of the guild (2-100 characters) */
|
|
1020
|
-
name: string;
|
|
1024
|
+
readonly name: string;
|
|
1021
1025
|
/** base64 128x128 image for the guild icon */
|
|
1022
|
-
icon?: string;
|
|
1026
|
+
readonly icon?: string;
|
|
1023
1027
|
}
|
|
1024
1028
|
export interface CreateGuildParams {
|
|
1025
1029
|
/** name of the guild (2-100 characters) */
|
|
1026
|
-
name: string;
|
|
1030
|
+
readonly name: string;
|
|
1027
1031
|
/** voice region id (deprecated) */
|
|
1028
|
-
region?: string | null;
|
|
1032
|
+
readonly region?: string | null;
|
|
1029
1033
|
/** base64 128x128 image for the guild icon */
|
|
1030
|
-
icon?: string;
|
|
1034
|
+
readonly icon?: string;
|
|
1031
1035
|
/** verification level */
|
|
1032
|
-
verification_level?: VerificationLevel;
|
|
1036
|
+
readonly verification_level?: VerificationLevel;
|
|
1033
1037
|
/** default message notification level */
|
|
1034
|
-
default_message_notifications?: DefaultMessageNotificationLevel;
|
|
1038
|
+
readonly default_message_notifications?: DefaultMessageNotificationLevel;
|
|
1035
1039
|
/** explicit content filter level */
|
|
1036
|
-
explicit_content_filter?: ExplicitContentFilterLevel;
|
|
1040
|
+
readonly explicit_content_filter?: ExplicitContentFilterLevel;
|
|
1037
1041
|
/** new guild roles */
|
|
1038
|
-
roles?: Role[];
|
|
1042
|
+
readonly roles?: Role[];
|
|
1039
1043
|
/** new guild's channels */
|
|
1040
|
-
channels?: Channel[];
|
|
1044
|
+
readonly channels?: Channel[];
|
|
1041
1045
|
/** id for afk channel */
|
|
1042
|
-
afk_channel_id?: Snowflake;
|
|
1046
|
+
readonly afk_channel_id?: Snowflake;
|
|
1043
1047
|
/** afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600 */
|
|
1044
|
-
afk_timeout?: number;
|
|
1048
|
+
readonly afk_timeout?: number;
|
|
1045
1049
|
/** the id of the channel where guild notices such as welcome messages and boost events are posted */
|
|
1046
|
-
system_channel_id?: Snowflake;
|
|
1050
|
+
readonly system_channel_id?: Snowflake;
|
|
1047
1051
|
/** system channel flags */
|
|
1048
|
-
system_channel_flags?: number;
|
|
1052
|
+
readonly system_channel_flags?: number;
|
|
1049
1053
|
}
|
|
1050
1054
|
export interface CreateGuildRoleParams {
|
|
1051
1055
|
/** name of the role, max 100 characters */
|
|
1052
|
-
name: string;
|
|
1056
|
+
readonly name: string;
|
|
1053
1057
|
/** bitwise value of the enabled/disabled permissions */
|
|
1054
|
-
permissions: string;
|
|
1058
|
+
readonly permissions: string;
|
|
1055
1059
|
/** RGB color value */
|
|
1056
|
-
color: number;
|
|
1060
|
+
readonly color: number;
|
|
1057
1061
|
/** whether the role should be displayed separately in the sidebar */
|
|
1058
|
-
hoist: boolean;
|
|
1062
|
+
readonly hoist: boolean;
|
|
1059
1063
|
/** the role's icon image (if the guild has the ROLE_ICONS feature) */
|
|
1060
|
-
icon?: string | null;
|
|
1064
|
+
readonly icon?: string | null;
|
|
1061
1065
|
/** the role's unicode emoji as a standard emoji (if the guild has the ROLE_ICONS feature) */
|
|
1062
|
-
unicode_emoji?: string | null;
|
|
1066
|
+
readonly unicode_emoji?: string | null;
|
|
1063
1067
|
/** whether the role should be mentionable */
|
|
1064
|
-
mentionable: boolean;
|
|
1068
|
+
readonly mentionable: boolean;
|
|
1065
1069
|
}
|
|
1066
1070
|
export interface CreateGuildScheduledEventParams {
|
|
1067
1071
|
/** the channel id of the scheduled event. */
|
|
1068
|
-
channel_id?: Snowflake;
|
|
1072
|
+
readonly channel_id?: Snowflake;
|
|
1069
1073
|
/** the entity metadata of the scheduled event */
|
|
1070
|
-
entity_metadata?: GuildScheduledEventEntityMetadatum;
|
|
1074
|
+
readonly entity_metadata?: GuildScheduledEventEntityMetadatum;
|
|
1071
1075
|
/** the name of the scheduled event */
|
|
1072
|
-
name: string;
|
|
1076
|
+
readonly name: string;
|
|
1073
1077
|
/** the privacy level of the scheduled event */
|
|
1074
|
-
privacy_level: GuildScheduledEventPrivacyLevel;
|
|
1078
|
+
readonly privacy_level: GuildScheduledEventPrivacyLevel;
|
|
1075
1079
|
/** the time to schedule the scheduled event */
|
|
1076
|
-
scheduled_start_time: string;
|
|
1080
|
+
readonly scheduled_start_time: string;
|
|
1077
1081
|
/** the time when the scheduled event is scheduled to end */
|
|
1078
|
-
scheduled_end_time?: string;
|
|
1082
|
+
readonly scheduled_end_time?: string;
|
|
1079
1083
|
/** the description of the scheduled event */
|
|
1080
|
-
description?: string;
|
|
1084
|
+
readonly description?: string;
|
|
1081
1085
|
/** the entity type of the scheduled event */
|
|
1082
|
-
entity_type: GuildScheduledEventEntityType;
|
|
1086
|
+
readonly entity_type: GuildScheduledEventEntityType;
|
|
1083
1087
|
/** the cover image of the scheduled event */
|
|
1084
|
-
image?: string;
|
|
1088
|
+
readonly image?: string;
|
|
1085
1089
|
}
|
|
1086
1090
|
export interface CreateGuildStickerParams {
|
|
1087
1091
|
/** name of the sticker (2-30 characters) */
|
|
1088
|
-
name: string;
|
|
1092
|
+
readonly name: string;
|
|
1089
1093
|
/** description of the sticker (empty or 2-100 characters) */
|
|
1090
|
-
description: string;
|
|
1094
|
+
readonly description: string;
|
|
1091
1095
|
/** autocomplete/suggestion tags for the sticker (max 200 characters) */
|
|
1092
|
-
tags: string;
|
|
1096
|
+
readonly tags: string;
|
|
1093
1097
|
/** the sticker file to upload, must be a PNG, APNG, GIF, or Lottie JSON file, max 512 KB */
|
|
1094
|
-
file: string;
|
|
1098
|
+
readonly file: string;
|
|
1095
1099
|
}
|
|
1096
1100
|
export interface CreateGuildTemplateParams {
|
|
1097
1101
|
/** name of the template (1-100 characters) */
|
|
1098
|
-
name: string;
|
|
1102
|
+
readonly name: string;
|
|
1099
1103
|
/** description for the template (0-120 characters) */
|
|
1100
|
-
description?: string | null;
|
|
1104
|
+
readonly description?: string | null;
|
|
1101
1105
|
}
|
|
1102
1106
|
export interface CreateMessageParams {
|
|
1103
1107
|
/** Message contents (up to 2000 characters) */
|
|
1104
|
-
content?: string;
|
|
1108
|
+
readonly content?: string;
|
|
1105
1109
|
/** Can be used to verify a message was sent (up to 25 characters). Value will appear in the Message Create event. */
|
|
1106
|
-
nonce?: string;
|
|
1110
|
+
readonly nonce?: string;
|
|
1107
1111
|
/** true if this is a TTS message */
|
|
1108
|
-
tts?: boolean;
|
|
1112
|
+
readonly tts?: boolean;
|
|
1109
1113
|
/** Up to 10 rich embeds (up to 6000 characters) */
|
|
1110
|
-
embeds?: Embed[];
|
|
1114
|
+
readonly embeds?: Embed[];
|
|
1111
1115
|
/** Allowed mentions for the message */
|
|
1112
|
-
allowed_mentions?: AllowedMention;
|
|
1116
|
+
readonly allowed_mentions?: AllowedMention;
|
|
1113
1117
|
/** Include to make your message a reply */
|
|
1114
|
-
message_reference?: MessageReference;
|
|
1118
|
+
readonly message_reference?: MessageReference;
|
|
1115
1119
|
/** Components to include with the message */
|
|
1116
|
-
components?: Component[];
|
|
1120
|
+
readonly components?: Component[];
|
|
1117
1121
|
/** IDs of up to 3 stickers in the server to send in the message */
|
|
1118
|
-
sticker_ids?: Snowflake[];
|
|
1122
|
+
readonly sticker_ids?: Snowflake[];
|
|
1119
1123
|
/** Contents of the file being sent. See Uploading Files */
|
|
1120
|
-
files?: string;
|
|
1124
|
+
readonly files?: string;
|
|
1121
1125
|
/** JSON-encoded body of non-file params, only for multipart/form-data requests. See Uploading Files */
|
|
1122
|
-
payload_json?: string;
|
|
1126
|
+
readonly payload_json?: string;
|
|
1123
1127
|
/** Attachment objects with filename and description. See Uploading Files */
|
|
1124
|
-
attachments?: Attachment[];
|
|
1128
|
+
readonly attachments?: Attachment[];
|
|
1125
1129
|
/** Message flags combined as a bitfield (only SUPPRESS_EMBEDS and SUPPRESS_NOTIFICATIONS can be set) */
|
|
1126
|
-
flags?: number;
|
|
1130
|
+
readonly flags?: number;
|
|
1127
1131
|
}
|
|
1128
1132
|
export declare function createRoutes<O = any>(fetch: <R, P>(route: Route<P, O>) => RestResponse<R>): Endpoints<O>;
|
|
1129
1133
|
export interface CreateStageInstanceParams {
|
|
1130
1134
|
/** The id of the Stage channel */
|
|
1131
|
-
channel_id: Snowflake;
|
|
1135
|
+
readonly channel_id: Snowflake;
|
|
1132
1136
|
/** The topic of the Stage instance (1-120 characters) */
|
|
1133
|
-
topic: string;
|
|
1137
|
+
readonly topic: string;
|
|
1134
1138
|
/** The privacy level of the Stage instance (default GUILD_ONLY) */
|
|
1135
|
-
privacy_level?: PrivacyLevel;
|
|
1139
|
+
readonly privacy_level?: PrivacyLevel;
|
|
1136
1140
|
/** Notify @everyone that a Stage instance has started */
|
|
1137
|
-
send_start_notification?: boolean;
|
|
1141
|
+
readonly send_start_notification?: boolean;
|
|
1138
1142
|
}
|
|
1139
1143
|
export interface CreateWebhookParams {
|
|
1140
1144
|
/** name of the webhook (1-80 characters) */
|
|
1141
|
-
name: string;
|
|
1145
|
+
readonly name: string;
|
|
1142
1146
|
/** image for the default webhook avatar */
|
|
1143
|
-
avatar?: string | null;
|
|
1147
|
+
readonly avatar?: string | null;
|
|
1144
1148
|
}
|
|
1145
1149
|
export declare const enum DefaultMessageNotificationLevel {
|
|
1146
1150
|
/** members will receive notifications for all messages by default */
|
|
@@ -1150,177 +1154,177 @@ export declare const enum DefaultMessageNotificationLevel {
|
|
|
1150
1154
|
}
|
|
1151
1155
|
export interface DefaultReaction {
|
|
1152
1156
|
/** the id of a guild's custom emoji */
|
|
1153
|
-
emoji_id?: Snowflake | null;
|
|
1157
|
+
readonly emoji_id?: Snowflake | null;
|
|
1154
1158
|
/** the unicode character of the emoji */
|
|
1155
|
-
emoji_name?: string | null;
|
|
1159
|
+
readonly emoji_name?: string | null;
|
|
1156
1160
|
}
|
|
1157
1161
|
export interface DeleteWebhookMessageParams {
|
|
1158
1162
|
/** id of the thread the message is in */
|
|
1159
|
-
thread_id: Snowflake;
|
|
1163
|
+
readonly thread_id: Snowflake;
|
|
1160
1164
|
}
|
|
1161
1165
|
export interface EditApplicationCommandPermissionParams {
|
|
1162
1166
|
/** Permissions for the command in the guild */
|
|
1163
|
-
permissions: ApplicationCommandPermission[];
|
|
1167
|
+
readonly permissions: ApplicationCommandPermission[];
|
|
1164
1168
|
}
|
|
1165
1169
|
export interface EditChannelPermissionParams {
|
|
1166
1170
|
/** the bitwise value of all allowed permissions (default "0") */
|
|
1167
|
-
allow?: string;
|
|
1171
|
+
readonly allow?: string;
|
|
1168
1172
|
/** the bitwise value of all disallowed permissions (default "0") */
|
|
1169
|
-
deny?: string;
|
|
1173
|
+
readonly deny?: string;
|
|
1170
1174
|
/** 0 for a role or 1 for a member */
|
|
1171
|
-
type: number;
|
|
1175
|
+
readonly type: number;
|
|
1172
1176
|
}
|
|
1173
1177
|
export interface EditGlobalApplicationCommandParams {
|
|
1174
1178
|
/** Name of command, 1-32 characters */
|
|
1175
|
-
name?: string;
|
|
1179
|
+
readonly name?: string;
|
|
1176
1180
|
/** Localization dictionary for the name field. Values follow the same restrictions as name */
|
|
1177
|
-
name_localizations?: Locale | null;
|
|
1181
|
+
readonly name_localizations?: Locale | null;
|
|
1178
1182
|
/** 1-100 character description */
|
|
1179
|
-
description?: string;
|
|
1183
|
+
readonly description?: string;
|
|
1180
1184
|
/** Localization dictionary for the description field. Values follow the same restrictions as description */
|
|
1181
|
-
description_localizations?: Locale | null;
|
|
1185
|
+
readonly description_localizations?: Locale | null;
|
|
1182
1186
|
/** the parameters for the command */
|
|
1183
|
-
options?: ApplicationCommandOption[];
|
|
1187
|
+
readonly options?: ApplicationCommandOption[];
|
|
1184
1188
|
/** Set of permissions represented as a bit set */
|
|
1185
|
-
default_member_permissions?: string | null;
|
|
1189
|
+
readonly default_member_permissions?: string | null;
|
|
1186
1190
|
/** Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. */
|
|
1187
|
-
dm_permission?: boolean | null;
|
|
1191
|
+
readonly dm_permission?: boolean | null;
|
|
1188
1192
|
/** Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true */
|
|
1189
|
-
default_permission?: boolean;
|
|
1193
|
+
readonly default_permission?: boolean;
|
|
1190
1194
|
/** Indicates whether the command is age-restricted */
|
|
1191
|
-
nsfw?: boolean;
|
|
1195
|
+
readonly nsfw?: boolean;
|
|
1192
1196
|
}
|
|
1193
1197
|
export interface EditGuildApplicationCommandParams {
|
|
1194
1198
|
/** Name of command, 1-32 characters */
|
|
1195
|
-
name?: string;
|
|
1199
|
+
readonly name?: string;
|
|
1196
1200
|
/** Localization dictionary for the name field. Values follow the same restrictions as name */
|
|
1197
|
-
name_localizations?: Locale | null;
|
|
1201
|
+
readonly name_localizations?: Locale | null;
|
|
1198
1202
|
/** 1-100 character description */
|
|
1199
|
-
description?: string;
|
|
1203
|
+
readonly description?: string;
|
|
1200
1204
|
/** Localization dictionary for the description field. Values follow the same restrictions as description */
|
|
1201
|
-
description_localizations?: Locale | null;
|
|
1205
|
+
readonly description_localizations?: Locale | null;
|
|
1202
1206
|
/** Parameters for the command */
|
|
1203
|
-
options?: ApplicationCommandOption[];
|
|
1207
|
+
readonly options?: ApplicationCommandOption[];
|
|
1204
1208
|
/** Set of permissions represented as a bit set */
|
|
1205
|
-
default_member_permissions?: string | null;
|
|
1209
|
+
readonly default_member_permissions?: string | null;
|
|
1206
1210
|
/** Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true */
|
|
1207
|
-
default_permission?: boolean;
|
|
1211
|
+
readonly default_permission?: boolean;
|
|
1208
1212
|
/** Indicates whether the command is age-restricted */
|
|
1209
|
-
nsfw?: boolean;
|
|
1213
|
+
readonly nsfw?: boolean;
|
|
1210
1214
|
}
|
|
1211
1215
|
export interface EditMessageParams {
|
|
1212
1216
|
/** Message contents (up to 2000 characters) */
|
|
1213
|
-
content: string;
|
|
1217
|
+
readonly content: string;
|
|
1214
1218
|
/** Up to 10 rich embeds (up to 6000 characters) */
|
|
1215
|
-
embeds: Embed[];
|
|
1219
|
+
readonly embeds: Embed[];
|
|
1216
1220
|
/** Edit the flags of a message (only SUPPRESS_EMBEDS can currently be set/unset) */
|
|
1217
|
-
flags: number;
|
|
1221
|
+
readonly flags: number;
|
|
1218
1222
|
/** Allowed mentions for the message */
|
|
1219
|
-
allowed_mentions: AllowedMention;
|
|
1223
|
+
readonly allowed_mentions: AllowedMention;
|
|
1220
1224
|
/** Components to include with the message */
|
|
1221
|
-
components: Component[];
|
|
1225
|
+
readonly components: Component[];
|
|
1222
1226
|
/** Contents of the file being sent/edited. See Uploading Files */
|
|
1223
|
-
files: string;
|
|
1227
|
+
readonly files: string;
|
|
1224
1228
|
/** JSON-encoded body of non-file params (multipart/form-data only). See Uploading Files */
|
|
1225
|
-
payload_json: string;
|
|
1229
|
+
readonly payload_json: string;
|
|
1226
1230
|
/** Attached files to keep and possible descriptions for new files. See Uploading Files */
|
|
1227
|
-
attachments: Attachment[];
|
|
1231
|
+
readonly attachments: Attachment[];
|
|
1228
1232
|
}
|
|
1229
1233
|
export interface EditWebhookMessageParams {
|
|
1230
1234
|
/** the message contents (up to 2000 characters) */
|
|
1231
|
-
content: string;
|
|
1235
|
+
readonly content: string;
|
|
1232
1236
|
/** embedded rich content */
|
|
1233
|
-
embeds: Embed[];
|
|
1237
|
+
readonly embeds: Embed[];
|
|
1234
1238
|
/** allowed mentions for the message */
|
|
1235
|
-
allowed_mentions: AllowedMention;
|
|
1239
|
+
readonly allowed_mentions: AllowedMention;
|
|
1236
1240
|
/** the components to include with the message */
|
|
1237
|
-
components: Component[];
|
|
1241
|
+
readonly components: Component[];
|
|
1238
1242
|
/** the contents of the file being sent/edited */
|
|
1239
|
-
files: string;
|
|
1243
|
+
readonly files: string;
|
|
1240
1244
|
/** JSON encoded body of non-file params (multipart/form-data only) */
|
|
1241
|
-
payload_json: string;
|
|
1245
|
+
readonly payload_json: string;
|
|
1242
1246
|
/** attached files to keep and possible descriptions for new files */
|
|
1243
|
-
attachments: Attachment[];
|
|
1247
|
+
readonly attachments: Attachment[];
|
|
1244
1248
|
}
|
|
1245
1249
|
export interface Embed {
|
|
1246
1250
|
/** title of embed */
|
|
1247
|
-
title?: string;
|
|
1251
|
+
readonly title?: string;
|
|
1248
1252
|
/** type of embed (always "rich" for webhook embeds) */
|
|
1249
|
-
type?: EmbedType;
|
|
1253
|
+
readonly type?: EmbedType;
|
|
1250
1254
|
/** description of embed */
|
|
1251
|
-
description?: string;
|
|
1255
|
+
readonly description?: string;
|
|
1252
1256
|
/** url of embed */
|
|
1253
|
-
url?: string;
|
|
1257
|
+
readonly url?: string;
|
|
1254
1258
|
/** timestamp of embed content */
|
|
1255
|
-
timestamp?: string;
|
|
1259
|
+
readonly timestamp?: string;
|
|
1256
1260
|
/** color code of the embed */
|
|
1257
|
-
color?: number;
|
|
1261
|
+
readonly color?: number;
|
|
1258
1262
|
/** footer information */
|
|
1259
|
-
footer?: EmbedFooter;
|
|
1263
|
+
readonly footer?: EmbedFooter;
|
|
1260
1264
|
/** image information */
|
|
1261
|
-
image?: EmbedImage;
|
|
1265
|
+
readonly image?: EmbedImage;
|
|
1262
1266
|
/** thumbnail information */
|
|
1263
|
-
thumbnail?: EmbedThumbnail;
|
|
1267
|
+
readonly thumbnail?: EmbedThumbnail;
|
|
1264
1268
|
/** video information */
|
|
1265
|
-
video?: EmbedVideo;
|
|
1269
|
+
readonly video?: EmbedVideo;
|
|
1266
1270
|
/** provider information */
|
|
1267
|
-
provider?: EmbedProvider;
|
|
1271
|
+
readonly provider?: EmbedProvider;
|
|
1268
1272
|
/** author information */
|
|
1269
|
-
author?: EmbedAuthor;
|
|
1273
|
+
readonly author?: EmbedAuthor;
|
|
1270
1274
|
/** fields information */
|
|
1271
|
-
fields?: EmbedField[];
|
|
1275
|
+
readonly fields?: EmbedField[];
|
|
1272
1276
|
}
|
|
1273
1277
|
export interface EmbedAuthor {
|
|
1274
1278
|
/** name of author */
|
|
1275
|
-
name: string;
|
|
1279
|
+
readonly name: string;
|
|
1276
1280
|
/** url of author (only supports http(s)) */
|
|
1277
|
-
url?: string;
|
|
1281
|
+
readonly url?: string;
|
|
1278
1282
|
/** url of author icon (only supports http(s) and attachments) */
|
|
1279
|
-
icon_url?: string;
|
|
1283
|
+
readonly icon_url?: string;
|
|
1280
1284
|
/** a proxied url of author icon */
|
|
1281
|
-
proxy_icon_url?: string;
|
|
1285
|
+
readonly proxy_icon_url?: string;
|
|
1282
1286
|
}
|
|
1283
1287
|
export interface EmbedField {
|
|
1284
1288
|
/** name of the field */
|
|
1285
|
-
name: string;
|
|
1289
|
+
readonly name: string;
|
|
1286
1290
|
/** value of the field */
|
|
1287
|
-
value: string;
|
|
1291
|
+
readonly value: string;
|
|
1288
1292
|
/** whether or not this field should display inline */
|
|
1289
|
-
inline?: boolean;
|
|
1293
|
+
readonly inline?: boolean;
|
|
1290
1294
|
}
|
|
1291
1295
|
export interface EmbedFooter {
|
|
1292
1296
|
/** footer text */
|
|
1293
|
-
text: string;
|
|
1297
|
+
readonly text: string;
|
|
1294
1298
|
/** url of footer icon (only supports http(s) and attachments) */
|
|
1295
|
-
icon_url?: string;
|
|
1299
|
+
readonly icon_url?: string;
|
|
1296
1300
|
/** a proxied url of footer icon */
|
|
1297
|
-
proxy_icon_url?: string;
|
|
1301
|
+
readonly proxy_icon_url?: string;
|
|
1298
1302
|
}
|
|
1299
1303
|
export interface EmbedImage {
|
|
1300
1304
|
/** source url of image (only supports http(s) and attachments) */
|
|
1301
|
-
url: string;
|
|
1305
|
+
readonly url: string;
|
|
1302
1306
|
/** a proxied url of the image */
|
|
1303
|
-
proxy_url?: string;
|
|
1307
|
+
readonly proxy_url?: string;
|
|
1304
1308
|
/** height of image */
|
|
1305
|
-
height?: number;
|
|
1309
|
+
readonly height?: number;
|
|
1306
1310
|
/** width of image */
|
|
1307
|
-
width?: number;
|
|
1311
|
+
readonly width?: number;
|
|
1308
1312
|
}
|
|
1309
1313
|
export interface EmbedProvider {
|
|
1310
1314
|
/** name of provider */
|
|
1311
|
-
name?: string;
|
|
1315
|
+
readonly name?: string;
|
|
1312
1316
|
/** url of provider */
|
|
1313
|
-
url?: string;
|
|
1317
|
+
readonly url?: string;
|
|
1314
1318
|
}
|
|
1315
1319
|
export interface EmbedThumbnail {
|
|
1316
1320
|
/** source url of thumbnail (only supports http(s) and attachments) */
|
|
1317
|
-
url: string;
|
|
1321
|
+
readonly url: string;
|
|
1318
1322
|
/** a proxied url of the thumbnail */
|
|
1319
|
-
proxy_url?: string;
|
|
1323
|
+
readonly proxy_url?: string;
|
|
1320
1324
|
/** height of thumbnail */
|
|
1321
|
-
height?: number;
|
|
1325
|
+
readonly height?: number;
|
|
1322
1326
|
/** width of thumbnail */
|
|
1323
|
-
width?: number;
|
|
1327
|
+
readonly width?: number;
|
|
1324
1328
|
}
|
|
1325
1329
|
export declare const enum EmbedType {
|
|
1326
1330
|
/** generic embed rendered from embed attributes */
|
|
@@ -1338,31 +1342,31 @@ export declare const enum EmbedType {
|
|
|
1338
1342
|
}
|
|
1339
1343
|
export interface EmbedVideo {
|
|
1340
1344
|
/** source url of video */
|
|
1341
|
-
url?: string;
|
|
1345
|
+
readonly url?: string;
|
|
1342
1346
|
/** a proxied url of the video */
|
|
1343
|
-
proxy_url?: string;
|
|
1347
|
+
readonly proxy_url?: string;
|
|
1344
1348
|
/** height of video */
|
|
1345
|
-
height?: number;
|
|
1349
|
+
readonly height?: number;
|
|
1346
1350
|
/** width of video */
|
|
1347
|
-
width?: number;
|
|
1351
|
+
readonly width?: number;
|
|
1348
1352
|
}
|
|
1349
1353
|
export interface Emoji {
|
|
1350
1354
|
/** emoji id */
|
|
1351
|
-
id?: Snowflake | null;
|
|
1355
|
+
readonly id?: Snowflake | null;
|
|
1352
1356
|
/** emoji name */
|
|
1353
|
-
name?: string | null;
|
|
1357
|
+
readonly name?: string | null;
|
|
1354
1358
|
/** roles allowed to use this emoji */
|
|
1355
|
-
roles?: Snowflake[];
|
|
1359
|
+
readonly roles?: Snowflake[];
|
|
1356
1360
|
/** user that created this emoji */
|
|
1357
|
-
user?: User;
|
|
1361
|
+
readonly user?: User;
|
|
1358
1362
|
/** whether this emoji must be wrapped in colons */
|
|
1359
|
-
require_colons?: boolean;
|
|
1363
|
+
readonly require_colons?: boolean;
|
|
1360
1364
|
/** whether this emoji is managed */
|
|
1361
|
-
managed?: boolean;
|
|
1365
|
+
readonly managed?: boolean;
|
|
1362
1366
|
/** whether this emoji is animated */
|
|
1363
|
-
animated?: boolean;
|
|
1367
|
+
readonly animated?: boolean;
|
|
1364
1368
|
/** whether this emoji can be used, may be false due to loss of Server Boosts */
|
|
1365
|
-
available?: boolean;
|
|
1369
|
+
readonly available?: boolean;
|
|
1366
1370
|
}
|
|
1367
1371
|
export interface Endpoints<O> {
|
|
1368
1372
|
/** Adds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope. Returns a 201 Created with the guild member as the body, or 204 No Content if the user is already a member of the guild. Fires a Guild Member Add Gateway event. */
|
|
@@ -1720,29 +1724,29 @@ export declare const enum EventType {
|
|
|
1720
1724
|
}
|
|
1721
1725
|
export interface ExecuteWebhookParams {
|
|
1722
1726
|
/** the message contents (up to 2000 characters) */
|
|
1723
|
-
content: string;
|
|
1727
|
+
readonly content: string;
|
|
1724
1728
|
/** override the default username of the webhook */
|
|
1725
|
-
username: string;
|
|
1729
|
+
readonly username: string;
|
|
1726
1730
|
/** override the default avatar of the webhook */
|
|
1727
|
-
avatar_url: string;
|
|
1731
|
+
readonly avatar_url: string;
|
|
1728
1732
|
/** true if this is a TTS message */
|
|
1729
|
-
tts: boolean;
|
|
1733
|
+
readonly tts: boolean;
|
|
1730
1734
|
/** embedded rich content */
|
|
1731
|
-
embeds: Embed[];
|
|
1735
|
+
readonly embeds: Embed[];
|
|
1732
1736
|
/** allowed mentions for the message */
|
|
1733
|
-
allowed_mentions: AllowedMention;
|
|
1737
|
+
readonly allowed_mentions: AllowedMention;
|
|
1734
1738
|
/** the components to include with the message */
|
|
1735
|
-
components: Component[];
|
|
1739
|
+
readonly components: Component[];
|
|
1736
1740
|
/** the contents of the file being sent */
|
|
1737
|
-
files: string;
|
|
1741
|
+
readonly files: string;
|
|
1738
1742
|
/** JSON encoded body of non-file params */
|
|
1739
|
-
payload_json: string;
|
|
1743
|
+
readonly payload_json: string;
|
|
1740
1744
|
/** attachment objects with filename and description */
|
|
1741
|
-
attachments: Attachment[];
|
|
1745
|
+
readonly attachments: Attachment[];
|
|
1742
1746
|
/** message flags combined as a bitfield (only SUPPRESS_EMBEDS can be set) */
|
|
1743
|
-
flags: number;
|
|
1747
|
+
readonly flags: number;
|
|
1744
1748
|
/** name of thread to create (requires the webhook channel to be a forum channel) */
|
|
1745
|
-
thread_name: string;
|
|
1749
|
+
readonly thread_name: string;
|
|
1746
1750
|
}
|
|
1747
1751
|
export declare const enum ExplicitContentFilterLevel {
|
|
1748
1752
|
/** media content will not be scanned */
|
|
@@ -1754,13 +1758,13 @@ export declare const enum ExplicitContentFilterLevel {
|
|
|
1754
1758
|
}
|
|
1755
1759
|
export interface FollowAnnouncementChannelParams {
|
|
1756
1760
|
/** id of target channel */
|
|
1757
|
-
webhook_channel_id: Snowflake;
|
|
1761
|
+
readonly webhook_channel_id: Snowflake;
|
|
1758
1762
|
}
|
|
1759
1763
|
export interface FollowedChannel {
|
|
1760
1764
|
/** source channel id */
|
|
1761
|
-
channel_id: Snowflake;
|
|
1765
|
+
readonly channel_id: Snowflake;
|
|
1762
1766
|
/** created target webhook id */
|
|
1763
|
-
webhook_id: Snowflake;
|
|
1767
|
+
readonly webhook_id: Snowflake;
|
|
1764
1768
|
}
|
|
1765
1769
|
export declare const enum ForumLayoutType {
|
|
1766
1770
|
/** No default has been set for forum channel */
|
|
@@ -1772,35 +1776,35 @@ export declare const enum ForumLayoutType {
|
|
|
1772
1776
|
}
|
|
1773
1777
|
export interface ForumTag {
|
|
1774
1778
|
/** the id of the tag */
|
|
1775
|
-
id: Snowflake;
|
|
1779
|
+
readonly id: Snowflake;
|
|
1776
1780
|
/** the name of the tag (0-20 characters) */
|
|
1777
|
-
name: string;
|
|
1781
|
+
readonly name: string;
|
|
1778
1782
|
/** whether this tag can only be added to or removed from threads by a member with the MANAGE_THREADS permission */
|
|
1779
|
-
moderated: boolean;
|
|
1783
|
+
readonly moderated: boolean;
|
|
1780
1784
|
/** the id of a guild's custom emoji * */
|
|
1781
|
-
emoji_id?: Snowflake | null;
|
|
1785
|
+
readonly emoji_id?: Snowflake | null;
|
|
1782
1786
|
/** the unicode character of the emoji * */
|
|
1783
|
-
emoji_name?: string | null;
|
|
1787
|
+
readonly emoji_name?: string | null;
|
|
1784
1788
|
}
|
|
1785
1789
|
export interface ForumThreadMessageParam {
|
|
1786
1790
|
/** Message contents (up to 2000 characters) */
|
|
1787
|
-
content?: string;
|
|
1791
|
+
readonly content?: string;
|
|
1788
1792
|
/** Up to 10 rich embeds (up to 6000 characters) */
|
|
1789
|
-
embeds?: Embed[];
|
|
1793
|
+
readonly embeds?: Embed[];
|
|
1790
1794
|
/** Allowed mentions for the message */
|
|
1791
|
-
allowed_mentions?: AllowedMention;
|
|
1795
|
+
readonly allowed_mentions?: AllowedMention;
|
|
1792
1796
|
/** Components to include with the message */
|
|
1793
|
-
components?: Component[];
|
|
1797
|
+
readonly components?: Component[];
|
|
1794
1798
|
/** IDs of up to 3 stickers in the server to send in the message */
|
|
1795
|
-
sticker_ids?: Snowflake[];
|
|
1799
|
+
readonly sticker_ids?: Snowflake[];
|
|
1796
1800
|
/** Contents of the file being sent. See Uploading Files */
|
|
1797
|
-
files: string;
|
|
1801
|
+
readonly files: string;
|
|
1798
1802
|
/** JSON-encoded body of non-file params, only for multipart/form-data requests. See Uploading Files */
|
|
1799
|
-
payload_json?: string;
|
|
1803
|
+
readonly payload_json?: string;
|
|
1800
1804
|
/** Attachment objects with filename and description. See Uploading Files */
|
|
1801
|
-
attachments?: Attachment[];
|
|
1805
|
+
readonly attachments?: Attachment[];
|
|
1802
1806
|
/** Message flags combined as a bitfield (only SUPPRESS_EMBEDS and SUPPRESS_NOTIFICATIONS can be set) */
|
|
1803
|
-
flags?: number;
|
|
1807
|
+
readonly flags?: number;
|
|
1804
1808
|
}
|
|
1805
1809
|
export declare const GatewayIntents: {
|
|
1806
1810
|
readonly GUILDS: number;
|
|
@@ -1849,282 +1853,282 @@ export declare const enum GatewayOpcode {
|
|
|
1849
1853
|
}
|
|
1850
1854
|
export interface GatewayPayload<T = any | null> {
|
|
1851
1855
|
/** opcode for the payload */
|
|
1852
|
-
op: GatewayOpcode;
|
|
1856
|
+
readonly op: GatewayOpcode;
|
|
1853
1857
|
/** event data */
|
|
1854
|
-
d?: T;
|
|
1858
|
+
readonly d?: T;
|
|
1855
1859
|
/** sequence number, used for resuming sessions and heartbeats */
|
|
1856
|
-
s?: number | null;
|
|
1860
|
+
readonly s?: number | null;
|
|
1857
1861
|
/** the event name for this payload */
|
|
1858
|
-
t?: string | null;
|
|
1862
|
+
readonly t?: string | null;
|
|
1859
1863
|
}
|
|
1860
1864
|
export interface GatewayUrlQueryStringParam {
|
|
1861
1865
|
/** API Version to use */
|
|
1862
|
-
v: number;
|
|
1866
|
+
readonly v: number;
|
|
1863
1867
|
/** The encoding of received gateway packets */
|
|
1864
|
-
encoding: string;
|
|
1868
|
+
readonly encoding: string;
|
|
1865
1869
|
/** The optional transport compression of gateway packets */
|
|
1866
|
-
compress?: string;
|
|
1870
|
+
readonly compress?: string;
|
|
1867
1871
|
}
|
|
1868
1872
|
export interface GetChannelMessageParams {
|
|
1869
1873
|
/** Get messages around this message ID */
|
|
1870
|
-
around?: Snowflake;
|
|
1874
|
+
readonly around?: Snowflake;
|
|
1871
1875
|
/** Get messages before this message ID */
|
|
1872
|
-
before?: Snowflake;
|
|
1876
|
+
readonly before?: Snowflake;
|
|
1873
1877
|
/** Get messages after this message ID */
|
|
1874
|
-
after?: Snowflake;
|
|
1878
|
+
readonly after?: Snowflake;
|
|
1875
1879
|
/** Max number of messages to return (1-100) */
|
|
1876
|
-
limit?: number;
|
|
1880
|
+
readonly limit?: number;
|
|
1877
1881
|
}
|
|
1878
1882
|
export interface GetCurrentAuthorizationInformationResponse {
|
|
1879
1883
|
/** the current application */
|
|
1880
|
-
application: Application;
|
|
1884
|
+
readonly application: Application;
|
|
1881
1885
|
/** the scopes the user has authorized the application for */
|
|
1882
|
-
scopes: string[];
|
|
1886
|
+
readonly scopes: string[];
|
|
1883
1887
|
/** when the access token expires */
|
|
1884
|
-
expires: string;
|
|
1888
|
+
readonly expires: string;
|
|
1885
1889
|
/** the user who has authorized, if the user has authorized with the identify scope */
|
|
1886
|
-
user?: User;
|
|
1890
|
+
readonly user?: User;
|
|
1887
1891
|
}
|
|
1888
1892
|
export interface GetCurrentUserGuildParams {
|
|
1889
1893
|
/** get guilds before this guild ID */
|
|
1890
|
-
before: Snowflake;
|
|
1894
|
+
readonly before: Snowflake;
|
|
1891
1895
|
/** get guilds after this guild ID */
|
|
1892
|
-
after: Snowflake;
|
|
1896
|
+
readonly after: Snowflake;
|
|
1893
1897
|
/** max number of guilds to return (1-200) */
|
|
1894
|
-
limit: number;
|
|
1898
|
+
readonly limit: number;
|
|
1895
1899
|
}
|
|
1896
1900
|
export interface GetGatewayBotResponse {
|
|
1897
1901
|
/** WSS URL that can be used for connecting to the Gateway */
|
|
1898
|
-
url: string;
|
|
1902
|
+
readonly url: string;
|
|
1899
1903
|
/** Recommended number of shards to use when connecting */
|
|
1900
|
-
shards: number;
|
|
1904
|
+
readonly shards: number;
|
|
1901
1905
|
/** Information on the current session start limit */
|
|
1902
|
-
session_start_limit: SessionStartLimit;
|
|
1906
|
+
readonly session_start_limit: SessionStartLimit;
|
|
1903
1907
|
}
|
|
1904
1908
|
export interface GetGlobalApplicationCommandParams {
|
|
1905
1909
|
/** Whether to include full localization dictionaries (name_localizations and description_localizations) in the returned objects, instead of the name_localized and description_localized fields. Default false. */
|
|
1906
|
-
with_localizations?: boolean;
|
|
1910
|
+
readonly with_localizations?: boolean;
|
|
1907
1911
|
}
|
|
1908
1912
|
export interface GetGuildApplicationCommandParams {
|
|
1909
1913
|
/** Whether to include full localization dictionaries (name_localizations and description_localizations) in the returned objects, instead of the name_localized and description_localized fields. Default false. */
|
|
1910
|
-
with_localizations?: boolean;
|
|
1914
|
+
readonly with_localizations?: boolean;
|
|
1911
1915
|
}
|
|
1912
1916
|
export interface GetGuildAuditLogParams {
|
|
1913
1917
|
/** Entries from a specific user ID */
|
|
1914
|
-
user_id?: Snowflake;
|
|
1918
|
+
readonly user_id?: Snowflake;
|
|
1915
1919
|
/** Entries for a specific audit log event */
|
|
1916
|
-
action_type?: AuditLogEvent;
|
|
1920
|
+
readonly action_type?: AuditLogEvent;
|
|
1917
1921
|
/** Entries with ID less than a specific audit log entry ID */
|
|
1918
|
-
before?: Snowflake;
|
|
1922
|
+
readonly before?: Snowflake;
|
|
1919
1923
|
/** Entries with ID greater than a specific audit log entry ID */
|
|
1920
|
-
after?: Snowflake;
|
|
1924
|
+
readonly after?: Snowflake;
|
|
1921
1925
|
/** Maximum number of entries (between 1-100) to return, defaults to 50 */
|
|
1922
|
-
limit?: number;
|
|
1926
|
+
readonly limit?: number;
|
|
1923
1927
|
}
|
|
1924
1928
|
export interface GetGuildBanParams {
|
|
1925
1929
|
/** number of users to return (up to maximum 1000) */
|
|
1926
|
-
limit?: Number;
|
|
1930
|
+
readonly limit?: Number;
|
|
1927
1931
|
/** consider only users before given user id */
|
|
1928
|
-
before?: Snowflake;
|
|
1932
|
+
readonly before?: Snowflake;
|
|
1929
1933
|
/** consider only users after given user id */
|
|
1930
|
-
after?: Snowflake;
|
|
1934
|
+
readonly after?: Snowflake;
|
|
1931
1935
|
}
|
|
1932
1936
|
export interface GetGuildParams {
|
|
1933
1937
|
/** when true, will return approximate member and presence counts for the guild */
|
|
1934
|
-
with_counts?: boolean;
|
|
1938
|
+
readonly with_counts?: boolean;
|
|
1935
1939
|
}
|
|
1936
1940
|
export interface GetGuildPruneCountParams {
|
|
1937
1941
|
/** number of days to count prune for (1-30) */
|
|
1938
|
-
days: number;
|
|
1942
|
+
readonly days: number;
|
|
1939
1943
|
/** role(s) to include */
|
|
1940
|
-
include_roles: Snowflake[];
|
|
1944
|
+
readonly include_roles: Snowflake[];
|
|
1941
1945
|
}
|
|
1942
1946
|
export interface GetGuildScheduledEventParams {
|
|
1943
1947
|
/** include number of users subscribed to this event */
|
|
1944
|
-
with_user_count?: boolean;
|
|
1948
|
+
readonly with_user_count?: boolean;
|
|
1945
1949
|
}
|
|
1946
1950
|
export interface GetGuildScheduledEventUserParams {
|
|
1947
1951
|
/** number of users to return (up to maximum 100) */
|
|
1948
|
-
limit?: Number;
|
|
1952
|
+
readonly limit?: Number;
|
|
1949
1953
|
/** include guild member data if it exists */
|
|
1950
|
-
with_member?: boolean;
|
|
1954
|
+
readonly with_member?: boolean;
|
|
1951
1955
|
/** consider only users before given user id */
|
|
1952
|
-
before?: Snowflake;
|
|
1956
|
+
readonly before?: Snowflake;
|
|
1953
1957
|
/** consider only users after given user id */
|
|
1954
|
-
after?: Snowflake;
|
|
1958
|
+
readonly after?: Snowflake;
|
|
1955
1959
|
}
|
|
1956
1960
|
export interface GetGuildWidgetImageParams {
|
|
1957
1961
|
/** style of the widget image returned (see below) */
|
|
1958
|
-
style: string;
|
|
1962
|
+
readonly style: string;
|
|
1959
1963
|
}
|
|
1960
1964
|
export interface GetInviteParams {
|
|
1961
1965
|
/** whether the invite should contain approximate member counts */
|
|
1962
|
-
with_counts?: boolean;
|
|
1966
|
+
readonly with_counts?: boolean;
|
|
1963
1967
|
/** whether the invite should contain the expiration date */
|
|
1964
|
-
with_expiration?: boolean;
|
|
1968
|
+
readonly with_expiration?: boolean;
|
|
1965
1969
|
/** the guild scheduled event to include with the invite */
|
|
1966
|
-
guild_scheduled_event_id?: Snowflake;
|
|
1970
|
+
readonly guild_scheduled_event_id?: Snowflake;
|
|
1967
1971
|
}
|
|
1968
1972
|
export interface GetReactionParams {
|
|
1969
1973
|
/** Get users after this user ID */
|
|
1970
|
-
after?: Snowflake;
|
|
1974
|
+
readonly after?: Snowflake;
|
|
1971
1975
|
/** Max number of users to return (1-100) */
|
|
1972
|
-
limit?: number;
|
|
1976
|
+
readonly limit?: number;
|
|
1973
1977
|
}
|
|
1974
1978
|
export interface GetThreadMemberParams {
|
|
1975
1979
|
/** Whether to include a guild member object for the thread member */
|
|
1976
|
-
with_member?: boolean;
|
|
1980
|
+
readonly with_member?: boolean;
|
|
1977
1981
|
}
|
|
1978
1982
|
export interface GetWebhookMessageParams {
|
|
1979
1983
|
/** id of the thread the message is in */
|
|
1980
|
-
thread_id: Snowflake;
|
|
1984
|
+
readonly thread_id: Snowflake;
|
|
1981
1985
|
}
|
|
1982
1986
|
export interface GroupDmAddRecipientParams {
|
|
1983
1987
|
/** access token of a user that has granted your app the gdm.join scope */
|
|
1984
|
-
access_token: string;
|
|
1988
|
+
readonly access_token: string;
|
|
1985
1989
|
/** nickname of the user being added */
|
|
1986
|
-
nick: string;
|
|
1990
|
+
readonly nick: string;
|
|
1987
1991
|
}
|
|
1988
1992
|
export interface Guild {
|
|
1989
1993
|
/** guild id */
|
|
1990
|
-
id: Snowflake;
|
|
1994
|
+
readonly id: Snowflake;
|
|
1991
1995
|
/** guild name (2-100 characters, excluding trailing and leading whitespace) */
|
|
1992
|
-
name: string;
|
|
1996
|
+
readonly name: string;
|
|
1993
1997
|
/** icon hash */
|
|
1994
|
-
icon?: string | null;
|
|
1998
|
+
readonly icon?: string | null;
|
|
1995
1999
|
/** icon hash, returned when in the template object */
|
|
1996
|
-
icon_hash?: string | null;
|
|
2000
|
+
readonly icon_hash?: string | null;
|
|
1997
2001
|
/** splash hash */
|
|
1998
|
-
splash?: string | null;
|
|
2002
|
+
readonly splash?: string | null;
|
|
1999
2003
|
/** discovery splash hash; only present for guilds with the "DISCOVERABLE" feature */
|
|
2000
|
-
discovery_splash?: string | null;
|
|
2004
|
+
readonly discovery_splash?: string | null;
|
|
2001
2005
|
/** true if the user is the owner of the guild */
|
|
2002
|
-
owner?: boolean;
|
|
2006
|
+
readonly owner?: boolean;
|
|
2003
2007
|
/** id of owner */
|
|
2004
|
-
owner_id: Snowflake;
|
|
2008
|
+
readonly owner_id: Snowflake;
|
|
2005
2009
|
/** total permissions for the user in the guild (excludes overwrites) */
|
|
2006
|
-
permissions?: string;
|
|
2010
|
+
readonly permissions?: string;
|
|
2007
2011
|
/** voice region id for the guild (deprecated) */
|
|
2008
|
-
region?: string | null;
|
|
2012
|
+
readonly region?: string | null;
|
|
2009
2013
|
/** id of afk channel */
|
|
2010
|
-
afk_channel_id?: Snowflake | null;
|
|
2014
|
+
readonly afk_channel_id?: Snowflake | null;
|
|
2011
2015
|
/** afk timeout in seconds */
|
|
2012
|
-
afk_timeout: number;
|
|
2016
|
+
readonly afk_timeout: number;
|
|
2013
2017
|
/** true if the server widget is enabled */
|
|
2014
|
-
widget_enabled?: boolean;
|
|
2018
|
+
readonly widget_enabled?: boolean;
|
|
2015
2019
|
/** the channel id that the widget will generate an invite to, or null if set to no invite */
|
|
2016
|
-
widget_channel_id?: Snowflake | null;
|
|
2020
|
+
readonly widget_channel_id?: Snowflake | null;
|
|
2017
2021
|
/** verification level required for the guild */
|
|
2018
|
-
verification_level: VerificationLevel;
|
|
2022
|
+
readonly verification_level: VerificationLevel;
|
|
2019
2023
|
/** default message notifications level */
|
|
2020
|
-
default_message_notifications: DefaultMessageNotificationLevel;
|
|
2024
|
+
readonly default_message_notifications: DefaultMessageNotificationLevel;
|
|
2021
2025
|
/** explicit content filter level */
|
|
2022
|
-
explicit_content_filter: ExplicitContentFilterLevel;
|
|
2026
|
+
readonly explicit_content_filter: ExplicitContentFilterLevel;
|
|
2023
2027
|
/** roles in the guild */
|
|
2024
|
-
roles: Role[];
|
|
2028
|
+
readonly roles: Role[];
|
|
2025
2029
|
/** custom guild emojis */
|
|
2026
|
-
emojis: Emoji[];
|
|
2030
|
+
readonly emojis: Emoji[];
|
|
2027
2031
|
/** enabled guild features */
|
|
2028
|
-
features: GuildFeature[];
|
|
2032
|
+
readonly features: GuildFeature[];
|
|
2029
2033
|
/** required MFA level for the guild */
|
|
2030
|
-
mfa_level: MfaLevel;
|
|
2034
|
+
readonly mfa_level: MfaLevel;
|
|
2031
2035
|
/** application id of the guild creator if it is bot-created */
|
|
2032
|
-
application_id?: Snowflake | null;
|
|
2036
|
+
readonly application_id?: Snowflake | null;
|
|
2033
2037
|
/** the id of the channel where guild notices such as welcome messages and boost events are posted */
|
|
2034
|
-
system_channel_id?: Snowflake | null;
|
|
2038
|
+
readonly system_channel_id?: Snowflake | null;
|
|
2035
2039
|
/** system channel flags */
|
|
2036
|
-
system_channel_flags: number;
|
|
2040
|
+
readonly system_channel_flags: number;
|
|
2037
2041
|
/** the id of the channel where Community guilds can display rules and/or guidelines */
|
|
2038
|
-
rules_channel_id?: Snowflake | null;
|
|
2042
|
+
readonly rules_channel_id?: Snowflake | null;
|
|
2039
2043
|
/** the maximum number of presences for the guild (null is always returned, apart from the largest of guilds) */
|
|
2040
|
-
max_presences?: number | null;
|
|
2044
|
+
readonly max_presences?: number | null;
|
|
2041
2045
|
/** the maximum number of members for the guild */
|
|
2042
|
-
max_members?: number;
|
|
2046
|
+
readonly max_members?: number;
|
|
2043
2047
|
/** the vanity url code for the guild */
|
|
2044
|
-
vanity_url_code?: string | null;
|
|
2048
|
+
readonly vanity_url_code?: string | null;
|
|
2045
2049
|
/** the description of a guild */
|
|
2046
|
-
description?: string | null;
|
|
2050
|
+
readonly description?: string | null;
|
|
2047
2051
|
/** banner hash */
|
|
2048
|
-
banner?: string | null;
|
|
2052
|
+
readonly banner?: string | null;
|
|
2049
2053
|
/** premium tier (Server Boost level) */
|
|
2050
|
-
premium_tier: PremiumTier;
|
|
2054
|
+
readonly premium_tier: PremiumTier;
|
|
2051
2055
|
/** the number of boosts this guild currently has */
|
|
2052
|
-
premium_subscription_count?: number;
|
|
2056
|
+
readonly premium_subscription_count?: number;
|
|
2053
2057
|
/** the preferred locale of a Community guild; used in server discovery and notices from Discord, and sent in interactions; defaults to "en-US" */
|
|
2054
|
-
preferred_locale: string;
|
|
2058
|
+
readonly preferred_locale: string;
|
|
2055
2059
|
/** the id of the channel where admins and moderators of Community guilds receive notices from Discord */
|
|
2056
|
-
public_updates_channel_id?: Snowflake | null;
|
|
2060
|
+
readonly public_updates_channel_id?: Snowflake | null;
|
|
2057
2061
|
/** the maximum amount of users in a video channel */
|
|
2058
|
-
max_video_channel_users?: number;
|
|
2062
|
+
readonly max_video_channel_users?: number;
|
|
2059
2063
|
/** the maximum amount of users in a stage video channel */
|
|
2060
|
-
max_stage_video_channel_users?: number;
|
|
2064
|
+
readonly max_stage_video_channel_users?: number;
|
|
2061
2065
|
/** approximate number of members in this guild, returned from the GET /guilds/<id> endpoint when with_counts is true */
|
|
2062
|
-
approximate_member_count?: number;
|
|
2066
|
+
readonly approximate_member_count?: number;
|
|
2063
2067
|
/** approximate number of non-offline members in this guild, returned from the GET /guilds/<id> endpoint when with_counts is true */
|
|
2064
|
-
approximate_presence_count?: number;
|
|
2068
|
+
readonly approximate_presence_count?: number;
|
|
2065
2069
|
/** the welcome screen of a Community guild, shown to new members, returned in an Invite's guild object */
|
|
2066
|
-
welcome_screen?: WelcomeScreen;
|
|
2070
|
+
readonly welcome_screen?: WelcomeScreen;
|
|
2067
2071
|
/** guild NSFW level */
|
|
2068
|
-
nsfw_level: GuildNsfwLevel;
|
|
2072
|
+
readonly nsfw_level: GuildNsfwLevel;
|
|
2069
2073
|
/** custom guild stickers */
|
|
2070
|
-
stickers?: Sticker[];
|
|
2074
|
+
readonly stickers?: Sticker[];
|
|
2071
2075
|
/** whether the guild has the boost progress bar enabled */
|
|
2072
|
-
premium_progress_bar_enabled: boolean;
|
|
2076
|
+
readonly premium_progress_bar_enabled: boolean;
|
|
2073
2077
|
}
|
|
2074
2078
|
export interface GuildApplicationCommandPermission {
|
|
2075
2079
|
/** ID of the command or the application ID */
|
|
2076
|
-
id: Snowflake;
|
|
2080
|
+
readonly id: Snowflake;
|
|
2077
2081
|
/** ID of the application the command belongs to */
|
|
2078
|
-
application_id: Snowflake;
|
|
2082
|
+
readonly application_id: Snowflake;
|
|
2079
2083
|
/** ID of the guild */
|
|
2080
|
-
guild_id: Snowflake;
|
|
2084
|
+
readonly guild_id: Snowflake;
|
|
2081
2085
|
/** Permissions for the command in the guild, max of 100 */
|
|
2082
|
-
permissions: ApplicationCommandPermission[];
|
|
2086
|
+
readonly permissions: ApplicationCommandPermission[];
|
|
2083
2087
|
}
|
|
2084
2088
|
export type GuildAuditLogEntryCreateEvent = AuditLogEntry;
|
|
2085
2089
|
export interface GuildBanAddEvent {
|
|
2086
2090
|
/** ID of the guild */
|
|
2087
|
-
guild_id: Snowflake;
|
|
2091
|
+
readonly guild_id: Snowflake;
|
|
2088
2092
|
/** User who was banned */
|
|
2089
|
-
user: User;
|
|
2093
|
+
readonly user: User;
|
|
2090
2094
|
}
|
|
2091
2095
|
export interface GuildBanRemoveEvent {
|
|
2092
2096
|
/** ID of the guild */
|
|
2093
|
-
guild_id: Snowflake;
|
|
2097
|
+
readonly guild_id: Snowflake;
|
|
2094
2098
|
/** User who was unbanned */
|
|
2095
|
-
user: User;
|
|
2099
|
+
readonly user: User;
|
|
2096
2100
|
}
|
|
2097
2101
|
export type GuildCreateEvent = Guild & GuildCreateExtra;
|
|
2098
2102
|
export interface GuildCreateExtra {
|
|
2099
2103
|
/** When this guild was joined at */
|
|
2100
|
-
joined_at: string;
|
|
2104
|
+
readonly joined_at: string;
|
|
2101
2105
|
/** true if this is considered a large guild */
|
|
2102
|
-
large: boolean;
|
|
2106
|
+
readonly large: boolean;
|
|
2103
2107
|
/** true if this guild is unavailable due to an outage */
|
|
2104
|
-
unavailable?: boolean;
|
|
2108
|
+
readonly unavailable?: boolean;
|
|
2105
2109
|
/** Total number of members in this guild */
|
|
2106
|
-
member_count: number;
|
|
2110
|
+
readonly member_count: number;
|
|
2107
2111
|
/** States of members currently in voice channels; lacks the guild_id key */
|
|
2108
|
-
voice_states: VoiceState[];
|
|
2112
|
+
readonly voice_states: VoiceState[];
|
|
2109
2113
|
/** Users in the guild */
|
|
2110
|
-
members: GuildMember[];
|
|
2114
|
+
readonly members: GuildMember[];
|
|
2111
2115
|
/** Channels in the guild */
|
|
2112
|
-
channels: Channel[];
|
|
2116
|
+
readonly channels: Channel[];
|
|
2113
2117
|
/** All active threads in the guild that current user has permission to view */
|
|
2114
|
-
threads: Channel[];
|
|
2118
|
+
readonly threads: Channel[];
|
|
2115
2119
|
/** Presences of the members in the guild, will only include non-offline members if the size is greater than large threshold */
|
|
2116
|
-
presences: PresenceUpdateEvent[];
|
|
2120
|
+
readonly presences: PresenceUpdateEvent[];
|
|
2117
2121
|
/** Stage instances in the guild */
|
|
2118
|
-
stage_instances: StageInstance[];
|
|
2122
|
+
readonly stage_instances: StageInstance[];
|
|
2119
2123
|
/** Scheduled events in the guild */
|
|
2120
|
-
guild_scheduled_events: GuildScheduledEvent[];
|
|
2124
|
+
readonly guild_scheduled_events: GuildScheduledEvent[];
|
|
2121
2125
|
}
|
|
2122
2126
|
export type GuildDeleteEvent = UnavailableGuild;
|
|
2123
2127
|
export interface GuildEmojisUpdateEvent {
|
|
2124
2128
|
/** ID of the guild */
|
|
2125
|
-
guild_id: Snowflake;
|
|
2129
|
+
readonly guild_id: Snowflake;
|
|
2126
2130
|
/** Array of emojis */
|
|
2127
|
-
emojis: Emoji[];
|
|
2131
|
+
readonly emojis: Emoji[];
|
|
2128
2132
|
}
|
|
2129
2133
|
export declare const enum GuildFeature {
|
|
2130
2134
|
/** guild has access to set an animated guild banner image */
|
|
@@ -2182,38 +2186,38 @@ export declare const enum GuildFeature {
|
|
|
2182
2186
|
}
|
|
2183
2187
|
export interface GuildIntegrationsUpdateEvent {
|
|
2184
2188
|
/** ID of the guild whose integrations were updated */
|
|
2185
|
-
guild_id: Snowflake;
|
|
2189
|
+
readonly guild_id: Snowflake;
|
|
2186
2190
|
}
|
|
2187
2191
|
export interface GuildMember {
|
|
2188
2192
|
/** the user this guild member represents */
|
|
2189
|
-
user?: User;
|
|
2193
|
+
readonly user?: User;
|
|
2190
2194
|
/** this user's guild nickname */
|
|
2191
|
-
nick?: string | null;
|
|
2195
|
+
readonly nick?: string | null;
|
|
2192
2196
|
/** the member's guild avatar hash */
|
|
2193
|
-
avatar?: string | null;
|
|
2197
|
+
readonly avatar?: string | null;
|
|
2194
2198
|
/** array of role object ids */
|
|
2195
|
-
roles: Snowflake[];
|
|
2199
|
+
readonly roles: Snowflake[];
|
|
2196
2200
|
/** when the user joined the guild */
|
|
2197
|
-
joined_at: string;
|
|
2201
|
+
readonly joined_at: string;
|
|
2198
2202
|
/** when the user started boosting the guild */
|
|
2199
|
-
premium_since?: string | null;
|
|
2203
|
+
readonly premium_since?: string | null;
|
|
2200
2204
|
/** whether the user is deafened in voice channels */
|
|
2201
|
-
deaf: boolean;
|
|
2205
|
+
readonly deaf: boolean;
|
|
2202
2206
|
/** whether the user is muted in voice channels */
|
|
2203
|
-
mute: boolean;
|
|
2207
|
+
readonly mute: boolean;
|
|
2204
2208
|
/** guild member flags represented as a bit set, defaults to 0 */
|
|
2205
|
-
flags: number;
|
|
2209
|
+
readonly flags: number;
|
|
2206
2210
|
/** whether the user has not yet passed the guild's Membership Screening requirements */
|
|
2207
|
-
pending?: boolean;
|
|
2211
|
+
readonly pending?: boolean;
|
|
2208
2212
|
/** total permissions of the member in the channel, including overwrites, returned when in the interaction object */
|
|
2209
|
-
permissions?: string;
|
|
2213
|
+
readonly permissions?: string;
|
|
2210
2214
|
/** when the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out */
|
|
2211
|
-
communication_disabled_until?: string | null;
|
|
2215
|
+
readonly communication_disabled_until?: string | null;
|
|
2212
2216
|
}
|
|
2213
2217
|
export type GuildMemberAddEvent = GuildMember & GuildMemberAddExtra;
|
|
2214
2218
|
export interface GuildMemberAddExtra {
|
|
2215
2219
|
/** ID of the guild */
|
|
2216
|
-
guild_id: Snowflake;
|
|
2220
|
+
readonly guild_id: Snowflake;
|
|
2217
2221
|
}
|
|
2218
2222
|
export declare const GuildMemberFlag: {
|
|
2219
2223
|
/** Member has left and rejoined the guild */
|
|
@@ -2227,49 +2231,49 @@ export declare const GuildMemberFlag: {
|
|
|
2227
2231
|
};
|
|
2228
2232
|
export interface GuildMemberRemoveEvent {
|
|
2229
2233
|
/** ID of the guild */
|
|
2230
|
-
guild_id: Snowflake;
|
|
2234
|
+
readonly guild_id: Snowflake;
|
|
2231
2235
|
/** User who was removed */
|
|
2232
|
-
user: User;
|
|
2236
|
+
readonly user: User;
|
|
2233
2237
|
}
|
|
2234
2238
|
export interface GuildMembersChunkEvent {
|
|
2235
2239
|
/** ID of the guild */
|
|
2236
|
-
guild_id: Snowflake;
|
|
2240
|
+
readonly guild_id: Snowflake;
|
|
2237
2241
|
/** Set of guild members */
|
|
2238
|
-
members: GuildMember[];
|
|
2242
|
+
readonly members: GuildMember[];
|
|
2239
2243
|
/** Chunk index in the expected chunks for this response (0 <= chunk_index < chunk_count) */
|
|
2240
|
-
chunk_index: number;
|
|
2244
|
+
readonly chunk_index: number;
|
|
2241
2245
|
/** Total number of expected chunks for this response */
|
|
2242
|
-
chunk_count: number;
|
|
2246
|
+
readonly chunk_count: number;
|
|
2243
2247
|
/** When passing an invalid ID to REQUEST_GUILD_MEMBERS, it will be returned here */
|
|
2244
|
-
not_found?: any[];
|
|
2248
|
+
readonly not_found?: any[];
|
|
2245
2249
|
/** When passing true to REQUEST_GUILD_MEMBERS, presences of the returned members will be here */
|
|
2246
|
-
presences?: PresenceUpdateEvent[];
|
|
2250
|
+
readonly presences?: PresenceUpdateEvent[];
|
|
2247
2251
|
/** Nonce used in the Guild Members Request */
|
|
2248
|
-
nonce?: string;
|
|
2252
|
+
readonly nonce?: string;
|
|
2249
2253
|
}
|
|
2250
2254
|
export interface GuildMemberUpdateEvent {
|
|
2251
2255
|
/** ID of the guild */
|
|
2252
|
-
guild_id: Snowflake;
|
|
2256
|
+
readonly guild_id: Snowflake;
|
|
2253
2257
|
/** User role ids */
|
|
2254
|
-
roles: Snowflake[];
|
|
2258
|
+
readonly roles: Snowflake[];
|
|
2255
2259
|
/** User */
|
|
2256
|
-
user: User;
|
|
2260
|
+
readonly user: User;
|
|
2257
2261
|
/** Nickname of the user in the guild */
|
|
2258
|
-
nick?: string | null;
|
|
2262
|
+
readonly nick?: string | null;
|
|
2259
2263
|
/** Member's guild avatar hash */
|
|
2260
|
-
avatar?: string | null;
|
|
2264
|
+
readonly avatar?: string | null;
|
|
2261
2265
|
/** When the user joined the guild */
|
|
2262
|
-
joined_at?: string | null;
|
|
2266
|
+
readonly joined_at?: string | null;
|
|
2263
2267
|
/** When the user starting boosting the guild */
|
|
2264
|
-
premium_since?: string | null;
|
|
2268
|
+
readonly premium_since?: string | null;
|
|
2265
2269
|
/** Whether the user is deafened in voice channels */
|
|
2266
|
-
deaf?: boolean;
|
|
2270
|
+
readonly deaf?: boolean;
|
|
2267
2271
|
/** Whether the user is muted in voice channels */
|
|
2268
|
-
mute?: boolean;
|
|
2272
|
+
readonly mute?: boolean;
|
|
2269
2273
|
/** Whether the user has not yet passed the guild's Membership Screening requirements */
|
|
2270
|
-
pending?: boolean;
|
|
2274
|
+
readonly pending?: boolean;
|
|
2271
2275
|
/** When the user's timeout will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out */
|
|
2272
|
-
communication_disabled_until?: string | null;
|
|
2276
|
+
readonly communication_disabled_until?: string | null;
|
|
2273
2277
|
}
|
|
2274
2278
|
export declare const enum GuildNsfwLevel {
|
|
2275
2279
|
DEFAULT = 0,
|
|
@@ -2279,95 +2283,95 @@ export declare const enum GuildNsfwLevel {
|
|
|
2279
2283
|
}
|
|
2280
2284
|
export interface GuildOnboarding {
|
|
2281
2285
|
/** ID of the guild this onboarding is part of */
|
|
2282
|
-
guild_id: Snowflake;
|
|
2286
|
+
readonly guild_id: Snowflake;
|
|
2283
2287
|
/** Prompts shown during onboarding and in customize community */
|
|
2284
|
-
prompts: OnboardingPrompt[];
|
|
2288
|
+
readonly prompts: OnboardingPrompt[];
|
|
2285
2289
|
/** Channel IDs that members get opted into automatically */
|
|
2286
|
-
default_channel_ids: Snowflake[];
|
|
2290
|
+
readonly default_channel_ids: Snowflake[];
|
|
2287
2291
|
/** Whether onboarding is enabled in the guild */
|
|
2288
|
-
enabled: boolean;
|
|
2292
|
+
readonly enabled: boolean;
|
|
2289
2293
|
}
|
|
2290
2294
|
export interface GuildPreview {
|
|
2291
2295
|
/** guild id */
|
|
2292
|
-
id: Snowflake;
|
|
2296
|
+
readonly id: Snowflake;
|
|
2293
2297
|
/** guild name (2-100 characters) */
|
|
2294
|
-
name: string;
|
|
2298
|
+
readonly name: string;
|
|
2295
2299
|
/** icon hash */
|
|
2296
|
-
icon?: string | null;
|
|
2300
|
+
readonly icon?: string | null;
|
|
2297
2301
|
/** splash hash */
|
|
2298
|
-
splash?: string | null;
|
|
2302
|
+
readonly splash?: string | null;
|
|
2299
2303
|
/** discovery splash hash */
|
|
2300
|
-
discovery_splash?: string | null;
|
|
2304
|
+
readonly discovery_splash?: string | null;
|
|
2301
2305
|
/** custom guild emojis */
|
|
2302
|
-
emojis: Emoji[];
|
|
2306
|
+
readonly emojis: Emoji[];
|
|
2303
2307
|
/** enabled guild features */
|
|
2304
|
-
features: GuildFeature[];
|
|
2308
|
+
readonly features: GuildFeature[];
|
|
2305
2309
|
/** approximate number of members in this guild */
|
|
2306
|
-
approximate_member_count: number;
|
|
2310
|
+
readonly approximate_member_count: number;
|
|
2307
2311
|
/** approximate number of online members in this guild */
|
|
2308
|
-
approximate_presence_count: number;
|
|
2312
|
+
readonly approximate_presence_count: number;
|
|
2309
2313
|
/** the description for the guild */
|
|
2310
|
-
description?: string | null;
|
|
2314
|
+
readonly description?: string | null;
|
|
2311
2315
|
/** custom guild stickers */
|
|
2312
|
-
stickers: Sticker[];
|
|
2316
|
+
readonly stickers: Sticker[];
|
|
2313
2317
|
}
|
|
2314
2318
|
export interface GuildRoleCreateEvent {
|
|
2315
2319
|
/** ID of the guild */
|
|
2316
|
-
guild_id: Snowflake;
|
|
2320
|
+
readonly guild_id: Snowflake;
|
|
2317
2321
|
/** Role that was created */
|
|
2318
|
-
role: Role;
|
|
2322
|
+
readonly role: Role;
|
|
2319
2323
|
}
|
|
2320
2324
|
export interface GuildRoleDeleteEvent {
|
|
2321
2325
|
/** ID of the guild */
|
|
2322
|
-
guild_id: Snowflake;
|
|
2326
|
+
readonly guild_id: Snowflake;
|
|
2323
2327
|
/** ID of the role */
|
|
2324
|
-
role_id: Snowflake;
|
|
2328
|
+
readonly role_id: Snowflake;
|
|
2325
2329
|
}
|
|
2326
2330
|
export interface GuildRoleUpdateEvent {
|
|
2327
2331
|
/** ID of the guild */
|
|
2328
|
-
guild_id: Snowflake;
|
|
2332
|
+
readonly guild_id: Snowflake;
|
|
2329
2333
|
/** Role that was updated */
|
|
2330
|
-
role: Role;
|
|
2334
|
+
readonly role: Role;
|
|
2331
2335
|
}
|
|
2332
2336
|
export interface GuildScheduledEvent {
|
|
2333
2337
|
/** the id of the scheduled event */
|
|
2334
|
-
id: Snowflake;
|
|
2338
|
+
readonly id: Snowflake;
|
|
2335
2339
|
/** the guild id which the scheduled event belongs to */
|
|
2336
|
-
guild_id: Snowflake;
|
|
2340
|
+
readonly guild_id: Snowflake;
|
|
2337
2341
|
/** the channel id in which the scheduled event will be hosted, or null if scheduled entity type is EXTERNAL */
|
|
2338
|
-
channel_id?: Snowflake | null;
|
|
2342
|
+
readonly channel_id?: Snowflake | null;
|
|
2339
2343
|
/** the id of the user that created the scheduled event * */
|
|
2340
|
-
creator_id?: Snowflake | null;
|
|
2344
|
+
readonly creator_id?: Snowflake | null;
|
|
2341
2345
|
/** the name of the scheduled event (1-100 characters) */
|
|
2342
|
-
name: string;
|
|
2346
|
+
readonly name: string;
|
|
2343
2347
|
/** the description of the scheduled event (1-1000 characters) */
|
|
2344
|
-
description?: string | null;
|
|
2348
|
+
readonly description?: string | null;
|
|
2345
2349
|
/** the time the scheduled event will start */
|
|
2346
|
-
scheduled_start_time: string;
|
|
2350
|
+
readonly scheduled_start_time: string;
|
|
2347
2351
|
/** the time the scheduled event will end, required if entity_type is EXTERNAL */
|
|
2348
|
-
scheduled_end_time?: string | null;
|
|
2352
|
+
readonly scheduled_end_time?: string | null;
|
|
2349
2353
|
/** the privacy level of the scheduled event */
|
|
2350
|
-
privacy_level: GuildScheduledEventPrivacyLevel;
|
|
2354
|
+
readonly privacy_level: GuildScheduledEventPrivacyLevel;
|
|
2351
2355
|
/** the status of the scheduled event */
|
|
2352
|
-
status: GuildScheduledEventStatus;
|
|
2356
|
+
readonly status: GuildScheduledEventStatus;
|
|
2353
2357
|
/** the type of the scheduled event */
|
|
2354
|
-
entity_type: GuildScheduledEventEntityType;
|
|
2358
|
+
readonly entity_type: GuildScheduledEventEntityType;
|
|
2355
2359
|
/** the id of an entity associated with a guild scheduled event */
|
|
2356
|
-
entity_id?: Snowflake | null;
|
|
2360
|
+
readonly entity_id?: Snowflake | null;
|
|
2357
2361
|
/** additional metadata for the guild scheduled event */
|
|
2358
|
-
entity_metadata?: GuildScheduledEventEntityMetadatum | null;
|
|
2362
|
+
readonly entity_metadata?: GuildScheduledEventEntityMetadatum | null;
|
|
2359
2363
|
/** the user that created the scheduled event */
|
|
2360
|
-
creator?: User;
|
|
2364
|
+
readonly creator?: User;
|
|
2361
2365
|
/** the number of users subscribed to the scheduled event */
|
|
2362
|
-
user_count?: number;
|
|
2366
|
+
readonly user_count?: number;
|
|
2363
2367
|
/** the cover image hash of the scheduled event */
|
|
2364
|
-
image?: string | null;
|
|
2368
|
+
readonly image?: string | null;
|
|
2365
2369
|
}
|
|
2366
2370
|
export type GuildScheduledEventCreateEvent = GuildScheduledEvent;
|
|
2367
2371
|
export type GuildScheduledEventDeleteEvent = GuildScheduledEvent;
|
|
2368
2372
|
export interface GuildScheduledEventEntityMetadatum {
|
|
2369
2373
|
/** location of the event (1-100 characters) */
|
|
2370
|
-
location?: string;
|
|
2374
|
+
readonly location?: string;
|
|
2371
2375
|
}
|
|
2372
2376
|
export declare const enum GuildScheduledEventEntityType {
|
|
2373
2377
|
STAGE_INSTANCE = 1,
|
|
@@ -2387,178 +2391,178 @@ export declare const enum GuildScheduledEventStatus {
|
|
|
2387
2391
|
export type GuildScheduledEventUpdateEvent = GuildScheduledEvent;
|
|
2388
2392
|
export interface GuildScheduledEventUser {
|
|
2389
2393
|
/** the scheduled event id which the user subscribed to */
|
|
2390
|
-
guild_scheduled_event_id: Snowflake;
|
|
2394
|
+
readonly guild_scheduled_event_id: Snowflake;
|
|
2391
2395
|
/** user which subscribed to an event */
|
|
2392
|
-
user: User;
|
|
2396
|
+
readonly user: User;
|
|
2393
2397
|
/** guild member data for this user for the guild which this event belongs to, if any */
|
|
2394
|
-
member?: GuildMember;
|
|
2398
|
+
readonly member?: GuildMember;
|
|
2395
2399
|
}
|
|
2396
2400
|
export interface GuildScheduledEventUserAddEvent {
|
|
2397
2401
|
/** ID of the guild scheduled event */
|
|
2398
|
-
guild_scheduled_event_id: Snowflake;
|
|
2402
|
+
readonly guild_scheduled_event_id: Snowflake;
|
|
2399
2403
|
/** ID of the user */
|
|
2400
|
-
user_id: Snowflake;
|
|
2404
|
+
readonly user_id: Snowflake;
|
|
2401
2405
|
/** ID of the guild */
|
|
2402
|
-
guild_id: Snowflake;
|
|
2406
|
+
readonly guild_id: Snowflake;
|
|
2403
2407
|
}
|
|
2404
2408
|
export interface GuildScheduledEventUserRemoveEvent {
|
|
2405
2409
|
/** ID of the guild scheduled event */
|
|
2406
|
-
guild_scheduled_event_id: Snowflake;
|
|
2410
|
+
readonly guild_scheduled_event_id: Snowflake;
|
|
2407
2411
|
/** ID of the user */
|
|
2408
|
-
user_id: Snowflake;
|
|
2412
|
+
readonly user_id: Snowflake;
|
|
2409
2413
|
/** ID of the guild */
|
|
2410
|
-
guild_id: Snowflake;
|
|
2414
|
+
readonly guild_id: Snowflake;
|
|
2411
2415
|
}
|
|
2412
2416
|
export interface GuildStickersUpdateEvent {
|
|
2413
2417
|
/** ID of the guild */
|
|
2414
|
-
guild_id: Snowflake;
|
|
2418
|
+
readonly guild_id: Snowflake;
|
|
2415
2419
|
/** Array of stickers */
|
|
2416
|
-
stickers: Sticker[];
|
|
2420
|
+
readonly stickers: Sticker[];
|
|
2417
2421
|
}
|
|
2418
2422
|
export interface GuildTemplate {
|
|
2419
2423
|
/** the template code (unique ID) */
|
|
2420
|
-
code: string;
|
|
2424
|
+
readonly code: string;
|
|
2421
2425
|
/** template name */
|
|
2422
|
-
name: string;
|
|
2426
|
+
readonly name: string;
|
|
2423
2427
|
/** the description for the template */
|
|
2424
|
-
description?: string | null;
|
|
2428
|
+
readonly description?: string | null;
|
|
2425
2429
|
/** number of times this template has been used */
|
|
2426
|
-
usage_count: number;
|
|
2430
|
+
readonly usage_count: number;
|
|
2427
2431
|
/** the ID of the user who created the template */
|
|
2428
|
-
creator_id: Snowflake;
|
|
2432
|
+
readonly creator_id: Snowflake;
|
|
2429
2433
|
/** the user who created the template */
|
|
2430
|
-
creator: User;
|
|
2434
|
+
readonly creator: User;
|
|
2431
2435
|
/** when this template was created */
|
|
2432
|
-
created_at: string;
|
|
2436
|
+
readonly created_at: string;
|
|
2433
2437
|
/** when this template was last synced to the source guild */
|
|
2434
|
-
updated_at: string;
|
|
2438
|
+
readonly updated_at: string;
|
|
2435
2439
|
/** the ID of the guild this template is based on */
|
|
2436
|
-
source_guild_id: Snowflake;
|
|
2440
|
+
readonly source_guild_id: Snowflake;
|
|
2437
2441
|
/** the guild snapshot this template contains */
|
|
2438
|
-
serialized_source_guild: Guild;
|
|
2442
|
+
readonly serialized_source_guild: Guild;
|
|
2439
2443
|
/** whether the template has unsynced changes */
|
|
2440
|
-
is_dirty?: boolean | null;
|
|
2444
|
+
readonly is_dirty?: boolean | null;
|
|
2441
2445
|
}
|
|
2442
2446
|
export type GuildUpdateEvent = Guild;
|
|
2443
2447
|
export interface GuildWidget {
|
|
2444
2448
|
/** guild id */
|
|
2445
|
-
id: Snowflake;
|
|
2449
|
+
readonly id: Snowflake;
|
|
2446
2450
|
/** guild name (2-100 characters) */
|
|
2447
|
-
name: string;
|
|
2451
|
+
readonly name: string;
|
|
2448
2452
|
/** instant invite for the guilds specified widget invite channel */
|
|
2449
|
-
instant_invite?: string | null;
|
|
2453
|
+
readonly instant_invite?: string | null;
|
|
2450
2454
|
/** voice and stage channels which are accessible by @everyone */
|
|
2451
|
-
channels: Channel[];
|
|
2455
|
+
readonly channels: Channel[];
|
|
2452
2456
|
/** special widget user objects that includes users presence (Limit 100) */
|
|
2453
|
-
members: User[];
|
|
2457
|
+
readonly members: User[];
|
|
2454
2458
|
/** number of online members in this guild */
|
|
2455
|
-
presence_count: number;
|
|
2459
|
+
readonly presence_count: number;
|
|
2456
2460
|
}
|
|
2457
2461
|
export interface GuildWidgetSetting {
|
|
2458
2462
|
/** whether the widget is enabled */
|
|
2459
|
-
enabled: boolean;
|
|
2463
|
+
readonly enabled: boolean;
|
|
2460
2464
|
/** the widget channel id */
|
|
2461
|
-
channel_id?: Snowflake | null;
|
|
2465
|
+
readonly channel_id?: Snowflake | null;
|
|
2462
2466
|
}
|
|
2463
2467
|
export type Heartbeat = number | null;
|
|
2464
2468
|
export interface HelloEvent {
|
|
2465
2469
|
/** Interval (in milliseconds) an app should heartbeat with */
|
|
2466
|
-
heartbeat_interval: number;
|
|
2470
|
+
readonly heartbeat_interval: number;
|
|
2467
2471
|
}
|
|
2468
2472
|
export interface Identify {
|
|
2469
2473
|
/** Authentication token */
|
|
2470
|
-
token: string;
|
|
2474
|
+
readonly token: string;
|
|
2471
2475
|
/** Connection properties */
|
|
2472
|
-
properties: IdentifyConnectionProperty;
|
|
2476
|
+
readonly properties: IdentifyConnectionProperty;
|
|
2473
2477
|
/** Whether this connection supports compression of packets */
|
|
2474
|
-
compress?: boolean;
|
|
2478
|
+
readonly compress?: boolean;
|
|
2475
2479
|
/** Value between 50 and 250, total number of members where the gateway will stop sending offline members in the guild member list */
|
|
2476
|
-
large_threshold?: number;
|
|
2480
|
+
readonly large_threshold?: number;
|
|
2477
2481
|
/** Used for Guild Sharding */
|
|
2478
|
-
shard?: number[];
|
|
2482
|
+
readonly shard?: number[];
|
|
2479
2483
|
/** Presence structure for initial presence information */
|
|
2480
|
-
presence?: UpdatePresence;
|
|
2484
|
+
readonly presence?: UpdatePresence;
|
|
2481
2485
|
/** Gateway Intents you wish to receive */
|
|
2482
|
-
intents: number;
|
|
2486
|
+
readonly intents: number;
|
|
2483
2487
|
}
|
|
2484
2488
|
export interface IdentifyConnectionProperty {
|
|
2485
2489
|
/** Your operating system */
|
|
2486
|
-
os: string;
|
|
2490
|
+
readonly os: string;
|
|
2487
2491
|
/** Your library name */
|
|
2488
|
-
browser: string;
|
|
2492
|
+
readonly browser: string;
|
|
2489
2493
|
/** Your library name */
|
|
2490
|
-
device: string;
|
|
2494
|
+
readonly device: string;
|
|
2491
2495
|
}
|
|
2492
2496
|
export interface InstallParam {
|
|
2493
2497
|
/** the scopes to add the application to the server with */
|
|
2494
|
-
scopes: OAuth2Scope[];
|
|
2498
|
+
readonly scopes: OAuth2Scope[];
|
|
2495
2499
|
/** the permissions to request for the bot role */
|
|
2496
|
-
permissions: string;
|
|
2500
|
+
readonly permissions: string;
|
|
2497
2501
|
}
|
|
2498
2502
|
export interface Integration {
|
|
2499
2503
|
/** integration id */
|
|
2500
|
-
id: Snowflake;
|
|
2504
|
+
readonly id: Snowflake;
|
|
2501
2505
|
/** integration name */
|
|
2502
|
-
name: string;
|
|
2506
|
+
readonly name: string;
|
|
2503
2507
|
/** integration type (twitch, youtube, discord, or guild_subscription) */
|
|
2504
|
-
type: string;
|
|
2508
|
+
readonly type: string;
|
|
2505
2509
|
/** is this integration enabled */
|
|
2506
|
-
enabled: boolean;
|
|
2510
|
+
readonly enabled: boolean;
|
|
2507
2511
|
/** is this integration syncing */
|
|
2508
|
-
syncing?: boolean;
|
|
2512
|
+
readonly syncing?: boolean;
|
|
2509
2513
|
/** id that this integration uses for "subscribers" */
|
|
2510
|
-
role_id?: Snowflake;
|
|
2514
|
+
readonly role_id?: Snowflake;
|
|
2511
2515
|
/** whether emoticons should be synced for this integration (twitch only currently) */
|
|
2512
|
-
enable_emoticons?: boolean;
|
|
2516
|
+
readonly enable_emoticons?: boolean;
|
|
2513
2517
|
/** the behavior of expiring subscribers */
|
|
2514
|
-
expire_behavior?: IntegrationExpireBehavior;
|
|
2518
|
+
readonly expire_behavior?: IntegrationExpireBehavior;
|
|
2515
2519
|
/** the grace period (in days) before expiring subscribers */
|
|
2516
|
-
expire_grace_period?: number;
|
|
2520
|
+
readonly expire_grace_period?: number;
|
|
2517
2521
|
/** user for this integration */
|
|
2518
|
-
user?: User;
|
|
2522
|
+
readonly user?: User;
|
|
2519
2523
|
/** integration account information */
|
|
2520
|
-
account: IntegrationAccount;
|
|
2524
|
+
readonly account: IntegrationAccount;
|
|
2521
2525
|
/** when this integration was last synced */
|
|
2522
|
-
synced_at?: string;
|
|
2526
|
+
readonly synced_at?: string;
|
|
2523
2527
|
/** how many subscribers this integration has */
|
|
2524
|
-
subscriber_count?: number;
|
|
2528
|
+
readonly subscriber_count?: number;
|
|
2525
2529
|
/** has this integration been revoked */
|
|
2526
|
-
revoked?: boolean;
|
|
2530
|
+
readonly revoked?: boolean;
|
|
2527
2531
|
/** The bot/OAuth2 application for discord integrations */
|
|
2528
|
-
application?: IntegrationApplication;
|
|
2532
|
+
readonly application?: IntegrationApplication;
|
|
2529
2533
|
/** the scopes the application has been authorized for */
|
|
2530
|
-
scopes?: OAuth2Scope[];
|
|
2534
|
+
readonly scopes?: OAuth2Scope[];
|
|
2531
2535
|
}
|
|
2532
2536
|
export interface IntegrationAccount {
|
|
2533
2537
|
/** id of the account */
|
|
2534
|
-
id: string;
|
|
2538
|
+
readonly id: string;
|
|
2535
2539
|
/** name of the account */
|
|
2536
|
-
name: string;
|
|
2540
|
+
readonly name: string;
|
|
2537
2541
|
}
|
|
2538
2542
|
export interface IntegrationApplication {
|
|
2539
2543
|
/** the id of the app */
|
|
2540
|
-
id: Snowflake;
|
|
2544
|
+
readonly id: Snowflake;
|
|
2541
2545
|
/** the name of the app */
|
|
2542
|
-
name: string;
|
|
2546
|
+
readonly name: string;
|
|
2543
2547
|
/** the icon hash of the app */
|
|
2544
|
-
icon?: string | null;
|
|
2548
|
+
readonly icon?: string | null;
|
|
2545
2549
|
/** the description of the app */
|
|
2546
|
-
description: string;
|
|
2550
|
+
readonly description: string;
|
|
2547
2551
|
/** the bot associated with this application */
|
|
2548
|
-
bot?: User;
|
|
2552
|
+
readonly bot?: User;
|
|
2549
2553
|
}
|
|
2550
2554
|
export type IntegrationCreateEvent = Integration & IntegrationCreateEventAdditional;
|
|
2551
2555
|
export interface IntegrationCreateEventAdditional {
|
|
2552
2556
|
/** ID of the guild */
|
|
2553
|
-
guild_id: Snowflake;
|
|
2557
|
+
readonly guild_id: Snowflake;
|
|
2554
2558
|
}
|
|
2555
2559
|
export interface IntegrationDeleteEvent {
|
|
2556
2560
|
/** Integration ID */
|
|
2557
|
-
id: Snowflake;
|
|
2561
|
+
readonly id: Snowflake;
|
|
2558
2562
|
/** ID of the guild */
|
|
2559
|
-
guild_id: Snowflake;
|
|
2563
|
+
readonly guild_id: Snowflake;
|
|
2560
2564
|
/** ID of the bot/OAuth2 application for this discord integration */
|
|
2561
|
-
application_id?: Snowflake;
|
|
2565
|
+
readonly application_id?: Snowflake;
|
|
2562
2566
|
}
|
|
2563
2567
|
export declare const enum IntegrationExpireBehavior {
|
|
2564
2568
|
REMOVE_ROLE = 0,
|
|
@@ -2567,68 +2571,68 @@ export declare const enum IntegrationExpireBehavior {
|
|
|
2567
2571
|
export type IntegrationUpdateEvent = Integration & IntegrationUpdateEventAdditional;
|
|
2568
2572
|
export interface IntegrationUpdateEventAdditional {
|
|
2569
2573
|
/** ID of the guild */
|
|
2570
|
-
guild_id: Snowflake;
|
|
2574
|
+
readonly guild_id: Snowflake;
|
|
2571
2575
|
}
|
|
2572
2576
|
export interface Interaction {
|
|
2573
2577
|
/** ID of the interaction */
|
|
2574
|
-
id: Snowflake;
|
|
2578
|
+
readonly id: Snowflake;
|
|
2575
2579
|
/** ID of the application this interaction is for */
|
|
2576
|
-
application_id: Snowflake;
|
|
2580
|
+
readonly application_id: Snowflake;
|
|
2577
2581
|
/** Type of interaction */
|
|
2578
|
-
type: InteractionType;
|
|
2582
|
+
readonly type: InteractionType;
|
|
2579
2583
|
/** Interaction data payload */
|
|
2580
|
-
data?: InteractionDatum;
|
|
2584
|
+
readonly data?: InteractionDatum;
|
|
2581
2585
|
/** Guild that the interaction was sent from */
|
|
2582
|
-
guild_id?: Snowflake;
|
|
2586
|
+
readonly guild_id?: Snowflake;
|
|
2583
2587
|
/** Channel that the interaction was sent from */
|
|
2584
|
-
channel?: Channel;
|
|
2588
|
+
readonly channel?: Channel;
|
|
2585
2589
|
/** Channel that the interaction was sent from */
|
|
2586
|
-
channel_id?: Snowflake;
|
|
2590
|
+
readonly channel_id?: Snowflake;
|
|
2587
2591
|
/** Guild member data for the invoking user, including permissions */
|
|
2588
|
-
member?: GuildMember;
|
|
2592
|
+
readonly member?: GuildMember;
|
|
2589
2593
|
/** User object for the invoking user, if invoked in a DM */
|
|
2590
|
-
user?: User;
|
|
2594
|
+
readonly user?: User;
|
|
2591
2595
|
/** Continuation token for responding to the interaction */
|
|
2592
|
-
token: string;
|
|
2596
|
+
readonly token: string;
|
|
2593
2597
|
/** Read-only property, always 1 */
|
|
2594
|
-
version: number;
|
|
2598
|
+
readonly version: number;
|
|
2595
2599
|
/** For components, the message they were attached to */
|
|
2596
|
-
message?: Message;
|
|
2600
|
+
readonly message?: Message;
|
|
2597
2601
|
/** Bitwise set of permissions the app or bot has within the channel the interaction was sent from */
|
|
2598
|
-
app_permissions?: string;
|
|
2602
|
+
readonly app_permissions?: string;
|
|
2599
2603
|
/** Selected language of the invoking user */
|
|
2600
|
-
locale?: string;
|
|
2604
|
+
readonly locale?: string;
|
|
2601
2605
|
/** Guild's preferred locale, if invoked in a guild */
|
|
2602
|
-
guild_locale?: string;
|
|
2606
|
+
readonly guild_locale?: string;
|
|
2603
2607
|
}
|
|
2604
2608
|
export interface InteractionCallbackAutocomplete {
|
|
2605
2609
|
/** autocomplete choices (max of 25 choices) */
|
|
2606
|
-
choices: ApplicationCommandOptionChoice[];
|
|
2610
|
+
readonly choices: ApplicationCommandOptionChoice[];
|
|
2607
2611
|
}
|
|
2608
2612
|
export type InteractionCallbackDatum = InteractionCallbackAutocomplete | InteractionCallbackMessage | InteractionCallbackModal;
|
|
2609
2613
|
export interface InteractionCallbackMessage {
|
|
2610
2614
|
/** is the response TTS */
|
|
2611
|
-
tts?: boolean;
|
|
2615
|
+
readonly tts?: boolean;
|
|
2612
2616
|
/** message content */
|
|
2613
|
-
content?: string;
|
|
2617
|
+
readonly content?: string;
|
|
2614
2618
|
/** supports up to 10 embeds */
|
|
2615
|
-
embeds?: Embed[];
|
|
2619
|
+
readonly embeds?: Embed[];
|
|
2616
2620
|
/** allowed mentions object */
|
|
2617
|
-
allowed_mentions?: AllowedMention;
|
|
2621
|
+
readonly allowed_mentions?: AllowedMention;
|
|
2618
2622
|
/** message flags combined as a bitfield (only SUPPRESS_EMBEDS and EPHEMERAL can be set) */
|
|
2619
|
-
flags?: number;
|
|
2623
|
+
readonly flags?: number;
|
|
2620
2624
|
/** message components */
|
|
2621
|
-
components?: Component[];
|
|
2625
|
+
readonly components?: Component[];
|
|
2622
2626
|
/** attachment objects with filename and description */
|
|
2623
|
-
attachments?: Attachment[];
|
|
2627
|
+
readonly attachments?: Attachment[];
|
|
2624
2628
|
}
|
|
2625
2629
|
export interface InteractionCallbackModal {
|
|
2626
2630
|
/** a developer-defined identifier for the modal, max 100 characters */
|
|
2627
|
-
custom_id: string;
|
|
2631
|
+
readonly custom_id: string;
|
|
2628
2632
|
/** the title of the popup modal, max 45 characters */
|
|
2629
|
-
title: string;
|
|
2633
|
+
readonly title: string;
|
|
2630
2634
|
/** between 1 and 5 (inclusive) components that make up the modal */
|
|
2631
|
-
components: Component[];
|
|
2635
|
+
readonly components: Component[];
|
|
2632
2636
|
}
|
|
2633
2637
|
export declare const enum InteractionCallbackType {
|
|
2634
2638
|
/** ACK a Ping */
|
|
@@ -2650,9 +2654,9 @@ export type InteractionCreateEvent = Interaction;
|
|
|
2650
2654
|
export type InteractionDatum = ApplicationCommandDatum | MessageComponentDatum | ModalSubmitDatum;
|
|
2651
2655
|
export interface InteractionResponse {
|
|
2652
2656
|
/** the type of response */
|
|
2653
|
-
type: InteractionCallbackType;
|
|
2657
|
+
readonly type: InteractionCallbackType;
|
|
2654
2658
|
/** an optional response message */
|
|
2655
|
-
data?: InteractionCallbackDatum;
|
|
2659
|
+
readonly data?: InteractionCallbackDatum;
|
|
2656
2660
|
}
|
|
2657
2661
|
export declare const enum InteractionType {
|
|
2658
2662
|
PING = 1,
|
|
@@ -2664,85 +2668,85 @@ export declare const enum InteractionType {
|
|
|
2664
2668
|
export type InvalidSessionEvent = boolean;
|
|
2665
2669
|
export interface Invite {
|
|
2666
2670
|
/** the invite code (unique ID) */
|
|
2667
|
-
code: string;
|
|
2671
|
+
readonly code: string;
|
|
2668
2672
|
/** the guild this invite is for */
|
|
2669
|
-
guild?: Guild;
|
|
2673
|
+
readonly guild?: Guild;
|
|
2670
2674
|
/** the channel this invite is for */
|
|
2671
|
-
channel?: Channel | null;
|
|
2675
|
+
readonly channel?: Channel | null;
|
|
2672
2676
|
/** the user who created the invite */
|
|
2673
|
-
inviter?: User;
|
|
2677
|
+
readonly inviter?: User;
|
|
2674
2678
|
/** the type of target for this voice channel invite */
|
|
2675
|
-
target_type?: InviteTargetType;
|
|
2679
|
+
readonly target_type?: InviteTargetType;
|
|
2676
2680
|
/** the user whose stream to display for this voice channel stream invite */
|
|
2677
|
-
target_user?: User;
|
|
2681
|
+
readonly target_user?: User;
|
|
2678
2682
|
/** the embedded application to open for this voice channel embedded application invite */
|
|
2679
|
-
target_application?: Application;
|
|
2683
|
+
readonly target_application?: Application;
|
|
2680
2684
|
/** approximate count of online members, returned from the GET /invites/<code> endpoint when with_counts is true */
|
|
2681
|
-
approximate_presence_count?: number;
|
|
2685
|
+
readonly approximate_presence_count?: number;
|
|
2682
2686
|
/** approximate count of total members, returned from the GET /invites/<code> endpoint when with_counts is true */
|
|
2683
|
-
approximate_member_count?: number;
|
|
2687
|
+
readonly approximate_member_count?: number;
|
|
2684
2688
|
/** the expiration date of this invite, returned from the GET /invites/<code> endpoint when with_expiration is true */
|
|
2685
|
-
expires_at?: string | null;
|
|
2689
|
+
readonly expires_at?: string | null;
|
|
2686
2690
|
/** stage instance data if there is a public Stage instance in the Stage channel this invite is for (deprecated) */
|
|
2687
|
-
stage_instance?: InviteStageInstance;
|
|
2691
|
+
readonly stage_instance?: InviteStageInstance;
|
|
2688
2692
|
/** guild scheduled event data, only included if guild_scheduled_event_id contains a valid guild scheduled event id */
|
|
2689
|
-
guild_scheduled_event?: GuildScheduledEvent;
|
|
2693
|
+
readonly guild_scheduled_event?: GuildScheduledEvent;
|
|
2690
2694
|
}
|
|
2691
2695
|
export interface InviteCreateEvent {
|
|
2692
2696
|
/** Channel the invite is for */
|
|
2693
|
-
channel_id: Snowflake;
|
|
2697
|
+
readonly channel_id: Snowflake;
|
|
2694
2698
|
/** Unique invite code */
|
|
2695
|
-
code: string;
|
|
2699
|
+
readonly code: string;
|
|
2696
2700
|
/** Time at which the invite was created */
|
|
2697
|
-
created_at: string;
|
|
2701
|
+
readonly created_at: string;
|
|
2698
2702
|
/** Guild of the invite */
|
|
2699
|
-
guild_id?: Snowflake;
|
|
2703
|
+
readonly guild_id?: Snowflake;
|
|
2700
2704
|
/** User that created the invite */
|
|
2701
|
-
inviter?: User;
|
|
2705
|
+
readonly inviter?: User;
|
|
2702
2706
|
/** How long the invite is valid for (in seconds) */
|
|
2703
|
-
max_age: number;
|
|
2707
|
+
readonly max_age: number;
|
|
2704
2708
|
/** Maximum number of times the invite can be used */
|
|
2705
|
-
max_uses: number;
|
|
2709
|
+
readonly max_uses: number;
|
|
2706
2710
|
/** Type of target for this voice channel invite */
|
|
2707
|
-
target_type?: InviteTargetType;
|
|
2711
|
+
readonly target_type?: InviteTargetType;
|
|
2708
2712
|
/** User whose stream to display for this voice channel stream invite */
|
|
2709
|
-
target_user?: User;
|
|
2713
|
+
readonly target_user?: User;
|
|
2710
2714
|
/** Embedded application to open for this voice channel embedded application invite */
|
|
2711
|
-
target_application?: Application;
|
|
2715
|
+
readonly target_application?: Application;
|
|
2712
2716
|
/** Whether or not the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role) */
|
|
2713
|
-
temporary: boolean;
|
|
2717
|
+
readonly temporary: boolean;
|
|
2714
2718
|
/** How many times the invite has been used (always will be 0) */
|
|
2715
|
-
uses: number;
|
|
2719
|
+
readonly uses: number;
|
|
2716
2720
|
}
|
|
2717
2721
|
export interface InviteDeleteEvent {
|
|
2718
2722
|
/** Channel of the invite */
|
|
2719
|
-
channel_id: Snowflake;
|
|
2723
|
+
readonly channel_id: Snowflake;
|
|
2720
2724
|
/** Guild of the invite */
|
|
2721
|
-
guild_id?: Snowflake;
|
|
2725
|
+
readonly guild_id?: Snowflake;
|
|
2722
2726
|
/** Unique invite code */
|
|
2723
|
-
code: string;
|
|
2727
|
+
readonly code: string;
|
|
2724
2728
|
}
|
|
2725
2729
|
export interface InviteMetadatum {
|
|
2726
2730
|
/** number of times this invite has been used */
|
|
2727
|
-
uses: number;
|
|
2731
|
+
readonly uses: number;
|
|
2728
2732
|
/** max number of times this invite can be used */
|
|
2729
|
-
max_uses: number;
|
|
2733
|
+
readonly max_uses: number;
|
|
2730
2734
|
/** duration (in seconds) after which the invite expires */
|
|
2731
|
-
max_age: number;
|
|
2735
|
+
readonly max_age: number;
|
|
2732
2736
|
/** whether this invite only grants temporary membership */
|
|
2733
|
-
temporary: boolean;
|
|
2737
|
+
readonly temporary: boolean;
|
|
2734
2738
|
/** when this invite was created */
|
|
2735
|
-
created_at: string;
|
|
2739
|
+
readonly created_at: string;
|
|
2736
2740
|
}
|
|
2737
2741
|
export interface InviteStageInstance {
|
|
2738
2742
|
/** the members speaking in the Stage */
|
|
2739
|
-
members: GuildMember[];
|
|
2743
|
+
readonly members: GuildMember[];
|
|
2740
2744
|
/** the number of users in the Stage */
|
|
2741
|
-
participant_count: number;
|
|
2745
|
+
readonly participant_count: number;
|
|
2742
2746
|
/** the number of users speaking in the Stage */
|
|
2743
|
-
speaker_count: number;
|
|
2747
|
+
readonly speaker_count: number;
|
|
2744
2748
|
/** the topic of the Stage instance (1-120 characters) */
|
|
2745
|
-
topic: string;
|
|
2749
|
+
readonly topic: string;
|
|
2746
2750
|
}
|
|
2747
2751
|
export declare const enum InviteTargetType {
|
|
2748
2752
|
STREAM = 1,
|
|
@@ -2758,131 +2762,131 @@ export declare const enum KeywordPresetType {
|
|
|
2758
2762
|
}
|
|
2759
2763
|
export interface ListActiveGuildThreadResponse {
|
|
2760
2764
|
/** the active threads */
|
|
2761
|
-
threads: Channel[];
|
|
2765
|
+
readonly threads: Channel[];
|
|
2762
2766
|
/** a thread member object for each returned thread the current user has joined */
|
|
2763
|
-
members: ThreadMember[];
|
|
2767
|
+
readonly members: ThreadMember[];
|
|
2764
2768
|
}
|
|
2765
2769
|
export interface ListGuildMemberParams {
|
|
2766
2770
|
/** max number of members to return (1-1000) */
|
|
2767
|
-
limit: number;
|
|
2771
|
+
readonly limit: number;
|
|
2768
2772
|
/** the highest user id in the previous page */
|
|
2769
|
-
after: Snowflake;
|
|
2773
|
+
readonly after: Snowflake;
|
|
2770
2774
|
}
|
|
2771
2775
|
export interface ListJoinedPrivateArchivedThreadParams {
|
|
2772
2776
|
/** returns threads before this id */
|
|
2773
|
-
before?: Snowflake;
|
|
2777
|
+
readonly before?: Snowflake;
|
|
2774
2778
|
/** optional maximum number of threads to return */
|
|
2775
|
-
limit?: number;
|
|
2779
|
+
readonly limit?: number;
|
|
2776
2780
|
}
|
|
2777
2781
|
export interface ListJoinedPrivateArchivedThreadResponse {
|
|
2778
2782
|
/** the private, archived threads the current user has joined */
|
|
2779
|
-
threads: Channel[];
|
|
2783
|
+
readonly threads: Channel[];
|
|
2780
2784
|
/** a thread member object for each returned thread the current user has joined */
|
|
2781
|
-
members: ThreadMember[];
|
|
2785
|
+
readonly members: ThreadMember[];
|
|
2782
2786
|
/** whether there are potentially additional threads that could be returned on a subsequent call */
|
|
2783
|
-
has_more: boolean;
|
|
2787
|
+
readonly has_more: boolean;
|
|
2784
2788
|
}
|
|
2785
2789
|
export interface ListPrivateArchivedThreadParams {
|
|
2786
2790
|
/** returns threads before this timestamp */
|
|
2787
|
-
before?: string;
|
|
2791
|
+
readonly before?: string;
|
|
2788
2792
|
/** optional maximum number of threads to return */
|
|
2789
|
-
limit?: number;
|
|
2793
|
+
readonly limit?: number;
|
|
2790
2794
|
}
|
|
2791
2795
|
export interface ListPrivateArchivedThreadResponse {
|
|
2792
2796
|
/** the private, archived threads */
|
|
2793
|
-
threads: Channel[];
|
|
2797
|
+
readonly threads: Channel[];
|
|
2794
2798
|
/** a thread member object for each returned thread the current user has joined */
|
|
2795
|
-
members: ThreadMember[];
|
|
2799
|
+
readonly members: ThreadMember[];
|
|
2796
2800
|
/** whether there are potentially additional threads that could be returned on a subsequent call */
|
|
2797
|
-
has_more: boolean;
|
|
2801
|
+
readonly has_more: boolean;
|
|
2798
2802
|
}
|
|
2799
2803
|
export interface ListPublicArchivedThreadParams {
|
|
2800
2804
|
/** returns threads before this timestamp */
|
|
2801
|
-
before?: string;
|
|
2805
|
+
readonly before?: string;
|
|
2802
2806
|
/** optional maximum number of threads to return */
|
|
2803
|
-
limit?: number;
|
|
2807
|
+
readonly limit?: number;
|
|
2804
2808
|
}
|
|
2805
2809
|
export interface ListPublicArchivedThreadResponse {
|
|
2806
2810
|
/** the public, archived threads */
|
|
2807
|
-
threads: Channel[];
|
|
2811
|
+
readonly threads: Channel[];
|
|
2808
2812
|
/** a thread member object for each returned thread the current user has joined */
|
|
2809
|
-
members: ThreadMember[];
|
|
2813
|
+
readonly members: ThreadMember[];
|
|
2810
2814
|
/** whether there are potentially additional threads that could be returned on a subsequent call */
|
|
2811
|
-
has_more: boolean;
|
|
2815
|
+
readonly has_more: boolean;
|
|
2812
2816
|
}
|
|
2813
2817
|
export interface ListScheduledEventsForGuildParams {
|
|
2814
2818
|
/** include number of users subscribed to each event */
|
|
2815
|
-
with_user_count?: boolean;
|
|
2819
|
+
readonly with_user_count?: boolean;
|
|
2816
2820
|
}
|
|
2817
2821
|
export interface ListThreadMemberParams {
|
|
2818
2822
|
/** Whether to include a guild member object for each thread member */
|
|
2819
|
-
with_member?: boolean;
|
|
2823
|
+
readonly with_member?: boolean;
|
|
2820
2824
|
/** Get thread members after this user ID */
|
|
2821
|
-
after?: Snowflake;
|
|
2825
|
+
readonly after?: Snowflake;
|
|
2822
2826
|
/** Max number of thread members to return (1-100). Defaults to 100. */
|
|
2823
|
-
limit?: number;
|
|
2827
|
+
readonly limit?: number;
|
|
2824
2828
|
}
|
|
2825
2829
|
export interface Locale {
|
|
2826
2830
|
/** Danish */
|
|
2827
|
-
da?: string;
|
|
2831
|
+
readonly da?: string;
|
|
2828
2832
|
/** German */
|
|
2829
|
-
de?: string;
|
|
2833
|
+
readonly de?: string;
|
|
2830
2834
|
/** English, */
|
|
2831
|
-
"en-GB"?: string;
|
|
2835
|
+
readonly "en-GB"?: string;
|
|
2832
2836
|
/** English, */
|
|
2833
|
-
"en-US"?: string;
|
|
2837
|
+
readonly "en-US"?: string;
|
|
2834
2838
|
/** Spanish */
|
|
2835
|
-
"es-ES"?: string;
|
|
2839
|
+
readonly "es-ES"?: string;
|
|
2836
2840
|
/** French */
|
|
2837
|
-
fr?: string;
|
|
2841
|
+
readonly fr?: string;
|
|
2838
2842
|
/** Croatian */
|
|
2839
|
-
hr?: string;
|
|
2843
|
+
readonly hr?: string;
|
|
2840
2844
|
/** Italian */
|
|
2841
|
-
it?: string;
|
|
2845
|
+
readonly it?: string;
|
|
2842
2846
|
/** Lithuanian */
|
|
2843
|
-
lt?: string;
|
|
2847
|
+
readonly lt?: string;
|
|
2844
2848
|
/** Hungarian */
|
|
2845
|
-
hu?: string;
|
|
2849
|
+
readonly hu?: string;
|
|
2846
2850
|
/** Dutch */
|
|
2847
|
-
nl?: string;
|
|
2851
|
+
readonly nl?: string;
|
|
2848
2852
|
/** Norwegian */
|
|
2849
|
-
no?: string;
|
|
2853
|
+
readonly no?: string;
|
|
2850
2854
|
/** Polish */
|
|
2851
|
-
pl?: string;
|
|
2855
|
+
readonly pl?: string;
|
|
2852
2856
|
/** Portuguese, Brazilian */
|
|
2853
|
-
"pt-BR"?: string;
|
|
2857
|
+
readonly "pt-BR"?: string;
|
|
2854
2858
|
/** Romanian, Romania */
|
|
2855
|
-
ro?: string;
|
|
2859
|
+
readonly ro?: string;
|
|
2856
2860
|
/** Finnish */
|
|
2857
|
-
fi?: string;
|
|
2861
|
+
readonly fi?: string;
|
|
2858
2862
|
/** Swedish */
|
|
2859
|
-
"sv-SE"?: string;
|
|
2863
|
+
readonly "sv-SE"?: string;
|
|
2860
2864
|
/** Vietnamese */
|
|
2861
|
-
vi?: string;
|
|
2865
|
+
readonly vi?: string;
|
|
2862
2866
|
/** Turkish */
|
|
2863
|
-
tr?: string;
|
|
2867
|
+
readonly tr?: string;
|
|
2864
2868
|
/** Czech */
|
|
2865
|
-
cs?: string;
|
|
2869
|
+
readonly cs?: string;
|
|
2866
2870
|
/** Greek */
|
|
2867
|
-
el?: string;
|
|
2871
|
+
readonly el?: string;
|
|
2868
2872
|
/** Bulgarian */
|
|
2869
|
-
bg?: string;
|
|
2873
|
+
readonly bg?: string;
|
|
2870
2874
|
/** Russian */
|
|
2871
|
-
ru?: string;
|
|
2875
|
+
readonly ru?: string;
|
|
2872
2876
|
/** Ukrainian */
|
|
2873
|
-
uk?: string;
|
|
2877
|
+
readonly uk?: string;
|
|
2874
2878
|
/** Hindi */
|
|
2875
|
-
hi?: string;
|
|
2879
|
+
readonly hi?: string;
|
|
2876
2880
|
/** Thai */
|
|
2877
|
-
th?: string;
|
|
2881
|
+
readonly th?: string;
|
|
2878
2882
|
/** Chinese, China */
|
|
2879
|
-
"zh-CN"?: string;
|
|
2883
|
+
readonly "zh-CN"?: string;
|
|
2880
2884
|
/** Japanese */
|
|
2881
|
-
ja?: string;
|
|
2885
|
+
readonly ja?: string;
|
|
2882
2886
|
/** Chinese, Taiwan */
|
|
2883
|
-
"zh-TW"?: string;
|
|
2887
|
+
readonly "zh-TW"?: string;
|
|
2884
2888
|
/** Korean */
|
|
2885
|
-
ko?: string;
|
|
2889
|
+
readonly ko?: string;
|
|
2886
2890
|
}
|
|
2887
2891
|
export declare const enum MembershipState {
|
|
2888
2892
|
INVITED = 1,
|
|
@@ -2890,73 +2894,73 @@ export declare const enum MembershipState {
|
|
|
2890
2894
|
}
|
|
2891
2895
|
export interface Message {
|
|
2892
2896
|
/** id of the message */
|
|
2893
|
-
id: Snowflake;
|
|
2897
|
+
readonly id: Snowflake;
|
|
2894
2898
|
/** id of the channel the message was sent in */
|
|
2895
|
-
channel_id: Snowflake;
|
|
2899
|
+
readonly channel_id: Snowflake;
|
|
2896
2900
|
/** the author of this message (not guaranteed to be a valid user, see below) */
|
|
2897
|
-
author: User;
|
|
2901
|
+
readonly author: User;
|
|
2898
2902
|
/** contents of the message */
|
|
2899
|
-
content: string;
|
|
2903
|
+
readonly content: string;
|
|
2900
2904
|
/** when this message was sent */
|
|
2901
|
-
timestamp: string;
|
|
2905
|
+
readonly timestamp: string;
|
|
2902
2906
|
/** when this message was edited (or null if never) */
|
|
2903
|
-
edited_timestamp?: string | null;
|
|
2907
|
+
readonly edited_timestamp?: string | null;
|
|
2904
2908
|
/** whether this was a TTS message */
|
|
2905
|
-
tts: boolean;
|
|
2909
|
+
readonly tts: boolean;
|
|
2906
2910
|
/** whether this message mentions everyone */
|
|
2907
|
-
mention_everyone: boolean;
|
|
2911
|
+
readonly mention_everyone: boolean;
|
|
2908
2912
|
/** users specifically mentioned in the message */
|
|
2909
|
-
mentions: User[];
|
|
2913
|
+
readonly mentions: User[];
|
|
2910
2914
|
/** roles specifically mentioned in this message */
|
|
2911
|
-
mention_roles: Snowflake[];
|
|
2915
|
+
readonly mention_roles: Snowflake[];
|
|
2912
2916
|
/** channels specifically mentioned in this message */
|
|
2913
|
-
mention_channels?: ChannelMention[];
|
|
2917
|
+
readonly mention_channels?: ChannelMention[];
|
|
2914
2918
|
/** any attached files */
|
|
2915
|
-
attachments: Attachment[];
|
|
2919
|
+
readonly attachments: Attachment[];
|
|
2916
2920
|
/** any embedded content */
|
|
2917
|
-
embeds: Embed[];
|
|
2921
|
+
readonly embeds: Embed[];
|
|
2918
2922
|
/** reactions to the message */
|
|
2919
|
-
reactions?: Reaction[];
|
|
2923
|
+
readonly reactions?: Reaction[];
|
|
2920
2924
|
/** used for validating a message was sent */
|
|
2921
|
-
nonce?: string;
|
|
2925
|
+
readonly nonce?: string;
|
|
2922
2926
|
/** whether this message is pinned */
|
|
2923
|
-
pinned: boolean;
|
|
2927
|
+
readonly pinned: boolean;
|
|
2924
2928
|
/** if the message is generated by a webhook, this is the webhook's id */
|
|
2925
|
-
webhook_id?: Snowflake;
|
|
2929
|
+
readonly webhook_id?: Snowflake;
|
|
2926
2930
|
/** type of message */
|
|
2927
|
-
type: MessageType;
|
|
2931
|
+
readonly type: MessageType;
|
|
2928
2932
|
/** sent with Rich Presence-related chat embeds */
|
|
2929
|
-
activity?: MessageActivity;
|
|
2933
|
+
readonly activity?: MessageActivity;
|
|
2930
2934
|
/** sent with Rich Presence-related chat embeds */
|
|
2931
|
-
application?: Application;
|
|
2935
|
+
readonly application?: Application;
|
|
2932
2936
|
/** if the message is an Interaction or application-owned webhook, this is the id of the application */
|
|
2933
|
-
application_id?: Snowflake;
|
|
2937
|
+
readonly application_id?: Snowflake;
|
|
2934
2938
|
/** data showing the source of a crosspost, channel follow add, pin, or reply message */
|
|
2935
|
-
message_reference?: MessageReference;
|
|
2939
|
+
readonly message_reference?: MessageReference;
|
|
2936
2940
|
/** message flags combined as a bitfield */
|
|
2937
|
-
flags?: number;
|
|
2941
|
+
readonly flags?: number;
|
|
2938
2942
|
/** the message associated with the message_reference */
|
|
2939
|
-
referenced_message?: Message | null;
|
|
2943
|
+
readonly referenced_message?: Message | null;
|
|
2940
2944
|
/** sent if the message is a response to an Interaction */
|
|
2941
|
-
interaction?: MessageInteraction;
|
|
2945
|
+
readonly interaction?: MessageInteraction;
|
|
2942
2946
|
/** the thread that was started from this message, includes thread member object */
|
|
2943
|
-
thread?: Channel;
|
|
2947
|
+
readonly thread?: Channel;
|
|
2944
2948
|
/** sent if the message contains components like buttons, action rows, or other interactive components */
|
|
2945
|
-
components?: Component[];
|
|
2949
|
+
readonly components?: Component[];
|
|
2946
2950
|
/** sent if the message contains stickers */
|
|
2947
|
-
sticker_items?: StickerItem[];
|
|
2951
|
+
readonly sticker_items?: StickerItem[];
|
|
2948
2952
|
/** Deprecated the stickers sent with the message */
|
|
2949
|
-
stickers?: Sticker[];
|
|
2953
|
+
readonly stickers?: Sticker[];
|
|
2950
2954
|
/** A generally increasing integer (there may be gaps or duplicates) that represents the approximate position of the message in a thread, it can be used to estimate the relative position of the message in a thread in company with total_message_sent on parent thread */
|
|
2951
|
-
position?: number;
|
|
2955
|
+
readonly position?: number;
|
|
2952
2956
|
/** data of the role subscription purchase or renewal that prompted this ROLE_SUBSCRIPTION_PURCHASE message */
|
|
2953
|
-
role_subscription_data?: RoleSubscriptionDatum;
|
|
2957
|
+
readonly role_subscription_data?: RoleSubscriptionDatum;
|
|
2954
2958
|
}
|
|
2955
2959
|
export interface MessageActivity {
|
|
2956
2960
|
/** type of message activity */
|
|
2957
|
-
type: MessageActivityType;
|
|
2961
|
+
readonly type: MessageActivityType;
|
|
2958
2962
|
/** party_id from a Rich Presence event */
|
|
2959
|
-
party_id?: string;
|
|
2963
|
+
readonly party_id?: string;
|
|
2960
2964
|
}
|
|
2961
2965
|
export declare const enum MessageActivityType {
|
|
2962
2966
|
JOIN = 1,
|
|
@@ -2966,36 +2970,36 @@ export declare const enum MessageActivityType {
|
|
|
2966
2970
|
}
|
|
2967
2971
|
export interface MessageComponentDatum {
|
|
2968
2972
|
/** the custom_id of the component */
|
|
2969
|
-
custom_id: string;
|
|
2973
|
+
readonly custom_id: string;
|
|
2970
2974
|
/** the type of the component */
|
|
2971
|
-
component_type: ComponentType;
|
|
2975
|
+
readonly component_type: ComponentType;
|
|
2972
2976
|
/** values the user selected in a select menu component */
|
|
2973
|
-
values?: SelectOption[];
|
|
2977
|
+
readonly values?: SelectOption[];
|
|
2974
2978
|
}
|
|
2975
2979
|
export type MessageCreateEvent = Message & MessageCreateExtra;
|
|
2976
2980
|
export interface MessageCreateExtra {
|
|
2977
2981
|
/** ID of the guild the message was sent in - unless it is an ephemeral message */
|
|
2978
|
-
guild_id?: Snowflake;
|
|
2982
|
+
readonly guild_id?: Snowflake;
|
|
2979
2983
|
/** Member properties for this message's author. Missing for ephemeral messages and messages from webhooks */
|
|
2980
|
-
member?: GuildMember;
|
|
2984
|
+
readonly member?: GuildMember;
|
|
2981
2985
|
/** Users specifically mentioned in the message */
|
|
2982
|
-
mentions: User[];
|
|
2986
|
+
readonly mentions: User[];
|
|
2983
2987
|
}
|
|
2984
2988
|
export interface MessageDeleteBulkEvent {
|
|
2985
2989
|
/** IDs of the messages */
|
|
2986
|
-
ids: Snowflake[];
|
|
2990
|
+
readonly ids: Snowflake[];
|
|
2987
2991
|
/** ID of the channel */
|
|
2988
|
-
channel_id: Snowflake;
|
|
2992
|
+
readonly channel_id: Snowflake;
|
|
2989
2993
|
/** ID of the guild */
|
|
2990
|
-
guild_id?: Snowflake;
|
|
2994
|
+
readonly guild_id?: Snowflake;
|
|
2991
2995
|
}
|
|
2992
2996
|
export interface MessageDeleteEvent {
|
|
2993
2997
|
/** ID of the message */
|
|
2994
|
-
id: Snowflake;
|
|
2998
|
+
readonly id: Snowflake;
|
|
2995
2999
|
/** ID of the channel */
|
|
2996
|
-
channel_id: Snowflake;
|
|
3000
|
+
readonly channel_id: Snowflake;
|
|
2997
3001
|
/** ID of the guild */
|
|
2998
|
-
guild_id?: Snowflake;
|
|
3002
|
+
readonly guild_id?: Snowflake;
|
|
2999
3003
|
}
|
|
3000
3004
|
export declare const MessageFlag: {
|
|
3001
3005
|
/** this message has been published to subscribed channels (via Channel Following) */
|
|
@@ -3018,72 +3022,74 @@ export declare const MessageFlag: {
|
|
|
3018
3022
|
readonly FAILED_TO_MENTION_SOME_ROLES_IN_THREAD: number;
|
|
3019
3023
|
/** this message will not trigger push and desktop notifications */
|
|
3020
3024
|
readonly SUPPRESS_NOTIFICATIONS: number;
|
|
3025
|
+
/** this message is a voice message */
|
|
3026
|
+
readonly IS_VOICE_MESSAGE: number;
|
|
3021
3027
|
};
|
|
3022
3028
|
export interface MessageInteraction {
|
|
3023
3029
|
/** ID of the interaction */
|
|
3024
|
-
id: Snowflake;
|
|
3030
|
+
readonly id: Snowflake;
|
|
3025
3031
|
/** Type of interaction */
|
|
3026
|
-
type: InteractionType;
|
|
3032
|
+
readonly type: InteractionType;
|
|
3027
3033
|
/** Name of the application command, including subcommands and subcommand groups */
|
|
3028
|
-
name: string;
|
|
3034
|
+
readonly name: string;
|
|
3029
3035
|
/** User who invoked the interaction */
|
|
3030
|
-
user: User;
|
|
3036
|
+
readonly user: User;
|
|
3031
3037
|
/** Member who invoked the interaction in the guild */
|
|
3032
|
-
member?: GuildMember;
|
|
3038
|
+
readonly member?: GuildMember;
|
|
3033
3039
|
}
|
|
3034
3040
|
export interface MessageReactionAddEvent {
|
|
3035
3041
|
/** ID of the user */
|
|
3036
|
-
user_id: Snowflake;
|
|
3042
|
+
readonly user_id: Snowflake;
|
|
3037
3043
|
/** ID of the channel */
|
|
3038
|
-
channel_id: Snowflake;
|
|
3044
|
+
readonly channel_id: Snowflake;
|
|
3039
3045
|
/** ID of the message */
|
|
3040
|
-
message_id: Snowflake;
|
|
3046
|
+
readonly message_id: Snowflake;
|
|
3041
3047
|
/** ID of the guild */
|
|
3042
|
-
guild_id?: Snowflake;
|
|
3048
|
+
readonly guild_id?: Snowflake;
|
|
3043
3049
|
/** Member who reacted if this happened in a guild */
|
|
3044
|
-
member?: GuildMember;
|
|
3050
|
+
readonly member?: GuildMember;
|
|
3045
3051
|
/** Emoji used to react - example */
|
|
3046
|
-
emoji: Emoji;
|
|
3052
|
+
readonly emoji: Emoji;
|
|
3047
3053
|
}
|
|
3048
3054
|
export interface MessageReactionRemoveAllEvent {
|
|
3049
3055
|
/** ID of the channel */
|
|
3050
|
-
channel_id: Snowflake;
|
|
3056
|
+
readonly channel_id: Snowflake;
|
|
3051
3057
|
/** ID of the message */
|
|
3052
|
-
message_id: Snowflake;
|
|
3058
|
+
readonly message_id: Snowflake;
|
|
3053
3059
|
/** ID of the guild */
|
|
3054
|
-
guild_id?: Snowflake;
|
|
3060
|
+
readonly guild_id?: Snowflake;
|
|
3055
3061
|
}
|
|
3056
3062
|
export interface MessageReactionRemoveEmojiEvent {
|
|
3057
3063
|
/** ID of the channel */
|
|
3058
|
-
channel_id: Snowflake;
|
|
3064
|
+
readonly channel_id: Snowflake;
|
|
3059
3065
|
/** ID of the guild */
|
|
3060
|
-
guild_id?: Snowflake;
|
|
3066
|
+
readonly guild_id?: Snowflake;
|
|
3061
3067
|
/** ID of the message */
|
|
3062
|
-
message_id: Snowflake;
|
|
3068
|
+
readonly message_id: Snowflake;
|
|
3063
3069
|
/** Emoji that was removed */
|
|
3064
|
-
emoji: Emoji;
|
|
3070
|
+
readonly emoji: Emoji;
|
|
3065
3071
|
}
|
|
3066
3072
|
export interface MessageReactionRemoveEvent {
|
|
3067
3073
|
/** ID of the user */
|
|
3068
|
-
user_id: Snowflake;
|
|
3074
|
+
readonly user_id: Snowflake;
|
|
3069
3075
|
/** ID of the channel */
|
|
3070
|
-
channel_id: Snowflake;
|
|
3076
|
+
readonly channel_id: Snowflake;
|
|
3071
3077
|
/** ID of the message */
|
|
3072
|
-
message_id: Snowflake;
|
|
3078
|
+
readonly message_id: Snowflake;
|
|
3073
3079
|
/** ID of the guild */
|
|
3074
|
-
guild_id?: Snowflake;
|
|
3080
|
+
readonly guild_id?: Snowflake;
|
|
3075
3081
|
/** Emoji used to react - example */
|
|
3076
|
-
emoji: Emoji;
|
|
3082
|
+
readonly emoji: Emoji;
|
|
3077
3083
|
}
|
|
3078
3084
|
export interface MessageReference {
|
|
3079
3085
|
/** id of the originating message */
|
|
3080
|
-
message_id?: Snowflake;
|
|
3086
|
+
readonly message_id?: Snowflake;
|
|
3081
3087
|
/** id of the originating message's channel */
|
|
3082
|
-
channel_id?: Snowflake;
|
|
3088
|
+
readonly channel_id?: Snowflake;
|
|
3083
3089
|
/** id of the originating message's guild */
|
|
3084
|
-
guild_id?: Snowflake;
|
|
3090
|
+
readonly guild_id?: Snowflake;
|
|
3085
3091
|
/** when sending, whether to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message, default true */
|
|
3086
|
-
fail_if_not_exists?: boolean;
|
|
3092
|
+
readonly fail_if_not_exists?: boolean;
|
|
3087
3093
|
}
|
|
3088
3094
|
export declare const enum MessageType {
|
|
3089
3095
|
DEFAULT = 0,
|
|
@@ -3127,276 +3133,276 @@ export declare const enum MfaLevel {
|
|
|
3127
3133
|
}
|
|
3128
3134
|
export interface ModalSubmitDatum {
|
|
3129
3135
|
/** the custom_id of the modal */
|
|
3130
|
-
custom_id: string;
|
|
3136
|
+
readonly custom_id: string;
|
|
3131
3137
|
/** the values submitted by the user */
|
|
3132
|
-
components: Component[];
|
|
3138
|
+
readonly components: Component[];
|
|
3133
3139
|
}
|
|
3134
3140
|
export interface ModifyAutoModerationRuleParams {
|
|
3135
3141
|
/** the rule name */
|
|
3136
|
-
name: string;
|
|
3142
|
+
readonly name: string;
|
|
3137
3143
|
/** the event type */
|
|
3138
|
-
event_type: EventType;
|
|
3144
|
+
readonly event_type: EventType;
|
|
3139
3145
|
/** the trigger metadata */
|
|
3140
|
-
trigger_metadata?: TriggerMetadatum;
|
|
3146
|
+
readonly trigger_metadata?: TriggerMetadatum;
|
|
3141
3147
|
/** the actions which will execute when the rule is triggered */
|
|
3142
|
-
actions: AutoModerationAction[];
|
|
3148
|
+
readonly actions: AutoModerationAction[];
|
|
3143
3149
|
/** whether the rule is enabled */
|
|
3144
|
-
enabled: boolean;
|
|
3150
|
+
readonly enabled: boolean;
|
|
3145
3151
|
/** the role ids that should not be affected by the rule (Maximum of 20) */
|
|
3146
|
-
exempt_roles: Snowflake[];
|
|
3152
|
+
readonly exempt_roles: Snowflake[];
|
|
3147
3153
|
/** the channel ids that should not be affected by the rule (Maximum of 50) */
|
|
3148
|
-
exempt_channels: Snowflake[];
|
|
3154
|
+
readonly exempt_channels: Snowflake[];
|
|
3149
3155
|
}
|
|
3150
3156
|
export interface ModifyChannelGroupDmParams {
|
|
3151
3157
|
/** 1-100 character channel name */
|
|
3152
|
-
name: string;
|
|
3158
|
+
readonly name: string;
|
|
3153
3159
|
/** base64 encoded icon */
|
|
3154
|
-
icon: string;
|
|
3160
|
+
readonly icon: string;
|
|
3155
3161
|
}
|
|
3156
3162
|
export interface ModifyChannelGuildChannelParams {
|
|
3157
3163
|
/** 1-100 character channel name */
|
|
3158
|
-
name: string;
|
|
3164
|
+
readonly name: string;
|
|
3159
3165
|
/** the type of channel; only conversion between text and announcement is supported and only in guilds with the "NEWS" feature */
|
|
3160
|
-
type: ChannelType;
|
|
3166
|
+
readonly type: ChannelType;
|
|
3161
3167
|
/** the position of the channel in the left-hand listing */
|
|
3162
|
-
position?: number | null;
|
|
3168
|
+
readonly position?: number | null;
|
|
3163
3169
|
/** 0-1024 character channel topic (0-4096 characters for GUILD_FORUM channels) */
|
|
3164
|
-
topic?: string | null;
|
|
3170
|
+
readonly topic?: string | null;
|
|
3165
3171
|
/** whether the channel is nsfw */
|
|
3166
|
-
nsfw?: boolean | null;
|
|
3172
|
+
readonly nsfw?: boolean | null;
|
|
3167
3173
|
/** amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages or manage_channel, are unaffected */
|
|
3168
|
-
rate_limit_per_user?: number | null;
|
|
3174
|
+
readonly rate_limit_per_user?: number | null;
|
|
3169
3175
|
/** the bitrate (in bits) of the voice or stage channel; min 8000 */
|
|
3170
|
-
bitrate?: number | null;
|
|
3176
|
+
readonly bitrate?: number | null;
|
|
3171
3177
|
/** the user limit of the voice or stage channel, max 99 for voice channels and 10,000 for stage channels (0 refers to no limit) */
|
|
3172
|
-
user_limit?: number | null;
|
|
3178
|
+
readonly user_limit?: number | null;
|
|
3173
3179
|
/** channel or category-specific permissions */
|
|
3174
|
-
permission_overwrites?: Overwrite[] | null;
|
|
3180
|
+
readonly permission_overwrites?: Overwrite[] | null;
|
|
3175
3181
|
/** id of the new parent category for a channel */
|
|
3176
|
-
parent_id?: Snowflake | null;
|
|
3182
|
+
readonly parent_id?: Snowflake | null;
|
|
3177
3183
|
/** channel voice region id, automatic when set to null */
|
|
3178
|
-
rtc_region?: string | null;
|
|
3184
|
+
readonly rtc_region?: string | null;
|
|
3179
3185
|
/** the camera video quality mode of the voice channel */
|
|
3180
|
-
video_quality_mode?: VideoQualityMode | null;
|
|
3186
|
+
readonly video_quality_mode?: VideoQualityMode | null;
|
|
3181
3187
|
/** the default duration that the clients use (not the API) for newly created threads in the channel, in minutes, to automatically archive the thread after recent activity */
|
|
3182
|
-
default_auto_archive_duration?: number | null;
|
|
3188
|
+
readonly default_auto_archive_duration?: number | null;
|
|
3183
3189
|
/** channel flags combined as a bitfield. Currently only REQUIRE_TAG (1 << 4) is supported. */
|
|
3184
|
-
flags?: number;
|
|
3190
|
+
readonly flags?: number;
|
|
3185
3191
|
/** the set of tags that can be used in a GUILD_FORUM channel; limited to 20 */
|
|
3186
|
-
available_tags?: ForumTag[];
|
|
3192
|
+
readonly available_tags?: ForumTag[];
|
|
3187
3193
|
/** the emoji to show in the add reaction button on a thread in a GUILD_FORUM channel */
|
|
3188
|
-
default_reaction_emoji?: DefaultReaction | null;
|
|
3194
|
+
readonly default_reaction_emoji?: DefaultReaction | null;
|
|
3189
3195
|
/** the initial rate_limit_per_user to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update. */
|
|
3190
|
-
default_thread_rate_limit_per_user?: number;
|
|
3196
|
+
readonly default_thread_rate_limit_per_user?: number;
|
|
3191
3197
|
/** the default sort order type used to order posts in GUILD_FORUM channels */
|
|
3192
|
-
default_sort_order?: SortOrderType | null;
|
|
3198
|
+
readonly default_sort_order?: SortOrderType | null;
|
|
3193
3199
|
/** the default forum layout type used to display posts in GUILD_FORUM channels */
|
|
3194
|
-
default_forum_layout?: ForumLayoutType;
|
|
3200
|
+
readonly default_forum_layout?: ForumLayoutType;
|
|
3195
3201
|
}
|
|
3196
3202
|
export type ModifyChannelParams = ModifyChannelGroupDmParams | ModifyChannelGuildChannelParams | ModifyChannelThreadParams;
|
|
3197
3203
|
export interface ModifyChannelThreadParams {
|
|
3198
3204
|
/** 1-100 character channel name */
|
|
3199
|
-
name: string;
|
|
3205
|
+
readonly name: string;
|
|
3200
3206
|
/** whether the thread is archived */
|
|
3201
|
-
archived: boolean;
|
|
3207
|
+
readonly archived: boolean;
|
|
3202
3208
|
/** the thread will stop showing in the channel list after auto_archive_duration minutes of inactivity, can be set to: 60, 1440, 4320, 10080 */
|
|
3203
|
-
auto_archive_duration: number;
|
|
3209
|
+
readonly auto_archive_duration: number;
|
|
3204
3210
|
/** whether the thread is locked; when a thread is locked, only users with MANAGE_THREADS can unarchive it */
|
|
3205
|
-
locked: boolean;
|
|
3211
|
+
readonly locked: boolean;
|
|
3206
3212
|
/** whether non-moderators can add other non-moderators to a thread; only available on private threads */
|
|
3207
|
-
invitable: boolean;
|
|
3213
|
+
readonly invitable: boolean;
|
|
3208
3214
|
/** amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages, manage_thread, or manage_channel, are unaffected */
|
|
3209
|
-
rate_limit_per_user?: number | null;
|
|
3215
|
+
readonly rate_limit_per_user?: number | null;
|
|
3210
3216
|
/** channel flags combined as a bitfield; PINNED can only be set for threads in forum channels */
|
|
3211
|
-
flags?: number;
|
|
3217
|
+
readonly flags?: number;
|
|
3212
3218
|
/** the IDs of the set of tags that have been applied to a thread in a GUILD_FORUM channel; limited to 5 */
|
|
3213
|
-
applied_tags?: Snowflake[];
|
|
3219
|
+
readonly applied_tags?: Snowflake[];
|
|
3214
3220
|
}
|
|
3215
3221
|
export interface ModifyCurrentMemberParams {
|
|
3216
3222
|
/** value to set user's nickname to */
|
|
3217
|
-
nick?: string | null;
|
|
3223
|
+
readonly nick?: string | null;
|
|
3218
3224
|
}
|
|
3219
3225
|
export interface ModifyCurrentUserNickParams {
|
|
3220
3226
|
/** value to set user's nickname to */
|
|
3221
|
-
nick?: string | null;
|
|
3227
|
+
readonly nick?: string | null;
|
|
3222
3228
|
}
|
|
3223
3229
|
export interface ModifyCurrentUserParams {
|
|
3224
3230
|
/** user's username, if changed may cause the user's discriminator to be randomized. */
|
|
3225
|
-
username: string;
|
|
3231
|
+
readonly username: string;
|
|
3226
3232
|
/** if passed, modifies the user's avatar */
|
|
3227
|
-
avatar?: string | null;
|
|
3233
|
+
readonly avatar?: string | null;
|
|
3228
3234
|
}
|
|
3229
3235
|
export interface ModifyCurrentUserVoiceStateParams {
|
|
3230
3236
|
/** the id of the channel the user is currently in */
|
|
3231
|
-
channel_id?: Snowflake;
|
|
3237
|
+
readonly channel_id?: Snowflake;
|
|
3232
3238
|
/** toggles the user's suppress state */
|
|
3233
|
-
suppress?: boolean;
|
|
3239
|
+
readonly suppress?: boolean;
|
|
3234
3240
|
/** sets the user's request to speak */
|
|
3235
|
-
request_to_speak_timestamp?: string | null;
|
|
3241
|
+
readonly request_to_speak_timestamp?: string | null;
|
|
3236
3242
|
}
|
|
3237
3243
|
export interface ModifyGuildChannelPositionParams {
|
|
3238
3244
|
/** channel id */
|
|
3239
|
-
id: Snowflake;
|
|
3245
|
+
readonly id: Snowflake;
|
|
3240
3246
|
/** sorting position of the channel */
|
|
3241
|
-
position?: number | null;
|
|
3247
|
+
readonly position?: number | null;
|
|
3242
3248
|
/** syncs the permission overwrites with the new parent, if moving to a new category */
|
|
3243
|
-
lock_permissions?: boolean | null;
|
|
3249
|
+
readonly lock_permissions?: boolean | null;
|
|
3244
3250
|
/** the new parent ID for the channel that is moved */
|
|
3245
|
-
parent_id?: Snowflake | null;
|
|
3251
|
+
readonly parent_id?: Snowflake | null;
|
|
3246
3252
|
}
|
|
3247
3253
|
export interface ModifyGuildEmojiParams {
|
|
3248
3254
|
/** name of the emoji */
|
|
3249
|
-
name: string;
|
|
3255
|
+
readonly name: string;
|
|
3250
3256
|
/** roles allowed to use this emoji */
|
|
3251
|
-
roles?: Snowflake[] | null;
|
|
3257
|
+
readonly roles?: Snowflake[] | null;
|
|
3252
3258
|
}
|
|
3253
3259
|
export interface ModifyGuildMemberParams {
|
|
3254
3260
|
/** value to set user's nickname to */
|
|
3255
|
-
nick: string;
|
|
3261
|
+
readonly nick: string;
|
|
3256
3262
|
/** array of role ids the member is assigned */
|
|
3257
|
-
roles: Snowflake[];
|
|
3263
|
+
readonly roles: Snowflake[];
|
|
3258
3264
|
/** whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel */
|
|
3259
|
-
mute: boolean;
|
|
3265
|
+
readonly mute: boolean;
|
|
3260
3266
|
/** whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel */
|
|
3261
|
-
deaf: boolean;
|
|
3267
|
+
readonly deaf: boolean;
|
|
3262
3268
|
/** id of channel to move user to (if they are connected to voice) */
|
|
3263
|
-
channel_id: Snowflake;
|
|
3269
|
+
readonly channel_id: Snowflake;
|
|
3264
3270
|
/** when the user's timeout will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild */
|
|
3265
|
-
communication_disabled_until: string;
|
|
3271
|
+
readonly communication_disabled_until: string;
|
|
3266
3272
|
/** guild member flags */
|
|
3267
|
-
flags: number;
|
|
3273
|
+
readonly flags: number;
|
|
3268
3274
|
}
|
|
3269
3275
|
export interface ModifyGuildMfaLevelParams {
|
|
3270
3276
|
/** MFA level */
|
|
3271
|
-
level: MfaLevel;
|
|
3277
|
+
readonly level: MfaLevel;
|
|
3272
3278
|
}
|
|
3273
3279
|
export interface ModifyGuildParams {
|
|
3274
3280
|
/** guild name */
|
|
3275
|
-
name: string;
|
|
3281
|
+
readonly name: string;
|
|
3276
3282
|
/** guild voice region id (deprecated) */
|
|
3277
|
-
region?: string | null;
|
|
3283
|
+
readonly region?: string | null;
|
|
3278
3284
|
/** verification level */
|
|
3279
|
-
verification_level?: VerificationLevel | null;
|
|
3285
|
+
readonly verification_level?: VerificationLevel | null;
|
|
3280
3286
|
/** default message notification level */
|
|
3281
|
-
default_message_notifications?: DefaultMessageNotificationLevel | null;
|
|
3287
|
+
readonly default_message_notifications?: DefaultMessageNotificationLevel | null;
|
|
3282
3288
|
/** explicit content filter level */
|
|
3283
|
-
explicit_content_filter?: ExplicitContentFilterLevel | null;
|
|
3289
|
+
readonly explicit_content_filter?: ExplicitContentFilterLevel | null;
|
|
3284
3290
|
/** id for afk channel */
|
|
3285
|
-
afk_channel_id?: Snowflake | null;
|
|
3291
|
+
readonly afk_channel_id?: Snowflake | null;
|
|
3286
3292
|
/** afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600 */
|
|
3287
|
-
afk_timeout: number;
|
|
3293
|
+
readonly afk_timeout: number;
|
|
3288
3294
|
/** base64 1024x1024 png/jpeg/gif image for the guild icon (can be animated gif when the server has the ANIMATED_ICON feature) */
|
|
3289
|
-
icon?: string | null;
|
|
3295
|
+
readonly icon?: string | null;
|
|
3290
3296
|
/** user id to transfer guild ownership to (must be owner) */
|
|
3291
|
-
owner_id: Snowflake;
|
|
3297
|
+
readonly owner_id: Snowflake;
|
|
3292
3298
|
/** base64 16:9 png/jpeg image for the guild splash (when the server has the INVITE_SPLASH feature) */
|
|
3293
|
-
splash?: string | null;
|
|
3299
|
+
readonly splash?: string | null;
|
|
3294
3300
|
/** base64 16:9 png/jpeg image for the guild discovery splash (when the server has the DISCOVERABLE feature) */
|
|
3295
|
-
discovery_splash?: string | null;
|
|
3301
|
+
readonly discovery_splash?: string | null;
|
|
3296
3302
|
/** base64 16:9 png/jpeg image for the guild banner (when the server has the BANNER feature; can be animated gif when the server has the ANIMATED_BANNER feature) */
|
|
3297
|
-
banner?: string | null;
|
|
3303
|
+
readonly banner?: string | null;
|
|
3298
3304
|
/** the id of the channel where guild notices such as welcome messages and boost events are posted */
|
|
3299
|
-
system_channel_id?: Snowflake | null;
|
|
3305
|
+
readonly system_channel_id?: Snowflake | null;
|
|
3300
3306
|
/** system channel flags */
|
|
3301
|
-
system_channel_flags: number;
|
|
3307
|
+
readonly system_channel_flags: number;
|
|
3302
3308
|
/** the id of the channel where Community guilds display rules and/or guidelines */
|
|
3303
|
-
rules_channel_id?: Snowflake | null;
|
|
3309
|
+
readonly rules_channel_id?: Snowflake | null;
|
|
3304
3310
|
/** the id of the channel where admins and moderators of Community guilds receive notices from Discord */
|
|
3305
|
-
public_updates_channel_id?: Snowflake | null;
|
|
3311
|
+
readonly public_updates_channel_id?: Snowflake | null;
|
|
3306
3312
|
/** the preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US" */
|
|
3307
|
-
preferred_locale?: string | null;
|
|
3313
|
+
readonly preferred_locale?: string | null;
|
|
3308
3314
|
/** enabled guild features */
|
|
3309
|
-
features: GuildFeature[];
|
|
3315
|
+
readonly features: GuildFeature[];
|
|
3310
3316
|
/** the description for the guild */
|
|
3311
|
-
description?: string | null;
|
|
3317
|
+
readonly description?: string | null;
|
|
3312
3318
|
/** whether the guild's boost progress bar should be enabled */
|
|
3313
|
-
premium_progress_bar_enabled: boolean;
|
|
3319
|
+
readonly premium_progress_bar_enabled: boolean;
|
|
3314
3320
|
}
|
|
3315
3321
|
export interface ModifyGuildRoleParams {
|
|
3316
3322
|
/** name of the role, max 100 characters */
|
|
3317
|
-
name: string;
|
|
3323
|
+
readonly name: string;
|
|
3318
3324
|
/** bitwise value of the enabled/disabled permissions */
|
|
3319
|
-
permissions: string;
|
|
3325
|
+
readonly permissions: string;
|
|
3320
3326
|
/** RGB color value */
|
|
3321
|
-
color: number;
|
|
3327
|
+
readonly color: number;
|
|
3322
3328
|
/** whether the role should be displayed separately in the sidebar */
|
|
3323
|
-
hoist: boolean;
|
|
3329
|
+
readonly hoist: boolean;
|
|
3324
3330
|
/** the role's icon image (if the guild has the ROLE_ICONS feature) */
|
|
3325
|
-
icon: string;
|
|
3331
|
+
readonly icon: string;
|
|
3326
3332
|
/** the role's unicode emoji as a standard emoji (if the guild has the ROLE_ICONS feature) */
|
|
3327
|
-
unicode_emoji: string;
|
|
3333
|
+
readonly unicode_emoji: string;
|
|
3328
3334
|
/** whether the role should be mentionable */
|
|
3329
|
-
mentionable: boolean;
|
|
3335
|
+
readonly mentionable: boolean;
|
|
3330
3336
|
}
|
|
3331
3337
|
export interface ModifyGuildRolePositionParams {
|
|
3332
3338
|
/** role */
|
|
3333
|
-
id: Snowflake;
|
|
3339
|
+
readonly id: Snowflake;
|
|
3334
3340
|
/** sorting position of the role */
|
|
3335
|
-
position?: number | null;
|
|
3341
|
+
readonly position?: number | null;
|
|
3336
3342
|
}
|
|
3337
3343
|
export interface ModifyGuildScheduledEventParams {
|
|
3338
3344
|
/** the channel id of the scheduled event, set to null if changing entity type to EXTERNAL */
|
|
3339
|
-
channel_id?: Snowflake | null;
|
|
3345
|
+
readonly channel_id?: Snowflake | null;
|
|
3340
3346
|
/** the entity metadata of the scheduled event */
|
|
3341
|
-
entity_metadata?: GuildScheduledEventEntityMetadatum | null;
|
|
3347
|
+
readonly entity_metadata?: GuildScheduledEventEntityMetadatum | null;
|
|
3342
3348
|
/** the name of the scheduled event */
|
|
3343
|
-
name?: string;
|
|
3349
|
+
readonly name?: string;
|
|
3344
3350
|
/** the privacy level of the scheduled event */
|
|
3345
|
-
privacy_level?: GuildScheduledEventPrivacyLevel;
|
|
3351
|
+
readonly privacy_level?: GuildScheduledEventPrivacyLevel;
|
|
3346
3352
|
/** the time to schedule the scheduled event */
|
|
3347
|
-
scheduled_start_time?: string;
|
|
3353
|
+
readonly scheduled_start_time?: string;
|
|
3348
3354
|
/** the time when the scheduled event is scheduled to end */
|
|
3349
|
-
scheduled_end_time?: string;
|
|
3355
|
+
readonly scheduled_end_time?: string;
|
|
3350
3356
|
/** the description of the scheduled event */
|
|
3351
|
-
description?: string | null;
|
|
3357
|
+
readonly description?: string | null;
|
|
3352
3358
|
/** the entity type of the scheduled event */
|
|
3353
|
-
entity_type?: GuildScheduledEventEntityType;
|
|
3359
|
+
readonly entity_type?: GuildScheduledEventEntityType;
|
|
3354
3360
|
/** the status of the scheduled event */
|
|
3355
|
-
status?: GuildScheduledEventStatus;
|
|
3361
|
+
readonly status?: GuildScheduledEventStatus;
|
|
3356
3362
|
/** the cover image of the scheduled event */
|
|
3357
|
-
image?: string;
|
|
3363
|
+
readonly image?: string;
|
|
3358
3364
|
}
|
|
3359
3365
|
export interface ModifyGuildStickerParams {
|
|
3360
3366
|
/** name of the sticker (2-30 characters) */
|
|
3361
|
-
name: string;
|
|
3367
|
+
readonly name: string;
|
|
3362
3368
|
/** description of the sticker (2-100 characters) */
|
|
3363
|
-
description?: string | null;
|
|
3369
|
+
readonly description?: string | null;
|
|
3364
3370
|
/** autocomplete/suggestion tags for the sticker (max 200 characters) */
|
|
3365
|
-
tags: string;
|
|
3371
|
+
readonly tags: string;
|
|
3366
3372
|
}
|
|
3367
3373
|
export interface ModifyGuildTemplateParams {
|
|
3368
3374
|
/** name of the template (1-100 characters) */
|
|
3369
|
-
name?: string;
|
|
3375
|
+
readonly name?: string;
|
|
3370
3376
|
/** description for the template (0-120 characters) */
|
|
3371
|
-
description?: string | null;
|
|
3377
|
+
readonly description?: string | null;
|
|
3372
3378
|
}
|
|
3373
3379
|
export interface ModifyGuildWelcomeScreenParams {
|
|
3374
3380
|
/** whether the welcome screen is enabled */
|
|
3375
|
-
enabled: boolean;
|
|
3381
|
+
readonly enabled: boolean;
|
|
3376
3382
|
/** channels linked in the welcome screen and their display options */
|
|
3377
|
-
welcome_channels: WelcomeScreenChannel[];
|
|
3383
|
+
readonly welcome_channels: WelcomeScreenChannel[];
|
|
3378
3384
|
/** the server description to show in the welcome screen */
|
|
3379
|
-
description: string;
|
|
3385
|
+
readonly description: string;
|
|
3380
3386
|
}
|
|
3381
3387
|
export interface ModifyStageInstanceParams {
|
|
3382
3388
|
/** The topic of the Stage instance (1-120 characters) */
|
|
3383
|
-
topic?: string;
|
|
3389
|
+
readonly topic?: string;
|
|
3384
3390
|
/** The privacy level of the Stage instance */
|
|
3385
|
-
privacy_level?: PrivacyLevel;
|
|
3391
|
+
readonly privacy_level?: PrivacyLevel;
|
|
3386
3392
|
}
|
|
3387
3393
|
export interface ModifyUserVoiceStateParams {
|
|
3388
3394
|
/** the id of the channel the user is currently in */
|
|
3389
|
-
channel_id: Snowflake;
|
|
3395
|
+
readonly channel_id: Snowflake;
|
|
3390
3396
|
/** toggles the user's suppress state */
|
|
3391
|
-
suppress?: boolean;
|
|
3397
|
+
readonly suppress?: boolean;
|
|
3392
3398
|
}
|
|
3393
3399
|
export interface ModifyWebhookParams {
|
|
3394
3400
|
/** the default name of the webhook */
|
|
3395
|
-
name: string;
|
|
3401
|
+
readonly name: string;
|
|
3396
3402
|
/** image for the default webhook avatar */
|
|
3397
|
-
avatar?: string | null;
|
|
3403
|
+
readonly avatar?: string | null;
|
|
3398
3404
|
/** the new channel id this webhook should be moved to */
|
|
3399
|
-
channel_id: Snowflake;
|
|
3405
|
+
readonly channel_id: Snowflake;
|
|
3400
3406
|
}
|
|
3401
3407
|
export declare const enum MutableGuildFeature {
|
|
3402
3408
|
COMMUNITY = "COMMUNITY",
|
|
@@ -3404,7 +3410,7 @@ export declare const enum MutableGuildFeature {
|
|
|
3404
3410
|
DISCOVERABLE = "DISCOVERABLE"
|
|
3405
3411
|
}
|
|
3406
3412
|
export declare const enum OAuth2Scope {
|
|
3407
|
-
/** allows your app to fetch data from a user's "Now Playing/Recently Played" list
|
|
3413
|
+
/** allows your app to fetch data from a user's "Now Playing/Recently Played" list — not currently available for apps */
|
|
3408
3414
|
ACTIVITIES_READ = "activities.read",
|
|
3409
3415
|
/** allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER) */
|
|
3410
3416
|
ACTIVITIES_WRITE = "activities.write",
|
|
@@ -3463,29 +3469,29 @@ export declare const enum OAuth2Scope {
|
|
|
3463
3469
|
}
|
|
3464
3470
|
export interface OnboardingPrompt {
|
|
3465
3471
|
/** ID of the prompt */
|
|
3466
|
-
id: Snowflake;
|
|
3472
|
+
readonly id: Snowflake;
|
|
3467
3473
|
/** Type of prompt */
|
|
3468
|
-
type: PromptType;
|
|
3474
|
+
readonly type: PromptType;
|
|
3469
3475
|
/** Options available within the prompt */
|
|
3470
|
-
options: PromptOption[];
|
|
3476
|
+
readonly options: PromptOption[];
|
|
3471
3477
|
/** Title of the prompt */
|
|
3472
|
-
title: string;
|
|
3478
|
+
readonly title: string;
|
|
3473
3479
|
/** Indicates whether users are limited to selecting one option for the prompt */
|
|
3474
|
-
single_select: boolean;
|
|
3480
|
+
readonly single_select: boolean;
|
|
3475
3481
|
/** Indicates whether the prompt is required before a user completes the onboarding flow */
|
|
3476
|
-
required: boolean;
|
|
3482
|
+
readonly required: boolean;
|
|
3477
3483
|
/** Indicates whether the prompt is present in the onboarding flow. If false, the prompt will only appear in the Channels & Roles tab */
|
|
3478
|
-
in_onboarding: boolean;
|
|
3484
|
+
readonly in_onboarding: boolean;
|
|
3479
3485
|
}
|
|
3480
3486
|
export interface Overwrite {
|
|
3481
3487
|
/** role or user id */
|
|
3482
|
-
id: Snowflake;
|
|
3488
|
+
readonly id: Snowflake;
|
|
3483
3489
|
/** either 0 (role) or 1 (member) */
|
|
3484
|
-
type: number;
|
|
3490
|
+
readonly type: number;
|
|
3485
3491
|
/** permission bit set */
|
|
3486
|
-
allow: string;
|
|
3492
|
+
readonly allow: string;
|
|
3487
3493
|
/** permission bit set */
|
|
3488
|
-
deny: string;
|
|
3494
|
+
readonly deny: string;
|
|
3489
3495
|
}
|
|
3490
3496
|
export declare const PermissionFlag: {
|
|
3491
3497
|
/** Allows creation of instant invites */
|
|
@@ -3574,6 +3580,8 @@ export declare const PermissionFlag: {
|
|
|
3574
3580
|
readonly VIEW_CREATOR_MONETIZATION_ANALYTICS: bigint;
|
|
3575
3581
|
/** Allows for using soundboard in a voice channel */
|
|
3576
3582
|
readonly USE_SOUNDBOARD: bigint;
|
|
3583
|
+
/** Allows sending voice messages */
|
|
3584
|
+
readonly SEND_VOICE_MESSAGES: bigint;
|
|
3577
3585
|
};
|
|
3578
3586
|
export declare const enum PremiumTier {
|
|
3579
3587
|
/** guild has not unlocked any Server Boost perks */
|
|
@@ -3593,15 +3601,15 @@ export declare const enum PremiumType {
|
|
|
3593
3601
|
}
|
|
3594
3602
|
export interface PresenceUpdateEvent {
|
|
3595
3603
|
/** User whose presence is being updated */
|
|
3596
|
-
user: User;
|
|
3604
|
+
readonly user: User;
|
|
3597
3605
|
/** ID of the guild */
|
|
3598
|
-
guild_id: Snowflake;
|
|
3606
|
+
readonly guild_id: Snowflake;
|
|
3599
3607
|
/** Either "idle", "dnd", "online", or "offline" */
|
|
3600
|
-
status: string;
|
|
3608
|
+
readonly status: string;
|
|
3601
3609
|
/** User's current activities */
|
|
3602
|
-
activities: Activity[];
|
|
3610
|
+
readonly activities: Activity[];
|
|
3603
3611
|
/** User's platform-dependent status */
|
|
3604
|
-
client_status: ClientStatus;
|
|
3612
|
+
readonly client_status: ClientStatus;
|
|
3605
3613
|
}
|
|
3606
3614
|
export declare const enum PrivacyLevel {
|
|
3607
3615
|
/** The Stage instance is visible publicly. (deprecated) */
|
|
@@ -3611,17 +3619,17 @@ export declare const enum PrivacyLevel {
|
|
|
3611
3619
|
}
|
|
3612
3620
|
export interface PromptOption {
|
|
3613
3621
|
/** ID of the prompt option */
|
|
3614
|
-
id: Snowflake;
|
|
3622
|
+
readonly id: Snowflake;
|
|
3615
3623
|
/** IDs for channels a member is added to when the option is selected */
|
|
3616
|
-
channel_ids: Snowflake[];
|
|
3624
|
+
readonly channel_ids: Snowflake[];
|
|
3617
3625
|
/** IDs for roles assigned to a member when the option is selected */
|
|
3618
|
-
role_ids: Snowflake[];
|
|
3626
|
+
readonly role_ids: Snowflake[];
|
|
3619
3627
|
/** Emoji of the option */
|
|
3620
|
-
emoji: Emoji;
|
|
3628
|
+
readonly emoji: Emoji;
|
|
3621
3629
|
/** Title of the option */
|
|
3622
|
-
title: string;
|
|
3630
|
+
readonly title: string;
|
|
3623
3631
|
/** Description of the option */
|
|
3624
|
-
description?: string | null;
|
|
3632
|
+
readonly description?: string | null;
|
|
3625
3633
|
}
|
|
3626
3634
|
export declare const enum PromptType {
|
|
3627
3635
|
MULTIPLE_CHOICE = 0,
|
|
@@ -3629,27 +3637,27 @@ export declare const enum PromptType {
|
|
|
3629
3637
|
}
|
|
3630
3638
|
export interface Reaction {
|
|
3631
3639
|
/** times this emoji has been used to react */
|
|
3632
|
-
count: number;
|
|
3640
|
+
readonly count: number;
|
|
3633
3641
|
/** whether the current user reacted using this emoji */
|
|
3634
|
-
me: boolean;
|
|
3642
|
+
readonly me: boolean;
|
|
3635
3643
|
/** emoji information */
|
|
3636
|
-
emoji: Emoji;
|
|
3644
|
+
readonly emoji: Emoji;
|
|
3637
3645
|
}
|
|
3638
3646
|
export interface ReadyEvent {
|
|
3639
3647
|
/** API version */
|
|
3640
|
-
v: number;
|
|
3648
|
+
readonly v: number;
|
|
3641
3649
|
/** Information about the user including email */
|
|
3642
|
-
user: User;
|
|
3650
|
+
readonly user: User;
|
|
3643
3651
|
/** Guilds the user is in */
|
|
3644
|
-
guilds: UnavailableGuild[];
|
|
3652
|
+
readonly guilds: UnavailableGuild[];
|
|
3645
3653
|
/** Used for resuming connections */
|
|
3646
|
-
session_id: string;
|
|
3654
|
+
readonly session_id: string;
|
|
3647
3655
|
/** Gateway URL for resuming connections */
|
|
3648
|
-
resume_gateway_url: string;
|
|
3656
|
+
readonly resume_gateway_url: string;
|
|
3649
3657
|
/** Shard information associated with this session, if sent when identifying */
|
|
3650
|
-
shard?: number[];
|
|
3658
|
+
readonly shard?: number[];
|
|
3651
3659
|
/** Contains id and flags */
|
|
3652
|
-
application: Application;
|
|
3660
|
+
readonly application: Application;
|
|
3653
3661
|
}
|
|
3654
3662
|
export type ReceiveEvent = HelloEvent | ReadyEvent | ResumedEvent | ReconnectEvent | InvalidSessionEvent | ApplicationCommandPermissionsUpdateEvent | AutoModerationRuleCreateEvent | AutoModerationRuleUpdateEvent | AutoModerationRuleDeleteEvent | AutoModerationActionExecutionEvent | ChannelCreateEvent | ChannelUpdateEvent | ChannelDeleteEvent | ChannelPinsUpdateEvent | ThreadCreateEvent | ThreadUpdateEvent | ThreadDeleteEvent | ThreadListSyncEvent | ThreadMemberUpdateEvent | ThreadMembersUpdateEvent | GuildCreateEvent | GuildUpdateEvent | GuildDeleteEvent | GuildAuditLogEntryCreateEvent | GuildBanAddEvent | GuildBanRemoveEvent | GuildEmojisUpdateEvent | GuildStickersUpdateEvent | GuildIntegrationsUpdateEvent | GuildMemberAddEvent | GuildMemberRemoveEvent | GuildMemberUpdateEvent | GuildMembersChunkEvent | GuildRoleCreateEvent | GuildRoleUpdateEvent | GuildRoleDeleteEvent | GuildScheduledEventCreateEvent | GuildScheduledEventUpdateEvent | GuildScheduledEventDeleteEvent | GuildScheduledEventUserAddEvent | GuildScheduledEventUserRemoveEvent | IntegrationCreateEvent | IntegrationUpdateEvent | IntegrationDeleteEvent | InteractionCreateEvent | InviteCreateEvent | InviteDeleteEvent | MessageCreateEvent | MessageUpdateEvent | MessageDeleteEvent | MessageDeleteBulkEvent | MessageReactionAddEvent | MessageReactionRemoveEvent | MessageReactionRemoveAllEvent | MessageReactionRemoveEmojiEvent | PresenceUpdateEvent | StageInstanceCreateEvent | StageInstanceUpdateEvent | StageInstanceDeleteEvent | TypingStartEvent | UserUpdateEvent | VoiceStateUpdateEvent | VoiceServerUpdateEvent | WebhooksUpdateEvent;
|
|
3655
3663
|
export interface ReceiveEvents {
|
|
@@ -3721,106 +3729,106 @@ export interface ReceiveEvents {
|
|
|
3721
3729
|
export type ReconnectEvent = null;
|
|
3722
3730
|
export interface RequestGuildMember {
|
|
3723
3731
|
/** ID of the guild to get members for */
|
|
3724
|
-
guild_id: Snowflake;
|
|
3732
|
+
readonly guild_id: Snowflake;
|
|
3725
3733
|
/** string that username starts with, or an empty string to return all members */
|
|
3726
|
-
query?: string;
|
|
3734
|
+
readonly query?: string;
|
|
3727
3735
|
/** maximum number of members to send matching the query; a limit of 0 can be used with an empty string query to return all members */
|
|
3728
|
-
limit: number;
|
|
3736
|
+
readonly limit: number;
|
|
3729
3737
|
/** used to specify if we want the presences of the matched members */
|
|
3730
|
-
presences?: boolean;
|
|
3738
|
+
readonly presences?: boolean;
|
|
3731
3739
|
/** used to specify which users you wish to fetch */
|
|
3732
|
-
user_ids?: Snowflake[];
|
|
3740
|
+
readonly user_ids?: Snowflake[];
|
|
3733
3741
|
/** nonce to identify the Guild Members Chunk response */
|
|
3734
|
-
nonce?: string;
|
|
3742
|
+
readonly nonce?: string;
|
|
3735
3743
|
}
|
|
3736
3744
|
export interface ResolvedDatum {
|
|
3737
3745
|
/** the ids and User objects */
|
|
3738
|
-
users?: Record<Snowflake, User>;
|
|
3746
|
+
readonly users?: Record<Snowflake, User>;
|
|
3739
3747
|
/** the ids and partial Member objects */
|
|
3740
|
-
members?: Record<Snowflake, GuildMember>;
|
|
3748
|
+
readonly members?: Record<Snowflake, GuildMember>;
|
|
3741
3749
|
/** the ids and Role objects */
|
|
3742
|
-
roles?: Record<Snowflake, Role>;
|
|
3750
|
+
readonly roles?: Record<Snowflake, Role>;
|
|
3743
3751
|
/** the ids and partial Channel objects */
|
|
3744
|
-
channels?: Record<Snowflake, Channel>;
|
|
3752
|
+
readonly channels?: Record<Snowflake, Channel>;
|
|
3745
3753
|
/** the ids and partial Message objects */
|
|
3746
|
-
messages?: Record<Snowflake, Message>;
|
|
3754
|
+
readonly messages?: Record<Snowflake, Message>;
|
|
3747
3755
|
/** the ids and attachment objects */
|
|
3748
|
-
attachments?: Record<Snowflake, Attachment>;
|
|
3756
|
+
readonly attachments?: Record<Snowflake, Attachment>;
|
|
3749
3757
|
}
|
|
3750
3758
|
export interface Response {
|
|
3751
3759
|
/** the current application */
|
|
3752
|
-
application: Application;
|
|
3760
|
+
readonly application: Application;
|
|
3753
3761
|
/** the scopes the user has authorized the application for */
|
|
3754
|
-
scopes: string[];
|
|
3762
|
+
readonly scopes: string[];
|
|
3755
3763
|
/** when the access token expires */
|
|
3756
|
-
expires: string;
|
|
3764
|
+
readonly expires: string;
|
|
3757
3765
|
/** the user who has authorized, if the user has authorized with the identify scope */
|
|
3758
|
-
user?: User;
|
|
3766
|
+
readonly user?: User;
|
|
3759
3767
|
}
|
|
3760
3768
|
export interface ResponseBody {
|
|
3761
3769
|
/** the public, archived threads */
|
|
3762
|
-
threads: Channel[];
|
|
3770
|
+
readonly threads: Channel[];
|
|
3763
3771
|
/** a thread member object for each returned thread the current user has joined */
|
|
3764
|
-
members: ThreadMember[];
|
|
3772
|
+
readonly members: ThreadMember[];
|
|
3765
3773
|
/** whether there are potentially additional threads that could be returned on a subsequent call */
|
|
3766
|
-
has_more: boolean;
|
|
3774
|
+
readonly has_more: boolean;
|
|
3767
3775
|
}
|
|
3768
3776
|
export interface Resume {
|
|
3769
3777
|
/** Session token */
|
|
3770
|
-
token: string;
|
|
3778
|
+
readonly token: string;
|
|
3771
3779
|
/** Session ID */
|
|
3772
|
-
session_id: string;
|
|
3780
|
+
readonly session_id: string;
|
|
3773
3781
|
/** Last sequence number received */
|
|
3774
|
-
seq: number;
|
|
3782
|
+
readonly seq: number;
|
|
3775
3783
|
}
|
|
3776
3784
|
export type ResumedEvent = null;
|
|
3777
3785
|
export interface Role {
|
|
3778
3786
|
/** role id */
|
|
3779
|
-
id: Snowflake;
|
|
3787
|
+
readonly id: Snowflake;
|
|
3780
3788
|
/** role name */
|
|
3781
|
-
name: string;
|
|
3789
|
+
readonly name: string;
|
|
3782
3790
|
/** integer representation of hexadecimal color code */
|
|
3783
|
-
color: number;
|
|
3791
|
+
readonly color: number;
|
|
3784
3792
|
/** if this role is pinned in the user listing */
|
|
3785
|
-
hoist: boolean;
|
|
3793
|
+
readonly hoist: boolean;
|
|
3786
3794
|
/** role icon hash */
|
|
3787
|
-
icon?: string | null;
|
|
3795
|
+
readonly icon?: string | null;
|
|
3788
3796
|
/** role unicode emoji */
|
|
3789
|
-
unicode_emoji?: string | null;
|
|
3797
|
+
readonly unicode_emoji?: string | null;
|
|
3790
3798
|
/** position of this role */
|
|
3791
|
-
position: number;
|
|
3799
|
+
readonly position: number;
|
|
3792
3800
|
/** permission bit set */
|
|
3793
|
-
permissions: string;
|
|
3801
|
+
readonly permissions: string;
|
|
3794
3802
|
/** whether this role is managed by an integration */
|
|
3795
|
-
managed: boolean;
|
|
3803
|
+
readonly managed: boolean;
|
|
3796
3804
|
/** whether this role is mentionable */
|
|
3797
|
-
mentionable: boolean;
|
|
3805
|
+
readonly mentionable: boolean;
|
|
3798
3806
|
/** the tags this role has */
|
|
3799
|
-
tags?: RoleTag;
|
|
3807
|
+
readonly tags?: RoleTag;
|
|
3800
3808
|
}
|
|
3801
3809
|
export interface RoleSubscriptionDatum {
|
|
3802
3810
|
/** the id of the sku and listing that the user is subscribed to */
|
|
3803
|
-
role_subscription_listing_id: Snowflake;
|
|
3811
|
+
readonly role_subscription_listing_id: Snowflake;
|
|
3804
3812
|
/** the name of the tier that the user is subscribed to */
|
|
3805
|
-
tier_name: string;
|
|
3813
|
+
readonly tier_name: string;
|
|
3806
3814
|
/** the cumulative number of months that the user has been subscribed for */
|
|
3807
|
-
total_months_subscribed: number;
|
|
3815
|
+
readonly total_months_subscribed: number;
|
|
3808
3816
|
/** whether this notification is for a renewal rather than a new purchase */
|
|
3809
|
-
is_renewal: boolean;
|
|
3817
|
+
readonly is_renewal: boolean;
|
|
3810
3818
|
}
|
|
3811
3819
|
export interface RoleTag {
|
|
3812
3820
|
/** the id of the bot this role belongs to */
|
|
3813
|
-
bot_id?: Snowflake;
|
|
3821
|
+
readonly bot_id?: Snowflake;
|
|
3814
3822
|
/** the id of the integration this role belongs to */
|
|
3815
|
-
integration_id?: Snowflake;
|
|
3823
|
+
readonly integration_id?: Snowflake;
|
|
3816
3824
|
/** whether this is the guild's Booster role */
|
|
3817
|
-
premium_subscriber?: null;
|
|
3825
|
+
readonly premium_subscriber?: null;
|
|
3818
3826
|
/** the id of this role's subscription sku and listing */
|
|
3819
|
-
subscription_listing_id?: Snowflake;
|
|
3827
|
+
readonly subscription_listing_id?: Snowflake;
|
|
3820
3828
|
/** whether this role is available for purchase */
|
|
3821
|
-
available_for_purchase?: null;
|
|
3829
|
+
readonly available_for_purchase?: null;
|
|
3822
3830
|
/** whether this role is a guild's linked role */
|
|
3823
|
-
guild_connections?: null;
|
|
3831
|
+
readonly guild_connections?: null;
|
|
3824
3832
|
}
|
|
3825
3833
|
export type Route<P, O> = {
|
|
3826
3834
|
method: string;
|
|
@@ -3830,39 +3838,39 @@ export type Route<P, O> = {
|
|
|
3830
3838
|
};
|
|
3831
3839
|
export interface SearchGuildMemberParams {
|
|
3832
3840
|
/** Query string to match username(s) and nickname(s) against. */
|
|
3833
|
-
query: string;
|
|
3841
|
+
readonly query: string;
|
|
3834
3842
|
/** max number of members to return (1-1000) */
|
|
3835
|
-
limit: number;
|
|
3843
|
+
readonly limit: number;
|
|
3836
3844
|
}
|
|
3837
3845
|
export interface SelectMenu {
|
|
3838
3846
|
/** Type of select menu component (text: 3, user: 5, role: 6, mentionable: 7, channels: 8) */
|
|
3839
|
-
type: ComponentType;
|
|
3847
|
+
readonly type: ComponentType;
|
|
3840
3848
|
/** ID for the select menu; max 100 characters */
|
|
3841
|
-
custom_id: string;
|
|
3849
|
+
readonly custom_id: string;
|
|
3842
3850
|
/** Specified choices in a select menu (only required and available for string selects (type 3); max 25 */
|
|
3843
|
-
options?: SelectOption[];
|
|
3851
|
+
readonly options?: SelectOption[];
|
|
3844
3852
|
/** List of channel types to include in the channel select component (type 8) */
|
|
3845
|
-
channel_types?: ChannelType[];
|
|
3853
|
+
readonly channel_types?: ChannelType[];
|
|
3846
3854
|
/** Placeholder text if nothing is selected; max 150 characters */
|
|
3847
|
-
placeholder?: string;
|
|
3855
|
+
readonly placeholder?: string;
|
|
3848
3856
|
/** Minimum number of items that must be chosen (defaults to 1); min 0, max 25 */
|
|
3849
|
-
min_values?: number;
|
|
3857
|
+
readonly min_values?: number;
|
|
3850
3858
|
/** Maximum number of items that can be chosen (defaults to 1); max 25 */
|
|
3851
|
-
max_values?: number;
|
|
3859
|
+
readonly max_values?: number;
|
|
3852
3860
|
/** Whether select menu is disabled (defaults to false) */
|
|
3853
|
-
disabled?: boolean;
|
|
3861
|
+
readonly disabled?: boolean;
|
|
3854
3862
|
}
|
|
3855
3863
|
export interface SelectOption {
|
|
3856
3864
|
/** User-facing name of the option; max 100 characters */
|
|
3857
|
-
label: string;
|
|
3865
|
+
readonly label: string;
|
|
3858
3866
|
/** Dev-defined value of the option; max 100 characters */
|
|
3859
|
-
value: string;
|
|
3867
|
+
readonly value: string;
|
|
3860
3868
|
/** Additional description of the option; max 100 characters */
|
|
3861
|
-
description?: string;
|
|
3869
|
+
readonly description?: string;
|
|
3862
3870
|
/** id, name, and animated */
|
|
3863
|
-
emoji?: Emoji;
|
|
3871
|
+
readonly emoji?: Emoji;
|
|
3864
3872
|
/** Will show this option as selected by default */
|
|
3865
|
-
default?: boolean;
|
|
3873
|
+
readonly default?: boolean;
|
|
3866
3874
|
}
|
|
3867
3875
|
export type SendEvent = Identify | Resume | Heartbeat | RequestGuildMember | UpdateVoiceState | UpdatePresence;
|
|
3868
3876
|
export interface SendEvents {
|
|
@@ -3875,13 +3883,13 @@ export interface SendEvents {
|
|
|
3875
3883
|
}
|
|
3876
3884
|
export interface SessionStartLimit {
|
|
3877
3885
|
/** Total number of session starts the current user is allowed */
|
|
3878
|
-
total: number;
|
|
3886
|
+
readonly total: number;
|
|
3879
3887
|
/** Remaining number of session starts the current user is allowed */
|
|
3880
|
-
remaining: number;
|
|
3888
|
+
readonly remaining: number;
|
|
3881
3889
|
/** Number of milliseconds after which the limit resets */
|
|
3882
|
-
reset_after: number;
|
|
3890
|
+
readonly reset_after: number;
|
|
3883
3891
|
/** Number of identify requests allowed per 5 seconds */
|
|
3884
|
-
max_concurrency: number;
|
|
3892
|
+
readonly max_concurrency: number;
|
|
3885
3893
|
}
|
|
3886
3894
|
export type Snowflake = `${bigint}`;
|
|
3887
3895
|
export declare const enum SortOrderType {
|
|
@@ -3892,74 +3900,74 @@ export declare const enum SortOrderType {
|
|
|
3892
3900
|
}
|
|
3893
3901
|
export interface StageInstance {
|
|
3894
3902
|
/** The id of this Stage instance */
|
|
3895
|
-
id: Snowflake;
|
|
3903
|
+
readonly id: Snowflake;
|
|
3896
3904
|
/** The guild id of the associated Stage channel */
|
|
3897
|
-
guild_id: Snowflake;
|
|
3905
|
+
readonly guild_id: Snowflake;
|
|
3898
3906
|
/** The id of the associated Stage channel */
|
|
3899
|
-
channel_id: Snowflake;
|
|
3907
|
+
readonly channel_id: Snowflake;
|
|
3900
3908
|
/** The topic of the Stage instance (1-120 characters) */
|
|
3901
|
-
topic: string;
|
|
3909
|
+
readonly topic: string;
|
|
3902
3910
|
/** The privacy level of the Stage instance */
|
|
3903
|
-
privacy_level: PrivacyLevel;
|
|
3911
|
+
readonly privacy_level: PrivacyLevel;
|
|
3904
3912
|
/** Whether or not Stage Discovery is disabled (deprecated) */
|
|
3905
|
-
discoverable_disabled: boolean;
|
|
3913
|
+
readonly discoverable_disabled: boolean;
|
|
3906
3914
|
/** The id of the scheduled event for this Stage instance */
|
|
3907
|
-
guild_scheduled_event_id?: Snowflake | null;
|
|
3915
|
+
readonly guild_scheduled_event_id?: Snowflake | null;
|
|
3908
3916
|
}
|
|
3909
3917
|
export type StageInstanceCreateEvent = StageInstance;
|
|
3910
3918
|
export type StageInstanceDeleteEvent = StageInstance;
|
|
3911
3919
|
export type StageInstanceUpdateEvent = StageInstance;
|
|
3912
3920
|
export interface StartThreadFromMessageParams {
|
|
3913
3921
|
/** 1-100 character channel name */
|
|
3914
|
-
name: string;
|
|
3922
|
+
readonly name: string;
|
|
3915
3923
|
/** the thread will stop showing in the channel list after auto_archive_duration minutes of inactivity, can be set to: 60, 1440, 4320, 10080 */
|
|
3916
|
-
auto_archive_duration?: number;
|
|
3924
|
+
readonly auto_archive_duration?: number;
|
|
3917
3925
|
/** amount of seconds a user has to wait before sending another message (0-21600) */
|
|
3918
|
-
rate_limit_per_user?: number | null;
|
|
3926
|
+
readonly rate_limit_per_user?: number | null;
|
|
3919
3927
|
}
|
|
3920
3928
|
export interface StartThreadInForumChannelForumThreadMessageParams {
|
|
3921
3929
|
/** Message contents (up to 2000 characters) */
|
|
3922
|
-
content?: string;
|
|
3930
|
+
readonly content?: string;
|
|
3923
3931
|
/** Up to 10 rich embeds (up to 6000 characters) */
|
|
3924
|
-
embeds?: Embed[];
|
|
3932
|
+
readonly embeds?: Embed[];
|
|
3925
3933
|
/** Allowed mentions for the message */
|
|
3926
|
-
allowed_mentions?: AllowedMention;
|
|
3934
|
+
readonly allowed_mentions?: AllowedMention;
|
|
3927
3935
|
/** Components to include with the message */
|
|
3928
|
-
components?: Component[];
|
|
3936
|
+
readonly components?: Component[];
|
|
3929
3937
|
/** IDs of up to 3 stickers in the server to send in the message */
|
|
3930
|
-
sticker_ids?: Snowflake[];
|
|
3938
|
+
readonly sticker_ids?: Snowflake[];
|
|
3931
3939
|
/** Contents of the file being sent. See Uploading Files */
|
|
3932
|
-
files: string;
|
|
3940
|
+
readonly files: string;
|
|
3933
3941
|
/** JSON-encoded body of non-file params, only for multipart/form-data requests. See Uploading Files */
|
|
3934
|
-
payload_json?: string;
|
|
3942
|
+
readonly payload_json?: string;
|
|
3935
3943
|
/** Attachment objects with filename and description. See Uploading Files */
|
|
3936
|
-
attachments?: Attachment[];
|
|
3944
|
+
readonly attachments?: Attachment[];
|
|
3937
3945
|
/** Message flags combined as a bitfield (only SUPPRESS_EMBEDS and SUPPRESS_NOTIFICATIONS can be set) */
|
|
3938
|
-
flags?: number;
|
|
3946
|
+
readonly flags?: number;
|
|
3939
3947
|
}
|
|
3940
3948
|
export interface StartThreadInForumChannelParams {
|
|
3941
3949
|
/** 1-100 character channel name */
|
|
3942
|
-
name: string;
|
|
3950
|
+
readonly name: string;
|
|
3943
3951
|
/** duration in minutes to automatically archive the thread after recent activity, can be set to: 60, 1440, 4320, 10080 */
|
|
3944
|
-
auto_archive_duration?: number;
|
|
3952
|
+
readonly auto_archive_duration?: number;
|
|
3945
3953
|
/** amount of seconds a user has to wait before sending another message (0-21600) */
|
|
3946
|
-
rate_limit_per_user?: number | null;
|
|
3954
|
+
readonly rate_limit_per_user?: number | null;
|
|
3947
3955
|
/** contents of the first message in the forum thread */
|
|
3948
|
-
message: StartThreadInForumChannelForumThreadMessageParams;
|
|
3956
|
+
readonly message: StartThreadInForumChannelForumThreadMessageParams;
|
|
3949
3957
|
/** the IDs of the set of tags that have been applied to a thread in a GUILD_FORUM channel */
|
|
3950
|
-
applied_tags?: Snowflake[];
|
|
3958
|
+
readonly applied_tags?: Snowflake[];
|
|
3951
3959
|
}
|
|
3952
3960
|
export interface StartThreadWithoutMessageParams {
|
|
3953
3961
|
/** 1-100 character channel name */
|
|
3954
|
-
name: string;
|
|
3962
|
+
readonly name: string;
|
|
3955
3963
|
/** the thread will stop showing in the channel list after auto_archive_duration minutes of inactivity, can be set to: 60, 1440, 4320, 10080 */
|
|
3956
|
-
auto_archive_duration?: number;
|
|
3964
|
+
readonly auto_archive_duration?: number;
|
|
3957
3965
|
/** the type of thread to create */
|
|
3958
|
-
type?: ChannelType;
|
|
3966
|
+
readonly type?: ChannelType;
|
|
3959
3967
|
/** whether non-moderators can add other non-moderators to a thread; only available when creating a private thread */
|
|
3960
|
-
invitable?: boolean;
|
|
3968
|
+
readonly invitable?: boolean;
|
|
3961
3969
|
/** amount of seconds a user has to wait before sending another message (0-21600) */
|
|
3962
|
-
rate_limit_per_user?: number | null;
|
|
3970
|
+
readonly rate_limit_per_user?: number | null;
|
|
3963
3971
|
}
|
|
3964
3972
|
export declare const enum StatusType {
|
|
3965
3973
|
/** Online */
|
|
@@ -3975,29 +3983,29 @@ export declare const enum StatusType {
|
|
|
3975
3983
|
}
|
|
3976
3984
|
export interface Sticker {
|
|
3977
3985
|
/** id of the sticker */
|
|
3978
|
-
id: Snowflake;
|
|
3986
|
+
readonly id: Snowflake;
|
|
3979
3987
|
/** for standard stickers, id of the pack the sticker is from */
|
|
3980
|
-
pack_id?: Snowflake;
|
|
3988
|
+
readonly pack_id?: Snowflake;
|
|
3981
3989
|
/** name of the sticker */
|
|
3982
|
-
name: string;
|
|
3990
|
+
readonly name: string;
|
|
3983
3991
|
/** description of the sticker */
|
|
3984
|
-
description?: string | null;
|
|
3992
|
+
readonly description?: string | null;
|
|
3985
3993
|
/** autocomplete/suggestion tags for the sticker (max 200 characters) */
|
|
3986
|
-
tags: string;
|
|
3994
|
+
readonly tags: string;
|
|
3987
3995
|
/** Deprecated previously the sticker asset hash, now an empty string */
|
|
3988
|
-
asset?: string;
|
|
3996
|
+
readonly asset?: string;
|
|
3989
3997
|
/** type of sticker */
|
|
3990
|
-
type: StickerType;
|
|
3998
|
+
readonly type: StickerType;
|
|
3991
3999
|
/** type of sticker format */
|
|
3992
|
-
format_type: StickerFormatType;
|
|
4000
|
+
readonly format_type: StickerFormatType;
|
|
3993
4001
|
/** whether this guild sticker can be used, may be false due to loss of Server Boosts */
|
|
3994
|
-
available?: boolean;
|
|
4002
|
+
readonly available?: boolean;
|
|
3995
4003
|
/** id of the guild that owns this sticker */
|
|
3996
|
-
guild_id?: Snowflake;
|
|
4004
|
+
readonly guild_id?: Snowflake;
|
|
3997
4005
|
/** the user that uploaded the guild sticker */
|
|
3998
|
-
user?: User;
|
|
4006
|
+
readonly user?: User;
|
|
3999
4007
|
/** the standard sticker's sort order within its pack */
|
|
4000
|
-
sort_value?: number;
|
|
4008
|
+
readonly sort_value?: number;
|
|
4001
4009
|
}
|
|
4002
4010
|
export declare const enum StickerFormatType {
|
|
4003
4011
|
PNG = 1,
|
|
@@ -4007,27 +4015,27 @@ export declare const enum StickerFormatType {
|
|
|
4007
4015
|
}
|
|
4008
4016
|
export interface StickerItem {
|
|
4009
4017
|
/** id of the sticker */
|
|
4010
|
-
id: Snowflake;
|
|
4018
|
+
readonly id: Snowflake;
|
|
4011
4019
|
/** name of the sticker */
|
|
4012
|
-
name: string;
|
|
4020
|
+
readonly name: string;
|
|
4013
4021
|
/** type of sticker format */
|
|
4014
|
-
format_type: StickerFormatType;
|
|
4022
|
+
readonly format_type: StickerFormatType;
|
|
4015
4023
|
}
|
|
4016
4024
|
export interface StickerPack {
|
|
4017
4025
|
/** id of the sticker pack */
|
|
4018
|
-
id: Snowflake;
|
|
4026
|
+
readonly id: Snowflake;
|
|
4019
4027
|
/** the stickers in the pack */
|
|
4020
|
-
stickers: Sticker[];
|
|
4028
|
+
readonly stickers: Sticker[];
|
|
4021
4029
|
/** name of the sticker pack */
|
|
4022
|
-
name: string;
|
|
4030
|
+
readonly name: string;
|
|
4023
4031
|
/** id of the pack's SKU */
|
|
4024
|
-
sku_id: Snowflake;
|
|
4032
|
+
readonly sku_id: Snowflake;
|
|
4025
4033
|
/** id of a sticker in the pack which is shown as the pack's icon */
|
|
4026
|
-
cover_sticker_id?: Snowflake;
|
|
4034
|
+
readonly cover_sticker_id?: Snowflake;
|
|
4027
4035
|
/** description of the sticker pack */
|
|
4028
|
-
description: string;
|
|
4036
|
+
readonly description: string;
|
|
4029
4037
|
/** id of the sticker pack's banner image */
|
|
4030
|
-
banner_asset_id?: Snowflake;
|
|
4038
|
+
readonly banner_asset_id?: Snowflake;
|
|
4031
4039
|
}
|
|
4032
4040
|
export declare const enum StickerType {
|
|
4033
4041
|
/** an official sticker in a pack, part of Nitro or in a removed purchasable pack */
|
|
@@ -4051,45 +4059,45 @@ export declare const SystemChannelFlag: {
|
|
|
4051
4059
|
};
|
|
4052
4060
|
export interface Team {
|
|
4053
4061
|
/** a hash of the image of the team's icon */
|
|
4054
|
-
icon?: string | null;
|
|
4062
|
+
readonly icon?: string | null;
|
|
4055
4063
|
/** the unique id of the team */
|
|
4056
|
-
id: Snowflake;
|
|
4064
|
+
readonly id: Snowflake;
|
|
4057
4065
|
/** the members of the team */
|
|
4058
|
-
members: TeamMember[];
|
|
4066
|
+
readonly members: TeamMember[];
|
|
4059
4067
|
/** the name of the team */
|
|
4060
|
-
name: string;
|
|
4068
|
+
readonly name: string;
|
|
4061
4069
|
/** the user id of the current team owner */
|
|
4062
|
-
owner_user_id: Snowflake;
|
|
4070
|
+
readonly owner_user_id: Snowflake;
|
|
4063
4071
|
}
|
|
4064
4072
|
export interface TeamMember {
|
|
4065
4073
|
/** the user's membership state on the team */
|
|
4066
|
-
membership_state: MembershipState;
|
|
4074
|
+
readonly membership_state: MembershipState;
|
|
4067
4075
|
/** will always be ["*"] */
|
|
4068
|
-
permissions: string[];
|
|
4076
|
+
readonly permissions: string[];
|
|
4069
4077
|
/** the id of the parent team of which they are a member */
|
|
4070
|
-
team_id: Snowflake;
|
|
4078
|
+
readonly team_id: Snowflake;
|
|
4071
4079
|
/** the avatar, discriminator, id, and username of the user */
|
|
4072
|
-
user: User;
|
|
4080
|
+
readonly user: User;
|
|
4073
4081
|
}
|
|
4074
4082
|
export interface TextInput {
|
|
4075
4083
|
/** 4 for a text input */
|
|
4076
|
-
type: number;
|
|
4084
|
+
readonly type: number;
|
|
4077
4085
|
/** Developer-defined identifier for the input; max 100 characters */
|
|
4078
|
-
custom_id: string;
|
|
4086
|
+
readonly custom_id: string;
|
|
4079
4087
|
/** The Text Input Style */
|
|
4080
|
-
style: TextInputStyle;
|
|
4088
|
+
readonly style: TextInputStyle;
|
|
4081
4089
|
/** Label for this component; max 45 characters */
|
|
4082
|
-
label: string;
|
|
4090
|
+
readonly label: string;
|
|
4083
4091
|
/** Minimum input length for a text input; min 0, max 4000 */
|
|
4084
|
-
min_length?: number;
|
|
4092
|
+
readonly min_length?: number;
|
|
4085
4093
|
/** Maximum input length for a text input; min 1, max 4000 */
|
|
4086
|
-
max_length?: number;
|
|
4094
|
+
readonly max_length?: number;
|
|
4087
4095
|
/** Whether this component is required to be filled (defaults to true) */
|
|
4088
|
-
required?: boolean;
|
|
4096
|
+
readonly required?: boolean;
|
|
4089
4097
|
/** Pre-filled value for this component; max 4000 characters */
|
|
4090
|
-
value?: string;
|
|
4098
|
+
readonly value?: string;
|
|
4091
4099
|
/** Custom placeholder text if the input is empty; max 100 characters */
|
|
4092
|
-
placeholder?: string;
|
|
4100
|
+
readonly placeholder?: string;
|
|
4093
4101
|
}
|
|
4094
4102
|
export declare const enum TextInputStyle {
|
|
4095
4103
|
/** Single-line input */
|
|
@@ -4101,69 +4109,69 @@ export type ThreadCreateEvent = Channel;
|
|
|
4101
4109
|
export type ThreadDeleteEvent = Channel;
|
|
4102
4110
|
export interface ThreadListSyncEvent {
|
|
4103
4111
|
/** ID of the guild */
|
|
4104
|
-
guild_id: Snowflake;
|
|
4112
|
+
readonly guild_id: Snowflake;
|
|
4105
4113
|
/** Parent channel IDs whose threads are being synced. If omitted, then threads were synced for the entire guild. This array may contain channel_ids that have no active threads as well, so you know to clear that data. */
|
|
4106
|
-
channel_ids?: Snowflake[];
|
|
4114
|
+
readonly channel_ids?: Snowflake[];
|
|
4107
4115
|
/** All active threads in the given channels that the current user can access */
|
|
4108
|
-
threads: Channel[];
|
|
4116
|
+
readonly threads: Channel[];
|
|
4109
4117
|
/** All thread member objects from the synced threads for the current user, indicating which threads the current user has been added to */
|
|
4110
|
-
members: ThreadMember[];
|
|
4118
|
+
readonly members: ThreadMember[];
|
|
4111
4119
|
}
|
|
4112
4120
|
export interface ThreadMember {
|
|
4113
4121
|
/** ID of the thread */
|
|
4114
|
-
id?: Snowflake;
|
|
4122
|
+
readonly id?: Snowflake;
|
|
4115
4123
|
/** ID of the user */
|
|
4116
|
-
user_id?: Snowflake;
|
|
4124
|
+
readonly user_id?: Snowflake;
|
|
4117
4125
|
/** Time the user last joined the thread */
|
|
4118
|
-
join_timestamp: string;
|
|
4126
|
+
readonly join_timestamp: string;
|
|
4119
4127
|
/** Any user-thread settings, currently only used for notifications */
|
|
4120
|
-
flags: number;
|
|
4128
|
+
readonly flags: number;
|
|
4121
4129
|
/** Additional information about the user */
|
|
4122
|
-
member?: GuildMember;
|
|
4130
|
+
readonly member?: GuildMember;
|
|
4123
4131
|
}
|
|
4124
4132
|
export interface ThreadMembersUpdateEvent {
|
|
4125
4133
|
/** ID of the thread */
|
|
4126
|
-
id: Snowflake;
|
|
4134
|
+
readonly id: Snowflake;
|
|
4127
4135
|
/** ID of the guild */
|
|
4128
|
-
guild_id: Snowflake;
|
|
4136
|
+
readonly guild_id: Snowflake;
|
|
4129
4137
|
/** Approximate number of members in the thread, capped at 50 */
|
|
4130
|
-
member_count: number;
|
|
4138
|
+
readonly member_count: number;
|
|
4131
4139
|
/** Users who were added to the thread */
|
|
4132
|
-
added_members?: ThreadMember[];
|
|
4140
|
+
readonly added_members?: ThreadMember[];
|
|
4133
4141
|
/** ID of the users who were removed from the thread */
|
|
4134
|
-
removed_member_ids?: Snowflake[];
|
|
4142
|
+
readonly removed_member_ids?: Snowflake[];
|
|
4135
4143
|
}
|
|
4136
4144
|
export type ThreadMemberUpdateEvent = ThreadMember;
|
|
4137
4145
|
export interface ThreadMemberUpdateEventExtra {
|
|
4138
4146
|
/** ID of the guild */
|
|
4139
|
-
guild_id: Snowflake;
|
|
4147
|
+
readonly guild_id: Snowflake;
|
|
4140
4148
|
}
|
|
4141
4149
|
export interface ThreadMetadatum {
|
|
4142
4150
|
/** whether the thread is archived */
|
|
4143
|
-
archived: boolean;
|
|
4151
|
+
readonly archived: boolean;
|
|
4144
4152
|
/** the thread will stop showing in the channel list after auto_archive_duration minutes of inactivity, can be set to: 60, 1440, 4320, 10080 */
|
|
4145
|
-
auto_archive_duration: number;
|
|
4153
|
+
readonly auto_archive_duration: number;
|
|
4146
4154
|
/** timestamp when the thread's archive status was last changed, used for calculating recent activity */
|
|
4147
|
-
archive_timestamp: string;
|
|
4155
|
+
readonly archive_timestamp: string;
|
|
4148
4156
|
/** whether the thread is locked; when a thread is locked, only users with MANAGE_THREADS can unarchive it */
|
|
4149
|
-
locked: boolean;
|
|
4157
|
+
readonly locked: boolean;
|
|
4150
4158
|
/** whether non-moderators can add other non-moderators to a thread; only available on private threads */
|
|
4151
|
-
invitable?: boolean;
|
|
4159
|
+
readonly invitable?: boolean;
|
|
4152
4160
|
/** timestamp when the thread was created; only populated for threads created after 2022-01-09 */
|
|
4153
|
-
create_timestamp?: string | null;
|
|
4161
|
+
readonly create_timestamp?: string | null;
|
|
4154
4162
|
}
|
|
4155
4163
|
export type ThreadUpdateEvent = Channel;
|
|
4156
4164
|
export interface TriggerMetadatum {
|
|
4157
4165
|
/** KEYWORD */
|
|
4158
|
-
keyword_filter: string[];
|
|
4166
|
+
readonly keyword_filter: string[];
|
|
4159
4167
|
/** KEYWORD */
|
|
4160
|
-
regex_patterns: string[];
|
|
4168
|
+
readonly regex_patterns: string[];
|
|
4161
4169
|
/** KEYWORD_PRESET */
|
|
4162
|
-
presets: KeywordPresetType[];
|
|
4170
|
+
readonly presets: KeywordPresetType[];
|
|
4163
4171
|
/** KEYWORD, KEYWORD_PRESET */
|
|
4164
|
-
allow_list: string[];
|
|
4172
|
+
readonly allow_list: string[];
|
|
4165
4173
|
/** MENTION_SPAM */
|
|
4166
|
-
mention_total_limit: number;
|
|
4174
|
+
readonly mention_total_limit: number;
|
|
4167
4175
|
}
|
|
4168
4176
|
export declare const enum TriggerType {
|
|
4169
4177
|
/** check if content contains words from a user defined list of keywords */
|
|
@@ -4177,81 +4185,81 @@ export declare const enum TriggerType {
|
|
|
4177
4185
|
}
|
|
4178
4186
|
export interface TypingStartEvent {
|
|
4179
4187
|
/** ID of the channel */
|
|
4180
|
-
channel_id: Snowflake;
|
|
4188
|
+
readonly channel_id: Snowflake;
|
|
4181
4189
|
/** ID of the guild */
|
|
4182
|
-
guild_id?: Snowflake;
|
|
4190
|
+
readonly guild_id?: Snowflake;
|
|
4183
4191
|
/** ID of the user */
|
|
4184
|
-
user_id: Snowflake;
|
|
4192
|
+
readonly user_id: Snowflake;
|
|
4185
4193
|
/** Unix time (in seconds) of when the user started typing */
|
|
4186
|
-
timestamp: number;
|
|
4194
|
+
readonly timestamp: number;
|
|
4187
4195
|
/** Member who started typing if this happened in a guild */
|
|
4188
|
-
member?: GuildMember;
|
|
4196
|
+
readonly member?: GuildMember;
|
|
4189
4197
|
}
|
|
4190
4198
|
export interface UnavailableGuild {
|
|
4191
4199
|
/** */
|
|
4192
|
-
id: Snowflake;
|
|
4200
|
+
readonly id: Snowflake;
|
|
4193
4201
|
/** */
|
|
4194
|
-
unavailable: boolean;
|
|
4202
|
+
readonly unavailable: boolean;
|
|
4195
4203
|
}
|
|
4196
4204
|
export interface UpdatePresence {
|
|
4197
4205
|
/** Unix time (in milliseconds) of when the client went idle, or null if the client is not idle */
|
|
4198
|
-
since?: number | null;
|
|
4206
|
+
readonly since?: number | null;
|
|
4199
4207
|
/** User's activities */
|
|
4200
|
-
activities: Activity[];
|
|
4208
|
+
readonly activities: Activity[];
|
|
4201
4209
|
/** User's new status */
|
|
4202
|
-
status: StatusType;
|
|
4210
|
+
readonly status: StatusType;
|
|
4203
4211
|
/** Whether or not the client is afk */
|
|
4204
|
-
afk: boolean;
|
|
4212
|
+
readonly afk: boolean;
|
|
4205
4213
|
}
|
|
4206
4214
|
export interface UpdateUserApplicationRoleConnectionParams {
|
|
4207
4215
|
/** the vanity name of the platform a bot has connected (max 50 characters) */
|
|
4208
|
-
platform_name?: string;
|
|
4216
|
+
readonly platform_name?: string;
|
|
4209
4217
|
/** the username on the platform a bot has connected (max 100 characters) */
|
|
4210
|
-
platform_username?: string;
|
|
4218
|
+
readonly platform_username?: string;
|
|
4211
4219
|
/** object mapping application role connection metadata keys to their string-ified value (max 100 characters) for the user on the platform a bot has connected */
|
|
4212
|
-
metadata?: ApplicationRoleConnectionMetadatum;
|
|
4220
|
+
readonly metadata?: ApplicationRoleConnectionMetadatum;
|
|
4213
4221
|
}
|
|
4214
4222
|
export interface UpdateVoiceState {
|
|
4215
4223
|
/** ID of the guild */
|
|
4216
|
-
guild_id: Snowflake;
|
|
4224
|
+
readonly guild_id: Snowflake;
|
|
4217
4225
|
/** ID of the voice channel client wants to join (null if disconnecting) */
|
|
4218
|
-
channel_id?: Snowflake | null;
|
|
4226
|
+
readonly channel_id?: Snowflake | null;
|
|
4219
4227
|
/** Whether the client is muted */
|
|
4220
|
-
self_mute: boolean;
|
|
4228
|
+
readonly self_mute: boolean;
|
|
4221
4229
|
/** Whether the client deafened */
|
|
4222
|
-
self_deaf: boolean;
|
|
4230
|
+
readonly self_deaf: boolean;
|
|
4223
4231
|
}
|
|
4224
4232
|
export interface User {
|
|
4225
4233
|
/** the user's id */
|
|
4226
|
-
id: Snowflake;
|
|
4234
|
+
readonly id: Snowflake;
|
|
4227
4235
|
/** the user's username, not unique across the platform */
|
|
4228
|
-
username: string;
|
|
4236
|
+
readonly username: string;
|
|
4229
4237
|
/** the user's 4-digit discord-tag */
|
|
4230
|
-
discriminator: string;
|
|
4238
|
+
readonly discriminator: string;
|
|
4231
4239
|
/** the user's avatar hash */
|
|
4232
|
-
avatar?: string | null;
|
|
4240
|
+
readonly avatar?: string | null;
|
|
4233
4241
|
/** whether the user belongs to an OAuth2 application */
|
|
4234
|
-
bot?: boolean;
|
|
4242
|
+
readonly bot?: boolean;
|
|
4235
4243
|
/** whether the user is an Official Discord System user (part of the urgent message system) */
|
|
4236
|
-
system?: boolean;
|
|
4244
|
+
readonly system?: boolean;
|
|
4237
4245
|
/** whether the user has two factor enabled on their account */
|
|
4238
|
-
mfa_enabled?: boolean;
|
|
4246
|
+
readonly mfa_enabled?: boolean;
|
|
4239
4247
|
/** the user's banner hash */
|
|
4240
|
-
banner?: string | null;
|
|
4248
|
+
readonly banner?: string | null;
|
|
4241
4249
|
/** the user's banner color encoded as an integer representation of hexadecimal color code */
|
|
4242
|
-
accent_color?: number | null;
|
|
4250
|
+
readonly accent_color?: number | null;
|
|
4243
4251
|
/** the user's chosen language option */
|
|
4244
|
-
locale?: string;
|
|
4252
|
+
readonly locale?: string;
|
|
4245
4253
|
/** whether the email on this account has been verified */
|
|
4246
|
-
verified?: boolean;
|
|
4254
|
+
readonly verified?: boolean;
|
|
4247
4255
|
/** the user's email */
|
|
4248
|
-
email?: string | null;
|
|
4256
|
+
readonly email?: string | null;
|
|
4249
4257
|
/** the flags on a user's account */
|
|
4250
|
-
flags?: number;
|
|
4258
|
+
readonly flags?: number;
|
|
4251
4259
|
/** the type of Nitro subscription on a user's account */
|
|
4252
|
-
premium_type?: PremiumType;
|
|
4260
|
+
readonly premium_type?: PremiumType;
|
|
4253
4261
|
/** the public flags on a user's account */
|
|
4254
|
-
public_flags?: number;
|
|
4262
|
+
readonly public_flags?: number;
|
|
4255
4263
|
}
|
|
4256
4264
|
export declare const UserFlag: {
|
|
4257
4265
|
/** Discord Employee */
|
|
@@ -4336,84 +4344,84 @@ export declare const enum VoiceOpcode {
|
|
|
4336
4344
|
}
|
|
4337
4345
|
export interface VoiceRegion {
|
|
4338
4346
|
/** unique ID for the region */
|
|
4339
|
-
id: string;
|
|
4347
|
+
readonly id: string;
|
|
4340
4348
|
/** name of the region */
|
|
4341
|
-
name: string;
|
|
4349
|
+
readonly name: string;
|
|
4342
4350
|
/** true for a single server that is closest to the current user's client */
|
|
4343
|
-
optimal: boolean;
|
|
4351
|
+
readonly optimal: boolean;
|
|
4344
4352
|
/** whether this is a deprecated voice region (avoid switching to these) */
|
|
4345
|
-
deprecated: boolean;
|
|
4353
|
+
readonly deprecated: boolean;
|
|
4346
4354
|
/** whether this is a custom voice region (used for events/etc) */
|
|
4347
|
-
custom: boolean;
|
|
4355
|
+
readonly custom: boolean;
|
|
4348
4356
|
}
|
|
4349
4357
|
export interface VoiceServerUpdateEvent {
|
|
4350
4358
|
/** Voice connection token */
|
|
4351
|
-
token: string;
|
|
4359
|
+
readonly token: string;
|
|
4352
4360
|
/** Guild this voice server update is for */
|
|
4353
|
-
guild_id: Snowflake;
|
|
4361
|
+
readonly guild_id: Snowflake;
|
|
4354
4362
|
/** Voice server host */
|
|
4355
|
-
endpoint?: string | null;
|
|
4363
|
+
readonly endpoint?: string | null;
|
|
4356
4364
|
}
|
|
4357
4365
|
export interface VoiceState {
|
|
4358
4366
|
/** the guild id this voice state is for */
|
|
4359
|
-
guild_id?: Snowflake;
|
|
4367
|
+
readonly guild_id?: Snowflake;
|
|
4360
4368
|
/** the channel id this user is connected to */
|
|
4361
|
-
channel_id?: Snowflake | null;
|
|
4369
|
+
readonly channel_id?: Snowflake | null;
|
|
4362
4370
|
/** the user id this voice state is for */
|
|
4363
|
-
user_id: Snowflake;
|
|
4371
|
+
readonly user_id: Snowflake;
|
|
4364
4372
|
/** the guild member this voice state is for */
|
|
4365
|
-
member?: GuildMember;
|
|
4373
|
+
readonly member?: GuildMember;
|
|
4366
4374
|
/** the session id for this voice state */
|
|
4367
|
-
session_id: string;
|
|
4375
|
+
readonly session_id: string;
|
|
4368
4376
|
/** whether this user is deafened by the server */
|
|
4369
|
-
deaf: boolean;
|
|
4377
|
+
readonly deaf: boolean;
|
|
4370
4378
|
/** whether this user is muted by the server */
|
|
4371
|
-
mute: boolean;
|
|
4379
|
+
readonly mute: boolean;
|
|
4372
4380
|
/** whether this user is locally deafened */
|
|
4373
|
-
self_deaf: boolean;
|
|
4381
|
+
readonly self_deaf: boolean;
|
|
4374
4382
|
/** whether this user is locally muted */
|
|
4375
|
-
self_mute: boolean;
|
|
4383
|
+
readonly self_mute: boolean;
|
|
4376
4384
|
/** whether this user is streaming using "Go Live" */
|
|
4377
|
-
self_stream?: boolean;
|
|
4385
|
+
readonly self_stream?: boolean;
|
|
4378
4386
|
/** whether this user's camera is enabled */
|
|
4379
|
-
self_video: boolean;
|
|
4387
|
+
readonly self_video: boolean;
|
|
4380
4388
|
/** whether this user's permission to speak is denied */
|
|
4381
|
-
suppress: boolean;
|
|
4389
|
+
readonly suppress: boolean;
|
|
4382
4390
|
/** the time at which the user requested to speak */
|
|
4383
|
-
request_to_speak_timestamp?: string | null;
|
|
4391
|
+
readonly request_to_speak_timestamp?: string | null;
|
|
4384
4392
|
}
|
|
4385
4393
|
export type VoiceStateUpdateEvent = VoiceState;
|
|
4386
4394
|
export interface Webhook {
|
|
4387
4395
|
/** the id of the webhook */
|
|
4388
|
-
id: Snowflake;
|
|
4396
|
+
readonly id: Snowflake;
|
|
4389
4397
|
/** the type of the webhook */
|
|
4390
|
-
type: WebhookType;
|
|
4398
|
+
readonly type: WebhookType;
|
|
4391
4399
|
/** the guild id this webhook is for, if any */
|
|
4392
|
-
guild_id?: Snowflake | null;
|
|
4400
|
+
readonly guild_id?: Snowflake | null;
|
|
4393
4401
|
/** the channel id this webhook is for, if any */
|
|
4394
|
-
channel_id?: Snowflake | null;
|
|
4402
|
+
readonly channel_id?: Snowflake | null;
|
|
4395
4403
|
/** the user this webhook was created by (not returned when getting a webhook with its token) */
|
|
4396
|
-
user?: User;
|
|
4404
|
+
readonly user?: User;
|
|
4397
4405
|
/** the default name of the webhook */
|
|
4398
|
-
name?: string | null;
|
|
4406
|
+
readonly name?: string | null;
|
|
4399
4407
|
/** the default user avatar hash of the webhook */
|
|
4400
|
-
avatar?: string | null;
|
|
4408
|
+
readonly avatar?: string | null;
|
|
4401
4409
|
/** the secure token of the webhook (returned for Incoming Webhooks) */
|
|
4402
|
-
token?: string;
|
|
4410
|
+
readonly token?: string;
|
|
4403
4411
|
/** the bot/OAuth2 application that created this webhook */
|
|
4404
|
-
application_id?: Snowflake | null;
|
|
4412
|
+
readonly application_id?: Snowflake | null;
|
|
4405
4413
|
/** the guild of the channel that this webhook is following (returned for Channel Follower Webhooks) */
|
|
4406
|
-
source_guild?: Guild;
|
|
4414
|
+
readonly source_guild?: Guild;
|
|
4407
4415
|
/** the channel that this webhook is following (returned for Channel Follower Webhooks) */
|
|
4408
|
-
source_channel?: Channel;
|
|
4416
|
+
readonly source_channel?: Channel;
|
|
4409
4417
|
/** the url used for executing the webhook (returned by the webhooks OAuth2 flow) */
|
|
4410
|
-
url?: string;
|
|
4418
|
+
readonly url?: string;
|
|
4411
4419
|
}
|
|
4412
4420
|
export interface WebhooksUpdateEvent {
|
|
4413
4421
|
/** ID of the guild */
|
|
4414
|
-
guild_id: Snowflake;
|
|
4422
|
+
readonly guild_id: Snowflake;
|
|
4415
4423
|
/** ID of the channel */
|
|
4416
|
-
channel_id: Snowflake;
|
|
4424
|
+
readonly channel_id: Snowflake;
|
|
4417
4425
|
}
|
|
4418
4426
|
export declare const enum WebhookType {
|
|
4419
4427
|
/** Incoming Webhooks can post messages to channels with a generated token */
|
|
@@ -4425,17 +4433,17 @@ export declare const enum WebhookType {
|
|
|
4425
4433
|
}
|
|
4426
4434
|
export interface WelcomeScreen {
|
|
4427
4435
|
/** the server description shown in the welcome screen */
|
|
4428
|
-
description?: string | null;
|
|
4436
|
+
readonly description?: string | null;
|
|
4429
4437
|
/** the channels shown in the welcome screen, up to 5 */
|
|
4430
|
-
welcome_channels: WelcomeScreenChannel[];
|
|
4438
|
+
readonly welcome_channels: WelcomeScreenChannel[];
|
|
4431
4439
|
}
|
|
4432
4440
|
export interface WelcomeScreenChannel {
|
|
4433
4441
|
/** the channel's id */
|
|
4434
|
-
channel_id: Snowflake;
|
|
4442
|
+
readonly channel_id: Snowflake;
|
|
4435
4443
|
/** the description shown for the channel */
|
|
4436
|
-
description: string;
|
|
4444
|
+
readonly description: string;
|
|
4437
4445
|
/** the emoji id, if the emoji is custom */
|
|
4438
|
-
emoji_id?: Snowflake | null;
|
|
4446
|
+
readonly emoji_id?: Snowflake | null;
|
|
4439
4447
|
/** the emoji name if custom, the unicode character if standard, or null if no emoji is set */
|
|
4440
|
-
emoji_name?: string | null;
|
|
4448
|
+
readonly emoji_name?: string | null;
|
|
4441
4449
|
}
|