@smartico/public-api 0.0.324 → 0.0.326

package/dist/index.modern.mjs

@@ -84,6 +84,8 @@ var ClassId;
   ClassId[ClassId["ACH_SHOP_ITEM_HISTORY_RESPONSE"] = 542] = "ACH_SHOP_ITEM_HISTORY_RESPONSE";
   ClassId[ClassId["GET_RELATED_ACH_N_TOURNAMENTS_REQUEST"] = 543] = "GET_RELATED_ACH_N_TOURNAMENTS_REQUEST";
   ClassId[ClassId["GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE"] = 544] = "GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE";
+  ClassId[ClassId["GET_POINT_HISTORY_REQUEST"] = 545] = "GET_POINT_HISTORY_REQUEST";
+  ClassId[ClassId["GET_POINT_HISTORY_RESPONSE"] = 546] = "GET_POINT_HISTORY_RESPONSE";
   /*
       !Important, if adding new messages that are 'acting' on behalf of the client,
       you need to include them in the CLASS_ID_IGNORE_FOR_SIMULATION
@@ -483,7 +485,8 @@ const SAWTemplatesTransform = items => {
           prize_modifiers: p.saw_prize_ui_definition.prize_modifiers,
           allow_split_decimal: p.saw_prize_ui_definition.allow_split_decimal,
           hide_prize_from_history: p.saw_prize_ui_definition.hide_prize_from_history,
-          requirements_to_get_prize: p.saw_prize_ui_definition.requirements_to_get_prize
+          requirements_to_get_prize: p.saw_prize_ui_definition.requirements_to_get_prize,
+          max_give_period_type_id: p.max_give_period_type_id
         };
         return y;
       })
@@ -613,6 +616,14 @@ var SAWExposeUserSpinId;
   SAWExposeUserSpinId[SAWExposeUserSpinId["SpinId"] = 2] = "SpinId";
 })(SAWExposeUserSpinId || (SAWExposeUserSpinId = {}));
 
+var AttemptPeriodType;
+(function (AttemptPeriodType) {
+  AttemptPeriodType[AttemptPeriodType["FromLastAttempt"] = 1] = "FromLastAttempt";
+  AttemptPeriodType[AttemptPeriodType["CalendarDaysUTC"] = 2] = "CalendarDaysUTC";
+  AttemptPeriodType[AttemptPeriodType["CalendarDaysUserTimeZone"] = 3] = "CalendarDaysUserTimeZone";
+  AttemptPeriodType[AttemptPeriodType["Lifetime"] = 4] = "Lifetime";
+})(AttemptPeriodType || (AttemptPeriodType = {}));
+
 class NodeCache {
   constructor() {
     this.ttlChecker = void 0;
@@ -2092,6 +2103,7 @@ var onUpdateContextKey;
   onUpdateContextKey["JackpotEligibleGames"] = "jackpotEligibleGames";
   onUpdateContextKey["CurrentLevel"] = "currentLevel";
   onUpdateContextKey["InboxUnreadCount"] = "inboxUnreadCount";
+  onUpdateContextKey["PointsHistory"] = "pointsHistory";
 })(onUpdateContextKey || (onUpdateContextKey = {}));
 /** @group General API */
 class WSAPI {
@@ -2143,10 +2155,13 @@ class WSAPI {
         }
       });
       on(ClassId.CLIENT_PUBLIC_PROPERTIES_CHANGED_EVENT, data => {
-        var _data$props, _data$props2;
+        var _data$props, _data$props2, _data$props3, _data$props4, _data$props5;
         if ((data == null || (_data$props = data.props) == null ? void 0 : _data$props.core_inbox_unread_count) !== undefined && (data == null || (_data$props2 = data.props) == null ? void 0 : _data$props2.core_inbox_unread_count) !== null) {
           this.updateInboxUnreadCount(data.props.core_inbox_unread_count);
         }
+        if ((data == null || (_data$props3 = data.props) == null ? void 0 : _data$props3.ach_points_balance) !== undefined || (data == null || (_data$props4 = data.props) == null ? void 0 : _data$props4.ach_gems_balance) !== undefined || (data == null || (_data$props5 = data.props) == null ? void 0 : _data$props5.ach_diamonds_balance) !== undefined) {
+          this.notifyPointsHistoryUpdate();
+        }
       });
     }
   }
@@ -2816,6 +2831,95 @@ class WSAPI {
       translations: r.translations
     };
   }
