Class APIGuild

auth: string

guildId: string

auth: string

guildId: string

auth: string

data: GuildMessageBody<T>

guildId: string

messageSubType: S

messageType: T

auth: string

data: GuildRoleBody<T>

guildId: string

roleId: string

type: T

auth: string

data: {
    onAddRolesToAdd: string[];
    onAddRolesToRemove: string[];
    onRemoveRolesToAdd: string[];
    onRemoveRolesToRemove: string[];
    roleId: string;
}

• onAddRolesToAdd: string[]

• onAddRolesToRemove: string[]

• onRemoveRolesToAdd: string[]

• onRemoveRolesToRemove: string[]

• roleId: string

guildId: string

roleId: string

auth: string

data: {
    actions: ("autoPublish" | "cancel" | "dontPublish")[];
    applyTo: (
        | "kick"
        | "twitch"
        | "rumble"
        | "tiktok"
        | "youtube"
        | "whatnot"
        | "club"
        | "twitter")[];
    applyToStreamers: string[];
    durationMinutes: null | number;
    minDurationMinutes: null | number;
    minFollowers: null | number;
    overrideChannelId: null | string;
    overridePingRoleId: null | string;
    priorityOnConflict: number;
    query: string[];
    queryIn: ("title" | "category" | "description")[];
}

• actions: ("autoPublish" | "cancel" | "dontPublish")[]

• applyTo: (
      | "kick"
      | "twitch"
      | "rumble"
      | "tiktok"
      | "youtube"
      | "whatnot"
      | "club"
      | "twitter")[]

• applyToStreamers: string[]

  Creator filter, alongside applyTo's platform filter. Empty means any creator.

  Platform USERNAMES - the channel slug, adinross for kick.com/adinross. NOT ids, and nothing Discord. Matched EXACTLY and case-insensitively; unlike query this is not a substring search, so adin will not match adinross.

  Spelled out because the neighbouring references here (overrideChannelId, overridePingRoleId) are snowflake ids, so a bare string[] called "streamers" reads like creator ids - the dashboard built its first editor that way. A value that matches nothing silently disables the override.

  Best offered as a picker over the guild's tracked streamers, not a free-text box.

• durationMinutes: null | number

  Duration CEILING - matches content shorter than this.

• minDurationMinutes: null | number

  Duration FLOOR - matches content longer than this. Set both for a range.

• minFollowers: null | number

  Audience floor. Kick/Rumble/TikTok only; elsewhere the override does not apply.

• overrideChannelId: null | string

• overridePingRoleId: null | string

• priorityOnConflict: number

• query: string[]

• queryIn: ("title" | "category" | "description")[]

guildId: string

priorityOnConflict: number

auth: string

channelId: string

data: {
    blacklistRoleIds: string[];
    buttons: {
        emojiUnicodeOrId: null | string;
        title: string;
        url: null | string;
    }[];
    channelId: string;
    content: null | string;
    embed: null | {
        author: null | string;
        authorIcon: null | string;
        color: null | string;
        description: null | string;
        fields: {
            inline: null | boolean;
            name: string;
            value: null | string;
        }[];
        footer: null | string;
        footerIcon: null | string;
        image: null | string;
        thumbnail: null | string;
        title: null | string;
        url: null | string;
    };
    messageId: null | string;
    requiredRoleIds: string[];
    showInviteButton: null | boolean;
    showWatchButton: null | boolean;
    webhook: null | {
        avatarUrl: null | string;
        enabled: null | boolean;
        username: null | string;
    };
}

• blacklistRoleIds: string[]

• buttons: {
      emojiUnicodeOrId: null | string;
      title: string;
      url: null | string;
  }[]

• channelId: string

• content: null | string

• embed: null | {
      author: null | string;
      authorIcon: null | string;
      color: null | string;
      description: null | string;
      fields: {
          inline: null | boolean;
          name: string;
          value: null | string;
      }[];
      footer: null | string;
      footerIcon: null | string;
      image: null | string;
      thumbnail: null | string;
      title: null | string;
      url: null | string;
  }

• messageId: null | string

• requiredRoleIds: string[]

• showInviteButton: null | boolean

• showWatchButton: null | boolean

• webhook: null | {
      avatarUrl: null | string;
      enabled: null | boolean;
      username: null | string;
  }

guildId: string

auth: string

guildId: string

messageSubType: S

messageType: T

auth: string

guildId: string

roleId: string

type: T

auth: string

guildId: string

roleId: string

auth: string

guildId: string

priorityOnConflict: number

auth: string

channelId: string

guildId: string

