@smartico/public-api 0.0.212 → 0.0.214

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.
@@ -1,5 +1,7 @@
1
1
  interface AchRelatedGame {
2
+ /** ID of the game on Smartico side */
2
3
  ach_game_id: number;
4
+ /** ID of the game on operator side */
3
5
  ext_game_id: string;
4
6
  game_public_meta: {
5
7
  name: string;
@@ -29,4 +29,5 @@ export interface SAWTemplate {
29
29
  expose_game_stat_on_api?: boolean;
30
30
  requires_prize_claim?: boolean;
31
31
  relative_period_timezone?: number;
32
+ show_prize_history?: boolean;
32
33
  }
@@ -3,6 +3,7 @@ import { TSawHistory } from "../WSAPI/WSAPITypes";
3
3
  import { SAWTemplate } from "./SAWTemplate";
4
4
  export interface SAWWinningHistoryResponse extends ProtocolResponse {
5
5
  prizes: SAWPrizesHistory[];
6
+ hasMore: boolean;
6
7
  }
7
8
  export interface SAWPrizesHistory {
8
9
  template: SAWTemplate;
@@ -55,7 +55,9 @@ export interface Tournament {
55
55
  tournamentPlayer?: TournamentPlayer;
56
56
  /** List of casino games (or other types of entities) related to the tournament */
57
57
  related_games?: AchRelatedGame[];
58
+ /** The minimum amount of score points that the user should get in order to be qualified for the prize */
58
59
  minScoreToWin?: number;
60
+ /** When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard. */
59
61
  hideLeaderboardsMinScores?: boolean;
60
62
  }
61
63
  export declare const TournamentItemsTransform: (items: Tournament[]) => TTournament[];
@@ -25,22 +25,41 @@ export interface TMiniGamePrize {
25
25
  font_size_mobile?: number;
26
26
  /** The URL of the icon of the prize */
27
27
  icon?: string;
28
+ /** for scratch card defines position of prize in the list */
28
29
  position: number;
30
+ /** List of sectors for the prize */
31
+ sectors: number[];
32
+ /** Type of acknowledge message for users */
29
33
  acknowledge_type: SAWAcknowledgeTypeName;
34
+ /** Message that will be shown to user in modal pop-up */
30
35
  aknowledge_message: string;
36
+ /** Deep link that will trigger some action in modal pop-up */
31
37
  acknowledge_dp: string;
38
+ /** The name of the action button in modal pop-up */
32
39
  acknowledge_action_title: string;
40
+ /** Deep link that will trigger some action in modal pop-up (additional) */
33
41
  acknowledge_dp_additional?: string;
42
+ /** The name of the action button in modal pop-up (additional) */
34
43
  acknowledge_action_title_additional?: string;
44
+ /** Message when the prize pool is empty for that specific prize */
35
45
  out_of_stock_message?: string;
46
+ /** Number of items in stock */
36
47
  pool?: number;
48
+ /** Initial number of items in stock */
37
49
  pool_initial?: number;
50
+ /** Number of wins in game */
38
51
  wins_count?: number;
52
+ /** Number of days of week, when the prize can be available */
39
53
  weekdays?: number[];
54
+ /** Holds time from which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp) */
40
55
  active_from_ts?: number;
56
+ /** Holds time till which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp) */
41
57
  active_till_ts?: number;
58
+ /** Time zone to ensure each day aligns with your local midnight. */
42
59
  relative_period_timezone?: number;
60
+ /** Flag indicating that the prize is surcharged (available all the time, despite pool numbers) */
43
61
  is_surcharge?: boolean;
62
+ /** Flag indicating the state of the prize */
44
63
  is_deleted?: boolean;
45
64
  /** The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number */
46
65
  custom_data?: any;
@@ -118,14 +137,21 @@ export interface TMiniGameTemplate {
118
137
  custom_data: any;
119
138
  /** List of prizes for mini-games */
120
139
  prizes: TMiniGamePrize[];
140
+ /** When enabled, the number of items in the pool and number of won items will be exposed in the Retention API and in the UI Widgets */
121
141
  expose_game_stat_on_api?: boolean;
142
+ /** Time zone to ensure each day aligns with your local midnight. */
122
143
  relative_period_timezone?: number;
144
+ /** Holds time from which template will become available, for the template that are targeted to be available from specific time (UNIX timestamp) */
123
145
  activeFromDate?: number;
146
+ /** Holds time till which template will become available, for the templates that are targeted to be available from specific time (UNIX timestamp) */
124
147
  activeTillDate?: number;
148
+ /** The amount of steps to complete the game and gather the prize */
125
149
  steps_to_finish_game?: number;
150
+ /** Hold the id of the custom section */
126
151
  custom_section_id?: number;
127
152
  /** The UI definition of the mini-game */
128
153
  saw_template_ui_definition: SAWTemplateUI;
154
+ show_prize_history?: boolean;
129
155
  }
130
156
  /**
131
157
  * TUser describes the information of the user
@@ -206,10 +232,15 @@ export interface TTournament {
206
232
  name: string;
207
233
  /** Description of the tournament, translated to the user language */
208
234
  description: string;
235
+ /** 1st image URL representing the tournament */
209
236
  image1: string;
237
+ /** 2nd image URL representing the tournament */
210
238
  image2: string;
239
+ /** 2nd image URL representing the tournament for mobile */
211
240
  image2_mobile: string;
241
+ /** The message indicating the prize pool of the tournament */
212
242
  prize_pool_short: string;
243
+ /** The message indicating the price to register in the tournament */
213
244
  custom_price_text: string;
214
245
  /** The message that should be shown to the user when the user cannot register in tournament with error code TOURNAMENT_USER_DONT_MATCH_CONDITIONS */
215
246
  segment_dont_match_message: string;
@@ -285,7 +316,9 @@ export interface TTournament {
285
316
  is_in_progress: boolean;
286
317
  /** Indicator if tournament instance is upcoming (status PUBLISHED or REGISTER) */
287
318
  is_upcoming: boolean;
319
+ /** The minimum amount of score points that the user should get in order to be qualified for the prize */
288
320
  min_scores_win?: number;
321
+ /** When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard */
289
322
  hide_leaderboard_min_scores?: boolean;
290
323
  }
291
324
  /**
@@ -598,7 +631,8 @@ export interface TInboxMessageBody {
598
631
  /** The action that should be performed when user clicks on the message.
599
632
  * Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
600
633
  * The 'dp' function will handle the CTA and will execute it in the most safe way.
601
- * If the message has a rich html body - the action will always be 'dp:inbox' which will open the inbox widget when triggered. */
634
+ * If the message has a rich html body - the action will always be 'dp:inbox' which will open the inbox widget when triggered.
635
+ */
602
636
  action: string;
603
637
  /** Rich HTML body of the message. */
604
638
  html_body?: string;
package/dist/index.js CHANGED
@@ -411,6 +411,7 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
411
411
  steps_to_finish_game: r.saw_template_ui_definition.steps_to_finish_game,
412
412
  custom_section_id: r.saw_template_ui_definition.custom_section_id,
413
413
  saw_template_ui_definition: r.saw_template_ui_definition,
414
+ show_prize_history: r.show_prize_history,
414
415
  prizes: r.prizes.map(function (p) {
415
416
  var y = {
416
417
  id: p.saw_prize_id,
@@ -421,6 +422,7 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
421
422
  font_size_mobile: p.saw_prize_ui_definition.font_size_mobile,
422
423
  icon: p.saw_prize_ui_definition.icon,
423
424
  position: p.saw_prize_ui_definition.position,
425
+ sectors: p.saw_prize_ui_definition.sectors,
424
426
  acknowledge_type: SAWAcknowledgeTypeNamed(p.saw_prize_ui_definition.acknowledge_type),
425
427
  aknowledge_message: p.saw_prize_ui_definition.aknowledge_message,
426
428
  acknowledge_dp: p.saw_prize_ui_definition.acknowledge_dp,