Type Definitions

BadgeData

Type:
  • Object
Properties
NameTypeDescription
emojiString

The emoji

idString

The id of the emoji

nameString

The name of the emoji

urlString

The url of the emoji

BaseComponentData

Type:
  • Object
Properties
NameTypeDescription
nameString

The name of the base component

enabledBoolean

If the base component is enabled (default: false)

clientPermissionsArray.<PermissionFlagsBits>

The permissions required for the client to execute the base component (default: [])

userPermissionsArray.<PermissionFlagsBits>

The permissions required for the user to execute the base component (default: [])

categoryString

The category of the base component (Will be set automatically. default: "Other")

cooldownNumber

The cooldown of the base component in seconds (default: 5)

customIdString

The custom id of the base component

deferBoolean

If the base component should be deferred (default: true)

dirnameString

The dirname of the base component (Will be set automatically)

ephemeralBoolean

If the response is ephemeral (default: false)

experimentExperimentData

If the base component is an experiment (default: { required: false, id: null })

locationString

The location of the base component (Will be set automatically)

betaOnlyBoolean

If the command is only available in beta (default: false)

channelOnlyArray.<TextBasedChannelTypes>

An array of all channel types the base component is available in (default: ALL)

devOnlyBoolean

If the base component can only be executed by developers (default: false)

guildOnlyBoolean

If the base component can only be executed in guilds (default: true)

ownerOnlyBoolean

If the base component can only be executed by the owner of the bot (default: true)

premiumOnlyBoolean

If the base component can only be executed by guilds who have premium perks (default: false)

nsfwBoolean

If the base component can only be executed in NSFW channels (default: false)

BaseInteractionData

Type:
  • Object
Properties
NameTypeDescription
nameString

The name of the base interaction

nameLocalizationsLocalizationMap

The localization names of the base interaction

enabledBoolean

If the base interaction is enabled (default: false)

clientPermissionsArray.<PermissionFlagsBits>

The permissions required for the client to execute the base interaction (default: [])

userPermissionsArray.<PermissionFlagsBits>

The permissions required for the user to execute the base interaction (default: [])

defaultMemberPermissionsArray.<PermissionFlagsBits>

The permissions required for the member to be able to use / see the base interaction (default: [])

deployEnabledBoolean

If the base interaction is enabled for deploying (default: false)

dmEnabledBoolean

If the base interaction is enabled for deloying in dms (default: true)

categoryString

The category of the base interaction (Will be set automatically. default: "Other")

cooldownNumber

The cooldown of the base interaction in seconds (default: 5)

deferBoolean

If the base interaction should be deferred (default: true)

dirnameString

The dirname of the base interaction (Will be set automatically)

ephemeralBoolean

If the response is ephemeral (default: false)

experimentExperimentData

If the base interaction is an experiment (default: { required: false, id: null })

idSnowflake

The id of the base interaction

locationString

The location of the base interaction (Will be set automatically)

typeApplicationCommandType

The type of the base interaction (Only required for context interactions: "Message" or "User")

betaOnlyBoolean

If the command is only available in beta (default: false)

channelOnlyArray.<TextBasedChannelTypes>

An array of all channel types the base interaction is available in (default: ALL)

devOnlyBoolean

If the base interaction can only be executed by developers (default: false)

guildOnlyBoolean

If the base interaction can only be executed in guilds (default: true)

ownerOnlyBoolean

If the base interaction can only be executed by the owner of the bot (default: true)

premiumOnlyBoolean

If the base interaction can only be executed by guilds who have premium perks (default: false)

nsfwBoolean

If the base interaction can only be executed in NSFW channels (default: false)

BaseTicketManagerOptions

Type:
  • Object
Properties
NameTypeDescription
staffRolesArray.<Snowflake>

The IDs of the staff roles

storageString

The json file to save the tickets to

ButtonInteractionData

Type:
  • Object
Properties
NameTypeDescription
nameString

The name of the button interaction

enabledBoolean

If the button interaction is enabled (default: false)

clientPermissionsArray.<PermissionFlagsBits>

The permissions required for the client to execute the button interaction (default: [])

userPermissionsArray.<PermissionFlagsBits>

The permissions required for the user to execute the button interaction (default: [])

categoryString

The category of the button interaction (Will be set automatically. default: "Other")

cooldownNumber

The cooldown of the button interaction in seconds (default: 5)

customIdString

The custom id of the button interaction

deferBoolean

If the button interaction should be deferred (default: true)

dirnameString

The dirname of the button interaction (Will be set automatically)

disabledBoolean

