Merge pull request #40 from AoshiW/nullable-and-props

better nullable annotation, add missing props

Author: Mahsaap

TwitchLib.EventSub.Core/Models/Charity/CharityBase.cs

@@ -22,7 +22,15 @@ public abstract class CharityBase
     /// </summary>
     public string CharityName { get; set; } = string.Empty;
     /// <summary>
+    /// A description of the charity.
+    /// </summary>
+    public string CharityDescription { get; set; } = string.Empty;
+    /// <summary>
     /// A URL to the charity’s logo.
     /// </summary>
     public string CharityLogo { get; set; } = string.Empty;
+    /// <summary>
+    /// A URL to the charity’s website.
+    /// </summary>
+    public string CharityWebsite { get; set; } = string.Empty;
 }

TwitchLib.EventSub.Core/Models/Chat/ChatCommunitySubGift.cs

@@ -10,6 +10,10 @@ public sealed class ChatCommunitySubGift
     /// </summary>
     public string Id { get; set; } = string.Empty;
     /// <summary>
+    /// Number of subscriptions being gifted.
+    /// </summary>
+    public int Total { get; set; }
+    /// <summary>
     /// The type of subscription plan being used. Possible values are:
     /// <para>1000 — First level of paid subscription</para>
     /// <para>2000 — Second level of paid subscription</para>

TwitchLib.EventSub.Core/Models/Chat/ChatGiftPaidUpgrade.cs

@@ -1,4 +1,6 @@
-namespace TwitchLib.EventSub.Core.Models.Chat;
+using System.Diagnostics.CodeAnalysis;
+
+namespace TwitchLib.EventSub.Core.Models.Chat;
 
 /// <summary>
 /// Information about the community gift paid upgrade event. Null if notice_type is not gift_paid_upgrade.
@@ -8,6 +10,9 @@ public sealed class ChatGiftPaidUpgrade
     /// <summary>
     /// Whether the gift was given anonymously.
     /// </summary>
+#if !NETSTANDARD
+    [MemberNotNullWhen(false, nameof(GifterUserId), nameof(GifterUserLogin), nameof(GifterUserName))]
+#endif
     public bool GifterIsAnonymous { get; set; }
     /// <summary>
     /// Optional. The user ID of the user who gifted the subscription. Null if anonymous.

TwitchLib.EventSub.Core/Models/Chat/ChatPayItForward.cs

@@ -1,4 +1,6 @@
-namespace TwitchLib.EventSub.Core.Models.Chat;
+using System.Diagnostics.CodeAnalysis;
+
+namespace TwitchLib.EventSub.Core.Models.Chat;
 
 /// <summary>
 /// Information about the pay it forward event. Null if notice_type is not pay_it_forward.
@@ -20,6 +22,9 @@ public sealed class ChatPayItForward
     /// <summary>
     /// Whether the gift was given anonymously.
     /// </summary>
+#if !NETSTANDARD
+    [MemberNotNullWhen(false, nameof(GifterUserId), nameof(GifterUserLogin), nameof(GifterUserName))]
+#endif
     public bool GifterIsAnonymous { get; set; }
     /// <summary>
     /// Optional. The user ID of the user who gifted the subscription. Null if anonymous.

TwitchLib.EventSub.Core/Models/HypeTrain/HypeTrainBase.cs

@@ -39,4 +39,8 @@ public class HypeTrainBase
     /// The current level of the Hype Train.
     /// </summary>
     public int Level { get; set; }
+    /// <summary>
+    /// Indicates if the Hype Train is a Golden Kappa Train.
+    /// </summary>
+    public bool IsGoldenKappaTrain { get; set; }
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelBan.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
@@ -60,5 +61,8 @@ public sealed class ChannelBan
     /// <summary>
     /// Indicates whether the ban is permanent (true) or a timeout (false). If true, EndsAt will be null.
     /// </summary>
+#if !NETSTANDARD
+    [MemberNotNullWhen(false, nameof(EndsAt))]
+#endif
     public bool IsPermanent { get; set; }
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelCharityCampaignDonate.cs

@@ -1,4 +1,5 @@
-using TwitchLib.EventSub.Core.Models.Charity;
+using System;
+using TwitchLib.EventSub.Core.Models.Charity;
 
 namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
