adds MsgParamOriginId to GiftedSubscription model (#267)

* GiftedSubscription: add MsgParamOriginId support for tracking messages related to bulk sub gifting
TwitchLib · Sep 6, 2024 · 5ef35d5 · 5ef35d5
1 parent 5677f50
commit 5ef35d5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/TwitchLib.Client.Models/GiftedSubscription.cs b/TwitchLib.Client.Models/GiftedSubscription.cs
@@ -17,6 +17,11 @@ public class GiftedSubscription : UserNoticeBase
     /// </summary>
     public string MsgParamMonths { get; protected set; } = default!;
 
+    /// <summary>
+    /// If this message sourced from an event, this is the ID of that event
+    /// </summary>
+    public string MsgParamOriginId { get; protected set; }
+
     /// <summary>
     /// The display name of the subscription gift recipient.
     /// </summary>
@@ -78,6 +83,7 @@ public GiftedSubscription(
         Dictionary<string, string>? undocumentedTags,
         Goal? msgParamGoal,
         string msgParamMonths,
+        string msgParamOriginId,
         string msgParamRecipientDisplayName,
         string msgParamRecipientId,
         string msgParamRecipientUserName, 
@@ -104,6 +110,7 @@ public GiftedSubscription(
         MsgParamGoal = msgParamGoal;
         IsAnonymous = userId == AnonymousGifterUserId;
         MsgParamMonths = msgParamMonths;
+        MsgParamOriginId = msgParamOriginId;
         MsgParamRecipientDisplayName = msgParamRecipientDisplayName;
         MsgParamRecipientId = msgParamRecipientId;
         MsgParamRecipientUserName = msgParamRecipientUserName;
@@ -121,6 +128,9 @@ protected override bool TrySet(KeyValuePair<string, string> tag)
             case Tags.MsgParamMonths:
                 MsgParamMonths = tag.Value;
                 break;
+            case Tags.MsgParamOriginId:
+                MsgParamOriginId = tag.Value;
+                break;
             case Tags.MsgParamRecipientDisplayName:
                 MsgParamRecipientDisplayName = tag.Value;
                 break;

diff --git a/TwitchLib.Client.Models/Internal/Tags.cs b/TwitchLib.Client.Models/Internal/Tags.cs
@@ -47,6 +47,7 @@ public static class Tags
         public const string MsgParamSubPlan = "msg-param-sub-plan";                             // Sent only on sub, resub, subgift, anonsubgift
         public const string MsgParamSubPlanName = "msg-param-sub-plan-name";                    // Sent only on sub, resub, subgift, anonsubgift
         public const string MsgParamViewerCount = "msg-param-viewerCount";                      // Sent only on raid
+        public const string MsgParamOriginId = "msg-param-origin-id";
         public const string MsgParamRecipientDisplayName = "msg-param-recipient-display-name";  // Sent only on subgift, anonsubgift
         public const string MsgParamRecipientId = "msg-param-recipient-id";                     // Sent only on subgift, anonsubgift
         public const string MsgParamRecipientUsername = "msg-param-recipient-user-name";        // Sent only on subgift, anonsubgift