If the button is disabled (default: false)

emojiAPIMessageComponentEmoji

The emoji of the button

ephemeralBoolean

If the response is ephemeral (default: false)

experimentExperimentData

If the button interaction is an experiment (default: { required: false, id: null })

labelString

The label of the button

locationString

The location of the button interaction (Will be set automatically)

styleButtonStyle

The style of the button (default: Success)

urlURL

The url of the button

betaOnlyBoolean

If the command is only available in beta (default: false)

channelOnlyArray.<TextBasedChannelTypes>

An array of all channel types the button interaction is available in (default: ALL)

devOnlyBoolean

If the button interaction can only be executed by developers (default: false)

guildOnlyBoolean

If the button interaction can only be executed in guilds (default: true)

ownerOnlyBoolean

If the button interaction can only be executed by the owner of the bot (default: true)

premiumOnlyBoolean

If the button interaction can only be executed by guilds who have premium perks (default: false)

nsfwBoolean

If the button interaction can only be executed in NSFW channels (default: false)

CaptchaOptions

Type:
  • Object
Properties
NameTypeAttributesDescription
heightNumber<nullable>

The height of the captcha (default: 250)

lengthNumber<nullable>

The length of the captcha (default: 6)

valueString<nullable>

The value of the captcha if not provided it will be generated randomly

widthNumber<nullable>

The width of the captcha (default: 400) ⚠️ Do only change if you know what you do! ⚠️

ContextInteractionData

Type:
  • Object
Properties
NameTypeDescription
nameString

The name of the context interaction

nameLocalizationsLocalizationMap

The localization names of the context interaction

enabledBoolean

If the context interaction is enabled (default: false)

clientPermissionsArray.<PermissionFlagsBits>

The permissions required for the client to execute the context interaction (default: [])

userPermissionsArray.<PermissionFlagsBits>

The permissions required for the user to execute the context interaction (default: [])

deployEnabledBoolean

If the context interaction is enabled for deploying (default: false)

dmEnabledBoolean

If the context interaction is enabled for deloying in dms (default: true)

categoryString

The category of the context interaction (Will be set automatically. default: "Other")

cooldownNumber

The cooldown of the context interaction in seconds (default: 5)

deferBoolean

If the context interaction should be deferred (default: true)

dirnameString

The dirname of the context interaction (Will be set automatically)

ephemeralBoolean

If the response is ephemeral (default: false)

experimentExperimentData

If the context interaction is an experiment (default: { required: false, id: null })

idSnowflake

The id of the context interaction

locationString

The location of the context interaction (Will be set automatically)

typeApplicationCommandType

The type of the base interaction (Only required for context interactions: "Message" or "User")

betaOnlyBoolean

If the command is only available in beta (default: false)

channelOnlyArray.<TextBasedChannelTypes>

An array of all channel types the context interaction is available in (default: ALL)

devOnlyBoolean

If the context interaction can only be executed by developers (default: false)

guildOnlyBoolean

If the context interaction can only be executed in guilds (default: true)

ownerOnlyBoolean

If the context interaction can only be executed by the owner of the bot (default: true)

premiumOnlyBoolean

If the context interaction can only be executed by guilds who have premium perks (default: false)

nsfwBoolean

If the context interaction can only be executed in NSFW channels (default: false)

EmojiData

Type:
  • Object
Properties
NameTypeDescription
emojiString

The emoji

idString

The id of the emoji

nameString

The name of the emoji

urlString

The url of the emoji

EmojiData

The data of all emojis

Type:
  • Object
Properties
NameTypeDescription
emojiString

The emoji

idString

The id of the emoji

nameString

The name of the emoji

urlString

The url of the emoji

EventData

Type:
  • Object
Properties
NameTypeDescription
enabledBoolean

If the event is enabled for loading. (default: true)

nameString

The name of the event.

onceBoolean

If the event should only be triggered once. (default: false)

locationString

The location of the event (Will be set automatically)

EventManagerOptions

Type:
  • Object
Properties
NameTypeDescription
locationEventsString

The location of the events

ExperimentData

Type:
  • Object
Properties
NameTypeDescription
requiredBoolean

If the experiment is required to execute the base component

idNumber

The id of the experiment

ExperimentData

Type:
  • Object
Properties
NameTypeDescription
requiredBoolean

If the experiment is required to execute the base interaction

idNumber

The id of the experiment

ExperimentData

Type:
  • Object
Properties
NameTypeDescription
requiredBoolean

If the experiment is required to execute the button interaction

idNumber

The id of the experiment

ExperimentData

Type:
  • Object
