@smartico/public-api 0.0.355 → 0.0.357

package/README.md

@@ -122,19 +122,44 @@ npm install --save @smartico/public-api
 
 ### Usage
 
+`WSAPI` provides a high-level interface on top of `SmarticoAPI`. Create a `SmarticoAPI` instance with a custom `messageSender`, then create `WSAPI` instances bound to specific users:
+
 ```typescript
-import { SmarticoAPI } from '@smartico/public-api';
+import { SmarticoAPI, WSAPI } from '@smartico/public-api';
+
+// publicApiUrl is resolved automatically by SmarticoAPI from your label key
+const messageSender = async (message: any, publicApiUrl?: string): Promise<any> => {
+    const res = await fetch(publicApiUrl, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(message),
+    });
+    return res.ok ? res.json() : '';
+};
+
+const smarticoApi = new SmarticoAPI('your-label-api-key', 'your-brand-key', messageSender);
+
+const userExtId = 'John1984';
+const api = new WSAPI(smarticoApi, userExtId);
+
+const missions = await api.getMissions();
+missions.forEach(m => {
+    console.log(m.name, m.is_completed);
+});
 
-const SAPI = new SmarticoAPI( 'your-label-api-key', 'your-brand-key', 'your-message-sender', { logger: console });
+const optInResult = await api.requestMissionOptIn(missions[0].id);
+console.log('Opt-in:', optInResult.err_code);
+```
 
-const userExtId = 'John1984'
-            
-const response = await SAPI.miniGamesGetTemplates(userExtId);
+For the full list of available methods, see the [WSAPI documentation](docs/api/classes/WSAPI.md).
 
-response.templates.forEach( t => {
-    console.log(t.saw_template_ui_definition.name)
-}
+You can also use `SmarticoAPI` directly for low-level protocol access:
 
+```typescript
+const response = await smarticoApi.miniGamesGetTemplates(userExtId);
+response.templates.forEach(t => {
+    console.log(t.saw_template_ui_definition.name);
+});
 ```
 
 ## Backend usage (http-protocol)

package/dist/SmarticoAPI.d.ts

@@ -25,7 +25,7 @@ import { InboxCategories } from './Inbox/InboxCategories';
 import { GetDrawRunResponse, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeResponse, RaffleOptinResponse } from './Raffle';
 import { GetJackpotWinnersResponse, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
 import { GetJackpotEligibleGamesResponse, TGetJackpotEligibleGamesResponse } from './Jackpots/GetJackpotEligibleGamesResponse';
-import { GamesApiResponse, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamePickGameInfo } from './GamePick';
+import { GamesApiResponse, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamePickGameInfo } from './WSAPI/WSAPITypes';
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,7 +1,6 @@
 import { ActivityTypeLimited } from '../Core';
 import { SmarticoAPI } from '../SmarticoAPI';
-import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT, TBonus, TClaimBonusResult, TMiniGamePlayBatchResult, TSawHistory, TRaffle, TRaffleDraw, TRaffleDrawRun, TransformedRaffleClaimPrizeResponse, TLevelCurrent, TActivityLog, TRaffleOptinResponse } from './WSAPITypes';
-import { GamesApiResponse, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamePickGameInfo, GamePickRequestParams, GamePickRoundRequestParams } from '../GamePick';
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT, TBonus, TClaimBonusResult, TMiniGamePlayBatchResult, TSawHistory, TRaffle, TRaffleDraw, TRaffleDrawRun, TransformedRaffleClaimPrizeResponse, TLevelCurrent, TActivityLog, TRaffleOptinResponse, GamesApiResponse, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamePickGameInfo, GamePickRequestParams, GamePickRoundRequestParams } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { JackpotDetails, JackpotWinnerHistory, JackpotsOptinResponse, JackpotsOptoutResponse } from '../Jackpots';
 import { GetRelatedAchTourResponse } from '../Missions/GetRelatedAchTourResponse';
