Function DiscordApiFactory

Returns {
    discordControllerDeleteMessage(
        channelId: string,
        messageId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    discordControllerGetChannels(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DiscordChannelOutputArrayDTOAPI>;
    discordControllerGetInvite(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DiscordInviteOutputDTO>;
    discordControllerGetRoles(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DiscordRoleOutputArrayDTOAPI>;
    discordControllerSearch(
        guildSearchInputDTO?: GuildSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GuildOutputArrayDTOAPI>;
    discordControllerSendMessage(
        id: string,
        sendMessageInputDTO?: SendMessageInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MessageOutputDTOAPI>;
    discordControllerUpdateGuild(
        id: string,
        guildApiUpdateDTO?: GuildApiUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GuildOutputDTOAPI>;
    discordControllerUpdateMessage(
        channelId: string,
        messageId: string,
        sendMessageInputDTO?: SendMessageInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MessageOutputDTOAPI>;
}

• discordControllerDeleteMessage: function

  • discordControllerDeleteMessage(
        channelId: string,
        messageId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Delete a Discord message. The bot must have sent the original message or have appropriate permissions. Returns an empty response on success. Required permissions: SEND_DISCORD_MESSAGE
    OperationId: DiscordControllerDeleteMessage

    Parameters

    • channelId: string
    • messageId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• discordControllerGetChannels: function

  • discordControllerGetChannels(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DiscordChannelOutputArrayDTOAPI>

    Retrieve all channels (text, voice, etc.) in a specific Discord guild. Useful for selecting channels for notifications or commands. Required permissions: VIEW_DISCORD_INFO
    OperationId: DiscordControllerGetChannels

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DiscordChannelOutputArrayDTOAPI>

    Throws

• discordControllerGetInvite: function

  • discordControllerGetInvite(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DiscordInviteOutputDTO>

    Get the invite link to add the Takaro bot to a Discord server, along with the developer Discord server link.
    OperationId: DiscordControllerGetInvite

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DiscordInviteOutputDTO>

    Throws

• discordControllerGetRoles: function

  • discordControllerGetRoles(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DiscordRoleOutputArrayDTOAPI>

    Retrieve all roles available in a specific Discord guild. Useful for role-based integrations and permissions mapping. Required permissions: VIEW_DISCORD_INFO
    OperationId: DiscordControllerGetRoles

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DiscordRoleOutputArrayDTOAPI>

    Throws

• discordControllerSearch: function

  • discordControllerSearch(
        guildSearchInputDTO?: GuildSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GuildOutputArrayDTOAPI>

    Search for Discord guilds (servers) that the bot has access to. Supports filtering by name, Discord ID, and whether Takaro is enabled. Required permissions: VIEW_DISCORD_INFO
    OperationId: DiscordControllerSearch

    Parameters

    • OptionalguildSearchInputDTO: GuildSearchInputDTO

      GuildSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GuildOutputArrayDTOAPI>

    Throws

• discordControllerSendMessage: function

  • discordControllerSendMessage(
        id: string,
        sendMessageInputDTO?: SendMessageInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MessageOutputDTOAPI>

    Send a text message or rich embed to a specific Discord channel. Requires the bot to have appropriate permissions in the channel. Required permissions: SEND_DISCORD_MESSAGE
    OperationId: DiscordControllerSendMessage

    Parameters

    • id: string
    • OptionalsendMessageInputDTO: SendMessageInputDTO

      SendMessageInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MessageOutputDTOAPI>

    Throws

• discordControllerUpdateGuild: function

  • discordControllerUpdateGuild(
        id: string,
        guildApiUpdateDTO?: GuildApiUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GuildOutputDTOAPI>

    Update Takaro-specific settings for a Discord guild, such as enabling or disabling Takaro features. Required permissions: MANAGE_SETTINGS
    OperationId: DiscordControllerUpdateGuild

    Parameters

    • id: string
    • OptionalguildApiUpdateDTO: GuildApiUpdateDTO

      GuildApiUpdateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GuildOutputDTOAPI>

    Throws

• discordControllerUpdateMessage: function

  • discordControllerUpdateMessage(
        channelId: string,
        messageId: string,
        sendMessageInputDTO?: SendMessageInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MessageOutputDTOAPI>

    Update an existing Discord message with new content or embed. Requires the bot to have sent the original message. Required permissions: SEND_DISCORD_MESSAGE
    OperationId: DiscordControllerUpdateMessage

    Parameters

    • channelId: string
    • messageId: string
    • OptionalsendMessageInputDTO: SendMessageInputDTO

      SendMessageInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MessageOutputDTOAPI>

    Throws