@openclaw/twitch 2026.5.20 → 2026.5.22

package/node_modules/@twurple/api/lib/endpoints/channelPoints/HelixCustomReward.d.ts

@@ -0,0 +1,94 @@
+import { DataObject } from '@twurple/common';
+import { type HelixCustomRewardData } from '../../interfaces/endpoints/channelPoints.external.js';
+import { type HelixCustomRewardImageScale } from '../../interfaces/endpoints/channelPoints.input.js';
+import type { HelixUser } from '../user/HelixUser.js';
+/**
+ * A custom Channel Points reward.
+ */
+export declare class HelixCustomReward extends DataObject<HelixCustomRewardData> {
+    /**
+     * The ID of the reward.
+     */
+    get id(): string;
+    /**
+     * The ID of the broadcaster the reward belongs to.
+     */
+    get broadcasterId(): string;
+    /**
+     * The name of the broadcaster the reward belongs to.
+     */
+    get broadcasterName(): string;
+    /**
+     * The display name of the broadcaster the reward belongs to.
+     */
+    get broadcasterDisplayName(): string;
+    /**
+     * Gets more information about the reward's broadcaster.
+     */
+    getBroadcaster(): Promise<HelixUser>;
+    /**
+     * Gets the URL of the image of the reward in the given scale.
+     *
+     * @param scale The scale of the image.
+     */
+    getImageUrl(scale: HelixCustomRewardImageScale): string;
+    /**
+     * The background color of the reward.
+     */
+    get backgroundColor(): string;
+    /**
+     * Whether the reward is enabled (shown to users).
+     */
+    get isEnabled(): boolean;
+    /**
+     * The channel points cost of the reward.
+     */
+    get cost(): number;
+    /**
+     * The title of the reward.
+     */
+    get title(): string;
+    /**
+     * The prompt shown to users when redeeming the reward.
+     */
+    get prompt(): string;
+    /**
+     * Whether the reward requires user input to be redeemed.
+     */
+    get userInputRequired(): boolean;
+    /**
+     * The maximum number of redemptions of the reward per stream. `null` means no limit.
+     */
+    get maxRedemptionsPerStream(): number | null;
+    /**
+     * The maximum number of redemptions of the reward per stream for each user. `null` means no limit.
+     */
+    get maxRedemptionsPerUserPerStream(): number | null;
+    /**
+     * The cooldown between two redemptions of the reward, in seconds. `null` means no cooldown.
+     */
+    get globalCooldown(): number | null;
+    /**
+     * Whether the reward is paused. If true, users can't redeem it.
+     */
+    get isPaused(): boolean;
+    /**
+     * Whether the reward is currently in stock.
+     */
+    get isInStock(): boolean;
+    /**
+     * How often the reward was already redeemed this stream.
+     *
+     * Only available when the stream is live and `maxRedemptionsPerStream` is set. Otherwise, this is `null`.
+     */
+    get redemptionsThisStream(): number | null;
+    /**
+     * Whether redemptions should automatically be marked as fulfilled.
+     */
+    get autoFulfill(): boolean;
+    /**
+     * The time when the cooldown ends. `null` means there is currently no cooldown.
+     */
+    get cooldownExpiryDate(): Date | null;
+}
+//# sourceMappingURL=HelixCustomReward.d.ts.map

package/node_modules/@twurple/api/lib/endpoints/channelPoints/HelixCustomReward.js

