Merge pull request #8 from TheStaticMage/kicks-gifted

Add Kicks gifted payload

Author: fb-sean

payloads/v1/webhooks.ts

@@ -1,12 +1,13 @@
 import type {Emote} from './emote';
 
-export interface WebhookUser {
+/**
+ * Represents a user in the context of most of Kick's webhook events,
+ * specifically those that include the is_anonymous field.
+ *
+ * @see WebhookBaseUser
+ */
+export interface WebhookUser extends WebhookBaseUser {
     is_anonymous: boolean;
-    user_id?: number;
-    username?: string;
-    is_verified?: boolean;
-    profile_picture?: string;
-    channel_slug?: string;
 }
 
 export interface WebhookBadge {
@@ -15,6 +16,14 @@ export interface WebhookBadge {
     count?: number;
 }
 
+export interface WebhookBaseUser {
+    user_id?: number;
+    username?: string;
+    is_verified?: boolean;
+    profile_picture?: string;
+    channel_slug?: string;
+}
+
 export interface WebhookIdentity {
     username_color: string;
     badges: WebhookBadge[];
@@ -24,6 +33,14 @@ export interface WebhookUserWithIdentity extends WebhookUser {
     identity: WebhookIdentity;
 }
 
+/**
+ * Represents a user in the context of a "kicks gifted" webhook event. Kick's
+ * API does not provide the is_anonymous field that other webhook events have.
+ *
+ * @see WebhookBaseUser
+ */
+export interface KicksGiftedWebhookUser extends WebhookBaseUser {}
+
 export interface WebhookRepliesTo {
     message_id: string;
     content: string;
@@ -103,3 +120,18 @@ export interface ModerationBannedEvent {
     banned_user: WebhookUser;
     metadata: ModerationBannedEventMetadata;
 }
+
+export interface KicksGiftedEvent {
+    eventType: 'kicks.gifted';
+    eventVersion: '1';
+    broadcaster: KicksGiftedWebhookUser;
+    sender: KicksGiftedWebhookUser;
+    gift: {
+        amount: number;
+        name: string;
+        type: string;
+        tier: string;
+        message: string;
+    };
+    created_at: string;
+}