Properties
NameTypeDescription
requiredBoolean

If the experiment is required to execute the context interaction

idNumber

The id of the experiment

ExperimentData

Type:
  • Object
Properties
NameTypeDescription
requiredBoolean

If the experiment is required to execute the modal interaction

idNumber

The id of the experiment

ExperimentData

Type:
  • Object
Properties
NameTypeDescription
requiredBoolean

If the experiment is required to execute the select menu interaction

idNumber

The id of the experiment

ExperimentData

Type:
  • Object
Properties
NameTypeDescription
requiredBoolean

If the experiment is required to execute the slash command

idNumber

The id of the experiment

IncidentData

Type:
  • Object
Properties
NameTypeDescription
idString

The id of the incident

lastUpdateString

The last update of the incident

messageIdSnowflake

The id of the message of the incident

resolvedBoolean

If the incident is resolved

IncidentDataRaw

Type:
  • Object
Properties
NameTypeDescription
componentsArray.<IncidentDataRawComponent>

The components of the incident

created_atString

The creation date of the incident

idString

The id of the incident

impactString

The impact of the incident

incident_updatesArray.<IncidentDataRawComponentUpdate>

The updates of the incident

monitoring_atString

The monitoring date of the incident

nameString

The name of the incident

page_idString

The id of the status page

resolved_atString

The resolved date of the incident

shortlinkString

The link of the incident

started_atString

The start date of the incident

statusString

The status of the incident

updated_atString

The last update of the incident

IncidentDataRawComponent

Type:
  • Object
Properties
NameTypeDescription
created_atString

The creation date of the component

descriptionString

The description of the component

groupBoolean

If the component is a group

group_idString | null

The id of the group of the component

idString

The id of the component

nameString

The name of the component

only_show_if_degradedBoolean

If the component is only shown if degraded

page_idString

The id of the status page

positionNumber

The position of the component

showcaseBoolean

If the component is in the showcase

start_dateString | null

The start date of the component

statusString

The status of the component

updated_atString

The last update of the component

IncidentDataRawComponentUpdate

Type:
  • Object
Properties
NameTypeDescription
codeString

The code of the component update

nameString

The name of the component update

new_statusString

The new status of the component update

old_statusString

The old status of the component update

IncidentDataRawUpdate

Type:
  • Object
Properties
NameTypeDescription
affected_componentsArray.<IncidentDataRawComponentUpdate>

The affected components of the update

bodyString

The body of the update

created_atString

The creation date of the update

custom_tweetString | null

The custom tweet of the update

deliver_notificationsBoolean

If the update should be delivered to the users

display_atString

The display date of the update

idString

The id of the incident update

incident_idString

The id of the incident

statusString

The status of the incident update

tweet_idString | null

The id of the tweet of the update

update_atString

The date of the incident update

InteractionManagerOptions

Type:
  • Object
Properties
NameTypeAttributesDescription
guildIDsArray.<Snowflake>

The ids of the guild the commands should be deployed to

locationButtonInteractionsString<nullable>

The location of the button interactions

locationContextInteractionsString<nullable>

The location of the context interactions

locationModalInteractionsString<nullable>

The location of the modal interactions

locationSelectMenuInteractionsString<nullable>

The location of the select menu interactions

locationSlashCommandsString<nullable>

The location of the slash commands

LoadAllOptions

Type:
  • Object
Properties
NameTypeAttributesDescription
folderNameString<optional>

The name of the folder

translationDirString<optional>

The location of the translations

namespacesArray<optional>

The namespaces

LogData

Type:
  • Object
Properties
NameTypeDescription
consoleStringString

The string that should be logged to the console

webhookStringString

The string that should be logged to a webhook

LoggerIcons

Type:
  • Object
Properties
NameTypeDescription
debugString

(Default: "⚒")

errorString

(Default: "🛑")

failString

(Default: "❌")

infoString

(Default: "ℹ")

successString

(Default: "✅")

warnString

(Default: "⚠")

LoggerOptions

Type:
  • Object
Properties
NameTypeAttributesDescription
iconsLoggerIcons<nullable>

The icons which the logger uses

nameString

The name of the logger

sentryOptionsNodeOptions<nullable>

The options for the Sentry client

webhooksArray.<WebhookClient>

An array of webhook clients, the messages should be sent to

ModalInteractionData

Type:
  • Object
Properties
NameTypeDescription
nameString

The name of the modal interaction

enabledBoolean

If the modal interaction is enabled (default: false)

clientPermissionsArray.<PermissionFlagsBits>

The permissions required for the client to execute the modal interaction (default: [])