@@ -0,0 +1,152 @@
+import { __decorate } from "tslib";
+import { Enumerable } from '@d-fischer/shared-utils';
+import { checkRelationAssertion, DataObject, rawDataSymbol, rtfm } from '@twurple/common';
+/**
+ * A custom Channel Points reward.
+ */
+let HelixCustomReward = class HelixCustomReward extends DataObject {
+    /** @internal */ _client;
+    /** @internal */
+    constructor(data, client) {
+        super(data);
+        this._client = client;
+    }
+    /**
+     * The ID of the reward.
+     */
+    get id() {
+        return this[rawDataSymbol].id;
+    }
+    /**
+     * The ID of the broadcaster the reward belongs to.
+     */
+    get broadcasterId() {
+        return this[rawDataSymbol].broadcaster_id;
+    }
+    /**
+     * The name of the broadcaster the reward belongs to.
+     */
+    get broadcasterName() {
+        return this[rawDataSymbol].broadcaster_login;
+    }
+    /**
+     * The display name of the broadcaster the reward belongs to.
+     */
+    get broadcasterDisplayName() {
+        return this[rawDataSymbol].broadcaster_name;
+    }
+    /**
+     * Gets more information about the reward's broadcaster.
+     */
+    async getBroadcaster() {
+        return checkRelationAssertion(await this._client.users.getUserById(this[rawDataSymbol].broadcaster_id));
+    }
+    /**
+     * Gets the URL of the image of the reward in the given scale.
+     *
+     * @param scale The scale of the image.
+     */
+    getImageUrl(scale) {
+        const urlProp = `url_${scale}x`;
+        return this[rawDataSymbol].image?.[urlProp] ?? this[rawDataSymbol].default_image[urlProp];
+    }
+    /**
+     * The background color of the reward.
+     */
+    get backgroundColor() {
+        return this[rawDataSymbol].background_color;
+    }
+    /**
+     * Whether the reward is enabled (shown to users).
+     */
+    get isEnabled() {
+        return this[rawDataSymbol].is_enabled;
+    }
+    /**
+     * The channel points cost of the reward.
+     */
+    get cost() {
+        return this[rawDataSymbol].cost;
+    }
+    /**
+     * The title of the reward.
+     */
+    get title() {
+        return this[rawDataSymbol].title;
+    }
+    /**
+     * The prompt shown to users when redeeming the reward.
+     */
+    get prompt() {
+        return this[rawDataSymbol].prompt;
+    }
+    /**
+     * Whether the reward requires user input to be redeemed.
+     */
+    get userInputRequired() {
+        return this[rawDataSymbol].is_user_input_required;
+    }
+    /**
+     * The maximum number of redemptions of the reward per stream. `null` means no limit.
+     */
+    get maxRedemptionsPerStream() {
+        return this[rawDataSymbol].max_per_stream_setting.is_enabled
+            ? this[rawDataSymbol].max_per_stream_setting.max_per_stream
+            : null;
+    }
+    /**
+     * The maximum number of redemptions of the reward per stream for each user. `null` means no limit.
+     */
+    get maxRedemptionsPerUserPerStream() {
+        return this[rawDataSymbol].max_per_user_per_stream_setting.is_enabled
+            ? this[rawDataSymbol].max_per_user_per_stream_setting.max_per_user_per_stream
+            : null;
+    }
+    /**
+     * The cooldown between two redemptions of the reward, in seconds. `null` means no cooldown.
+     */
+    get globalCooldown() {
+        return this[rawDataSymbol].global_cooldown_setting.is_enabled
+            ? this[rawDataSymbol].global_cooldown_setting.global_cooldown_seconds
+            : null;
+    }
+    /**
+     * Whether the reward is paused. If true, users can't redeem it.
+     */
+    get isPaused() {
+        return this[rawDataSymbol].is_paused;
+    }
+    /**
+     * Whether the reward is currently in stock.
+     */
+    get isInStock() {
+        return this[rawDataSymbol].is_in_stock;
+    }
+    /**
+     * How often the reward was already redeemed this stream.
+     *
+     * Only available when the stream is live and `maxRedemptionsPerStream` is set. Otherwise, this is `null`.
+     */
+    get redemptionsThisStream() {
+        return this[rawDataSymbol].redemptions_redeemed_current_stream;
+    }
+    /**
+     * Whether redemptions should automatically be marked as fulfilled.
+     */
+    get autoFulfill() {
+        return this[rawDataSymbol].should_redemptions_skip_request_queue;
+    }
+    /**
+     * The time when the cooldown ends. `null` means there is currently no cooldown.
+     */
+    get cooldownExpiryDate() {
+        return this[rawDataSymbol].cooldown_expires_at ? new Date(this[rawDataSymbol].cooldown_expires_at) : null;
+    }
+};
+__decorate([
+    Enumerable(false)
+], HelixCustomReward.prototype, "_client", void 0);
+HelixCustomReward = __decorate([
+    rtfm('api', 'HelixCustomReward', 'id')
+], HelixCustomReward);
+export { HelixCustomReward };

package/node_modules/@twurple/api/lib/endpoints/channelPoints/HelixCustomRewardRedemption.d.ts

