@smartico/public-api 0.0.341 → 0.0.343

package/docs/api/interfaces/UserAchievementTask.md

@@ -0,0 +1,83 @@
+# Interface: UserAchievementTask
+
+## Properties
+
+### task\_id
+
+• `Optional` **task\_id**: `number`
+
+___
+
+### task\_public\_meta
+
+• `Optional` **task\_public\_meta**: `AchievementTaskPublicMeta`
+
+___
+
+### points\_reward
+
+• `Optional` **points\_reward**: `number`
+
+___
+
+### task\_type\_id
+
+• **task\_type\_id**: `AchievementTaskType`
+
+___
+
+### isCompleted
+
+• `Optional` **isCompleted**: `boolean`
+
+___
+
+### userExecutedCount
+
+• `Optional` **userExecutedCount**: `number`
+
+___
+
+### executionCount
+
+• `Optional` **executionCount**: `number`
+
+___
+
+### userProgress
+
+• `Optional` **userProgress**: `number`
+
+___
+
+### lastExecutionDate
+
+• **lastExecutionDate**: `string`
+
+___
+
+### unlocked\_by\_mission\_id
+
+• `Optional` **unlocked\_by\_mission\_id**: `number`
+
+___
+
+### unlocked\_by\_level\_id
+
+• `Optional` **unlocked\_by\_level\_id**: `number`
+
+___
+
+### user\_state\_params
+
+• `Optional` **user\_state\_params**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: `any`
+
+___
+
+### affects\_progress
+
+• `Optional` **affects\_progress**: `AffectsProgress`

package/docs/native/ADDING_METHODS.md

@@ -9,7 +9,7 @@ Context:
 - public-api is our JavaScript SDK that communicates with Java backend via WebSocket
 - PROTOCOL.md (./PROTOCOL.md) documents the low-level WebSocket protocol for native clients (Kotlin, Swift) who can't use our JS SDK
 - Native clients need raw ClassIds and message structures without JS-side transformations
-- ../interfaces/ contains typedoc-style interface documentation files
+- ../api/interfaces/ contains typedoc-style interface documentation files
 
 Task:
 Document method `{method_name}` in ./PROTOCOL.md for native clients (Kotlin, Swift, etc.).
