@smartico/public-api 0.0.400 → 0.0.402

package/docs/api/interfaces/GamePickRoundBoard.md

@@ -0,0 +1,359 @@
+# Interface: GamePickRoundBoard
+
+GamePickRoundBoard describes a round's leaderboard with ranked users
+
+## Extends
+
+- [`GamePickRoundBase`](GamePickRoundBase.md)
+
+## Properties
+
+### round\_id
+
+> **round\_id**: `number`
+
+Unique round identifier
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`round_id`](GamePickRoundBase.md#round_id)
+
+***
+
+### round\_row\_id
+
+> **round\_row\_id**: `number`
+
+Sequential row ID used for ordering rounds
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`round_row_id`](GamePickRoundBase.md#round_row_id)
+
+***
+
+### round\_name
+
+> **round\_name**: `string`
+
+Localized display name of the round
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`round_name`](GamePickRoundBase.md#round_name)
+
+***
+
+### round\_description
+
+> **round\_description**: `string`
+
+Localized description of the round
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`round_description`](GamePickRoundBase.md#round_description)
+
+***
+
+### final\_screen\_cta\_button\_title
+
+> **final\_screen\_cta\_button\_title**: `string`
+
+Label for the CTA button on the final/results screen
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_cta_button_title`](GamePickRoundBase.md#final_screen_cta_button_title)
+
+***
+
+### final\_screen\_message
+
+> **final\_screen\_message**: `string`
+
+Message displayed on the final/results screen
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_message`](GamePickRoundBase.md#final_screen_message)
+
+***
+
+### final\_screen\_image\_desktop
+
+> **final\_screen\_image\_desktop**: `string`
+
+URL of the final screen image (desktop)
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_image_desktop`](GamePickRoundBase.md#final_screen_image_desktop)
+
+***
+
+### final\_screen\_image\_mobile
+
+> **final\_screen\_image\_mobile**: `string`
+
+URL of the final screen image (mobile)
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_image_mobile`](GamePickRoundBase.md#final_screen_image_mobile)
+
+***
+
+### promo\_image
+
+> **promo\_image**: `string`
+
+URL of the promotional image for the round
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`promo_image`](GamePickRoundBase.md#promo_image)
+
+***
+
+### promo\_text
+
+> **promo\_text**: `string`
+
+Promotional text displayed with the round
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`promo_text`](GamePickRoundBase.md#promo_text)
+
+***
+
+### open\_date
+
+> **open\_date**: `number`
+
+Timestamp (ms) when the round opens for participation
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`open_date`](GamePickRoundBase.md#open_date)
+
+***
+
+### last\_bet\_date
+
+> **last\_bet\_date**: `number`
+
+Timestamp (ms) of the last moment bets are accepted
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`last_bet_date`](GamePickRoundBase.md#last_bet_date)
+
+***
+
+### resolution\_date
+
+> **resolution\_date**: `number`
+
+Timestamp (ms) when the round is expected to be resolved
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`resolution_date`](GamePickRoundBase.md#resolution_date)
+
+***
+
+### score\_full\_win
+
+> **score\_full\_win**: `number`
+
+Points awarded for a fully correct prediction
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`score_full_win`](GamePickRoundBase.md#score_full_win)
+
+***
+
+### score\_part\_win
+
+> **score\_part\_win**: `number`
+
+Points awarded for a partially correct prediction
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`score_part_win`](GamePickRoundBase.md#score_part_win)
+
+***
+
+### score\_lost
+
+> **score\_lost**: `number`
+
+Points awarded (or deducted) for an incorrect prediction
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`score_lost`](GamePickRoundBase.md#score_lost)
+
+***
+
+### is\_active\_now
+
+> **is\_active\_now**: `boolean`
+
+Whether the round is currently active for participation
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`is_active_now`](GamePickRoundBase.md#is_active_now)
+
+***
+
+### is\_resolved
+
+> **is\_resolved**: `boolean`
+
+Whether the round has been fully resolved and scored
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`is_resolved`](GamePickRoundBase.md#is_resolved)
+
+***
+
+### round\_status\_id
+
+> **round\_status\_id**: [`GPRoundStatus`](../enumerations/GPRoundStatus.md)
+
+Current lifecycle status of the round
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`round_status_id`](GamePickRoundBase.md#round_status_id)
+
+***
+
+### events\_total
+
+> **events\_total**: `number`
+
+Total number of events in the round
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`events_total`](GamePickRoundBase.md#events_total)
+
+***
+
+### events\_resolved
+
+> **events\_resolved**: `number`
+
+Number of events that have been resolved
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`events_resolved`](GamePickRoundBase.md#events_resolved)
+
+***
+
+### score\_type\_id
+
+> **score\_type\_id**: [`GamePickScoreType`](../enumerations/GamePickScoreType.md)
+
+Scoring method used for this round
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`score_type_id`](GamePickRoundBase.md#score_type_id)
+
+***
+
+### order\_events
+
+> **order\_events**: [`GameRoundOrderType`](../enumerations/GameRoundOrderType.md)
+
+How events are ordered for display
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`order_events`](GamePickRoundBase.md#order_events)
+
+***
+
+### board\_users\_count
+
+> **board\_users\_count**: `number`
+
+Maximum number of users shown on the leaderboard
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`board_users_count`](GamePickRoundBase.md#board_users_count)
+
+***
+
+### hide\_users\_predictions
+
+> **hide\_users\_predictions**: `boolean`
+
+Whether other users' predictions are hidden until resolution
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`hide_users_predictions`](GamePickRoundBase.md#hide_users_predictions)
+
+***
+
+### public\_meta
+
+> **public\_meta**: [`GamePickRoundPublicMeta`](GamePickRoundPublicMeta.md)
+
+Public metadata including translations and display settings from the BackOffice
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`public_meta`](GamePickRoundBase.md#public_meta)
+
+***
+
+### next\_round\_open\_date
+
+> **next\_round\_open\_date**: `number`
+
+Timestamp (ms) when the next round opens, if available
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`next_round_open_date`](GamePickRoundBase.md#next_round_open_date)
+
+***
+
+### show\_users\_preference
+
+> **show\_users\_preference**: `boolean`
+
+Whether to show aggregated user preference percentages for each outcome
+
+#### Inherited from
+
+[`GamePickRoundBase`](GamePickRoundBase.md).[`show_users_preference`](GamePickRoundBase.md#show_users_preference)
+
+***
+
+### my\_user
+
+> **my\_user**: [`GamePickBoardUser`](GamePickBoardUser.md)
+
+Current user's leaderboard entry, or null if user hasn't participated
+
+***
+
+### users
+
+> **users**: [`GamePickBoardUser`](GamePickBoardUser.md)[]
+
+Ranked list of users on the leaderboard

package/docs/api/interfaces/GamePickRoundPublicMeta.md

@@ -0,0 +1,103 @@
+# Interface: GamePickRoundPublicMeta
+
+GamePickRoundPublicMeta describes the public-facing metadata and translations for a round, configured in the BackOffice
+
+## Properties
+
+### round\_name
+
+> **round\_name**: `string`
+
+Localized round name
+
+***
+
+### round\_description
+
+> **round\_description**: `string`
+
+Localized round description
+
+***
+
+### promo\_image
+
+> **promo\_image**: `string`
+
+URL of the promotional image for the round
+
+***
+
+### promo\_text
+
+> **promo\_text**: `string`
+
+Promotional text displayed with the round
+
+***
+
+### hide\_resolved\_round
+
+> **hide\_resolved\_round**: `boolean`
+
+Whether to hide the round from the UI after it has been resolved
+
+***
+
+### final\_screen\_image\_desktop
+
+> **final\_screen\_image\_desktop**: `string`
+
+URL of the final screen image for desktop
+
+***
+
+### final\_screen\_image\_mobile
+
+> **final\_screen\_image\_mobile**: `string`
+
+URL of the final screen image for mobile
+
+***
+
+### final\_screen\_message
+
+> **final\_screen\_message**: `string`
+
+Message displayed on the final/results screen
+
+***
+
+### final\_screen\_cta\_button\_title
+
+> **final\_screen\_cta\_button\_title**: `string`
+
+Label for the CTA button on the final screen
+
+***
+
+### final\_screen\_cta\_dp
+
+> **final\_screen\_cta\_dp**: `string`
+
+Deep link triggered by the CTA button on the final screen
+
+***
+
+### allow\_edit\_answers?
+
+> `optional` **allow\_edit\_answers?**: `boolean`
+
+Whether users can edit their answers after initial submission (within betting window)
+
+***
+
+### \_translations
+
+> **\_translations**: `object`
+
+Per-language overrides for round display content
+
+#### Index Signature
+
+\[`key`: `string`\]: `object`

package/docs/api/interfaces/GamePickRoundRequestParams.md

@@ -0,0 +1,63 @@
+# Interface: GamePickRoundRequestParams
+
+GamePickRoundRequestParams extends base params with a specific round ID
+
+## Extends
+
+- [`GamePickRequestParams`](GamePickRequestParams.md)
+
+## Properties
+
+### saw\_template\_id
+
+> **saw\_template\_id**: `number`
+
+ID of the MatchX or Quiz game template. The only field the consumer supplies.
+
+#### Inherited from
+
+[`GamePickRequestParams`](GamePickRequestParams.md).[`saw_template_id`](GamePickRequestParams.md#saw_template_id)
+
+***
+
+### ext\_user\_id?
+
+> `optional` **ext\_user\_id?**: `string`
+
+External user ID. Injected by the SDK from the active session; consumers omit it.
+
+#### Inherited from
+
+[`GamePickRequestParams`](GamePickRequestParams.md).[`ext_user_id`](GamePickRequestParams.md#ext_user_id)
+
+***
+
+### smartico\_ext\_user\_id?
+
+> `optional` **smartico\_ext\_user\_id?**: `string`
+
+Platform external user ID. Injected by the SDK from the active session; consumers omit it.
+
+#### Inherited from
+
+[`GamePickRequestParams`](GamePickRequestParams.md).[`smartico_ext_user_id`](GamePickRequestParams.md#smartico_ext_user_id)
+
+***
+
+### lang?
+
+> `optional` **lang?**: `string`
+
+Language code for translations (e.g. 'EN', 'DE'). Defaults to the session language.
+
+#### Inherited from
+
+[`GamePickRequestParams`](GamePickRequestParams.md).[`lang`](GamePickRequestParams.md#lang)
+
+***
+
+### round\_id
+
+> **round\_id**: `number`
+
+ID of the specific round

package/docs/api/interfaces/GamePickUserInfo.md

@@ -0,0 +1,107 @@
+# Interface: GamePickUserInfo
+
+GamePickUserInfo describes the current user's profile in the games system
+
+## Properties
+
+### ext\_user\_id
+
+> **ext\_user\_id**: `string`
+
+External user ID (Smartico numeric user ID)
+
+***
+
+### int\_user\_id
+
+> **int\_user\_id**: `number`
+
+Internal user ID within the games system
+
+***
+
+### public\_username
+
+> **public\_username**: `string`
+
+Display name
+
+***
+
+### avatar\_url
+
+> **avatar\_url**: `string`
+
+URL of the user's avatar image
+
+***
+
+### gp\_position?
+
+> `optional` **gp\_position?**: `number`
+
+User's leaderboard rank position
+
+***
+
+### full\_wins\_count?
+
+> `optional` **full\_wins\_count?**: `number`
+
+Number of fully correct predictions
+
+***
+
+### part\_wins\_count?
+
+> `optional` **part\_wins\_count?**: `number`
+
+Number of partially correct predictions
+
+***
+
+### resolution\_score?
+
+> `optional` **resolution\_score?**: `number`
+
+User's total score
+
+***
+
+### last\_wallet\_sync\_time?
+
+> `optional` **last\_wallet\_sync\_time?**: `string`
+
+ISO 8601 date-time string of the last time the user's balance was synced from the Smartico platform.
+
+***
+
+### ach\_points\_balance?
+
+> `optional` **ach\_points\_balance?**: `number`
+
+User's current points balance
+
+***
+
+### ach\_gems\_balance?
+
+> `optional` **ach\_gems\_balance?**: `number`
+
+User's current gems balance
+
+***
+
+### ach\_diamonds\_balance?
+
+> `optional` **ach\_diamonds\_balance?**: `number`
+
+User's current diamonds balance
+
+***
+
+### pubic\_username\_set?
+
+> `optional` **pubic\_username\_set?**: `boolean`
+
+Whether the user has set a custom public username

package/docs/api/interfaces/GamesApiResponse.md

@@ -0,0 +1,33 @@
+# Interface: GamesApiResponse\<T\>
+
+GamesApiResponse is the standard response wrapper for all GamePick/Quiz API calls
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### errCode
+
+> **errCode**: `number`
+
+Error code; `0` = success. Per-method code tables live in each `gamePick*` method's TSDoc.
+
+***
+
+### errMessage?
+
+> `optional` **errMessage?**: `string`
+
+Human-readable error message; populated when `errCode` is non-zero.
+
+***
+
+### data?
+
+> `optional` **data?**: `T`
+
+Response payload, present on success

package/docs/api/interfaces/GemsDiamondsLog.md

@@ -6,6 +6,8 @@
 
 > **create\_date**: `number`
 
+Epoch timestamp in SECONDS (not ms — unlike most SDK timestamps).
+
 ***
 
 ### user\_ext\_id

package/docs/api/interfaces/Level.md

@@ -49,3 +49,11 @@ Internal status of level. Not in use right now on the front-end
 ### general\_level\_progress
 
 > **general\_level\_progress**: `number`
+
+***
+
+### ordinal\_position?
+
+> `optional` **ordinal\_position?**: `number`
+
+1-based position of this level within the level ladder.

package/docs/api/interfaces/PointsLog.md

@@ -6,6 +6,8 @@
 
 > **create\_date**: `number`
 
+Epoch timestamp in SECONDS (not ms — unlike most SDK timestamps).
+
 ***
 
 ### user\_ext\_id