@overlaysymphony/twitch 0.2.2 → 0.2.3

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,
-    },
-  }
-}

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

@@ -1,51 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-import { type ChannelPredictionOutcome } from "./channel.prediction._.js"
-
-type ChannelPredictionProgressType = "channel.prediction.progress"
-type ChannelPredictionProgressVersion = "1"
-
-/** The parameters under which an event fires when A user participates in a Prediction. */
-export interface ChannelPredictionProgressCondition {
-  /** The user ID of the broadcaster. */
-  broadcaster_user_id: string
-}
-
-/** The event information when A user participates in a Prediction. */
-export interface ChannelPredictionProgressEvent {
-  /** 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 will automatically lock. */
-  locks_at: Date
-}
-
-/** The event notification received when A user participates in a Prediction. */
-export type ChannelPredictionProgressSubscription = BaseSubscription<
-  ChannelPredictionProgressType,
-  ChannelPredictionProgressVersion,
-  ChannelPredictionProgressCondition
->
-
-export function makeChannelPredictionProgressSubscription(
-  userId: string,
-): ChannelPredictionProgressSubscription {
-  return {
-    type: "channel.prediction.progress",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-    },
-  }
-}

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

@@ -1,49 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ChannelRaidType = "channel.raid"
-type ChannelRaidVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster raids another broadcaster's channel. */
-export interface ChannelRaidCondition {
-  /** The user ID of the broadcaster that created the channel raid. */
-  from_broadcaster_user_id?: string
-  /** The user ID of the broadcaster that received the channel raid. */
-  to_broadcaster_user_id?: string
-}
-
-/** The event information when The broadcaster raids another broadcaster's channel. */
-export interface ChannelRaidEvent {
-  /** The user ID of the broadcaster that created the raid. */
-  from_broadcaster_user_id: string
-  /** The user login of the broadcaster that created the raid. */
-  from_broadcaster_user_login: string
-  /** The user name of the broadcaster that created the raid. */
-  from_broadcaster_user_name: string
-  /** The user ID of the broadcaster that received the raid. */
-  to_broadcaster_user_id: string
-  /** The user login of the broadcaster that received the raid. */
-  to_broadcaster_user_login: string
-  /** The user name of the broadcaster that received the raid. */
-  to_broadcaster_user_name: string
-  /** Integer. The number of viewers in the raid. */
-  viewers: number
-}
-
-/** The event notification received when The broadcaster raids another broadcaster's channel. */
-export type ChannelRaidSubscription = BaseSubscription<
-  ChannelRaidType,
-  ChannelRaidVersion,
-  ChannelRaidCondition
->
-
-export function makeChannelRaidSubscription(
-  userId: string,
-): ChannelRaidSubscription {
-  return {
-    type: "channel.raid",
-    version: "1",
-    condition: {
-      to_broadcaster_user_id: userId,
-    },
-  }
-}

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

@@ -1,50 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ShieldModeBeginType = "channel.shield_mode.begin"
-type ShieldModeBeginVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster activates Shield Mode. */
-export interface ShieldModeBeginCondition {
-  /** 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 The broadcaster activates Shield Mode. */
-export interface ShieldModeBeginEvent {
-  /** 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 moderator that updated the shield mode's status. If the broadcaster updated the status, this ID will be the same as broadcaster_user_id. */
-  moderator_user_id: string
-  /** The user login of the moderator. */
-  moderator_user_login: string
-  /** The user name of the moderator. */
-  moderator_user_name: string
-  /** The time the moderator activated shield mode. */
-  started_at: Date
-}
-
-/** The event notification received when The broadcaster activates Shield Mode. */
-export type ShieldModeBeginSubscription = BaseSubscription<
-  ShieldModeBeginType,
-  ShieldModeBeginVersion,
-  ShieldModeBeginCondition
->
-
-export function makeShieldModeBeginSubscription(
-  userId: string,
-): ShieldModeBeginSubscription {
-  return {
-    type: "channel.shield_mode.begin",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
-    },
-  }
-}

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