auth: string

guildId: string

auth: string

guildId: string

auth: string

guildId: string

auth: string

guildId: string

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

auth: string

body: SendPanelBody<T>

OptionaldontPing?: boolean

guildId: string

panel: T

auth: string

OptionaldontPing?: boolean

guildId: string

streamerUserName: string

type: "clip" | "vod"

auth: string

formData: FormData

guildId: string

auth: string

guild: {
    autoLiveRoleLogs?: null | string;
    autoLiveRoles?: {
        filter?: null | {
            mode?: "whitelist" | "blacklist";
            roles?: string[];
        };
        roleId?: string;
    }[];
    birthdayChannelId?: null | string;
    birthdayEnabled?: null | boolean;
    birthdayPanelChannelId?: null | string;
    birthdayPanelDuration?: null | string;
    birthdayPanelMessageId?: null | string;
    birthdayRoleId?: null | string;
    bitfield?: null | string;
    blacklisted?: boolean;
    customBotProfile?: null | {
        avatarKey?: null | string;
        bannerKey?: null | string;
        bio?: null | string;
        enabled?: boolean;
        nick?: null | string;
    };
    disableBranding?: null | {
        birthday?: null | boolean;
        clips?: null | boolean;
        fixUrl?: null | boolean;
        giveaways?: null | boolean;
        leaderboard?: null | boolean;
        linkedRoles?: null | boolean;
        notifications?: null | boolean;
        starboard?: null | boolean;
        stickyMessage?: null | boolean;
        vods?: null | boolean;
        watchOnButton?: null | boolean;
        welcomeLeave?: null | boolean;
    };
    disableDoubleVoteEntry?: null | boolean;
    gettingStarted?: null | {
        didBuyPremium?: boolean;
        didDismissGuildAds?: boolean;
        didSetupBirthday?: boolean;
        didSetupFirstContentCreator?: boolean;
    };
    giveawayJoinLinks?: boolean;
    giveawayLogsChannelId?: null | string;
    guildId?: string;
    ignoreIfNotCatchedByOverride?: null | boolean;
    leaveChannelId?: null | string;
    leaveEnabled?: null | boolean;
    leftAt?: null | Date;
    linkedRoleLogs?: null | string;
    linkedRoles?: {
        onAddRolesToAdd?: string[];
        onAddRolesToRemove?: string[];
        onRemoveRolesToAdd?: string[];
        onRemoveRolesToRemove?: string[];
        roleId?: string;
    }[];
    locale?: string;
    messages?: {
        buttons?: {
            emojiUnicodeOrId?: null | string;
            title?: string;
            url?: null | string;
        }[];
        content?: null | string;
        embed?: null | {
            author?: null | string;
            authorIcon?: null | string;
            color?: null | string;
            description?: null | string;
            fields?: {
                inline?:
                    | (...)
                    | (...)
                    | (...)
                    | (...);
                name?: (...) | (...);
                value?: (...) | (...) | (...);
            }[];
            footer?: null | string;
            footerIcon?: null | string;
            image?: null | string;
            thumbnail?: null | string;
            title?: null | string;
            url?: null | string;
        };
        showInviteButton?: null | boolean;
        showWatchButton?: null | boolean;
        type?:
            | "clip"
            | "clipForward"
            | "vod"
            | "kickLive"
            | "kickOffline"
            | "twitchLive"
            | "twitchOffline"
            | "rumbleLive"
            | "rumbleOffline"
            | "rumbleVideo"
            | "tiktokLive"
            | "tiktokOffline"
            | "tiktokVideo"
            | "youtubeLive"
            | "youtubeVideo"
            | "whatnotLive"
            | "whatnotOffline"
            | "clubPost"
            | "twitterPost"
            | "twitterLive"
            | "twitterOffline"
            | "giveawayRerolled"
            | "giveawayWinner"
            | "giveawayEnded"
            | "giveawayDM"
            | "linkedRole"
            | "giveaway"
            | "birthday"
            | "welcome"
            | "leave";
        webhook?: null | {
            avatarUrl?: null | string;
            enabled?: null | boolean;
            username?: null | string;
        };
    }[];
    notificationOverrides?: {
        actions?: ("autoPublish" | "cancel" | "dontPublish")[];
        applyTo?: (
            | "kick"
            | "twitch"
            | "rumble"
            | "tiktok"
            | "youtube"
            | "whatnot"
            | "club"
            | "twitter")[];
        applyToStreamers?: string[];
        durationMinutes?: null | number;
        minDurationMinutes?: null | number;
        minFollowers?: null | number;
        overrideChannelId?: null | string;
        overridePingRoleId?: null | string;
        priorityOnConflict?: number;
        query?: string[];
        queryIn?: ("title" | "category" | "description")[];
    }[];
    overrideBranding?: null | boolean;
    premium?: null | {
        additionalAutoLiveRoles?: number;
        additionalClipperConnections?: number;
        additionalClubConnections?: number;
        additionalKickClips?: number;
        additionalKickConnections?: number;
        additionalLinkedRoles?: number;
        additionalOverrides?: number;
        additionalRumbleConnections?: number;
        additionalStarboards?: number;
        additionalStatCounters?: number;
        additionalStatusRoles?: number;
        additionalStickyMessages?: number;
        additionalTiktokConnections?: number;
        additionalTwitchClips?: number;
        additionalTwitchConnections?: number;
        additionalTwitterConnections?: number;
        additionalWhatnotConnections?: number;
        additionalYoutubeConnections?: number;
        assignedAt?: Date;
        attributedAt?: null | Date;
        attributionGuildId?: null | string;
        attributionSource?: null | string;
        customBot?: boolean;
        tier?: string;
        updatedAt?: Date;
    };
    publicGiveaways?: boolean;
    randomMessages?: {
        messages?: string[];
        type?:
            | "clip"
            | "clipForward"
            | "vod"
            | "kickLive"
            | "kickOffline"
            | "twitchLive"
            | "twitchOffline"
            | "rumbleLive"
            | "rumbleOffline"
            | "rumbleVideo"
            | "tiktokLive"
            | "tiktokOffline"
            | "tiktokVideo"
            | "youtubeLive"
            | "youtubeVideo"
            | "whatnotLive"
            | "whatnotOffline"
            | "clubPost"
            | "twitterPost"
            | "twitterLive"
            | "twitterOffline"
            | "giveawayRerolled"
            | "giveawayWinner"
            | "giveawayEnded"
            | "giveawayDM"
            | "linkedRole"
            | "giveaway"
            | "birthday"
            | "welcome"
            | "leave";
    }[];
    singleMessages?: {
        message?: null | string;
        type?:
            | "autoLiveRoleAdded"
            | "autoLiveRoleRemoved"
            | "statusRoleAdded"
            | "statusRoleRemoved"
            | "statChannelLive"
            | "statChannelOffline"
            | "statFollowers";
        webhook?: null | {
            avatarUrl?: null | string;
            enabled?: null | boolean;
            username?: null | string;
        };
    }[];
    statusRoleLogs?: null | string;
    statusRoles?: {
        filter?: null | {
            mode?: "whitelist" | "blacklist";
            roles?: string[];
        };
        keepOnOffline?: null | boolean;
        roleId?: string;
        texts?: string[];
    }[];
    stickyMessageDelaySeconds?: null | number;
    stickyMessages?: {
        blacklistRoleIds?: string[];
        buttons?: {
            emojiUnicodeOrId?: null | string;
            title?: string;
            url?: null | string;
        }[];
        channelId?: string;
        content?: null | string;
        embed?: null | {
            author?: null | string;
            authorIcon?: null | string;
            color?: null | string;
            description?: null | string;
            fields?: {
                inline?:
                    | (...)
                    | (...)
                    | (...)
                    | (...);
                name?: (...) | (...);
                value?: (...) | (...) | (...);
            }[];
            footer?: null | string;
            footerIcon?: null | string;
            image?: null | string;
            thumbnail?: null | string;
            title?: null | string;
            url?: null | string;
        };
        messageId?: null | string;
        requiredRoleIds?: string[];
        showInviteButton?: null | boolean;
        showWatchButton?: null | boolean;
        webhook?: null | {
            avatarUrl?: null | string;
            enabled?: null | boolean;
            username?: null | string;
        };
    }[];
    streamRoleLogs?: null | string;
    streamRoles?: {
        applyTo?: (
            | "kick"
            | "twitch"
            | "rumble"
            | "tiktok"
            | "youtube"
            | "whatnot"
            | "club"
            | "twitter")[];
        applyToStreamers?: string[];
        categoryTexts?: string[];
        filter?: null | {
            mode?: "whitelist" | "blacklist";
            roles?: string[];
        };
        roleId?: string;
        source?: "any" | "presence" | "platform";
        texts?: string[];
        titleTexts?: string[];
    }[];
    syncUsername?: null | boolean;
    timezone?: string;
    vodDownloadStoreForHours?: null | number;
    welcomeChannelId?: null | string;
    welcomeEnabled?: null | boolean;
}

