@smartico/public-api 0.0.355 → 0.0.356

package/docs/api/interfaces/GamePickEventMeta.md

@@ -0,0 +1,181 @@
+# Interface: GamePickEventMeta
+
+GamePickEventMeta describes metadata for a MatchX or Quiz event, including team info and sport context
+
+## Hierarchy
+
+- [`QuizEventMeta`](QuizEventMeta.md)
+
+  ↳ **`GamePickEventMeta`**
+
+## Properties
+
+### answers
+
+• `Optional` **answers**: \{ `value`: `string` ; `text`: `string` ; `_translations`: \{ `[key: string]`: \{ `text`: `string`  };  }  }[]
+
+List of possible answer options for the quiz question
+
+#### Inherited from
+
+[QuizEventMeta](QuizEventMeta.md).[answers](QuizEventMeta.md#answers)
+
+___
+
+### question\_image
+
+• `Optional` **question\_image**: `string`
+
+URL of an image associated with the question
+
+#### Inherited from
+
+[QuizEventMeta](QuizEventMeta.md).[question_image](QuizEventMeta.md#question_image)
+
+___
+
+### result
+
+• `Optional` **result**: [`QuizAnswersValueType`](../enums/QuizAnswersValueType.md)
+
+Correct answer value after resolution
+
+#### Inherited from
+
+[QuizEventMeta](QuizEventMeta.md).[result](QuizEventMeta.md#result)
+
+___
+
+### custom\_question
+
+• **custom\_question**: `string`
+
+Custom question text displayed to the user
+
+#### Inherited from
+
+[QuizEventMeta](QuizEventMeta.md).[custom_question](QuizEventMeta.md#custom_question)
+
+___
+
+### event\_name
+
+• `Optional` **event\_name**: `string`
+
+Display name of the event/match
+
+___
+
+### team1\_name
+
+• **team1\_name**: `string`
+
+Name of the first team (home)
+
+___
+
+### team1\_image
+
+• **team1\_image**: `string`
+
+URL of the first team's logo image
+
+___
+
+### team2\_name
+
+• **team2\_name**: `string`
+
+Name of the second team (away)
+
+___
+
+### team2\_image
+
+• **team2\_image**: `string`
+
+URL of the second team's logo image
+
+___
+
+### team1\_result
+
+• `Optional` **team1\_result**: `number`
+
+Actual result score for team 1 after resolution
+
+___
+
+### team2\_result
+
+• `Optional` **team2\_result**: `number`
+
+Actual result score for team 2 after resolution
+
+___
+
+### sport\_type\_id
+
+• `Optional` **sport\_type\_id**: `number`
+
+Betradar sport type ID for the event
+
+___
+
+### is\_canceled
+
+• `Optional` **is\_canceled**: `boolean`
+
+Whether the event has been canceled
+
+___
+
+### auto\_resolve\_enabled
+
+• `Optional` **auto\_resolve\_enabled**: `boolean`
+
+Whether auto-resolution from live data feed is enabled
+
+___
+
+### auto\_resolve\_date
+
+• `Optional` **auto\_resolve\_date**: `string`
+
+ISO date string for when auto-resolution is expected
+
+___
+
+### team1\_auto\_result
+
+• `Optional` **team1\_auto\_result**: `number`
+
+Auto-resolved score for team 1 from live data feed
+
+___
+
+### team2\_auto\_result
+
+• `Optional` **team2\_auto\_result**: `number`
+
+Auto-resolved score for team 2 from live data feed
+
+___
+
+### auto\_result
+
+• `Optional` **auto\_result**: `string`
+
+Auto-resolved answer value from live data feed (for quiz events)
+
+___
+
+### \_translations
+
+• **\_translations**: `Object`
+
+Per-language overrides for team names, event name, and custom question
+
+#### Index signature
+
+▪ [key: `string`]: \{ `team1_name`: `string` ; `team2_name`: `string` ; `event_name`: `string` ; `custom_question`: `string`  }

package/docs/api/interfaces/GamePickGameInfo.md

@@ -0,0 +1,27 @@
+# Interface: GamePickGameInfo
+
+GamePickGameInfo describes the game configuration including SAW template, rounds list, and label settings
+
+## Properties
+
+### sawTemplate
+
+• **sawTemplate**: [`SAWTemplate`](SAWTemplate.md)
+
+Game template configuration (SAW template) with UI settings, buy-in type, cost, and spin count
+
+___
+
+### allRounds
+
+• **allRounds**: [`GamePickRoundBase`](GamePickRoundBase.md)[]
+
+List of all rounds (metadata only, no events)
+
+___
+
+### labelInfo
+
+• **labelInfo**: `any`
+
+Label/brand configuration and settings

package/docs/api/interfaces/GamePickRequestParams.md

@@ -0,0 +1,41 @@
+# Interface: GamePickRequestParams
+
+GamePickRequestParams describes the base parameters required for GamePick API calls
+
+## Hierarchy
+
+- **`GamePickRequestParams`**
+
+  ↳ [`GamePickRoundRequestParams`](GamePickRoundRequestParams.md)
+
+## Properties
+
+### saw\_template\_id
+
+• **saw\_template\_id**: `number`
+
+ID of the MatchX or Quiz game template
+
+___
+
+### ext\_user\_id
+
+• **ext\_user\_id**: `string`
+
+External user ID
+
+___
+
+### smartico\_ext\_user\_id
+
+• **smartico\_ext\_user\_id**: `string`
+
+Smartico external user ID used for platform API calls
+
+___
+
+### lang
+
+• `Optional` **lang**: `string`
+
+Language code for translations (e.g. 'EN', 'DE')

package/docs/api/interfaces/GamePickRound.md

@@ -0,0 +1,385 @@
+# Interface: GamePickRound
+
+GamePickRound describes a round with its events and the current user's prediction data
+
+## Hierarchy
+
+- [`GamePickRoundBase`](GamePickRoundBase.md)
+
+  ↳ **`GamePickRound`**
+
+## 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`](../enums/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`](../enums/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`](../enums/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)
+
+___
+
+### events
+
+• **events**: [`GamePickEvent`](GamePickEvent.md)[]
+
+List of events (matches/questions) in this round
+
+___
+
+### user\_score
+
+• **user\_score**: `number`
+
+Current user's total score in this round
+
+___
+
+### user\_placed\_bet
+
+• **user\_placed\_bet**: `boolean`
+
+Whether the current user has submitted any predictions in this round
+
+___
+
+### has\_open\_for\_bet\_events
+
+• `Optional` **has\_open\_for\_bet\_events**: `boolean`
+
+Whether there are events still open for betting
+
+___
+
+### has\_not\_submitted\_changes
+
+• `Optional` **has\_not\_submitted\_changes**: `boolean`
+
+Whether the user has unsaved changes to their predictions