glitch-javascript-sdk 3.5.3 → 3.6.0

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

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

package/dist/index.d.ts

@@ -11027,6 +11027,28 @@ declare class MarketResearch {
     static exportGame(game_id: string, params?: Record<string, any>): AxiosPromise<Blob>;
 }
 
+interface GameAdEventPayload {
+    token: string;
+    event_uuid?: string;
+    provider: string;
+    placement: string;
+    format: 'banner' | 'video' | 'interstitial' | 'rewarded' | 'other';
+    event_type: 'sdk_ready' | 'request_started' | 'loaded' | 'no_fill' | 'started' | 'impression' | 'viewable' | 'clicked' | 'completed' | 'skipped' | 'closed' | 'paused_game' | 'resumed_game' | 'error';
+    provider_event_id?: string;
+    metadata?: Record<string, any>;
+    occurred_at?: string;
+}
+declare class GameAdvertising {
+    static settings<T>(title_id: string): AxiosPromise<Response<T>>;
+    static updateSettings<T>(title_id: string, data: object): AxiosPromise<Response<T>>;
+    static createSession<T>(title_id: string, data: object): AxiosPromise<Response<T>>;
+    static storeEvent<T>(title_id: string, session_id: string, data: GameAdEventPayload): AxiosPromise<Response<T>>;
+    static revenueSummary<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static adminDashboard<T>(): AxiosPromise<Response<T>>;
+    static adminUpdateSettings<T>(data: object): AxiosPromise<Response<T>>;
+    static adminStoreRevenue<T>(data: object): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -11397,6 +11419,7 @@ declare class Glitch {
         AdminReports: typeof AdminReports;
         AdminUsers: typeof AdminUsers;
         MarketResearch: typeof MarketResearch;
+        GameAdvertising: typeof GameAdvertising;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "3.5.3",
+  "version": "3.6.0",
   "description": "Javascript SDK for Glitch",
   "publishConfig": {
     "access": "public"
@@ -13,7 +13,7 @@
   ],
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "node scripts/test-game-advertising-routes.cjs",
     "build": "rm -Rf dist && rollup -c --bundleConfigAsCjs",
     "build-docs": "rm  -rf docs && typedoc  --tsconfig tsconfig.json src/"
   },

package/src/api/GameAdvertising.ts

@@ -0,0 +1,52 @@
+import { AxiosPromise } from 'axios';
+import GameAdvertisingRoute from '../routes/GameAdvertisingRoute';
+import Requests from '../util/Requests';
+import Response from '../util/Response';
+
+export interface GameAdEventPayload {
+  token: string;
+  event_uuid?: string;
+  provider: string;
+  placement: string;
+  format: 'banner' | 'video' | 'interstitial' | 'rewarded' | 'other';
+  event_type: 'sdk_ready' | 'request_started' | 'loaded' | 'no_fill' | 'started' | 'impression' | 'viewable' | 'clicked' | 'completed' | 'skipped' | 'closed' | 'paused_game' | 'resumed_game' | 'error';
+  provider_event_id?: string;
+  metadata?: Record<string, any>;
+  occurred_at?: string;
+}
+
+class GameAdvertising {
+  public static settings<T>(title_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.settings, undefined, { title_id });
+  }
+
+  public static updateSettings<T>(title_id: string, data: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.updateSettings, data, { title_id });
+  }
+
+  public static createSession<T>(title_id: string, data: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.createSession, data, { title_id });
+  }
+
+  public static storeEvent<T>(title_id: string, session_id: string, data: GameAdEventPayload): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.storeEvent, data, { title_id, session_id });
+  }
+
+  public static revenueSummary<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.revenueSummary, undefined, { title_id }, params);
+  }
+
+  public static adminDashboard<T>(): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.adminDashboard);
+  }
+
+  public static adminUpdateSettings<T>(data: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.adminUpdateSettings, data);
+  }
+
+  public static adminStoreRevenue<T>(data: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(GameAdvertisingRoute.routes.adminStoreRevenue, data);
+  }
+}
+
+export default GameAdvertising;

package/src/api/Titles.ts

@@ -1316,7 +1316,7 @@ class Titles {
     }
 
     /**
-     * Get a consolidated report of all earnings for a title, including 
+     * Get a consolidated report of all earnings for a title, including
      * playtime payouts, direct premium purchases, and rentals (minus refunds).
      * 
      * @param title_id The UUID of the title.

package/src/api/index.ts

@@ -51,6 +51,7 @@ import PrDirectory from "./PrDirectory";
 import AdminReports from "./AdminReports";
 import AdminUsers from "./AdminUsers";
 import MarketResearch from "./MarketResearch";
+import GameAdvertising from './GameAdvertising';
 
 export {Ads};
 export {AccessKeys};
@@ -105,3 +106,4 @@ export {PrDirectory};
 export {AdminReports};
 export {AdminUsers};
 export {MarketResearch};
+export {GameAdvertising};

package/src/index.ts

@@ -55,6 +55,7 @@ import {PrDirectory} from './api';
 import {AdminReports} from './api';
 import {AdminUsers} from './api';
 import {MarketResearch} from './api';
+import {GameAdvertising} from './api';
 
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
@@ -139,6 +140,7 @@ class Glitch {
         AdminReports : AdminReports,
         AdminUsers : AdminUsers,
         MarketResearch : MarketResearch,
+        GameAdvertising: GameAdvertising,
     }
 
     public static util = {

package/src/routes/GameAdvertisingRoute.ts

@@ -0,0 +1,17 @@
+import Route from './interface';
+import HTTP_METHODS from '../constants/HttpMethods';
+
+class GameAdvertisingRoute {
+  public static routes: { [key: string]: Route } = {
+    settings: { url: '/titles/{title_id}/advertising/settings', method: HTTP_METHODS.GET },
+    updateSettings: { url: '/titles/{title_id}/advertising/settings', method: HTTP_METHODS.PUT },
+    createSession: { url: '/titles/{title_id}/advertising/sessions', method: HTTP_METHODS.POST },
+    storeEvent: { url: '/titles/{title_id}/advertising/sessions/{session_id}/events', method: HTTP_METHODS.POST },
+    revenueSummary: { url: '/titles/{title_id}/advertising/revenue-summary', method: HTTP_METHODS.GET },
+    adminDashboard: { url: '/admin/game-advertising', method: HTTP_METHODS.GET },
+    adminUpdateSettings: { url: '/admin/game-advertising/settings', method: HTTP_METHODS.PUT },
+    adminStoreRevenue: { url: '/admin/game-advertising/revenue', method: HTTP_METHODS.POST },
+  };
+}
+
+export default GameAdvertisingRoute;