glitch-javascript-sdk 3.8.2 → 3.8.4

package/dist/cjs/index.js

@@ -24481,7 +24481,13 @@ var Titles = /** @class */ (function () {
         return Requests.processRoute(TitlesRoute.routes.viewInstall, {}, { title_id: title_id, install_id: install_id }, params);
     };
     /**
-     * Create a new game install record.
+     * Create or update a game install record.
+     *
+     * `user_install_id` is required. `game_build_id` is optional: send the
+     * exact Glitch build UUID returned as `build_id` by a play session when it
+     * is available, and omit it for external/legacy/unknown builds. Do not
+     * guess a build id. `game_version`, `build_type`, `device_id`, platform,
+     * device type, and operating system may be sent independently.
      */
     Titles.createInstall = function (title_id, data, params) {
         return Requests.processRoute(TitlesRoute.routes.createInstall, data, { title_id: title_id }, params);
@@ -24498,25 +24504,31 @@ var Titles = /** @class */ (function () {
     Titles.retentionSummary = function (title_id, params) {
         return Requests.processRoute(TitlesRoute.routes.retentionSummary, {}, { title_id: title_id }, params);
     };
+    /** Filter/group by platform, device_type, operating_system, game_version, optional game_build_id, or optional device_id. */
     Titles.activeRetentions = function (title_id, params) {
         return Requests.processRoute(TitlesRoute.routes.activeRetentions, {}, { title_id: title_id }, params);
     };
     Titles.retentionAnalysis = function (title_id, params) {
         return Requests.processRoute(TitlesRoute.routes.retentionAnalysis, {}, { title_id: title_id }, params);
     };
+    /** Returns string dimensions plus labeled `builds` and `devices` options for report filters. */
     Titles.distinctDimensions = function (title_id, params) {
         return Requests.processRoute(TitlesRoute.routes.distinctDimensions, {}, { title_id: title_id }, params);
     };
     /**
      * List sessions for a specific title, with optional filters and pagination.
-     * Returns a paginated list of sessions with start/end times, session_length, user info, etc.
+     * Returns a paginated list of sessions with start/end times, session_length,
+     * build/version/device snapshots, and user info. `game_build_id` and
+     * `device_id` filters are optional; unattributed/unknown options are exposed
+     * by distinctDimensions.
      */
     Titles.listSessions = function (title_id, params) {
         return Requests.processRoute(TitlesRoute.routes.listSessions, {}, { title_id: title_id }, params);
     };
     /**
      * Get aggregated average session length data (daily/weekly/monthly) for a title.
-     * Optionally filter by platform/device_type/OS/version and group by one dimension.
+     * Optionally filter/group by platform, device type, OS, version, exact
+     * build id, or device id.
      */
     Titles.sessionsAverage = function (title_id, params) {
         return Requests.processRoute(TitlesRoute.routes.sessionsAverage, {}, { title_id: title_id }, params);
@@ -24788,13 +24800,17 @@ var Titles = /** @class */ (function () {
     };
     /**
      * Record a single in-game action.
+     *
+     * Keep step_key and action_key stable. Optional step_label,
+     * step_description, event_label, and event_description fields are
+     * canonical display text for those keys within the title.
      */
     Titles.createEvent = function (title_id, data) {
         return Requests.processRoute(TitlesRoute.routes.createEvent, data, { title_id: title_id });
     };
     /**
      * Record multiple events in one request (Batching).
-     * @param data { events: Array<{game_install_id, step_key, action_key, metadata?}> }
+     * @param data { events: Array<{game_install_id, step_key, step_label?, step_description?, action_key, event_label?, event_description?, previous_step_key?, metadata?, event_timestamp?}> }
      */
     Titles.bulkCreateEvents = function (title_id, data) {
         return Requests.processRoute(TitlesRoute.routes.bulkCreateEvents, data, { title_id: title_id });