@smartico/public-api 0.0.324 → 0.0.325

package/dist/SmarticoAPI.d.ts

@@ -2,7 +2,7 @@ import { ClassId } from './Base/ClassId';
 import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
 import { ILogger } from './ILogger';
 import { SAWDoAknowledgeResponse, SAWDoSpinResponse, SAWPrizesHistory, SAWWinningHistoryResponse } from './MiniGames';
-import { GetTranslationsResponse, PublicLabelSettings, ResponseIdentify, TranslationArea } from './Core';
+import { ActivityTypeLimited, GetTranslationsResponse, PublicLabelSettings, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetInboxMessagesResponse, InboxMessageBody, InboxReadStatus, MarkInboxMessageDeletedResponse, MarkInboxMessageReadResponse, MarkInboxMessageStarredResponse } from './Inbox';
 import { BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreHistoryResponse, GetStoreItemsResponse } from './Store';
@@ -71,6 +71,14 @@ declare class SmarticoAPI {
         public_username_custom: string;
     }>;
     coreCheckSegments(user_ext_id: string, segment_id: number[]): Promise<TSegmentCheckResult[]>;
+    /**
+     * Reports an engagement impression event (when engagement content is displayed to the user).
+     */
+    reportEngagementImpression(user_ext_id: string, engagement_uid: string, activityType: ActivityTypeLimited | number): void;
+    /**
+     * Reports an engagement action event (when user clicks/interacts with engagement content).
+     */
+    reportEngagementAction(user_ext_id: string, engagement_uid: string, activityType: ActivityTypeLimited | number, action?: string): void;
     jackpotGet(user_ext_id: string, filter?: {
         related_game_id?: string;
         jp_template_id?: number;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,3 +1,4 @@
+import { ActivityTypeLimited } from '../Core';
 import { SmarticoAPI } from '../SmarticoAPI';
 import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT, TBonus, TClaimBonusResult, TMiniGamePlayBatchResult, TSawHistory, TRaffle, TRaffleDraw, TRaffleDrawRun, TransformedRaffleClaimPrizeResponse, TLevelCurrent } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
@@ -496,6 +497,54 @@ export declare class WSAPI {
      * Requests translations for the given language. Returns the object including translation key/translation value pairs. All possible translation keys defined in the back office.
      */
     getTranslations(lang_code: string): Promise<TGetTranslations>;
+    /**
+     * Reports an impression event for an engagement (when engagement content is displayed to the user).
+     * Use this method to track when users view engagement content such as inbox messages, popups.
+     * When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType.
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.reportImpressionEvent({
+     *      engagement_uid: 'abc123-def456',
+     *      activityType: 31 // Inbox
+     * });
+     * ```
+     *
+     * **Visitor mode: not supported**
+     *
+     * @param params.engagement_uid - Unique identifier for the engagement
+     * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
+     */
+    reportImpressionEvent({ engagement_uid, activityType, }: {
+        engagement_uid: string;
+        activityType: ActivityTypeLimited | number;
+    }): void;
+    /**
+     * Reports a click/action event for an engagement (when user interacts with engagement content).
+     * Use this method to track when users click on or interact with engagement content such as inbox messages, popups.
+     * When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType, and pass the action/deeplink that was triggered by the user interaction as action.
+     *
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.reportClickEvent({
+     *      engagement_uid: 'abc123-def456',
+     *      activityType: 31 // Inbox,
+     *      action: 'dp:gf_missions'
+     * });
+     * ```
+     *
+     * **Visitor mode: not supported**
+     *
+     * @param params.engagement_uid - Unique identifier for the engagement
+     * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
+     * @param params.action - Optional action/deeplink that was triggered by the user interaction
+     */
+    reportClickEvent({ engagement_uid, activityType, action, }: {
+        engagement_uid: string;
+        activityType: ActivityTypeLimited | number;
+        action?: string;
+    }): void;
     private updateOnSpin;
     private reloadMiniGameTemplate;
     private updateMissions;

package/dist/index.js

@@ -3102,6 +3102,57 @@ var WSAPI = /*#__PURE__*/function () {
     } catch (e) {
       return Promise.reject(e);
     }
+  }
+  /**
+   * Reports an impression event for an engagement (when engagement content is displayed to the user).
+   * Use this method to track when users view engagement content such as inbox messages, popups.
+   * When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType.
+   *
+   * **Example**:
+   * ```
+   * _smartico.api.reportImpressionEvent({
+   *      engagement_uid: 'abc123-def456',
+   *      activityType: 31 // Inbox
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   * @param params.engagement_uid - Unique identifier for the engagement
+   * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
+   */
+  ;
+  _proto.reportImpressionEvent = function reportImpressionEvent(_ref12) {
+    var engagement_uid = _ref12.engagement_uid,
+      activityType = _ref12.activityType;
+    this.api.reportEngagementImpression(null, engagement_uid, activityType);
+  }
+  /**
+   * Reports a click/action event for an engagement (when user interacts with engagement content).
+   * Use this method to track when users click on or interact with engagement content such as inbox messages, popups.
+   * When using for Inbox cases, you need to use message guid as engagement_uid, and pass 31 as activityType, and pass the action/deeplink that was triggered by the user interaction as action.
+   *
+   *
+   * **Example**:
+   * ```
+   * _smartico.api.reportClickEvent({
+   *      engagement_uid: 'abc123-def456',
+   *      activityType: 31 // Inbox,
+   *      action: 'dp:gf_missions'
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   * @param params.engagement_uid - Unique identifier for the engagement
+   * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
+   * @param params.action - Optional action/deeplink that was triggered by the user interaction
+   */;
+  _proto.reportClickEvent = function reportClickEvent(_ref13) {
+    var engagement_uid = _ref13.engagement_uid,
+      activityType = _ref13.activityType,
+      action = _ref13.action;
+    this.api.reportEngagementAction(null, engagement_uid, activityType, action);
   };
   _proto.updateOnSpin = function updateOnSpin(data) {
     try {
@@ -3382,10 +3433,10 @@ var WSAPI = /*#__PURE__*/function () {
    *
    */
   ;
-  _proto.getJackpotWinners = function getJackpotWinners(_ref12) {
-    var limit = _ref12.limit,
-      offset = _ref12.offset,
-      jp_template_id = _ref12.jp_template_id;
+  _proto.getJackpotWinners = function getJackpotWinners(_ref14) {
+    var limit = _ref14.limit,
+      offset = _ref14.offset,
+      jp_template_id = _ref14.jp_template_id;
     try {
       var _this51 = this;
       return Promise.resolve(OCache.use(onUpdateContextKey.JackpotWinners + jp_template_id, exports.ECacheContext.WSAPI, function () {
@@ -3409,9 +3460,9 @@ var WSAPI = /*#__PURE__*/function () {
    *
    */
   ;
-  _proto.getJackpotEligibleGames = function getJackpotEligibleGames(_ref13) {
-    var jp_template_id = _ref13.jp_template_id,
-      onUpdate = _ref13.onUpdate;
+  _proto.getJackpotEligibleGames = function getJackpotEligibleGames(_ref15) {
+    var jp_template_id = _ref15.jp_template_id,
+      onUpdate = _ref15.onUpdate;
     try {
       var _this52 = this;
       if (onUpdate) {
@@ -3477,8 +3528,8 @@ var WSAPI = /*#__PURE__*/function () {
    */
   ;
   _proto.getRaffles = function getRaffles(_temp13) {
-    var _ref14 = _temp13 === void 0 ? {} : _temp13,
-      onUpdate = _ref14.onUpdate;
+    var _ref16 = _temp13 === void 0 ? {} : _temp13,
+      onUpdate = _ref16.onUpdate;
     try {
       var _this54 = this;
       if (onUpdate) {
@@ -4069,6 +4120,29 @@ var SmarticoAPI = /*#__PURE__*/function () {
     } catch (e) {
       return Promise.reject(e);
     }
+  }
+  /**
+   * Reports an engagement impression event (when engagement content is displayed to the user).
+   */
+  ;
+  _proto.reportEngagementImpression = function reportEngagementImpression(user_ext_id, engagement_uid, activityType) {
+    var message = this.buildMessage(user_ext_id, exports.ClassId.CLIENT_ENGAGEMENT_IMPRESSION_REQUEST, {
+      engagement_uid: engagement_uid,
+      activityType: activityType
+    });
+    this.send(message)["catch"](function () {});
+  }
+  /**
+   * Reports an engagement action event (when user clicks/interacts with engagement content).
+   */;
+  _proto.reportEngagementAction = function reportEngagementAction(user_ext_id, engagement_uid, activityType, action) {
+    var message = this.buildMessage(user_ext_id, exports.ClassId.CLIENT_ENGAGEMENT_ACTION_REQUEST, _extends({
+      engagement_uid: engagement_uid,
+      activityType: activityType
+    }, action && {
+      action: action
+    }));
+    this.send(message)["catch"](function () {});
   };
   _proto.jackpotGet = function jackpotGet(user_ext_id, filter, force_language) {
     try {