discord
Module discord
API
Definitions
ballerinax/discord Ballerina library
Overview
Discord is a popular communication platform designed for creating communities and facilitating real-time messaging, voice, and video interactions over the internet.
The Ballerina Discord connector offers APIs to connect and interact with the Discord REST API v10.
Setup guide
Follow these steps to create a Discord developer account.
Step 1: Login to Discord developer page
-
Visit Discord developer portal by logging into your Discord account.
-
If you do not have a Discord account already, create a new discord account by clicking on the
Register
hyperlink below theLog In
button when opening the Discord developer page. -
Complete the account creation process by including the relevant information in the given fields.
Step 2: Make a new Discord application
-
Once in the Discord developer portal is open, click on the
New Application
button as displayed above to start the process.
Step 3: Name the Discord Application
-
Proceed by giving the Discord Application a name and click on the terms of service.
-
Finally complete the naming process by clicking on the
next
button.
Step 4: Obtain the Client ID and Client Secret
-
Under the
OAuth2
section found on the left-sided list, locate the Client's Information as shown on the screen. To implement the functionalities provided by Discord's API, you will need the Client ID and Client Secret.
Quickstart
To use the discord
connector in your Ballerina application, modify the .bal
file as follows:
Step 1: Import the module
Import the discord
module.
import ballerinax/discord;
Step 2: Instantiate a new connector
Create a discord:ConnectionConfig
with the obtained OAuth2.0 Client Credentials and initialize the connector with it.
Apps must receive approval from users installing them to perform actions within Discord. To enable these functions, specific scopes must be defined. These scopes are outlined in the OAuth2 Scopes documentation.
configurable string clientId = ?; configurable string clientSecret = ?; configurable string[] scopes = ?; discord:Client discord = check new({ auth: { clientId, clientSecret, scopes } });
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Return linked third-party accounts of the user
public function main() returns error? { ConnectedAccountResponse[] connectedAccounts = check discord->/users/\@me/connections(); }
Step 4: Run the Ballerina application
bal run
Examples
The Discord
connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Automated Event Reminders - This use case illustrates how the Discord API can be leveraged to create a scheduled event in a Discord server and automate daily reminders about this event across all channels within the server.
- Automated Role Assignment Based on Reactions - This use case illustrates the utilization of the Discord API to assign roles to members based on their interests, enabling them to gain roles by reacting to designated messages.
Clients
discord: Client
Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.
Constructor
Gets invoked to initialize the connector
.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://discord.com/api/v10" - URL of the target service
delete applications/[string application_id]/commands/[string command_id]
function delete applications/[string application_id]/commands/[string command_id](map<string|string[]> headers) returns Response|error
delete_application_command
delete applications/[string application_id]/entitlements/[string entitlement_id]
function delete applications/[string application_id]/entitlements/[string entitlement_id](map<string|string[]> headers) returns Response|error
delete_entitlement
delete applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]
function delete applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id](map<string|string[]> headers) returns Response|error
delete_guild_application_command
delete channels/[string channel_id]
function delete channels/[string channel_id](map<string|string[]> headers) returns inline_response_200_6|error
delete_channel
Return Type
- inline_response_200_6|error - 200 response for delete_channel
delete channels/[string channel_id]/messages/[string message_id]
function delete channels/[string channel_id]/messages/[string message_id](map<string|string[]> headers) returns Response|error
delete_message
delete channels/[string channel_id]/messages/[string message_id]/reactions
function delete channels/[string channel_id]/messages/[string message_id]/reactions(map<string|string[]> headers) returns Response|error
delete_all_message_reactions
delete channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]
function delete channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name](map<string|string[]> headers) returns Response|error
delete_all_message_reactions_by_emoji
delete channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]/[string user_id]
function delete channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]/[string user_id](map<string|string[]> headers) returns Response|error
delete_user_message_reaction
delete channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]/@me
function delete channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]/\@me(map<string|string[]> headers) returns Response|error
delete channels/[string channel_id]/permissions/[string overwrite_id]
function delete channels/[string channel_id]/permissions/[string overwrite_id](map<string|string[]> headers) returns Response|error
delete_channel_permission_overwrite
delete channels/[string channel_id]/pins/[string message_id]
function delete channels/[string channel_id]/pins/[string message_id](map<string|string[]> headers) returns Response|error
unpin_message
delete channels/[string channel_id]/recipients/[string user_id]
function delete channels/[string channel_id]/recipients/[string user_id](map<string|string[]> headers) returns Response|error
delete_group_dm_user
delete channels/[string channel_id]/thread-members/[string user_id]
function delete channels/[string channel_id]/thread\-members/[string user_id](map<string|string[]> headers) returns Response|error
delete_thread_member
delete channels/[string channel_id]/thread-members/@me
function delete channels/[string channel_id]/thread\-members/\@me(map<string|string[]> headers) returns Response|error
delete guilds/[string guild_id]
delete_guild
delete guilds/[string guild_id]/auto-moderation/rules/[string rule_id]
function delete guilds/[string guild_id]/auto\-moderation/rules/[string rule_id](map<string|string[]> headers) returns Response|error
delete_auto_moderation_rule
delete guilds/[string guild_id]/bans/[string user_id]
function delete guilds/[string guild_id]/bans/[string user_id](map<string|string[]> headers) returns Response|error
unban_user_from_guild
delete guilds/[string guild_id]/emojis/[string emoji_id]
function delete guilds/[string guild_id]/emojis/[string emoji_id](map<string|string[]> headers) returns Response|error
delete_guild_emoji
delete guilds/[string guild_id]/integrations/[string integration_id]
function delete guilds/[string guild_id]/integrations/[string integration_id](map<string|string[]> headers) returns Response|error
delete_guild_integration
delete guilds/[string guild_id]/members/[string user_id]
function delete guilds/[string guild_id]/members/[string user_id](map<string|string[]> headers) returns Response|error
delete_guild_member
delete guilds/[string guild_id]/members/[string user_id]/roles/[string role_id]
function delete guilds/[string guild_id]/members/[string user_id]/roles/[string role_id](map<string|string[]> headers) returns Response|error
delete_guild_member_role
delete guilds/[string guild_id]/roles/[string role_id]
function delete guilds/[string guild_id]/roles/[string role_id](map<string|string[]> headers) returns Response|error
delete_guild_role
delete guilds/[string guild_id]/scheduled-events/[string guild_scheduled_event_id]
function delete guilds/[string guild_id]/scheduled\-events/[string guild_scheduled_event_id](map<string|string[]> headers) returns Response|error
delete_guild_scheduled_event
delete guilds/[string guild_id]/stickers/[string sticker_id]
function delete guilds/[string guild_id]/stickers/[string sticker_id](map<string|string[]> headers) returns Response|error
delete_guild_sticker
delete guilds/[string guild_id]/templates/[string code]
function delete guilds/[string guild_id]/templates/[string code](map<string|string[]> headers) returns GuildTemplateResponse|error
delete_guild_template
Return Type
- GuildTemplateResponse|error - 200 response for delete_guild_template
delete invites/[string code]
function delete invites/[string code](map<string|string[]> headers) returns inline_response_200_2|error
invite_revoke
Return Type
- inline_response_200_2|error - 200 response for invite_revoke
delete stage-instances/[string channel_id]
function delete stage\-instances/[string channel_id](map<string|string[]> headers) returns Response|error
delete users/@me/guilds/[string guild_id]
function delete users/\@me/guilds/[string guild_id](map<string|string[]> headers) returns Response|error
leave_guild
delete webhooks/[string webhook_id]
delete_webhook
delete webhooks/[string webhook_id]/[string webhook_token]
function delete webhooks/[string webhook_id]/[string webhook_token](map<string|string[]> headers) returns Response|error
delete_webhook_by_token
delete webhooks/[string webhook_id]/[string webhook_token]/messages/[string message_id]
function delete webhooks/[string webhook_id]/[string webhook_token]/messages/[string message_id](map<string|string[]> headers, *Delete_webhook_messageQueries queries) returns Response|error
delete_webhook_message
Parameters
- queries *Delete_webhook_messageQueries - Queries to be sent with the request
delete webhooks/[string webhook_id]/[string webhook_token]/messages/@original
function delete webhooks/[string webhook_id]/[string webhook_token]/messages/\@original(map<string|string[]> headers, *Delete_original_webhook_messageQueries queries) returns Response|error
Parameters
- queries *Delete_original_webhook_messageQueries -
get applications/[string application_id]
function get applications/[string application_id](map<string|string[]> headers) returns PrivateApplicationResponse|error
get_application
Return Type
- PrivateApplicationResponse|error - 200 response for get_application
get applications/[string application_id]/commands
function get applications/[string application_id]/commands(map<string|string[]> headers, *List_application_commandsQueries queries) returns ApplicationCommandResponse[]|error
list_application_commands
Parameters
- queries *List_application_commandsQueries - Queries to be sent with the request
Return Type
- ApplicationCommandResponse[]|error - 200 response for list_application_commands
get applications/[string application_id]/commands/[string command_id]
function get applications/[string application_id]/commands/[string command_id](map<string|string[]> headers) returns ApplicationCommandResponse|error
get_application_command
Return Type
- ApplicationCommandResponse|error - 200 response for get_application_command
get applications/[string application_id]/entitlements
function get applications/[string application_id]/entitlements(map<string|string[]> headers, *Get_entitlementsQueries queries) returns EntitlementResponse[]|error
get_entitlements
Parameters
- queries *Get_entitlementsQueries - Queries to be sent with the request
Return Type
- EntitlementResponse[]|error - 200 response for get_entitlements
get applications/[string application_id]/entitlements/[string entitlement_id]
function get applications/[string application_id]/entitlements/[string entitlement_id](map<string|string[]> headers) returns EntitlementResponse|error
get_entitlement
Return Type
- EntitlementResponse|error - 200 response for get_entitlement
get applications/[string application_id]/guilds/[string guild_id]/commands
function get applications/[string application_id]/guilds/[string guild_id]/commands(map<string|string[]> headers, *List_guild_application_commandsQueries queries) returns ApplicationCommandResponse[]|error
list_guild_application_commands
Parameters
- queries *List_guild_application_commandsQueries - Queries to be sent with the request
Return Type
- ApplicationCommandResponse[]|error - 200 response for list_guild_application_commands
get applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]
function get applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id](map<string|string[]> headers) returns ApplicationCommandResponse|error
get_guild_application_command
Return Type
- ApplicationCommandResponse|error - 200 response for get_guild_application_command
get applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]/permissions
function get applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]/permissions(map<string|string[]> headers) returns CommandPermissionsResponse|error
get_guild_application_command_permissions
Return Type
- CommandPermissionsResponse|error - 200 response for get_guild_application_command_permissions
get applications/[string application_id]/guilds/[string guild_id]/commands/permissions
function get applications/[string application_id]/guilds/[string guild_id]/commands/permissions(map<string|string[]> headers) returns CommandPermissionsResponse[]|error
list_guild_application_command_permissions
Return Type
- CommandPermissionsResponse[]|error - 200 response for list_guild_application_command_permissions
get applications/[string application_id]/role-connections/metadata
function get applications/[string application_id]/role\-connections/metadata(map<string|string[]> headers) returns ApplicationRoleConnectionsMetadataItemResponse[]|error
get_application_role_connections_metadata
Return Type
- ApplicationRoleConnectionsMetadataItemResponse[]|error - 200 response for get_application_role_connections_metadata
get applications/@me
function get applications/\@me(map<string|string[]> headers) returns PrivateApplicationResponse|error
get channels/[string channel_id]
function get channels/[string channel_id](map<string|string[]> headers) returns inline_response_200_6|error
get_channel
Return Type
- inline_response_200_6|error - 200 response for get_channel
get channels/[string channel_id]/invites
function get channels/[string channel_id]/invites(map<string|string[]> headers) returns anydata[]|error
list_channel_invites
Return Type
- anydata[]|error - 200 response for list_channel_invites
get channels/[string channel_id]/messages
function get channels/[string channel_id]/messages(map<string|string[]> headers, *List_messagesQueries queries) returns MessageResponse[]|error
list_messages
Parameters
- queries *List_messagesQueries - Queries to be sent with the request
Return Type
- MessageResponse[]|error - 200 response for list_messages
get channels/[string channel_id]/messages/[string message_id]
function get channels/[string channel_id]/messages/[string message_id](map<string|string[]> headers) returns MessageResponse|error
get_message
Return Type
- MessageResponse|error - 200 response for get_message
get channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]
function get channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name](map<string|string[]> headers, *List_message_reactions_by_emojiQueries queries) returns UserResponse[]|error
list_message_reactions_by_emoji
Parameters
- queries *List_message_reactions_by_emojiQueries - Queries to be sent with the request
Return Type
- UserResponse[]|error - 200 response for list_message_reactions_by_emoji
get channels/[string channel_id]/pins
function get channels/[string channel_id]/pins(map<string|string[]> headers) returns MessageResponse[]|error
list_pinned_messages
Return Type
- MessageResponse[]|error - 200 response for list_pinned_messages
get channels/[string channel_id]/thread-members
function get channels/[string channel_id]/thread\-members(map<string|string[]> headers, *List_thread_membersQueries queries) returns ThreadMemberResponse[]|error
get channels/[string channel_id]/thread-members/[string user_id]
function get channels/[string channel_id]/thread\-members/[string user_id](map<string|string[]> headers, *Get_thread_memberQueries queries) returns ThreadMemberResponse|error
get_thread_member
Parameters
- queries *Get_thread_memberQueries - Queries to be sent with the request
Return Type
- ThreadMemberResponse|error - 200 response for get_thread_member
get channels/[string channel_id]/threads/archived/'private
function get channels/[string channel_id]/threads/archived/'private(map<string|string[]> headers, *List_private_archived_threadsQueries queries) returns ThreadsResponse|error
Parameters
- queries *List_private_archived_threadsQueries -
get channels/[string channel_id]/threads/archived/'public
function get channels/[string channel_id]/threads/archived/'public(map<string|string[]> headers, *List_public_archived_threadsQueries queries) returns ThreadsResponse|error
Parameters
- queries *List_public_archived_threadsQueries -
get channels/[string channel_id]/users/@me/threads/archived/'private
function get channels/[string channel_id]/users/\@me/threads/archived/'private(map<string|string[]> headers, *List_my_private_archived_threadsQueries queries) returns ThreadsResponse|error
Parameters
- queries *List_my_private_archived_threadsQueries -
get channels/[string channel_id]/webhooks
function get channels/[string channel_id]/webhooks(map<string|string[]> headers) returns anydata[]|error
list_channel_webhooks
Return Type
- anydata[]|error - 200 response for list_channel_webhooks
get gateway
function get gateway(map<string|string[]> headers) returns GatewayResponse|error
get_gateway
Return Type
- GatewayResponse|error - 200 response for get_gateway
get gateway/bot
function get gateway/bot(map<string|string[]> headers) returns GatewayBotResponse|error
get_bot_gateway
Return Type
- GatewayBotResponse|error - 200 response for get_bot_gateway
get guilds/[string guild_id]
function get guilds/[string guild_id](map<string|string[]> headers, *Get_guildQueries queries) returns GuildWithCountsResponse|error
get_guild
Parameters
- queries *Get_guildQueries - Queries to be sent with the request
Return Type
- GuildWithCountsResponse|error - 200 response for get_guild
get guilds/[string guild_id]/audit-logs
function get guilds/[string guild_id]/audit\-logs(map<string|string[]> headers, *List_guild_audit_log_entriesQueries queries) returns GuildAuditLogResponse|error
Parameters
- queries *List_guild_audit_log_entriesQueries -
get guilds/[string guild_id]/auto-moderation/rules
function get guilds/[string guild_id]/auto\-moderation/rules(map<string|string[]> headers) returns anydata[]|error
list_auto_moderation_rules
Return Type
- anydata[]|error - 200 response for list_auto_moderation_rules
get guilds/[string guild_id]/auto-moderation/rules/[string rule_id]
function get guilds/[string guild_id]/auto\-moderation/rules/[string rule_id](map<string|string[]> headers) returns inline_response_200_1|error
get_auto_moderation_rule
Return Type
- inline_response_200_1|error - 200 response for get_auto_moderation_rule
get guilds/[string guild_id]/bans
function get guilds/[string guild_id]/bans(map<string|string[]> headers, *List_guild_bansQueries queries) returns GuildBanResponse[]|error
list_guild_bans
Parameters
- queries *List_guild_bansQueries - Queries to be sent with the request
Return Type
- GuildBanResponse[]|error - 200 response for list_guild_bans
get guilds/[string guild_id]/bans/[string user_id]
function get guilds/[string guild_id]/bans/[string user_id](map<string|string[]> headers) returns GuildBanResponse|error
get_guild_ban
Return Type
- GuildBanResponse|error - 200 response for get_guild_ban
get guilds/[string guild_id]/channels
function get guilds/[string guild_id]/channels(map<string|string[]> headers) returns anydata[]|error
list_guild_channels
Return Type
- anydata[]|error - 200 response for list_guild_channels
get guilds/[string guild_id]/emojis
function get guilds/[string guild_id]/emojis(map<string|string[]> headers) returns EmojiResponse[]|error
list_guild_emojis
Return Type
- EmojiResponse[]|error - 200 response for list_guild_emojis
get guilds/[string guild_id]/emojis/[string emoji_id]
function get guilds/[string guild_id]/emojis/[string emoji_id](map<string|string[]> headers) returns EmojiResponse|error
get_guild_emoji
Return Type
- EmojiResponse|error - 200 response for get_guild_emoji
get guilds/[string guild_id]/integrations
function get guilds/[string guild_id]/integrations(map<string|string[]> headers) returns anydata[]|error
list_guild_integrations
Return Type
- anydata[]|error - 200 response for list_guild_integrations
get guilds/[string guild_id]/invites
list_guild_invites
Return Type
- anydata[]|error - 200 response for list_guild_invites
get guilds/[string guild_id]/members
function get guilds/[string guild_id]/members(map<string|string[]> headers, *List_guild_membersQueries queries) returns GuildMemberResponse[]|error
list_guild_members
Parameters
- queries *List_guild_membersQueries - Queries to be sent with the request
Return Type
- GuildMemberResponse[]|error - 200 response for list_guild_members
get guilds/[string guild_id]/members/[string user_id]
function get guilds/[string guild_id]/members/[string user_id](map<string|string[]> headers) returns GuildMemberResponse|error
get_guild_member
Return Type
- GuildMemberResponse|error - 200 response for get_guild_member
get guilds/[string guild_id]/members/search
function get guilds/[string guild_id]/members/search(map<string|string[]> headers, *Search_guild_membersQueries queries) returns GuildMemberResponse[]|error
search_guild_members
Parameters
- queries *Search_guild_membersQueries - Queries to be sent with the request
Return Type
- GuildMemberResponse[]|error - 200 response for search_guild_members
get guilds/[string guild_id]/new-member-welcome
function get guilds/[string guild_id]/new\-member\-welcome(map<string|string[]> headers) returns GuildHomeSettingsResponse|error
get guilds/[string guild_id]/onboarding
function get guilds/[string guild_id]/onboarding(map<string|string[]> headers) returns UserGuildOnboardingResponse|error
get_guilds_onboarding
Return Type
- UserGuildOnboardingResponse|error - 200 response for get_guilds_onboarding
get guilds/[string guild_id]/preview
function get guilds/[string guild_id]/preview(map<string|string[]> headers) returns GuildPreviewResponse|error
get_guild_preview
Return Type
- GuildPreviewResponse|error - 200 response for get_guild_preview
get guilds/[string guild_id]/prune
function get guilds/[string guild_id]/prune(map<string|string[]> headers, *Preview_prune_guildQueries queries) returns GuildPruneResponse|error
preview_prune_guild
Parameters
- queries *Preview_prune_guildQueries - Queries to be sent with the request
Return Type
- GuildPruneResponse|error - 200 response for preview_prune_guild
get guilds/[string guild_id]/regions
function get guilds/[string guild_id]/regions(map<string|string[]> headers) returns VoiceRegionResponse[]|error
list_guild_voice_regions
Return Type
- VoiceRegionResponse[]|error - 200 response for list_guild_voice_regions
get guilds/[string guild_id]/roles
function get guilds/[string guild_id]/roles(map<string|string[]> headers) returns GuildRoleResponse[]|error
list_guild_roles
Return Type
- GuildRoleResponse[]|error - 200 response for list_guild_roles
get guilds/[string guild_id]/scheduled-events
function get guilds/[string guild_id]/scheduled\-events(map<string|string[]> headers, *List_guild_scheduled_eventsQueries queries) returns anydata[]|error
get guilds/[string guild_id]/scheduled-events/[string guild_scheduled_event_id]
function get guilds/[string guild_id]/scheduled\-events/[string guild_scheduled_event_id](map<string|string[]> headers, *Get_guild_scheduled_eventQueries queries) returns inline_response_200_3|error
get_guild_scheduled_event
Parameters
- queries *Get_guild_scheduled_eventQueries - Queries to be sent with the request
Return Type
- inline_response_200_3|error - 200 response for get_guild_scheduled_event
get guilds/[string guild_id]/scheduled-events/[string guild_scheduled_event_id]/users
function get guilds/[string guild_id]/scheduled\-events/[string guild_scheduled_event_id]/users(map<string|string[]> headers, *List_guild_scheduled_event_usersQueries queries) returns ScheduledEventUserResponse[]|error
list_guild_scheduled_event_users
Parameters
- queries *List_guild_scheduled_event_usersQueries - Queries to be sent with the request
Return Type
- ScheduledEventUserResponse[]|error - 200 response for list_guild_scheduled_event_users
get guilds/[string guild_id]/stickers
function get guilds/[string guild_id]/stickers(map<string|string[]> headers) returns GuildStickerResponse[]|error
list_guild_stickers
Return Type
- GuildStickerResponse[]|error - 200 response for list_guild_stickers
get guilds/[string guild_id]/stickers/[string sticker_id]
function get guilds/[string guild_id]/stickers/[string sticker_id](map<string|string[]> headers) returns GuildStickerResponse|error
get_guild_sticker
Return Type
- GuildStickerResponse|error - 200 response for get_guild_sticker
get guilds/[string guild_id]/templates
function get guilds/[string guild_id]/templates(map<string|string[]> headers) returns GuildTemplateResponse[]|error
list_guild_templates
Return Type
- GuildTemplateResponse[]|error - 200 response for list_guild_templates
get guilds/[string guild_id]/threads/active
function get guilds/[string guild_id]/threads/active(map<string|string[]> headers) returns ThreadsResponse|error
get_active_guild_threads
Return Type
- ThreadsResponse|error - 200 response for get_active_guild_threads
get guilds/[string guild_id]/vanity-url
function get guilds/[string guild_id]/vanity\-url(map<string|string[]> headers) returns VanityURLResponse|error
get guilds/[string guild_id]/webhooks
function get guilds/[string guild_id]/webhooks(map<string|string[]> headers) returns anydata[]|error
get_guild_webhooks
Return Type
- anydata[]|error - 200 response for get_guild_webhooks
get guilds/[string guild_id]/welcome-screen
function get guilds/[string guild_id]/welcome\-screen(map<string|string[]> headers) returns GuildWelcomeScreenResponse|error
get guilds/[string guild_id]/widget
function get guilds/[string guild_id]/widget(map<string|string[]> headers) returns WidgetSettingsResponse|error
get_guild_widget_settings
Return Type
- WidgetSettingsResponse|error - 200 response for get_guild_widget_settings
get guilds/[string guild_id]/widget.json
function get guilds/[string guild_id]/widget\.json(map<string|string[]> headers) returns WidgetResponse|error
get guilds/[string guild_id]/widget.png
function get guilds/[string guild_id]/widget\.png(map<string|string[]> headers, *Get_guild_widget_pngQueries queries) returns byte[]|error
get guilds/templates/[string code]
function get guilds/templates/[string code](map<string|string[]> headers) returns GuildTemplateResponse|error
get_guild_template
Return Type
- GuildTemplateResponse|error - 200 response for get_guild_template
get invites/[string code]
function get invites/[string code](map<string|string[]> headers, *Invite_resolveQueries queries) returns inline_response_200_2|error
invite_resolve
Parameters
- queries *Invite_resolveQueries - Queries to be sent with the request
Return Type
- inline_response_200_2|error - 200 response for invite_resolve
get oauth2/@me
function get oauth2/\@me(map<string|string[]> headers) returns OAuth2GetAuthorizationResponse|error
get oauth2/applications/@me
function get oauth2/applications/\@me(map<string|string[]> headers) returns PrivateApplicationResponse|error
get oauth2/keys
function get oauth2/keys(map<string|string[]> headers) returns OAuth2GetKeys|error
get_public_keys
Return Type
- OAuth2GetKeys|error - 200 response for get_public_keys
get stage-instances/[string channel_id]
function get stage\-instances/[string channel_id](map<string|string[]> headers) returns StageInstanceResponse|error
get sticker-packs
function get sticker\-packs(map<string|string[]> headers) returns StickerPackCollectionResponse|error
get stickers/[string sticker_id]
function get stickers/[string sticker_id](map<string|string[]> headers) returns inline_response_200_5|error
get_sticker
Return Type
- inline_response_200_5|error - 200 response for get_sticker
get users/[string user_id]
function get users/[string user_id](map<string|string[]> headers) returns UserResponse|error
get_user
Return Type
- UserResponse|error - 200 response for get_user
get users/@me
function get users/\@me(map<string|string[]> headers) returns UserPIIResponse|error
get users/@me/applications/[string application_id]/role-connection
function get users/\@me/applications/[string application_id]/role\-connection(map<string|string[]> headers) returns ApplicationUserRoleConnectionResponse|error
get users/@me/connections
function get users/\@me/connections(map<string|string[]> headers) returns ConnectedAccountResponse[]|error
list_my_connections
Return Type
- ConnectedAccountResponse[]|error - 200 response for list_my_connections
get users/@me/guilds
function get users/\@me/guilds(map<string|string[]> headers, *List_my_guildsQueries queries) returns MyGuildResponse[]|error
list_my_guilds
Parameters
- queries *List_my_guildsQueries - Queries to be sent with the request
Return Type
- MyGuildResponse[]|error - 200 response for list_my_guilds
get users/@me/guilds/[string guild_id]/member
function get users/\@me/guilds/[string guild_id]/member(map<string|string[]> headers) returns PrivateGuildMemberResponse|error
get_my_guild_member
Return Type
- PrivateGuildMemberResponse|error - 200 response for get_my_guild_member
get voice/regions
function get voice/regions(map<string|string[]> headers) returns VoiceRegionResponse[]|error
list_voice_regions
Return Type
- VoiceRegionResponse[]|error - 200 response for list_voice_regions
get webhooks/[string webhook_id]
function get webhooks/[string webhook_id](map<string|string[]> headers) returns inline_response_200_4|error
get_webhook
Return Type
- inline_response_200_4|error - 200 response for get_webhook
get webhooks/[string webhook_id]/[string webhook_token]
function get webhooks/[string webhook_id]/[string webhook_token](map<string|string[]> headers) returns inline_response_200_4|error
get_webhook_by_token
Return Type
- inline_response_200_4|error - 200 response for get_webhook_by_token
get webhooks/[string webhook_id]/[string webhook_token]/messages/[string message_id]
function get webhooks/[string webhook_id]/[string webhook_token]/messages/[string message_id](map<string|string[]> headers, *Get_webhook_messageQueries queries) returns MessageResponse|error
get_webhook_message
Parameters
- queries *Get_webhook_messageQueries - Queries to be sent with the request
Return Type
- MessageResponse|error - 200 response for get_webhook_message
get webhooks/[string webhook_id]/[string webhook_token]/messages/@original
function get webhooks/[string webhook_id]/[string webhook_token]/messages/\@original(map<string|string[]> headers, *Get_original_webhook_messageQueries queries) returns MessageResponse|error
Parameters
- queries *Get_original_webhook_messageQueries -
patch applications/[string application_id]
function patch applications/[string application_id](ApplicationFormPartial payload, map<string|string[]> headers) returns PrivateApplicationResponse|error
update_application
Parameters
- payload ApplicationFormPartial -
Return Type
- PrivateApplicationResponse|error - 200 response for update_application
patch applications/[string application_id]/commands/[string command_id]
function patch applications/[string application_id]/commands/[string command_id](ApplicationCommandPatchRequestPartial payload, map<string|string[]> headers) returns ApplicationCommandResponse|error
update_application_command
Parameters
- payload ApplicationCommandPatchRequestPartial -
Return Type
- ApplicationCommandResponse|error - 200 response for update_application_command
patch applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]
function patch applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id](ApplicationCommandPatchRequestPartial payload, map<string|string[]> headers) returns ApplicationCommandResponse|error
update_guild_application_command
Parameters
- payload ApplicationCommandPatchRequestPartial -
Return Type
- ApplicationCommandResponse|error - 200 response for update_guild_application_command
patch applications/@me
function patch applications/\@me(ApplicationFormPartial payload, map<string|string[]> headers) returns PrivateApplicationResponse|error
patch channels/[string channel_id]
function patch channels/[string channel_id](channels_channel_id_body payload, map<string|string[]> headers) returns inline_response_200_6|error
update_channel
Parameters
- payload channels_channel_id_body -
Return Type
- inline_response_200_6|error - 200 response for update_channel
patch channels/[string channel_id]/messages/[string message_id]
function patch channels/[string channel_id]/messages/[string message_id](Update_messageHeaders headers, messages_message_id_body payload) returns MessageResponse|error
update_message
Parameters
- headers Update_messageHeaders - Headers to be sent with the request
- payload messages_message_id_body -
Return Type
- MessageResponse|error - 200 response for update_message
patch guilds/[string guild_id]
function patch guilds/[string guild_id](GuildPatchRequestPartial payload, map<string|string[]> headers) returns GuildResponse|error
update_guild
Parameters
- payload GuildPatchRequestPartial -
Return Type
- GuildResponse|error - 200 response for update_guild
patch guilds/[string guild_id]/auto-moderation/rules/[string rule_id]
function patch guilds/[string guild_id]/auto\-moderation/rules/[string rule_id](rules_rule_id_body payload, map<string|string[]> headers) returns inline_response_200_1|error
update_auto_moderation_rule
Parameters
- payload rules_rule_id_body -
Return Type
- inline_response_200_1|error - 200 response for update_auto_moderation_rule
patch guilds/[string guild_id]/channels
function patch guilds/[string guild_id]/channels(GuildsChannelsRequest[] payload, map<string|string[]> headers) returns Response|error
bulk_update_guild_channels
Parameters
- payload GuildsChannelsRequest[] -
patch guilds/[string guild_id]/emojis/[string emoji_id]
function patch guilds/[string guild_id]/emojis/[string emoji_id](GuildsEmojisRequest payload, map<string|string[]> headers) returns EmojiResponse|error
update_guild_emoji
Parameters
- payload GuildsEmojisRequest -
Return Type
- EmojiResponse|error - 200 response for update_guild_emoji
patch guilds/[string guild_id]/members/[string user_id]
function patch guilds/[string guild_id]/members/[string user_id](GuildsMembersRequest1 payload, map<string|string[]> headers) returns GuildMemberResponse|error
update_guild_member
Parameters
- payload GuildsMembersRequest1 -
Return Type
- GuildMemberResponse|error - 200 response for update_guild_member
patch guilds/[string guild_id]/members/@me
function patch guilds/[string guild_id]/members/\@me(GuildsMembersMeRequest payload, map<string|string[]> headers) returns PrivateGuildMemberResponse|error
patch guilds/[string guild_id]/roles
function patch guilds/[string guild_id]/roles(GuildsRolesRequest2[] payload, map<string|string[]> headers) returns GuildRoleResponse[]|error
bulk_update_guild_roles
Parameters
- payload GuildsRolesRequest2[] -
Return Type
- GuildRoleResponse[]|error - 200 response for bulk_update_guild_roles
patch guilds/[string guild_id]/roles/[string role_id]
function patch guilds/[string guild_id]/roles/[string role_id](GuildsRolesRequest payload, map<string|string[]> headers) returns GuildRoleResponse|error
update_guild_role
Parameters
- payload GuildsRolesRequest -
Return Type
- GuildRoleResponse|error - 200 response for update_guild_role
patch guilds/[string guild_id]/scheduled-events/[string guild_scheduled_event_id]
function patch guilds/[string guild_id]/scheduled\-events/[string guild_scheduled_event_id](scheduledevents_guild_scheduled_event_id_body payload, map<string|string[]> headers) returns inline_response_200_3|error
update_voice_state
Parameters
Return Type
- inline_response_200_3|error - 204 response for update_voice_state
patch guilds/[string guild_id]/stickers/[string sticker_id]
function patch guilds/[string guild_id]/stickers/[string sticker_id](GuildsStickersRequest payload, map<string|string[]> headers) returns GuildStickerResponse|error
update_guild_sticker
Parameters
- payload GuildsStickersRequest -
Return Type
- GuildStickerResponse|error - 200 response for update_guild_sticker
patch guilds/[string guild_id]/templates/[string code]
function patch guilds/[string guild_id]/templates/[string code](GuildsTemplatesRequest1 payload, map<string|string[]> headers) returns GuildTemplateResponse|error
update_guild_template
Parameters
- payload GuildsTemplatesRequest1 -
Return Type
- GuildTemplateResponse|error - 200 response for update_guild_template
patch guilds/[string guild_id]/voice-states/[string user_id]
function patch guilds/[string guild_id]/voice\-states/[string user_id](GuildsVoiceStatesRequest payload, map<string|string[]> headers) returns Response|error
update_voice_state
Parameters
- payload GuildsVoiceStatesRequest -
patch guilds/[string guild_id]/voice-states/@me
function patch guilds/[string guild_id]/voice\-states/\@me(GuildsVoiceStatesMeRequest payload, map<string|string[]> headers) returns Response|error
patch guilds/[string guild_id]/welcome-screen
function patch guilds/[string guild_id]/welcome\-screen(WelcomeScreenPatchRequestPartial payload, map<string|string[]> headers) returns GuildWelcomeScreenResponse|error
patch guilds/[string guild_id]/widget
function patch guilds/[string guild_id]/widget(GuildsWidgetRequest payload, map<string|string[]> headers) returns WidgetSettingsResponse|error
update_guild_widget_settings
Parameters
- payload GuildsWidgetRequest -
Return Type
- WidgetSettingsResponse|error - 200 response for update_guild_widget_settings
patch stage-instances/[string channel_id]
function patch stage\-instances/[string channel_id](StageInstancesRequest1 payload, map<string|string[]> headers) returns StageInstanceResponse|error
patch users/@me
function patch users/\@me(BotAccountPatchRequest payload, map<string|string[]> headers) returns UserPIIResponse|error
patch webhooks/[string webhook_id]
function patch webhooks/[string webhook_id](WebhooksRequest2 payload, map<string|string[]> headers) returns inline_response_200_4|error
update_webhook
Parameters
- payload WebhooksRequest2 -
Return Type
- inline_response_200_4|error - 200 response for update_webhook
patch webhooks/[string webhook_id]/[string webhook_token]
function patch webhooks/[string webhook_id]/[string webhook_token](WebhooksRequest1 payload, map<string|string[]> headers) returns inline_response_200_4|error
update_webhook_by_token
Parameters
- payload WebhooksRequest1 -
Return Type
- inline_response_200_4|error - 200 response for update_webhook_by_token
patch webhooks/[string webhook_id]/[string webhook_token]/messages/[string message_id]
function patch webhooks/[string webhook_id]/[string webhook_token]/messages/[string message_id](Update_webhook_messageHeaders headers, messages_message_id_body_1 payload, *Update_webhook_messageQueries queries) returns MessageResponse|error
update_webhook_message
Parameters
- headers Update_webhook_messageHeaders - Headers to be sent with the request
- payload messages_message_id_body_1 -
- queries *Update_webhook_messageQueries - Queries to be sent with the request
Return Type
- MessageResponse|error - 200 response for update_webhook_message
patch webhooks/[string webhook_id]/[string webhook_token]/messages/@original
function patch webhooks/[string webhook_id]/[string webhook_token]/messages/\@original(messages_original_body payload, Update_original_webhook_messageHeaders headers, *Update_original_webhook_messageQueries queries) returns MessageResponse|error
Parameters
- payload messages_original_body -
- headers Update_original_webhook_messageHeaders -
- queries *Update_original_webhook_messageQueries -
post applications/[string application_id]/commands
function post applications/[string application_id]/commands(ApplicationCommandCreateRequest payload, map<string|string[]> headers) returns ApplicationCommandResponse|error
create_application_command
Parameters
- payload ApplicationCommandCreateRequest -
Return Type
- ApplicationCommandResponse|error - 200 response for create_application_command
post applications/[string application_id]/entitlements
function post applications/[string application_id]/entitlements(CreateEntitlementRequestData payload, map<string|string[]> headers) returns EntitlementResponse|error
create_entitlement
Parameters
- payload CreateEntitlementRequestData -
Return Type
- EntitlementResponse|error - 200 response for create_entitlement
post applications/[string application_id]/entitlements/[string entitlement_id]/consume
function post applications/[string application_id]/entitlements/[string entitlement_id]/consume(map<string|string[]> headers) returns Response|error
consume_entitlement
post applications/[string application_id]/guilds/[string guild_id]/commands
function post applications/[string application_id]/guilds/[string guild_id]/commands(ApplicationCommandCreateRequest payload, map<string|string[]> headers) returns ApplicationCommandResponse|error
create_guild_application_command
Parameters
- payload ApplicationCommandCreateRequest -
Return Type
- ApplicationCommandResponse|error - 200 response for create_guild_application_command
post channels/[string channel_id]/followers
function post channels/[string channel_id]/followers(ChannelsFollowersRequest payload, map<string|string[]> headers) returns ChannelFollowerResponse|error
follow_channel
Parameters
- payload ChannelsFollowersRequest -
Return Type
- ChannelFollowerResponse|error - 200 response for follow_channel
post channels/[string channel_id]/invites
function post channels/[string channel_id]/invites(channel_id_invites_body payload, map<string|string[]> headers) returns inline_response_200_2|error
create_channel_invite
Parameters
- payload channel_id_invites_body -
Return Type
- inline_response_200_2|error - 200 response for create_channel_invite
post channels/[string channel_id]/messages
function post channels/[string channel_id]/messages(Create_messageHeaders headers, channel_id_messages_body payload) returns MessageResponse|error
create_message
Parameters
- headers Create_messageHeaders - Headers to be sent with the request
- payload channel_id_messages_body -
Return Type
- MessageResponse|error - 200 response for create_message
post channels/[string channel_id]/messages/[string message_id]/crosspost
function post channels/[string channel_id]/messages/[string message_id]/crosspost(map<string|string[]> headers) returns MessageResponse|error
crosspost_message
Return Type
- MessageResponse|error - 200 response for crosspost_message
post channels/[string channel_id]/messages/[string message_id]/threads
function post channels/[string channel_id]/messages/[string message_id]/threads(CreateTextThreadWithMessageRequest payload, map<string|string[]> headers) returns ThreadResponse|error
create_thread_from_message
Parameters
- payload CreateTextThreadWithMessageRequest -
Return Type
- ThreadResponse|error - 201 response for create_thread_from_message
post channels/[string channel_id]/messages/bulk-delete
function post channels/[string channel_id]/messages/bulk\-delete(ChannelsMessagesBulkDeleteRequest payload, map<string|string[]> headers) returns Response|error
post channels/[string channel_id]/threads
function post channels/[string channel_id]/threads(channel_id_threads_body payload, map<string|string[]> headers) returns CreatedThreadResponse|error
create_thread
Parameters
- payload channel_id_threads_body -
Return Type
- CreatedThreadResponse|error - 201 response for create_thread
post channels/[string channel_id]/typing
function post channels/[string channel_id]/typing(map<string|string[]> headers) returns record {}|error
trigger_typing_indicator
Return Type
- record {}|error - 200 response for trigger_typing_indicator
post channels/[string channel_id]/webhooks
function post channels/[string channel_id]/webhooks(ChannelsWebhooksRequest payload, map<string|string[]> headers) returns GuildIncomingWebhookResponse|error
create_webhook
Parameters
- payload ChannelsWebhooksRequest -
Return Type
- GuildIncomingWebhookResponse|error - 200 response for create_webhook
post guilds
function post guilds(GuildCreateRequest payload, map<string|string[]> headers) returns GuildResponse|error
create_guild
Parameters
- payload GuildCreateRequest -
Return Type
- GuildResponse|error - 201 response for create_guild
post guilds/[string guild_id]/auto-moderation/rules
function post guilds/[string guild_id]/auto\-moderation/rules(automoderation_rules_body payload, map<string|string[]> headers) returns inline_response_200_1|error
create_auto_moderation_rule
Parameters
- payload automoderation_rules_body -
Return Type
- inline_response_200_1|error - 200 response for create_auto_moderation_rule
post guilds/[string guild_id]/bulk-ban
function post guilds/[string guild_id]/bulk\-ban(GuildsBulkBanRequest payload, map<string|string[]> headers) returns BulkBanUsersResponse|error
post guilds/[string guild_id]/channels
function post guilds/[string guild_id]/channels(CreateGuildChannelRequest payload, map<string|string[]> headers) returns GuildChannelResponse|error
create_guild_channel
Parameters
- payload CreateGuildChannelRequest -
Return Type
- GuildChannelResponse|error - 201 response for create_guild_channel
post guilds/[string guild_id]/emojis
function post guilds/[string guild_id]/emojis(GuildsEmojisRequest1 payload, map<string|string[]> headers) returns EmojiResponse|error
create_guild_emoji
Parameters
- payload GuildsEmojisRequest1 -
Return Type
- EmojiResponse|error - 201 response for create_guild_emoji
post guilds/[string guild_id]/mfa
function post guilds/[string guild_id]/mfa(GuildMFALevelResponse payload, map<string|string[]> headers) returns GuildMFALevelResponse|error
set_guild_mfa_level
Parameters
- payload GuildMFALevelResponse -
Return Type
- GuildMFALevelResponse|error - 200 response for set_guild_mfa_level
post guilds/[string guild_id]/prune
function post guilds/[string guild_id]/prune(GuildsPruneRequest payload, map<string|string[]> headers) returns GuildPruneResponse|error
prune_guild
Parameters
- payload GuildsPruneRequest -
Return Type
- GuildPruneResponse|error - 200 response for prune_guild
post guilds/[string guild_id]/roles
function post guilds/[string guild_id]/roles(GuildsRolesRequest payload, map<string|string[]> headers) returns GuildRoleResponse|error
create_guild_role
Parameters
- payload GuildsRolesRequest -
Return Type
- GuildRoleResponse|error - 200 response for create_guild_role
post guilds/[string guild_id]/scheduled-events
function post guilds/[string guild_id]/scheduled\-events(guild_id_scheduledevents_body payload, map<string|string[]> headers) returns inline_response_200_3|error
post guilds/[string guild_id]/stickers
function post guilds/[string guild_id]/stickers(guild_id_stickers_body payload, map<string|string[]> headers) returns GuildStickerResponse|error
create_guild_sticker
Parameters
- payload guild_id_stickers_body -
Return Type
- GuildStickerResponse|error - 201 response for create_guild_sticker
post guilds/[string guild_id]/templates
function post guilds/[string guild_id]/templates(GuildsTemplatesRequest2 payload, map<string|string[]> headers) returns GuildTemplateResponse|error
create_guild_template
Parameters
- payload GuildsTemplatesRequest2 -
Return Type
- GuildTemplateResponse|error - 200 response for create_guild_template
post guilds/templates/[string code]
function post guilds/templates/[string code](GuildsTemplatesRequest payload, map<string|string[]> headers) returns GuildResponse|error
create_guild_from_template
Parameters
- payload GuildsTemplatesRequest -
Return Type
- GuildResponse|error - 201 response for create_guild_from_template
post interactions/[string interaction_id]/[string interaction_token]/callback
function post interactions/[string interaction_id]/[string interaction_token]/callback(interaction_token_callback_body payload, map<string|string[]> headers) returns Response|error
create_interaction_response
Parameters
- payload interaction_token_callback_body -
post stage-instances
function post stage\-instances(StageInstancesRequest payload, map<string|string[]> headers) returns StageInstanceResponse|error
post users/@me/channels
function post users/\@me/channels(CreatePrivateChannelRequest payload, map<string|string[]> headers) returns inline_response_200|error
create_dm
Parameters
- payload CreatePrivateChannelRequest -
Return Type
- inline_response_200|error - 200 response for create_dm
post webhooks/[string webhook_id]/[string webhook_token]
function post webhooks/[string webhook_id]/[string webhook_token](webhook_id_webhook_token_body payload, map<string|string[]> headers, *Execute_webhookQueries queries) returns MessageResponse|error
execute_webhook
Parameters
- payload webhook_id_webhook_token_body -
- queries *Execute_webhookQueries - Queries to be sent with the request
Return Type
- MessageResponse|error - 200 response for execute_webhook
post webhooks/[string webhook_id]/[string webhook_token]/github
function post webhooks/[string webhook_id]/[string webhook_token]/github(GithubWebhook payload, map<string|string[]> headers, *Execute_github_compatible_webhookQueries queries) returns Response|error
execute_github_compatible_webhook
Parameters
- payload GithubWebhook -
- queries *Execute_github_compatible_webhookQueries - Queries to be sent with the request
post webhooks/[string webhook_id]/[string webhook_token]/slack
function post webhooks/[string webhook_id]/[string webhook_token]/slack(Execute_slack_compatible_webhookHeaders headers, webhook_token_slack_body payload, *Execute_slack_compatible_webhookQueries queries) returns string?|error
execute_slack_compatible_webhook
Parameters
- headers Execute_slack_compatible_webhookHeaders - Headers to be sent with the request
- payload webhook_token_slack_body -
- queries *Execute_slack_compatible_webhookQueries - Queries to be sent with the request
put applications/[string application_id]/commands
function put applications/[string application_id]/commands(ApplicationCommandUpdateRequest[] payload, map<string|string[]> headers) returns ApplicationCommandResponse[]|error
bulk_set_application_commands
Parameters
- payload ApplicationCommandUpdateRequest[] -
Return Type
- ApplicationCommandResponse[]|error - 200 response for bulk_set_application_commands
put applications/[string application_id]/guilds/[string guild_id]/commands
function put applications/[string application_id]/guilds/[string guild_id]/commands(ApplicationCommandUpdateRequest[] payload, map<string|string[]> headers) returns ApplicationCommandResponse[]|error
bulk_set_guild_application_commands
Parameters
- payload ApplicationCommandUpdateRequest[] -
Return Type
- ApplicationCommandResponse[]|error - 200 response for bulk_set_guild_application_commands
put applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]/permissions
function put applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]/permissions(ApplicationsGuildsCommandsCommandIdPermissionsRequest payload, map<string|string[]> headers) returns CommandPermissionsResponse|error
set_guild_application_command_permissions
Parameters
Return Type
- CommandPermissionsResponse|error - 200 response for set_guild_application_command_permissions
put applications/[string application_id]/role-connections/metadata
function put applications/[string application_id]/role\-connections/metadata(ApplicationRoleConnectionsMetadataItemRequest[] payload, map<string|string[]> headers) returns ApplicationRoleConnectionsMetadataItemResponse[]|error
update_application_role_connections_metadata
Parameters
- payload ApplicationRoleConnectionsMetadataItemRequest[] -
Return Type
- ApplicationRoleConnectionsMetadataItemResponse[]|error - 200 response for update_application_role_connections_metadata
put channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]/@me
function put channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]/\@me(map<string|string[]> headers) returns Response|error
put channels/[string channel_id]/permissions/[string overwrite_id]
function put channels/[string channel_id]/permissions/[string overwrite_id](ChannelsPermissionsRequest payload, map<string|string[]> headers) returns Response|error
set_channel_permission_overwrite
Parameters
- payload ChannelsPermissionsRequest -
put channels/[string channel_id]/pins/[string message_id]
function put channels/[string channel_id]/pins/[string message_id](map<string|string[]> headers) returns Response|error
pin_message
put channels/[string channel_id]/recipients/[string user_id]
function put channels/[string channel_id]/recipients/[string user_id](ChannelsRecipientsRequest payload, map<string|string[]> headers) returns inline_response_200|error
add_group_dm_user
Parameters
- payload ChannelsRecipientsRequest -
Return Type
- inline_response_200|error - 201 response for add_group_dm_user
put channels/[string channel_id]/thread-members/[string user_id]
function put channels/[string channel_id]/thread\-members/[string user_id](map<string|string[]> headers) returns Response|error
add_thread_member
put channels/[string channel_id]/thread-members/@me
function put channels/[string channel_id]/thread\-members/\@me(map<string|string[]> headers) returns Response|error
put guilds/[string guild_id]/bans/[string user_id]
function put guilds/[string guild_id]/bans/[string user_id](GuildsBansRequest payload, map<string|string[]> headers) returns Response|error
ban_user_from_guild
Parameters
- payload GuildsBansRequest -
put guilds/[string guild_id]/members/[string user_id]
function put guilds/[string guild_id]/members/[string user_id](GuildsMembersRequest payload, map<string|string[]> headers) returns GuildMemberResponse|error
add_guild_member
Parameters
- payload GuildsMembersRequest -
Return Type
- GuildMemberResponse|error - 201 response for add_guild_member
put guilds/[string guild_id]/members/[string user_id]/roles/[string role_id]
function put guilds/[string guild_id]/members/[string user_id]/roles/[string role_id](map<string|string[]> headers) returns Response|error
add_guild_member_role
put guilds/[string guild_id]/onboarding
function put guilds/[string guild_id]/onboarding(UpdateGuildOnboardingRequest payload, map<string|string[]> headers) returns GuildOnboardingResponse|error
put_guilds_onboarding
Parameters
- payload UpdateGuildOnboardingRequest -
Return Type
- GuildOnboardingResponse|error - 200 response for put_guilds_onboarding
put guilds/[string guild_id]/templates/[string code]
function put guilds/[string guild_id]/templates/[string code](map<string|string[]> headers) returns GuildTemplateResponse|error
sync_guild_template
Return Type
- GuildTemplateResponse|error - 200 response for sync_guild_template
put users/@me/applications/[string application_id]/role-connection
function put users/\@me/applications/[string application_id]/role\-connection(UsersMeApplicationsRoleConnectionRequest payload, map<string|string[]> headers) returns ApplicationUserRoleConnectionResponse|error
Parameters
- payload UsersMeApplicationsRoleConnectionRequest -
Records
discord: AccountResponse
Fields
- id string -
- name string? -
discord: ActionRow
Fields
- 'type 1 -
- components (Button|ChannelSelect|InputText|MentionableSelect|RoleSelect|StringSelect|UserSelect)[] -
discord: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- Authorization string - Discord bot token
discord: ApplicationCommandAttachmentOption
Fields
- 'type 11 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandAttachmentOptionResponse
Fields
- 'type 11 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandAutocompleteCallbackRequest
Fields
- 'type 8 -
discord: ApplicationCommandBooleanOption
Fields
- 'type 5 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandBooleanOptionResponse
Fields
- 'type 5 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandChannelOption
Fields
- 'type 7 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
- channel_types ChannelTypes[]? -
discord: ApplicationCommandChannelOptionResponse
Fields
- 'type 7 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
- channel_types ChannelTypes[]? -
discord: ApplicationCommandCreateRequest
Fields
- name string -
- name_localizations record { string... }? -
- description string? -
- description_localizations record { string... }? -
- options (anydata)[]? -
- default_member_permissions Signed32? -
- dm_permission boolean? -
- 'type anydata? -
discord: ApplicationCommandIntegerOption
Fields
- 'type 4 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
- autocomplete boolean? -
- choices ApplicationCommandOptionIntegerChoice[]? -
- min_value anydata? -
- max_value anydata? -
discord: ApplicationCommandIntegerOptionResponse
Fields
- 'type 4 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
- autocomplete boolean? -
- choices ApplicationCommandOptionIntegerChoiceResponse[]? -
- min_value anydata? -
- max_value anydata? -
discord: ApplicationCommandMentionableOption
Fields
- 'type 9 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandMentionableOptionResponse
Fields
- 'type 9 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandNumberOption
Fields
- 'type 10 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
- autocomplete boolean? -
- choices ApplicationCommandOptionNumberChoice[]? -
- min_value decimal? -
- max_value decimal? -
discord: ApplicationCommandNumberOptionResponse
Fields
- 'type 10 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
- autocomplete boolean? -
- choices ApplicationCommandOptionNumberChoiceResponse[]? -
- min_value decimal? -
- max_value decimal? -
discord: ApplicationCommandOptionIntegerChoice
Fields
- name string -
- name_localizations record { string... }? -
- value int -
discord: ApplicationCommandOptionIntegerChoiceResponse
Fields
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- value int -
discord: ApplicationCommandOptionNumberChoice
Fields
- name string -
- name_localizations record { string... }? -
- value decimal -
discord: ApplicationCommandOptionNumberChoiceResponse
Fields
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- value decimal -
discord: ApplicationCommandOptionStringChoice
Fields
- name string -
- name_localizations record { string... }? -
- value string -
discord: ApplicationCommandOptionStringChoiceResponse
Fields
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- value string -
discord: ApplicationCommandPatchRequestPartial
Fields
- name string? -
- name_localizations record { string... }? -
- description string? -
- description_localizations record { string... }? -
- options (anydata)[]? -
- default_member_permissions Signed32? -
- dm_permission boolean? -
discord: ApplicationCommandPermission
Fields
- id string -
- 'type ApplicationCommandPermissionType -
- permission boolean -
discord: ApplicationCommandResponse
Fields
- id string -
- application_id string -
- version string -
- default_member_permissions string? -
- 'type ApplicationCommandType -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- guild_id anydata? -
- dm_permission boolean? -
- options (anydata)[]? -
- nsfw boolean? -
discord: ApplicationCommandRoleOption
Fields
- 'type 8 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandRoleOptionResponse
Fields
- 'type 8 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandStringOption
Fields
- 'type 3 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
- autocomplete boolean? -
- min_length Signed32? -
- max_length Signed32? -
- choices ApplicationCommandOptionStringChoice[]? -
discord: ApplicationCommandStringOptionResponse
Fields
- 'type 3 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
- autocomplete boolean? -
- choices ApplicationCommandOptionStringChoiceResponse[]? -
- min_length Signed32? -
- max_length Signed32? -
discord: ApplicationCommandSubcommandGroupOption
Fields
- 'type 2 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
- options ApplicationCommandSubcommandOption[]? -
discord: ApplicationCommandSubcommandGroupOptionResponse
Fields
- 'type 2 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
- options ApplicationCommandSubcommandOptionResponse[]? -
discord: ApplicationCommandSubcommandOption
Fields
- 'type 1 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
- options (anydata)[]? -
discord: ApplicationCommandSubcommandOptionResponse
Fields
- 'type 1 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
- options (anydata)[]? -
discord: ApplicationCommandUpdateRequest
Fields
- name string -
- name_localizations record { string... }? -
- description string? -
- description_localizations record { string... }? -
- options (anydata)[]? -
- default_member_permissions Signed32? -
- dm_permission boolean? -
- 'type anydata? -
- id anydata? -
discord: ApplicationCommandUserOption
Fields
- 'type 6 -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationCommandUserOptionResponse
Fields
- 'type 6 -
- name string -
- name_localized string? -
- name_localizations record { string... }? -
- description string -
- description_localized string? -
- description_localizations record { string... }? -
- required boolean? -
discord: ApplicationFormPartial
Fields
- description anydata? -
- icon record { fileContent byte[], fileName string }? -
- cover_image record { fileContent byte[], fileName string }? -
- team_id anydata? -
- flags Signed32? -
- interactions_endpoint_url string? -
- max_participants Signed32? -
- 'type anydata? -
- tags ApplicationFormPartialTagsItemsString[]? -
- custom_install_url string? -
- install_params anydata? -
- role_connections_verification_url string? -
discord: ApplicationIncomingWebhookResponse
Fields
- application_id anydata? -
- avatar string? -
- channel_id anydata? -
- guild_id anydata? -
- id string -
- name string -
- 'type 3 -
- user anydata? -
discord: ApplicationOAuth2InstallParams
Fields
- scopes OAuth2Scopes[]? -
- permissions Signed32? -
discord: ApplicationOAuth2InstallParamsResponse
Fields
- scopes OAuth2Scopes[] -
- permissions string -
discord: ApplicationResponse
Fields
- id string -
- name string -
- icon string? -
- description string -
- 'type anydata? -
- cover_image string? -
- primary_sku_id anydata? -
- bot anydata? -
- slug string? -
- guild_id anydata? -
- rpc_origins string[]? -
- bot_public boolean? -
- bot_require_code_grant boolean? -
- terms_of_service_url string? -
- privacy_policy_url string? -
- custom_install_url string? -
- install_params anydata? -
- verify_key string -
- flags Signed32 -
- max_participants Signed32? -
- tags string[]? -
discord: ApplicationRoleConnectionsMetadataItemRequest
Fields
- 'type MetadataItemTypes -
- 'key string -
- name string -
- name_localizations record { string?... }? -
- description string -
- description_localizations record { string?... }? -
discord: ApplicationRoleConnectionsMetadataItemResponse
Fields
- 'type MetadataItemTypes -
- 'key string -
- name string -
- name_localizations record { string... }? -
- description string -
- description_localizations record { string... }? -
discord: ApplicationsGuildsCommandsCommandIdPermissionsRequest
Fields
- permissions ApplicationCommandPermission[]? -
discord: ApplicationUserRoleConnectionResponse
Fields
- platform_name string? -
- platform_username string? -
- metadata record { string... }? -
discord: AuditLogEntryResponse
Fields
- id string -
- action_type AuditLogActionTypes -
- user_id anydata? -
- target_id anydata? -
- changes AuditLogObjectChangeResponse[]? -
- options record { string... }? -
- reason string? -
discord: AuditLogObjectChangeResponse
Fields
- 'key string? -
- new_value anydata? -
- old_value anydata? -
discord: BaseCreateMessageCreateRequest
Fields
- content string? -
- embeds RichEmbed[]? -
- allowed_mentions anydata? -
- sticker_ids BaseCreateMessageCreateRequestStickeridsItemsString[]? -
- components ActionRow[]? -
- flags Signed32? -
- attachments MessageAttachmentRequest[]? -
discord: BasicApplicationResponse
Fields
- id string -
- name string -
- icon string? -
- description string -
- 'type anydata? -
- cover_image string? -
- primary_sku_id anydata? -
- bot anydata? -
discord: BasicMessageResponse
Fields
- 'type MessageType -
- channel_id string -
- content string -
- attachments MessageAttachmentResponse[] -
- embeds MessageEmbedResponse[] -
- timestamp string -
- edited_timestamp string? -
- flags Signed32 -
- components (MessageComponentActionRowResponse|MessageComponentButtonResponse|MessageComponentChannelSelectResponse|MessageComponentInputTextResponse|MessageComponentMentionableSelectResponse|MessageComponentRoleSelectResponse|MessageComponentStringSelectResponse|MessageComponentUserSelectResponse)[] -
- resolved anydata? -
- id string -
- author UserResponse -
- mentions UserResponse[] -
- mention_roles BasicMessageResponseMentionrolesItemsString[] -
- pinned boolean -
- mention_everyone boolean -
- tts boolean -
- call anydata? -
- activity anydata? -
- application anydata? -
- application_id anydata? -
- interaction anydata? -
- nonce anydata? -
- webhook_id anydata? -
- message_reference anydata? -
- thread anydata? -
- mention_channels (anydata)[]? -
- stickers (anydata)[]? -
- sticker_items MessageStickerItemResponse[]? -
- role_subscription_data anydata? -
- purchase_notification anydata? -
- position Signed32? -
discord: BlockMessageAction
Fields
- 'type 1 -
- metadata anydata? -
discord: BlockMessageActionMetadata
Fields
- custom_message string? -
discord: BlockMessageActionMetadataResponse
Fields
- custom_message string? -
discord: BlockMessageActionResponse
Fields
- 'type 1 -
- metadata BlockMessageActionMetadataResponse -
discord: BotAccountPatchRequest
Fields
- username string -
- avatar record { fileContent byte[], fileName string }? -
- banner record { fileContent byte[], fileName string }? -
discord: BulkBanUsersResponse
Fields
- banned_users BulkBanUsersResponseBannedusersItemsString[] -
- failed_users BulkBanUsersResponseFailedusersItemsString[] -
discord: Button
Fields
- 'type 2 -
- custom_id string? -
- style ButtonStyleTypes -
- label string? -
- disabled boolean? -
- emoji anydata? -
- url string? -
- sku_id anydata? -
discord: channel_id_messages_body
Fields
- content string? -
- embeds RichEmbed[]? -
- allowed_mentions anydata? -
- sticker_ids channel_id_messages_bodyStickeridsItemsString[]? -
- components ActionRow[]? -
- flags Signed32? -
- attachments MessageAttachmentRequest[]? -
- message_reference anydata? -
- nonce anydata? -
- tts boolean? -
discord: ChannelFollowerResponse
Fields
- channel_id string -
- webhook_id string -
discord: ChannelFollowerWebhookResponse
Fields
- application_id anydata? -
- avatar string? -
- channel_id anydata? -
- guild_id anydata? -
- id string -
- name string -
- 'type 2 -
- user anydata? -
- source_guild anydata? -
- source_channel anydata? -
discord: ChannelPermissionOverwriteRequest
Fields
- id string -
- 'type anydata? -
- allow Signed32? -
- deny Signed32? -
discord: ChannelPermissionOverwriteResponse
Fields
- id string -
- 'type ChannelPermissionOverwrites -
- allow string -
- deny string -
discord: ChannelSelect
Fields
- 'type 8 -
- custom_id string -
- placeholder string? -
- min_values Signed32? -
- max_values Signed32? -
- disabled boolean? -
- default_values ChannelSelectDefaultValue[]? -
- channel_types ChannelTypes[]? -
discord: ChannelSelectDefaultValue
Fields
- 'type "channel" -
- id string -
discord: ChannelsFollowersRequest
Fields
- webhook_channel_id string -
discord: ChannelsMessagesBulkDeleteRequest
Fields
- messages ChannelsMessagesBulkDeleteRequestMessagesItemsString[] -
discord: ChannelsPermissionsRequest
Fields
- 'type anydata? -
- allow Signed32? -
- deny Signed32? -
discord: ChannelsRecipientsRequest
Fields
- access_token string? -
- nick string? -
discord: ChannelsWebhooksRequest
Fields
- name string -
- avatar record { fileContent byte[], fileName string }? -
discord: ClientHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
discord: CommandPermissionResponse
Fields
- id string -
- 'type ApplicationCommandPermissionType -
- permission boolean -
discord: CommandPermissionsResponse
Fields
- id string -
- application_id string -
- guild_id string -
- permissions CommandPermissionResponse[] -
discord: ConnectedAccountGuildResponse
Fields
- id string -
- name string -
- icon string? -
discord: ConnectedAccountIntegrationResponse
Fields
- id string -
- 'type IntegrationTypes -
- account AccountResponse -
- guild ConnectedAccountGuildResponse -
discord: ConnectedAccountResponse
Fields
- id string -
- name string? -
- 'type ConnectedAccountProviders -
- friend_sync boolean -
- integrations ConnectedAccountIntegrationResponse[]? -
- show_activity boolean -
- two_way_link boolean -
- verified boolean -
- visibility ConnectedAccountVisibility -
- revoked boolean? -
discord: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig|OAuth2RefreshTokenGrantConfig|ApiKeysConfig - Provides Auth configurations needed when communicating with a remote HTTP endpoint.
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
discord: Create_messageHeaders
Represents the Headers record for the operation: create_message
Fields
- Content\-Type "application/x-www-form-urlencoded" -
discord: CreatedThreadResponse
Fields
- id string -
- 'type ChannelTypes -
- last_message_id anydata? -
- flags Signed32 -
- last_pin_timestamp string? -
- guild_id string -
- name string -
- parent_id anydata? -
- rate_limit_per_user Signed32? -
- bitrate Signed32? -
- user_limit Signed32? -
- rtc_region string? -
- video_quality_mode anydata? -
- permissions string? -
- owner_id string -
- thread_metadata anydata? -
- message_count Signed32 -
- member_count Signed32 -
- total_message_sent Signed32 -
- applied_tags CreatedThreadResponseAppliedtagsItemsString[]? -
- member anydata? -
discord: CreateEntitlementRequestData
Fields
- sku_id string -
- owner_id string -
- owner_type Signed32 -
discord: CreateForumThreadRequest
Fields
- name string -
- auto_archive_duration anydata? -
- rate_limit_per_user Signed32? -
- applied_tags CreateForumThreadRequestAppliedtagsItemsString[]? -
- message BaseCreateMessageCreateRequest -
discord: CreateGroupDMInviteRequest
Fields
- max_age Signed32? -
discord: CreateGuildChannelRequest
Fields
- 'type anydata? -
- name string -
- position Signed32? -
- topic string? -
- bitrate Signed32? -
- user_limit Signed32? -
- nsfw boolean? -
- rate_limit_per_user Signed32? -
- parent_id anydata? -
- permission_overwrites ChannelPermissionOverwriteRequest[]? -
- rtc_region string? -
- video_quality_mode anydata? -
- default_auto_archive_duration anydata? -
- default_reaction_emoji anydata? -
- default_thread_rate_limit_per_user Signed32? -
- default_sort_order anydata? -
- default_forum_layout anydata? -
- available_tags (anydata)[]? -
discord: CreateGuildInviteRequest
Fields
- max_age Signed32? -
- temporary boolean? -
- max_uses Signed32? -
- unique boolean? -
- target_user_id anydata? -
- target_application_id anydata? -
- target_type anydata? -
discord: CreateGuildRequestChannelItem
Fields
- 'type anydata? -
- name string -
- position Signed32? -
- topic string? -
- bitrate Signed32? -
- user_limit Signed32? -
- nsfw boolean? -
- rate_limit_per_user Signed32? -
- parent_id anydata? -
- permission_overwrites ChannelPermissionOverwriteRequest[]? -
- rtc_region string? -
- video_quality_mode anydata? -
- default_auto_archive_duration anydata? -
- default_reaction_emoji anydata? -
- default_thread_rate_limit_per_user Signed32? -
- default_sort_order anydata? -
- default_forum_layout anydata? -
- id anydata? -
- available_tags CreateOrUpdateThreadTagRequest[]? -
discord: CreateGuildRequestRoleItem
Fields
- id Signed32 -
- name string? -
- permissions Signed32? -
- color Signed32? -
- hoist boolean? -
- mentionable boolean? -
- unicode_emoji string? -
discord: CreateMessageInteractionCallbackRequest
Fields
- 'type InteractionCallbackTypes -
- data anydata? -
discord: CreateOrUpdateThreadTagRequest
Fields
- name string -
- emoji_id anydata? -
- emoji_name string? -
- moderated boolean? -
discord: CreatePrivateChannelRequest
Fields
- recipient_id anydata? -
- access_tokens CreatePrivateChannelRequestAccesstokensItemsString[]? -
- nicks record { string?... }? -
discord: CreateTextThreadWithMessageRequest
Fields
- name string -
- auto_archive_duration anydata? -
- rate_limit_per_user Signed32? -
discord: CreateTextThreadWithoutMessageRequest
Fields
- name string -
- auto_archive_duration anydata? -
- rate_limit_per_user Signed32? -
- 'type anydata? -
- invitable boolean? -
discord: DefaultKeywordListTriggerMetadata
Fields
- allow_list DefaultKeywordListTriggerMetadataAllowlistItemsString[]? -
- presets AutomodKeywordPresetType[]? -
discord: DefaultKeywordListTriggerMetadataResponse
Fields
- allow_list string[] -
- presets AutomodKeywordPresetType[] -
discord: DefaultKeywordListUpsertRequest
Fields
- name string -
- event_type AutomodEventType -
- actions (anydata)[]? -
- enabled boolean? -
- exempt_roles DefaultKeywordListUpsertRequestExemptrolesItemsString[]? -
- exempt_channels DefaultKeywordListUpsertRequestExemptchannelsItemsString[]? -
- trigger_type 4 -
- trigger_metadata DefaultKeywordListTriggerMetadata -
discord: DefaultKeywordListUpsertRequestPartial
Fields
- name string? -
- event_type AutomodEventType? -
- actions (anydata)[]? -
- enabled boolean? -
- exempt_roles DefaultKeywordListUpsertRequestPartialExemptrolesItemsString[]? -
- exempt_channels DefaultKeywordListUpsertRequestPartialExemptchannelsItemsString[]? -
- trigger_type AutomodTriggerType? -
- trigger_metadata DefaultKeywordListTriggerMetadata? -
discord: DefaultKeywordRuleResponse
Fields
- id string -
- guild_id string -
- creator_id string -
- name string -
- event_type AutomodEventType -
- trigger_type 4 -
- enabled boolean? -
- exempt_roles DefaultKeywordRuleResponseExemptrolesItemsString[]? -
- exempt_channels DefaultKeywordRuleResponseExemptchannelsItemsString[]? -
- trigger_metadata DefaultKeywordListTriggerMetadataResponse -
discord: DefaultReactionEmojiResponse
Fields
- emoji_id anydata? -
- emoji_name string? -
discord: Delete_original_webhook_messageQueries
Represents the Queries record for the operation: delete_original_webhook_message
Fields
- thread_id string? -
discord: Delete_webhook_messageQueries
Represents the Queries record for the operation: delete_webhook_message
Fields
- thread_id string? -
discord: DiscordIntegrationResponse
Fields
- 'type "discord" -
- name string? -
- account anydata? -
- enabled boolean? -
- id string -
- application IntegrationApplicationResponse -
- scopes OAuth2Scopes[] -
- user anydata? -
discord: Emoji
Fields
- id anydata? -
- name string -
- animated boolean? -
discord: EmojiResponse
Fields
- id string -
- name string -
- user anydata? -
- roles EmojiResponseRolesItemsString[] -
- require_colons boolean -
- managed boolean -
- animated boolean -
- available boolean -
discord: EntitlementResponse
Fields
- id string -
- sku_id string -
- application_id string -
- user_id string -
- guild_id anydata? -
- deleted boolean -
- starts_at string? -
- ends_at string? -
- 'type EntitlementTypes -
- fulfilled_at string? -
- fulfillment_status anydata? -
- consumed boolean? -
discord: EntityMetadataExternal
Fields
- location string -
discord: EntityMetadataExternalResponse
Fields
- location string -
discord: Execute_github_compatible_webhookQueries
Represents the Queries record for the operation: execute_github_compatible_webhook
Fields
- 'wait boolean? -
- thread_id string? -
discord: Execute_slack_compatible_webhookHeaders
Represents the Headers record for the operation: execute_slack_compatible_webhook
Fields
- Content\-Type "application/x-www-form-urlencoded" -
discord: Execute_slack_compatible_webhookQueries
Represents the Queries record for the operation: execute_slack_compatible_webhook
Fields
- 'wait boolean? -
- thread_id string? -
discord: Execute_webhookQueries
Represents the Queries record for the operation: execute_webhook
Fields
- 'wait boolean? -
- thread_id string? -
discord: ExternalConnectionIntegrationResponse
Fields
- 'type IntegrationTypes -
- name string? -
- account anydata? -
- enabled boolean? -
- id string -
- user UserResponse -
- revoked boolean? -
- expire_behavior anydata? -
- expire_grace_period anydata? -
- subscriber_count Signed32? -
- synced_at string? -
- role_id anydata? -
- syncing boolean? -
- enable_emoticons boolean? -
discord: ExternalScheduledEventCreateRequest
Fields
- name string -
- description string? -
- image record { fileContent byte[], fileName string }? -
- scheduled_start_time string -
- scheduled_end_time string? -
- privacy_level GuildScheduledEventPrivacyLevels -
- entity_type 3 -
- channel_id anydata? -
- entity_metadata EntityMetadataExternal -
discord: ExternalScheduledEventPatchRequestPartial
Fields
- status anydata? -
- name string? -
- description string? -
- image record { fileContent byte[], fileName string }? -
- scheduled_start_time string? -
- scheduled_end_time string? -
- entity_type anydata? -
- privacy_level GuildScheduledEventPrivacyLevels? -
- channel_id anydata? -
- entity_metadata EntityMetadataExternal? -
discord: ExternalScheduledEventResponse
Fields
- id string -
- guild_id string -
- name string -
- description string? -
- channel_id anydata? -
- creator_id anydata? -
- creator anydata? -
- image string? -
- scheduled_start_time string -
- scheduled_end_time string? -
- status GuildScheduledEventStatuses -
- entity_type 3 -
- entity_id anydata? -
- user_count Signed32? -
- privacy_level GuildScheduledEventPrivacyLevels -
- user_rsvp anydata? -
- entity_metadata EntityMetadataExternalResponse -
discord: FlagToChannelAction
Fields
- 'type 2 -
- metadata FlagToChannelActionMetadata -
discord: FlagToChannelActionMetadata
Fields
- channel_id string -
discord: FlagToChannelActionMetadataResponse
Fields
- channel_id string -
discord: FlagToChannelActionResponse
Fields
- 'type 2 -
- metadata FlagToChannelActionMetadataResponse -
discord: ForumTagResponse
Fields
- id string -
- name string -
- moderated boolean -
- emoji_id anydata? -
- emoji_name string? -
discord: FriendInviteResponse
Fields
- 'type anydata? -
- code string -
- inviter anydata? -
- max_age Signed32? -
- created_at string? -
- expires_at string? -
- friends_count Signed32? -
- channel anydata? -
- is_contact boolean? -
- uses Signed32? -
- max_uses Signed32? -
- flags Signed32? -
discord: GatewayBotResponse
Fields
- url string -
- session_start_limit GatewayBotSessionStartLimitResponse -
- shards Signed32 -
discord: GatewayBotSessionStartLimitResponse
Fields
- max_concurrency Signed32 -
- remaining Signed32 -
- reset_after Signed32 -
- total Signed32 -
discord: GatewayResponse
Fields
- url string -
discord: Get_entitlementsQueries
Represents the Queries record for the operation: get_entitlements
Fields
- exclude_ended boolean? -
- user_id string? -
- before string? -
- sku_ids sku_ids -
- guild_id string? -
- 'limit Signed32? -
- after string? -
- only_active boolean? -
discord: Get_guild_scheduled_eventQueries
Represents the Queries record for the operation: get_guild_scheduled_event
Fields
- with_user_count boolean? -
discord: Get_guild_widget_pngQueries
Represents the Queries record for the operation: get_guild_widget_png
Fields
- style WidgetImageStyles? -
discord: Get_guildQueries
Represents the Queries record for the operation: get_guild
Fields
- with_counts boolean? -
discord: Get_original_webhook_messageQueries
Represents the Queries record for the operation: get_original_webhook_message
Fields
- thread_id string? -
discord: Get_thread_memberQueries
Represents the Queries record for the operation: get_thread_member
Fields
- with_member boolean? -
discord: Get_webhook_messageQueries
Represents the Queries record for the operation: get_webhook_message
Fields
- thread_id string? -
discord: GithubAuthor
Fields
- username string? -
- name string -
discord: GithubCheckApp
Fields
- name string -
discord: GithubCheckPullRequest
Fields
- number Signed32 -
discord: GithubCheckRun
Fields
- conclusion string? -
- name string -
- html_url string -
- check_suite GithubCheckSuite -
- details_url string? -
- output anydata? -
- pull_requests GithubCheckPullRequest[]? -
discord: GithubCheckRunOutput
Fields
- title string? -
- summary string? -
discord: GithubCheckSuite
Fields
- conclusion string? -
- head_branch string? -
- head_sha string -
- pull_requests GithubCheckPullRequest[]? -
- app GithubCheckApp -
discord: GithubComment
Fields
- id Signed32 -
- html_url string -
- user GithubUser -
- commit_id string? -
- body string -
discord: GithubCommit
Fields
- id string -
- url string -
- message string -
- author GithubAuthor -
discord: GithubDiscussion
Fields
- title string -
- number Signed32 -
- html_url string -
- answer_html_url string? -
- body string? -
- user GithubUser -
discord: GithubIssue
Fields
- id Signed32 -
- number Signed32 -
- html_url string -
- user GithubUser -
- title string -
- body string? -
- pull_request anydata? -
discord: GithubRelease
Fields
- id Signed32 -
- tag_name string -
- html_url string -
- author GithubUser -
discord: GithubRepository
Fields
- id Signed32 -
- html_url string -
- name string -
- full_name string -
discord: GithubReview
Fields
- user GithubUser -
- body string? -
- html_url string -
- state string -
discord: GithubUser
Fields
- id Signed32 -
- login string -
- html_url string -
- avatar_url string -
discord: GithubWebhook
Fields
- action string? -
- ref string? -
- ref_type string? -
- comment anydata? -
- issue anydata? -
- pull_request anydata? -
- repository anydata? -
- forkee anydata? -
- sender GithubUser -
- member anydata? -
- release anydata? -
- head_commit anydata? -
- commits GithubCommit[]? -
- forced boolean? -
- compare string? -
- review anydata? -
- check_run anydata? -
- check_suite anydata? -
- discussion anydata? -
- answer anydata? -
discord: GroupDMInviteResponse
Fields
- 'type anydata? -
- code string -
- inviter anydata? -
- max_age Signed32? -
- created_at string? -
- expires_at string? -
- channel anydata? -
- approximate_member_count Signed32? -
discord: guild_id_stickers_body
Fields
- name string -
- tags string -
- description string? -
- file record { fileContent byte[], fileName string } -
discord: GuildAuditLogResponse
Fields
- audit_log_entries AuditLogEntryResponse[] -
- users UserResponse[] -
- guild_scheduled_events (ExternalScheduledEventResponse|StageScheduledEventResponse|VoiceScheduledEventResponse)[] -
- threads ThreadResponse[] -
- application_commands ApplicationCommandResponse[] -
- auto_moderation_rules (DefaultKeywordRuleResponse|KeywordRuleResponse|MLSpamRuleResponse|MentionSpamRuleResponse|SpamLinkRuleResponse)[] -
discord: GuildBanResponse
Fields
- user UserResponse -
- reason string? -
discord: GuildChannelResponse
Fields
- id string -
- 'type ChannelTypes -
- last_message_id anydata? -
- flags Signed32 -
- last_pin_timestamp string? -
- guild_id string -
- name string -
- parent_id anydata? -
- rate_limit_per_user Signed32? -
- bitrate Signed32? -
- user_limit Signed32? -
- rtc_region string? -
- video_quality_mode anydata? -
- permissions string? -
- topic string? -
- default_auto_archive_duration anydata? -
- default_thread_rate_limit_per_user Signed32? -
- position Signed32 -
- permission_overwrites ChannelPermissionOverwriteResponse[]? -
- nsfw boolean? -
- available_tags ForumTagResponse[]? -
- default_reaction_emoji anydata? -
- default_sort_order anydata? -
- default_forum_layout anydata? -
discord: GuildCreateRequest
Fields
- description string? -
- name string -
- region string? -
- icon record { fileContent byte[], fileName string }? -
- verification_level anydata? -
- default_message_notifications anydata? -
- explicit_content_filter anydata? -
- preferred_locale anydata? -
- afk_timeout anydata? -
- roles CreateGuildRequestRoleItem[]? -
- channels CreateGuildRequestChannelItem[]? -
- afk_channel_id anydata? -
- system_channel_id anydata? -
- system_channel_flags Signed32? -
discord: GuildHomeSettingsResponse
Fields
- guild_id string -
- enabled boolean -
- welcome_message anydata? -
- new_member_actions (anydata)[]? -
- resource_channels (anydata)[]? -
discord: GuildIncomingWebhookResponse
Fields
- application_id anydata? -
- avatar string? -
- channel_id anydata? -
- guild_id anydata? -
- id string -
- name string -
- 'type 1 -
- user anydata? -
- token string? -
- url string? -
discord: GuildInviteResponse
Fields
- 'type anydata? -
- code string -
- inviter anydata? -
- max_age Signed32? -
- created_at string? -
- expires_at string? -
- is_contact boolean? -
- flags Signed32? -
- guild anydata? -
- guild_id anydata? -
- channel anydata? -
- stage_instance anydata? -
- target_type anydata? -
- target_user anydata? -
- target_application anydata? -
- guild_scheduled_event anydata? -
- uses Signed32? -
- max_uses Signed32? -
- temporary boolean? -
- approximate_member_count Signed32? -
- approximate_presence_count Signed32? -
discord: GuildMemberResponse
Fields
- avatar string? -
- avatar_decoration_data anydata? -
- communication_disabled_until string? -
- flags Signed32 -
- joined_at string -
- nick string? -
- pending boolean -
- premium_since string? -
- roles GuildMemberResponseRolesItemsString[] -
- user UserResponse -
- mute boolean -
- deaf boolean -
discord: GuildMFALevelResponse
Fields
- level GuildMFALevel -
discord: GuildOnboardingResponse
Fields
- guild_id string -
- prompts OnboardingPromptResponse[] -
- default_channel_ids GuildOnboardingResponseDefaultchannelidsItemsString[] -
- enabled boolean -
discord: GuildPatchRequestPartial
Fields
- name string? -
- description string? -
- region string? -
- icon record { fileContent byte[], fileName string }? -
- verification_level anydata? -
- default_message_notifications anydata? -
- explicit_content_filter anydata? -
- preferred_locale anydata? -
- afk_timeout anydata? -
- afk_channel_id anydata? -
- system_channel_id anydata? -
- owner_id string? -
- splash record { fileContent byte[], fileName string }? -
- banner record { fileContent byte[], fileName string }? -
- system_channel_flags Signed32? -
- features GuildPatchRequestPartialFeaturesItemsString[]? -
- discovery_splash record { fileContent byte[], fileName string }? -
- home_header record { fileContent byte[], fileName string }? -
- rules_channel_id anydata? -
- safety_alerts_channel_id anydata? -
- public_updates_channel_id anydata? -
- premium_progress_bar_enabled boolean? -
discord: GuildPreviewResponse
Fields
- id string -
- name string -
- icon string? -
- description string? -
- home_header string? -
- splash string? -
- discovery_splash string? -
- features GuildFeatures[] -
- approximate_member_count Signed32 -
- approximate_presence_count Signed32 -
- emojis EmojiResponse[] -
- stickers GuildStickerResponse[] -
discord: GuildProductPurchaseResponse
Fields
- listing_id string -
- product_name string -
discord: GuildPruneResponse
Fields
- pruned Signed32? -
discord: GuildResponse
Fields
- id string -
- name string -
- icon string? -
- description string? -
- home_header string? -
- splash string? -
- discovery_splash string? -
- features GuildFeatures[] -
- banner string? -
- owner_id string -
- application_id anydata? -
- region string -
- afk_channel_id anydata? -
- afk_timeout AfkTimeouts -
- system_channel_id anydata? -
- system_channel_flags Signed32 -
- widget_enabled boolean -
- widget_channel_id anydata? -
- verification_level VerificationLevels -
- roles GuildRoleResponse[] -
- default_message_notifications UserNotificationSettings -
- mfa_level GuildMFALevel -
- explicit_content_filter GuildExplicitContentFilterTypes -
- max_presences Signed32? -
- max_members Signed32? -
- max_stage_video_channel_users Signed32? -
- max_video_channel_users Signed32? -
- vanity_url_code string? -
- premium_tier PremiumGuildTiers -
- premium_subscription_count Signed32 -
- preferred_locale AvailableLocalesEnum -
- rules_channel_id anydata? -
- safety_alerts_channel_id anydata? -
- public_updates_channel_id anydata? -
- premium_progress_bar_enabled boolean -
- nsfw boolean -
- nsfw_level GuildNSFWContentLevel -
- emojis EmojiResponse[] -
- stickers GuildStickerResponse[] -
discord: GuildRoleResponse
Fields
- id string -
- name string -
- description string? -
- permissions string -
- position Signed32 -
- color Signed32 -
- hoist boolean -
- managed boolean -
- mentionable boolean -
- icon string? -
- unicode_emoji string? -
- tags anydata? -
discord: GuildRoleTagsResponse
Fields
- premium_subscriber string? -
- bot_id anydata? -
- integration_id anydata? -
- subscription_listing_id anydata? -
- available_for_purchase string? -
- guild_connections string? -
discord: GuildsBansRequest
Fields
- delete_message_seconds Signed32? -
- delete_message_days Signed32? -
discord: GuildsBulkBanRequest
Fields
- user_ids GuildsBulkBanRequestUseridsItemsString[] -
- delete_message_seconds Signed32? -
discord: GuildsChannelsRequest
Fields
- id string? -
- position Signed32? -
- parent_id anydata? -
- lock_permissions boolean? -
discord: GuildsEmojisRequest
Fields
- name string? -
- roles (anydata)[]? -
discord: GuildsEmojisRequest1
Fields
- name string -
- image record { fileContent byte[], fileName string } -
- roles (anydata)[]? -
discord: GuildsMembersMeRequest
Fields
- nick string? -
discord: GuildsMembersRequest
Fields
- nick string? -
- roles (anydata)[]? -
- mute boolean? -
- deaf boolean? -
- access_token string -
- flags