@@ -17,8 +17,8 @@ Document method `{method_name}` in ./PROTOCOL.md for native clients (Kotlin, Swi
 Requirements:
 1. Find request/response ClassId in ../../src/SmarticoAPI.ts and ../../src/Base/ClassId.ts
 2. Document raw message structure (not transformed T-prefixed types)
-3. For complex types — link to ../interfaces/*.md files
-4. If raw interface MD file doesn't exist in ../interfaces/ — create it following typedoc style like existing files there:
+3. For complex types — link to ../api/interfaces/*.md files
+4. If raw interface MD file doesn't exist in ../api/interfaces/ — create it following typedoc style like existing files there:
    - Format: `# Interface: Name`, `## Properties`, `### property_name`, `• **property_name**: \`type\``, `___` separators between properties
 5. Add method to Table of Contents in appropriate category
 6. Follow the same format as other methods in PROTOCOL.md (Request section with ClassId and fields table, Response section with ClassId and fields table, JSON examples where helpful)
@@ -34,5 +34,5 @@ Document method `getUserLevelExtraCounters` in docs/native/PROTOCOL.md for nativ
 or shorter:
 
 ```
-Document method `myNewMethod` in PROTOCOL.md. Raw types, ClassId from code. New interfaces in docs/interfaces/ — follow typedoc style like existing files there.
+Document method `myNewMethod` in PROTOCOL.md. Raw types, ClassId from code. New interfaces in docs/api/interfaces/ — follow typedoc style like existing files there.
 ```

package/docs/native/PROTOCOL.md

@@ -276,8 +276,8 @@ Sent when a jackpot is won (can be the current user or another player).
 | Field | Type | Description |
 |-------|------|-------------|
 | `cid` | `number` | Message type identifier |
-| `jackpot` | [`JackpotDetails`](../interfaces/JackpotDetails.md) | Jackpot information |
-| `winners` | [`JackPotWinner[]`](../interfaces/JackPotWinner.md) | Array of winners |
+| `jackpot` | [`JackpotDetails`](../api/interfaces/JackpotDetails.md) | Jackpot information |
+| `winners` | [`JackPotWinner[]`](../api/interfaces/JackPotWinner.md) | Array of winners |
 
 **Recommended action:** Show jackpot win notification/celebration. Re-fetch jackpot data to update UI.
 
@@ -408,7 +408,7 @@ Check if the current user belongs to a specific segment.
 | `cid` | `number` | Message type identifier |
 | `errCode` | `number` | Error code. `0` = success |
 | `errMsg` | `string` | Error message (if any) |
-| `segments` | [`TSegmentCheckResult[]`](../interfaces/TSegmentCheckResult.md) | Array of segment check results |
+| `segments` | [`TSegmentCheckResult[]`](../api/interfaces/TSegmentCheckResult.md) | Array of segment check results |
 
 ---
 
@@ -468,7 +468,7 @@ Check if the current user belongs to multiple segments.
 | `cid` | `number` | Message type identifier |
 | `errCode` | `number` | Error code. `0` = success |
 | `errMsg` | `string` | Error message (if any) |
-| `segments` | [`TSegmentCheckResult[]`](../interfaces/TSegmentCheckResult.md) | Array of segment check results |
+| `segments` | [`TSegmentCheckResult[]`](../api/interfaces/TSegmentCheckResult.md) | Array of segment check results |
 
 ---
 
@@ -551,7 +551,7 @@ Get list of all levels defined in the system.
 | `cid` | `number` | Message type identifier |
 | `errCode` | `number` | Error code. `0` = success |
 | `errMsg` | `string` | Error message (if any) |
-| `levels` | [`Level[]`](../interfaces/Level.md) | Array of level objects |
+| `levels` | [`Level[]`](../api/interfaces/Level.md) | Array of level objects |
 
 ---
 
@@ -593,7 +593,7 @@ Get all missions and badges for the current user.
 | `uuid` | `string` | Request identifier (matches request) |
 | `errCode` | `number` | Error code (`0` = success) |
 | `errMsg` | `string` | Error message (if any) |
-| `achievements` | [`UserAchievement[]`](../interfaces/UserAchievement.md) | Array of achievements (missions + badges) |
+| `achievements` | [`UserAchievement[]`](../api/interfaces/UserAchievement.md) | Array of achievements (missions + badges) |
 
 **Example:**
 
@@ -715,7 +715,7 @@ Get mission and badge categories.
 | `cid` | `number` | `538` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `categories` | [`AchCategory[]`](../interfaces/AchCategory.md) | Array of categories |
+| `categories` | [`AchCategory[]`](../api/interfaces/AchCategory.md) | Array of categories |
 
 ---
 
@@ -744,7 +744,7 @@ Get custom UI sections.
 | `cid` | `number` | `524` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `customSections` | `object` | Map of section ID to [`UICustomSection`](../interfaces/UICustomSection.md) |
+| `customSections` | `object` | Map of section ID to [`UICustomSection`](../api/interfaces/UICustomSection.md) |
 
 ---
 
@@ -784,7 +784,7 @@ Get all bonuses for the current user.
 | `uuid` | `string` | Request identifier (matches request) |
 | `errCode` | `number` | Error code (`0` = success) |
 | `errMsg` | `string` | Error message (if any) |
-| `bonuses` | [`Bonus[]`](../interfaces/Bonus.md) | Array of bonus objects |
+| `bonuses` | [`Bonus[]`](../api/interfaces/Bonus.md) | Array of bonus objects |
 
 **Example:**
 
@@ -890,7 +890,7 @@ Get all available store items.
 | `cid` | `number` | `510` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `items` | [`StoreItem[]`](../interfaces/StoreItem.md) | Array of store items |
+| `items` | [`StoreItem[]`](../api/interfaces/StoreItem.md) | Array of store items |
 
 ---
 
@@ -945,7 +945,7 @@ Get store categories.
 | `cid` | `number` | `516` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `categories` | [`StoreCategory[]`](../interfaces/StoreCategory.md) | Array of categories |
+| `categories` | [`StoreCategory[]`](../api/interfaces/StoreCategory.md) | Array of categories |
 
 ---
 
@@ -974,7 +974,7 @@ Get user's purchase history.
 | `cid` | `number` | `542` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `items` | [`StoreItem[]`](../interfaces/StoreItem.md) | Array of purchased items |
+| `items` | [`StoreItem[]`](../api/interfaces/StoreItem.md) | Array of purchased items |
 
 ---
 
@@ -1003,7 +1003,7 @@ Get all available mini-games (spin wheels, scratch cards, etc.).
 | `cid` | `number` | `701` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `templates` | [`SAWTemplate[]`](../interfaces/SAWTemplate.md) | Array of mini-game templates |
+| `templates` | [`SAWTemplate[]`](../api/interfaces/SAWTemplate.md) | Array of mini-game templates |
 
 ---
 
@@ -1147,7 +1147,7 @@ Get mini-game play history.
 | `cid` | `number` | `717` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `history` | [`SAWPrizesHistory[]`](../interfaces/SAWPrizesHistory.md) | Array of history items |
+| `history` | [`SAWPrizesHistory[]`](../api/interfaces/SAWPrizesHistory.md) | Array of history items |
 
 ---
 
@@ -1176,7 +1176,7 @@ Get all active tournament instances.
 | `cid` | `number` | `518` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `tournaments` | [`Tournament[]`](../interfaces/Tournament.md) | Array of tournaments |
+| `tournaments` | [`Tournament[]`](../api/interfaces/Tournament.md) | Array of tournaments |
 
 ---
 
@@ -1204,8 +1204,8 @@ Get detailed information about a tournament instance including leaderboard.
 | `cid` | `number` | `520` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `tournamentInfo` | [`GetTournamentInfoResponse.tournamentInfo`](../interfaces/GetTournamentInfoResponse.md) | Tournament info with players |
-| `userPosition` | [`TournamentPlayer`](../interfaces/TournamentPlayer.md) | Current user's position |
+| `tournamentInfo` | [`GetTournamentInfoResponse.tournamentInfo`](../api/interfaces/GetTournamentInfoResponse.md) | Tournament info with players |
+| `userPosition` | [`TournamentPlayer`](../api/interfaces/TournamentPlayer.md) | Current user's position |
 | `prizeStructure` | `object` | Prize structure with `prizes` array |
 
 ---
@@ -1265,7 +1265,7 @@ Get leaderboard for a specific period type.
 | `cid` | `number` | `506` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `leaders` | [`LeaderBoardUserT[]`](../interfaces/LeaderBoardUserT.md) | Array of leaderboard entries |
+| `leaders` | [`LeaderBoardUserT[]`](../api/interfaces/LeaderBoardUserT.md) | Array of leaderboard entries |
 | `user_position` | `number` | Current user's position |
 | `user_points` | `number` | Current user's points |
 
@@ -1301,7 +1301,7 @@ Get user's inbox messages.
 | `cid` | `number` | `514` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `messages` | [`InboxMessage[]`](../interfaces/InboxMessage.md) | Array of messages |
+| `messages` | [`InboxMessage[]`](../api/interfaces/InboxMessage.md) | Array of messages |
 | `unread_count` | `number` | Total unread count |
 
 ---
@@ -1517,7 +1517,7 @@ Get all available jackpots.
 | `cid` | `number` | `801` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `items` | [`JackpotDetails[]`](../interfaces/JackpotDetails.md) | Array of jackpots |
+| `items` | [`JackpotDetails[]`](../api/interfaces/JackpotDetails.md) | Array of jackpots |
 
 ---
 
@@ -1601,7 +1601,7 @@ Get jackpot winners history.
 | `cid` | `number` | `810` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `winners` | [`JackpotWinnerHistory[]`](../interfaces/JackpotWinnerHistory.md) | Array of winners |
+| `winners` | [`JackpotWinnerHistory[]`](../api/interfaces/JackpotWinnerHistory.md) | Array of winners |
 
 ---
 
@@ -1748,7 +1748,7 @@ Get list of Raffles available for user.
 | `cid` | `number` | Message type identifier |
 | `errCode` | `number` | Error code. `0` = success |
 | `errMsg` | `string` | Error message (if any) |
-| `items` | [`Raffle[]`](../interfaces/Raffle.md) | Array of raffles |
+| `items` | [`Raffle[]`](../api/interfaces/Raffle.md) | Array of raffles |
 
 ---
 
@@ -1869,7 +1869,7 @@ Get detailed information about a specific draw run, including winners.
 | `cid` | `number` | Message type identifier |
 | `errCode` | `number` | Error code. `0` = success |
 | `errMsg` | `string` | Error message (if any) |
-| `draw` | [`RaffleDraw`](../interfaces/RaffleDraw.md) | Draw run details with winners |
+| `draw` | [`RaffleDraw`](../api/interfaces/RaffleDraw.md) | Draw run details with winners |
 
 ---
 
@@ -1966,7 +1966,7 @@ Get history of completed draw runs for a specific raffle. Useful for displaying
 | `cid` | `number` | Message type identifier |
 | `errCode` | `number` | Error code. `0` = success |
 | `errMsg` | `string` | Error message (if any) |
-| `draw_runs` | [`RaffleDrawRun[]`](../interfaces/RaffleDrawRun.md) | Array of historical draw runs |
+| `draw_runs` | [`RaffleDrawRun[]`](../api/interfaces/RaffleDrawRun.md) | Array of historical draw runs |
 
 ---
 
@@ -2179,7 +2179,7 @@ Get user's points history.
 | `cid` | `number` | `546` |
 | `uuid` | `string` | Request identifier |
 | `errCode` | `number` | Error code (`0` = success) |
-| `history` | `array` | Array of points history entries |
+| `logHistory` | [`PointsLog[]`](../api/interfaces/PointsLog.md) \| [`GemsDiamondsLog[]`](../api/interfaces/GemsDiamondsLog.md) | Array of points history entries |
 
 #### Example
 
@@ -2200,9 +2200,16 @@ Get user's points history.
   "cid": 546,
   "uuid": "hist-123",
   "errCode": 0,
-  "history": [
-    { "ts": 1699950000, "points": 100, "action": "mission_complete" },
-    { "ts": 1699960000, "points": 50, "action": "daily_login" }
+  "logHistory": [
+    {
+      "create_date": 1699950000,
+      "user_ext_id": "user123",
+      "crm_brand_id": 1,
+      "points_collected": 100,
+      "user_points_ever": 5000,
+      "user_points_balance": 1500,
+      "source_type_id": 1
+    }
   ]
 }
 ```

package/package.json

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

package/tsconfig.json

@@ -18,18 +18,35 @@
 			"src/WSAPI/WSAPITypes.ts",
 			"src/Tournaments/TournamentRegistrationStatus.ts",
 			"src/Tournaments/TournamentRegistrationType.ts",
+			"src/Tournaments/Tournament.ts",
+			"src/Tournaments/TournamentPlayer.ts",
+			"src/Tournaments/TournamentPrize.ts",
+			"src/Tournaments/GetTournamentInfoResponse.ts",
 			"src/Bonuses/BonusStatus.ts",
+			"src/Bonuses/Bonus.ts",
 			"src/MiniGames/index.ts",
+			"src/MiniGames/SAWWinningHistoryResponse.ts",
 			"src/CustomSections/AchCustomSection.ts",
-			"src/Tournaments/TournamentRegistrationError.ts",
+			"src/CustomSections/UICustomSection.ts",
 			"src/Store/BuyStoreItemErrorCode.ts",
+			"src/Store/StoreItem.ts",
+			"src/Store/StoreCategory.ts",
+			"src/Store/StoreCategoryPublicMeta.ts",
 			"src/Leaderboard/LeaderBoardPeriodType.ts",
 			"src/Base/AchRelatedGame.ts",
 			"src/Jackpots/index.ts",
 			"src/Raffle/index.ts",
 			"src/Missions/AchievementAvailabilityStatus.ts",
+			"src/Missions/UserAchievement.ts",
+			"src/Missions/UserAchievementTask.ts",
+			"src/Missions/AchievementCategory.ts",
+			"src/Missions/AchCategoryPublicMeta.ts",
+			"src/Missions/AchievementPublicMeta.ts",
+			"src/Level/Level.ts",
+			"src/Level/LevelPublicMeta.ts",
+			"src/Inbox/InboxMessage.ts"
 		],
-		"out": "docs",
+		"out": "docs/api",
 		"plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],
 		"entryDocument": "README.md",
 		"disableSources": true,

package/docs/enums/TournamentRegistrationError.md

@@ -1,55 +0,0 @@
-# Enumeration: TournamentRegistrationError
-
-## Enumeration Members
-
-### NO\_ERROR
-
-• **NO\_ERROR** = ``0``
-
-___
-
-### TOURNAMENT\_INSTANCE\_NOT\_FOUND
-
-• **TOURNAMENT\_INSTANCE\_NOT\_FOUND** = ``30001``
-
-___
-
-### TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS
-
-• **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS** = ``30002``
-
-___
-
-### TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE
-
-• **TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE** = ``30003``
-
-___
-
-### TOURNAMENT\_ALREADY\_REGISTERED
-
-• **TOURNAMENT\_ALREADY\_REGISTERED** = ``30004``
-
-___
-
-### TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS
-
-• **TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS** = ``30005``
-
-___
-
-### TOURNAMENT\_USER\_NOT\_REGISTERED
-
-• **TOURNAMENT\_USER\_NOT\_REGISTERED** = ``30006``
-
-___
-
-### TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS
-
-• **TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS** = ``30007``
-
-___
-
-### TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED
-
-• **TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED** = ``30008``

package/docs/interfaces/AchCategory.md

@@ -1,19 +0,0 @@
-# Interface: AchCategory
-
-Achievement/Mission category object.
-
-## Properties
-
-### id
-
-• **id**: `number`
-
-Category ID
-
-___
-
-### publicMeta
-
-• **publicMeta**: [`AchCategoryPublicMeta`](AchCategoryPublicMeta.md)
-
-Public metadata for UI display

package/docs/interfaces/AchCategoryPublicMeta.md

@@ -1,19 +0,0 @@
-# Interface: AchCategoryPublicMeta
-
-Public metadata for achievement category.
-
-## Properties
-
-### name
-
-• **name**: `string`
-
-Category name (translated)
-
-___
-
-### order
-
-• **order**: `number`
-
-Sort order for UI display

package/docs/interfaces/AchCustomSectionType.md

@@ -1,21 +0,0 @@
-# Enum: AchCustomSectionType
-
-Custom section type identifiers.
-
-## Values
-
-| Value | Name | Description |
-|-------|------|-------------|
-| `1` | HTML_PAGE | Custom HTML page |
-| `2` | MISSIONS_CATEGORY | Missions category section |
-| `3` | TOURNAMENTS_CATEGORY | Tournaments category section |
-| `4` | LEVELS | Levels section |
-| `5` | MINI_GAMES | Mini-games section |
-| `6` | MISSION_CUSTOM_LAYOUT | Custom mission layout |
-| `7` | MATCH_X_AND_QUIZ | Match X and Quiz games |
-| `9` | REDIRECT_LINK | Redirect link |
-| `10` | LOOTBOX_WEEKLY | Weekly lootbox |
-| `11` | LOOTBOX_CALENDAR_DAYS | Calendar days lootbox |
-| `12` | TREASURE_HUNT | Treasure hunt |
-| `13` | RAFFLE | Raffle section |
-| `14` | BADGES | Badges section |

package/docs/interfaces/AchievementPublicMeta.md

@@ -1,155 +0,0 @@
-# Interface: AchievementPublicMeta
-
-Public metadata for an Achievement (Mission or Badge), used for UI display.
-
-## Properties
-
-### name
-
-• **name**: `string`
-
-Achievement name
-
-___
-
-### description
-
-• **description**: `string`
-
-Achievement description (HTML capable)
-
-___
-
-### sub\_header
-
-• **sub\_header**: `string`
-
-Sub-header text
-
-___
-
-### hint\_text
-
-• **hint\_text**: `string`
-
-Hint text
-
-___
-
-### image\_url
-
-• **image\_url**: `string`
-
-Image URL
-
-___
-
-### reward
-
-• **reward**: `string`
-
-Reward description
-
-___
-
-### cta\_action
-
-• **cta\_action**: `string`
-
-Call-to-action URL
-
-___
-
-### cta\_text
-
-• **cta\_text**: `string`
-
-Call-to-action button text
-
-___
-
-### custom\_data
-
-• **custom\_data**: `string`
-
-Custom data (JSON string)
-
-___
-
-### position
-
-• **position**: `object`
-
-Position on mission map
-
-___
-
-### label\_tag
-
-• **label\_tag**: `string`
-
-Label/ribbon tag
-
-___
-
-### custom\_label\_tag
-
-• **custom\_label\_tag**: `string`
-
-Custom label tag
-
-___
-
-### custom\_section\_id
-
-• **custom\_section\_id**: `number`
-
-Custom section ID
-
-___
-
-### only\_in\_custom\_section
-
-• **only\_in\_custom\_section**: `boolean`
-
-Show only in custom section
-
-___
-
-### unlock\_mission\_description
-
-• **unlock\_mission\_description**: `string`
-
-Description for locked state
-
-___
-
-### claim\_button\_title
-
-• **claim\_button\_title**: `string`
-
-Claim button title
-
-___
-
-### claim\_button\_action
-
-• **claim\_button\_action**: `string`
-
-Claim button action
-
-___
-
-### hide\_locked\_mission
-
-• **hide\_locked\_mission**: `boolean`
-
-Hide when locked
-
-___
-
-### custom\_section\_type\_id
-
-• **custom\_section\_type\_id**: `number`
-
-Custom section type ID