@smartico/public-api 0.0.324 → 0.0.326

package/dist/Base/ClassId.d.ts

@@ -68,6 +68,8 @@ export declare enum ClassId {
     ACH_SHOP_ITEM_HISTORY_RESPONSE = 542,
     GET_RELATED_ACH_N_TOURNAMENTS_REQUEST = 543,
     GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE = 544,
+    GET_POINT_HISTORY_REQUEST = 545,
+    GET_POINT_HISTORY_RESPONSE = 546,
     GET_BONUSES_REQUEST = 600,
     GET_BONUSES_RESPONSE = 601,
     CLAIM_BONUS_REQUEST = 602,

package/dist/MiniGames/AttemptPeriodType.d.ts

@@ -0,0 +1,6 @@
+export declare enum AttemptPeriodType {
+    FromLastAttempt = 1,
+    CalendarDaysUTC = 2,
+    CalendarDaysUserTimeZone = 3,
+    Lifetime = 4
+}

package/dist/MiniGames/SAWPrize.d.ts

@@ -1,3 +1,4 @@
+import { AttemptPeriodType } from './AttemptPeriodType';
 import { SAWPrizeType } from './SAWPrizeType';
 import { SAWPrizeUI } from './SAWPrizeUI';
 export interface SAWPrize {
@@ -20,4 +21,5 @@ export interface SAWPrize {
     prize_details_json?: {
         [key: string]: any;
     };
+    max_give_period_type_id?: AttemptPeriodType;
 }

package/dist/MiniGames/index.d.ts

@@ -29,3 +29,4 @@ export * from './PrizeModifiers';
 export * from './SAWWheelLayout';
 export * from './SAWGameDifficulty';
 export * from './SAWExposeUserSpinId';
+export * from './AttemptPeriodType';

package/dist/PointsHistory/GetPointsHistoryRequest.d.ts

@@ -0,0 +1,6 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+export interface GetPointsHistoryRequest extends ProtocolMessage {
+    userId: number;
+    startTimeSeconds: number;
+    endTimeSeconds: number;
+}

package/dist/PointsHistory/GetPointsHistoryResponse.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { PointsHistoryLog } from './PointsHistoryLog';
+import { TPointsHistoryLog } from '../WSAPI/WSAPITypes';
+export interface GetPointsHistoryResponse extends ProtocolResponse {
+    logHistory: PointsHistoryLog[];
+}
+export declare const PointsHistoryTransform: (items: PointsHistoryLog[]) => TPointsHistoryLog[];

package/dist/PointsHistory/PointChangeSourceType.d.ts

@@ -0,0 +1,19 @@
+export declare enum PointChangeSourceType {
+    Journey = 1,
+    AchievementTaskCompletion = 2,
+    AchievementCompletion = 3,
+    LevelsStructureChange = 4,
+    StorePurchase = 5,
+    ManualAdjustment = 6,
+    Leaderboard = 7,
+    Tournament = 11,
+    AutomationRule = 12,
+    TournamentRegistration = 13,
+    TournamentRegistrationCancellation = 14,
+    RefundPoints = 15,
+    PlayMiniGame = 16,
+    WinMiniGame = 17,
+    API = 18,
+    DynamicFormula = 19,
+    Raffle = 21
+}

package/dist/PointsHistory/PointsHistoryLog.d.ts

@@ -0,0 +1,21 @@
+import { PointChangeSourceType } from './PointChangeSourceType';
+import { UserBalanceType } from './UserBalanceType';
+export interface PointsLog {
+    create_date: number;
+    user_ext_id: string;
+    crm_brand_id: number;
+    points_collected: number;
+    user_points_ever: number;
+    user_points_balance: number;
+    source_type_id: PointChangeSourceType;
+}
+export interface GemsDiamondsLog {
+    create_date: number;
+    user_ext_id: string;
+    crm_brand_id: number;
+    type: UserBalanceType;
+    amount: number;
+    balance: number;
+    source_type_id: PointChangeSourceType;
+}
+export type PointsHistoryLog = PointsLog | GemsDiamondsLog;

package/dist/PointsHistory/UserBalanceType.d.ts

@@ -0,0 +1,5 @@
+export declare enum UserBalanceType {
+    Points = 0,
+    Gems = 1,
+    Diamonds = 2
+}

package/dist/PointsHistory/index.d.ts

@@ -0,0 +1,5 @@
+export * from './GetPointsHistoryRequest';
+export * from './GetPointsHistoryResponse';
+export * from './PointsHistoryLog';
+export * from './PointChangeSourceType';
+export * from './UserBalanceType';

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';
@@ -11,7 +11,7 @@ import { GetTournamentInfoResponse, GetTournamentsResponse, TournamentRegisterRe
 import { LeaderBoardDetails, LeaderBoardPeriodType } from './Leaderboard';
 import { GetLevelMapResponse } from './Level';
 import { WSAPI } from './WSAPI/WSAPI';
-import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult, TUICustomSection, TBonus, TRaffle, TLevelCurrent } from './WSAPI/WSAPITypes';
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult, TUICustomSection, TBonus, TRaffle, TLevelCurrent, TPointsHistoryLog } from './WSAPI/WSAPITypes';
 import { GetAchievementsUserInfoResponse } from './Core/GetAchievementsUserInfoResponse';
 import { GetJackpotsPotsResponse, GetJackpotsResponse, JackpotsOptinResponse, JackpotsOptoutResponse } from './Jackpots';
 import { GetCustomSectionsResponse } from './CustomSections';
@@ -20,6 +20,7 @@ import { SAWDoSpinBatchResponse } from './MiniGames/SAWDoSpinBatchResponse';
 import { SAWDoAcknowledgeBatchResponse } from './MiniGames/SAWDoAcknowledgeBatchResponse';
 import { GetRelatedAchTourResponse } from './Missions/GetRelatedAchTourResponse';
 import { GetRafflesResponse } from './Raffle/GetRafflesResponse';
+import { GetPointsHistoryResponse } from './PointsHistory';
 import { InboxCategories } from './Inbox/InboxCategories';
 import { GetDrawRunResponse, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeResponse } from './Raffle';
 import { GetJackpotWinnersResponse, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
@@ -71,6 +72,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;
@@ -159,5 +168,7 @@ declare class SmarticoAPI {
     claimRafflePrize(user_ext_id: string, props: {
         won_id: number;
     }): Promise<RaffleClaimPrizeResponse>;
+    getPointsHistory(user_ext_id: string, startTimeSeconds: number, endTimeSeconds: number): Promise<GetPointsHistoryResponse>;
+    getPointsHistoryT(user_ext_id: string, startTimeSeconds: number, endTimeSeconds: number): Promise<TPointsHistoryLog[]>;
 }
 export { SmarticoAPI, MessageSender };

package/dist/WSAPI/WSAPI.d.ts

@@ -1,5 +1,6 @@
+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 { 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, TPointsHistoryLog } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { JackpotDetails, JackpotWinnerHistory, JackpotsOptinResponse, JackpotsOptoutResponse } from '../Jackpots';
 import { GetRelatedAchTourResponse } from '../Missions/GetRelatedAchTourResponse';
@@ -496,6 +497,86 @@ 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;
+    /**
+     * 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
+     */
+    getPointsHistory({ startTimeSeconds, endTimeSeconds, onUpdate, }: {
+        startTimeSeconds: number;
+        endTimeSeconds: number;
+        onUpdate?: (data: TPointsHistoryLog[]) => void;
+    }): Promise<TPointsHistoryLog[]>;
     private updateOnSpin;
     private reloadMiniGameTemplate;
     private updateMissions;
@@ -506,6 +587,7 @@ export declare class WSAPI {
     private updateInboxUnreadCount;
     private updateInboxMessages;
     private updateRaffles;
+    private notifyPointsHistoryUpdate;
     private updateEntity;
     private jackpotClearCache;
     /** Returns list of Jackpots that are active in the systen and matching to the filter definition.

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1,5 +1,5 @@
 import { BuyStoreItemErrorCode } from '../Store';
-import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWAskForUsername, SAWBuyInTypeName, SAWGameLayout, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
+import { AttemptPeriodType, MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWAskForUsername, SAWBuyInTypeName, SAWGameLayout, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
 import { AchievementAvailabilityStatus, BadgesTimeLimitStates } from '../Missions';
 import { LeaderBoardPeriodType } from '../Leaderboard';
@@ -7,6 +7,8 @@ import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, Ach
 import { PrizeModifiers } from '../MiniGames/PrizeModifiers';
 import { InboxCategories } from '../Inbox/InboxCategories';
 import { RaffleDrawInstanceState, RaffleDrawTypeExecution } from '../Raffle';
+import { PointChangeSourceType } from '../PointsHistory/PointChangeSourceType';
+import { UserBalanceType } from '../PointsHistory/UserBalanceType';
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
 /**
  * TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
@@ -74,6 +76,8 @@ export interface TMiniGamePrize {
     hide_prize_from_history?: boolean;
     /** Requirements to claim the prize  (lootbox specific)*/
     requirements_to_get_prize?: string;
+    /** The period type for the prize to be given: Time from last attempt, Calendar days UTC, Calendar days user time zone, Lifetime */
+    max_give_period_type_id?: AttemptPeriodType;
 }
 /**
  * TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame(template_id) method
@@ -1177,4 +1181,26 @@ export interface TransformedRaffleClaimPrizeResponse {
     /** Error message, will be exposed only if ErrorCode is not 0 */
     errorMessage?: string;
 }
-export { SAWAcknowledgeTypeName, PrizeModifiers, SAWTemplateUI, InboxCategories, AchCustomSectionType, SAWAskForUsername, SAWGameLayout };
+/**
+ * TPointsHistoryLog describes a unified history log entry for points, gems, or diamonds changes.
+ * The structure is the same regardless of balance type, making it easy to iterate and display.
+ */
+export interface TPointsHistoryLog {
+    /** Date when the change was created (epoch timestamp in seconds) */
+    create_date: number;
+    /** External user ID */
+    user_ext_id: string;
+    /** CRM brand ID */
+    crm_brand_id: number;
+    /** Type of balance: Points = 0, Gems = 1, Diamonds = 2 */
+    type: UserBalanceType;
+    /** Amount changed (positive or negative) */
+    amount: number;
+    /** Current balance after this change */
+    balance: number;
+    /** Total ever collected (only relevant for type points) */
+    total_ever?: number;
+    /** Source type ID indicating what triggered this change */
+    source_type_id: PointChangeSourceType;
+}
+export { SAWAcknowledgeTypeName, PrizeModifiers, SAWTemplateUI, InboxCategories, AchCustomSectionType, SAWAskForUsername, SAWGameLayout, PointChangeSourceType, UserBalanceType };

package/dist/index.d.ts

@@ -17,3 +17,4 @@ export * from './Jackpots';
 export * from './OCache';
 export * from './Bonuses';
 export * from './CustomSections';
+export * from './PointsHistory';