@smartico/public-api 0.0.325 → 0.0.327

package/docs/README.md

@@ -13,6 +13,7 @@
 - [JackPotTemparature](enums/JackPotTemparature.md)
 - [JackpotType](enums/JackpotType.md)
 - [LeaderBoardPeriodType](enums/LeaderBoardPeriodType.md)
+- [AttemptPeriodType](enums/AttemptPeriodType.md)
 - [PrizeModifiers](enums/PrizeModifiers.md)
 - [SAWAcknowledgeType](enums/SAWAcknowledgeType.md)
 - [SAWAcknowledgeTypeName](enums/SAWAcknowledgeTypeName.md)
@@ -31,6 +32,8 @@
 - [SAWWheelLayout](enums/SAWWheelLayout.md)
 - [SAWWinSoundType](enums/SAWWinSoundType.md)
 - [AchievementAvailabilityStatus](enums/AchievementAvailabilityStatus.md)
+- [PointChangeSourceType](enums/PointChangeSourceType.md)
+- [UserBalanceType](enums/UserBalanceType.md)
 - [RaffleDrawInstanceState](enums/RaffleDrawInstanceState.md)
 - [RaffleDrawTypeExecution](enums/RaffleDrawTypeExecution.md)
 - [BuyStoreItemErrorCode](enums/BuyStoreItemErrorCode.md)
@@ -145,6 +148,7 @@
 - [TRaffleDraw](interfaces/TRaffleDraw.md)
 - [TRaffleDrawRun](interfaces/TRaffleDrawRun.md)
 - [TransformedRaffleClaimPrizeResponse](interfaces/TransformedRaffleClaimPrizeResponse.md)
