@overlaysymphony/twitch 0.2.2 → 0.3.0

package/src/eventsub/events/channel.hype_train._.ts

@@ -1,12 +0,0 @@
-export interface HypeTrainTopContribution {
-  /** The ID of the user that made the contribution. */
-  user_id: string
-  /** The user’s login name. */
-  user_login: string
-  /** The user’s display name. */
-  user_name: string
-  /** The contribution method used. Possible values are:\n  bits — Cheering with Bits.\n  subscription — Subscription activity like subscribing or gifting subscriptions.\n  other — Covers other contribution methods not listed. */
-  type: string
-  /** Integer. 	The total amount contributed. If type is bits, total represents the amount of Bits used. If type is subscription, total is 500, 1000, or 2500 to represent tier 1, 2, or 3 subscriptions, respectively. */
-  total: number
-}

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

@@ -1,57 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type HypeTrainTopContribution } from "./channel.hype_train._.js"
-
-type HypeTrainBeginType = "channel.hype_train.begin"
-type HypeTrainBeginVersion = "1"
-
-/** The parameters under which an event fires when A Hype Train begins. */
-export interface HypeTrainBeginCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A Hype Train begins. */
-export interface HypeTrainBeginEvent {
-  /** The hype train ID. */
-  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
-  /** Integer. Total points contributed to the hype train. */
-  total: number
-  /** Integer. The number of points contributed to the hype train at the current level. */
-  progress: number
-  /** Integer. The number of points required to reach the next level. */
-  goal: number
-  /** The contributors with the most points contributed. */
-  top_contributions: HypeTrainTopContribution[]
-  /** Integer. The starting level of the hype train. */
-  level: number
-  /** The time the hype train started. */
-  started_at: Date
-  /** The time the hype train expires. The expiration is extended when the hype train reaches a new level. */
-  expires_at: Date
-}
-
-/** The event notification received when A Hype Train begins. */
-export type HypeTrainBeginSubscription = BaseSubscription<
-  HypeTrainBeginType,
-  HypeTrainBeginVersion,
-  HypeTrainBeginCondition
->
-
-export function makeHypeTrainBeginSubscription(
-  userId: string,
-): HypeTrainBeginSubscription {
-  return {
-    type: "channel.hype_train.begin",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.hype_train.end.ts

@@ -1,55 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type HypeTrainTopContribution } from "./channel.hype_train._.js"
-
-type HypeTrainEndType = "channel.hype_train.end"
-type HypeTrainEndVersion = "1"
-
-/** The parameters under which an event fires when A Hype Train ends. */
-export interface HypeTrainEndCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A Hype Train ends. */
-export interface HypeTrainEndEvent {
-  /** The hype train ID. */
-  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
-  /** Integer. The final level of the hype train. */
-  level: number
-  /** Integer. Total points contributed to the hype train. */
-  total: number
-  /** The contributors with the most points contributed. */
-  top_contributions: HypeTrainTopContribution[]
-  /** The time the hype train started. */
-  started_at: Date
-  /** The time the hype train ended. */
-  ended_at: Date
-  /** The time the hype train cooldown ends so that the next hype train can start. */
-  cooldown_ends_at: Date
-}
-
-/** The event notification received when A Hype Train ends. */
-export type HypeTrainEndSubscription = BaseSubscription<
-  HypeTrainEndType,
-  HypeTrainEndVersion,
-  HypeTrainEndCondition
->
-
-export function makeHypeTrainEndSubscription(
-  userId: string,
-): HypeTrainEndSubscription {
-  return {
-    type: "channel.hype_train.end",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

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

@@ -1,70 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type HypeTrainTopContribution } from "./channel.hype_train._.js"
-
-type HypeTrainProgressType = "channel.hype_train.progress"
-type HypeTrainProgressVersion = "1"
-
-/** The parameters under which an event fires when A Hype Train makes progress. */
-export interface HypeTrainProgressCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A Hype Train makes progress. */
-export interface HypeTrainProgressEvent {
-  /** The hype train ID. */
-  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
-  /** Integer. The current level of the hype train. */
-  level: number
-  /** Integer. Total points contributed to the hype train. */
-  total: number
-  /** Integer. The number of points contributed to the hype train at the current level. */
-  progress: number
-  /** Integer. The number of points required to reach the next level. */
-  goal: number
-  /** The contributors with the most points contributed. */
-  top_contributions: HypeTrainTopContribution[]
-  /** The most recent contribution. */
-  last_contribution: {
-    /** The user ID of the user who made the contribution. */
-    user_id: string
-    /** The user login name. */
-    user_login: string
-    /** The user name. */
-    user_name: string
-    /** The contribution method used. Possible values are:\n  bits — Cheering with Bits.\n  subscription — Subscription activity like subscribing or gifting subscriptions.\n  other — Covers other contribution methods not listed. */
-    type: string
-    /** Integer. The total amount contributed. If type is bits, total represents the amount of Bits used. If type is subscription, total is 500, 1000, or 2500 to represent tier 1, 2, or 3 subscriptions, respectively. */
-    total: number
-  }
-  /** The time the hype train started. */
-  started_at: Date
-  /** The time the hype train expires. The expiration is extended when the hype train reaches a new level. */
-  expires_at: Date
-}
-
-/** The event notification received when A Hype Train makes progress. */
-export type HypeTrainProgressSubscription = BaseSubscription<
-  HypeTrainProgressType,
-  HypeTrainProgressVersion,
-  HypeTrainProgressCondition
->
-
-export function makeHypeTrainProgressSubscription(
-  userId: string,
-): HypeTrainProgressSubscription {
-  return {
-    type: "channel.hype_train.progress",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

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

@@ -1,45 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelModeratorAddType = "channel.moderator.add"
-type ChannelModeratorAddVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster gives moderator privileges to a user. */
-export interface ChannelModeratorAddCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when The broadcaster gives moderator privileges to a user. */
-export interface ChannelModeratorAddEvent {
-  /** 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 new moderator. */
-  user_id: string
-  /** The user login of the new moderator. */
-  user_login: string
-  /** The user name of the new moderator. */
-  user_name: string
-}
-
-/** The event notification received when The broadcaster gives moderator privileges to a user. */
-export type ChannelModeratorAddSubscription = BaseSubscription<
-  ChannelModeratorAddType,
-  ChannelModeratorAddVersion,
-  ChannelModeratorAddCondition
->
-
-export function makeChannelModeratorAddSubscription(
-  userId: string,
-): ChannelModeratorAddSubscription {
-  return {
-    type: "channel.moderator.add",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.moderator.remove.ts

@@ -1,45 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelModeratorRemoveType = "channel.moderator.remove"
-type ChannelModeratorRemoveVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster removes moderator privileges from a user. */
-export interface ChannelModeratorRemoveCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when The broadcaster removes moderator privileges from a user. */
-export interface ChannelModeratorRemoveEvent {
-  /** 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 removed moderator. */
-  user_id: string
-  /** The user login of the removed moderator. */
-  user_login: string
-  /** The user name of the removed moderator. */
-  user_name: string
-}
-
-/** The event notification received when The broadcaster removes moderator privileges from a user. */
-export type ChannelModeratorRemoveSubscription = BaseSubscription<
-  ChannelModeratorRemoveType,
-  ChannelModeratorRemoveVersion,
-  ChannelModeratorRemoveCondition
->
-
-export function makeChannelModeratorRemoveSubscription(
-  userId: string,
-): ChannelModeratorRemoveSubscription {
-  return {
-    type: "channel.moderator.remove",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.poll._.ts

@@ -1,26 +0,0 @@
-export interface ChannelPollPointsVoting {
-  /** Indicates if channel points can be used for voting. */
-  is_enabled: boolean
-  /** Integer. Number of channel points required to vote once with channel points. */
-  amount_per_vote: number
-}
-
-export interface ChannelPollBitsVoting {
-  /** Indicates if bits can be used for voting. */
-  is_enabled: boolean
-  /** Integer. Number of bits required to vote once with bits. */
-  amount_per_vote: number
-}
-
-export interface ChannelPollChoice {
-  /** ID for the choice. */
-  id: string
-  /** Text displayed for the choice. */
-  title: string
-  /** Integer. Not used; will be set to 0. */
-  bits_votes: number
-  /** Integer. Number of votes received via Channel Points. */
-  channel_points_votes: number
-  /** Integer. Total number of votes received for the choice across all methods of voting. */
-  votes: number
-}

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

@@ -1,55 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type ChannelPollBitsVoting, type ChannelPollChoice, type ChannelPollPointsVoting } from "./channel.poll._.js"
-
-type ChannelPollBeginType = "channel.poll.begin"
-type ChannelPollBeginVersion = "1"
-
-/** The parameters under which an event fires when A poll starts. */
-export interface ChannelPollBeginCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A poll starts. */
-export interface ChannelPollBeginEvent {
-  /** ID of the poll. */
-  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
-  /** Question displayed for the poll. */
-  title: string
-  /** An array of choices for the poll. */
-  choices: ChannelPollChoice[]
-  /** The bits voting settings for the poll. */
-  bits_voting: ChannelPollBitsVoting
-  /** The Channel Points voting settings for the poll. */
-  channel_points_voting: ChannelPollPointsVoting
-  /** The time the poll started. */
-  started_at: Date
-  /** The time the poll will end. */
-  ends_at: Date
-}
-
-/** The event notification received when A poll starts. */
-export type ChannelPollBeginSubscription = BaseSubscription<
-  ChannelPollBeginType,
-  ChannelPollBeginVersion,
-  ChannelPollBeginCondition
->
-
-export function makeChannelPollBeginSubscription(
-  userId: string,
-): ChannelPollBeginSubscription {
-  return {
-    type: "channel.poll.begin",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.poll.end.ts

@@ -1,57 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type ChannelPollBitsVoting, type ChannelPollChoice, type ChannelPollPointsVoting } from "./channel.poll._.js"
-
-type ChannelPollEndType = "channel.poll.end"
-type ChannelPollEndVersion = "1"
-
-/** The parameters under which an event fires when A poll ends. */
-export interface ChannelPollEndCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A poll ends. */
-export interface ChannelPollEndEvent {
-  /** ID of the poll. */
-  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
-  /** Question displayed for the poll. */
-  title: string
-  /** An array of choices for the poll. Includes vote counts. */
-  choices: ChannelPollChoice[]
-  /** The bits voting settings for the poll. */
-  bits_voting: ChannelPollBitsVoting
-  /** The Channel Points voting settings for the poll. */
-  channel_points_voting: ChannelPollPointsVoting
-  /** The status of the poll. Valid values are completed, archived, and terminated. */
-  status: string
-  /** The time the poll started. */
-  started_at: Date
-  /** The time the poll ended. */
-  ended_at: Date
-}
-
-/** The event notification received when A poll ends. */
-export type ChannelPollEndSubscription = BaseSubscription<
-  ChannelPollEndType,
-  ChannelPollEndVersion,
-  ChannelPollEndCondition
->
-
-export function makeChannelPollEndSubscription(
-  userId: string,
-): ChannelPollEndSubscription {
-  return {
-    type: "channel.poll.end",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

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

@@ -1,55 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type ChannelPollBitsVoting, type ChannelPollChoice, type ChannelPollPointsVoting } from "./channel.poll._.js"
-
-type ChannelPollProgressType = "channel.poll.progress"
-type ChannelPollProgressVersion = "1"
-
-/** The parameters under which an event fires when A user responds to a poll. */
-export interface ChannelPollProgressCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A user responds to a poll. */
-export interface ChannelPollProgressEvent {
-  /** ID of the poll. */
-  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
-  /** Question displayed for the poll. */
-  title: string
-  /** An array of choices for the poll. Includes vote counts. */
-  choices: ChannelPollChoice[]
-  /** The bits voting settings for the poll. */
-  bits_voting: ChannelPollBitsVoting
-  /** The Channel Points voting settings for the poll. */
-  channel_points_voting: ChannelPollPointsVoting
-  /** The time the poll started. */
-  started_at: Date
-  /** The time the poll will end. */
-  ends_at: Date
-}
-
-/** The event notification received when A user responds to a poll. */
-export type ChannelPollProgressSubscription = BaseSubscription<
-  ChannelPollProgressType,
-  ChannelPollProgressVersion,
-  ChannelPollProgressCondition
->
-
-export function makeChannelPollProgressSubscription(
-  userId: string,
-): ChannelPollProgressSubscription {
-  return {
-    type: "channel.poll.progress",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.prediction._.ts

@@ -1,25 +0,0 @@
-export interface ChannelPredictionOutcome {
-  /** The outcome ID. */
-  id: string
-  /** The outcome title. */
-  title: string
-  /** The color for the outcome. Valid values are pink and blue. */
-  color: string
-  /** Integer. The number of users who used Channel Points on this outcome. */
-  users: number
-  /** Integer. The total number of Channel Points used on this outcome. */
-  channel_points: number
-  /** An array of users who used the most Channel Points on this outcome. */
-  top_predictors: Array<{
-    /** The ID of the user. */
-    user_id: string
-    /** The login of the user. */
-    user_login: string
-    /** The display name of the user. */
-    user_name: string
-    /** Integer. The number of Channel Points won. This value is always null in the event payload for Prediction progress and Prediction lock. This value is 0 if the outcome did not win or if the Prediction was canceled and Channel Points were refunded. */
-    channel_points_won: number
-    /** Integer. The number of Channel Points used to participate in the Prediction. */
-    channel_points_used: number
-  }>
-}

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

@@ -1,51 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type ChannelPredictionOutcome } from "./channel.prediction._.js"
-
-type ChannelPredictionBeginType = "channel.prediction.begin"
-type ChannelPredictionBeginVersion = "1"
-
-/** The parameters under which an event fires when A Prediction startn. */
-export interface ChannelPredictionBeginCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A Prediction startn. */
-export interface ChannelPredictionBeginEvent {
-  /** Channel Points Prediction ID. */
-  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
-  /** Title for the Channel Points Prediction. */
-  title: string
-  /** An array of outcomes for the Channel Points Prediction. */
-  outcomes: ChannelPredictionOutcome[]
-  /** The time the Channel Points Prediction started. */
-  started_at: Date
-  /** The time the Channel Points Prediction will automatically lock. */
-  locks_at: Date
-}
-
-/** The event notification received when A Prediction startn. */
-export type ChannelPredictionBeginSubscription = BaseSubscription<
-  ChannelPredictionBeginType,
-  ChannelPredictionBeginVersion,
-  ChannelPredictionBeginCondition
->
-
-export function makeChannelPredictionBeginSubscription(
-  userId: string,
-): ChannelPredictionBeginSubscription {
-  return {
-    type: "channel.prediction.begin",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.prediction.end.ts

@@ -1,55 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type ChannelPredictionOutcome } from "./channel.prediction._.js"
-
-type ChannelPredictionEndType = "channel.prediction.end"
-type ChannelPredictionEndVersion = "1"
-
-/** The parameters under which an event fires when A Prediction ends. */
-export interface ChannelPredictionEndCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A Prediction ends. */
-export interface ChannelPredictionEndEvent {
-  /** Channel Points Prediction ID. */
-  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
-  /** Title for the Channel Points Prediction. */
-  title: string
-  /** ID of the winning outcome. */
-  winning_outcome_id: string
-  /** An array of outcomes for the Channel Points Prediction. Includes top_predictors. */
-  outcomes: ChannelPredictionOutcome[]
-  /** The status of the Channel Points Prediction. Valid values are resolved and canceled. */
-  status: string
-  /** The time the Channel Points Prediction started. */
-  started_at: Date
-  /** The time the Channel Points Prediction ended. */
-  ended_at: Date
-}
-
-/** The event notification received when A Prediction ends. */
-export type ChannelPredictionEndSubscription = BaseSubscription<
-  ChannelPredictionEndType,
-  ChannelPredictionEndVersion,
-  ChannelPredictionEndCondition
->
-
-export function makeChannelPredictionEndSubscription(
-  userId: string,
-): ChannelPredictionEndSubscription {
-  return {
-    type: "channel.prediction.end",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.prediction.lock.ts

@@ -1,51 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type ChannelPredictionOutcome } from "./channel.prediction._.js"
-
-type ChannelPredictionLockType = "channel.prediction.lock"
-type ChannelPredictionLockVersion = "1"
-
-/** The parameters under which an event fires when A Prediction lockeds. */
-export interface ChannelPredictionLockCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A Prediction lockeds. */
-export interface ChannelPredictionLockEvent {
-  /** Channel Points Prediction ID. */
-  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
-  /** Title for the Channel Points Prediction. */
-  title: string
-  /** An array of outcomes for the Channel Points Prediction. Includes top_predictors. */
-  outcomes: ChannelPredictionOutcome[]
-  /** The time the Channel Points Prediction started. */
-  started_at: Date
-  /** The time the Channel Points Prediction was locked. */
-  locked_at: Date
-}
-
-/** The event notification received when A Prediction lockeds. */
-export type ChannelPredictionLockSubscription = BaseSubscription<
-  ChannelPredictionLockType,
-  ChannelPredictionLockVersion,
-  ChannelPredictionLockCondition
->
-
-export function makeChannelPredictionLockSubscription(
-  userId: string,
-): ChannelPredictionLockSubscription {
-  return {
-    type: "channel.prediction.lock",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}