@smartico/public-api 0.0.57 → 0.0.59

package/docs/README.md

@@ -5,11 +5,13 @@
 - [SAWBuyInTypeName](enums/SAWBuyInTypeName.md)
 - [SAWGameTypeName](enums/SAWGameTypeName.md)
 - [MiniGamePrizeTypeName](enums/MiniGamePrizeTypeName.md)
+- [SAWSpinErrorCode](enums/SAWSpinErrorCode.md)
 - [TournamentRegistrationStatusName](enums/TournamentRegistrationStatusName.md)
 
 ## Interfaces
 
 - [TMiniGamePrize](interfaces/TMiniGamePrize.md)
+- [TMiniGamePlayResult](interfaces/TMiniGamePlayResult.md)
 - [TMiniGameTemplate](interfaces/TMiniGameTemplate.md)
 - [TUserProfile](interfaces/TUserProfile.md)
 - [TLevel](interfaces/TLevel.md)

package/docs/classes/WSAPI.md

@@ -4,13 +4,13 @@
 
 ### getUserProfile
 
-▸ **getUserProfile**(): `Promise`<[`TUserProfile`](../interfaces/TUserProfile.md)\>
+▸ **getUserProfile**(): [`TUserProfile`](../interfaces/TUserProfile.md)
 
 Returns information about current user
 
 #### Returns
 
-`Promise`<[`TUserProfile`](../interfaces/TUserProfile.md)\>
+[`TUserProfile`](../interfaces/TUserProfile.md)
 
 ___
 
@@ -86,6 +86,24 @@ Returns the list of mini-games available for user
 
 ___
 
+### playMiniGame
+
+▸ **playMiniGame**(`template_id`): `Promise`<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
+
+Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `template_id` | `number` |
+
+#### Returns
+
+`Promise`<[`TMiniGamePlayResult`](../interfaces/TMiniGamePlayResult.md)\>
+
+___
+
 ### getTournamentsList
 
 ▸ **getTournamentsList**(): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>

package/docs/enums/SAWSpinErrorCode.md

@@ -0,0 +1,49 @@
+# Enumeration: SAWSpinErrorCode
+
+## Enumeration Members
+
+### SAW\_OK
+
+• **SAW\_OK** = ``0``
+
+No error
+
+___
+
+### SAW\_NO\_SPINS
+
+• **SAW\_NO\_SPINS** = ``40001``
+
+User doesn't have 'spin attempts' to play. In case buy in type for the game is 'spins' based
+
+___
+
+### SAW\_PRIZE\_POOL\_EMPTY
+
+• **SAW\_PRIZE\_POOL\_EMPTY** = ``40002``
+
+The are no prizes left to play the game
+
+___
+
+### SAW\_NOT\_ENOUGH\_POINTS
+
+• **SAW\_NOT\_ENOUGH\_POINTS** = ``40003``
+
+User doesn't have enough points to play. In case buy in type for the game is 'points' based
+
+___
+
+### SAW\_FAILED\_MAX\_SPINS\_REACHED
+
+• **SAW\_FAILED\_MAX\_SPINS\_REACHED** = ``40004``
+
+User reached max number of game attempts defined in the BackOffice
+
+___
+
+### SAW\_VISITOR\_STOP\_SPIN\_REQUEST
+
+• **SAW\_VISITOR\_STOP\_SPIN\_REQUEST** = ``-40001``
+
+Special code for the 'visitor' mode

package/docs/interfaces/TLevel.md

@@ -1,6 +1,6 @@
 # Interface: TLevel
 
-TLevel interface describes the information of each level defined in the system
+TLevel describes the information of each level defined in the system
 There is no order of the levels, but it can be calculated using required_points property
 The current level of user can be taken from the user object using ach_level_current_id property
 The progress to the next level can be calculated using ach_points_ever and required_points properties of next level

package/docs/interfaces/TMiniGamePlayResult.md

