@smartico/public-api 0.0.166 → 0.0.168

package/docs/README.md

@@ -32,6 +32,7 @@
 - [JackpotsOptoutResponse](interfaces/JackpotsOptoutResponse.md)
 - [TMiniGamePrize](interfaces/TMiniGamePrize.md)
 - [TMiniGamePlayResult](interfaces/TMiniGamePlayResult.md)
+- [TMiniGamePlayBatchResult](interfaces/TMiniGamePlayBatchResult.md)
 - [TMiniGameTemplate](interfaces/TMiniGameTemplate.md)
 - [TUserProfile](interfaces/TUserProfile.md)
 - [TLevel](interfaces/TLevel.md)

package/docs/classes/WSAPI.md

@@ -150,15 +150,22 @@ ___
 
 ### getBonuses
 
-▸ **getBonuses**(): `Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
+▸ **getBonuses**(`«destructured»?`): `Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
 
-Returns all the bonuses for the current user.
+Returns all the bonuses for the current user
 The returned bonuss are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
 Note that each time you call getBonuses with a new onUpdate callback, the old one will be overwritten by the new one.
-The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it.
+The onUpdate callback will be called on bonus claimed and the updated bonuses will be passed to it.
 
 **Visitor mode: not supported**
 
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `onUpdate?` | (`data`: [`TBonus`](../interfaces/TBonus.md)[]) => `void` |
+
 #### Returns
 
 `Promise`\<[`TBonus`](../interfaces/TBonus.md)[]\>
@@ -428,6 +435,27 @@ Plays the specified by template_id mini-game on behalf of user and returns prize
 
 ___
 
+### playMiniGameBatch
+
+▸ **playMiniGameBatch**(`template_id`, `spin_count`): `Promise`\<[`TMiniGamePlayBatchResult`](../interfaces/TMiniGamePlayBatchResult.md)[]\>
+
+Plays the specified by template_id mini-game on behalf of user {count} times and returns prizes or err_code
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `template_id` | `number` |
+| `spin_count` | `number` |
+
+#### Returns
+
+`Promise`\<[`TMiniGamePlayBatchResult`](../interfaces/TMiniGamePlayBatchResult.md)[]\>
+
+___
+
 ### requestMissionOptIn
 
 ▸ **requestMissionOptIn**(`mission_id`): `Promise`\<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
