v7.2.0: Endpoint Coverage

Changes

• Promoted EventSubApi -> subscribeToChannelShieldMode to version 1
• Promoted EventSubApi -> subscribeToChannelFollow to version 2
• Promoted EventSubApi -> subscribeToChannelCharityCampaign to version 1
• Resolved error in EventSubApi -> drop.entitlement.grant by adding required parameter of is_batching_enabled (@alexschastny)

New Features

• Added ChatApi -> sendShoutout
• Added EventSubApi -> subscribeToChannelShoutout
• Added ChannelsApi -> getFollowedChannels
• Added ChannelsApi -> getChannelFollowers
• Added GoalsApi
• Added GoalsApi -> getGoals (Thanks @radiojoe!)
• Added fulfillmentStatus parameter to EntitlementsApi -> getDropsEntitlements (Thanks @alexschastny!)

v7.1.0: Endpoint Coverage

New Features

• Added CharityApi
• Added CharityApi -> getCharityCampaign
• Added CharityApi -> getCharityCampaignDonations
• Added ModerationApi -> getShieldModeStatus
• Added ModerationApi -> updateShieldModeStatus
• Added ChatApi -> getChatters
• Added EventSub -> channel.charity_campaign.start
• Added EventSub -> channel.charity_campaign.progress
• Added EventSub -> channel.charity_campaign.stop
• Added EventSub -> channel.charity_campaign.donate
• Added EventSub -> channel.shield_mode.begin
• Added EventSub -> channel.shield_mode.end

v7.0.1

Changes

• updateDropEntitlements now allows you to specify no parameters, in line with the API Docs
• Added Missing Testing Coverage for many older functions

New Features

• Added first parameter to getBannedUsers
• Added first parameter to getModerators
• Added EventSub -> drop.entitlement.grant

Pull Request

• Finish Endpoint and Testing Coverage by @Brandin in #143

Full Changelog: v7.0.0...v7.0.1

v7.0.0: Endpoint Coverage Update

This update completes a large amount of endpoint coverage including most of the endpoints released in 2022. A number of changes have occurred to functions that were not working and some changes that happened in the Twitch API itself. Please be sure to review the breaking changes and the other release notes below.

Breaking Changes

• Removed getBannedEvents and getModeratorEvents - Announcement
• Removed id parameter from getHypeTrainEvents (this function was broken anyways) - Announcement
• Removed user_id parameter from checkAutoModStatus - Announcement

Changes

• Promoted EventSub -> extension.bits_transaction.crate to version 1

New Features

• Added user_id parameter to getEventSubSubscription
• Added ChatApi -> getChatSettings
• Added ChatApi -> updateChatSettings
• Added ChatApi -> sendChatAnnouncement
• Added ChatApi -> getUserChatColor
• Added ChatApi -> updateUserChatColor
• Added EventSub -> user.authorization.grant
• Added EventSub -> channel.goal.begin
• Added EventSub -> channel.goal.progress
• Added EventSub -> channel.goal.end
• Added ModerationApi -> banUser
• Added ModerationApi -> unbanUser
• Added ModerationApi -> getAutoModSettings
• Added ModerationApi -> updateAutoModSettings
• Added ModerationApi -> getBlockedTerms
• Added ModerationApi -> addBlockedTerm
• Added ModerationApi -> removeBlockedTerm
• Added ModerationApi -> deleteChatMessages
• Added ModerationApi -> addChannelModerator
• Added ModerationApi -> removeChannelModerator
• Added ModerationApi -> getVips
• Added ModerationApi -> addChannelVip
• Added ModerationApi -> removeChannelVip
• Added RaidsApi
• Added RaidsApi -> startRaid
• Added RaidsApi -> cancelRaid
• Added WhispersApi
• Added WhispersApi -> sendWhisper

Pull Request

• v7.0.0: Endpoint Coverage by @Brandin in #142

Full Changelog: v6.1.0...v7.0.0

v6.1.0

NEW FEATURES

