glitch-javascript-sdk 2.2.6 → 2.2.7

package/dist/esm/routes/TwitchReportingRoute.d.ts

@@ -0,0 +1,7 @@
+import Route from "./interface";
+declare class TwitchReportingRoute {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default TwitchReportingRoute;

package/dist/index.d.ts

@@ -6595,6 +6595,70 @@ declare class MarketingAgencies {
     }): AxiosPromise<Response<T>>;
 }
 
+declare class TwitchReporting {
+    /**
+     * Get a streamer's Concurrent Viewership (CCV) history.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getCreatorCcvHistory
+     *
+     * @param twitch_streamer_id The ID of the Twitch streamer.
+     * @param params Optional query parameters for filtering (e.g., start_date, end_date, per_page).
+     *
+     * @returns promise
+     */
+    static getCreatorCcvHistory<T>(twitch_streamer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a summary of game performance metrics.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getGamesSummary
+     *
+     * @param params Optional query parameters for filtering and sorting (e.g., start_date, end_date, sort_by, limit).
+     *
+     * @returns promise
+     */
+    static getGamesSummary<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get most recently active streamers.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getMostActiveStreamers
+     *
+     * @param params Optional query parameters (e.g., limit).
+     *
+     * @returns promise
+     */
+    static getMostActiveStreamers<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get most recently streamed games.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getMostActiveGames
+     *
+     * @param params Optional query parameters (e.g., limit).
+     *
+     * @returns promise
+     */
+    static getMostActiveGames<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get top streamers by performance (average or peak CCV).
+     *
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getTopStreamers
+     *
+     * @param params Optional query parameters for filtering and sorting (e.g., sort_by, start_date, limit).
+     *
+     * @returns promise
+     */
+    static getTopStreamers<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a streamer's typical streaming schedule as a heatmap.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getCreatorStreamingSchedule
+     *
+     * @param twitch_streamer_id The ID of the Twitch streamer.
+     *
+     * @returns promise
+     */
+    static getCreatorStreamingSchedule<T>(twitch_streamer_id: string): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -6941,6 +7005,7 @@ declare class Glitch {
         ShortLinks: typeof ShortLinks;
         AIUsage: typeof AIUsage;
         MarketingAgencies: typeof MarketingAgencies;
+        TwitchReporting: typeof TwitchReporting;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "2.2.6",
+  "version": "2.2.7",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/TwitchReporting.ts

@@ -0,0 +1,89 @@
+import TwitchReportingRoute from "../routes/TwitchReportingRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class TwitchReporting {
+
+    /**
+     * Get a streamer's Concurrent Viewership (CCV) history.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getCreatorCcvHistory
+     * 
+     * @param twitch_streamer_id The ID of the Twitch streamer.
+     * @param params Optional query parameters for filtering (e.g., start_date, end_date, per_page).
+     * 
+     * @returns promise
+     */
+    public static getCreatorCcvHistory<T>(twitch_streamer_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TwitchReportingRoute.routes.getCreatorCcvHistory, undefined, { twitch_streamer_id }, params);
+    }
+
+    /**
+     * Get a summary of game performance metrics.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getGamesSummary
+     * 
+     * @param params Optional query parameters for filtering and sorting (e.g., start_date, end_date, sort_by, limit).
+     * 
+     * @returns promise
+     */
+    public static getGamesSummary<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TwitchReportingRoute.routes.getGamesSummary, undefined, undefined, params);
+    }
+
+    /**
+     * Get most recently active streamers.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getMostActiveStreamers
+     * 
+     * @param params Optional query parameters (e.g., limit).
+     * 
+     * @returns promise
+     */
+    public static getMostActiveStreamers<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TwitchReportingRoute.routes.getMostActiveStreamers, undefined, undefined, params);
+    }
+
+    /**
+     * Get most recently streamed games.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getMostActiveGames
+     * 
+     * @param params Optional query parameters (e.g., limit).
+     * 
+     * @returns promise
+     */
+    public static getMostActiveGames<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TwitchReportingRoute.routes.getMostActiveGames, undefined, undefined, params);
+    }
+
+    /**
+     * Get top streamers by performance (average or peak CCV).
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getTopStreamers
+     * 
+     * @param params Optional query parameters for filtering and sorting (e.g., sort_by, start_date, limit).
+     * 
+     * @returns promise
+     */
+    public static getTopStreamers<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TwitchReportingRoute.routes.getTopStreamers, undefined, undefined, params);
+    }
+
+    /**
+     * Get a streamer's typical streaming schedule as a heatmap.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Twitch%20Reporting/getCreatorStreamingSchedule
+     * 
+     * @param twitch_streamer_id The ID of the Twitch streamer.
+     * 
+     * @returns promise
+     */
+    public static getCreatorStreamingSchedule<T>(twitch_streamer_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TwitchReportingRoute.routes.getCreatorStreamingSchedule, undefined, { twitch_streamer_id });
+    }
+
+}
+
+export default TwitchReporting;

package/src/api/index.ts

@@ -37,6 +37,7 @@ import WebsiteAnalytics from "./WebsiteAnalytics";
 import ShortLinks from "./ShortLinks";
 import AIUsage from "./AIUsage";
 import MarketingAgencies from "./MarketingAgencies";
+import TwitchReporting from "./TwitchReporting";
 
 export {Ads};
 export {AccessKeys};
@@ -76,4 +77,5 @@ export {WebsiteAnalytics};
 export {Fingerprinting};
 export {ShortLinks};
 export {AIUsage};
-export {MarketingAgencies};
+export {MarketingAgencies};
+export {TwitchReporting};

package/src/index.ts

@@ -41,6 +41,7 @@ import {Fingerprinting} from "./api";
 import {ShortLinks} from "./api";
 import {AIUsage} from "./api";
 import {MarketingAgencies} from "./api"
+import {TwitchReporting} from './api'
 
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
@@ -110,7 +111,8 @@ class Glitch {
         Fingerprinting : Fingerprinting,
         ShortLinks : ShortLinks,
         AIUsage : AIUsage,
-        MarketingAgencies : MarketingAgencies
+        MarketingAgencies : MarketingAgencies,
+        TwitchReporting: TwitchReporting,
     }
 
     public static util = {

package/src/routes/TwitchReportingRoute.ts

@@ -0,0 +1,35 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class TwitchReportingRoute {
+
+    public static routes: { [key: string]: Route } = {
+        getCreatorCcvHistory: {
+            url: '/reporting/twitch/streamers/{twitch_streamer_id}/ccv-history',
+            method: HTTP_METHODS.GET
+        },
+        getGamesSummary: {
+            url: '/reporting/twitch/games/summary',
+            method: HTTP_METHODS.GET
+        },
+        getMostActiveStreamers: {
+            url: '/reporting/twitch/streamers/most-active',
+            method: HTTP_METHODS.GET
+        },
+        getMostActiveGames: {
+            url: '/reporting/twitch/games/most-active',
+            method: HTTP_METHODS.GET
+        },
+        getTopStreamers: {
+            url: '/reporting/twitch/streamers/top',
+            method: HTTP_METHODS.GET
+        },
+        getCreatorStreamingSchedule: {
+            url: '/reporting/twitch/streamers/{twitch_streamer_id}/streaming-schedule',
+            method: HTTP_METHODS.GET
+        },
+    };
+
+}
+
+export default TwitchReportingRoute;