glitch-javascript-sdk 2.2.6 → 2.2.8

package/dist/esm/api/TwitchReporting.d.ts

@@ -0,0 +1,81 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+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>>;
+    /**
+    * Get a list of games played by a specific streamer.
+    *
+    * @param twitch_streamer_id The ID of the Twitch streamer.
+    * @returns promise
+    */
+    static getStreamerGameHistory<T>(twitch_streamer_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Get a paginated list of streamers who played a specific game.
+     *
+     * @param game_name The URL-encoded name of the game.
+     * @param params Optional query parameters for pagination (e.g., page, per_page).
+     * @returns promise
+     */
+    static getStreamersForGame<T>(game_name: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+export default TwitchReporting;

package/dist/esm/api/index.d.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 };
 export { Auth };
@@ -76,3 +77,4 @@ export { Fingerprinting };
 export { ShortLinks };
 export { AIUsage };
 export { MarketingAgencies };
+export { TwitchReporting };

package/dist/esm/index.d.ts

@@ -37,6 +37,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";
 import Session from "./util/Session";
@@ -95,6 +96,7 @@ declare class Glitch {
         ShortLinks: typeof ShortLinks;
         AIUsage: typeof AIUsage;
         MarketingAgencies: typeof MarketingAgencies;
+        TwitchReporting: typeof TwitchReporting;
     };
     static util: {
         Requests: typeof Requests;

package/dist/esm/index.js

@@ -15605,6 +15605,144 @@ var MarketingAgencies = /** @class */ (function () {
     return MarketingAgencies;
 }());
 
+var TwitchReportingRoute = /** @class */ (function () {
+    function TwitchReportingRoute() {
+    }
+    TwitchReportingRoute.routes = {
+        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
+        },
+        getStreamerGameHistory: {
+            url: '/reporting/twitch/streamers/{twitch_streamer_id}/games',
+            method: HTTP_METHODS.GET
+        },
+        getStreamersForGame: {
+            url: '/reporting/twitch/games/{game_name}/streamers',
+            method: HTTP_METHODS.GET
+        },
+    };
+    return TwitchReportingRoute;
+}());
+
+var TwitchReporting = /** @class */ (function () {
+    function 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
+     */
+    TwitchReporting.getCreatorCcvHistory = function (twitch_streamer_id, params) {
+        return Requests.processRoute(TwitchReportingRoute.routes.getCreatorCcvHistory, undefined, { twitch_streamer_id: 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
+     */
+    TwitchReporting.getGamesSummary = function (params) {
+        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
+     */
+    TwitchReporting.getMostActiveStreamers = function (params) {
+        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
+     */
+    TwitchReporting.getMostActiveGames = function (params) {
+        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
+     */
+    TwitchReporting.getTopStreamers = function (params) {
+        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
+     */
+    TwitchReporting.getCreatorStreamingSchedule = function (twitch_streamer_id) {
+        return Requests.processRoute(TwitchReportingRoute.routes.getCreatorStreamingSchedule, undefined, { twitch_streamer_id: twitch_streamer_id });
+    };
+    /**
+    * Get a list of games played by a specific streamer.
+    *
+    * @param twitch_streamer_id The ID of the Twitch streamer.
+    * @returns promise
+    */
+    TwitchReporting.getStreamerGameHistory = function (twitch_streamer_id) {
+        return Requests.processRoute(TwitchReportingRoute.routes.getStreamerGameHistory, undefined, { twitch_streamer_id: twitch_streamer_id });
+    };
+    /**
+     * Get a paginated list of streamers who played a specific game.
+     *
+     * @param game_name The URL-encoded name of the game.
+     * @param params Optional query parameters for pagination (e.g., page, per_page).
+     * @returns promise
+     */
+    TwitchReporting.getStreamersForGame = function (game_name, params) {
+        return Requests.processRoute(TwitchReportingRoute.routes.getStreamersForGame, undefined, { game_name: encodeURIComponent(game_name) }, params);
+    };
+    return TwitchReporting;
+}());
+
 var Parser = /** @class */ (function () {
     function Parser() {
     }
@@ -16131,7 +16269,8 @@ var Glitch = /** @class */ (function () {
         Fingerprinting: Fingerprinting,
         ShortLinks: ShortLinks,
         AIUsage: AIUsage,
-        MarketingAgencies: MarketingAgencies
+        MarketingAgencies: MarketingAgencies,
+        TwitchReporting: TwitchReporting,
     };
     Glitch.util = {
         Requests: Requests,