• Add Update Drops Entitlements endpoint #138

v6.0.0: Drop v5 Support, Rename Namespace, Endpoint Drops

KRAKEN SUPPORT HAS BEEN REMOVED FROM THIS LIBRARY AS OF VERSION 6

The V5 API (Kraken) was considered legacy for some time now, and as of July 15, 2021, began a gradual shutdown. If you have not accessed v5 before this date, you can no longer access that API. For those who are continuing to use it until February 2022, you should remain on a lower version of this library, however we would encourage you to upgrade to a compatible endpoint. Read more here.

Helix Namespace and Classes Changed from NewTwitchApi to TwitchApi

We've updated the name of the namespace to be consistent with the language from Twitch, which is Twitch API. We've added some code that will remain in for the current future that allows continued calls to the NewTwitchApi Namespace and Classes. You should begin using the new classes ASAP by updating your code. Any time you have been individually initializing classes instead of using our helper functions you will begin to receive errors until you update your namespace and classes. You can review the Getting Started section of the README for more information.

If you were previously using:

$helixGuzzleClient = new \NewTwitchApi\HelixGuzzleClient($twitch_client_id);
$newTwitchApi = new \NewTwitchApi\NewTwitchApi($helixGuzzleClient, $twitch_client_id, $twitch_client_secret);

You should change this code to:

$helixGuzzleClient = new \TwitchApi\HelixGuzzleClient($twitch_client_id);
$twitchApi = new \TwitchApi\TwitchApi($helixGuzzleClient, $twitch_client_id, $twitch_client_secret);

Not changing this code will not break your project at this time but in the future, when the legacy classes are removed, your project will begin to throw errors. No timeline has been announced for this yet.

BREAKING CHANGES

• Drop v5 Support
• Rename Namespace for Helix from NewTwitchApi to TwitchApi
• Rename NewTwitchApi Class to TwitchApi
• Removed createUserFollow and deleteUserFollow from UsersApi (Twitch Announcement)

MAINTENANCE

• Added NewTwitchApi\NewTwitchApi Class that extends TwitchApi\TwitchApi for backwards compatibility
• Added NewTwitchApi\HelixGuzzleClient Class that extends TwitchApi\HelixGuzzleClient for backwards compatibility

v5.0.5: Schedules API

NEW FEATURES

• Added ScheduleApi
• Added ScheduleApi -> getChannelStreamSchedule
• Added ScheduleApi -> getChanneliCalendar (optional auth)
• Added ScheduleApi -> updateChannelStreamSchedule
• Added ScheduleApi -> createChannelStreamScheduleSegment
• Added ScheduleApi -> updateChannelStreamScheduleSegment
• Added ScheduleApi -> deleteChannelStreamScheduleSegment
• Added EventSub->subscribeToChannelSubscriptionMessage

CORE

• Allow Optional Auth in Request Generator
• Cleanup Headers in Request Generator
• Added getApiWithOptionalAuth for explicit calls with optional authentication (since all endpoints but 1 require auth at this time)

v5.0.3: Emotes Endpoints

NEW FEATURES

• Added ChatApi->GetChannelEmotes
• Added ChatApi->GetGlobalEmotes
• Added ChatApi->GetEmotesSet

v5.0.2: Hotfix for Version 5

This release fixes some issues we introduced in v5.0 when we stopped extending the Guzzle Client.

BREAKING

• Stop testing Webhook Subscriptions API (it is broken in the library, use EventSub instead per Twitch's recommendation)

CORE

• Convert HelixGuzzleClient to be a Guzzle Middleware
• Adjusted all calls for Guzzle\Client to HelixGuzzleClient

v5.0.1: Chat API & More

BREAKING

• Promote ChannelSubscriptionEnd from beta to v1 (renamed from ChannelUnsubscribe)

NEW FEATURES

• Add channel.subscription.gift to EventSub (beta)
• Add ChatApi
• Add ChatApi->getChannelChatBadges
• Add ChatApi->getGlobalChatBadges