@@ -0,0 +1,88 @@
+import { DataObject } from '@twurple/common';
+import { type HelixCustomRewardRedemptionData, type HelixCustomRewardRedemptionTargetStatus } from '../../interfaces/endpoints/channelPoints.external.js';
+import type { HelixUser } from '../user/HelixUser.js';
+import type { HelixCustomReward } from './HelixCustomReward.js';
+/**
+ * A redemption of a custom Channel Points reward.
+ */
+export declare class HelixCustomRewardRedemption extends DataObject<HelixCustomRewardRedemptionData> {
+    /**
+     * The ID of the redemption.
+     */
+    get id(): string;
+    /**
+     * The ID of the broadcaster where the reward was redeemed.
+     */
+    get broadcasterId(): string;
+    /**
+     * The name of the broadcaster where the reward was redeemed.
+     */
+    get broadcasterName(): string;
+    /**
+     * The display name of the broadcaster where the reward was redeemed.
+     */
+    get broadcasterDisplayName(): string;
+    /**
+     * Gets more information about the broadcaster where the reward was redeemed.
+     */
+    getBroadcaster(): Promise<HelixUser>;
+    /**
+     * The ID of the user that redeemed the reward.
+     */
+    get userId(): string;
+    /**
+     * The name of the user that redeemed the reward.
+     */
+    get userName(): string;
+    /**
+     * The display name of the user that redeemed the reward.
+     */
+    get userDisplayName(): string;
+    /**
+     * Gets more information about the user that redeemed the reward.
+     */
+    getUser(): Promise<HelixUser>;
+    /**
+     * The text the user wrote when redeeming the reward.
+     */
+    get userInput(): string;
+    /**
+     * Whether the redemption was fulfilled.
+     */
+    get isFulfilled(): boolean;
+    /**
+     * Whether the redemption was canceled.
+     */
+    get isCanceled(): boolean;
+    /**
+     * The date and time when the reward was redeemed.
+     */
+    get redemptionDate(): Date;
+    /**
+     * The ID of the reward that was redeemed.
+     */
+    get rewardId(): string;
+    /**
+     * The title of the reward that was redeemed.
+     */
+    get rewardTitle(): string;
+    /**
+     * The prompt of the reward that was redeemed.
+     */
+    get rewardPrompt(): string;
+    /**
+     * The cost of the reward that was redeemed.
+     */
+    get rewardCost(): number;
+    /**
+     * Gets more information about the reward that was redeemed.
+     */
+    getReward(): Promise<HelixCustomReward>;
+    /**
+     * Updates the redemption's status.
+     *
+     * @param newStatus The status the redemption should have.
+     */
+    updateStatus(newStatus: HelixCustomRewardRedemptionTargetStatus): Promise<HelixCustomRewardRedemption>;
+}
+//# sourceMappingURL=HelixCustomRewardRedemption.d.ts.map

package/node_modules/@twurple/api/lib/endpoints/channelPoints/HelixCustomRewardRedemption.js

