discord-api-types 0.37.0 → 0.37.2-next.f8a9c8b.1660038997

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "discord-api-types",
3
- "version": "0.37.0",
3
+ "version": "0.37.2-next.f8a9c8b.1660038997",
4
4
  "description": "Discord API typings that are kept up to date for use in bot library creation.",
5
5
  "homepage": "https://discord-api-types.dev",
6
6
  "exports": {
@@ -40,7 +40,7 @@ export declare type APIApplicationCommandOption = APIApplicationCommandSubcomman
40
40
  export declare type APIApplicationCommandInteractionDataOption = APIApplicationCommandInteractionDataSubcommandOption | APIApplicationCommandInteractionDataSubcommandGroupOption | APIApplicationCommandInteractionDataBasicOption;
41
41
  export declare type APIApplicationCommandInteractionDataBasicOption = APIApplicationCommandInteractionDataStringOption | APIApplicationCommandInteractionDataIntegerOption | APIApplicationCommandInteractionDataBooleanOption | APIApplicationCommandInteractionDataUserOption | APIApplicationCommandInteractionDataChannelOption | APIApplicationCommandInteractionDataRoleOption | APIApplicationCommandInteractionDataMentionableOption | APIApplicationCommandInteractionDataNumberOption | APIApplicationCommandInteractionDataAttachmentOption;
42
42
  /**
43
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
43
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
44
44
  */
45
45
  export interface APIChatInputApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.ChatInput> {
46
46
  options?: APIApplicationCommandInteractionDataOption[];
@@ -5,7 +5,7 @@ import type { APIUser } from '../../user';
5
5
  import type { APIApplicationCommandInteractionWrapper, APIInteractionDataResolvedGuildMember, ApplicationCommandType } from '../applicationCommands';
6
6
  import type { APIDMInteractionWrapper, APIGuildInteractionWrapper } from '../base';
7
7
  /**
8
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
8
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
9
9
  */
10
10
  export interface APIUserApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.User> {
11
11
  target_id: Snowflake;
@@ -19,7 +19,7 @@ export interface APIUserApplicationCommandInteractionDataResolved {
19
19
  members?: Record<Snowflake, APIInteractionDataResolvedGuildMember>;
20
20
  }
21
21
  /**
22
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
22
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
23
23
  */
24
24
  export interface APIMessageApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.Message> {
25
25
  target_id: Snowflake;
@@ -32,7 +32,7 @@ export interface APIMessageApplicationCommandInteractionDataResolved {
32
32
  messages: Record<Snowflake, APIMessage>;
33
33
  }
34
34
  /**
35
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
35
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
36
36
  */
37
37
  export declare type APIContextMenuInteractionData = APIUserApplicationCommandInteractionData | APIMessageApplicationCommandInteractionData;
38
38
  /**
@@ -86,7 +86,7 @@ export declare enum ApplicationCommandType {
86
86
  Message = 3
87
87
  }
88
88
  /**
89
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
89
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
90
90
  */
91
91
  export declare type APIApplicationCommandInteractionData = APIChatInputApplicationCommandInteractionData | APIContextMenuInteractionData;
92
92
  /**
@@ -60,7 +60,7 @@ export interface APIApplication {
60
60
  /**
61
61
  * The hexadecimal encoded key for verification in interactions and the GameSDK's GetTicket function
62
62
  *
63
- * See https://discord.com/developers/docs/game-sdk/applications#get-ticket
63
+ * See https://discord.com/developers/docs/game-sdk/applications#getticket
64
64
  */
65
65
  verify_key: string;
66
66
  /**
@@ -391,7 +391,7 @@ export interface APIMessage {
391
391
  /**
392
392
  * Sent with Rich Presence-related chat embeds
393
393
  *
394
- * See https://discord.com/developers/docs/resources/channel#message-object-message-application-structure
394
+ * See https://discord.com/developers/docs/resources/application#application-object
395
395
  */
396
396
  application?: Partial<APIApplication>;
397
397
  /**
@@ -1085,7 +1085,7 @@ export interface APIBaseComponent<T extends ComponentType> {
1085
1085
  type: T;
1086
1086
  }
1087
1087
  /**
1088
- * https://discord.com/developers/docs/interactions/message-components#component-types
1088
+ * https://discord.com/developers/docs/interactions/message-components#component-object-component-types
1089
1089
  */
1090
1090
  export declare enum ComponentType {
1091
1091
  /**
@@ -223,7 +223,7 @@ var AllowedMentionsTypes;
223
223
  AllowedMentionsTypes["User"] = "users";
224
224
  })(AllowedMentionsTypes = exports.AllowedMentionsTypes || (exports.AllowedMentionsTypes = {}));
225
225
  /**
226
- * https://discord.com/developers/docs/interactions/message-components#component-types
226
+ * https://discord.com/developers/docs/interactions/message-components#component-object-component-types
227
227
  */
228
228
  var ComponentType;
229
229
  (function (ComponentType) {
@@ -746,7 +746,7 @@ export interface APIBan {
746
746
  user: APIUser;
747
747
  }
748
748
  /**
749
- * https://discord.com/developers/docs/resources/guild#get-guild-widget-example-get-guild-widget
749
+ * https://discord.com/developers/docs/resources/guild#guild-widget-object
750
750
  */
751
751
  export interface APIGuildWidget {
752
752
  id: Snowflake;
@@ -757,7 +757,7 @@ export interface APIGuildWidget {
757
757
  presence_count: number;
758
758
  }
759
759
  /**
760
- * https://discord.com/developers/docs/resources/guild#get-guild-widget-example-get-guild-widget
760
+ * https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
761
761
  */
762
762
  export interface APIGuildWidgetChannel {
763
763
  id: Snowflake;
@@ -765,7 +765,7 @@ export interface APIGuildWidgetChannel {
765
765
  position: number;
766
766
  }
767
767
  /**
768
- * https://discord.com/developers/docs/resources/guild#get-guild-widget-example-get-guild-widget
768
+ * https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
769
769
  */
770
770
  export interface APIGuildWidgetMember {
771
771
  id: string;
@@ -37,7 +37,7 @@ export interface APIInvite {
37
37
  /**
38
38
  * The type of target for this voice channel invite
39
39
  *
40
- * See https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
40
+ * See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
41
41
  */
42
42
  target_type?: InviteTargetType;
43
43
  /**
@@ -49,7 +49,7 @@ export interface APIInvite {
49
49
  /**
50
50
  * The embedded application to open for this voice channel embedded application invite
51
51
  *
52
- * See https://discord.com/developers/docs/topics/oauth2#application
52
+ * See https://discord.com/developers/docs/resources/application#application-object
53
53
  */
54
54
  target_application?: Partial<APIApplication>;
55
55
  /**
@@ -29,7 +29,7 @@ export interface APITeam {
29
29
  owner_user_id: Snowflake;
30
30
  }
31
31
  /**
32
- * https://discord.com/developers/docs/topics/teams#data-models-team-members-object
32
+ * https://discord.com/developers/docs/topics/teams#data-models-team-member-object
33
33
  */
34
34
  export interface APITeamMember {
35
35
  /**
@@ -1,11 +1,11 @@
1
1
  /**
2
- * Types extracted from https://discord.com/developers/docs/resources/template
2
+ * Types extracted from https://discord.com/developers/docs/resources/guild-template
3
3
  */
4
4
  import type { APIUser } from './user';
5
5
  import type { Snowflake } from '../../globals';
6
6
  import type { RESTPostAPIGuildsJSONBody } from '../../rest/v10/index';
7
7
  /**
8
- * https://discord.com/developers/docs/resources/template#template-object
8
+ * https://discord.com/developers/docs/resources/guild-template#guild-template-object
9
9
  */
10
10
  export interface APITemplate {
11
11
  /**
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * Types extracted from https://discord.com/developers/docs/resources/template
3
+ * Types extracted from https://discord.com/developers/docs/resources/guild-template
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  //# sourceMappingURL=template.js.map
@@ -40,7 +40,7 @@ export declare type APIApplicationCommandOption = APIApplicationCommandSubcomman
40
40
  export declare type APIApplicationCommandInteractionDataOption = APIApplicationCommandInteractionDataSubcommandOption | APIApplicationCommandInteractionDataSubcommandGroupOption | APIApplicationCommandInteractionDataBasicOption;
41
41
  export declare type APIApplicationCommandInteractionDataBasicOption = APIApplicationCommandInteractionDataStringOption | APIApplicationCommandInteractionDataIntegerOption | APIApplicationCommandInteractionDataBooleanOption | APIApplicationCommandInteractionDataUserOption | APIApplicationCommandInteractionDataChannelOption | APIApplicationCommandInteractionDataRoleOption | APIApplicationCommandInteractionDataMentionableOption | APIApplicationCommandInteractionDataNumberOption | APIApplicationCommandInteractionDataAttachmentOption;
42
42
  /**
43
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
43
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
44
44
  */
45
45
  export interface APIChatInputApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.ChatInput> {
46
46
  options?: APIApplicationCommandInteractionDataOption[];
@@ -5,7 +5,7 @@ import type { APIUser } from '../../user';
5
5
  import type { APIApplicationCommandInteractionWrapper, APIInteractionDataResolvedGuildMember, ApplicationCommandType } from '../applicationCommands';
6
6
  import type { APIDMInteractionWrapper, APIGuildInteractionWrapper } from '../base';
7
7
  /**
8
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
8
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
9
9
  */
10
10
  export interface APIUserApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.User> {
11
11
  target_id: Snowflake;
@@ -19,7 +19,7 @@ export interface APIUserApplicationCommandInteractionDataResolved {
19
19
  members?: Record<Snowflake, APIInteractionDataResolvedGuildMember>;
20
20
  }
21
21
  /**
22
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
22
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
23
23
  */
24
24
  export interface APIMessageApplicationCommandInteractionData extends APIBaseApplicationCommandInteractionData<ApplicationCommandType.Message> {
25
25
  target_id: Snowflake;
@@ -32,7 +32,7 @@ export interface APIMessageApplicationCommandInteractionDataResolved {
32
32
  messages: Record<Snowflake, APIMessage>;
33
33
  }
34
34
  /**
35
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
35
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
36
36
  */
37
37
  export declare type APIContextMenuInteractionData = APIUserApplicationCommandInteractionData | APIMessageApplicationCommandInteractionData;
38
38
  /**
@@ -86,7 +86,7 @@ export declare enum ApplicationCommandType {
86
86
  Message = 3
87
87
  }
88
88
  /**
89
- * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data-structure
89
+ * https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-interaction-data
90
90
  */
91
91
  export declare type APIApplicationCommandInteractionData = APIChatInputApplicationCommandInteractionData | APIContextMenuInteractionData;
92
92
  /**
@@ -60,7 +60,7 @@ export interface APIApplication {
60
60
  /**
61
61
  * The hexadecimal encoded key for verification in interactions and the GameSDK's GetTicket function
62
62
  *
63
- * See https://discord.com/developers/docs/game-sdk/applications#get-ticket
63
+ * See https://discord.com/developers/docs/game-sdk/applications#getticket
64
64
  */
65
65
  verify_key: string;
66
66
  /**
@@ -391,7 +391,7 @@ export interface APIMessage {
391
391
  /**
392
392
  * Sent with Rich Presence-related chat embeds
393
393
  *
394
- * See https://discord.com/developers/docs/resources/channel#message-object-message-application-structure
394
+ * See https://discord.com/developers/docs/resources/application#application-object
395
395
  */
396
396
  application?: Partial<APIApplication>;
397
397
  /**
@@ -1089,7 +1089,7 @@ export interface APIBaseComponent<T extends ComponentType> {
1089
1089
  type: T;
1090
1090
  }
1091
1091
  /**
1092
- * https://discord.com/developers/docs/interactions/message-components#component-types
1092
+ * https://discord.com/developers/docs/interactions/message-components#component-object-component-types
1093
1093
  */
1094
1094
  export declare enum ComponentType {
1095
1095
  /**
@@ -223,7 +223,7 @@ var AllowedMentionsTypes;
223
223
  AllowedMentionsTypes["User"] = "users";
224
224
  })(AllowedMentionsTypes = exports.AllowedMentionsTypes || (exports.AllowedMentionsTypes = {}));
225
225
  /**
226
- * https://discord.com/developers/docs/interactions/message-components#component-types
226
+ * https://discord.com/developers/docs/interactions/message-components#component-object-component-types
227
227
  */
228
228
  var ComponentType;
229
229
  (function (ComponentType) {
@@ -746,7 +746,7 @@ export interface APIBan {
746
746
  user: APIUser;
747
747
  }
748
748
  /**
749
- * https://discord.com/developers/docs/resources/guild#get-guild-widget-example-get-guild-widget
749
+ * https://discord.com/developers/docs/resources/guild#guild-widget-object
750
750
  */
751
751
  export interface APIGuildWidget {
752
752
  id: Snowflake;
@@ -757,7 +757,7 @@ export interface APIGuildWidget {
757
757
  presence_count: number;
758
758
  }
759
759
  /**
760
- * https://discord.com/developers/docs/resources/guild#get-guild-widget-example-get-guild-widget
760
+ * https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
761
761
  */
762
762
  export interface APIGuildWidgetChannel {
763
763
  id: Snowflake;
@@ -765,7 +765,7 @@ export interface APIGuildWidgetChannel {
765
765
  position: number;
766
766
  }
767
767
  /**
768
- * https://discord.com/developers/docs/resources/guild#get-guild-widget-example-get-guild-widget
768
+ * https://discord.com/developers/docs/resources/guild#guild-widget-object-example-guild-widget
769
769
  */
770
770
  export interface APIGuildWidgetMember {
771
771
  id: string;
@@ -37,7 +37,7 @@ export interface APIInvite {
37
37
  /**
38
38
  * The type of target for this voice channel invite
39
39
  *
40
- * See https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
40
+ * See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
41
41
  */
42
42
  target_type?: InviteTargetType;
43
43
  /**
@@ -49,7 +49,7 @@ export interface APIInvite {
49
49
  /**
50
50
  * The embedded application to open for this voice channel embedded application invite
51
51
  *
52
- * See https://discord.com/developers/docs/topics/oauth2#application
52
+ * See https://discord.com/developers/docs/resources/application#application-object
53
53
  */
54
54
  target_application?: Partial<APIApplication>;
55
55
  /**
@@ -29,7 +29,7 @@ export interface APITeam {
29
29
  owner_user_id: Snowflake;
30
30
  }
31
31
  /**
32
- * https://discord.com/developers/docs/topics/teams#data-models-team-members-object
32
+ * https://discord.com/developers/docs/topics/teams#data-models-team-member-object
33
33
  */
34
34
  export interface APITeamMember {
35
35
  /**
@@ -1,11 +1,11 @@
1
1
  /**
2
- * Types extracted from https://discord.com/developers/docs/resources/template
2
+ * Types extracted from https://discord.com/developers/docs/resources/guild-template
3
3
  */
4
4
  import type { APIUser } from './user';
5
5
  import type { Snowflake } from '../../globals';
6
6
  import type { RESTPostAPIGuildsJSONBody } from '../../rest/v9/index';
7
7
  /**
8
- * https://discord.com/developers/docs/resources/template#template-object
8
+ * https://discord.com/developers/docs/resources/guild-template#template-object
9
9
  */
10
10
  export interface APITemplate {
11
11
  /**
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  /**
3
- * Types extracted from https://discord.com/developers/docs/resources/template
3
+ * Types extracted from https://discord.com/developers/docs/resources/guild-template
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  //# sourceMappingURL=template.js.map
@@ -289,7 +289,7 @@ export declare type RESTPatchAPIGuildChannelPositionsJSONBody = Array<AddUndefin
289
289
  */
290
290
  export declare type RESTPatchAPIGuildChannelPositionsResult = never;
291
291
  /**
292
- * https://discord.com/developers/docs/resources/guild#list-active-threads
292
+ * https://discord.com/developers/docs/resources/guild#list-active-guild-threads
293
293
  */
294
294
  export declare type RESTGetAPIGuildThreadsResult = APIThreadList;
295
295
  /**
@@ -289,7 +289,7 @@ export declare type RESTPatchAPIGuildChannelPositionsJSONBody = Array<AddUndefin
289
289
  */
290
290
  export declare type RESTPatchAPIGuildChannelPositionsResult = never;
291
291
  /**
292
- * https://discord.com/developers/docs/resources/guild#list-active-threads
292
+ * https://discord.com/developers/docs/resources/guild#list-active-guild-threads
293
293
  */
294
294
  export declare type RESTGetAPIGuildThreadsResult = Omit<APIThreadList, 'has_more'>;
295
295
  /**