Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: promote helix chat endpoints out of beta #615

Merged
merged 1 commit into from Jul 30, 2022
Merged

chore: promote helix chat endpoints out of beta #615

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 0 additions & 30 deletions rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java
View file
Open in desktop
Expand Up @@ -326,8 +326,6 @@ HystrixCommand<CustomRewardRedemptionList> updateRedemptionStatus(

/**
* Sends an announcement to the broadcaster’s chat room.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
*
* @param authToken User access token (scope: moderator:manage:announcements) of the broadcaster or a moderator.
* @param broadcasterId The ID of the broadcaster that owns the chat room to send the announcement to.
Expand All @@ -337,7 +335,6 @@ HystrixCommand<CustomRewardRedemptionList> updateRedemptionStatus(
* @return 204 No Content upon a successful call
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_CHAT_ANNOUNCEMENTS_MANAGE
*/
@Unofficial // beta
@RequestLine("POST /chat/announcements?broadcaster_id={broadcaster_id}&moderator_id={moderator_id}")
@Headers({
"Authorization: Bearer {token}",
Expand Down Expand Up @@ -381,15 +378,12 @@ HystrixCommand<ChatBadgeSetList> getGlobalChatBadges(

/**
* Gets the color used for the user’s name in chat.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
*
* @param authToken App access token or user access token.
* @param userIds The ID of the users whose color you want to get. Maximum: 100.
* @return UserChatColorList
* @see ChatUserColor#getColor()
*/
@Unofficial // beta
@RequestLine("GET /chat/color?user_id={user_id}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<UserChatColorList> getUserChatColor(
Expand All @@ -400,8 +394,6 @@ HystrixCommand<UserChatColorList> getUserChatColor(
/**
* Updates the color used for the user’s name in chat.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
* <p>
* All users may specify one of the following named color values in {@link NamedUserChatColor}.
* Turbo and Prime users may specify a named color or a Hex color code like #9146FF.
*
Expand All @@ -411,7 +403,6 @@ HystrixCommand<UserChatColorList> getUserChatColor(
* @return 204 No Content upon a successful call
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_USER_COLOR_MANAGE
*/
@Unofficial // beta
@RequestLine("PUT /chat/color?user_id={user_id}&color={color}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<Void> updateUserChatColor(
Expand Down Expand Up @@ -1119,8 +1110,6 @@ HystrixCommand<ChannelEditorList> getChannelEditors(

/**
* Gets a list of the channel’s VIPs.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
*
* @param authToken Broadcaster's user access token that includes the channel:read:vips scope.
* @param broadcasterId The ID of the broadcaster whose list of VIPs you want to get.
Expand All @@ -1130,7 +1119,6 @@ HystrixCommand<ChannelEditorList> getChannelEditors(
* @return ChannelVipList
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_CHANNEL_VIPS_READ
*/
@Unofficial // beta
@RequestLine("GET /channels/vips?broadcaster_id={broadcaster_id}&user_id={user_id}&first={first}&after={after}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<ChannelVipList> getChannelVips(
Expand All @@ -1143,16 +1131,13 @@ HystrixCommand<ChannelVipList> getChannelVips(

/**
* Adds a VIP to the broadcaster’s chat room.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
*
* @param authToken Broadcaster's user access token that includes the channel:manage:vips scope.
* @param broadcasterId The ID of the broadcaster that’s granting VIP status to the user.
* @param userId The ID of the user to add as a VIP in the broadcaster’s chat room.
* @return 204 No Content upon a successful call
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_CHANNEL_VIPS_MANAGE
*/
@Unofficial // beta
@RequestLine("POST /channels/vips?broadcaster_id={broadcaster_id}&user_id={user_id}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<Void> addChannelVip(
Expand All @@ -1163,16 +1148,13 @@ HystrixCommand<Void> addChannelVip(

/**
* Removes a VIP from the broadcaster’s chat room.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
*
* @param authToken Broadcaster's user access token that includes the channel:manage:vips scope.
* @param broadcasterId The ID of the broadcaster that’s removing VIP status from the user.
* @param userId The ID of the user to remove as a VIP from the broadcaster’s chat room.
* @return 204 No Content upon a successful call
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_CHANNEL_VIPS_MANAGE
*/
@Unofficial // beta
@RequestLine("DELETE /channels/vips?broadcaster_id={broadcaster_id}&user_id={user_id}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<Void> removeChannelVip(
Expand Down Expand Up @@ -1599,8 +1581,6 @@ HystrixCommand<Void> removeBlockedTerm(
/**
* Removes a single chat message or all chat messages from the broadcaster’s chat room.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
* <p>
* The ID in the moderator_id query parameter must match the user ID in the access token.
* If the broadcaster wants to remove messages themselves (instead of having the moderator do it), set this parameter to the broadcaster’s ID, too.
* <p>
Expand All @@ -1619,7 +1599,6 @@ HystrixCommand<Void> removeBlockedTerm(
* @return 204 No Content upon a successful call
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_CHAT_MESSAGES_MANAGE
*/
@Unofficial // beta
@RequestLine("DELETE /moderation/chat?broadcaster_id={broadcaster_id}&moderator_id={moderator_id}&message_id={message_id}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<Void> deleteChatMessages(
Expand Down Expand Up @@ -1670,16 +1649,13 @@ HystrixCommand<ModeratorList> getModerators(

/**
* Adds a moderator to the broadcaster’s chat room.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
*
* @param authToken Broadcaster's user access token that includes the channel:manage:moderators scope.
* @param broadcasterId The ID of the broadcaster that owns the chat room.
* @param userId The ID of the user to add as a moderator in the broadcaster’s chat room.
* @return 204 No Content upon a successful call
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_CHANNEL_MODS_MANAGE
*/
@Unofficial // beta
@RequestLine("POST /moderation/moderators?broadcaster_id={broadcaster_id}&user_id={user_id}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<Void> addChannelModerator(
Expand All @@ -1690,16 +1666,13 @@ HystrixCommand<Void> addChannelModerator(

/**
* Removes a moderator from the broadcaster’s chat room.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
*
* @param authToken Broadcaster's user access token that includes the channel:manage:moderators scope.
* @param broadcasterId The ID of the broadcaster that owns the chat room.
* @param userId The ID of the user to remove as a moderator from the broadcaster’s chat room.
* @return 204 No Content upon a successful call
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_CHANNEL_MODS_MANAGE
*/
@Unofficial // beta
@RequestLine("DELETE /moderation/moderators?broadcaster_id={broadcaster_id}&user_id={user_id}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<Void> removeChannelModerator(
Expand Down Expand Up @@ -2681,8 +2654,6 @@ HystrixCommand<Response> requestWebhookSubscription(
/**
* Sends a whisper message to the specified user.
* <p>
* This endpoint is in <a href="https://discuss.dev.twitch.tv/t/new-chat-and-role-management-api-endpoints-are-now-in-open-beta/39563">open beta</a>.
* <p>
* Note: The user sending the whisper must have a verified phone number.
* <p>
* Note: The API may silently drop whispers that it suspects of violating Twitch policies.
Expand All @@ -2709,7 +2680,6 @@ HystrixCommand<Response> requestWebhookSubscription(
* @return 204 No Content upon a successful call, even if the message was silently dropped
* @see com.github.twitch4j.auth.domain.TwitchScopes#HELIX_USER_WHISPERS_MANAGE
*/
@Unofficial // beta
@RequestLine("POST /whispers?from_user_id={from_user_id}&to_user_id={to_user_id}")
@Headers({
"Authorization: Bearer {token}",
Expand Down