+  /**
+   * 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
+  }) {
+    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
+   */
+  reportClickEvent({
+    engagement_uid,
+    activityType,
+    action
+  }) {
+    this.api.reportEngagementAction(null, engagement_uid, activityType, action);
+  }
+  /**
+   * Returns the points history for a user within a specified time range.
+   * The response includes both points changes and gems/diamonds changes.
+   * Each log entry contains information about the change amount, balance, and source.
+   * The returned list is cached for 30 seconds.
+   * You can pass the onUpdate callback as a parameter, it will be called every time the points history is updated and will provide the updated list of points history logs for the last 10 minutes.
+   *
+   * **Example**:
+   * ```
+   * const startTime = Math.floor(Date.now() / 1000) - 86400 * 30; // 30 days ago
+   * const endTime = Math.floor(Date.now() / 1000); // now
+   *
+   * _smartico.api.getPointsHistory({
+   *      startTimeSeconds: startTime,
+   *      endTimeSeconds: endTime,
+   *      onUpdate: (data) => console.log('Updated:', data)
+   * }).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+   *
+   * **Visitor mode: not supported**
+   *
+   * @param params.startTimeSeconds - Start time in seconds (epoch timestamp)
+   * @param params.endTimeSeconds - End time in seconds (epoch timestamp)
+   * @param params.onUpdate - Optional callback function that will be called when the points history is updated
+   */
+  async getPointsHistory({
+    startTimeSeconds,
+    endTimeSeconds,
+    onUpdate
+  }) {
+    if (onUpdate) {
+      this.onUpdateCallback.set(onUpdateContextKey.PointsHistory, onUpdate);
+    }
+    return await OCache.use(onUpdateContextKey.PointsHistory, ECacheContext.WSAPI, () => this.api.getPointsHistoryT(null, startTimeSeconds, endTimeSeconds), CACHE_DATA_SEC);
+  }
   async updateOnSpin(data) {
     const templates = await OCache.use(onUpdateContextKey.Saw, ECacheContext.WSAPI, () => this.api.sawGetTemplatesT(null), CACHE_DATA_SEC);
     const index = templates.findIndex(t => t.id === data.saw_template_id);
@@ -2857,6 +2961,12 @@ class WSAPI {
     const payload = await this.api.getRafflesT(null);
     this.updateEntity(onUpdateContextKey.Raffles, payload);
   }
+  async notifyPointsHistoryUpdate() {
+    const startSeconds = Date.now() / 1000 - 600;
+    const endSeconds = Date.now() / 1000;
+    const payload = await this.api.getPointsHistoryT(null, startSeconds, endSeconds);
+    this.updateEntity(onUpdateContextKey.PointsHistory, payload);
+  }
   async updateEntity(contextKey, payload) {
     OCache.set(contextKey, payload, ECacheContext.WSAPI);
     const onUpdate = this.onUpdateCallback.get(contextKey);
@@ -3256,6 +3366,60 @@ var BonusStatus;
   BonusStatus[BonusStatus["EXPIRED"] = 6] = "EXPIRED";
 })(BonusStatus || (BonusStatus = {}));
 
