@smartico/public-api 0.0.253 → 0.0.255

package/docs/README.md

@@ -19,6 +19,10 @@
 ## Interfaces
 
 - [AchRelatedGame](interfaces/AchRelatedGame.md)
+- [GetJackpotEligibleGamesRequest](interfaces/GetJackpotEligibleGamesRequest.md)
+- [GetJackpotEligibleGamesResponse](interfaces/GetJackpotEligibleGamesResponse.md)
+- [TGetJackpotEligibleGamesResponse](interfaces/TGetJackpotEligibleGamesResponse.md)
+- [JackpotEligibleGame](interfaces/JackpotEligibleGame.md)
 - [GetJackpotWinnersRequest](interfaces/GetJackpotWinnersRequest.md)
 - [GetJackpotWinnersResponse](interfaces/GetJackpotWinnersResponse.md)
 - [JackpotWinnerHistory](interfaces/JackpotWinnerHistory.md)

package/docs/classes/WSAPI.md

@@ -989,6 +989,35 @@ _smartico.api.getJackpotWinners({
 
 ___
 
+### getJackpotEligibleGames
+
+▸ **getJackpotEligibleGames**(`«destructured»`): `Promise`\<[`TGetJackpotEligibleGamesResponse`](../interfaces/TGetJackpotEligibleGamesResponse.md)\>
+
+Returns the eligible games for the jackpot with the specified jp_template_id.
+
+**Example**:
+```
+_smartico.api.getJackpotEligibleGames({ jp_template_id: 123 }).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `jp_template_id` | `number` |
+| › `onUpdate?` | () => `void` |
+
+#### Returns
+
+`Promise`\<[`TGetJackpotEligibleGamesResponse`](../interfaces/TGetJackpotEligibleGamesResponse.md)\>
+
+___
+
 ### getRelatedItemsForGame
 
 ▸ **getRelatedItemsForGame**(`related_game_id`): `Promise`\<`GetRelatedAchTourResponse`\>

package/docs/interfaces/GetJackpotEligibleGamesRequest.md

@@ -0,0 +1,43 @@
+# Interface: GetJackpotEligibleGamesRequest
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`GetJackpotEligibleGamesRequest`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolMessage.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolMessage.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolMessage.uuid
+
+___
+
+### jp\_template\_id
+
+• **jp\_template\_id**: `number`

package/docs/interfaces/GetJackpotEligibleGamesResponse.md

@@ -0,0 +1,63 @@
+# Interface: GetJackpotEligibleGamesResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`GetJackpotEligibleGamesResponse`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolResponse.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolResponse.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolResponse.uuid
+
+___
+
+### errCode
+
+• `Optional` **errCode**: `number`
+
+#### Inherited from
+
+ProtocolResponse.errCode
+
+___
+
+### errMsg
+
+• `Optional` **errMsg**: `string`
+
+#### Inherited from
+
+ProtocolResponse.errMsg
+
+___
+
+### eligible\_games
+
+• **eligible\_games**: [`AchRelatedGame`](AchRelatedGame.md)[]

package/docs/interfaces/JackpotEligibleGame.md

@@ -0,0 +1,73 @@
+# Interface: JackpotEligibleGame
+
+## Properties
+
+### game\_id
+
+• **game\_id**: `number`
+
+ID of the game on Smartico side
+
+___
+
+### ext\_game\_id
+
+• **ext\_game\_id**: `string`
+
+ID of the game on operator side
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the game
+
+___
+
+### link
+
+• **link**: `string`
+
+Link to the game
+
+___
+
+### image
+
+• **image**: `string`
+
+Image of the game
+
+___
+
+### enabled
+
+• **enabled**: `boolean`
+
+Whether the game is enabled
+
+___
+
+### game\_categories
+
+• **game\_categories**: `string`[]
+
+Categories of the game
+
+___
+
+### game\_provider
+
+• **game\_provider**: `string`
+
+Provider of the game
+
+___
+
+### mobile\_spec\_link
+
+• **mobile\_spec\_link**: `string`
+
+The link to the mobile game

package/docs/interfaces/TGetJackpotEligibleGamesResponse.md

@@ -0,0 +1,7 @@
+# Interface: TGetJackpotEligibleGamesResponse
+
+## Properties
+
+### eligible\_games
+
+• **eligible\_games**: [`JackpotEligibleGame`](JackpotEligibleGame.md)[]

package/package.json

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

package/src/Base/ClassId.ts

@@ -150,6 +150,9 @@ export enum ClassId {
 	JP_GET_WINNERS_REQUEST = 809,
 	JP_GET_WINNERS_RESPONSE = 810,
 
+	JP_GET_ELIGIBLE_GAMES_REQUEST = 811,
+	JP_GET_ELIGIBLE_GAMES_RESPONSE = 812,
+
 	RAF_GET_RAFFLES_REQUEST = 902,
 	RAF_GET_RAFFLES_RESPONSE = 903,
 	RAF_GET_DRAW_RUN_REQUEST = 904,

package/src/Jackpots/GetJackpotEligibleGamesRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+
+export interface GetJackpotEligibleGamesRequest extends ProtocolMessage {
+	jp_template_id: number;
+}

package/src/Jackpots/GetJackpotEligibleGamesResponse.ts

@@ -0,0 +1,50 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { AchRelatedGame } from '../Base/AchRelatedGame';
+
+export interface GetJackpotEligibleGamesResponse extends ProtocolResponse {
+	eligible_games: AchRelatedGame[];
+}
+
+export interface TGetJackpotEligibleGamesResponse {
+	eligible_games: JackpotEligibleGame[];
+}
+
+export interface JackpotEligibleGame {
+    /** ID of the game on Smartico side */
+	game_id: number;
+    /** ID of the game on operator side */
+    ext_game_id: string;
+    /** Name of the game */
+    name: string;
+    /** Link to the game */
+    link: string;
+    /** Image of the game */
+    image: string;
+    /** Whether the game is enabled */
+    enabled: boolean;
+    /** Categories of the game */
+    game_categories: string[];
+    /** Provider of the game */
+    game_provider: string;
+    /** The link to the mobile game */
+    mobile_spec_link: string;
+}
+
+/**
+ * @ignore
+ */
+export const GetJackpotEligibleGamesResponseTransform = ({ eligible_games } : { eligible_games: AchRelatedGame[]}): TGetJackpotEligibleGamesResponse => {
+	const games = eligible_games.map((game: AchRelatedGame) => ({
+		game_id: game.ach_game_id,
+		ext_game_id: game.ext_game_id,
+		name: game.game_public_meta.name,
+		link: game.game_public_meta.link,
+		image: game.game_public_meta.image,
+		enabled: game.game_public_meta.enabled,
+		game_categories: game.game_public_meta.game_categories,
+		game_provider: game.game_public_meta.game_provider,
+		mobile_spec_link: game.game_public_meta.mobile_spec_link,
+	}));
+
+	return { eligible_games: games };
+};

package/src/Jackpots/index.ts

@@ -16,3 +16,5 @@ export * from './JackpotsOptoutResponse';
 export * from './JackpotHtmlTemplate';
 export * from './GetJackpotWinnersRequest';
 export * from './GetJackpotWinnersResponse';
+export * from './GetJackpotEligibleGamesRequest';
+export * from './GetJackpotEligibleGamesResponse';

package/src/SmarticoAPI.ts

@@ -13,7 +13,6 @@ import {
 	SAWHistoryTransform,
 	SAWPrizesHistory,
 	SAWSpinErrorCode,
-	SAWTemplate,
 	SAWTemplatesTransform,
 	SAWWinningHistoryRequest,
 	SAWWinningHistoryResponse,
@@ -94,7 +93,6 @@ import {
 	TSegmentCheckResult,
 	TUICustomSection,
 	TBonus,
-	TSawHistory,
 	TRaffle,
 } from './WSAPI/WSAPITypes';
 import { getLeaderBoardTransform } from './Leaderboard/LeaderBoards';
@@ -126,6 +124,8 @@ import { InboxCategories } from './Inbox/InboxCategories';
 import { GetDrawRunRequest, GetDrawRunResponse, GetRaffleDrawRunsHistoryRequest, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeRequest, RaffleClaimPrizeResponse } from './Raffle';
 import { GetJackpotWinnersResponse, GetJackpotWinnersResponseTransform, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
 import { GetJackpotWinnersRequest } from './Jackpots/GetJackpotWinnersRequest';
+import { GetJackpotEligibleGamesRequest } from './Jackpots/GetJackpotEligibleGamesRequest';
+import { GetJackpotEligibleGamesResponse, GetJackpotEligibleGamesResponseTransform, JackpotEligibleGame, TGetJackpotEligibleGamesResponse } from './Jackpots/GetJackpotEligibleGamesResponse';
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -505,6 +505,20 @@ class SmarticoAPI {
 		return GetJackpotWinnersResponseTransform((await this.getJackpotWinners(user_ext_id, limit, offset, jp_template_id)).winners);
 	}
 
+	public async getJackpotEligibleGames(user_ext_id: string, { jp_template_id } : { jp_template_id: number }): Promise<GetJackpotEligibleGamesResponse> {
+		const message = this.buildMessage<GetJackpotEligibleGamesRequest, GetJackpotEligibleGamesResponse>(
+			user_ext_id,
+			ClassId.JP_GET_ELIGIBLE_GAMES_REQUEST,
+			{ jp_template_id },
+		);
+
+		return await this.send<GetJackpotEligibleGamesResponse>(message, ClassId.JP_GET_ELIGIBLE_GAMES_RESPONSE);;
+	}
+
+	public async getJackpotEligibleGamesT(user_ext_id: string, { jp_template_id } : { jp_template_id: number }): Promise<TGetJackpotEligibleGamesResponse> {
+		return GetJackpotEligibleGamesResponseTransform(await this.getJackpotEligibleGames(user_ext_id, { jp_template_id }));
+	}
+
 	public async sawGetTemplates(
 		user_ext_id: string,
 		force_language?: string,

package/src/WSAPI/WSAPI.ts

@@ -70,6 +70,7 @@ import {
 	raffleClaimPrizeResponseTransform,
 } from '../Raffle';
 import { IntUtils } from '../IntUtils';
+import { JackpotEligibleGame, TGetJackpotEligibleGamesResponse } from 'src/Jackpots/GetJackpotEligibleGamesResponse';
 
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -77,6 +78,7 @@ const CACHE_DATA_SEC = 30;
 const JACKPOT_TEMPLATE_CACHE_SEC = 30;
 const JACKPOT_POT_CACHE_SEC = 1;
 const JACKPOT_WINNERS_CACHE_SEC = 30;
+const JACKPOT_ELIGIBLE_GAMES_CACHE_SEC = 30;
 
 /** @hidden */
 enum onUpdateContextKey {
@@ -100,6 +102,7 @@ enum onUpdateContextKey {
 	SAWHistory = 'sawHistory',
 	JackpotWinners = 'jackpotWinners',
 	Raffles = 'raffles',
+	JackpotEligibleGames = 'jackpotEligibleGames',
 }
 
 /** @group General API */
@@ -1095,6 +1098,33 @@ export class WSAPI {
 		);
 	}
 
+	/**
+	 * Returns the eligible games for the jackpot with the specified jp_template_id.
+	 *
+	 * **Example**:
+	 * ```
+	 * _smartico.api.getJackpotEligibleGames({ jp_template_id: 123 }).then((result) => {
+	 *      console.log(result);
+	 * });
+	 * ```
+	 * 
+	 * **Visitor mode: not supported**
+	 * 
+	 */
+
+	public async getJackpotEligibleGames({ jp_template_id, onUpdate } : { jp_template_id: number, onUpdate?: () => void }): Promise<TGetJackpotEligibleGamesResponse> {
+		if (onUpdate) {
+			this.onUpdateCallback.set(onUpdateContextKey.JackpotEligibleGames, onUpdate);
+		}
+
+		return OCache.use(
+			onUpdateContextKey.JackpotEligibleGames + jp_template_id,
+			ECacheContext.WSAPI,
+			() => this.api.getJackpotEligibleGamesT(null, { jp_template_id }),
+			JACKPOT_ELIGIBLE_GAMES_CACHE_SEC,
+		);
+	}
+
 	/**
 	 * 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

package/dist/Quiz/MarketsAnswersType.d.ts

@@ -1,22 +0,0 @@
-export declare enum MarketsValueType {
-    HomeTeam = "1",
-    AwayTeam = "2",
-    Draw = "x",
-    HomeTeamHomeTeam = "1/1",
-    HomeTeamDraw = "1/x",
-    HomeTeamAwayTeam = "1/2",
-    DrawHomeTeam = "x/1",
-    DrawDraw = "x/x",
-    DrawAwayTeam = "x/2",
-    AwayTeamHomeTeam = "2/1",
-    AwayTeamDraw = "2/x",
-    AwayTeamAwayTeam = "2/2",
-    Yes = "yes",
-    No = "no",
-    Odd = "odd",
-    Even = "even",
-    HomeOdd = "1/odd",
-    HomeEven = "1/even",
-    AwayOdd = "2/odd",
-    AwayEven = "2/even"
-}

package/dist/Raffle/GetDrawResponse.d.ts

@@ -1,5 +0,0 @@
-import { ProtocolResponse } from '../Base/ProtocolResponse';
-import { RaffleDraw } from './RaffleDraw';
-export interface GetDrawResponse extends ProtocolResponse {
-    draw: RaffleDraw;
-}

package/dist/SmarticoPublicAPI.d.ts

@@ -1,23 +0,0 @@
-import { ClassId } from "./Base/ClassId";
-import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
-import { SAWTemplate } from './MiniGames/SAWTemplate';
-import { ILogger } from './ILogger';
-interface IOptions {
-    logger?: ILogger;
-    logCIDs?: ClassId[];
-    logHTTPTiming?: boolean;
-}
-declare class SmarticoPublicApi {
-    private label_api_key;
-    private brand_api_key;
-    private publicUrl;
-    private logger;
-    private logCIDs;
-    private logHTTPTiming;
-    constructor(label_api_key: string, brand_api_key: string, options?: IOptions);
-    private send;
-    private buildMessage;
-    miniGamesGetTemplates(user_ext_id: string): Promise<SAWGetTemplatesResponse>;
-    miniGamesFormatTemplatesForWidget(templates: SAWTemplate[], pointsBalance: number): any[];
-}
-export { SmarticoPublicApi };

package/dist/Store/BuyShopItemErrorCode.d.ts

@@ -1,10 +0,0 @@
-export declare enum BuyShopItemErrorCode {
-    FAILED_TO_BUY_SHOP_ITEM = 121,
-    SHOP_NO_BALANCE = 11000,
-    SHOP_WRONG_LABEL = 11001,
-    SHOP_FAILED_TO_BUY_BONUS = 11002,
-    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003,
-    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004,
-    SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
-    SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006
-}

package/dist/Store/BuyShopItemRequest.d.ts

@@ -1,4 +0,0 @@
-import { ProtocolMessage } from "../Base/ProtocolMessage";
-export interface BuyShopItemRequest extends ProtocolMessage {
-    itemId: number;
-}

package/dist/Store/BuyShopItemResponse.d.ts

@@ -1,4 +0,0 @@
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-export interface BuyShopItemResponse extends ProtocolResponse {
-    success?: boolean;
-}

package/dist/Store/GetCategoriesShopResponse.d.ts

@@ -1,5 +0,0 @@
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-import { ShopCategory } from "./ShopCategory";
-export interface GetCategoriesShopResponse extends ProtocolResponse {
-    categories: ShopCategory[];
-}

package/dist/Store/GetShopItemsResponse.d.ts

@@ -1,5 +0,0 @@
-import { ProtocolResponse } from "../Base/ProtocolResponse";
-import { ShopItem } from "./ShopItem";
-export interface GetShopItemsResponse extends ProtocolResponse {
-    items: ShopItem[];
-}

package/dist/Store/ShopCategory.d.ts

@@ -1,5 +0,0 @@
-import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
-export interface ShopCategory {
-    id?: number;
-    publicMeta?: ShopCategoryPublicMeta;
-}

package/dist/Store/ShopCategoryPublicMeta.d.ts

@@ -1,4 +0,0 @@
-export interface ShopCategoryPublicMeta {
-    name?: string;
-    order?: number;
-}

package/dist/Store/ShopItem.d.ts

@@ -1,9 +0,0 @@
-import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
-import { ShopItemType } from "./ShopItemType";
-export interface ShopItem {
-    id: number;
-    itemTypeId: ShopItemType;
-    itemPublicMeta: ShopItemPublicMeta;
-    categoryIds?: number[];
-    canBuy?: boolean;
-}

package/dist/Store/ShopItemPublicMeta.d.ts

@@ -1,10 +0,0 @@
-export interface ShopItemPublicMeta {
-    price: string;
-    image_url: string;
-    name: string;
-    description: string;
-    label_tag: string;
-    limit_message: string;
-    priority: number;
-    related_items: number[];
-}

package/dist/Store/ShopItemType.d.ts

@@ -1,4 +0,0 @@
-export declare enum ShopItemType {
-    Bonus = 1,
-    Manual = 2
-}

package/dist/Store/StorItemPruchased.d.ts

@@ -1,6 +0,0 @@
-import { StoreItem } from "./StoreItem";
-interface StorItemPruchased extends StoreItem {
-    purchase_ts: number;
-    purchase_points_amount: number;
-}
-export { StorItemPruchased };

package/dist/service/index.d.ts

@@ -1,5 +0,0 @@
-import { ErrorCodes, ErrorCodesGame } from './types/ErrorCodes';
-import { GBaseRequest } from './types/GRequest';
-import { GResponseBase, GResponse } from './types/GResponse';
-import { SAWSpinErrorCode } from './types/SmarticoProto/SAW/SAWDoSpinResponse';
-export { ErrorCodes, ErrorCodesGame, SAWSpinErrorCode, GBaseRequest, GResponseBase, GResponse, };

package/dist/service/types/ErrorCodes.d.ts

@@ -1,13 +0,0 @@
-import { SAWSpinErrorCode } from "./SmarticoProto/SAW/SAWDoSpinResponse";
-export declare const ErrorCodes_FatalStartingRange = 100000;
-export declare enum ErrorCodesGame {
-    OK = 0,
-    NoBetsUpdatedOnSubmit = 3,
-    RepeatRequest_Unhandled = 4,
-    Fatal_NotValidHash,
-    Fatal_WrongCustomerID,
-    Fatal_TemplateNotFound,
-    Fatal_NoOpenRounds,
-    Fatal_Unhandled
-}
-export type ErrorCodes = SAWSpinErrorCode | ErrorCodesGame;

package/dist/service/types/GRequest.d.ts

@@ -1,16 +0,0 @@
-interface GBaseRequest {
-    customer_id: string;
-    ext_user_id: string;
-    int_user_id: number;
-    smartico_ext_user_id: string;
-    ext_game_id: number;
-    lang: string;
-    hash: string;
-    zoom?: number;
-    label_api_key?: string;
-    brand_key?: string;
-    bridgeId?: string;
-    height?: 'auto' | string;
-    theme?: string;
-}
-export { GBaseRequest };

package/dist/service/types/GResponse.d.ts

@@ -1,10 +0,0 @@
-import { ErrorCodes } from "./ErrorCodes";
-interface GResponseBase {
-    errCode: ErrorCodes;
-    errMessage?: string;
-}
-interface GResponse<T> extends GResponseBase {
-    data?: T;
-}
-declare const SMX = 1;
-export { GResponseBase, GResponse, SMX };

package/dist/service/types/Game/GameAttemptType.d.ts

@@ -1,6 +0,0 @@
-declare enum GameAttemptType {
-    Free = 1,
-    Points = 2,
-    Attempts = 3
-}
-export { GameAttemptType };

package/dist/service/types/Game/GameCanPlayType.d.ts

@@ -1,10 +0,0 @@
-declare enum GameCanPlayType {
-    Yes = 1,
-    NotEnoughPoints = 2,
-    NotEnoughAttempts = 3,
-    InactiveGame = 4,
-    TimeRestrictions = 5,
-    SegmentRestrictions = 6,
-    GameNotFound = 7
-}
-export { GameCanPlayType };

package/dist/service/types/Game/GameExternalStatus.d.ts

@@ -1,6 +0,0 @@
-declare enum GameExternalStatus {
-    Draft = 1,
-    Active = 2,
-    Archived = 3
-}
-export { GameExternalStatus };

package/dist/service/types/Game/GameInfo.d.ts

@@ -1,9 +0,0 @@
-import { ResponseIdentifyLabelInfo } from "../SmarticoProto/PublicLabelInfo";
-import { GamePickRoundBase } from "./GamePick";
-import { SAWTemplate } from "../SmarticoProto/SAW/SAWTemplate";
-interface GameInfo {
-    sawTemplate: SAWTemplate;
-    allRounds: GamePickRoundBase[];
-    labelInfo: ResponseIdentifyLabelInfo;
-}
-export { GameInfo };