@smartico/public-api 0.0.121 → 0.0.123

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.121",
+  "version": "0.0.123",
   "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,
@@ -78,6 +81,9 @@ export enum ClassId {
     ACHIEVEMENT_CLAIM_PRIZE_REQUEST = 539,
     ACHIEVEMENT_CLAIM_PRIZE_RESPONSE = 540,
 
+    ACH_SHOP_ITEM_HISTORY_REQUEST = 541,
+    ACH_SHOP_ITEM_HISTORY_RESPONSE = 542,
+
     GET_BONUSES_REQUEST = 600,
     GET_BONUSES_RESPONSE = 601,
     CLAIM_BONUS_REQUEST = 602,
@@ -91,6 +97,24 @@ export enum ClassId {
     SAW_AKNOWLEDGE_RESPONSE = 705,
     SAW_SPINS_COUNT_PUSH = 706,
     SAW_SHOW_SPIN_PUSH = 707,
+    SAW_PRIZE_DROP_WIN_PUSH = 708,
+    SAW_PRIZE_DROP_WIN_AKNOWLEDGE_REQUEST = 709,
+    SAW_PRIZE_DROP_WIN_AKNOWLEDGE_RESPONSE = 710,
+
+
+    JP_GET_JACKPOTS_REQUEST = 800,
+    JP_GET_JACKPOTS_RESPONSE = 801,
+
+    JP_GET_LATEST_POTS_REQUEST = 802,
+    JP_GET_LATEST_POTS_RESPONSE = 803,
+
+    JP_OPTIN_REQUEST = 804,
+    JP_OPTIN_RESPONSE = 805,
+
+    JP_OPTOUT_REQUEST = 806,
+    JP_OPTOUT_RESPONSE = 807,
+
+    // 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

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

package/src/Jackpots/GetJackpotsPotsResponse.ts

@@ -0,0 +1,8 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { JackpotPot } from "./JackpotPot";
+
+export interface GetJackpotsPotsResponse extends ProtocolResponse {
+
+    pots: JackpotPot[];
+}
+

package/src/Jackpots/GetJackpotsRequest.ts

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

package/src/Jackpots/GetJackpotsResponse.ts

@@ -0,0 +1,9 @@
+import { AchRelatedGame } from "../Base/AchRelatedGame";
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { JackpotDetails } from "./JackpotDetails";
+
+export interface  GetJackpotsResponse extends ProtocolResponse {
+
+    jackpots: JackpotDetails[];
+}
+

package/src/Jackpots/JackpotContributionType.ts

@@ -0,0 +1,7 @@
+enum JackpotContributionType {
+    Fixed = 1,
+    Percentage = 2
+}
+
+
+export { JackpotContributionType }

package/src/Jackpots/JackpotDetails.ts

@@ -0,0 +1,20 @@
+import { AchRelatedGame } from "../Base/AchRelatedGame";
+import { JackpotContributionType } from "./JackpotContributionType";
+import { JackpotPot } from "./JackpotPot";
+import { JackpotPublicMeta } from "./JackpotPublicMeta";
+import { JackpotType } from "./JackpotType";
+
+interface JackpotDetails {
+    jp_template_id: number;
+    jp_type_id: JackpotType;
+    jp_public_meta: JackpotPublicMeta;
+    jp_currency: string;
+    related_games?: AchRelatedGame[];
+    contribution_type: JackpotContributionType;
+    contribution_value: number;
+    pot: JackpotPot;
+    is_opted_in: boolean;
+
+}
+
+export { JackpotDetails }

package/src/Jackpots/JackpotPot.ts

@@ -0,0 +1,10 @@
+
+interface JackpotPot {
+    jp_template_id: number;
+    jp_pot_id: number;
+    current_pot_amount: number;
+    explode_date_ts: number;
+    // last_exploded_pot?: JackpotPot;
+}
+
+export { JackpotPot }

package/src/Jackpots/JackpotPublicMeta.ts

@@ -0,0 +1,8 @@
+interface JackpotPublicMeta {
+    name: string;
+    description: string;
+    image_url: string;
+}
+
+
+export { JackpotPublicMeta }

package/src/Jackpots/JackpotType.ts

@@ -0,0 +1,8 @@
+
+
+enum JackpotType {
+    Main = 1
+}
+
+
+export { JackpotType }

package/src/Jackpots/JackpotsOptinRequest.ts

@@ -0,0 +1,7 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+
+export interface JackpotsOptinRequest extends ProtocolMessage {
+
+    jp_template_id: number;
+}

package/src/Jackpots/JackpotsOptinResponse.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+
+export interface JackpotsOptinResponse extends ProtocolResponse {
+
+}

package/src/Jackpots/JackpotsOptoutRequest.ts

@@ -0,0 +1,7 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+
+export interface JackpotsOptoutRequest extends ProtocolMessage {
+
+    jp_template_id: number;
+}

package/src/Jackpots/JackpotsOptoutResponse.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+
+export interface JackpotsOptoutResponse extends ProtocolResponse {
+
+}

package/src/MiniGames/SAWGameType.ts

@@ -4,7 +4,8 @@ export enum SAWGameType {
     SpinAWheel = 1,
     ScratchCard = 2,
     MatchX = 3,
-    GiftBox = 4
+    GiftBox = 4,
+    PrizeDrop = 5
 }
 
 export enum SAWGameTypeName {
@@ -12,6 +13,7 @@ export enum SAWGameTypeName {
     ScratchCard = "scratch",
     MatchX = "matchx",
     GiftBox = "giftbox",
+    PrizeDrop = "prizedrop",
     Unknown = "unknown"
 }
 
@@ -21,6 +23,7 @@ export const SAWGameTypeNamed = (type: SAWGameType): SAWGameTypeName => {
         [SAWGameType.SpinAWheel]: SAWGameTypeName.SpinAWheel,
         [SAWGameType.ScratchCard]: SAWGameTypeName.ScratchCard,
         [SAWGameType.MatchX]: SAWGameTypeName.MatchX,
-        [SAWGameType.GiftBox]: SAWGameTypeName.GiftBox
+        [SAWGameType.GiftBox]: SAWGameTypeName.GiftBox,
+        [SAWGameType.PrizeDrop]: SAWGameTypeName.PrizeDrop
     }[type] || SAWGameTypeName.Unknown;
 }

package/src/MiniGames/SAWPrizeDropAknowledgeRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface SAWPrizeDropAknowledgeRequest extends ProtocolMessage {
+    request_id: string; // guid
+}

package/src/MiniGames/SAWPrizeDropAknowledgeResponse.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+
+export interface SAWPrizeDropAknowledgeResponse extends ProtocolMessage {
+    request_id: string; // guid
+}

package/src/MiniGames/SAWPrizeDropWinPush.ts

@@ -0,0 +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/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/Quiz/MarketsAnswersType.ts

@@ -0,0 +1,22 @@
+export 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',
+}