@smartico/public-api 0.0.72 → 0.0.74

package/docs/README.md

@@ -21,6 +21,7 @@
 - [TStoreItem](interfaces/TStoreItem.md)
 - [TMissionOrBadge](interfaces/TMissionOrBadge.md)
 - [TMissionOrBadgeTask](interfaces/TMissionOrBadgeTask.md)
+- [TMissionOptInResult](interfaces/TMissionOptInResult.md)
 
 ## General API
 

package/docs/classes/WSAPI.md

@@ -28,18 +28,14 @@ ___
 
 ### getMissions
 
-▸ **getMissions**(`«destructured»?`): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
-
-Returns all the missions available the current user.
-The returned missions is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one. 
-The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it.
+▸ **getMissions**(`params?`): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `«destructured»` | `Object` |
-| › `onUpdate?` | (`data`: [`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]) => `void` |
+| `params` | `Object` |
+| `params.onUpdate?` | (`data`: [`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]) => `void` |
 
 #### Returns
 
@@ -85,18 +81,17 @@ ___
 
 ### getMiniGames
 
-▸ **getMiniGames**(`«destructured»?`): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
+▸ **getMiniGames**(`params?`): `Promise`<[`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]\>
 
-Returns the list of mini-games available for user 
-The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one. 
-The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or wined prize is spin/jackpot and if max count of the available user spin equal one. Updated templates will be passed to onUpdate callback.
+/**
+ *
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `«destructured»` | `Object` |
-| › `onUpdate?` | (`data`: [`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]) => `void` |
+| `params` | `Object` |
+| `params.onUpdate?` | (`data`: [`TMiniGameTemplate`](../interfaces/TMiniGameTemplate.md)[]) => `void` |
 
 #### Returns
 
@@ -122,20 +117,34 @@ Plays the specified by template_id mini-game on behalf of user and returns prize
 
 ___
 