userPermissionsArray.<PermissionFlagsBits>

The permissions required for the user to execute the modal interaction (default: [])

categoryString

The category of the modal interaction (Will be set automatically. default: "Other")

componentsArray.<TextInputBuilder>

The components of the modal

cooldownNumber

The cooldown of the modal interaction in seconds (default: 5)

customIdString

The custom id of the modal interaction

deferBoolean

If the modal interaction should be deferred (default: true)

dirnameString

The dirname of the modal interaction (Will be set automatically)

ephemeralBoolean

If the response is ephemeral (default: false)

experimentExperimentData

If the modal interaction is an experiment (default: { required: false, id: null })

locationString

The location of the modal interaction (Will be set automatically)

titleString

The title of the modal

betaOnlyBoolean

If the command is only available in beta (default: false)

channelOnlyArray.<TextBasedChannelTypes>

An array of all channel types the modal interaction is available in (default: ALL)

devOnlyBoolean

If the modal interaction can only be executed by developers (default: false)

guildOnlyBoolean

If the modal interaction can only be executed in guilds (default: true)

ownerOnlyBoolean

If the modal interaction can only be executed by the owner of the bot (default: true)

premiumOnlyBoolean

If the modal interaction can only be executed by guilds who have premium perks (default: false)

nsfwBoolean

If the modal interaction can only be executed in NSFW channels (default: false)

PartnerData

The data of all partners

Type:
  • Object
Properties
NameTypeAttributesDescription
nameString

The name of the partner

longDescriptionTranslationData

The long description of the partner

shortDescriptionTranslationData

The short description of the partner

emojiEmojiData

The emoji of the partner

ownerString

The owner id of the partner

typeTranslationData

The type of the partner

bannerURLString<nullable>

The banner URL of the partner

iconURLString

The icon URL of the partner

discordURLString<nullable>

The discord URL of the partner

instagramURLString<nullable>

The instagram URL of the partner

twitterURLString<nullable>

The twitter URL of the partner

websiteURLString<nullable>

The website URL of the partner

SelectMenuInteractionData

Type:
  • Object
Properties
NameTypeDescription
nameString

The name of the select menu interaction

enabledBoolean

If the select menu interaction is enabled (default: false)

clientPermissionsArray.<PermissionFlagsBits>

The permissions required for the client to execute the select menu interaction (default: [])

userPermissionsArray.<PermissionFlagsBits>

The permissions required for the user to execute the select menu interaction (default: [])

categoryString

The category of the select menu interaction (Will be set automatically. default: "Other")

cooldownNumber

The cooldown of the select menu interaction in seconds (default: 5)

customIdString

The custom id of the select menu interaction

deferBoolean

If the select menu interaction should be deferred (default: true)

dirnameString

The dirname of the select menu interaction (Will be set automatically)

disabledBoolean

If the select menu is disabled (default: false)

ephemeralBoolean

If the response is ephemeral (default: false)

experimentExperimentData

If the select menu interaction is an experiment (default: { required: false, id: null })

locationString

The location of the select menu interaction (Will be set automatically)

maxValuesNumber

The maximum amount of values the user can choose from the select menu (default: 1)

minValuesNumber

The minimum amount of values the user can choose from the select menu (default: 1)

optionsArray.<SelectMenuOptionBuilder>

The options of the select menu

placeholderString

The placeholder of the select menu

betaOnlyBoolean

If the command is only available in beta (default: false)

channelOnlyArray.<TextBasedChannelTypes>

An array of all channel types the select menu interaction is available in (default: ALL)

devOnlyBoolean

If the select menu interaction can only be executed by developers (default: false)

guildOnlyBoolean

If the select menu interaction can only be executed in guilds (default: true)

ownerOnlyBoolean

If the select menu interaction can only be executed by the owner of the bot (default: true)

premiumOnlyBoolean

If the select menu interaction can only be executed by guilds who have premium perks (default: false)

nsfwBoolean

If the select menu interaction can only be executed in NSFW channels (default: false)

SlashCommandData

Type:
  • Object
Properties
NameTypeDescription
nameString

The name of the slash command

nameLocalizationsLocalizationMap

The localization names of the slash command

descriptionString

The description of the slash command

descriptionLocalizationsLocalizationMap

The localization descriptions of the slash command

usageString

The usage of the slash command

enabledBoolean

If the slash command is enabled (default: false)

clientPermissionsArray.<PermissionFlagsBits>

The permissions required for the client to execute the slash command (default: [])

userPermissionsArray.<PermissionFlagsBits>

