@smartico/public-api 0.0.411 → 0.0.413
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.
- package/dist/Jackpots/JackpotPublicMeta.d.ts +1 -1
- package/dist/Level/LevelPublicMeta.d.ts +1 -1
- package/dist/MiniGames/SAWTemplate.d.ts +2 -0
- package/dist/Raffle/Raffle.d.ts +1 -1
- package/dist/SmarticoLib/index.d.ts +3 -3
- package/dist/WSAPI/WSAPIJackpots.d.ts +3 -1
- package/dist/WSAPI/WSAPIMissions.d.ts +40 -12
- package/dist/WSAPI/WSAPITypes.d.ts +7 -5
- package/dist/index.js +47 -14
- package/dist/index.js.map +1 -1
- package/dist/index.modern.mjs +47 -14
- package/dist/index.modern.mjs.map +1 -1
- package/docs/api/classes/WSAPIMissions.md +40 -12
- package/docs/api/interfaces/JackpotPublicMeta.md +1 -1
- package/docs/api/interfaces/LevelPublicMeta.md +1 -1
- package/docs/api/interfaces/RafflePublicMeta.md +1 -1
- package/docs/api/interfaces/SAWTemplate.md +8 -0
- package/docs/api/interfaces/TMissionOrBadge.md +6 -4
- package/docs/api/interfaces/TRaffle.md +1 -1
- package/docs/capabilities/getBadges.md +4 -4
- package/docs/capabilities/getMissions.md +44 -16
- package/docs/capabilities/getRaffles.md +1 -1
- package/docs/capabilities/jackpotGet.md +1 -1
- package/docs/ui/jackpots/UIGuide_getJackpotWinners.md +3 -2
- package/docs/ui/missions/UIGuide_getMissions.md +44 -24
- package/package.json +1 -1
- package/src/Jackpots/JackpotPublicMeta.ts +1 -1
- package/src/Level/LevelPublicMeta.ts +1 -1
- package/src/MiniGames/SAWTemplate.ts +2 -0
- package/src/Raffle/Raffle.ts +1 -1
- package/src/SmarticoLib/index.ts +3 -3
- package/src/WSAPI/WSAPIJackpots.ts +7 -2
- package/src/WSAPI/WSAPIMissions.ts +40 -12
- package/src/WSAPI/WSAPITypes.ts +7 -5
package/src/WSAPI/WSAPITypes.ts
CHANGED
|
@@ -853,7 +853,9 @@ export interface TMissionOrBadge {
|
|
|
853
853
|
reward: string;
|
|
854
854
|
/** URL of the image of the mission or badge, 256x256px */
|
|
855
855
|
image: string;
|
|
856
|
-
/** Indicator if the mission is completed or badge is granted
|
|
856
|
+
/** Indicator if the mission is completed or badge is granted. Stays `false` for
|
|
857
|
+
* Recurring-upon-completion missions even after cycles complete — use `completion_count`
|
|
858
|
+
* to detect completed cycles (see `getMissions` bucketing). */
|
|
857
859
|
is_completed: boolean;
|
|
858
860
|
/** Indicator if the mission is locked. Means that it's visible to the user, but he cannot progress in it until it's unlocked.
|
|
859
861
|
* Mission may optionally contain the explanation of what should be done to unlock it in the unlock_mission_description property
|
|
@@ -945,10 +947,10 @@ export interface TMissionOrBadge {
|
|
|
945
947
|
/** ID of specific Custom Section type */
|
|
946
948
|
custom_section_type_id?: number;
|
|
947
949
|
|
|
948
|
-
/** Max number of times the user can complete a mission in case if mission type is Recurring upon completion. NULL equals infinite. */
|
|
950
|
+
/** Max number of times the user can complete a mission in case if mission type is Recurring upon completion. NULL equals infinite (still recurring — not "no cap disables recurring"). */
|
|
949
951
|
max_completion_count?: number;
|
|
950
952
|
|
|
951
|
-
/** Current completion count for Recurring
|
|
953
|
+
/** Current completion count for Recurring-upon-completion missions. Non-null ONLY for that mission type, so its presence identifies one; `> 0` means at least one cycle completed. */
|
|
952
954
|
completion_count?: number;
|
|
953
955
|
|
|
954
956
|
/** The date/timestamp for recurring missions, which indicating the time remaining until the next recurrence of the mission.
|
|
@@ -956,7 +958,7 @@ export interface TMissionOrBadge {
|
|
|
956
958
|
*/
|
|
957
959
|
next_recurrence_date_ts?: number;
|
|
958
960
|
|
|
959
|
-
/**
|
|
961
|
+
/** Timer/window state derived from the mission's time limits (which countdown to show / whether the window elapsed). NOT a tab-bucketing signal — it ignores `completion_count`, so bucket sections from the raw fields instead (see `getMissions`). */
|
|
960
962
|
availability_status?: AchievementAvailabilityStatus;
|
|
961
963
|
|
|
962
964
|
/** Title for the claim reward button */
|
|
@@ -1418,7 +1420,7 @@ export interface TRaffle {
|
|
|
1418
1420
|
/**
|
|
1419
1421
|
* Custom data as string or JSON string that can be used in API to build custom UI
|
|
1420
1422
|
* You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
|
|
1421
|
-
* Read more here - https://help.smartico.ai/welcome/products/
|
|
1423
|
+
* Read more here - https://help.smartico.ai/welcome/products/tools-and-guides/custom-fields-attributes
|
|
1422
1424
|
*/
|
|
1423
1425
|
custom_data: string;
|
|
1424
1426
|
/** Date of start */
|