@overlaysymphony/twitch 0.1.0

package/src/eventsub/events/channel.channel_points_custom_reward_redemption.add.ts

@@ -0,0 +1,59 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+import { ChannelPointsCustomRewardRedemptionReward } from "./channel.channel_points_custom_reward_redemption._.js"
+
+type ChannelPointsCustomRewardRedemptionAddType = "channel.channel_points_custom_reward_redemption.add"
+type ChannelPointsCustomRewardRedemptionAddVersion = "1"
+
+/** The parameters under which an event fires when A user redeems a custom channel points reward. */
+export interface ChannelPointsCustomRewardRedemptionAddCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** Optional. Specify a reward ID to only receive notifications for a specific reward. */
+  reward_id?: string
+}
+
+/** The event information when A user redeems a custom channel points reward. */
+export interface ChannelPointsCustomRewardRedemptionAddEvent {
+  /** The redemption identifier. */
+  id: 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 user ID of the user who redeemed the reward. */
+  user_id: string
+  /** The user login of the user who redeemed the reward. */
+  user_login: string
+  /** The user name of the user who redeemed the reward. */
+  user_name: string
+  /** The user input provided. Empty string if not provided. */
+  user_input: string
+  /** Defaults to unfulfilled. Possible values are unknown, unfulfilled, fulfilled, and canceled. */
+  status: string
+  /** Basic information about the reward that was redeemed, at the time it was redeemed. */
+  reward: ChannelPointsCustomRewardRedemptionReward
+  /** The time the reward was redeemed. */
+  redeemed_at: Date
+}
+
+/** The event notification received when A user redeems a custom channel points reward. */
+export type ChannelPointsCustomRewardRedemptionAddSubscription = BaseSubscription<
+  ChannelPointsCustomRewardRedemptionAddType,
+  ChannelPointsCustomRewardRedemptionAddVersion,
+  ChannelPointsCustomRewardRedemptionAddCondition
+>
+
+export function makeChannelPointsCustomRewardRedemptionAddSubscription(
+  userId: string,
+): ChannelPointsCustomRewardRedemptionAddSubscription {
+  return {
+    type: "channel.channel_points_custom_reward_redemption.add",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

package/src/eventsub/events/channel.channel_points_custom_reward_redemption.update.ts

@@ -0,0 +1,59 @@
+import { BaseSubscription } from "../events-helpers.js"
+
+import { ChannelPointsCustomRewardRedemptionReward } from "./channel.channel_points_custom_reward_redemption._.js"
+
+type ChannelPointsCustomRewardRedemptionUpdateType = "channel.channel_points_custom_reward_redemption.update"
+type ChannelPointsCustomRewardRedemptionUpdateVersion = "1"
+
+/** The parameters under which an event fires when A moderator updates the redemption of a channel points custom reward. */
+export interface ChannelPointsCustomRewardRedemptionUpdateCondition {
+  /** The user ID of the broadcaster. */
+  broadcaster_user_id: string
+  /** Optional. Specify a reward ID to only receive notifications for a specific reward. */
+  reward_id?: string
+}
+
+/** The event information when A moderator updates the redemption of a channel points custom reward. */
+export interface ChannelPointsCustomRewardRedemptionUpdateEvent {
+  /** The redemption identifier. */
+  id: 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 user ID of the user who redeemed the reward. */
+  user_id: string
+  /** The user login of the user who redeemed the reward. */
+  user_login: string
+  /** The user name of the user who redeemed the reward. */
+  user_name: string
+  /** The user input provided. Empty string if not provided. */
+  user_input: string
+  /** Will be fulfilled or canceled. Possible values are unknown, unfulfilled, fulfilled, and canceled. */
+  status: string
+  /** Basic information about the reward that was redeemed, at the time it was redeemed. */
+  reward: ChannelPointsCustomRewardRedemptionReward
+  /** The time the reward was redeemed. */
+  redeemed_at: Date
+}
+
+/** The event notification received when A moderator updates the redemption of a channel points custom reward. */
+export type ChannelPointsCustomRewardRedemptionUpdateSubscription = BaseSubscription<
+  ChannelPointsCustomRewardRedemptionUpdateType,
+  ChannelPointsCustomRewardRedemptionUpdateVersion,
+  ChannelPointsCustomRewardRedemptionUpdateCondition
+>
+
+export function makeChannelPointsCustomRewardRedemptionUpdateSubscription(
+  userId: string,
+): ChannelPointsCustomRewardRedemptionUpdateSubscription {
+  return {
+    type: "channel.channel_points_custom_reward_redemption.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }
+}

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

@@ -0,0 +1,66 @@
+import { 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

@@ -0,0 +1,67 @@
+import { 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

@@ -0,0 +1,69 @@
+import { 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

@@ -0,0 +1,69 @@
+import { 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

@@ -0,0 +1,42 @@
+import { 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

@@ -0,0 +1,48 @@
+import { 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

@@ -0,0 +1,50 @@
+import { 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

@@ -0,0 +1,50 @@
+import { 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

@@ -0,0 +1,51 @@
+import { 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,
+    },
+  }
+}