@smartico/public-api 0.0.122 → 0.0.124

package/docs/README.md

@@ -26,6 +26,7 @@
 - [AchRelatedGame](interfaces/AchRelatedGame.md)
 - [TMissionOrBadgeTask](interfaces/TMissionOrBadgeTask.md)
 - [TMissionOptInResult](interfaces/TMissionOptInResult.md)
+- [TMissionClaimRewardResult](interfaces/TMissionClaimRewardResult.md)
 - [TTournamentRegistrationResult](interfaces/TTournamentRegistrationResult.md)
 - [TBuyStoreItemResult](interfaces/TBuyStoreItemResult.md)
 - [TGetTranslations](interfaces/TGetTranslations.md)
@@ -36,6 +37,7 @@
 - [LeaderBoardsRewardsT](interfaces/LeaderBoardsRewardsT.md)
 - [LeaderBoardUserT](interfaces/LeaderBoardUserT.md)
 - [UserLevelExtraCountersT](interfaces/UserLevelExtraCountersT.md)
+- [TSegmentCheckResult](interfaces/TSegmentCheckResult.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -14,6 +14,42 @@ Returns information about current user
 
 ___
 
+### checkSegmentMatch
+
+▸ **checkSegmentMatch**(`segment_id`): `Promise`<`boolean`\>
+
+Check if user belongs to specific segments
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `segment_id` | `number` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+___
+
+### checkSegmentListMatch
+
+▸ **checkSegmentListMatch**(`segment_ids`): `Promise`<[`TSegmentCheckResult`](../interfaces/TSegmentCheckResult.md)[]\>
+
+Check if user belongs to specific list of segments
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `segment_ids` | `number`[] |
+
+#### Returns
+
+`Promise`<[`TSegmentCheckResult`](../interfaces/TSegmentCheckResult.md)[]\>
+
+___
+
 ### getLevels
 
 ▸ **getLevels**(): `Promise`<[`TLevel`](../interfaces/TLevel.md)[]\>
@@ -177,6 +213,25 @@ Requests an opt-in for the specified mission_id. Returns the err_code.
 
 ___
 
+### requestMissionClaimReward
+
+▸ **requestMissionClaimReward**(`mission_id`, `ach_completed_id`): `Promise`<[`TMissionClaimRewardResult`](../interfaces/TMissionClaimRewardResult.md)\>
+
+Request for claim reward for the specified mission id. Returns the err_code.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mission_id` | `number` |
+| `ach_completed_id` | `number` |
+
+#### Returns
+
+`Promise`<[`TMissionClaimRewardResult`](../interfaces/TMissionClaimRewardResult.md)\>
+
+___
+
 ### getTournamentsList
 
 ▸ **getTournamentsList**(`params?`): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>

package/docs/enums/SAWGameTypeName.md

@@ -26,6 +26,12 @@ ___
 
 ___
 
+### PrizeDrop
+
+• **PrizeDrop** = ``"prizedrop"``
+
+___
+
 ### Unknown
 
 • **Unknown** = ``"unknown"``

package/docs/interfaces/TMiniGamePrize.md

@@ -40,7 +40,15 @@ ___
 
 • `Optional` **font\_size**: `number`
 
-Custom font size for the prize
+Custom font size for the prize (desktop)
+
+___
+
+### font\_size\_mobile
+
+• `Optional` **font\_size\_mobile**: `number`
+
+Custom font size for the prize (mobile)
 
 ___
 

package/docs/interfaces/TMiniGameTemplate.md

@@ -136,7 +136,7 @@ ___
 
 • **custom\_data**: `any`
 
-The custom data of the mini-game defined by operator. Can be a JSON object, string or number
+The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number
 
 ___
 

package/docs/interfaces/TMissionClaimRewardResult.md

@@ -0,0 +1,19 @@
+# Interface: TMissionClaimRewardResult
+
+TMissionClaimRewardResult describes the response of call to _smartico.api.requestMissionClaimReward(mission_id, ach_completed_id) method
+
+## Properties
+
+### err\_code
+
+• **err\_code**: `number`
+
+Error code that represents outcome of the claim request. Successful claim reward in case err_code is 0
+
+___
+
+### err\_message
+
+• **err\_message**: `string`
+
+Optional error message

package/docs/interfaces/TMissionOrBadge.md

@@ -197,3 +197,35 @@ ___
 • `Optional` **position**: `number`
 
 Priority (or position) of the mission in the UI. Low value indicates higher position in the UI
+
+___
+
+### ribbon
+
+• `Optional` **ribbon**: `string`
+
+The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+
+___
+
+### ach\_completed\_id
+
+• `Optional` **ach\_completed\_id**: `number`
+
+ID of the completion fact from ach_completed or ach_completed_recurring tables
+
+___
+
+### requires\_prize\_claim
+
+• `Optional` **requires\_prize\_claim**: `boolean`
+
+Flag from achievement if the mission prize will be given only after user claims it
+
+___
+
+### prize\_claimed\_date\_ts
+
+• `Optional` **prize\_claimed\_date\_ts**: `number`
+
+The date/timestamp indicating when the prize was claimed by the user

package/docs/interfaces/TSegmentCheckResult.md

@@ -0,0 +1,13 @@
+# Interface: TSegmentCheckResult
+
+## Properties
+
+### segment\_id
+
+• **segment\_id**: `number`
+
+___
+
+### is\_matching
+
+• **is\_matching**: `boolean`

package/package.json

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

package/src/Base/ClassId.ts

@@ -33,6 +33,9 @@ export enum ClassId {
     CLIENT_SET_CUSTOM_USERNAME_REQUEST = 159,
     CLIENT_SET_CUSTOM_USERNAME_RESPONSE = 160,
 
+    CHECK_SEGMENT_MATCH_REQUEST = 161,
+    CHECK_SEGMENT_MATCH_RESPONSE = 162,
+
     // 500-1000 - Achievements
     GET_LEVEL_MAP_REQUEST = 500,
     GET_LEVEL_MAP_RESPONSE = 501,
@@ -111,7 +114,7 @@ export enum ClassId {
     JP_OPTOUT_REQUEST = 806,
     JP_OPTOUT_RESPONSE = 807,
 
-    // JP_WIN_PUSH = 808,
+    JP_WIN_PUSH = 808,
 
     REGISTER_PUSH_NOTIFICATIONS_TOKEN_REQ = 1003,
     REGISTER_PUSH_NOTIFICATIONS_TOKEN_RESP = 2003,

package/src/Core/CheckSegmentMatchRequest.ts

@@ -0,0 +1,6 @@
+
+import { ProtocolRequest } from "../Base/ProtocolRequest";
+
+export interface CheckSegmentMatchRequest extends ProtocolRequest {
+    segment_id: number[];
+}

package/src/Core/CheckSegmentMatchResponse.ts

@@ -0,0 +1,8 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+
+export interface CheckSegmentMatchResponse extends ProtocolResponse {
+    segments: {
+        segment_id: number;
+        is_matching: boolean;
+    }[];
+}

package/src/Jackpots/GetJackpotsPotsRequest.ts

@@ -1,5 +1,5 @@
 import { ProtocolMessage } from "../Base/ProtocolMessage";
 
 export interface  GetJackpotsPotsRequest extends ProtocolMessage {
-    pot_ids: number[];
+    jp_template_ids: number[];
 }

package/src/Jackpots/GetJackpotsPotsResponse.ts

@@ -3,6 +3,6 @@ import { JackpotPot } from "./JackpotPot";
 
 export interface GetJackpotsPotsResponse extends ProtocolResponse {
 
-    pots: JackpotPot[];
+    items: JackpotPot[];
 }
 

package/src/Jackpots/GetJackpotsRequest.ts

@@ -3,5 +3,5 @@ import { ProtocolMessage } from "../Base/ProtocolMessage";
 
 export interface  GetJackpotsRequest extends ProtocolMessage {
     
-    related_game_id?: string[];
+    related_game_id?: string;
 }

package/src/Jackpots/JackPotWinner.ts

@@ -0,0 +1,10 @@
+
+interface JackPotWinner {
+        is_me: boolean;        
+        public_username: string; // masked for all except "is_me"
+        winning_amount_jp_currency: number;
+        winning_amount_wallet_currency: number;
+        winning_position: number
+}
+
+export { JackPotWinner }

package/src/Jackpots/JackpotWinPush.ts

@@ -0,0 +1,8 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+import { JackPotWinner } from "./JackPotWinner";
+import { JackpotDetails } from "./JackpotDetails";
+
+export interface JackpotWinPush extends ProtocolMessage {
+    jackpot: JackpotDetails;
+    winners: JackPotWinner[];
+}

package/src/MiniGames/SAWPrizeDropWinPush.ts

@@ -1,8 +1,10 @@
 import { ProtocolMessage } from ".././Base/ProtocolMessage";
 import { SAWPrize } from "./SAWPrize";
+import { SAWTemplate } from "./SAWTemplate";
 
 export interface SAWPrizeDropWinPush extends ProtocolMessage {
     request_id: string; // guid
     saw_template_id: number;
     saw_prize: SAWPrize;
+    saw_template: SAWTemplate;
 }

package/src/MiniGames/SAWTemplateUI.ts

@@ -40,4 +40,14 @@ export interface SAWTemplateUI {
     only_in_custom_section?: boolean;
 
     custom_data: any;
+
+
+    // prize drop specific
+    placeholder_1?: string;
+    placeholder_2?: string;
+    prize_drop_template?: {
+        id: string;
+        content: string;
+    }
+
 }

package/src/MiniGames/index.ts

@@ -16,4 +16,5 @@ export * from "./SAWTemplateUI";
 export * from "./SAWWinSoundType";
 export * from "./SAWDoAknowledgeRequest";
 export * from "./SAWDoAknowledgeResponse";
-export * from "./SAWSpinsCountPush";
+export * from "./SAWSpinsCountPush";
+export * from "./SAWPrizeDropWinPush";

package/src/Missions/AchClaimPrizeResponse.ts

@@ -1,6 +1,5 @@
-import { ProtocolMessage } from "../Base/ProtocolMessage";
-
-export interface AchClaimPrizeRequest extends ProtocolMessage {
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+export interface AchClaimPrizeResponse extends ProtocolResponse {
 
     // no details here, just check for errCode and reload list of missions
 }

package/src/Missions/UserAchievement.ts

@@ -86,6 +86,9 @@ export const UserAchievementTransform = (items: UserAchievement[]): TMissionOrBa
                 },
             })),
             category_ids: r.ach_categories ?? [],
+            ach_completed_id: r.ach_completed_id,
+            requires_prize_claim: r.requires_prize_claim,
+            prize_claimed_date_ts: r.prize_claimed_date_ts,
         }
         return x;
 });

package/src/Missions/index.ts

@@ -14,4 +14,6 @@ export * from "./ScheduledMissionType";
 export * from './AchCategoryPublicMeta';
 export * from './AchievementCategory';
 export * from './GetAchCategoriesResponse';
-export * from './GetAchCategoriesRequest';
+export * from './GetAchCategoriesRequest';
+export * from './AchClaimPrizeRequest';
+export * from './AchClaimPrizeResponse'

package/src/SmarticoAPI.ts

@@ -12,14 +12,16 @@ import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetLabelInfoRequest } from './Core/GetLabelInfoRequest';
 import { GetInboxMessagesRequest, GetInboxMessagesResponse, InboxMessageBody, InboxMessageBodyTransform, InboxMessagesTransform, MarkInboxMessageDeletedRequest, MarkInboxMessageDeletedResponse, MarkInboxMessageReadRequest, MarkInboxMessageReadResponse, MarkInboxMessageStarredRequest, MarkInboxMessageStarredResponse } from './Inbox';
 import { BuyStoreItemRequest, BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreItemsResponse, StoreCategoryTransform, StoreItemTransform } from './Store';
-import { AchCategoryTransform, AchievementOptinRequest, AchievementOptinResponse, AchievementType, GetAchCategoriesResponse, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
+import { AchCategoryTransform, AchClaimPrizeRequest, AchClaimPrizeResponse, AchievementOptinRequest, AchievementOptinResponse, AchievementType, GetAchCategoriesResponse, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
 import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse, TournamentItemsTransform, TournamentRegisterRequest, TournamentRegisterResponse, tournamentInfoItemTransform } from './Tournaments';
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse, GetLevelMapResponseTransform } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT } from "./WSAPI/WSAPITypes";
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult } from "./WSAPI/WSAPITypes";
 import { getLeaderBoardTransform } from "./Leaderboard/LeaderBoards";
 import { GetAchievementsUserInfoResponse } from "./Core/GetAchievementsUserInfoResponse";
+import { CheckSegmentMatchResponse } from "./Core/CheckSegmentMatchResponse";
+import { CheckSegmentMatchRequest } from "./Core/CheckSegmentMatchRequest";
 
 const PUBLIC_API_URL = 'https://papi{ENV_ID}.smartico.ai/services/public';
 const C_SOCKET_PROD = 'wss://api{ENV_ID}.smartico.ai/websocket/services';
@@ -271,6 +273,19 @@ class SmarticoAPI {
         return await this.send(message, ClassId.CLIENT_SET_CUSTOM_USERNAME_RESPONSE);
     }
 
+    public async coreCheckSegments(user_ext_id: string, segment_id: number[]): Promise<TSegmentCheckResult[]> {
+        
+        const message = this.buildMessage<CheckSegmentMatchRequest, any>(user_ext_id, ClassId.CHECK_SEGMENT_MATCH_REQUEST, {
+            segment_id
+        });
+        
+        const results = await this.send<CheckSegmentMatchResponse>(message, ClassId.CHECK_SEGMENT_MATCH_RESPONSE);
+
+        return results.segments || [];
+    }    
+
+
+
     public async sawGetTemplates(user_ext_id: string, lang?: string, is_visitor_mode: boolean = false): Promise<SAWGetTemplatesResponse> {
 
         const message = this.buildMessage<SAWGetTemplatesRequest, SAWGetTemplatesResponse>(user_ext_id, ClassId.SAW_GET_SPINS_REQUEST, lang ? { force_language: lang, is_visitor_mode } : { is_visitor_mode });
@@ -355,6 +370,21 @@ class SmarticoAPI {
         return res;
     }
 
+    public async missionClaimPrize(user_ext_id: string, mission_id: number, ach_completed_id: number) {
+        if (!mission_id) {
+            throw new Error('Missing mission id');
+        }
+
+        const message = this.buildMessage<AchClaimPrizeRequest, AchClaimPrizeResponse>(user_ext_id, ClassId.ACHIEVEMENT_CLAIM_PRIZE_REQUEST, {
+            ach_id: mission_id,
+            ach_completed_id: ach_completed_id
+        })
+
+        const res = await this.send<AchClaimPrizeResponse>(message, ClassId.ACHIEVEMENT_CLAIM_PRIZE_RESPONSE);
+
+        return res;
+    }
+
     public async registerInTournament(user_ext_id: string, tournamentInstanceId: number) {
         if (!tournamentInstanceId) {
             throw new Error('Missing tournament instance id');

package/src/WSAPI/WSAPI.ts

@@ -3,7 +3,7 @@ import { CoreUtils } from "../Core";
 import { MiniGamePrizeTypeName, SAWDoSpinResponse, SAWSpinErrorCode, SAWSpinsCountPush } from "../MiniGames";
 import { ECacheContext, OCache } from "../OCache";
 import { SmarticoAPI } from "../SmarticoAPI";
-import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
 import { LeaderBoardPeriodType } from "../Leaderboard";
  
 /** @hidden */
@@ -21,6 +21,7 @@ enum onUpdateContextKey {
     AchCategories = 'achCategories',
     LeaderBoards = 'leaderBoards',
     LevelExtraCounters = 'levelExtraCounters',
+    Segments = 'segments',
 }
 
 
@@ -53,6 +54,22 @@ export class WSAPI {
         }
     }
 
+    /** Check if user belongs to specific segments */
+
+    public async checkSegmentMatch(segment_id: number): Promise<boolean> {
+        const r = await this.api.coreCheckSegments(null, [segment_id]);
+        if (r && r.find(s => s.segment_id === segment_id && s.is_matching)) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    /** Check if user belongs to specific list of segments */
+    public async checkSegmentListMatch(segment_ids: number[]): Promise<TSegmentCheckResult[]> {
+        return await this.api.coreCheckSegments(null, segment_ids)
+    }    
+
     /** Returns all the levels available the current user */
     public async getLevels(): Promise<TLevel[]> {
         return OCache.use(onUpdateContextKey.Levels, ECacheContext.WSAPI, () => this.api.levelsGetT(null), CACHE_DATA_SEC);
@@ -150,6 +167,18 @@ export class WSAPI {
         return o;
     }
 
+    /** Request for claim reward for the specified mission id. Returns the err_code. */
+    public async requestMissionClaimReward(mission_id: number, ach_completed_id: number): Promise<TMissionClaimRewardResult> {
+        const r = await this.api.missionClaimPrize(null, mission_id, ach_completed_id);
+
+        const o: TMissionClaimRewardResult = {
+            err_code: r.errCode,
+            err_message: r.errMsg,
+        }
+
+        return o;
+    }
+
     /** Returns all the active instances of tournaments 
      * The returned list is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getTournamentsList with a new onUpdate callback, the old one will be overwritten by the new one. 
      * The onUpdate callback will be called when the user has registered in a tournament. Updated list will be passed to onUpdate callback.*/

package/src/WSAPI/WSAPITypes.ts

@@ -457,6 +457,15 @@ export interface TMissionOrBadge {
 
     /** The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
     ribbon?: TRibbon;
+
+    /** ID of the completion fact from ach_completed or ach_completed_recurring tables */
+    ach_completed_id?: number;
+
+    /** Flag from achievement if the mission prize will be given only after user claims it */
+    requires_prize_claim?: boolean;
+
+    /** The date/timestamp indicating when the prize was claimed by the user */
+    prize_claimed_date_ts?: number;
 }
 
 export interface AchRelatedGame {
@@ -505,6 +514,16 @@ export interface TMissionOptInResult {
      err_message: string;
 }
 
+/**
+ * TMissionClaimRewardResult describes the response of call to _smartico.api.requestMissionClaimReward(mission_id, ach_completed_id) method
+*/
+export interface TMissionClaimRewardResult {
+    /** Error code that represents outcome of the claim request. Successful claim reward in case err_code is 0 */
+    err_code: number;
+    /** Optional error message */
+    err_message: string;
+}
+
 export interface TTournamentRegistrationResult {
      /** Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0 */
     err_code: TournamentRegistrationError;
@@ -608,3 +627,8 @@ export interface UserLevelExtraCountersT {
     level_counter_2?: number,
 }
 
+
+export interface TSegmentCheckResult {
+    segment_id: number;
+    is_matching: boolean;
+}