Constructors
Methods
getGuild
- getGuild(__namedParameters): Promise<WebResponse<GuildWithErrors>>
Parameters
- __namedParameters: {
auth: string;
guildId: string;
}auth: string
guildId: string
sendGuildPanel
- sendGuildPanel<T>(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
body: SendPanelBody<T>;
guildId: string;
panel: T;
}auth: string
guildId: string
panel: T
Returns Promise<WebResponse<string>>
sendTestNotification
- sendTestNotification(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
guildId: string;
streamer: string;
type: "clip" | "vod";
}auth: string
guildId: string
streamer: string
type: "clip" | "vod"
Returns Promise<WebResponse<string>>
updateGuild
- updateGuild(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
guild: DeepPartial<{
autoLiveRoleLogs?: null | string;
autoLiveRoles?: null | {
filter?: null | {
mode?: null | "whitelist" | "blacklist";
roles?: null | string[];
};
roleId?: null | string;
}[];
birthdayChannelId?: null | string;
birthdayEnabled?: null | boolean;
birthdayRoleId?: null | string;
bitfield?: null | string;
blacklisted?: null | boolean;
disableBranding?: null | {
birthday?: null | boolean;
clips?: null | boolean;
giveaways?: null | boolean;
leaderboard?: null | boolean;
notifications?: null | boolean;
starboard?: null | boolean;
vods?: null | boolean;
welcomeLeave?: null | boolean;
};
gettingStarted?: null | {
didBuyPremium?: null | boolean;
didDismissGuildAds?: null | boolean;
didSetupBirthday?: null | boolean;
didSetupFirstContentCreator?: null | boolean;
};
guildId?: string;
leaveChannelId?: null | string;
leaveEnabled?: null | boolean;
locale?: null | string;
messages?: null | {
buttons?: null | {
title?: null | string;
url?: null | string;
}[];
content?: null | string;
embed?: null | {
author?: null | {
icon_url?: (...) | (...) | (...);
name?: (...) | (...) | (...);
url?: (...) | (...) | (...);
};
color?: null | number;
description?: null | string;
fields?: null | {
inline?: ...;
name?: ...;
value?: ...;
}[];
footer?: null | {
icon_url?: (...) | (...) | (...);
text?: (...) | (...) | (...);
};
image?: null | {
url?: (...) | (...) | (...);
};
thumbnail?: null | {
url?: (...) | (...) | (...);
};
title?: null | string;
url?: null | string;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "birthday"
| "welcome"
| "leave";
webhook?: null | {
avatarUrl?: null | string;
enabled?: null | boolean;
username?: null | string;
};
}[];
notificationOverrides?: null | {
actions?: null | ("autoPublish" | "cancel" | "dontPublish")[];
applyTo?: null | (
| "kick"
| "tiktok"
| "twitch"
| "rumble")[];
overrideChannelId?: null | string;
overridePingRoleId?: null | string;
priorityOnConflict?: null | number;
query?: null | string[];
queryIn?:
| null
| "title"
| "description"
| "category";
}[];
overrideBranding?: null | boolean;
premium?: null | {
additionalAutoLiveRoles?: null | number;
additionalConnections?: null | number;
additionalOverrides?: null | number;
additionalStatusRoles?: null | number;
additionalStickyMessages?: null | number;
enabled?: null | boolean;
tier?: null | string;
};
singleMessages?: null | {
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?: null | {
filter?: null | {
mode?: null | "whitelist" | "blacklist";
roles?: null | string[];
};
keepOnOffline?: null | boolean;
roleId?: null | string;
texts?: null | string[];
}[];
stickyMessages?: null | {
buttons?: null | {
title?: null | string;
url?: null | string;
}[];
channelId?: null | string;
content?: null | string;
embed?: null | {
author?: null | {
icon_url?: (...) | (...) | (...);
name?: (...) | (...) | (...);
url?: (...) | (...) | (...);
};
color?: null | number;
description?: null | string;
fields?: null | {
inline?: ...;
name?: ...;
value?: ...;
}[];
footer?: null | {
icon_url?: (...) | (...) | (...);
text?: (...) | (...) | (...);
};
image?: null | {
url?: (...) | (...) | (...);
};
thumbnail?: null | {
url?: (...) | (...) | (...);
};
title?: null | string;
url?: null | string;
};
messageId?: null | string;
webhook?: null | {
avatarUrl?: null | string;
enabled?: null | boolean;
username?: null | string;
};
}[];
syncUsername?: null | boolean;
vodDownloadStoreForHours?: null | number;
welcomeChannelId?: null | string;
welcomeEnabled?: null | boolean;
}, true>;
guildId: string;
}auth: string
guild: DeepPartial<{
autoLiveRoleLogs?: null | string;
autoLiveRoles?: null | {
filter?: null | {
mode?: null | "whitelist" | "blacklist";
roles?: null | string[];
};
roleId?: null | string;
}[];
birthdayChannelId?: null | string;
birthdayEnabled?: null | boolean;
birthdayRoleId?: null | string;
bitfield?: null | string;
blacklisted?: null | boolean;
disableBranding?: null | {
birthday?: null | boolean;
clips?: null | boolean;
giveaways?: null | boolean;
leaderboard?: null | boolean;
notifications?: null | boolean;
starboard?: null | boolean;
vods?: null | boolean;
welcomeLeave?: null | boolean;
};
gettingStarted?: null | {
didBuyPremium?: null | boolean;
didDismissGuildAds?: null | boolean;
didSetupBirthday?: null | boolean;
didSetupFirstContentCreator?: null | boolean;
};
guildId?: string;
leaveChannelId?: null | string;
leaveEnabled?: null | boolean;
locale?: null | string;
messages?: null | {
buttons?: null | {
title?: null | string;
url?: null | string;
}[];
content?: null | string;
embed?: null | {
author?: null | {
icon_url?: (...) | (...) | (...);
name?: (...) | (...) | (...);
url?: (...) | (...) | (...);
};
color?: null | number;
description?: null | string;
fields?: null | {
inline?: ...;
name?: ...;
value?: ...;
}[];
footer?: null | {
icon_url?: (...) | (...) | (...);
text?: (...) | (...) | (...);
};
image?: null | {
url?: (...) | (...) | (...);
};
thumbnail?: null | {
url?: (...) | (...) | (...);
};
title?: null | string;
url?: null | string;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "birthday"
| "welcome"
| "leave";
webhook?: null | {
avatarUrl?: null | string;
enabled?: null | boolean;
username?: null | string;
};
}[];
notificationOverrides?: null | {
actions?: null | ("autoPublish" | "cancel" | "dontPublish")[];
applyTo?: null | (
| "kick"
| "tiktok"
| "twitch"
| "rumble")[];
overrideChannelId?: null | string;
overridePingRoleId?: null | string;
priorityOnConflict?: null | number;
query?: null | string[];
queryIn?:
| null
| "title"
| "description"
| "category";
}[];
overrideBranding?: null | boolean;
premium?: null | {
additionalAutoLiveRoles?: null | number;
additionalConnections?: null | number;
additionalOverrides?: null | number;
additionalStatusRoles?: null | number;
additionalStickyMessages?: null | number;
enabled?: null | boolean;
tier?: null | string;
};
singleMessages?: null | {
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?: null | {
filter?: null | {
mode?: null | "whitelist" | "blacklist";
roles?: null | string[];
};
keepOnOffline?: null | boolean;
roleId?: null | string;
texts?: null | string[];
}[];
stickyMessages?: null | {
buttons?: null | {
title?: null | string;
url?: null | string;
}[];
channelId?: null | string;
content?: null | string;
embed?: null | {
author?: null | {
icon_url?: (...) | (...) | (...);
name?: (...) | (...) | (...);
url?: (...) | (...) | (...);
};
color?: null | number;
description?: null | string;
fields?: null | {
inline?: ...;
name?: ...;
value?: ...;
}[];
footer?: null | {
icon_url?: (...) | (...) | (...);
text?: (...) | (...) | (...);
};
image?: null | {
url?: (...) | (...) | (...);
};
thumbnail?: null | {
url?: (...) | (...) | (...);
};
title?: null | string;
url?: null | string;
};
messageId?: null | string;
webhook?: null | {
avatarUrl?: null | string;
enabled?: null | boolean;
username?: null | string;
};
}[];
syncUsername?: null | boolean;
vodDownloadStoreForHours?: null | number;
welcomeChannelId?: null | string;
welcomeEnabled?: null | boolean;
}, true>
guildId: string
Returns Promise<WebResponse<string>>