+var UserBalanceType;
+(function (UserBalanceType) {
+  UserBalanceType[UserBalanceType["Points"] = 0] = "Points";
+  UserBalanceType[UserBalanceType["Gems"] = 1] = "Gems";
+  UserBalanceType[UserBalanceType["Diamonds"] = 2] = "Diamonds";
+})(UserBalanceType || (UserBalanceType = {}));
+
+const PointsHistoryTransform = items => {
+  if (!items) {
+    return [];
+  }
+  return items.map(item => {
+    const itemTransformed = {
+      create_date: item.create_date,
+      user_ext_id: item.user_ext_id,
+      crm_brand_id: item.crm_brand_id,
+      source_type_id: item.source_type_id
+    };
+    if (item.type === UserBalanceType.Diamonds || item.type === UserBalanceType.Gems) {
+      itemTransformed.type = item.type;
+      itemTransformed.amount = item.amount;
+      itemTransformed.balance = item.balance;
+    }
+    if (item.type === UserBalanceType.Points) {
+      itemTransformed.type = UserBalanceType.Points;
+      itemTransformed.amount = item.points_collected;
+      itemTransformed.balance = item.user_points_balance;
+      itemTransformed.total_ever = item.user_points_ever;
+    }
+    return itemTransformed;
+  });
+};
+
+var PointChangeSourceType;
+(function (PointChangeSourceType) {
+  PointChangeSourceType[PointChangeSourceType["Journey"] = 1] = "Journey";
+  PointChangeSourceType[PointChangeSourceType["AchievementTaskCompletion"] = 2] = "AchievementTaskCompletion";
+  PointChangeSourceType[PointChangeSourceType["AchievementCompletion"] = 3] = "AchievementCompletion";
+  PointChangeSourceType[PointChangeSourceType["LevelsStructureChange"] = 4] = "LevelsStructureChange";
+  PointChangeSourceType[PointChangeSourceType["StorePurchase"] = 5] = "StorePurchase";
+  PointChangeSourceType[PointChangeSourceType["ManualAdjustment"] = 6] = "ManualAdjustment";
+  PointChangeSourceType[PointChangeSourceType["Leaderboard"] = 7] = "Leaderboard";
+  PointChangeSourceType[PointChangeSourceType["Tournament"] = 11] = "Tournament";
+  PointChangeSourceType[PointChangeSourceType["AutomationRule"] = 12] = "AutomationRule";
+  PointChangeSourceType[PointChangeSourceType["TournamentRegistration"] = 13] = "TournamentRegistration";
+  PointChangeSourceType[PointChangeSourceType["TournamentRegistrationCancellation"] = 14] = "TournamentRegistrationCancellation";
+  PointChangeSourceType[PointChangeSourceType["RefundPoints"] = 15] = "RefundPoints";
+  PointChangeSourceType[PointChangeSourceType["PlayMiniGame"] = 16] = "PlayMiniGame";
+  PointChangeSourceType[PointChangeSourceType["WinMiniGame"] = 17] = "WinMiniGame";
+  PointChangeSourceType[PointChangeSourceType["API"] = 18] = "API";
+  PointChangeSourceType[PointChangeSourceType["DynamicFormula"] = 19] = "DynamicFormula";
+  PointChangeSourceType[PointChangeSourceType["Raffle"] = 21] = "Raffle";
+})(PointChangeSourceType || (PointChangeSourceType = {}));
+
 /**
  * @ignore
  */
@@ -3530,6 +3694,28 @@ class SmarticoAPI {
     const results = await this.send(message, ClassId.CHECK_SEGMENT_MATCH_RESPONSE);
     return results.segments || [];
   }
+  /**
+   * Reports an engagement impression event (when engagement content is displayed to the user).
+   */
+  reportEngagementImpression(user_ext_id, engagement_uid, activityType) {
+    const message = this.buildMessage(user_ext_id, ClassId.CLIENT_ENGAGEMENT_IMPRESSION_REQUEST, {
+      engagement_uid,
+      activityType
+    });
+    this.send(message).catch(() => {});
+  }
+  /**
+   * Reports an engagement action event (when user clicks/interacts with engagement content).
+   */
+  reportEngagementAction(user_ext_id, engagement_uid, activityType, action) {
+    const message = this.buildMessage(user_ext_id, ClassId.CLIENT_ENGAGEMENT_ACTION_REQUEST, _extends({
+      engagement_uid,
+      activityType
+    }, action && {
+      action
+    }));
+    this.send(message).catch(() => {});
+  }
   async jackpotGet(user_ext_id, filter, force_language) {
     const message = this.buildMessage(user_ext_id, ClassId.JP_GET_JACKPOTS_REQUEST, filter);
     return await this.send(message, ClassId.JP_GET_JACKPOTS_RESPONSE, force_language);
@@ -4017,6 +4203,16 @@ class SmarticoAPI {
     const message = this.buildMessage(user_ext_id, ClassId.RAF_CLAIM_PRIZE_REQUEST, props);
     return await this.send(message, ClassId.RAF_CLAIM_PRIZE_RESPONSE);
   }
+  async getPointsHistory(user_ext_id, startTimeSeconds, endTimeSeconds) {
+    const message = this.buildMessage(user_ext_id, ClassId.GET_POINT_HISTORY_REQUEST, {
+      startTimeSeconds,
+      endTimeSeconds
+    });
+    return await this.send(message, ClassId.GET_POINT_HISTORY_RESPONSE);
+  }
+  async getPointsHistoryT(user_ext_id, startTimeSeconds, endTimeSeconds) {
+    return PointsHistoryTransform((await this.getPointsHistory(user_ext_id, startTimeSeconds, endTimeSeconds)).logHistory);
+  }
 }
 
 class CookieStore {
@@ -4482,5 +4678,5 @@ var JackpotType;
   JackpotType[JackpotType["Personal"] = 2] = "Personal";
 })(JackpotType || (JackpotType = {}));
 
