Type Alias GuildFunctionsInput<T, T2, S, T3>

Type declaration

• cleanupStreamRoles: {
      auth: string;
      guildId: string;
  }

  • auth: string

  • guildId: string

• clearGuildErrors: {
      auth: string;
      guildId: string;
  }

  • auth: string

  • guildId: string

• createOrUpdateGuildMessage: {
      auth: string;
      data: GuildMessageBody<T2>;
      guildId: string;
      messageSubType: S;
      messageType: T2;
  }

  • auth: string

  • data: GuildMessageBody<T2>

  • guildId: string

  • messageSubType: S

  • messageType: T2

• createOrUpdateGuildRoles: {
      auth: string;
      data: GuildRoleBody<T3>;
      guildId: string;
      roleId: string;
      type: T3;
  }

  • auth: string

  • data: GuildRoleBody<T3>

  • guildId: string

  • roleId: string

  • type: T3

• createOrUpdateLinkedRole: {
      auth: string;
      data: GuildZod["linkedRoles"][number];
      guildId: string;
      roleId: string;
  }

  • auth: string

  • data: GuildZod["linkedRoles"][number]

  • guildId: string

  • roleId: string

• createOrUpdateOverride: {
      auth: string;
      data: GuildZod["notificationOverrides"][number];
      guildId: string;
      priorityOnConflict: number;
  }

  • auth: string

  • data: GuildZod["notificationOverrides"][number]

  • guildId: string

  • priorityOnConflict: number

• createOrUpdateStickyMessage: {
      auth: string;
      channelId: string;
      data: GuildZod["stickyMessages"][number];
      guildId: string;
  }

  • auth: string

  • channelId: string

  • data: GuildZod["stickyMessages"][number]

  • guildId: string

• deleteGuildMessage: {
      auth: string;
      guildId: string;
      messageSubType: S;
      messageType: T2;
  }

  • auth: string

  • guildId: string

  • messageSubType: S

  • messageType: T2

• deleteGuildRoles: {
      auth: string;
      guildId: string;
      roleId: string;
      type: T3;
  }

  • auth: string

  • guildId: string

  • roleId: string

  • type: T3

• deleteLinkedRole: {
      auth: string;
      guildId: string;
      roleId: string;
  }

  • auth: string

  • guildId: string

  • roleId: string

• deleteOverride: {
      auth: string;
      guildId: string;
      priorityOnConflict: number;
  }

  • auth: string

  • guildId: string

  • priorityOnConflict: number

• deleteStickyMessage: {
      auth: string;
      channelId: string;
      guildId: string;
  }

  • auth: string

  • channelId: string

  • guildId: string

• getCustomBotProfile: {
      auth: string;
      guildId: string;
  }

  • auth: string

  • guildId: string

• getGuild: {
      auth: string;
      guildId: string;
  }

  • auth: string

  • guildId: string

• getGuildErrors: {
      auth: string;
      guildId: string;
  }

  • auth: string

  • guildId: string

• sendGreetOrBirthdayMessage: {
      auth: string;
      guildId: string;
      type: "welcome" | "leave" | "birthday";
  }

  • auth: string

  • guildId: string

  • type: "welcome" | "leave" | "birthday"

• sendGuildPanelOrNotification: {
      auth: string;
      body: SendPanelBody<T>;
      dontPing?: boolean;
      guildId: string;
      panel: T;
  }

  • auth: string

  • body: SendPanelBody<T>

  • OptionaldontPing?: boolean

  • guildId: string

  • panel: T

• sendTestKickBotNotification: {
      auth: string;
      dontPing?: boolean;
      guildId: string;
      streamerUserName: string;
      type: "vod" | "clip";
  }

  • auth: string

  • OptionaldontPing?: boolean

    Deprecated

    Ignored as of the 2026-09-19 API build. A dashboard test NEVER pings.

    Sending it is harmless - the route no longer reads the query parameter - but it does nothing, so do not build a UI control on it. The role still RENDERS in the test message: the bot sends allowedMentions: { parse: [] }, which keeps the mention highlighted and resolves nobody, so a test shows exactly what the real notification will look like without notifying the server.

    Three of the four dashboard test routes used to ping for real, this one included. Pinging a server to preview a layout is a cost with no matching benefit.

    The Discord side keeps an opt-IN: /setup test with_ping:True.

  • guildId: string

  • streamerUserName: string

  • type: "vod" | "clip"

• updateCustomBotProfile: {
      auth: string;
      formData: FormData;
      guildId: string;
  }

  • auth: string

  • formData: FormData

  • guildId: string

• updateGuild: {
      auth: string;
      guild: DeepPartial<GuildZod>;
      guildId: string;
  }

  • auth: string

  • guild: DeepPartial<GuildZod>

  • guildId: string