@overlaysymphony/twitch 0.2.1 → 0.2.3

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

@@ -0,0 +1,72 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.prediction.begin": ChannelPredictionBegin
+  }
+}
+
+/** Channel Prediction Begin v1: When a Prediction started on the specified channel. */
+type ChannelPredictionBegin = EventConfig<{
+  Type: "channel.prediction.begin"
+  Version: "1"
+  /** The conditions to listen for when a Prediction started on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID of the channel for which "prediction begin" notifications will be received. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a Prediction started on the specified channel. */
+  Event: {
+    /** Channel Points Prediction 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
+    /** Title for the Channel Points Prediction. */
+    title: string
+    /** An array of outcomes for the Channel Points Prediction. */
+    outcomes: Array<{
+      /** The outcome ID. */
+      id: string
+      /** The outcome title. */
+      title: string
+      /** The color for the outcome. Valid values are pink and blue. */
+      color: string
+      /** The number of users who used Channel Points on this outcome. */
+      users: number
+      /** 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: {
+        /** 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
+        /** 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
+        /** The number of Channel Points used to participate in the Prediction. */
+        channel_points_used: number
+      }
+    }>
+    /** The time the Channel Points Prediction started. */
+    started_at: string
+    /** The time the Channel Points Prediction will automatically lock. */
+    locks_at: string
+  }
+}>
+
+registerEvent("channel.prediction.begin", {
+  scopes: ["channel:manage:predictions", "channel:read:predictions"],
+  subscriber: (userId) => ({
+    type: "channel.prediction.begin",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,76 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.prediction.end": ChannelPredictionEnd
+  }
+}
+
+/** Channel Prediction End v1: When a Prediction ended on the specified channel. */
+type ChannelPredictionEnd = EventConfig<{
+  Type: "channel.prediction.end"
+  Version: "1"
+  /** The conditions to listen for when a Prediction ended on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID of the channel for which "prediction end" notifications will be received. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a Prediction ended on the specified channel. */
+  Event: {
+    /** Channel Points Prediction 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
+    /** 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: Array<{
+      /** The outcome ID. */
+      id: string
+      /** The outcome title. */
+      title: string
+      /** The color for the outcome. Valid values are pink and blue. */
+      color: string
+      /** The number of users who used Channel Points on this outcome. */
+      users: number
+      /** 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: {
+        /** 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
+        /** 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
+        /** The number of Channel Points used to participate in the Prediction. */
+        channel_points_used: number
+      }
+    }>
+    /** The status of the Channel Points Prediction. Valid values are resolved and canceled. */
+    status: string
+    /** The time the Channel Points Prediction started. */
+    started_at: string
+    /** The time the Channel Points Prediction ended. */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.prediction.end", {
+  scopes: ["channel:manage:predictions", "channel:read:predictions"],
+  subscriber: (userId) => ({
+    type: "channel.prediction.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,72 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.prediction.lock": ChannelPredictionLock
+  }
+}
+
+/** Channel Prediction Lock v1: When a Prediction was locked on the specified channel. */
+type ChannelPredictionLock = EventConfig<{
+  Type: "channel.prediction.lock"
+  Version: "1"
+  /** The conditions to listen for when a Prediction was locked on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID of the channel for which "prediction lock" notifications will be received. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a Prediction was locked on the specified channel. */
+  Event: {
+    /** Channel Points Prediction 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
+    /** Title for the Channel Points Prediction. */
+    title: string
+    /** An array of outcomes for the Channel Points Prediction. Includes top_predictors. */
+    outcomes: Array<{
+      /** The outcome ID. */
+      id: string
+      /** The outcome title. */
+      title: string
+      /** The color for the outcome. Valid values are pink and blue. */
+      color: string
+      /** The number of users who used Channel Points on this outcome. */
+      users: number
+      /** 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: {
+        /** 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
+        /** 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
+        /** The number of Channel Points used to participate in the Prediction. */
+        channel_points_used: number
+      }
+    }>
+    /** The time the Channel Points Prediction started. */
+    started_at: string
+    /** The time the Channel Points Prediction was locked. */
+    locked_at: string
+  }
+}>
+
+registerEvent("channel.prediction.lock", {
+  scopes: ["channel:manage:predictions", "channel:read:predictions"],
+  subscriber: (userId) => ({
+    type: "channel.prediction.lock",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,72 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.prediction.progress": ChannelPredictionProgress
+  }
+}
+
+/** Channel Prediction Progress v1: When users participated in a Prediction on the specified channel. */
+type ChannelPredictionProgress = EventConfig<{
+  Type: "channel.prediction.progress"
+  Version: "1"
+  /** The conditions to listen for when users participated in a Prediction on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID of the channel for which "prediction progress" notifications will be received. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when users participated in a Prediction on the specified channel. */
+  Event: {
+    /** Channel Points Prediction 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
+    /** Title for the Channel Points Prediction. */
+    title: string
+    /** An array of outcomes for the Channel Points Prediction. Includes top_predictors. */
+    outcomes: Array<{
+      /** The outcome ID. */
+      id: string
+      /** The outcome title. */
+      title: string
+      /** The color for the outcome. Valid values are pink and blue. */
+      color: string
+      /** The number of users who used Channel Points on this outcome. */
+      users: number
+      /** 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: {
+        /** 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
+        /** 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
+        /** The number of Channel Points used to participate in the Prediction. */
+        channel_points_used: number
+      }
+    }>
+    /** The time the Channel Points Prediction started. */
+    started_at: string
+    /** The time the Channel Points Prediction will automatically lock. */
+    locks_at: string
+  }
+}>
+
+registerEvent("channel.prediction.progress", {
+  scopes: ["channel:manage:predictions", "channel:read:predictions"],
+  subscriber: (userId) => ({
+    type: "channel.prediction.progress",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,48 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.raid": ChannelRaid
+  }
+}
+
+/** Channel Raid v1: When the broadcaster raids another broadcaster's channel. */
+type ChannelRaid = EventConfig<{
+  Type: "channel.raid"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster raids another broadcaster's channel. */
+  Condition: {
+    /** The broadcaster user ID that created the channel raid you want to get notifications for. Use this parameter if you want to know when a specific broadcaster raids another broadcaster. The channel raid condition must include either from_broadcaster_user_id or to_broadcaster_user_id. */
+    from_broadcaster_user_id?: string
+    /** The broadcaster user ID that received the channel raid you want to get notifications for. Use this parameter if you want to know when a specific broadcaster is raided by another broadcaster. The channel raid condition must include either from_broadcaster_user_id or to_broadcaster_user_id. */
+    to_broadcaster_user_id?: string
+  }
+  /** The event fired when the broadcaster raids another broadcaster's channel. */
+  Event: {
+    /** The broadcaster ID that created the raid. */
+    from_broadcaster_user_id: string
+    /** The broadcaster login that created the raid. */
+    from_broadcaster_user_login: string
+    /** The broadcaster display name that created the raid. */
+    from_broadcaster_user_name: string
+    /** The broadcaster ID that received the raid. */
+    to_broadcaster_user_id: string
+    /** The broadcaster login that received the raid. */
+    to_broadcaster_user_login: string
+    /** The broadcaster display name that received the raid. */
+    to_broadcaster_user_name: string
+    /** The number of viewers in the raid. */
+    viewers: number
+  }
+}>
+
+registerEvent("channel.raid", {
+  scopes: [],
+  subscriber: (userId) => ({
+    type: "channel.raid",
+    version: "1",
+    condition: {
+      to_broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,55 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shared_chat.begin": ChannelSharedChatBegin
+  }
+}
+
+/** Channel Shared Chat Begin v1: When a channel becomes active in an active shared chat session. */
+type ChannelSharedChatBegin = EventConfig<{
+  Type: "channel.shared_chat.begin"
+  Version: "1"
+  /** The conditions to listen for when a channel becomes active in an active shared chat session. */
+  Condition: {
+    /** The User ID of the channel to receive shared chat session begin events for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a channel becomes active in an active shared chat session. */
+  Event: {
+    /** The unique identifier for the shared chat session. */
+    session_id: string
+    /** The User ID of the channel in the subscription condition which is now active in the shared chat session. */
+    broadcaster_user_id: string
+    /** The display name of the channel in the subscription condition which is now active in the shared chat session. */
+    broadcaster_user_name: string
+    /** The user login of the channel in the subscription condition which is now active in the shared chat session. */
+    broadcaster_user_login: string
+    /** The User ID of the host channel. */
+    host_broadcaster_user_id: string
+    /** The display name of the host channel. */
+    host_broadcaster_user_name: string
+    /** The user login of the host channel. */
+    host_broadcaster_user_login: string
+    /** The list of participants in the session. */
+    participants: {
+      /** The User ID of the participant channel. */
+      broadcaster_user_id: string
+      /** The display name of the participant channel. */
+      broadcaster_user_name: string
+      /** The user login of the participant channel. */
+      broadcaster_user_login: string
+    }
+  }
+}>
+
+registerEvent("channel.shared_chat.begin", {
+  scopes: [],
+  subscriber: (userId) => ({
+    type: "channel.shared_chat.begin",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,46 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shared_chat.end": ChannelSharedChatEnd
+  }
+}
+
+/** Channel Shared Chat End v1: When a channel leaves a shared chat session or the session ends. */
+type ChannelSharedChatEnd = EventConfig<{
+  Type: "channel.shared_chat.end"
+  Version: "1"
+  /** The conditions to listen for when a channel leaves a shared chat session or the session ends. */
+  Condition: {
+    /** The User ID of the channel to receive shared chat session end events for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a channel leaves a shared chat session or the session ends. */
+  Event: {
+    /** The unique identifier for the shared chat session. */
+    session_id: string
+    /** The User ID of the channel in the subscription condition which is no longer active in the shared chat session. */
+    broadcaster_user_id: string
+    /** The display name of the channel in the subscription condition which is no longer active in the shared chat session. */
+    broadcaster_user_name: string
+    /** The user login of the channel in the subscription condition which is no longer active in the shared chat session. */
+    broadcaster_user_login: string
+    /** The User ID of the host channel. */
+    host_broadcaster_user_id: string
+    /** The display name of the host channel. */
+    host_broadcaster_user_name: string
+    /** The user login of the host channel. */
+    host_broadcaster_user_login: string
+  }
+}>
+
+registerEvent("channel.shared_chat.end", {
+  scopes: [],
+  subscriber: (userId) => ({
+    type: "channel.shared_chat.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.shared_chat.update-1.ts

@@ -0,0 +1,55 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shared_chat.update": ChannelSharedChatUpdate
+  }
+}
+
+/** Channel Shared Chat Update v1: When the active shared chat session the channel is in changes. */
+type ChannelSharedChatUpdate = EventConfig<{
+  Type: "channel.shared_chat.update"
+  Version: "1"
+  /** The conditions to listen for when the active shared chat session the channel is in changes. */
+  Condition: {
+    /** The User ID of the channel to receive shared chat session update events for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when the active shared chat session the channel is in changes. */
+  Event: {
+    /** The unique identifier for the shared chat session. */
+    session_id: string
+    /** The User ID of the channel in the subscription condition. */
+    broadcaster_user_id: string
+    /** The display name of the channel in the subscription condition. */
+    broadcaster_user_name: string
+    /** The user login of the channel in the subscription condition. */
+    broadcaster_user_login: string
+    /** The User ID of the host channel. */
+    host_broadcaster_user_id: string
+    /** The display name of the host channel. */
+    host_broadcaster_user_name: string
+    /** The user login of the host channel. */
+    host_broadcaster_user_login: string
+    /** The list of participants in the session. */
+    participants: {
+      /** The User ID of the participant channel. */
+      broadcaster_user_id: string
+      /** The display name of the participant channel. */
+      broadcaster_user_name: string
+      /** The user login of the participant channel. */
+      broadcaster_user_login: string
+    }
+  }
+}>
+
+registerEvent("channel.shared_chat.update", {
+  scopes: [],
+  subscriber: (userId) => ({
+    type: "channel.shared_chat.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,51 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shield_mode.begin": ChannelShieldModeBegin
+  }
+}
+
+/** Channel Shield Mode Begin v1: When the broadcaster activates Shield Mode. */
+type ChannelShieldModeBegin = EventConfig<{
+  Type: "channel.shield_mode.begin"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster activates Shield Mode. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they activate Shield Mode. */
+    broadcaster_user_id: string
+    /** The ID of the broadcaster or one of the broadcaster's moderators. */
+    moderator_user_id: string
+  }
+  /** The event fired when the broadcaster activates Shield Mode. */
+  Event: {
+    /** An ID that identifies the broadcaster whose Shield Mode status was updated. */
+    broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** An ID that identifies 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 moderator's login name. */
+    moderator_user_login: string
+    /** The moderator's display name. */
+    moderator_user_name: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator activated Shield Mode. The object includes this field only for channel.shield_mode.begin events. */
+    started_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator deactivated Shield Mode. The object includes this field only for channel.shield_mode.end events. */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.shield_mode.begin", {
+  scopes: ["moderator:manage:shield", "moderator:read:shield"],
+  subscriber: (userId) => ({
+    type: "channel.shield_mode.begin",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,51 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shield_mode.end": ChannelShieldModeEnd
+  }
+}
+
+/** Channel Shield Mode End v1: When the broadcaster deactivates Shield Mode. */
+type ChannelShieldModeEnd = EventConfig<{
+  Type: "channel.shield_mode.end"
+  Version: "1"
+  /** The conditions to listen for when the broadcaster deactivates Shield Mode. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they deactivate Shield Mode. */
+    broadcaster_user_id: string
+    /** The ID of the broadcaster or one of the broadcaster's moderators. */
+    moderator_user_id: string
+  }
+  /** The event fired when the broadcaster deactivates Shield Mode. */
+  Event: {
+    /** An ID that identifies the broadcaster whose Shield Mode status was updated. */
+    broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** An ID that identifies 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 moderator's login name. */
+    moderator_user_login: string
+    /** The moderator's display name. */
+    moderator_user_name: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator activated Shield Mode. The object includes this field only for channel.shield_mode.begin events. */
+    started_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the moderator deactivated Shield Mode. The object includes this field only for channel.shield_mode.end events. */
+    ended_at: string
+  }
+}>
+
+registerEvent("channel.shield_mode.end", {
+  scopes: ["moderator:manage:shield", "moderator:read:shield"],
+  subscriber: (userId) => ({
+    type: "channel.shield_mode.end",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,61 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.shoutout.create": ChannelShoutoutCreate
+  }
+}
+
+/** Channel Shoutout Create v1: When the specified broadcaster sends a Shoutout. */
+type ChannelShoutoutCreate = EventConfig<{
+  Type: "channel.shoutout.create"
+  Version: "1"
+  /** The conditions to listen for when the specified broadcaster sends a Shoutout. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when they send a Shoutout. */
+    broadcaster_user_id: string
+    /** The ID of the broadcaster that gave the Shoutout or one of the broadcaster's moderators. */
+    moderator_user_id: string
+  }
+  /** The event fired when the specified broadcaster sends a Shoutout. */
+  Event: {
+    /** An ID that identifies the broadcaster that sent the Shoutout. */
+    broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    broadcaster_user_name: string
+    /** An ID that identifies the broadcaster that received the Shoutout. */
+    to_broadcaster_user_id: string
+    /** The broadcaster's login name. */
+    to_broadcaster_user_login: string
+    /** The broadcaster's display name. */
+    to_broadcaster_user_name: string
+    /** An ID that identifies 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 moderator's login name. */
+    moderator_user_login: string
+    /** The moderator's display name. */
+    moderator_user_name: string
+    /** The number of users that were watching the broadcaster's stream at the time of the Shoutout. */
+    viewer_count: number
+    /** The UTC timestamp (in RFC3339 format) of when the moderator sent the Shoutout. */
+    started_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the broadcaster may send a Shoutout to a different broadcaster. */
+    cooldown_ends_at: string
+    /** The UTC timestamp (in RFC3339 format) of when the broadcaster may send another Shoutout to the broadcaster in to_broadcaster_user_id. */
+    target_cooldown_ends_at: string
+  }
+}>
+
+registerEvent("channel.shoutout.create", {
+  scopes: ["moderator:manage:shoutouts", "moderator:read:shoutouts"],
+  subscriber: (userId) => ({
+    type: "channel.shoutout.create",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+      moderator_user_id: userId,
+    },
+  }),
+})