@@ -0,0 +1,27 @@
+# Interface: TMiniGamePlayResult
+
+TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame(template_id) method
+
+## Properties
+
+### err\_code
+
+• **err\_code**: [`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
+
+___
+
+### err\_message
+
+• **err\_message**: `string`
+
+Optional error message
+
+___
+
+### prize\_id
+
+• **prize\_id**: `number`
+
+The prize_id that user won, details of the prize can be found in the mini-game definition

package/docs/interfaces/TMiniGamePrize.md

@@ -1,6 +1,6 @@
 # Interface: TMiniGamePrize
 
-TMiniGamePrize interface describes the information of prize in the array of prizes in the TMiniGameTemplate
+TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
 
 ## Properties
 

package/docs/interfaces/TMiniGameTemplate.md

@@ -1,6 +1,6 @@
 # Interface: TMiniGameTemplate
 
-TMiniGameTemplate interface describes the information of mini-games available for the user
+TMiniGameTemplate describes the information of mini-games available for the user
 
 ## Properties
 

package/docs/interfaces/TMissionOrBadge.md

@@ -1,6 +1,6 @@
 # Interface: TMissionOrBadge
 
-TMissionOrBadge interface describes the information of mission or badge defined in the system
+TMissionOrBadge describes the information of mission or badge defined in the system
 
 ## Properties
 

package/docs/interfaces/TMissionOrBadgeTask.md

@@ -1,6 +1,6 @@
 # Interface: TMissionOrBadgeTask
 
-TMissionOrBadgeTask interface describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
+TMissionOrBadgeTask describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
 
 ## Properties
 

package/docs/interfaces/TStoreCategory.md

@@ -1,6 +1,6 @@
 # Interface: TStoreCategory
 
-TStoreCategory interface describes the store category item. Each store item can be assigned to 1 or more categories
+TStoreCategory describes the store category item. Each store item can be assigned to 1 or more categories
 
 ## Properties
 

package/docs/interfaces/TStoreItem.md

@@ -1,6 +1,6 @@
 # Interface: TStoreItem
 
-TStoreItem interface describes the information of the store item defined in the system
+TStoreItem describes the information of the store item defined in the system
 
 ## Properties
 

package/docs/interfaces/TTournament.md

@@ -1,6 +1,6 @@
 # Interface: TTournament
 
-TTournament interface describes the general information of the tournament item
+TTournament describes the general information of the tournament item
 
 ## Hierarchy
 

package/docs/interfaces/TTournamentDetailed.md

@@ -1,6 +1,6 @@
 # Interface: TTournamentDetailed
 
-TTournamentDetailed interface describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
+TTournamentDetailed describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
 
 ## Hierarchy
 

package/docs/interfaces/TUserProfile.md

@@ -1,6 +1,6 @@
 # Interface: TUserProfile
 
-TUser interface describes the information of the user
+TUser describes the information of the user
 The user object is returned by _smartico.api.getUserProfile() method.
 If you want to track the changes of the user profile, you can subscribe to the callback in the following way
  _smartico.on('props_change', () => console.log(_smartico.api.getUserProfile()) );

package/package.json

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

package/src/MiniGames/SAWPrizeUI.ts

@@ -12,4 +12,5 @@ export interface SAWPrizeUI {
     sound_type: SAWWinSoundType;    
     icon?: string;
     replace_name_with_image?: boolean;
+    acknowledge_action_title?: string;
 }

package/src/MiniGames/SAWSpinErrorCode.ts

@@ -1,10 +1,18 @@
 
+/*
+*  Possible error codes for the mini-games attempts
+*/
 export enum SAWSpinErrorCode {
+    /** No error */
     SAW_OK = 0,
+    /** User doesn't have 'spin attempts' to play. In case buy in type for the game is 'spins' based */
     SAW_NO_SPINS = 40001,
+    /** The are no prizes left to play the game */
     SAW_PRIZE_POOL_EMPTY = 40002,
+    /** User doesn't have enough points to play. In case buy in type for the game is 'points' based */
     SAW_NOT_ENOUGH_POINTS = 40003,
+    /** User reached max number of game attempts defined in the BackOffice */
     SAW_FAILED_MAX_SPINS_REACHED = 40004,
-
-    SAW_VISITOR_STOP_SPIN_REQUEST = -40001 // special code for visitor game mode to stop spin request
+    /** Special code for the 'visitor' mode */
+    SAW_VISITOR_STOP_SPIN_REQUEST = -40001 
 }

package/src/SmarticoAPI.ts

@@ -295,7 +295,7 @@ class SmarticoAPI {
         return SAWTemplatesTransform((await this.sawGetTemplates(user_ext_id)).templates);
     }    
 
-    public async sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id: number): Promise<SAWDoSpinResponse> {
+    public async sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id?: number): Promise<SAWDoSpinResponse> {
 
         const message = this.buildMessage<SAWDoSpinRequest, SAWDoSpinResponse>(user_ext_id, ClassId.SAW_DO_SPIN_REQUEST, {
             saw_template_id,

package/src/WSAPI/WSAPI.ts

@@ -1,7 +1,7 @@
 import { CoreUtils } from "../Core";
 import { SmarticoAPI } from "../SmarticoAPI";
 
-import { TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
+import { TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
 
 /** @group General API */
 export class WSAPI {
@@ -49,7 +49,21 @@ export class WSAPI {
     /** Returns the list of mini-games available for user */
     public async getMiniGames(): Promise<TMiniGameTemplate[]> {
         return this.api.sawGetTemplatesT(null);
-    }        
+    }
+
+    /** Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code  */
+    public async playMiniGame(template_id: number): Promise<TMiniGamePlayResult> {
+        
+        const r = await this.api.sawSpinRequest(null, template_id);
+
+        const o: TMiniGamePlayResult = {
+            err_code: r.errCode,
+            err_message: r.errMsg,
+            prize_id: r.saw_prize_id,
+        }
+
+        return o;
+    }    
 
     /** Returns all the active instances of tournaments */
     public async getTournamentsList(): Promise<TTournament[]> {

package/src/WSAPI/WSAPITypes.ts

@@ -1,11 +1,11 @@
-import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWPrizeType, SAWPrizeUI } from "../MiniGames";
+import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWPrizeType, SAWPrizeUI, SAWSpinErrorCode } from "../MiniGames";
 import { TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
 
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string
 
 
 /**
- * TMiniGamePrize interface describes the information of prize in the array of prizes in the TMiniGameTemplate
+ * TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
 */
 export interface TMiniGamePrize {
     /** ID of the prize */
@@ -23,9 +23,21 @@ export interface TMiniGamePrize {
 }
 
 
+/**
+ * TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame(template_id) method
+*/
+export interface TMiniGamePlayResult {
+    /** Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0 */
+    err_code: SAWSpinErrorCode;
+    /** Optional error message */
+    err_message: string;
+    /** The prize_id that user won, details of the prize can be found in the mini-game definition */
+    prize_id: number;
+}
+
 
 /**
- * TMiniGameTemplate interface describes the information of mini-games available for the user
+ * TMiniGameTemplate describes the information of mini-games available for the user
 */
 export interface TMiniGameTemplate {
     /** ID of the mini-game template */
@@ -69,7 +81,7 @@ export interface TMiniGameTemplate {
 
 
 /**
- * TUser interface describes the information of the user
+ * TUser describes the information of the user
  * The user object is returned by _smartico.api.getUserProfile() method.
  * If you want to track the changes of the user profile, you can subscribe to the callback in the following way
  *  _smartico.on('props_change', () => console.log(_smartico.api.getUserProfile()) );
@@ -102,7 +114,7 @@ export interface TUserProfile {
 }
 
 /** 
- * TLevel interface describes the information of each level defined in the system
+ * TLevel describes the information of each level defined in the system
  * There is no order of the levels, but it can be calculated using required_points property
  * The current level of user can be taken from the user object using ach_level_current_id property
  * The progress to the next level can be calculated using ach_points_ever and required_points properties of next level
@@ -138,7 +150,7 @@ export interface TLevel {
 }
 
 /** 
- * TTournament interface describes the general information of the tournament item
+ * TTournament describes the general information of the tournament item
  */
 
 export interface TTournament {
@@ -213,7 +225,7 @@ export interface TTournament {
 }
 
 /** 
- * TTournamentDetailed interface describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
+ * TTournamentDetailed describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
  */
 export interface TTournamentDetailed extends TTournament {
     
@@ -245,7 +257,7 @@ export interface TTournamentDetailed extends TTournament {
 };
 
 /** 
- * TStoreCategory interface describes the store category item. Each store item can be assigned to 1 or more categories
+ * TStoreCategory describes the store category item. Each store item can be assigned to 1 or more categories
  */
 export interface TStoreCategory {
     id: number;
@@ -254,7 +266,7 @@ export interface TStoreCategory {
 }
 
 /** 
- * TStoreItem interface describes the information of the store item defined in the system
+ * TStoreItem describes the information of the store item defined in the system
  */
 export interface TStoreItem {
     /** ID of the store item  */
@@ -290,7 +302,7 @@ export interface TStoreItem {
 }
 
 /** 
- * TMissionOrBadge interface describes the information of mission or badge defined in the system
+ * TMissionOrBadge describes the information of mission or badge defined in the system
  */
 export interface TMissionOrBadge {
     /** ID of the mission or badge  */
@@ -346,7 +358,7 @@ export interface TMissionOrBadge {
 }
 
 /** 
- * TMissionOrBadgeTask interface describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
+ * TMissionOrBadgeTask describes the information of tasks that belings to mission or badge. See also TMissionOrBadge
  */
 export interface TMissionOrBadgeTask {
     /** ID of the task */

package/tsconfig.json

@@ -22,6 +22,7 @@
             "src/MiniGames/SAWBuyInType.ts",
             "src/MiniGames/SAWGameType.ts",
             "src/MiniGames/SAWPrizeType.ts",
+            "src/MiniGames/SAWSpinErrorCode.ts",
         ],
         "out": "docs",
         "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],