@overlaysymphony/twitch 0.2.1 → 0.2.3

package/src/eventsub/events/channel.channel_points_automatic_reward_redemption.add-2.ts

@@ -0,0 +1,88 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.channel_points_automatic_reward_redemption.add": ChannelChannelPointsAutomaticRewardRedemptionAdd
+  }
+}
+
+/** Channel Channel Points Automatic Reward Redemption Add v2: When a viewer has redeemed an automatic channel points reward on the specified channel. */
+type ChannelChannelPointsAutomaticRewardRedemptionAdd = EventConfig<{
+  Type: "channel.channel_points_automatic_reward_redemption.add"
+  Version: "2"
+  /** The conditions to listen for when a viewer has redeemed an automatic channel points reward on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to receive channel points reward add notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a viewer has redeemed an automatic channel points reward on the specified channel. */
+  Event: {
+    /** The ID of the channel where the reward was redeemed. */
+    broadcaster_user_id: string
+    /** The login of the channel where the reward was redeemed. */
+    broadcaster_user_login: string
+    /** The display name of the channel where the reward was redeemed. */
+    broadcaster_user_name: string
+    /** The ID of the redeeming user. */
+    user_id: string
+    /** The login of the redeeming user. */
+    user_login: string
+    /** The display name of the redeeming user. */
+    user_name: string
+    /** The ID of the Redemption. */
+    id: string
+    /** An object that contains the reward information. */
+    reward: {
+      /**
+       * The type of reward. One of:
+       * - single_message_bypass_sub_mode
+       * - send_highlighted_message
+       * - random_sub_emote_unlock
+       * - chosen_sub_emote_unlock
+       * - chosen_modified_sub_emote_unlock
+       * - message_effect
+       * - gigantify_an_emote
+       * - celebration
+       */
+      type: string
+      /** The reward cost. */
+      cost: number
+      /** Emote that was unlocked. */
+      unlocked_emote?: {
+        /** The emote ID. */
+        id: string
+        /** The human readable emote token. */
+        name: string
+      }
+    }
+    /** An object that contains the user message and emote information needed to recreate the message. */
+    message: {
+      /** The text of the chat message. */
+      text: string
+      /** An array that includes the emote ID and start and end positions for where the emote appears in the text. */
+      emotes: Array<{
+        /** The emote ID. */
+        id: string
+        /** The index of where the Emote starts in the text. */
+        begin: number
+        /** The index of where the Emote ends in the text. */
+        end: number
+      }>
+    }
+    /** A string that the user entered if the reward requires input. */
+    user_input?: string
+    /** The UTC date and time (in RFC3339 format) of when the reward was redeemed. */
+    redeemed_at: string
+  }
+}>
+
+registerEvent("channel.channel_points_automatic_reward_redemption.add", {
+  scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
+  subscriber: (userId) => ({
+    type: "channel.channel_points_automatic_reward_redemption.add",
+    version: "2",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.channel_points_custom_reward.add-1.ts

@@ -0,0 +1,101 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.channel_points_custom_reward.add": ChannelChannelPointsCustomRewardAdd
+  }
+}
+
+/** Channel Channel Points Custom Reward Add v1: When a custom channel points reward has been created for the specified channel. */
+type ChannelChannelPointsCustomRewardAdd = EventConfig<{
+  Type: "channel.channel_points_custom_reward.add"
+  Version: "1"
+  /** The conditions to listen for when a custom channel points reward has been created for the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to receive channel points custom reward add notifications for. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a custom channel points reward has been created for the specified channel. */
+  Event: {
+    /** The reward identifier. */
+    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
+    /** Is the reward currently enabled. If false, the reward won't show up to viewers. */
+    is_enabled: boolean
+    /** Is the reward currently paused. If true, viewers can't redeem. */
+    is_paused: boolean
+    /** Is the reward currently in stock. If false, viewers can't redeem. */
+    is_in_stock: boolean
+    /** The reward title. */
+    title: string
+    /** The reward cost. */
+    cost: number
+    /** The reward description. */
+    prompt: string
+    /** Does the viewer need to enter information when redeeming the reward. */
+    is_user_input_required: boolean
+    /** Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status. */
+    should_redemptions_skip_request_queue: boolean
+    /** Whether a maximum per stream is enabled and what the maximum is. */
+    max_per_stream: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The max per stream limit. */
+      value: number
+    }
+    /** Whether a maximum per user per stream is enabled and what the maximum is. */
+    max_per_user_per_stream: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The max per user per stream limit. */
+      value: number
+    }
+    /** Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2. */
+    background_color: string
+    /** Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded. */
+    image: {
+      /** URL for the image at 1x size. */
+      url_1x: string
+      /** URL for the image at 2x size. */
+      url_2x: string
+      /** URL for the image at 4x size. */
+      url_4x: string
+    }
+    /** Set of default images of 1x, 2x and 4x sizes for the reward. */
+    default_image: {
+      /** URL for the image at 1x size. */
+      url_1x: string
+      /** URL for the image at 2x size. */
+      url_2x: string
+      /** URL for the image at 4x size. */
+      url_4x: string
+    }
+    /** Whether a cooldown is enabled and what the cooldown is in seconds. */
+    global_cooldown: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The cooldown in seconds. */
+      seconds: number
+    }
+    /** Timestamp of the cooldown expiration. null if the reward isn't on cooldown. */
+    cooldown_expires_at: string
+    /** The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn't live or max_per_stream isn't enabled. */
+    redemptions_redeemed_current_stream: number
+  }
+}>
+
+registerEvent("channel.channel_points_custom_reward.add", {
+  scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
+  subscriber: (userId) => ({
+    type: "channel.channel_points_custom_reward.add",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

package/src/eventsub/events/channel.channel_points_custom_reward.remove-1.ts

@@ -0,0 +1,103 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.channel_points_custom_reward.remove": ChannelChannelPointsCustomRewardRemove
+  }
+}
+
+/** Channel Channel Points Custom Reward Remove v1: When a custom channel points reward has been removed from the specified channel. */
+type ChannelChannelPointsCustomRewardRemove = EventConfig<{
+  Type: "channel.channel_points_custom_reward.remove"
+  Version: "1"
+  /** The conditions to listen for when a custom channel points reward has been removed from the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to receive channel points custom reward remove notifications for. */
+    broadcaster_user_id: string
+    /** Specify a reward id to only receive notifications for a specific reward. */
+    reward_id?: string
+  }
+  /** The event fired when a custom channel points reward has been removed from the specified channel. */
+  Event: {
+    /** The reward identifier. */
+    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
+    /** Is the reward currently enabled. If false, the reward won't show up to viewers. */
+    is_enabled: boolean
+    /** Is the reward currently paused. If true, viewers can't redeem. */
+    is_paused: boolean
+    /** Is the reward currently in stock. If false, viewers can't redeem. */
+    is_in_stock: boolean
+    /** The reward title. */
+    title: string
+    /** The reward cost. */
+    cost: number
+    /** The reward description. */
+    prompt: string
+    /** Does the viewer need to enter information when redeeming the reward. */
+    is_user_input_required: boolean
+    /** Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status. */
+    should_redemptions_skip_request_queue: boolean
+    /** Whether a maximum per stream is enabled and what the maximum is. */
+    max_per_stream: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The max per stream limit. */
+      value: number
+    }
+    /** Whether a maximum per user per stream is enabled and what the maximum is. */
+    max_per_user_per_stream: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The max per user per stream limit. */
+      value: number
+    }
+    /** Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2. */
+    background_color: string
+    /** Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded. */
+    image: {
+      /** URL for the image at 1x size. */
+      url_1x: string
+      /** URL for the image at 2x size. */
+      url_2x: string
+      /** URL for the image at 4x size. */
+      url_4x: string
+    }
+    /** Set of default images of 1x, 2x and 4x sizes for the reward. */
+    default_image: {
+      /** URL for the image at 1x size. */
+      url_1x: string
+      /** URL for the image at 2x size. */
+      url_2x: string
+      /** URL for the image at 4x size. */
+      url_4x: string
+    }
+    /** Whether a cooldown is enabled and what the cooldown is in seconds. */
+    global_cooldown: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The cooldown in seconds. */
+      seconds: number
+    }
+    /** Timestamp of the cooldown expiration. null if the reward isn't on cooldown. */
+    cooldown_expires_at: string
+    /** The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn't live or max_per_stream isn't enabled. */
+    redemptions_redeemed_current_stream: number
+  }
+}>
+
+registerEvent("channel.channel_points_custom_reward.remove", {
+  scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
+  subscriber: (userId) => ({
+    type: "channel.channel_points_custom_reward.remove",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,103 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.channel_points_custom_reward.update": ChannelChannelPointsCustomRewardUpdate
+  }
+}
+
+/** Channel Channel Points Custom Reward Update v1: When a custom channel points reward has been updated for the specified channel. */
+type ChannelChannelPointsCustomRewardUpdate = EventConfig<{
+  Type: "channel.channel_points_custom_reward.update"
+  Version: "1"
+  /** The conditions to listen for when a custom channel points reward has been updated for the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to receive channel points custom reward update notifications for. */
+    broadcaster_user_id: string
+    /** Specify a reward id to only receive notifications for a specific reward. */
+    reward_id?: string
+  }
+  /** The event fired when a custom channel points reward has been updated for the specified channel. */
+  Event: {
+    /** The reward identifier. */
+    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
+    /** Is the reward currently enabled. If false, the reward won't show up to viewers. */
+    is_enabled: boolean
+    /** Is the reward currently paused. If true, viewers can't redeem. */
+    is_paused: boolean
+    /** Is the reward currently in stock. If false, viewers can't redeem. */
+    is_in_stock: boolean
+    /** The reward title. */
+    title: string
+    /** The reward cost. */
+    cost: number
+    /** The reward description. */
+    prompt: string
+    /** Does the viewer need to enter information when redeeming the reward. */
+    is_user_input_required: boolean
+    /** Should redemptions be set to fulfilled status immediately when redeemed and skip the request queue instead of the normal unfulfilled status. */
+    should_redemptions_skip_request_queue: boolean
+    /** Whether a maximum per stream is enabled and what the maximum is. */
+    max_per_stream: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The max per stream limit. */
+      value: number
+    }
+    /** Whether a maximum per user per stream is enabled and what the maximum is. */
+    max_per_user_per_stream: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The max per user per stream limit. */
+      value: number
+    }
+    /** Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2. */
+    background_color: string
+    /** Set of custom images of 1x, 2x and 4x sizes for the reward. Can be null if no images have been uploaded. */
+    image: {
+      /** URL for the image at 1x size. */
+      url_1x: string
+      /** URL for the image at 2x size. */
+      url_2x: string
+      /** URL for the image at 4x size. */
+      url_4x: string
+    }
+    /** Set of default images of 1x, 2x and 4x sizes for the reward. */
+    default_image: {
+      /** URL for the image at 1x size. */
+      url_1x: string
+      /** URL for the image at 2x size. */
+      url_2x: string
+      /** URL for the image at 4x size. */
+      url_4x: string
+    }
+    /** Whether a cooldown is enabled and what the cooldown is in seconds. */
+    global_cooldown: {
+      /** Is the setting enabled. */
+      is_enabled: boolean
+      /** The cooldown in seconds. */
+      seconds: number
+    }
+    /** Timestamp of the cooldown expiration. null if the reward isn't on cooldown. */
+    cooldown_expires_at: string
+    /** The number of redemptions redeemed during the current live stream. Counts against the max_per_stream limit. null if the broadcasters stream isn't live or max_per_stream isn't enabled. */
+    redemptions_redeemed_current_stream: number
+  }
+}>
+
+registerEvent("channel.channel_points_custom_reward.update", {
+  scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
+  subscriber: (userId) => ({
+    type: "channel.channel_points_custom_reward.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,65 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.channel_points_custom_reward_redemption.add": ChannelChannelPointsCustomRewardRedemptionAdd
+  }
+}
+
+/** Channel Channel Points Custom Reward Redemption Add v1: When a viewer has redeemed a custom channel points reward on the specified channel. */
+type ChannelChannelPointsCustomRewardRedemptionAdd = EventConfig<{
+  Type: "channel.channel_points_custom_reward_redemption.add"
+  Version: "1"
+  /** The conditions to listen for when a viewer has redeemed a custom channel points reward on the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to receive channel points custom reward redemption add notifications for. */
+    broadcaster_user_id: string
+    /** Specify a reward id to only receive notifications for a specific reward. */
+    reward_id?: string
+  }
+  /** The event fired when a viewer has redeemed a custom channel points reward on the specified channel. */
+  Event: {
+    /** The redemption identifier. */
+    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
+    /** User ID of the user that redeemed the reward. */
+    user_id: string
+    /** Login of the user that redeemed the reward. */
+    user_login: string
+    /** Display name of the user that redeemed the reward. */
+    user_name: string
+    /** The user input provided. Empty string if not provided. */
+    user_input: string
+    /** Defaults to unfulfilled. Possible values are unknown, unfulfilled, fulfilled, and canceled . */
+    status: string
+    /** Basic information about the reward that was redeemed, at the time it was redeemed. */
+    reward: {
+      /** The reward identifier. */
+      id: string
+      /** The reward name. */
+      title: string
+      /** The reward cost. */
+      cost: number
+      /** The reward description. */
+      prompt: string
+    }
+    /** RFC3339 timestamp of when the reward was redeemed. */
+    redeemed_at: string
+  }
+}>
+
+registerEvent("channel.channel_points_custom_reward_redemption.add", {
+  scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
+  subscriber: (userId) => ({
+    type: "channel.channel_points_custom_reward_redemption.add",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,65 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.channel_points_custom_reward_redemption.update": ChannelChannelPointsCustomRewardRedemptionUpdate
+  }
+}
+
+/** Channel Channel Points Custom Reward Redemption Update v1: When a redemption of a channel points custom reward has been updated for the specified channel. */
+type ChannelChannelPointsCustomRewardRedemptionUpdate = EventConfig<{
+  Type: "channel.channel_points_custom_reward_redemption.update"
+  Version: "1"
+  /** The conditions to listen for when a redemption of a channel points custom reward has been updated for the specified channel. */
+  Condition: {
+    /** The broadcaster user ID for the channel you want to receive channel points custom reward redemption update notifications for. */
+    broadcaster_user_id: string
+    /** Specify a reward id to only receive notifications for a specific reward. */
+    reward_id?: string
+  }
+  /** The event fired when a redemption of a channel points custom reward has been updated for the specified channel. */
+  Event: {
+    /** The redemption identifier. */
+    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
+    /** User ID of the user that redeemed the reward. */
+    user_id: string
+    /** Login of the user that redeemed the reward. */
+    user_login: string
+    /** Display name of the user that redeemed the reward. */
+    user_name: string
+    /** The user input provided. Empty string if not provided. */
+    user_input: string
+    /** Will be fulfilled or canceled. Possible values are unknown, unfulfilled, fulfilled, and canceled . */
+    status: string
+    /** Basic information about the reward that was redeemed, at the time it was redeemed. */
+    reward: {
+      /** The reward identifier. */
+      id: string
+      /** The reward name. */
+      title: string
+      /** The reward cost. */
+      cost: number
+      /** The reward description. */
+      prompt: string
+    }
+    /** RFC3339 timestamp of when the reward was redeemed. */
+    redeemed_at: string
+  }
+}>
+
+registerEvent("channel.channel_points_custom_reward_redemption.update", {
+  scopes: ["channel:manage:redemptions", "channel:read:redemptions"],
+  subscriber: (userId) => ({
+    type: "channel.channel_points_custom_reward_redemption.update",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,69 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.charity_campaign.donate": ChannelCharityCampaignDonate
+  }
+}
+
+/** Channel Charity Campaign Donate v1: When a user donates to the broadcaster's charity campaign. */
+type ChannelCharityCampaignDonate = EventConfig<{
+  Type: "channel.charity_campaign.donate"
+  Version: "1"
+  /** The conditions to listen for when a user donates to the broadcaster's charity campaign. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when users donate to their campaign. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when a user donates to the broadcaster's charity campaign. */
+  Event: {
+    /** An ID that identifies the donation. The ID is unique across campaigns. */
+    id: string
+    /** An ID that identifies the charity campaign. */
+    campaign_id: string
+    /** An ID that identifies the broadcaster that's running the campaign. */
+    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 user that donated to the campaign. */
+    user_id: string
+    /** The user's login name. */
+    user_login: string
+    /** The user's display name. */
+    user_name: string
+    /** The charity's name. */
+    charity_name: string
+    /** A description of the charity. */
+    charity_description: string
+    /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
+    charity_logo: string
+    /** A URL to the charity's website. */
+    charity_website: string
+    /** An object that contains the amount of money that the user donated. */
+    amount: {
+      /** The monetary amount. The amount is specified in the currency's minor unit. */
+      value: number
+      /**
+       * The number of decimal places used by the currency.
+       *
+       * value / 10^decimal_places
+       */
+      decimal_places: number
+      /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
+      currency: string
+    }
+  }
+}>
+
+registerEvent("channel.charity_campaign.donate", {
+  scopes: ["channel:read:charity"],
+  subscriber: (userId) => ({
+    type: "channel.charity_campaign.donate",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})

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

@@ -0,0 +1,74 @@
+import { type EventConfig, registerEvent } from "../events-helpers.ts"
+
+declare module "../events-helpers.ts" {
+  interface EventConfigs {
+    "channel.charity_campaign.progress": ChannelCharityCampaignProgress
+  }
+}
+
+/** Channel Charity Campaign Progress v1: When progress is made towards the campaign's goal or the broadcaster changes the fundraising goal. */
+type ChannelCharityCampaignProgress = EventConfig<{
+  Type: "channel.charity_campaign.progress"
+  Version: "1"
+  /** The conditions to listen for when progress is made towards the campaign's goal or the broadcaster changes the fundraising goal. */
+  Condition: {
+    /** The ID of the broadcaster that you want to receive notifications about when their campaign makes progress or is updated. */
+    broadcaster_user_id: string
+  }
+  /** The event fired when progress is made towards the campaign's goal or the broadcaster changes the fundraising goal. */
+  Event: {
+    /** An ID that identifies the charity campaign. */
+    id: string
+    /** An ID that identifies the broadcaster that's running the campaign. */
+    broadcaster_id: string
+    /** The broadcaster's login name. */
+    broadcaster_login: string
+    /** The broadcaster's display name. */
+    broadcaster_name: string
+    /** The charity's name. */
+    charity_name: string
+    /** A description of the charity. */
+    charity_description: string
+    /** A URL to an image of the charity's logo. The image's type is PNG and its size is 100px X 100px. */
+    charity_logo: string
+    /** A URL to the charity's website. */
+    charity_website: string
+    /** An object that contains the current amount of donations that the campaign has received. */
+    current_amount: {
+      /** The monetary amount. The amount is specified in the currency's minor unit. */
+      value: number
+      /**
+       * The number of decimal places used by the currency.
+       *
+       * value / 10^decimal_places
+       */
+      decimal_places: number
+      /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
+      currency: string
+    }
+    /** An object that contains the campaign's target fundraising goal. */
+    target_amount: {
+      /** The monetary amount. The amount is specified in the currency's minor unit. */
+      value: number
+      /**
+       * The number of decimal places used by the currency.
+       *
+       * value / 10^decimal_places
+       */
+      decimal_places: number
+      /** The ISO-4217 three-letter currency code that identifies the type of currency in value. */
+      currency: string
+    }
+  }
+}>
+
+registerEvent("channel.charity_campaign.progress", {
+  scopes: ["channel:read:charity"],
+  subscriber: (userId) => ({
+    type: "channel.charity_campaign.progress",
+    version: "1",
+    condition: {
+      broadcaster_user_id: userId,
+    },
+  }),
+})