chore: deprecate poll bits due to twitch change (#634)

twitch4j · Sep 3, 2022 · b732834 · b732834
1 parent 7a41221
commit b732834
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 3 deletions.
diff --git a/eventsub-common/src/main/java/com/github/twitch4j/eventsub/domain/BitsVoting.java b/eventsub-common/src/main/java/com/github/twitch4j/eventsub/domain/BitsVoting.java
@@ -7,21 +7,25 @@
 import lombok.Setter;
 import lombok.experimental.Accessors;
 
+/**
+ * @deprecated Twitch no longer supports bits on polls.
+ */
 @Data
 @Setter(AccessLevel.PRIVATE)
 @NoArgsConstructor
+@Deprecated
 public class BitsVoting {
 
     /**
      * Indicates if Bits can be used for voting.
      */
     @Accessors(fluent = true)
     @JsonProperty("is_enabled")
-    private Boolean isEnabled;
+    private Boolean isEnabled = false;
 
     /**
      * Number of Bits required to vote once with Bits.
      */
-    private Integer amountPerVote;
+    private Integer amountPerVote = 0;
 
 }
diff --git a/eventsub-common/src/main/java/com/github/twitch4j/eventsub/domain/PollChoice.java b/eventsub-common/src/main/java/com/github/twitch4j/eventsub/domain/PollChoice.java
@@ -45,8 +45,11 @@ public class PollChoice {
 
     /**
      * Number of votes received via Bits.
+     *
+     * @deprecated Twitch no longer supports bits on polls.
      */
     @Nullable
+    @Deprecated
     private Integer bitsVotes;
 
 }
diff --git a/eventsub-common/src/main/java/com/github/twitch4j/eventsub/events/ChannelPollEvent.java b/eventsub-common/src/main/java/com/github/twitch4j/eventsub/events/ChannelPollEvent.java
@@ -39,7 +39,10 @@ public abstract class ChannelPollEvent extends EventSubChannelEvent {
 
     /**
      * The Bits voting settings for the poll.
+     *
+     * @deprecated Twitch no longer supports bits on polls.
      */
+    @Deprecated
     private BitsVoting bitsVoting;
 
     /**

diff --git a/pubsub/src/main/java/com/github/twitch4j/pubsub/domain/PollData.java b/pubsub/src/main/java/com/github/twitch4j/pubsub/domain/PollData.java
@@ -24,6 +24,7 @@ public class PollData {
     private Integer totalVoters;
     private Long remainingDurationMilliseconds;
     private Contributor topContributor;
+    @Deprecated
     private Contributor topBitsContributor;
     private Contributor topChannelPointsContributor;
 
@@ -32,6 +33,7 @@ public static class PollSettings {
         private Setting multiChoice;
         private Setting subscriberOnly;
         private Setting subscriberMultiplier;
+        @Deprecated
         private Setting bitsVotes;
         private Setting channelPointsVotes;
 
@@ -54,13 +56,15 @@ public static class PollChoice {
     @Data
     public static class Votes {
         private Long total;
+        @Deprecated
         private Long bits;
         private Long channelPoints;
         private Long base;
     }
 
     @Data
     public static class Tokens {
+        @Deprecated
         private Long bits;
         private Long channelPoints;
     }
@@ -69,6 +73,7 @@ public static class Tokens {
     public static class Contributor {
         private String userId;
         private String displayName;
+        @Deprecated
         private Long bitsContributed;
         private Long channelPointsContributed;
     }

diff --git a/rest-helix/src/main/java/com/github/twitch4j/helix/domain/Poll.java b/rest-helix/src/main/java/com/github/twitch4j/helix/domain/Poll.java
@@ -64,14 +64,20 @@ public class Poll {
 
     /**
      * Indicates whether Bits can be used for voting. Default: false.
+     *
+     * @deprecated Twitch no longer supports bits on polls.
      */
+    @Deprecated
     @Accessors(fluent = true)
     @JsonProperty("bits_voting_enabled")
-    private Boolean isBitsVotingEnabled;
+    private Boolean isBitsVotingEnabled = false;
 
     /**
      * Number of Bits required to vote once with Bits. Minimum: 0. Maximum: 10000.
+     *
+     * @deprecated Twitch no longer supports bits on polls.
      */
+    @Deprecated
     private Integer bitsPerVote;
 
     /**