@smartico/public-api 0.0.49 → 0.0.51

package/docs/interfaces/TStoreItem.md

@@ -0,0 +1,102 @@
+# Interface: TStoreItem
+
+TStoreItem interface describes the information of the store item defined in the system
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+ID of the store item
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the store item, translated to the user language
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the store item, translated to the user language
+
+___
+
+### image
+
+• **image**: `string`
+
+URL of the image of the store item
+
+___
+
+### type
+
+• **type**: ``"manual"`` \| ``"bonus"``
+
+Type of the store item. Can be 'bonus' or 'manual'. Manual, means it's tangible item, e.g. iPhone
+
+___
+
+### price
+
+• **price**: `number`
+
+The price of the store item in the gamification points
+
+___
+
+### ribbon
+
+• **ribbon**: `string`
+
+The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+
+___
+
+### limit\_message
+
+• **limit\_message**: `string`
+
+The message that should be shown to the user if he is not eligible to buy it. this message can be used to explain the reason why user cannot buy the item, e.g. 'You should be VIP to buy this item' and can be used in case can_buy property is false.
+   The message is translated to the user language.
+   **Note**: when user is trying to buy the item, the response from server can return custom error messages that can be shown to the user as well
+
+___
+
+### priority
+
+• **priority**: `number`
+
+The priority of the store item. Can be used to sort the items in the store
+
+___
+
+### related\_item\_ids
+
+• **related\_item\_ids**: `number`[]
+
+The list of IDs of the related items. Can be used to show the related items in the store
+
+___
+
+### can\_buy
+
+• **can\_buy**: `boolean`
+
+The indicator if the user can buy the item
+ This indicator is taking into account the segment conditions for the store item, the price of item towards users balance,
+
+___
+
+### category\_ids
+
+• **category\_ids**: `number`[]
+
+The list of IDs of the categories where the store item is assigned, information about categories can be retrievend with getStoreCategories method

package/docs/interfaces/TTournament.md

