@smartico/public-api 0.0.363 → 0.0.365

package/src/WSAPI/WSAPI.ts

@@ -39,6 +39,10 @@ import {
 	TLevelCurrent,
 	TActivityLog,
 	TRaffleOptinResponse,
+	TClans,
+	TClanInfo,
+	TClanJoinResult,
+	TClanTournamentPlayers,
 	GamesApiResponse,
 	GamePickRound,
 	GamePickRoundBoard,
@@ -66,8 +70,6 @@ import { InboxCategories } from '../Inbox/InboxCategories';
 import {
 	drawRunHistoryTransform,
 	raffleClaimPrizeResponseTransform,
-	RaffleOptinRequest,
-	RaffleOptinResponse,
 } from '../Raffle';
 import { IntUtils } from '../IntUtils';
 import { TGetJackpotEligibleGamesResponse } from '../Jackpots/GetJackpotEligibleGamesResponse';
@@ -100,6 +102,7 @@ enum onUpdateContextKey {
 	Pots = 'Pots',
 	CustomSections = 'customSections',
 	Bonuses = 'bonuses',
+	Clans = 'clans',
 	SAWHistory = 'sawHistory',
 	JackpotWinners = 'jackpotWinners',
 	Raffles = 'raffles',
@@ -748,6 +751,44 @@ export class WSAPI {
 		);
 	}
 
+	/**
+	 * Returns clans list payload for the current user.
+	 * The returned payload is cached for 30 seconds.
+	 * If onUpdate is passed, it will be called when clans response is received.
+	 *
+	 * **Visitor mode: not supported**
+	 */
+	public async getClans({ onUpdate }: { onUpdate?: (data: TClans) => void } = {}): Promise<TClans> {
+		if (onUpdate) {
+			this.onUpdateCallback.set(onUpdateContextKey.Clans, onUpdate);
+		}
+
+		return OCache.use(
+			onUpdateContextKey.Clans,
+			ECacheContext.WSAPI,
+			() => this.api.clansGetListT(this.userExtId),
+			CACHE_DATA_SEC,
+		);
+	}
+
+	/**
+	 * Returns detailed information for a specific clan including its members.
+	 *
+	 * **Visitor mode: not supported**
+	 */
+	public async getClanInfo(clanId: number): Promise<TClanInfo> {
+		return this.api.clansGetInfoT(this.userExtId, clanId);
+	}
+
+	/**
+	 * Joins a clan on behalf of the current user.
+	 *
+	 * **Visitor mode: not supported**
+	 */
+	public async joinClan(clanId: number): Promise<TClanJoinResult> {
+		return this.api.clanJoin(this.userExtId, clanId);
+	}
+
 	/**
 	 * Returns detailed information for a specific tournament instance; the response includes tournament info and the leaderboard of players
 	 *
@@ -777,6 +818,15 @@ export class WSAPI {
 		return this.api.tournamentsGetInfoT(this.userExtId, tournamentInstanceId);
 	}
 
+	/**
+	 * Returns the players of a specific clan in a clan-based tournament.
+	 *
+	 * **Visitor mode: not supported**
+	 */
+	public async getClanTournamentPlayers(tournamentInstanceId: number, clanId: number): Promise<TClanTournamentPlayers> {
+		return this.api.clanTournamentGetPlayers(this.userExtId, tournamentInstanceId, clanId);
+	}
+
 	/**
 	 * Requests registration for the specified tournament instance. Returns the err_code.
 	 *
@@ -980,6 +1030,7 @@ export class WSAPI {
 	 *
 	 * **Visitor mode: not supported**
 	 *
+	 * @param params - Event parameters
 	 * @param params.engagement_uid - Unique identifier for the engagement
 	 * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
 	 */
@@ -1010,6 +1061,7 @@ export class WSAPI {
 	 *
 	 * **Visitor mode: not supported**
 	 *
+	 * @param params - Event parameters
 	 * @param params.engagement_uid - Unique identifier for the engagement
 	 * @param params.activityType - Type of engagement activity (Popup=30, Inbox=31)
 	 * @param params.action - Optional action/deeplink that was triggered by the user interaction
@@ -1051,6 +1103,7 @@ export class WSAPI {
 	 *
 	 * **Visitor mode: not supported**
 	 *
+	 * @param params - Activity log parameters
 	 * @param params.startTimeSeconds - Start time in seconds (epoch timestamp)
 	 * @param params.endTimeSeconds - End time in seconds (epoch timestamp)
 	 * @param params.from - Start index of records to return
@@ -1596,6 +1649,11 @@ export class WSAPI {
 		this.updateEntity(onUpdateContextKey.TournamentList, payload);
 	}
 
+	private async updateClans() {
+		const payload = await this.api.clansGetListT(this.userExtId);
+		this.updateEntity(onUpdateContextKey.Clans, payload);
+	}
+
 	private async updateStorePurchasedItems() {
 		const payload = await this.api.storeGetPurchasedItemsT(this.userExtId, 20, 0);
 		this.updateEntity(onUpdateContextKey.StoreHistory, payload);
@@ -1775,6 +1833,7 @@ export class WSAPI {
 	 *
 	 * **Visitor mode: not supported**
 	 *
+	 * @param params - Jackpot winners parameters
 	 * @param params.jp_template_id - Jackpot template id (required; throws if missing)
 	 * @param params.limit - Page size (server default 20 when omitted)
 	 * @param params.offset - Offset into the winner list

package/src/WSAPI/WSAPITypes.ts

@@ -478,6 +478,137 @@ export interface TTournamentDetailed extends TTournament {
 		/** if the prize is points related, indicates amount of points */
 		points?: number;
 	}[];
+
+	/** True when this tournament groups participants by clan */
+	is_clan_based?: boolean;
+	/** Ranked list of clans in this tournament; null for non-clan tournaments */
+	clan_leaderboard?: {
+		clan_id: number;
+		public_meta: { name: string; description: string; image_url: string };
+		position: number;
+		total_score: number;
+		contributing_members: number;
+	}[] | null;
+	/** The clan ID the current user belongs to; null when clanless or non-clan tournament */
+	user_clan_id?: number | null;
+	/** The user's rank within their own clan; null when clanless or not registered */
+	user_position_in_clan?: number | null;
+	/** The user's score contribution to their clan; null when clanless or not registered */
+	user_score_in_clan?: number | null;
+	/** Per-clan prize structure; null for non-clan tournaments */
+	clan_prize_structure?: {
+		clan_place: number;
+		/** 1 = Fixed, 2 = Dynamic */
+		prize_type_id: number;
+		prize_pool_amount: number | null;
+		activity_type_id: number | null;
+		details_json: Record<string, any>;
+		public_meta: { name: string; description: string; image_url: string } | null;
+		tiers: {
+			player_place_from: number;
+			player_place_to: number;
+			pool_amount: number | null;
+			/** 1 = ScoreWeighted, 2 = EqualSplit; null for Fixed */
+			distribution_type: number | null;
+			activity_type_id: number;
+			details_json: Record<string, any>;
+			public_meta: { name: string; description: string; image_url: string } | null;
+		}[];
+	}[] | null;
+}
+
+/**
+ * TClanTournamentPlayers describes the players of a specific clan in a clan-based tournament.
+ */
+export interface TClanTournamentPlayers {
+	/** Clan ID */
+	clan_id: number;
+	/** Clan display metadata */
+	clan_public_meta: { name: string; image_url: string };
+	/** Top players of this clan ranked by score DESC */
+	players: {
+		user_id: number;
+		public_username: string;
+		avatar_id: string;
+		avatar_real_id: number;
+		avatar_url?: string;
+		position: number;
+		scores: number;
+		is_me: boolean;
+		clean_ext_user_id: string;
+	}[];
+}
+
+/**
+ * TClan describes one clan item from the clans list.
+ */
+export interface TClan {
+	/** Clan ID */
+	clan_id: number;
+	/** Translated clan metadata */
+	public_meta: {
+		name: string;
+		description: string;
+		image_url: string;
+	};
+	/** Current number of members in clan */
+	member_count: number;
+	/** Max number of members allowed in clan */
+	capacity_limit: number;
+	/** ShopPurchaseType: 0=Points, 1=Gems, 2=Diamonds, 3=Free */
+	entry_fee_currency_type_id: number;
+	/** Numeric value for entry fee */
+	entry_fee_amount: number;
+	/** F1 rank ASC, 1=best */
+	rating_position: number;
+	/** Clan rating score */
+	rating_score: number;
+}
+
+/**
+ * TClans describes the clans payload returned by the API.
+ */
+export interface TClans {
+	/** List of active clans available to the user */
+	clans: TClan[];
+	/** The clan ID the current user belongs to; null if clanless */
+	user_clan_id: number | null;
+	/** Cooldown-until date string; null if no cooldown */
+	cooldown_until: string | null;
+}
+
+/**
+ * TClanInfo describes the detailed info of a single clan including its members.
+ */
+export interface TClanInfo {
+	clan_id: number;
+	public_meta: { name: string; description: string; image_url: string };
+	member_count: number;
+	capacity_limit: number;
+	entry_fee_currency_type_id: number;
+	entry_fee_amount: number;
+	rating_position: number;
+	rating_score: number;
+	cooldown_until: string | null;
+	members: {
+		user_id: number;
+		public_username: string;
+		avatar_id: string;
+		avatar_real_id: number;
+		avatar_url?: string;
+		position: number;
+		contribution_score: number;
+		is_me?: boolean;
+		clean_ext_user_id?: string;
+	}[];
+}
+
+/**
+ * TClanJoinResult describes the result of a join clan request.
+ */
+export interface TClanJoinResult {
+	errCode: number;
+	errMsg: string;
 }
 
 /**

package/src/index.ts

@@ -23,4 +23,5 @@ export * from './Bonuses';
 export * from './CustomSections';
 export * from './ActivityLog';
 export * from './Base/AchRelatedGame';
-export * from './Avatars';
+export * from './Avatars';
+export * from './Clans';

package/tsconfig.json

@@ -26,6 +26,7 @@
 			"src/Tournaments/TournamentPlayer.ts",
 			"src/Tournaments/TournamentPrize.ts",
 			"src/Tournaments/GetTournamentInfoResponse.ts",
+			"src/Tournaments/TournamentClan.ts",
 			"src/Bonuses/BonusStatus.ts",
 			"src/Bonuses/Bonus.ts",
 			"src/Bonuses/BonusMetaMap.ts",
@@ -66,17 +67,18 @@
 			"src/Inbox/InboxMessage.ts",
 			"src/Inbox/InboxMessageType.ts",
 			"src/Inbox/OpenLinksType.ts",
-			"src/Inbox/InboxReadStatus.ts"
+			"src/Inbox/InboxReadStatus.ts",
+			"src/Clans/Clan.ts"
 		],
 		"out": "docs/api",
 		"plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],
-		"entryDocument": "README.md",
+		"entryFileName": "README.md",
 		"disableSources": true,
 		"excludePrivate": true,
 		"readme": "none",
 		"cleanOutputDir": true,
 		"hideBreadcrumbs": true,
-		"hideInPageTOC": true,
+		"hidePageHeader": true,
 		"sort": "source-order"
 	}
 }

package/docs/api/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/api/enums/AchCustomLayoutTheme.md

@@ -1,25 +0,0 @@
-# Enumeration: AchCustomLayoutTheme
-
-## Enumeration Members
-
-### VALENTINES\_LIGHT
-
-• **VALENTINES\_LIGHT** = ``"valentines-light"``
-
-___
-
-### VALENTINES\_DARK
-
-• **VALENTINES\_DARK** = ``"valentines-dark"``
-
-___
-
-### EURO\_2024
-
-• **EURO\_2024** = ``"euro-2024"``
-
-___
-
-### GENERIC
-
-• **GENERIC** = ``"generic"``

package/docs/api/enums/AchCustomSectionType.md

@@ -1,79 +0,0 @@
-# Enumeration: AchCustomSectionType
-
-## Enumeration Members
-
-### HTML\_PAGE
-
-• **HTML\_PAGE** = ``1``
-
-___
-
-### MISSIONS\_CATEGORY
-
-• **MISSIONS\_CATEGORY** = ``2``
-
-___
-
-### TOURNAMENTS\_CATEGORY
-
-• **TOURNAMENTS\_CATEGORY** = ``3``
-
-___
-
-### LEVELS
-
-• **LEVELS** = ``4``
-
-___
-
-### MINI\_GAMES
-
-• **MINI\_GAMES** = ``5``
-
-___
-
-### MISSION\_CUSTOM\_LAYOUT
-
-• **MISSION\_CUSTOM\_LAYOUT** = ``6``
-
-___
-
-### MATCH\_X\_AND\_QUIZ
-
-• **MATCH\_X\_AND\_QUIZ** = ``7``
-
-___
-
-### REDIRECT\_LINK
-
-• **REDIRECT\_LINK** = ``9``
-
-___
-
-### LOOTBOX\_WEEKLY
-
-• **LOOTBOX\_WEEKLY** = ``10``
-
-___
-
-### LOOTBOX\_CALENDAR\_DAYS
-
-• **LOOTBOX\_CALENDAR\_DAYS** = ``11``
-
-___
-
-### STORE
-
-• **STORE** = ``12``
-
-___
-
-### RAFFLE
-
-• **RAFFLE** = ``13``
-
-___
-
-### BADGES
-
-• **BADGES** = ``14``

package/docs/api/enums/AchievementStatus.md

@@ -1,49 +0,0 @@
-# Enumeration: AchievementStatus
-
-## Enumeration Members
-
-### Draft
-
-• **Draft** = ``1``
-
-___
-
-### AvailableUnlocked
-
-• **AvailableUnlocked** = ``2``
-
-___
-
-### AvailableLocked
-
-• **AvailableLocked** = ``3``
-
-___
-
-### Archived
-
-• **Archived** = ``4``
-
-___
-
-### FeaturedManually
-
-• **FeaturedManually** = ``5``
-
-___
-
-### FeaturedAI
-
-• **FeaturedAI** = ``6``
-
-___
-
-### Recurring
-
-• **Recurring** = ``7``
-
-___
-
-### RecurringUponCompletion
-
-• **RecurringUponCompletion** = ``8``

package/docs/api/enums/ActivityTypeLimited.md

@@ -1,115 +0,0 @@
-# Enumeration: ActivityTypeLimited
-
-## Enumeration Members
-
-### DoNothing
-
-• **DoNothing** = ``8``
-
-___
-
-### Points
-
-• **Points** = ``12``
-
-___
-
-### GiveMission
-
-• **GiveMission** = ``14``
-
-___
-
-### StartAnotherCampaign
-
-• **StartAnotherCampaign** = ``15``
-
-___
-
-### MiniGameAttempt
-
-• **MiniGameAttempt** = ``16``
-
-___
-
-### DeductPoints
-
-• **DeductPoints** = ``21``
-
-___
-
-### ResetPoints
-
-• **ResetPoints** = ``22``
-
-___
-
-### AddGemsAndDiamonds
-
-• **AddGemsAndDiamonds** = ``25``
-
-___
-
-### DeductGemsAndDiamonds
-
-• **DeductGemsAndDiamonds** = ``26``
-
-___
-
-### ResetGemsAndDiamonds
-
-• **ResetGemsAndDiamonds** = ``27``
-
-___
-
-### Popup
-
-• **Popup** = ``30``
-
-___
-
-### Inbox
-
-• **Inbox** = ``31``
-
-___
-
-### Slack
-
-• **Slack** = ``70``
-
-___
-
-### Email\_To\_Customer\_Support
-
-• **Email\_To\_Customer\_Support** = ``80``
-
-___
-
-### Email\_To\_Risk\_Operator
-
-• **Email\_To\_Risk\_Operator** = ``90``
-
-___
-
-### Bonus
-
-• **Bonus** = ``100``
-
-___
-
-### WebHook
-
-• **WebHook** = ``200``
-
-___
-
-### TagCustomer
-
-• **TagCustomer** = ``504``
-
-___
-
-### UnTagCustomer
-
-• **UnTagCustomer** = ``505``

package/docs/api/enums/BonusStatus.md

@@ -1,37 +0,0 @@
-# Enumeration: BonusStatus
-
-## Enumeration Members
-
-### New
-
-• **New** = ``1``
-
-___
-
-### COUPON\_ISSUED
-
-• **COUPON\_ISSUED** = ``2``
-
-___
-
-### REDEEMED
-
-• **REDEEMED** = ``3``
-
-___
-
-### REDEEM\_FAILED
-
-• **REDEEM\_FAILED** = ``4``
-
-___
-
-### COUPON\_ISSUE\_FAILED
-
-• **COUPON\_ISSUE\_FAILED** = ``5``
-
-___
-
-### EXPIRED
-
-• **EXPIRED** = ``6``