@@ -9,6 +10,10 @@ namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 /// </summary>
 public sealed class ChannelCharityCampaignDonate : CharityBase
 {
+    /// <summary>
+    /// An ID that identifies the donation. The ID is unique across campaigns.
+    /// </summary>
+    public string Id { get; set; } = string.Empty;
     /// <summary>
     /// An ID that uniquely identifies the charity campaign.
     /// </summary>
@@ -34,5 +39,6 @@ public sealed class ChannelCharityCampaignDonate : CharityBase
     /// <summary>
     /// The ISO-4217 three-letter currency code that identifies the type of currency in value.
     /// </summary>
+    [Obsolete("This property is a typo, please use: Amount.Currency")]
     public string Currency { get; set; } = string.Empty;
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelCharityCampaignStart.cs

@@ -16,10 +16,6 @@ public sealed class ChannelCharityCampaignStart : CharityBase
     /// </summary>
     public string Id { get; set; } = string.Empty;
     /// <summary>
-    /// A URL to the charity’s website.
-    /// </summary>
-    public string CharityWebsite { get; set; } = string.Empty;
-    /// <summary>
     /// An object that contains the current amount of donations that the campaign has received.
     /// </summary>
     public CharityAmount CurrentAmount { get; set; } = new();

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelCharityCampaignStop.cs

@@ -29,6 +29,18 @@ public sealed class ChannelCharityCampaignStop
     /// </summary>
     public string BroadcasterName { get; set; } = string.Empty;
     /// <summary>
+    /// A description of the charity.
+    /// </summary>
+    public string CharityDescription { get; set; } = string.Empty;
+    /// <summary>
+    /// A URL to an image of the charity’s logo. The image’s type is PNG and its size is 100px X 100px.
+    /// </summary>
+    public string CharityLogo { get; set; } = string.Empty;
+    /// <summary>
+    /// A URL to the charity’s website.
+    /// </summary>
+    public string CharityWebsite { get; set; } = string.Empty;
+    /// <summary>
     /// An object that contains the final amount of donations that the campaign received.
     /// </summary>
     public CharityAmount CurrentAmount { get; set; } = new();

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelCheer.cs

@@ -1,4 +1,6 @@
-namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using System.Diagnostics.CodeAnalysis;
+
+namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
 /// <summary>
 /// Channel Cheer subscription type model
@@ -10,6 +12,9 @@ public sealed class ChannelCheer
     /// <summary>
     /// Whether the user cheered anonymously or not.
     /// </summary>
+#if !NETSTANDARD
+    [MemberNotNullWhen(false, nameof(UserId), nameof(UserLogin), nameof(UserName))]
+#endif
     public bool IsAnonymous { get; set; }
     /// <summary>
     /// The user ID for the user who cheered on the specified channel. This is null if is_anonymous is true.

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelGuestStarGuestUpdate.cs

@@ -9,6 +9,18 @@ namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 /// </summary>
 public sealed class ChannelGuestStarGuestUpdate : ChannelGuestStarBase
 {
+    /// <summary>
+    /// User ID of the host channel.
+    /// </summary>
+    public string HostUserId { get; set; }
+    /// <summary>
+    /// The host display name.
+    /// </summary>
+    public string HostUserName { get; set; }
+    /// <summary>
+    /// The host login.
+    /// </summary>
+    public string HostUserLogin { get; set; }
     /// <summary>
     /// The current state of the user after the update has taken place. Can be one of the following:
     /// <para>

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelGuestStarSessionEnd.cs

@@ -18,4 +18,16 @@ public sealed class ChannelGuestStarSessionEnd : ChannelGuestStarSessionBase
     /// RFC3339 timestamp indicating the time the session ended.
     /// </summary>
     public DateTimeOffset EndedAt { get; set; }
+    /// <summary>
+    /// User ID of the host channel.
+    /// </summary>
+    public string HostUserId { get; set; }
+    /// <summary>
+    /// The host display name.
+    /// </summary>
+    public string HostUserName { get; set; }
+    /// <summary>
+    /// The host login.
+    /// </summary>
+    public string HostUserLogin { get; set; }
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelGuestStarSlotUpdate.cs

@@ -1,3 +1,4 @@
+using System;
 using TwitchLib.EventSub.Core.Models.GuestStar;
 
 namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel
@@ -7,6 +8,7 @@ namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel
     /// <para>Description:</para>
     /// <para>The channel.guest_star_slot.update subscription type sends a notification when a slot setting is updated in an active Guest Star session.</para>
     /// </summary>
+    [Obsolete("Removed 2023‑08‑24")]
     public class ChannelGuestStarSlotUpdate : ChannelGuestStarBase
     {
         /// <summary>

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelShieldModeEnd.cs

@@ -13,5 +13,10 @@ public sealed class ChannelShieldModeEnd : ShieldModeBase
     /// <summary>
     /// The UTC timestamp (in RFC3339 format) of when the moderator deactivated Shield Mode.
     /// </summary>
+    [Obsolete("This property is a typo, please use: EndedAt")]
     public DateTimeOffset StartedAt { get; set; } = DateTimeOffset.MinValue;
+    /// <summary>
+    /// The UTC timestamp (in RFC3339 format) of when the moderator deactivated Shield Mode.
+    /// </summary>
+    public DateTimeOffset EndedAt { get; set; } = DateTimeOffset.MinValue;
 }

TwitchLib.EventSub.Core/SubscriptionTypes/Channel/ChannelSubscriptionGift.cs

@@ -1,4 +1,6 @@
-namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
+using System.Diagnostics.CodeAnalysis;
+
+namespace TwitchLib.EventSub.Core.SubscriptionTypes.Channel;
 
 /// <summary>
 /// Channel Subscription Gift subscription type model
@@ -10,15 +12,15 @@ public sealed class ChannelSubscriptionGift
     /// <summary>
     /// The user ID of the user who sent the subscription gift. Set to null if it was an anonymous subscription gift.
     /// </summary>
-    public string UserId { get; set; } = string.Empty;
+    public string? UserId { get; set; } = string.Empty;
     /// <summary>
     /// The user display name of the user who sent the gift. Set to null if it was an anonymous subscription gift.
     /// </summary>
-    public string UserName { get; set; } = string.Empty;
+    public string? UserName { get; set; } = string.Empty;
     /// <summary>
     /// The user login of the user who sent the gift. Set to null if it was an anonymous subscription gift.
     /// </summary>
-    public string UserLogin { get; set; } = string.Empty;
+    public string? UserLogin { get; set; } = string.Empty;
     /// <summary>
     /// The broadcaster user ID.
     /// </summary>
@@ -46,5 +48,8 @@ public sealed class ChannelSubscriptionGift
     /// <summary>
     /// Whether the subscription gift was anonymous.
     /// </summary>
+#if !NETSTANDARD
+    [MemberNotNullWhen(false, nameof(UserId), nameof(UserLogin), nameof(UserName))]
+#endif
     public bool IsAnonymous { get; set; }
 }