Skip to content

Commit e3df123

Browse files
committed
Add first kwarg for get_redemption
Add first kwarg for get_redemption
1 parent 7a46bd1 commit e3df123

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

docs/changelog.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Massive documentation updates
1616
- Added :func:`User.fetch_goals` method
1717
- Added :func:`User.fetch_chat_settings` and :func:`User.update_chat_settings` methods
1818
- Added :func:`Client.part_channels` method
19+
- Added :func:`Client.event_channel_joined` event. This is dispatched when the bot joins a channel
20+
- Added first kwarg to CustomReward.get_redemption()
1921

2022
- ext.commands
2123
- :func:`Bot.handle_commands` now also invokes on threads / replies

twitchio/http.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -445,12 +445,12 @@ async def get_reward_redemptions(
445445
token: str,
446446
broadcaster_id: int,
447447
reward_id: str,
448-
redemption_id: str = None,
449-
status: str = None,
450-
sort: str = None,
448+
redemption_id: Optional[str] = None,
449+
status: Optional[str] = None,
450+
sort: str = "OLDEST",
451+
first: int = 20
451452
):
452-
params = [("broadcaster_id", str(broadcaster_id)), ("reward_id", reward_id)]
453-
453+
params = [("broadcaster_id", str(broadcaster_id)), ("reward_id", reward_id), ("first", first)]
454454
if redemption_id:
455455
params.append(("id", redemption_id))
456456
if status:

twitchio/rewards.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ async def delete(self, token: str):
224224
) from error
225225
raise
226226

227-
async def get_redemptions(self, token: str, status: str, sort: str = None):
227+
async def get_redemptions(self, token: str, status: str, sort: str = "OLDEST", first: int = 20):
228228
"""
229229
Gets redemptions for this reward
230230
@@ -235,11 +235,14 @@ async def get_redemptions(self, token: str, status: str, sort: str = None):
235235
status:
236236
:class:`str` one of UNFULFILLED, FULFILLED or CANCELED
237237
sort:
238-
:class:`str` the order redemptions are returned in. One of OLDEST, NEWEST. Default: OLDEST.
238+
Optional[:class:`str`] the order redemptions are returned in. One of OLDEST, NEWEST. Default: OLDEST.
239+
first:
240+
:class:`int` Number of results to be returned when getting the paginated Custom Reward Redemption objects for a reward.
241+
Limit: 50. Default: 20.
239242
"""
240243
try:
241244
data = await self._http.get_reward_redemptions(
242-
token, self._broadcaster_id, self.id, status=status, sort=sort
245+
token, self._broadcaster_id, self.id, status=status, sort=sort, first=first
243246
)
244247
except Unauthorized as error:
245248
raise Unauthorized("The given token is invalid", "", 401) from error

0 commit comments

Comments
 (0)