Takaro - v0.4.9
    Preparing search index...

    Function DiscordApiAxiosParamCreator

    • DiscordApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          discordControllerDeleteMessage: (
              channelId: string,
              messageId: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          discordControllerGetChannels: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          discordControllerGetInvite: (
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          discordControllerGetRoles: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          discordControllerSearch: (
              guildSearchInputDTO?: GuildSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          discordControllerSendMessage: (
              id: string,
              sendMessageInputDTO?: SendMessageInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          discordControllerUpdateGuild: (
              id: string,
              guildApiUpdateDTO?: GuildApiUpdateDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          discordControllerUpdateMessage: (
              channelId: string,
              messageId: string,
              sendMessageInputDTO?: SendMessageInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • discordControllerDeleteMessage: (
            channelId: string,
            messageId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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

      • discordControllerGetChannels: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        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

      • discordControllerGetInvite: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

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

      • discordControllerGetRoles: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

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

      • discordControllerSearch: (
            guildSearchInputDTO?: GuildSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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

      • discordControllerSendMessage: (
            id: string,
            sendMessageInputDTO?: SendMessageInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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

      • discordControllerUpdateGuild: (
            id: string,
            guildApiUpdateDTO?: GuildApiUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

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

      • discordControllerUpdateMessage: (
            channelId: string,
            messageId: string,
            sendMessageInputDTO?: SendMessageInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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