glitch-javascript-sdk 1.3.9 → 1.4.1

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

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

package/dist/esm/util/Requests.d.ts

@@ -1,4 +1,4 @@
-import { AxiosPromise } from 'axios';
+import { AxiosPromise, AxiosProgressEvent } from 'axios';
 import Config from '../config/Config';
 import Route from '../routes/interface';
 import Response from './Response';
@@ -16,8 +16,8 @@ declare class Requests {
     static post<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static put<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static delete<T>(url: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
+    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     static uploadFileInChunks<T>(file: File, uploadUrl: string, onProgress?: (totalSize: number, amountUploaded: number) => void, data?: any, chunkSize?: number): Promise<void>;
     static processRoute<T>(route: Route, data?: object, routeReplace?: {
         [key: string]: any;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosPromise } from 'axios';
+import { AxiosPromise, AxiosProgressEvent } from 'axios';
 
 /**
  * Config
@@ -2792,6 +2792,14 @@ declare class Titles {
      * @returns promise
      */
     static uploadBannerImageBlob<T>(title_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+    * Add media to a title.
+    */
+    static addMedia<T>(title_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Remove media from a title.
+     */
+    static removeMedia<T>(title_id: string, media_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Campaigns {
@@ -3901,7 +3909,7 @@ declare class Media {
      *
      * @returns promise
      */
-    static uploadFile<T>(file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadFile<T>(file: File, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     /**
      * Upload media content using a Blob.
      *
@@ -3912,7 +3920,7 @@ declare class Media {
      *
      * @returns promise
      */
-    static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     /**
      * Get media details.
      *
@@ -3975,6 +3983,17 @@ declare class Scheduler {
      * @returns promise
      */
     static deleteSchedule<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Test the tone of the scheduler.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Scheduler/updateTitlePromotionSchedule
+     *
+     * @param scheduler_id The ID of the promotion schedule.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static testTone<T>(scheduler_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Get social media posts related to a promotion schedule.
      *
@@ -4176,6 +4195,70 @@ declare class Scheduler {
     static getDiscordChannels<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class Funnel {
+    /**
+     * Get funnel metrics.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels
+     *
+     * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+     * @returns Promise with funnel metrics data
+     */
+    static index<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get funnel-optimized metrics.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_funnel
+     *
+     * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+     * @returns Promise with funnel data optimized for visual funnels
+     */
+    static funnel<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get available metrics.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_metrics
+     *
+     * @returns Promise with list of available metrics
+     */
+    static metrics<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Get available stages.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_stages
+     *
+     * @returns Promise with list of available stages
+     */
+    static stages<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Get daily funnel metrics.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_daily
+     *
+     * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+     * @returns Promise with daily funnel metrics data
+     */
+    static daily<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get monthly funnel metrics.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_monthly
+     *
+     * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+     * @returns Promise with monthly funnel metrics data
+     */
+    static monthly<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get yearly funnel metrics.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_yearly
+     *
+     * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+     * @returns Promise with yearly funnel metrics data
+     */
+    static yearly<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -4195,8 +4278,8 @@ declare class Requests {
     static post<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static put<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static delete<T>(url: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
+    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     static uploadFileInChunks<T>(file: File, uploadUrl: string, onProgress?: (totalSize: number, amountUploaded: number) => void, data?: any, chunkSize?: number): Promise<void>;
     static processRoute<T>(route: Route, data?: object, routeReplace?: {
         [key: string]: any;
@@ -4504,6 +4587,7 @@ declare class Glitch {
         PlayTests: typeof PlayTests;
         Media: typeof Media;
         Scheduler: typeof Scheduler;
+        Funnel: typeof Funnel;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

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

package/src/api/Funnel.ts

@@ -0,0 +1,92 @@
+// src/controllers/Funnel.tsx
+
+import FunnelRoutes from "../routes/FunnelRoutes";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Funnel {
+  /**
+   * Get funnel metrics.
+   * 
+   * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels
+   * 
+   * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+   * @returns Promise with funnel metrics data
+   */
+  public static index<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(FunnelRoutes.routes.index, undefined, undefined, params);
+  }
+
+  /**
+   * Get funnel-optimized metrics.
+   * 
+   * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_funnel
+   * 
+   * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+   * @returns Promise with funnel data optimized for visual funnels
+   */
+  public static funnel<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(FunnelRoutes.routes.funnel, undefined, undefined, params);
+  }
+
+  /**
+   * Get available metrics.
+   * 
+   * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_metrics
+   * 
+   * @returns Promise with list of available metrics
+   */
+  public static metrics<T>(): AxiosPromise<Response<T>> {
+    return Requests.processRoute(FunnelRoutes.routes.metrics);
+  }
+
+  /**
+   * Get available stages.
+   * 
+   * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_stages
+   * 
+   * @returns Promise with list of available stages
+   */
+  public static stages<T>(): AxiosPromise<Response<T>> {
+    return Requests.processRoute(FunnelRoutes.routes.stages);
+  }
+
+  /**
+   * Get daily funnel metrics.
+   * 
+   * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_daily
+   * 
+   * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+   * @returns Promise with daily funnel metrics data
+   */
+  public static daily<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(FunnelRoutes.routes.daily, undefined, undefined, params);
+  }
+
+  /**
+   * Get monthly funnel metrics.
+   * 
+   * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_monthly
+   * 
+   * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+   * @returns Promise with monthly funnel metrics data
+   */
+  public static monthly<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(FunnelRoutes.routes.monthly, undefined, undefined, params);
+  }
+
+  /**
+   * Get yearly funnel metrics.
+   * 
+   * @see https://api.glitch.fun/api/documentation#/Funnel%20Metrics/get_funnels_yearly
+   * 
+   * @param params Query parameters for filtering (title_id, community_id, start_date, end_date)
+   * @returns Promise with yearly funnel metrics data
+   */
+  public static yearly<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(FunnelRoutes.routes.yearly, undefined, undefined, params);
+  }
+}
+
+export default Funnel;

package/src/api/Media.ts

@@ -1,7 +1,7 @@
 import MediaRoute from "../routes/MediaRoute";
 import Requests from "../util/Requests";
 import Response from "../util/Response";
-import { AxiosPromise } from "axios";
+import { AxiosProgressEvent, AxiosPromise } from "axios";
 
 class Media {
     /**
@@ -14,8 +14,8 @@ class Media {
      * 
      * @returns promise
      */
-    public static uploadFile<T>(file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
-        return Requests.uploadFile(MediaRoute.routes.upload.url, 'media', file, data, params);
+    public static uploadFile<T>(file: File, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>> {
+        return Requests.uploadFile(MediaRoute.routes.upload.url, 'media', file, data, params, onUploadProgress);
     }
 
     /**
@@ -28,8 +28,8 @@ class Media {
      * 
      * @returns promise
      */
-    public static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
-        return Requests.uploadBlob(MediaRoute.routes.upload.url, 'media', blob, data, params);
+    public static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>> {
+        return Requests.uploadBlob(MediaRoute.routes.upload.url, 'media', blob, data, params, onUploadProgress);
     }
 
     /**

package/src/api/Scheduler.ts

@@ -68,6 +68,20 @@ class Scheduler {
         return Requests.processRoute(SchedulerRoute.routes.deleteSchedule, {}, { scheduler_id }, params);
     }
 
+    /**
+     * Test the tone of the scheduler.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Scheduler/updateTitlePromotionSchedule
+     * 
+     * @param scheduler_id The ID of the promotion schedule.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static testTone<T>(scheduler_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SchedulerRoute.routes.testTone, data, { scheduler_id }, params);
+    }
+
     /**
      * Get social media posts related to a promotion schedule.
      * 

package/src/api/Titles.ts

@@ -196,6 +196,20 @@ class Titles {
         return Requests.uploadBlob(url, 'image', blob, data);
     }
 
+     /**
+     * Add media to a title.
+     */
+     public static addMedia<T>(title_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TitlesRoute.routes.addMedia, data, { title_id: title_id }, params);
+    }
+
+    /**
+     * Remove media from a title.
+     */
+    public static removeMedia<T>(title_id: string, media_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TitlesRoute.routes.removeMedia, {}, { title_id: title_id, media_id: media_id }, params);
+    }
+
 }
 
 export default Titles;

package/src/api/index.ts

@@ -27,6 +27,7 @@ import Newsletters from "./Newsletters"
 import PlayTests from "./PlayTests";
 import Media from "./Media";
 import Scheduler from "./Scheduler";
+import Funnel from "./Funnel";
 
 export {Auth};
 export {Competitions};
@@ -56,4 +57,5 @@ export {GameShows};
 export {Newsletters};
 export {PlayTests};
 export {Media};
-export {Scheduler};
+export {Scheduler};
+export {Funnel};

package/src/index.ts

@@ -31,6 +31,7 @@ import {Newsletters} from "./api";
 import {PlayTests} from "./api";
 import {Media} from "./api";
 import {Scheduler} from "./api";
+import {Funnel} from "./api";
 
 
 
@@ -93,6 +94,7 @@ class Glitch {
         PlayTests : PlayTests,
         Media : Media,
         Scheduler : Scheduler,
+        Funnel: Funnel,
     }
 
     public static util = {

package/src/routes/FunnelRoutes.ts

@@ -0,0 +1,18 @@
+// src/routes/FunnelRoutes.tsx
+
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class FunnelRoutes {
+  public static routes: { [key: string]: Route } = {
+    index: { url: '/funnels', method: HTTP_METHODS.GET },
+    funnel: { url: '/funnels/funnel', method: HTTP_METHODS.GET },
+    metrics: { url: '/funnels/metrics', method: HTTP_METHODS.GET },
+    stages: { url: '/funnels/stages', method: HTTP_METHODS.GET },
+    daily: { url: '/funnels/daily', method: HTTP_METHODS.GET },
+    monthly: { url: '/funnels/monthly', method: HTTP_METHODS.GET },
+    yearly: { url: '/funnels/yearly', method: HTTP_METHODS.GET },
+  };
+}
+
+export default FunnelRoutes;

package/src/routes/SchedulerRoute.ts

@@ -18,6 +18,8 @@ class SchedulerRoute {
         updateUpdate: { url: '/schedulers/{scheduler_id}/updates/{update_id}', method: HTTP_METHODS.PUT },
         deleteUpdate: { url: '/schedulers/{scheduler_id}/updates/{update_id}', method: HTTP_METHODS.DELETE },
 
+        testTone: { url: '/schedulers/{scheduler_id}/tone', method: HTTP_METHODS.POST },
+
         // Clear OAuth Routes
         clearTwitterAuth: { url: '/schedulers/{scheduler_id}/clearTwitterAuth', method: HTTP_METHODS.DELETE },
         clearFacebookAuth: { url: '/schedulers/{scheduler_id}/clearFacebookAuth', method: HTTP_METHODS.DELETE },

package/src/routes/TitlesRoute.ts

@@ -15,6 +15,8 @@ class TitlesRoute {
       uploadBannerImage : {url : '/titles/{title_id}/uploadBannerImage', method: HTTP_METHODS.POST},
       addAdministrator : { url: '/titles/{title_id}/addAdministrator', method: HTTP_METHODS.POST },
       removeAdministrator : { url: '/titles/{title_id}/removeAdministrator/{user_id}', method: HTTP_METHODS.DELETE },
+      addMedia: { url: '/titles/{title_id}/addMedia', method: HTTP_METHODS.POST },
+      removeMedia: { url: '/titles/{title_id}/removeMedia/{media_id}', method: HTTP_METHODS.DELETE },
     };
 
   }

package/src/util/Requests.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosPromise } from 'axios';
+import axios, { AxiosPromise, AxiosRequestConfig, AxiosProgressEvent } from 'axios';
 import Config from '../config/Config';
 import HTTP_METHODS from '../constants/HttpMethods';
 import Route from '../routes/interface';
@@ -140,7 +140,8 @@ class Requests {
     filename: string,
     file: File | Blob,
     data?: any,
-    params?: Record<string, any>
+    params?: Record<string, any>,
+    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void // Correct type here
   ): AxiosPromise<Response<T>> {
     if (params && Object.keys(params).length > 0) {
       const queryString = Object.entries(params)
@@ -148,31 +149,43 @@ class Requests {
         .join('&');
       url = `${url}?${queryString}`;
     }
-
+  
     const formData = new FormData();
-
     formData.append(filename, file);
-
+  
     if (Requests.community_id) {
       data = {
         ...data,
         communities: [Requests.community_id],
       };
     }
-
+  
     for (let key in data) {
       formData.append(key, data[key]);
     }
-
-    return Requests.request<T>('POST', url, data, formData);
+  
+    const config: AxiosRequestConfig = {
+      method: 'POST',
+      url,
+      data: formData,
+      headers: {
+        'Content-Type': 'multipart/form-data',
+        ...(Requests.authToken && { Authorization: `Bearer ${Requests.authToken}` }),
+      },
+      onUploadProgress, // Pass directly, as the type now matches
+    };
+  
+    return axios(config);
   }
 
+  // Modify uploadBlob method
   public static uploadBlob<T>(
     url: string,
     filename: string,
     blob: Blob,
     data?: any,
-    params?: Record<string, any>
+    params?: Record<string, any>,
+    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void // Corrected type
   ): AxiosPromise<Response<T>> {
     if (params && Object.keys(params).length > 0) {
       const queryString = Object.entries(params)
@@ -180,25 +193,35 @@ class Requests {
         .join('&');
       url = `${url}?${queryString}`;
     }
-
+  
     const formData = new FormData();
-
     formData.append(filename, blob);
-
+  
     if (Requests.community_id) {
       data = {
         ...data,
         communities: [Requests.community_id],
       };
     }
-
+  
     for (let key in data) {
       formData.append(key, data[key]);
     }
-
-    return Requests.request<T>('POST', url, data, formData);
+  
+    const config: AxiosRequestConfig = {
+      method: 'POST',
+      url,
+      data: formData,
+      headers: {
+        'Content-Type': 'multipart/form-data',
+        ...(Requests.authToken && { Authorization: `Bearer ${Requests.authToken}` }),
+      },
+      onUploadProgress, // Pass directly
+    };
+  
+    return axios(config);
   }
-
+  
   // Method adapted for browser environments
 
   public static async uploadFileInChunks<T>(