Skip to content

v6.0.0: Drop v5 Support, Rename Namespace, Endpoint Drops
Compare
Choose a tag to compare
@Brandin Brandin released this 30 Jul 18:51
· 55 commits to master since this release
v6.0.0
1846cb2
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

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
Assets 2
Loading