glitch-javascript-sdk 1.5.1 → 1.5.2

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

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

package/dist/index.d.ts

@@ -4329,6 +4329,52 @@ declare class Funnel {
     static yearly<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class SocialStats {
+    /**
+     * List all the social media account statistics, with optional filters.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics
+     *
+     * @param params Optional query parameters:
+     *  - platform (string | string[]): Filter by platform(s)
+     *  - start_date (string): Filter records created on or after this date (YYYY-MM-DD)
+     *  - end_date (string): Filter records created on or before this date (YYYY-MM-DD)
+     *  - user_id (string): Filter by user ID
+     *  - title_promotion_schedule_id (string): Filter by TitlePromotionSchedule ID
+     * @returns promise
+     */
+    static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get platform-level statistics, such as average follower count per platform.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/platformStatistics
+     *
+     * @returns promise
+     */
+    static platformStatistics<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Generate various reports for social media account statistics.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/reports
+     *
+     * @param params Query parameters:
+     *  - report_type (string): Required (e.g. average_followers, growth, platform_breakdown)
+     *  - platform (string or string[]): Filter by platform(s)
+     *  - start_date (string): Filter from date (YYYY-MM-DD)
+     *  - end_date (string): Filter to date (YYYY-MM-DD)
+     *  - user_id (string): Filter by user ID
+     *  - title_promotion_schedule_id (string): Filter by schedule ID
+     *
+     * @returns promise
+     */
+    static reports<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single social media account statistic record by its ID.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/show
+     *
+     * @param id The ID of the statistic record.
+     * @returns promise
+     */
+    static view<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -4658,6 +4704,7 @@ declare class Glitch {
         Media: typeof Media;
         Scheduler: typeof Scheduler;
         Funnel: typeof Funnel;
+        SocialStats: typeof SocialStats;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

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

package/src/api/SocialStats.ts

@@ -0,0 +1,65 @@
+// src/api/SocialStats.ts
+import SocialStatsRoute from "../routes/SocialStatsRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class SocialStats {
+
+    /**
+     * List all the social media account statistics, with optional filters.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics
+     * 
+     * @param params Optional query parameters:
+     *  - platform (string | string[]): Filter by platform(s)
+     *  - start_date (string): Filter records created on or after this date (YYYY-MM-DD)
+     *  - end_date (string): Filter records created on or before this date (YYYY-MM-DD)
+     *  - user_id (string): Filter by user ID
+     *  - title_promotion_schedule_id (string): Filter by TitlePromotionSchedule ID
+     * @returns promise
+     */
+    public static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialStatsRoute.routes.getStats, undefined, undefined, params);
+    }
+
+    /**
+     * Get platform-level statistics, such as average follower count per platform.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/platformStatistics
+     * 
+     * @returns promise
+     */
+    public static platformStatistics<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialStatsRoute.routes.getPlatformStatistics, undefined, undefined, params);
+    }
+
+    /**
+     * Generate various reports for social media account statistics.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/reports
+     * 
+     * @param params Query parameters:
+     *  - report_type (string): Required (e.g. average_followers, growth, platform_breakdown)
+     *  - platform (string or string[]): Filter by platform(s)
+     *  - start_date (string): Filter from date (YYYY-MM-DD)
+     *  - end_date (string): Filter to date (YYYY-MM-DD)
+     *  - user_id (string): Filter by user ID
+     *  - title_promotion_schedule_id (string): Filter by schedule ID
+     * 
+     * @returns promise
+     */
+    public static reports<T>(params: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialStatsRoute.routes.getReports, undefined, undefined, params);
+    }
+
+    /**
+     * Retrieve a single social media account statistic record by its ID.
+     * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/show
+     * 
+     * @param id The ID of the statistic record.
+     * @returns promise
+     */
+    public static view<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialStatsRoute.routes.getStatById, {}, { id: id }, params);
+    }
+}
+
+export default SocialStats;

package/src/api/index.ts

@@ -28,6 +28,7 @@ import PlayTests from "./PlayTests";
 import Media from "./Media";
 import Scheduler from "./Scheduler";
 import Funnel from "./Funnel";
+import SocialStats from "./SocialStats";
 
 export {Auth};
 export {Competitions};
@@ -58,4 +59,5 @@ export {Newsletters};
 export {PlayTests};
 export {Media};
 export {Scheduler};
-export {Funnel};
+export {Funnel};
+export {SocialStats};

package/src/index.ts

@@ -32,6 +32,7 @@ import {PlayTests} from "./api";
 import {Media} from "./api";
 import {Scheduler} from "./api";
 import {Funnel} from "./api";
+import {SocialStats} from "./api";
 
 
 
@@ -95,6 +96,7 @@ class Glitch {
         Media : Media,
         Scheduler : Scheduler,
         Funnel: Funnel,
+        SocialStats : SocialStats
     }
 
     public static util = {

package/src/routes/MediaRoute.ts

@@ -4,7 +4,7 @@ import HTTP_METHODS from "../constants/HttpMethods";
 class MediaRoute {
     public static routes: { [key: string]: Route } = {
         upload: { url: '/media', method: HTTP_METHODS.POST },
-        getMedia: { url: '/media/{meda_id}', method: HTTP_METHODS.GET },
+        getMedia: { url: '/media/{media_id}', method: HTTP_METHODS.GET },
     };
 }
 

package/src/routes/SocialStatsRoute.ts

@@ -0,0 +1,35 @@
+// src/routes/SocialStatsRoute.ts
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class SocialStatsRoute {
+    
+    public static routes: { [key: string]: Route } = {
+        /**
+         * Retrieve a list of social statistics with optional filters.
+         * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics
+         */
+        getStats: { url: '/socialstats', method: HTTP_METHODS.GET },
+
+        /**
+         * Retrieve platform-level statistics (e.g., average followers).
+         * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/platformStatistics
+         */
+        getPlatformStatistics: { url: '/socialstats/statistics', method: HTTP_METHODS.GET },
+
+        /**
+         * Generate reports with various insights based on report_type and filters.
+         * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/reports
+         */
+        getReports: { url: '/socialstats/reports', method: HTTP_METHODS.GET },
+
+        /**
+         * Retrieve a single social media account statistic record by its ID.
+         * @see https://api.glitch.fun/api/documentation#/SocialMediaAccountStatistics/show
+         */
+        getStatById: { url: '/socialstats/{id}', method: HTTP_METHODS.GET },
+    };
+
+}
+
+export default SocialStatsRoute;