@smartico/public-api 0.0.439 → 0.0.440
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/GamePick/GamePickTypes.d.ts +2 -2
- package/dist/MiniGames/SAWGameType.d.ts +3 -1
- package/dist/MiniGames/SAWPrize.d.ts +3 -3
- package/dist/MiniGames/SAWTemplate.d.ts +1 -1
- package/dist/MiniGames/SAWTemplateUI.d.ts +2 -2
- package/dist/WSAPI/WSAPIGamePick.d.ts +12 -12
- package/dist/WSAPI/WSAPIMiniGames.d.ts +4 -4
- package/dist/WSAPI/WSAPITypes.d.ts +1 -1
- package/dist/index.js +19 -17
- package/dist/index.js.map +1 -1
- package/dist/index.modern.mjs +20 -17
- package/dist/index.modern.mjs.map +1 -1
- package/package.json +1 -1
- package/src/GamePick/GamePickTypes.ts +2 -2
- package/src/MiniGames/SAWGameType.ts +3 -0
- package/src/MiniGames/SAWPrize.ts +3 -3
- package/src/MiniGames/SAWTemplate.ts +1 -1
- package/src/MiniGames/SAWTemplateUI.ts +2 -2
- package/src/WSAPI/WSAPIGamePick.ts +12 -12
- package/src/WSAPI/WSAPIMiniGames.ts +4 -4
- package/src/WSAPI/WSAPITypes.ts +1 -1
|
@@ -154,7 +154,7 @@ export interface QuizEventMeta {
|
|
|
154
154
|
custom_question: string;
|
|
155
155
|
}
|
|
156
156
|
/**
|
|
157
|
-
* GamePickEventMeta describes metadata for a MatchX or
|
|
157
|
+
* GamePickEventMeta describes metadata for a MatchX, Quiz or Bingo event, including team info and sport context
|
|
158
158
|
*/
|
|
159
159
|
export interface GamePickEventMeta extends QuizEventMeta {
|
|
160
160
|
/** Display name of the event/match */
|
|
@@ -448,7 +448,7 @@ export interface GamesApiResponse<T> {
|
|
|
448
448
|
* GamePickRequestParams describes the base parameters required for GamePick API calls
|
|
449
449
|
*/
|
|
450
450
|
export interface GamePickRequestParams {
|
|
451
|
-
/** ID of the MatchX or
|
|
451
|
+
/** ID of the MatchX, Quiz or Bingo game template. The only field the consumer supplies. */
|
|
452
452
|
saw_template_id: number;
|
|
453
453
|
/** External user ID. Injected by the SDK from the active session; consumers omit it. */
|
|
454
454
|
ext_user_id?: string;
|
|
@@ -11,7 +11,8 @@ export declare enum SAWGameType {
|
|
|
11
11
|
Voyager = 10,
|
|
12
12
|
Plinko = 11,
|
|
13
13
|
CoinFlip = 12,
|
|
14
|
-
CustomMinigame = 13
|
|
14
|
+
CustomMinigame = 13,
|
|
15
|
+
Bingo = 14
|
|
15
16
|
}
|
|
16
17
|
export declare enum SAWGameTypeName {
|
|
17
18
|
SpinAWheel = "wheel",
|
|
@@ -27,6 +28,7 @@ export declare enum SAWGameTypeName {
|
|
|
27
28
|
Plinko = "plinko",
|
|
28
29
|
CoinFlip = "coin_flip",
|
|
29
30
|
CustomMinigame = "custom_minigame",
|
|
31
|
+
Bingo = "bingo",
|
|
30
32
|
Unknown = "unknown"
|
|
31
33
|
}
|
|
32
34
|
/** @hidden */
|
|
@@ -10,13 +10,13 @@ export interface SAWPrize {
|
|
|
10
10
|
prize_value?: number;
|
|
11
11
|
/** The type of the prize — see {@link SAWPrizeType} */
|
|
12
12
|
prize_type_id: SAWPrizeType;
|
|
13
|
-
/** Competition games (MatchX / Quiz): first finishing place this prize applies to */
|
|
13
|
+
/** Competition games (MatchX / Quiz / Bingo): first finishing place this prize applies to */
|
|
14
14
|
place_from?: number;
|
|
15
|
-
/** Competition games (MatchX / Quiz): last finishing place this prize applies to; equals `place_from` for a single-place prize */
|
|
15
|
+
/** Competition games (MatchX / Quiz / Bingo): last finishing place this prize applies to; equals `place_from` for a single-place prize */
|
|
16
16
|
place_to?: number;
|
|
17
17
|
/** Client-side only — unique id of a win instance generated by the default Smartico UI to dedupe render effects; never sent by the server */
|
|
18
18
|
sawUniqueWinId?: string;
|
|
19
|
-
/** Remaining stock. Present only when the template's `expose_game_stat_on_api` is enabled; always present for MatchX / Quiz games */
|
|
19
|
+
/** Remaining stock. Present only when the template's `expose_game_stat_on_api` is enabled; always present for MatchX / Quiz / Bingo games */
|
|
20
20
|
pool?: number;
|
|
21
21
|
/** Initial (configured) stock. Present regardless of `expose_game_stat_on_api` */
|
|
22
22
|
pool_initial?: number;
|
|
@@ -52,7 +52,7 @@ export interface SAWTemplate {
|
|
|
52
52
|
use_new_popups?: boolean;
|
|
53
53
|
lottie_animation_speed?: number;
|
|
54
54
|
};
|
|
55
|
-
/** Operator template setting. When enabled, the per-prize stock statistics (`pool`, `wins_count`, `weekdays`, `active_from_ts` / `active_till_ts`) are populated on `prizes`; when disabled (default) the server strips them from the response (`pool` is kept for MatchX / Quiz games). */
|
|
55
|
+
/** Operator template setting. When enabled, the per-prize stock statistics (`pool`, `wins_count`, `weekdays`, `active_from_ts` / `active_till_ts`) are populated on `prizes`; when disabled (default) the server strips them from the response (`pool` is kept for MatchX / Quiz / Bingo games). */
|
|
56
56
|
expose_game_stat_on_api?: boolean;
|
|
57
57
|
/** Prize Drop only: when true, the pushed prize requires an explicit claim by the user before it is credited */
|
|
58
58
|
requires_prize_claim?: boolean;
|
|
@@ -383,8 +383,8 @@ export interface SAWTemplateUI {
|
|
|
383
383
|
* widget loads `custom_game_url` in an iframe instead of rendering the
|
|
384
384
|
* built-in game. `saw_game_type_id` still reports the original type, so
|
|
385
385
|
* treat this flag — not the type — as the answer to "is this played as a
|
|
386
|
-
* custom game", together with `SAWGameType.CustomMinigame
|
|
387
|
-
* played that way.
|
|
386
|
+
* custom game", together with `SAWGameType.CustomMinigame` and
|
|
387
|
+
* `SAWGameType.Bingo`, which are always played that way.
|
|
388
388
|
*
|
|
389
389
|
* When `false` or omitted, the template is played as its own game type.
|
|
390
390
|
* Back-Office label: _"Use Custom Game"_.
|
|
@@ -3,7 +3,7 @@ import { WSAPIAvatars } from './WSAPIAvatars';
|
|
|
3
3
|
/** @group GamePick */
|
|
4
4
|
export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
5
5
|
/**
|
|
6
|
-
* Returns every open round for a MatchX or
|
|
6
|
+
* Returns every open round for a MatchX, Quiz or Bingo game template, with the full
|
|
7
7
|
* event list (matches / questions) and the current user's selections per event.
|
|
8
8
|
*
|
|
9
9
|
* Use to power the rounds-lobby screen — typically a list of round cards a user
|
|
@@ -13,7 +13,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
13
13
|
* @remarks
|
|
14
14
|
* **Preconditions**
|
|
15
15
|
* - User must be authenticated.
|
|
16
|
-
* - `saw_template_id` must reference a MatchX or
|
|
16
|
+
* - `saw_template_id` must reference a MatchX, Quiz or Bingo game template. The SDK
|
|
17
17
|
* throws synchronously if it's missing.
|
|
18
18
|
*
|
|
19
19
|
* **Transport**
|
|
@@ -46,7 +46,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
46
46
|
*
|
|
47
47
|
* **UI guidance**: see [UI Guide — `gamePickGetActiveRounds`](../../docs/ui/gamepick/UIGuide_gamePickGetActiveRounds.md).
|
|
48
48
|
*
|
|
49
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
49
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
50
50
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickRound} array.
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
@@ -66,7 +66,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
66
66
|
gamePickGetActiveRounds(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickRound[]>>;
|
|
67
67
|
/**
|
|
68
68
|
* Returns a single round (events, user selections, scoring rules) for a
|
|
69
|
-
* MatchX or
|
|
69
|
+
* MatchX, Quiz or Bingo game. Use to power the round-detail / prediction-input
|
|
70
70
|
* screen the user lands on after picking a round from the lobby.
|
|
71
71
|
*
|
|
72
72
|
* Same shape as one entry of {@link gamePickGetActiveRounds}; cheaper when the
|
|
@@ -98,7 +98,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
98
98
|
*
|
|
99
99
|
* **UI guidance**: see [UI Guide — `gamePickGetActiveRound`](../../docs/ui/gamepick/UIGuide_gamePickGetActiveRound.md).
|
|
100
100
|
*
|
|
101
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
101
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
102
102
|
* @param props.round_id ID of the round to fetch.
|
|
103
103
|
* @returns Wrapped {@link GamesApiResponse} of a single {@link GamePickRound}.
|
|
104
104
|
*
|
|
@@ -118,7 +118,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
118
118
|
*/
|
|
119
119
|
gamePickGetActiveRound(props: GamePickRoundRequestParams): Promise<GamesApiResponse<GamePickRound>>;
|
|
120
120
|
/**
|
|
121
|
-
* Returns the full round history (active + resolved) for a MatchX or
|
|
121
|
+
* Returns the full round history (active + resolved) for a MatchX, Quiz or Bingo game
|
|
122
122
|
* template, newest-first. Each round carries the user's predictions plus the
|
|
123
123
|
* server-resolved outcome on each event.
|
|
124
124
|
*
|
|
@@ -152,7 +152,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
152
152
|
*
|
|
153
153
|
* **UI guidance**: see [UI Guide — `gamePickGetHistory`](../../docs/ui/gamepick/UIGuide_gamePickGetHistory.md).
|
|
154
154
|
*
|
|
155
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
155
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
156
156
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickRound} array,
|
|
157
157
|
* newest-first.
|
|
158
158
|
*
|
|
@@ -167,7 +167,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
167
167
|
*/
|
|
168
168
|
gamePickGetHistory(props: GamePickRequestParams): Promise<GamesApiResponse<GamePickRound[]>>;
|
|
169
169
|
/**
|
|
170
|
-
* Returns the leaderboard for a MatchX or
|
|
170
|
+
* Returns the leaderboard for a MatchX, Quiz or Bingo game round — ranked list of
|
|
171
171
|
* players plus the current user's entry (`my_user`). Pass `round_id: -1` for
|
|
172
172
|
* the season / overall leaderboard across every round in the template.
|
|
173
173
|
*
|
|
@@ -207,7 +207,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
207
207
|
*
|
|
208
208
|
* **UI guidance**: see [UI Guide — `gamePickGetBoard`](../../docs/ui/gamepick/UIGuide_gamePickGetBoard.md).
|
|
209
209
|
*
|
|
210
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
210
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
211
211
|
* @param props.round_id Round ID, or `-1` for the season leaderboard.
|
|
212
212
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickRoundBoard}.
|
|
213
213
|
*
|
|
@@ -452,7 +452,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
452
452
|
*
|
|
453
453
|
* **UI guidance**: see [UI Guide — `gamePickGetUserInfo`](../../docs/ui/gamepick/UIGuide_gamePickGetUserInfo.md).
|
|
454
454
|
*
|
|
455
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
455
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
456
456
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickUserInfo}.
|
|
457
457
|
*
|
|
458
458
|
* @example
|
|
@@ -504,7 +504,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
504
504
|
*
|
|
505
505
|
* **UI guidance**: see [UI Guide — `gamePickGetGameInfo`](../../docs/ui/gamepick/UIGuide_gamePickGetGameInfo.md).
|
|
506
506
|
*
|
|
507
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
507
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
508
508
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickGameInfo}.
|
|
509
509
|
*
|
|
510
510
|
* @example
|
|
@@ -559,7 +559,7 @@ export declare class WSAPIGamePick extends WSAPIAvatars {
|
|
|
559
559
|
*
|
|
560
560
|
* **UI guidance**: see [UI Guide — `gamePickGetRoundInfoForUser`](../../docs/ui/gamepick/UIGuide_gamePickGetRoundInfoForUser.md).
|
|
561
561
|
*
|
|
562
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
562
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
563
563
|
* @param props.round_id ID of the round to inspect.
|
|
564
564
|
* @param props.int_user_id Internal user ID from
|
|
565
565
|
* `gamePickGetBoard.users[].int_user_id`.
|
|
@@ -42,14 +42,14 @@ export declare class WSAPIMiniGames extends WSAPIRaffles {
|
|
|
42
42
|
* substitution at fetch time.
|
|
43
43
|
*
|
|
44
44
|
* **Game-type variants**
|
|
45
|
-
* All
|
|
45
|
+
* All `SAWGameType` values (`SpinAWheel`, `ScratchCard`,
|
|
46
46
|
* `MatchX`, `GiftBox`, `PrizeDrop`, `Quiz`, `LootboxWeekdays`,
|
|
47
47
|
* `LootboxCalendarDays`, `TreasureHunt`, `Voyager`, `Plinko`,
|
|
48
|
-
* `CoinFlip`) surface through the same template shape. Most are
|
|
48
|
+
* `CoinFlip`, `CustomMinigame`, `Bingo`) surface through the same template shape. Most are
|
|
49
49
|
* played via {@link playMiniGame}; the exceptions are:
|
|
50
50
|
* - `PrizeDrop` — server-push only; the consumer does NOT call
|
|
51
51
|
* `playMiniGame`. Prizes arrive via the prize-drop push channel.
|
|
52
|
-
* - `MatchX` / `Quiz` — predictions are submitted via a separate
|
|
52
|
+
* - `MatchX` / `Quiz` / `Bingo` — predictions are submitted via a separate
|
|
53
53
|
* games server (not this SDK); the SAW spin is fired
|
|
54
54
|
* server-internally to deduct the buy-in.
|
|
55
55
|
*
|
|
@@ -208,7 +208,7 @@ export declare class WSAPIMiniGames extends WSAPIRaffles {
|
|
|
208
208
|
* Works for all `SAWGameType` values EXCEPT:
|
|
209
209
|
* - `PrizeDrop` — prizes arrive server-pushed; do NOT call
|
|
210
210
|
* `playMiniGame` for this type.
|
|
211
|
-
* - `MatchX` / `Quiz` — prediction submission goes through a
|
|
211
|
+
* - `MatchX` / `Quiz` / `Bingo` — prediction submission goes through a
|
|
212
212
|
* separate games server; `playMiniGame` is not the entry point.
|
|
213
213
|
*
|
|
214
214
|
* @remarks
|
|
@@ -62,7 +62,7 @@ export interface TMiniGamePrize {
|
|
|
62
62
|
second_btn_action_title?: string;
|
|
63
63
|
/** Message when the prize pool is empty for that specific prize */
|
|
64
64
|
out_of_stock_message?: string;
|
|
65
|
-
/** Remaining stock of the prize — decrements on each win, refunded if the spin is finalised as lost. Populated only when the template's `expose_game_stat_on_api` is enabled; always populated for MatchX / Quiz games */
|
|
65
|
+
/** Remaining stock of the prize — decrements on each win, refunded if the spin is finalised as lost. Populated only when the template's `expose_game_stat_on_api` is enabled; always populated for MatchX / Quiz / Bingo games */
|
|
66
66
|
pool?: number;
|
|
67
67
|
/** Initial (configured) stock of the prize. Populated regardless of `expose_game_stat_on_api` */
|
|
68
68
|
pool_initial?: number;
|
package/dist/index.js
CHANGED
|
@@ -394,6 +394,7 @@ exports.SAWGameType = void 0;
|
|
|
394
394
|
SAWGameType[SAWGameType["Plinko"] = 11] = "Plinko";
|
|
395
395
|
SAWGameType[SAWGameType["CoinFlip"] = 12] = "CoinFlip";
|
|
396
396
|
SAWGameType[SAWGameType["CustomMinigame"] = 13] = "CustomMinigame";
|
|
397
|
+
SAWGameType[SAWGameType["Bingo"] = 14] = "Bingo";
|
|
397
398
|
})(exports.SAWGameType || (exports.SAWGameType = {}));
|
|
398
399
|
exports.SAWGameTypeName = void 0;
|
|
399
400
|
(function (SAWGameTypeName) {
|
|
@@ -410,12 +411,13 @@ exports.SAWGameTypeName = void 0;
|
|
|
410
411
|
SAWGameTypeName["Plinko"] = "plinko";
|
|
411
412
|
SAWGameTypeName["CoinFlip"] = "coin_flip";
|
|
412
413
|
SAWGameTypeName["CustomMinigame"] = "custom_minigame";
|
|
414
|
+
SAWGameTypeName["Bingo"] = "bingo";
|
|
413
415
|
SAWGameTypeName["Unknown"] = "unknown";
|
|
414
416
|
})(exports.SAWGameTypeName || (exports.SAWGameTypeName = {}));
|
|
415
417
|
/** @hidden */
|
|
416
418
|
var SAWGameTypeNamed = function SAWGameTypeNamed(type) {
|
|
417
419
|
var _SAWGameType$SpinAWhe;
|
|
418
|
-
return (_SAWGameType$SpinAWhe = {}, _SAWGameType$SpinAWhe[exports.SAWGameType.SpinAWheel] = exports.SAWGameTypeName.SpinAWheel, _SAWGameType$SpinAWhe[exports.SAWGameType.ScratchCard] = exports.SAWGameTypeName.ScratchCard, _SAWGameType$SpinAWhe[exports.SAWGameType.MatchX] = exports.SAWGameTypeName.MatchX, _SAWGameType$SpinAWhe[exports.SAWGameType.GiftBox] = exports.SAWGameTypeName.GiftBox, _SAWGameType$SpinAWhe[exports.SAWGameType.PrizeDrop] = exports.SAWGameTypeName.PrizeDrop, _SAWGameType$SpinAWhe[exports.SAWGameType.Quiz] = exports.SAWGameTypeName.Quiz, _SAWGameType$SpinAWhe[exports.SAWGameType.LootboxWeekdays] = exports.SAWGameTypeName.LootboxWeekdays, _SAWGameType$SpinAWhe[exports.SAWGameType.LootboxCalendarDays] = exports.SAWGameTypeName.LootboxCalendarDays, _SAWGameType$SpinAWhe[exports.SAWGameType.TreasureHunt] = exports.SAWGameTypeName.TreasureHunt, _SAWGameType$SpinAWhe[exports.SAWGameType.Voyager] = exports.SAWGameTypeName.Voyager, _SAWGameType$SpinAWhe[exports.SAWGameType.Plinko] = exports.SAWGameTypeName.Plinko, _SAWGameType$SpinAWhe[exports.SAWGameType.CoinFlip] = exports.SAWGameTypeName.CoinFlip, _SAWGameType$SpinAWhe[exports.SAWGameType.CustomMinigame] = exports.SAWGameTypeName.CustomMinigame, _SAWGameType$SpinAWhe)[type] || exports.SAWGameTypeName.Unknown;
|
|
420
|
+
return (_SAWGameType$SpinAWhe = {}, _SAWGameType$SpinAWhe[exports.SAWGameType.SpinAWheel] = exports.SAWGameTypeName.SpinAWheel, _SAWGameType$SpinAWhe[exports.SAWGameType.ScratchCard] = exports.SAWGameTypeName.ScratchCard, _SAWGameType$SpinAWhe[exports.SAWGameType.MatchX] = exports.SAWGameTypeName.MatchX, _SAWGameType$SpinAWhe[exports.SAWGameType.GiftBox] = exports.SAWGameTypeName.GiftBox, _SAWGameType$SpinAWhe[exports.SAWGameType.PrizeDrop] = exports.SAWGameTypeName.PrizeDrop, _SAWGameType$SpinAWhe[exports.SAWGameType.Quiz] = exports.SAWGameTypeName.Quiz, _SAWGameType$SpinAWhe[exports.SAWGameType.LootboxWeekdays] = exports.SAWGameTypeName.LootboxWeekdays, _SAWGameType$SpinAWhe[exports.SAWGameType.LootboxCalendarDays] = exports.SAWGameTypeName.LootboxCalendarDays, _SAWGameType$SpinAWhe[exports.SAWGameType.TreasureHunt] = exports.SAWGameTypeName.TreasureHunt, _SAWGameType$SpinAWhe[exports.SAWGameType.Voyager] = exports.SAWGameTypeName.Voyager, _SAWGameType$SpinAWhe[exports.SAWGameType.Plinko] = exports.SAWGameTypeName.Plinko, _SAWGameType$SpinAWhe[exports.SAWGameType.CoinFlip] = exports.SAWGameTypeName.CoinFlip, _SAWGameType$SpinAWhe[exports.SAWGameType.CustomMinigame] = exports.SAWGameTypeName.CustomMinigame, _SAWGameType$SpinAWhe[exports.SAWGameType.Bingo] = exports.SAWGameTypeName.Bingo, _SAWGameType$SpinAWhe)[type] || exports.SAWGameTypeName.Unknown;
|
|
419
421
|
};
|
|
420
422
|
|
|
421
423
|
exports.SAWExposeUserSpinId = void 0;
|
|
@@ -7409,14 +7411,14 @@ var WSAPIMiniGames = /*#__PURE__*/function (_WSAPIRaffles) {
|
|
|
7409
7411
|
* substitution at fetch time.
|
|
7410
7412
|
*
|
|
7411
7413
|
* **Game-type variants**
|
|
7412
|
-
* All
|
|
7414
|
+
* All `SAWGameType` values (`SpinAWheel`, `ScratchCard`,
|
|
7413
7415
|
* `MatchX`, `GiftBox`, `PrizeDrop`, `Quiz`, `LootboxWeekdays`,
|
|
7414
7416
|
* `LootboxCalendarDays`, `TreasureHunt`, `Voyager`, `Plinko`,
|
|
7415
|
-
* `CoinFlip`) surface through the same template shape. Most are
|
|
7417
|
+
* `CoinFlip`, `CustomMinigame`, `Bingo`) surface through the same template shape. Most are
|
|
7416
7418
|
* played via {@link playMiniGame}; the exceptions are:
|
|
7417
7419
|
* - `PrizeDrop` — server-push only; the consumer does NOT call
|
|
7418
7420
|
* `playMiniGame`. Prizes arrive via the prize-drop push channel.
|
|
7419
|
-
* - `MatchX` / `Quiz` — predictions are submitted via a separate
|
|
7421
|
+
* - `MatchX` / `Quiz` / `Bingo` — predictions are submitted via a separate
|
|
7420
7422
|
* games server (not this SDK); the SAW spin is fired
|
|
7421
7423
|
* server-internally to deduct the buy-in.
|
|
7422
7424
|
*
|
|
@@ -7596,7 +7598,7 @@ var WSAPIMiniGames = /*#__PURE__*/function (_WSAPIRaffles) {
|
|
|
7596
7598
|
* Works for all `SAWGameType` values EXCEPT:
|
|
7597
7599
|
* - `PrizeDrop` — prizes arrive server-pushed; do NOT call
|
|
7598
7600
|
* `playMiniGame` for this type.
|
|
7599
|
-
* - `MatchX` / `Quiz` — prediction submission goes through a
|
|
7601
|
+
* - `MatchX` / `Quiz` / `Bingo` — prediction submission goes through a
|
|
7600
7602
|
* separate games server; `playMiniGame` is not the entry point.
|
|
7601
7603
|
*
|
|
7602
7604
|
* @remarks
|
|
@@ -8587,7 +8589,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8587
8589
|
_inheritsLoose(WSAPIGamePick, _WSAPIAvatars);
|
|
8588
8590
|
var _proto = WSAPIGamePick.prototype;
|
|
8589
8591
|
/**
|
|
8590
|
-
* Returns every open round for a MatchX or
|
|
8592
|
+
* Returns every open round for a MatchX, Quiz or Bingo game template, with the full
|
|
8591
8593
|
* event list (matches / questions) and the current user's selections per event.
|
|
8592
8594
|
*
|
|
8593
8595
|
* Use to power the rounds-lobby screen — typically a list of round cards a user
|
|
@@ -8597,7 +8599,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8597
8599
|
* @remarks
|
|
8598
8600
|
* **Preconditions**
|
|
8599
8601
|
* - User must be authenticated.
|
|
8600
|
-
* - `saw_template_id` must reference a MatchX or
|
|
8602
|
+
* - `saw_template_id` must reference a MatchX, Quiz or Bingo game template. The SDK
|
|
8601
8603
|
* throws synchronously if it's missing.
|
|
8602
8604
|
*
|
|
8603
8605
|
* **Transport**
|
|
@@ -8630,7 +8632,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8630
8632
|
*
|
|
8631
8633
|
* **UI guidance**: see [UI Guide — `gamePickGetActiveRounds`](../../docs/ui/gamepick/UIGuide_gamePickGetActiveRounds.md).
|
|
8632
8634
|
*
|
|
8633
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
8635
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
8634
8636
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickRound} array.
|
|
8635
8637
|
*
|
|
8636
8638
|
* @example
|
|
@@ -8660,7 +8662,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8660
8662
|
}
|
|
8661
8663
|
/**
|
|
8662
8664
|
* Returns a single round (events, user selections, scoring rules) for a
|
|
8663
|
-
* MatchX or
|
|
8665
|
+
* MatchX, Quiz or Bingo game. Use to power the round-detail / prediction-input
|
|
8664
8666
|
* screen the user lands on after picking a round from the lobby.
|
|
8665
8667
|
*
|
|
8666
8668
|
* Same shape as one entry of {@link gamePickGetActiveRounds}; cheaper when the
|
|
@@ -8692,7 +8694,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8692
8694
|
*
|
|
8693
8695
|
* **UI guidance**: see [UI Guide — `gamePickGetActiveRound`](../../docs/ui/gamepick/UIGuide_gamePickGetActiveRound.md).
|
|
8694
8696
|
*
|
|
8695
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
8697
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
8696
8698
|
* @param props.round_id ID of the round to fetch.
|
|
8697
8699
|
* @returns Wrapped {@link GamesApiResponse} of a single {@link GamePickRound}.
|
|
8698
8700
|
*
|
|
@@ -8726,7 +8728,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8726
8728
|
}
|
|
8727
8729
|
}
|
|
8728
8730
|
/**
|
|
8729
|
-
* Returns the full round history (active + resolved) for a MatchX or
|
|
8731
|
+
* Returns the full round history (active + resolved) for a MatchX, Quiz or Bingo game
|
|
8730
8732
|
* template, newest-first. Each round carries the user's predictions plus the
|
|
8731
8733
|
* server-resolved outcome on each event.
|
|
8732
8734
|
*
|
|
@@ -8760,7 +8762,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8760
8762
|
*
|
|
8761
8763
|
* **UI guidance**: see [UI Guide — `gamePickGetHistory`](../../docs/ui/gamepick/UIGuide_gamePickGetHistory.md).
|
|
8762
8764
|
*
|
|
8763
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
8765
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
8764
8766
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickRound} array,
|
|
8765
8767
|
* newest-first.
|
|
8766
8768
|
*
|
|
@@ -8786,7 +8788,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8786
8788
|
}
|
|
8787
8789
|
}
|
|
8788
8790
|
/**
|
|
8789
|
-
* Returns the leaderboard for a MatchX or
|
|
8791
|
+
* Returns the leaderboard for a MatchX, Quiz or Bingo game round — ranked list of
|
|
8790
8792
|
* players plus the current user's entry (`my_user`). Pass `round_id: -1` for
|
|
8791
8793
|
* the season / overall leaderboard across every round in the template.
|
|
8792
8794
|
*
|
|
@@ -8826,7 +8828,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
8826
8828
|
*
|
|
8827
8829
|
* **UI guidance**: see [UI Guide — `gamePickGetBoard`](../../docs/ui/gamepick/UIGuide_gamePickGetBoard.md).
|
|
8828
8830
|
*
|
|
8829
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
8831
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
8830
8832
|
* @param props.round_id Round ID, or `-1` for the season leaderboard.
|
|
8831
8833
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickRoundBoard}.
|
|
8832
8834
|
*
|
|
@@ -9111,7 +9113,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
9111
9113
|
*
|
|
9112
9114
|
* **UI guidance**: see [UI Guide — `gamePickGetUserInfo`](../../docs/ui/gamepick/UIGuide_gamePickGetUserInfo.md).
|
|
9113
9115
|
*
|
|
9114
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
9116
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
9115
9117
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickUserInfo}.
|
|
9116
9118
|
*
|
|
9117
9119
|
* @example
|
|
@@ -9174,7 +9176,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
9174
9176
|
*
|
|
9175
9177
|
* **UI guidance**: see [UI Guide — `gamePickGetGameInfo`](../../docs/ui/gamepick/UIGuide_gamePickGetGameInfo.md).
|
|
9176
9178
|
*
|
|
9177
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
9179
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
9178
9180
|
* @returns Wrapped {@link GamesApiResponse} of {@link GamePickGameInfo}.
|
|
9179
9181
|
*
|
|
9180
9182
|
* @example
|
|
@@ -9240,7 +9242,7 @@ var WSAPIGamePick = /*#__PURE__*/function (_WSAPIAvatars) {
|
|
|
9240
9242
|
*
|
|
9241
9243
|
* **UI guidance**: see [UI Guide — `gamePickGetRoundInfoForUser`](../../docs/ui/gamepick/UIGuide_gamePickGetRoundInfoForUser.md).
|
|
9242
9244
|
*
|
|
9243
|
-
* @param props.saw_template_id ID of the MatchX or
|
|
9245
|
+
* @param props.saw_template_id ID of the MatchX, Quiz or Bingo game template.
|
|
9244
9246
|
* @param props.round_id ID of the round to inspect.
|
|
9245
9247
|
* @param props.int_user_id Internal user ID from
|
|
9246
9248
|
* `gamePickGetBoard.users[].int_user_id`.
|