-### getTournamentsList
+### requestMissionOptIn
+
+▸ **requestMissionOptIn**(`mission_id`): `Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
+
+Requests an opt-in for the specified mission_id. Returns the err_code.
 
-▸ **getTournamentsList**(`«destructured»?`): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mission_id` | `number` |
+
+#### Returns
+
+`Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
+
+___
+
+### getTournamentsList
 
-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.
+▸ **getTournamentsList**(`params?`): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `«destructured»` | `Object` |
-| › `onUpdate?` | (`data`: [`TTournament`](../interfaces/TTournament.md)[]) => `void` |
+| `params` | `Object` |
+| `params.onUpdate?` | (`data`: [`TTournament`](../interfaces/TTournament.md)[]) => `void` |
 
 #### Returns
 

package/docs/interfaces/TMissionOptInResult.md

@@ -0,0 +1,19 @@
+# Interface: TMissionOptInResult
+
+TMissionOptInResult describes the response of call to _smartico.api.requestMissionOptIn(mission_id) method
+
+## Properties
+
+### err\_code
+
+• **err\_code**: `number`
+
+Error code that represents outcome of the opt-in request. Successful opt-in 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.72",
+  "version": "0.0.74",
   "description": "Smartico public API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/SmarticoAPI.ts

@@ -12,7 +12,7 @@ import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetLabelInfoRequest } from './Core/GetLabelInfoRequest';
 import { GetInboxMessagesRequest, GetInboxMessagesResponse } from './Inbox';
 import { GetCategoriesStoreResponse, GetStoreItemsResponse, StoreCategoryTransform, StoreItemTransform } from './Store';
-import { AchievementType, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
+import { AchievementOptinRequest, AchievementOptinResponse, AchievementType, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
 import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse, TournamentItemsTransform, tournamentInfoItemTransform } from './Tournaments';
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse, GetLevelMapResponseTransform } from "./Level";
@@ -334,6 +334,16 @@ class SmarticoAPI {
         return {...spinAttemptResponse, request_id };
     }
 
+    public async missionOptIn(user_ext_id: string, mission_id: number) {
+        const message = this.buildMessage<AchievementOptinRequest, AchievementOptinResponse>(user_ext_id, ClassId.MISSION_OPTIN_REQUEST, {
+           achievementId: mission_id
+        });
+
+        const res = await this.send<AchievementOptinResponse>(message, ClassId.MISSION_OPTIN_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, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
+import { TLevel, TMiniGamePlayResult, TMiniGamePrize, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
  
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -24,6 +24,7 @@ export class WSAPI {
     constructor(private api: SmarticoAPI) {
         const on = this.api.tracker.on;
         on(ClassId.SAW_SPINS_COUNT_PUSH, (data: SAWSpinsCountPush) => this.updateOnSpin(data));
+        on(ClassId.SAW_SHOW_SPIN_PUSH, () => this.updateOnAddSpin());
         on(ClassId.SAW_DO_SPIN_RESPONSE, (data: SAWDoSpinResponse) => on(ClassId.SAW_AKNOWLEDGE_RESPONSE, () => this.updateOnPrizeWin(data)));
         on(ClassId.MISSION_OPTIN_RESPONSE, () => this.updateMissionsOnOptIn());
         on(ClassId.TOURNAMENT_REGISTER_RESPONSE, () => this.updateTournamentsOnRegistration());
@@ -47,7 +48,10 @@ export class WSAPI {
 
     /** Returns all the missions available the current user.
      * The returned missions is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one. 
-     * The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it. */ 
+     * The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it. */
+     /**
+     * @param params
+     */
     public async getMissions({ onUpdate }: { onUpdate?: (data: TMissionOrBadge[]) => void } = {}): Promise<TMissionOrBadge[]> {
         if (onUpdate) {
             this.onUpdateCallback.set(onUpdateContextKey.Missions, onUpdate);
@@ -73,7 +77,11 @@ export class WSAPI {
 
     /** Returns the list of mini-games available for user 
      * The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one. 
-     * The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or wined prize is spin/jackpot and if max count of the available user spin equal one. Updated templates will be passed to onUpdate callback. */
+     * The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or wined prize is spin/jackpot and if max count of the available user spin equal one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback. */
+    /**
+    /**
+     * @param params
+     */
     public async getMiniGames({ onUpdate }: { onUpdate?: (data: TMiniGameTemplate[]) => void } = {}): Promise<TMiniGameTemplate[]> {
         if (onUpdate) {
             this.onUpdateCallback.set(onUpdateContextKey.Saw, onUpdate);
@@ -94,11 +102,26 @@ export class WSAPI {
         }
 
         return o;
-    }    
+    }
+
+    /** Requests an opt-in for the specified mission_id. Returns the err_code. */
+    public async requestMissionOptIn(mission_id: number): Promise<TMissionOptInResult>{
+        const r = await this.api.missionOptIn(null, mission_id);
+
+        const o: TMissionOptInResult = {
+            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.*/
+    /**
+     * @param params
+     */
     public async getTournamentsList({ onUpdate }: { onUpdate?: (data: TTournament[]) => void } = {}): Promise<TTournament[]> {
         if (onUpdate) {
             this.onUpdateCallback.set(onUpdateContextKey.TournamentList, onUpdate);
@@ -119,6 +142,11 @@ export class WSAPI {
         this.updateEntity(onUpdateContextKey.Saw, templates)
     }
 
+    private async updateOnAddSpin() {
+        const payload = await this.api.sawGetTemplatesT(null);
+        this.updateEntity(onUpdateContextKey.Saw, payload)
+    }
+
     private async updateOnPrizeWin(data: SAWDoSpinResponse) {
         if (data.errCode === SAWSpinErrorCode.SAW_OK) {
             const templates: TMiniGameTemplate[] = await OCache.use(onUpdateContextKey.Saw, ECacheContext.WSAPI, () => this.api.sawGetTemplatesT(null), CACHE_DATA_SEC);

package/src/WSAPI/WSAPITypes.ts

@@ -372,4 +372,14 @@ export interface TMissionOrBadgeTask {
     is_completed: boolean,
     /** The progress of the task in percents */
     progress: number
+}
+
+/**
+ * TMissionOptInResult describes the response of call to _smartico.api.requestMissionOptIn(mission_id) method
+*/
+export interface TMissionOptInResult {
+     /** Error code that represents outcome of the opt-in request. Successful opt-in in case err_code is 0 */
+     err_code: number;
+     /** Optional error message */
+     err_message: string;
 }