@@ -1,50 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ShieldModeEndType = "channel.shield_mode.end"
-type ShieldModeEndVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster deactivates Shield Mode. */
-export interface ShieldModeEndCondition {
-  /** 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 The broadcaster deactivates Shield Mode. */
-export interface ShieldModeEndEvent {
-  /** 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 moderator that updated the shield mode's status. If the broadcaster updated the status, this ID will be the same as broadcaster_user_id. */
-  moderator_user_id: string
-  /** The user login of the moderator. */
-  moderator_user_login: string
-  /** The user name of the moderator. */
-  moderator_user_name: string
-  /** The time the moderator deactivated shield mode. */
-  ended_at: Date
-}
-
-/** The event notification received when The broadcaster deactivates Shield Mode. */
-export type ShieldModeEndSubscription = BaseSubscription<
-  ShieldModeEndType,
-  ShieldModeEndVersion,
-  ShieldModeEndCondition
->
-
-export function makeShieldModeEndSubscription(
-  userId: string,
-): ShieldModeEndSubscription {
-  return {
-    type: "channel.shield_mode.end",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.shoutout.create.ts

@@ -1,62 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ShoutoutCreateType = "channel.shoutout.create"
-type ShoutoutCreateVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster sends a Shoutout. */
-export interface ShoutoutCreateCondition {
-  /** 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 The broadcaster sends a Shoutout. */
-export interface ShoutoutCreateEvent {
-  /** 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 broadcaster that received the shoutout. */
-  to_broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  to_broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  to_broadcaster_user_name: string
-  /** The user ID of the moderator that sent the shoutout. If the broadcaster sent the shoutout, this ID is the same as the ID in broadcaster_user_id. */
-  moderator_user_id: string
-  /** The user login of the moderator. */
-  moderator_user_login: string
-  /** The user name of the moderator. */
-  moderator_user_name: string
-  /** Integer. The number of users that were watching the broadcaster's stream at the time of the shoutout. */
-  viewer_count: number
-  /** The time the moderator sent the shoutout. */
-  started_at: Date
-  /** The time the broadcaster may send a shoutout to a different broadcaster. */
-  cooldown_ends_at: Date
-  /** The time the broadcaster may send another shoutout to the broadcaster in to_broadcaster_user_id. */
-  target_cooldown_ends_at: Date
-}
-
-/** The event notification received when The broadcaster sends a Shoutout. */
-export type ShoutoutCreateSubscription = BaseSubscription<
-  ShoutoutCreateType,
-  ShoutoutCreateVersion,
-  ShoutoutCreateCondition
->
-
-export function makeShoutoutCreateSubscription(
-  userId: string,
-): ShoutoutCreateSubscription {
-  return {
-    type: "channel.shoutout.create",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
-    },
-  }
-}

package/src/eventsub/events/channel.shoutout.receive.ts

@@ -1,52 +0,0 @@
-import { type BaseSubscription } from "../events-helpers.js"
-
-type ShoutoutReceiveType = "channel.shoutout.receive"
-type ShoutoutReceiveVersion = "1"
-
-/** The parameters under which an event fires when The broadcaster receives a Shoutout. */
-export interface ShoutoutReceiveCondition {
-  /** 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 The broadcaster receives a Shoutout. */
-export interface ShoutoutReceiveEvent {
-  /** 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 broadcaster that sent the shoutout. */
-  from_broadcaster_user_id: string
-  /** The user login of the broadcaster. */
-  from_broadcaster_user_login: string
-  /** The user name of the broadcaster. */
-  from_broadcaster_user_name: string
-  /** Integer. The number of users that were watching the from-broadcaster's stream at the time of the shoutout. */
-  viewer_count: number
-  /** The time the moderator sent the shoutout. */
-  started_at: Date
-}
-
-/** The event notification received when The broadcaster receives a Shoutout. */
-export type ShoutoutReceiveSubscription = BaseSubscription<
-  ShoutoutReceiveType,
-  ShoutoutReceiveVersion,
-  ShoutoutReceiveCondition
->
-
-export function makeShoutoutReceiveSubscription(
-  userId: string,
-): ShoutoutReceiveSubscription {
-  return {
-    type: "channel.shoutout.receive",
-    version: "1",
-    condition: {
-      broadcaster_user_id: userId,
-      moderator_user_id: userId,
-    },
-  }
-}