@smartico/public-api 0.0.356 → 0.0.358

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/WSAPI/WSAPI.d.ts

@@ -21,7 +21,7 @@ export declare class WSAPI {
      * Pay attention that this method is synchronous and returns the user profile object immediately, not a promise.
      * **Example**:
      * ```
-     * var p = _smartico.api.getUserProfile);
+     * var p = _smartico.api.getUserProfile();
      * console.log(p);
      * ```
      * **Visitor mode: not supported**
@@ -48,7 +48,7 @@ export declare class WSAPI {
      * **Visitor mode: not supported**
      */
     checkSegmentListMatch(segment_ids: number[]): Promise<TSegmentCheckResult[]>;
-    /** Returns all the levels available the current user
+    /** Returns all the levels available to the current user
      * **Example**:
      * ```
      * _smartico.api.getLevels().then((result) => {
@@ -100,14 +100,14 @@ export declare class WSAPI {
         onUpdate?: (data: TMissionOrBadge[]) => void;
     }): Promise<TMissionOrBadge[]>;
     /**
-     * Returns all the badges available the current user
+     * Returns all the badges available to the current user
      *
      * **Visitor mode: not supported**
      */
     getBadges(): Promise<TMissionOrBadge[]>;
     /**
      * Returns all the bonuses for the current user
-     * The returned bonuss are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
+     * The returned bonuses are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
      * Note that each time you call getBonuses with a new onUpdate callback, the old one will be overwritten by the new one.
      * The onUpdate callback will be called on bonus claimed and the updated bonuses will be passed to it.
      *
@@ -127,7 +127,7 @@ export declare class WSAPI {
     claimBonus(bonus_id: number): Promise<TClaimBonusResult>;
     /**
      * Returns the extra counters for the current user level.
-     * These are counters that are configured for each Smartico client separatly by request.
+     * These are counters that are configured for each Smartico client separately by request.
      * For example 1st counter could be total wagering amount, 2nd counter could be total deposit amount, etc.
      *
      * **Example**:
@@ -142,7 +142,7 @@ export declare class WSAPI {
     getUserLevelExtraCounters(): Promise<UserLevelExtraCountersT>;
     /**
      *
-     * Returns all the store items available the current user
+     * Returns all the store items available to the current user
      * The returned store items are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
      * Note that each time you call getStoreItems with a new onUpdate callback, the old one will be overwritten by the new one.
      * The onUpdate callback will be called on purchase of the store item.
@@ -259,7 +259,7 @@ export declare class WSAPI {
     /**
      * Returns the list of mini-games configured for the current user (not filtered by spin availability or Widget visibility).
      * 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, also if the spins were issued to the user manually in the BO. 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 won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
      *
      * **Example**:
      * ```
@@ -302,7 +302,7 @@ export declare class WSAPI {
     /**
      * Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
      * After playMiniGame is called, you can call getMiniGames to get the list of mini-games.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 playMiniGame 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, also if the spins were issued to the user manually in the BO. 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 won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
      *
      * **Example**:
      * ```
@@ -329,7 +329,7 @@ export declare class WSAPI {
     /**
      * Plays the specified by template_id mini-game on behalf of user spin_count times and returns array of the prizes
      * After playMiniGameBatch is called, you can call getMiniGames to get the list of mini-games. 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 playMiniGameBatch 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, also if the spins were issued to the user manually in the BO. 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 won prize is spin/jackpot and if max count of the available user spins equals one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback.
      *
      * **Example**:
      * ```
@@ -340,7 +340,7 @@ export declare class WSAPI {
      * **Visitor mode: not supported**
      */
     playMiniGameBatch(template_id: number, spin_count: number, { onUpdate }?: {
-        onUpdate?: (data: TMissionOrBadge[]) => void;
+        onUpdate?: (data: TMiniGameTemplate[]) => void;
     }): Promise<TMiniGamePlayBatchResult[]>;
     /**
      * Requests an opt-in for the specified mission_id. Returns the err_code.
@@ -376,7 +376,7 @@ export declare class WSAPI {
         onUpdate?: (data: TTournament[]) => void;
     }): Promise<TTournament[]>;
     /**
-     * Returns details information of specific tournament instance, the response will include tournament info and the leaderboard of players
+     * Returns detailed information for a specific tournament instance; the response includes tournament info and the leaderboard of players
      *
      * **Example**:
      * ```
@@ -431,7 +431,7 @@ export declare class WSAPI {
      * An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
      * An indicator "read_status" can be passed to get only messages marked as read or unread.
      * You can leave this params empty and by default it will return list of messages ranging from 0 to 20.
-     * This functions return list of messages without the body of the message.
+     * This function returns a list of messages without the body of each message.
      * To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
      * All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
      * The "onUpdate" callback will be triggered when the user receives a new message. It will provide an updated list of messages, ranging from 0 to 20, to the onUpdate callback function.
@@ -470,7 +470,7 @@ export declare class WSAPI {
      */
     markInboxMessageAsRead(messageGuid: string): Promise<InboxMarkMessageAction>;
     /**
-     * Requests to mark all inbox messages as rea
+     * Requests to mark all inbox messages as read
      *
      * **Visitor mode: not supported**
      */
@@ -529,7 +529,7 @@ export declare class WSAPI {
      * ```
      * _smartico.api.reportClickEvent({
      *      engagement_uid: 'abc123-def456',
-     *      activityType: 31 // Inbox,
+     *      activityType: 31 // Inbox
      *      action: 'dp:gf_missions'
      * });
      * ```
@@ -604,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[]
@@ -616,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.
@@ -626,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) => {
@@ -642,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.
@@ -652,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 => {
@@ -668,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.
@@ -690,7 +690,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickBoard({
+     * _smartico.api.gamePickGetBoard({
      *      saw_template_id: 1083,
      *      round_id: 31652,
      * }).then((result) => {
@@ -701,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.
@@ -710,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>`:
@@ -720,7 +720,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickActiveRound({
+     * _smartico.api.gamePickGetActiveRound({
      *      saw_template_id: 1190,
      *      round_id: 38665,
      * }).then((roundData) => {
@@ -730,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) => {
@@ -741,7 +741,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    submitGamePickSelection(props: GamePickRequestParams & {
+    gamePickSubmitSelection(props: GamePickRequestParams & {
         round: Partial<GamePickRound>;
     }): Promise<GamesApiResponse<GamePickRound>>;
     /**
@@ -752,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>`:
@@ -762,7 +762,7 @@ export declare class WSAPI {
      *
      * **Example**:
      * ```
-     * _smartico.api.getGamePickActiveRound({
+     * _smartico.api.gamePickGetActiveRound({
      *      saw_template_id: 1183,
      *      round_id: 37974,
      * }).then((roundData) => {
@@ -771,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) => {
@@ -782,7 +782,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    submitGamePickSelectionQuiz(props: GamePickRequestParams & {
+    gamePickSubmitSelectionQuiz(props: GamePickRequestParams & {
         round: Partial<GamePickRound>;
     }): Promise<GamesApiResponse<GamePickRound>>;
     /**
@@ -807,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);
@@ -816,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).
@@ -840,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);
@@ -851,11 +851,11 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      */
-    getGamePickGameInfo(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickGameInfo>>;
+    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
@@ -864,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,
@@ -883,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;
@@ -899,7 +899,7 @@ export declare class WSAPI {
     private notifyActivityLogUpdate;
     private updateEntity;
     private jackpotClearCache;
-    /** Returns list of Jackpots that are active in the systen and matching to the filter definition.
+    /** Returns list of Jackpots that are active in the system and matching to the filter definition.
      * If filter is not provided, all active jackpots will be returned.
      * Filter can be used to get jackpots related to specific game or specific jackpot template.
      * You can call this method every second in order to get up to date information about current value of the jackpot(s) and present them to the end-users
@@ -957,7 +957,9 @@ export declare class WSAPI {
         jp_template_id: number;
     }): Promise<JackpotsOptoutResponse>;
     /**
-     * Returns the winners of the jackpot with the specified jp_template_id.
+     * Returns jackpot winners for the given `jp_template_id` (paginated on the server).
+     * Default page size on the wire is 20; use `limit`, `offset`, and repeated calls to load more.
+     * The full protocol response also includes `has_more`; this method returns only the `winners` array.
      *
      * **Example**:
      * ```
@@ -970,6 +972,9 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      *
+     * @param params.jp_template_id - Jackpot template id (required; throws if missing)
+     * @param params.limit - Page size (server default 20 when omitted)
+     * @param params.offset - Offset into the winner list
      */
     getJackpotWinners({ limit, offset, jp_template_id, }: {
         limit?: number;
@@ -1073,7 +1078,7 @@ export declare class WSAPI {
      * **Example**:
      *
      * ```javascript
-     * _smartico.api.getRaffleDrawRunHistory({raffle_id:156, draw_id: 432}).then((result) => {
+     * _smartico.api.getRaffleDrawRunsHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
      *      console.log(result);
      * });
      * ```
@@ -1081,7 +1086,7 @@ export declare class WSAPI {
      * **Example in the Visitor mode**:
      *
      * ```javascript
-     * _smartico.vapi('EN').getRaffleDrawRunHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
+     * _smartico.vapi('EN').getRaffleDrawRunsHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
      *      console.log(result);
      * });
      * ```
@@ -1092,7 +1097,7 @@ export declare class WSAPI {
         draw_id?: number;
     }): Promise<TRaffleDrawRun[]>;
     /**
-     * Returns error code, and error Message after calling the function, error message 0 - means that the request was successful
+     * Returns `err_code` and `err_message` after the call; `err_code` 0 means the request succeeded.
      *
      *
      * **Example**: