discord

0.3.0

Explore all defined data models and types for this version. For live editing and client SDK generators, inspect on TypeHub.

Open in TypeHub
Defined Types (98)
Audit_Log
The audit log of a guild.
Type
Audit_Log_Change
A change made to an audit log target.
Type
Audit_Log_Entry
A single administrative action.
Type
Audit_Log_Entry_Info
Additional info for certain audit log event types.
Type
Ban
A guild ban.
Type
Ban_Bulk_Create
Request body for banning up to 200 users.
Type
Ban_Bulk_Response
Result of a bulk ban.
Type
Ban_Create
Request body for creating a guild ban.
Type
Channel
Represents a Discord guild or DM channel.
Type
Channel_Create
Request body for creating a guild channel.
Type
Channel_Default_Reaction
The emoji shown in the add reaction button on a forum/media thread.
Type
Channel_Follow
Request body for following an announcement channel.
Type
Channel_Followed
A followed channel.
Type
Channel_Forum_Tag
A tag that can be applied to a thread in a forum or media channel.
Type
Channel_Invite_Create
Request body for creating a channel invite.
Type
Channel_Overwrite
Explicit permission overwrite for a role or member (also used as the partial overwrite in requests).
Type
Channel_Permission_Update
Request body for editing a channel permission overwrite.
Type
Channel_Pin
A pinned message.
Type
Channel_Pins
Paginated list of pinned messages.
Type
Channel_Position
One entry of a modify guild channel positions request.
Type
Channel_Update
Request body for updating a channel.
Type
Command
An application command (slash, user, message or entry point command).
Type
Command_Create
Request body for creating an application command (also used as an element of bulk overwrite).
Type
Command_Guild_Permissions
Permissions for a command (or the whole application) in a guild.
Type
Command_Option
A parameter of an application command.
Type
Command_Option_Choice
A choice of an application command option.
Type
Command_Permission
A single application command permission.
Type
Command_Permissions_Update
Request body for editing application command permissions.
Type
Command_Update
Request body for editing an application command.
Type
Component
A message or modal component. Integer type discriminator: 1 Action Row, 2 Button, 3 String Select, 4 Text Input, 5 User Select, 6 Role Select, 7 Mentionable Select, 8 Channel Select, 9 Section, 10 Text Display, 11 Thumbnail, 12 Media Gallery, 13 File, 14 Separator, 17 Container, 18 Label, 19 File Upload. This struct is the union of the fields of all component types.
Type
Component_Default_Value
Default value of an auto-populated select menu.
Type
Component_Media
Unfurled media item used by thumbnail, media gallery and file components.
Type
Component_Media_Gallery_Item
An item of a media gallery component.
Type
Component_Select_Option
An option of a string select, radio group or checkbox group component.
Type
Emoji
Represents a custom or unicode emoji (also used as a partial emoji).
Type
Error
Standard Discord error object.
Type
Gateway
Gateway connection information.
Type
Gateway_Bot
Gateway connection information for bots, including sharding metadata.
Type
Gateway_Session_Start_Limit
Session start limit information.
Type
Guild
Represents a Discord guild (server).
Type
Guild_Member
Represents a member of a Discord guild.
Type
Guild_Member_Add
Request body for adding a user to a guild using an OAuth2 access token.
Type
Guild_Member_Update
Request body for modifying a guild member.
Type
Guild_Member_Update_Current
Request body for modifying the current member.
Type
Guild_Partial
Partial guild object returned by Get Current User Guilds.
Type
Guild_Prune
Result of a prune count or prune operation.
Type
Guild_Prune_Begin
Request body for beginning a guild prune.
Type
Guild_Update
Request body for modifying a guild.
Type
Interaction_Callback_Data
Data of an interaction response (union of message, autocomplete and modal callback data).
Type
Interaction_Response
Request body for responding to an interaction.
Type
Invite
Represents a code that when used, adds a user to a guild or group DM.
Type
Message_Allowed_Mentions
Allowed mentions object for messages.
Type
Message_Attachment
A file attached to a message.
Type
Message_Attachment_Request
Partial attachment object used in requests to describe uploaded or kept attachments.
Type
Message_Bulk_Delete
Request body for bulk deleting messages.
Type
Message_Channel_Mention
A channel mentioned in a message (crossposted messages only).
Type
Message_Create
Request body for posting a message.
Type
Message_Embed
Embed object for messages.
Type
Message_Embed_Author
Embed author information.
Type
Message_Embed_Field
Embed field.
Type
Message_Embed_Footer
Embed footer information.
Type
Message_Embed_Image
Embed image or thumbnail information.
Type
Message_Embed_Provider
Embed provider information.
Type
Message_Embed_Video
Embed video information.
Type
Message_Interaction_Metadata
Metadata about the interaction that created a message (union of application command, message component and modal submit metadata).
Type
Message_Reaction
A reaction to a message.
Type
Message_Reaction_Count_Details
Breakdown of normal and super reaction counts.
Type
Message_Reference
Reference object for message replies.
Type
Message_Response
Represents a message returned by the Discord API.
Type
Message_Update
Request body for editing a message.
Type
Poll
A poll attached to a message.
Type
Poll_Answer
An answer of a poll.
Type
Poll_Answer_Count
Vote count of a poll answer.
Type
Poll_Create
Request object to create a poll.
Type
Poll_Media
The text or emoji of a poll question or answer.
Type
Poll_Results
Results of a poll.
Type
Role
Represents a role in a guild.
Type
Role_Colors
The colors of a role.
Type
Role_Create
Request body for creating a guild role.
Type
Role_Position
One entry of a modify guild role positions request.
Type
Role_Tags
Tags a role has.
Type
Role_Update
Request body for modifying a guild role.
Type
Sticker
Represents a sticker that can be sent in messages.
Type
Sticker_Item
The smallest amount of data required to render a sticker.
Type
Thread_Create
Request body for starting a thread without a message, or a thread in a forum/media channel (set message and applied_tags for forum/media).
Type
Thread_Create_From_Message
Request body for starting a thread from a message.
Type
Thread_Forum_Message
Contents of the first message of a forum or media thread.
Type
Thread_List
A list of threads with the current user's thread members.
Type
Thread_Member
Information about a user that has joined a thread.
Type
Thread_Metadata
Thread-specific fields not needed by other channels.
Type
User
Represents a Discord user.
Type
User_DM_Create
Request body for creating a DM channel.
Type
User_Update
Request body for modifying the current user.
Type
Webhook
A webhook, a low-effort way to post messages to channels.
Type
Webhook_Create
Request body for creating a webhook.
Type
Webhook_Execute
Request body for executing a webhook or creating an interaction followup message.
Type
Webhook_Message_Update
Request body for editing a webhook message or interaction response/followup.
Type
Webhook_Update
Request body for modifying a webhook.
Type
part of the Apioo-Project