The permissions required for the user to execute the slash command (default: [])

deployEnabledBoolean

If the slash command is enabled for deploying (default: false)

dmEnabledBoolean

If the slash command is enabled for deloying in dms (default: true)

optionsArray.<ApplicationCommandOptionData>

The options of the slash command

categoryString

The category of the slash command (Will be set automatically. default: "Other")

cooldownNumber

The cooldown of the slash command in seconds (default: 5)

defaultEnabledBoolean

If the slash command is enabled by default (default: false)

deferBoolean

If the slash command should be deferred (default: true)

dirnameString

The dirname of the slash command (Will be set automatically)

ephemeralBoolean

If the response is ephemeral (default: false)

experimentExperimentData

If the slash command is an experiment (default: { required: false, id: null })

hiddenBoolean

If the slash command should be hidden in the list (default: false)

idSnowflake

The id of the slash command

locationString

The location of the slash command (Will be set automatically)

betaOnlyBoolean

If the command is only available in beta (default: false)

channelOnlyArray.<TextBasedChannelTypes>

An array of all channel types the slash command is available in (default: ALL)

devOnlyBoolean

If the slash command can only be executed by developers (default: false)

guildOnlyBoolean

If the slash command can only be executed in guilds (default: true)

ownerOnlyBoolean

If the slash command can only be executed by the owner of the bot (default: true)

premiumOnlyBoolean

If the slash command can only be executed by guilds who have premium perks (default: false)

nsfwBoolean

If the slash command can only be executed in NSFW channels (default: false)

StatusPageCheckerOptions

Type:
  • Object
Properties
NameTypeDescription
checkIntervalNumber

The time in ms the checker should check (default: 60000)

colorsStatusPageCheckerOptionsColors

The colors of the embeds

storageString

The json file to save the incidents to

urlString

The URL of the status page you want to monitore

webhookWebhookClient

webhook client

StatusPageCheckerOptionsColors

Type:
  • Object
Properties
NameTypeDescription
BLACKString

(default: #000000)

GREENString

(default: #51f34d)

ORANGEString

(default: #fcb22d)

REDString

(default: #fe6b61)

YELLOWString

(default: #ffde22)

TextTicketManagerOptions

Type:
  • Object
Properties
NameTypeDescription
channelTopicString

The topic of the ticket channel

closedParentIdSnowflake

The id of the closed tickte category (default: #parentId)

parentIdSnowflake

The id of the ticket category

staffRolesArray.<Snowflake>

The IDs of the staff roles

storageString

The json file to save the tickets to

TicketDataRaw

Type:
  • Object
Properties
NameTypeDescription
channelIdSnowflake

The id of the ticket channel or thread

guildIdSnowflake

The id of the guild

numberNumber

The number of the ticket

participantsArray.<Snowflake>

The array with all ids of participants

statusTicketDataStatus

The status of the ticket

typeTicketDataType

The type of the ticket

userIdSnowflake

The id of the user

TicketDataRaw

Type:
  • Object
Properties
NameTypeDescription
channelIdSnowflake

The id of the ticket channel or thread

guildIdSnowflake

The id of the guild

numberNumber

The number of the ticket

participantsArray.<Snowflake>

The array with all ids of participants

statusTicketDataStatus

The status of the ticket

typeTicketDataType

The type of the ticket

userIdSnowflake

The id of the user

TicketDataRaw

Type:
  • Object
Properties
NameTypeDescription
channelIdSnowflake

The id of the ticket channel or thread

guildIdSnowflake

The id of the guild

numberNumber

The number of the ticket

participantsArray.<Snowflake>

The array with all ids of participants

statusTicketDataStatus

The status of the ticket

typeTicketDataType

The type of the ticket

userIdSnowflake

The id of the user

TicketDataStatus

  • "CLOSED"
  • "DELETED"
  • "OPEN"
Type:
  • String

TicketDataStatus

  • "CLOSED"
  • "DELETED"
  • "OPEN"
Type:
  • String

TicketDataType

  • "CHANNEL"
Type:
  • String

TicketDataType

  • "CHANNEL"
Type:
  • String

TranslateOptions

Type:
  • Object
Properties
NameTypeAttributesDescription
languageString<optional>

The language

TranslationData

The data of all translations

Type:
  • Object
Properties
NameTypeDescription
languageString

The language of the string

TranslationManagerOptions

Type:
  • Object
Properties
NameTypeDescription
defaultLanguageString

The default language to use if no language is specified.

i18nextOptionsi18next.InitOptions

Additional options to pass to i18next.

locationTranslationsString

The location of the translations