@overlaysymphony/twitch 0.2.1 → 0.2.3

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

@@ -0,0 +1,80 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.goal.begin": ChannelGoalBegin
+  }
+}
+
+/** Channel Goal Begin v1: When the broadcaster begins a goal. */
+type ChannelGoalBegin = EventConfig<{
+  Type: "channel.goal.begin"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster begins a goal. */
+  Condition: {
+    /** The ID of the broadcaster to get notified about. The ID must match the user_id in the OAuth access token. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when the broadcaster begins a goal. */
+  Event: {
+    /** An ID that identifies this event. */
+    id: string
+    /** An ID that uniquely identifies the broadcaster. */
+    broadcaster_user_id: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** The broadcaster's user handle. */
+    broadcaster_user_login: string
+    /**
+     * The type of goal. Possible values are:
+     * - follow — The goal is to increase followers.
+     * - subscription — The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions.
+     * - subscription_count — The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.
+     * - new_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).
+     * - new_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).
+     * - new_bit — The goal is to increase the amount of Bits used on the channel.
+     * - new_cheerer — The goal is to increase the number of unique Cheerers to Cheer on the channel.
+     */
+    type: string
+    /** A description of the goal, if specified. The description may contain a maximum of 40 characters. */
+    description: string
+    /**
+     * A Boolean value that indicates whether the broadcaster achieved their goal. Is true if the goal was achieved; otherwise, false.
+     *
+     * Only the channel.goal.end event includes this field.
+     */
+    is_achieved: boolean
+    /**
+     * The goal's current value.
+     *
+     * The goal's type determines how this value is increased or decreased.
+     * - If 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.
+     * - If type is subscription, this field is increased and decreased by the points value associated with the subscription tier.
+     * - If type is subscription_count, this field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.
+     * - If type is new_subscription, this field is increased by the points value associated with the subscription tier.
+     * - If type is new_subscription_count, this field is increased by 1 for each new subscription.
+     */
+    current_amount: number
+    /** The goal's target value. */
+    target_amount: number
+    /** The UTC timestamp in RFC 3339 format, which indicates when the broadcaster created the goal. */
+    started_at: string
+    /**
+     * The UTC timestamp in RFC 3339 format, which indicates when the broadcaster ended the goal.
+     *
+     * Only the channel.goal.end event includes this field.
+     */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.goal.begin", {
+  scopes: ["channel:read:goals"],
+  subscriber: (userId) => ({
+    type: "channel.goal.begin",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.goal.end-1.ts

@@ -0,0 +1,80 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.goal.end": ChannelGoalEnd
+  }
+}
+
+/** Channel Goal End v1: When the broadcaster ends a goal. */
+type ChannelGoalEnd = EventConfig<{
+  Type: "channel.goal.end"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster ends a goal. */
+  Condition: {
+    /** The ID of the broadcaster to get notified about. The ID must match the user_id in the OAuth access token. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when the broadcaster ends a goal. */
+  Event: {
+    /** An ID that identifies this event. */
+    id: string
+    /** An ID that uniquely identifies the broadcaster. */
+    broadcaster_user_id: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** The broadcaster's user handle. */
+    broadcaster_user_login: string
+    /**
+     * The type of goal. Possible values are:
+     * - follow — The goal is to increase followers.
+     * - subscription — The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions.
+     * - subscription_count — The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.
+     * - new_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).
+     * - new_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).
+     * - new_bit — The goal is to increase the amount of Bits used on the channel.
+     * - new_cheerer — The goal is to increase the number of unique Cheerers to Cheer on the channel.
+     */
+    type: string
+    /** A description of the goal, if specified. The description may contain a maximum of 40 characters. */
+    description: string
+    /**
+     * A Boolean value that indicates whether the broadcaster achieved their goal. Is true if the goal was achieved; otherwise, false.
+     *
+     * Only the channel.goal.end event includes this field.
+     */
+    is_achieved: boolean
+    /**
+     * The goal's current value.
+     *
+     * The goal's type determines how this value is increased or decreased.
+     * - If 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.
+     * - If type is subscription, this field is increased and decreased by the points value associated with the subscription tier.
+     * - If type is subscription_count, this field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.
+     * - If type is new_subscription, this field is increased by the points value associated with the subscription tier.
+     * - If type is new_subscription_count, this field is increased by 1 for each new subscription.
+     */
+    current_amount: number
+    /** The goal's target value. */
+    target_amount: number
+    /** The UTC timestamp in RFC 3339 format, which indicates when the broadcaster created the goal. */
+    started_at: string
+    /**
+     * The UTC timestamp in RFC 3339 format, which indicates when the broadcaster ended the goal.
+     *
+     * Only the channel.goal.end event includes this field.
+     */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.goal.end", {
+  scopes: ["channel:read:goals"],
+  subscriber: (userId) => ({
+    type: "channel.goal.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.goal.progress-1.ts

@@ -0,0 +1,80 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.goal.progress": ChannelGoalProgress
+  }
+}
+
+/** Channel Goal Progress v1: When progress (either positive or negative) is made towards the broadcaster's goal. */
+type ChannelGoalProgress = EventConfig<{
+  Type: "channel.goal.progress"
+  Version: "1"
+  /** The conditions to listen for when progress (either positive or negative) is made towards the broadcaster's goal. */
+  Condition: {
+    /** The ID of the broadcaster to get notified about. The ID must match the user_id in the OAuth access token. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when progress (either positive or negative) is made towards the broadcaster's goal. */
+  Event: {
+    /** An ID that identifies this event. */
+    id: string
+    /** An ID that uniquely identifies the broadcaster. */
+    broadcaster_user_id: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** The broadcaster's user handle. */
+    broadcaster_user_login: string
+    /**
+     * The type of goal. Possible values are:
+     * - follow — The goal is to increase followers.
+     * - subscription — The goal is to increase subscriptions. This type shows the net increase or decrease in tier points associated with the subscriptions.
+     * - subscription_count — The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.
+     * - new_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).
+     * - new_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).
+     * - new_bit — The goal is to increase the amount of Bits used on the channel.
+     * - new_cheerer — The goal is to increase the number of unique Cheerers to Cheer on the channel.
+     */
+    type: string
+    /** A description of the goal, if specified. The description may contain a maximum of 40 characters. */
+    description: string
+    /**
+     * A Boolean value that indicates whether the broadcaster achieved their goal. Is true if the goal was achieved; otherwise, false.
+     *
+     * Only the channel.goal.end event includes this field.
+     */
+    is_achieved: boolean
+    /**
+     * The goal's current value.
+     *
+     * The goal's type determines how this value is increased or decreased.
+     * - If 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.
+     * - If type is subscription, this field is increased and decreased by the points value associated with the subscription tier.
+     * - If type is subscription_count, this field is increased by 1 for each new subscription and decreased by 1 for each user that unsubscribes.
+     * - If type is new_subscription, this field is increased by the points value associated with the subscription tier.
+     * - If type is new_subscription_count, this field is increased by 1 for each new subscription.
+     */
+    current_amount: number
+    /** The goal's target value. */
+    target_amount: number
+    /** The UTC timestamp in RFC 3339 format, which indicates when the broadcaster created the goal. */
+    started_at: string
+    /**
+     * The UTC timestamp in RFC 3339 format, which indicates when the broadcaster ended the goal.
+     *
+     * Only the channel.goal.end event includes this field.
+     */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.goal.progress", {
+  scopes: ["channel:read:goals"],
+  subscriber: (userId) => ({
+    type: "channel.goal.progress",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.guest_star_guest.update-beta.ts

@@ -0,0 +1,85 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.guest_star_guest.update@be": ChannelGuestStarGuestUpdateBe
+  }
+}
+
+/** Channel Guest Star Guest Update Be vbeta: When a guest or a slot is updated in an active Guest Star session. */
+type ChannelGuestStarGuestUpdateBe = EventConfig<{
+  Type: "channel.guest_star_guest.update@be"
+  Version: "beta"
+  /** The conditions to listen for when a guest or a slot is updated in an active Guest Star session. */
+  Condition: {
+    /** The broadcaster user ID of the channel hosting the Guest Star Session */
+    broadcaster_user_id: string
+    /** The user ID of the moderator or broadcaster of the specified channel. */
+    moderator_user_id: string
+  }
+  /** The event fired when a guest or a slot is updated in an active Guest Star session. */
+  Event: {
+    /** The non-host broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The non-host broadcaster display name. */
+    broadcaster_user_name: string
+    /** The non-host broadcaster login. */
+    broadcaster_user_login: string
+    /** ID representing the unique session that was started. */
+    session_id: string
+    /** The user ID of the moderator who updated the guest's state (could be the host). null if the update was performed by the guest. */
+    moderator_user_id: string
+    /** The moderator display name. null if the update was performed by the guest. */
+    moderator_user_name: string
+    /** The moderator login. null if the update was performed by the guest. */
+    moderator_user_login: string
+    /** The user ID of the guest who transitioned states in the session. null if the slot is now empty. */
+    guest_user_id: string
+    /** The guest display name. null if the slot is now empty. */
+    guest_user_name: string
+    /** The guest login. null if the slot is now empty. */
+    guest_user_login: string
+    /** The ID of the slot assignment the guest is assigned to. null if the guest is in the INVITED, REMOVED, READY, or ACCEPTED state. */
+    slot_id: string
+    /**
+     * The current state of the user after the update has taken place. null if the slot is now empty. Can otherwise be one of the following:
+     * - invited — The guest has transitioned to the invite queue. This can take place when the guest was previously assigned a slot, but have been removed from the call and are sent back to the invite queue.
+     * - accepted — The guest has accepted the invite and is currently in the process of setting up to join the session.
+     * - ready — The guest has signaled they are ready and can be assigned a slot.
+     * - backstage — The guest has been assigned a slot in the session, but is not currently seen live in the broadcasting software.
+     * - live — The guest is now live in the host's broadcasting software.
+     * - removed — The guest was removed from the call or queue.
+     * - accepted — The guest has accepted the invite to the call.
+     */
+    state: string
+    /** User ID of the host channel. */
+    host_user_id: string
+    /** The host display name. */
+    host_user_name: string
+    /** The host login. */
+    host_user_login: string
+    /** Flag that signals whether the host is allowing the slot's video to be seen by participants within the session. null if the guest is not slotted. */
+    host_video_enabled: boolean
+    /** Flag that signals whether the host is allowing the slot's audio to be heard by participants within the session. null if the guest is not slotted. */
+    host_audio_enabled: boolean
+    /** Value between 0-100 that represents the slot's audio level as heard by participants within the session. null if the guest is not slotted. */
+    host_volume: number
+  }
+}>
+
+registerEvent("channel.guest_star_guest.update@be", {
+  scopes: [
+    "channel:manage:guest",
+    "channel:read:guest",
+    "moderator:manage:guest",
+    "moderator:read:guest",
+  ],
+  subscriber: (userId) => ({
+    type: "channel.guest_star_guest.update@be",
+    version: "beta",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.guest_star_session.begin-beta.ts

@@ -0,0 +1,50 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.guest_star_session.begin@be": ChannelGuestStarSessionBeginBe
+  }
+}
+
+/** Channel Guest Star Session Begin Be vbeta: When the host began a new Guest Star session. */
+type ChannelGuestStarSessionBeginBe = EventConfig<{
+  Type: "channel.guest_star_session.begin@be"
+  Version: "beta"
+  /** The conditions to listen for when the host began a new Guest Star session. */
+  Condition: {
+    /** The broadcaster user ID of the channel hosting the Guest Star Session */
+    broadcaster_user_id: string
+    /** The user ID of the moderator or broadcaster of the specified channel. */
+    moderator_user_id: string
+  }
+  /** The event fired when the host began a new Guest Star session. */
+  Event: {
+    /** The broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The broadcaster display name. */
+    broadcaster_user_name: string
+    /** The broadcaster login. */
+    broadcaster_user_login: string
+    /** ID representing the unique session that was started. */
+    session_id: string
+    /** RFC3339 timestamp indicating the time the session began. */
+    started_at: string
+  }
+}>
+
+registerEvent("channel.guest_star_session.begin@be", {
+  scopes: [
+    "channel:manage:guest",
+    "channel:read:guest",
+    "moderator:manage:guest",
+    "moderator:read:guest",
+  ],
+  subscriber: (userId) => ({
+    type: "channel.guest_star_session.begin@be",
+    version: "beta",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.guest_star_session.end-beta.ts

@@ -0,0 +1,58 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.guest_star_session.end@be": ChannelGuestStarSessionEndBe
+  }
+}
+
+/** Channel Guest Star Session End Be vbeta: When a running Guest Star session has ended. */
+type ChannelGuestStarSessionEndBe = EventConfig<{
+  Type: "channel.guest_star_session.end@be"
+  Version: "beta"
+  /** The conditions to listen for when a running Guest Star session has ended. */
+  Condition: {
+    /** The broadcaster user ID of the channel hosting the Guest Star Session */
+    broadcaster_user_id: string
+    /** The user ID of the moderator or broadcaster of the specified channel. */
+    moderator_user_id: string
+  }
+  /** The event fired when a running Guest Star session has ended. */
+  Event: {
+    /** The non-host broadcaster user ID. */
+    broadcaster_user_id: string
+    /** The non-host broadcaster display name. */
+    broadcaster_user_name: string
+    /** The non-host broadcaster login. */
+    broadcaster_user_login: string
+    /** ID representing the unique session that was started. */
+    session_id: string
+    /** RFC3339 timestamp indicating the time the session began. */
+    started_at: string
+    /** RFC3339 timestamp indicating the time the session ended. */
+    ended_at: string
+    /** User ID of the host channel. */
+    host_user_id: string
+    /** The host display name. */
+    host_user_name: string
+    /** The host login. */
+    host_user_login: string
+  }
+}>
+
+registerEvent("channel.guest_star_session.end@be", {
+  scopes: [
+    "channel:manage:guest",
+    "channel:read:guest",
+    "moderator:manage:guest",
+    "moderator:read:guest",
+  ],
+  subscriber: (userId) => ({
+    type: "channel.guest_star_session.end@be",
+    version: "beta",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.guest_star_settings.update-beta.ts

@@ -0,0 +1,62 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.guest_star_settings.update@be": ChannelGuestStarSettingsUpdateBe
+  }
+}
+
+/** Channel Guest Star Settings Update Be vbeta: When the host preferences for Guest Star have been updated. */
+type ChannelGuestStarSettingsUpdateBe = EventConfig<{
+  Type: "channel.guest_star_settings.update@be"
+  Version: "beta"
+  /** The conditions to listen for when the host preferences for Guest Star have been updated. */
+  Condition: {
+    /** The broadcaster user ID of the channel hosting the Guest Star Session */
+    broadcaster_user_id: string
+    /** The user ID of the moderator or broadcaster of the specified channel. */
+    moderator_user_id: string
+  }
+  /** The event fired when the host preferences for Guest Star have been updated. */
+  Event: {
+    /** User ID of the host channel. */
+    broadcaster_user_id: string
+    /** The broadcaster display name */
+    broadcaster_user_name: string
+    /** he broadcaster login. */
+    broadcaster_user_login: string
+    /** Flag determining if Guest Star moderators have access to control whether a guest is live once assigned to a slot. */
+    is_moderator_send_live_enabled: boolean
+    /** Number of slots the Guest Star call interface will allow the host to add to a call. */
+    slot_count: number
+    /** Flag determining if browser sources subscribed to sessions on this channel should output audio. */
+    is_browser_source_audio_enabled: boolean
+    /**
+     * This setting determines how the guests within a session should be laid out within a group browser source. Can be one of the following values:
+     * - tiled — All live guests are tiled within the browser source with the same size.
+     * - screenshare — All live guests are tiled within the browser source with the same size. If there is an active screen share, it is sized larger than the other guests.
+     * - horizontal_top — Indicates the group layout will contain all participants in a top-aligned horizontal stack.
+     * - horizontal_bottom — Indicates the group layout will contain all participants in a bottom-aligned horizontal stack.
+     * - vertical_left — Indicates the group layout will contain all participants in a left-aligned vertical stack.
+     * - vertical_right — Indicates the group layout will contain all participants in a right-aligned vertical stack.
+     */
+    group_layout: string
+  }
+}>
+
+registerEvent("channel.guest_star_settings.update@be", {
+  scopes: [
+    "channel:manage:guest",
+    "channel:read:guest",
+    "moderator:manage:guest",
+    "moderator:read:guest",
+  ],
+  subscriber: (userId) => ({
+    type: "channel.guest_star_settings.update@be",
+    version: "beta",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,90 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.hype_train.begin": ChannelHypeTrainBegin
+  }
+}
+
+/** Channel Hype Train Begin v2: When a Hype Train begins on the specified channel. */
+type ChannelHypeTrainBegin = EventConfig<{
+  Type: "channel.hype_train.begin"
+  Version: "2"
+  /** The conditions to listen for when a Hype Train begins on the specified channel. */
+  Condition: {
+    /** The ID of the broadcaster that you want to get Hype Train begin notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a Hype Train begins on the specified channel. */
+  Event: {
+    /** The Hype Train ID. */
+    id: string
+    /** The requested broadcaster ID. */
+    broadcaster_user_id: string
+    /** The requested broadcaster login. */
+    broadcaster_user_login: string
+    /** The requested broadcaster display name. */
+    broadcaster_user_name: string
+    /** Total points contributed to the Hype Train. */
+    total: number
+    /** The number of points contributed to the Hype Train at the current level. */
+    progress: number
+    /** The number of points required to reach the next level. */
+    goal: number
+    /** The contributors with the most points contributed. */
+    top_contributions: {
+      /** 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:
+       * - bits - Bits contributions with Cheering, Power-ups, and Extensions.
+       * - subscription - Subscription activity like subscribing or gifting subscriptions.
+       * - other - Covers other contribution methods not listed.
+       */
+      type: string
+      /** 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 most recent contribution. */
+    last_contribution: {
+      /** 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:
+       * - bits — Cheering with Bits.
+       * - subscription — Subscription activity like subscribing or gifting subscriptions.
+       * - other — Covers other contribution methods not listed.
+       */
+      type: string
+      /** 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 starting level of the Hype Train. */
+    level: number
+    /** The time when the Hype Train started. */
+    started_at: string
+    /** The time when the Hype Train expires. The expiration is extended when the Hype Train reaches a new level. */
+    expires_at: string
+    /** Indicates if the Hype Train is a Golden Kappa Train. */
+    is_golden_kappa_train: boolean
+  }
+}>
+
+registerEvent("channel.hype_train.begin", {
+  scopes: ["channel:read:hype"],
+  subscriber: (userId) => ({
+    type: "channel.hype_train.begin",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,70 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.hype_train.end": ChannelHypeTrainEnd
+  }
+}
+
+/** Channel Hype Train End v2: When a Hype Train ends on the specified channel. */
+type ChannelHypeTrainEnd = EventConfig<{
+  Type: "channel.hype_train.end"
+  Version: "2"
+  /** The conditions to listen for when a Hype Train ends on the specified channel. */
+  Condition: {
+    /** The ID of the broadcaster that you want to get Hype Train end notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a Hype Train ends on the specified channel. */
+  Event: {
+    /** The Hype Train ID. */
+    id: string
+    /** The requested broadcaster ID. */
+    broadcaster_user_id: string
+    /** The requested broadcaster login. */
+    broadcaster_user_login: string
+    /** The requested broadcaster display name. */
+    broadcaster_user_name: string
+    /** The final level of the Hype Train. */
+    level: number
+    /** Total points contributed to the Hype Train. */
+    total: number
+    /** The contributors with the most points contributed. */
+    top_contributions: {
+      /** 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:
+       * - bits - Bits contributions with Cheering, Power-ups, and Extensions.
+       * - subscription - Subscription activity like subscribing or gifting subscriptions.
+       * - other - Covers other contribution methods not listed.
+       */
+      type: string
+      /** 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 when the Hype Train started. */
+    started_at: string
+    /** The time when the Hype Train ended. */
+    ended_at: string
+    /** The time when the Hype Train cooldown ends so that the next Hype Train can start. */
+    cooldown_ends_at: string
+    /** Indicates if the Hype Train is a Golden Kappa Train. */
+    is_golden_kappa_train: boolean
+  }
+}>
+
+registerEvent("channel.hype_train.end", {
+  scopes: ["channel:read:hype"],
+  subscriber: (userId) => ({
+    type: "channel.hype_train.end",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})