HasChannelPointsMethods

trait Zairakai\LaravelTwitch\Services\Concerns\HasChannelPointsMethods

Twitch Channel Points API methods.

Source: src/Services/Concerns/HasChannelPointsMethods.php

Methods

createCustomReward()

public function createCustomReward(string $broadcasterId, CreateCustomRewardRequest $createCustomRewardRequest): CustomReward

Create a new custom reward for a broadcaster's channel.

deleteCustomReward()

public function deleteCustomReward(string $broadcasterId, string $rewardId): void

Delete a custom reward for a broadcaster's channel.

getCustomRewards()

public function getCustomRewards(string $broadcasterId, string|array|null $rewardIds = null, bool $onlyManageable = false): DataCollection

Get the list of custom rewards for a broadcaster's channel.

Parameter	Description
$rewardIds	Filter by reward ID(s)

Returns DataCollection<int, CustomReward>

getRedemptions()

public function getRedemptions(string $broadcasterId, string $rewardId, string $status = null, string|array|null $redemptionIds = null, int $first = 20, string $after = null): PaginatedResult

Get a list of redemptions for a custom reward.

Parameter	Description
$status	UNFULFILLED, FULFILLED, or CANCELED
$redemptionIds	Filter by specific redemption ID(s)

Returns PaginatedResult<Redemption>

updateCustomReward()

public function updateCustomReward(string $broadcasterId, string $rewardId, UpdateCustomRewardRequest $updateCustomRewardRequest): CustomReward

Update a custom reward for a broadcaster's channel.

updateRedemptionStatus()

public function updateRedemptionStatus(string $broadcasterId, string $rewardId, string|array $redemptionIds, string $status): DataCollection

Update the redemption status for one or more redemptions.

Parameter	Description
$redemptionIds	Redemption ID(s) to update
$status	FULFILLED or CANCELED

Returns DataCollection<int, Redemption>