@@ -0,0 +1,138 @@
+import { __decorate } from "tslib";
+import { Enumerable } from '@d-fischer/shared-utils';
+import { checkRelationAssertion, DataObject, rawDataSymbol, rtfm } from '@twurple/common';
+/**
+ * A redemption of a custom Channel Points reward.
+ */
+let HelixCustomRewardRedemption = class HelixCustomRewardRedemption extends DataObject {
+    /** @internal */ _client;
+    /** @internal */
+    constructor(data, client) {
+        super(data);
+        this._client = client;
+    }
+    /**
+     * The ID of the redemption.
+     */
+    get id() {
+        return this[rawDataSymbol].id;
+    }
+    /**
+     * The ID of the broadcaster where the reward was redeemed.
+     */
+    get broadcasterId() {
+        return this[rawDataSymbol].broadcaster_id;
+    }
+    /**
+     * The name of the broadcaster where the reward was redeemed.
+     */
+    get broadcasterName() {
+        return this[rawDataSymbol].broadcaster_login;
+    }
+    /**
+     * The display name of the broadcaster where the reward was redeemed.
+     */
+    get broadcasterDisplayName() {
+        return this[rawDataSymbol].broadcaster_name;
+    }
+    /**
+     * Gets more information about the broadcaster where the reward was redeemed.
+     */
+    async getBroadcaster() {
+        return checkRelationAssertion(await this._client.users.getUserById(this[rawDataSymbol].broadcaster_id));
+    }
+    /**
+     * The ID of the user that redeemed the reward.
+     */
+    get userId() {
+        return this[rawDataSymbol].user_id;
+    }
+    /**
+     * The name of the user that redeemed the reward.
+     */
+    get userName() {
+        return this[rawDataSymbol].user_login;
+    }
+    /**
+     * The display name of the user that redeemed the reward.
+     */
+    get userDisplayName() {
+        return this[rawDataSymbol].user_name;
+    }
+    /**
+     * Gets more information about the user that redeemed the reward.
+     */
+    async getUser() {
+        return checkRelationAssertion(await this._client.users.getUserById(this[rawDataSymbol].user_id));
+    }
+    /**
+     * The text the user wrote when redeeming the reward.
+     */
+    get userInput() {
+        return this[rawDataSymbol].user_input;
+    }
+    /**
+     * Whether the redemption was fulfilled.
+     */
+    get isFulfilled() {
+        return this[rawDataSymbol].status === 'FULFILLED';
+    }
+    /**
+     * Whether the redemption was canceled.
+     */
+    get isCanceled() {
+        return this[rawDataSymbol].status === 'CANCELED';
+    }
+    /**
+     * The date and time when the reward was redeemed.
+     */
+    get redemptionDate() {
+        return new Date(this[rawDataSymbol].redeemed_at);
+    }
+    /**
+     * The ID of the reward that was redeemed.
+     */
+    get rewardId() {
+        return this[rawDataSymbol].reward.id;
+    }
+    /**
+     * The title of the reward that was redeemed.
+     */
+    get rewardTitle() {
+        return this[rawDataSymbol].reward.title;
+    }
+    /**
+     * The prompt of the reward that was redeemed.
+     */
+    get rewardPrompt() {
+        return this[rawDataSymbol].reward.prompt;
+    }
+    /**
+     * The cost of the reward that was redeemed.
+     */
+    get rewardCost() {
+        return this[rawDataSymbol].reward.cost;
+    }
+    /**
+     * Gets more information about the reward that was redeemed.
+     */
+    async getReward() {
+        return checkRelationAssertion(await this._client.channelPoints.getCustomRewardById(this[rawDataSymbol].broadcaster_id, this[rawDataSymbol].reward.id));
+    }
+    /**
+     * Updates the redemption's status.
+     *
+     * @param newStatus The status the redemption should have.
+     */
+    async updateStatus(newStatus) {
+        const result = await this._client.channelPoints.updateRedemptionStatusByIds(this[rawDataSymbol].broadcaster_id, this[rawDataSymbol].reward.id, [this[rawDataSymbol].id], newStatus);
+        return result[0];
+    }
+};
+__decorate([
+    Enumerable(false)
+], HelixCustomRewardRedemption.prototype, "_client", void 0);
+HelixCustomRewardRedemption = __decorate([
+    rtfm('api', 'HelixCustomRewardRedemption', 'id')
+], HelixCustomRewardRedemption);
+export { HelixCustomRewardRedemption };

package/node_modules/@twurple/api/lib/endpoints/charity/HelixCharityApi.d.ts

@@ -0,0 +1,39 @@
+import { type UserIdResolvable } from '@twurple/common';
+import { type HelixPaginatedResult } from '../../utils/pagination/HelixPaginatedResult.js';
+import { type HelixForwardPagination } from '../../utils/pagination/HelixPagination.js';
+import { BaseApi } from '../BaseApi.js';
+import { HelixCharityCampaign } from './HelixCharityCampaign.js';
+import { HelixCharityCampaignDonation } from './HelixCharityCampaignDonation.js';
+/**
+ * The Helix API methods that deal with charity campaigns.
+ *
+ * Can be accessed using `client.charity` on an {@link ApiClient} instance.
+ *
+ * ## Example
+ * ```ts
+ * const api = new ApiClient({ authProvider });
+ * const charityCampaign = await api.charity.getCharityCampaign('125328655');
+ * ```
+ *
+ * @meta category helix
+ * @meta categorizedTitle Charity Campaigns
+ */
+export declare class HelixCharityApi extends BaseApi {
+    /**
+     * Gets information about the charity campaign that a broadcaster is running.
+     * Returns null if the specified broadcaster has no active charity campaign.
+     *
+     * @param broadcaster The broadcaster to get charity campaign information about.
+     */
+    getCharityCampaign(broadcaster: UserIdResolvable): Promise<HelixCharityCampaign>;
+    /**
+     * Gets the list of donations that users have made to the broadcaster’s active charity campaign.
+     *
+     * @param broadcaster The broadcaster to get charity campaign donation information about.
+     * @param pagination
+     *
+     * @expandParams
+     */
+    getCharityCampaignDonations(broadcaster: UserIdResolvable, pagination?: HelixForwardPagination): Promise<HelixPaginatedResult<HelixCharityCampaignDonation>>;
+}
+//# sourceMappingURL=HelixCharityApi.d.ts.map

package/node_modules/@twurple/api/lib/endpoints/charity/HelixCharityApi.js