@@ -0,0 +1,234 @@
+# Interface: TTournament
+
+TTournament interface describes the general information of the tournament item
+
+## Hierarchy
+
+- **`TTournament`**
+
+  ↳ [`TTournamentDetailed`](TTournamentDetailed.md)
+
+## Properties
+
+### instance\_id
+
+• **instance\_id**: `number`
+
+ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run
+
+___
+
+### tournament\_id
+
+• **tournament\_id**: `number`
+
+ID of tournament template
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the tournament, translated to the user language
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the tournament, translated to the user language
+
+___
+
+### image1
+
+• **image1**: `string`
+
+___
+
+### image2
+
+• **image2**: `string`
+
+___
+
+### prize\_pool\_short
+
+• **prize\_pool\_short**: `string`
+
+___
+
+### custom\_price\_text
+
+• **custom\_price\_text**: `string`
+
+___
+
+### segment\_dont\_match\_message
+
+• **segment\_dont\_match\_message**: `string`
+
+The message that should be shown to the user when the user cannot register in tournament with error code TOURNAMENT_USER_DONT_MATCH_CONDITIONS
+
+___
+
+### custom\_section\_id
+
+• **custom\_section\_id**: `number`
+
+The ID of the custom section where the tournament is assigned
+The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+
+___
+
+### custom\_data
+
+• **custom\_data**: `any`
+
+The custom data of the tournament defined by operator. Can be a JSON object, string or number
+
+___
+
+### is\_featured
+
+• **is\_featured**: `boolean`
+
+The indicator if the tournament is 'Featured'
+
+___
+
+### ribbon
+
+• **ribbon**: `string`
+
+The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+
+___
+
+### start\_time
+
+• **start\_time**: `number`
+
+The time when tournament is going to start, epoch with milliseconds
+
+___
+
+### end\_time
+
+• **end\_time**: `number`
+
+The time when tournament is going to finish, epoch with milliseconds
+
+___
+
+### registration\_type
+
+• **registration\_type**: [`TournamentRegistrationTypeName`](../README.md#tournamentregistrationtypename)
+
+Type of registration in the tournament
+
+___
+
+### registration\_count
+
+• **registration\_count**: `number`
+
+Number of users registered in the tournament
+
+___
+
+### is\_user\_registered
+
+• **is\_user\_registered**: `boolean`
+
+flag indicating if current user is registered in the tournament
+
+___
+
+### players\_min\_count
+
+• **players\_min\_count**: `number`
+
+Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start
+
+___
+
+### players\_max\_count
+
+• **players\_max\_count**: `number`
+
+Maximum number of participant for this tournament. When reached, new users won't be able to register
+
+___
+
+### registration\_status
+
+• **registration\_status**: `TournamentRegistrationStatusName`
+
+Status of registration in the tournament for current user
+
+___
+
+### duration\_ms
+
+• **duration\_ms**: `number`
+
+Tournament duration in millisecnnds
+
+___
+
+### registration\_cost\_points
+
+• **registration\_cost\_points**: `number`
+
+Cost of registration in the tournament in gamification points
+
+___
+
+### is\_active
+
+• **is\_active**: `boolean`
+
+Indicator if tournament instance is active, means in one of the statues -  PUBLISHED, REGISTED, STARTED
+
+___
+
+### is\_can\_register
+
+• **is\_can\_register**: `boolean`
+
+Indicator if user can register in this tournament instance, e.g tournament is active, max users is not reached, user is not registered yet
+
+___
+
+### is\_cancelled
+
+• **is\_cancelled**: `boolean`
+
+Indicator if tournament instance is cancelled (status CANCELLED)
+
+___
+
+### is\_finished
+
+• **is\_finished**: `boolean`
+
+Indicator if tournament instance is finished (status FINISHED, CANCELLED OR FINIALIZING)
+
+___
+
+### is\_in\_progress
+
+• **is\_in\_progress**: `boolean`
+
+Indicator if tournament instance is running (status STARTED)
+
+___
+
+### is\_upcoming
+
+• **is\_upcoming**: `boolean`
+
+Indicator if tournament instance is upcoming (status PUBLISHED or REGISTER)

package/docs/interfaces/TTournamentDetailed.md

@@ -0,0 +1,375 @@
+# Interface: TTournamentDetailed
+
+TTournamentDetailed interface describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
+
+## Hierarchy
+
+- [`TTournament`](TTournament.md)
+
+  ↳ **`TTournamentDetailed`**
+
+## Properties
+
+### instance\_id
+
+• **instance\_id**: `number`
+
+ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run
+
+#### Inherited from
+
+[TTournament](TTournament.md).[instance_id](TTournament.md#instance_id)
+
+___
+
+### tournament\_id
+
+• **tournament\_id**: `number`
+
+ID of tournament template
+
+#### Inherited from
+
+[TTournament](TTournament.md).[tournament_id](TTournament.md#tournament_id)
+
+___
+
+### name
+
+• **name**: `string`
+
+Name of the tournament, translated to the user language
+
+#### Inherited from
+
+[TTournament](TTournament.md).[name](TTournament.md#name)
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the tournament, translated to the user language
+
+#### Inherited from
+
+[TTournament](TTournament.md).[description](TTournament.md#description)
+
+___
+
+### image1
+
+• **image1**: `string`
+
+#### Inherited from
+
+[TTournament](TTournament.md).[image1](TTournament.md#image1)
+
+___
+
+### image2
+
+• **image2**: `string`
+
+#### Inherited from
+
+[TTournament](TTournament.md).[image2](TTournament.md#image2)
+
+___
+
+### prize\_pool\_short
+
+• **prize\_pool\_short**: `string`
+
+#### Inherited from
+
+[TTournament](TTournament.md).[prize_pool_short](TTournament.md#prize_pool_short)
+
+___
+
+### custom\_price\_text
+
+• **custom\_price\_text**: `string`
+
+#### Inherited from
+
+[TTournament](TTournament.md).[custom_price_text](TTournament.md#custom_price_text)
+
+___
+
+### segment\_dont\_match\_message
+
+• **segment\_dont\_match\_message**: `string`
+
+The message that should be shown to the user when the user cannot register in tournament with error code TOURNAMENT_USER_DONT_MATCH_CONDITIONS
+
+#### Inherited from
+
+[TTournament](TTournament.md).[segment_dont_match_message](TTournament.md#segment_dont_match_message)
+
+___
+
+### custom\_section\_id
+
+• **custom\_section\_id**: `number`
+
+The ID of the custom section where the tournament is assigned
+The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+
+#### Inherited from
+
+[TTournament](TTournament.md).[custom_section_id](TTournament.md#custom_section_id)
+
+___
+
+### custom\_data
+
+• **custom\_data**: `any`
+
+The custom data of the tournament defined by operator. Can be a JSON object, string or number
+
+#### Inherited from
+
+[TTournament](TTournament.md).[custom_data](TTournament.md#custom_data)
+
+___
+
+### is\_featured
+
+• **is\_featured**: `boolean`
+
+The indicator if the tournament is 'Featured'
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_featured](TTournament.md#is_featured)
+
+___
+
+### ribbon
+
+• **ribbon**: `string`
+
+The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon
+
+#### Inherited from
+
+[TTournament](TTournament.md).[ribbon](TTournament.md#ribbon)
+
+___
+
+### start\_time
+
+• **start\_time**: `number`
+
+The time when tournament is going to start, epoch with milliseconds
+
+#### Inherited from
+
+[TTournament](TTournament.md).[start_time](TTournament.md#start_time)
+
+___
+
+### end\_time
+
+• **end\_time**: `number`
+
+The time when tournament is going to finish, epoch with milliseconds
+
+#### Inherited from
+
+[TTournament](TTournament.md).[end_time](TTournament.md#end_time)
+
+___
+
+### registration\_type
+
+• **registration\_type**: [`TournamentRegistrationTypeName`](../README.md#tournamentregistrationtypename)
+
+Type of registration in the tournament
+
+#### Inherited from
+
+[TTournament](TTournament.md).[registration_type](TTournament.md#registration_type)
+
+___
+
+### registration\_count
+
+• **registration\_count**: `number`
+
+Number of users registered in the tournament
+
+#### Inherited from
+
+[TTournament](TTournament.md).[registration_count](TTournament.md#registration_count)
+
+___
+
+### is\_user\_registered
+
+• **is\_user\_registered**: `boolean`
+
+flag indicating if current user is registered in the tournament
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_user_registered](TTournament.md#is_user_registered)
+
+___
+
+### players\_min\_count
+
+• **players\_min\_count**: `number`
+
+Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start
+
+#### Inherited from
+
+[TTournament](TTournament.md).[players_min_count](TTournament.md#players_min_count)
+
+___
+
+### players\_max\_count
+
+• **players\_max\_count**: `number`
+
+Maximum number of participant for this tournament. When reached, new users won't be able to register
+
+#### Inherited from
+
+[TTournament](TTournament.md).[players_max_count](TTournament.md#players_max_count)
+
+___
+
+### registration\_status
+
+• **registration\_status**: `TournamentRegistrationStatusName`
+
+Status of registration in the tournament for current user
+
+#### Inherited from
+
+[TTournament](TTournament.md).[registration_status](TTournament.md#registration_status)
+
+___
+
+### duration\_ms
+
+• **duration\_ms**: `number`
+
+Tournament duration in millisecnnds
+
+#### Inherited from
+
+[TTournament](TTournament.md).[duration_ms](TTournament.md#duration_ms)
+
+___
+
+### registration\_cost\_points
+
+• **registration\_cost\_points**: `number`
+
+Cost of registration in the tournament in gamification points
+
+#### Inherited from
+
+[TTournament](TTournament.md).[registration_cost_points](TTournament.md#registration_cost_points)
+
+___
+
+### is\_active
+
+• **is\_active**: `boolean`
+
+Indicator if tournament instance is active, means in one of the statues -  PUBLISHED, REGISTED, STARTED
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_active](TTournament.md#is_active)
+
+___
+
+### is\_can\_register
+
+• **is\_can\_register**: `boolean`
+
+Indicator if user can register in this tournament instance, e.g tournament is active, max users is not reached, user is not registered yet
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_can_register](TTournament.md#is_can_register)
+
+___
+
+### is\_cancelled
+
+• **is\_cancelled**: `boolean`
+
+Indicator if tournament instance is cancelled (status CANCELLED)
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_cancelled](TTournament.md#is_cancelled)
+
+___
+
+### is\_finished
+
+• **is\_finished**: `boolean`
+
+Indicator if tournament instance is finished (status FINISHED, CANCELLED OR FINIALIZING)
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_finished](TTournament.md#is_finished)
+
+___
+
+### is\_in\_progress
+
+• **is\_in\_progress**: `boolean`
+
+Indicator if tournament instance is running (status STARTED)
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_in_progress](TTournament.md#is_in_progress)
+
+___
+
+### is\_upcoming
+
+• **is\_upcoming**: `boolean`
+
+Indicator if tournament instance is upcoming (status PUBLISHED or REGISTER)
+
+#### Inherited from
+
+[TTournament](TTournament.md).[is_upcoming](TTournament.md#is_upcoming)
+
+___
+
+### players
+
+• `Optional` **players**: { `public_username`: `string` ; `avatar_url`: `string` ; `position`: `number` ; `scores`: `number` ; `is_me`: `boolean`  }[]
+
+The list of the tournament participants
+
+___
+
+### me
+
+• `Optional` **me**: `Object`
+
+The information about current user in the tournament if he is registered in the tournamnet
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `public_username` | `string` | The username of the current user |
+| `avatar_url` | `string` | The URL to the avatar of the current user |
+| `position` | `number` | The position of the current user in the tournament |
+| `scores` | `number` | The scores of the current user in the tournament |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartico/public-api",
-  "version": "0.0.49",
+  "version": "0.0.51",
   "description": "Smartico public API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/MiniGames/SAWTemplateUI.ts

@@ -25,6 +25,8 @@ export interface SAWTemplateUI {
     promo_image?: string;
     promo_text?: string;
     matchx_banner?: string;
+    matchx_seasonal_ranking?: boolean;
+    matchx_general_board_users_count: number;
     ask_for_username?: SAWAskForUsername;
     show_prize_board?: boolean;