@@ -605,7 +604,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickActiveRounds({
+     * _smartico.api.gamePickGetActiveRounds({
      *      saw_template_id: 1083,
      * }).then((result) => {
      *      console.log(result.data); // GamePickRound[]
@@ -617,7 +616,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickActiveRounds(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickRound[]>>;
+    gamePickGetActiveRounds(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickRound[]>>;
     /**
      * Returns a single active round for the specified MatchX or Quiz game.
      * The round includes full event details with the current user's selections.
@@ -627,12 +626,12 @@ export declare class WSAPI {
      *
      * **Response** `GamesApiResponse<GamePickRound>`:
      * - `errCode` - 0 on success
-     * - `data` - Single round object with the same structure as in `getGamePickActiveRounds`,
+     * - `data` - Single round object with the same structure as in `gamePickGetActiveRounds`,
      *   including `events[]` with full event details, user selections, and resolution info
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickActiveRound({
+     * _smartico.api.gamePickGetActiveRound({
      *      saw_template_id: 1083,
      *      round_id: 31652,
      * }).then((result) => {
@@ -643,7 +642,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickActiveRound(props: GamePickRoundRequestParams): Promise<GamesApiResponse<GamePickRound>>;
+    gamePickGetActiveRound(props: GamePickRoundRequestParams): Promise<GamesApiResponse<GamePickRound>>;
     /**
      * Returns the history of all rounds (including resolved ones) for the specified MatchX or Quiz game.
      * Each round contains full event details with results and the current user's predictions.
@@ -653,12 +652,12 @@ export declare class WSAPI {
      * **Response** `GamesApiResponse<GamePickRound[]>`:
      * - `errCode` - 0 on success
      * - `data` - Array of rounds ordered by `round_row_id` descending (newest first).
-     *   Each round has the same structure as in `getGamePickActiveRounds`, including resolved events
+     *   Each round has the same structure as in `gamePickGetActiveRounds`, including resolved events
      *   with `resolution_type_id` (0=None, 2=Lost, 3=PartialWin, 4=FullWin) and `resolution_score`
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickHistory({
+     * _smartico.api.gamePickGetHistory({
      *      saw_template_id: 1083,
      * }).then((result) => {
      *      result.data.forEach(round => {
@@ -669,7 +668,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickHistory(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickRound[]>>;
+    gamePickGetHistory(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickRound[]>>;
     /**
      * Returns the leaderboard for a specific round within a MatchX or Quiz game.
      * Use `round_id = -1` (AllRoundsGameBoardID) to get the season/overall leaderboard across all rounds.
@@ -691,7 +690,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickBoard({
+     * _smartico.api.gamePickGetBoard({
      *      saw_template_id: 1083,
      *      round_id: 31652,
      * }).then((result) => {
@@ -702,7 +701,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickBoard(props: GamePickRoundRequestParams): Promise<GamesApiResponse<GamePickRoundBoard>>;
+    gamePickGetBoard(props: GamePickRoundRequestParams): Promise<GamesApiResponse<GamePickRoundBoard>>;
     /**
      * Submits score predictions for a round in a MatchX game.
      * Sends the round object with user selections for all events at once.
@@ -711,7 +710,7 @@ export declare class WSAPI {
      * Predictions can be edited until each match starts (if `allow_edit_answers` is enabled on the round).
      *
      * @param props.saw_template_id - The ID of the MatchX game template
-     * @param props.round - Round object containing `round_id` and `events[]`. Typically obtained from `getGamePickActiveRound`
+     * @param props.round - Round object containing `round_id` and `events[]`. Typically obtained from `gamePickGetActiveRound`
      *   and modified with user predictions. Each event needs: `gp_event_id`, `team1_user_selection`, `team2_user_selection`
      *
      * **Response** `GamesApiResponse<GamePickRound>`:
@@ -721,7 +720,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickActiveRound({
+     * _smartico.api.gamePickGetActiveRound({
      *      saw_template_id: 1190,
      *      round_id: 38665,
      * }).then((roundData) => {
@@ -731,7 +730,7 @@ export declare class WSAPI {
      *          team1_user_selection: 1,
      *          team2_user_selection: 0,
      *      }));
-     *      _smartico.api.submitGamePickSelection({
+     *      _smartico.api.gamePickSubmitSelection({
      *          saw_template_id: 1190,
      *          round: round,
      *      }).then((result) => {
@@ -742,7 +741,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    submitGamePickSelection(props: GamePickRequestParams & {
+    gamePickSubmitSelection(props: GamePickRequestParams & {
         round: Partial<GamePickRound>;
     }): Promise<GamesApiResponse<GamePickRound>>;
     /**
@@ -753,7 +752,7 @@ export declare class WSAPI {
      * Answers can be edited until each match starts (if `allow_edit_answers` is enabled on the round).
      *
      * @param props.saw_template_id - The ID of the Quiz game template
-     * @param props.round - Round object containing `round_id` and `events[]`. Typically obtained from `getGamePickActiveRound`
+     * @param props.round - Round object containing `round_id` and `events[]`. Typically obtained from `gamePickGetActiveRound`
      *   and modified with user answers. Each event needs: `gp_event_id`, `user_selection`
      *
      * **Response** `GamesApiResponse<GamePickRound>`:
@@ -763,7 +762,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickActiveRound({
+     * _smartico.api.gamePickGetActiveRound({
      *      saw_template_id: 1183,
      *      round_id: 37974,
      * }).then((roundData) => {
@@ -772,7 +771,7 @@ export declare class WSAPI {
      *          gp_event_id: e.gp_event_id,
      *          user_selection: 'x',
      *      }));
-     *      _smartico.api.submitGamePickSelectionQuiz({
+     *      _smartico.api.gamePickSubmitSelectionQuiz({
      *          saw_template_id: 1183,
      *          round: round,
      *      }).then((result) => {
@@ -783,7 +782,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    submitGamePickSelectionQuiz(props: GamePickRequestParams & {
+    gamePickSubmitSelectionQuiz(props: GamePickRequestParams & {
         round: Partial<GamePickRound>;
     }): Promise<GamesApiResponse<GamePickRound>>;
     /**
@@ -808,7 +807,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickUserInfo({
+     * _smartico.api.gamePickGetUserInfo({
      *      saw_template_id: 1083,
      * }).then((result) => {
      *      console.log(result.data.public_username, result.data.ach_points_balance);
@@ -817,7 +816,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickUserInfo(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickUserInfo>>;
+    gamePickGetUserInfo(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickUserInfo>>;
     /**
      * Returns the game configuration and the list of all rounds for the specified MatchX or Quiz game.
      * Includes the SAW template definition, label settings, and round metadata (without events).
@@ -841,7 +840,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickGameInfo({
+     * _smartico.api.gamePickGetGameInfo({
      *      saw_template_id: 1189,
      * }).then((result) => {
      *      console.log(result.data.sawTemplate.saw_template_ui_definition.name);
@@ -852,39 +851,11 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickGameInfo(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickGameInfo>>;
-    /**
-     * Returns translations for the MatchX/Quiz game UI.
-     * Translations are returned as a key-value map for the Gamification and RetentionGames areas,
-     * resolved to the current user's language.
-     *
-     * @param props.saw_template_id - The ID of the MatchX or Quiz game template
-     *
-     * **Response** `GamesApiResponse<any>`:
-     * - `errCode` - 0 on success
-     * - `data`:
-     *   - `translations` - Key-value map of translation strings (e.g. `rgSubmitSelection`, `rgLeaderboardTitle`, `quizConfirmAnswer`, etc.)
-     *   - `hash_code` - Hash for cache invalidation
-     *   - `lang_code` - Resolved language code (e.g. 'EN')
-     *
-     * **Example**:
-     * ```
-     * _smartico.api.getGamePickTranslations({
-     *      saw_template_id: 1083,
-     * }).then((result) => {
-     *      const tr = result.data.translations;
-     *      console.log(tr.rgSubmitSelection);   // "Submit selection"
-     *      console.log(tr.rgLeaderboardTitle);  // "Leaderboard"
-     * });
-     * ```
-     *
-     * **Visitor mode: not supported**
-     */
-    getGamePickTranslations(props: GamePickRequestParams): Promise<GamesApiResponse<any>>;
+    gamePickGetGameInfo(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickGameInfo>>;
     /**
      * Returns round data with events and picks for a specific user (identified by their internal user ID).
      * Useful for viewing another user's predictions from the leaderboard.
-     * The `int_user_id` can be obtained from the `getGamePickBoard` response (`users[].int_user_id`).
+     * The `int_user_id` can be obtained from the `gamePickGetBoard` response (`users[].int_user_id`).
      *
      * @param props.saw_template_id - The ID of the MatchX or Quiz game template
      * @param props.round_id - The round to get info for
@@ -893,13 +864,13 @@ export declare class WSAPI {
      * **Response** `GamesApiResponse<GamePickRound>`:
      * - `errCode` - 0 on success
      * - `data` - Round object with the target user's selections.
-     *   Same structure as `getGamePickActiveRound`, but `user_selection`/`team1_user_selection`/`team2_user_selection`
+     *   Same structure as `gamePickGetActiveRound`, but `user_selection`/`team1_user_selection`/`team2_user_selection`
      *   fields on events reflect the specified user's picks instead of the current user's.
      *   Events also include `resolution_type_id` (0=None, 2=Lost, 3=PartialWin, 4=FullWin) showing how each prediction was scored
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickRoundInfoForUser({
+     * _smartico.api.gamePickGetRoundInfoForUser({
      *      saw_template_id: 1083,
      *      round_id: 31652,
      *      int_user_id: 65653810,
@@ -912,7 +883,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickRoundInfoForUser(props: GamePickRoundRequestParams & {
+    gamePickGetRoundInfoForUser(props: GamePickRoundRequestParams & {
         int_user_id: number;
     }): Promise<GamesApiResponse<GamePickRound>>;
     private updateOnSpin;