@smartico/public-api 0.0.73 → 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

@@ -117,6 +117,24 @@ Plays the specified by template_id mini-game on behalf of user and returns prize
 
 ___
 
+### requestMissionOptIn
+
+▸ **requestMissionOptIn**(`mission_id`): `Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
+
+Requests an opt-in for the specified mission_id. Returns the err_code.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mission_id` | `number` |
+
+#### Returns
+
+`Promise`<[`TMissionOptInResult`](../interfaces/TMissionOptInResult.md)\>
+
+___
+
 ### getTournamentsList
 
 ▸ **getTournamentsList**(`params?`): `Promise`<[`TTournament`](../interfaces/TTournament.md)[]\>

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.73",
+  "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,7 +24,6 @@ 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_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());
@@ -103,7 +102,19 @@ 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. 

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;
 }