@overlaysymphony/twitch 0.2.1 → 0.2.3

package/src/eventsub/events/channel.charity_campaign.donate.ts

@@ -1,66 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type CharityDonationType = "channel.charity_campaign.donate"
-type CharityDonationVersion = "1"
-
-/** The parameters under which an event fires when A user donates to the broadcaster's charity campaign. */
-export interface CharityDonationCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A user donates to the broadcaster's charity campaign. */
-export interface CharityDonationEvent {
-  /** An ID of the donation. The ID is unique across campaigns. */
-  id: string
-  /** The ID of the charity campaign. */
-  campaign_id: string
-  /** The user ID of the broadcaster. */
-  broadcaster_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_name: string
-  /** The user ID of the user who donated to the campaign. */
-  user_id: string
-  /** The user login of the user who donated to the campaign. */
-  user_login: string
-  /** The user name of the user who donated to the campaign. */
-  user_name: string
-  /** The charity's name. */
-  charity_name: string
-  /** A description of the charity. */
-  charity_description: string
-  /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
-  charity_logo: string
-  /** A URL to the charity's website. */
-  charity_website: string
-  /** An object that contains the current amount of donations that the campaign has received. */
-  amount: {
-    /** Integer. The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550. */
-    value: number
-    /** Integer. The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:\n\nvalue / 10^decimal_places */
-    decimal_places: number
-    /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
-    currency: string
-  }
-}
-
-/** The event notification received when A user donates to the broadcaster's charity campaign. */
-export type CharityDonationSubscription = BaseSubscription<
-  CharityDonationType,
-  CharityDonationVersion,
-  CharityDonationCondition
->
-
-export function makeCharityDonationSubscription(
-  userId: string,
-): CharityDonationSubscription {
-  return {
-    type: "channel.charity_campaign.donate",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.charity_campaign.progress.ts

@@ -1,67 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type CharityCampaignProgressType = "channel.charity_campaign.progress"
-type CharityCampaignProgressVersion = "1"
-
-/** The parameters under which an event fires when Progress is made towards the campaign's goal or when the broadcaster changes the fundraising goal. */
-export interface CharityCampaignProgressCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when Progress is made towards the campaign's goal or when the broadcaster changes the fundraising goal. */
-export interface CharityCampaignProgressEvent {
-  /** The ID of the charity campaign. */
-  id: string
-  /** The user ID of the broadcaster. */
-  broadcaster_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_name: string
-  /** The charity's name. */
-  charity_name: string
-  /** A description of the charity. */
-  charity_description: string
-  /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
-  charity_logo: string
-  /** A URL to the charity's website. */
-  charity_website: string
-  /** An object that contains the current amount of donations that the campaign has received. */
-  current_amount: {
-    /** Integer. The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550. */
-    value: number
-    /** Integer. The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:\n\nvalue / 10^decimal_places */
-    decimal_places: number
-    /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
-    currency: string
-  }
-  /** An object that contains the campaign's target fundraising goal. */
-  target_amount: {
-    /** Integer. The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550. */
-    value: number
-    /** Integer. The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:\n\nvalue / 10^decimal_places */
-    decimal_places: number
-    /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
-    currency: string
-  }
-}
-
-/** The event notification received when Progress is made towards the campaign's goal or when the broadcaster changes the fundraising goal. */
-export type CharityCampaignProgressSubscription = BaseSubscription<
-  CharityCampaignProgressType,
-  CharityCampaignProgressVersion,
-  CharityCampaignProgressCondition
->
-
-export function makeCharityCampaignProgressSubscription(
-  userId: string,
-): CharityCampaignProgressSubscription {
-  return {
-    type: "channel.charity_campaign.progress",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.charity_campaign.start.ts

@@ -1,69 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type CharityCampaignStartType = "channel.charity_campaign.start"
-type CharityCampaignStartVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster starts a charity campaign. */
-export interface CharityCampaignStartCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when The broadcaster starts a charity campaign. */
-export interface CharityCampaignStartEvent {
-  /** The ID of the charity campaign. */
-  id: string
-  /** The user ID of the broadcaster. */
-  broadcaster_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_name: string
-  /** The charity's name. */
-  charity_name: string
-  /** A description of the charity. */
-  charity_description: string
-  /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
-  charity_logo: string
-  /** A URL to the charity's website. */
-  charity_website: string
-  /** An object that contains the current amount of donations that the campaign has received. */
-  current_amount: {
-    /** Integer. The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550. */
-    value: number
-    /** Integer. The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:\n\nvalue / 10^decimal_places */
-    decimal_places: number
-    /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
-    currency: string
-  }
-  /** An object that contains the campaign's target fundraising goal. */
-  target_amount: {
-    /** Integer. The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550. */
-    value: number
-    /** Integer. The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:\n\nvalue / 10^decimal_places */
-    decimal_places: number
-    /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
-    currency: string
-  }
-  /** The time the broadcaster started the campaign. */
-  started_at: Date
-}
-
-/** The event notification received when The broadcaster starts a charity campaign. */
-export type CharityCampaignStartSubscription = BaseSubscription<
-  CharityCampaignStartType,
-  CharityCampaignStartVersion,
-  CharityCampaignStartCondition
->
-
-export function makeCharityCampaignStartSubscription(
-  userId: string,
-): CharityCampaignStartSubscription {
-  return {
-    type: "channel.charity_campaign.start",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.charity_campaign.stop.ts

@@ -1,69 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type CharityCampaignStopType = "channel.charity_campaign.stop"
-type CharityCampaignStopVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster stops a charity campaign. */
-export interface CharityCampaignStopCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when The broadcaster stops a charity campaign. */
-export interface CharityCampaignStopEvent {
-  /** The ID of the charity campaign. */
-  id: string
-  /** The user ID of the broadcaster. */
-  broadcaster_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_name: string
-  /** The charity's name. */
-  charity_name: string
-  /** A description of the charity. */
-  charity_description: string
-  /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
-  charity_logo: string
-  /** A URL to the charity's website. */
-  charity_website: string
-  /** An object that contains the current amount of donations that the campaign has received. */
-  current_amount: {
-    /** Integer. The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550. */
-    value: number
-    /** Integer. The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:\n\nvalue / 10^decimal_places */
-    decimal_places: number
-    /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
-    currency: string
-  }
-  /** An object that contains the campaign's target fundraising goal. */
-  target_amount: {
-    /** Integer. The monetary amount. The amount is specified in the currency's minor unit. For example, the minor units for USD is cents, so if the amount is $5.50 USD, value is set to 550. */
-    value: number
-    /** Integer. The number of decimal places used by the currency. For example, USD uses two decimal places. Use this number to translate value from minor units to major units by using the formula:\n\nvalue / 10^decimal_places */
-    decimal_places: number
-    /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
-    currency: string
-  }
-  /** The time the broadcaster stopped the campaign. */
-  stopped_at: Date
-}
-
-/** The event notification received when The broadcaster stops a charity campaign. */
-export type CharityCampaignStopSubscription = BaseSubscription<
-  CharityCampaignStopType,
-  CharityCampaignStopVersion,
-  CharityCampaignStopCondition
->
-
-export function makeCharityCampaignStopSubscription(
-  userId: string,
-): CharityCampaignStopSubscription {
-  return {
-    type: "channel.charity_campaign.stop",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.chat.clear.ts

@@ -1,42 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelChatClearType = "channel.chat.clear"
-type ChannelChatClearVersion = "1"
-
-/** The parameters under which an event fires when A moderator clears all messages from the chat room. */
-export interface ChannelChatClearCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user ID to read chat as. */
-  user_id: string
-}
-
-/** The event information when A moderator clears all messages from the chat room. */
-export interface ChannelChatClearEvent {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_user_name: string
-}
-
-/** The event notification received when A moderator clears all messages from the chat room. */
-export type ChannelChatClearSubscription = BaseSubscription<
-  ChannelChatClearType,
-  ChannelChatClearVersion,
-  ChannelChatClearCondition
->
-
-export function makeChannelChatClearSubscription(
-  userId: string,
-): ChannelChatClearSubscription {
-  return {
-    type: "channel.chat.clear",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.chat.clear_user_messages.ts

@@ -1,48 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelChatClearUserMessagesType = "channel.chat.clear_user_messages"
-type ChannelChatClearUserMessagesVersion = "1"
-
-/** The parameters under which an event fires when A moderator clears all messages from a specific user. */
-export interface ChannelChatClearUserMessagesCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user ID to read chat as. */
-  user_id: string
-}
-
-/** The event information when A moderator clears all messages from a specific user. */
-export interface ChannelChatClearUserMessagesEvent {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_user_name: string
-  /** The user ID of the user who was banned or put in a timeout. */
-  target_user_id: string
-  /** The user name of the user who was banned or put in a timeout. */
-  target_user_login: string
-  /** The user login of the user who was banned or put in a timeout. */
-  target_user_name: string
-}
-
-/** The event notification received when A moderator clears all messages from a specific user. */
-export type ChannelChatClearUserMessagesSubscription = BaseSubscription<
-  ChannelChatClearUserMessagesType,
-  ChannelChatClearUserMessagesVersion,
-  ChannelChatClearUserMessagesCondition
->
-
-export function makeChannelChatClearUserMessagesSubscription(
-  userId: string,
-): ChannelChatClearUserMessagesSubscription {
-  return {
-    type: "channel.chat.clear_user_messages",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.chat.message_delete.ts

@@ -1,50 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelChatMessageDeleteType = "channel.chat.message_delete"
-type ChannelChatMessageDeleteVersion = "1"
-
-/** The parameters under which an event fires when A moderator removes a specific message. */
-export interface ChannelChatMessageDeleteCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user ID to read chat as. */
-  user_id: string
-}
-
-/** The event information when A moderator removes a specific message. */
-export interface ChannelChatMessageDeleteEvent {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_user_name: string
-  /** The user ID of the user whose message was deleted. */
-  target_user_id: string
-  /** The user name of the user whose message was deleted. */
-  target_user_login: string
-  /** The user login of the user whose message was deleted. */
-  target_user_name: string
-  /** The UUID of the message that was removed. */
-  message_id: string
-}
-
-/** The event notification received when A moderator removes a specific message. */
-export type ChannelChatMessageDeleteSubscription = BaseSubscription<
-  ChannelChatMessageDeleteType,
-  ChannelChatMessageDeleteVersion,
-  ChannelChatMessageDeleteCondition
->
-
-export function makeChannelChatMessageDeleteSubscription(
-  userId: string,
-): ChannelChatMessageDeleteSubscription {
-  return {
-    type: "channel.chat.message_delete",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.chat.notification.ts

@@ -1,50 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelChatNotificationType = "channel.chat.notification"
-type ChannelChatNotificationVersion = "1"
-
-/** The parameters under which an event fires when An event appears in chat. */
-export interface ChannelChatNotificationCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user ID to read chat as. */
-  user_id: string
-}
-
-/** The event information when An event appears in chat. */
-export interface ChannelChatNotificationEvent {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_user_name: string
-  /** The user ID of the user who sent the message. */
-  chatter_user_id: string
-  /** The user login of the user who sent the message. */
-  chatter_user_login: string
-  /** The user name of the user who sent the message. */
-  chatter_user_name: string
-  /** The UUID of the message. */
-  message_id: string
-}
-
-/** The event notification received when An event appears in chat. */
-export type ChannelChatNotificationSubscription = BaseSubscription<
-  ChannelChatNotificationType,
-  ChannelChatNotificationVersion,
-  ChannelChatNotificationCondition
->
-
-export function makeChannelChatNotificationSubscription(
-  userId: string,
-): ChannelChatNotificationSubscription {
-  return {
-    type: "channel.chat.notification",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.cheer.ts

@@ -1,51 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelCheerType = "channel.cheer"
-type ChannelCheerVersion = "1"
-
-/** The parameters under which an event fires when A user cheers. */
-export interface ChannelCheerCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A user cheers. */
-export interface ChannelCheerEvent {
-  /** Whether the user cheered anonymously or not. */
-  is_anonymous: boolean
-  /** The user ID of the user who cheered. This is null if is_anonymous is true. */
-  user_id: string
-  /** The user login of the user who cheered. This is null if is_anonymous is true. */
-  user_login: string
-  /** The user name of the user who cheered. This is null if is_anonymous is true. */
-  user_name: string
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_user_name: string
-  /** The message sent with the cheer. */
-  message: string
-  /** Integer. The number of bits cheered. */
-  bits: number
-}
-
-/** The event notification received when A user cheers. */
-export type ChannelCheerSubscription = BaseSubscription<
-  ChannelCheerType,
-  ChannelCheerVersion,
-  ChannelCheerCondition
->
-
-export function makeChannelCheerSubscription(
-  userId: string,
-): ChannelCheerSubscription {
-  return {
-    type: "channel.cheer",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.follow.ts

@@ -1,50 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelFollowType = "channel.follow"
-type ChannelFollowVersion = "2"
-
-/** The parameters under which an event fires when A user follows. */
-export interface ChannelFollowCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user ID of the moderator or broadcaster. */
-  moderator_user_id: string
-}
-
-/** The event information when A user follows. */
-export interface ChannelFollowEvent {
-  /** The user ID of the user who followed. */
-  user_id: string
-  /** The user login of the user who followed. */
-  user_login: string
-  /** The user name of the user who followed. */
-  user_name: string
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  broadcaster_user_name: string
-  /** The time the follow occurred. */
-  followed_at: Date
-}
-
-/** The event notification received when A user follows. */
-export type ChannelFollowSubscription = BaseSubscription<
-  ChannelFollowType,
-  ChannelFollowVersion,
-  ChannelFollowCondition
->
-
-export function makeChannelFollowSubscription(
-  userId: string,
-): ChannelFollowSubscription {
-  return {
-    type: "channel.follow",
-    version: "2",
-    condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.goal.begin.ts

@@ -1,51 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type GoalBeginType = "channel.goal.begin"
-type GoalBeginVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster begins a goal. */
-export interface GoalBeginCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when The broadcaster begins a goal. */
-export interface GoalBeginEvent {
-  /** The ID of the goal. */
-  id: string
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-  /** The user name of the broadcaster. */
-  broadcaster_user_name: string
-  /** The user login of the broadcaster. */
-  broadcaster_user_login: string
-  /** The type of goal. Possible values are:\nfollow — The goal is to increase followers.\nsubscription — The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions.\nsubscription_count — The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.\nnew_subscription — The goal is to increase subscriptions. This type shows only the net increase in tier points associated with the subscriptions (it does not account for users that unsubscribed since the goal started).\nnew_subscription_count — The goal is to increase subscriptions. This type shows only the net increase in the number of subscriptions (it does not account for users that unsubscribed since the goal started). */
-  type: string
-  /** A description of the goal, if specified. The description may contain a maximum of 40 characters. */
-  description: string
-  /** Integer. The goal's current value.\n\nThe goal's type determines how this value is increased or decreased.\nIf type is follow, this field is set to the broadcaster's current number of followers. This number increases with new followers and decreases when users unfollow the broadcaster.\nIf type is subscription, this field is increased and decreased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased or decreased by 2, not 1.\nIf type is subscription_count, this field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.\nIf type is new_subscription, this field is increased by the points value associated with the subscription tier. For example, if a tier-two subscription is worth 2 points, this field is increased by 2, not 1.\nIf type is new_subscription_count, this field is increased by 1 for each new subscription. */
-  current_amount: number
-  /** Integer. The goal's target value. For example, if the broadcaster has 200 followers before creating the goal, and their goal is to double that number, this field is set to 400. */
-  target_amount: number
-  /** The time the broadcaster created the goal. */
-  started_at: Date
-}
-
-/** The event notification received when The broadcaster begins a goal. */
-export type GoalBeginSubscription = BaseSubscription<
-  GoalBeginType,
-  GoalBeginVersion,
-  GoalBeginCondition
->
-
-export function makeGoalBeginSubscription(
-  userId: string,
-): GoalBeginSubscription {
-  return {
-    type: "channel.goal.begin",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}