• OptionalautoLiveRoleLogs?: null | string

• OptionalautoLiveRoles?: {
      filter?: null | {
          mode?: "whitelist" | "blacklist";
          roles?: string[];
      };
      roleId?: string;
  }[]

• OptionalbirthdayChannelId?: null | string

• OptionalbirthdayEnabled?: null | boolean

• OptionalbirthdayPanelChannelId?: null | string

• OptionalbirthdayPanelDuration?: null | string

• OptionalbirthdayPanelMessageId?: null | string

• OptionalbirthdayRoleId?: null | string

• Optionalbitfield?: null | string

• Optionalblacklisted?: boolean

• OptionalcustomBotProfile?: null | {
      avatarKey?: null | string;
      bannerKey?: null | string;
      bio?: null | string;
      enabled?: boolean;
      nick?: null | string;
  }

• OptionaldisableBranding?: null | {
      birthday?: null | boolean;
      clips?: null | boolean;
      fixUrl?: null | boolean;
      giveaways?: null | boolean;
      leaderboard?: null | boolean;
      linkedRoles?: null | boolean;
      notifications?: null | boolean;
      starboard?: null | boolean;
      stickyMessage?: null | boolean;
      vods?: null | boolean;
      watchOnButton?: null | boolean;
      welcomeLeave?: null | boolean;
  }

