glitch-javascript-sdk 3.6.0 → 3.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/index.js CHANGED
@@ -21043,12 +21043,13 @@ var Users = /** @class */ (function () {
21043
21043
  return Requests.processRoute(UserRoutes.routes.getCampaignInvites, {}, undefined, params);
21044
21044
  };
21045
21045
  /**
21046
- * Gets payouts from past campaings
21046
+ * Gets the authenticated influencer's payouts from campaigns and attributed
21047
+ * game advertising. Advertising revenue is returned as a separate additive
21048
+ * source with provider-period metrics and tracking-link/social-post IDs.
21047
21049
  *
21048
21050
  * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
21049
21051
  *
21050
- * @param user_id The id of the user to update.
21051
- * @param data The data to update.
21052
+ * @param params Optional campaign, date, status, source, and ordering filters.
21052
21053
  *
21053
21054
  * @returns promise
21054
21055
  */
@@ -32959,46 +32960,84 @@ var MarketResearch = /** @class */ (function () {
32959
32960
  var GameAdvertisingRoute = /** @class */ (function () {
32960
32961
  function GameAdvertisingRoute() {
32961
32962
  }
32963
+ /**
32964
+ * Route templates for publisher game-ad inventory, telemetry, earnings, and
32965
+ * site administration. Placeholders are expanded by Requests.processRoute.
32966
+ */
32962
32967
  GameAdvertisingRoute.routes = {
32963
32968
  settings: { url: '/titles/{title_id}/advertising/settings', method: HTTP_METHODS.GET },
32964
32969
  updateSettings: { url: '/titles/{title_id}/advertising/settings', method: HTTP_METHODS.PUT },
32965
32970
  createSession: { url: '/titles/{title_id}/advertising/sessions', method: HTTP_METHODS.POST },
32966
32971
  storeEvent: { url: '/titles/{title_id}/advertising/sessions/{session_id}/events', method: HTTP_METHODS.POST },
32967
32972
  revenueSummary: { url: '/titles/{title_id}/advertising/revenue-summary', method: HTTP_METHODS.GET },
32973
+ inGamePlacements: { url: '/titles/{title_id}/advertising/in-game/placements', method: HTTP_METHODS.GET },
32974
+ replaceInGamePlacements: { url: '/titles/{title_id}/advertising/in-game/placements', method: HTTP_METHODS.PUT },
32968
32975
  adminDashboard: { url: '/admin/game-advertising', method: HTTP_METHODS.GET },
32969
32976
  adminUpdateSettings: { url: '/admin/game-advertising/settings', method: HTTP_METHODS.PUT },
32970
32977
  adminStoreRevenue: { url: '/admin/game-advertising/revenue', method: HTTP_METHODS.POST },
32978
+ adminProviderApps: { url: '/admin/game-advertising/provider-apps', method: HTTP_METHODS.GET },
32979
+ adminUpsertProviderApp: { url: '/admin/game-advertising/provider-apps', method: HTTP_METHODS.PUT },
32971
32980
  };
32972
32981
  return GameAdvertisingRoute;
32973
32982
  }());
32974
32983
 
32984
+ /**
32985
+ * Typed client for platform-served game advertising.
32986
+ *
32987
+ * These endpoints manage publisher inventory displayed around playable games;
32988
+ * they are intentionally separate from APIs used to buy advertising campaigns.
32989
+ */
32975
32990
  var GameAdvertising = /** @class */ (function () {
32976
32991
  function GameAdvertising() {
32977
32992
  }
32993
+ /** Return developer-visible ad-earnings settings for a title. */
32978
32994
  GameAdvertising.settings = function (title_id) {
32979
32995
  return Requests.processRoute(GameAdvertisingRoute.routes.settings, undefined, { title_id: title_id });
32980
32996
  };
32997
+ /** Update developer ad-earnings activation and optional title provider ID. */
32981
32998
  GameAdvertising.updateSettings = function (title_id, data) {
32982
32999
  return Requests.processRoute(GameAdvertisingRoute.routes.updateSettings, data, { title_id: title_id });
32983
33000
  };
33001
+ /** Resolve ad eligibility and create an expiring provider manifest/session. */
32984
33002
  GameAdvertising.createSession = function (title_id, data) {
32985
33003
  return Requests.processRoute(GameAdvertisingRoute.routes.createSession, data, { title_id: title_id });
32986
33004
  };
33005
+ /** Store one normalized, idempotent event for an advertising session. */
32987
33006
  GameAdvertising.storeEvent = function (title_id, session_id, data) {
32988
33007
  return Requests.processRoute(GameAdvertisingRoute.routes.storeEvent, data, { title_id: title_id, session_id: session_id });
32989
33008
  };
33009
+ /** Return developer-visible estimated/finalized earnings and delivery totals. */
32990
33010
  GameAdvertising.revenueSummary = function (title_id, params) {
32991
33011
  return Requests.processRoute(GameAdvertisingRoute.routes.revenueSummary, undefined, { title_id: title_id }, params);
32992
33012
  };
33013
+ /** Return every intrinsic-ad surface configured for a title. */
33014
+ GameAdvertising.inGamePlacements = function (title_id) {
33015
+ return Requests.processRoute(GameAdvertisingRoute.routes.inGamePlacements, undefined, { title_id: title_id });
33016
+ };
33017
+ /** Atomically replace a title's provider-neutral intrinsic-ad surfaces. */
33018
+ GameAdvertising.replaceInGamePlacements = function (title_id, placements) {
33019
+ return Requests.processRoute(GameAdvertisingRoute.routes.replaceInGamePlacements, { placements: placements }, { title_id: title_id });
33020
+ };
33021
+ /** Return site-admin delivery settings, aggregate metrics, and recent revenue. */
32993
33022
  GameAdvertising.adminDashboard = function () {
32994
33023
  return Requests.processRoute(GameAdvertisingRoute.routes.adminDashboard);
32995
33024
  };
33025
+ /** Partially update platform-wide providers and delivery frequency. */
32996
33026
  GameAdvertising.adminUpdateSettings = function (data) {
32997
33027
  return Requests.processRoute(GameAdvertisingRoute.routes.adminUpdateSettings, data);
32998
33028
  };
33029
+ /** Import or reconcile one provider revenue report row. */
32999
33030
  GameAdvertising.adminStoreRevenue = function (data) {
33000
33031
  return Requests.processRoute(GameAdvertisingRoute.routes.adminStoreRevenue, data);
33001
33032
  };
33033
+ /** Return public provider app keys and platform mappings for site admins. */
33034
+ GameAdvertising.adminProviderApps = function () {
33035
+ return Requests.processRoute(GameAdvertisingRoute.routes.adminProviderApps);
33036
+ };
33037
+ /** Create or update a provider app mapping without accepting report secrets. */
33038
+ GameAdvertising.adminUpsertProviderApp = function (data) {
33039
+ return Requests.processRoute(GameAdvertisingRoute.routes.adminUpsertProviderApp, data);
33040
+ };
33002
33041
  return GameAdvertising;
33003
33042
  }());
33004
33043