@smartico/public-api 0.0.399 → 0.0.401

package/docs/api/interfaces/GamePickEventMeta.md

@@ -0,0 +1,201 @@
+# Interface: GamePickEventMeta
+
+GamePickEventMeta describes metadata for a MatchX or Quiz event, including team info and sport context
+
+## Extends
+
+- [`QuizEventMeta`](QuizEventMeta.md)
+
+## Properties
+
+### answers?
+
+> `optional` **answers?**: `object`[]
+
+List of possible answer options for the quiz question
+
+#### value
+
+> **value**: `string`
+
+Answer identifier value sent on submission
+
+#### text
+
+> **text**: `string`
+
+Localized display text of the answer
+
+#### \_translations
+
+> **\_translations**: `object`
+
+Per-language overrides for the answer text
+
+##### Index Signature
+
+\[`key`: `string`\]: `object`
+
+#### 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`](../enumerations/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`\]: `object`

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,39 @@
+# Interface: GamePickRequestParams
+
+GamePickRequestParams describes the base parameters required for GamePick API calls
+
+## Extended by
+
+- [`GamePickRoundRequestParams`](GamePickRoundRequestParams.md)
+
+## Properties
+
+### saw\_template\_id
+
+> **saw\_template\_id**: `number`
+
+ID of the MatchX or Quiz game template. The only field the consumer supplies.
+
+***
+
+### ext\_user\_id?
+
+> `optional` **ext\_user\_id?**: `string`
+
+External user ID. Injected by the SDK from the active session; consumers omit it.
+
+***
+
+### 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.
+
+***
+
+### lang?
+
+> `optional` **lang?**: `string`
+
+Language code for translations (e.g. 'EN', 'DE'). Defaults to the session language.

package/docs/api/interfaces/GamePickRound.md

@@ -0,0 +1,383 @@
+# Interface: GamePickRound
+
+GamePickRound describes a round with its events and the current user's prediction data
+
+## 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)
+
+***
+
+### 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