• OptionaldisableDoubleVoteEntry?: null | boolean

• OptionalgettingStarted?: null | {
      didBuyPremium?: boolean;
      didDismissGuildAds?: boolean;
      didSetupBirthday?: boolean;
      didSetupFirstContentCreator?: boolean;
  }

• OptionalgiveawayJoinLinks?: boolean

• OptionalgiveawayLogsChannelId?: null | string

• OptionalguildId?: string

• OptionalignoreIfNotCatchedByOverride?: null | boolean

• OptionalleaveChannelId?: null | string

• OptionalleaveEnabled?: null | boolean

• OptionalleftAt?: null | Date

• OptionallinkedRoleLogs?: null | string

• OptionallinkedRoles?: {
      onAddRolesToAdd?: string[];
      onAddRolesToRemove?: string[];
      onRemoveRolesToAdd?: string[];
      onRemoveRolesToRemove?: string[];
      roleId?: string;
  }[]

• Optionallocale?: string

• Optionalmessages?: {
      buttons?: {
          emojiUnicodeOrId?: null | string;
          title?: string;
          url?: null | string;
      }[];
      content?: null | string;
      embed?: null | {
          author?: null | string;
          authorIcon?: null | string;
          color?: null | string;
          description?: null | string;
          fields?: {
              inline?:
                  | (...)
                  | (...)
                  | (...)
                  | (...);
              name?: (...) | (...);
              value?: (...) | (...) | (...);
          }[];
          footer?: null | string;
          footerIcon?: null | string;
          image?: null | string;
          thumbnail?: null | string;
          title?: null | string;
          url?: null | string;
      };
      showInviteButton?: null | boolean;
      showWatchButton?: null | boolean;
      type?:
          | "clip"
          | "clipForward"
          | "vod"
          | "kickLive"
          | "kickOffline"
          | "twitchLive"
          | "twitchOffline"
          | "rumbleLive"
          | "rumbleOffline"
          | "rumbleVideo"
          | "tiktokLive"
          | "tiktokOffline"
          | "tiktokVideo"
          | "youtubeLive"
          | "youtubeVideo"
          | "whatnotLive"
          | "whatnotOffline"
          | "clubPost"
          | "twitterPost"
          | "twitterLive"
          | "twitterOffline"
          | "giveawayRerolled"
          | "giveawayWinner"
          | "giveawayEnded"
          | "giveawayDM"
          | "linkedRole"
          | "giveaway"
          | "birthday"
          | "welcome"
          | "leave";
      webhook?: null | {
          avatarUrl?: null | string;
          enabled?: null | boolean;
          username?: null | string;
      };
  }[]

• OptionalnotificationOverrides?: {
      actions?: ("autoPublish" | "cancel" | "dontPublish")[];
      applyTo?: (
          | "kick"
          | "twitch"
          | "rumble"
          | "tiktok"
          | "youtube"
          | "whatnot"
          | "club"
          | "twitter")[];
      applyToStreamers?: string[];
      durationMinutes?: null | number;
      minDurationMinutes?: null | number;
      minFollowers?: null | number;
      overrideChannelId?: null | string;
      overridePingRoleId?: null | string;
      priorityOnConflict?: number;
      query?: string[];
      queryIn?: ("title" | "category" | "description")[];
  }[]