+- [TPointsHistoryLog](interfaces/TPointsHistoryLog.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -986,6 +986,47 @@ _smartico.api.reportClickEvent({
 
 ___
 
+### getPointsHistory
+
+▸ **getPointsHistory**(`«destructured»`): `Promise`\<[`TPointsHistoryLog`](../interfaces/TPointsHistoryLog.md)[]\>
+
+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**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `startTimeSeconds` | `number` |
+| › `endTimeSeconds` | `number` |
+| › `onUpdate?` | (`data`: [`TPointsHistoryLog`](../interfaces/TPointsHistoryLog.md)[]) => `void` |
+
+#### Returns
+
+`Promise`\<[`TPointsHistoryLog`](../interfaces/TPointsHistoryLog.md)[]\>
+
+___
+
 ### jackpotGet
 
 ▸ **jackpotGet**(`filter?`): `Promise`\<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>

package/docs/enums/AchCustomSectionType.md

@@ -71,3 +71,9 @@ ___
 ### RAFFLE
 
 • **RAFFLE** = ``13``
+
+___
+
+### BADGES
+
+• **BADGES** = ``14``

package/docs/enums/AttemptPeriodType.md

@@ -0,0 +1,25 @@
+# Enumeration: AttemptPeriodType
+
+## Enumeration Members
+
+### FromLastAttempt
+
+• **FromLastAttempt** = ``1``
+
+___
+
+### CalendarDaysUTC
+
+• **CalendarDaysUTC** = ``2``
+
+___
+
+### CalendarDaysUserTimeZone
+
+• **CalendarDaysUserTimeZone** = ``3``
+
+___
+
+### Lifetime
+
+• **Lifetime** = ``4``

package/docs/enums/PointChangeSourceType.md

@@ -0,0 +1,103 @@
+# Enumeration: PointChangeSourceType
+
+## Enumeration Members
+
+### Journey
+
+• **Journey** = ``1``
+
+___
+
+### AchievementTaskCompletion
+
+• **AchievementTaskCompletion** = ``2``
+
+___
+
+### AchievementCompletion
+
+• **AchievementCompletion** = ``3``
+
+___
+
+### LevelsStructureChange
+
+• **LevelsStructureChange** = ``4``
+
+___
+
+### StorePurchase
+
+• **StorePurchase** = ``5``
+
+___
+
+### ManualAdjustment
+
+• **ManualAdjustment** = ``6``
+
+___
+
+### Leaderboard
+
+• **Leaderboard** = ``7``
+
+___
+
+### Tournament
+
+• **Tournament** = ``11``
+
+___
+
+### AutomationRule
+
+• **AutomationRule** = ``12``
+
+___
+
+### TournamentRegistration
+
+• **TournamentRegistration** = ``13``
+
+___
+
+### TournamentRegistrationCancellation
+
+• **TournamentRegistrationCancellation** = ``14``
+
+___
+
+### RefundPoints
+
+• **RefundPoints** = ``15``
+
+___
+
+### PlayMiniGame
+
+• **PlayMiniGame** = ``16``
+
+___
+
+### WinMiniGame
+
+• **WinMiniGame** = ``17``
+
+___
+
+### API
+
+• **API** = ``18``
+
+___
+
+### DynamicFormula
+
+• **DynamicFormula** = ``19``
+
+___
+
+### Raffle
+
+• **Raffle** = ``21``

package/docs/enums/UserBalanceType.md

@@ -0,0 +1,19 @@
+# Enumeration: UserBalanceType
+
+## Enumeration Members
+
+### Points
+
+• **Points** = ``0``
+
+___
+
+### Gems
+
+• **Gems** = ``1``
+
+___
+
+### Diamonds
+
+• **Diamonds** = ``2``

package/docs/interfaces/SAWPrize.md

@@ -105,3 +105,9 @@ ___
 #### Index signature
 
 ▪ [key: `string`]: `any`
+
+___
+
+### max\_give\_period\_type\_id
+
+• `Optional` **max\_give\_period\_type\_id**: [`AttemptPeriodType`](../enums/AttemptPeriodType.md)

package/docs/interfaces/TMiniGamePrize.md

@@ -242,3 +242,11 @@ ___
 • `Optional` **requirements\_to\_get\_prize**: `string`
 
 Requirements to claim the prize  (lootbox specific)
+
+___
+
+### max\_give\_period\_type\_id
+
+• `Optional` **max\_give\_period\_type\_id**: [`AttemptPeriodType`](../enums/AttemptPeriodType.md)
+
+The period type for the prize to be given: Time from last attempt, Calendar days UTC, Calendar days user time zone, Lifetime

package/docs/interfaces/TPointsHistoryLog.md

@@ -0,0 +1,68 @@
+# Interface: TPointsHistoryLog
+
+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.
+
+## Properties
+
+### create\_date
+
+• **create\_date**: `number`
+
+Date when the change was created (epoch timestamp in seconds)
+
+___
+
+### user\_ext\_id
+
+• **user\_ext\_id**: `string`
+
+External user ID
+
+___
+
+### crm\_brand\_id
+
+• **crm\_brand\_id**: `number`
+
+CRM brand ID
+
+___
+
+### type
+
+• **type**: [`UserBalanceType`](../enums/UserBalanceType.md)
+
+Type of balance: Points = 0, Gems = 1, Diamonds = 2
+
+___
+
+### amount
+
+• **amount**: `number`
+
+Amount changed (positive or negative)
+
+___
+
+### balance
+
+• **balance**: `number`
+
+Current balance after this change
+
+___
+
+### total\_ever
+
+• `Optional` **total\_ever**: `number`
+
+Total ever collected (only relevant for type points)
+
+___
+
+### source\_type\_id
+
+• **source\_type\_id**: [`PointChangeSourceType`](../enums/PointChangeSourceType.md)
+
+Source type ID indicating what triggered this change

package/docs/interfaces/TUICustomSection.md

@@ -119,3 +119,11 @@ ___
 • `Optional` **liquid\_template**: `number`
 
 Liquid template id to be used for Liquid templates
+
+___
+
+### ach\_category\_ids
+
+• `Optional` **ach\_category\_ids**: `number`[]
+
+List of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@smartico/public-api",
-	"version": "0.0.325",
+	"version": "0.0.327",
 	"description": "Smartico public API",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/Base/ClassId.ts

@@ -99,6 +99,9 @@ export enum ClassId {
 	GET_RELATED_ACH_N_TOURNAMENTS_REQUEST = 543,
 	GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE = 544,
 
+	GET_POINT_HISTORY_REQUEST = 545,
+	GET_POINT_HISTORY_RESPONSE = 546,
+
 	/*
         !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

package/src/CustomSections/AchCustomSection.ts

@@ -11,6 +11,7 @@ export enum AchCustomSectionType {
 	LOOTBOX_CALENDAR_DAYS = 11,
 	TREASURE_HUNT = 12,
 	RAFFLE = 13,
+	BADGES = 14,
 }
 
 export enum AchCustomLayoutTheme {

package/src/CustomSections/UICustomSection.ts

@@ -23,6 +23,7 @@ export interface UICustomSection {
 	ach_tournament_id?: number;
 	show_raw_data?: boolean;
 	liquid_template?: number;
+	ach_category_ids?: number[];
 }
 
 export const UICustomSectionTransform = (response: GetCustomSectionsResponse): TUICustomSection[] => {
@@ -54,6 +55,12 @@ export const UICustomSectionTransform = (response: GetCustomSectionsResponse): T
 					}
 					: {}
 				),
+				...(r.section_type_id === AchCustomSectionType.BADGES
+					? {
+						ach_category_ids: r.ach_category_ids,
+					}
+					: {}
+				),
 			};
 
 			items.push(x);

package/src/MiniGames/AttemptPeriodType.ts

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

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -80,6 +80,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					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,
+					max_give_period_type_id: p.max_give_period_type_id,
 				};
 				return y;
 			}),

package/src/MiniGames/SAWPrize.ts

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

package/src/MiniGames/index.ts

@@ -28,4 +28,5 @@ export * from './SAWGameLayout';
 export * from './PrizeModifiers';
 export * from './SAWWheelLayout';
 export * from './SAWGameDifficulty'
-export * from './SAWExposeUserSpinId';
+export * from './SAWExposeUserSpinId';
+export * from './AttemptPeriodType';

package/src/PointsHistory/GetPointsHistoryRequest.ts

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

package/src/PointsHistory/GetPointsHistoryResponse.ts

@@ -0,0 +1,39 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { PointsHistoryLog } from './PointsHistoryLog';
+import { TPointsHistoryLog } from '../WSAPI/WSAPITypes';
+import { UserBalanceType } from './UserBalanceType';
+
+export interface GetPointsHistoryResponse extends ProtocolResponse {
+	logHistory: PointsHistoryLog[];
+}
+
+export const PointsHistoryTransform = (items: PointsHistoryLog[]): TPointsHistoryLog[] => {
+	if (!items) {
+		return [];
+	}
+
+	return items.map((item: any): TPointsHistoryLog => {
+		const itemTransformed: Partial<TPointsHistoryLog> = {
+			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 as TPointsHistoryLog;
+	});
+};
+

package/src/PointsHistory/PointChangeSourceType.ts

@@ -0,0 +1,20 @@
+export 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/src/PointsHistory/PointsHistoryLog.ts

@@ -0,0 +1,24 @@
+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/src/PointsHistory/UserBalanceType.ts

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

package/src/PointsHistory/index.ts

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

package/src/SmarticoAPI.ts

@@ -98,6 +98,7 @@ import {
 	TBonus,
 	TRaffle,
 	TLevelCurrent,
+	TPointsHistoryLog,
 } from './WSAPI/WSAPITypes';
 import { getLeaderBoardTransform } from './Leaderboard/LeaderBoards';
 import { GetAchievementsUserInfoResponse } from './Core/GetAchievementsUserInfoResponse';
@@ -124,6 +125,7 @@ import { GetRelatedAchTourRequest } from './Missions/GetRelatedAchTourRequest';
 import { GetRelatedAchTourResponse } from './Missions/GetRelatedAchTourResponse';
 import { GetRafflesResponse, raffleTransform } from './Raffle/GetRafflesResponse';
 import { GetRafflesRequest } from './Raffle/GetRafflesRequest';
+import { GetPointsHistoryRequest, GetPointsHistoryResponse, PointsHistoryTransform } from './PointsHistory';
 import { InboxCategories } from './Inbox/InboxCategories';
 import { GetDrawRunRequest, GetDrawRunResponse, GetRaffleDrawRunsHistoryRequest, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeRequest, RaffleClaimPrizeResponse } from './Raffle';
 import { GetJackpotWinnersResponse, GetJackpotWinnersResponseTransform, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
@@ -1323,6 +1325,33 @@ class SmarticoAPI {
 		return await this.send<RaffleClaimPrizeResponse>(message, ClassId.RAF_CLAIM_PRIZE_RESPONSE);
 
 	}
+
+	public async getPointsHistory(
+		user_ext_id: string,
+		startTimeSeconds: number,
+		endTimeSeconds: number,
+	): Promise<GetPointsHistoryResponse> {
+		const message = this.buildMessage<GetPointsHistoryRequest, GetPointsHistoryResponse>(
+			user_ext_id,
+			ClassId.GET_POINT_HISTORY_REQUEST,
+			{
+				startTimeSeconds,
+				endTimeSeconds,
+			},
+		);
+
+		return await this.send<GetPointsHistoryResponse>(message, ClassId.GET_POINT_HISTORY_RESPONSE);
+	}
+
+	public async getPointsHistoryT(
+		user_ext_id: string,
+		startTimeSeconds: number,
+		endTimeSeconds: number,
+	): Promise<TPointsHistoryLog[]> {
+		return PointsHistoryTransform(
+			(await this.getPointsHistory(user_ext_id, startTimeSeconds, endTimeSeconds)).logHistory,
+		);
+	}
 }
 
 export { SmarticoAPI, MessageSender };

package/src/WSAPI/WSAPI.ts

@@ -36,7 +36,8 @@ import {
 	TRaffleDraw,
 	TRaffleDrawRun,
 	TransformedRaffleClaimPrizeResponse,
-	TLevelCurrent
+	TLevelCurrent,
+	TPointsHistoryLog,
 } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import {
@@ -92,6 +93,7 @@ enum onUpdateContextKey {
 	JackpotEligibleGames = 'jackpotEligibleGames',
 	CurrentLevel = 'currentLevel',
 	InboxUnreadCount = 'inboxUnreadCount',
+	PointsHistory = 'pointsHistory',
 }
 
 /** @group General API */
@@ -143,10 +145,13 @@ export class WSAPI {
 					this.updateInboxUnreadCount(res.unread_count);
 				}
 			});
-			on(ClassId.CLIENT_PUBLIC_PROPERTIES_CHANGED_EVENT, (data: { props: { core_inbox_unread_count: number } }) => {
+			on(ClassId.CLIENT_PUBLIC_PROPERTIES_CHANGED_EVENT, (data: { props: { core_inbox_unread_count?: number; ach_points_balance?: number; ach_gems_balance?: number; ach_diamonds_balance?: number } }) => {
 				if (data?.props?.core_inbox_unread_count !== undefined && data?.props?.core_inbox_unread_count !== null) {
 					this.updateInboxUnreadCount(data.props.core_inbox_unread_count);
 				}
+				if (data?.props?.ach_points_balance !== undefined || data?.props?.ach_gems_balance !== undefined || data?.props?.ach_diamonds_balance !== undefined) {
+					this.notifyPointsHistoryUpdate();
+				}
 			});
 		}
 	}
@@ -1006,6 +1011,55 @@ export class WSAPI {
 		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
+	 */
+	public async getPointsHistory({
+		startTimeSeconds,
+		endTimeSeconds,
+		onUpdate,
+	}: {
+		startTimeSeconds: number;
+		endTimeSeconds: number;
+		onUpdate?: (data: TPointsHistoryLog[]) => void;
+	}): Promise<TPointsHistoryLog[]> {
+
+		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,
+		);
+	}
+
 	private async updateOnSpin(data: SAWSpinsCountPush) {
 		const templates: TMiniGameTemplate[] = await OCache.use(
 			onUpdateContextKey.Saw,
@@ -1062,6 +1116,14 @@ export class WSAPI {
 		this.updateEntity(onUpdateContextKey.Raffles, payload);
 	}
 
+	private 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);
+	}
+
 	private async updateEntity(contextKey: onUpdateContextKey, payload: any) {
 		OCache.set(contextKey, payload, ECacheContext.WSAPI);