@@ -847,3 +875,36 @@ _smartico.api.jackpotOptOut({ jp_template_id: 123 }).then((result) => {
 #### Returns
 
 `Promise`\<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
+
+___
+
+### getRelatedItemsForGame
+
+▸ **getRelatedItemsForGame**(`related_game_id`): `Promise`\<`GetAchievementMapResponse`\>
+
+Returns all the related tournaments and missions for the provided game id for the current user
+The provided Game ID should correspond to the ID from the Games Catalog - https://help.smartico.ai/welcome/technical-guides/games-catalog-api
+
+**Example**:
+```
+_smartico.api.getRelatedItemsForGame('gold-slot2').then((result) => {
+     console.log(result);
+});
+```
+
+**Example in the Visitor mode**:
+```
+_smartico.vapi('EN').getRelatedItemsForGame('gold-slot2').then((result) => {
+     console.log(result);
+});
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `related_game_id` | `string` |
+
+#### Returns
+
+`Promise`\<`GetAchievementMapResponse`\>

package/docs/interfaces/TMiniGamePlayBatchResult.md

@@ -0,0 +1,43 @@
+# Interface: TMiniGamePlayBatchResult
+
+TMiniGamePlayBatchResult describes the response of call to _smartico.api.playMiniGameBatch(template_id, spin_count) method
+
+## Properties
+
+### 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
+
+___
+
+### errCode
+
+• **errCode**: [`SAWSpinErrorCode`](../enums/SAWSpinErrorCode.md)
+
+Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0
+
+___
+
+### errMessage
+
+• `Optional` **errMessage**: `string`
+
+Optional error message
+
+___
+
+### jackpot\_amount
+
+• `Optional` **jackpot\_amount**: `number`
+
+Jackpot amount what user won
+
+___
+
+### first\_spin\_in\_period
+
+• `Optional` **first\_spin\_in\_period**: `number`
+
+Period in miliseconds from last spin

package/package.json

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

package/src/Base/ClassId.ts

@@ -121,6 +121,10 @@ export enum ClassId {
 	SAW_PRIZE_DROP_WIN_AKNOWLEDGE_REQUEST = 709,
 	SAW_PRIZE_DROP_WIN_AKNOWLEDGE_RESPONSE = 710,
 	SAW_AKNOWLEDGE_SPIN_PUSH = 711,
+	SAW_DO_SPIN_BATCH_REQUEST = 712,
+	SAW_DO_SPIN_BATCH_RESPONSE = 713,
+	SAW_AKNOWLEDGE_BATCH_REQUEST = 714,
+	SAW_AKNOWLEDGE_BATCH_RESPONSE = 715,
 
 	/*
         !Important, if adding new messages that are 'acting' on behalf of the client,

package/src/MiniGames/SAWDoAcknowledgeBatchRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolRequest } from '../Base/ProtocolRequest';
+
+export interface SAWDoAcknowledgeBatchRequest extends ProtocolRequest {
+	request_ids: string[];
+}

package/src/MiniGames/SAWDoAcknowledgeBatchResponse.ts

@@ -0,0 +1,5 @@
+import { ProtocolRequest } from '../Base/ProtocolRequest';
+
+export interface SAWDoAcknowledgeBatchResponse extends ProtocolRequest {
+	results: Array<{ request_id: string, errCode: number, errMessage?: string }>;
+}

package/src/MiniGames/SAWDoSpinBatchRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from 'src/SmarticoLib';
+
+export interface SAWDoSpinBatchRequest extends ProtocolMessage {
+	spins: Array<{ request_id: string, saw_template_id: number }>;
+}

package/src/MiniGames/SAWDoSpinBatchResponse.ts

@@ -0,0 +1,8 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { SAWDoSpinResponse } from './SAWDoSpinResponse';
+import { SAWSpinErrorCode } from './SAWSpinErrorCode';
+
+export interface SAWDoSpinBatchResponse extends ProtocolResponse {
+	results: SAWDoSpinResponse[];
+	errCode: SAWSpinErrorCode,
+}

package/src/Missions/GetRelatedAchTourResponse.ts

@@ -2,7 +2,7 @@ import { ProtocolResponse } from '../Base/ProtocolResponse';
 import { Tournament } from '../Tournaments';
 import { UserAchievement } from './UserAchievement';
 
-export interface GetAchievementMapResponse extends ProtocolResponse {
+export interface GetRelatedAchTourResponse extends ProtocolResponse {
 	achievements: UserAchievement[];
 	tournaments?: Tournament[];
 }

package/src/SmarticoAPI.ts

@@ -109,6 +109,12 @@ import {
 import { GetCustomSectionsRequest, GetCustomSectionsResponse, UICustomSectionTransform } from './CustomSections';
 import { BonusItemsTransform, ClaimBonusRequest, ClaimBonusResponse, GetBonusesResponse } from './Bonuses';
 import { GetBonusesRequest } from './Bonuses/GetBonusesRequest';
+import { SAWDoSpinBatchResponse } from './MiniGames/SAWDoSpinBatchResponse';
+import { SAWDoSpinBatchRequest } from './MiniGames/SAWDoSpinBatchRequest';
+import { SAWDoAcknowledgeBatchRequest } from './MiniGames/SAWDoAcknowledgeBatchRequest';
+import { SAWDoAcknowledgeBatchResponse } from './MiniGames/SAWDoAcknowledgeBatchResponse';
+import { GetRelatedAchTourRequest } from './Missions/GetRelatedAchTourRequest';
+import { GetRelatedAchTourResponse } from './Missions/GetRelatedAchTourResponse';
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -537,6 +543,47 @@ class SmarticoAPI {
 		return { ...spinAttemptResponse, request_id };
 	}
 
+
+	public async doAcknowledgeBatchRequest(user_ext_id: string, request_ids: string[]): Promise<SAWDoAcknowledgeBatchResponse> {
+		const message = this.buildMessage<SAWDoAcknowledgeBatchRequest, SAWDoAcknowledgeBatchResponse>(
+			user_ext_id,
+			ClassId.SAW_AKNOWLEDGE_REQUEST,
+			{
+				request_ids,
+			},
+		);
+
+		return await this.send<SAWDoAcknowledgeBatchResponse>(message, ClassId.SAW_AKNOWLEDGE_BATCH_RESPONSE);
+	}
+
+	public async sawSpinBatchRequest(user_ext_id: string, saw_template_id: number, spins_count: number): Promise<SAWDoSpinBatchResponse> {
+
+		const spins = [];
+		for (let i = 0; i < spins_count; i++) {
+			const request_id = IntUtils.uuid();
+			spins.push({ request_id, saw_template_id })
+		}
+
+		const message = this.buildMessage<SAWDoSpinBatchRequest, SAWDoSpinBatchResponse>(user_ext_id, ClassId.SAW_DO_SPIN_BATCH_REQUEST, { spins });
+		const spinAttemptResponse = await this.send<SAWDoSpinBatchResponse>(message, ClassId.SAW_DO_SPIN_BATCH_RESPONSE);
+
+		// If one response is 'OK' we consider that whole result is 'OK'
+		const result = spinAttemptResponse.results.find((res) => res.errCode === 0);
+
+		let status = 'OK';
+		if (!result) {
+			status = 'BATCH FAIL';
+		}
+
+		await this.coreReportCustomEvent(user_ext_id, 'minigame_attempt', {
+			saw_template_id,
+			status,
+			spins_count,
+		});
+
+		return { ...spinAttemptResponse };
+	}
+
 	public async missionOptIn(user_ext_id: string, mission_id: number) {
 		if (!mission_id) {
 			throw new Error('Missing mission id');
@@ -1027,6 +1074,19 @@ class SmarticoAPI {
 	public getWSCalls(): WSAPI {
 		return new WSAPI(this);
 	}
+
+	public async getRelatedItemsForGame(user_ext_id: string, related_game_id: string,): Promise<GetRelatedAchTourResponse> {
+		const message = this.buildMessage< GetRelatedAchTourRequest, GetRelatedAchTourResponse>(
+			user_ext_id,
+			ClassId.GET_RELATED_ACH_N_TOURNAMENTS_REQUEST,
+			{
+				related_game_id: related_game_id
+			}
+		);
+		
+		return await this.send<GetRelatedAchTourResponse>(message, ClassId.GET_RELATED_ACH_N_TOURNAMENTS_RESPONSE);
+
+	}
 }
 
 export { SmarticoAPI, MessageSender };

package/src/WSAPI/WSAPI.ts

@@ -1,6 +1,6 @@
 import { ClassId } from '../Base/ClassId';
 import { CoreUtils } from '../Core';
-import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWSpinErrorCode, SAWSpinsCountPush } from '../MiniGames';
+import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWGetTemplatesResponse, SAWSpinErrorCode, SAWSpinsCountPush } from '../MiniGames';
 import { ECacheContext, OCache } from '../OCache';
 import { SmarticoAPI } from '../SmarticoAPI';
 import {
@@ -26,7 +26,8 @@ import {
 	TUICustomSection,
 	TUserProfile,
 	UserLevelExtraCountersT,TBonus,
-	TClaimBonusResult
+	TClaimBonusResult,
+	TMiniGamePlayBatchResult
 } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import {
@@ -37,6 +38,8 @@ import {
 	JackpotsOptoutRequest,
 	JackpotsOptoutResponse,
 } from '../Jackpots';
+import { GetTournamentsResponse } from 'src/Tournaments';
+import { GetAchievementMapResponse } from 'src/Missions';
 
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -202,6 +205,9 @@ export class WSAPI {
 
 	/**
 	 * Returns all the bonuses for the current user
+	 * The returned bonuss are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
+	 * Note that each time you call getBonuses with a new onUpdate callback, the old one will be overwritten by the new one.
+	 * The onUpdate callback will be called on bonus claimed and the updated bonuses will be passed to it.
 	 *
 	 * **Visitor mode: not supported**
 	 */
@@ -466,6 +472,28 @@ export class WSAPI {
 		return o;
 	}
 
+	/**
+	 * Plays the specified by template_id mini-game on behalf of user {count} times and returns prizes or err_code
+	 *
+	 * **Visitor mode: not supported**
+	 */
+	public async playMiniGameBatch(template_id: number, spin_count: number): Promise<TMiniGamePlayBatchResult[]> {
+		const response = await this.api.sawSpinBatchRequest(null, template_id, spin_count);
+
+		const request_ids = response.results.map((result) => result.request_id);
+		this.api.doAcknowledgeBatchRequest(null, request_ids);
+
+		const o: TMiniGamePlayBatchResult[] = response.results.map((result) => ({
+			errCode: result.errCode,
+			errMessage: result.errMsg,
+			saw_prize_id: result.saw_prize_id,
+			jackpot_amount: result.jackpot_amount,
+			first_spin_in_period: result.first_spin_in_period,
+		}));
+
+		return o;
+	}
+
 	/**
 	 * Requests an opt-in for the specified mission_id. Returns the err_code.
 	 *
@@ -890,4 +918,28 @@ export class WSAPI {
 
 		return result;
 	}
+	/**
+	 * Returns all the related tournaments and missions for the provided game id for the current user
+	 * The provided Game ID should correspond to the ID from the Games Catalog - https://help.smartico.ai/welcome/technical-guides/games-catalog-api
+	 * 
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getRelatedItemsForGame('gold-slot2').then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 *
+	 * **Example in the Visitor mode**:
+	 * ```
+	 * _smartico.vapi('EN').getRelatedItemsForGame('gold-slot2').then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 */
+	public async getRelatedItemsForGame(related_game_id: string): Promise<GetAchievementMapResponse> {
+
+		const result = await this.api.getRelatedItemsForGame(null, related_game_id);
+        return result;
+		
+	}
 }

package/src/WSAPI/WSAPITypes.ts

@@ -55,6 +55,22 @@ export interface TMiniGamePlayResult {
 	prize_id: number;
 }
 
+/**
+ * TMiniGamePlayBatchResult describes the response of call to _smartico.api.playMiniGameBatch(template_id, spin_count) method
+ */
+export interface TMiniGamePlayBatchResult {
+	/** The saw_prize_id that user won, details of the prize can be found in the mini-game definition */
+	saw_prize_id: number;
+	/** Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0 */
+	errCode: SAWSpinErrorCode;
+	/** Optional error message */
+	errMessage?: string;
+	/** Jackpot amount what user won */
+	jackpot_amount?: number;
+	/** Period in miliseconds from last spin */
+	first_spin_in_period?: number,
+}
+
 /**
  * TMiniGameTemplate describes the information of mini-games available for the user
  */