• OptionaloverrideBranding?: null | boolean

• Optionalpremium?: null | {
      additionalAutoLiveRoles?: number;
      additionalClipperConnections?: number;
      additionalClubConnections?: number;
      additionalKickClips?: number;
      additionalKickConnections?: number;
      additionalLinkedRoles?: number;
      additionalOverrides?: number;
      additionalRumbleConnections?: number;
      additionalStarboards?: number;
      additionalStatCounters?: number;
      additionalStatusRoles?: number;
      additionalStickyMessages?: number;
      additionalTiktokConnections?: number;
      additionalTwitchClips?: number;
      additionalTwitchConnections?: number;
      additionalTwitterConnections?: number;
      additionalWhatnotConnections?: number;
      additionalYoutubeConnections?: number;
      assignedAt?: Date;
      attributedAt?: null | Date;
      attributionGuildId?: null | string;
      attributionSource?: null | string;
      customBot?: boolean;
      tier?: string;
      updatedAt?: Date;
  }

• OptionalpublicGiveaways?: boolean

• OptionalrandomMessages?: {
      messages?: string[];
      type?:
          | "clip"
          | "clipForward"
          | "vod"
          | "kickLive"
          | "kickOffline"
          | "twitchLive"
          | "twitchOffline"
          | "rumbleLive"
          | "rumbleOffline"
          | "rumbleVideo"
          | "tiktokLive"
          | "tiktokOffline"
          | "tiktokVideo"
          | "youtubeLive"
          | "youtubeVideo"
          | "whatnotLive"
          | "whatnotOffline"
          | "clubPost"
          | "twitterPost"
          | "twitterLive"
          | "twitterOffline"
          | "giveawayRerolled"
          | "giveawayWinner"
          | "giveawayEnded"
          | "giveawayDM"
          | "linkedRole"
          | "giveaway"
          | "birthday"
          | "welcome"
          | "leave";
  }[]

• OptionalsingleMessages?: {
      message?: null | string;
      type?:
          | "autoLiveRoleAdded"
          | "autoLiveRoleRemoved"
          | "statusRoleAdded"
          | "statusRoleRemoved"
          | "statChannelLive"
          | "statChannelOffline"
          | "statFollowers";
      webhook?: null | {
          avatarUrl?: null | string;
          enabled?: null | boolean;
          username?: null | string;
      };
  }[]

• OptionalstatusRoleLogs?: null | string

• OptionalstatusRoles?: {
      filter?: null | {
          mode?: "whitelist" | "blacklist";
          roles?: string[];
      };
      keepOnOffline?: null | boolean;
      roleId?: string;
      texts?: string[];
  }[]

• OptionalstickyMessageDelaySeconds?: null | number

• OptionalstickyMessages?: {
      blacklistRoleIds?: string[];
      buttons?: {
          emojiUnicodeOrId?: null | string;
          title?: string;
          url?: null | string;
      }[];
      channelId?: string;
      content?: null | string;
      embed?: null | {
          author?: null | string;
          authorIcon?: null | string;
          color?: null | string;
          description?: null | string;
          fields?: {
              inline?:
                  | (...)
                  | (...)
                  | (...)
                  | (...);
              name?: (...) | (...);
              value?: (...) | (...) | (...);
          }[];
          footer?: null | string;
          footerIcon?: null | string;
          image?: null | string;
          thumbnail?: null | string;
          title?: null | string;
          url?: null | string;
      };
      messageId?: null | string;
      requiredRoleIds?: string[];
      showInviteButton?: null | boolean;
      showWatchButton?: null | boolean;
      webhook?: null | {
          avatarUrl?: null | string;
          enabled?: null | boolean;
          username?: null | string;
      };
  }[]

• OptionalstreamRoleLogs?: null | string

• OptionalstreamRoles?: {
      applyTo?: (
          | "kick"
          | "twitch"
          | "rumble"
          | "tiktok"
          | "youtube"
          | "whatnot"
          | "club"
          | "twitter")[];
      applyToStreamers?: string[];
      categoryTexts?: string[];
      filter?: null | {
          mode?: "whitelist" | "blacklist";
          roles?: string[];
      };
      roleId?: string;
      source?: "any" | "presence" | "platform";
      texts?: string[];
      titleTexts?: string[];
  }[]

• OptionalsyncUsername?: null | boolean

• Optionaltimezone?: string

• OptionalvodDownloadStoreForHours?: null | number

• OptionalwelcomeChannelId?: null | string

• OptionalwelcomeEnabled?: null | boolean