grom - v7.0.0-beta.2.0

grom

Types

ActionRowComponent

</> 
pub type ActionRowComponent {
  ActionRowButton(MessageButton)
  ActionRowStringSelect(MessageStringSelect)
  ActionRowUserSelect(MessageUserSelect)
  ActionRowRoleSelect(MessageRoleSelect)
  ActionRowMentionableSelect(MessageMentionableSelect)
  ActionRowChannelSelect(MessageChannelSelect)
}

Constructors

AfkTimeout

</>

Represents the time after which an AFK person will be moved to an AFK channel, if one is present.

pub type AfkTimeout {
  AfkTimeout60Seconds
  AfkTimeout300Seconds
  AfkTimeout900Seconds
  AfkTimeout1800Seconds
  AfkTimeout3600Seconds
}

Constructors 

  • AfkTimeout60Seconds

    After 1 minute.

  • AfkTimeout300Seconds

    After 5 minutes.

  • AfkTimeout900Seconds

    After 15 minutes.

  • AfkTimeout1800Seconds

    After 30 minutes.

  • AfkTimeout3600Seconds

    After 60 minutes.

AllowedMessageMention

</>

This type controls which persons get notified after mentioning them in a message.

This type will always be used as a special unique list - you cannot reuse the same variant.

That means that, i.e.

[
  AllowMentioningUsers(AllowMentioningAllUsers),
  AllowMentioningUsers(AllowMentioningSpecificUsers([some_id]))
]

is not a valid allowed mention.

In that case, the more specific allowed mention will be given priority. If multiple specific mentions are passed, only the first will be used.

If an empty list is passed (which is the default Grom behavior), contrary to default Discord behavior, no mentions will be allowed to notify users, to prevent abuse.

pub type AllowedMessageMention {
  AllowMentioningRoles(AllowedRoleMentions)
  AllowMentioningUsers(AllowedUserMentions)
  AllowMentioningAtEveryone
  AllowMentioningRepliedUser
}

Constructors 

  • AllowMentioningRoles(AllowedRoleMentions)
  • AllowMentioningUsers(AllowedUserMentions)
  • AllowMentioningAtEveryone

    Allows mentioning @everyone and @here.

    Requires the AllowMentioningEveryone permission - otherwise ineffective.

  • AllowMentioningRepliedUser

AllowedRoleMentions

</> 
pub type AllowedRoleMentions {
  AllowMentioningAllRoles
  AllowMentioningSpecificRoles(ids: List(Snowflake(Role)))
}

Constructors 

  • AllowMentioningAllRoles
  • AllowMentioningSpecificRoles(ids: List(Snowflake(Role)))

AllowedUserMentions

</> 
pub type AllowedUserMentions {
  AllowMentioningAllUsers
  AllowMentioningSpecificUsers(ids: List(Snowflake(User)))
}

Constructors 

  • AllowMentioningAllUsers
  • AllowMentioningSpecificUsers(ids: List(Snowflake(User)))

AnnouncementChannel

</> 
pub type AnnouncementChannel {
  AnnouncementChannel(
    id: Snowflake(AnnouncementChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    thread_creatable_channel_id: Snowflake(ThreadCreatableChannel),
    permission_overwrites: List(PermissionOverwrite),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    last_pin_timestamp: option.Option(timestamp.Timestamp),
    default_thread_auto_archive_duration: ThreadAutoArchiveDuration,
    parent_id: option.Option(Snowflake(CategoryChannel)),
  )
}

Constructors

Application

</> 
pub type Application {
  Application(
    id: Snowflake(Application),
    name: String,
    icon_hash: option.Option(ImageHash),
    description: String,
    rpc_origins: option.Option(List(String)),
    is_bot_public: Bool,
    bot_requires_code_grant: Bool,
    bot: option.Option(User),
    terms_of_service_url: option.Option(String),
    privacy_policy_url: option.Option(String),
    owner: ApplicationOwner,
    verify_key: String,
    guild: option.Option(Guild),
    primary_sku_id: option.Option(Snowflake(Sku)),
    slug: option.Option(String),
    cover_image_hash: option.Option(ImageHash),
    flags: List(ApplicationFlag),
    approximate_guild_count: option.Option(Int),
    approximate_user_install_count: option.Option(Int),
    approximate_user_authorization_count: option.Option(Int),
    redirect_uris: List(String),
    interactions_endpoint_url: option.Option(String),
    role_connections_verification_url: option.Option(String),
    webhook_events_url: option.Option(String),
    webhook_events_status: ApplicationWebhookEventStatus,
    webhook_events_types: option.Option(List(String)),
    tags: List(String),
    in_app_installation_settings: option.Option(
      ApplicationInstallationSettings,
    ),
    guild_installation_settings: option.Option(
      ApplicationInstallationSettings,
    ),
    user_installation_settings: option.Option(
      ApplicationInstallationSettings,
    ),
    custom_installation_url: option.Option(String),
  )
}

Constructors 

  • Application(
  id: Snowflake(Application),
  name: String,
  icon_hash: option.Option(ImageHash),
  description: String,
  rpc_origins: option.Option(List(String)),
  is_bot_public: Bool,
  bot_requires_code_grant: Bool,
  bot: option.Option(User),
  terms_of_service_url: option.Option(String),
  privacy_policy_url: option.Option(String),
  owner: ApplicationOwner,
  verify_key: String,
  guild: option.Option(Guild),
  primary_sku_id: option.Option(Snowflake(Sku)),
  slug: option.Option(String),
  cover_image_hash: option.Option(ImageHash),
  flags: List(ApplicationFlag),
  approximate_guild_count: option.Option(Int),
  approximate_user_install_count: option.Option(Int),
  approximate_user_authorization_count: option.Option(Int),
  redirect_uris: List(String),
  interactions_endpoint_url: option.Option(String),
  role_connections_verification_url: option.Option(String),
  webhook_events_url: option.Option(String),
  webhook_events_status: ApplicationWebhookEventStatus,
  webhook_events_types: option.Option(List(String)),
  tags: List(String),
  in_app_installation_settings: option.Option(
    ApplicationInstallationSettings,
  ),
  guild_installation_settings: option.Option(
    ApplicationInstallationSettings,
  ),
  user_installation_settings: option.Option(
    ApplicationInstallationSettings,
  ),
  custom_installation_url: option.Option(String),
)

    Arguments

    description

    Appears in a bot’s biography.

    rpc_origins

    List of RPC origin URLs, if RPC is enabled.

    is_bot_public

    If False, only the owner can add the app to guilds.

    bot_requires_code_grant

    If True, the bot will only join a guild upon completion of the full OAuth2 code grant flow.

    bot

    Is None if there’s no bot associated with the app.

    terms_of_service_url

    The app’s Terms of Service.

    Is None if the developer didn’t specify any Terms of Service.

    privacy_policy_url

    The app’s Privacy Policy.

    Is None if the developer didn’t specify any Privacy Policy.

    guild

    Guild associated with the app - for example, a developer support server.

    primary_sku_id

    If this app is a game sold on Discord, this field will be the ID of the Game SKU.

    slug

    If this app is a game sold on Discord, this field will be the URL slug that links to the store page.

    cover_image_hash

    Default rich presence invite cover image.

    approximate_guild_count

    Approximately, how many guilds has the app been added to?

    Is None if not computed yet.

    approximate_user_install_count

    Approximately, how many users installed the app?

    Is None if not computed yet.

    approximate_user_authorization_count

    Approximately, how many users have completed OAuth2 authorizations for the app?

    Is None if not computed yet.

    redirect_uris

    OAuth2 redirect URIs.

    interactions_endpoint_url

    The URL for webhook-based interactions.

    role_connections_verification_url

    The URL for verification to link an app to a user’s Discord profile.

    webhook_events_url

    The URL for webhook-based events.

    webhook_events_types

    The types of events the application is subscribed to (if any)

    tags

    A list of maximum 5 tags describing the application.

    in_app_installation_settings

    Installation settings for the default in-app authorization link.

    guild_installation_settings

    Default installation settings for guild installation.

    user_installation_settings

    Default installation settings for user installation.

    custom_installation_url

    Custom authorization URL.

ApplicationEmoji

</> 
pub type ApplicationEmoji {
  ApplicationEmoji(
    id: Snowflake(Emoji),
    name: String,
    creator: User,
    allowed_roles_ids: option.Option(List(Snowflake(Role))),
    requires_colons: Bool,
    is_integration_managed: Bool,
    is_animated: Bool,
    is_available: Bool,
  )
}

Constructors 

  • ApplicationEmoji(
  id: Snowflake(Emoji),
  name: String,
  creator: User,
  allowed_roles_ids: option.Option(List(Snowflake(Role))),
  requires_colons: Bool,
  is_integration_managed: Bool,
  is_animated: Bool,
  is_available: Bool,
)

    Arguments

    allowed_roles_ids

    Is None if the emoji is not restricted on a per-role basis.

    requires_colons

    Whether this emoji must be wrapped in colons.

    is_integration_managed

    Whether this emoji is managed by an integration.

ApplicationFlag

</> 
pub type ApplicationFlag {
  ApplicationCreatedAutoModerationRule
  ApplicationApprovedForPresenceIntent
  ApplicationTemporarilyApprovedForPresenceIntent
  ApplicationApprovedForGuildMembersIntent
  ApplicationTemporarilyApprovedForGuildMembersIntent
  ApplicationGrowsUnusuallyFast
  ApplicationIsEmbedded
  ApplicationApprovedForMessageContentIntent
  ApplicationTemporarilyApprovedForMessageContentIntent
  ApplicationRegisteredGlobalCommand
}

Constructors 

  • ApplicationCreatedAutoModerationRule

    The application was awarded a badge for creating an auto moderation rule

  • ApplicationApprovedForPresenceIntent

    The application is approved for the privileged presence intent. (100+ guilds)

  • ApplicationTemporarilyApprovedForPresenceIntent

    The application is temporarily approved for the privileged presence intent (0-99 guilds)

  • ApplicationApprovedForGuildMembersIntent

    The application is approved for the privileged guild members intent. (100+ guilds)

  • ApplicationTemporarilyApprovedForGuildMembersIntent

    The application is temporarily approved for the privileged guild members intent (0-99 guilds)

  • ApplicationGrowsUnusuallyFast

    Indicates unusual growth of an app that prevents verification.

  • ApplicationIsEmbedded

    The application is embedded within the Discord client (unavailable publicly)

  • ApplicationApprovedForMessageContentIntent

    The application is approved for the privileged message content intent. (100+ guilds)

  • ApplicationTemporarilyApprovedForMessageContentIntent

    The application is temporarily approved for the privileged message content intent (0-99 guilds)

  • ApplicationRegisteredGlobalCommand

    The application was awarded a badge for creating a global command

ApplicationInstallationSettings

</>

Describes variable values during application installation.

pub type ApplicationInstallationSettings {
  ApplicationInstallationSettings(
    scopes: List(String),
    permissions: List(Permission),
  )
}

Constructors 

  • ApplicationInstallationSettings(
  scopes: List(String),
  permissions: List(Permission),
)

    Arguments

    scopes

    The OAuth2 scopes the app will be installed with.

    permissions

    The permissions the app will be installed with.

ApplicationInstallationType

</> 
pub type ApplicationInstallationType {
  GuildInstalledApplication
  UserInstalledApplication
}

Constructors 

  • GuildInstalledApplication

    A guild installed application allows all members of the guild to use its functionality.

    They may also receive permissions in the guild and execute permission-restricted actions, such as kicking members.

  • UserInstalledApplication

    A user installed application only allows the user who installed it to themselves to use its functionality.

    User installed applications cannot receive guild permissions - they can only respond to interactions.

    In DMs, the interaction response will be posted to all recipients.

    In guilds, whether the response will be ephemeral depends on whether the executing user has the AllowUsingExternalApplications permission.

ApplicationOwner

</> 
pub type ApplicationOwner {
  ApplicationOwnerUser(user: User)
  ApplicationOwnerTeam(team: DeveloperTeam)
}

Constructors

ApplicationWebhookEventStatus

</> 
pub type ApplicationWebhookEventStatus {
  ApplicationWebhookEventsDisabled
  ApplicationWebhookEventsEnabled
  ApplicationWebhookEventsDisabledByDiscord
}

Constructors 

  • ApplicationWebhookEventsDisabled

    The application isn’t receiving webhook events

  • ApplicationWebhookEventsEnabled

    The application’s receiving webhook events

  • ApplicationWebhookEventsDisabledByDiscord

    The application’s webhook events were disabled by Discord (usually due to inactivity)

AttachmentSlashCommandOption

</> 
pub type AttachmentSlashCommandOption {
  AttachmentSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
    file_types: List(FileUploadFilter),
  )
}

Constructors

AudioMessageAttachment

</> 
pub type AudioMessageAttachment {
  AudioMessageAttachment(duration: duration.Duration)
}

Constructors

AutocompleteRequestCommand

</>

This is always a slash command.

pub type AutocompleteRequestCommand {
  AutocompleteRequestCommand(
    id: Snowflake(Command),
    slash_command_id: Snowflake(SlashCommand),
    name: String,
    guild_id: option.Option(Snowflake(Guild)),
    options: List(AutocompleteRequestCommandOption),
    resolved_objects: InteractionResolvedObjects,
  )
}

Constructors

AutocompleteRequestCommandOption

</> 
pub type AutocompleteRequestCommandOption {
  AutocompleteRequestCommandOptionSubCommand(
    AutocompleteRequestSubCommandCommandOption,
  )
  AutocompleteRequestCommandOptionSubCommandGroup(
    AutocompleteRequestSubCommandGroupCommandOption,
  )
  AutocompleteRequestCommandOptionString(
    AutocompleteRequestStringCommandOption,
  )
  AutocompleteRequestCommandOptionInt(
    AutocompleteRequestIntCommandOption,
  )
  AutocompleteRequestCommandOptionFloat(
    AutocompleteRequestFloatCommandOption,
  )
}

Constructors

AutocompleteRequestFloatCommandOption

</> 
pub type AutocompleteRequestFloatCommandOption {
  AutocompleteRequestFloatCommandOption(
    name: String,
    value: Float,
    is_focused: Bool,
  )
}

Constructors 

  • AutocompleteRequestFloatCommandOption(
  name: String,
  value: Float,
  is_focused: Bool,
)

AutocompleteRequestIntCommandOption

</> 
pub type AutocompleteRequestIntCommandOption {
  AutocompleteRequestIntCommandOption(
    name: String,
    value: Int,
    is_focused: Bool,
  )
}

Constructors 

  • AutocompleteRequestIntCommandOption(
  name: String,
  value: Int,
  is_focused: Bool,
)

AutocompleteRequestInteraction

</> 
pub type AutocompleteRequestInteraction {
  AutocompleteRequestInteraction(
    id: Snowflake(Interaction),
    application_id: Snowflake(Application),
    command: AutocompleteRequestCommand,
    invokement_data: InteractionInvokementData,
    channel_id: Snowflake(Channel),
    token: AutocompleteRequestInteractionToken,
    application_permissions: List(Permission),
    invoking_user_locale: Locale,
    invoking_user_entitlements: List(Entitlement),
    context: InteractionContext,
    authorizing_installers: InteractionAuthorizingInstallers,
  )
}

Constructors

AutocompleteRequestInteractionResponse

opaque </> 
pub opaque type AutocompleteRequestInteractionResponse

AutocompleteRequestInteractionToken

opaque </> 
pub opaque type AutocompleteRequestInteractionToken

AutocompleteRequestStringCommandOption

</> 
pub type AutocompleteRequestStringCommandOption {
  AutocompleteRequestStringCommandOption(
    name: String,
    value: String,
    is_focused: Bool,
  )
}

Constructors 

  • AutocompleteRequestStringCommandOption(
  name: String,
  value: String,
  is_focused: Bool,
)

AutocompleteRequestSubCommandCommandOption

</> 
pub type AutocompleteRequestSubCommandCommandOption {
  AutocompleteRequestSubCommandCommandOption(
    name: String,
    options: List(AutocompleteRequestSubCommandOption),
  )
}

Constructors

AutocompleteRequestSubCommandGroupCommandOption

</> 
pub type AutocompleteRequestSubCommandGroupCommandOption {
  AutocompleteRequestSubCommandGroupCommandOption(
    name: String,
    options: List(AutocompleteRequestSubCommandGroupOption),
  )
}

Constructors

AutocompleteRequestSubCommandGroupOption

</> 
pub type AutocompleteRequestSubCommandGroupOption {
  AutocompleteRequestSubCommandGroupOptionSubCommand(
    AutocompleteRequestSubCommandCommandOption,
  )
  AutocompleteRequestSubCommandGroupOptionSubCommandGroup(
    AutocompleteRequestSubCommandGroupCommandOption,
  )
}

Constructors

AutocompleteRequestSubCommandOption

</> 
pub type AutocompleteRequestSubCommandOption {
  AutocompleteRequestSubCommandOptionString(
    AutocompleteRequestStringCommandOption,
  )
  AutocompleteRequestSubCommandOptionInt(
    AutocompleteRequestIntCommandOption,
  )
  AutocompleteRequestSubCommandOptionFloat(
    AutocompleteRequestFloatCommandOption,
  )
}

Constructors

BoolSlashCommandOption

</> 
pub type BoolSlashCommandOption {
  BoolSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
  )
}

Constructors

BulkGuildBanResponse

</> 
pub type BulkGuildBanResponse {
  BulkGuildBanResponse(
    banned_users: List(Snowflake(User)),
    failed_users: List(Snowflake(User)),
  )
}

Constructors

BulkOverwriteGlobalCommands

opaque </> 
pub opaque type BulkOverwriteGlobalCommands

BulkOverwriteGuildCommands

opaque </> 
pub opaque type BulkOverwriteGuildCommands

CategoryChannel

</> 
pub type CategoryChannel {
  CategoryChannel(
    id: Snowflake(CategoryChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    permission_overwrites: List(PermissionOverwrite),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
  )
}

Constructors

Channel

</> 
pub type Channel {
  ChannelText(TextChannel)
  ChannelVoice(VoiceChannel)
  ChannelCategory(CategoryChannel)
  ChannelAnnouncement(AnnouncementChannel)
  ChannelStage(StageChannel)
  ChannelForum(ForumChannel)
  ChannelMedia(MediaChannel)
  ChannelDm(DmChannel)
  ChannelThread(Thread)
}

Constructors

ChannelSlashCommandOption

</> 
pub type ChannelSlashCommandOption {
  ChannelSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
    channel_types: List(SelectChannelType),
  )
}

Constructors

ClipMessageAttachment

</> 
pub type ClipMessageAttachment {
  ClipMessageAttachment(
    height: Int,
    width: Int,
    placeholder: String,
    placeholder_version: Int,
    duration: duration.Duration,
    participants: List(User),
    created_timestamp: timestamp.Timestamp,
    application: option.Option(Application),
  )
}

Constructors

Command

</> 
pub type Command {
  CommandSlash(SlashCommand)
  CommandUser(UserCommand)
  CommandMessage(MessageCommand)
}

Constructors

CommandContext

</> 
pub type CommandContext {
  CommandUsableInGuilds
  CommandUsableInBotDms
  CommandUsableInDms
}

Constructors 

  • CommandUsableInGuilds
  • CommandUsableInBotDms
  • CommandUsableInDms

    The command is usable in DMs between different users.

CommandInstallationType

</>

See also: ApplicationInstallationType

pub type CommandInstallationType {
  GuildInstalledCommand
  UserInstalledCommand
}

Constructors 

  • GuildInstalledCommand

    A guild installed command can be used when the application is guild installed.

  • UserInstalledCommand

    A user installed command can be used when the application is user installed.

CommandInteraction

</> 
pub type CommandInteraction {
  CommandInteraction(
    id: Snowflake(Interaction),
    application_id: Snowflake(Application),
    command: ExecutedCommand,
    invokement_data: InteractionInvokementData,
    channel_id: Snowflake(Channel),
    token: CommandInteractionToken,
    interaction_token: InteractionToken,
    application_permissions: List(Permission),
    invoking_user_locale: Locale,
    invoking_user_entitlements: List(Entitlement),
    context: InteractionContext,
    authorizing_installers: InteractionAuthorizingInstallers,
  )
}

Constructors

CommandInteractionResponse

opaque </> 
pub opaque type CommandInteractionResponse

CommandInteractionToken

opaque </> 
pub opaque type CommandInteractionToken

CommandVersion

</> 
pub type CommandVersion

ComponentEmoji

</> 
pub type ComponentEmoji {
  UnicodeComponentEmoji(character: String)
  CustomComponentEmoji(
    id: Snowflake(Emoji),
    name: String,
    is_animated: Bool,
  )
}

Constructors 

  • UnicodeComponentEmoji(character: String)
  • CustomComponentEmoji(
  id: Snowflake(Emoji),
  name: String,
  is_animated: Bool,
)

ContainerComponent

</> 
pub type ContainerComponent {
  ContainerActionRow(MessageActionRow)
  ContainerTextDisplay(MessageTextDisplay)
  ContainerSection(MessageSection)
  ContainerMediaGallery(MessageMediaGallery)
  ContainerSeparator(MessageSeparator)
  ContainerFile(MessageFile)
}

Constructors

CreateActionRowComponent

</> 
pub type CreateActionRowComponent {
  CreateActionRowButton(CreateMessageButton)
  CreateActionRowStringSelect(CreateMessageStringSelect)
  CreateActionRowUserSelect(CreateMessageUserSelect)
  CreateActionRowRoleSelect(CreateMessageRoleSelect)
  CreateActionRowMentionableSelect(
    CreateMessageMentionableSelect,
  )
  CreateActionRowChannelSelect(CreateMessageChannelSelect)
}

Constructors

CreateAnnouncementChannel

opaque </> 
pub opaque type CreateAnnouncementChannel

CreateCategoryChannel

opaque </> 
pub opaque type CreateCategoryChannel

CreateCheckboxGroupOption

opaque </> 
pub opaque type CreateCheckboxGroupOption

CreateContainerComponent

</> 
pub type CreateContainerComponent {
  CreateContainerActionRow(CreateMessageActionRow)
  CreateContainerTextDisplay(CreateMessageTextDisplay)
  CreateContainerSection(CreateMessageSection)
  CreateContainerMediaGallery(CreateMessageMediaGallery)
  CreateContainerSeparator(CreateMessageSeparator)
  CreateContainerFile(CreateMessageFile)
}

Constructors

CreateEmbedAuthor

opaque </> 
pub opaque type CreateEmbedAuthor

CreateEmbedField

opaque </> 
pub opaque type CreateEmbedField

CreateEmbedFooter

opaque </> 
pub opaque type CreateEmbedFooter

CreateEmbedImage

opaque </> 
pub opaque type CreateEmbedImage

CreateForumChannel

opaque </> 
pub opaque type CreateForumChannel

CreateForumLikeThread

opaque </> 
pub opaque type CreateForumLikeThread

CreateForumLikeThreadMessage

opaque </> 
pub opaque type CreateForumLikeThreadMessage

CreateForumLikeThreadMessageEmbed

opaque </> 
pub opaque type CreateForumLikeThreadMessageEmbed

CreateForumLikeThreadMessageFlag

</> 
pub type CreateForumLikeThreadMessageFlag {
  CreateForumLikeThreadMessageWithSuppressedEmbeds
  CreateForumLikeThreadMessageWithSuppressedNotifications
  CreateForumLikeThreadMessageUsingComponentsV2
}

Constructors 

  • CreateForumLikeThreadMessageWithSuppressedEmbeds
  • CreateForumLikeThreadMessageWithSuppressedNotifications
  • CreateForumLikeThreadMessageUsingComponentsV2

CreateGlobalMessageCommand

opaque </> 
pub opaque type CreateGlobalMessageCommand

CreateGlobalSlashCommand

opaque </> 
pub opaque type CreateGlobalSlashCommand

CreateGlobalUserCommand

opaque </> 
pub opaque type CreateGlobalUserCommand

CreateGuildChannelInvite

opaque </> 
pub opaque type CreateGuildChannelInvite

CreateGuildMessageCommand

opaque </> 
pub opaque type CreateGuildMessageCommand

CreateGuildSlashCommand

opaque </> 
pub opaque type CreateGuildSlashCommand

CreateGuildSoundboardSound

opaque </> 
pub opaque type CreateGuildSoundboardSound

CreateGuildSticker

opaque </> 
pub opaque type CreateGuildSticker

CreateGuildUserCommand

opaque </> 
pub opaque type CreateGuildUserCommand

CreateLinkButton

opaque </> 
pub opaque type CreateLinkButton

CreateMediaChannel

opaque </> 
pub opaque type CreateMediaChannel

CreateMediaGalleryItem

opaque </> 
pub opaque type CreateMediaGalleryItem

CreateMessage

opaque </> 
pub opaque type CreateMessage

CreateMessageActionRow

opaque </> 
pub opaque type CreateMessageActionRow

CreateMessageAttachment

opaque </> 
pub opaque type CreateMessageAttachment

CreateMessageButton

</> 
pub type CreateMessageButton {
  CreateRegularMessageButton(CreateRegularButton)
  CreateLinkMessageButton(CreateLinkButton)
  CreatePremiumMessageButton(CreatePremiumButton)
}

Constructors

CreateMessageChannelSelect

opaque </> 
pub opaque type CreateMessageChannelSelect

CreateMessageComponent

</> 
pub type CreateMessageComponent {
  CreateMessageActionRowComponent(CreateMessageActionRow)
  CreateMessageSectionComponent(CreateMessageSection)
  CreateMessageTextDisplayComponent(CreateMessageTextDisplay)
  CreateMessageMediaGalleryComponent(CreateMessageMediaGallery)
  CreateMessageFileComponent(CreateMessageFile)
  CreateMessageSeparatorComponent(CreateMessageSeparator)
  CreateMessageContainerComponent(CreateMessageContainer)
}

Constructors

CreateMessageContainer

opaque </> 
pub opaque type CreateMessageContainer

CreateMessageEmbed

opaque </> 
pub opaque type CreateMessageEmbed

CreateMessageFile

opaque </> 
pub opaque type CreateMessageFile

CreateMessageFlag

</> 
pub type CreateMessageFlag {
  CreateMessageWithSuppressedEmbeds
  CreateMessageWithSuppressedNotifications
  CreateMessageUsingComponentsV2
}

Constructors 

  • CreateMessageWithSuppressedEmbeds

    Makes the links in the message not create an embed.

  • CreateMessageWithSuppressedNotifications
  • CreateMessageUsingComponentsV2

    If this flag is set, you cannot set content, embeds, sticker_ids, or poll.

CreateMessageMediaGallery

opaque </> 
pub opaque type CreateMessageMediaGallery

CreateMessageMentionableSelect

opaque </> 
pub opaque type CreateMessageMentionableSelect

CreateMessageReference

opaque </> 
pub opaque type CreateMessageReference

CreateMessageRoleSelect

opaque </> 
pub opaque type CreateMessageRoleSelect

CreateMessageSection

opaque </> 
pub opaque type CreateMessageSection

CreateMessageSeparator

opaque </> 
pub opaque type CreateMessageSeparator

CreateMessageStringSelect

opaque </> 
pub opaque type CreateMessageStringSelect

CreateMessageTextDisplay

opaque </> 
pub opaque type CreateMessageTextDisplay

CreateMessageThumbnail

opaque </> 
pub opaque type CreateMessageThumbnail

CreateMessageUserSelect

opaque </> 
pub opaque type CreateMessageUserSelect

CreateModalChannelSelect

opaque </> 
pub opaque type CreateModalChannelSelect

CreateModalCheckbox

opaque </> 
pub opaque type CreateModalCheckbox

CreateModalCheckboxGroup

opaque </> 
pub opaque type CreateModalCheckboxGroup

CreateModalComponent

</> 
pub type CreateModalComponent {
  CreateModalTextDisplayComponent(CreateModalTextDisplay)
  CreateModalLabelComponent(CreateModalLabel)
}

Constructors

CreateModalFileUpload

opaque </> 
pub opaque type CreateModalFileUpload

CreateModalLabel

opaque </> 
pub opaque type CreateModalLabel

CreateModalLabelComponent

</> 
pub type CreateModalLabelComponent {
  CreateModalLabelStringSelectComponent(CreateModalStringSelect)
  CreateModalLabelTextInputComponent(CreateModalTextInput)
  CreateModalLabelUserSelectComponent(CreateModalUserSelect)
  CreateModalLabelRoleSelectComponent(CreateModalRoleSelect)
  CreateModalLabelMentionableSelectComponent(
    CreateModalMentionableSelect,
  )
  CreateModalLabelChannelSelectComponent(
    CreateModalChannelSelect,
  )
  CreateModalLabelFileUploadComponent(CreateModalFileUpload)
  CreateModalLabelRadioGroupComponent(CreateModalRadioGroup)
  CreateModalLabelCheckboxGroupComponent(
    CreateModalCheckboxGroup,
  )
  CreateModalLabelCheckboxComponent(CreateModalCheckbox)
}

Constructors

CreateModalMentionableSelect

opaque </> 
pub opaque type CreateModalMentionableSelect

CreateModalRadioGroup

opaque </> 
pub opaque type CreateModalRadioGroup

CreateModalRoleSelect

opaque </> 
pub opaque type CreateModalRoleSelect

CreateModalStringSelect

opaque </> 
pub opaque type CreateModalStringSelect

CreateModalTextDisplay

opaque </> 
pub opaque type CreateModalTextDisplay

CreateModalTextInput

opaque </> 
pub opaque type CreateModalTextInput

CreateModalUserSelect

opaque </> 
pub opaque type CreateModalUserSelect

CreatePoll

opaque </> 
pub opaque type CreatePoll

CreatePollAnswer

opaque </> 
pub opaque type CreatePollAnswer

CreatePollAnswerEmoji

</> 
pub type CreatePollAnswerEmoji {
  CreatePollAnswerUnicodeEmoji(character: String)
  CreatePollAnswerCustomEmoji(id: Snowflake(Emoji))
}

Constructors 

  • CreatePollAnswerUnicodeEmoji(character: String)
  • CreatePollAnswerCustomEmoji(id: Snowflake(Emoji))

CreatePremiumButton

opaque </> 
pub opaque type CreatePremiumButton

CreateRadioGroupOption

opaque </> 
pub opaque type CreateRadioGroupOption

CreateRegularButton

opaque </> 
pub opaque type CreateRegularButton

CreateRole

opaque </> 
pub opaque type CreateRole

CreateSectionAccessory

</> 
pub type CreateSectionAccessory {
  CreateSectionButton(CreateMessageButton)
  CreateSectionThumbnail(CreateMessageThumbnail)
}

Constructors

CreateSectionComponent

</> 
pub type CreateSectionComponent {
  CreateSectionTextDisplay(CreateMessageTextDisplay)
}

Constructors

CreateStageChannel

opaque </> 
pub opaque type CreateStageChannel

CreateStageInstance

opaque </> 
pub opaque type CreateStageInstance

CreateTextChannel

opaque </> 
pub opaque type CreateTextChannel

CreateThread

opaque </> 
pub opaque type CreateThread

CreateThreadFromMessage

opaque </> 
pub opaque type CreateThreadFromMessage

CreateUnfurledMediaItem

opaque </> 
pub opaque type CreateUnfurledMediaItem

CreateVoiceChannel

opaque </> 
pub opaque type CreateVoiceChannel

CustomEmoji

</> 
pub type CustomEmoji {
  CustomEmoji(
    id: Snowflake(Emoji),
    name: String,
    allowed_roles_ids: option.Option(List(Snowflake(Role))),
    requires_colons: Bool,
    is_integration_managed: Bool,
    is_animated: Bool,
    is_available: Bool,
  )
}

Constructors 

  • CustomEmoji(
  id: Snowflake(Emoji),
  name: String,
  allowed_roles_ids: option.Option(List(Snowflake(Role))),
  requires_colons: Bool,
  is_integration_managed: Bool,
  is_animated: Bool,
  is_available: Bool,
)

    Arguments

    allowed_roles_ids

    Is None if the emoji is not restricted on a per-role basis.

    requires_colons

    Whether this emoji must be wrapped in colons.

    is_integration_managed

    Whether this emoji is managed by an integration.

    is_available

    May be False when a server loses boosts.

DefaultForumReaction

</> 
pub type DefaultForumReaction {
  CustomDefaultForumReaction(id: Snowflake(CustomEmoji))
  StandardDefaultForumReaction(character: String)
}

Constructors 

  • CustomDefaultForumReaction(id: Snowflake(CustomEmoji))
  • StandardDefaultForumReaction(character: String)

DeveloperTeam

</> 
pub type DeveloperTeam {
  DeveloperTeam(
    id: Snowflake(DeveloperTeam),
    members: List(DeveloperTeamMember),
    icon_hash: option.Option(ImageHash),
    name: String,
    owner_id: Snowflake(User),
  )
}

Constructors

DeveloperTeamMember

</> 
pub type DeveloperTeamMember {
  DeveloperTeamMember(
    user: User,
    role: DeveloperTeamMemberRole,
    team_id: Snowflake(DeveloperTeam),
    membership_state: DeveloperTeamMembershipState,
  )
}

Constructors

DeveloperTeamMemberRole

</> 
pub type DeveloperTeamMemberRole {
  DeveloperTeamAdmin
  DeveloperTeamDeveloper
  DeveloperTeamReadOnlyAccess
}

Constructors 

  • DeveloperTeamAdmin

    Owners and admins have the admin role.

    Use the DeveloperTeam.owner_id property to determine who is the owner of the team.

  • DeveloperTeamDeveloper
  • DeveloperTeamReadOnlyAccess

DeveloperTeamMembershipState

</> 
pub type DeveloperTeamMembershipState {
  DeveloperIsAccepted
  DeveloperIsInvited
}

Constructors 

  • DeveloperIsAccepted

    The developer was invited to the team and accepted the invite.

  • DeveloperIsInvited

    The developer was invited to the team and has not accepted the invite (yet).

DmChannel

</> 
pub type DmChannel {
  DmChannel(
    id: Snowflake(DmChannel),
    channel_id: Snowflake(Channel),
    last_message_id: option.Option(Snowflake(Message)),
    recipient: User,
    last_pin_timestamp: option.Option(timestamp.Timestamp),
  )
}

Constructors

EmbedAuthor

</> 
pub type EmbedAuthor {
  EmbedAuthor(
    name: String,
    url: option.Option(String),
    icon_url: option.Option(String),
    proxy_icon_url: option.Option(String),
  )
}

Constructors

EmbedField

</> 
pub type EmbedField {
  EmbedField(name: String, value: String, is_inline: Bool)
}

Constructors 

  • EmbedField(name: String, value: String, is_inline: Bool)

EmbedFooter

</> 
pub type EmbedFooter {
  EmbedFooter(
    text: String,
    icon_url: option.Option(String),
    proxy_icon_url: option.Option(String),
  )
}

Constructors

EmbedImage

</> 
pub type EmbedImage {
  EmbedImage(
    url: String,
    proxy_url: String,
    height: Int,
    width: Int,
    content_type: String,
    placeholder: String,
    placeholder_version: Int,
    description: option.Option(String),
    flags: List(EmbedImageFlag),
  )
}

Constructors 

  • EmbedImage(
  url: String,
  proxy_url: String,
  height: Int,
  width: Int,
  content_type: String,
  placeholder: String,
  placeholder_version: Int,
  description: option.Option(String),
  flags: List(EmbedImageFlag),
)

    Arguments

    height

    In pixels.

    width

    In pixels.

    placeholder

    Thumbhash representation of a placeholder.

    placeholder_version

    Thumbhash version.

EmbedImageFlag

</> 
pub type EmbedImageFlag {
  EmbedImageIsAnimated
}

Constructors 

  • EmbedImageIsAnimated

EmbedType

</> 
pub type EmbedType {
  RichEmbed
  ImageEmbed
  VideoEmbed
  GifEmbed
  ArticleEmbed
  LinkEmbed
  PollResultsEmbed
}

Constructors 

  • RichEmbed
  • ImageEmbed
  • VideoEmbed
  • GifEmbed
  • ArticleEmbed
  • LinkEmbed
  • PollResultsEmbed

EmbedVideo

</> 
pub type EmbedVideo {
  EmbedVideo(
    url: String,
    proxy_url: String,
    height: Int,
    width: Int,
    content_type: String,
    placeholder: String,
    placeholder_version: Int,
    description: option.Option(String),
  )
}

Constructors 

  • EmbedVideo(
  url: String,
  proxy_url: String,
  height: Int,
  width: Int,
  content_type: String,
  placeholder: String,
  placeholder_version: Int,
  description: option.Option(String),
)

    Arguments

    height

    In pixels.

    width

    In pixels.

    placeholder

    Thumbhash representation of a placeholder.

    placeholder_version

    Thumbhash version.

Emoji

</> 
pub type Emoji {
  EmojiUnicode(character: String)
  EmojiCustom(emoji: CustomEmoji)
  EmojiApplication(emoji: ApplicationEmoji)
}

Constructors

Entitlement

</>

An “entitlement” is something a user gets access to by purchasing an application’s premium offer (SKU).

pub type Entitlement {
  Entitlement(
    id: Snowflake(Entitlement),
    sku_id: Snowflake(Sku),
    application_id: Snowflake(Application),
    type_: EntitlementType,
    is_deleted: Bool,
    start_timestamp: option.Option(timestamp.Timestamp),
    end_timestamp: option.Option(timestamp.Timestamp),
    holder: EntitlementHolder,
    is_consumed: option.Option(Bool),
  )
}

Constructors

EntitlementHolder

</> 
pub type EntitlementHolder {
  UserEntitlementHolder(id: Snowflake(User))
  GuildEntitlementHolder(id: Snowflake(Guild))
}

Constructors 

  • UserEntitlementHolder(id: Snowflake(User))

    The perks were given to a user.

  • GuildEntitlementHolder(id: Snowflake(Guild))

    The perks were given to a guild.

EntitlementType

</> 
pub type EntitlementType {
  EntitlementThroughPurchase
  EntitlementThroughPremiumSubscription
  EntitlementThroughDeveloperGift
  EntitlementThroughTestModePurchase
  EntitlementThroughFreePurchase
  EntitlementThroughUserGift
  EntitlementThroughPremiumPurchase
  EntitlementThroughApplicationSubscription
}

Constructors 

  • EntitlementThroughPurchase

    The entitlement was purchased by a user.

  • EntitlementThroughPremiumSubscription

    The entitlement is for a Discord Nitro subscription.

  • EntitlementThroughDeveloperGift

    The entitlement was gifted to a user/guild by the application’s developer.

  • EntitlementThroughTestModePurchase

    The entitlement was purchased by a developer in application test mode.

  • EntitlementThroughFreePurchase

    The entitlement was granted when the SKU was free.

  • EntitlementThroughUserGift

    The entitlement was gifted to a user/guild by another user.

  • EntitlementThroughPremiumPurchase

    The entitlement was claimed by user for free as a Nitro subscriber.

  • EntitlementThroughApplicationSubscription

    The entitlement was purchased as an application subscription.

ErrorCode

</> 
pub type ErrorCode {
  IntErrorCode(Int)
  StringErrorCode(String)
}

Constructors 

  • IntErrorCode(Int)
  • StringErrorCode(String)

ErrorItem

</> 
pub type ErrorItem {
  ErrorItem(code: ErrorCode, message: String)
}

Constructors 

  • ErrorItem(code: ErrorCode, message: String)

ErrorNode

</> 
pub type ErrorNode {
  ErrorNode(List(ErrorItem))
  ErrorBranch(dict.Dict(String, ErrorNode))
}

Constructors

ErrorResponse

</> 
pub type ErrorResponse {
  ErrorResponse(
    code: Int,
    message: String,
    errors: option.Option(ErrorNode),
  )
}

Constructors 

  • ErrorResponse(
  code: Int,
  message: String,
  errors: option.Option(ErrorNode),
)

    Arguments

    code

    See the list of error codes: link

    message

    User-friendly message briefly explaining what error happened.

    errors

    Contains a tree of errors

ExecutedAttachmentSlashCommandOption

</> 
pub type ExecutedAttachmentSlashCommandOption {
  ExecutedAttachmentSlashCommandOption(
    name: String,
    value: Snowflake(MessageAttachment),
  )
}

Constructors

ExecutedBoolSlashCommandOption

</> 
pub type ExecutedBoolSlashCommandOption {
  ExecutedBoolSlashCommandOption(name: String, value: Bool)
}

Constructors 

  • ExecutedBoolSlashCommandOption(name: String, value: Bool)

ExecutedButton

</> 
pub type ExecutedButton {
  ExecutedButton(custom_id: String)
}

Constructors 

  • ExecutedButton(custom_id: String)

ExecutedChannelSelect

</> 
pub type ExecutedChannelSelect {
  ExecutedChannelSelect(
    custom_id: String,
    selected_channels_ids: List(Snowflake(Channel)),
    resolved_channels: dict.Dict(
      Snowflake(Channel),
      ResolvedChannel,
    ),
  )
}

Constructors

ExecutedChannelSlashCommandOption

</> 
pub type ExecutedChannelSlashCommandOption {
  ExecutedChannelSlashCommandOption(
    name: String,
    value: Snowflake(Channel),
  )
}

Constructors

ExecutedCommand

</> 
pub type ExecutedCommand {
  ExecutedCommand(
    id: Snowflake(Command),
    name: String,
    guild_id: option.Option(Snowflake(Guild)),
    data: ExecutedCommandData,
    resolved_objects: InteractionResolvedObjects,
  )
}

Constructors

ExecutedCommandData

</> 
pub type ExecutedCommandData {
  ExecutedSlashCommand(options: List(ExecutedSlashCommandOption))
  ExecutedUserCommand(target_user_id: Snowflake(User))
  ExecutedMessageCommand(target_message_id: Snowflake(Message))
}

Constructors

ExecutedFloatSlashCommandOption

</> 
pub type ExecutedFloatSlashCommandOption {
  ExecutedFloatSlashCommandOption(name: String, value: Float)
}

Constructors 

  • ExecutedFloatSlashCommandOption(name: String, value: Float)

ExecutedIntSlashCommandOption

</> 
pub type ExecutedIntSlashCommandOption {
  ExecutedIntSlashCommandOption(name: String, value: Int)
}

Constructors 

  • ExecutedIntSlashCommandOption(name: String, value: Int)

ExecutedMentionableSelect

</> 
pub type ExecutedMentionableSelect {
  ExecutedMentionableSelect(
    custom_id: String,
    selected_mentionables_ids: List(Snowflake(Mentionable)),
    resolved_users: dict.Dict(Snowflake(Mentionable), User),
    resolved_guild_members: option.Option(
      dict.Dict(Snowflake(Mentionable), ResolvedGuildMember),
    ),
    resolved_roles: dict.Dict(Snowflake(Mentionable), Role),
  )
}

Constructors

ExecutedMentionableSlashCommandOption

</> 
pub type ExecutedMentionableSlashCommandOption {
  ExecutedMentionableSlashCommandOption(
    name: String,
    value: Snowflake(Mentionable),
  )
}

Constructors

ExecutedMessageComponent

</> 
pub type ExecutedMessageComponent {
  ButtonExecuted(ExecutedButton)
  StringSelectExecuted(ExecutedStringSelect)
  UserSelectExecuted(ExecutedUserSelect)
  RoleSelectExecuted(ExecutedRoleSelect)
  MentionableSelectExecuted(ExecutedMentionableSelect)
  ChannelSelectExecuted(ExecutedChannelSelect)
}

Constructors

ExecutedRoleSelect

</> 
pub type ExecutedRoleSelect {
  ExecutedRoleSelect(
    custom_id: String,
    selected_roles_ids: List(Snowflake(Role)),
    resolved_roles: dict.Dict(Snowflake(Role), Role),
  )
}

Constructors

ExecutedRoleSlashCommandOption

</> 
pub type ExecutedRoleSlashCommandOption {
  ExecutedRoleSlashCommandOption(
    name: String,
    value: Snowflake(Role),
  )
}

Constructors 

  • ExecutedRoleSlashCommandOption(
  name: String,
  value: Snowflake(Role),
)

ExecutedSlashCommandOption

</> 
pub type ExecutedSlashCommandOption {
  ExecutedSlashCommandOptionSubCommand(
    ExecutedSubCommandSlashCommandOption,
  )
  ExecutedSlashCommandOptionSubCommandGroup(
    ExecutedSubCommandGroupSlashCommandOption,
  )
  ExecutedSlashCommandOptionString(
    ExecutedStringSlashCommandOption,
  )
  ExecutedSlashCommandOptionInt(ExecutedIntSlashCommandOption)
  ExecutedSlashCommandOptionFloat(
    ExecutedFloatSlashCommandOption,
  )
  ExecutedSlashCommandOptionBool(ExecutedBoolSlashCommandOption)
  ExecutedSlashCommandOptionUser(ExecutedUserSlashCommandOption)
  ExecutedSlashCommandOptionChannel(
    ExecutedChannelSlashCommandOption,
  )
  ExecutedSlashCommandOptionRole(ExecutedRoleSlashCommandOption)
  ExecutedSlashCommandOptionMentionable(
    ExecutedMentionableSlashCommandOption,
  )
  ExecutedSlashCommandOptionAttachment(
    ExecutedAttachmentSlashCommandOption,
  )
}

Constructors

ExecutedStringSelect

</> 
pub type ExecutedStringSelect {
  ExecutedStringSelect(
    custom_id: String,
    selected_values: List(String),
  )
}

Constructors 

  • ExecutedStringSelect(
  custom_id: String,
  selected_values: List(String),
)

ExecutedStringSlashCommandOption

</> 
pub type ExecutedStringSlashCommandOption {
  ExecutedStringSlashCommandOption(name: String, value: String)
}

Constructors 

  • ExecutedStringSlashCommandOption(name: String, value: String)

ExecutedSubCommandGroupOption

</> 
pub type ExecutedSubCommandGroupOption {
  ExecutedSubCommandGroupOptionSubCommand(
    ExecutedSubCommandSlashCommandOption,
  )
  ExecutedSubCommandGroupOptionSubCommandGroup(
    ExecutedSubCommandGroupSlashCommandOption,
  )
}

Constructors

ExecutedSubCommandGroupSlashCommandOption

</> 
pub type ExecutedSubCommandGroupSlashCommandOption {
  ExecutedSubCommandGroupSlashCommandOption(
    name: String,
    options: List(ExecutedSubCommandGroupOption),
  )
}

Constructors

ExecutedSubCommandOption

</> 
pub type ExecutedSubCommandOption {
  ExecutedSubCommandOptionString(
    ExecutedStringSlashCommandOption,
  )
  ExecutedSubCommandOptionInt(ExecutedIntSlashCommandOption)
  ExecutedSubCommandOptionFloat(ExecutedFloatSlashCommandOption)
  ExecutedSubCommandOptionBool(ExecutedBoolSlashCommandOption)
  ExecutedSubCommandOptionUser(ExecutedUserSlashCommandOption)
  ExecutedSubCommandOptionChannel(
    ExecutedChannelSlashCommandOption,
  )
  ExecutedSubCommandOptionRole(ExecutedRoleSlashCommandOption)
  ExecutedSubCommandOptionMentionable(
    ExecutedMentionableSlashCommandOption,
  )
  ExecutedSubCommandOptionAttachment(
    ExecutedAttachmentSlashCommandOption,
  )
}

Constructors

ExecutedSubCommandSlashCommandOption

</> 
pub type ExecutedSubCommandSlashCommandOption {
  ExecutedSubCommandSlashCommandOption(
    name: String,
    options: List(ExecutedSubCommandOption),
  )
}

Constructors

ExecutedUserSelect

</> 
pub type ExecutedUserSelect {
  ExecutedUserSelect(
    custom_id: String,
    selected_users_ids: List(Snowflake(User)),
    resolved_users: dict.Dict(Snowflake(User), User),
    resolved_guild_members: option.Option(
      dict.Dict(Snowflake(User), ResolvedGuildMember),
    ),
  )
}

Constructors

ExecutedUserSlashCommandOption

</> 
pub type ExecutedUserSlashCommandOption {
  ExecutedUserSlashCommandOption(
    name: String,
    value: Snowflake(User),
  )
}

Constructors 

  • ExecutedUserSlashCommandOption(
  name: String,
  value: Snowflake(User),
)

File

</> 
pub type File {
  File(name: String, content_type: String, content: BitArray)
}

Constructors 

  • File(name: String, content_type: String, content: BitArray)

FileUploadFilter

</>

CAUTION: The filter doesn’t check file contents, only the file’s extension!

You’re still expected to verify file contents.

pub type FileUploadFilter {
  AcceptUploadingImages
  AcceptUploadingVideos
  AcceptUploadingAudios
  AcceptUploadingFilesWithExtension(extension: String)
}

Constructors 

  • AcceptUploadingImages

    Default set: .png, .gif, .jpg, .jpeg, .jfif, .webp, .avif

  • AcceptUploadingVideos

    Default set: .mp4, .mov, .qt, .webm

  • AcceptUploadingAudios

    Default set: .mp3, .m4a, .wav, .ogg, .opus, .flac

  • AcceptUploadingFilesWithExtension(extension: String)

    Including the . prefix.

FloatSlashCommandOption

</> 
pub type FloatSlashCommandOption {
  FloatSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
    choices: List(FloatSlashCommandOptionChoice),
    min_value: option.Option(Float),
    max_value: option.Option(Float),
    is_autocomplete_enabled: Bool,
  )
}

Constructors

FloatSlashCommandOptionChoice

</> 
pub type FloatSlashCommandOptionChoice {
  FloatSlashCommandOptionChoice(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    value: Float,
  )
}

Constructors

FollowedChannel

</>

A followed channel represents a followed announcement channel, which copies its messages to a text channel.

pub type FollowedChannel {
  FollowedChannel(
    source_channel_id: Snowflake(AnnouncementChannel),
    target_channel_id: Snowflake(TextChannel),
  )
}

Constructors

ForumChannel

</> 
pub type ForumChannel {
  ForumChannel(
    id: Snowflake(ForumChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    forum_like_channel_id: Snowflake(ForumLikeChannel),
    permission_overwrites: List(PermissionOverwrite),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    rate_limit_per_user: RateLimitPerUser,
    last_thread_id: option.Option(Snowflake(Thread)),
    parent_id: option.Option(Snowflake(CategoryChannel)),
    default_thread_auto_archive_duration: ThreadAutoArchiveDuration,
    flags: List(ForumChannelFlag),
    available_tags: List(ForumTag),
    default_reaction: option.Option(DefaultForumReaction),
    default_thread_rate_limit_per_user: RateLimitPerUser,
    default_sort_order: ForumSortOrder,
    default_layout: ForumLayout,
  )
}

Constructors

ForumChannelFlag

</> 
pub type ForumChannelFlag {
  ForumChannelRequiresTags
}

Constructors 

  • ForumChannelRequiresTags

ForumLayout

</> 
pub type ForumLayout {
  ForumLayoutUnspecified
  ListForumLayout
  GalleryForumLayout
}

Constructors 

  • ForumLayoutUnspecified

    An admin hasn’t specified a default forum layout.

  • ListForumLayout
  • GalleryForumLayout

ForumLikeChannel

</>

A forum-like channel - forum and media channels.

pub type ForumLikeChannel

ForumSortOrder

</> 
pub type ForumSortOrder {
  ForumSortOrderUnspecified
  SortForumPostsByActivity
  SortForumPostsByCreationTime
}

Constructors 

  • ForumSortOrderUnspecified
  • SortForumPostsByActivity
  • SortForumPostsByCreationTime

    From newest to oldest

ForumTag

</> 
pub type ForumTag {
  ForumTag(
    id: Snowflake(ForumTag),
    name: String,
    is_moderated: Bool,
    emoji: ForumTagEmoji,
  )
}

Constructors 

  • ForumTag(
  id: Snowflake(ForumTag),
  name: String,
  is_moderated: Bool,
  emoji: ForumTagEmoji,
)

    Arguments

    is_moderated

    Whether this tag can only be added/removed from threads by a member with the AllowManagingThreads permission.

ForumTagEmoji

</> 
pub type ForumTagEmoji {
  StandardForumTagEmoji(character: String)
  CustomForumTagEmoji(id: Snowflake(CustomEmoji))
}

Constructors

GatewayConnectionInfo

</> 
pub type GatewayConnectionInfo {
  GatewayConnectionInfo(
    connection_url: String,
    recommended_shard_amount: Int,
    connection_start_limits: GatewayConnectionStartLimits,
  )
}

Constructors

GatewayConnectionStartLimits

</> 
pub type GatewayConnectionStartLimits {
  GatewayConnectionStartLimits(
    total_start_limit: Int,
    remaining_starts: Int,
    limits_reset_after_duration: duration.Duration,
    max_identify_per_5_seconds: Int,
  )
}

Constructors 

  • GatewayConnectionStartLimits(
  total_start_limit: Int,
  remaining_starts: Int,
  limits_reset_after_duration: duration.Duration,
  max_identify_per_5_seconds: Int,
)

GetAllActiveGuildThreadsResponse

</> 
pub type GetAllActiveGuildThreadsResponse {
  GetAllActiveGuildThreadsResponse(
    threads: List(Thread),
    members: List(ThreadMember),
  )
}

Constructors 

  • GetAllActiveGuildThreadsResponse(
  threads: List(Thread),
  members: List(ThreadMember),
)

    Arguments

    threads

    The active threads. Sorted by id in descending order.

    members

    The thread member object for each thread the current user has joined.

GetChannelPinsOptions

opaque </> 
pub opaque type GetChannelPinsOptions

GetChannelPinsResponse

</> 
pub type GetChannelPinsResponse {
  GetChannelPinsResponse(pins: List(MessagePin), has_more: Bool)
}

Constructors 

  • GetChannelPinsResponse(pins: List(MessagePin), has_more: Bool)

GetCurrentApplicationEntitlementsOptions

opaque </> 
pub opaque type GetCurrentApplicationEntitlementsOptions

GetGuildBansOptions

opaque </> 
pub opaque type GetGuildBansOptions

GetGuildMembersOptions

opaque </> 
pub opaque type GetGuildMembersOptions

GetPollAnswerVotersOptions

opaque </> 
pub opaque type GetPollAnswerVotersOptions

GetReactingUsersOptions

</> 
pub type GetReactingUsersOptions {
  GetReactingUsersOptions(
    get_burst_reactions: Bool,
    after: option.Option(Snowflake(User)),
    limit: Int,
  )
}

Constructors

GetSkuSubscriptionsOptions

opaque </> 
pub opaque type GetSkuSubscriptionsOptions

Guild

</> 
pub type Guild {
  Guild(
    id: Snowflake(Guild),
    name: String,
    icon_hash: option.Option(ImageHash),
    splash_hash: option.Option(ImageHash),
    discovery_splash_hash: option.Option(ImageHash),
    owner_id: Snowflake(User),
    afk_channel_id: option.Option(Snowflake(Channel)),
    afk_timeout: AfkTimeout,
    is_widget_enabled: Bool,
    widget_channel_id: option.Option(Snowflake(Channel)),
    required_verification_level: GuildMemberVerificationLevel,
    default_message_notification_setting: GuildDefaultMessageNotificationSetting,
    explicit_content_filter_setting: GuildExplicitContentFilterSetting,
    roles: List(Role),
    emojis: List(CustomEmoji),
    features: List(GuildFeature),
    required_mfa_level: GuildRequiredMfaLevel,
    application_id: option.Option(Snowflake(Application)),
    system_channel_id: option.Option(Snowflake(Channel)),
    system_channel_flags: List(GuildSystemChannelFlag),
    rules_channel_id: option.Option(Snowflake(Channel)),
    max_presences: option.Option(Int),
    max_members: option.Option(Int),
    vanity_url_code: option.Option(String),
    description: option.Option(String),
    banner_hash: option.Option(ImageHash),
    premium_tier: GuildPremiumTier,
    premium_subscription_count: Int,
    preferred_locale: Locale,
    public_updates_channel_id: option.Option(Snowflake(Channel)),
    max_video_channel_users: Int,
    max_stage_video_channel_users: Int,
    welcome_screen: option.Option(GuildWelcomeScreen),
    nsfw_level: GuildNsfwLevel,
    stickers: option.Option(List(GuildSticker)),
    is_premium_progress_bar_enabled: Bool,
    safety_alerts_channel_id: option.Option(Snowflake(Channel)),
    incidents_data: option.Option(GuildIncidentsData),
  )
}

Constructors 

  • Guild(
  id: Snowflake(Guild),
  name: String,
  icon_hash: option.Option(ImageHash),
  splash_hash: option.Option(ImageHash),
  discovery_splash_hash: option.Option(ImageHash),
  owner_id: Snowflake(User),
  afk_channel_id: option.Option(Snowflake(Channel)),
  afk_timeout: AfkTimeout,
  is_widget_enabled: Bool,
  widget_channel_id: option.Option(Snowflake(Channel)),
  required_verification_level: GuildMemberVerificationLevel,
  default_message_notification_setting: GuildDefaultMessageNotificationSetting,
  explicit_content_filter_setting: GuildExplicitContentFilterSetting,
  roles: List(Role),
  emojis: List(CustomEmoji),
  features: List(GuildFeature),
  required_mfa_level: GuildRequiredMfaLevel,
  application_id: option.Option(Snowflake(Application)),
  system_channel_id: option.Option(Snowflake(Channel)),
  system_channel_flags: List(GuildSystemChannelFlag),
  rules_channel_id: option.Option(Snowflake(Channel)),
  max_presences: option.Option(Int),
  max_members: option.Option(Int),
  vanity_url_code: option.Option(String),
  description: option.Option(String),
  banner_hash: option.Option(ImageHash),
  premium_tier: GuildPremiumTier,
  premium_subscription_count: Int,
  preferred_locale: Locale,
  public_updates_channel_id: option.Option(Snowflake(Channel)),
  max_video_channel_users: Int,
  max_stage_video_channel_users: Int,
  welcome_screen: option.Option(GuildWelcomeScreen),
  nsfw_level: GuildNsfwLevel,
  stickers: option.Option(List(GuildSticker)),
  is_premium_progress_bar_enabled: Bool,
  safety_alerts_channel_id: option.Option(Snowflake(Channel)),
  incidents_data: option.Option(GuildIncidentsData),
)

    Arguments

    icon_hash

    Image hash of the guild icon.

    An icon is the picture shown in the server list.

    Is None when the guild doesn’t have an icon.

    splash_hash

    Image hash of the guild splash.

    A splash is the picture shown when a user joins a guild, at the “Accept Invite” UI.

    Is None when the guild doesn’t have a splash.

    discovery_splash_hash

    Image hash of the guild discovery splash.

    A discovery splash is the picture shown when a user clicks on a guild in the “Server Discovery” UI.

    Is None when the guild isn’t discoverable or doesn’t have a discovery splash.

    afk_channel_id

    The “AFK channel” is the channel to which inactive voice channel users are moved.

    Is None when the guild doesn’t have a configured AFK channel.

    afk_timeout

    The time of inactivity after a voice channel user is marked as AFK in this guild.

    is_widget_enabled

    Whether the “server widget” is enabled. The server widget is a feature allowing guild advertisements on websites.

    widget_channel_id

    The channel to which the widget will generate an invite to.

    Is None if the widget was configured to not generate invites or is disabled.

    required_verification_level

    The verification level required for a guild member to be able to communicate in a guild.

    default_message_notification_setting

    The default setting regarding sending push notifications to members’ devices.

    Note that this can be overriden on a per-member basis.

    emojis

    List of the guild’s custom emojis.

    required_mfa_level

    MFA = multi-factor authentication

    application_id

    Application ID of the guild creator if it is created by a bot.

    system_channel_id

    The system channel is the channel where certain notifications, such as on-boost messages are sent.

    Is None if the guild does not use system messages.

    rules_channel_id

    Is None if the guild doesn’t have a rules channel.

    max_presences

    The maximum number of presences for the guild.

    Is always None, apart from the largest of guilds.

    max_members

    According to discord.py, this is always None, unless the guild is received from get_guild().

    vanity_url_code

    Is None if the guild doesn’t have a vanity url.

    description

    Is None if the guild doesn’t have a description.

    banner_hash

    Is None if the guild doesn’t have a banner.

    premium_tier

    The guild’s server boost benefit tier.

    premium_subscription_count

    The guild’s current amount of active server boosts.

    preferred_locale

    Is present for all guilds, but only community guilds have the ability to change it.

    Defaults to EnglishUsLocale if not selected by the guild’s admins.

    public_updates_channel_id

    ID of the channel where admins and moderators of a Community guild receive notices from Discord.

    Is None if the guild isn’t a community guild.

    max_video_channel_users

    The maximum amount of webcam-sharing users in a voice channel for this guild.

    max_stage_video_channel_users

    The maximum amount of webcam-sharing users in a stage channel for this guild.

    welcome_screen

    Is only present in the Invite.guild field.

    stickers

    Is None in many circumstances, it’s best to always check for this field’s presence.

    is_premium_progress_bar_enabled

    Whether the guild has the boost progress bar enabled.

    safety_alerts_channel_id

    ID of the chanel where moderators of Community guilds receive safety alerts from Discord. Is None if the guild isn’t a community guild.

    incidents_data

    Is None if there is no active incident.

GuildApproximateCounts

</> 
pub type GuildApproximateCounts {
  GuildApproximateCounts(
    approximate_member_count: Int,
    approximate_presence_count: Int,
  )
}

Constructors 

  • GuildApproximateCounts(
  approximate_member_count: Int,
  approximate_presence_count: Int,
)

GuildBan

</> 
pub type GuildBan {
  GuildBan(reason: option.Option(String), user: User)
}

Constructors

GuildChannel

</> 
pub type GuildChannel {
  GuildChannelText(TextChannel)
  GuildChannelVoice(VoiceChannel)
  GuildChannelCategory(CategoryChannel)
  GuildChannelAnnouncement(AnnouncementChannel)
  GuildChannelStage(StageChannel)
  GuildChannelForum(ForumChannel)
  GuildChannelMedia(MediaChannel)
}

Constructors

GuildDefaultMessageNotificationSetting

</> 
pub type GuildDefaultMessageNotificationSetting {
  NotifyForAllMessages
  NotifyOnlyForMentions
}

Constructors 

  • NotifyForAllMessages

    By default, notifications will be sent for all messages in the guild.

  • NotifyOnlyForMentions

    By default, notifications will be sent only for messages in which the user was mentioned.

GuildDiscordBotIntegration

</> 
pub type GuildDiscordBotIntegration {
  GuildDiscordBotIntegration(
    application: GuildIntegrationApplication,
    scopes: List(String),
  )
}

Constructors 

  • GuildDiscordBotIntegration(
  application: GuildIntegrationApplication,
  scopes: List(String),
)

    Arguments

    scopes

    OAuth2 scopes the application has been authorized for.

GuildExplicitContentFilterSetting

</> 
pub type GuildExplicitContentFilterSetting {
  GuildExplicitContentFilterDisabled
  GuildExplicitContentFilterForMembersWithoutRoles
  GuildExplicitContentFilterForAllMembers
}

Constructors 

  • GuildExplicitContentFilterDisabled

    Media will not be scanned for explicit content.

  • GuildExplicitContentFilterForMembersWithoutRoles

    Only media sent by members who do not have any roles will be scanned for explicit content.

  • GuildExplicitContentFilterForAllMembers

    Media sent by all members will be scanned for explicit content.

GuildFeature

</> 
pub type GuildFeature {
  GuildCanUseAnimatedBanner
  GuildCanUseAnimatedIcon
  GuildUsesOldPermissionConfigurationBehavior
  GuildCreatedAutoModerationRules
  GuildCanUseBanner
  GuildIsCommunity
  GuildUsesMonetization
  GuildUsesRoleSubscriptionPromoPage
  GuildIsDeveloperSupportServer
  GuildIsDiscoverable
  GuildIsFeaturable
  GuildHasPausedInvites
  GuildCanUseInviteSplash
  GuildUsesMembershipScreening
  GuildHasMoreSoundboardSoundSlots
  GuildHasMoreStickerSlots
  GuildCanCreateAnnouncementChannels
  GuildIsPartnered
  GuildCanBePreviewed
  GuildDisabledRaidAlerts
  GuildCanUseRoleIcons
  GuildHasPurchasableRoleSubscriptions
  GuildUsesRoleSubscriptions
  GuildCreatedSoundboardSounds
  GuildUsesTicketedEvents
  GuildCanUseVanityUrl
  GuildIsVerified
  GuildCanUse384KbpsVoiceBitrate
  GuildUsesWelcomeScreen
  GuildCanUseGuestInvites
  GuildCanUseGuildTags
  GuildCanUseEnhancedRoleColours
}

Constructors 

  • GuildCanUseAnimatedBanner
  • GuildCanUseAnimatedIcon
  • GuildUsesOldPermissionConfigurationBehavior

    Guild uses the old permission configuration behavior.

  • GuildCreatedAutoModerationRules

    Guild has set up auto-moderation rules. This does not guarantee that the guild currently has auto-moderation rules set-up.

  • GuildCanUseBanner
  • GuildIsCommunity

    Guild can use the welcome screen, Membership Screening, stage channels, and server discovery and receives community updates.

  • GuildUsesMonetization
  • GuildUsesRoleSubscriptionPromoPage
  • GuildIsDeveloperSupportServer

    Guild has been set as a support server on the App Directory.

  • GuildIsDiscoverable

    Guild can be discovered in the discovery tab.

  • GuildIsFeaturable

    Guild can be featured in the discovery tab.

  • GuildHasPausedInvites

    Guild has currently paused invites as an anti-raid measure.

  • GuildCanUseInviteSplash
  • GuildUsesMembershipScreening
  • GuildHasMoreSoundboardSoundSlots
  • GuildHasMoreStickerSlots
  • GuildCanCreateAnnouncementChannels
  • GuildIsPartnered

    Guild is partnered with Discord.

  • GuildCanBePreviewed
  • GuildDisabledRaidAlerts
  • GuildCanUseRoleIcons
  • GuildHasPurchasableRoleSubscriptions
  • GuildUsesRoleSubscriptions
  • GuildCreatedSoundboardSounds

    Guild has created soundboard sounds. This does not guarantee that the guild currently has any soundboard sounds.

  • GuildUsesTicketedEvents
  • GuildCanUseVanityUrl
  • GuildIsVerified

    Guild is verified by Discord.

  • GuildCanUse384KbpsVoiceBitrate
  • GuildUsesWelcomeScreen
  • GuildCanUseGuestInvites
  • GuildCanUseGuildTags
  • GuildCanUseEnhancedRoleColours

GuildIncidentsData

</> 
pub type GuildIncidentsData {
  GuildIncidentsData(
    invites_disabled_until: option.Option(timestamp.Timestamp),
    dms_disabled_until: option.Option(timestamp.Timestamp),
    dm_spam_detected_at: option.Option(timestamp.Timestamp),
    raid_detected_at: option.Option(timestamp.Timestamp),
  )
}

Constructors

GuildIntegration

</>

Discord has some integrations with YouTube/Twitch for member/subscriber-only guilds.

Additionally, a guild may also be integrated with a Discord bot.

pub type GuildIntegration {
  GuildIntegration(
    id: Snowflake(GuildIntegration),
    name: String,
    is_enabled: Bool,
    account: GuildIntegrationAccount,
    integrator: option.Option(User),
    data: GuildIntegrationData,
  )
}

Constructors

GuildIntegrationAccount

</>

The account is the integration’s pseudo-user.

pub type GuildIntegrationAccount {
  GuildIntegrationAccount(id: Snowflake(User), name: String)
}

Constructors

GuildIntegrationApplication

</>

Partial application object used by guild integrations.

pub type GuildIntegrationApplication {
  GuildIntegrationApplication(
    id: Snowflake(Application),
    name: String,
    icon_hash: option.Option(ImageHash),
    description: String,
    bot: option.Option(User),
  )
}

Constructors

GuildIntegrationData

</> 
pub type GuildIntegrationData {
  GuildIntegrationDiscordBot(data: GuildDiscordBotIntegration)
  GuildIntegrationSocial(data: GuildSocialIntegration)
  GuildIntegrationGuildSubscription
}

Constructors

GuildMember

</> 
pub type GuildMember {
  GuildMember(
    user: User,
    nick: option.Option(String),
    avatar_hash: option.Option(ImageHash),
    banner_hash: option.Option(ImageHash),
    role_ids: List(Snowflake(Role)),
    joined_timestamp: timestamp.Timestamp,
    boosting_since: option.Option(timestamp.Timestamp),
    is_deafened: Bool,
    is_muted: Bool,
    flags: List(GuildMemberFlag),
    is_pending: Bool,
    communication_disabled_until: option.Option(
      timestamp.Timestamp,
    ),
    avatar_decoration: option.Option(UserAvatarDecoration),
  )
}

Constructors 

  • GuildMember(
  user: User,
  nick: option.Option(String),
  avatar_hash: option.Option(ImageHash),
  banner_hash: option.Option(ImageHash),
  role_ids: List(Snowflake(Role)),
  joined_timestamp: timestamp.Timestamp,
  boosting_since: option.Option(timestamp.Timestamp),
  is_deafened: Bool,
  is_muted: Bool,
  flags: List(GuildMemberFlag),
  is_pending: Bool,
  communication_disabled_until: option.Option(timestamp.Timestamp),
  avatar_decoration: option.Option(UserAvatarDecoration),
)

    Arguments

    user

    Corresponding user object.

    nick

    Guild-specific nickname.

    Is None when the member doesn’t have a guild-specific nickname.

    avatar_hash

    Guild-specific avatar hash.

    Is None if the member chose not to use a guild-specific avatar.

    banner_hash

    Guild-specific banner hash.

    Is None if the member chose not to use a guild-specific banner.

    is_deafened

    Whether the member is deafened in voice channels for this guild.

    is_muted

    Whether the member is muted in voice channels for this guild.

    is_pending

    Whether the member has not yet passed the membership screening requirements.

    communication_disabled_until

    When the member’s timeout will expire, returning their ability to communicate in the guild.

    IMPORTANT: the member is not timed out if this field is None or a time in the past.

    avatar_decoration

    Guild-specific avatar decoration.

    Is None if the member chose not to use guild-specific avatar decorations.

GuildMemberFlag

</> 
pub type GuildMemberFlag {
  GuildMemberRejoined
  GuildMemberCompletedOnboarding
  GuildMemberBypassesVerification
  GuildMemberStartedOnboarding
  GuildMemberIsGuest
  GuildMemberStartedHomeActions
  GuildMemberCompletedHomeActions
  GuildMemberUsernameQuarantinedByAutomod
  GuildMemberAcknowledgedDmSettingsUpsell
  GuildMemberGuildTagQuarantinedByAutomod
}

Constructors 

  • GuildMemberRejoined

    Member left and rejoined the guild

  • GuildMemberCompletedOnboarding

    Member completed onboarding

  • GuildMemberBypassesVerification

    Member is exempt from guild verification requirements

  • GuildMemberStartedOnboarding

    Member has started onboarding

  • GuildMemberIsGuest

    Member is a guest and can only access the voice channel they were invited to

  • GuildMemberStartedHomeActions

    Member has started Server Guide new member actions

  • GuildMemberCompletedHomeActions

    Member has completed Server Guide new member actions

  • GuildMemberUsernameQuarantinedByAutomod

    Member’s username, display name or nickname is blocked by AutoMod

  • GuildMemberAcknowledgedDmSettingsUpsell

    Member has dismissed the DM settings upsell

  • GuildMemberGuildTagQuarantinedByAutomod

    Member’s guild tag is blocked by AutoMod

GuildMemberVerificationLevel

</> 
pub type GuildMemberVerificationLevel {
  NoGuildMemberVerification
  LowGuildMemberVerification
  MediumGuildMemberVerification
  HighGuildMemberVerification
  VeryHighGuildMemberVerification
}

Constructors 

  • NoGuildMemberVerification

    Access to the guild is unrestricted.

  • LowGuildMemberVerification

    Access to the guild is granted to those who have verified their email with Discord.

  • MediumGuildMemberVerification

    Access to the guild is granted to those who have been registered on Discord for longer than 5 minutes.

  • HighGuildMemberVerification

    Access to the guild is granted to those who have been a member of the guild for longer than 10 minutes.

  • VeryHighGuildMemberVerification

    Access to the guild is granted to those who have verified their phone number with Discord.

GuildNsfwLevel

</> 
pub type GuildNsfwLevel {
  DefaultGuildNsfwLevel
  ExplicitGuild
  SafeGuild
  AgeRestrictedGuild
}

Constructors 

  • DefaultGuildNsfwLevel

    Unrated.

  • ExplicitGuild

    Has explicit content.

  • SafeGuild

    Safe-for-work.

  • AgeRestrictedGuild

    Guild is restricted to adults.

GuildOnboarding

</> 
pub type GuildOnboarding {
  GuildOnboarding(
    guild_id: Snowflake(Guild),
    prompts: List(GuildOnboardingPrompt),
    default_channel_ids: List(Snowflake(Channel)),
    is_enabled: Bool,
    mode: GuildOnboardingMode,
  )
}

Constructors

GuildOnboardingMode

</> 
pub type GuildOnboardingMode {
  DefaultOnboardingMode
  AdvancedOnboardingMode
}

Constructors 

  • DefaultOnboardingMode

    Assigns only default channels.

  • AdvancedOnboardingMode

    Asks pre-join questions to add people to channels & roles based on their answers.

GuildOnboardingPrompt

</> 
pub type GuildOnboardingPrompt {
  GuildOnboardingPrompt(
    id: Snowflake(GuildOnboardingPrompt),
    type_: GuildOnboardingPromptType,
    options: List(GuildOnboardingPromptOption),
    title: String,
    is_single_select: Bool,
    is_required: Bool,
    is_present_in_onboarding_flow: Bool,
  )
}

Constructors

GuildOnboardingPromptOption

</> 
pub type GuildOnboardingPromptOption {
  GuildOnboadingPromptOption(
    id: Snowflake(GuildOnboardingPromptOption),
    channel_ids: List(Snowflake(Channel)),
    role_ids: List(Snowflake(Role)),
    emoji: option.Option(Emoji),
    title: String,
    description: option.Option(String),
  )
}

Constructors

GuildOnboardingPromptType

</> 
pub type GuildOnboardingPromptType {
  MultipleChoiceGuildOnboardingPrompt
  DropdownGuildOnboardingPrompt
}

Constructors 

  • MultipleChoiceGuildOnboardingPrompt
  • DropdownGuildOnboardingPrompt

GuildPremiumTier

</> 
pub type GuildPremiumTier {
  GuildWithoutPremium
  GuildPremiumTier1
  GuildPremiumTier2
  GuildPremiumTier3
}

Constructors 

  • GuildWithoutPremium

    The guild hasn’t unlocked any server boost perks.

  • GuildPremiumTier1

    Server boost level 1 perks.

  • GuildPremiumTier2

    Server boost level 2 perks.

  • GuildPremiumTier3

    Server boost level 3 perks.

GuildPreview

</> 
pub type GuildPreview {
  GuildPreview(
    id: Snowflake(Guild),
    name: String,
    icon_hash: option.Option(ImageHash),
    splash_hash: option.Option(ImageHash),
    discovery_splash_hash: option.Option(ImageHash),
    emojis: List(CustomEmoji),
    features: List(GuildFeature),
    approximate_member_count: Int,
    approximate_presence_count: Int,
    description: option.Option(String),
    stickers: List(GuildSticker),
  )
}

Constructors

GuildRequiredMfaLevel

</> 
pub type GuildRequiredMfaLevel {
  GuildDoesNotRequireMfa
  GuildRequiresMfaForModerationActions
}

Constructors 

  • GuildDoesNotRequireMfa
  • GuildRequiresMfaForModerationActions

GuildSocialIntegration

</>

A social integration is an integration between a Discord guild and Youtube/Twitch.

It’s used to make subscriber-only guilds/roles.

Vocabulary:

  • Subscriber - A paid supporter of a YouTube/Twitch channel (Twitch subscriber/YouTube channel member)
pub type GuildSocialIntegration {
  GuildSocialIntegration(
    data: GuildSocialIntegrationData,
    is_syncing: Bool,
    subscriber_role_id: option.Option(Snowflake(Role)),
    subscription_expiration_behavior: GuildSocialIntegrationSubscriptionExpirationBehavior,
    subscription_expiration_grace_period: duration.Duration,
    last_sync_timestamp: option.Option(timestamp.Timestamp),
    subscriber_count: Int,
    is_revoked: Bool,
  )
}

Constructors

GuildSocialIntegrationData

</> 
pub type GuildSocialIntegrationData {
  YoutubeGuildIntegration
  TwitchGuildIntegration(is_syncing_emoticons: Bool)
}

Constructors 

  • YoutubeGuildIntegration
  • TwitchGuildIntegration(is_syncing_emoticons: Bool)

GuildSocialIntegrationSubscriptionExpirationBehavior

</> 
pub type GuildSocialIntegrationSubscriptionExpirationBehavior {
  RemoveRoleOnSubscriptionExpiration
  KickOnSubscriptionExpiration
}

Constructors 

  • RemoveRoleOnSubscriptionExpiration

    Remove the subscriber-only role when the subscription expires.

  • KickOnSubscriptionExpiration

    Kick the ex-subscriber from the guild when the subscription expires.

GuildSticker

</> 
pub type GuildSticker {
  GuildSticker(
    id: Snowflake(GuildSticker),
    sticker_id: Snowflake(Sticker),
    name: String,
    description: option.Option(String),
    tags: String,
    format_type: StickerFormatType,
    is_available: Bool,
    guild_id: Snowflake(Guild),
    uploader: option.Option(User),
  )
}

Constructors 

  • GuildSticker(
  id: Snowflake(GuildSticker),
  sticker_id: Snowflake(Sticker),
  name: String,
  description: option.Option(String),
  tags: String,
  format_type: StickerFormatType,
  is_available: Bool,
  guild_id: Snowflake(Guild),
  uploader: option.Option(User),
)

    Arguments

    description

    Is None if the sticker doesn’t have a description.

    tags

    Auto-complete/suggestion tags (keywords).

    is_available

    Is False when a guild loses its premium tier, reducing its sticker capacity and removing the sticker.

    uploader

    Only returned with certain permissions.

GuildSystemChannelFlag

</> 
pub type GuildSystemChannelFlag {
  GuildSystemChannelWithoutJoinNotifications
  GuildSystemChannelWithoutPremiumNotifications
  GuildSystemChannelWithoutGuildReminderNotifications
  GuildSystemChannelWithoutJoinNotificationStickerReplyButtons
  GuildSystemChannelWithoutRoleSubscriptionPurchaseNotifications
  GuildSystemChannelWithoutRoleSubscriptionPurchaseNotificationStickerReplyButtons
}

Constructors 

  • GuildSystemChannelWithoutJoinNotifications

    Suppresses the member join notifications.

  • GuildSystemChannelWithoutPremiumNotifications

    Suppresses the server boost notifications.

  • GuildSystemChannelWithoutGuildReminderNotifications

    Suppresses server setup tips.

  • GuildSystemChannelWithoutJoinNotificationStickerReplyButtons

    Hides the sticker reply buttons to member join notifications.

  • GuildSystemChannelWithoutRoleSubscriptionPurchaseNotifications

    Suppresses role subscription purchase/renewal notifications.

  • GuildSystemChannelWithoutRoleSubscriptionPurchaseNotificationStickerReplyButtons

    Hides the sticker reply buttons to role subscription purchase/renewal notifications.

GuildVanityInvite

</> 
pub type GuildVanityInvite {
  GuildVanityInvite(code: String, uses: Int)
}

Constructors 

  • GuildVanityInvite(code: String, uses: Int)

    Arguments

    code

    Prepend https://discord.gg/ to the code to create an invite link!

    uses

    How many times the invite has been used.

GuildWelcomeScreen

</> 
pub type GuildWelcomeScreen {
  GuildWelcomeScreen(
    description: option.Option(String),
    welcome_channels: List(GuildWelcomeScreenChannel),
  )
}

Constructors 

  • GuildWelcomeScreen(
  description: option.Option(String),
  welcome_channels: List(GuildWelcomeScreenChannel),
)

    Arguments

    description

    The guild description shown in the welcome screen. Is None if the guild hasn’t configured a description.

    welcome_channels

    The channels shown in the welcome screen. Up to 5.

GuildWelcomeScreenChannel

</> 
pub type GuildWelcomeScreenChannel {
  GuildWelcomeScreenChannel(
    id: Snowflake(Channel),
    description: String,
    emoji: option.Option(GuildWelcomeScreenChannelEmoji),
  )
}

Constructors

GuildWelcomeScreenChannelEmoji

</> 
pub type GuildWelcomeScreenChannelEmoji {
  StandardGuildWelcomeScreenChannelEmoji(character: String)
  CustomGuildWelcomeScreenChannelEmoji(
    id: Snowflake(Emoji),
    name: String,
  )
}

Constructors 

  • StandardGuildWelcomeScreenChannelEmoji(character: String)
  • CustomGuildWelcomeScreenChannelEmoji(
  id: Snowflake(Emoji),
  name: String,
)

GuildWidget

</> 
pub type GuildWidget {
  GuildWidget(
    guild_id: Snowflake(Guild),
    guild_name: String,
    instant_invite_url: option.Option(String),
    channels: List(GuildWidgetChannel),
    users: List(GuildWidgetUser),
    presence_count: Int,
  )
}

Constructors 

  • GuildWidget(
  guild_id: Snowflake(Guild),
  guild_name: String,
  instant_invite_url: option.Option(String),
  channels: List(GuildWidgetChannel),
  users: List(GuildWidgetUser),
  presence_count: Int,
)

    Arguments

    channels

    Contains voice and stage channels which are accessible by @everyone

    presence_count

    Amount of online members in the guild.

GuildWidgetChannel

</>

A partial channel object used in guild widgets.

Represents an @everyone-accessible voice or stage channel.

pub type GuildWidgetChannel {
  GuildWidgetChannel(
    id: Snowflake(GuildChannel),
    name: String,
    position: Int,
  )
}

Constructors 

  • GuildWidgetChannel(
  id: Snowflake(GuildChannel),
  name: String,
  position: Int,
)

    Arguments

    position

    Channels with the same position are sorted by ID.

GuildWidgetSettings

</>

A guild’s settings pertaining to the website widget.

pub type GuildWidgetSettings {
  GuildWidgetSettings(
    is_enabled: Bool,
    channel_id: option.Option(Snowflake(Channel)),
  )
}

Constructors

GuildWidgetUser

</>

A partial user object used in guild widgets.

Includes the user’s status + a specific avatar URL.

pub type GuildWidgetUser {
  GuildWidgetUser(
    id: Snowflake(User),
    username: String,
    discriminator: String,
    avatar_hash: option.Option(ImageHash),
    status: UserStatus,
    avatar_url: option.Option(String),
  )
}

Constructors 

  • GuildWidgetUser(
  id: Snowflake(User),
  username: String,
  discriminator: String,
  avatar_hash: option.Option(ImageHash),
  status: UserStatus,
  avatar_url: option.Option(String),
)

    Arguments

    discriminator

    Mostly deprecated. Only bots have discriminators nowadays.

    Users will very likely have their discriminator set to 0.

    Used in the past when usernames weren’t user-specific.

    Doesn’t include the # prefix.

ImageData

opaque </>

Used for uploading images to Discord. You’ll encounter this type in modify and create functions. Use image_data_from_bit_array to create this.

pub opaque type ImageData

ImageDataContentType

</> 
pub type ImageDataContentType {
  JpegImageData
  PngImageData
  GifImageData
}

Constructors 

  • JpegImageData
  • PngImageData
  • GifImageData

ImageHash

opaque </>

An image hash is used to download images from Discord.

Every non-attachment image (avatars, banners, even guild tag badges) is hashed by Discord and is able to be downloaded through a link.

pub opaque type ImageHash

ImageMessageAttachment

</> 
pub type ImageMessageAttachment {
  ImageMessageAttachment(
    height: Int,
    width: Int,
    placeholder: String,
    placeholder_version: Int,
  )
}

Constructors 

  • ImageMessageAttachment(
  height: Int,
  width: Int,
  placeholder: String,
  placeholder_version: Int,
)

    Arguments

    height

    In pixels.

    width

    In pixels.

    placeholder

    Thumbhash representation of a placeholder.

    placeholder_version

    Thumbhash version.

IntSlashCommandOption

</> 
pub type IntSlashCommandOption {
  IntSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
    choices: List(IntSlashCommandOptionChoice),
    min_value: option.Option(Int),
    max_value: option.Option(Int),
    is_autocomplete_enabled: Bool,
  )
}

Constructors

IntSlashCommandOptionChoice

</> 
pub type IntSlashCommandOptionChoice {
  IntSlashCommandOptionChoice(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    value: Int,
  )
}

Constructors

Interaction

</> 
pub type Interaction {
  InteractionCommand(CommandInteraction)
  InteractionMessageComponent(MessageComponentInteraction)
  InteractionModal(ModalInteraction)
  InteractionAutocompleteRequest(AutocompleteRequestInteraction)
}

Constructors

InteractionAuthorizingInstallers

</> 
pub type InteractionAuthorizingInstallers {
  InteractionAuthorizingInstallers(
    guild_installer: option.Option(Snowflake(Guild)),
    user_installer: option.Option(Snowflake(User)),
  )
}

Constructors 

  • InteractionAuthorizingInstallers(
  guild_installer: option.Option(Snowflake(Guild)),
  user_installer: option.Option(Snowflake(User)),
)

    Arguments

    guild_installer

    If the command was guild installed, the guild installer is the guild where the application is installed.

    user_installer

    If the command was user installed, the user installer is the user who installed the application.

InteractionContext

</> 
pub type InteractionContext {
  InteractionExecutedInGuild
  InteractionExecutedInBotDms
  InteractionExecutedInDms
}

Constructors 

  • InteractionExecutedInGuild

    The interaction was executed in a guild channel.

  • InteractionExecutedInBotDms

    The interaction was executed in the DM channel between the invoking user and the bot.

  • InteractionExecutedInDms

    The interaction was executed in a DM channel between different recipients where the bot was user-installed.

InteractionInvokementData

</> 
pub type InteractionInvokementData {
  InteractionInvokedInGuild(
    guild: InteractionPartialGuild,
    invoking_member: GuildMember,
  )
  InteractionInvokedInPrivateChannel(invoking_user: User)
}

Constructors 

  • InteractionInvokedInGuild(
  guild: InteractionPartialGuild,
  invoking_member: GuildMember,
)
  • InteractionInvokedInPrivateChannel(invoking_user: User)

    Invoked in something such as a DM Channel.

InteractionPartialGuild

</> 
pub type InteractionPartialGuild {
  InteractionPartialGuild(
    id: Snowflake(Guild),
    preferred_locale: Locale,
    features: List(GuildFeature),
  )
}

Constructors 

  • InteractionPartialGuild(
  id: Snowflake(Guild),
  preferred_locale: Locale,
  features: List(GuildFeature),
)

    Arguments

    preferred_locale

    Only Community Guilds can change their locale.

    Other guilds, and ones who haven’t set their locale, will default to the EnglishUsLocale

InteractionResolvedObjects

</>

Contains objects mentioned in an interaction - for example, if a slash command was executed with a user parameter, you can grab the user’s ID from the command options, and get the object from the resolved data.

pub type InteractionResolvedObjects {
  InteractionResolvedObjects(
    users: dict.Dict(Snowflake(User), User),
    guild_members: dict.Dict(Snowflake(User), ResolvedGuildMember),
    roles: dict.Dict(Snowflake(Role), Role),
    mentionable_users: dict.Dict(Snowflake(Mentionable), User),
    mentionable_guild_members: dict.Dict(
      Snowflake(Mentionable),
      ResolvedGuildMember,
    ),
    mentionable_roles: dict.Dict(Snowflake(Mentionable), Role),
    channels: dict.Dict(Snowflake(Channel), ResolvedChannel),
    messages: dict.Dict(Snowflake(Message), Message),
    attachments: dict.Dict(
      Snowflake(MessageAttachment),
      MessageAttachment,
    ),
  )
}

Constructors

InteractionResponseMessage

opaque </> 
pub opaque type InteractionResponseMessage

InteractionResponseMessageFlag

</> 
pub type InteractionResponseMessageFlag {
  InteractionResponseMessageWithSuppressedEmbeds
  InteractionResponseMessageIsEphemeral
  InteractionResponseMessageIsVoiceMessage
  InteractionResponseMessageUsesComponentsV2
  InteractionResponseMessageWithSuppressedNotifications
}

Constructors 

  • InteractionResponseMessageWithSuppressedEmbeds

    Makes links not create embeds.

  • InteractionResponseMessageIsEphemeral

    Makes the response only visible to the invoking user.

  • InteractionResponseMessageIsVoiceMessage
  • InteractionResponseMessageUsesComponentsV2

    Required for some components, see CreateMessageComponent for more info on which components require this flag.

  • InteractionResponseMessageWithSuppressedNotifications

    Makes people not receive push notifications for this message.

InteractionResponseModal

opaque </> 
pub opaque type InteractionResponseModal

InteractionToken

opaque </> 
pub opaque type InteractionToken

Invite

</> 
pub type Invite {
  Invite(
    code: String,
    guild: Guild,
    channel: option.Option(GuildChannel),
    inviter: option.Option(User),
    target: option.Option(InviteTarget),
    expiration: option.Option(timestamp.Timestamp),
    scheduled_event: option.Option(ScheduledEvent),
    flags: List(InviteFlag),
    automatically_awarded_roles: List(InviteRole),
    metadata: option.Option(InviteMetadata),
  )
}

Constructors

InviteFlag

</> 
pub type InviteFlag {
  InviteIsGuestInvite
}

Constructors 

  • InviteIsGuestInvite

InviteMetadata

</> 
pub type InviteMetadata {
  InviteMetadata(
    uses: Int,
    max_uses: Int,
    max_age: duration.Duration,
    grants_temporary_membership: Bool,
    creation: timestamp.Timestamp,
  )
}

Constructors 

  • InviteMetadata(
  uses: Int,
  max_uses: Int,
  max_age: duration.Duration,
  grants_temporary_membership: Bool,
  creation: timestamp.Timestamp,
)

    Arguments

    uses

    How many times has the invite been used?

    max_uses

    How many times can the invite be used?

    max_age

    Duration after which the invite expires.

InviteRole

</>

A partial role object for invites.

pub type InviteRole {
  InviteRole(
    id: Snowflake(Role),
    name: String,
    position: Int,
    colours: RoleColours,
    icon_hash: option.Option(ImageHash),
    unicode_emoji: option.Option(String),
  )
}

Constructors

InviteTarget

</> 
pub type InviteTarget {
  StreamInvite(streaming_user: User)
  EmbeddedApplicationInvite(application: Application)
}

Constructors 

  • StreamInvite(streaming_user: User)
  • EmbeddedApplicationInvite(application: Application)

LinkButton

</> 
pub type LinkButton {
  LinkButton(
    id: Int,
    label: option.Option(String),
    emoji: option.Option(ComponentEmoji),
    url: String,
    is_disabled: Bool,
  )
}

Constructors

Locale

</>

An enum describing every available Discord locale.

pub type Locale {
  IndonesianLocale
  DanishLocale
  GermanLocale
  EnglishUkLocale
  EnglishUsLocale
  SpanishSpainLocale
  SpanishLatamLocale
  FrenchLocale
  CroatianLocale
  ItalianLocale
  LithuanianLocale
  HungarianLocale
  DutchLocale
  NorwegianLocale
  PolishLocale
  PortugueseBrazilLocale
  RomanianRomaniaLocale
  FinnishLocale
  SwedishLocale
  VietnameseLocale
  TurkishLocale
  CzechLocale
  GreekLocale
  BulgarianLocale
  RussianLocale
  UkrainianLocale
  HindiLocale
  ThaiLocale
  ChineseChinaLocale
  JapaneseLocale
  ChineseTaiwanLocale
  KoreanLocale
}

Constructors 

  • IndonesianLocale
  • DanishLocale
  • GermanLocale
  • EnglishUkLocale
  • EnglishUsLocale
  • SpanishSpainLocale
  • SpanishLatamLocale
  • FrenchLocale
  • CroatianLocale
  • ItalianLocale
  • LithuanianLocale
  • HungarianLocale
  • DutchLocale
  • NorwegianLocale
  • PolishLocale

    🇵🇱

  • PortugueseBrazilLocale
  • RomanianRomaniaLocale
  • FinnishLocale
  • SwedishLocale
  • VietnameseLocale
  • TurkishLocale
  • CzechLocale
  • GreekLocale
  • BulgarianLocale
  • RussianLocale
  • UkrainianLocale
  • HindiLocale
  • ThaiLocale
  • ChineseChinaLocale
  • JapaneseLocale
  • ChineseTaiwanLocale
  • KoreanLocale

MediaChannel

</> 
pub type MediaChannel {
  MediaChannel(
    id: Snowflake(MediaChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    forum_like_channel_id: Snowflake(ForumLikeChannel),
    permission_overwrites: List(PermissionOverwrite),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    rate_limit_per_user: RateLimitPerUser,
    last_thread_id: option.Option(Snowflake(Thread)),
    parent_id: option.Option(Snowflake(CategoryChannel)),
    default_thread_auto_archive_duration: ThreadAutoArchiveDuration,
    flags: List(MediaChannelFlag),
    available_tags: List(ForumTag),
    default_reaction: option.Option(DefaultForumReaction),
    default_thread_rate_limit_per_user: RateLimitPerUser,
    default_sort_order: ForumSortOrder,
  )
}

Constructors

MediaChannelFlag

</> 
pub type MediaChannelFlag {
  MediaChannelRequiresTags
  MediaChannelHidesMediaDownloadOptions
}

Constructors 

  • MediaChannelRequiresTags
  • MediaChannelHidesMediaDownloadOptions

MediaGalleryItem

</> 
pub type MediaGalleryItem {
  MediaGalleryItem(
    media: UnfurledMediaItem,
    description: option.Option(String),
    is_spoiler: Bool,
  )
}

Constructors

Mentionable

</> 
pub type Mentionable

MentionableSlashCommandOption

</> 
pub type MentionableSlashCommandOption {
  MentionableSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
  )
}

Constructors

Message

</> 
pub type Message {
  Message(
    id: Snowflake(Message),
    channel_id: Snowflake(Channel),
    author: User,
    content: String,
    sent_timestamp: timestamp.Timestamp,
    edited_timestamp: option.Option(timestamp.Timestamp),
    is_tts: Bool,
    mentions_everyone: Bool,
    mentioned_users: List(User),
    mentioned_roles_ids: List(Snowflake(Role)),
    attachments: List(MessageAttachment),
    embeds: List(MessageEmbed),
    reactions: List(MessageReaction),
    nonce: option.Option(MessageNonce),
    is_pinned: Bool,
    webhook_id: option.Option(Snowflake(Webhook)),
    type_: MessageType,
    application_id: option.Option(Snowflake(Application)),
    flags: List(MessageFlag),
    reference: option.Option(MessageReference),
    snapshots: List(MessageSnapshot),
    referenced_message: option.Option(Message),
    components: List(MessageComponent),
    interaction_metadata: option.Option(
      MessageInteractionMetadata,
    ),
    thread: option.Option(Thread),
    sticker_items: List(StickerItem),
    approximate_position_in_thread: option.Option(Int),
    role_subscription_purchase_notification: option.Option(
      RoleSubscriptionPurchaseNotification,
    ),
    poll: option.Option(Poll),
    call: option.Option(MessageCall),
  )
}

Constructors 

  • Message(
  id: Snowflake(Message),
  channel_id: Snowflake(Channel),
  author: User,
  content: String,
  sent_timestamp: timestamp.Timestamp,
  edited_timestamp: option.Option(timestamp.Timestamp),
  is_tts: Bool,
  mentions_everyone: Bool,
  mentioned_users: List(User),
  mentioned_roles_ids: List(Snowflake(Role)),
  attachments: List(MessageAttachment),
  embeds: List(MessageEmbed),
  reactions: List(MessageReaction),
  nonce: option.Option(MessageNonce),
  is_pinned: Bool,
  webhook_id: option.Option(Snowflake(Webhook)),
  type_: MessageType,
  application_id: option.Option(Snowflake(Application)),
  flags: List(MessageFlag),
  reference: option.Option(MessageReference),
  snapshots: List(MessageSnapshot),
  referenced_message: option.Option(Message),
  components: List(MessageComponent),
  interaction_metadata: option.Option(MessageInteractionMetadata),
  thread: option.Option(Thread),
  sticker_items: List(StickerItem),
  approximate_position_in_thread: option.Option(Int),
  role_subscription_purchase_notification: option.Option(
    RoleSubscriptionPurchaseNotification,
  ),
  poll: option.Option(Poll),
  call: option.Option(MessageCall),
)

    Arguments

    content

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty string.

    is_tts

    Whether the message is text-to-speech-enabled.

    attachments

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty list.

    embeds

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty list.

    nonce

    Used for verifying a message was sent.

    webhook_id

    If the message was generated by a webhook, this is its ID.

    application_id

    If the message is an interaction or application-owned webhook, this is its ID.

    reference

    Information regarding a crossposted message, channel follow add notification, pin notificatio, reply, etc.

    snapshots

    Snapshots of a forwarded message.

    referenced_message

    If this message is a reply or similar, this will be its parent message.

    components

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty list.

    interaction_metadata

    Sent if the message was sent as a result of an interaction

    thread

    Sent if the message was the one that started a thread.

    approximate_position_in_thread

    Only sent if the message was sent in a thread.

    role_subscription_purchase_notification

    If the message is a notification about a role subscription purchase, this will contain additional data about it.

    poll

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be None.

    Also None if the message doesn’t have a poll :)

MessageActionRow

</> 
pub type MessageActionRow {
  MessageActionRow(id: Int, components: List(ActionRowComponent))
}

Constructors

MessageAttachment

</> 
pub type MessageAttachment {
  MessageAttachment(
    id: Snowflake(MessageAttachment),
    file_name: String,
    title: option.Option(String),
    description: option.Option(String),
    content_type: option.Option(String),
    size_bytes: Int,
    url: String,
    proxy_url: String,
    is_ephemeral: Bool,
    data: option.Option(MessageAttachmentData),
    flags: List(MessageAttachmentFlag),
  )
}

Constructors

MessageAttachmentData

</> 
pub type MessageAttachmentData {
  MessageAttachmentImage(ImageMessageAttachment)
  MessageAttachmentVideo(VideoMessageAttachment)
  MessageAttachmentAudio(AudioMessageAttachment)
  MessageAttachmentVoice(VoiceMessageAttachment)
  MessageAttachmentClip(ClipMessageAttachment)
}

Constructors

MessageAttachmentFlag

</> 
pub type MessageAttachmentFlag {
  MessageAttachmentIsThumbnail
  MessageAttachmentIsRemix
  MessageAttachmentIsSpoiler
  MessageAttachmentIsAnimated
}

Constructors 

  • MessageAttachmentIsThumbnail
  • MessageAttachmentIsRemix

    The attachment is edited using the mobile-only “remix” feature

  • MessageAttachmentIsSpoiler
  • MessageAttachmentIsAnimated

MessageButton

</> 
pub type MessageButton {
  RegularMessageButton(RegularButton)
  LinkMessageButton(LinkButton)
  PremiumMessageButton(PremiumButton)
}

Constructors

MessageCall

</> 
pub type MessageCall {
  MessageCall(
    participants_ids: List(Snowflake(User)),
    ended_timestamp: option.Option(timestamp.Timestamp),
  )
}

Constructors

MessageChannelSelect

</> 
pub type MessageChannelSelect {
  MessageChannelSelect(
    id: Int,
    custom_id: String,
    placeholder: option.Option(String),
    default_channels: List(Snowflake(Channel)),
    channel_types: List(SelectChannelType),
    min_values: Int,
    max_values: Int,
    is_required: Bool,
  )
}

Constructors

MessageCommand

</> 
pub type MessageCommand {
  MessageCommand(
    id: Snowflake(MessageCommand),
    command_id: Snowflake(Command),
    application_id: Snowflake(Application),
    guild_id: option.Option(Snowflake(Guild)),
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    required_permissions: option.Option(List(Permission)),
    is_nsfw: Bool,
    installation_types: List(CommandInstallationType),
    contexts: List(CommandContext),
    version: Snowflake(CommandVersion),
  )
}

Constructors

MessageComponent

</> 
pub type MessageComponent {
  MessageActionRowComponent(MessageActionRow)
  MessageSectionComponent(MessageSection)
  MessageTextDisplayComponent(MessageTextDisplay)
  MessageMediaGalleryComponent(MessageMediaGallery)
  MessageFileComponent(MessageFile)
  MessageSeparatorComponent(MessageSeparator)
  MessageContainerComponent(MessageContainer)
}

Constructors

MessageComponentInteraction

</> 
pub type MessageComponentInteraction {
  MessageComponentInteraction(
    id: Snowflake(Interaction),
    application_id: Snowflake(Application),
    invokement_data: InteractionInvokementData,
    channel_id: Snowflake(Channel),
    token: MessageComponentInteractionToken,
    interaction_token: InteractionToken,
    message: Message,
    application_permissions: List(Permission),
    invoking_user_locale: Locale,
    invoking_user_entitlements: List(Entitlement),
    context: InteractionContext,
    authorizing_installers: InteractionAuthorizingInstallers,
    component: ExecutedMessageComponent,
  )
}

Constructors

MessageComponentInteractionResponse

opaque </> 
pub opaque type MessageComponentInteractionResponse

MessageComponentInteractionToken

opaque </> 
pub opaque type MessageComponentInteractionToken

MessageContainer

</> 
pub type MessageContainer {
  MessageContainer(
    id: Int,
    components: List(ContainerComponent),
    accent_colour: option.Option(colour.Colour),
    is_spoiler: Bool,
  )
}

Constructors

MessageEmbed

</> 
pub type MessageEmbed {
  MessageEmbed(
    title: option.Option(String),
    type_: EmbedType,
    description: option.Option(String),
    url: option.Option(String),
    timestamp: option.Option(timestamp.Timestamp),
    colour: option.Option(colour.Colour),
    footer: option.Option(EmbedFooter),
    image: option.Option(EmbedImage),
    thumbnail: option.Option(EmbedImage),
    video: option.Option(EmbedVideo),
    author: option.Option(EmbedAuthor),
    fields: option.Option(List(EmbedField)),
  )
}

Constructors

MessageFile

</> 
pub type MessageFile {
  MessageFile(
    id: Int,
    media: UnfurledMediaItem,
    is_spoiler: Bool,
    file_name: String,
    size_bytes: Int,
  )
}

Constructors 

  • MessageFile(
  id: Int,
  media: UnfurledMediaItem,
  is_spoiler: Bool,
  file_name: String,
  size_bytes: Int,
)

MessageFlag

</> 
pub type MessageFlag {
  MessageIsCrossposted
  MessageIsCrosspost
  MessageHasSuppressedEmbeds
  MessageSourceDeleted
  MessageIsUrgent
  MessageHasThread
  MessageIsEphemeral
  MessageIsLoading
  MessageFailedToMentionSomeRolesInThread
  MessageHasSuppressedNotifications
  MessageIsVoiceMessage
  MessageHasSnapshot
  MessageUsesComponentsV2
}

Constructors 

  • MessageIsCrossposted
  • MessageIsCrosspost
  • MessageHasSuppressedEmbeds
  • MessageSourceDeleted

    The message came from a followed announcement channel, and the original message has been deleted.

  • MessageIsUrgent

    This message came from Discord’s urgent message system

  • MessageHasThread

    The message has an associated thread - its ID is the same as the message’s.

  • MessageIsEphemeral

    The message is only visible to its interaction’s invoker.

  • MessageIsLoading

    The message is an interaction response and the bot is “thinking”.

  • MessageFailedToMentionSomeRolesInThread
  • MessageHasSuppressedNotifications
  • MessageIsVoiceMessage
  • MessageHasSnapshot
  • MessageUsesComponentsV2

MessageInteractionMetadata

</> 
pub type MessageInteractionMetadata {
  MessageInteractionMetadata(
    interaction_id: Snowflake(Interaction),
    triggering_user: User,
    installed_guild_id: option.Option(Snowflake(Guild)),
    installed_user_id: option.Option(Snowflake(User)),
    original_response_message_id: option.Option(
      Snowflake(Message),
    ),
    target_user: option.Option(User),
    target_message_id: option.Option(Snowflake(Message)),
  )
}

Constructors 

  • MessageInteractionMetadata(
  interaction_id: Snowflake(Interaction),
  triggering_user: User,
  installed_guild_id: option.Option(Snowflake(Guild)),
  installed_user_id: option.Option(Snowflake(User)),
  original_response_message_id: option.Option(Snowflake(Message)),
  target_user: option.Option(User),
  target_message_id: option.Option(Snowflake(Message)),
)

    Arguments

    installed_guild_id

    If the interaction’s application was guild-installed, this will be the guild’s ID.

    installed_user_id

    If the interaction’s application was user-installed, this will be the user’s ID.

    original_response_message_id

    If this message is a follow-up message to an interaction, this will be its parent’s ID.

    target_user

    If the interaction was a user command invokement, this will be its target user.

    target_message_id

    If the interaction was a message command invokement, this will be its target message’s ID.

    Note: You can retrieve the target message from referenced_message field of the original message.

MessageMediaGallery

</> 
pub type MessageMediaGallery {
  MessageMediaGallery(id: Int, items: List(MediaGalleryItem))
}

Constructors

MessageMentionableSelect

</> 
pub type MessageMentionableSelect {
  MessageMentionableSelect(
    id: Int,
    custom_id: String,
    placeholder: option.Option(String),
    default_users: List(Snowflake(User)),
    default_roles: List(Snowflake(Role)),
    min_values: Int,
    max_values: Int,
    is_required: Bool,
  )
}

Constructors 

  • MessageMentionableSelect(
  id: Int,
  custom_id: String,
  placeholder: option.Option(String),
  default_users: List(Snowflake(User)),
  default_roles: List(Snowflake(Role)),
  min_values: Int,
  max_values: Int,
  is_required: Bool,
)

MessageNonce

</> 
pub type MessageNonce {
  IntMessageNonce(Int)
  StringMessageNonce(String)
}

Constructors 

  • IntMessageNonce(Int)
  • StringMessageNonce(String)

MessagePin

</> 
pub type MessagePin {
  MessagePin(
    pinned_timestamp: timestamp.Timestamp,
    message: Message,
  )
}

Constructors

MessageReaction

</> 
pub type MessageReaction {
  MessageReaction(
    count: Int,
    super_count: Int,
    normal_count: Int,
    current_user_reacted: Bool,
    current_user_super_reacted: Bool,
    emoji: Emoji,
    super_colours: List(colour.Colour),
  )
}

Constructors 

  • MessageReaction(
  count: Int,
  super_count: Int,
  normal_count: Int,
  current_user_reacted: Bool,
  current_user_super_reacted: Bool,
  emoji: Emoji,
  super_colours: List(colour.Colour),
)

    Arguments

    count

    Sum of all reactions (normal + super).

MessageReactionEmoji

</> 
pub type MessageReactionEmoji {
  MessageReactionWithUnicodeEmoji(character: String)
  MessageReactionWithCustomEmoji(
    name: String,
    id: Snowflake(Emoji),
  )
}

Constructors 

  • MessageReactionWithUnicodeEmoji(character: String)
  • MessageReactionWithCustomEmoji(
  name: String,
  id: Snowflake(Emoji),
)

MessageReference

</>

Information regarding a crossposted message, channel follow add notification, pin notification reply, etc.

pub type MessageReference {
  MessageReference(
    type_: MessageReferenceType,
    original_message_id: Snowflake(Message),
    original_channel_id: Snowflake(Channel),
    original_guild_id: option.Option(Snowflake(Guild)),
  )
}

Constructors

MessageReferenceType

</> 
pub type MessageReferenceType {
  MessageReferenceIsReply
  MessageReferenceIsForward
}

Constructors 

  • MessageReferenceIsReply
  • MessageReferenceIsForward

MessageRoleSelect

</> 
pub type MessageRoleSelect {
  MessageRoleSelect(
    id: Int,
    custom_id: String,
    placeholder: option.Option(String),
    default_roles: List(Snowflake(Role)),
    min_values: Int,
    max_values: Int,
    is_required: Bool,
  )
}

Constructors 

  • MessageRoleSelect(
  id: Int,
  custom_id: String,
  placeholder: option.Option(String),
  default_roles: List(Snowflake(Role)),
  min_values: Int,
  max_values: Int,
  is_required: Bool,
)

MessageSection

</> 
pub type MessageSection {
  MessageSection(
    id: Int,
    components: List(SectionComponent),
    accessory: SectionAccessory,
  )
}

Constructors

MessageSeparator

</> 
pub type MessageSeparator {
  MessageSeparator(
    id: Int,
    is_divider_visible: Bool,
    spacing: SeparatorSpacing,
  )
}

Constructors 

  • MessageSeparator(
  id: Int,
  is_divider_visible: Bool,
  spacing: SeparatorSpacing,
)

MessageSnapshot

</> 
pub type MessageSnapshot {
  MessageSnapshot(
    type_: MessageType,
    content: String,
    embeds: List(MessageEmbed),
    attachments: List(MessageAttachment),
    sent_timestamp: timestamp.Timestamp,
    edited_timestamp: option.Option(timestamp.Timestamp),
    flags: List(MessageFlag),
    mentioned_users: List(User),
    mentioned_roles_ids: List(Snowflake(Role)),
    sticker_items: List(StickerItem),
    components: List(MessageComponent),
  )
}

Constructors 

  • MessageSnapshot(
  type_: MessageType,
  content: String,
  embeds: List(MessageEmbed),
  attachments: List(MessageAttachment),
  sent_timestamp: timestamp.Timestamp,
  edited_timestamp: option.Option(timestamp.Timestamp),
  flags: List(MessageFlag),
  mentioned_users: List(User),
  mentioned_roles_ids: List(Snowflake(Role)),
  sticker_items: List(StickerItem),
  components: List(MessageComponent),
)

    Arguments

    content

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty string.

    embeds

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty list.

    attachments

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty list.

    components

    If your app doesn’t have the MESSAGE_CONTENT privileged intent enabled, this will be an empty list.

MessageStringSelect

</> 
pub type MessageStringSelect {
  MessageStringSelect(
    id: Int,
    custom_id: String,
    options: List(StringSelectOption),
    placeholder: option.Option(String),
    min_values: Int,
    max_values: Int,
    is_disabled: Bool,
  )
}

Constructors 

  • MessageStringSelect(
  id: Int,
  custom_id: String,
  options: List(StringSelectOption),
  placeholder: option.Option(String),
  min_values: Int,
  max_values: Int,
  is_disabled: Bool,
)

MessageTextDisplay

</> 
pub type MessageTextDisplay {
  MessageTextDisplay(id: Int, content: String)
}

Constructors 

  • MessageTextDisplay(id: Int, content: String)

MessageThumbnail

</> 
pub type MessageThumbnail {
  MessageThumbnail(
    id: Int,
    media: UnfurledMediaItem,
    description: option.Option(String),
    is_spoiler: Bool,
  )
}

Constructors

MessageType

</> 
pub type MessageType {
  MessageIsNormalMessage
  MessageIsRecipientAddNotification
  MessageIsRecipientRemoveNotification
  MessageIsCallNotification
  MessageIsChannelNameChangeNotification
  MessageIsChannelIconChangeNotification
  MessageIsPinnedMessageNotification
  MessageIsUserJoinNotification
  MessageIsGuildBoostNotification
  MessageIsGuildBoostTier1Notification
  MessageIsGuildBoostTier2Notification
  MessageIsGuildBoostTier3Notification
  MessageIsChannelFollowAddedNotification
  MessageIsGuildDiscoveryDisqualificationNotification
  MessageIsGuildDiscoveryRequalificationNotification
  MessageIsGuildDiscoveryGracePeriodInitialWarning
  MessageIsGuildDiscoveryGracePeriodFinalWarning
  MessageIsThreadCreationNotification
  MessageIsReply
  MessageIsSlashCommand
  MessageIsThreadStarterMessage
  MessageIsGuildInviteReminder
  MessageIsContextMenuCommand
  MessageIsAutoModerationActionNotification
  MessageIsRoleSubscriptionPurchaseNotification
  MessageIsInteractionPremiumUpsell
  MessageIsStageStartNotification
  MessageIsStageEndNotification
  MessageIsNewStageSpeakerNotification
  MessageIsNewStageTopicNotification
  MessageIsGuildApplicationPremiumSubscriptionNotification
  MessageIsGuildIncidentAlertModeEnabledNotification
  MessageIsGuildIncidentAlertModeDisabledNotification
  MessageIsRaidReportNotification
  MessageIsFalseAlarmReportNotification
  MessageIsPurchaseNotification
  MessageIsPollResult
}

Constructors 

  • MessageIsNormalMessage

    Deletable.

  • MessageIsRecipientAddNotification

    Not deletable.

  • MessageIsRecipientRemoveNotification

    Not deletable.

  • MessageIsCallNotification

    Not deletable.

  • MessageIsChannelNameChangeNotification

    Not deletable.

  • MessageIsChannelIconChangeNotification

    Not deletable.

  • MessageIsPinnedMessageNotification

    Deletable.

  • MessageIsUserJoinNotification

    Deletable.

  • MessageIsGuildBoostNotification

    Deletable.

  • MessageIsGuildBoostTier1Notification

    Deletable.

  • MessageIsGuildBoostTier2Notification

    Deletable.

  • MessageIsGuildBoostTier3Notification

    Deletable.

  • MessageIsChannelFollowAddedNotification

    Deletable.

  • MessageIsGuildDiscoveryDisqualificationNotification

    Deletable.

  • MessageIsGuildDiscoveryRequalificationNotification

    Deletable.

  • MessageIsGuildDiscoveryGracePeriodInitialWarning

    Deletable.

  • MessageIsGuildDiscoveryGracePeriodFinalWarning

    Deletable.

  • MessageIsThreadCreationNotification

    Deletable.

  • MessageIsReply

    Deletable.

  • MessageIsSlashCommand

    Deletable.

  • MessageIsThreadStarterMessage

    Not deletable.

  • MessageIsGuildInviteReminder

    Deletable.

  • MessageIsContextMenuCommand

    Deletable.

  • MessageIsAutoModerationActionNotification

    Deletable by members with the AllowManagingMessages permission.

  • MessageIsRoleSubscriptionPurchaseNotification

    Deletable.

  • MessageIsInteractionPremiumUpsell

    Deletable.

  • MessageIsStageStartNotification

    Deletable.

  • MessageIsStageEndNotification

    Deletable.

  • MessageIsNewStageSpeakerNotification

    Deletable.

  • MessageIsNewStageTopicNotification

    Deletable.

  • MessageIsGuildApplicationPremiumSubscriptionNotification

    Deletable.

  • MessageIsGuildIncidentAlertModeEnabledNotification

    Deletable.

  • MessageIsGuildIncidentAlertModeDisabledNotification

    Deletable.

  • MessageIsRaidReportNotification

    Deletable.

  • MessageIsFalseAlarmReportNotification

    Deletable.

  • MessageIsPurchaseNotification

    Deletable.

  • MessageIsPollResult

    Deletable.

MessageUserSelect

</> 
pub type MessageUserSelect {
  MessageUserSelect(
    id: Int,
    custom_id: String,
    placeholder: option.Option(String),
    default_users: List(Snowflake(User)),
    min_values: Int,
    max_values: Int,
    is_required: Bool,
  )
}

Constructors 

  • MessageUserSelect(
  id: Int,
  custom_id: String,
  placeholder: option.Option(String),
  default_users: List(Snowflake(User)),
  min_values: Int,
  max_values: Int,
  is_required: Bool,
)

ModalInteraction

</> 
pub type ModalInteraction {
  ModalInteraction(
    id: Snowflake(Interaction),
    application_id: Snowflake(Application),
    invokement_data: InteractionInvokementData,
    token: ModalInteractionToken,
    interaction_token: InteractionToken,
    message: option.Option(Message),
    application_permissions: List(Permission),
    invoking_user_locale: Locale,
    invoking_user_entitlements: List(Entitlement),
    context: InteractionContext,
    authorizing_installers: InteractionAuthorizingInstallers,
    modal: SubmittedModal,
  )
}

Constructors

ModalInteractionResponse

opaque </> 
pub opaque type ModalInteractionResponse

ModalInteractionToken

opaque </> 
pub opaque type ModalInteractionToken

ModifyAnnouncementChannel

opaque </> 
pub opaque type ModifyAnnouncementChannel

ModifyCategoryChannel

opaque </> 
pub opaque type ModifyCategoryChannel

ModifyCurrentApplication

opaque </> 
pub opaque type ModifyCurrentApplication

ModifyCurrentApplicationFlag

</> 
pub type ModifyCurrentApplicationFlag {
  ModifyCurrentApplicationPresenceTemporaryPrivilegedIntent
  ModifyCurrentApplicationGuildMembersTemporaryPrivilegedIntent
  ModifyCurrentApplicationMessageContentTemporaryPrivilegedIntent
}

Constructors 

  • ModifyCurrentApplicationPresenceTemporaryPrivilegedIntent

    Add/remove the presence temporary privileged intent.

    Does not apply to apps which were approved for this intent.

  • ModifyCurrentApplicationGuildMembersTemporaryPrivilegedIntent

    Add/remove the guild members temporary privileged intent.

    Does not apply to apps which were approved for this intent.

  • ModifyCurrentApplicationMessageContentTemporaryPrivilegedIntent

    Add/remove the message content temporary privileged intent.

    Does not apply to apps which were approved for this intent.

ModifyCurrentGuildMember

opaque </> 
pub opaque type ModifyCurrentGuildMember

ModifyCurrentUser

opaque </> 
pub opaque type ModifyCurrentUser

ModifyForumChannel

opaque </> 
pub opaque type ModifyForumChannel

ModifyGlobalMessageCommand

opaque </> 
pub opaque type ModifyGlobalMessageCommand

ModifyGlobalSlashCommand

opaque </> 
pub opaque type ModifyGlobalSlashCommand

ModifyGlobalUserCommand

opaque </> 
pub opaque type ModifyGlobalUserCommand

ModifyGuild

opaque </>

Look into the (new_)modify_guild_* functions to use this type using a builder pattern.

pub opaque type ModifyGuild

ModifyGuildChannelPosition

opaque </> 
pub opaque type ModifyGuildChannelPosition

ModifyGuildIncidentsData

opaque </> 
pub opaque type ModifyGuildIncidentsData

ModifyGuildMember

opaque </> 
pub opaque type ModifyGuildMember

ModifyGuildMessageCommand

opaque </> 
pub opaque type ModifyGuildMessageCommand

ModifyGuildSlashCommand

opaque </> 
pub opaque type ModifyGuildSlashCommand

ModifyGuildSoundboardSound

opaque </> 
pub opaque type ModifyGuildSoundboardSound

ModifyGuildSticker

opaque </> 
pub opaque type ModifyGuildSticker

ModifyGuildUserCommand

opaque </> 
pub opaque type ModifyGuildUserCommand

ModifyGuildWelcomeScreen

opaque </> 
pub opaque type ModifyGuildWelcomeScreen

ModifyGuildWidgetSettings

opaque </> 
pub opaque type ModifyGuildWidgetSettings

ModifyInteractionResponseMessage

opaque </> 
pub opaque type ModifyInteractionResponseMessage

ModifyMediaChannel

opaque </> 
pub opaque type ModifyMediaChannel

ModifyMessage

opaque </> 
pub opaque type ModifyMessage

ModifyMessageAddFlag

</> 
pub type ModifyMessageAddFlag {
  ModifyMessageToSuppressEmbeds
  ModifyMessageToUseComponentsV2
}

Constructors 

  • ModifyMessageToSuppressEmbeds
  • ModifyMessageToUseComponentsV2

ModifyMessageRemoveFlag

</> 
pub type ModifyMessageRemoveFlag {
  ModifyMessageToNoLongerSuppressEmbeds
}

Constructors 

  • ModifyMessageToNoLongerSuppressEmbeds

ModifyRole

opaque </> 
pub opaque type ModifyRole

ModifyRolePosition

opaque </>

See the move_role and delete_role_position functions.

pub opaque type ModifyRolePosition

ModifyStageChannel

opaque </> 
pub opaque type ModifyStageChannel

ModifyTextChannel

opaque </> 
pub opaque type ModifyTextChannel

ModifyThread

opaque </> 
pub opaque type ModifyThread

ModifyVoiceChannel

opaque </> 
pub opaque type ModifyVoiceChannel

Permission

</> 
pub type Permission {
  AllowCreatingInstantInvites
  AllowKickingMembers
  AllowBanningMembers
  AdministratorPermission
  AllowManagingChannels
  AllowManagingGuild
  AllowAddingReactions
  AllowViewingAuditLog
  AllowPrioritySpeakingInVoiceChannels
  AllowStreamingInVoiceChannels
  AllowViewingChannels
  AllowSendingMessages
  AllowSendingTtsMessages
  AllowManagingMessages
  AutoEmbedLinksPermission
  AllowAttachingFiles
  AllowReadingMessageHistory
  AllowMentioningEveryone
  AllowUsingExternalEmojis
  AllowViewingGuildInsights
  AllowConnectingToVoiceChannels
  AllowSpeakingInVoiceChannels
  AllowMutingMembersInVoiceChannels
  AllowDeafeningMembersInVoiceChannels
  AllowMovingMembersBetweenVoiceChannels
  AllowUsingVoiceActivityDetection
  AllowChangingOwnNickname
  AllowManagingNicknames
  AllowManagingRoles
  AllowManagingWebhooks
  AllowManagingGuildExpressions
  AllowUsingCommands
  AllowRequestingToSpeakInStageChannels
  AllowManagingEvents
  AllowManagingThreads
  AllowCreatingPublicThreads
  AllowCreatingPrivateThreads
  AllowUsingExternalStickers
  AllowSendingMessagesInThreads
  AllowUsingEmbeddedActivities
  AllowModeratingMembers
  AllowViewingCreatorMonetizationAnalytics
  AllowUsingSoundboard
  AllowCreatingGuildExpressions
  AllowCreatingEvents
  AllowUsingExternalSoundboardSounds
  AllowSendingVoiceMessages
  AllowSettingVoiceChannelStatus
  AllowSendingPolls
  AllowUsingExternalApplications
  AllowPinningMessages
  AllowBypassingSlowmode
}

Constructors 

  • AllowCreatingInstantInvites
  • AllowKickingMembers
  • AllowBanningMembers
  • AdministratorPermission

    Allows all permissions and bypasses channel permission overrides.

  • AllowManagingChannels

    Allows management and editing of channels

  • AllowManagingGuild

    Allows management and editing of the guild

  • AllowAddingReactions

    Allows adding new reactions to messages. Does not change the ability to react with an existing reaction.

  • AllowViewingAuditLog
  • AllowPrioritySpeakingInVoiceChannels
  • AllowStreamingInVoiceChannels
  • AllowViewingChannels

    Implicitly enabled by default.

  • AllowSendingMessages

    Implicitly enabled by default.

  • AllowSendingTtsMessages

    Allows sending text-to-speech messages, read out loud by default to all readers.

  • AllowManagingMessages

    Allows deleting others’ messages.

  • AutoEmbedLinksPermission

    Automatically shows embeds of links sent by the permission’s owner.

  • AllowAttachingFiles
  • AllowReadingMessageHistory
  • AllowMentioningEveryone

    Allows mentioning @everyone - everyone in the guild and @here - every online person in the guild.

  • AllowUsingExternalEmojis

    Allows using custom emojis from other servers.

  • AllowViewingGuildInsights
  • AllowConnectingToVoiceChannels
  • AllowSpeakingInVoiceChannels
  • AllowMutingMembersInVoiceChannels
  • AllowDeafeningMembersInVoiceChannels
  • AllowMovingMembersBetweenVoiceChannels
  • AllowUsingVoiceActivityDetection
  • AllowChangingOwnNickname
  • AllowManagingNicknames

    Allows modifying others’ nicknames.

  • AllowManagingRoles

    Allows modifying others’ roles.

  • AllowManagingWebhooks
  • AllowManagingGuildExpressions

    Allows editing and deleting the guild’s custom emojis, stickers and soundboard sounds.

  • AllowUsingCommands

    Allows using slash/context-menu commands.

  • AllowRequestingToSpeakInStageChannels
  • AllowManagingEvents

    Allows editing and deleting the guild’s scheduled events.

  • AllowManagingThreads

    Allows deleting and archiving threads, and viewing all public and private threads.

  • AllowCreatingPublicThreads

    Allows creating public and announcement threads.

  • AllowCreatingPrivateThreads
  • AllowUsingExternalStickers

    Allows using custom stickers from other guilds.

  • AllowSendingMessagesInThreads
  • AllowUsingEmbeddedActivities
  • AllowModeratingMembers

    Allows timing-out other members.

  • AllowViewingCreatorMonetizationAnalytics

    Allows viewing role subscription insights.

  • AllowUsingSoundboard
  • AllowCreatingGuildExpressions

    Allows creating custom emojis, stickers and soundboard sounds. Also allows editing and deleting the aforementioned expressions created by the permission’s owner.

  • AllowCreatingEvents

    Allows creating scheduled events. Also allows editing and deleting events created by the permission’s owner.

  • AllowUsingExternalSoundboardSounds

    Allows using soundboard sounds from other guilds.

  • AllowSendingVoiceMessages
  • AllowSettingVoiceChannelStatus
  • AllowSendingPolls
  • AllowUsingExternalApplications

    Allows user-installed applications to send public responses.

    When disabled, users will still be able to use their apps, but their responses will be ephemeral. This only applies to apps that are not installed at the guild level.

  • AllowPinningMessages
  • AllowBypassingSlowmode

PermissionOverwrite

</>

Permission overwrites are used to grant/deny specific permissions to members (personally or per-role) in specific channels.

The order of importance for permission overwrites:

  1. User-based allow overwrites
  2. User-based deny overwrites
  3. Role-based allow overwrites
  4. Role-based deny overwrites
  5. @everyone allow overwrites
  6. @everyone deny overwrites
  7. Guild-level role permissions
  8. Guild-level @everyone permissions
pub type PermissionOverwrite {
  RolePermissionOverwrite(
    role_id: Snowflake(Role),
    allow: List(Permission),
    deny: List(Permission),
  )
  UserPermissionOverwrite(
    user_id: Snowflake(User),
    allow: List(Permission),
    deny: List(Permission),
  )
}

Constructors

Poll

</> 
pub type Poll {
  Poll(
    question: String,
    answers: List(PollAnswer),
    end_timestamp: timestamp.Timestamp,
    allows_multiselect: Bool,
    results: option.Option(PollResults),
  )
}

Constructors

PollAnswer

</> 
pub type PollAnswer {
  PollAnswer(id: Int, text: String, emoji: option.Option(Emoji))
}

Constructors

PollAnswerCount

</> 
pub type PollAnswerCount {
  PollAnswerCount(
    answer_id: Int,
    count: Int,
    current_user_voted: Bool,
  )
}

Constructors 

  • PollAnswerCount(
  answer_id: Int,
  count: Int,
  current_user_voted: Bool,
)

PollResults

</> 
pub type PollResults {
  PollResults(
    is_finalized: Bool,
    answer_counts: List(PollAnswerCount),
  )
}

Constructors 

  • PollResults(
  is_finalized: Bool,
  answer_counts: List(PollAnswerCount),
)

    Arguments

    is_finalized

    Whether the votes have been precisely counted.

PremiumButton

</> 
pub type PremiumButton {
  PremiumButton(
    id: Int,
    sku_id: Snowflake(Sku),
    is_disabled: Bool,
  )
}

Constructors 

  • PremiumButton(id: Int, sku_id: Snowflake(Sku), is_disabled: Bool)

PruneGuild

opaque </> 
pub opaque type PruneGuild

RateLimitPerUser

opaque </> 
pub opaque type RateLimitPerUser

RegularButton

</> 
pub type RegularButton {
  RegularButton(
    id: Int,
    style: RegularButtonStyle,
    label: option.Option(String),
    emoji: option.Option(ComponentEmoji),
    custom_id: String,
    is_disabled: Bool,
  )
}

Constructors

RegularButtonStyle

</> 
pub type RegularButtonStyle {
  PrimaryRegularButton
  SecondaryRegularButton
  SuccessRegularButton
  DangerRegularButton
}

Constructors 

  • PrimaryRegularButton
  • SecondaryRegularButton
  • SuccessRegularButton
  • DangerRegularButton

RequestedApplicationAssetFormat

</> 
pub type RequestedApplicationAssetFormat {
  RequestPngApplicationAsset
  RequestJpegApplicationAsset
  RequestWebpApplicationAsset
}

Constructors 

  • RequestPngApplicationAsset
  • RequestJpegApplicationAsset
  • RequestWebpApplicationAsset

RequestedApplicationCoverFormat

</> 
pub type RequestedApplicationCoverFormat {
  RequestPngApplicationCover
  RequestJpegApplicationCover
  RequestWebpApplicationCover
}

Constructors 

  • RequestPngApplicationCover
  • RequestJpegApplicationCover
  • RequestWebpApplicationCover

RequestedApplicationIconFormat

</> 
pub type RequestedApplicationIconFormat {
  RequestPngApplicationIcon
  RequestJpegApplicationIcon
  RequestWebpApplicationIcon
}

Constructors 

  • RequestPngApplicationIcon
  • RequestJpegApplicationIcon
  • RequestWebpApplicationIcon

RequestedCustomEmojiFormat

</> 
pub type RequestedCustomEmojiFormat {
  RequestPngCustomEmoji
  RequestJpegCustomEmoji
  RequestWebpCustomEmoji
  RequestGifCustomEmoji
}

Constructors 

  • RequestPngCustomEmoji
  • RequestJpegCustomEmoji
  • RequestWebpCustomEmoji

    Recommended format.

    Emojis can be uploaded as PNG, JPEG, WebP, GIF, or AVIF.

    Other formats don’t convert well to formats other than WebP.

  • RequestGifCustomEmoji

    Discouraged.

RequestedDeveloperTeamFormat

</> 
pub type RequestedDeveloperTeamFormat {
  RequestPngDeveloperTeam
  RequestJpegDeveloperTeam
  RequestWebpDeveloperTeam
}

Constructors 

  • RequestPngDeveloperTeam
  • RequestJpegDeveloperTeam
  • RequestWebpDeveloperTeam

RequestedGuildBannerFormat

</> 
pub type RequestedGuildBannerFormat {
  RequestPngGuildBanner
  RequestJpegGuildBanner
  RequestWebpGuildBanner
  RequestGifGuildBanner
}

Constructors 

  • RequestPngGuildBanner
  • RequestJpegGuildBanner
  • RequestWebpGuildBanner
  • RequestGifGuildBanner

RequestedGuildDiscoverySplashFormat

</> 
pub type RequestedGuildDiscoverySplashFormat {
  RequestPngGuildDiscoverySplash
  RequestJpegGuildDiscoverySplash
  RequestWebpGuildDiscoverySplash
}

Constructors 

  • RequestPngGuildDiscoverySplash
  • RequestJpegGuildDiscoverySplash
  • RequestWebpGuildDiscoverySplash

RequestedGuildIconFormat

</> 
pub type RequestedGuildIconFormat {
  RequestPngGuildIcon
  RequestJpegGuildIcon
  RequestWebpGuildIcon
  RequestGifGuildIcon
}

Constructors 

  • RequestPngGuildIcon
  • RequestJpegGuildIcon
  • RequestWebpGuildIcon
  • RequestGifGuildIcon

RequestedGuildMemberAvatarFormat

</> 
pub type RequestedGuildMemberAvatarFormat {
  RequestPngGuildMemberAvatar
  RequestJpegGuildMemberAvatar
  RequestWebpGuildMemberAvatar
  RequestGifGuildMemberAvatar
}

Constructors 

  • RequestPngGuildMemberAvatar
  • RequestJpegGuildMemberAvatar
  • RequestWebpGuildMemberAvatar
  • RequestGifGuildMemberAvatar

RequestedGuildMemberBannerFormat

</> 
pub type RequestedGuildMemberBannerFormat {
  RequestPngGuildMemberBanner
  RequestJpegGuildMemberBanner
  RequestWebpGuildMemberBanner
  RequestGifGuildMemberBanner
}

Constructors 

  • RequestPngGuildMemberBanner
  • RequestJpegGuildMemberBanner
  • RequestWebpGuildMemberBanner
  • RequestGifGuildMemberBanner

RequestedGuildSplashFormat

</> 
pub type RequestedGuildSplashFormat {
  RequestPngGuildSplash
  RequestJpegGuildSplash
  RequestWebpGuildSplash
}

Constructors 

  • RequestPngGuildSplash
  • RequestJpegGuildSplash
  • RequestWebpGuildSplash

RequestedGuildTagBadgeFormat

</> 
pub type RequestedGuildTagBadgeFormat {
  RequestPngGuildTagBadge
  RequestJpegGuildTagBadge
  RequestWebpGuildTagBadge
}

Constructors 

  • RequestPngGuildTagBadge
  • RequestJpegGuildTagBadge
  • RequestWebpGuildTagBadge

RequestedImageSize

</>

The number refers to the size of the larger side of a rectangle.

pub type RequestedImageSize {
  Request16xImage
  Request32xImage
  Request64xImage
  Request128xImage
  Request256xImage
  Request512xImage
  Request1024xImage
  Request2048xImage
  Request4096xImage
  RequestDefaultImage
}

Constructors 

  • Request16xImage
  • Request32xImage
  • Request64xImage
  • Request128xImage
  • Request256xImage
  • Request512xImage
  • Request1024xImage
  • Request2048xImage
  • Request4096xImage
  • RequestDefaultImage

RequestedScheduledEventCoverFormat

</> 
pub type RequestedScheduledEventCoverFormat {
  RequestPngScheduledEventCover
  RequestJpegScheduledEventCover
  RequestWebpScheduledEventCover
}

Constructors 

  • RequestPngScheduledEventCover
  • RequestJpegScheduledEventCover
  • RequestWebpScheduledEventCover

RequestedStickerFormat

</> 
pub type RequestedStickerFormat {
  RequestPngSticker
  RequestLottieSticker
  RequestGifSticker
}

Constructors 

  • RequestPngSticker
  • RequestLottieSticker
  • RequestGifSticker

RequestedStickerPackBannerFormat

</> 
pub type RequestedStickerPackBannerFormat {
  RequestPngStickerPackBanner
  RequestJpegStickerPackBanner
  RequestWebpStickerPackBanner
}

Constructors 

  • RequestPngStickerPackBanner
  • RequestJpegStickerPackBanner
  • RequestWebpStickerPackBanner

RequestedUserAvatarFormat

</> 
pub type RequestedUserAvatarFormat {
  RequestPngUserAvatar
  RequestJpegUserAvatar
  RequestWebpUserAvatar
  RequestGifUserAvatar
}

Constructors 

  • RequestPngUserAvatar
  • RequestJpegUserAvatar
  • RequestWebpUserAvatar
  • RequestGifUserAvatar

RequestedUserBannerFormat

</> 
pub type RequestedUserBannerFormat {
  RequestPngUserBanner
  RequestJpegUserBanner
  RequestWebpUserBanner
  RequestGifUserBanner
}

Constructors 

  • RequestPngUserBanner
  • RequestJpegUserBanner
  • RequestWebpUserBanner
  • RequestGifUserBanner

ResolvedAnnouncementChannel

</> 
pub type ResolvedAnnouncementChannel {
  ResolvedAnnouncementChannel(
    id: Snowflake(AnnouncementChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    thread_creatable_channel_id: Snowflake(ThreadCreatableChannel),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    last_pin_timestamp: option.Option(timestamp.Timestamp),
    parent_id: option.Option(Snowflake(CategoryChannel)),
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors

ResolvedCategoryChannel

</> 
pub type ResolvedCategoryChannel {
  ResolvedCategoryChannel(
    id: Snowflake(CategoryChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors

ResolvedChannel

</> 
pub type ResolvedChannel {
  ResolvedChannelText(ResolvedTextChannel)
  ResolvedChannelVoice(ResolvedVoiceChannel)
  ResolvedChannelCategory(ResolvedCategoryChannel)
  ResolvedChannelAnnouncement(ResolvedAnnouncementChannel)
  ResolvedChannelStage(ResolvedStageChannel)
  ResolvedChannelForum(ResolvedForumChannel)
  ResolvedChannelMedia(ResolvedMediaChannel)
  ResolvedChannelDm(ResolvedDmChannel)
  ResolvedChannelThread(ResolvedThread)
}

Constructors

ResolvedDmChannel

</> 
pub type ResolvedDmChannel {
  ResolvedDmChannel(
    id: Snowflake(DmChannel),
    channel_id: Snowflake(Channel),
    last_message_id: option.Option(Snowflake(Message)),
    last_pin_timestamp: option.Option(timestamp.Timestamp),
  )
}

Constructors

ResolvedForumChannel

</> 
pub type ResolvedForumChannel {
  ResolvedForumChannel(
    id: Snowflake(ForumChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    forum_like_channel_id: Snowflake(ForumLikeChannel),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    rate_limit_per_user: RateLimitPerUser,
    last_thread_id: option.Option(Snowflake(Thread)),
    parent_id: option.Option(Snowflake(CategoryChannel)),
    flags: List(ForumChannelFlag),
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors

ResolvedGuildMember

</> 
pub type ResolvedGuildMember {
  ResolvedGuildMember(
    nick: option.Option(String),
    avatar_hash: option.Option(ImageHash),
    banner_hash: option.Option(ImageHash),
    role_ids: List(Snowflake(Role)),
    joined_timestamp: timestamp.Timestamp,
    boosting_since: option.Option(timestamp.Timestamp),
    flags: List(GuildMemberFlag),
    is_pending: Bool,
    communication_disabled_until: option.Option(
      timestamp.Timestamp,
    ),
    avatar_decoration: option.Option(UserAvatarDecoration),
  )
}

Constructors 

  • ResolvedGuildMember(
  nick: option.Option(String),
  avatar_hash: option.Option(ImageHash),
  banner_hash: option.Option(ImageHash),
  role_ids: List(Snowflake(Role)),
  joined_timestamp: timestamp.Timestamp,
  boosting_since: option.Option(timestamp.Timestamp),
  flags: List(GuildMemberFlag),
  is_pending: Bool,
  communication_disabled_until: option.Option(timestamp.Timestamp),
  avatar_decoration: option.Option(UserAvatarDecoration),
)

    Arguments

    nick

    Guild-specific nickname.

    Is None when the member doesn’t have a guild-specific nickname.

    avatar_hash

    Guild-specific avatar hash.

    Is None if the member chose not to use a guild-specific avatar.

    banner_hash

    Guild-specific banner hash.

    Is None if the member chose not to use a guild-specific banner.

    is_pending

    Whether the member has not yet passed the membership screening requirements.

    communication_disabled_until

    When the member’s timeout will expire, returning their ability to communicate in the guild.

    IMPORTANT: the member is not timed out if this field is None or a time in the past.

    avatar_decoration

    Guild-specific avatar decoration.

    Is None if the member chose not to use guild-specific avatar decorations.

ResolvedMediaChannel

</> 
pub type ResolvedMediaChannel {
  ResolvedMediaChannel(
    id: Snowflake(MediaChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    forum_like_channel_id: Snowflake(ForumLikeChannel),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    rate_limit_per_user: RateLimitPerUser,
    last_thread_id: option.Option(Snowflake(Thread)),
    flags: List(MediaChannelFlag),
    parent_id: option.Option(Snowflake(CategoryChannel)),
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors

ResolvedStageChannel

</> 
pub type ResolvedStageChannel {
  ResolvedStageChannel(
    id: Snowflake(StageChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    voice_like_channel_id: Snowflake(VoiceLikeChannel),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    rate_limit_per_user: RateLimitPerUser,
    parent_id: option.Option(Snowflake(CategoryChannel)),
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors

ResolvedTextChannel

</> 
pub type ResolvedTextChannel {
  ResolvedTextChannel(
    id: Snowflake(TextChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    thread_creatable_channel_id: Snowflake(ThreadCreatableChannel),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    rate_limit_per_user: RateLimitPerUser,
    last_pin_timestamp: option.Option(timestamp.Timestamp),
    parent_id: option.Option(Snowflake(CategoryChannel)),
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors

ResolvedThread

</> 
pub type ResolvedThread {
  ResolvedThread(
    id: Snowflake(Thread),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    type_: ThreadType,
    guild_id: option.Option(Snowflake(Guild)),
    name: String,
    last_message_id: option.Option(Snowflake(Message)),
    rate_limit_per_user: RateLimitPerUser,
    parent_id: Snowflake(GuildChannel),
    is_archived: Bool,
    auto_archive_duration: ThreadAutoArchiveDuration,
    last_archive_status_change_at: timestamp.Timestamp,
    is_locked: Bool,
    created_at: option.Option(timestamp.Timestamp),
    flags: List(ThreadFlag),
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors 

  • ResolvedThread(
  id: Snowflake(Thread),
  channel_id: Snowflake(Channel),
  guild_channel_id: Snowflake(GuildChannel),
  type_: ThreadType,
  guild_id: option.Option(Snowflake(Guild)),
  name: String,
  last_message_id: option.Option(Snowflake(Message)),
  rate_limit_per_user: RateLimitPerUser,
  parent_id: Snowflake(GuildChannel),
  is_archived: Bool,
  auto_archive_duration: ThreadAutoArchiveDuration,
  last_archive_status_change_at: timestamp.Timestamp,
  is_locked: Bool,
  created_at: option.Option(timestamp.Timestamp),
  flags: List(ThreadFlag),
  invoking_user_permissions: List(Permission),
  current_application_permissions: List(Permission),
)

    Arguments

    guild_id

    Is None in some gateway events.

    last_message_id

    Is None if there are no messages in the channel.

    rate_limit_per_user

    Represents he amount of time between a user has to wait between sending a message or creating a thread.

    Bots and members with the AllowBypassingSlowmode permission are exempt from slowmode.

    Rate limits per user must be between 0 and 21600 seconds (7.22 hours).

    auto_archive_duration

    Time of inactivity after which the thread will be automatically archived.

    last_archive_status_change_at

    Time when the thread’s archive status was last changed at.

    is_locked

    If a thread is locked, only users with the AllowManagingThreads permission will be able to unarchive it.

    created_at

    Is None if the thread was created before September 1st, 2022.

ResolvedVoiceChannel

</> 
pub type ResolvedVoiceChannel {
  ResolvedVoiceChannel(
    id: Snowflake(VoiceChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    voice_like_channel_id: Snowflake(VoiceLikeChannel),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    rate_limit_per_user: RateLimitPerUser,
    parent_id: option.Option(Snowflake(CategoryChannel)),
    invoking_user_permissions: List(Permission),
    current_application_permissions: List(Permission),
  )
}

Constructors

RestError

</>

An error that is returned if something goes wrong using REST (HTTP) API calls. Examples include:

  • Discord responds with invalid UTF-8 -> ResponseNotValidUtf8
  • A Discord internal server error -> ReceivedUnsuccessfulStatusCode
  • A bad request (e.g. message content too long) -> ReceivedErrorResponse
  • A response decoding failure due to a breaking change with the Discord API -> CouldNotDecodeResponse
pub type RestError {
  ResponseNotValidUtf8(response.Response(BitArray))
  ReceivedUnsuccessfulStatusCode(response.Response(String))
  ReceivedErrorResponse(ErrorResponse)
  CouldNotDecodeResponse(json.DecodeError)
}

Constructors

Role

</> 
pub type Role {
  Role(
    id: Snowflake(Role),
    mentionable_id: Snowflake(Mentionable),
    name: String,
    colours: RoleColours,
    is_hoisted: Bool,
    icon_hash: option.Option(ImageHash),
    unicode_emoji: option.Option(String),
    position: Int,
    permissions: List(Permission),
    is_integration_managed: Bool,
    is_mentionable: Bool,
    bot_id: option.Option(Snowflake(User)),
    integration_id: option.Option(Snowflake(GuildIntegration)),
    is_booster_role: Bool,
    subscription_listing_id: option.Option(Snowflake(Sku)),
    is_available_for_purchase: Bool,
    is_linked_role: Bool,
    flags: List(RoleFlag),
  )
}

Constructors 

  • Role(
  id: Snowflake(Role),
  mentionable_id: Snowflake(Mentionable),
  name: String,
  colours: RoleColours,
  is_hoisted: Bool,
  icon_hash: option.Option(ImageHash),
  unicode_emoji: option.Option(String),
  position: Int,
  permissions: List(Permission),
  is_integration_managed: Bool,
  is_mentionable: Bool,
  bot_id: option.Option(Snowflake(User)),
  integration_id: option.Option(Snowflake(GuildIntegration)),
  is_booster_role: Bool,
  subscription_listing_id: option.Option(Snowflake(Sku)),
  is_available_for_purchase: Bool,
  is_linked_role: Bool,
  flags: List(RoleFlag),
)

    Arguments

    is_hoisted

    Whether the role is pinned in the guild user list.

    position

    Position of this role in the hierarchy. Roles with the same position are sorted by ID.

    permissions

    Permissions given to members with this role.

    is_integration_managed

    Whether this role is managed by an integration. Example: All bots added to a guild are given an integration-managed role.

    is_mentionable

    Whether this role is mentionable in text channels.

    bot_id

    The ID of the bot user associated with this role. Is None if the role isn’t a bot’s role.

    integration_id

    The ID of the integration associated with this role. Is None if the role isn’t an integration’s role.

    is_booster_role

    Whether this role is the role automatically given to the guild’s boosters.

    subscription_listing_id

    The ID of the subscription SKU for this role. Is None if the role isn’t a subscription-based role.

    is_linked_role

    Whether this role is linked to a Discord connection. Learn more: https://support.discord.com/hc/en-us/articles/10388356626711-Connections-Linked-Roles-Admins

RoleColours

</> 
pub type RoleColours {
  RoleColours(
    primary_colour: colour.Colour,
    secondary_colour: option.Option(colour.Colour),
    tertiary_colour: option.Option(colour.Colour),
  )
}

Constructors 

  • RoleColours(
  primary_colour: colour.Colour,
  secondary_colour: option.Option(colour.Colour),
  tertiary_colour: option.Option(colour.Colour),
)

    Arguments

    primary_colour

    The primary colour of the role.

    secondary_colour

    The secondary colour of the role. If present, this will make the role colour a gradient between the provided colours. Can only be set to Some(colour) if the guild has the GuildCanUseEnhancedRoleColours feature.

    tertiary_colour

    The tertiary colour of the role. If present, this will turn the gradient into a holographic style. Can only be set to Some(colour) if the guild has the GuildCanUseEnhancedRoleColours feature.

    Note: When sending tertiary_colour, the API enforces the role colour to be a holographic style with the values:

    • primary_colour = 0xA9C9FF
    • secondary_colour = 0xFFBBEC
    • tertiary_colour = 0xFFC3A0

RoleFlag

</> 
pub type RoleFlag {
  RoleCanBeSeletedInOnboardingPrompt
}

Constructors 

  • RoleCanBeSeletedInOnboardingPrompt

RoleSlashCommandOption

</> 
pub type RoleSlashCommandOption {
  RoleSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
  )
}

Constructors

RoleSubscriptionPurchaseNotification

</> 
pub type RoleSubscriptionPurchaseNotification {
  RoleSubscriptionPurchaseNotification(
    listing_id: Snowflake(Sku),
    tier_name: String,
    total_months_subscribed: Int,
    is_renewal: Bool,
  )
}

Constructors 

  • RoleSubscriptionPurchaseNotification(
  listing_id: Snowflake(Sku),
  tier_name: String,
  total_months_subscribed: Int,
  is_renewal: Bool,
)

    Arguments

    total_months_subscribed

    Cumulative number of months the user has been subscribed for.

    is_renewal

    Whether the notification is for a renewal rather than a new purhase.

ScheduledEvent

</> 
pub type ScheduledEvent {
  ScheduledEvent(
    id: Snowflake(ScheduledEvent),
    guild_id: Snowflake(Guild),
    location: ScheduledEventLocation,
    creator: option.Option(User),
    name: String,
    description: option.Option(String),
    scheduled_start_time: timestamp.Timestamp,
    status: ScheduledEventStatus,
    user_count: option.Option(Int),
    cover_image_hash: option.Option(ImageHash),
    recurrence_rule: option.Option(ScheduledEventRecurrenceRule),
  )
}

Constructors

ScheduledEventLocation

</> 
pub type ScheduledEventLocation {
  ScheduledEventInStageChannel(
    channel_id: Snowflake(StageChannel),
    scheduled_end_time: option.Option(timestamp.Timestamp),
  )
  ScheduledEventInVoiceChannel(
    channel_id: Snowflake(VoiceChannel),
    scheduled_end_time: option.Option(timestamp.Timestamp),
  )
  ExternalScheduledEvent(
    location: String,
    scheduled_end_time: timestamp.Timestamp,
  )
}

Constructors 

  • ScheduledEventInStageChannel(
  channel_id: Snowflake(StageChannel),
  scheduled_end_time: option.Option(timestamp.Timestamp),
)

    Arguments

    scheduled_end_time

    The type of this field is dependent on the location, hence why you must first match on the location.

  • ScheduledEventInVoiceChannel(
  channel_id: Snowflake(VoiceChannel),
  scheduled_end_time: option.Option(timestamp.Timestamp),
)

    Arguments

    scheduled_end_time

    The type of this field is dependent on the location, hence why you must first match on the location.

  • ExternalScheduledEvent(
  location: String,
  scheduled_end_time: timestamp.Timestamp,
)

    Arguments

    location

    Where will the event be held?

    scheduled_end_time

    The type of this field is dependent on the location, hence why you must first match on the location.

ScheduledEventRecurrenceRule

</>

Describes how often an event recurs.

Important! System limitations: https://docs.discord.com/developers/resources/guild-scheduled-event#system-limitations

pub type ScheduledEventRecurrenceRule {
  ScheduledEventRecurrenceRule(
    start: timestamp.Timestamp,
    end: option.Option(timestamp.Timestamp),
    frequency: ScheduledEventRecurrenceRuleFrequency,
    every_weekday: option.Option(List(weekday.Weekday)),
    every_nth_weekday: option.Option(
      List(ScheduledEventRecurrenceRuleNthWeekday),
    ),
    every_month: option.Option(List(calendar.Month)),
    every_month_day: option.Option(List(Int)),
    every_year_day: option.Option(List(Int)),
    count: option.Option(Int),
  )
}

Constructors

ScheduledEventRecurrenceRuleFrequency

</>

interval describes the spacing between events.

For example, ScheduledEventRecursWeekly(interval: 2) means “every two weeks”.

pub type ScheduledEventRecurrenceRuleFrequency {
  ScheduledEventRecursYearly(interval: Int)
  ScheduledEventRecursMonthly(interval: Int)
  ScheduledEventRecursWeekly(interval: Int)
  ScheduledEventRecursDaily(interval: Int)
}

Constructors 

  • ScheduledEventRecursYearly(interval: Int)
  • ScheduledEventRecursMonthly(interval: Int)
  • ScheduledEventRecursWeekly(interval: Int)
  • ScheduledEventRecursDaily(interval: Int)

ScheduledEventRecurrenceRuleNthWeekday

</> 
pub type ScheduledEventRecurrenceRuleNthWeekday {
  ScheduledEventRecurrenceRuleNthWeekday(
    n: Int,
    day: weekday.Weekday,
  )
}

Constructors 

  • ScheduledEventRecurrenceRuleNthWeekday(
  n: Int,
  day: weekday.Weekday,
)

    Arguments

    n

    On which week of the month should the event recur? (1-5)

    day

    On which day of the nth should the event recur?

ScheduledEventStatus

</> 
pub type ScheduledEventStatus {
  ScheduledEventIsPlanned
  ScheduledEventIsActive
  ScheduledEventIsCompleted
  ScheduledEventIsCancelled
}

Constructors 

  • ScheduledEventIsPlanned

    The event is planned to happen.

  • ScheduledEventIsActive

    The event is happening.

  • ScheduledEventIsCompleted

    The event has happened.

  • ScheduledEventIsCancelled

    The event was cancelled.

SectionAccessory

</> 
pub type SectionAccessory {
  SectionButton(MessageButton)
  SectionThumbnail(MessageThumbnail)
}

Constructors

SectionComponent

</> 
pub type SectionComponent {
  SectionTextDisplay(MessageTextDisplay)
}

Constructors

SelectChannelType

</> 
pub type SelectChannelType {
  SelectTextChannels
  SelectDmChannels
  SelectVoiceChannels
  SelectCategoryChannels
  SelectAnnouncementChannels
  SelectAnnouncementThreads
  SelectPublicThreads
  SelectPrivateThreads
  SelectStageChannels
  SelectForumChannels
  SelectMediaChannels
}

Constructors 

  • SelectTextChannels
  • SelectDmChannels
  • SelectVoiceChannels
  • SelectCategoryChannels
  • SelectAnnouncementChannels
  • SelectAnnouncementThreads
  • SelectPublicThreads
  • SelectPrivateThreads
  • SelectStageChannels
  • SelectForumChannels
  • SelectMediaChannels

SeparatorSpacing

</> 
pub type SeparatorSpacing {
  SmallSeparatorSpacing
  LargeSeparatorSpacing
}

Constructors 

  • SmallSeparatorSpacing
  • LargeSeparatorSpacing

Sku

</>

A SKU represents premium offerings that applications sell through Discord.

pub type Sku {
  Sku(
    id: Snowflake(Sku),
    type_: SkuType,
    application_id: Snowflake(Application),
    name: String,
    slug: String,
    flags: List(SkuFlag),
  )
}

Constructors

SkuFlag

</> 
pub type SkuFlag {
  SkuIsAvailable
  SkuIsGuildSubscription
  SkuIsUserSubscription
}

Constructors 

  • SkuIsAvailable

    The SKU is available for purchase

  • SkuIsGuildSubscription

    The SKU is a subscription purchased by a user and applied to a single guild.

    Everyone in that server gets premium benefits.

  • SkuIsUserSubscription

    The SKU is a subscription purchased by a user and applied to themselves.

    They get premium benefits in all guilds.

SkuType

</> 
pub type SkuType {
  DurableSku
  ConsumableSku
  SubscriptionSku
  SubscriptionGroupSku
}

Constructors 

  • DurableSku

    A durable one-time purchase

  • ConsumableSku

    A consumable one-time-purchase

  • SubscriptionSku
  • SubscriptionGroupSku

    An internal SKU used by Discord in their secret programs… for all intents and purposes, Subscription Group SKUs don’t exist.

SlashCommand

</> 
pub type SlashCommand {
  SlashCommand(
    id: Snowflake(SlashCommand),
    command_id: Snowflake(Command),
    application_id: Snowflake(Application),
    guild_id: option.Option(Snowflake(Guild)),
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    options: List(SlashCommandOption),
    required_permissions: option.Option(List(Permission)),
    is_nsfw: Bool,
    installation_types: List(CommandInstallationType),
    contexts: List(CommandContext),
    version: Snowflake(CommandVersion),
  )
}

Constructors

SlashCommandOption

</> 
pub type SlashCommandOption {
  SlashCommandOptionSubCommand(SubCommandSlashCommandOption)
  SlashCommandOptionSubCommandGroup(
    SubCommandGroupSlashCommandOption,
  )
  SlashCommandOptionString(StringSlashCommandOption)
  SlashCommandOptionInt(IntSlashCommandOption)
  SlashCommandOptionFloat(FloatSlashCommandOption)
  SlashCommandOptionBool(BoolSlashCommandOption)
  SlashCommandOptionUser(UserSlashCommandOption)
  SlashCommandOptionChannel(ChannelSlashCommandOption)
  SlashCommandOptionRole(RoleSlashCommandOption)
  SlashCommandOptionMentionable(MentionableSlashCommandOption)
  SlashCommandOptionAttachment(AttachmentSlashCommandOption)
}

Constructors

Snowflake

opaque </>

A snowflake is another name for an ID.

It is possible to retrieve an object’s creation date & time from its snowflake.

pub opaque type Snowflake(a)

SoundboardSound

</> 
pub type SoundboardSound {
  SoundboardSound(
    name: String,
    id: Snowflake(SoundboardSound),
    volume: Float,
    emoji: option.Option(SoundboardSoundEmoji),
    guild_id: option.Option(Snowflake(Guild)),
    is_available: Bool,
    creator: option.Option(User),
  )
}

Constructors

SoundboardSoundContentType

</> 
pub type SoundboardSoundContentType {
  Mp3SoundboardSound
  OggSoundboardSound
}

Constructors 

  • Mp3SoundboardSound
  • OggSoundboardSound

SoundboardSoundEmoji

</> 
pub type SoundboardSoundEmoji {
  UnicodeSoundboardSoundEmoji(character: String)
  CustomSoundboardSoundEmoji(id: Snowflake(Emoji))
}

Constructors 

  • UnicodeSoundboardSoundEmoji(character: String)
  • CustomSoundboardSoundEmoji(id: Snowflake(Emoji))

StageChannel

</> 
pub type StageChannel {
  StageChannel(
    id: Snowflake(StageChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    voice_like_channel_id: Snowflake(VoiceLikeChannel),
    permission_overwrites: List(PermissionOverwrite),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    bitrate: Int,
    user_limit: option.Option(Int),
    rate_limit_per_user: RateLimitPerUser,
    rtc_region_id: option.Option(String),
    video_quality_mode: VideoQualityMode,
    parent_id: option.Option(Snowflake(CategoryChannel)),
  )
}

Constructors

StageInstance

</>

A stage instance is an ongoing event in a stage channel.

pub type StageInstance {
  StageInstance(
    id: Snowflake(StageInstance),
    guild_id: Snowflake(Guild),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    stage_channel_id: Snowflake(StageChannel),
    voice_like_channel_id: Snowflake(VoiceLikeChannel),
    topic: String,
    scheduled_event_id: option.Option(Snowflake(ScheduledEvent)),
  )
}

Constructors

StandardSticker

</> 
pub type StandardSticker {
  StandardSticker(
    id: Snowflake(StandardSticker),
    sticker_id: Snowflake(Sticker),
    pack_id: Snowflake(StickerPack),
    name: String,
    description: option.Option(String),
    tags: String,
    format_type: StickerFormatType,
    sort_value: option.Option(Int),
  )
}

Constructors 

  • StandardSticker(
  id: Snowflake(StandardSticker),
  sticker_id: Snowflake(Sticker),
  pack_id: Snowflake(StickerPack),
  name: String,
  description: option.Option(String),
  tags: String,
  format_type: StickerFormatType,
  sort_value: option.Option(Int),
)

    Arguments

    pack_id

    ID of the pack from which this sticker comes from.

    description

    Is None if the sticker doesn’t have a description.

    tags

    Auto-complete/suggestion tags (keywords).

    sort_value

    A value used to sort more important stickers in the client. If None, sorted alphabetically. (I assume)

Sticker

</> 
pub type Sticker {
  StickerStandardType(StandardSticker)
  StickerGuildType(GuildSticker)
}

Constructors 

  • StickerStandardType(StandardSticker)

    Stickers available on all guilds to every user.

  • StickerGuildType(GuildSticker)

    Stickers available:

    • in the guild of registratrion for that guild’s members
    • in all guilds for Nitro subscribers who are also members of the guild of registration

StickerFormatType

</> 
pub type StickerFormatType {
  PngSticker
  ApngSticker
  LottieSticker
  GifSticker
}

Constructors 

  • PngSticker
  • ApngSticker
  • LottieSticker
  • GifSticker

StickerItem

</>

A partial representation of a sticker.

pub type StickerItem {
  StickerItem(
    id: Snowflake(Sticker),
    name: String,
    format_type: StickerFormatType,
  )
}

Constructors

StickerPack

</> 
pub type StickerPack {
  StickerPack(
    id: Snowflake(StickerPack),
    stickers: List(StandardSticker),
    name: String,
    sku_id: Snowflake(Sku),
    cover_sticker_id: option.Option(Snowflake(StandardSticker)),
    description: String,
    banner_id: option.Option(Snowflake(StickerPackBanner)),
  )
}

Constructors

StickerPackBanner

</>

A constructorless type for the StickerPack type as a Snowflake helper.

Used only to download the image of the sticker pack banner.

pub type StickerPackBanner

StringSelectOption

</> 
pub type StringSelectOption {
  StringSelectOption(
    label: String,
    value: String,
    description: option.Option(String),
    emoji: option.Option(ComponentEmoji),
    is_default_selected: Bool,
  )
}

Constructors 

  • StringSelectOption(
  label: String,
  value: String,
  description: option.Option(String),
  emoji: option.Option(ComponentEmoji),
  is_default_selected: Bool,
)

    Arguments

    label

    User-facing name.

    value

    Dev-facing value.

    description

    Max 100 characters.

    is_default_selected

    Whether the option is selected by default.

StringSlashCommandOption

</> 
pub type StringSlashCommandOption {
  StringSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
    choices: List(StringSlashCommandOptionChoice),
    min_length: option.Option(Int),
    max_length: option.Option(Int),
    is_autocomplete_enabled: Bool,
  )
}

Constructors

StringSlashCommandOptionChoice

</> 
pub type StringSlashCommandOptionChoice {
  StringSlashCommandOptionChoice(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    value: String,
  )
}

Constructors

SubCommandGroupOption

</> 
pub type SubCommandGroupOption {
  SubCommandGroupOptionSubCommand(SubCommandSlashCommandOption)
  SubCommandGroupOptionSubCommandGroup(
    SubCommandGroupSlashCommandOption,
  )
}

Constructors

SubCommandGroupSlashCommandOption

</> 
pub type SubCommandGroupSlashCommandOption {
  SubCommandGroupSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    options: List(SubCommandGroupOption),
  )
}

Constructors

SubCommandOption

</> 
pub type SubCommandOption {
  SubCommandOptionString(StringSlashCommandOption)
  SubCommandOptionInt(IntSlashCommandOption)
  SubCommandOptionFloat(FloatSlashCommandOption)
  SubCommandOptionBool(BoolSlashCommandOption)
  SubCommandOptionUser(UserSlashCommandOption)
  SubCommandOptionChannel(ChannelSlashCommandOption)
  SubCommandOptionRole(RoleSlashCommandOption)
  SubCommandOptionMentionable(MentionableSlashCommandOption)
  SubCommandOptionAttachment(AttachmentSlashCommandOption)
}

Constructors

SubCommandSlashCommandOption

</> 
pub type SubCommandSlashCommandOption {
  SubCommandSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    options: List(SubCommandOption),
  )
}

Constructors

SubmittedLabelComponent

</> 
pub type SubmittedLabelComponent {
  SubmittedLabelStringSelectComponent(SubmittedModalStringSelect)
  SubmittedLabelTextInputComponent(SubmittedModalTextInput)
  SubmittedLabelUserSelectComponent(SubmittedModalUserSelect)
  SubmittedLabelRoleSelectComponent(SubmittedModalRoleSelect)
  SubmittedLabelMentionableSelectComponent(
    SubmittedModalMentionableSelect,
  )
  SubmittedLabelChannelSelectComponent(
    SubmittedModalChannelSelect,
  )
  SubmittedLabelFileUploadComponent(SubmittedModalFileUpload)
  SubmittedLabelRadioGroupComponent(SubmittedModalRadioGroup)
  SubmittedLabelCheckboxGroupComponent(
    SubmittedModalCheckboxGroup,
  )
  SubmittedLabelCheckboxComponent(SubmittedModalCheckbox)
}

Constructors

SubmittedModal

</> 
pub type SubmittedModal {
  SubmittedModal(
    custom_id: String,
    components: List(SubmittedModalComponent),
    resolved_objects: InteractionResolvedObjects,
  )
}

Constructors

SubmittedModalChannelSelect

</> 
pub type SubmittedModalChannelSelect {
  SubmittedModalChannelSelect(
    id: Int,
    custom_id: String,
    submitted_channels_ids: List(Snowflake(Channel)),
  )
}

Constructors 

  • SubmittedModalChannelSelect(
  id: Int,
  custom_id: String,
  submitted_channels_ids: List(Snowflake(Channel)),
)

    Arguments

    submitted_channels_ids

    Use the SubmittedModal’s resolved_objects field to get the channels themselves.

SubmittedModalCheckbox

</> 
pub type SubmittedModalCheckbox {
  SubmittedModalCheckbox(
    id: Int,
    custom_id: String,
    is_checked: Bool,
  )
}

Constructors 

  • SubmittedModalCheckbox(
  id: Int,
  custom_id: String,
  is_checked: Bool,
)

    Arguments

    is_checked

    Whether the user selected the checkbox

SubmittedModalCheckboxGroup

</> 
pub type SubmittedModalCheckboxGroup {
  SubmittedModalCheckboxGroup(
    id: Int,
    custom_id: String,
    submitted_values: List(String),
  )
}

Constructors 

  • SubmittedModalCheckboxGroup(
  id: Int,
  custom_id: String,
  submitted_values: List(String),
)

SubmittedModalComponent

</> 
pub type SubmittedModalComponent {
  SubmittedModalLabelComponent(SubmittedModalLabel)
  SubmittedModalTextDisplayComponent(SubmittedModalTextDisplay)
}

Constructors

SubmittedModalFileUpload

</> 
pub type SubmittedModalFileUpload {
  SubmittedModalFileUpload(
    id: Int,
    custom_id: String,
    submitted_attachments_ids: List(Snowflake(MessageAttachment)),
  )
}

Constructors 

  • SubmittedModalFileUpload(
  id: Int,
  custom_id: String,
  submitted_attachments_ids: List(Snowflake(MessageAttachment)),
)

    Arguments

    submitted_attachments_ids

    Use the SubmittedModal’s resolved_objects field to get the attachments themselves.

SubmittedModalLabel

</> 
pub type SubmittedModalLabel {
  SubmittedModalLabel(
    id: Int,
    component: SubmittedLabelComponent,
  )
}

Constructors

SubmittedModalMentionableSelect

</> 
pub type SubmittedModalMentionableSelect {
  SubmittedModalMentionableSelect(
    id: Int,
    custom_id: String,
    submitted_mentionables_ids: List(Snowflake(Mentionable)),
  )
}

Constructors 

  • SubmittedModalMentionableSelect(
  id: Int,
  custom_id: String,
  submitted_mentionables_ids: List(Snowflake(Mentionable)),
)

    Arguments

    submitted_mentionables_ids

    Use the SubmittedModal’s resolved_objects field to get the mentionables themselves.

SubmittedModalRadioGroup

</> 
pub type SubmittedModalRadioGroup {
  SubmittedModalRadioGroup(
    id: Int,
    custom_id: String,
    submitted_value: option.Option(String),
  )
}

Constructors 

  • SubmittedModalRadioGroup(
  id: Int,
  custom_id: String,
  submitted_value: option.Option(String),
)

SubmittedModalRoleSelect

</> 
pub type SubmittedModalRoleSelect {
  SubmittedModalSelect(
    id: Int,
    custom_id: String,
    submitted_roles_ids: List(Snowflake(Role)),
  )
}

Constructors 

  • SubmittedModalSelect(
  id: Int,
  custom_id: String,
  submitted_roles_ids: List(Snowflake(Role)),
)

    Arguments

    submitted_roles_ids

    Use the SubmittedModal’s resolved_objects field to get the roles themselves.

SubmittedModalStringSelect

</> 
pub type SubmittedModalStringSelect {
  SubmittedModalStringSelect(
    id: Int,
    custom_id: String,
    submitted_values: List(String),
  )
}

Constructors 

  • SubmittedModalStringSelect(
  id: Int,
  custom_id: String,
  submitted_values: List(String),
)

SubmittedModalTextDisplay

</> 
pub type SubmittedModalTextDisplay {
  SubmittedModalTextDisplay(id: Int)
}

Constructors 

  • SubmittedModalTextDisplay(id: Int)

SubmittedModalTextInput

</> 
pub type SubmittedModalTextInput {
  SubmittedModalTextInput(
    id: Int,
    custom_id: String,
    submitted_text: String,
  )
}

Constructors 

  • SubmittedModalTextInput(
  id: Int,
  custom_id: String,
  submitted_text: String,
)

SubmittedModalUserSelect

</> 
pub type SubmittedModalUserSelect {
  SubmittedModalUserSelect(
    id: Int,
    custom_id: String,
    submitted_users_ids: List(Snowflake(User)),
  )
}

Constructors 

  • SubmittedModalUserSelect(
  id: Int,
  custom_id: String,
  submitted_users_ids: List(Snowflake(User)),
)

    Arguments

    submitted_users_ids

    Use the SubmittedModal’s resolved_objects field to get the users themselves.

Subscription

</>

A “subscription” is a user making recurring payments for at least one SKU.

Successful subscriptions grant access to the SKU’s entitlements.

pub type Subscription {
  Subscription(
    id: Snowflake(Subscription),
    user_id: Snowflake(User),
    sku_ids: List(Snowflake(Sku)),
    entitlement_ids: List(Snowflake(Entitlement)),
    renewal_sku_ids: List(Snowflake(Sku)),
    current_period_start: timestamp.Timestamp,
    current_period_end: timestamp.Timestamp,
    status: SubscriptionStatus,
    canceled_timestamp: option.Option(timestamp.Timestamp),
  )
}

Constructors

SubscriptionStatus

</> 
pub type SubscriptionStatus {
  SubscriptionIsActive
  SubscriptionIsInactive
  SubscriptionIsEnding
}

Constructors 

  • SubscriptionIsActive

    The subscription is active and scheduled to renew.

  • SubscriptionIsInactive

    The subscription is not being charged.

  • SubscriptionIsEnding

    The subscription is active but won’t renew.

TextChannel

</> 
pub type TextChannel {
  TextChannel(
    id: Snowflake(TextChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    thread_creatable_channel_id: Snowflake(ThreadCreatableChannel),
    permission_overwrites: List(PermissionOverwrite),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    topic: option.Option(String),
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    rate_limit_per_user: RateLimitPerUser,
    last_pin_timestamp: option.Option(timestamp.Timestamp),
    default_thread_auto_archive_duration: ThreadAutoArchiveDuration,
    default_thread_rate_limit_per_user: RateLimitPerUser,
    parent_id: option.Option(Snowflake(CategoryChannel)),
  )
}

Constructors

TextInputStyle

</> 
pub type TextInputStyle {
  ShortTextInput
  ParagraphTextInput
}

Constructors 

  • ShortTextInput

    Single-line input.

  • ParagraphTextInput

    Multi-line input.

Thread

</> 
pub type Thread {
  Thread(
    id: Snowflake(Thread),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    type_: ThreadType,
    guild_id: option.Option(Snowflake(Guild)),
    name: String,
    last_message_id: option.Option(Snowflake(Message)),
    rate_limit_per_user: RateLimitPerUser,
    parent_id: Snowflake(GuildChannel),
    message_count: Int,
    approximate_member_count: Int,
    owner_id: Snowflake(User),
    is_archived: Bool,
    auto_archive_duration: ThreadAutoArchiveDuration,
    last_archive_status_change_at: timestamp.Timestamp,
    is_locked: Bool,
    created_at: option.Option(timestamp.Timestamp),
    flags: List(ThreadFlag),
    total_message_count: Int,
    applied_tags_ids: List(Snowflake(ForumTag)),
  )
}

Constructors 

  • Thread(
  id: Snowflake(Thread),
  channel_id: Snowflake(Channel),
  guild_channel_id: Snowflake(GuildChannel),
  type_: ThreadType,
  guild_id: option.Option(Snowflake(Guild)),
  name: String,
  last_message_id: option.Option(Snowflake(Message)),
  rate_limit_per_user: RateLimitPerUser,
  parent_id: Snowflake(GuildChannel),
  message_count: Int,
  approximate_member_count: Int,
  owner_id: Snowflake(User),
  is_archived: Bool,
  auto_archive_duration: ThreadAutoArchiveDuration,
  last_archive_status_change_at: timestamp.Timestamp,
  is_locked: Bool,
  created_at: option.Option(timestamp.Timestamp),
  flags: List(ThreadFlag),
  total_message_count: Int,
  applied_tags_ids: List(Snowflake(ForumTag)),
)

    Arguments

    guild_id

    Is None in some gateway events.

    last_message_id

    Is None if there are no messages in the channel.

    rate_limit_per_user

    Represents he amount of time between a user has to wait between sending a message or creating a thread.

    Bots and members with the AllowBypassingSlowmode permission are exempt from slowmode.

    Rate limits per user must be between 0 and 21600 seconds (7.22 hours).

    message_count

    Number of messages in the thread, not including the initial message or deleted messages.

    Inaccurate for threads created before July 1st, 2022 if they have more than 50 messages.

    approximate_member_count

    Stops counting at 50.

    owner_id

    OP’s ID.

    auto_archive_duration

    Time of inactivity after which the thread will be automatically archived.

    last_archive_status_change_at

    Time when the thread’s archive status was last changed at.

    is_locked

    If a thread is locked, only users with the AllowManagingThreads permission will be able to unarchive it.

    created_at

    Is None if the thread was created before September 1st, 2022.

    total_message_count

    Similar to message_count, except it won’t decrement when a message is deleted.

    applied_tags_ids

    IDs of the tags that are applied to this thread.

ThreadAutoArchiveDuration

</> 
pub type ThreadAutoArchiveDuration {
  ArchiveThreadAfter1Hour
  ArchiveThreadAfter1Day
  ArchiveThreadAfter3Days
  ArchiveThreadAfter7Days
}

Constructors 

  • ArchiveThreadAfter1Hour
  • ArchiveThreadAfter1Day
  • ArchiveThreadAfter3Days
  • ArchiveThreadAfter7Days

ThreadCreatableChannel

</>

A channel where you can create threads - text and announcement channels.

Forum and media channels have their own type: ForumLikeChannel

pub type ThreadCreatableChannel

ThreadFlag

</> 
pub type ThreadFlag {
  ThreadIsPinned
}

Constructors 

  • ThreadIsPinned

    The thread is pinned on top of its parent Forum or Media channel.

ThreadMember

</> 
pub type ThreadMember {
  ThreadMember(
    thread_id: Snowflake(Thread),
    user_id: Snowflake(User),
    joined_at: timestamp.Timestamp,
  )
}

Constructors

ThreadType

</> 
pub type ThreadType {
  AnnouncementThread
  PublicThread
  PrivateThread(is_invitable: Bool)
}

Constructors 

  • AnnouncementThread
  • PublicThread
  • PrivateThread(is_invitable: Bool)

Token

opaque </>

An authentication token, required to identify the user (bot) making requests. See bot for creating bot tokens.

In the future, this will be extended to also support OAuth2 bearer tokens.

pub opaque type Token

UnavailableGuild

</>

Represents an offline guild, or a guild whose information has not been provided through the Guild Create events during the gateway connection initiation.

pub type UnavailableGuild {
  UnavailableGuild(id: Snowflake(Guild), is_unavailable: Bool)
}

Constructors

UnfurledMediaItem

</> 
pub type UnfurledMediaItem {
  UnfurledMediaItem(
    url: String,
    proxy_url: String,
    content_type: String,
    flags: List(UnfurledMediaItemFlag),
    metadata: option.Option(UnfurledMediaItemMetadata),
    attachment_id: option.Option(Snowflake(MessageAttachment)),
  )
}

Constructors

UnfurledMediaItemFlag

</> 
pub type UnfurledMediaItemFlag {
  UnfurledMediaItemIsAnimated
}

Constructors 

  • UnfurledMediaItemIsAnimated

UnfurledMediaItemMetadata

</> 
pub type UnfurledMediaItemMetadata {
  UnfurledMediaItemMetadata(
    height: Int,
    width: Int,
    placeholder: String,
    placeholder_version: Int,
  )
}

Constructors 

  • UnfurledMediaItemMetadata(
  height: Int,
  width: Int,
  placeholder: String,
  placeholder_version: Int,
)

    Arguments

    height

    In pixels.

    width

    In pixels.

    placeholder

    Thumbhash representation of a placeholder.

    placeholder_version

    Thumbhash version.

User

</> 
pub type User {
  User(
    id: Snowflake(User),
    mentionable_id: Snowflake(Mentionable),
    username: String,
    discriminator: String,
    global_name: option.Option(String),
    avatar_hash: option.Option(ImageHash),
    is_bot: Bool,
    is_system: Bool,
    has_mfa_enabled: option.Option(Bool),
    banner_hash: option.Option(ImageHash),
    accent_colour: option.Option(colour.Colour),
    locale: option.Option(Locale),
    flags: List(UserFlag),
    premium_type: option.Option(UserPremiumType),
    public_flags: List(UserFlag),
    avatar_decoration: option.Option(UserAvatarDecoration),
    collectibles: option.Option(UserCollectibles),
    primary_guild: option.Option(UserPrimaryGuild),
  )
}

Constructors 

  • User(
  id: Snowflake(User),
  mentionable_id: Snowflake(Mentionable),
  username: String,
  discriminator: String,
  global_name: option.Option(String),
  avatar_hash: option.Option(ImageHash),
  is_bot: Bool,
  is_system: Bool,
  has_mfa_enabled: option.Option(Bool),
  banner_hash: option.Option(ImageHash),
  accent_colour: option.Option(colour.Colour),
  locale: option.Option(Locale),
  flags: List(UserFlag),
  premium_type: option.Option(UserPremiumType),
  public_flags: List(UserFlag),
  avatar_decoration: option.Option(UserAvatarDecoration),
  collectibles: option.Option(UserCollectibles),
  primary_guild: option.Option(UserPrimaryGuild),
)

    Arguments

    discriminator

    Mostly deprecated. Only bots have discriminators nowadays.

    Users will very likely have their discriminator set to 0.

    Used in the past when usernames weren’t user-specific.

    Doesn’t include the # prefix.

    global_name

    Also called a display name.

    Is None when the user doesn’t have a global name, and rather uses their username as their display name.

    avatar_hash

    Is None when the user uses a default avatar.

    is_bot

    Whether the user is a bot user.

    is_system

    Whether the user is Discord’s official system account.

    has_mfa_enabled

    Is None if it isn’t known whether the user has enabled MFA.

    MFA = multi-factor authentication.

    banner_hash

    Is None when the user doesn’t use a custom banner.

    accent_colour

    The user’s banner accent colour in RGB hexadecimal format.

    Is None when the user uses a default color based on avatar.

    locale

    The user’s chosen locale.

    Discord hasn’t disclosed when this field could be None.

    premium_type

    Is None if the user’s premium type isn’t known.

    public_flags

    Publicly visible flags - aka Discord badges.

    Visible in the top right corner of a person’s profile in the apps.

    primary_guild

    Is None if the user never had a primary guild.

UserAvatarDecoration

</> 
pub type UserAvatarDecoration {
  UserAvatarDecoration(hash: ImageHash, sku_id: Snowflake(Sku))
}

Constructors

UserCollectibles

</> 
pub type UserCollectibles {
  UserCollectibles(nameplate: option.Option(UserNameplate))
}

Constructors

UserCommand

</> 
pub type UserCommand {
  UserCommand(
    id: Snowflake(UserCommand),
    command_id: Snowflake(Command),
    application_id: Snowflake(Application),
    guild_id: option.Option(Snowflake(Guild)),
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    required_permissions: option.Option(List(Permission)),
    is_nsfw: Bool,
    installation_types: List(CommandInstallationType),
    contexts: List(CommandContext),
    version: Snowflake(CommandVersion),
  )
}

Constructors

UserFlag

</> 
pub type UserFlag {
  UserIsStaff
  UserIsDiscordPartner
  UserIsHypesquadEventsMember
  UserIsBugHunterLevel1
  UserBelongsToHypesquadBravery
  UserBelongsToHypesquadBrilliance
  UserBelongsToHypesquadBalance
  UserIsPremiumEarlySupporter
  UserIsTeamPseudoUser
  UserIsBugHunterLevel2
  UserIsVerifiedBot
  UserIsVerifiedDeveloper
  UserIsCertifiedModerator
  BotUsesHttpInteractions
  UserIsActiveDeveloper
}

Constructors 

  • UserIsStaff

    Given to official Discord staff.

  • UserIsDiscordPartner

    Given to partnered guild owners.

  • UserIsHypesquadEventsMember

    Given to participants of Hypesquad events.

  • UserIsBugHunterLevel1

    Given to Discord Bug Hunters, first level of the badge.

  • UserBelongsToHypesquadBravery
  • UserBelongsToHypesquadBrilliance
  • UserBelongsToHypesquadBalance
  • UserIsPremiumEarlySupporter

    Given to “early Nitro supporters”.

  • UserIsTeamPseudoUser

    The user is actually a development team.

  • UserIsBugHunterLevel2

    Given to Discord Bug Hunters, second level of the badge.

  • UserIsVerifiedBot

    Given to verified bot users.

  • UserIsVerifiedDeveloper

    Given to early verified bot developers. No longer obtainable.

  • UserIsCertifiedModerator

    Given to people who passed the Discord Certified Moderator course.

  • BotUsesHttpInteractions

    The bot only uses HTTP webhook interaction and is shown in the online member list.

  • UserIsActiveDeveloper

    Given to active developers. No longer obtainable.

UserNameplate

</>

A nameplate is a decoration around a user’s Direct Messages / online member list view tab.

pub type UserNameplate {
  UserNameplate(
    sku_id: Snowflake(Sku),
    hash: ImageHash,
    label: String,
    palette: UserNameplatePalette,
  )
}

Constructors

UserNameplatePalette

</> 
pub type UserNameplatePalette {
  CrimsonUserNameplate
  BerryUserNameplate
  SkyUserNameplate
  TealUserNameplate
  ForestUserNameplate
  BubbleGumUserNameplate
  VioletUserNameplate
  CobaltUserNameplate
  CloverUserNameplate
  LemonUserNameplate
  WhiteUserNameplate
}

Constructors 

  • CrimsonUserNameplate
  • BerryUserNameplate
  • SkyUserNameplate
  • TealUserNameplate
  • ForestUserNameplate
  • BubbleGumUserNameplate
  • VioletUserNameplate
  • CobaltUserNameplate
  • CloverUserNameplate
  • LemonUserNameplate
  • WhiteUserNameplate

UserPremiumType

</>

Describes what level of a Nitro subscription a user has.

pub type UserPremiumType {
  UserHasNoPremiumSubscription
  UserHasNitroClassic
  UserHasNitro
  UserHasNitroBasic
}

Constructors 

  • UserHasNoPremiumSubscription
  • UserHasNitroClassic
  • UserHasNitro
  • UserHasNitroBasic

UserPrimaryGuild

</> 
pub type UserPrimaryGuild {
  ActiveUserPrimaryGuild(
    id: Snowflake(Guild),
    tag: String,
    badge_hash: ImageHash,
  )
  AutomaticallyClearedUserPrimaryGuild
  ManuallyClearedUserPrimaryGuild
}

Constructors 

  • ActiveUserPrimaryGuild(
  id: Snowflake(Guild),
  tag: String,
  badge_hash: ImageHash,
)

    A user actively has a primary guild tag.

  • AutomaticallyClearedUserPrimaryGuild

    The user’s primary guild was cleared by Discord because the guild became ineligible for guild tags.

  • ManuallyClearedUserPrimaryGuild

    The user manually removed their guild tag.

UserSlashCommandOption

</> 
pub type UserSlashCommandOption {
  UserSlashCommandOption(
    name: String,
    name_localizations: option.Option(dict.Dict(Locale, String)),
    description: String,
    description_localizations: option.Option(
      dict.Dict(Locale, String),
    ),
    is_required: Bool,
  )
}

Constructors

UserStatus

</> 
pub type UserStatus {
  UserIsOnline
  UserIsNotToBeDisturbed
  UserIsIdle
  UserIsInvisible
  UserIsOffline
}

Constructors 

  • UserIsOnline

    Green circle icon displayed in the client.

  • UserIsNotToBeDisturbed

    Red do-not-disturb icon displayed in the client.

  • UserIsIdle

    Yellow crescent moon icon displayed in the client.

  • UserIsInvisible

    Looks offline in the client, is actually online.

    Gray empty circle icon displayed in the client.

  • UserIsOffline

    Gray empty circle icon displayed in the client.

VideoMessageAttachment

</> 
pub type VideoMessageAttachment {
  VideoMessageAttachment(
    height: Int,
    width: Int,
    placeholder: String,
    placeholder_version: Int,
    duration: duration.Duration,
  )
}

Constructors 

  • VideoMessageAttachment(
  height: Int,
  width: Int,
  placeholder: String,
  placeholder_version: Int,
  duration: duration.Duration,
)

    Arguments

    height

    In pixels.

    width

    In pixels.

    placeholder

    Thumbhash representation of a placeholder.

    placeholder_version

    Thumbhash version.

VideoQualityMode

</> 
pub type VideoQualityMode {
  AutomaticVideoQuality
  HdVideoQuality
}

Constructors 

  • AutomaticVideoQuality
  • HdVideoQuality

    720p

VoiceChannel

</> 
pub type VoiceChannel {
  VoiceChannel(
    id: Snowflake(VoiceChannel),
    channel_id: Snowflake(Channel),
    guild_channel_id: Snowflake(GuildChannel),
    voice_like_channel_id: Snowflake(VoiceLikeChannel),
    permission_overwrites: List(PermissionOverwrite),
    guild_id: option.Option(Snowflake(Guild)),
    position: Int,
    name: String,
    is_nsfw: Bool,
    last_message_id: option.Option(Snowflake(Message)),
    bitrate: Int,
    user_limit: option.Option(Int),
    rate_limit_per_user: RateLimitPerUser,
    rtc_region_id: option.Option(String),
    video_quality_mode: VideoQualityMode,
    parent_id: option.Option(Snowflake(CategoryChannel)),
  )
}

Constructors

VoiceLikeChannel

</> 
pub type VoiceLikeChannel

VoiceMessageAttachment

</> 
pub type VoiceMessageAttachment {
  VoiceMessageAttachment(
    duration: duration.Duration,
    waveform: BitArray,
  )
}

Constructors

VoiceRegion

</> 
pub type VoiceRegion {
  VoiceRegion(
    id: String,
    name: String,
    is_optimal: Bool,
    is_deprecated: Bool,
    is_custom: Bool,
  )
}

Constructors 

  • VoiceRegion(
  id: String,
  name: String,
  is_optimal: Bool,
  is_deprecated: Bool,
  is_custom: Bool,
)

    Arguments

    is_optimal

    Whether the region is the closest one to the current user.

    is_deprecated

    Avoid connecting to deprecated regions.

    is_custom

    Whether the region is a custom one (used for Discord events)

VoiceState

</> 
pub type VoiceState {
  VoiceState(
    guild_id: Snowflake(Guild),
    channel_id: option.Option(Snowflake(Channel)),
    guild_channel_id: option.Option(Snowflake(GuildChannel)),
    voice_like_channel_id: option.Option(
      Snowflake(VoiceLikeChannel),
    ),
    user_id: Snowflake(User),
    guild_member: GuildMember,
    session_id: String,
    is_guild_deafened: Bool,
    is_guild_muted: Bool,
    is_self_deafened: Bool,
    is_self_muted: Bool,
    is_streaming: Bool,
    is_sharing_camera: Bool,
    is_suppressed: Bool,
    request_to_speak_timestamp: option.Option(timestamp.Timestamp),
  )
}

Constructors 

  • VoiceState(
  guild_id: Snowflake(Guild),
  channel_id: option.Option(Snowflake(Channel)),
  guild_channel_id: option.Option(Snowflake(GuildChannel)),
  voice_like_channel_id: option.Option(
    Snowflake(VoiceLikeChannel),
  ),
  user_id: Snowflake(User),
  guild_member: GuildMember,
  session_id: String,
  is_guild_deafened: Bool,
  is_guild_muted: Bool,
  is_self_deafened: Bool,
  is_self_muted: Bool,
  is_streaming: Bool,
  is_sharing_camera: Bool,
  is_suppressed: Bool,
  request_to_speak_timestamp: option.Option(timestamp.Timestamp),
)

    Arguments

    channel_id

    Is None when the user is not connected to any channel.

    guild_channel_id

    Is None when the user is not connected to any channel.

    voice_like_channel_id

    Is None when the user is not connected to any channel.

    is_suppressed

    For stage channels with an active instance, whether the user’s request to speak was denied.

    request_to_speak_timestamp

    For stage channels with an active instance, when the user requested to speak.

Webhook

</> 
pub type Webhook

Values

action_row_component_decoder

</> 
pub fn action_row_component_decoder() -> decode.Decoder(
  ActionRowComponent,
)

add_member_to_thread_request

</> 
pub fn add_member_to_thread_request(
  token token: Token,
  thread_with_id thread_id: Snowflake(Thread),
  member_with_id member_id: Snowflake(User),
) -> request.Request(String)

The thread mustn’t be archived.

Requires the ability to send messages in the thread.

add_member_to_thread_response

</> 
pub fn add_member_to_thread_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

add_role_to_guild_member_request

</> 
pub fn add_role_to_guild_member_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  to_member_with_id user_id: Snowflake(User),
  role_with_id role_id: Snowflake(Role),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingRoles permission.

add_role_to_guild_member_response

</> 
pub fn add_role_to_guild_member_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

afk_timeout_decoder

</> 
pub fn afk_timeout_decoder() -> decode.Decoder(AfkTimeout)

afk_timeout_to_json

</> 
pub fn afk_timeout_to_json(afk_timeout: AfkTimeout) -> json.Json

allowed_message_mentions_to_json

</> 
pub fn allowed_message_mentions_to_json(
  mentions: List(AllowedMessageMention),
) -> json.Json

announcement_channel_decoder

</> 
pub fn announcement_channel_decoder() -> decode.Decoder(
  AnnouncementChannel,
)

application_decoder

</> 
pub fn application_decoder() -> decode.Decoder(Application)

application_emoji_decoder

</> 
pub fn application_emoji_decoder() -> decode.Decoder(
  ApplicationEmoji,
)

application_installation_settings_decoder

</> 
pub fn application_installation_settings_decoder() -> decode.Decoder(
  ApplicationInstallationSettings,
)

application_installation_settings_to_json

</> 
pub fn application_installation_settings_to_json(
  application_installation_settings: ApplicationInstallationSettings,
) -> json.Json

application_owner_decoder

</> 
pub fn application_owner_decoder() -> decode.Decoder(
  ApplicationOwner,
)

application_webhook_event_status_decoder

</> 
pub fn application_webhook_event_status_decoder() -> decode.Decoder(
  ApplicationWebhookEventStatus,
)

archive_thread

</> 
pub fn archive_thread(modify: ModifyThread) -> ModifyThread

attachment_slash_command_option_decoder

</> 
pub fn attachment_slash_command_option_decoder() -> decode.Decoder(
  AttachmentSlashCommandOption,
)

attachment_slash_command_option_to_json

</> 
pub fn attachment_slash_command_option_to_json(
  option: AttachmentSlashCommandOption,
) -> json.Json

audio_message_attachment_decoder

</> 
pub fn audio_message_attachment_decoder() -> decode.Decoder(
  AudioMessageAttachment,
)

autocomplete_request_command_option_decoder

</> 
pub fn autocomplete_request_command_option_decoder() -> decode.Decoder(
  Result(AutocompleteRequestCommandOption, Nil),
)

autocomplete_request_command_options_decoder

</> 
pub fn autocomplete_request_command_options_decoder() -> decode.Decoder(
  List(AutocompleteRequestCommandOption),
)

autocomplete_request_float_command_option_decoder

</> 
pub fn autocomplete_request_float_command_option_decoder() -> decode.Decoder(
  AutocompleteRequestFloatCommandOption,
)

autocomplete_request_int_command_option_decoder

</> 
pub fn autocomplete_request_int_command_option_decoder() -> decode.Decoder(
  AutocompleteRequestIntCommandOption,
)

autocomplete_request_interaction_decoder

</> 
pub fn autocomplete_request_interaction_decoder() -> decode.Decoder(
  AutocompleteRequestInteraction,
)

autocomplete_request_interaction_response_to_json

</> 
pub fn autocomplete_request_interaction_response_to_json(
  response: AutocompleteRequestInteractionResponse,
) -> json.Json

autocomplete_request_interaction_token_decoder

</> 
pub fn autocomplete_request_interaction_token_decoder() -> decode.Decoder(
  AutocompleteRequestInteractionToken,
)

autocomplete_request_string_command_option_decoder

</> 
pub fn autocomplete_request_string_command_option_decoder() -> decode.Decoder(
  AutocompleteRequestStringCommandOption,
)

autocomplete_request_sub_command_command_option_decoder

</> 
pub fn autocomplete_request_sub_command_command_option_decoder() -> decode.Decoder(
  AutocompleteRequestSubCommandCommandOption,
)

autocomplete_request_sub_command_group_command_option_decoder

</> 
pub fn autocomplete_request_sub_command_group_command_option_decoder() -> decode.Decoder(
  AutocompleteRequestSubCommandGroupCommandOption,
)

autocomplete_request_sub_command_group_option_decoder

</> 
pub fn autocomplete_request_sub_command_group_option_decoder() -> decode.Decoder(
  AutocompleteRequestSubCommandGroupOption,
)

autocomplete_request_sub_command_option_decoder

</> 
pub fn autocomplete_request_sub_command_option_decoder() -> decode.Decoder(
  Result(AutocompleteRequestSubCommandOption, Nil),
)

autocomplete_request_sub_command_options_decoder

</> 
pub fn autocomplete_request_sub_command_options_decoder() -> decode.Decoder(
  List(AutocompleteRequestSubCommandOption),
)

ban_guild_member_request

</> 
pub fn ban_guild_member_request(
  token token: Token,
  with_id user_id: Snowflake(User),
  from_guild_with_id guild_id: Snowflake(Guild),
  delete_messages_since delete_messages_since: option.Option(
    duration.Duration,
  ),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowBanningMembers permission.

delete_messages_since will delete the messages the user has sent in the guild that are at most 7 days old.

ban_guild_member_response

</> 
pub fn ban_guild_member_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

base64_decoder

</> 
pub fn base64_decoder() -> decode.Decoder(BitArray)

bool_slash_command_option_decoder

</> 
pub fn bool_slash_command_option_decoder() -> decode.Decoder(
  BoolSlashCommandOption,
)

bool_slash_command_option_to_json

</> 
pub fn bool_slash_command_option_to_json(
  option: BoolSlashCommandOption,
) -> json.Json

bot

</> 
pub fn bot(token: String) -> Token

Creates a token object for a bot.

bulk_delete_messages_request

</> 
pub fn bulk_delete_messages_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(GuildChannel),
  message_ids message_ids: List(Snowflake(Message)),
  reason reason: option.Option(String),
) -> request.Request(String)

Any messages older than 2 weeks will be rejected by Discord.

You must provide between 2 and 100 messages.

Requires the AllowManagingMessages permission.

bulk_delete_messages_response

</> 
pub fn bulk_delete_messages_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

bulk_guild_ban_request

</> 
pub fn bulk_guild_ban_request(
  token token: Token,
  users_with_ids user_ids: List(Snowflake(User)),
  from_guild_with_id guild_id: Snowflake(Guild),
  delete_messages_since delete_messages_since: option.Option(
    duration.Duration,
  ),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowBanningMembers and AllowManagingGuild permissions.

bulk_guild_ban_response

</> 
pub fn bulk_guild_ban_response(
  response: response.Response(String),
) -> Result(BulkGuildBanResponse, RestError)

bulk_guild_ban_response_decoder

</> 
pub fn bulk_guild_ban_response_decoder() -> decode.Decoder(
  BulkGuildBanResponse,
)

bulk_overwrite_global_commands

</> 
pub fn bulk_overwrite_global_commands() -> BulkOverwriteGlobalCommands

bulk_overwrite_global_commands_request

</> 
pub fn bulk_overwrite_global_commands_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  using bulk_overwrite: BulkOverwriteGlobalCommands,
) -> request.Request(String)

bulk_overwrite_global_commands_to_json

</> 
pub fn bulk_overwrite_global_commands_to_json(
  bulk_overwrite: BulkOverwriteGlobalCommands,
) -> json.Json

bulk_overwrite_global_message_commands

</> 
pub fn bulk_overwrite_global_message_commands(
  bulk_overwrite: BulkOverwriteGlobalCommands,
  new message_commands: List(CreateGlobalMessageCommand),
) -> BulkOverwriteGlobalCommands

bulk_overwrite_global_slash_commands

</> 
pub fn bulk_overwrite_global_slash_commands(
  bulk_overwrite: BulkOverwriteGlobalCommands,
  new slash_commands: List(CreateGlobalSlashCommand),
) -> BulkOverwriteGlobalCommands

bulk_overwrite_global_user_commands

</> 
pub fn bulk_overwrite_global_user_commands(
  bulk_overwrite: BulkOverwriteGlobalCommands,
  new user_commands: List(CreateGlobalUserCommand),
) -> BulkOverwriteGlobalCommands

bulk_overwrite_guild_commands

</> 
pub fn bulk_overwrite_guild_commands() -> BulkOverwriteGuildCommands

bulk_overwrite_guild_commands_request

</> 
pub fn bulk_overwrite_guild_commands_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  using bulk_overwrite: BulkOverwriteGuildCommands,
) -> request.Request(String)

bulk_overwrite_guild_commands_to_json

</> 
pub fn bulk_overwrite_guild_commands_to_json(
  bulk_overwrite: BulkOverwriteGuildCommands,
) -> json.Json

bulk_overwrite_guild_message_commands

</> 
pub fn bulk_overwrite_guild_message_commands(
  bulk_overwrite: BulkOverwriteGuildCommands,
  new message_commands: List(CreateGuildMessageCommand),
) -> BulkOverwriteGuildCommands

bulk_overwrite_guild_slash_commands

</> 
pub fn bulk_overwrite_guild_slash_commands(
  bulk_overwrite: BulkOverwriteGuildCommands,
  new slash_commands: List(CreateGuildSlashCommand),
) -> BulkOverwriteGuildCommands

bulk_overwrite_guild_user_commands

</> 
pub fn bulk_overwrite_guild_user_commands(
  bulk_overwrite: BulkOverwriteGuildCommands,
  new user_commands: List(CreateGuildUserCommand),
) -> BulkOverwriteGuildCommands

bulk_ovewrite_global_commands_response

</> 
pub fn bulk_ovewrite_global_commands_response(
  response: response.Response(String),
) -> Result(List(Command), RestError)

bulk_ovewrite_guild_commands_response

</> 
pub fn bulk_ovewrite_guild_commands_response(
  response: response.Response(String),
) -> Result(List(Command), RestError)

category_channel_decoder

</> 
pub fn category_channel_decoder() -> decode.Decoder(
  CategoryChannel,
)

channel_decoder

</> 
pub fn channel_decoder() -> decode.Decoder(Channel)

channel_select_default_value_to_json

</> 
pub fn channel_select_default_value_to_json(
  id: Snowflake(Channel),
) -> json.Json

channel_slash_command_option_decoder

</> 
pub fn channel_slash_command_option_decoder() -> decode.Decoder(
  ChannelSlashCommandOption,
)

channel_slash_command_option_to_json

</> 
pub fn channel_slash_command_option_to_json(
  option: ChannelSlashCommandOption,
) -> json.Json

clip_message_attachment_decoder

</> 
pub fn clip_message_attachment_decoder() -> decode.Decoder(
  ClipMessageAttachment,
)

colour_to_json

</> 
pub fn colour_to_json(colour: colour.Colour) -> json.Json

command_context_decoder

</> 
pub fn command_context_decoder() -> decode.Decoder(CommandContext)

command_context_to_json

</> 
pub fn command_context_to_json(
  context: CommandContext,
) -> json.Json

command_decoder

</> 
pub fn command_decoder() -> decode.Decoder(Command)

command_installation_type_decoder

</> 
pub fn command_installation_type_decoder() -> decode.Decoder(
  CommandInstallationType,
)

command_installation_type_to_json

</> 
pub fn command_installation_type_to_json(
  type_: CommandInstallationType,
) -> json.Json

command_interaction_decoder

</> 
pub fn command_interaction_decoder() -> decode.Decoder(
  CommandInteraction,
)

command_interaction_response_to_json

</> 
pub fn command_interaction_response_to_json(
  response: CommandInteractionResponse,
) -> json.Json

command_interaction_token_decoder

</> 
pub fn command_interaction_token_decoder() -> decode.Decoder(
  CommandInteractionToken,
)

component_emoji_decoder

</> 
pub fn component_emoji_decoder() -> decode.Decoder(ComponentEmoji)

component_emoji_to_json

</> 
pub fn component_emoji_to_json(
  emoji: ComponentEmoji,
) -> json.Json

consume_entitlement_request

</> 
pub fn consume_entitlement_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  entitlement_with_id entitlement_id: Snowflake(Entitlement),
) -> request.Request(String)

Marks the entitlement as consumed by the user.

Only for one-time consumable SKUs.

You have to provide the current application’s ID. Sorry, I don’t make the rules :/

consume_entitlement_response

</> 
pub fn consume_entitlement_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

container_component_decoder

</> 
pub fn container_component_decoder() -> decode.Decoder(
  ContainerComponent,
)

convert_announcement_channel_to_text_channel

</> 
pub fn convert_announcement_channel_to_text_channel(
  modify: ModifyAnnouncementChannel,
) -> ModifyAnnouncementChannel

convert_text_channel_to_announcement_channel

</> 
pub fn convert_text_channel_to_announcement_channel(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

Requires the guild to have the GuildCanCreateAnnouncementChannels feature.

create_action_row_component_to_json

</> 
pub fn create_action_row_component_to_json(
  component: CreateActionRowComponent,
) -> json.Json

create_announcement_channel_to_json

</> 
pub fn create_announcement_channel_to_json(
  create: CreateAnnouncementChannel,
) -> json.Json

create_category_channel_to_json

</> 
pub fn create_category_channel_to_json(
  create: CreateCategoryChannel,
) -> json.Json

create_checkbox_group_option_to_json

</> 
pub fn create_checkbox_group_option_to_json(
  create: CreateCheckboxGroupOption,
) -> json.Json

create_container_component_to_json

</> 
pub fn create_container_component_to_json(
  component: CreateContainerComponent,
) -> json.Json

create_embed_author_to_json

</> 
pub fn create_embed_author_to_json(
  create: CreateEmbedAuthor,
) -> json.Json

create_embed_field_to_json

</> 
pub fn create_embed_field_to_json(
  create: CreateEmbedField,
) -> json.Json
</> 
pub fn create_embed_footer_to_json(
  create: CreateEmbedFooter,
) -> json.Json

create_embed_image_to_json

</> 
pub fn create_embed_image_to_json(
  create: CreateEmbedImage,
) -> json.Json

create_forum_channel_to_json

</> 
pub fn create_forum_channel_to_json(
  create: CreateForumChannel,
) -> json.Json

create_forum_like_thread_message_embed_to_json

</> 
pub fn create_forum_like_thread_message_embed_to_json(
  create: CreateForumLikeThreadMessageEmbed,
) -> json.Json

create_forum_like_thread_message_to_json

</> 
pub fn create_forum_like_thread_message_to_json(
  create: CreateForumLikeThreadMessage,
) -> json.Json

create_forum_like_thread_to_json

</> 
pub fn create_forum_like_thread_to_json(
  create: CreateForumLikeThread,
) -> json.Json

create_global_message_command_to_json

</> 
pub fn create_global_message_command_to_json(
  create: CreateGlobalMessageCommand,
) -> json.Json

create_global_slash_command_to_json

</> 
pub fn create_global_slash_command_to_json(
  create: CreateGlobalSlashCommand,
) -> json.Json

create_global_user_command_to_json

</> 
pub fn create_global_user_command_to_json(
  create: CreateGlobalUserCommand,
) -> json.Json

create_guild_channel_invite_to_json

</> 
pub fn create_guild_channel_invite_to_json(
  create: CreateGuildChannelInvite,
) -> json.Json

create_guild_message_command_to_json

</> 
pub fn create_guild_message_command_to_json(
  create: CreateGuildMessageCommand,
) -> json.Json

create_guild_slash_command_to_json

</> 
pub fn create_guild_slash_command_to_json(
  create: CreateGuildSlashCommand,
) -> json.Json

create_guild_soundboard_sound_to_json

</> 
pub fn create_guild_soundboard_sound_to_json(
  create: CreateGuildSoundboardSound,
) -> json.Json

create_guild_user_command_to_json

</> 
pub fn create_guild_user_command_to_json(
  create: CreateGuildUserCommand,
) -> json.Json
</> 
pub fn create_link_button_to_json(
  create: CreateLinkButton,
) -> json.Json

create_media_channel_to_json

</> 
pub fn create_media_channel_to_json(
  create: CreateMediaChannel,
) -> json.Json
</> 
pub fn create_media_gallery_item_to_json(
  create: CreateMediaGalleryItem,
) -> json.Json

create_message_action_row_to_json

</> 
pub fn create_message_action_row_to_json(
  create: CreateMessageActionRow,
) -> json.Json

create_message_attachment_to_json

</> 
pub fn create_message_attachment_to_json(
  create: CreateMessageAttachment,
  idx: Int,
) -> json.Json

create_message_attachments_to_json

</> 
pub fn create_message_attachments_to_json(
  attachments: option.Option(List(CreateMessageAttachment)),
) -> Result(#(String, json.Json), Nil)

create_message_button_to_json

</> 
pub fn create_message_button_to_json(
  button: CreateMessageButton,
) -> json.Json

create_message_channel_select_to_json

</> 
pub fn create_message_channel_select_to_json(
  create: CreateMessageChannelSelect,
) -> json.Json

create_message_component_to_json

</> 
pub fn create_message_component_to_json(
  component: CreateMessageComponent,
) -> json.Json

create_message_container_to_json

</> 
pub fn create_message_container_to_json(
  create: CreateMessageContainer,
) -> json.Json

create_message_embed_to_json

</> 
pub fn create_message_embed_to_json(
  create: CreateMessageEmbed,
) -> json.Json

create_message_file_to_json

</> 
pub fn create_message_file_to_json(
  create: CreateMessageFile,
) -> json.Json
</> 
pub fn create_message_media_gallery_to_json(
  create: CreateMessageMediaGallery,
) -> json.Json

create_message_mentionable_select_to_json

</> 
pub fn create_message_mentionable_select_to_json(
  create: CreateMessageMentionableSelect,
) -> json.Json

create_message_reference_to_json

</> 
pub fn create_message_reference_to_json(
  create: CreateMessageReference,
) -> json.Json

create_message_role_select_to_json

</> 
pub fn create_message_role_select_to_json(
  create: CreateMessageRoleSelect,
) -> json.Json

create_message_section_to_json

</> 
pub fn create_message_section_to_json(
  create: CreateMessageSection,
) -> json.Json

create_message_separator_to_json

</> 
pub fn create_message_separator_to_json(
  create: CreateMessageSeparator,
) -> json.Json

create_message_string_select_to_json

</> 
pub fn create_message_string_select_to_json(
  create: CreateMessageStringSelect,
) -> json.Json

create_message_text_display_to_json

</> 
pub fn create_message_text_display_to_json(
  create: CreateMessageTextDisplay,
) -> json.Json

create_message_thumbnail_to_json

</> 
pub fn create_message_thumbnail_to_json(
  create: CreateMessageThumbnail,
) -> json.Json

create_message_to_json

</> 
pub fn create_message_to_json(create: CreateMessage) -> json.Json

create_message_user_select_to_json

</> 
pub fn create_message_user_select_to_json(
  create: CreateMessageUserSelect,
) -> json.Json

create_modal_channel_select_to_json

</> 
pub fn create_modal_channel_select_to_json(
  create: CreateModalChannelSelect,
) -> json.Json

create_modal_checkbox_group_to_json

</> 
pub fn create_modal_checkbox_group_to_json(
  create: CreateModalCheckboxGroup,
) -> json.Json

create_modal_checkbox_to_json

</> 
pub fn create_modal_checkbox_to_json(
  create: CreateModalCheckbox,
) -> json.Json

create_modal_component_to_json

</> 
pub fn create_modal_component_to_json(
  create: CreateModalComponent,
) -> json.Json

create_modal_file_upload_to_json

</> 
pub fn create_modal_file_upload_to_json(
  create: CreateModalFileUpload,
) -> json.Json

create_modal_label_component_to_json

</> 
pub fn create_modal_label_component_to_json(
  create: CreateModalLabelComponent,
) -> json.Json

create_modal_label_to_json

</> 
pub fn create_modal_label_to_json(
  create: CreateModalLabel,
) -> json.Json

create_modal_mentionable_select_to_json

</> 
pub fn create_modal_mentionable_select_to_json(
  create: CreateModalMentionableSelect,
) -> json.Json

create_modal_radio_group_to_json

</> 
pub fn create_modal_radio_group_to_json(
  create: CreateModalRadioGroup,
) -> json.Json

create_modal_role_select_to_json

</> 
pub fn create_modal_role_select_to_json(
  create: CreateModalRoleSelect,
) -> json.Json

create_modal_string_select_to_json

</> 
pub fn create_modal_string_select_to_json(
  create: CreateModalStringSelect,
) -> json.Json

create_modal_text_display_to_json

</> 
pub fn create_modal_text_display_to_json(
  create: CreateModalTextDisplay,
) -> json.Json

create_modal_text_input_to_json

</> 
pub fn create_modal_text_input_to_json(
  create: CreateModalTextInput,
) -> json.Json

create_modal_user_select_to_json

</> 
pub fn create_modal_user_select_to_json(
  create: CreateModalUserSelect,
) -> json.Json

create_poll_answer_emoji_to_json

</> 
pub fn create_poll_answer_emoji_to_json(
  create: CreatePollAnswerEmoji,
) -> json.Json

create_poll_answer_to_json

</> 
pub fn create_poll_answer_to_json(
  create: CreatePollAnswer,
) -> json.Json

create_poll_to_json

</> 
pub fn create_poll_to_json(create: CreatePoll) -> json.Json

create_premium_button_to_json

</> 
pub fn create_premium_button_to_json(
  create: CreatePremiumButton,
) -> json.Json

create_radio_group_option_to_json

</> 
pub fn create_radio_group_option_to_json(
  create: CreateRadioGroupOption,
) -> json.Json

create_regular_button_to_json

</> 
pub fn create_regular_button_to_json(
  create: CreateRegularButton,
) -> json.Json

create_role_to_json

</> 
pub fn create_role_to_json(create: CreateRole) -> json.Json

create_section_accessory_to_json

</> 
pub fn create_section_accessory_to_json(
  accessory: CreateSectionAccessory,
) -> json.Json

create_section_component_to_json

</> 
pub fn create_section_component_to_json(
  component: CreateSectionComponent,
) -> json.Json

create_stage_channel_to_json

</> 
pub fn create_stage_channel_to_json(
  create: CreateStageChannel,
) -> json.Json

create_stage_instance_to_json

</> 
pub fn create_stage_instance_to_json(
  create: CreateStageInstance,
) -> json.Json

create_text_channel_to_json

</> 
pub fn create_text_channel_to_json(
  create: CreateTextChannel,
) -> json.Json

create_thread_from_message_to_json

</> 
pub fn create_thread_from_message_to_json(
  create: CreateThreadFromMessage,
) -> json.Json

create_thread_to_json

</> 
pub fn create_thread_to_json(create: CreateThread) -> json.Json

create_unfurled_media_item_to_json

</> 
pub fn create_unfurled_media_item_to_json(
  create: CreateUnfurledMediaItem,
) -> json.Json

create_voice_channel_to_json

</> 
pub fn create_voice_channel_to_json(
  create: CreateVoiceChannel,
) -> json.Json

crosspost_message_request

</> 
pub fn crosspost_message_request(
  token token: Token,
  from_channel_with_id channel_id: Snowflake(AnnouncementChannel),
  message_with_id message_id: Snowflake(Message),
) -> request.Request(String)

Crossposts a message from an announcement channel to all its followers.

Required permissions in the announcement channel:

  • AllowSendingMessages - for the current user’s messages
  • AllowManagingMessages - for all other messages

crosspost_message_response

</> 
pub fn crosspost_message_response(
  response: response.Response(String),
) -> Result(Message, RestError)

custom_emoji_decoder

</> 
pub fn custom_emoji_decoder() -> decode.Decoder(CustomEmoji)

days_decoder

</> 
pub fn days_decoder() -> decode.Decoder(duration.Duration)

deafen_guild_member

</> 
pub fn deafen_guild_member(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowDeafeningMembersInVoiceChannels permission.

Denies the user’s permission to listen and speak in all the guild’s voice channels.

Will return a bad request if the user is not in a voice channel.

default_forum_reaction_decoder

</> 
pub fn default_forum_reaction_decoder() -> decode.Decoder(
  DefaultForumReaction,
)

default_forum_reaction_to_json

</> 
pub fn default_forum_reaction_to_json(
  reaction: DefaultForumReaction,
) -> json.Json

defer_command_interaction_response

</> 
pub fn defer_command_interaction_response(
  is_response_ephemeral is_ephemeral: Bool,
) -> CommandInteractionResponse

Gives you 15 minutes while the bot is displaying a “thinking” state.

Modify the original interaction response to stop the “thinking” state.

defer_message_component_interaction_message_response

</> 
pub fn defer_message_component_interaction_message_response(
  is_ephemeral is_ephemeral: Bool,
) -> MessageComponentInteractionResponse

Responds by replying to the original component’s message with a “thinking” state.

Gives you 15 minutes to edit the response, will create a reply message after editing.

defer_message_component_interaction_message_update_response

</> 
pub fn defer_message_component_interaction_message_update_response() -> MessageComponentInteractionResponse

Responds by acknowledging the interaction and pledging to edit the original message within 15 minutes.

defer_modal_interaction_response

</> 
pub fn defer_modal_interaction_response(
  is_ephemeral is_ephemeral: Bool,
) -> ModalInteractionResponse

delete_announcement_channel_topic

</> 
pub fn delete_announcement_channel_topic(
  modify: ModifyAnnouncementChannel,
) -> ModifyAnnouncementChannel

delete_channel_request

</> 
pub fn delete_channel_request(
  token token: Token,
  channel_with_id id: Snowflake(Channel),
  reason reason: option.Option(String),
) -> request.Request(String)

Behavior:

  • guild channels - will permanently and irreversibly delete the channel; requires the AllowManagingChannels permission
    • category channels - will not delete the child channels, their parent_id property will be deleted
    • community-specific (rules & community updates) channels - cannot be deleted
  • threads - will permanently and irreversibly delete the thread; requires the AllowManagingThreads permission
  • DM channels - will close the channel; the channel can be re-opened by opening a DM with the recipient once again

delete_channel_response

</> 
pub fn delete_channel_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_current_application_cover_image

</> 
pub fn delete_current_application_cover_image(
  modify: ModifyCurrentApplication,
) -> ModifyCurrentApplication

delete_current_application_icon

</> 
pub fn delete_current_application_icon(
  modify: ModifyCurrentApplication,
) -> ModifyCurrentApplication

delete_current_guild_member_avatar

</> 
pub fn delete_current_guild_member_avatar(
  modify: ModifyCurrentGuildMember,
) -> ModifyCurrentGuildMember

Modifies your per-guild avatar.

delete_current_guild_member_banner

</> 
pub fn delete_current_guild_member_banner(
  modify: ModifyCurrentGuildMember,
) -> ModifyCurrentGuildMember

Modifies your per-guild banner.

delete_current_guild_member_bio

</> 
pub fn delete_current_guild_member_bio(
  modify: ModifyCurrentGuildMember,
) -> ModifyCurrentGuildMember

Deletes your per-guild bio.

delete_current_guild_member_nick

</> 
pub fn delete_current_guild_member_nick(
  modify: ModifyCurrentGuildMember,
) -> ModifyCurrentGuildMember

Requires the AllowChangingOwnNickname permission.

delete_current_user_avatar

</> 
pub fn delete_current_user_avatar(
  modify: ModifyCurrentUser,
) -> ModifyCurrentUser

delete_current_user_banner

</> 
pub fn delete_current_user_banner(
  modify: ModifyCurrentUser,
) -> ModifyCurrentUser

delete_current_user_message_reaction_request

</> 
pub fn delete_current_user_message_reaction_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  from_message_with_id message_id: Snowflake(Message),
  emoji emoji: MessageReactionEmoji,
) -> request.Request(String)

delete_current_user_message_reaction_response

</> 
pub fn delete_current_user_message_reaction_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_forum_channel_rate_limit_per_user

</> 
pub fn delete_forum_channel_rate_limit_per_user(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

delete_forum_channel_topic

</> 
pub fn delete_forum_channel_topic(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

delete_global_command_request

</> 
pub fn delete_global_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  command_with_id command_id: Snowflake(Command),
) -> request.Request(String)

delete_global_command_response

</> 
pub fn delete_global_command_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_global_message_command_name_localizations

</> 
pub fn delete_global_message_command_name_localizations(
  modify: ModifyGlobalMessageCommand,
) -> ModifyGlobalMessageCommand

delete_global_message_command_required_permissions

</> 
pub fn delete_global_message_command_required_permissions(
  modify: ModifyGlobalMessageCommand,
) -> ModifyGlobalMessageCommand

Enables the command for everyone.

delete_global_slash_command_description_localizations

</> 
pub fn delete_global_slash_command_description_localizations(
  modify: ModifyGlobalSlashCommand,
) -> ModifyGlobalSlashCommand

delete_global_slash_command_name_localizations

</> 
pub fn delete_global_slash_command_name_localizations(
  modify: ModifyGlobalSlashCommand,
) -> ModifyGlobalSlashCommand

delete_global_slash_command_required_permissions

</> 
pub fn delete_global_slash_command_required_permissions(
  modify: ModifyGlobalSlashCommand,
) -> ModifyGlobalSlashCommand

Enables the command for everyone.

delete_global_user_command_name_localizations

</> 
pub fn delete_global_user_command_name_localizations(
  modify: ModifyGlobalUserCommand,
) -> ModifyGlobalUserCommand

delete_global_user_command_required_permissions

</> 
pub fn delete_global_user_command_required_permissions(
  modify: ModifyGlobalUserCommand,
) -> ModifyGlobalUserCommand

Enables the command for everyone.

delete_guild_command_request

</> 
pub fn delete_guild_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  command_with_id command_id: Snowflake(Command),
) -> request.Request(String)

delete_guild_command_response

</> 
pub fn delete_guild_command_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_guild_discovery_splash

</> 
pub fn delete_guild_discovery_splash(
  modify: ModifyGuild,
) -> ModifyGuild

delete_guild_integration_request

</> 
pub fn delete_guild_integration_request(
  token token: Token,
  with_id integration_id: Snowflake(GuildIntegration),
  from_guild_with_id guild_id: Snowflake(Guild),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingGuild permission.

Deletes any associated webhooks and kicks the associated bot (if there is one).

delete_guild_integration_response

</> 
pub fn delete_guild_integration_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_guild_message_command_name_localizations

</> 
pub fn delete_guild_message_command_name_localizations(
  modify: ModifyGuildMessageCommand,
) -> ModifyGuildMessageCommand

delete_guild_message_command_required_permissions

</> 
pub fn delete_guild_message_command_required_permissions(
  modify: ModifyGuildMessageCommand,
) -> ModifyGuildMessageCommand

Enables the command for everyone.

delete_guild_slash_command_description_localizations

</> 
pub fn delete_guild_slash_command_description_localizations(
  modify: ModifyGuildSlashCommand,
) -> ModifyGuildSlashCommand

delete_guild_slash_command_name_localizations

</> 
pub fn delete_guild_slash_command_name_localizations(
  modify: ModifyGuildSlashCommand,
) -> ModifyGuildSlashCommand

delete_guild_slash_command_required_permissions

</> 
pub fn delete_guild_slash_command_required_permissions(
  modify: ModifyGuildSlashCommand,
) -> ModifyGuildSlashCommand

Enables the command for everyone.

delete_guild_soundboard_sound_emoji

</> 
pub fn delete_guild_soundboard_sound_emoji(
  modify: ModifyGuildSoundboardSound,
) -> ModifyGuildSoundboardSound

delete_guild_soundboard_sound_request

</> 
pub fn delete_guild_soundboard_sound_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  sound_with_id sound_id: Snowflake(SoundboardSound),
  reason reason: option.Option(String),
) -> request.Request(String)

If the sound was created by the current user, requires the AllowCreatingGuildExpressions or AllowManagingGuildExpressions permission.

For all other sounds, requires the AllowManagingGuildExpressions permission.

delete_guild_soundboard_sound_response

</> 
pub fn delete_guild_soundboard_sound_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_guild_sticker_description

</> 
pub fn delete_guild_sticker_description(
  modify: ModifyGuildSticker,
) -> ModifyGuildSticker

delete_guild_sticker_request

</> 
pub fn delete_guild_sticker_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  sticker_with_id sticker_id: Snowflake(GuildSticker),
  reason reason: option.Option(String),
) -> request.Request(String)

Required permissions:

  • for stickers created by the current user - AllowCreatingGuildExpressions or AllowManagingGuildExpressions
  • for other stickers - AllowManagingGuildExpressions

delete_guild_sticker_response

</> 
pub fn delete_guild_sticker_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_guild_user_command_name_localizations

</> 
pub fn delete_guild_user_command_name_localizations(
  modify: ModifyGuildUserCommand,
) -> ModifyGuildUserCommand

delete_guild_user_command_required_permissions

</> 
pub fn delete_guild_user_command_required_permissions(
  modify: ModifyGuildUserCommand,
) -> ModifyGuildUserCommand

Enables the command for everyone.

delete_guild_welcome_screen_description

</> 
pub fn delete_guild_welcome_screen_description(
  modify: ModifyGuildWelcomeScreen,
) -> ModifyGuildWelcomeScreen

delete_interaction_response_followup_message_request

</> 
pub fn delete_interaction_response_followup_message_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  interaction_token interaction_token: InteractionToken,
  message_id message_id: Snowflake(Message),
) -> request.Request(String)

delete_interaction_response_followup_message_response

</> 
pub fn delete_interaction_response_followup_message_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_interaction_response_message_attachments

</> 
pub fn delete_interaction_response_message_attachments(
  modify: ModifyInteractionResponseMessage,
) -> ModifyInteractionResponseMessage

delete_interaction_response_message_components

</> 
pub fn delete_interaction_response_message_components(
  modify: ModifyInteractionResponseMessage,
) -> ModifyInteractionResponseMessage

delete_interaction_response_message_content

</> 
pub fn delete_interaction_response_message_content(
  modify: ModifyInteractionResponseMessage,
) -> ModifyInteractionResponseMessage

delete_interaction_response_message_embeds

</> 
pub fn delete_interaction_response_message_embeds(
  modify: ModifyInteractionResponseMessage,
) -> ModifyInteractionResponseMessage

delete_interaction_response_message_poll

</> 
pub fn delete_interaction_response_message_poll(
  modify: ModifyInteractionResponseMessage,
) -> ModifyInteractionResponseMessage

delete_invite_request

</> 
pub fn delete_invite_request(
  token token: Token,
  invite_with_code code: String,
  reason reason: option.Option(String),
) -> request.Request(String)

Requirements:

  • for a channel invite - AllowManagingChannels in that channel
  • for any invite - AllowManagingGuild

delete_invite_response

</> 
pub fn delete_invite_response(
  response: response.Response(String),
) -> Result(Invite, RestError)

delete_media_channel_rate_limit_per_user

</> 
pub fn delete_media_channel_rate_limit_per_user(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

delete_media_channel_topic

</> 
pub fn delete_media_channel_topic(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

delete_message_emoji_reactions_request

</> 
pub fn delete_message_emoji_reactions_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  from_message_with_id message_id: Snowflake(Message),
  emoji emoji: MessageReactionEmoji,
) -> request.Request(String)

Deletes all the reactions for a given messages from a message.

Requires the AllowManagingMessages permission.

delete_message_emoji_reactions_response

</> 
pub fn delete_message_emoji_reactions_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_message_reaction_request

</> 
pub fn delete_message_reaction_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  from_message_with_id message_id: Snowflake(Message),
  by_user_with_id user_id: Snowflake(User),
  emoji emoji: MessageReactionEmoji,
) -> request.Request(String)

Requires the AllowManagingMessages permission.

delete_message_reaction_response

</> 
pub fn delete_message_reaction_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_message_reactions_request

</> 
pub fn delete_message_reactions_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  message_with_id message_id: Snowflake(Message),
) -> request.Request(String)

Removes all reactions from a message.

Requires the AllowManagingMessages permission.

delete_message_reactions_response

</> 
pub fn delete_message_reactions_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_message_request

</> 
pub fn delete_message_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  message_with_id message_id: Snowflake(Message),
  reason reason: option.Option(String),
) -> request.Request(String)

Deleting others’ messages requires the AllowManagingMessages permission.

delete_message_response

</> 
pub fn delete_message_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_original_interaction_response_request

</> 
pub fn delete_original_interaction_response_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  interaction_token interaction_token: InteractionToken,
) -> request.Request(String)

delete_original_interaction_response_response

</> 
pub fn delete_original_interaction_response_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_role_colours

</> 
pub fn delete_role_colours(modify: ModifyRole) -> ModifyRole

delete_role_position

</> 
pub fn delete_role_position(
  of_role_with_id id: Snowflake(Role),
) -> ModifyRolePosition

Deleting a role’s position makes it lower than any role with a position.

Roles with the same position are sorted by ID.

delete_role_request

</> 
pub fn delete_role_request(
  token token: Token,
  with_id role_id: Snowflake(Role),
  from_guild_with_id guild_id: Snowflake(Guild),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingRoles permission.

delete_role_response

</> 
pub fn delete_role_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_role_unicode_emoji

</> 
pub fn delete_role_unicode_emoji(
  modify: ModifyRole,
) -> ModifyRole

delete_stage_channel_rate_limit_per_user

</> 
pub fn delete_stage_channel_rate_limit_per_user(
  modify: ModifyStageChannel,
) -> ModifyStageChannel

delete_stage_instance_request

</> 
pub fn delete_stage_instance_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(StageChannel),
) -> request.Request(String)

delete_stage_instance_response

</> 
pub fn delete_stage_instance_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

delete_text_channel_rate_limit_per_user

</> 
pub fn delete_text_channel_rate_limit_per_user(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

AKA remove slowmode.

delete_text_channel_topic

</> 
pub fn delete_text_channel_topic(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

delete_voice_channel_rate_limit_per_user

</> 
pub fn delete_voice_channel_rate_limit_per_user(
  modify: ModifyVoiceChannel,
) -> ModifyVoiceChannel

developer_team_decoder

</> 
pub fn developer_team_decoder() -> decode.Decoder(DeveloperTeam)

developer_team_member_decoder

</> 
pub fn developer_team_member_decoder() -> decode.Decoder(
  DeveloperTeamMember,
)

developer_team_member_role_decoder

</> 
pub fn developer_team_member_role_decoder() -> decode.Decoder(
  DeveloperTeamMemberRole,
)

developer_team_membership_state_decoder

</> 
pub fn developer_team_membership_state_decoder() -> decode.Decoder(
  DeveloperTeamMembershipState,
)

disable_current_application_webhook_events

</> 
pub fn disable_current_application_webhook_events(
  modify: ModifyCurrentApplication,
) -> ModifyCurrentApplication

disable_guild_dms

</> 
pub fn disable_guild_dms(
  modify: ModifyGuildIncidentsData,
  until timestamp: timestamp.Timestamp,
) -> ModifyGuildIncidentsData

Disable DMs between guild members as a response to an incident.

You can only disable DMs for up to 24 hours.

disable_guild_invites

</> 
pub fn disable_guild_invites(
  modify: ModifyGuildIncidentsData,
  until timestamp: timestamp.Timestamp,
) -> ModifyGuildIncidentsData

Disable invites in response to an incident.

You can only disable invites for up to 24 hours.

disable_guild_premium_progress_bar

</> 
pub fn disable_guild_premium_progress_bar(
  modify: ModifyGuild,
) -> ModifyGuild

disable_guild_welcome_screen

</> 
pub fn disable_guild_welcome_screen(
  modify: ModifyGuildWelcomeScreen,
) -> ModifyGuildWelcomeScreen

disable_guild_widget

</> 
pub fn disable_guild_widget(
  modify: ModifyGuildWidgetSettings,
) -> ModifyGuildWidgetSettings

disconnect_guild_member

</> 
pub fn disconnect_guild_member(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowMovingMembersBetweenVoiceChannels permission and the AllowConnectingToVoiceChannels permission for that voice channel.

Will return a bad request if the user is not in a voice channel.

dm_channel_decoder

</> 
pub fn dm_channel_decoder() -> decode.Decoder(DmChannel)

duration_to_json_hours

</> 
pub fn duration_to_json_hours(
  duration: duration.Duration,
) -> json.Json

duration_to_json_seconds

</> 
pub fn duration_to_json_seconds(
  duration: duration.Duration,
) -> json.Json

embed_author_decoder

</> 
pub fn embed_author_decoder() -> decode.Decoder(EmbedAuthor)

embed_field_decoder

</> 
pub fn embed_field_decoder() -> decode.Decoder(EmbedField)
</> 
pub fn embed_footer_decoder() -> decode.Decoder(EmbedFooter)

embed_image_decoder

</> 
pub fn embed_image_decoder() -> decode.Decoder(EmbedImage)

embed_type_decoder

</> 
pub fn embed_type_decoder() -> decode.Decoder(EmbedType)

embed_video_decoder

</> 
pub fn embed_video_decoder() -> decode.Decoder(EmbedVideo)

emoji_decoder

</> 
pub fn emoji_decoder() -> decode.Decoder(Emoji)

enable_current_application_webhook_events

</> 
pub fn enable_current_application_webhook_events(
  modify: ModifyCurrentApplication,
) -> ModifyCurrentApplication

enable_guild_dms

</> 
pub fn enable_guild_dms(
  modify: ModifyGuildIncidentsData,
) -> ModifyGuildIncidentsData

Enable DMs between guild members after they were disabled in response to an incident.

enable_guild_invites

</> 
pub fn enable_guild_invites(
  modify: ModifyGuildIncidentsData,
) -> ModifyGuildIncidentsData

Enable guild invites after they were disabled in response to an incident.

enable_guild_premium_progress_bar

</> 
pub fn enable_guild_premium_progress_bar(
  modify: ModifyGuild,
) -> ModifyGuild

enable_guild_welcome_screen

</> 
pub fn enable_guild_welcome_screen(
  modify: ModifyGuildWelcomeScreen,
) -> ModifyGuildWelcomeScreen

enable_guild_widget

</> 
pub fn enable_guild_widget(
  modify: ModifyGuildWidgetSettings,
) -> ModifyGuildWidgetSettings

end_poll_request

</> 
pub fn end_poll_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  for_message_with_id message_id: Snowflake(Message),
) -> request.Request(String)

You cannot end other users’ polls.

end_poll_response

</> 
pub fn end_poll_response(
  response: response.Response(String),
) -> Result(Message, RestError)

entitlement_decoder

</> 
pub fn entitlement_decoder() -> decode.Decoder(Entitlement)

entitlement_holder_decoder

</> 
pub fn entitlement_holder_decoder() -> decode.Decoder(
  EntitlementHolder,
)

entitlement_type_decoder

</> 
pub fn entitlement_type_decoder() -> decode.Decoder(
  EntitlementType,
)

error_code_decoder

</> 
pub fn error_code_decoder() -> decode.Decoder(ErrorCode)

error_item_decoder

</> 
pub fn error_item_decoder() -> decode.Decoder(ErrorItem)

error_node_decoder

</> 
pub fn error_node_decoder() -> decode.Decoder(ErrorNode)

error_response_decoder

</> 
pub fn error_response_decoder() -> decode.Decoder(ErrorResponse)

executed_attachment_slash_command_option_decoder

</> 
pub fn executed_attachment_slash_command_option_decoder() -> decode.Decoder(
  ExecutedAttachmentSlashCommandOption,
)

executed_bool_slash_command_option_decoder

</> 
pub fn executed_bool_slash_command_option_decoder() -> decode.Decoder(
  ExecutedBoolSlashCommandOption,
)

executed_button_decoder

</> 
pub fn executed_button_decoder() -> decode.Decoder(ExecutedButton)

executed_channel_select_decoder

</> 
pub fn executed_channel_select_decoder() -> decode.Decoder(
  ExecutedChannelSelect,
)

executed_channel_slash_command_option_decoder

</> 
pub fn executed_channel_slash_command_option_decoder() -> decode.Decoder(
  ExecutedChannelSlashCommandOption,
)

executed_command_data_decoder

</> 
pub fn executed_command_data_decoder() -> decode.Decoder(
  ExecutedCommandData,
)

executed_command_decoder

</> 
pub fn executed_command_decoder() -> decode.Decoder(
  ExecutedCommand,
)

executed_float_slash_command_option_decoder

</> 
pub fn executed_float_slash_command_option_decoder() -> decode.Decoder(
  ExecutedFloatSlashCommandOption,
)

executed_int_slash_command_option_decoder

</> 
pub fn executed_int_slash_command_option_decoder() -> decode.Decoder(
  ExecutedIntSlashCommandOption,
)

executed_mentionable_select_decoder

</> 
pub fn executed_mentionable_select_decoder() -> decode.Decoder(
  ExecutedMentionableSelect,
)

executed_mentionable_slash_command_option_decoder

</> 
pub fn executed_mentionable_slash_command_option_decoder() -> decode.Decoder(
  ExecutedMentionableSlashCommandOption,
)

executed_message_component_decoder

</> 
pub fn executed_message_component_decoder() -> decode.Decoder(
  ExecutedMessageComponent,
)

executed_role_slash_command_option_decoder

</> 
pub fn executed_role_slash_command_option_decoder() -> decode.Decoder(
  ExecutedRoleSlashCommandOption,
)

executed_slash_command_option_decoder

</> 
pub fn executed_slash_command_option_decoder() -> decode.Decoder(
  ExecutedSlashCommandOption,
)

executed_string_select_decoder

</> 
pub fn executed_string_select_decoder() -> decode.Decoder(
  ExecutedStringSelect,
)

executed_string_slash_command_option_decoder

</> 
pub fn executed_string_slash_command_option_decoder() -> decode.Decoder(
  ExecutedStringSlashCommandOption,
)

executed_sub_command_group_option_decoder

</> 
pub fn executed_sub_command_group_option_decoder() -> decode.Decoder(
  ExecutedSubCommandGroupOption,
)

executed_sub_command_group_slash_command_option_decoder

</> 
pub fn executed_sub_command_group_slash_command_option_decoder() -> decode.Decoder(
  ExecutedSubCommandGroupSlashCommandOption,
)

executed_sub_command_option_decoder

</> 
pub fn executed_sub_command_option_decoder() -> decode.Decoder(
  ExecutedSubCommandOption,
)

executed_sub_command_slash_command_option_decoder

</> 
pub fn executed_sub_command_slash_command_option_decoder() -> decode.Decoder(
  ExecutedSubCommandSlashCommandOption,
)

executed_user_slash_command_option_decoder

</> 
pub fn executed_user_slash_command_option_decoder() -> decode.Decoder(
  ExecutedUserSlashCommandOption,
)

file_upload_filter_decoder

</> 
pub fn file_upload_filter_decoder() -> decode.Decoder(
  FileUploadFilter,
)

file_upload_filter_to_json

</> 
pub fn file_upload_filter_to_json(
  filter: FileUploadFilter,
) -> json.Json

float_slash_command_option_choice_decoder

</> 
pub fn float_slash_command_option_choice_decoder() -> decode.Decoder(
  FloatSlashCommandOptionChoice,
)

float_slash_command_option_choice_to_json

</> 
pub fn float_slash_command_option_choice_to_json(
  choice: FloatSlashCommandOptionChoice,
) -> json.Json

float_slash_command_option_decoder

</> 
pub fn float_slash_command_option_decoder() -> decode.Decoder(
  FloatSlashCommandOption,
)

float_slash_command_option_to_json

</> 
pub fn float_slash_command_option_to_json(
  option: FloatSlashCommandOption,
) -> json.Json

follow_announcement_channel_request

</> 
pub fn follow_announcement_channel_request(
  token token: Token,
  source_channel_id source_id: Snowflake(AnnouncementChannel),
  target_channel_id target_id: Snowflake(TextChannel),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingWebhooks permission.

follow_announcement_channel_response

</> 
pub fn follow_announcement_channel_response(
  response: response.Response(String),
) -> Result(FollowedChannel, RestError)

followed_channel_decoder

</> 
pub fn followed_channel_decoder() -> decode.Decoder(
  FollowedChannel,
)

followup_to_interaction_response_request

</> 
pub fn followup_to_interaction_response_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  interaction_token interaction_token: InteractionToken,
  with message: InteractionResponseMessage,
) -> request.Request(BitArray)

Creates a reply to the original interaction response.

IMPORTANT: If you deferred the interaction’s response and didn’t modify the deferred response, this endpoint will modify the original interaction response. This behaviour is deprecated, use modify_original_interaction_response_request if you don’t want to create a followup reply.

followup_to_interaction_response_response

</> 
pub fn followup_to_interaction_response_response(
  response: response.Response(BitArray),
) -> Result(Message, RestError)

forum_channel_decoder

</> 
pub fn forum_channel_decoder() -> decode.Decoder(ForumChannel)

forum_layout_decoder

</> 
pub fn forum_layout_decoder() -> decode.Decoder(ForumLayout)

forum_layout_to_json

</> 
pub fn forum_layout_to_json(layout: ForumLayout) -> json.Json

forum_sort_order_decoder

</> 
pub fn forum_sort_order_decoder() -> decode.Decoder(
  ForumSortOrder,
)

forum_sort_order_to_json

</> 
pub fn forum_sort_order_to_json(
  order: ForumSortOrder,
) -> json.Json

forum_tag_decoder

</> 
pub fn forum_tag_decoder() -> decode.Decoder(ForumTag)

forum_tag_emoji_to_json

</> 
pub fn forum_tag_emoji_to_json(
  emoji: ForumTagEmoji,
) -> #(String, json.Json)

forum_tag_to_json

</> 
pub fn forum_tag_to_json(forum_tag: ForumTag) -> json.Json

gateway_connection_info_decoder

</> 
pub fn gateway_connection_info_decoder() -> decode.Decoder(
  GatewayConnectionInfo,
)

gateway_connection_start_limits_decoder

</> 
pub fn gateway_connection_start_limits_decoder() -> decode.Decoder(
  GatewayConnectionStartLimits,
)

get_all_active_guild_threads_response_decoder

</> 
pub fn get_all_active_guild_threads_response_decoder() -> decode.Decoder(
  GetAllActiveGuildThreadsResponse,
)

get_all_active_threads_request

</> 
pub fn get_all_active_threads_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

get_all_active_threads_response

</> 
pub fn get_all_active_threads_response(
  response: response.Response(String),
) -> Result(GetAllActiveGuildThreadsResponse, RestError)

get_application_asset_image_request

</> 
pub fn get_application_asset_image_request(
  id application_id: Snowflake(Application),
  hash asset_hash: ImageHash,
  format format: RequestedApplicationAssetFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_application_cover_image_request

</> 
pub fn get_application_cover_image_request(
  id application_id: Snowflake(Application),
  hash cover_hash: ImageHash,
  format format: RequestedApplicationCoverFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_application_icon_image_request

</> 
pub fn get_application_icon_image_request(
  id application_id: Snowflake(Application),
  hash icon_hash: ImageHash,
  format format: RequestedApplicationIconFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_application_skus_request

</> 
pub fn get_application_skus_request(
  token token: Token,
  application_with_id application_id: Snowflake(Application),
) -> request.Request(String)

get_application_skus_response

</> 
pub fn get_application_skus_response(
  response: response.Response(String),
) -> Result(List(Sku), RestError)

get_avatar_decoration_image_request

</> 
pub fn get_avatar_decoration_image_request(
  hash image_hash: ImageHash,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

Returns the image in PNG format.

get_burst_reacting_users

</> 
pub fn get_burst_reacting_users(
  options: GetReactingUsersOptions,
) -> GetReactingUsersOptions

Will ONLY return burst reacting users.

get_channel_pins_before

</> 
pub fn get_channel_pins_before(
  options: GetChannelPinsOptions,
  timestamp timestamp: timestamp.Timestamp,
) -> GetChannelPinsOptions

get_channel_pins_request

</> 
pub fn get_channel_pins_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(GuildChannel),
  using options: GetChannelPinsOptions,
) -> request.Request(String)

Requires the AllowViewingChannels permission.

Soft fails (returns 0 pins) if missing the AllowReadingMessageHistory permission.

get_channel_pins_response

</> 
pub fn get_channel_pins_response(
  response: response.Response(String),
) -> Result(GetChannelPinsResponse, RestError)

get_channel_pins_response_decoder

</> 
pub fn get_channel_pins_response_decoder() -> decode.Decoder(
  GetChannelPinsResponse,
)

get_channel_pins_with_limit

</> 
pub fn get_channel_pins_with_limit(
  options: GetChannelPinsOptions,
  limit: Int,
) -> GetChannelPinsOptions

get_channel_request

</> 
pub fn get_channel_request(
  token token: Token,
  with_id channel_id: Snowflake(Channel),
) -> request.Request(String)

get_channel_response

</> 
pub fn get_channel_response(
  response: response.Response(String),
) -> Result(Channel, RestError)

get_creation_timestamp

</> 
pub fn get_creation_timestamp(
  of snowflake: Snowflake(a),
) -> timestamp.Timestamp

get_current_application_entitlements_after

</> 
pub fn get_current_application_entitlements_after(
  options: GetCurrentApplicationEntitlementsOptions,
  entitlement_with_id after: Snowflake(Entitlement),
) -> GetCurrentApplicationEntitlementsOptions

get_current_application_entitlements_before

</> 
pub fn get_current_application_entitlements_before(
  options: GetCurrentApplicationEntitlementsOptions,
  entitlement_with_id before: Snowflake(Entitlement),
) -> GetCurrentApplicationEntitlementsOptions

get_current_application_entitlements_excluding_ended

</> 
pub fn get_current_application_entitlements_excluding_ended(
  options: GetCurrentApplicationEntitlementsOptions,
) -> GetCurrentApplicationEntitlementsOptions

get_current_application_entitlements_for_guild

</> 
pub fn get_current_application_entitlements_for_guild(
  options: GetCurrentApplicationEntitlementsOptions,
  guild_with_id guild_id: Snowflake(Guild),
) -> GetCurrentApplicationEntitlementsOptions

get_current_application_entitlements_for_skus

</> 
pub fn get_current_application_entitlements_for_skus(
  options: GetCurrentApplicationEntitlementsOptions,
  skus_with_ids sku_ids: List(Snowflake(Sku)),
) -> GetCurrentApplicationEntitlementsOptions

get_current_application_entitlements_for_user

</> 
pub fn get_current_application_entitlements_for_user(
  options: GetCurrentApplicationEntitlementsOptions,
  user_with_id user_id: Snowflake(User),
) -> GetCurrentApplicationEntitlementsOptions

get_current_application_entitlements_including_deleted

</> 
pub fn get_current_application_entitlements_including_deleted(
  options: GetCurrentApplicationEntitlementsOptions,
) -> GetCurrentApplicationEntitlementsOptions

get_current_application_entitlements_request

</> 
pub fn get_current_application_entitlements_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  using options: GetCurrentApplicationEntitlementsOptions,
) -> request.Request(String)

You have to provide the current application’s ID. Sorry, I don’t make the rules :/

get_current_application_entitlements_response

</> 
pub fn get_current_application_entitlements_response(
  response: response.Response(String),
) -> Result(List(Entitlement), RestError)

get_current_application_entitlements_with_limit

</> 
pub fn get_current_application_entitlements_with_limit(
  options: GetCurrentApplicationEntitlementsOptions,
  limit: Int,
) -> GetCurrentApplicationEntitlementsOptions

Limit must be between 1 and 100.

get_current_application_request

</> 
pub fn get_current_application_request(
  token token: Token,
) -> request.Request(String)

get_current_application_response

</> 
pub fn get_current_application_response(
  response: response.Response(String),
) -> Result(Application, RestError)

get_current_user_as_guild_member_request

</> 
pub fn get_current_user_as_guild_member_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

get_current_user_as_guild_member_response

</> 
pub fn get_current_user_as_guild_member_response(
  response: response.Response(String),
) -> Result(GuildMember, RestError)

get_current_user_request

</> 
pub fn get_current_user_request(
  token token: Token,
) -> request.Request(String)

get_current_user_response

</> 
pub fn get_current_user_response(
  response: response.Response(String),
) -> Result(User, RestError)

get_current_user_voice_state_request

</> 
pub fn get_current_user_voice_state_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

get_current_user_voice_state_response

</> 
pub fn get_current_user_voice_state_response(
  response: response.Response(String),
) -> Result(VoiceState, RestError)

get_custom_emoji_image_request

</> 
pub fn get_custom_emoji_image_request(
  id emoji_id: Snowflake(Emoji),
  format format: RequestedCustomEmojiFormat,
) -> request.Request(BitArray)

It is recommended to use the WebP format.

Emojis can be uploaded as PNG, JPEG, WebP, GIF, or AVIF.

Other formats don’t convert well to formats other than WebP.

get_default_soundboard_sounds_request

</> 
pub fn get_default_soundboard_sounds_request(
  token token: Token,
) -> request.Request(String)

get_default_soundboard_sounds_response

</> 
pub fn get_default_soundboard_sounds_response(
  response: response.Response(String),
) -> Result(List(SoundboardSound), RestError)

get_developer_team_icon_image_request

</> 
pub fn get_developer_team_icon_image_request(
  id developer_team_id: Snowflake(DeveloperTeam),
  hash image_hash: ImageHash,
  format format: RequestedDeveloperTeamFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_entitlement_request

</> 
pub fn get_entitlement_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  entitlement_with_id entitlement_id: Snowflake(Entitlement),
) -> request.Request(String)

You have to provide the current application’s ID. Sorry, I don’t make the rules :/

get_entitlement_response

</> 
pub fn get_entitlement_response(
  response: response.Response(String),
) -> Result(Entitlement, RestError)

get_everyone_role_id

</> 
pub fn get_everyone_role_id(
  of_guild_with_id id: Snowflake(Guild),
) -> Snowflake(Role)

Returns the ID of the @everyone role for a specific guild.

get_gateway_connection_info_request

</> 
pub fn get_gateway_connection_info_request(
  token token: Token,
) -> request.Request(String)

get_gateway_connection_info_response

</> 
pub fn get_gateway_connection_info_response(
  response: response.Response(String),
) -> Result(GatewayConnectionInfo, RestError)

get_global_command_request

</> 
pub fn get_global_command_request(
  token: Token,
  current_application_id application_id: Snowflake(Application),
  command_id command_id: Snowflake(Command),
) -> request.Request(String)

You can only get commands that belong to the current application.

get_global_command_response

</> 
pub fn get_global_command_response(
  response: response.Response(String),
) -> Result(Command, RestError)

get_global_commands_request

</> 
pub fn get_global_commands_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  with_localizations with_localizations: Bool,
) -> request.Request(String)

get_global_commands_response

</> 
pub fn get_global_commands_response(
  response: response.Response(String),
) -> Result(List(Command), RestError)

get_guild_ban_request

</> 
pub fn get_guild_ban_request(
  token token: Token,
  of_user_with_id user_id: Snowflake(Guild),
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Requires the AllowBanningMembers permission.

get_guild_ban_response

</> 
pub fn get_guild_ban_response(
  response: response.Response(String),
) -> Result(GuildBan, RestError)

get_guild_banner_image_request

</> 
pub fn get_guild_banner_image_request(
  id guild_id: Snowflake(Guild),
  hash banner_hash: ImageHash,
  format format: RequestedGuildBannerFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_guild_bans_after_id

</> 
pub fn get_guild_bans_after_id(
  options: GetGuildBansOptions,
  id: Snowflake(User),
) -> GetGuildBansOptions

Used for pagination. The parameter should be the highest user ID in the previous page.

get_guild_bans_before_id

</> 
pub fn get_guild_bans_before_id(
  options: GetGuildBansOptions,
  id: Snowflake(User),
) -> GetGuildBansOptions

Used for pagination. Takes priority over get_guild_bans_after_id.

get_guild_bans_request

</> 
pub fn get_guild_bans_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  options options: option.Option(GetGuildBansOptions),
) -> request.Request(String)

Requires the AllowBanningMembers permission.

get_guild_bans_response

</> 
pub fn get_guild_bans_response(
  response: response.Response(String),
) -> Result(List(GuildBan), RestError)

get_guild_bans_with_limit

</> 
pub fn get_guild_bans_with_limit(
  options: GetGuildBansOptions,
  limit: Int,
) -> GetGuildBansOptions

Between 1-1000 bans.

get_guild_channel_invites_request

</> 
pub fn get_guild_channel_invites_request(
  token token: Token,
  channel_with_id id: Snowflake(GuildChannel),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

get_guild_channel_invites_response

</> 
pub fn get_guild_channel_invites_response(
  response: response.Response(String),
) -> Result(List(Invite), RestError)

get_guild_channels_request

</> 
pub fn get_guild_channels_request(
  token token: Token,
  guild_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Returns all the channels of a guild, excluding threads.

get_guild_channels_response

</> 
pub fn get_guild_channels_response(
  response: response.Response(String),
) -> Result(List(GuildChannel), RestError)

get_guild_command_request

</> 
pub fn get_guild_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  command_with_id command_id: Snowflake(Command),
) -> request.Request(String)

get_guild_command_response

</> 
pub fn get_guild_command_response(
  response: response.Response(String),
) -> Result(Command, RestError)

get_guild_commands_request

</> 
pub fn get_guild_commands_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  with_localizations with_localizations: Bool,
) -> request.Request(String)

get_guild_commands_response

</> 
pub fn get_guild_commands_response(
  response: response.Response(String),
) -> Result(List(Command), RestError)

get_guild_discovery_splash_image_request

</> 
pub fn get_guild_discovery_splash_image_request(
  id guild_id: Snowflake(Guild),
  hash discovery_splash_hash: ImageHash,
  format format: RequestedGuildDiscoverySplashFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_guild_icon_image_request

</> 
pub fn get_guild_icon_image_request(
  id guild_id: Snowflake(Guild),
  hash icon_hash: ImageHash,
  format format: RequestedGuildIconFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_guild_integrations_request

</> 
pub fn get_guild_integrations_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Requires the AllowManagingGuild permission.

Returns a maximum of 50 integrations. If a guild has more, they cannot be accessed.

get_guild_integrations_response

</> 
pub fn get_guild_integrations_response(
  response: response.Response(String),
) -> Result(List(GuildIntegration), RestError)

get_guild_invites_request

</> 
pub fn get_guild_invites_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Requires the AllowManagingGuild or AllowViewingAuditLog permission.

Will include metadata with the AllowManagingGuild permission.

get_guild_invites_response

</> 
pub fn get_guild_invites_response(
  response: response.Response(String),
) -> Result(List(Invite), RestError)

get_guild_member_avatar_image_request

</> 
pub fn get_guild_member_avatar_image_request(
  user_id user_id: Snowflake(GuildMember),
  guild_id guild_id: Snowflake(Guild),
  hash avatar_hash: ImageHash,
  format format: RequestedGuildMemberAvatarFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

Returns the guild-specific avatar of the user.

get_guild_member_banner_image_request

</> 
pub fn get_guild_member_banner_image_request(
  user_id user_id: Snowflake(GuildMember),
  guild_id guild_id: Snowflake(Guild),
  hash banner_hash: ImageHash,
  format format: RequestedGuildMemberBannerFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

Returns the guild-specific banner of the user.

get_guild_member_request

</> 
pub fn get_guild_member_request(
  token token: Token,
  with_id user_id: Snowflake(User),
  in_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

get_guild_member_response

</> 
pub fn get_guild_member_response(
  response: response.Response(String),
) -> Result(GuildMember, RestError)

get_guild_members_after_id

</> 
pub fn get_guild_members_after_id(
  options: GetGuildMembersOptions,
  id: Snowflake(User),
) -> GetGuildMembersOptions

Used for pagination. The parameter should be the highest user ID in the previous page.

get_guild_members_request

</> 
pub fn get_guild_members_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  options options: option.Option(GetGuildMembersOptions),
) -> request.Request(String)

Requires the GUILD_MEMBERS privileged intent.

By default, will return one member. The maximum limit is 1000.

get_guild_members_response

</> 
pub fn get_guild_members_response(
  response: response.Response(String),
) -> Result(List(GuildMember), RestError)

get_guild_members_with_limit

</> 
pub fn get_guild_members_with_limit(
  options: GetGuildMembersOptions,
  limit: Int,
) -> GetGuildMembersOptions

The maximum limit is 1000 members. The API will not return more than that.

get_guild_onboarding_request

</> 
pub fn get_guild_onboarding_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

get_guild_onboarding_response

</> 
pub fn get_guild_onboarding_response(
  response: response.Response(String),
) -> Result(GuildOnboarding, RestError)

get_guild_preview_request

</> 
pub fn get_guild_preview_request(
  token token: Token,
  id id: Snowflake(Guild),
) -> request.Request(String)

Returns a guild preview object. Is useful for receiving information about discoverable guilds, when the current user isn’t a member of one of those guilds.

get_guild_preview_response

</> 
pub fn get_guild_preview_response(
  response: response.Response(String),
) -> Result(GuildPreview, RestError)

get_guild_prunable_count_request

</> 
pub fn get_guild_prunable_count_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  required_inactive_days days: Int,
  include_roles_with_ids include_roles: List(Snowflake(Role)),
) -> request.Request(String)

Requires the AllowManagingGuild and AllowKickingMembers permissions.

Returns the amount of members that would be kicked if a prune starts.

Pruning will, by default, only kick members with no roles. Include any roles which you count as prunable.

The minimum number of days is 1 and the maximum number of days is 30. Numbers not within these bounds will return the closest result (1 or 30 days)

get_guild_prunable_count_response

</> 
pub fn get_guild_prunable_count_response(
  response: response.Response(String),
) -> Result(Int, RestError)

get_guild_request

</> 
pub fn get_guild_request(
  token token: Token,
  id id: Snowflake(Guild),
) -> request.Request(String)

get_guild_response

</> 
pub fn get_guild_response(
  response: response.Response(String),
) -> Result(Guild, RestError)

get_guild_roles_request

</> 
pub fn get_guild_roles_request(
  token token: Token,
  of_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

get_guild_roles_response

</> 
pub fn get_guild_roles_response(
  response: response.Response(String),
) -> Result(List(Role), RestError)

get_guild_soundboard_sound_request

</> 
pub fn get_guild_soundboard_sound_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  sound_with_id sound_id: Snowflake(SoundboardSound),
) -> request.Request(String)

Includes the creator field if the current user has the AllowCreatingGuildExpressions or AllowManagingGuildExpressions permission.

get_guild_soundboard_sound_response

</> 
pub fn get_guild_soundboard_sound_response(
  response: response.Response(String),
) -> Result(SoundboardSound, RestError)

get_guild_soundboard_sounds_request

</> 
pub fn get_guild_soundboard_sounds_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Includes the creator field if the current user has the AllowCreatingGuildExpressions or AllowManagingGuildExpressions permission.

get_guild_soundboard_sounds_response

</> 
pub fn get_guild_soundboard_sounds_response(
  response: response.Response(String),
) -> Result(List(SoundboardSound), RestError)

get_guild_splash_image_request

</> 
pub fn get_guild_splash_image_request(
  id guild_id: Snowflake(Guild),
  hash splash_hash: ImageHash,
  format format: RequestedGuildSplashFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_guild_sticker_request

</> 
pub fn get_guild_sticker_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  sticker_with_id sticker_id: Snowflake(Sticker),
) -> request.Request(String)

The returned sticker will contain the user field if the bot has the AllowCreatingGuildExpressions or AllowManagingGuildExpressions permission.

get_guild_sticker_response

</> 
pub fn get_guild_sticker_response(
  response: response.Response(String),
) -> Result(GuildSticker, RestError)

get_guild_stickers_request

</> 
pub fn get_guild_stickers_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

The returned stickers will contain the user field if the bot has the AllowCreatingGuildExpressions or AllowManagingGuildExpressions permission.

get_guild_stickers_response

</> 
pub fn get_guild_stickers_response(
  response: response.Response(String),
) -> Result(List(GuildSticker), RestError)

get_guild_tag_badge_image_request

</> 
pub fn get_guild_tag_badge_image_request(
  guild_id guild_id: Snowflake(Guild),
  hash badge_hash: ImageHash,
  format format: RequestedGuildTagBadgeFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_guild_vanity_invite_request

</> 
pub fn get_guild_vanity_invite_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Requires the AllowManagingGuild permission.

Use Guild.vanity_url_code to get the vanity URL code without this permission.

This endpoint is only necessary to get the use count. Returns Ok(None) if the guild can have a vanity URL but doesn’t.

get_guild_vanity_invite_response

</> 
pub fn get_guild_vanity_invite_response(
  response: response.Response(String),
) -> Result(option.Option(GuildVanityInvite), RestError)

get_guild_voice_regions_request

</> 
pub fn get_guild_voice_regions_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Unlike the similar get_voice_regions_request, this returns VIP regions if the guild is VIP-enabled.

get_guild_voice_regions_response

</> 
pub fn get_guild_voice_regions_response(
  response: response.Response(String),
) -> Result(List(VoiceRegion), RestError)

get_guild_welcome_screen_request

</> 
pub fn get_guild_welcome_screen_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Requires the AllowManagingGuild permission if the welcome screen is disabled.

get_guild_welcome_screen_response

</> 
pub fn get_guild_welcome_screen_response(
  response: response.Response(String),
) -> Result(GuildWelcomeScreen, RestError)

get_guild_widget_request

</> 
pub fn get_guild_widget_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Useful for creating custom website widgets.

get_guild_widget_response

</> 
pub fn get_guild_widget_response(
  response: response.Response(String),
) -> Result(GuildWidget, RestError)

get_guild_widget_settings_request

</> 
pub fn get_guild_widget_settings_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Requires the AllowManagingGuild permission.

get_guild_widget_settings_response

</> 
pub fn get_guild_widget_settings_response(
  response: response.Response(String),
) -> Result(GuildWidgetSettings, RestError)

get_guild_with_counts

</> 
pub fn get_guild_with_counts(
  token token: Token,
  id id: Snowflake(Guild),
) -> request.Request(String)

Returns a guild object along with its approximate member and presence counts.

get_guild_with_counts_response

</> 
pub fn get_guild_with_counts_response(
  response: response.Response(String),
) -> Result(#(Guild, GuildApproximateCounts), RestError)

get_interaction_response_followup_message_request

</> 
pub fn get_interaction_response_followup_message_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  interaction_token interaction_token: InteractionToken,
  message_id message_id: Snowflake(Message),
) -> request.Request(String)

get_interaction_response_followup_message_response

</> 
pub fn get_interaction_response_followup_message_response(
  response: response.Response(String),
) -> Result(Message, RestError)

get_invite_request

</> 
pub fn get_invite_request(
  token token: Token,
  invite_with_code code: String,
) -> request.Request(String)

get_invite_response

</> 
pub fn get_invite_response(
  response: response.Response(String),
) -> Result(Invite, RestError)

get_invite_with_counts_request

</> 
pub fn get_invite_with_counts_request(
  token token: Token,
  invite_with_code code: String,
) -> request.Request(String)

get_invite_with_counts_response

</> 
pub fn get_invite_with_counts_response(
  response: response.Response(String),
) -> Result(#(Invite, GuildApproximateCounts), RestError)

get_message_request

</> 
pub fn get_message_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(Channel),
  message_with_id message_id: Snowflake(Message),
) -> request.Request(String)

Behavior:

  • in DM channels - must be a DM channel between the bot and another user
  • in guild channels - the bot must have the AllowViewingChannels and AllowReadingMessageHistory permissions in that channel
  • in voice channels - in addition to the aforementioned permissions, the bot must also have the AllowConnectingToVoiceChannels permission in that channel

get_message_response

</> 
pub fn get_message_response(
  response: response.Response(String),
) -> Result(Message, RestError)

get_original_interaction_response_request

</> 
pub fn get_original_interaction_response_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  interaction_token interaction_token: InteractionToken,
) -> request.Request(String)

get_original_interaction_response_response

</> 
pub fn get_original_interaction_response_response(
  response: response.Response(String),
) -> Result(Message, RestError)

get_poll_answer_voters_after

</> 
pub fn get_poll_answer_voters_after(
  options: GetPollAnswerVotersOptions,
  id id: Snowflake(User),
) -> GetPollAnswerVotersOptions

get_poll_answer_voters_request

</> 
pub fn get_poll_answer_voters_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  for_message_with_id message_id: Snowflake(Message),
  answer_with_id answer_id: Int,
  using options: GetPollAnswerVotersOptions,
) -> request.Request(String)

Get a list of users who voted for a specific poll answer.

get_poll_answer_voters_response

</> 
pub fn get_poll_answer_voters_response(
  response: response.Response(String),
) -> Result(List(User), RestError)

get_poll_answer_voters_with_limit

</> 
pub fn get_poll_answer_voters_with_limit(
  options: GetPollAnswerVotersOptions,
  limit: Int,
) -> GetPollAnswerVotersOptions

Limit must be between 1 and 100.

get_reacting_users_after

</> 
pub fn get_reacting_users_after(
  options: GetReactingUsersOptions,
  id id: Snowflake(User),
) -> GetReactingUsersOptions

get_reacting_users_request

</> 
pub fn get_reacting_users_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  from_message_with_id message_id: Snowflake(Message),
  emoji emoji: MessageReactionEmoji,
  using options: GetReactingUsersOptions,
) -> request.Request(String)

get_reacting_users_response

</> 
pub fn get_reacting_users_response(
  response: response.Response(String),
) -> Result(List(User), RestError)

get_reacting_users_with_limit

</> 
pub fn get_reacting_users_with_limit(
  options: GetReactingUsersOptions,
  limit: Int,
) -> GetReactingUsersOptions

Limit must be between 1 and 100.

get_role_member_counts_request

</> 
pub fn get_role_member_counts_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

Returns a Dict of (role_id, member_count)

get_role_member_counts_response

</> 
pub fn get_role_member_counts_response(
  response: response.Response(String),
) -> Result(dict.Dict(Snowflake(Role), Int), RestError)

get_role_request

</> 
pub fn get_role_request(
  token token: Token,
  with_id role_id: Snowflake(Role),
  from_guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

get_role_response

</> 
pub fn get_role_response(
  response: response.Response(String),
) -> Result(Role, RestError)

get_scheduled_event_cover_image_request

</> 
pub fn get_scheduled_event_cover_image_request(
  id scheduled_event_id: Snowflake(ScheduledEvent),
  hash cover_hash: ImageHash,
  format format: RequestedScheduledEventCoverFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_sku_subscription_request

</> 
pub fn get_sku_subscription_request(
  token token: Token,
  for_sku_with_id sku_id: Snowflake(Sku),
  subscription_with_id subscription_id: Snowflake(Subscription),
) -> request.Request(String)

get_sku_subscription_response

</> 
pub fn get_sku_subscription_response(
  response: response.Response(String),
) -> Result(Subscription, RestError)

get_sku_subscriptions_after

</> 
pub fn get_sku_subscriptions_after(
  options: GetSkuSubscriptionsOptions,
  subscription_with_id after: Snowflake(Subscription),
) -> GetSkuSubscriptionsOptions

get_sku_subscriptions_before

</> 
pub fn get_sku_subscriptions_before(
  options: GetSkuSubscriptionsOptions,
  subscription_with_id before: Snowflake(Subscription),
) -> GetSkuSubscriptionsOptions

get_sku_subscriptions_request

</> 
pub fn get_sku_subscriptions_request(
  token token: Token,
  for_sku_with_id sku_id: Snowflake(Sku),
  using options: GetSkuSubscriptionsOptions,
) -> request.Request(String)

get_sku_subscriptions_response

</> 
pub fn get_sku_subscriptions_response(
  response: response.Response(String),
) -> Result(List(Subscription), RestError)

get_sku_subscriptions_with_limit

</> 
pub fn get_sku_subscriptions_with_limit(
  options: GetSkuSubscriptionsOptions,
  limit: Int,
) -> GetSkuSubscriptionsOptions

Limit must be between 1 and 100.

get_stage_channel_response

</> 
pub fn get_stage_channel_response(
  response: response.Response(String),
) -> Result(StageInstance, RestError)

get_stage_instance_request

</> 
pub fn get_stage_instance_request(
  token token: Token,
  for_channel_with_id channel_id: Snowflake(StageChannel),
) -> request.Request(String)

Returns the stage instance for the stage channel, if it exists.

get_sticker_image_request

</> 
pub fn get_sticker_image_request(
  id sticker_id: Snowflake(Sticker),
  format format: RequestedStickerFormat,
) -> request.Request(BitArray)

The sticker is only available in the format it was uploaded in.

get_sticker_pack_banner_image_request

</> 
pub fn get_sticker_pack_banner_image_request(
  id sticker_pack_banner_id: Snowflake(StickerPackBanner),
  format format: RequestedStickerPackBannerFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_sticker_pack_request

</> 
pub fn get_sticker_pack_request(
  token token: Token,
  pack_with_id pack_id: Snowflake(StickerPack),
) -> request.Request(String)

get_sticker_pack_response

</> 
pub fn get_sticker_pack_response(
  response: response.Response(String),
) -> Result(StickerPack, RestError)

get_sticker_packs_request

</> 
pub fn get_sticker_packs_request(
  token token: Token,
) -> request.Request(String)

get_sticker_packs_response

</> 
pub fn get_sticker_packs_response(
  response: response.Response(String),
) -> Result(List(StickerPack), RestError)

get_sticker_request

</> 
pub fn get_sticker_request(
  token token: Token,
  sticker_with_id sticker_id: Snowflake(Sticker),
) -> request.Request(String)

get_sticker_response

</> 
pub fn get_sticker_response(
  response: response.Response(String),
) -> Result(Sticker, RestError)

get_thread_member_request

</> 
pub fn get_thread_member_request(
  token token: Token,
  thread_with_id thread_id: Snowflake(Thread),
  member_with_id member_id: Snowflake(User),
) -> request.Request(String)

get_thread_member_response

</> 
pub fn get_thread_member_response(
  response: response.Response(String),
) -> Result(ThreadMember, RestError)

get_thread_member_with_guild_member_request

</> 
pub fn get_thread_member_with_guild_member_request(
  token token: Token,
  thread_with_id thread_id: Snowflake(Thread),
  member_with_id member_id: Snowflake(User),
) -> request.Request(String)

get_thread_member_with_guild_member_response

</> 
pub fn get_thread_member_with_guild_member_response(
  response: response.Response(String),
) -> Result(#(ThreadMember, GuildMember), RestError)

get_thread_members_request

</> 
pub fn get_thread_members_request(
  token token: Token,
  thread_with_id thread_id: Snowflake(Thread),
) -> request.Request(String)

Requires that your app has the GUILD_MEMBERS priviledged intent enabled.

get_thread_members_response

</> 
pub fn get_thread_members_response(
  response: response.Response(String),
) -> Result(List(ThreadMember), RestError)

get_url_to_attachment

</> 
pub fn get_url_to_attachment(named filename: String) -> String

Include the extension in the file name.

get_user_avatar_image_request

</> 
pub fn get_user_avatar_image_request(
  id user_id: Snowflake(User),
  hash avatar_hash: ImageHash,
  format format: RequestedUserAvatarFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_user_banner_image_request

</> 
pub fn get_user_banner_image_request(
  id user_id: Snowflake(User),
  hash banner_hash: ImageHash,
  format format: RequestedUserBannerFormat,
  size size: RequestedImageSize,
) -> request.Request(BitArray)

get_user_default_avatar_image_request

</> 
pub fn get_user_default_avatar_image_request(
  index index: Int,
) -> request.Request(BitArray)

Use the get_user_index function to get the index.

Returns the default avatar of the user (the one with the Discord logo) in PNG format, with constant size.

get_user_index

</> 
pub fn get_user_index(of user: User) -> Result(Int, Nil)

Used to get the default user avatar.

If it returns an error - you got lucky - the user still has a discriminator and it somehow isn’t an integer.

get_user_request

</> 
pub fn get_user_request(
  token token: Token,
  id id: Snowflake(User),
) -> request.Request(String)

get_user_response

</> 
pub fn get_user_response(
  response: response.Response(String),
) -> Result(User, RestError)

get_user_voice_state_request

</> 
pub fn get_user_voice_state_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  for_user_with_id user_id: Snowflake(User),
) -> request.Request(String)

If the user is connected to a voice channel, requires the AllowConnectingToVoiceChannels permission in that channel.

get_user_voice_state_response

</> 
pub fn get_user_voice_state_response(
  response: response.Response(String),
) -> Result(VoiceState, RestError)

get_voice_regions_request

</> 
pub fn get_voice_regions_request(
  token token: Token,
) -> request.Request(String)

get_voice_regions_response

</> 
pub fn get_voice_regions_response(
  response: response.Response(String),
) -> Result(List(VoiceRegion), RestError)

guild_approximate_counts_decoder

</> 
pub fn guild_approximate_counts_decoder() -> decode.Decoder(
  GuildApproximateCounts,
)

guild_ban_decoder

</> 
pub fn guild_ban_decoder() -> decode.Decoder(GuildBan)

guild_channel_decoder

</> 
pub fn guild_channel_decoder() -> decode.Decoder(GuildChannel)

guild_decoder

</> 
pub fn guild_decoder() -> decode.Decoder(Guild)

guild_default_message_notification_setting_decoder

</> 
pub fn guild_default_message_notification_setting_decoder() -> decode.Decoder(
  GuildDefaultMessageNotificationSetting,
)

guild_default_message_notification_setting_to_json

</> 
pub fn guild_default_message_notification_setting_to_json(
  setting: GuildDefaultMessageNotificationSetting,
) -> json.Json

guild_discord_bot_integration_decoder

</> 
pub fn guild_discord_bot_integration_decoder() -> decode.Decoder(
  GuildDiscordBotIntegration,
)

guild_explicit_content_filter_setting_decoder

</> 
pub fn guild_explicit_content_filter_setting_decoder() -> decode.Decoder(
  GuildExplicitContentFilterSetting,
)

guild_explicit_content_filter_setting_to_json

</> 
pub fn guild_explicit_content_filter_setting_to_json(
  setting: GuildExplicitContentFilterSetting,
) -> json.Json

guild_feature_to_json

</> 
pub fn guild_feature_to_json(feature: GuildFeature) -> json.Json

guild_features_decoder

</> 
pub fn guild_features_decoder() -> decode.Decoder(
  List(GuildFeature),
)

guild_incidents_data_decoder

</> 
pub fn guild_incidents_data_decoder() -> decode.Decoder(
  GuildIncidentsData,
)

guild_integration_account_decoder

</> 
pub fn guild_integration_account_decoder() -> decode.Decoder(
  GuildIntegrationAccount,
)

guild_integration_application_decoder

</> 
pub fn guild_integration_application_decoder() -> decode.Decoder(
  GuildIntegrationApplication,
)

guild_integration_data_decoder

</> 
pub fn guild_integration_data_decoder() -> decode.Decoder(
  GuildIntegrationData,
)

guild_integration_decoder

</> 
pub fn guild_integration_decoder() -> decode.Decoder(
  GuildIntegration,
)

guild_member_decoder

</> 
pub fn guild_member_decoder() -> decode.Decoder(GuildMember)

guild_member_verification_level_decoder

</> 
pub fn guild_member_verification_level_decoder() -> decode.Decoder(
  GuildMemberVerificationLevel,
)

guild_member_verification_level_to_json

</> 
pub fn guild_member_verification_level_to_json(
  level: GuildMemberVerificationLevel,
) -> json.Json

guild_nsfw_level_decoder

</> 
pub fn guild_nsfw_level_decoder() -> decode.Decoder(
  GuildNsfwLevel,
)

guild_onboarding_decoder

</> 
pub fn guild_onboarding_decoder() -> decode.Decoder(
  GuildOnboarding,
)

guild_onboarding_mode_decoder

</> 
pub fn guild_onboarding_mode_decoder() -> decode.Decoder(
  GuildOnboardingMode,
)

guild_onboarding_prompt_decoder

</> 
pub fn guild_onboarding_prompt_decoder() -> decode.Decoder(
  GuildOnboardingPrompt,
)

guild_onboarding_prompt_option_decoder

</> 
pub fn guild_onboarding_prompt_option_decoder() -> decode.Decoder(
  GuildOnboardingPromptOption,
)

guild_onboarding_prompt_type_decoder

</> 
pub fn guild_onboarding_prompt_type_decoder() -> decode.Decoder(
  GuildOnboardingPromptType,
)

guild_premium_tier_decoder

</> 
pub fn guild_premium_tier_decoder() -> decode.Decoder(
  GuildPremiumTier,
)

guild_preview_decoder

</> 
pub fn guild_preview_decoder() -> decode.Decoder(GuildPreview)

guild_required_mfa_level_decoder

</> 
pub fn guild_required_mfa_level_decoder() -> decode.Decoder(
  GuildRequiredMfaLevel,
)

guild_social_integration_data_decoder

</> 
pub fn guild_social_integration_data_decoder() -> decode.Decoder(
  GuildSocialIntegrationData,
)

guild_social_integration_decoder

</> 
pub fn guild_social_integration_decoder() -> decode.Decoder(
  GuildSocialIntegration,
)

guild_social_integration_subscription_expiration_behavior_decoder

</> 
pub fn guild_social_integration_subscription_expiration_behavior_decoder() -> decode.Decoder(
  GuildSocialIntegrationSubscriptionExpirationBehavior,
)

guild_sticker_decoder

</> 
pub fn guild_sticker_decoder() -> decode.Decoder(GuildSticker)

guild_vanity_invite_decoder

</> 
pub fn guild_vanity_invite_decoder() -> decode.Decoder(
  option.Option(GuildVanityInvite),
)

guild_welcome_screen_channel_decoder

</> 
pub fn guild_welcome_screen_channel_decoder() -> decode.Decoder(
  GuildWelcomeScreenChannel,
)

guild_welcome_screen_channel_to_json

</> 
pub fn guild_welcome_screen_channel_to_json(
  channel: GuildWelcomeScreenChannel,
) -> json.Json

guild_welcome_screen_channel_with_emoji

</> 
pub fn guild_welcome_screen_channel_with_emoji(
  channel: GuildWelcomeScreenChannel,
  emoji: GuildWelcomeScreenChannelEmoji,
) -> GuildWelcomeScreenChannel

guild_welcome_screen_decoder

</> 
pub fn guild_welcome_screen_decoder() -> decode.Decoder(
  GuildWelcomeScreen,
)

guild_widget_channel_decoder

</> 
pub fn guild_widget_channel_decoder() -> decode.Decoder(
  GuildWidgetChannel,
)

guild_widget_decoder

</> 
pub fn guild_widget_decoder() -> decode.Decoder(GuildWidget)

guild_widget_settings_decoder

</> 
pub fn guild_widget_settings_decoder() -> decode.Decoder(
  GuildWidgetSettings,
)

guild_widget_user_decoder

</> 
pub fn guild_widget_user_decoder() -> decode.Decoder(
  GuildWidgetUser,
)

hoist_role

</> 
pub fn hoist_role(modify: ModifyRole) -> ModifyRole

Makes the role separate from others in the sidebar.

image_data_from_bit_array

</> 
pub fn image_data_from_bit_array(
  image data: BitArray,
  content_type content_type: ImageDataContentType,
) -> ImageData

image_data_to_json

</> 
pub fn image_data_to_json(image_data: ImageData) -> json.Json

image_hash_decoder

</> 
pub fn image_hash_decoder() -> decode.Decoder(ImageHash)

image_hash_to_string

</> 
pub fn image_hash_to_string(image_hash: ImageHash) -> String

Returns the image hash in string form.

image_message_attachment_decoder

</> 
pub fn image_message_attachment_decoder() -> decode.Decoder(
  ImageMessageAttachment,
)

int_slash_command_option_choice_decoder

</> 
pub fn int_slash_command_option_choice_decoder() -> decode.Decoder(
  IntSlashCommandOptionChoice,
)

int_slash_command_option_choice_to_json

</> 
pub fn int_slash_command_option_choice_to_json(
  choice: IntSlashCommandOptionChoice,
) -> json.Json

int_slash_command_option_decoder

</> 
pub fn int_slash_command_option_decoder() -> decode.Decoder(
  IntSlashCommandOption,
)

int_slash_command_option_to_json

</> 
pub fn int_slash_command_option_to_json(
  option: IntSlashCommandOption,
) -> json.Json

interaction_authorizing_installers_decoder

</> 
pub fn interaction_authorizing_installers_decoder() -> decode.Decoder(
  InteractionAuthorizingInstallers,
)

interaction_context_decoder

</> 
pub fn interaction_context_decoder() -> decode.Decoder(
  InteractionContext,
)

interaction_decoder

</> 
pub fn interaction_decoder() -> decode.Decoder(Interaction)

interaction_invokement_data_decoder

</> 
pub fn interaction_invokement_data_decoder() -> decode.Decoder(
  InteractionInvokementData,
)

interaction_resolved_objects_decoder

</> 
pub fn interaction_resolved_objects_decoder() -> decode.Decoder(
  InteractionResolvedObjects,
)

interaction_response_message_to_json

</> 
pub fn interaction_response_message_to_json(
  message: InteractionResponseMessage,
) -> json.Json

interaction_response_modal_to_json

</> 
pub fn interaction_response_modal_to_json(
  modal: InteractionResponseModal,
) -> json.Json

interaction_token_decoder

</> 
pub fn interaction_token_decoder() -> decode.Decoder(
  InteractionToken,
)

invite_decoder

</> 
pub fn invite_decoder() -> decode.Decoder(Invite)

invite_metadata_decoder

</> 
pub fn invite_metadata_decoder() -> decode.Decoder(
  option.Option(InviteMetadata),
)

invite_role_decoder

</> 
pub fn invite_role_decoder() -> decode.Decoder(InviteRole)

invite_target_decoder

</> 
pub fn invite_target_decoder() -> decode.Decoder(
  option.Option(InviteTarget),
)

invite_target_to_json

</> 
pub fn invite_target_to_json(
  target: InviteTarget,
) -> List(Result(#(String, json.Json), Nil))

join_thread_request

</> 
pub fn join_thread_request(
  token token: Token,
  thread_with_id id: Snowflake(Thread),
) -> request.Request(String)

The thread mustn’t be archived.

join_thread_response

</> 
pub fn join_thread_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

kick_guild_member_request

</> 
pub fn kick_guild_member_request(
  token token: Token,
  with_id user_id: Snowflake(User),
  from_guild_with_id guild_id: Snowflake(Guild),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowKickingMembers permission

kick_guild_member_response

</> 
pub fn kick_guild_member_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

leave_guild_request

</> 
pub fn leave_guild_request(
  token token: Token,
  guild_with_id guild_id: Snowflake(Guild),
) -> request.Request(String)

leave_guild_response

</> 
pub fn leave_guild_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

leave_thread_request

</> 
pub fn leave_thread_request(
  token token: Token,
  thread_with_id id: Snowflake(Thread),
) -> request.Request(String)

The thread mustn’t be archived.

leave_thread_response

</> 
pub fn leave_thread_response(
  response: response.Response(String),
) -> Result(Nil, RestError)
</> 
pub fn link_button_decoder() -> decode.Decoder(LinkButton)

locale_decoder

</> 
pub fn locale_decoder() -> decode.Decoder(Locale)

locale_to_json

</> 
pub fn locale_to_json(locale: Locale) -> json.Json

locale_to_string

</> 
pub fn locale_to_string(locale: Locale) -> String

lock_thread

</> 
pub fn lock_thread(modify: ModifyThread) -> ModifyThread

When a thread is locked, only users with the AllowManagingThreads permission can unarchive it.

media_channel_decoder

</> 
pub fn media_channel_decoder() -> decode.Decoder(MediaChannel)
</> 
pub fn media_gallery_item_decoder() -> decode.Decoder(
  MediaGalleryItem,
)

mentionable_slash_command_option_decoder

</> 
pub fn mentionable_slash_command_option_decoder() -> decode.Decoder(
  MentionableSlashCommandOption,
)

mentionable_slash_command_option_to_json

</> 
pub fn mentionable_slash_command_option_to_json(
  option: MentionableSlashCommandOption,
) -> json.Json

message_action_row_decoder

</> 
pub fn message_action_row_decoder() -> decode.Decoder(
  MessageActionRow,
)

message_attachment_data_decoder

</> 
pub fn message_attachment_data_decoder() -> decode.Decoder(
  option.Option(MessageAttachmentData),
)

message_attachment_decoder

</> 
pub fn message_attachment_decoder() -> decode.Decoder(
  MessageAttachment,
)

message_button_decoder

</> 
pub fn message_button_decoder() -> decode.Decoder(MessageButton)

message_call_decoder

</> 
pub fn message_call_decoder() -> decode.Decoder(MessageCall)

message_channel_select_decoder

</> 
pub fn message_channel_select_decoder() -> decode.Decoder(
  MessageChannelSelect,
)

message_command_decoder

</> 
pub fn message_command_decoder() -> decode.Decoder(MessageCommand)

message_component_decoder

</> 
pub fn message_component_decoder() -> decode.Decoder(
  MessageComponent,
)

message_component_interaction_decoder

</> 
pub fn message_component_interaction_decoder() -> decode.Decoder(
  MessageComponentInteraction,
)

message_component_interaction_response_to_json

</> 
pub fn message_component_interaction_response_to_json(
  response: MessageComponentInteractionResponse,
) -> json.Json

message_component_interaction_token_decoder

</> 
pub fn message_component_interaction_token_decoder() -> decode.Decoder(
  MessageComponentInteractionToken,
)

message_container_decoder

</> 
pub fn message_container_decoder() -> decode.Decoder(
  MessageContainer,
)

message_decoder

</> 
pub fn message_decoder() -> decode.Decoder(Message)

message_embed_decoder

</> 
pub fn message_embed_decoder() -> decode.Decoder(MessageEmbed)

message_file_decoder

</> 
pub fn message_file_decoder() -> decode.Decoder(MessageFile)

message_interaction_metadata_decoder

</> 
pub fn message_interaction_metadata_decoder() -> decode.Decoder(
  MessageInteractionMetadata,
)
</> 
pub fn message_media_gallery_decoder() -> decode.Decoder(
  MessageMediaGallery,
)

message_mentionable_select_decoder

</> 
pub fn message_mentionable_select_decoder() -> decode.Decoder(
  MessageMentionableSelect,
)

message_nonce_decoder

</> 
pub fn message_nonce_decoder() -> decode.Decoder(MessageNonce)

message_nonce_to_json

</> 
pub fn message_nonce_to_json(nonce: MessageNonce) -> json.Json

message_pin_decoder

</> 
pub fn message_pin_decoder() -> decode.Decoder(MessagePin)

message_reaction_decoder

</> 
pub fn message_reaction_decoder() -> decode.Decoder(
  MessageReaction,
)

message_reference_decoder

</> 
pub fn message_reference_decoder() -> decode.Decoder(
  MessageReference,
)

message_reference_type_decoder

</> 
pub fn message_reference_type_decoder() -> decode.Decoder(
  MessageReferenceType,
)

message_reference_type_to_json

</> 
pub fn message_reference_type_to_json(
  type_: MessageReferenceType,
) -> json.Json

message_role_select_decoder

</> 
pub fn message_role_select_decoder() -> decode.Decoder(
  MessageRoleSelect,
)

message_section_decoder

</> 
pub fn message_section_decoder() -> decode.Decoder(MessageSection)

message_separator_decoder

</> 
pub fn message_separator_decoder() -> decode.Decoder(
  MessageSeparator,
)

message_snapshot_decoder

</> 
pub fn message_snapshot_decoder() -> decode.Decoder(
  MessageSnapshot,
)

message_string_select_decoder

</> 
pub fn message_string_select_decoder() -> decode.Decoder(
  MessageStringSelect,
)

message_text_display_decoder

</> 
pub fn message_text_display_decoder() -> decode.Decoder(
  MessageTextDisplay,
)

message_thumbnail_decoder

</> 
pub fn message_thumbnail_decoder() -> decode.Decoder(
  MessageThumbnail,
)

message_type_decoder

</> 
pub fn message_type_decoder() -> decode.Decoder(MessageType)

message_user_select_decoder

</> 
pub fn message_user_select_decoder() -> decode.Decoder(
  MessageUserSelect,
)
</> 
pub fn modal_interaction_decoder() -> decode.Decoder(
  ModalInteraction,
)
</> 
pub fn modal_interaction_response_to_json(
  response: ModalInteractionResponse,
) -> json.Json
</> 
pub fn modal_interaction_token_decoder() -> decode.Decoder(
  ModalInteractionToken,
)

modify_announcement_channel_default_thread_auto_archive_duration

</> 
pub fn modify_announcement_channel_default_thread_auto_archive_duration(
  modify: ModifyAnnouncementChannel,
  new duration: ThreadAutoArchiveDuration,
) -> ModifyAnnouncementChannel

modify_announcement_channel_name

</> 
pub fn modify_announcement_channel_name(
  modify: ModifyAnnouncementChannel,
  new name: String,
) -> ModifyAnnouncementChannel

modify_announcement_channel_parent_id

</> 
pub fn modify_announcement_channel_parent_id(
  modify: ModifyAnnouncementChannel,
  new parent_id: Snowflake(CategoryChannel),
) -> ModifyAnnouncementChannel

modify_announcement_channel_permission_overwrites

</> 
pub fn modify_announcement_channel_permission_overwrites(
  modify: ModifyAnnouncementChannel,
  new overwrites: List(PermissionOverwrite),
) -> ModifyAnnouncementChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

modify_announcement_channel_position

</> 
pub fn modify_announcement_channel_position(
  modify: ModifyAnnouncementChannel,
  new position: Int,
) -> ModifyAnnouncementChannel

Channels with the same position are sorted by ID (newer channel will be lower)

modify_announcement_channel_request

</> 
pub fn modify_announcement_channel_request(
  token token: Token,
  channel_with_id id: Snowflake(AnnouncementChannel),
  using modify: ModifyAnnouncementChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

modify_announcement_channel_response

</> 
pub fn modify_announcement_channel_response(
  response: response.Response(String),
) -> Result(AnnouncementChannel, RestError)

Use modify_announcement_channel_with_conversion_response if you converted the announcement channel into a text channel.

modify_announcement_channel_to_json

</> 
pub fn modify_announcement_channel_to_json(
  modify: ModifyAnnouncementChannel,
) -> json.Json

modify_announcement_channel_topic

</> 
pub fn modify_announcement_channel_topic(
  modify: ModifyAnnouncementChannel,
  new topic: String,
) -> ModifyAnnouncementChannel

modify_announcement_channel_with_conversion_response

</> 
pub fn modify_announcement_channel_with_conversion_response(
  response: response.Response(String),
) -> Result(TextChannel, RestError)

Use this if you converted the announcement channel to a text channel.

modify_category_channel_name

</> 
pub fn modify_category_channel_name(
  modify: ModifyCategoryChannel,
  new name: String,
) -> ModifyCategoryChannel

modify_category_channel_permission_overwrites

</> 
pub fn modify_category_channel_permission_overwrites(
  modify: ModifyCategoryChannel,
  new overwrites: List(PermissionOverwrite),
) -> ModifyCategoryChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

modify_category_channel_position

</> 
pub fn modify_category_channel_position(
  modify: ModifyCategoryChannel,
  new position: Int,
) -> ModifyCategoryChannel

Channels with the same position are sorted by ID (newer channel will be lower)

modify_category_channel_request

</> 
pub fn modify_category_channel_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(CategoryChannel),
  using modify: ModifyCategoryChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

modify_category_channel_response

</> 
pub fn modify_category_channel_response(
  response: response.Response(String),
) -> Result(CategoryChannel, RestError)

modify_category_channel_to_json

</> 
pub fn modify_category_channel_to_json(
  modify: ModifyCategoryChannel,
) -> json.Json

modify_current_application_cover_image

</> 
pub fn modify_current_application_cover_image(
  modify: ModifyCurrentApplication,
  new cover_image: ImageData,
) -> ModifyCurrentApplication

modify_current_application_custom_installation_url

</> 
pub fn modify_current_application_custom_installation_url(
  modify: ModifyCurrentApplication,
  new url: String,
) -> ModifyCurrentApplication

modify_current_application_description

</> 
pub fn modify_current_application_description(
  modify: ModifyCurrentApplication,
  new description: String,
) -> ModifyCurrentApplication

modify_current_application_flags

</> 
pub fn modify_current_application_flags(
  modify: ModifyCurrentApplication,
  old old: List(ApplicationFlag),
  new_added new_added: List(ModifyCurrentApplicationFlag),
  new_removed new_removed: List(ModifyCurrentApplicationFlag),
) -> ModifyCurrentApplication

You need the message’s present (old) flags to modify them.

Removal takes prescedence over addition.

Trying to add an already present flag or remove an already absent one is a no-op.

modify_current_application_guild_installation_settings

</> 
pub fn modify_current_application_guild_installation_settings(
  modify: ModifyCurrentApplication,
  new settings: ApplicationInstallationSettings,
) -> ModifyCurrentApplication

modify_current_application_icon

</> 
pub fn modify_current_application_icon(
  modify: ModifyCurrentApplication,
  new icon: ImageData,
) -> ModifyCurrentApplication

modify_current_application_in_app_installation_settings

</> 
pub fn modify_current_application_in_app_installation_settings(
  modify: ModifyCurrentApplication,
  new settings: ApplicationInstallationSettings,
) -> ModifyCurrentApplication

modify_current_application_interactions_endpoint_url

</> 
pub fn modify_current_application_interactions_endpoint_url(
  modify: ModifyCurrentApplication,
  new url: String,
) -> ModifyCurrentApplication

modify_current_application_request

</> 
pub fn modify_current_application_request(
  token token: Token,
  using modify: ModifyCurrentApplication,
) -> request.Request(String)

modify_current_application_response

</> 
pub fn modify_current_application_response(
  response: response.Response(String),
) -> Result(Application, RestError)

modify_current_application_role_connections_verification_url

</> 
pub fn modify_current_application_role_connections_verification_url(
  modify: ModifyCurrentApplication,
  new url: String,
) -> ModifyCurrentApplication

modify_current_application_tags

</> 
pub fn modify_current_application_tags(
  modify: ModifyCurrentApplication,
  new tags: List(String),
) -> ModifyCurrentApplication

modify_current_application_to_json

</> 
pub fn modify_current_application_to_json(
  modify: ModifyCurrentApplication,
) -> json.Json

modify_current_application_user_installation_settings

</> 
pub fn modify_current_application_user_installation_settings(
  modify: ModifyCurrentApplication,
  new settings: ApplicationInstallationSettings,
) -> ModifyCurrentApplication

modify_current_application_webhook_events_types

</> 
pub fn modify_current_application_webhook_events_types(
  modify: ModifyCurrentApplication,
  new types: List(String),
) -> ModifyCurrentApplication

modify_current_application_webhook_events_url

</> 
pub fn modify_current_application_webhook_events_url(
  modify: ModifyCurrentApplication,
  new url: String,
) -> ModifyCurrentApplication

modify_current_guild_member_avatar

</> 
pub fn modify_current_guild_member_avatar(
  modify: ModifyCurrentGuildMember,
  new avatar: ImageData,
) -> ModifyCurrentGuildMember

Modifies your per-guild avatar.

modify_current_guild_member_banner

</> 
pub fn modify_current_guild_member_banner(
  modify: ModifyCurrentGuildMember,
  new banner: ImageData,
) -> ModifyCurrentGuildMember

Modifies your per-guild banner.

modify_current_guild_member_bio

</> 
pub fn modify_current_guild_member_bio(
  modify: ModifyCurrentGuildMember,
  new bio: String,
) -> ModifyCurrentGuildMember

Modifies your per-guild bio.

modify_current_guild_member_nick

</> 
pub fn modify_current_guild_member_nick(
  modify: ModifyCurrentGuildMember,
  new nick: String,
) -> ModifyCurrentGuildMember

Requires the AllowChangingOwnNickname permission.

modify_current_guild_member_request

</> 
pub fn modify_current_guild_member_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using modify: ModifyCurrentGuildMember,
  reason reason: option.Option(String),
) -> request.Request(String)

modify_current_guild_member_response

</> 
pub fn modify_current_guild_member_response(
  response: response.Response(String),
) -> Result(GuildMember, RestError)

modify_current_guild_member_to_json

</> 
pub fn modify_current_guild_member_to_json(
  modify: ModifyCurrentGuildMember,
) -> json.Json

modify_current_user_avatar

</> 
pub fn modify_current_user_avatar(
  modify: ModifyCurrentUser,
  new avatar: ImageData,
) -> ModifyCurrentUser

modify_current_user_banner

</> 
pub fn modify_current_user_banner(
  modify: ModifyCurrentUser,
  new banner: ImageData,
) -> ModifyCurrentUser

modify_current_user_request

</> 
pub fn modify_current_user_request(
  token token: Token,
  using modify: ModifyCurrentUser,
) -> request.Request(String)

modify_current_user_response

</> 
pub fn modify_current_user_response(
  response: response.Response(String),
) -> Result(User, RestError)

modify_current_user_to_json

</> 
pub fn modify_current_user_to_json(
  modify: ModifyCurrentUser,
) -> json.Json

modify_current_user_username

</> 
pub fn modify_current_user_username(
  modify: ModifyCurrentUser,
  new username: String,
) -> ModifyCurrentUser

May cause the discriminator to randomize if changed (mostly applies to bots).

modify_forum_channel_available_tags

</> 
pub fn modify_forum_channel_available_tags(
  modify: ModifyForumChannel,
  new tags: List(ForumTag),
) -> ModifyForumChannel

modify_forum_channel_default_layout

</> 
pub fn modify_forum_channel_default_layout(
  modify: ModifyForumChannel,
  new layout: ForumLayout,
) -> ModifyForumChannel

modify_forum_channel_default_reaction

</> 
pub fn modify_forum_channel_default_reaction(
  modify: ModifyForumChannel,
  new reaction: DefaultForumReaction,
) -> ModifyForumChannel

modify_forum_channel_default_sort_order

</> 
pub fn modify_forum_channel_default_sort_order(
  modify: ModifyForumChannel,
  new order: ForumSortOrder,
) -> ModifyForumChannel

modify_forum_channel_default_thread_auto_archive_duration

</> 
pub fn modify_forum_channel_default_thread_auto_archive_duration(
  modify: ModifyForumChannel,
  new duration: ThreadAutoArchiveDuration,
) -> ModifyForumChannel

modify_forum_channel_default_thread_rate_limit_per_user

</> 
pub fn modify_forum_channel_default_thread_rate_limit_per_user(
  modify: ModifyForumChannel,
  new limit: RateLimitPerUser,
) -> ModifyForumChannel

modify_forum_channel_flags

</> 
pub fn modify_forum_channel_flags(
  modify: ModifyForumChannel,
  new flags: List(ForumChannelFlag),
) -> ModifyForumChannel

modify_forum_channel_name

</> 
pub fn modify_forum_channel_name(
  modify: ModifyForumChannel,
  new name: String,
) -> ModifyForumChannel

modify_forum_channel_parent_id

</> 
pub fn modify_forum_channel_parent_id(
  modify: ModifyForumChannel,
  new id: Snowflake(CategoryChannel),
) -> ModifyForumChannel

modify_forum_channel_permission_overwrites

</> 
pub fn modify_forum_channel_permission_overwrites(
  modify: ModifyForumChannel,
  new overwrites: List(PermissionOverwrite),
) -> ModifyForumChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

modify_forum_channel_position

</> 
pub fn modify_forum_channel_position(
  modify: ModifyForumChannel,
  new position: Int,
) -> ModifyForumChannel

modify_forum_channel_rate_limit_per_user

</> 
pub fn modify_forum_channel_rate_limit_per_user(
  modify: ModifyForumChannel,
  new limit: RateLimitPerUser,
) -> ModifyForumChannel

modify_forum_channel_request

</> 
pub fn modify_forum_channel_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(ForumChannel),
  using modify: ModifyForumChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

modify_forum_channel_response

</> 
pub fn modify_forum_channel_response(
  response: response.Response(String),
) -> Result(ForumChannel, RestError)

modify_forum_channel_to_json

</> 
pub fn modify_forum_channel_to_json(
  modify: ModifyForumChannel,
) -> json.Json

modify_forum_channel_topic

</> 
pub fn modify_forum_channel_topic(
  modify: ModifyForumChannel,
  new topic: String,
) -> ModifyForumChannel

modify_global_message_command

</> 
pub fn modify_global_message_command() -> ModifyGlobalMessageCommand

modify_global_message_command_allowed_contexts

</> 
pub fn modify_global_message_command_allowed_contexts(
  modify: ModifyGlobalMessageCommand,
  contexts: List(CommandContext),
) -> ModifyGlobalMessageCommand

modify_global_message_command_allowed_installation_types

</> 
pub fn modify_global_message_command_allowed_installation_types(
  modify: ModifyGlobalMessageCommand,
  new types: List(CommandInstallationType),
) -> ModifyGlobalMessageCommand

modify_global_message_command_name

</> 
pub fn modify_global_message_command_name(
  modify: ModifyGlobalMessageCommand,
  new name: String,
) -> ModifyGlobalMessageCommand

Name must be between 1 and 32 characters.

modify_global_message_command_name_localizations

</> 
pub fn modify_global_message_command_name_localizations(
  modify: ModifyGlobalMessageCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGlobalMessageCommand

Name must be between 1 and 32 characters.

modify_global_message_command_request

</> 
pub fn modify_global_message_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  command_with_id command_id: Snowflake(MessageCommand),
  using modify: ModifyGlobalMessageCommand,
) -> request.Request(String)

modify_global_message_command_required_permissions

</> 
pub fn modify_global_message_command_required_permissions(
  modify: ModifyGlobalMessageCommand,
  new permissions: List(Permission),
) -> ModifyGlobalMessageCommand

Use delete_global_message_command_required_permissions to enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

modify_global_message_command_response

</> 
pub fn modify_global_message_command_response(
  response: response.Response(String),
) -> Result(MessageCommand, RestError)

modify_global_message_command_to_json

</> 
pub fn modify_global_message_command_to_json(
  modify: ModifyGlobalMessageCommand,
) -> json.Json

modify_global_slash_command

</> 
pub fn modify_global_slash_command() -> ModifyGlobalSlashCommand

modify_global_slash_command_allowed_contexts

</> 
pub fn modify_global_slash_command_allowed_contexts(
  modify: ModifyGlobalSlashCommand,
  contexts: List(CommandContext),
) -> ModifyGlobalSlashCommand

modify_global_slash_command_allowed_installation_types

</> 
pub fn modify_global_slash_command_allowed_installation_types(
  modify: ModifyGlobalSlashCommand,
  new types: List(CommandInstallationType),
) -> ModifyGlobalSlashCommand

modify_global_slash_command_description

</> 
pub fn modify_global_slash_command_description(
  modify: ModifyGlobalSlashCommand,
  new description: String,
) -> ModifyGlobalSlashCommand

Description must be between 1 and 100 characters.

modify_global_slash_command_description_localizations

</> 
pub fn modify_global_slash_command_description_localizations(
  modify: ModifyGlobalSlashCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGlobalSlashCommand

Description must be between 1 and 100 characters.

modify_global_slash_command_name

</> 
pub fn modify_global_slash_command_name(
  modify: ModifyGlobalSlashCommand,
  new name: String,
) -> ModifyGlobalSlashCommand

Name must be between 1 and 32 characters.

modify_global_slash_command_name_localizations

</> 
pub fn modify_global_slash_command_name_localizations(
  modify: ModifyGlobalSlashCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGlobalSlashCommand

Name must be between 1 and 32 characters.

modify_global_slash_command_options

</> 
pub fn modify_global_slash_command_options(
  modify: ModifyGlobalSlashCommand,
  new options: List(SlashCommandOption),
) -> ModifyGlobalSlashCommand

There is a limit of 25 options per command.

modify_global_slash_command_request

</> 
pub fn modify_global_slash_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  command_with_id command_id: Snowflake(SlashCommand),
  using modify: ModifyGlobalSlashCommand,
) -> request.Request(String)

modify_global_slash_command_required_permissions

</> 
pub fn modify_global_slash_command_required_permissions(
  modify: ModifyGlobalSlashCommand,
  new permissions: List(Permission),
) -> ModifyGlobalSlashCommand

Use delete_global_slash_command_required_permissions to enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

modify_global_slash_command_response

</> 
pub fn modify_global_slash_command_response(
  response: response.Response(String),
) -> Result(SlashCommand, RestError)

modify_global_slash_command_to_json

</> 
pub fn modify_global_slash_command_to_json(
  modify: ModifyGlobalSlashCommand,
) -> json.Json

modify_global_user_command

</> 
pub fn modify_global_user_command() -> ModifyGlobalUserCommand

modify_global_user_command_allowed_contexts

</> 
pub fn modify_global_user_command_allowed_contexts(
  modify: ModifyGlobalUserCommand,
  contexts: List(CommandContext),
) -> ModifyGlobalUserCommand

modify_global_user_command_allowed_installation_types

</> 
pub fn modify_global_user_command_allowed_installation_types(
  modify: ModifyGlobalUserCommand,
  new types: List(CommandInstallationType),
) -> ModifyGlobalUserCommand

modify_global_user_command_name

</> 
pub fn modify_global_user_command_name(
  modify: ModifyGlobalUserCommand,
  new name: String,
) -> ModifyGlobalUserCommand

Name must be between 1 and 32 characters.

modify_global_user_command_name_localizations

</> 
pub fn modify_global_user_command_name_localizations(
  modify: ModifyGlobalUserCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGlobalUserCommand

Name must be between 1 and 32 characters.

modify_global_user_command_request

</> 
pub fn modify_global_user_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  command_with_id command_id: Snowflake(UserCommand),
  using modify: ModifyGlobalUserCommand,
) -> request.Request(String)

modify_global_user_command_required_permissions

</> 
pub fn modify_global_user_command_required_permissions(
  modify: ModifyGlobalUserCommand,
  new permissions: List(Permission),
) -> ModifyGlobalUserCommand

Use delete_global_user_command_required_permissions to enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

modify_global_user_command_response

</> 
pub fn modify_global_user_command_response(
  response: response.Response(String),
) -> Result(UserCommand, RestError)

modify_global_user_command_to_json

</> 
pub fn modify_global_user_command_to_json(
  modify: ModifyGlobalUserCommand,
) -> json.Json

modify_guild_afk_channel

</> 
pub fn modify_guild_afk_channel(
  modify: ModifyGuild,
  new_id id: Snowflake(Channel),
) -> ModifyGuild

modify_guild_afk_timeout

</> 
pub fn modify_guild_afk_timeout(
  modify: ModifyGuild,
  new timeout: AfkTimeout,
) -> ModifyGuild

modify_guild_banner

</> 
pub fn modify_guild_banner(
  modify: ModifyGuild,
  new banner: ImageData,
) -> ModifyGuild

If not animated, the banner must be a PNG/JPEG image with a 16:9 aspect ratio.

If animated, the banner must be a GIF image with a 16:9 aspect ratio and the guild must have the GuildCanUseAnimatedBanner feature.

In all cases, the guild must have the GuildCanUseBanner feature.

modify_guild_channel_parent_id

</> 
pub fn modify_guild_channel_parent_id(
  modify: ModifyGuildChannelPosition,
  new parent_id: Snowflake(CategoryChannel),
  sync_permissions sync_permissions: Bool,
) -> ModifyGuildChannelPosition

sync_permissions - whether to sync the permission overwrites with the new parent.

modify_guild_channel_position

</> 
pub fn modify_guild_channel_position(
  modify: ModifyGuildChannelPosition,
  new position: Int,
) -> ModifyGuildChannelPosition

Channels with the same position are sorted by ID (newer channel will be lower)

modify_guild_channel_position_to_json

</> 
pub fn modify_guild_channel_position_to_json(
  modify: ModifyGuildChannelPosition,
) -> json.Json

modify_guild_channel_positions_request

</> 
pub fn modify_guild_channel_positions_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using modify: List(ModifyGuildChannelPosition),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

modify_guild_channel_positions_response

</> 
pub fn modify_guild_channel_positions_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

modify_guild_default_message_notification_setting

</> 
pub fn modify_guild_default_message_notification_setting(
  modify: ModifyGuild,
  new setting: GuildDefaultMessageNotificationSetting,
) -> ModifyGuild

modify_guild_description

</> 
pub fn modify_guild_description(
  modify: ModifyGuild,
  new description: String,
) -> ModifyGuild

modify_guild_discovery_splash

</> 
pub fn modify_guild_discovery_splash(
  modify: ModifyGuild,
  new splash: ImageData,
) -> ModifyGuild

The splash must be a PNG/JPEG image with a 16:9 aspect ratio.

The guild must have the GuildIsDiscoverable feature.

modify_guild_explicit_content_filter_setting

</> 
pub fn modify_guild_explicit_content_filter_setting(
  modify: ModifyGuild,
  new setting: GuildExplicitContentFilterSetting,
) -> ModifyGuild

modify_guild_features

</> 
pub fn modify_guild_features(
  modify: ModifyGuild,
  new features: List(GuildFeature),
) -> ModifyGuild

Modifies the guild’s features to the provided list.

You can only modify the following features:

  • GuildIsCommunity - requires the AdministratorPermission permission
  • GuildIsDiscoverable - requires the AdministratorPermission permission. The guild must also satisfy all the discovery requirements.
  • GuildHasPausedInvites - requires the AllowManagingGuild permission
  • GuildDisabledRaidAlerts - requires the AllowManagingGuild permission

NOTE: All enabled features, mutable and immutable, must be provided.

modify_guild_icon

</> 
pub fn modify_guild_icon(
  modify: ModifyGuild,
  new icon: ImageData,
) -> ModifyGuild

The icon must have a resolution of 1024x1024.

It can only be animated if the guild has the GuildCanUseAnimatedIcon feature.

modify_guild_incidents_data_request

</> 
pub fn modify_guild_incidents_data_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  using modify: ModifyGuildIncidentsData,
) -> request.Request(String)

Requires the AllowManagingGuild permission.

modify_guild_incidents_data_response

</> 
pub fn modify_guild_incidents_data_response(
  response: response.Response(String),
) -> Result(GuildIncidentsData, RestError)

modify_guild_incidents_data_to_json

</> 
pub fn modify_guild_incidents_data_to_json(
  modify: ModifyGuildIncidentsData,
) -> json.Json

modify_guild_member_flags

</> 
pub fn modify_guild_member_flags(
  modify: ModifyGuildMember,
  new flags: List(GuildMemberFlag),
) -> ModifyGuildMember

You can only add or remove the GuildMemberBypassesVerificationFlag.

Supply the function with all of the future flags.

Requires one of the following permissions:

  • AllowManagingGuild
  • AllowManagingRoles
  • AllowModeratingMembers + AllowKickingMembers + AllowBanningMembers

modify_guild_member_nick

</> 
pub fn modify_guild_member_nick(
  modify: ModifyGuildMember,
  new nick: String,
) -> ModifyGuildMember

Requires the AllowManagingNicknames permission.

modify_guild_member_request

</> 
pub fn modify_guild_member_request(
  token token: Token,
  member_with_id user_id: Snowflake(User),
  in_guild_with_id guild_id: Snowflake(Guild),
  using modify: ModifyGuildMember,
  reason reason: option.Option(String),
) -> request.Request(String)

modify_guild_member_response

</> 
pub fn modify_guild_member_response(
  response: response.Response(String),
) -> Result(GuildMember, RestError)

modify_guild_member_roles

</> 
pub fn modify_guild_member_roles(
  modify: ModifyGuildMember,
  new_roles_ids roles: List(Snowflake(Role)),
) -> ModifyGuildMember

Requires the AllowManagingRoles permission.

Supply the function with all of the member’s future roles.

modify_guild_member_to_json

</> 
pub fn modify_guild_member_to_json(
  modify: ModifyGuildMember,
) -> json.Json

modify_guild_member_verification_level

</> 
pub fn modify_guild_member_verification_level(
  modify: ModifyGuild,
  new level: GuildMemberVerificationLevel,
) -> ModifyGuild

modify_guild_message_command

</> 
pub fn modify_guild_message_command() -> ModifyGuildMessageCommand

modify_guild_message_command_name

</> 
pub fn modify_guild_message_command_name(
  modify: ModifyGuildMessageCommand,
  new name: String,
) -> ModifyGuildMessageCommand

Name must be between 1 and 32 characters.

modify_guild_message_command_name_localizations

</> 
pub fn modify_guild_message_command_name_localizations(
  modify: ModifyGuildMessageCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGuildMessageCommand

Name must be between 1 and 32 characters.

modify_guild_message_command_request

</> 
pub fn modify_guild_message_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  command_with_id command_id: Snowflake(MessageCommand),
  using modify: ModifyGuildMessageCommand,
) -> request.Request(String)

modify_guild_message_command_required_permissions

</> 
pub fn modify_guild_message_command_required_permissions(
  modify: ModifyGuildMessageCommand,
  new permissions: List(Permission),
) -> ModifyGuildMessageCommand

Use delete_guild_message_command_required_permissions to enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

modify_guild_message_command_response

</> 
pub fn modify_guild_message_command_response(
  response: response.Response(String),
) -> Result(MessageCommand, RestError)

modify_guild_message_command_to_json

</> 
pub fn modify_guild_message_command_to_json(
  modify: ModifyGuildMessageCommand,
) -> json.Json

modify_guild_name

</> 
pub fn modify_guild_name(
  modify: ModifyGuild,
  new name: String,
) -> ModifyGuild

modify_guild_preferred_locale

</> 
pub fn modify_guild_preferred_locale(
  modify: ModifyGuild,
  new preferred_locale: Locale,
) -> ModifyGuild

modify_guild_public_updates_channel

</> 
pub fn modify_guild_public_updates_channel(
  modify: ModifyGuild,
  new_id id: Snowflake(Channel),
) -> ModifyGuild

modify_guild_request

</> 
pub fn modify_guild_request(
  token token: Token,
  guild_with_id id: Snowflake(Guild),
  using modify: ModifyGuild,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingGuild permission.

modify_guild_response

</> 
pub fn modify_guild_response(
  response: response.Response(String),
) -> Result(Guild, RestError)

modify_guild_rules_channel

</> 
pub fn modify_guild_rules_channel(
  modify: ModifyGuild,
  new_id id: Snowflake(Channel),
) -> ModifyGuild

modify_guild_safety_alerts_channel

</> 
pub fn modify_guild_safety_alerts_channel(
  modify: ModifyGuild,
  new_id id: Snowflake(Channel),
) -> ModifyGuild

modify_guild_slash_command

</> 
pub fn modify_guild_slash_command() -> ModifyGuildSlashCommand

modify_guild_slash_command_description

</> 
pub fn modify_guild_slash_command_description(
  modify: ModifyGuildSlashCommand,
  new description: String,
) -> ModifyGuildSlashCommand

Description must be between 1 and 100 characters.

modify_guild_slash_command_description_localizations

</> 
pub fn modify_guild_slash_command_description_localizations(
  modify: ModifyGuildSlashCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGuildSlashCommand

Description must be between 1 and 100 characters.

modify_guild_slash_command_name

</> 
pub fn modify_guild_slash_command_name(
  modify: ModifyGuildSlashCommand,
  new name: String,
) -> ModifyGuildSlashCommand

Name must be between 1 and 32 characters.

modify_guild_slash_command_name_localizations

</> 
pub fn modify_guild_slash_command_name_localizations(
  modify: ModifyGuildSlashCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGuildSlashCommand

Name must be between 1 and 32 characters.

modify_guild_slash_command_options

</> 
pub fn modify_guild_slash_command_options(
  modify: ModifyGuildSlashCommand,
  new options: List(SlashCommandOption),
) -> ModifyGuildSlashCommand

There is a limit of 25 options per command.

modify_guild_slash_command_request

</> 
pub fn modify_guild_slash_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  command_with_id command_id: Snowflake(SlashCommand),
  using modify: ModifyGuildSlashCommand,
) -> request.Request(String)

modify_guild_slash_command_required_permissions

</> 
pub fn modify_guild_slash_command_required_permissions(
  modify: ModifyGuildSlashCommand,
  new permissions: List(Permission),
) -> ModifyGuildSlashCommand

Use delete_guild_slash_command_required_permissions to enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

modify_guild_slash_command_response

</> 
pub fn modify_guild_slash_command_response(
  response: response.Response(String),
) -> Result(SlashCommand, RestError)

modify_guild_slash_command_to_json

</> 
pub fn modify_guild_slash_command_to_json(
  modify: ModifyGuildSlashCommand,
) -> json.Json

modify_guild_soundboard_sound_emoji

</> 
pub fn modify_guild_soundboard_sound_emoji(
  modify: ModifyGuildSoundboardSound,
  new emoji: SoundboardSoundEmoji,
) -> ModifyGuildSoundboardSound

modify_guild_soundboard_sound_name

</> 
pub fn modify_guild_soundboard_sound_name(
  modify: ModifyGuildSoundboardSound,
  new name: String,
) -> ModifyGuildSoundboardSound

modify_guild_soundboard_sound_request

</> 
pub fn modify_guild_soundboard_sound_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  sound_with_id sound_id: Snowflake(SoundboardSound),
  using modify: ModifyGuildSoundboardSound,
  reason reason: option.Option(String),
) -> request.Request(String)

If the sound was created by the current user, requires the AllowCreatingGuildExpressions or AllowManagingGuildExpressions permission.

For all other sounds, requires the AllowManagingGuildExpressions permission.

modify_guild_soundboard_sound_response

</> 
pub fn modify_guild_soundboard_sound_response(
  response: response.Response(String),
) -> Result(SoundboardSound, RestError)

modify_guild_soundboard_sound_to_json

</> 
pub fn modify_guild_soundboard_sound_to_json(
  modify: ModifyGuildSoundboardSound,
) -> json.Json

modify_guild_soundboard_sound_volume

</> 
pub fn modify_guild_soundboard_sound_volume(
  modify: ModifyGuildSoundboardSound,
  new volume: Float,
) -> ModifyGuildSoundboardSound

The volume will be clamped between 0.0 and 1.0, so make sure to provide a value within that range.

modify_guild_splash

</> 
pub fn modify_guild_splash(
  modify: ModifyGuild,
  new splash: ImageData,
) -> ModifyGuild

The splash must be a PNG/JPEG image with a 16:9 aspect ratio.

The guild must have the GuildCanUseInviteSplash feature.

modify_guild_sticker_description

</> 
pub fn modify_guild_sticker_description(
  modify: ModifyGuildSticker,
  new description: String,
) -> ModifyGuildSticker

modify_guild_sticker_name

</> 
pub fn modify_guild_sticker_name(
  modify: ModifyGuildSticker,
  new name: String,
) -> ModifyGuildSticker

modify_guild_sticker_request

</> 
pub fn modify_guild_sticker_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  sticker_with_id sticker_id: Snowflake(GuildSticker),
  using modify: ModifyGuildSticker,
  reason reason: option.Option(String),
) -> request.Request(String)

Required permissions:

  • for stickers created by the current user - AllowCreatingGuildExpressions or AllowManagingGuildExpressions
  • for other stickers - AllowManagingGuildExpressions

modify_guild_sticker_response

</> 
pub fn modify_guild_sticker_response(
  response: response.Response(String),
) -> Result(GuildSticker, RestError)

modify_guild_sticker_tags

</> 
pub fn modify_guild_sticker_tags(
  modify: ModifyGuildSticker,
  new tags: String,
) -> ModifyGuildSticker

modify_guild_sticker_to_json

</> 
pub fn modify_guild_sticker_to_json(
  modify: ModifyGuildSticker,
) -> json.Json

modify_guild_system_channel

</> 
pub fn modify_guild_system_channel(
  modify: ModifyGuild,
  new_id id: Snowflake(Channel),
) -> ModifyGuild

modify_guild_system_channel_flags

</> 
pub fn modify_guild_system_channel_flags(
  modify: ModifyGuild,
  new flags: List(GuildSystemChannelFlag),
) -> ModifyGuild

modify_guild_to_json

</> 
pub fn modify_guild_to_json(modify: ModifyGuild) -> json.Json

modify_guild_user_command

</> 
pub fn modify_guild_user_command() -> ModifyGuildUserCommand

modify_guild_user_command_name

</> 
pub fn modify_guild_user_command_name(
  modify: ModifyGuildUserCommand,
  new name: String,
) -> ModifyGuildUserCommand

Name must be between 1 and 32 characters.

modify_guild_user_command_name_localizations

</> 
pub fn modify_guild_user_command_name_localizations(
  modify: ModifyGuildUserCommand,
  new localizations: dict.Dict(Locale, String),
) -> ModifyGuildUserCommand

Name must be between 1 and 32 characters.

modify_guild_user_command_request

</> 
pub fn modify_guild_user_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  command_with_id command_id: Snowflake(UserCommand),
  using modify: ModifyGuildUserCommand,
) -> request.Request(String)

modify_guild_user_command_required_permissions

</> 
pub fn modify_guild_user_command_required_permissions(
  modify: ModifyGuildUserCommand,
  new permissions: List(Permission),
) -> ModifyGuildUserCommand

Use delete_guild_user_command_required_permissions to enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

modify_guild_user_command_response

</> 
pub fn modify_guild_user_command_response(
  response: response.Response(String),
) -> Result(UserCommand, RestError)

modify_guild_user_command_to_json

</> 
pub fn modify_guild_user_command_to_json(
  modify: ModifyGuildUserCommand,
) -> json.Json

modify_guild_welcome_screen_channels

</> 
pub fn modify_guild_welcome_screen_channels(
  modify: ModifyGuildWelcomeScreen,
  new channels: List(GuildWelcomeScreenChannel),
) -> ModifyGuildWelcomeScreen

modify_guild_welcome_screen_description

</> 
pub fn modify_guild_welcome_screen_description(
  modify: ModifyGuildWelcomeScreen,
  new description: String,
) -> ModifyGuildWelcomeScreen

modify_guild_welcome_screen_request

</> 
pub fn modify_guild_welcome_screen_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  using modify: ModifyGuildWelcomeScreen,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingGuild permission.

modify_guild_welcome_screen_response

</> 
pub fn modify_guild_welcome_screen_response(
  response: response.Response(String),
) -> Result(GuildWelcomeScreen, RestError)

modify_guild_welcome_screen_to_json

</> 
pub fn modify_guild_welcome_screen_to_json(
  modify: ModifyGuildWelcomeScreen,
) -> json.Json

modify_guild_widget_channel_id

</> 
pub fn modify_guild_widget_channel_id(
  modify: ModifyGuildWidgetSettings,
  new id: Snowflake(Channel),
) -> ModifyGuildWidgetSettings

modify_guild_widget_settings_request

</> 
pub fn modify_guild_widget_settings_request(
  token token: Token,
  for_guild_with_id guild_id: Snowflake(Guild),
  using modify: ModifyGuildWidgetSettings,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingGuild permission.

modify_guild_widget_settings_response

</> 
pub fn modify_guild_widget_settings_response(
  response: response.Response(String),
) -> Result(GuildWidgetSettings, RestError)

modify_guild_widget_settings_to_json

</> 
pub fn modify_guild_widget_settings_to_json(
  modify: ModifyGuildWidgetSettings,
) -> json.Json

modify_interaction_response_followup_message_request

</> 
pub fn modify_interaction_response_followup_message_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  interaction_token interaction_token: InteractionToken,
  message_id message_id: Snowflake(Message),
  using modify: ModifyInteractionResponseMessage,
) -> request.Request(BitArray)

modify_interaction_response_followup_message_response

</> 
pub fn modify_interaction_response_followup_message_response(
  response: response.Response(BitArray),
) -> Result(Message, RestError)

modify_interaction_response_message_allowed_mentions

</> 
pub fn modify_interaction_response_message_allowed_mentions(
  modify: ModifyInteractionResponseMessage,
  new allowed_mentions: List(AllowedMessageMention),
) -> ModifyInteractionResponseMessage

Provide an empty list to deny all mentions.

modify_interaction_response_message_attachments

</> 
pub fn modify_interaction_response_message_attachments(
  modify: ModifyInteractionResponseMessage,
  new attachments: List(CreateMessageAttachment),
) -> ModifyInteractionResponseMessage

modify_interaction_response_message_components

</> 
pub fn modify_interaction_response_message_components(
  modify: ModifyInteractionResponseMessage,
  new components: List(CreateMessageComponent),
) -> ModifyInteractionResponseMessage

Make sure to set the InteractionResponseMessageUsesComponentsV2 if using V2 components.

Also make sure to delete the content, embeds, attachments and poll fields if using V2 components.

modify_interaction_response_message_content

</> 
pub fn modify_interaction_response_message_content(
  modify: ModifyInteractionResponseMessage,
  new content: String,
) -> ModifyInteractionResponseMessage

modify_interaction_response_message_embeds

</> 
pub fn modify_interaction_response_message_embeds(
  modify: ModifyInteractionResponseMessage,
  new embeds: List(CreateMessageEmbed),
) -> ModifyInteractionResponseMessage

modify_interaction_response_message_flags

</> 
pub fn modify_interaction_response_message_flags(
  modify: ModifyInteractionResponseMessage,
  new flags: List(InteractionResponseMessageFlag),
) -> ModifyInteractionResponseMessage

You must provide all flags that the message has.

You can only modify the following flags:

  • InteractionResponseMessageWithSuppressedEmbeds - add/remove
  • InteractionResponseMessageUsesComponentsV2 - add

Make sure to delete the content, embeds, attachments and poll fields if you’re adding the Components V2 flag.

modify_interaction_response_message_poll

</> 
pub fn modify_interaction_response_message_poll(
  modify: ModifyInteractionResponseMessage,
  new poll: CreatePoll,
) -> ModifyInteractionResponseMessage

modify_interaction_response_message_to_json

</> 
pub fn modify_interaction_response_message_to_json(
  modify: ModifyInteractionResponseMessage,
) -> json.Json

modify_media_channel_available_tags

</> 
pub fn modify_media_channel_available_tags(
  modify: ModifyMediaChannel,
  new tags: List(ForumTag),
) -> ModifyMediaChannel

modify_media_channel_default_reaction

</> 
pub fn modify_media_channel_default_reaction(
  modify: ModifyMediaChannel,
  new reaction: DefaultForumReaction,
) -> ModifyMediaChannel

modify_media_channel_default_sort_order

</> 
pub fn modify_media_channel_default_sort_order(
  modify: ModifyMediaChannel,
  new order: ForumSortOrder,
) -> ModifyMediaChannel

modify_media_channel_default_thread_auto_archive_duration

</> 
pub fn modify_media_channel_default_thread_auto_archive_duration(
  modify: ModifyMediaChannel,
  new duration: ThreadAutoArchiveDuration,
) -> ModifyMediaChannel

modify_media_channel_default_thread_rate_limit_per_user

</> 
pub fn modify_media_channel_default_thread_rate_limit_per_user(
  modify: ModifyMediaChannel,
  new limit: RateLimitPerUser,
) -> ModifyMediaChannel

modify_media_channel_flags

</> 
pub fn modify_media_channel_flags(
  modify: ModifyMediaChannel,
  new flags: List(MediaChannelFlag),
) -> ModifyMediaChannel

modify_media_channel_name

</> 
pub fn modify_media_channel_name(
  modify: ModifyMediaChannel,
  new name: String,
) -> ModifyMediaChannel

modify_media_channel_parent_id

</> 
pub fn modify_media_channel_parent_id(
  modify: ModifyMediaChannel,
  new id: Snowflake(CategoryChannel),
) -> ModifyMediaChannel

modify_media_channel_permission_overwrites

</> 
pub fn modify_media_channel_permission_overwrites(
  modify: ModifyMediaChannel,
  new overwrites: List(PermissionOverwrite),
) -> ModifyMediaChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

modify_media_channel_position

</> 
pub fn modify_media_channel_position(
  modify: ModifyMediaChannel,
  new position: Int,
) -> ModifyMediaChannel

modify_media_channel_rate_limit_per_user

</> 
pub fn modify_media_channel_rate_limit_per_user(
  modify: ModifyMediaChannel,
  new limit: RateLimitPerUser,
) -> ModifyMediaChannel

modify_media_channel_request

</> 
pub fn modify_media_channel_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(MediaChannel),
  using modify: ModifyMediaChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

modify_media_channel_response

</> 
pub fn modify_media_channel_response(
  response: response.Response(String),
) -> Result(MediaChannel, RestError)

modify_media_channel_to_json

</> 
pub fn modify_media_channel_to_json(
  modify: ModifyMediaChannel,
) -> json.Json

modify_media_channel_topic

</> 
pub fn modify_media_channel_topic(
  modify: ModifyMediaChannel,
  new topic: String,
) -> ModifyMediaChannel

modify_message_allowed_mentions

</> 
pub fn modify_message_allowed_mentions(
  modify: ModifyMessage,
  allowed_mentions: List(AllowedMessageMention),
) -> ModifyMessage

Modifying a message’s allowed mentions doesn’t notify anyone.

Please read through the AllowedMessageMention documentation before going forward.

modify_message_attachments

</> 
pub fn modify_message_attachments(
  modify: ModifyMessage,
  attachments: List(CreateMessageAttachment),
) -> ModifyMessage

All the attachments you plan on having in the new version of the message must be provided.

modify_message_components

</> 
pub fn modify_message_components(
  modify: ModifyMessage,
  components: List(CreateMessageComponent),
) -> ModifyMessage

All the components you plan on having in the new version of the message must be provided.

Make sure to set the ModifyMessageToUseComponentsV2 flag if using components V2.

Clear out the content and embeds fields if using components V2.

modify_message_content

</> 
pub fn modify_message_content(
  modify: ModifyMessage,
  new content: String,
) -> ModifyMessage

modify_message_embeds

</> 
pub fn modify_message_embeds(
  modify: ModifyMessage,
  new embeds: List(CreateMessageEmbed),
) -> ModifyMessage

modify_message_flags

</> 
pub fn modify_message_flags(
  modify: ModifyMessage,
  old old: List(MessageFlag),
  new_added added: List(ModifyMessageAddFlag),
  new_removed removed: List(ModifyMessageRemoveFlag),
) -> ModifyMessage

You need the message’s present flags to modify them.

Removal takes prescedence over addition.

Trying to add an already present flag or remove an already absent one is a no-op.

modify_message_request

</> 
pub fn modify_message_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  message_with_id message_id: Snowflake(Message),
  using modify: ModifyMessage,
) -> request.Request(BitArray)

Modifying someone else’s message:

  • you can only add the ModifyMessageToSuppressEmbeds flag
  • requires the AllowManagingMessages permission.

modify_message_response

</> 
pub fn modify_message_response(
  response: response.Response(BitArray),
) -> Result(Message, RestError)

modify_message_to_json

</> 
pub fn modify_message_to_json(modify: ModifyMessage) -> json.Json

modify_original_interaction_response_request

</> 
pub fn modify_original_interaction_response_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  interaction_token interaction_token: InteractionToken,
  with modify: ModifyInteractionResponseMessage,
) -> request.Request(BitArray)

modify_original_interaction_response_response

</> 
pub fn modify_original_interaction_response_response(
  response: response.Response(BitArray),
) -> Result(Message, RestError)

modify_role_as_mentionable

</> 
pub fn modify_role_as_mentionable(
  modify: ModifyRole,
) -> ModifyRole

Allows everyone to mention the role.

modify_role_as_unmentionable

</> 
pub fn modify_role_as_unmentionable(
  modify: ModifyRole,
) -> ModifyRole

Does not allow everyone to mention the role.

modify_role_colours

</> 
pub fn modify_role_colours(
  modify: ModifyRole,
  new colours: RoleColours,
) -> ModifyRole

modify_role_icon

</> 
pub fn modify_role_icon(
  modify: ModifyRole,
  new icon: ImageData,
) -> ModifyRole

Requires the GuildCanUseRoleIcons feature.

modify_role_name

</> 
pub fn modify_role_name(
  modify: ModifyRole,
  new name: String,
) -> ModifyRole

modify_role_permissions

</> 
pub fn modify_role_permissions(
  modify: ModifyRole,
  new permissions: List(Permission),
) -> ModifyRole

Controls the role’s guild-wide permissions. Supply the function with all the future permissions.

modify_role_position_response

</> 
pub fn modify_role_position_response(
  response: response.Response(String),
) -> Result(List(Role), RestError)

modify_role_position_to_json

</> 
pub fn modify_role_position_to_json(
  modify: ModifyRolePosition,
) -> json.Json

modify_role_positions_request

</> 
pub fn modify_role_positions_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using modify: List(ModifyRolePosition),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingRoles permission.

Returns all of the guild’s roles.

modify_role_request

</> 
pub fn modify_role_request(
  token token: Token,
  role_with_id role_id: Snowflake(Role),
  in_guild_with_id guild_id: Snowflake(Guild),
  using modify: ModifyRole,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingRoles permission.

modify_role_response

</> 
pub fn modify_role_response(
  response: response.Response(String),
) -> Result(Role, RestError)

modify_role_to_json

</> 
pub fn modify_role_to_json(modify: ModifyRole) -> json.Json

modify_role_unicode_emoji

</> 
pub fn modify_role_unicode_emoji(
  modify: ModifyRole,
  new unicode_emoji: String,
) -> ModifyRole

Requires the GuildCanUseRoleIcons feature.

modify_stage_channel_bitrate

</> 
pub fn modify_stage_channel_bitrate(
  modify: ModifyStageChannel,
  new bitrate: Int,
) -> ModifyStageChannel

modify_stage_channel_name

</> 
pub fn modify_stage_channel_name(
  modify: ModifyStageChannel,
  new name: String,
) -> ModifyStageChannel

modify_stage_channel_parent_id

</> 
pub fn modify_stage_channel_parent_id(
  modify: ModifyStageChannel,
  new parent_id: Snowflake(CategoryChannel),
) -> ModifyStageChannel

modify_stage_channel_permission_overwrites

</> 
pub fn modify_stage_channel_permission_overwrites(
  modify: ModifyStageChannel,
  new overwrites: List(PermissionOverwrite),
) -> ModifyStageChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

modify_stage_channel_position

</> 
pub fn modify_stage_channel_position(
  modify: ModifyStageChannel,
  new position: Int,
) -> ModifyStageChannel

Channels with the same position are sorted by ID (newer channel will be lower)

modify_stage_channel_rate_limit_per_user

</> 
pub fn modify_stage_channel_rate_limit_per_user(
  modify: ModifyStageChannel,
  new limit: RateLimitPerUser,
) -> ModifyStageChannel

Modifies the slowmode for the stage-channel-attached text channel.

Must be between 0 and 21600 seconds.

Bots and members with the AllowBypassingSlowmode permission are exempt from slowmode.

modify_stage_channel_request

</> 
pub fn modify_stage_channel_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(StageChannel),
  using modify: ModifyStageChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

modify_stage_channel_response

</> 
pub fn modify_stage_channel_response(
  response: response.Response(String),
) -> Result(StageChannel, RestError)

modify_stage_channel_rtc_region_id

</> 
pub fn modify_stage_channel_rtc_region_id(
  modify: ModifyStageChannel,
  new rtc_region_id: String,
) -> ModifyStageChannel

modify_stage_channel_to_json

</> 
pub fn modify_stage_channel_to_json(
  modify: ModifyStageChannel,
) -> json.Json

modify_stage_channel_user_limit

</> 
pub fn modify_stage_channel_user_limit(
  modify: ModifyStageChannel,
  new limit: Int,
) -> ModifyStageChannel

modify_stage_channel_video_quality_mode

</> 
pub fn modify_stage_channel_video_quality_mode(
  modify: ModifyStageChannel,
  new video_quality_mode: VideoQualityMode,
) -> ModifyStageChannel

modify_text_channel_default_thread_auto_archive_duration

</> 
pub fn modify_text_channel_default_thread_auto_archive_duration(
  modify: ModifyTextChannel,
  new duration: ThreadAutoArchiveDuration,
) -> ModifyTextChannel

modify_text_channel_default_thread_rate_limit_per_user

</> 
pub fn modify_text_channel_default_thread_rate_limit_per_user(
  modify: ModifyTextChannel,
  new duration: RateLimitPerUser,
) -> ModifyTextChannel

The modified value will only apply to new threads - existing threads won’t auto-update.

modify_text_channel_name

</> 
pub fn modify_text_channel_name(
  modify: ModifyTextChannel,
  new name: String,
) -> ModifyTextChannel

modify_text_channel_parent_id

</> 
pub fn modify_text_channel_parent_id(
  modify: ModifyTextChannel,
  new id: Snowflake(CategoryChannel),
) -> ModifyTextChannel

modify_text_channel_permission_ovewrites

</> 
pub fn modify_text_channel_permission_ovewrites(
  modify: ModifyTextChannel,
  new overwrites: List(PermissionOverwrite),
) -> ModifyTextChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

modify_text_channel_position

</> 
pub fn modify_text_channel_position(
  modify: ModifyTextChannel,
  new position: Int,
) -> ModifyTextChannel

Channels with the same position are sorted by ID (newer channel will be lower)

modify_text_channel_rate_limit_per_user

</> 
pub fn modify_text_channel_rate_limit_per_user(
  modify: ModifyTextChannel,
  new limit: RateLimitPerUser,
) -> ModifyTextChannel

Modify the amount of time between a user has to wait between sending a message or creating a thread.

Must be between 0 and 21600 seconds.

Bots and members with the AllowBypassingSlowmode permission are exempt from slowmode.

modify_text_channel_request

</> 
pub fn modify_text_channel_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(TextChannel),
  using modify: ModifyTextChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

modify_text_channel_response

</> 
pub fn modify_text_channel_response(
  response: response.Response(String),
) -> Result(TextChannel, RestError)

Use modify_text_channel_with_conversion_response if you converted the text channel into announcement channel.

modify_text_channel_to_json

</> 
pub fn modify_text_channel_to_json(
  modify: ModifyTextChannel,
) -> json.Json

modify_text_channel_topic

</> 
pub fn modify_text_channel_topic(
  modify: ModifyTextChannel,
  new topic: String,
) -> ModifyTextChannel

modify_text_channel_with_conversion_response

</> 
pub fn modify_text_channel_with_conversion_response(
  response: response.Response(String),
) -> Result(AnnouncementChannel, RestError)

Use this if you converted the text channel to an announcement channel.

modify_thread_applied_tags

</> 
pub fn modify_thread_applied_tags(
  modify: ModifyThread,
  new_ids ids: List(Snowflake(ForumTag)),
) -> ModifyThread

Limited to 5.

modify_thread_auto_archive_duration

</> 
pub fn modify_thread_auto_archive_duration(
  modify: ModifyThread,
  new duration: ThreadAutoArchiveDuration,
) -> ModifyThread

modify_thread_flags

</> 
pub fn modify_thread_flags(
  modify: ModifyThread,
  new flags: List(ThreadFlag),
) -> ModifyThread

modify_thread_name

</> 
pub fn modify_thread_name(
  modify: ModifyThread,
  new name: String,
) -> ModifyThread

modify_thread_rate_limit_per_user

</> 
pub fn modify_thread_rate_limit_per_user(
  modify: ModifyThread,
  new limit: RateLimitPerUser,
) -> ModifyThread

modify_thread_request

</> 
pub fn modify_thread_request(
  token token: Token,
  thread_with_id id: Snowflake(Thread),
  using modify: ModifyThread,
  reason reason: option.Option(String),
) -> request.Request(String)

modify_thread_response

</> 
pub fn modify_thread_response(
  response: response.Response(String),
) -> Result(Thread, RestError)

modify_thread_to_json

</> 
pub fn modify_thread_to_json(modify: ModifyThread) -> json.Json

modify_voice_channel_bitrate

</> 
pub fn modify_voice_channel_bitrate(
  modify: ModifyVoiceChannel,
  new bitrate: Int,
) -> ModifyVoiceChannel

modify_voice_channel_name

</> 
pub fn modify_voice_channel_name(
  modify: ModifyVoiceChannel,
  new name: String,
) -> ModifyVoiceChannel

modify_voice_channel_parent_id

</> 
pub fn modify_voice_channel_parent_id(
  modify: ModifyVoiceChannel,
  new parent_id: Snowflake(CategoryChannel),
) -> ModifyVoiceChannel

modify_voice_channel_permission_overwrites

</> 
pub fn modify_voice_channel_permission_overwrites(
  modify: ModifyVoiceChannel,
  new overwrites: List(PermissionOverwrite),
) -> ModifyVoiceChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

modify_voice_channel_position

</> 
pub fn modify_voice_channel_position(
  modify: ModifyVoiceChannel,
  new position: Int,
) -> ModifyVoiceChannel

Channels with the same position are sorted by ID (newer channel will be lower)

modify_voice_channel_rate_limit_per_user

</> 
pub fn modify_voice_channel_rate_limit_per_user(
  modify: ModifyVoiceChannel,
  new limit: RateLimitPerUser,
) -> ModifyVoiceChannel

Modifies the slowmode for the voice-channel-attached text channel.

Must be between 0 and 21600 seconds.

Bots and members with the AllowBypassingSlowmode permission are exempt from slowmode.

modify_voice_channel_request

</> 
pub fn modify_voice_channel_request(
  token token: Token,
  channel_with_id channel_id: Snowflake(VoiceChannel),
  using modify: ModifyVoiceChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

modify_voice_channel_response

</> 
pub fn modify_voice_channel_response(
  response: response.Response(String),
) -> Result(VoiceChannel, RestError)

modify_voice_channel_rtc_region_id

</> 
pub fn modify_voice_channel_rtc_region_id(
  modify: ModifyVoiceChannel,
  new rtc_region_id: String,
) -> ModifyVoiceChannel

modify_voice_channel_to_json

</> 
pub fn modify_voice_channel_to_json(
  modify: ModifyVoiceChannel,
) -> json.Json

modify_voice_channel_user_limit

</> 
pub fn modify_voice_channel_user_limit(
  modify: ModifyVoiceChannel,
  new limit: Int,
) -> ModifyVoiceChannel

modify_voice_channel_video_quality_mode

</> 
pub fn modify_voice_channel_video_quality_mode(
  modify: ModifyVoiceChannel,
  new video_quality_mode: VideoQualityMode,
) -> ModifyVoiceChannel

month_decoder

</> 
pub fn month_decoder() -> decode.Decoder(calendar.Month)

move_guild_member

</> 
pub fn move_guild_member(
  modify: ModifyGuildMember,
  to channel_id: Snowflake(VoiceLikeChannel),
) -> ModifyGuildMember

Requires the AllowMovingMembersBetweenVoiceChannels permission and the AllowConnectingToVoiceChannels permission for that voice channel.

Will return a bad request if the user is not in a voice channel.

move_role

</> 
pub fn move_role(
  with_id id: Snowflake(Role),
  to_position position: Int,
) -> ModifyRolePosition

Roles with the same position are sorted by ID.

mute_guild_member

</> 
pub fn mute_guild_member(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowMutingMembersInVoiceChannels permission.

Denies the user’s permission to speak in all the guild’s voice channels.

Will return a bad request if the user is not in a voice channel.

new_announcement_channel

</> 
pub fn new_announcement_channel(
  named name: String,
) -> CreateAnnouncementChannel

Requires the AllowManagingChannels permission.

new_announcement_channel_at_position

</> 
pub fn new_announcement_channel_at_position(
  create: CreateAnnouncementChannel,
  position: Int,
) -> CreateAnnouncementChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list. Channels with the same position are sorted by ID (new channel will be lower)

new_announcement_channel_request

</> 
pub fn new_announcement_channel_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateAnnouncementChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

new_announcement_channel_response

</> 
pub fn new_announcement_channel_response(
  response: response.Response(String),
) -> Result(AnnouncementChannel, RestError)

new_announcement_channel_with_parent_id

</> 
pub fn new_announcement_channel_with_parent_id(
  create: CreateAnnouncementChannel,
  parent_id: Snowflake(CategoryChannel),
) -> CreateAnnouncementChannel

Puts the channel in a category. Channels without a parent ID will not be in a category, and will rather be independent in the server list.

new_announcement_channel_with_permission_overwrites

</> 
pub fn new_announcement_channel_with_permission_overwrites(
  create: CreateAnnouncementChannel,
  overwrites: List(PermissionOverwrite),
) -> CreateAnnouncementChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

new_announcement_channel_with_thread_auto_archive_duration

</> 
pub fn new_announcement_channel_with_thread_auto_archive_duration(
  create: CreateAnnouncementChannel,
  duration: ThreadAutoArchiveDuration,
) -> CreateAnnouncementChannel

Controls the default amount of time after which inactive threads are archived in the channel.

new_announcement_channel_with_thread_rate_limit_per_user

</> 
pub fn new_announcement_channel_with_thread_rate_limit_per_user(
  create: CreateAnnouncementChannel,
  rate_limit_per_user: RateLimitPerUser,
) -> CreateAnnouncementChannel

The default thread rate limit per user. This value gets copied to every thread and does not live-update.

new_announcement_channel_with_topic

</> 
pub fn new_announcement_channel_with_topic(
  create: CreateAnnouncementChannel,
  topic: String,
) -> CreateAnnouncementChannel

new_attachment_slash_command_option

</> 
pub fn new_attachment_slash_command_option(
  named name: String,
  with_description description: String,
) -> AttachmentSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_attachment_slash_command_option_with_allowed_file_types

</> 
pub fn new_attachment_slash_command_option_with_allowed_file_types(
  option: AttachmentSlashCommandOption,
  file_types: List(FileUploadFilter),
) -> AttachmentSlashCommandOption

Passing an empty list to this function (default behavior in the new function), allows the user to pass files of any type into the option.

If you pass any file types, the user will only be allowed to pass in files with such types.

new_attachment_slash_command_option_with_description_localizations

</> 
pub fn new_attachment_slash_command_option_with_description_localizations(
  option: AttachmentSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> AttachmentSlashCommandOption

The description must be between 1 and 100 characters.

new_attachment_slash_command_option_with_name_localizations

</> 
pub fn new_attachment_slash_command_option_with_name_localizations(
  option: AttachmentSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> AttachmentSlashCommandOption

The name must be between 1 and 32 characters.

new_bool_slash_command_option

</> 
pub fn new_bool_slash_command_option(
  named name: String,
  with_description description: String,
) -> BoolSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_bool_slash_command_option_with_description_localizations

</> 
pub fn new_bool_slash_command_option_with_description_localizations(
  option: BoolSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> BoolSlashCommandOption

The description must be between 1 and 100 characters.

new_bool_slash_command_option_with_name_localizations

</> 
pub fn new_bool_slash_command_option_with_name_localizations(
  option: BoolSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> BoolSlashCommandOption

The name must be between 1 and 32 characters.

new_category_channel

</> 
pub fn new_category_channel(
  named name: String,
) -> CreateCategoryChannel

new_category_channel_at_position

</> 
pub fn new_category_channel_at_position(
  create: CreateCategoryChannel,
  position: Int,
) -> CreateCategoryChannel

Channels without a specified position will automatically be assigned one at the bottom of their channel list. Channels with the same position are sorted by ID (new channel will be lower)

new_category_channel_request

</> 
pub fn new_category_channel_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateCategoryChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

new_category_channel_response

</> 
pub fn new_category_channel_response(
  response: response.Response(String),
) -> Result(CategoryChannel, RestError)

new_category_channel_with_permission_overwrites

</> 
pub fn new_category_channel_with_permission_overwrites(
  create: CreateCategoryChannel,
  overwrites: List(PermissionOverwrite),
) -> CreateCategoryChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission. Channels can sync their permissions to their category channels.

new_channel_slash_command_option

</> 
pub fn new_channel_slash_command_option(
  named name: String,
  with_description description: String,
) -> ChannelSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_channel_slash_command_option_with_allowed_channel_types

</> 
pub fn new_channel_slash_command_option_with_allowed_channel_types(
  option: ChannelSlashCommandOption,
  channel_types: List(SelectChannelType),
) -> ChannelSlashCommandOption

Passing an empty list (default behavior in the new function), allows the user to select a channel of any type.

If you pass any channel types into this function, now users will only be allowed to select channels of those types.

new_channel_slash_command_option_with_description_localizations

</> 
pub fn new_channel_slash_command_option_with_description_localizations(
  option: ChannelSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> ChannelSlashCommandOption

The description must be between 1 and 100 characters.

new_channel_slash_command_option_with_name_localizations

</> 
pub fn new_channel_slash_command_option_with_name_localizations(
  option: ChannelSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> ChannelSlashCommandOption

The name must be between 1 and 32 characters.

new_checkbox_group_option

</> 
pub fn new_checkbox_group_option(
  label label: String,
  value value: String,
) -> CreateCheckboxGroupOption

Label and value must each be up to 100 characters.

new_checkbox_group_option_with_description

</> 
pub fn new_checkbox_group_option_with_description(
  create: CreateCheckboxGroupOption,
  description: String,
) -> CreateCheckboxGroupOption

Must be up to 100 characters.

new_default_selected_checkbox_group_option

</> 
pub fn new_default_selected_checkbox_group_option(
  create: CreateCheckboxGroupOption,
) -> CreateCheckboxGroupOption

new_default_selected_modal_checkbox

</> 
pub fn new_default_selected_modal_checkbox(
  create: CreateModalCheckbox,
) -> CreateModalCheckbox

new_default_selected_radio_group_option

</> 
pub fn new_default_selected_radio_group_option(
  create: CreateRadioGroupOption,
) -> CreateRadioGroupOption

Only one radio group option can be selected by default.

new_default_selected_string_select_option

</> 
pub fn new_default_selected_string_select_option(
  option: StringSelectOption,
) -> StringSelectOption

Whether the option is selected by default.

</> 
pub fn new_disabled_link_button(
  create: CreateLinkButton,
) -> CreateLinkButton

new_disabled_message_button

</> 
pub fn new_disabled_message_button(
  create: CreatePremiumButton,
) -> CreatePremiumButton

new_disabled_message_channel_select

</> 
pub fn new_disabled_message_channel_select(
  create: CreateMessageChannelSelect,
) -> CreateMessageChannelSelect

new_disabled_message_mentionable_select

</> 
pub fn new_disabled_message_mentionable_select(
  create: CreateMessageMentionableSelect,
) -> CreateMessageMentionableSelect

new_disabled_message_role_select

</> 
pub fn new_disabled_message_role_select(
  create: CreateMessageRoleSelect,
) -> CreateMessageRoleSelect

new_disabled_message_string_select

</> 
pub fn new_disabled_message_string_select(
  create: CreateMessageStringSelect,
) -> CreateMessageStringSelect

new_disabled_message_user_select

</> 
pub fn new_disabled_message_user_select(
  create: CreateMessageUserSelect,
) -> CreateMessageUserSelect

new_disabled_regular_button

</> 
pub fn new_disabled_regular_button(
  create: CreateRegularButton,
) -> CreateRegularButton

new_dm_channel_request

</> 
pub fn new_dm_channel_request(
  token token: Token,
  to_user_with_id user_id: Snowflake(User),
) -> request.Request(String)

Do not use this endpoint as means of notifying everyone in a server about something.

DMs should be initiated by user action - for example, interactions.

Even then, if you create a significant amount of DMs too quickly, your bot may be quarantined.

new_dm_channel_response

</> 
pub fn new_dm_channel_response(
  response: response.Response(String),
) -> Result(DmChannel, RestError)

new_embed_author

</> 
pub fn new_embed_author(named name: String) -> CreateEmbedAuthor

new_embed_author_with_icon

</> 
pub fn new_embed_author_with_icon(
  create: CreateEmbedAuthor,
  url icon_url: String,
) -> CreateEmbedAuthor

URL must be attachment or HTTPS.

new_embed_author_with_url

</> 
pub fn new_embed_author_with_url(
  create: CreateEmbedAuthor,
  url: String,
) -> CreateEmbedAuthor

URL must be HTTPS.

new_embed_field

</> 
pub fn new_embed_field(
  named name: String,
  value value: String,
) -> CreateEmbedField
</> 
pub fn new_embed_footer(text text: String) -> CreateEmbedFooter
</> 
pub fn new_embed_footer_with_icon(
  create: CreateEmbedFooter,
  url icon_url: String,
) -> CreateEmbedFooter

URL must beattachment or HTTPS.

new_embed_image

</> 
pub fn new_embed_image(url url: String) -> CreateEmbedImage

new_embed_image_with_description

</> 
pub fn new_embed_image_with_description(
  create: CreateEmbedImage,
  description: String,
) -> CreateEmbedImage

new_float_slash_command_option

</> 
pub fn new_float_slash_command_option(
  named name: String,
  with_description description: String,
) -> FloatSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_float_slash_command_option_choice

</> 
pub fn new_float_slash_command_option_choice(
  named name: String,
  value value: Float,
) -> FloatSlashCommandOptionChoice

Name must be between 1 and 100 characters.

new_float_slash_command_option_choice_with_name_localizations

</> 
pub fn new_float_slash_command_option_choice_with_name_localizations(
  choice: FloatSlashCommandOptionChoice,
  localizations: dict.Dict(Locale, String),
) -> FloatSlashCommandOptionChoice

Name must be between 1 and 100 characters.

new_float_slash_command_option_with_choices

</> 
pub fn new_float_slash_command_option_with_choices(
  option: FloatSlashCommandOption,
  choices: List(FloatSlashCommandOptionChoice),
) -> FloatSlashCommandOption

If you hard-code choices, you cannot enable autocomplete.

There is a limit of 25 choices per option.

new_float_slash_command_option_with_description_localizations

</> 
pub fn new_float_slash_command_option_with_description_localizations(
  option: FloatSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> FloatSlashCommandOption

The description must be between 1 and 100 characters.

new_float_slash_command_option_with_enabled_autocomplete

</> 
pub fn new_float_slash_command_option_with_enabled_autocomplete(
  option: FloatSlashCommandOption,
) -> FloatSlashCommandOption

Used for dynamic suggestion of choices based on user input.

The provided suggestions are not the only possible choices, and the user can still input anything, provided it fits in the character range.

You cannot use hard-coded choices if autocomplete is enabled.

new_float_slash_command_option_with_maximum_value

</> 
pub fn new_float_slash_command_option_with_maximum_value(
  option: FloatSlashCommandOption,
  value: Float,
) -> FloatSlashCommandOption

new_float_slash_command_option_with_minimum_value

</> 
pub fn new_float_slash_command_option_with_minimum_value(
  option: FloatSlashCommandOption,
  value: Float,
) -> FloatSlashCommandOption

new_float_slash_command_option_with_name_localizations

</> 
pub fn new_float_slash_command_option_with_name_localizations(
  option: FloatSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> FloatSlashCommandOption

The name must be between 1 and 32 characters.

new_forum_channel

</> 
pub fn new_forum_channel(
  named name: String,
) -> CreateForumChannel

new_forum_channel_at_position

</> 
pub fn new_forum_channel_at_position(
  create: CreateForumChannel,
  position: Int,
) -> CreateForumChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list. Channels with the same position are sorted by ID (new channel will be lower)

new_forum_channel_request

</> 
pub fn new_forum_channel_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateForumChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

new_forum_channel_response

</> 
pub fn new_forum_channel_response(
  response: response.Response(String),
) -> Result(ForumChannel, RestError)

new_forum_channel_with_default_layout

</> 
pub fn new_forum_channel_with_default_layout(
  create: CreateForumChannel,
  layout: ForumLayout,
) -> CreateForumChannel

Controls the default layout the channel is shown in.

new_forum_channel_with_default_reaction

</> 
pub fn new_forum_channel_with_default_reaction(
  create: CreateForumChannel,
  reaction: DefaultForumReaction,
) -> CreateForumChannel

Controls the default reaction shown in the thread preview.

new_forum_channel_with_default_sort_order

</> 
pub fn new_forum_channel_with_default_sort_order(
  create: CreateForumChannel,
  order: ForumSortOrder,
) -> CreateForumChannel

Controls the default order of sorting the threads in the forum.

new_forum_channel_with_parent_id

</> 
pub fn new_forum_channel_with_parent_id(
  create: CreateForumChannel,
  parent_id: Snowflake(CategoryChannel),
) -> CreateForumChannel

Puts the channel in a category. Channels without a parent ID will not be in a category, and will rather be independent in the server list.

new_forum_channel_with_permission_overwrites

</> 
pub fn new_forum_channel_with_permission_overwrites(
  create: CreateForumChannel,
  overwrites: List(PermissionOverwrite),
) -> CreateForumChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

new_forum_channel_with_rate_limit_per_user

</> 
pub fn new_forum_channel_with_rate_limit_per_user(
  create: CreateForumChannel,
  limit: RateLimitPerUser,
) -> CreateForumChannel

The rate limit per user is the amount of time a user has to wait between sending messages.

new_forum_channel_with_tags

</> 
pub fn new_forum_channel_with_tags(
  create: CreateForumChannel,
  tags: List(ForumTag),
) -> CreateForumChannel

new_forum_channel_with_thread_auto_archive_duration

</> 
pub fn new_forum_channel_with_thread_auto_archive_duration(
  create: CreateForumChannel,
  duration: ThreadAutoArchiveDuration,
) -> CreateForumChannel

Controls the default amount of time after which inactive threads are archived in the channel.

new_forum_channel_with_thread_rate_limit_per_user

</> 
pub fn new_forum_channel_with_thread_rate_limit_per_user(
  create: CreateForumChannel,
  limit: RateLimitPerUser,
) -> CreateForumChannel

The default thread rate limit per user. This value gets copied to every thread and does not live-update.

new_forum_channel_with_topic

</> 
pub fn new_forum_channel_with_topic(
  create: CreateForumChannel,
  topic: String,
) -> CreateForumChannel

new_forum_like_thread

</> 
pub fn new_forum_like_thread(
  named name: String,
  using message: CreateForumLikeThreadMessage,
) -> CreateForumLikeThread

new_forum_like_thread_message

</> 
pub fn new_forum_like_thread_message() -> CreateForumLikeThreadMessage

You need to set one of content, embeds, sticker_ids, components, or attachments.

You have to use the CreateForumLikeThreadMessageUsingComponentsV2 flag if you use Components V2.

new_forum_like_thread_message_embed

</> 
pub fn new_forum_like_thread_message_embed() -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_author

</> 
pub fn new_forum_like_thread_message_embed_with_author(
  create: CreateForumLikeThreadMessageEmbed,
  author: CreateEmbedAuthor,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_colour

</> 
pub fn new_forum_like_thread_message_embed_with_colour(
  create: CreateForumLikeThreadMessageEmbed,
  colour: colour.Colour,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_description

</> 
pub fn new_forum_like_thread_message_embed_with_description(
  create: CreateForumLikeThreadMessageEmbed,
  description: String,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_fields

</> 
pub fn new_forum_like_thread_message_embed_with_fields(
  create: CreateForumLikeThreadMessageEmbed,
  fields: List(CreateEmbedField),
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_image

</> 
pub fn new_forum_like_thread_message_embed_with_image(
  create: CreateForumLikeThreadMessageEmbed,
  image: CreateEmbedImage,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_thumbnail

</> 
pub fn new_forum_like_thread_message_embed_with_thumbnail(
  create: CreateForumLikeThreadMessageEmbed,
  thumbnail: CreateEmbedImage,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_timestamp

</> 
pub fn new_forum_like_thread_message_embed_with_timestamp(
  create: CreateForumLikeThreadMessageEmbed,
  timestamp: timestamp.Timestamp,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_title

</> 
pub fn new_forum_like_thread_message_embed_with_title(
  create: CreateForumLikeThreadMessageEmbed,
  title: String,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_embed_with_url

</> 
pub fn new_forum_like_thread_message_embed_with_url(
  create: CreateForumLikeThreadMessageEmbed,
  url: String,
) -> CreateForumLikeThreadMessageEmbed

new_forum_like_thread_message_with_allowed_mentions

</> 
pub fn new_forum_like_thread_message_with_allowed_mentions(
  create: CreateForumLikeThreadMessage,
  allowed_mentions: List(AllowedMessageMention),
) -> CreateForumLikeThreadMessage

Please read the AllowedMessageMention documentation beforehand.

new_forum_like_thread_message_with_attachments

</> 
pub fn new_forum_like_thread_message_with_attachments(
  create: CreateForumLikeThreadMessage,
  attachments: List(CreateMessageAttachment),
) -> CreateForumLikeThreadMessage

new_forum_like_thread_message_with_components

</> 
pub fn new_forum_like_thread_message_with_components(
  create: CreateForumLikeThreadMessage,
  components: List(CreateMessageComponent),
) -> CreateForumLikeThreadMessage

If sending a V2 component, remember to set the CreateForumLikeThreadMessageUsingComponentsV2 flag.

new_forum_like_thread_message_with_content

</> 
pub fn new_forum_like_thread_message_with_content(
  create: CreateForumLikeThreadMessage,
  content: String,
) -> CreateForumLikeThreadMessage

new_forum_like_thread_message_with_embeds

</> 
pub fn new_forum_like_thread_message_with_embeds(
  create: CreateForumLikeThreadMessage,
  embeds: List(CreateForumLikeThreadMessageEmbed),
) -> CreateForumLikeThreadMessage

new_forum_like_thread_message_with_flags

</> 
pub fn new_forum_like_thread_message_with_flags(
  create: CreateForumLikeThreadMessage,
  flags: List(CreateForumLikeThreadMessageFlag),
) -> CreateForumLikeThreadMessage

new_forum_like_thread_message_with_stickers

</> 
pub fn new_forum_like_thread_message_with_stickers(
  create: CreateForumLikeThreadMessage,
  ids sticker_ids: List(Snowflake(Sticker)),
) -> CreateForumLikeThreadMessage

new_forum_like_thread_request

</> 
pub fn new_forum_like_thread_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(ForumLikeChannel),
  using create: CreateForumLikeThread,
  reason reason: option.Option(String),
) -> request.Request(BitArray)

Behavior:

  • the created thread will be a PublicThread
  • requires the AllowSendingMessages permission in the forum-like channel

new_forum_like_thread_response

</> 
pub fn new_forum_like_thread_response(
  response: response.Response(BitArray),
) -> Result(Thread, RestError)

new_forum_like_thread_with_applied_tags

</> 
pub fn new_forum_like_thread_with_applied_tags(
  create: CreateForumLikeThread,
  ids ids: List(Snowflake(ForumTag)),
) -> CreateForumLikeThread

new_forum_like_thread_with_auto_archive_duration

</> 
pub fn new_forum_like_thread_with_auto_archive_duration(
  create: CreateForumLikeThread,
  duration: ThreadAutoArchiveDuration,
) -> CreateForumLikeThread

new_forum_like_thread_with_rate_limit_per_user

</> 
pub fn new_forum_like_thread_with_rate_limit_per_user(
  create: CreateForumLikeThread,
  limit: RateLimitPerUser,
) -> CreateForumLikeThread

new_forward_message_reference

</> 
pub fn new_forward_message_reference(
  original_message_id original_message_id: Snowflake(Message),
  original_channel_id original_channel_id: Snowflake(Channel),
  original_guild_id original_guild_id: option.Option(
    Snowflake(Guild),
  ),
) -> CreateMessageReference

Allows you to make a new message be a forward of another message.

You MUST include the original guild ID unless the message was sent in a DM.

new_get_channel_pins_options

</> 
pub fn new_get_channel_pins_options() -> GetChannelPinsOptions

Default limit is 50.

new_get_current_application_entitlements_options

</> 
pub fn new_get_current_application_entitlements_options() -> GetCurrentApplicationEntitlementsOptions

Defaults:

  • limit 100
  • include ended
  • exclude deleted

new_get_guild_bans_options

</> 
pub fn new_get_guild_bans_options() -> GetGuildBansOptions

new_get_guild_members_options

</> 
pub fn new_get_guild_members_options() -> GetGuildMembersOptions

new_get_poll_answer_voters_options

</> 
pub fn new_get_poll_answer_voters_options() -> GetPollAnswerVotersOptions

Default limit is 25.

new_get_reacting_users_options

</> 
pub fn new_get_reacting_users_options() -> GetReactingUsersOptions

Defaults:

  • only normal reactions
  • limit: 25

new_get_sku_subscriptions_options

</> 
pub fn new_get_sku_subscriptions_options(
  for_user_with_id user_id: Snowflake(User),
) -> GetSkuSubscriptionsOptions

Default limit is 50.

new_global_message_command

</> 
pub fn new_global_message_command(
  named name: String,
) -> CreateGlobalMessageCommand

Name must be between 1 and 32 characters.

new_global_message_command_request

</> 
pub fn new_global_message_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  using create: CreateGlobalMessageCommand,
) -> request.Request(String)

Creating a command with the same name as an existing one will overwrite that command.

new_global_message_command_response

</> 
pub fn new_global_message_command_response(
  response: response.Response(String),
) -> Result(MessageCommand, RestError)

Response status codes:

  • 201 - new command created
  • 200 - existed command overwritten

new_global_message_command_with_allowed_contexts

</> 
pub fn new_global_message_command_with_allowed_contexts(
  create: CreateGlobalMessageCommand,
  contexts: List(CommandContext),
) -> CreateGlobalMessageCommand

new_global_message_command_with_allowed_installation_types

</> 
pub fn new_global_message_command_with_allowed_installation_types(
  create: CreateGlobalMessageCommand,
  types: List(CommandInstallationType),
) -> CreateGlobalMessageCommand

Check CommandInstallationType documentation.

new_global_message_command_with_name_localizations

</> 
pub fn new_global_message_command_with_name_localizations(
  create: CreateGlobalMessageCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGlobalMessageCommand

Name must be between 1 and 32 characters.

new_global_message_command_with_required_permissions

</> 
pub fn new_global_message_command_with_required_permissions(
  create: CreateGlobalMessageCommand,
  permissions: List(Permission),
) -> CreateGlobalMessageCommand

Not using this function (default in new), will enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

new_global_slash_command

</> 
pub fn new_global_slash_command(
  named name: String,
  with_description description: String,
) -> CreateGlobalSlashCommand

Name must be between 1 and 32 characters.

Description must be between 1 and 100 characters.

new_global_slash_command_request

</> 
pub fn new_global_slash_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  using create: CreateGlobalSlashCommand,
) -> request.Request(String)

Creating a command with the same name as an existing one will overwrite that command.

new_global_slash_command_response

</> 
pub fn new_global_slash_command_response(
  response: response.Response(String),
) -> Result(SlashCommand, RestError)

Response status codes:

  • 201 - new command created
  • 200 - existed command overwritten

new_global_slash_command_with_allowed_contexts

</> 
pub fn new_global_slash_command_with_allowed_contexts(
  create: CreateGlobalSlashCommand,
  contexts: List(CommandContext),
) -> CreateGlobalSlashCommand

new_global_slash_command_with_allowed_installation_types

</> 
pub fn new_global_slash_command_with_allowed_installation_types(
  create: CreateGlobalSlashCommand,
  types: List(CommandInstallationType),
) -> CreateGlobalSlashCommand

Check CommandInstallationType documentation.

new_global_slash_command_with_description_localizations

</> 
pub fn new_global_slash_command_with_description_localizations(
  create: CreateGlobalSlashCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGlobalSlashCommand

Description must be between 1 and 100 characters.

new_global_slash_command_with_name_localizations

</> 
pub fn new_global_slash_command_with_name_localizations(
  create: CreateGlobalSlashCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGlobalSlashCommand

Name must be between 1 and 32 characters.

new_global_slash_command_with_options

</> 
pub fn new_global_slash_command_with_options(
  create: CreateGlobalSlashCommand,
  options: List(SlashCommandOption),
) -> CreateGlobalSlashCommand

There is a limit of 25 options per command.

new_global_slash_command_with_required_permissions

</> 
pub fn new_global_slash_command_with_required_permissions(
  create: CreateGlobalSlashCommand,
  permissions: List(Permission),
) -> CreateGlobalSlashCommand

Not using this function (default in new), will enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

new_global_user_command

</> 
pub fn new_global_user_command(
  named name: String,
) -> CreateGlobalUserCommand

Name must be between 1 and 32 characters.

new_global_user_command_request

</> 
pub fn new_global_user_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  using create: CreateGlobalUserCommand,
) -> request.Request(String)

Creating a command with the same name as an existing one will overwrite that command.

new_global_user_command_response

</> 
pub fn new_global_user_command_response(
  response: response.Response(String),
) -> Result(UserCommand, RestError)

Response status codes:

  • 201 - new command created
  • 200 - existed command overwritten

new_global_user_command_with_allowed_contexts

</> 
pub fn new_global_user_command_with_allowed_contexts(
  create: CreateGlobalUserCommand,
  contexts: List(CommandContext),
) -> CreateGlobalUserCommand

new_global_user_command_with_allowed_installation_types

</> 
pub fn new_global_user_command_with_allowed_installation_types(
  create: CreateGlobalUserCommand,
  types: List(CommandInstallationType),
) -> CreateGlobalUserCommand

Check CommandInstallationType documentation.

new_global_user_command_with_name_localizations

</> 
pub fn new_global_user_command_with_name_localizations(
  create: CreateGlobalUserCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGlobalUserCommand

Name must be between 1 and 32 characters.

new_global_user_command_with_required_permissions

</> 
pub fn new_global_user_command_with_required_permissions(
  create: CreateGlobalUserCommand,
  permissions: List(Permission),
) -> CreateGlobalUserCommand

Not using this function (default in new), will enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

new_guild_channel_invite

</> 
pub fn new_guild_channel_invite() -> CreateGuildChannelInvite

new_guild_channel_invite_request

</> 
pub fn new_guild_channel_invite_request(
  token token: Token,
  channel_with_id id: Snowflake(GuildChannel),
  using create: CreateGuildChannelInvite,
  reason reason: option.Option(String),
) -> request.Request(BitArray)

Requires the AllowCreatingInstantInvites permission.

new_guild_channel_invite_response

</> 
pub fn new_guild_channel_invite_response(
  response: response.Response(BitArray),
) -> Result(Invite, RestError)

new_guild_channel_invite_with_allowlist

</> 
pub fn new_guild_channel_invite_with_allowlist(
  create: CreateGuildChannelInvite,
  user_ids allowlist: List(Snowflake(User)),
) -> CreateGuildChannelInvite

Restricts who can accept the invite.

new_guild_channel_invite_with_automatically_awarded_roles

</> 
pub fn new_guild_channel_invite_with_automatically_awarded_roles(
  create: CreateGuildChannelInvite,
  role_ids role_ids: List(Snowflake(Role)),
) -> CreateGuildChannelInvite

Requires the AllowManagingRoles permission.

You cannot assign roles with higher permissions than the current user.

new_guild_channel_invite_with_expiration

</> 
pub fn new_guild_channel_invite_with_expiration(
  create: CreateGuildChannelInvite,
  max_age: duration.Duration,
) -> CreateGuildChannelInvite

Defaults to 24 hours.

new_guild_channel_invite_with_max_uses

</> 
pub fn new_guild_channel_invite_with_max_uses(
  create: CreateGuildChannelInvite,
  max_uses: Int,
) -> CreateGuildChannelInvite

new_guild_channel_invite_with_target

</> 
pub fn new_guild_channel_invite_with_target(
  create: CreateGuildChannelInvite,
  target: InviteTarget,
) -> CreateGuildChannelInvite

new_guild_message_command

</> 
pub fn new_guild_message_command(
  named name: String,
) -> CreateGuildMessageCommand

Name must be between 1 and 32 characters.

new_guild_message_command_request

</> 
pub fn new_guild_message_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  using create: CreateGuildMessageCommand,
) -> request.Request(String)

Creating a command with the same name as an existing one will overwrite that command.

new_guild_message_command_with_name_localizations

</> 
pub fn new_guild_message_command_with_name_localizations(
  create: CreateGuildMessageCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGuildMessageCommand

Name must be between 1 and 32 characters.

new_guild_message_command_with_required_permissions

</> 
pub fn new_guild_message_command_with_required_permissions(
  create: CreateGuildMessageCommand,
  permissions: List(Permission),
) -> CreateGuildMessageCommand

Not using this function (default in new), will enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

new_guild_slash_command

</> 
pub fn new_guild_slash_command(
  named name: String,
  with_description description: String,
) -> CreateGuildSlashCommand

Name must be between 1 and 32 characters.

Description must be between 1 and 100 characters.

new_guild_slash_command_request

</> 
pub fn new_guild_slash_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  using create: CreateGuildSlashCommand,
) -> request.Request(String)

Creating a command with the same name as an existing one will overwrite that command.

new_guild_slash_command_with_description_localizations

</> 
pub fn new_guild_slash_command_with_description_localizations(
  create: CreateGuildSlashCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGuildSlashCommand

Description must be between 1 and 100 characters.

new_guild_slash_command_with_name_localizations

</> 
pub fn new_guild_slash_command_with_name_localizations(
  create: CreateGuildSlashCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGuildSlashCommand

Name must be between 1 and 32 characters.

new_guild_slash_command_with_options

</> 
pub fn new_guild_slash_command_with_options(
  create: CreateGuildSlashCommand,
  options: List(SlashCommandOption),
) -> CreateGuildSlashCommand

There is a limit of 25 options per command.

new_guild_slash_command_with_required_permissions

</> 
pub fn new_guild_slash_command_with_required_permissions(
  create: CreateGuildSlashCommand,
  permissions: List(Permission),
) -> CreateGuildSlashCommand

Not using this function (default in new), will enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

new_guild_soundboard_sound

</> 
pub fn new_guild_soundboard_sound(
  named name: String,
  data data: BitArray,
  content_type content_type: SoundboardSoundContentType,
) -> CreateGuildSoundboardSound

The data must be maximum 512 kB and maximum 5.2 seconds.

new_guild_soundboard_sound_request

</> 
pub fn new_guild_soundboard_sound_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateGuildSoundboardSound,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowCreatingGuildExpressions permission

new_guild_soundboard_sound_response

</> 
pub fn new_guild_soundboard_sound_response(
  response: response.Response(String),
) -> Result(SoundboardSound, RestError)

new_guild_soundboard_sound_with_emoji

</> 
pub fn new_guild_soundboard_sound_with_emoji(
  create: CreateGuildSoundboardSound,
  emoji: SoundboardSoundEmoji,
) -> CreateGuildSoundboardSound

new_guild_soundboard_sound_with_volume

</> 
pub fn new_guild_soundboard_sound_with_volume(
  create: CreateGuildSoundboardSound,
  volume: Float,
) -> CreateGuildSoundboardSound

The volume will be clamped between 0.0 and 1.0, so make sure to provide a value within that range.

new_guild_sticker

</> 
pub fn new_guild_sticker(
  named name: String,
  with_with_description description: String,
  with_tags tags: String,
  file file: File,
) -> CreateGuildSticker

Requirements:

  • name must be between 2 and 30 characters
  • description must be empty or between 2 and 100 characters
  • tags must be between 0 and 200 characters
  • the file must be a PNG, APNG, GIF or Lottie JSON file, maximum 512 KiB
  • only guilds with the GuildIsVerified or GuildIsPartnered features can upload Lottie stickers
  • animated stickers must be maximum 5 seconds long
  • stickers must be maximum 320x320px

new_guild_sticker_request

</> 
pub fn new_guild_sticker_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateGuildSticker,
  reason reason: option.Option(String),
) -> request.Request(BitArray)

Requires the AllowCreatingGuildExpressions permission.

new_guild_sticker_response

</> 
pub fn new_guild_sticker_response(
  response: response.Response(BitArray),
) -> Result(GuildSticker, RestError)

new_guild_user_command

</> 
pub fn new_guild_user_command(
  named name: String,
) -> CreateGuildUserCommand

Name must be between 1 and 32 characters.

new_guild_user_command_request

</> 
pub fn new_guild_user_command_request(
  token token: Token,
  current_application_id application_id: Snowflake(Application),
  guild_id guild_id: Snowflake(Guild),
  using create: CreateGuildUserCommand,
) -> request.Request(String)

Creating a command with the same name as an existing one will overwrite that command.

new_guild_user_command_with_name_localizations

</> 
pub fn new_guild_user_command_with_name_localizations(
  create: CreateGuildUserCommand,
  localizations: dict.Dict(Locale, String),
) -> CreateGuildUserCommand

Name must be between 1 and 32 characters.

new_guild_user_command_with_required_permissions

</> 
pub fn new_guild_user_command_with_required_permissions(
  create: CreateGuildUserCommand,
  permissions: List(Permission),
) -> CreateGuildUserCommand

Not using this function (default in new), will enable the command for everyone.

Passing an empty list will disable the command for everyone.

Passing a list with at least one permission will require those permissions to use the command.

new_guild_welcome_screen_channel

</> 
pub fn new_guild_welcome_screen_channel(
  with_id id: Snowflake(Channel),
  with_description description: String,
) -> GuildWelcomeScreenChannel

new_hoisted_role

</> 
pub fn new_hoisted_role(create: CreateRole) -> CreateRole

Controls whether the role is shown separately in the sidebar.

new_inline_embed_field

</> 
pub fn new_inline_embed_field(
  create: CreateEmbedField,
) -> CreateEmbedField

new_int_slash_command_option

</> 
pub fn new_int_slash_command_option(
  named name: String,
  with_description description: String,
) -> IntSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_int_slash_command_option_choice

</> 
pub fn new_int_slash_command_option_choice(
  named name: String,
  value value: Int,
) -> IntSlashCommandOptionChoice

Name must be between 1 and 100 characters.

new_int_slash_command_option_choice_with_name_localizations

</> 
pub fn new_int_slash_command_option_choice_with_name_localizations(
  choice: IntSlashCommandOptionChoice,
  localizations: dict.Dict(Locale, String),
) -> IntSlashCommandOptionChoice

Name must be between 1 and 100 characters.

new_int_slash_command_option_with_choices

</> 
pub fn new_int_slash_command_option_with_choices(
  option: IntSlashCommandOption,
  choices: List(IntSlashCommandOptionChoice),
) -> IntSlashCommandOption

If you hard-code choices, you cannot enable autocomplete.

There is a limit of 25 choices per option.

new_int_slash_command_option_with_description_localizations

</> 
pub fn new_int_slash_command_option_with_description_localizations(
  option: IntSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> IntSlashCommandOption

The description must be between 1 and 100 characters.

new_int_slash_command_option_with_enabled_autocomplete

</> 
pub fn new_int_slash_command_option_with_enabled_autocomplete(
  option: IntSlashCommandOption,
) -> IntSlashCommandOption

Used for dynamic suggestion of choices based on user input.

The provided suggestions are not the only possible choices, and the user can still input anything, provided it fits in the character range.

You cannot use hard-coded choices if autocomplete is enabled.

new_int_slash_command_option_with_maximum_value

</> 
pub fn new_int_slash_command_option_with_maximum_value(
  option: IntSlashCommandOption,
  value: Int,
) -> IntSlashCommandOption

new_int_slash_command_option_with_minimum_value

</> 
pub fn new_int_slash_command_option_with_minimum_value(
  option: IntSlashCommandOption,
  value: Int,
) -> IntSlashCommandOption

new_int_slash_command_option_with_name_localizations

</> 
pub fn new_int_slash_command_option_with_name_localizations(
  option: IntSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> IntSlashCommandOption

The name must be between 1 and 32 characters.

new_interaction_response_message

</> 
pub fn new_interaction_response_message() -> InteractionResponseMessage

new_interaction_response_message_with_allowed_mentions

</> 
pub fn new_interaction_response_message_with_allowed_mentions(
  message: InteractionResponseMessage,
  allowed_mentions: List(AllowedMessageMention),
) -> InteractionResponseMessage

The default behavior of grom is not to allow any mentions.

new_interaction_response_message_with_attachments

</> 
pub fn new_interaction_response_message_with_attachments(
  message: InteractionResponseMessage,
  attachments: List(CreateMessageAttachment),
) -> InteractionResponseMessage

new_interaction_response_message_with_components

</> 
pub fn new_interaction_response_message_with_components(
  message: InteractionResponseMessage,
  components: List(CreateMessageComponent),
) -> InteractionResponseMessage

Make sure to set the InteractionResponseMessageUsesComponentsV2 flag if you’re using any V2 components!

new_interaction_response_message_with_content

</> 
pub fn new_interaction_response_message_with_content(
  message: InteractionResponseMessage,
  content: String,
) -> InteractionResponseMessage

Cannot be used with the InteractionResponseMessageUsesComponentsV2 flag.

new_interaction_response_message_with_flags

</> 
pub fn new_interaction_response_message_with_flags(
  message: InteractionResponseMessage,
  flags: List(InteractionResponseMessageFlag),
) -> InteractionResponseMessage

new_interaction_response_message_with_poll

</> 
pub fn new_interaction_response_message_with_poll(
  message: InteractionResponseMessage,
  poll: CreatePoll,
) -> InteractionResponseMessage

A message cannot contain a poll and any of the following: content, attachments, components, allowed mentions, embeds.

new_interaction_response_modal

</> 
pub fn new_interaction_response_modal(
  custom_id custom_id: String,
  title title: String,
  components components: List(CreateModalComponent),
) -> InteractionResponseModal

Limitations:

  • custom ID must be between 1 and 100 characters
  • title must be maximum 45 characters
  • you must provide between 1 and 5 components (inclusive)
</> 
pub fn new_link_button(url url: String) -> CreateLinkButton
</> 
pub fn new_link_button_with_emoji(
  create: CreateLinkButton,
  emoji: ComponentEmoji,
) -> CreateLinkButton
</> 
pub fn new_link_button_with_id(
  create: CreateLinkButton,
  id: Int,
) -> CreateLinkButton
</> 
pub fn new_link_button_with_label(
  create: CreateLinkButton,
  label: String,
) -> CreateLinkButton

Label must be max 80 characters.

new_media_channel

</> 
pub fn new_media_channel(
  named name: String,
) -> CreateMediaChannel

new_media_channel_at_position

</> 
pub fn new_media_channel_at_position(
  create: CreateMediaChannel,
  position: Int,
) -> CreateMediaChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list. Channels with the same position are sorted by ID (new channel will be lower)

new_media_channel_request

</> 
pub fn new_media_channel_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateMediaChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

new_media_channel_response

</> 
pub fn new_media_channel_response(
  response: response.Response(String),
) -> Result(MediaChannel, RestError)

new_media_channel_with_default_reaction

</> 
pub fn new_media_channel_with_default_reaction(
  create: CreateMediaChannel,
  reaction: DefaultForumReaction,
) -> CreateMediaChannel

Controls the default reaction shown in the thread preview.

new_media_channel_with_default_sort_order

</> 
pub fn new_media_channel_with_default_sort_order(
  create: CreateMediaChannel,
  order: ForumSortOrder,
) -> CreateMediaChannel

Controls the default order of sorting the threads in the media.

new_media_channel_with_parent_id

</> 
pub fn new_media_channel_with_parent_id(
  create: CreateMediaChannel,
  parent_id: Snowflake(CategoryChannel),
) -> CreateMediaChannel

Puts the channel in a category. Channels without a parent ID will not be in a category, and will rather be independent in the server list.

new_media_channel_with_permission_overwrites

</> 
pub fn new_media_channel_with_permission_overwrites(
  create: CreateMediaChannel,
  overwrites: List(PermissionOverwrite),
) -> CreateMediaChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

new_media_channel_with_rate_limit_per_user

</> 
pub fn new_media_channel_with_rate_limit_per_user(
  create: CreateMediaChannel,
  limit: RateLimitPerUser,
) -> CreateMediaChannel

The rate limit per user is the amount of time a user has to wait between sending messages.

new_media_channel_with_tags

</> 
pub fn new_media_channel_with_tags(
  create: CreateMediaChannel,
  tags: List(ForumTag),
) -> CreateMediaChannel

new_media_channel_with_thread_auto_archive_duration

</> 
pub fn new_media_channel_with_thread_auto_archive_duration(
  create: CreateMediaChannel,
  duration: ThreadAutoArchiveDuration,
) -> CreateMediaChannel

Controls the default amount of time after which inactive threads are archived in the channel.

new_media_channel_with_thread_rate_limit_per_user

</> 
pub fn new_media_channel_with_thread_rate_limit_per_user(
  create: CreateMediaChannel,
  limit: RateLimitPerUser,
) -> CreateMediaChannel

The default thread rate limit per user. This value gets copied to every thread and does not live-update.

new_media_channel_with_topic

</> 
pub fn new_media_channel_with_topic(
  create: CreateMediaChannel,
  topic: String,
) -> CreateMediaChannel
</> 
pub fn new_media_gallery_item(
  media media: CreateUnfurledMediaItem,
) -> CreateMediaGalleryItem
</> 
pub fn new_media_gallery_item_with_description(
  create: CreateMediaGalleryItem,
  description: String,
) -> CreateMediaGalleryItem

Description must be max 1024 characters.

new_mentionable_role

</> 
pub fn new_mentionable_role(create: CreateRole) -> CreateRole

Allows everyone the mention the role.

new_mentionable_slash_command_option

</> 
pub fn new_mentionable_slash_command_option(
  named name: String,
  with_description description: String,
) -> MentionableSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_mentionable_slash_command_option_with_description_localizations

</> 
pub fn new_mentionable_slash_command_option_with_description_localizations(
  option: MentionableSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> MentionableSlashCommandOption

The description must be between 1 and 100 characters.

new_mentionable_slash_command_option_with_name_localizations

</> 
pub fn new_mentionable_slash_command_option_with_name_localizations(
  option: MentionableSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> MentionableSlashCommandOption

The name must be between 1 and 32 characters.

new_message

</> 
pub fn new_message() -> CreateMessage

You must set at least one of content, embeds, sticker_ids, components, attachments, or poll.

If you’re forwarding a message, only reference is required.

By default, no mentions will be allowed.

new_message_action_row

</> 
pub fn new_message_action_row(
  components components: List(CreateActionRowComponent),
) -> CreateMessageActionRow

Components must be either up to 5 buttons or a single select component.

new_message_action_row_with_id

</> 
pub fn new_message_action_row_with_id(
  create: CreateMessageActionRow,
  id: Int,
) -> CreateMessageActionRow

new_message_attachment

</> 
pub fn new_message_attachment(
  file file: File,
) -> CreateMessageAttachment

new_message_attachment_with_description

</> 
pub fn new_message_attachment_with_description(
  create: CreateMessageAttachment,
  description: String,
) -> CreateMessageAttachment

Maximum 1024 characters.

new_message_attachment_with_title

</> 
pub fn new_message_attachment_with_title(
  create: CreateMessageAttachment,
  title: String,
) -> CreateMessageAttachment

new_message_channel_select

</> 
pub fn new_message_channel_select(
  custom_id custom_id: String,
) -> CreateMessageChannelSelect

new_message_channel_select_with_channel_types

</> 
pub fn new_message_channel_select_with_channel_types(
  create: CreateMessageChannelSelect,
  channel_types: List(SelectChannelType),
) -> CreateMessageChannelSelect

Which channel types are to be included in the select window.

new_message_channel_select_with_default_channels

</> 
pub fn new_message_channel_select_with_default_channels(
  create: CreateMessageChannelSelect,
  default_channels: List(Snowflake(Channel)),
) -> CreateMessageChannelSelect

Which channels are to be selected by default.

new_message_channel_select_with_id

</> 
pub fn new_message_channel_select_with_id(
  create: CreateMessageChannelSelect,
  id: Int,
) -> CreateMessageChannelSelect

new_message_channel_select_with_max_values

</> 
pub fn new_message_channel_select_with_max_values(
  create: CreateMessageChannelSelect,
  max_values: Int,
) -> CreateMessageChannelSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_message_channel_select_with_min_values

</> 
pub fn new_message_channel_select_with_min_values(
  create: CreateMessageChannelSelect,
  min_values: Int,
) -> CreateMessageChannelSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_message_channel_select_with_placeholder

</> 
pub fn new_message_channel_select_with_placeholder(
  create: CreateMessageChannelSelect,
  placeholder: String,
) -> CreateMessageChannelSelect

Shown when no value is selected. Maximum 150 characters.

new_message_container

</> 
pub fn new_message_container() -> CreateMessageContainer

new_message_container_with_accent_colour

</> 
pub fn new_message_container_with_accent_colour(
  create: CreateMessageContainer,
  accent_colour: colour.Colour,
) -> CreateMessageContainer

new_message_container_with_components

</> 
pub fn new_message_container_with_components(
  create: CreateMessageContainer,
  components: List(CreateContainerComponent),
) -> CreateMessageContainer

new_message_container_with_id

</> 
pub fn new_message_container_with_id(
  create: CreateMessageContainer,
  id: Int,
) -> CreateMessageContainer

new_message_embed

</> 
pub fn new_message_embed() -> CreateMessageEmbed

new_message_embed_with_author

</> 
pub fn new_message_embed_with_author(
  create: CreateMessageEmbed,
  author: CreateEmbedAuthor,
) -> CreateMessageEmbed

new_message_embed_with_colour

</> 
pub fn new_message_embed_with_colour(
  create: CreateMessageEmbed,
  colour: colour.Colour,
) -> CreateMessageEmbed

new_message_embed_with_description

</> 
pub fn new_message_embed_with_description(
  create: CreateMessageEmbed,
  description: String,
) -> CreateMessageEmbed

new_message_embed_with_fields

</> 
pub fn new_message_embed_with_fields(
  create: CreateMessageEmbed,
  fields: List(CreateEmbedField),
) -> CreateMessageEmbed

new_message_embed_with_image

</> 
pub fn new_message_embed_with_image(
  create: CreateMessageEmbed,
  image: CreateEmbedImage,
) -> CreateMessageEmbed

new_message_embed_with_thumbnail

</> 
pub fn new_message_embed_with_thumbnail(
  create: CreateMessageEmbed,
  thumbnail: CreateEmbedImage,
) -> CreateMessageEmbed

new_message_embed_with_timestamp

</> 
pub fn new_message_embed_with_timestamp(
  create: CreateMessageEmbed,
  timestamp: timestamp.Timestamp,
) -> CreateMessageEmbed

new_message_embed_with_title

</> 
pub fn new_message_embed_with_title(
  create: CreateMessageEmbed,
  title: String,
) -> CreateMessageEmbed

new_message_embed_with_url

</> 
pub fn new_message_embed_with_url(
  create: CreateMessageEmbed,
  url: String,
) -> CreateMessageEmbed

new_message_file

</> 
pub fn new_message_file(
  file file: CreateUnfurledMediaItem,
) -> CreateMessageFile

The unfurled media item MUST contain an attachment URL.

new_message_file_with_id

</> 
pub fn new_message_file_with_id(
  create: CreateMessageFile,
  id: Int,
) -> CreateMessageFile
</> 
pub fn new_message_media_gallery(
  items items: List(CreateMediaGalleryItem),
) -> CreateMessageMediaGallery

A media gallery must contain between 1 and 10 items.

</> 
pub fn new_message_media_gallery_with_id(
  create: CreateMessageMediaGallery,
  id: Int,
) -> CreateMessageMediaGallery

new_message_mentionable_select

</> 
pub fn new_message_mentionable_select(
  custom_id custom_id: String,
) -> CreateMessageMentionableSelect

new_message_mentionable_select_with_default_roles

</> 
pub fn new_message_mentionable_select_with_default_roles(
  create: CreateMessageMentionableSelect,
  default_roles: List(Snowflake(Role)),
) -> CreateMessageMentionableSelect

Which roles are to be selected by default.

new_message_mentionable_select_with_default_users

</> 
pub fn new_message_mentionable_select_with_default_users(
  create: CreateMessageMentionableSelect,
  default_users: List(Snowflake(User)),
) -> CreateMessageMentionableSelect

Which users are to be selected by default.

new_message_mentionable_select_with_id

</> 
pub fn new_message_mentionable_select_with_id(
  create: CreateMessageMentionableSelect,
  id: Int,
) -> CreateMessageMentionableSelect

new_message_mentionable_select_with_max_values

</> 
pub fn new_message_mentionable_select_with_max_values(
  create: CreateMessageMentionableSelect,
  max_values: Int,
) -> CreateMessageMentionableSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_message_mentionable_select_with_min_values

</> 
pub fn new_message_mentionable_select_with_min_values(
  create: CreateMessageMentionableSelect,
  min_values: Int,
) -> CreateMessageMentionableSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_message_mentionable_select_with_placeholder

</> 
pub fn new_message_mentionable_select_with_placeholder(
  create: CreateMessageMentionableSelect,
  placeholder: String,
) -> CreateMessageMentionableSelect

Shown when no value is selected. Maximum 150 characters.

new_message_reaction_request

</> 
pub fn new_message_reaction_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  message_with_id message_id: Snowflake(Message),
  emoji emoji: MessageReactionEmoji,
) -> request.Request(String)

Required permissions in the target channel:

  • always - AllowReadingMessageHistory
  • if nobody else reacted to the message with this emoji - AllowAddingReactions

new_message_reaction_response

</> 
pub fn new_message_reaction_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

new_message_reference_with_no_fail_if_original_not_exists

</> 
pub fn new_message_reference_with_no_fail_if_original_not_exists(
  create: CreateMessageReference,
) -> CreateMessageReference

Makes it so that the message will send as a regular message instead of failing if the original message doesn’t exist.

new_message_request

</> 
pub fn new_message_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(Channel),
  using create: CreateMessage,
) -> request.Request(BitArray)

If sending in a guild channel, requires the AllowSendingMessages permission.

new_message_response

</> 
pub fn new_message_response(
  response: response.Response(BitArray),
) -> Result(Message, RestError)

new_message_role_select

</> 
pub fn new_message_role_select(
  custom_id custom_id: String,
) -> CreateMessageRoleSelect

new_message_role_select_with_default_roles

</> 
pub fn new_message_role_select_with_default_roles(
  create: CreateMessageRoleSelect,
  default_roles: List(Snowflake(Role)),
) -> CreateMessageRoleSelect

Which roles are to be selected by default.

new_message_role_select_with_id

</> 
pub fn new_message_role_select_with_id(
  create: CreateMessageRoleSelect,
  id: Int,
) -> CreateMessageRoleSelect

new_message_role_select_with_max_values

</> 
pub fn new_message_role_select_with_max_values(
  create: CreateMessageRoleSelect,
  max_values: Int,
) -> CreateMessageRoleSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_message_role_select_with_min_values

</> 
pub fn new_message_role_select_with_min_values(
  create: CreateMessageRoleSelect,
  min_values: Int,
) -> CreateMessageRoleSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_message_role_select_with_placeholder

</> 
pub fn new_message_role_select_with_placeholder(
  create: CreateMessageRoleSelect,
  placeholder: String,
) -> CreateMessageRoleSelect

Shown when no value is selected. Maximum 150 characters.

new_message_section

</> 
pub fn new_message_section(
  children components: List(CreateSectionComponent),
  accessory accessory: CreateSectionAccessory,
) -> CreateMessageSection

A section must contain between 1 and 3 children.

new_message_section_with_id

</> 
pub fn new_message_section_with_id(
  create: CreateMessageSection,
  id: Int,
) -> CreateMessageSection

new_message_separator

</> 
pub fn new_message_separator() -> CreateMessageSeparator

Defaults: visible divider, small spacing.

new_message_separator_with_id

</> 
pub fn new_message_separator_with_id(
  create: CreateMessageSeparator,
  id: Int,
) -> CreateMessageSeparator

new_message_separator_with_large_spacing

</> 
pub fn new_message_separator_with_large_spacing(
  create: CreateMessageSeparator,
) -> CreateMessageSeparator

new_message_separator_without_visible_divider

</> 
pub fn new_message_separator_without_visible_divider(
  create: CreateMessageSeparator,
) -> CreateMessageSeparator

new_message_string_select

</> 
pub fn new_message_string_select(
  custom_id custom_id: String,
  options options: List(StringSelectOption),
) -> CreateMessageStringSelect

new_message_string_select_with_id

</> 
pub fn new_message_string_select_with_id(
  create: CreateMessageStringSelect,
  id: Int,
) -> CreateMessageStringSelect

new_message_string_select_with_max_values

</> 
pub fn new_message_string_select_with_max_values(
  create: CreateMessageStringSelect,
  max_values: Int,
) -> CreateMessageStringSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_message_string_select_with_min_values

</> 
pub fn new_message_string_select_with_min_values(
  create: CreateMessageStringSelect,
  min_values: Int,
) -> CreateMessageStringSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_message_string_select_with_placeholder

</> 
pub fn new_message_string_select_with_placeholder(
  create: CreateMessageStringSelect,
  placeholder: String,
) -> CreateMessageStringSelect

Shown when no value is selected. Maximum 150 characters.

new_message_text_display

</> 
pub fn new_message_text_display(
  content content: String,
) -> CreateMessageTextDisplay

new_message_text_display_with_id

</> 
pub fn new_message_text_display_with_id(
  create: CreateMessageTextDisplay,
  id: Int,
) -> CreateMessageTextDisplay

new_message_thumbnail

</> 
pub fn new_message_thumbnail(
  media media: CreateUnfurledMediaItem,
) -> CreateMessageThumbnail

new_message_thumbnail_with_description

</> 
pub fn new_message_thumbnail_with_description(
  create: CreateMessageThumbnail,
  description: String,
) -> CreateMessageThumbnail

The description must be max 1024 characters.

new_message_thumbnail_with_id

</> 
pub fn new_message_thumbnail_with_id(
  create: CreateMessageThumbnail,
  id: Int,
) -> CreateMessageThumbnail

new_message_user_select

</> 
pub fn new_message_user_select(
  custom_id custom_id: String,
) -> CreateMessageUserSelect

new_message_user_select_with_default_users

</> 
pub fn new_message_user_select_with_default_users(
  create: CreateMessageUserSelect,
  default_users: List(Snowflake(User)),
) -> CreateMessageUserSelect

Which users are to be selected by default.

new_message_user_select_with_id

</> 
pub fn new_message_user_select_with_id(
  create: CreateMessageUserSelect,
  id: Int,
) -> CreateMessageUserSelect

new_message_user_select_with_max_values

</> 
pub fn new_message_user_select_with_max_values(
  create: CreateMessageUserSelect,
  max_values: Int,
) -> CreateMessageUserSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_message_user_select_with_min_values

</> 
pub fn new_message_user_select_with_min_values(
  create: CreateMessageUserSelect,
  min_values: Int,
) -> CreateMessageUserSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_message_user_select_with_placeholder

</> 
pub fn new_message_user_select_with_placeholder(
  create: CreateMessageUserSelect,
  placeholder: String,
) -> CreateMessageUserSelect

Shown when no value is selected. Maximum 150 characters.

new_message_with_allowed_mentions

</> 
pub fn new_message_with_allowed_mentions(
  create: CreateMessage,
  allowed_mentions: List(AllowedMessageMention),
) -> CreateMessage

Please read the AllowedMessageMention documentation beforehand.

new_message_with_attachments

</> 
pub fn new_message_with_attachments(
  create: CreateMessage,
  attachments: List(CreateMessageAttachment),
) -> CreateMessage

new_message_with_components

</> 
pub fn new_message_with_components(
  create: CreateMessage,
  components: List(CreateMessageComponent),
) -> CreateMessage

If using Components V2, make sure to set the CreateMessageUsingComponentsV2 flag.

new_message_with_content

</> 
pub fn new_message_with_content(
  create: CreateMessage,
  content: String,
) -> CreateMessage

Content must be maximum 2000 characters.

new_message_with_embeds

</> 
pub fn new_message_with_embeds(
  create: CreateMessage,
  embeds: List(CreateMessageEmbed),
) -> CreateMessage

new_message_with_enforced_nonce

</> 
pub fn new_message_with_enforced_nonce(
  create: CreateMessage,
  nonce: MessageNonce,
) -> CreateMessage

With an enforced nonce, Discord will verify whether a message with the same nonce was sent by the bot in the past couple minutes.

If that is the case, the response will contain the older message and no new message will be created.

new_message_with_flags

</> 
pub fn new_message_with_flags(
  create: CreateMessage,
  flags: List(CreateMessageFlag),
) -> CreateMessage

new_message_with_nonce

</> 
pub fn new_message_with_nonce(
  create: CreateMessage,
  nonce: MessageNonce,
) -> CreateMessage

A nonce is used to verify a message was sent through the gateway.

Verify message create events for that nonce to make sure a message was created.

new_message_with_poll

</> 
pub fn new_message_with_poll(
  create: CreateMessage,
  poll: CreatePoll,
) -> CreateMessage

new_message_with_reference

</> 
pub fn new_message_with_reference(
  create: CreateMessage,
  reference: CreateMessageReference,
) -> CreateMessage

new_message_with_stickers

</> 
pub fn new_message_with_stickers(
  create: CreateMessage,
  ids sticker_ids: List(Snowflake(Sticker)),
) -> CreateMessage

new_modal_channel_select

</> 
pub fn new_modal_channel_select(
  custom_id custom_id: String,
) -> CreateModalChannelSelect

new_modal_channel_select_with_channel_types

</> 
pub fn new_modal_channel_select_with_channel_types(
  create: CreateModalChannelSelect,
  channel_types: List(SelectChannelType),
) -> CreateModalChannelSelect

Which channel types are to be included in the select window.

new_modal_channel_select_with_default_channels

</> 
pub fn new_modal_channel_select_with_default_channels(
  create: CreateModalChannelSelect,
  default_channels: List(Snowflake(Channel)),
) -> CreateModalChannelSelect

Which channels are to be selected by default.

new_modal_channel_select_with_id

</> 
pub fn new_modal_channel_select_with_id(
  create: CreateModalChannelSelect,
  id: Int,
) -> CreateModalChannelSelect

new_modal_channel_select_with_max_values

</> 
pub fn new_modal_channel_select_with_max_values(
  create: CreateModalChannelSelect,
  max_values: Int,
) -> CreateModalChannelSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_modal_channel_select_with_min_values

</> 
pub fn new_modal_channel_select_with_min_values(
  create: CreateModalChannelSelect,
  min_values: Int,
) -> CreateModalChannelSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_modal_channel_select_with_placeholder

</> 
pub fn new_modal_channel_select_with_placeholder(
  create: CreateModalChannelSelect,
  placeholder: String,
) -> CreateModalChannelSelect

Shown when no value is selected. Maximum 150 characters.

new_modal_checkbox

</> 
pub fn new_modal_checkbox(
  custom_id custom_id: String,
) -> CreateModalCheckbox

new_modal_checkbox_group

</> 
pub fn new_modal_checkbox_group(
  custom_id custom_id: String,
  options options: List(CreateCheckboxGroupOption),
) -> CreateModalCheckboxGroup

new_modal_checkbox_group_with_max_values

</> 
pub fn new_modal_checkbox_group_with_max_values(
  create: CreateModalCheckboxGroup,
  max_values: Int,
) -> CreateModalCheckboxGroup

Must be between 1 and 10.

new_modal_checkbox_group_with_min_values

</> 
pub fn new_modal_checkbox_group_with_min_values(
  create: CreateModalCheckboxGroup,
  min_values: Int,
) -> CreateModalCheckboxGroup

Must be between 1 and 10 if not optional.

Can be 0 if optional.

new_modal_checkbox_with_id

</> 
pub fn new_modal_checkbox_with_id(
  create: CreateModalCheckbox,
  id: Int,
) -> CreateModalCheckbox

new_modal_file_upload

</> 
pub fn new_modal_file_upload(
  custom_id custom_id: String,
) -> CreateModalFileUpload

new_modal_file_upload_with_file_type_filter

</> 
pub fn new_modal_file_upload_with_file_type_filter(
  create: CreateModalFileUpload,
  filter: List(FileUploadFilter),
) -> CreateModalFileUpload

Providing an empty list will deny all files.

new_modal_file_upload_with_id

</> 
pub fn new_modal_file_upload_with_id(
  create: CreateModalFileUpload,
  id: Int,
) -> CreateModalFileUpload

new_modal_file_upload_with_max_values

</> 
pub fn new_modal_file_upload_with_max_values(
  create: CreateModalFileUpload,
  max_values: Int,
) -> CreateModalFileUpload

Must be between 1 and 10.

new_modal_file_upload_with_min_values

</> 
pub fn new_modal_file_upload_with_min_values(
  create: CreateModalFileUpload,
  min_values: Int,
) -> CreateModalFileUpload

Must be between 0 and 10.

new_modal_label

</> 
pub fn new_modal_label(
  text label: String,
  component component: CreateModalLabelComponent,
) -> CreateModalLabel

The text must be maximum 45 characters.

new_modal_label_with_description

</> 
pub fn new_modal_label_with_description(
  label: CreateModalLabel,
  description: String,
) -> CreateModalLabel

The description must be maximum 100 characters.

new_modal_label_with_id

</> 
pub fn new_modal_label_with_id(
  label: CreateModalLabel,
  id: Int,
) -> CreateModalLabel

new_modal_mentionable_select

</> 
pub fn new_modal_mentionable_select(
  custom_id custom_id: String,
) -> CreateModalMentionableSelect

new_modal_mentionable_select_with_default_roles

</> 
pub fn new_modal_mentionable_select_with_default_roles(
  create: CreateModalMentionableSelect,
  default_roles: List(Snowflake(Role)),
) -> CreateModalMentionableSelect

Which roles are to be selected by default.

new_modal_mentionable_select_with_default_users

</> 
pub fn new_modal_mentionable_select_with_default_users(
  create: CreateModalMentionableSelect,
  default_users: List(Snowflake(User)),
) -> CreateModalMentionableSelect

Which users are to be selected by default.

new_modal_mentionable_select_with_id

</> 
pub fn new_modal_mentionable_select_with_id(
  create: CreateModalMentionableSelect,
  id: Int,
) -> CreateModalMentionableSelect

new_modal_mentionable_select_with_max_values

</> 
pub fn new_modal_mentionable_select_with_max_values(
  create: CreateModalMentionableSelect,
  max_values: Int,
) -> CreateModalMentionableSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_modal_mentionable_select_with_min_values

</> 
pub fn new_modal_mentionable_select_with_min_values(
  create: CreateModalMentionableSelect,
  min_values: Int,
) -> CreateModalMentionableSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_modal_mentionable_select_with_placeholder

</> 
pub fn new_modal_mentionable_select_with_placeholder(
  create: CreateModalMentionableSelect,
  placeholder: String,
) -> CreateModalMentionableSelect

Shown when no value is selected. Maximum 150 characters.

new_modal_radio_group

</> 
pub fn new_modal_radio_group(
  custom_id custom_id: String,
  options options: List(CreateRadioGroupOption),
) -> CreateModalRadioGroup

new_modal_radio_group_with_id

</> 
pub fn new_modal_radio_group_with_id(
  create: CreateModalRadioGroup,
  id: Int,
) -> CreateModalRadioGroup

new_modal_role_select

</> 
pub fn new_modal_role_select(
  custom_id custom_id: String,
) -> CreateModalRoleSelect

new_modal_role_select_with_default_roles

</> 
pub fn new_modal_role_select_with_default_roles(
  create: CreateModalRoleSelect,
  default_roles: List(Snowflake(Role)),
) -> CreateModalRoleSelect

Which roles are to be selected by default.

new_modal_role_select_with_id

</> 
pub fn new_modal_role_select_with_id(
  create: CreateModalRoleSelect,
  id: Int,
) -> CreateModalRoleSelect

new_modal_role_select_with_max_values

</> 
pub fn new_modal_role_select_with_max_values(
  create: CreateModalRoleSelect,
  max_values: Int,
) -> CreateModalRoleSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_modal_role_select_with_min_values

</> 
pub fn new_modal_role_select_with_min_values(
  create: CreateModalRoleSelect,
  min_values: Int,
) -> CreateModalRoleSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_modal_role_select_with_placeholder

</> 
pub fn new_modal_role_select_with_placeholder(
  create: CreateModalRoleSelect,
  placeholder: String,
) -> CreateModalRoleSelect

Shown when no value is selected. Maximum 150 characters.

new_modal_string_select

</> 
pub fn new_modal_string_select(
  custom_id: String,
  options: List(StringSelectOption),
) -> CreateModalStringSelect

new_modal_string_select_with_id

</> 
pub fn new_modal_string_select_with_id(
  create: CreateModalStringSelect,
  id: Int,
) -> CreateModalStringSelect

new_modal_string_select_with_max_values

</> 
pub fn new_modal_string_select_with_max_values(
  create: CreateModalStringSelect,
  max_values: Int,
) -> CreateModalStringSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_modal_string_select_with_min_values

</> 
pub fn new_modal_string_select_with_min_values(
  create: CreateModalStringSelect,
  min_values: Int,
) -> CreateModalStringSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_modal_string_select_with_placeholder

</> 
pub fn new_modal_string_select_with_placeholder(
  create: CreateModalStringSelect,
  placeholder: String,
) -> CreateModalStringSelect

The placeholder will be shown when no value is selected.

Maximum 150 characters.

new_modal_text_display

</> 
pub fn new_modal_text_display(
  content content: String,
) -> CreateModalTextDisplay

new_modal_text_display_with_id

</> 
pub fn new_modal_text_display_with_id(
  text_display: CreateModalTextDisplay,
  id: Int,
) -> CreateModalTextDisplay

new_modal_text_input

</> 
pub fn new_modal_text_input(
  custom_id custom_id: String,
  style style: TextInputStyle,
) -> CreateModalTextInput

The custom ID must be between 1 and 100 characters.

new_modal_text_input_with_id

</> 
pub fn new_modal_text_input_with_id(
  create: CreateModalTextInput,
  id: Int,
) -> CreateModalTextInput

new_modal_text_input_with_max_length

</> 
pub fn new_modal_text_input_with_max_length(
  create: CreateModalTextInput,
  max_length: Int,
) -> CreateModalTextInput

Must be between 1 and 4000.

new_modal_text_input_with_min_length

</> 
pub fn new_modal_text_input_with_min_length(
  create: CreateModalTextInput,
  min_length: Int,
) -> CreateModalTextInput

Must be between 0 and 4000.

new_modal_text_input_with_placeholder

</> 
pub fn new_modal_text_input_with_placeholder(
  create: CreateModalTextInput,
  placeholder: String,
) -> CreateModalTextInput

new_modal_text_input_with_prefilled_value

</> 
pub fn new_modal_text_input_with_prefilled_value(
  create: CreateModalTextInput,
  value: String,
) -> CreateModalTextInput

new_modal_user_select

</> 
pub fn new_modal_user_select(
  custom_id custom_id: String,
) -> CreateModalUserSelect

new_modal_user_select_with_default_users

</> 
pub fn new_modal_user_select_with_default_users(
  create: CreateModalUserSelect,
  default_users: List(Snowflake(User)),
) -> CreateModalUserSelect

Which users are to be selected by default.

new_modal_user_select_with_id

</> 
pub fn new_modal_user_select_with_id(
  create: CreateModalUserSelect,
  id: Int,
) -> CreateModalUserSelect

new_modal_user_select_with_max_values

</> 
pub fn new_modal_user_select_with_max_values(
  create: CreateModalUserSelect,
  max_values: Int,
) -> CreateModalUserSelect

Maximum amount of selected values, default 1.

Must be between 1 and 25.

new_modal_user_select_with_min_values

</> 
pub fn new_modal_user_select_with_min_values(
  create: CreateModalUserSelect,
  min_values: Int,
) -> CreateModalUserSelect

Minimum amount of selected values, default 1.

Must be between 0 and 25.

new_modal_user_select_with_placeholder

</> 
pub fn new_modal_user_select_with_placeholder(
  create: CreateModalUserSelect,
  placeholder: String,
) -> CreateModalUserSelect

Shown when no value is selected. Maximum 150 characters.

new_modify_announcement_channel

</> 
pub fn new_modify_announcement_channel() -> ModifyAnnouncementChannel

new_modify_category_channel

</> 
pub fn new_modify_category_channel() -> ModifyCategoryChannel

new_modify_current_application

</> 
pub fn new_modify_current_application() -> ModifyCurrentApplication

new_modify_current_guild_member

</> 
pub fn new_modify_current_guild_member() -> ModifyCurrentGuildMember

new_modify_current_user

</> 
pub fn new_modify_current_user() -> ModifyCurrentUser

new_modify_forum_channel

</> 
pub fn new_modify_forum_channel() -> ModifyForumChannel

new_modify_guild

</> 
pub fn new_modify_guild() -> ModifyGuild

new_modify_guild_channel_position

</> 
pub fn new_modify_guild_channel_position(
  of_channel_with_id id: Snowflake(GuildChannel),
) -> ModifyGuildChannelPosition

new_modify_guild_incidents_data

</> 
pub fn new_modify_guild_incidents_data() -> ModifyGuildIncidentsData

new_modify_guild_member

</> 
pub fn new_modify_guild_member() -> ModifyGuildMember

new_modify_guild_soundboard_sound

</> 
pub fn new_modify_guild_soundboard_sound() -> ModifyGuildSoundboardSound

new_modify_guild_sticker

</> 
pub fn new_modify_guild_sticker() -> ModifyGuildSticker

new_modify_guild_welcome_screen

</> 
pub fn new_modify_guild_welcome_screen() -> ModifyGuildWelcomeScreen

new_modify_guild_widget_settings

</> 
pub fn new_modify_guild_widget_settings() -> ModifyGuildWidgetSettings

new_modify_interaction_response

</> 
pub fn new_modify_interaction_response() -> ModifyInteractionResponseMessage

new_modify_media_channel

</> 
pub fn new_modify_media_channel() -> ModifyMediaChannel

new_modify_message

</> 
pub fn new_modify_message() -> ModifyMessage

new_modify_role

</> 
pub fn new_modify_role() -> ModifyRole

new_modify_stage_channel

</> 
pub fn new_modify_stage_channel() -> ModifyStageChannel

new_modify_text_channel

</> 
pub fn new_modify_text_channel() -> ModifyTextChannel

new_modify_thread

</> 
pub fn new_modify_thread() -> ModifyThread

new_modify_voice_channel

</> 
pub fn new_modify_voice_channel() -> ModifyVoiceChannel

new_nsfw_announcement_channel

</> 
pub fn new_nsfw_announcement_channel(
  create: CreateAnnouncementChannel,
) -> CreateAnnouncementChannel

Creates an age-restricted announcement channel.

new_nsfw_global_message_command

</> 
pub fn new_nsfw_global_message_command(
  create: CreateGlobalMessageCommand,
) -> CreateGlobalMessageCommand

This will only make the command usable in NSFW contexts.

new_nsfw_global_slash_command

</> 
pub fn new_nsfw_global_slash_command(
  create: CreateGlobalSlashCommand,
) -> CreateGlobalSlashCommand

This will only make the command usable in NSFW contexts.

new_nsfw_global_user_command

</> 
pub fn new_nsfw_global_user_command(
  create: CreateGlobalUserCommand,
) -> CreateGlobalUserCommand

This will only make the command usable in NSFW contexts.

new_nsfw_guild_message_command

</> 
pub fn new_nsfw_guild_message_command(
  create: CreateGuildMessageCommand,
) -> CreateGuildMessageCommand

This will only make the command usable in NSFW contexts.

new_nsfw_guild_slash_command

</> 
pub fn new_nsfw_guild_slash_command(
  create: CreateGuildSlashCommand,
) -> CreateGuildSlashCommand

This will only make the command usable in NSFW contexts.

new_nsfw_guild_user_command

</> 
pub fn new_nsfw_guild_user_command(
  create: CreateGuildUserCommand,
) -> CreateGuildUserCommand

This will only make the command usable in NSFW contexts.

new_nsfw_stage_channel

</> 
pub fn new_nsfw_stage_channel(
  create: CreateStageChannel,
) -> CreateStageChannel

Creates an age-restricted stage channel.

new_nsfw_text_channel

</> 
pub fn new_nsfw_text_channel(
  create: CreateTextChannel,
) -> CreateTextChannel

Creates an age-restricted text channel.

new_nsfw_voice_channel

</> 
pub fn new_nsfw_voice_channel(
  create: CreateVoiceChannel,
) -> CreateVoiceChannel

Creates an age-restricted voice channel.

new_optional_modal_channel_select

</> 
pub fn new_optional_modal_channel_select(
  create: CreateModalChannelSelect,
) -> CreateModalChannelSelect

new_optional_modal_checkbox_group

</> 
pub fn new_optional_modal_checkbox_group(
  create: CreateModalCheckboxGroup,
) -> CreateModalCheckboxGroup

new_optional_modal_file_upload

</> 
pub fn new_optional_modal_file_upload(
  create: CreateModalFileUpload,
) -> CreateModalFileUpload

new_optional_modal_mentionable_select

</> 
pub fn new_optional_modal_mentionable_select(
  create: CreateModalMentionableSelect,
) -> CreateModalMentionableSelect

new_optional_modal_radio_group

</> 
pub fn new_optional_modal_radio_group(
  create: CreateModalRadioGroup,
) -> CreateModalRadioGroup

new_optional_modal_role_select

</> 
pub fn new_optional_modal_role_select(
  create: CreateModalRoleSelect,
) -> CreateModalRoleSelect

new_optional_modal_string_select

</> 
pub fn new_optional_modal_string_select(
  create: CreateModalStringSelect,
) -> CreateModalStringSelect

new_optional_modal_text_input

</> 
pub fn new_optional_modal_text_input(
  create: CreateModalTextInput,
) -> CreateModalTextInput

new_optional_modal_user_select

</> 
pub fn new_optional_modal_user_select(
  create: CreateModalUserSelect,
) -> CreateModalUserSelect

new_poll

</> 
pub fn new_poll(
  asking question: String,
  answers answers: List(CreatePollAnswer),
) -> CreatePoll

Defaults:

  • duration - 24 hours
  • doesn’t allow multiselect

new_poll_allowing_multiselect

</> 
pub fn new_poll_allowing_multiselect(
  create: CreatePoll,
) -> CreatePoll

new_poll_answer

</> 
pub fn new_poll_answer(text text: String) -> CreatePollAnswer

Text must be maximum 55 characters.

new_poll_answer_with_emoji

</> 
pub fn new_poll_answer_with_emoji(
  create: CreatePollAnswer,
  emoji: CreatePollAnswerEmoji,
) -> CreatePollAnswer

new_poll_with_duration

</> 
pub fn new_poll_with_duration(
  create: CreatePoll,
  duration: duration.Duration,
) -> CreatePoll

Duration must be max 32 days. Duration is rounded to the nearest hour.

new_premium_button

</> 
pub fn new_premium_button(
  for_sku_with_id sku_id: Snowflake(Sku),
) -> CreatePremiumButton

new_premium_button_with_id

</> 
pub fn new_premium_button_with_id(
  create: CreatePremiumButton,
  id: Int,
) -> CreatePremiumButton

new_prune_guild

</> 
pub fn new_prune_guild() -> PruneGuild

Defaults:

  • days: 7
  • include_roles: None

new_radio_group_option

</> 
pub fn new_radio_group_option(
  label label: String,
  value value: String,
) -> CreateRadioGroupOption

Label and value must each be up to 100 characters.

new_radio_group_option_with_description

</> 
pub fn new_radio_group_option_with_description(
  create: CreateRadioGroupOption,
  description: String,
) -> CreateRadioGroupOption

Description must be up to 100 characters.

new_regular_button

</> 
pub fn new_regular_button(
  custom_id custom_id: String,
  style style: RegularButtonStyle,
) -> CreateRegularButton

Custom ID must be between 1 and 100 characters.

new_regular_button_with_emoji

</> 
pub fn new_regular_button_with_emoji(
  create: CreateRegularButton,
  emoji: ComponentEmoji,
) -> CreateRegularButton

new_regular_button_with_id

</> 
pub fn new_regular_button_with_id(
  create: CreateRegularButton,
  id: Int,
) -> CreateRegularButton

new_regular_button_with_label

</> 
pub fn new_regular_button_with_label(
  create: CreateRegularButton,
  label: String,
) -> CreateRegularButton

Label must be max 80 characters.

new_reply_message_reference

</> 
pub fn new_reply_message_reference(
  original_message_id original_message_id: Snowflake(Message),
  original_guild_id original_guild_id: option.Option(
    Snowflake(Guild),
  ),
) -> CreateMessageReference

Allows you to make a new message be a reply to another message.

You MUST include the original guild ID unless the message was sent in a DM.

Requires the AllowReadingMessageHistory permission.

new_required_attachment_slash_command_option

</> 
pub fn new_required_attachment_slash_command_option(
  option: AttachmentSlashCommandOption,
) -> AttachmentSlashCommandOption

new_required_bool_slash_command_option

</> 
pub fn new_required_bool_slash_command_option(
  option: BoolSlashCommandOption,
) -> BoolSlashCommandOption

new_required_channel_slash_command_option

</> 
pub fn new_required_channel_slash_command_option(
  option: ChannelSlashCommandOption,
) -> ChannelSlashCommandOption

new_required_float_slash_command_option

</> 
pub fn new_required_float_slash_command_option(
  option: FloatSlashCommandOption,
) -> FloatSlashCommandOption

new_required_int_slash_command_option

</> 
pub fn new_required_int_slash_command_option(
  option: IntSlashCommandOption,
) -> IntSlashCommandOption

new_required_mentionable_slash_command_option

</> 
pub fn new_required_mentionable_slash_command_option(
  option: MentionableSlashCommandOption,
) -> MentionableSlashCommandOption

new_required_role_slash_command_option

</> 
pub fn new_required_role_slash_command_option(
  option: RoleSlashCommandOption,
) -> RoleSlashCommandOption

new_required_string_slash_command_option

</> 
pub fn new_required_string_slash_command_option(
  option: StringSlashCommandOption,
) -> StringSlashCommandOption

new_required_user_slash_command_option

</> 
pub fn new_required_user_slash_command_option(
  option: UserSlashCommandOption,
) -> UserSlashCommandOption

new_role

</> 
pub fn new_role() -> CreateRole

Defaults:

  • name: “new role”
  • permissions: the same as the guild @everyone permissions
  • colours: { primary: 0, secondary: null, tertiary: null }
  • is_hoisted: false
  • icon: null
  • unicode_emoji: null
  • is_mentionable: false

new_role_colours

</> 
pub fn new_role_colours() -> RoleColours

new_role_request

</> 
pub fn new_role_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateRole,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingRoles permission.

new_role_response

</> 
pub fn new_role_response(
  response: response.Response(String),
) -> Result(Role, RestError)

new_role_slash_command_option

</> 
pub fn new_role_slash_command_option(
  named name: String,
  with_description description: String,
) -> RoleSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_role_slash_command_option_with_description_localizations

</> 
pub fn new_role_slash_command_option_with_description_localizations(
  option: RoleSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> RoleSlashCommandOption

The description must be between 1 and 100 characters.

new_role_slash_command_option_with_name_localizations

</> 
pub fn new_role_slash_command_option_with_name_localizations(
  option: RoleSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> RoleSlashCommandOption

The name must be between 1 and 32 characters.

new_role_with_colours

</> 
pub fn new_role_with_colours(
  create: CreateRole,
  colours: RoleColours,
) -> CreateRole

new_role_with_icon

</> 
pub fn new_role_with_icon(
  create: CreateRole,
  icon: ImageData,
) -> CreateRole

Requires the GuildCanUseRoleIcons feature.

new_role_with_name

</> 
pub fn new_role_with_name(
  create: CreateRole,
  name: String,
) -> CreateRole

new_role_with_permissions

</> 
pub fn new_role_with_permissions(
  create: CreateRole,
  permissions: List(Permission),
) -> CreateRole

Controls the role’s guild-wide permissions.

new_role_with_unicode_emoji

</> 
pub fn new_role_with_unicode_emoji(
  create: CreateRole,
  emoji: String,
) -> CreateRole

Requires the GuildCanUseRoleIcons feature.

Accepts a unicode emoji character (e.g. 🔨)

new_snowflake

</> 
pub fn new_snowflake(from id: Int) -> Snowflake(a)

Used for creating arbitary snowflakes.

This should only be used for hardcoding values or retrieving IDs from a database.

Don’t use this function to change Snowflake(a) to a Snowflake(b).

Example usage:

let guild_id: Snowflake(Guild) = new_snowflake(768594524158427167)
</> 
pub fn new_spoiler_media_gallery_item(
  create: CreateMediaGalleryItem,
) -> CreateMediaGalleryItem

new_spoiler_message_attachment

</> 
pub fn new_spoiler_message_attachment(
  create: CreateMessageAttachment,
) -> CreateMessageAttachment

new_spoiler_message_container

</> 
pub fn new_spoiler_message_container(
  create: CreateMessageContainer,
) -> CreateMessageContainer

new_spoiler_message_file

</> 
pub fn new_spoiler_message_file(
  create: CreateMessageFile,
) -> CreateMessageFile

new_spoiler_message_thumbnail

</> 
pub fn new_spoiler_message_thumbnail(
  create: CreateMessageThumbnail,
) -> CreateMessageThumbnail

new_stage_channel

</> 
pub fn new_stage_channel(
  named name: String,
) -> CreateStageChannel

new_stage_channel_at_position

</> 
pub fn new_stage_channel_at_position(
  create: CreateStageChannel,
  position: Int,
) -> CreateStageChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list. Channels with the same position are sorted by ID (new channel will be lower)

new_stage_channel_request

</> 
pub fn new_stage_channel_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateStageChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

new_stage_channel_response

</> 
pub fn new_stage_channel_response(
  response: response.Response(String),
) -> Result(StageChannel, RestError)

new_stage_channel_with_bitrate

</> 
pub fn new_stage_channel_with_bitrate(
  create: CreateStageChannel,
  bitrate: Int,
) -> CreateStageChannel

Bitrate is expressed in bits per second.

Maximum bitrate for every premium tier:

  • No premium tier - 96000
  • Premium tier 1 - 128000
  • Premium tier 2 - 256000
  • Premium tier 3 - 384000

Additionally, servers with the GuildCanUse384KbpsstageBitrate can specify the bitrate up to 384000.

new_stage_channel_with_parent_id

</> 
pub fn new_stage_channel_with_parent_id(
  create: CreateStageChannel,
  parent_id: Snowflake(CategoryChannel),
) -> CreateStageChannel

Puts the channel in a category. Channels without a parent ID will not be in a category, and will rather be independent in the server list.

new_stage_channel_with_permission_overwrites

</> 
pub fn new_stage_channel_with_permission_overwrites(
  create: CreateStageChannel,
  overwrites: List(PermissionOverwrite),
) -> CreateStageChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

new_stage_channel_with_rate_limit_per_user

</> 
pub fn new_stage_channel_with_rate_limit_per_user(
  create: CreateStageChannel,
  limit: RateLimitPerUser,
) -> CreateStageChannel

The rate limit per user amount of time that a user has to wait between sending messages in the stage-channel attached text channel.

new_stage_channel_with_rtc_region_id

</> 
pub fn new_stage_channel_with_rtc_region_id(
  create: CreateStageChannel,
  id: String,
) -> CreateStageChannel

Manually sets the stage channel’s region.

new_stage_channel_with_user_limit

</> 
pub fn new_stage_channel_with_user_limit(
  create: CreateStageChannel,
  user_limit: Int,
) -> CreateStageChannel

new_stage_channel_with_video_quality_mode

</> 
pub fn new_stage_channel_with_video_quality_mode(
  create: CreateStageChannel,
  mode: VideoQualityMode,
) -> CreateStageChannel

new_stage_instance

</> 
pub fn new_stage_instance(
  in_channel_with_id channel_id: Snowflake(StageChannel),
  topic topic: String,
) -> CreateStageInstance

new_stage_instance_for_scheduled_event

</> 
pub fn new_stage_instance_for_scheduled_event(
  create: CreateStageInstance,
  scheduled_event_with_id scheduled_event_id: Snowflake(
    ScheduledEvent,
  ),
) -> CreateStageInstance

new_stage_instance_request

</> 
pub fn new_stage_instance_request(
  token token: Token,
  using create: CreateStageInstance,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels, AllowMutingMembersInVoiceChannels, and AllowMovingMembersBetweenVoiceChannels permissions.

new_stage_instance_response

</> 
pub fn new_stage_instance_response(
  response: response.Response(String),
) -> Result(StageInstance, RestError)

Requires the AllowManagingChannels, AllowMutingMembersInVoiceChannels, and AllowMovingMembersBetweenVoiceChannels permissions.

new_stage_instance_with_start_notification

</> 
pub fn new_stage_instance_with_start_notification(
  create: CreateStageInstance,
) -> CreateStageInstance

Notifies @everyone about the stage instance starting.

Requires the AllowMentioningEveryone permission.

new_string_select_option

</> 
pub fn new_string_select_option(
  label label: String,
  value value: String,
) -> StringSelectOption

Label is user-facing, value is dev-facing.

new_string_select_option_with_description

</> 
pub fn new_string_select_option_with_description(
  option: StringSelectOption,
  description: String,
) -> StringSelectOption

Description must be max 100 characters.

new_string_slash_command_option

</> 
pub fn new_string_slash_command_option(
  named name: String,
  with_description description: String,
) -> StringSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_string_slash_command_option_choice

</> 
pub fn new_string_slash_command_option_choice(
  named name: String,
  value value: String,
) -> StringSlashCommandOptionChoice

Name and value must be between 1 and 100 characters each.

new_string_slash_command_option_choice_with_name_localizations

</> 
pub fn new_string_slash_command_option_choice_with_name_localizations(
  choice: StringSlashCommandOptionChoice,
  localizations: dict.Dict(Locale, String),
) -> StringSlashCommandOptionChoice

Name must be between 1 and 100 characters.

new_string_slash_command_option_with_choices

</> 
pub fn new_string_slash_command_option_with_choices(
  option: StringSlashCommandOption,
  choices: List(StringSlashCommandOptionChoice),
) -> StringSlashCommandOption

If you hard-code choices, you cannot enable autocomplete.

There is a limit of 25 choices per option.

new_string_slash_command_option_with_description_localizations

</> 
pub fn new_string_slash_command_option_with_description_localizations(
  option: StringSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> StringSlashCommandOption

The description must be between 1 and 100 characters.

new_string_slash_command_option_with_enabled_autocomplete

</> 
pub fn new_string_slash_command_option_with_enabled_autocomplete(
  option: StringSlashCommandOption,
) -> StringSlashCommandOption

Used for dynamic suggestion of choices based on user input.

The provided suggestions are not the only possible choices, and the user can still input anything, provided it fits in the character range.

You cannot use hard-coded choices if autocomplete is enabled.

new_string_slash_command_option_with_maximum_length

</> 
pub fn new_string_slash_command_option_with_maximum_length(
  option: StringSlashCommandOption,
  length: Int,
) -> StringSlashCommandOption

The maximum length must be between 1 and 6000.

new_string_slash_command_option_with_minimum_length

</> 
pub fn new_string_slash_command_option_with_minimum_length(
  option: StringSlashCommandOption,
  length: Int,
) -> StringSlashCommandOption

The minimum length must be between 0 and 6000.

new_string_slash_command_option_with_name_localizations

</> 
pub fn new_string_slash_command_option_with_name_localizations(
  option: StringSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> StringSlashCommandOption

The name must be between 1 and 32 characters.

new_sub_command

</> 
pub fn new_sub_command(
  named name: String,
  with_description description: String,
) -> SubCommandSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_sub_command_group

</> 
pub fn new_sub_command_group(
  named name: String,
  with_description description: String,
) -> SubCommandGroupSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_sub_command_group_with_description_localizations

</> 
pub fn new_sub_command_group_with_description_localizations(
  sub_command_group: SubCommandGroupSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> SubCommandGroupSlashCommandOption

The description must be between 1 and 100 characters.

new_sub_command_group_with_name_localizations

</> 
pub fn new_sub_command_group_with_name_localizations(
  sub_command_group: SubCommandGroupSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> SubCommandGroupSlashCommandOption

The name must be between 1 and 32 characters.

new_sub_command_group_with_options

</> 
pub fn new_sub_command_group_with_options(
  sub_command_group: SubCommandGroupSlashCommandOption,
  options: List(SubCommandGroupOption),
) -> SubCommandGroupSlashCommandOption

new_sub_command_with_description_localizations

</> 
pub fn new_sub_command_with_description_localizations(
  sub_command: SubCommandSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> SubCommandSlashCommandOption

The description must be between 1 and 100 characters.

new_sub_command_with_name_localizations

</> 
pub fn new_sub_command_with_name_localizations(
  sub_command: SubCommandSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> SubCommandSlashCommandOption

The name must be between 1 and 32 characters.

new_sub_command_with_options

</> 
pub fn new_sub_command_with_options(
  sub_command: SubCommandSlashCommandOption,
  options: List(SubCommandOption),
) -> SubCommandSlashCommandOption

Required options must come before optional ones.

new_temporary_guild_channel_invite

</> 
pub fn new_temporary_guild_channel_invite(
  create: CreateGuildChannelInvite,
) -> CreateGuildChannelInvite

A temporary invite only grants temporary membership.

new_text_channel

</> 
pub fn new_text_channel(named name: String) -> CreateTextChannel

Requires the AllowManagingChannels permission.

new_text_channel_at_position

</> 
pub fn new_text_channel_at_position(
  create: CreateTextChannel,
  position: Int,
) -> CreateTextChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list. Channels with the same position are sorted by ID (new channel will be lower)

new_text_channel_request

</> 
pub fn new_text_channel_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateTextChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

new_text_channel_response

</> 
pub fn new_text_channel_response(
  response: response.Response(String),
) -> Result(TextChannel, RestError)

new_text_channel_with_parent_id

</> 
pub fn new_text_channel_with_parent_id(
  create: CreateTextChannel,
  parent_id: Snowflake(CategoryChannel),
) -> CreateTextChannel

Puts the channel in a category. Channels without a parent ID will not be in a category, and will rather be independent in the server list.

new_text_channel_with_permission_overwrites

</> 
pub fn new_text_channel_with_permission_overwrites(
  create: CreateTextChannel,
  overwrites: List(PermissionOverwrite),
) -> CreateTextChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

new_text_channel_with_rate_limit_per_user

</> 
pub fn new_text_channel_with_rate_limit_per_user(
  create: CreateTextChannel,
  rate_limit_per_user: RateLimitPerUser,
) -> CreateTextChannel

The rate limit per user is the amount of time a user has to wait between sending messages.

new_text_channel_with_thread_auto_archive_duration

</> 
pub fn new_text_channel_with_thread_auto_archive_duration(
  create: CreateTextChannel,
  duration: ThreadAutoArchiveDuration,
) -> CreateTextChannel

Controls the default amount of time after which inactive threads are archived in the channel.

new_text_channel_with_thread_rate_limit_per_user

</> 
pub fn new_text_channel_with_thread_rate_limit_per_user(
  create: CreateTextChannel,
  rate_limit_per_user: RateLimitPerUser,
) -> CreateTextChannel

The default thread rate limit per user. This value gets copied to every thread and does not live-update.

new_text_channel_with_topic

</> 
pub fn new_text_channel_with_topic(
  create: CreateTextChannel,
  topic: String,
) -> CreateTextChannel

new_thread

</> 
pub fn new_thread(
  named name: String,
  of_type type_: ThreadType,
) -> CreateThread

new_thread_from_message

</> 
pub fn new_thread_from_message(
  named name: String,
) -> CreateThreadFromMessage

new_thread_from_message_request

</> 
pub fn new_thread_from_message_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(ThreadCreatableChannel),
  message_with_id message_id: Snowflake(Message),
  using create: CreateThreadFromMessage,
  reason reason: option.Option(String),
) -> request.Request(String)

Behavior:

  • in text channels - creates a PublicThread
  • in announcement channels - creates an AnnouncementThread
  • the ID of the created thread will be the same as the message’s ID
  • you can only create 1 thread per message

new_thread_from_message_response

</> 
pub fn new_thread_from_message_response(
  response: response.Response(String),
) -> Result(Thread, RestError)

new_thread_from_message_with_auto_archive_duration

</> 
pub fn new_thread_from_message_with_auto_archive_duration(
  create: CreateThreadFromMessage,
  duration: ThreadAutoArchiveDuration,
) -> CreateThreadFromMessage

new_thread_from_message_with_rate_limit_per_user

</> 
pub fn new_thread_from_message_with_rate_limit_per_user(
  create: CreateThreadFromMessage,
  limit: RateLimitPerUser,
) -> CreateThreadFromMessage

new_thread_request

</> 
pub fn new_thread_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(ThreadCreatableChannel),
  using create: CreateThread,
  reason reason: option.Option(String),
) -> request.Request(String)

new_thread_with_auto_archive_duration

</> 
pub fn new_thread_with_auto_archive_duration(
  create: CreateThread,
  duration: ThreadAutoArchiveDuration,
) -> CreateThread

new_thread_with_rate_limit_per_user

</> 
pub fn new_thread_with_rate_limit_per_user(
  create: CreateThread,
  limit: RateLimitPerUser,
) -> CreateThread

new_tts_interaction_response_message

</> 
pub fn new_tts_interaction_response_message(
  message: InteractionResponseMessage,
) -> InteractionResponseMessage

Makes the message be read out loud using text-to-speech.

Requires the AllowSendingTtsMessages permission and content to be set.

new_tts_message

</> 
pub fn new_tts_message(create: CreateMessage) -> CreateMessage

A text-to-speech message will be read out-loud to all readers.

Requires the AllowSendingTtsMessages permission.

new_unfurled_media_item

</> 
pub fn new_unfurled_media_item(
  url url: String,
) -> CreateUnfurledMediaItem

Supports HTTPS and attachment URLs.

new_unique_guild_channel_invite

</> 
pub fn new_unique_guild_channel_invite(
  create: CreateGuildChannelInvite,
) -> CreateGuildChannelInvite

Will force creating a new code, won’t reuse similar invites.

new_user_slash_command_option

</> 
pub fn new_user_slash_command_option(
  named name: String,
  with_description description: String,
) -> UserSlashCommandOption

The name must be between 1 and 32 characters.

The description must be between 1 and 100 characters.

new_user_slash_command_option_with_description_localizations

</> 
pub fn new_user_slash_command_option_with_description_localizations(
  option: UserSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> UserSlashCommandOption

The description must be between 1 and 100 characters.

new_user_slash_command_option_with_name_localizations

</> 
pub fn new_user_slash_command_option_with_name_localizations(
  option: UserSlashCommandOption,
  localizations: dict.Dict(Locale, String),
) -> UserSlashCommandOption

The name must be between 1 and 32 characters.

new_voice_channel

</> 
pub fn new_voice_channel(
  named name: String,
) -> CreateVoiceChannel

new_voice_channel_at_position

</> 
pub fn new_voice_channel_at_position(
  create: CreateVoiceChannel,
  position: Int,
) -> CreateVoiceChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list. Channels with the same position are sorted by ID (new channel will be lower)

new_voice_channel_request

</> 
pub fn new_voice_channel_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  using create: CreateVoiceChannel,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingChannels permission.

new_voice_channel_response

</> 
pub fn new_voice_channel_response(
  response: response.Response(String),
) -> Result(VoiceChannel, RestError)

new_voice_channel_with_bitrate

</> 
pub fn new_voice_channel_with_bitrate(
  create: CreateVoiceChannel,
  bitrate: Int,
) -> CreateVoiceChannel

Bitrate is expressed in bits per second.

Maximum bitrate for every premium tier:

  • No premium tier - 96000
  • Premium tier 1 - 128000
  • Premium tier 2 - 256000
  • Premium tier 3 - 384000

Additionally, servers with the GuildCanUse384KbpsVoiceBitrate can specify the bitrate up to 384000.

new_voice_channel_with_parent_id

</> 
pub fn new_voice_channel_with_parent_id(
  create: CreateVoiceChannel,
  parent_id: Snowflake(CategoryChannel),
) -> CreateVoiceChannel

Puts the channel in a category. Channels without a parent ID will not be in a category, and will rather be independent in the server list.

new_voice_channel_with_permission_overwrites

</> 
pub fn new_voice_channel_with_permission_overwrites(
  create: CreateVoiceChannel,
  overwrites: List(PermissionOverwrite),
) -> CreateVoiceChannel

You can only allow/deny permissions if your bot has those permissions. Setting the AllowManagingRoles permission requires your bot to have the AdministratorPermission.

new_voice_channel_with_rate_limit_per_user

</> 
pub fn new_voice_channel_with_rate_limit_per_user(
  create: CreateVoiceChannel,
  limit: RateLimitPerUser,
) -> CreateVoiceChannel

The rate limit per user amount of time that a user has to wait between sending messages in the voice-channel attached text channel.

new_voice_channel_with_rtc_region_id

</> 
pub fn new_voice_channel_with_rtc_region_id(
  create: CreateVoiceChannel,
  id: String,
) -> CreateVoiceChannel

Manually sets the voice channel’s region.

new_voice_channel_with_user_limit

</> 
pub fn new_voice_channel_with_user_limit(
  create: CreateVoiceChannel,
  user_limit: Int,
) -> CreateVoiceChannel

new_voice_channel_with_video_quality_mode

</> 
pub fn new_voice_channel_with_video_quality_mode(
  create: CreateVoiceChannel,
  mode: VideoQualityMode,
) -> CreateVoiceChannel

optional_to_json

</> 
pub fn optional_to_json(
  option: option.Option(a),
  name: String,
  encoder: fn(a) -> json.Json,
) -> Result(#(String, json.Json), Nil)

permission_overwrite_decoder

</> 
pub fn permission_overwrite_decoder() -> decode.Decoder(
  PermissionOverwrite,
)

permission_overwrite_to_json

</> 
pub fn permission_overwrite_to_json(
  overwrite: PermissionOverwrite,
) -> json.Json

pin_message_request

</> 
pub fn pin_message_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(GuildChannel),
  message_with_id message_id: Snowflake(Message),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowPinningMessages permission.

pin_message_response

</> 
pub fn pin_message_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

poll_answer_count_decoder

</> 
pub fn poll_answer_count_decoder() -> decode.Decoder(
  PollAnswerCount,
)

poll_answer_decoder

</> 
pub fn poll_answer_decoder() -> decode.Decoder(PollAnswer)

poll_decoder

</> 
pub fn poll_decoder() -> decode.Decoder(Poll)

poll_results_decoder

</> 
pub fn poll_results_decoder() -> decode.Decoder(PollResults)

premium_button_decoder

</> 
pub fn premium_button_decoder() -> decode.Decoder(PremiumButton)

prune_guild_request

</> 
pub fn prune_guild_request(
  token token: Token,
  with_id guild_id: Snowflake(Guild),
  using prune: PruneGuild,
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingGuild and AllowKickingMembers permissions.

Kicks inactive members based on the provided options.

prune_guild_response

</> 
pub fn prune_guild_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

prune_guild_to_json

</> 
pub fn prune_guild_to_json(prune: PruneGuild) -> json.Json

prune_guild_with_count_request

</> 
pub fn prune_guild_with_count_request(
  token token: Token,
  with_id guild_id: Snowflake(Guild),
  using prune: PruneGuild,
  reason reason: option.Option(String),
) -> request.Request(String)

Not recommended for large guilds, use prune_guild instead.

Requires the AllowManagingGuild and AllowKickingMembers permissions.

Kicks inactive members based on the provided options.

Returns the amount of members who have been kicked.

prune_guild_with_count_response

</> 
pub fn prune_guild_with_count_response(
  response: response.Response(String),
) -> Result(Int, RestError)

prune_guild_with_included_roles

</> 
pub fn prune_guild_with_included_roles(
  prune: PruneGuild,
  roles: List(Snowflake(Role)),
) -> PruneGuild

Pruning will, by default, only kick members with no roles. Include any roles which you count as prunable.

prune_guild_with_required_inactive_days

</> 
pub fn prune_guild_with_required_inactive_days(
  prune: PruneGuild,
  days: Int,
) -> PruneGuild

The minimum number of days is 1 and the maximum number of days is 30. Numbers not within these bounds will kick the closest amount of time (1 or 30 days).

rate_limit_per_user

</> 
pub fn rate_limit_per_user(
  taking duration: duration.Duration,
) -> RateLimitPerUser

Represents the amount of time between a user has to wait between sending a message or creating a thread.

Bots and members with the AllowBypassingSlowmode permission are exempt from slowmode.

Rate limits per user must be between 0 and 21600 seconds (7.22 hours). The value will be clamped within the bounds.

rate_limit_per_user_decoder

</> 
pub fn rate_limit_per_user_decoder() -> decode.Decoder(
  RateLimitPerUser,
)

rate_limit_per_user_to_duration

</> 
pub fn rate_limit_per_user_to_duration(
  limit: RateLimitPerUser,
) -> duration.Duration

rate_limit_per_user_to_json

</> 
pub fn rate_limit_per_user_to_json(
  limit: RateLimitPerUser,
) -> json.Json

regular_button_decoder

</> 
pub fn regular_button_decoder() -> decode.Decoder(RegularButton)

regular_button_style_decoder

</> 
pub fn regular_button_style_decoder() -> decode.Decoder(
  RegularButtonStyle,
)

regular_button_style_to_json

</> 
pub fn regular_button_style_to_json(
  style: RegularButtonStyle,
) -> json.Json

remove_all_guild_member_roles

</> 
pub fn remove_all_guild_member_roles(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowManagingRoles permission.

Does not actually delete the roles - only removes them from the member.

remove_guild_banner

</> 
pub fn remove_guild_banner(modify: ModifyGuild) -> ModifyGuild

remove_guild_description

</> 
pub fn remove_guild_description(
  modify: ModifyGuild,
) -> ModifyGuild

remove_guild_icon

</> 
pub fn remove_guild_icon(modify: ModifyGuild) -> ModifyGuild

remove_guild_member_nick

</> 
pub fn remove_guild_member_nick(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowManagingNicknames permission.

remove_guild_splash

</> 
pub fn remove_guild_splash(modify: ModifyGuild) -> ModifyGuild

remove_member_from_thread

</> 
pub fn remove_member_from_thread(
  token token: Token,
  thread_with_id thread_id: Snowflake(Thread),
  member_with_id member_id: Snowflake(User),
) -> request.Request(String)

The thread mustn’t be archived.

Requires the AllowManagingThreads permission or the current user to be the thread’s creator if it’s a private thread.

remove_member_from_thread_response

</> 
pub fn remove_member_from_thread_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

remove_role_from_guild_member_request

</> 
pub fn remove_role_from_guild_member_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  from_member_with_id user_id: Snowflake(User),
  with_id role_id: Snowflake(Role),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowManagingRoles permission.

remove_role_from_guild_member_response

</> 
pub fn remove_role_from_guild_member_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

remove_role_icon

</> 
pub fn remove_role_icon(modify: ModifyRole) -> ModifyRole

reset_guild_default_message_notification_setting

</> 
pub fn reset_guild_default_message_notification_setting(
  modify: ModifyGuild,
) -> ModifyGuild

Resets the guild’s default message notification setting back to default.

reset_guild_explicit_content_filter_setting

</> 
pub fn reset_guild_explicit_content_filter_setting(
  modify: ModifyGuild,
) -> ModifyGuild

Resets the guild’s explicit content filter setting back to default.

reset_guild_member_verification_level

</> 
pub fn reset_guild_member_verification_level(
  modify: ModifyGuild,
) -> ModifyGuild

Resets the guild’s member verification level back to default.

reset_role_name

</> 
pub fn reset_role_name(modify: ModifyRole) -> ModifyRole

Resets the role’s name to “new name”.

reset_stage_channel_bitrate

</> 
pub fn reset_stage_channel_bitrate(
  modify: ModifyStageChannel,
) -> ModifyStageChannel

reset_voice_channel_bitrate

</> 
pub fn reset_voice_channel_bitrate(
  modify: ModifyVoiceChannel,
) -> ModifyVoiceChannel

resolved_announcement_channel_decoder

</> 
pub fn resolved_announcement_channel_decoder() -> decode.Decoder(
  ResolvedAnnouncementChannel,
)

resolved_category_channel_decoder

</> 
pub fn resolved_category_channel_decoder() -> decode.Decoder(
  ResolvedCategoryChannel,
)

resolved_channel_decoder

</> 
pub fn resolved_channel_decoder() -> decode.Decoder(
  ResolvedChannel,
)

resolved_dm_channel_decoder

</> 
pub fn resolved_dm_channel_decoder() -> decode.Decoder(
  ResolvedDmChannel,
)

resolved_forum_channel_decoder

</> 
pub fn resolved_forum_channel_decoder() -> decode.Decoder(
  ResolvedForumChannel,
)

resolved_guild_member_decoder

</> 
pub fn resolved_guild_member_decoder() -> decode.Decoder(
  ResolvedGuildMember,
)

resolved_media_channel_decoder

</> 
pub fn resolved_media_channel_decoder() -> decode.Decoder(
  ResolvedMediaChannel,
)

resolved_stage_channel_decoder

</> 
pub fn resolved_stage_channel_decoder() -> decode.Decoder(
  ResolvedStageChannel,
)

resolved_text_channel_decoder

</> 
pub fn resolved_text_channel_decoder() -> decode.Decoder(
  ResolvedTextChannel,
)

resolved_thread_decoder

</> 
pub fn resolved_thread_decoder() -> decode.Decoder(ResolvedThread)

resolved_voice_channel_decoder

</> 
pub fn resolved_voice_channel_decoder() -> decode.Decoder(
  ResolvedVoiceChannel,
)

respond_to_autocomplete_request_interaction_request

</> 
pub fn respond_to_autocomplete_request_interaction_request(
  token token: Token,
  id interaction_id: Snowflake(Interaction),
  interaction_token interaction_token: AutocompleteRequestInteractionToken,
  with response: AutocompleteRequestInteractionResponse,
) -> request.Request(String)

respond_to_autocomplete_request_interaction_response

</> 
pub fn respond_to_autocomplete_request_interaction_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

respond_to_command_interaction_request

</> 
pub fn respond_to_command_interaction_request(
  token token: Token,
  id interaction_id: Snowflake(Interaction),
  interaction_token interaction_token: CommandInteractionToken,
  with response: CommandInteractionResponse,
) -> request.Request(BitArray)

respond_to_command_interaction_response

</> 
pub fn respond_to_command_interaction_response(
  response: response.Response(BitArray),
) -> Result(Nil, RestError)

respond_to_command_interaction_with_message

</> 
pub fn respond_to_command_interaction_with_message(
  message: InteractionResponseMessage,
) -> CommandInteractionResponse

respond_to_command_interaction_with_modal

</> 
pub fn respond_to_command_interaction_with_modal(
  modal: InteractionResponseModal,
) -> CommandInteractionResponse

respond_to_float_autocomplete_request_interaction

</> 
pub fn respond_to_float_autocomplete_request_interaction(
  choices: List(FloatSlashCommandOptionChoice),
) -> AutocompleteRequestInteractionResponse

You can provide up to 25 choices.

respond_to_int_autocomplete_request_interaction

</> 
pub fn respond_to_int_autocomplete_request_interaction(
  choices: List(IntSlashCommandOptionChoice),
) -> AutocompleteRequestInteractionResponse

You can provide up to 25 choices.

respond_to_message_component_interaction_request

</> 
pub fn respond_to_message_component_interaction_request(
  token token: Token,
  id interaction_id: Snowflake(Interaction),
  interaction_token interaction_token: MessageComponentInteractionToken,
  with response: MessageComponentInteractionResponse,
) -> request.Request(BitArray)

respond_to_message_component_interaction_response

</> 
pub fn respond_to_message_component_interaction_response(
  response: response.Response(BitArray),
) -> Result(Nil, RestError)

respond_to_message_component_interaction_with_message

</> 
pub fn respond_to_message_component_interaction_with_message(
  message: InteractionResponseMessage,
) -> MessageComponentInteractionResponse

Responds by replying to the original component’s message.

respond_to_message_component_interaction_with_message_update

</> 
pub fn respond_to_message_component_interaction_with_message_update(
  message: InteractionResponseMessage,
) -> MessageComponentInteractionResponse

Responds by editing the original component’s message.

respond_to_message_component_interaction_with_modal

</> 
pub fn respond_to_message_component_interaction_with_modal(
  modal: InteractionResponseModal,
) -> MessageComponentInteractionResponse

respond_to_modal_interaction_request

</> 
pub fn respond_to_modal_interaction_request(
  token token: Token,
  id interaction_id: Snowflake(Interaction),
  interaction_token interaction_token: ModalInteractionToken,
  with response: ModalInteractionResponse,
) -> request.Request(BitArray)

respond_to_modal_interaction_response

</> 
pub fn respond_to_modal_interaction_response(
  response: response.Response(BitArray),
) -> Result(Nil, RestError)

respond_to_modal_interaction_with_message

</> 
pub fn respond_to_modal_interaction_with_message(
  message: InteractionResponseMessage,
) -> ModalInteractionResponse

respond_to_string_autocomplete_request_interaction

</> 
pub fn respond_to_string_autocomplete_request_interaction(
  choices: List(StringSlashCommandOptionChoice),
) -> AutocompleteRequestInteractionResponse

You can provide up to 25 choices.

rfc3339_decoder

</> 
pub fn rfc3339_decoder() -> decode.Decoder(timestamp.Timestamp)

role_colours_decoder

</> 
pub fn role_colours_decoder() -> decode.Decoder(RoleColours)

role_colours_to_json

</> 
pub fn role_colours_to_json(
  role_colours: RoleColours,
) -> json.Json

role_colours_with_primary_colour

</> 
pub fn role_colours_with_primary_colour(
  colours: RoleColours,
  colour: colour.Colour,
) -> RoleColours

role_colours_with_secondary_colour

</> 
pub fn role_colours_with_secondary_colour(
  colours: RoleColours,
  colour: colour.Colour,
) -> RoleColours

role_colours_with_tertiary_colour

</> 
pub fn role_colours_with_tertiary_colour(
  colours: RoleColours,
  colour: colour.Colour,
) -> RoleColours

role_decoder

</> 
pub fn role_decoder() -> decode.Decoder(Role)

role_select_default_value_to_json

</> 
pub fn role_select_default_value_to_json(
  id: Snowflake(Role),
) -> json.Json

role_slash_command_option_decoder

</> 
pub fn role_slash_command_option_decoder() -> decode.Decoder(
  RoleSlashCommandOption,
)

role_slash_command_option_to_json

</> 
pub fn role_slash_command_option_to_json(
  option: RoleSlashCommandOption,
) -> json.Json

role_subscription_purchase_notification_decoder

</> 
pub fn role_subscription_purchase_notification_decoder() -> decode.Decoder(
  RoleSubscriptionPurchaseNotification,
)

scheduled_event_decoder

</> 
pub fn scheduled_event_decoder() -> decode.Decoder(ScheduledEvent)

scheduled_event_location_decoder

</> 
pub fn scheduled_event_location_decoder() -> decode.Decoder(
  ScheduledEventLocation,
)

scheduled_event_recurrence_rule_decoder

</> 
pub fn scheduled_event_recurrence_rule_decoder() -> decode.Decoder(
  ScheduledEventRecurrenceRule,
)

scheduled_event_recurrence_rule_frequency_decoder

</> 
pub fn scheduled_event_recurrence_rule_frequency_decoder() -> decode.Decoder(
  ScheduledEventRecurrenceRuleFrequency,
)

scheduled_event_recurrence_rule_nth_weekday_decoder

</> 
pub fn scheduled_event_recurrence_rule_nth_weekday_decoder() -> decode.Decoder(
  ScheduledEventRecurrenceRuleNthWeekday,
)

scheduled_event_status_decoder

</> 
pub fn scheduled_event_status_decoder() -> decode.Decoder(
  ScheduledEventStatus,
)

search_guild_members_request

</> 
pub fn search_guild_members_request(
  token token: Token,
  in_guild_with_id guild_id: Snowflake(Guild),
  search_query query: String,
  limit limit: Int,
) -> request.Request(String)

The API will respond with one member for limits smaller than 1, and with 1000 members for limits larger than 1000.

search_guild_members_response

</> 
pub fn search_guild_members_response(
  response: response.Response(String),
) -> Result(List(GuildMember), RestError)

section_accessory_decoder

</> 
pub fn section_accessory_decoder() -> decode.Decoder(
  SectionAccessory,
)

section_component_decoder

</> 
pub fn section_component_decoder() -> decode.Decoder(
  SectionComponent,
)

select_channel_type_decoder

</> 
pub fn select_channel_type_decoder() -> decode.Decoder(
  SelectChannelType,
)

select_channel_type_to_json

</> 
pub fn select_channel_type_to_json(
  type_: SelectChannelType,
) -> json.Json

send_soundboard_sound_request

</> 
pub fn send_soundboard_sound_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(VoiceLikeChannel),
  sound_with_id sound_id: Snowflake(SoundboardSound),
  sound_from_guild_with_id source_guild_id: option.Option(
    Snowflake(Guild),
  ),
) -> request.Request(String)

Requirements:

  • must have the AllowSpeakingInVoiceChannels and AllowUsingSoundboard permissions
  • must be connected to the channel
  • must not be muted, deafened or suppressed
  • if using a sound from another guild:
    • must supply the source guild ID
    • must additionally have the AllowUsingExternalSoundboardSounds permission

Do not supply the source guild ID if the sound is from a default pack/the channel’s guild.

send_soundboard_sound_response

</> 
pub fn send_soundboard_sound_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

separator_spacing_decoder

</> 
pub fn separator_spacing_decoder() -> decode.Decoder(
  SeparatorSpacing,
)

separator_spacing_to_json

</> 
pub fn separator_spacing_to_json(
  spacing: SeparatorSpacing,
) -> json.Json

set_announcement_channel_as_nsfw

</> 
pub fn set_announcement_channel_as_nsfw(
  modify: ModifyAnnouncementChannel,
) -> ModifyAnnouncementChannel

set_announcement_channel_as_sfw

</> 
pub fn set_announcement_channel_as_sfw(
  modify: ModifyAnnouncementChannel,
) -> ModifyAnnouncementChannel

set_forum_channel_as_nsfw

</> 
pub fn set_forum_channel_as_nsfw(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

set_forum_channel_as_sfw

</> 
pub fn set_forum_channel_as_sfw(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

set_global_message_command_as_nsfw

</> 
pub fn set_global_message_command_as_nsfw(
  modify: ModifyGlobalMessageCommand,
) -> ModifyGlobalMessageCommand

This will only make the command usable in NSFW contexts.

set_global_message_command_as_sfw

</> 
pub fn set_global_message_command_as_sfw(
  modify: ModifyGlobalMessageCommand,
) -> ModifyGlobalMessageCommand

This will only make the command also available outside of NSFW contexts.

set_global_slash_command_as_nsfw

</> 
pub fn set_global_slash_command_as_nsfw(
  modify: ModifyGlobalSlashCommand,
) -> ModifyGlobalSlashCommand

This will only make the command usable in NSFW contexts.

set_global_slash_command_as_sfw

</> 
pub fn set_global_slash_command_as_sfw(
  modify: ModifyGlobalSlashCommand,
) -> ModifyGlobalSlashCommand

This will only make the command also available outside of NSFW contexts.

set_global_user_command_as_nsfw

</> 
pub fn set_global_user_command_as_nsfw(
  modify: ModifyGlobalUserCommand,
) -> ModifyGlobalUserCommand

This will only make the command usable in NSFW contexts.

set_global_user_command_as_sfw

</> 
pub fn set_global_user_command_as_sfw(
  modify: ModifyGlobalUserCommand,
) -> ModifyGlobalUserCommand

This will only make the command also available outside of NSFW contexts.

set_guild_message_command_as_nsfw

</> 
pub fn set_guild_message_command_as_nsfw(
  modify: ModifyGuildMessageCommand,
) -> ModifyGuildMessageCommand

This will only make the command usable in NSFW contexts.

set_guild_message_command_as_sfw

</> 
pub fn set_guild_message_command_as_sfw(
  modify: ModifyGuildMessageCommand,
) -> ModifyGuildMessageCommand

This will only make the command also available outside of NSFW contexts.

set_guild_slash_command_as_nsfw

</> 
pub fn set_guild_slash_command_as_nsfw(
  modify: ModifyGuildSlashCommand,
) -> ModifyGuildSlashCommand

This will only make the command usable in NSFW contexts.

set_guild_slash_command_as_sfw

</> 
pub fn set_guild_slash_command_as_sfw(
  modify: ModifyGuildSlashCommand,
) -> ModifyGuildSlashCommand

This will only make the command also available outside of NSFW contexts.

set_guild_user_command_as_nsfw

</> 
pub fn set_guild_user_command_as_nsfw(
  modify: ModifyGuildUserCommand,
) -> ModifyGuildUserCommand

This will only make the command usable in NSFW contexts.

set_guild_user_command_as_sfw

</> 
pub fn set_guild_user_command_as_sfw(
  modify: ModifyGuildUserCommand,
) -> ModifyGuildUserCommand

This will only make the command also available outside of NSFW contexts.

set_media_channel_as_nsfw

</> 
pub fn set_media_channel_as_nsfw(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

set_media_channel_as_sfw

</> 
pub fn set_media_channel_as_sfw(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

set_stage_channel_as_nsfw

</> 
pub fn set_stage_channel_as_nsfw(
  modify: ModifyStageChannel,
) -> ModifyStageChannel

set_stage_channel_as_sfw

</> 
pub fn set_stage_channel_as_sfw(
  modify: ModifyStageChannel,
) -> ModifyStageChannel

set_text_channel_as_nsfw

</> 
pub fn set_text_channel_as_nsfw(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

set_text_channel_as_sfw

</> 
pub fn set_text_channel_as_sfw(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

set_thread_as_invitable

</> 
pub fn set_thread_as_invitable(
  modify: ModifyThread,
) -> ModifyThread

Non-moderators can add other non-moderators to an invitable thread.

Only available on private threads.

set_thread_as_uninvitable

</> 
pub fn set_thread_as_uninvitable(
  modify: ModifyThread,
) -> ModifyThread

Non-moderators can add other non-moderators to an invitable thread.

Only available on private threads.

set_voice_channel_as_nsfw

</> 
pub fn set_voice_channel_as_nsfw(
  modify: ModifyVoiceChannel,
) -> ModifyVoiceChannel

set_voice_channel_as_sfw

</> 
pub fn set_voice_channel_as_sfw(
  modify: ModifyVoiceChannel,
) -> ModifyVoiceChannel

set_voice_channel_status_request

</> 
pub fn set_voice_channel_status_request(
  token token: Token,
  channel_with_id id: Snowflake(VoiceChannel),
  new status: option.Option(String),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowSettingVoiceChannelStatus permission.

Additionally requires the AllowManagingChannels permission if the current user isn’t connected to the specified channel.

set_voice_channel_status_response

</> 
pub fn set_voice_channel_status_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

sku_decoder

</> 
pub fn sku_decoder() -> decode.Decoder(Sku)

sku_type_decoder

</> 
pub fn sku_type_decoder() -> decode.Decoder(SkuType)

slash_command_decoder

</> 
pub fn slash_command_decoder() -> decode.Decoder(SlashCommand)

slash_command_option_decoder

</> 
pub fn slash_command_option_decoder() -> decode.Decoder(
  SlashCommandOption,
)

slash_command_option_to_json

</> 
pub fn slash_command_option_to_json(
  option: SlashCommandOption,
) -> json.Json

snowflake_decoder

</> 
pub fn snowflake_decoder() -> decode.Decoder(Snowflake(a))

snowflake_to_int

</> 
pub fn snowflake_to_int(snowflake: Snowflake(a)) -> Int

snowflake_to_json

</> 
pub fn snowflake_to_json(snowflake: Snowflake(a)) -> json.Json

soundboard_sound_decoder

</> 
pub fn soundboard_sound_decoder() -> decode.Decoder(
  SoundboardSound,
)

soundboard_sound_emoji_decoder

</> 
pub fn soundboard_sound_emoji_decoder() -> decode.Decoder(
  option.Option(SoundboardSoundEmoji),
)

soundboard_sound_emoji_to_json

</> 
pub fn soundboard_sound_emoji_to_json(
  emoji: option.Option(SoundboardSoundEmoji),
) -> Result(#(String, json.Json), Nil)

stage_channel_decoder

</> 
pub fn stage_channel_decoder() -> decode.Decoder(StageChannel)

stage_instance_decoder

</> 
pub fn stage_instance_decoder() -> decode.Decoder(StageInstance)

standard_sticker_decoder

</> 
pub fn standard_sticker_decoder() -> decode.Decoder(
  StandardSticker,
)

sticker_decoder

</> 
pub fn sticker_decoder() -> decode.Decoder(Sticker)

sticker_format_type_decoder

</> 
pub fn sticker_format_type_decoder() -> decode.Decoder(
  StickerFormatType,
)

sticker_item_decoder

</> 
pub fn sticker_item_decoder() -> decode.Decoder(StickerItem)

sticker_pack_decoder

</> 
pub fn sticker_pack_decoder() -> decode.Decoder(StickerPack)

string_select_option_decoder

</> 
pub fn string_select_option_decoder() -> decode.Decoder(
  StringSelectOption,
)

string_select_option_to_json

</> 
pub fn string_select_option_to_json(
  option: StringSelectOption,
) -> json.Json

string_slash_command_option_choice_decoder

</> 
pub fn string_slash_command_option_choice_decoder() -> decode.Decoder(
  StringSlashCommandOptionChoice,
)

string_slash_command_option_choice_to_json

</> 
pub fn string_slash_command_option_choice_to_json(
  choice: StringSlashCommandOptionChoice,
) -> json.Json

string_slash_command_option_decoder

</> 
pub fn string_slash_command_option_decoder() -> decode.Decoder(
  StringSlashCommandOption,
)

string_slash_command_option_to_json

</> 
pub fn string_slash_command_option_to_json(
  option: StringSlashCommandOption,
) -> json.Json

sub_command_group_option_decoder

</> 
pub fn sub_command_group_option_decoder() -> decode.Decoder(
  SubCommandGroupOption,
)

sub_command_group_option_to_json

</> 
pub fn sub_command_group_option_to_json(
  option: SubCommandGroupOption,
) -> json.Json

sub_command_group_slash_command_option_decoder

</> 
pub fn sub_command_group_slash_command_option_decoder() -> decode.Decoder(
  SubCommandGroupSlashCommandOption,
)

sub_command_group_slash_command_option_to_json

</> 
pub fn sub_command_group_slash_command_option_to_json(
  option: SubCommandGroupSlashCommandOption,
) -> json.Json

sub_command_option_decoder

</> 
pub fn sub_command_option_decoder() -> decode.Decoder(
  SubCommandOption,
)

sub_command_option_to_json

</> 
pub fn sub_command_option_to_json(
  option: SubCommandOption,
) -> json.Json

sub_command_slash_command_option_decoder

</> 
pub fn sub_command_slash_command_option_decoder() -> decode.Decoder(
  SubCommandSlashCommandOption,
)

sub_command_slash_command_option_to_json

</> 
pub fn sub_command_slash_command_option_to_json(
  option: SubCommandSlashCommandOption,
) -> json.Json

submitted_label_component_decoder

</> 
pub fn submitted_label_component_decoder() -> decode.Decoder(
  SubmittedLabelComponent,
)

submitted_modal_channel_select_decoder

</> 
pub fn submitted_modal_channel_select_decoder() -> decode.Decoder(
  SubmittedModalChannelSelect,
)

submitted_modal_checkbox_decoder

</> 
pub fn submitted_modal_checkbox_decoder() -> decode.Decoder(
  SubmittedModalCheckbox,
)

submitted_modal_checkbox_group_decoder

</> 
pub fn submitted_modal_checkbox_group_decoder() -> decode.Decoder(
  SubmittedModalCheckboxGroup,
)

submitted_modal_component_decoder

</> 
pub fn submitted_modal_component_decoder() -> decode.Decoder(
  SubmittedModalComponent,
)

submitted_modal_decoder

</> 
pub fn submitted_modal_decoder() -> decode.Decoder(SubmittedModal)

submitted_modal_file_upload_decoder

</> 
pub fn submitted_modal_file_upload_decoder() -> decode.Decoder(
  SubmittedModalFileUpload,
)

submitted_modal_label_decoder

</> 
pub fn submitted_modal_label_decoder() -> decode.Decoder(
  SubmittedModalLabel,
)

submitted_modal_mentionable_select_decoder

</> 
pub fn submitted_modal_mentionable_select_decoder() -> decode.Decoder(
  SubmittedModalMentionableSelect,
)

submitted_modal_radio_group_decoder

</> 
pub fn submitted_modal_radio_group_decoder() -> decode.Decoder(
  SubmittedModalRadioGroup,
)

submitted_modal_role_select_decoder

</> 
pub fn submitted_modal_role_select_decoder() -> decode.Decoder(
  SubmittedModalRoleSelect,
)

submitted_modal_string_select_decoder

</> 
pub fn submitted_modal_string_select_decoder() -> decode.Decoder(
  SubmittedModalStringSelect,
)

submitted_modal_text_input_decoder

</> 
pub fn submitted_modal_text_input_decoder() -> decode.Decoder(
  SubmittedModalTextInput,
)

submitted_modal_user_select_decoder

</> 
pub fn submitted_modal_user_select_decoder() -> decode.Decoder(
  SubmittedModalUserSelect,
)

subscription_decoder

</> 
pub fn subscription_decoder() -> decode.Decoder(Subscription)

subscription_status_decoder

</> 
pub fn subscription_status_decoder() -> decode.Decoder(
  SubscriptionStatus,
)

text_channel_decoder

</> 
pub fn text_channel_decoder() -> decode.Decoder(TextChannel)

thread_auto_archive_duration_decoder

</> 
pub fn thread_auto_archive_duration_decoder() -> decode.Decoder(
  ThreadAutoArchiveDuration,
)

thread_auto_archive_duration_to_json

</> 
pub fn thread_auto_archive_duration_to_json(
  thread_auto_archive_duration: ThreadAutoArchiveDuration,
) -> json.Json

thread_decoder

</> 
pub fn thread_decoder() -> decode.Decoder(Thread)

thread_member_decoder

</> 
pub fn thread_member_decoder() -> decode.Decoder(ThreadMember)

thread_type_decoder

</> 
pub fn thread_type_decoder() -> decode.Decoder(ThreadType)

thread_type_to_json

</> 
pub fn thread_type_to_json(
  type_: ThreadType,
) -> List(Result(#(String, json.Json), Nil))

timeout_guild_member

</> 
pub fn timeout_guild_member(
  modify: ModifyGuildMember,
  until timestamp: timestamp.Timestamp,
) -> ModifyGuildMember

Requires the AllowModeratingMembers permission.

The timeout can be issued for a maximum of 28 days.

Will override all previous timeouts.

Will return a Forbidden (403) status code if the member has the AdministratorPermission or is the guild’s owner.

timestamp_to_json

</> 
pub fn timestamp_to_json(
  timestamp: timestamp.Timestamp,
) -> json.Json

trigger_typing_indicator_request

</> 
pub fn trigger_typing_indicator_request(
  token token: Token,
  in_channel_with_id id: Snowflake(Channel),
) -> request.Request(String)

The typing indicator expires after 10 seconds.

Bots generally shouldn’t use this endpoint. It’s useful if you want to let the user know that the bot is still working on their request.

Prefer deferring interactions and using the thinking state.

trigger_typing_indicator_response

</> 
pub fn trigger_typing_indicator_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

unarchive_thread

</> 
pub fn unarchive_thread(modify: ModifyThread) -> ModifyThread

unban_user_from_guild_request

</> 
pub fn unban_user_from_guild_request(
  token token: Token,
  with_id user_id: Snowflake(User),
  from_guild_with_id guild_id: Snowflake(Guild),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowBanningMembers permission.

unban_user_from_guild_response

</> 
pub fn unban_user_from_guild_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

undeafen_guild_member

</> 
pub fn undeafen_guild_member(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowDeafeningMembersInVoiceChannels permission.

Allows the user to listen in all the guild’s voice channels, and, if they were previously muted because of a server-wide deafen, allows them to speak.

Will return a bad request if the user is not in a voice channel.

unfurled_media_item_decoder

</> 
pub fn unfurled_media_item_decoder() -> decode.Decoder(
  UnfurledMediaItem,
)

unfurled_media_item_metadata_decoder

</> 
pub fn unfurled_media_item_metadata_decoder() -> decode.Decoder(
  option.Option(UnfurledMediaItemMetadata),
)

unhoist_role

</> 
pub fn unhoist_role(modify: ModifyRole) -> ModifyRole

Makes the role no longer separate from others in the sidebar.

unlock_thread

</> 
pub fn unlock_thread(modify: ModifyThread) -> ModifyThread

When a thread is locked, only users with the AllowManagingThreads permission can unarchive it.

unmute_guild_member

</> 
pub fn unmute_guild_member(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowMutingMembersInVoiceChannels permission.

Allows the user to speak in all the guild’s voice channels.

Will return a bad request if the user is not in a voice channel.

unpin_message_request

</> 
pub fn unpin_message_request(
  token token: Token,
  in_channel_with_id channel_id: Snowflake(GuildChannel),
  message_with_id message_id: Snowflake(Message),
  reason reason: option.Option(String),
) -> request.Request(String)

Requires the AllowPinningMessages permission.

unpin_message_response

</> 
pub fn unpin_message_response(
  response: response.Response(String),
) -> Result(Nil, RestError)

unset_announcement_channel_default_thread_auto_archive_duration

</> 
pub fn unset_announcement_channel_default_thread_auto_archive_duration(
  modify: ModifyAnnouncementChannel,
) -> ModifyAnnouncementChannel

unset_announcement_channel_parent_id

</> 
pub fn unset_announcement_channel_parent_id(
  modify: ModifyAnnouncementChannel,
) -> ModifyAnnouncementChannel

unset_announcement_channel_position

</> 
pub fn unset_announcement_channel_position(
  modify: ModifyAnnouncementChannel,
) -> ModifyAnnouncementChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list.

unset_category_channel_position

</> 
pub fn unset_category_channel_position(
  modify: ModifyCategoryChannel,
) -> ModifyCategoryChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list.

unset_forum_channel_default_reaction

</> 
pub fn unset_forum_channel_default_reaction(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

unset_forum_channel_default_sort_order

</> 
pub fn unset_forum_channel_default_sort_order(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

unset_forum_channel_default_thread_auto_archive_duration

</> 
pub fn unset_forum_channel_default_thread_auto_archive_duration(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

unset_forum_channel_parent_id

</> 
pub fn unset_forum_channel_parent_id(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

unset_forum_channel_position

</> 
pub fn unset_forum_channel_position(
  modify: ModifyForumChannel,
) -> ModifyForumChannel

unset_guild_afk_channel

</> 
pub fn unset_guild_afk_channel(
  modify: ModifyGuild,
) -> ModifyGuild

Unsets the guild’s AFK channel.

This will not delete the channel, just make the guild not have an AFK channel.

unset_guild_channel_parent_id

</> 
pub fn unset_guild_channel_parent_id(
  modify: ModifyGuildChannelPosition,
) -> ModifyGuildChannelPosition

Makes the channel independent of a category, putting it by itself in the channel list.

unset_guild_channel_position

</> 
pub fn unset_guild_channel_position(
  modify: ModifyGuildChannelPosition,
) -> ModifyGuildChannelPosition

Resets the channel’s position back to the default - will put the channel at the bottom of the category/channel list.

unset_guild_public_updates_channel

</> 
pub fn unset_guild_public_updates_channel(
  modify: ModifyGuild,
) -> ModifyGuild

Makes the guild not have a public updates channel anymore.

This will not delete the channel.

unset_guild_rules_channel

</> 
pub fn unset_guild_rules_channel(
  modify: ModifyGuild,
) -> ModifyGuild

Makes the guild not have a rules channel anymore.

This will not delete the channel.

unset_guild_safety_alerts_channel

</> 
pub fn unset_guild_safety_alerts_channel(
  modify: ModifyGuild,
) -> ModifyGuild

Makes the guild not have a safety alerts channel anymore.

This will not delete the channel.

unset_guild_system_channel

</> 
pub fn unset_guild_system_channel(
  modify: ModifyGuild,
) -> ModifyGuild

Makes the guild not have a system channel anymore.

This will not delete the channel.

unset_guild_widget_channel_id

</> 
pub fn unset_guild_widget_channel_id(
  modify: ModifyGuildWidgetSettings,
) -> ModifyGuildWidgetSettings

unset_media_channel_default_reaction

</> 
pub fn unset_media_channel_default_reaction(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

unset_media_channel_default_sort_order

</> 
pub fn unset_media_channel_default_sort_order(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

unset_media_channel_default_thread_auto_archive_duration

</> 
pub fn unset_media_channel_default_thread_auto_archive_duration(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

unset_media_channel_parent_id

</> 
pub fn unset_media_channel_parent_id(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

unset_media_channel_position

</> 
pub fn unset_media_channel_position(
  modify: ModifyMediaChannel,
) -> ModifyMediaChannel

unset_stage_channel_parent_id

</> 
pub fn unset_stage_channel_parent_id(
  modify: ModifyStageChannel,
) -> ModifyStageChannel

unset_stage_channel_position

</> 
pub fn unset_stage_channel_position(
  modify: ModifyStageChannel,
) -> ModifyStageChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list.

unset_stage_channel_rtc_region_id

</> 
pub fn unset_stage_channel_rtc_region_id(
  modify: ModifyStageChannel,
) -> ModifyStageChannel

Makes the RTC region automatically selected by Discord.

unset_text_channel_default_thread_auto_archive_duration

</> 
pub fn unset_text_channel_default_thread_auto_archive_duration(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

unset_text_channel_parent_id

</> 
pub fn unset_text_channel_parent_id(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

unset_text_channel_position

</> 
pub fn unset_text_channel_position(
  modify: ModifyTextChannel,
) -> ModifyTextChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list.

unset_thread_rate_limit_per_user

</> 
pub fn unset_thread_rate_limit_per_user(
  modify: ModifyThread,
) -> ModifyThread

unset_voice_channel_parent_id

</> 
pub fn unset_voice_channel_parent_id(
  modify: ModifyVoiceChannel,
) -> ModifyVoiceChannel

unset_voice_channel_position

</> 
pub fn unset_voice_channel_position(
  modify: ModifyVoiceChannel,
) -> ModifyVoiceChannel

Channels without a specified position will automatically be assigned one at the bottom of their category/channel list.

unset_voice_channel_rtc_region_id

</> 
pub fn unset_voice_channel_rtc_region_id(
  modify: ModifyVoiceChannel,
) -> ModifyVoiceChannel

Makes the RTC region automatically selected by Discord.

untimeout_guild_member

</> 
pub fn untimeout_guild_member(
  modify: ModifyGuildMember,
) -> ModifyGuildMember

Requires the AllowModeratingMembers permission.

user_avatar_decoration_decoder

</> 
pub fn user_avatar_decoration_decoder() -> decode.Decoder(
  UserAvatarDecoration,
)

user_collectibles_decoder

</> 
pub fn user_collectibles_decoder() -> decode.Decoder(
  UserCollectibles,
)

user_command_decoder

</> 
pub fn user_command_decoder() -> decode.Decoder(UserCommand)

user_decoder

</> 
pub fn user_decoder() -> decode.Decoder(User)

user_nameplate_decoder

</> 
pub fn user_nameplate_decoder() -> decode.Decoder(UserNameplate)

user_nameplate_palette_decoder

</> 
pub fn user_nameplate_palette_decoder() -> decode.Decoder(
  UserNameplatePalette,
)

user_premium_type_decoder

</> 
pub fn user_premium_type_decoder() -> decode.Decoder(
  UserPremiumType,
)

user_primary_guild_decoder

</> 
pub fn user_primary_guild_decoder() -> decode.Decoder(
  UserPrimaryGuild,
)

user_select_default_value_to_json

</> 
pub fn user_select_default_value_to_json(
  id: Snowflake(User),
) -> json.Json

user_slash_command_option_decoder

</> 
pub fn user_slash_command_option_decoder() -> decode.Decoder(
  UserSlashCommandOption,
)

user_slash_command_option_to_json

</> 
pub fn user_slash_command_option_to_json(
  option: UserSlashCommandOption,
) -> json.Json

user_status_decoder

</> 
pub fn user_status_decoder() -> decode.Decoder(UserStatus)

video_message_attachment_decoder

</> 
pub fn video_message_attachment_decoder() -> decode.Decoder(
  VideoMessageAttachment,
)

video_quality_mode_decoder

</> 
pub fn video_quality_mode_decoder() -> decode.Decoder(
  VideoQualityMode,
)

video_quality_mode_to_json

</> 
pub fn video_quality_mode_to_json(
  video_quality_mode: VideoQualityMode,
) -> json.Json

voice_channel_decoder

</> 
pub fn voice_channel_decoder() -> decode.Decoder(VoiceChannel)

voice_message_attachment_decoder

</> 
pub fn voice_message_attachment_decoder() -> decode.Decoder(
  VoiceMessageAttachment,
)

voice_region_decoder

</> 
pub fn voice_region_decoder() -> decode.Decoder(VoiceRegion)

voice_state_decoder

</> 
pub fn voice_state_decoder() -> decode.Decoder(VoiceState)

weekday_decoder

</> 
pub fn weekday_decoder() -> decode.Decoder(weekday.Weekday)
✨ Search Document