@smartico/public-api 0.0.173 → 0.0.174

package/docs/README.md

@@ -60,6 +60,7 @@
 - [TUICustomSection](interfaces/TUICustomSection.md)
 - [TBonus](interfaces/TBonus.md)
 - [TClaimBonusResult](interfaces/TClaimBonusResult.md)
+- [TSawHistory](interfaces/TSawHistory.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -415,6 +415,42 @@ _smartico.vapi('EN').getMiniGames().then((result) => {
 
 ___
 
+### getMiniGamesHistory
+
+▸ **getMiniGamesHistory**(`«destructured»?`): `Promise`\<[`TSawHistory`](../interfaces/TSawHistory.md)[]\>
+
+Returns the list of mini-games based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
+The maximum number of items per request is limited to 20.
+You can leave this params empty and by default it will return list of mini-games ranging from 0 to 20.
+The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGamesHistory with a new onUpdate callback, the old one will be overwritten by the new one.
+Updated templates will be passed to onUpdate callback.
+
+**Example**:
+```
+_smartico.api.getMiniGamesHistory().then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `limit?` | `number` |
+| › `offset?` | `number` |
+| › `saw_template_id?` | `number` |
+| › `onUpdate?` | (`data`: [`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]) => `void` |
+
+#### Returns
+
+`Promise`\<[`TSawHistory`](../interfaces/TSawHistory.md)[]\>
+
+___
+
+
 ### playMiniGame
 
 ▸ **playMiniGame**(`template_id`, `«destructured»?`): `Promise`\<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>

package/docs/interfaces/TSawHistory.md

@@ -0,0 +1,53 @@
+# Interface: TSawHistory
+
+TSawHistory describes the information of the history of mini-games.
+
+## Properties
+
+### template
+
+• **template**: `SAWTemplate`
+
+The initial information about mini-game.
+
+___
+
+### saw_template_id
+
+• **saw_template_id**: `number`
+
+ID of the mini-game template.
+
+___
+
+### saw_prize_id
+
+• **saw_prize_id**: `number`
+
+The saw_prize_id that user won, details of the prize can be found in the mini-game definition.
+
+___
+
+### prize_amount
+
+• **prize_amount**: `number`
+
+Amount of prizes in stock.
+
+___
+
+### client_request_id
+
+• **client_request_id**: `string`
+
+Request ID that client is sending to show history.
+
+___
+
+### is_claimed
+
+• **is_claimed**: `boolean`
+
+Flag indicating to show whether prize in the mini-game claimed or not.
+
+___

package/package.json

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

package/src/Base/ClassId.ts

@@ -126,6 +126,9 @@ export enum ClassId {
 	SAW_AKNOWLEDGE_BATCH_REQUEST = 714,
 	SAW_AKNOWLEDGE_BATCH_RESPONSE = 715,
 
+	GET_SAW_HISTORY_REQUEST = 716,
+	GET_SAW_HISTORY_RESPONSE = 717,
+
 	/*
         !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/MiniGames/SAWGetTemplatesResponse.ts

@@ -52,6 +52,9 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					pool: p.pool,
 					pool_initial: p.pool_initial,
 					wins_count: p.wins_count,
+					weekdays: p.weekdays,
+					active_from_ts: p.active_from_ts,
+					active_till_ts: p.active_till_ts,
 				};
 				return y;
 			}),

package/src/MiniGames/SAWPrize.ts

@@ -12,4 +12,7 @@ export interface SAWPrize {
 	pool?: number;
 	pool_initial?: number;
 	wins_count?: number;
+	weekdays?: number[];
+	active_from_ts?: number;
+	active_till_ts?: number;
 }

package/src/MiniGames/SAWWinningHistoryRequest.ts

@@ -0,0 +1,8 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface SAWWinningHistoryRequest extends ProtocolMessage {
+    limit: number;
+    offset: number;
+    saw_template_id?: number;
+    only_claimed?: boolean;
+}

package/src/MiniGames/SAWWinningHistoryResponse.ts

@@ -0,0 +1,31 @@
+import { ProtocolResponse } from "../SmarticoLib";
+import { TSawHistory } from "../WSAPI/WSAPITypes";
+import { SAWTemplate } from "./SAWTemplate";
+
+export interface SAWWinningHistoryResponse extends ProtocolResponse {
+	prizes: SAWPrizesHistory[];
+}
+
+export interface SAWPrizesHistory {
+	template: SAWTemplate,
+	saw_template_id: number,
+	saw_prize_id: number,
+	prize_amount: number,
+	client_request_id: string,
+	is_claimed: boolean,
+}
+
+export const SAWHistoryTransform = (items: SAWPrizesHistory[]): TSawHistory[] => {
+	return items.map((r) => {
+		const x: TSawHistory = {
+			template: r.template,
+			saw_template_id: r.saw_template_id,
+			saw_prize_id: r.saw_prize_id,
+			prize_amount: r.prize_amount,
+			client_request_id: r.client_request_id,
+			is_claimed: r.is_claimed
+		}
+		return x;
+	})
+}
+

package/src/MiniGames/index.ts

@@ -22,3 +22,5 @@ export * from './SAWPrizeDropAknowledgeRequest';
 export * from './SAWPrizeDropAknowledgeResponse';
 export * from './SAWEventSawPush';
 export * from './SAWAcknowledgeSpinPushRequest';
+export * from './SAWWinningHistoryRequest';
+export * from './SAWWinningHistoryResponse';

package/src/Missions/GetRelatedAchTourRequest.ts

@@ -2,4 +2,5 @@ import { ProtocolMessage } from '../Base/ProtocolMessage';
 
 export interface GetRelatedAchTourRequest extends ProtocolMessage {
 	related_game_id?: string;
+	force_language?: string;
 }

package/src/SmarticoAPI.ts

@@ -10,8 +10,13 @@ import {
 	SAWDoAknowledgeResponse,
 	SAWDoSpinRequest,
 	SAWDoSpinResponse,
+	SAWHistoryTransform,
+	SAWPrizesHistory,
 	SAWSpinErrorCode,
+	SAWTemplate,
 	SAWTemplatesTransform,
+	SAWWinningHistoryRequest,
+	SAWWinningHistoryResponse,
 } from './MiniGames';
 import { ECacheContext, OCache } from './OCache';
 import {
@@ -89,6 +94,7 @@ import {
 	TSegmentCheckResult,
 	TUICustomSection,
 	TBonus,
+	TSawHistory,
 } from './WSAPI/WSAPITypes';
 import { getLeaderBoardTransform } from './Leaderboard/LeaderBoards';
 import { GetAchievementsUserInfoResponse } from './Core/GetAchievementsUserInfoResponse';
@@ -584,6 +590,18 @@ class SmarticoAPI {
 		return { ...spinAttemptResponse };
 	}
 
+	public async getSawWinningHistory(user_ext_id: string, limit: number = 20, offset: number = 0, saw_template_id: number): Promise<SAWWinningHistoryResponse> {
+		const message = this.buildMessage<SAWWinningHistoryRequest, SAWWinningHistoryResponse>(user_ext_id, ClassId.GET_SAW_HISTORY_REQUEST, {
+			limit, offset, saw_template_id
+		})
+
+		return await this.send<SAWWinningHistoryResponse>(message, ClassId.GET_SAW_HISTORY_RESPONSE);
+	}
+
+	public async getSawWinningHistoryT(user_ext_id: string, limit?: number, offset?: number, saw_template_id?: number): Promise<SAWPrizesHistory[]> {
+		return SAWHistoryTransform((await this.getSawWinningHistory(user_ext_id, limit, offset, saw_template_id)).prizes);
+	}
+	
 	public async missionOptIn(user_ext_id: string, mission_id: number) {
 		if (!mission_id) {
 			throw new Error('Missing mission id');
@@ -1075,7 +1093,7 @@ class SmarticoAPI {
 		return new WSAPI(this);
 	}
 
-	public async getRelatedItemsForGame(user_ext_id: string, related_game_id: string,): Promise<GetRelatedAchTourResponse> {
+	public async getRelatedItemsForGame(user_ext_id: string, related_game_id: string, force_language?: string,): Promise<GetRelatedAchTourResponse> {
 		const message = this.buildMessage< GetRelatedAchTourRequest, GetRelatedAchTourResponse>(
 			user_ext_id,
 			ClassId.GET_RELATED_ACH_N_TOURNAMENTS_REQUEST,
@@ -1084,7 +1102,7 @@ class SmarticoAPI {
 			}
 		);
 		
-		return await this.send<GetRelatedAchTourResponse>(message, ClassId.GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE);
+		return await this.send<GetRelatedAchTourResponse>(message, ClassId.GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE, force_language);
 
 	}
 }

package/src/WSAPI/WSAPI.ts

@@ -1,6 +1,6 @@
 import { ClassId } from '../Base/ClassId';
 import { CoreUtils } from '../Core';
-import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWGetTemplatesResponse, SAWSpinErrorCode, SAWSpinsCountPush } from '../MiniGames';
+import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWGetTemplatesResponse, SAWSpinErrorCode, SAWSpinsCountPush, SAWWinningHistoryRequest, SAWWinningHistoryResponse } from '../MiniGames';
 import { ECacheContext, OCache } from '../OCache';
 import { SmarticoAPI } from '../SmarticoAPI';
 import {
@@ -27,7 +27,8 @@ import {
 	TUserProfile,
 	UserLevelExtraCountersT,TBonus,
 	TClaimBonusResult,
-	TMiniGamePlayBatchResult
+	TMiniGamePlayBatchResult,
+	TSawHistory
 } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import {
@@ -455,6 +456,42 @@ export class WSAPI {
 		return OCache.use(onUpdateContextKey.Saw, ECacheContext.WSAPI, () => this.api.sawGetTemplatesT(null), CACHE_DATA_SEC);
 	}
 
+	/**
+	 * Returns the list of mini-games based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
+	 * The maximum number of items per request is limited to 20.
+	 * You can leave this params empty and by default it will return list of mini-games ranging from 0 to 20.
+	 * The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGamesHistory with a new onUpdate callback, the old one will be overwritten by the new one.
+	 * Updated templates will be passed to onUpdate callback.
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getMiniGamesHistory().then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 *
+	 * **Visitor mode: not supported**
+	*/	
+
+	public async getMiniGamesHistory({
+		limit,
+		offset,
+		saw_template_id,
+		onUpdate
+	} : { limit?: number, offset?: number, saw_template_id?: number, onUpdate?: (data: TMiniGameTemplate[]) => void }): Promise<TSawHistory[]> {
+
+		if (onUpdate) {
+			this.onUpdateCallback.set(onUpdateContextKey.Saw, onUpdate);
+		}
+		
+		return OCache.use(
+			onUpdateContextKey.Saw,
+			ECacheContext.WSAPI,
+			() => this.api.getSawWinningHistoryT(null, limit, offset, saw_template_id),
+			CACHE_DATA_SEC,
+		);
+	}
+
 	/**
 	 * Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
  	 * After playMiniGame is called, you can call getMiniGames to get the list of mini-games.The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call playMiniGame with a new onUpdate callback, the old one will be overwritten by the new one.
@@ -964,9 +1001,9 @@ export class WSAPI {
 	 * });
 	 * ```
 	 */
-	public async getRelatedItemsForGame(related_game_id: string): Promise<GetAchievementMapResponse> {
+	public async getRelatedItemsForGame(related_game_id: string, force_language?: string): Promise<GetAchievementMapResponse> {
 
-		const result = await this.api.getRelatedItemsForGame(null, related_game_id);
+		const result = await this.api.getRelatedItemsForGame(null, related_game_id, force_language);
         return result;
 		
 	}

package/src/WSAPI/WSAPITypes.ts

@@ -1,5 +1,5 @@
 import { BuyStoreItemErrorCode } from '../Store';
-import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from '../MiniGames';
+import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate } from '../MiniGames';
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
 import { AchCategory } from '../Missions';
 import { LeaderBoardPeriodType } from '../Leaderboard';
@@ -41,6 +41,12 @@ export interface TMiniGamePrize {
 	pool_initial?: number;
 	/* Number of wins in game */
 	wins_count?: number;
+	/* Number of days of week, when the prize can be available */
+	weekdays?: number[];
+	/* Holds time from which prize will become available, for the prizes that are targeted to be available from specific date/time */
+	active_from_ts?: number;
+	/* Holds time till which prize will become available, for the prizes that are targeted to be available from specific date/time */
+	active_till_ts?: number;
 }
 
 /**
@@ -747,3 +753,18 @@ export interface TClaimBonusResult {
 	/** If the bonus was claimed successfully, then success is true */
 	success?: boolean;
 }
+
+export interface TSawHistory {
+	/** The initial information about mini-game */
+	template: SAWTemplate,
+	/** ID of the mini-game template */
+	saw_template_id: number,
+	/** The saw_prize_id that user won, details of the prize can be found in the mini-game definition */
+	saw_prize_id: number,
+	/** Amount of prizes in stock */
+	prize_amount: number,
+	/** Request ID that client is sending to show history*/
+	client_request_id: string,
+	/** Flag indicating to show whether prize in the mini-game claimed or not */
+	is_claimed: boolean,
+}