Constructors
Methods
createGuildStreamer
- createGuildStreamer<P>(__namedParameters): Promise<WebResponse<GuildSingleStreamer<P>>>
Type Parameters
- P extends
| "kick"
| "twitch"
| "rumble"
| "tiktok"
| "youtube"
Parameters
- __namedParameters: {
auth: string;
body: GuildSingleStreamer<P>;
guildId: string;
platform: P;
rumbleType?: RumbleType;
streamer: string;
}auth: string
guildId: string
platform: P
OptionalrumbleType?: RumbleType
streamer: string
createOrUpdateKickStreamerRoles
- createOrUpdateKickStreamerRoles<T>(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
data: KickRolesData<T>;
guildId: string;
platform: "kick";
streamer: string;
subTypeOrId: KickRolesSubType<T>;
type: T;
}auth: string
guildId: string
platform: "kick"
streamer: string
type: T
Returns Promise<WebResponse<string>>
createOrUpdateStreamerMessage
- createOrUpdateStreamerMessage(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
data:
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
};
guildId: string;
platform: never;
rumbleType?: RumbleType;
streamer: string;
subTypeOrId: StreamerMessageTypeEnum;
type: "customMessages";
}auth: string
data:
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
| {
buttons: {
emojiUnicodeOrId: null | string;
title: string;
url: null | string;
}[];
content: null | string;
embed: null | {
author: null | string;
authorIcon: null | string;
color: null | string;
description: 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;
};
type:
| "clip"
| "vod"
| "kickLive"
| "kickOffline"
| "twitchLive"
| "twitchOffline"
| "rumbleLive"
| "rumbleOffline"
| "tiktokLive"
| "tiktokOffline"
| "tiktokVideo"
| "youtubeLive"
| "youtubeVideo";
webhook: null | {
avatarUrl: null | string;
enabled: null | boolean;
username: null | string;
};
}
guildId: string
platform: never
OptionalrumbleType?: RumbleType
streamer: string
type: "customMessages"
Returns Promise<WebResponse<string>>
deleteGuildStreamer
- deleteGuildStreamer<P>(__namedParameters): Promise<WebResponse<string>>
Type Parameters
- P extends
| "kick"
| "twitch"
| "rumble"
| "tiktok"
| "youtube"
Returns Promise<WebResponse<string>>
deleteKickStreamerRoles
- deleteKickStreamerRoles<T>(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
guildId: string;
platform: "kick";
streamer: string;
subTypeOrId: KickRolesSubType<T>;
type: T;
}auth: string
guildId: string
platform: "kick"
streamer: string
type: T
Returns Promise<WebResponse<string>>
deleteStreamerMessage
- deleteStreamerMessage(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
guildId: string;
platform: never;
rumbleType?: RumbleType;
streamer: string;
subTypeOrId: StreamerMessageTypeEnum;
type: "customMessages";
}auth: string
guildId: string
platform: never
OptionalrumbleType?: RumbleType
streamer: string
type: "customMessages"
Returns Promise<WebResponse<string>>
getGuildStreamer
- getGuildStreamer<P>(__namedParameters): Promise<WebResponse<GuildSingleStreamerWithFormatedRole<P>>>
Type Parameters
- P extends
| "kick"
| "twitch"
| "rumble"
| "tiktok"
| "youtube"
Parameters
- __namedParameters: {
auth: string;
guildId: string;
platform: P;
rumbleType?: RumbleType;
streamer: string;
}auth: string
guildId: string
platform: P
OptionalrumbleType?: RumbleType
streamer: string
getGuildStreamers
- getGuildStreamers<T, P>(__namedParameters): Promise<WebResponse<Platformstreamers<T, P>>>
Type Parameters
- T extends boolean
- P extends
| "kick"
| "twitch"
| "rumble"
| "tiktok"
| "youtube"
Parameters
- __namedParameters: {
auth: string;
guildId: string;
platform: P;
shortView: T;
}auth: string
guildId: string
platform: P
shortView: T
sendTestNotification
- sendTestNotification(__namedParameters): Promise<WebResponse<string>>
Parameters
- __namedParameters: {
auth: string;
guildId: string;
platform: never;
rumbleType?: RumbleType;
streamer: string;
subType?: SubType;
}auth: string
guildId: string
platform: never
OptionalrumbleType?: RumbleType
streamer: string
OptionalsubType?: SubType
Returns Promise<WebResponse<string>>
updateGuildStreamer
- updateGuildStreamer<P>(__namedParameters): Promise<WebResponse<string>>
Type Parameters
- P extends
| "kick"
| "twitch"
| "rumble"
| "tiktok"
| "youtube"
Returns Promise<WebResponse<string>>