-export { AchCategoryTransform, AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter, AchievementAvailabilityStatus, AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, AnalyticsInboxSubScreenNameId, AnalyticsInterfaceType, AnalyticsScreenNameId, AnalyticsTournamentsLobbySubScreenNameId, BadgesTimeLimitStates, BonusItemsTransform, BonusStatus, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, ECacheContext, GetJackpotEligibleGamesResponseTransform, GetJackpotWinnersResponseTransform, GetLevelMapResponseTransform, InboxCategories, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, InboxReadStatus, JackPotTemparature, JackpotContributionType, JackpotType, LeaderBoardPeriodType, LiquidEntityData, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, MissionCategory, MissionUtils, OCache, OpenLinksType, PrizeModifiers, PrizeModifiersKeysNames, PublicLabelSettings, QuizAnswersValueType, QuizMarketPerSport, QuizSportType, SAWAcknowledgeType, SAWAcknowledgeTypeName, SAWAcknowledgeTypeNamed, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWExposeUserSpinId, SAWGPMarketType, SAWGameDifficultyType, SAWGameDifficultyTypeName, SAWGameLayout, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWHistoryTransform, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWheelLayout, SAWWinSoundFiles, SAWWinSoundType, SawGameDifficultyTypeNamed, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemPurchaseType, StoreItemPurchasedTransform, StoreItemTransform, StoreItemType, StoreItemTypeName, StoreItemTypeNamed, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UICustomSectionTransform, UserAchievementTransform, enrichUserAchievementsWithBadgeState, getLeaderBoardTransform, marketsInfo, quizAnswerAwayTeamReplacementText, quizAnswerHomeTeamReplacementText, quizAnswersTrKeys, quizDrawReplacementText, quizEvenReplacementText, quizNoGoalsReplacementText, quizNoReplacementText, quizOddReplacementText, quizOrReplacementText, quizSupportedSports, quizYesReplacementText, tournamentInfoItemTransform };
+export { AchCategoryTransform, AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter, AchievementAvailabilityStatus, AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, AnalyticsInboxSubScreenNameId, AnalyticsInterfaceType, AnalyticsScreenNameId, AnalyticsTournamentsLobbySubScreenNameId, AttemptPeriodType, BadgesTimeLimitStates, BonusItemsTransform, BonusStatus, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, ECacheContext, GetJackpotEligibleGamesResponseTransform, GetJackpotWinnersResponseTransform, GetLevelMapResponseTransform, InboxCategories, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, InboxReadStatus, JackPotTemparature, JackpotContributionType, JackpotType, LeaderBoardPeriodType, LiquidEntityData, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, MissionCategory, MissionUtils, OCache, OpenLinksType, PointChangeSourceType, PointsHistoryTransform, PrizeModifiers, PrizeModifiersKeysNames, PublicLabelSettings, QuizAnswersValueType, QuizMarketPerSport, QuizSportType, SAWAcknowledgeType, SAWAcknowledgeTypeName, SAWAcknowledgeTypeNamed, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWExposeUserSpinId, SAWGPMarketType, SAWGameDifficultyType, SAWGameDifficultyTypeName, SAWGameLayout, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWHistoryTransform, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWheelLayout, SAWWinSoundFiles, SAWWinSoundType, SawGameDifficultyTypeNamed, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemPurchaseType, StoreItemPurchasedTransform, StoreItemTransform, StoreItemType, StoreItemTypeName, StoreItemTypeNamed, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UICustomSectionTransform, UserAchievementTransform, UserBalanceType, enrichUserAchievementsWithBadgeState, getLeaderBoardTransform, marketsInfo, quizAnswerAwayTeamReplacementText, quizAnswerHomeTeamReplacementText, quizAnswersTrKeys, quizDrawReplacementText, quizEvenReplacementText, quizNoGoalsReplacementText, quizNoReplacementText, quizOddReplacementText, quizOrReplacementText, quizSupportedSports, quizYesReplacementText, tournamentInfoItemTransform };
 //# sourceMappingURL=index.modern.mjs.map