@notidotbot/noti-api-client 1.4.0

package/dist/other/templates.js

@@ -0,0 +1,706 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.messages = exports.statChannels = exports.buttons = exports.randomMessages = exports.placeholders = void 0;
+exports.placeholders = {
+    vod: {
+        'streamerName': 'Example',
+        'followers': '239.9K',
+        'category': 'Example Category',
+        'streamTitle': 'Example Stream Title',
+        'streamThumbnail': 'https://example.com',
+        'pingRole': '<@&123456789>',
+        'vodUrl': 'https://example.com',
+        'viewers': '239.9K',
+        'expiresAt': '<t:164099520:R>',
+        'duration': '4h 20m',
+        'startTime': '<t:164099520:R>',
+        'endTime': '<t:164099520:R>',
+        'userAvatar': 'https://example.com',
+        'downloadUrl': 'https://example.com',
+    },
+    clip: {
+        'streamerName': 'Example',
+        'clipperName': 'Example',
+        'duration': '4h 20m',
+        'kickBotUrl': 'https://example.com',
+        'downloadUrl': 'https://example.com',
+        'clipThumbnail': 'https://example.com',
+        'pingRole': '<@&123456789>',
+        'streamerUrl': 'https://example.com',
+        'clipperUrl': 'https://example.com',
+    },
+    linkedRole: {
+        'guild': 'Example Guild',
+        'username': 'Example',
+        'userId': '123456789',
+        'userMention': '<@123456789>',
+        'userAvatar': 'https://example.com',
+        'guildMemberCount': '123',
+        'triggeredBy': 'Example',
+        'rolesAdded': 'Example',
+        'rolesRemoved': 'Example',
+    },
+    stickyMessage: {
+        'guildName': 'Example Guild',
+        'guildMemberCount': '123',
+        'guildId': '123456789',
+        'channelName': 'Example Channel',
+        'channelId': '123456789',
+        'lastTriggerUser': 'Example#1234',
+        'lastTriggerUserId': '123456789',
+        'lastTriggerUserMention': '<@123456789>',
+    },
+    live: {
+        kick: {
+            'platform': 'Kick',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'viewers': '239.9K',
+            'followers': '239.9K',
+            'category': 'Example Category',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'randomMessage': 'Example Message',
+        },
+        twitch: {
+            'platform': 'Twitch',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'viewers': '239.9K',
+            'category': 'Example Category',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'randomMessage': 'Example Message',
+        },
+        rumble: {
+            'platform': 'Rumble',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'category': 'Example Category',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'followers': '239879',
+            'viewers': '239.9K',
+            'randomMessage': 'Example Message',
+        },
+        tiktok: {
+            'platform': 'TikTok',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'followers': '239879',
+            'verified': 'Verified / Not Verified',
+            'randomMessage': 'Example Message',
+        },
+        youtube: {
+            'platform': 'YouTube',
+            'liveUrl': 'https://example.com',
+            'description': 'Example Description',
+            'streamerName': 'Example',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'comments': '239.9K',
+            'likes': '239.9K',
+            'views': '239.9K',
+            'saves': '239.9K',
+            'randomMessage': 'Example Message',
+        },
+    },
+    offline: {
+        kick: {
+            'platform': 'Kick',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'totalViews': '134.5K',
+            'duration': '4h 20m',
+            'streamUrl': 'https://example.com',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'randomMessage': 'Example Message',
+        },
+        twitch: {
+            'platform': 'Twitch',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'duration': '4h 20m',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'randomMessage': 'Example Message',
+        },
+        rumble: {
+            'platform': 'Rumble',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'duration': '4h 20m',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'pingRole': '<@&123456789>',
+            'followers': '239879',
+            'description': 'Example Description',
+            'randomMessage': 'Example Message',
+        },
+        tiktok: {
+            'platform': 'TikTok',
+            'liveUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'streamTitle': 'Example Stream Title',
+            'streamThumbnail': 'https://example.com',
+            'duration': '4h 20m',
+            'pingRole': '<@&123456789>',
+            'followers': '239879',
+            'verified': 'Verified / Not Verified',
+            'randomMessage': 'Example Message',
+        },
+    },
+    video: {
+        tiktok: {
+            'platform': 'TikTok',
+            'videoUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'pingRole': '<@&123456789>',
+            'category': 'Example Category',
+            'description': 'Example Description',
+            'description.nohastag': 'Example Description',
+            'musicTitle': 'Example Music Title',
+            'musicAuthor': 'Example Music Author',
+            'thumbnail': 'https://example.com',
+            'views': '239.9K',
+            'likes': '239.9K',
+            'shares': '239.9K',
+            'saves': '239.9K',
+            'comments': '239.9K',
+            'duration': '4h 20m',
+            'randomMessage': 'Example Message',
+        },
+        youtube: {
+            'platform': 'YouTube',
+            'videoUrl': 'https://example.com',
+            'streamerName': 'Example',
+            'pingRole': '<@&123456789>',
+            'description': 'Example Description',
+            'thumbnail': 'https://example.com',
+            'views': '239.9K',
+            'likes': '239.9K',
+            'saves': '239.9K',
+            'comments': '239.9K',
+            'duration': '4h 20m',
+            'randomMessage': 'Example Message',
+        },
+    },
+    birthday: {
+        'username': 'Example',
+        'userMention': '<@123456789>',
+        'userAvatar': 'https://example.com',
+        'userId': '123456789',
+        'guild': 'Example Guild',
+        'birthday': '1st of January',
+        'day': '1',
+        'month.short': 'Jan',
+        'month.long': 'January',
+        'year': '2022',
+    },
+    giveaway: {
+        'name': 'Example Giveaway',
+        'winners': '1',
+        'ends': '<t:1640995200:R>',
+        'maxEntries': '1',
+        'pingRole': '<@&123456789>',
+        'requirementsList': 'Account created before: <t:1739543645:R>\nMessage count: 1000\nRoles: <@&123456789>, <@&123456789>',
+        'requirementsListPretty': '**〢 Account created before:** <t:1739543645:R>\n**〢 Message count:** 1000\n**〢 Roles:** <@&123456789>, <@&123456789>',
+        'bonusEntriesList': '> <@&123456789>: 1 entry\n> <@&123456789> - 2 entries',
+        'bonusEntriesListPretty': '**〢 <@&123456789>:** 1 entry\n**〢 <@&123456789> - 2 entries**',
+        'entryFilter': 'Whitelisted roles: <@&123456789>, <@&123456789>',
+        'hostMention': '<@123456789>',
+        'doubleVoteActive': '✅ `Double Vote Entry Activated!`',
+        'doubleVoteActiveSeparated': '\n✅ `Double Vote Entry Activated!`\n',
+    },
+    giveawayEnded: {
+        'name': 'Example Giveaway',
+        'winners': '<@123456789>, <@123456789>',
+        'hostMention': '<@123456789>',
+    },
+    giveawayRerolled: {
+        'name': 'Example Giveaway',
+        'winners': '<@123456789>, <@123456789>',
+        'hostMention': '<@123456789>',
+    },
+    giveawayWinnerAndDM: {
+        'name': 'Example Giveaway',
+        'guild': 'Example Guild',
+        'message': 'https://discord.com/...',
+        'hostMention': '<@123456789>',
+        'doubleVoteActive': '✅ `Double Vote Entry Activated!`',
+        'doubleVoteActiveSeparated': '\n✅ `Double Vote Entry Activated!`\n',
+        'ends': '<t:1640995200:R>',
+    },
+    welcomeMessage: {
+        'guild': 'Example Guild',
+        'username': 'Example',
+        'userId': '123456789',
+        'userMention': '<@123456789>',
+        'userAvatar': 'https://example.com',
+        'guildMemberCount': '123',
+    },
+    leaveMessage: {
+        'guild': 'Example Guild',
+        'username': 'Example',
+        'userId': '123456789',
+        'userMention': '<@123456789>',
+        'userAvatar': 'https://example.com',
+        'guildMemberCount': '123',
+    },
+};
+exports.randomMessages = {
+    live: [
+        '{streamerName} is live on {platform}! Join now!',
+        'Catch {streamerName} live on {platform}! Don’t miss it!',
+        'Live now! {streamerName} is streaming on {platform}!',
+        'Hop in! {streamerName} just went live on {platform}!',
+        '{streamerName} is live on {platform}! Tune in!',
+    ],
+    offline: [
+        '{streamerName} just signed off from {platform}. See you next time!',
+        'That’s a wrap! {streamerName} is now offline on {platform}.',
+        '{streamerName} has gone offline on {platform}. Catch you later!',
+        'Stream over! {streamerName} is now offline on {platform}. Thanks for watching!',
+        '{streamerName} is offline on {platform}. Don’t miss the next stream!',
+    ],
+    video: [
+        'New video! {streamerName} just uploaded on {platform}!',
+        'Fresh upload from {streamerName} on {platform}! Watch now!',
+        '{streamerName} dropped a new video on {platform}! Check it out!',
+        'Heads up! {streamerName} has a new video on {platform}!',
+        '{streamerName} posted a new video on {platform}!',
+    ],
+};
+exports.buttons = {
+    video: [{
+            label: 'Watch on {platform}!',
+            style: 5,
+            url: '{videoUrl}',
+        }],
+    live: [{
+            label: 'Watch {streamerName} on {platform}!',
+        }, {
+            label: 'Toggle Notification',
+            style: 2,
+        }, {
+            label: 'Invite Noti!',
+            style: 5,
+            url: 'https://discord.com/...',
+        }],
+    offline: [{
+            label: 'Missed the stream? Watch it on {platform}!',
+            style: 5,
+            url: '{streamerUrl}',
+        }, {
+            label: 'Toggle Notification',
+            style: 2,
+        }, {
+            label: 'Invite Noti!',
+            style: 5,
+            url: 'https://discord.com/...',
+        }],
+    birthday: [{
+            label: 'Invite Noti!',
+            style: 5,
+            url: 'https://discord.com/...',
+        }],
+    giveaway: [{
+            label: '🎉',
+            style: 1,
+        }, {
+            label: 'Vote for 2x entry',
+            style: 5,
+            url: 'https://noti.bot/vote',
+        }, {
+            label: 'Invite Noti!',
+            style: 5,
+            url: 'https://discord.com/...',
+        }],
+    giveawayDM: [{
+            label: 'Vote for 2x entry',
+            style: 5,
+            url: 'https://noti.bot/vote',
+        }, {
+            label: 'Invite Noti!',
+            style: 5,
+            url: 'https://discord.com/...',
+        }],
+    giveawayWinner: [{
+            label: 'Invite Noti!',
+            style: 5,
+            url: 'https://discord.com/...',
+        }],
+};
+exports.statChannels = {
+    live: {
+        name: '{live} • {username}',
+        placeholders: {
+            'live': '🟢 Live',
+            'username': 'Example',
+            'followers': '239879',
+            'followersFormatted': '239.9K',
+            'views': '239879',
+            'viewsFormatted': '239.9K',
+        },
+    },
+    offline: {
+        name: '{offline} • {username}',
+        placeholders: {
+            'offline': '🔴 Offline',
+            'username': 'Example',
+            'duration': '4h 20m',
+        },
+    },
+    kickFollowers: {
+        name: '{username} • {followersFormatted}',
+        placeholders: {
+            'username': 'Example',
+            'followers': '239879',
+            'followersFormatted': '239.9K',
+        },
+    },
+};
+exports.messages = {
+    vod: {
+        content: '{pingRole}',
+        embed: {
+            title: '{streamerName} VOD is ready for download!',
+            description: '> {streamTitle}',
+            image: { url: '{streamThumbnail}' },
+            color: 0x53fc18,
+            fields: [{
+                    name: '• Duration',
+                    value: '> {duration}',
+                    inline: true,
+                }, {
+                    name: '• Expires',
+                    value: '> {expiresAt}',
+                    inline: true,
+                }, {
+                    name: '• Category',
+                    value: '> {category}',
+                    inline: true,
+                }, {
+                    name: '• Started At',
+                    value: '> {startTime}',
+                    inline: true,
+                }, {
+                    name: '• Ended At',
+                    value: '> {endTime}',
+                    inline: true,
+                }],
+            footer: {
+                text: 'Powered by Noti x KickBot.',
+                icon_url: 'https://noti.bot/logo.png',
+            },
+        },
+        buttons: [{
+                label: 'Watch & Download VOD',
+                style: 5,
+                url: '{vodUrl}',
+            }, ...exports.buttons.live],
+    },
+    clip: {
+        content: '{pingRole}',
+        embed: {
+            title: 'New Clip from {streamerName}!',
+            description: '> You can watch the full clip by clicking the button below.',
+            image: { url: '{clipThumbnail}' },
+            url: '{kickBotUrl}',
+            color: 0x53fc18,
+            fields: [{
+                    name: '• Duration',
+                    value: '> {duration}',
+                    inline: true,
+                }, {
+                    name: '• Clipped By',
+                    value: '> {clipperName}',
+                    inline: true,
+                }],
+            footer: {
+                text: 'Powered by Noti x KickBot.',
+                icon_url: 'https://noti.bot/logo.png',
+            },
+        },
+        buttons: [{
+                label: 'Preview Clip',
+                style: 5,
+                url: '{kickBotUrl}',
+            }, {
+                label: 'Download Clip',
+                style: 5,
+                url: '{downloadUrl}',
+            }, ...exports.buttons.live],
+    },
+    linkedRole: {
+        embed: {
+            title: 'Linked Roles Update',
+            description: '> {streamerName}\'s roles have been updated.',
+            fields: [{
+                    name: '• Triggered By',
+                    value: '> {triggeredBy}',
+                }, {
+                    name: '• Roles Added',
+                    value: '> {rolesAdded}',
+                }, {
+                    name: '• Roles Removed',
+                    value: '> {rolesRemoved}',
+                }],
+            color: 0xff4c4c,
+        },
+        buttons: [{
+                label: 'Invite Noti!',
+                style: 5,
+                url: 'https://discord.com/...',
+            }],
+    },
+    live: {
+        kick: {
+            content: '{pingRole} {randomMessage}',
+            embed: {
+                title: '{streamerName} is now live!',
+                description: '> {streamTitle}',
+                image: { url: '{streamThumbnail}' },
+                url: '{liveUrl}',
+                color: 0x53fc18,
+                fields: [{
+                        name: '• Category',
+                        value: '> {category}',
+                        inline: true,
+                    }, {
+                        name: '• Followers',
+                        value: '> {followers}',
+                        inline: true,
+                    }],
+            },
+            buttons: exports.buttons.live,
+        },
+        twitch: {
+            content: '{pingRole} {randomMessage}',
+            embed: {
+                title: '{streamerName} is now live!',
+                description: '> {streamTitle}',
+                image: { url: '{streamThumbnail}' },
+                url: '{liveUrl}',
+                color: 0x9347ff,
+                fields: [{
+                        name: '• Category',
+                        value: '> {category}',
+                        inline: true,
+                    }],
+            },
+            buttons: exports.buttons.live,
+        },
+        rumble: {
+            content: '{pingRole} {randomMessage}',
+            embed: {
+                title: '{streamerName} is now live!',
+                description: '> {streamTitle}',
+                image: { url: '{streamThumbnail}' },
+                url: '{liveUrl}',
+                color: 0x85c742,
+                fields: [{
+                        name: '• Category',
+                        value: '> {category}',
+                        inline: true,
+                    }, {
+                        name: '• Followers',
+                        value: '> {followers}',
+                        inline: true,
+                    }],
+            },
+            buttons: exports.buttons.live,
+        },
+        tiktok: {
+            content: '{pingRole} {randomMessage}!\n\n> {liveUrl}',
+            embed: {},
+            buttons: exports.buttons.live,
+        },
+        youtube: {
+            content: '{pingRole} {randomMessage}!\n\n> {liveUrl}',
+            embed: {},
+            buttons: exports.buttons.live,
+        },
+    },
+    offline: {
+        kick: {
+            content: '{pingRole} {randomMessage}',
+            embed: {
+                title: '{streamerName} is now offline!',
+                description: '> You can still watch their past broadcasts, click the button below!',
+                image: { url: '{streamThumbnail}' },
+                url: '{liveUrl}',
+                color: 0xff4c4c,
+                fields: [{
+                        name: '• Duration',
+                        value: '> {duration}',
+                        inline: true,
+                    }, {
+                        name: '• Stream Title',
+                        value: '> {streamTitle}',
+                        inline: false,
+                    }],
+            },
+            buttons: exports.buttons.offline,
+        },
+        twitch: {
+            content: '{pingRole} {randomMessage}',
+            embed: {
+                title: '{streamerName} is now offline!',
+                description: '> You can still watch their past broadcasts, click the button below!',
+                image: { url: '{streamThumbnail}' },
+                url: '{liveUrl}',
+                color: 0xff4c4c,
+                fields: [{
+                        name: '• Duration',
+                        value: '> {duration}',
+                        inline: true,
+                    }, {
+                        name: '• Stream Title',
+                        value: '> {streamTitle}',
+                        inline: false,
+                    }],
+            },
+            buttons: exports.buttons.offline,
+        },
+        rumble: {
+            content: '{pingRole} {randomMessage}',
+            embed: {
+                title: '{streamerName} is now offline!',
+                description: '> You can still watch their past broadcasts, click the button below!',
+                image: { url: '{streamThumbnail}' },
+                url: '{liveUrl}',
+                color: 0xff4c4c,
+                fields: [{
+                        name: '• Duration',
+                        value: '> {duration}',
+                        inline: true,
+                    }, {
+                        name: '• Followers',
+                        value: '> {followers}',
+                        inline: true,
+                    }, {
+                        name: '• Stream Title',
+                        value: '> {streamTitle}',
+                        inline: false,
+                    }],
+            },
+            buttons: exports.buttons.offline,
+        },
+        tiktok: {
+            content: '{pingRole} {randomMessage}',
+            embed: {
+                title: '{streamerName} is now offline!',
+                description: '> You can still watch their past broadcasts, click the button below!',
+                image: { url: '{streamThumbnail}' },
+                url: '{liveUrl}',
+                color: 0xff4c4c,
+                fields: [{
+                        name: '• Duration',
+                        value: '> {duration}',
+                        inline: true,
+                    }, {
+                        name: '• Followers',
+                        value: '> {followers}',
+                        inline: true,
+                    }, {
+                        name: '• Stream Title',
+                        value: '> {streamTitle}',
+                        inline: false,
+                    }],
+            },
+            buttons: exports.buttons.offline,
+        },
+    },
+    video: {
+        tiktok: {
+            content: '{pingRole} {randomMessage}\n\n> {videoUrl}',
+            embed: {},
+            buttons: exports.buttons.video,
+        },
+        youtube: {
+            content: '{pingRole} {randomMessage}\n\n> {videoUrl}',
+            embed: {},
+            buttons: exports.buttons.video,
+        },
+    },
+    birthday: {
+        content: '{userMention}',
+        embed: {
+            title: '🎉 Happy Birthday {username}! 🎉',
+            description: '> You are now a year older, hope you have a great day!',
+            color: 0xff4c4c,
+            footer: {
+                text: 'Powered by Noti.',
+                icon_url: 'https://noti.bot/logo.png',
+            },
+        },
+        buttons: exports.buttons.birthday,
+    },
+    giveaway: {
+        content: '{pingRole}',
+        embed: {
+            title: '{name}',
+            description: 'Click the button below to enter the giveaway!\n{doubleVoteActiveSeparated}\n**📌 Giveaway Details:**\n**〢 Max Winners:** {winners}\n**〢 Max Entries:** {maxEntries}\n**〢 Hosted By:** {hostMention}\n\n**📋 Requirements:**\n{requirementsListPretty}\n\n**🕰️ Time remaining:** {ends}',
+            color: 0xff4c4c,
+            image: { url: 'https://dev.noti.bot/giveaway_thumbnail.png' },
+        },
+        buttons: exports.buttons.giveaway,
+    },
+    giveawayEnded: {
+        content: '{winners}',
+        embed: {
+            title: '🎉 {name} has ended! 🎉',
+            description: '> Thank you to everyone who has participated!\n\n> **WINNERS:** {winners}\n> **HOST:** {hostMention}',
+            image: { url: 'https://dev.noti.bot/giveaway_thumbnail.png' },
+            color: 0xff4c4c,
+        },
+    },
+    giveawayRerolled: {
+        content: '{winners}',
+        embed: {
+            title: '🎉 {name} was rerolled! 🎉',
+            description: '> Thank you to everyone who has participated!\n\n> **WINNERS:** {winners}\n> **HOST:** {hostMention}',
+            image: { url: 'https://dev.noti.bot/giveaway_thumbnail.png' },
+            color: 0xff4c4c,
+        },
+    },
+    giveawayWinner: {
+        content: '',
+        embed: {
+            title: '🎉 You won {name}! 🎉',
+            description: '> Thank you for your participation!\n\n> **GIVEAWAY:** [Giveaway]({message})\n> **HOST:** {hostMention}',
+            color: 0x1dbf57,
+            image: { url: 'https://dev.noti.bot/giveaway_thumbnail.png' },
+        },
+        buttons: exports.buttons.giveawayWinner,
+    },
+    giveawayDM: {
+        content: '',
+        embed: {
+            title: '🎉 You Entered {name}! 🎉',
+            description: '> Thank you for joining!\n{doubleVoteActiveSeparated}\n**🕰️ Time remaining:** {ends}\n> **GIVEAWAY:** [Giveaway]({message})\n> **HOST:** {hostMention}',
+            color: 0xff4c4c,
+            image: { url: 'https://dev.noti.bot/giveaway_thumbnail.png' },
+        },
+        buttons: exports.buttons.giveawayDM,
+    },
+    welcomeMessage: {
+        content: 'Welcome to **{guild}**, {userMention}!',
+        embed: {},
+    },
+    leaveMessage: {
+        content: '`{username}` has left the server, we hope to see you again!',
+        embed: {},
+    },
+};