@smartico/public-api 0.0.78 → 0.0.80

package/docs/README.md

@@ -6,6 +6,8 @@
 - [SAWGameTypeName](enums/SAWGameTypeName.md)
 - [MiniGamePrizeTypeName](enums/MiniGamePrizeTypeName.md)
 - [SAWSpinErrorCode](enums/SAWSpinErrorCode.md)
+- [BuyStoreItemErrorCode](enums/BuyStoreItemErrorCode.md)
+- [TournamentRegistrationError](enums/TournamentRegistrationError.md)
 - [TournamentRegistrationStatusName](enums/TournamentRegistrationStatusName.md)
 
 ## Interfaces
@@ -22,6 +24,8 @@
 - [TMissionOrBadge](interfaces/TMissionOrBadge.md)
 - [TMissionOrBadgeTask](interfaces/TMissionOrBadgeTask.md)
 - [TMissionOptInResult](interfaces/TMissionOptInResult.md)
+- [TTournamentRegistrationResult](interfaces/TTournamentRegistrationResult.md)
+- [TBuyStoreItemResult](interfaces/TBuyStoreItemResult.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -67,6 +67,24 @@ Returns all the store items available the current user
 
 ___
 
+### buyStoreItem
+
+▸ **buyStoreItem**(`item_id`): `Promise`<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
+
+Buy the specific shop item by item_id. Returns the err_code.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `item_id` | `number` |
+
+#### Returns
+
+`Promise`<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
+
+___
+
 ### getStoreCategories
 
 ▸ **getStoreCategories**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
@@ -167,3 +185,21 @@ Returns details information of specific tournament instance, the response will i
 #### Returns
 
 `Promise`<[`TTournamentDetailed`](../interfaces/TTournamentDetailed.md)\>
+
+___
+
+### registerInTournament
+
+▸ **registerInTournament**(`tournamentInstanceId`): `Promise`<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>
+
+Requests registration for the specified tournament instance. Returns the err_code.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tournamentInstanceId` | `number` |
+
+#### Returns
+
+`Promise`<[`TTournamentRegistrationResult`](../interfaces/TTournamentRegistrationResult.md)\>

package/docs/enums/BuyStoreItemErrorCode.md

@@ -0,0 +1,49 @@
+# Enumeration: BuyStoreItemErrorCode
+
+## Enumeration Members
+
+### FAILED\_TO\_BUY\_SHOP\_ITEM
+
+• **FAILED\_TO\_BUY\_SHOP\_ITEM** = ``121``
+
+___
+
+### SHOP\_NO\_BALANCE
+
+• **SHOP\_NO\_BALANCE** = ``11000``
+
+___
+
+### SHOP\_WRONG\_LABEL
+
+• **SHOP\_WRONG\_LABEL** = ``11001``
+
+___
+
+### SHOP\_FAILED\_TO\_BUY\_BONUS
+
+• **SHOP\_FAILED\_TO\_BUY\_BONUS** = ``11002``
+
+___
+
+### SHOP\_FAILED\_TO\_BUY\_SHOP\_ITEM\_CONDITION
+
+• **SHOP\_FAILED\_TO\_BUY\_SHOP\_ITEM\_CONDITION** = ``11003``
+
+___
+
+### SHOP\_FAILED\_TO\_BUY\_SHOP\_ITEM\_CONDITION\_PURSHASE
+
+• **SHOP\_FAILED\_TO\_BUY\_SHOP\_ITEM\_CONDITION\_PURSHASE** = ``11004``
+
+___
+
+### SHOP\_FAILED\_TO\_BUY\_MATCHING\_BONUS
+
+• **SHOP\_FAILED\_TO\_BUY\_MATCHING\_BONUS** = ``11005``
+
+___
+
+### SHOP\_FAILED\_MAX\_BOUGHT\_ITEMS\_REACHED
+
+• **SHOP\_FAILED\_MAX\_BOUGHT\_ITEMS\_REACHED** = ``11006``

package/docs/enums/TournamentRegistrationError.md

@@ -0,0 +1,55 @@
+# Enumeration: TournamentRegistrationError
+
+## Enumeration Members
+
+### NO\_ERROR
+
+• **NO\_ERROR** = ``0``
+
+___
+
+### TOURNAMENT\_INSTANCE\_NOT\_FOUND
+
+• **TOURNAMENT\_INSTANCE\_NOT\_FOUND** = ``30001``
+
+___
+
+### TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS
+
+• **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS** = ``30002``
+
+___
+
+### TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE
+
+• **TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE** = ``30003``
+
+___
+
+### TOURNAMENT\_ALREADY\_REGISTERED
+
+• **TOURNAMENT\_ALREADY\_REGISTERED** = ``30004``
+
+___
+
+### TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS
+
+• **TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS** = ``30005``
+
+___
+
+### TOURNAMENT\_USER\_NOT\_REGISTERED
+
+• **TOURNAMENT\_USER\_NOT\_REGISTERED** = ``30006``
+
+___
+
+### TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS
+
+• **TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS** = ``30007``
+
+___
+
+### TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED
+
+• **TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED** = ``30008``

package/docs/interfaces/TBuyStoreItemResult.md

@@ -0,0 +1,17 @@
+# Interface: TBuyStoreItemResult
+
+## Properties
+
+### err\_code
+
+• **err\_code**: [`BuyStoreItemErrorCode`](../enums/BuyStoreItemErrorCode.md)
+
+Error code representing the result of the purchase of the shop item. Successful purchase if err_code is 0
+
+___
+
+### err\_message
+
+• **err\_message**: `string`
+
+Optional error message

package/docs/interfaces/TTournamentRegistrationResult.md

@@ -0,0 +1,17 @@
+# Interface: TTournamentRegistrationResult
+
+## Properties
+
+### err\_code
+
+• **err\_code**: [`TournamentRegistrationError`](../enums/TournamentRegistrationError.md)
+
+Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0
+
+___
+
+### err\_message
+
+• **err\_message**: `string`
+
+Optional error message

package/package.json

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

package/src/Inbox/InboxMessage.ts

@@ -14,5 +14,5 @@ export interface InboxMessage {
     engagement_uid: string;
     is_read: boolean;
     is_starred: boolean;
-    additional_buttons?: { inbox_cta_text: string, action: string }
+    additional_buttons?: { inbox_cta_text: string, action: string }[];
 }

package/src/SmarticoAPI.ts

@@ -11,9 +11,9 @@ import { CoreUtils, GetTranslationsRequest, GetTranslationsResponse, ResponseIde
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetLabelInfoRequest } from './Core/GetLabelInfoRequest';
 import { GetInboxMessagesRequest, GetInboxMessagesResponse } from './Inbox';
-import { GetCategoriesStoreResponse, GetStoreItemsResponse, StoreCategoryTransform, StoreItemTransform } from './Store';
+import { BuyStoreItemRequest, BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreItemsResponse, StoreCategoryTransform, StoreItemTransform } from './Store';
 import { AchievementOptinRequest, AchievementOptinResponse, AchievementType, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
-import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse, TournamentItemsTransform, tournamentInfoItemTransform } from './Tournaments';
+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";
@@ -264,7 +264,7 @@ class SmarticoAPI {
             public_username_custom
         });
         
-        return this.send(message, ClassId.CLIENT_SET_CUSTOM_USERNAME_RESPONSE);
+        return await this.send(message, ClassId.CLIENT_SET_CUSTOM_USERNAME_RESPONSE);
     }
 
     public async sawGetTemplates(user_ext_id: string, lang?: string, is_visitor_mode: boolean = false): Promise<SAWGetTemplatesResponse> {
@@ -351,6 +351,32 @@ class SmarticoAPI {
         return res;
     }
 
+    public async registerInTournament(user_ext_id: string, tournamentInstanceId: number) {
+        if (!tournamentInstanceId) {
+            throw new Error('Missing tournament instance id');
+        }
+        const message = this.buildMessage<TournamentRegisterRequest, TournamentRegisterResponse>(user_ext_id, ClassId.TOURNAMENT_REGISTER_REQUEST, {
+            tournamentInstanceId
+        });
+
+        const res = await this.send<TournamentRegisterResponse>(message, ClassId.TOURNAMENT_REGISTER_RESPONSE);
+
+        return res;
+    }
+
+    public async buyStoreItem(user_ext_id: string, itemId: number) {
+        if (!itemId) {
+            throw new Error('Missing store item id');
+        }
+        const message = this.buildMessage<BuyStoreItemRequest, BuyStoreItemResponse>(user_ext_id, ClassId.BUY_SHOP_ITEM_REQUEST, {
+            itemId
+        });
+
+        const res = await this.send<BuyStoreItemResponse>(message, ClassId.BUY_SHOP_ITEM_RESPONSE);
+
+        return res;
+    }
+
     public async inboxGetMessages(user_ext_id: string, limit: number = 10, offset: number = 0): Promise<GetInboxMessagesResponse> {
 
         const message = this.buildMessage<GetInboxMessagesRequest, GetInboxMessagesResponse>(user_ext_id, ClassId.GET_INBOX_MESSAGES_REQUEST, {

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 { TLevel, TMiniGamePlayResult, TMiniGamePrize, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
+import { TBuyStoreItemResult, TLevel, TMiniGamePlayResult, TMiniGamePrize, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
  
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -70,6 +70,18 @@ export class WSAPI {
         return this.api.storeGetItemsT(null);
     }
 
+    /** Buy the specific shop item by item_id. Returns the err_code.*/
+    public async buyStoreItem(item_id: number): Promise<TBuyStoreItemResult> {
+        const r = await this.api.buyStoreItem(null, item_id);
+
+        const o: TBuyStoreItemResult = {
+            err_code: r.errCode,
+            err_message: r.errMsg,
+        }
+
+        return o;
+    }
+
     /** Returns store categories */
     public async getStoreCategories(): Promise<TStoreItem[]> {
         return this.api.storeGetItemsT(null);
@@ -135,6 +147,18 @@ export class WSAPI {
         return this.api.tournamentsGetInfoT(null, tournamentInstanceId);
     }
 
+    /** Requests registration for the specified tournament instance. Returns the err_code. */
+    public async registerInTournament(tournamentInstanceId: number): Promise<TTournamentRegistrationResult>{
+        const r = await this.api.registerInTournament(null, tournamentInstanceId);
+
+        const o: TTournamentRegistrationResult = {
+            err_code: r.errCode,
+            err_message: r.errMsg,
+        }
+
+        return o;
+    }
+
     private async updateOnSpin(data: SAWSpinsCountPush) {
         const templates: TMiniGameTemplate[] = await OCache.use(onUpdateContextKey.Saw, ECacheContext.WSAPI, () => this.api.sawGetTemplatesT(null), CACHE_DATA_SEC);
         const index = templates.findIndex(t => t.id === data.saw_template_id);

package/src/WSAPI/WSAPITypes.ts

@@ -1,5 +1,6 @@
-import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWPrizeType, SAWPrizeUI, SAWSpinErrorCode } from "../MiniGames";
-import { TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
+import { BuyStoreItemErrorCode } from "../Store";
+import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from "../MiniGames";
+import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
 
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string
 
@@ -398,4 +399,18 @@ export interface TMissionOptInResult {
      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;
+     /** Optional error message */
+    err_message: string;
+}
+
+export interface TBuyStoreItemResult {
+    /** Error code representing the result of the purchase of the shop item. Successful purchase if err_code is 0 */
+   err_code: BuyStoreItemErrorCode;
+    /** Optional error message */
+   err_message: string;
 }

package/tsconfig.json

@@ -23,6 +23,8 @@
             "src/MiniGames/SAWGameType.ts",
             "src/MiniGames/SAWPrizeType.ts",
             "src/MiniGames/SAWSpinErrorCode.ts",
+            "src/Tournaments/TournamentRegistrationError.ts",
+            "src/Store/BuyStoreItemErrorCode.ts",
         ],
         "out": "docs",
         "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],