@@ -0,0 +1,66 @@
+import { __decorate } from "tslib";
+import { createBroadcasterQuery } from '@twurple/api-call';
+import { extractUserId, rtfm } from '@twurple/common';
+import { createPaginatedResult } from '../../utils/pagination/HelixPaginatedResult.js';
+import { createPaginationQuery } from '../../utils/pagination/HelixPagination.js';
+import { BaseApi } from '../BaseApi.js';
+import { HelixCharityCampaign } from './HelixCharityCampaign.js';
+import { HelixCharityCampaignDonation } from './HelixCharityCampaignDonation.js';
+/**
+ * The Helix API methods that deal with charity campaigns.
+ *
+ * Can be accessed using `client.charity` on an {@link ApiClient} instance.
+ *
+ * ## Example
+ * ```ts
+ * const api = new ApiClient({ authProvider });
+ * const charityCampaign = await api.charity.getCharityCampaign('125328655');
+ * ```
+ *
+ * @meta category helix
+ * @meta categorizedTitle Charity Campaigns
+ */
+let HelixCharityApi = class HelixCharityApi extends BaseApi {
+    /**
+     * Gets information about the charity campaign that a broadcaster is running.
+     * Returns null if the specified broadcaster has no active charity campaign.
+     *
+     * @param broadcaster The broadcaster to get charity campaign information about.
+     */
+    async getCharityCampaign(broadcaster) {
+        const response = await this._client.callApi({
+            type: 'helix',
+            url: 'charity/campaigns',
+            method: 'GET',
+            userId: extractUserId(broadcaster),
+            scopes: ['channel:read:charity'],
+            query: createBroadcasterQuery(broadcaster),
+        });
+        return new HelixCharityCampaign(response.data[0], this._client);
+    }
+    /**
+     * Gets the list of donations that users have made to the broadcaster’s active charity campaign.
+     *
+     * @param broadcaster The broadcaster to get charity campaign donation information about.
+     * @param pagination
+     *
+     * @expandParams
+     */
+    async getCharityCampaignDonations(broadcaster, pagination) {
+        const response = await this._client.callApi({
+            type: 'helix',
+            url: 'charity/donations',
+            userId: extractUserId(broadcaster),
+            scopes: ['channel:read:charity'],
+            query: {
+                ...createBroadcasterQuery(broadcaster),
+                ...createPaginationQuery(pagination),
+            },
+        });
+        return createPaginatedResult(response, HelixCharityCampaignDonation, this._client);
+    }
+};
+HelixCharityApi = __decorate([
+    rtfm('api', 'HelixCharityApi')
+], HelixCharityApi);
+export { HelixCharityApi };

package/node_modules/@twurple/api/lib/endpoints/charity/HelixCharityCampaign.d.ts

@@ -0,0 +1,54 @@
+import { DataObject } from '@twurple/common';
+import { type HelixCharityCampaignData } from '../../interfaces/endpoints/charity.external.js';
+import type { HelixUser } from '../user/HelixUser.js';
+import { HelixCharityCampaignAmount } from './HelixCharityCampaignAmount.js';
+/**
+ * A charity campaign in a Twitch channel.
+ */
+export declare class HelixCharityCampaign extends DataObject<HelixCharityCampaignData> {
+    /**
+     * An ID that identifies the charity campaign.
+     */
+    get id(): string;
+    /**
+     * The ID of the broadcaster.
+     */
+    get broadcasterId(): string;
+    /**
+     * The name of the broadcaster.
+     */
+    get broadcasterName(): string;
+    /**
+     * The display name of the broadcaster.
+     */
+    get broadcasterDisplayName(): string;
+    /**
+     * Gets more information about the broadcaster.
+     */
+    getBroadcaster(): Promise<HelixUser>;
+    /**
+     * The name of the charity.
+     */
+    get charityName(): string;
+    /**
+     * A description of the charity.
+     */
+    get charityDescription(): string;
+    /**
+     * A URL to an image of the charity's logo. The image’s type is PNG and its size is 100px X 100px.
+     */
+    get charityLogo(): string;
+    /**
+     * A URL to the charity’s website.
+     */
+    get charityWebsite(): string;
+    /**
+     * An object that contains the current amount of donations that the campaign has received.
+     */
+    get currentAmount(): HelixCharityCampaignAmount;
+    /**
+     * An object that contains the campaign’s target fundraising goal.
+     */
+    get targetAmount(): HelixCharityCampaignAmount;
+}
+//# sourceMappingURL=HelixCharityCampaign.d.ts.map