@smartico/public-api 0.0.363 → 0.0.365

package/docs/api/interfaces/UserAchievement.md

@@ -2,204 +2,204 @@
 
 ## Properties
 
-### ach\_id
+### ach\_id?
 
-• `Optional` **ach\_id**: `number`
+> `optional` **ach\_id?**: `number`
 
-___
+***
 
-### ach\_type\_id
+### ach\_type\_id?
 
-• `Optional` **ach\_type\_id**: [`AchievementType`](../enums/AchievementType.md)
+> `optional` **ach\_type\_id?**: [`AchievementType`](../enumerations/AchievementType.md)
 
-___
+***
 
-### ach\_public\_meta
+### ach\_public\_meta?
 
-• `Optional` **ach\_public\_meta**: [`AchievementPublicMeta`](AchievementPublicMeta.md)
+> `optional` **ach\_public\_meta?**: [`AchievementPublicMeta`](AchievementPublicMeta.md)
 
-___
+***
 
-### isCompleted
+### isCompleted?
 
-• `Optional` **isCompleted**: `boolean`
+> `optional` **isCompleted?**: `boolean`
 
-___
+***
 
-### isLocked
+### isLocked?
 
-• `Optional` **isLocked**: `boolean`
+> `optional` **isLocked?**: `boolean`
 
-___
+***
 
-### requiresOptin
+### requiresOptin?
 
-• `Optional` **requiresOptin**: `boolean`
+> `optional` **requiresOptin?**: `boolean`
 
-___
+***
 
-### isOptedIn
+### isOptedIn?
 
-• `Optional` **isOptedIn**: `boolean`
+> `optional` **isOptedIn?**: `boolean`
 
-___
+***
 
-### start\_date
+### start\_date?
 
-• `Optional` **start\_date**: `string`
+> `optional` **start\_date?**: `string`
 
-___
+***
 
-### start\_date\_ts
+### start\_date\_ts?
 
-• `Optional` **start\_date\_ts**: `number`
+> `optional` **start\_date\_ts?**: `number`
 
-___
+***
 
-### time\_limit\_ms
+### time\_limit\_ms?
 
-• `Optional` **time\_limit\_ms**: `number`
+> `optional` **time\_limit\_ms?**: `number`
 
-___
+***
 
-### progress
+### progress?
 
-• `Optional` **progress**: `number`
+> `optional` **progress?**: `number`
 
-___
+***
 
-### complete\_date
+### complete\_date?
 
-• `Optional` **complete\_date**: `string`
+> `optional` **complete\_date?**: `string`
 
-___
+***
 
-### complete\_date\_ts
+### complete\_date\_ts?
 
-• `Optional` **complete\_date\_ts**: `number`
+> `optional` **complete\_date\_ts?**: `number`
 
-___
+***
 
-### unlock\_date
+### unlock\_date?
 
-• `Optional` **unlock\_date**: `string`
+> `optional` **unlock\_date?**: `string`
 
-___
+***
 
-### milliseconds\_till\_available
+### milliseconds\_till\_available?
 
-• `Optional` **milliseconds\_till\_available**: `number`
+> `optional` **milliseconds\_till\_available?**: `number`
 
-___
+***
 
-### completed\_tasks
+### completed\_tasks?
 
-• `Optional` **completed\_tasks**: `number`
+> `optional` **completed\_tasks?**: `number`
 
-___
+***
 
-### achievementTasks
+### achievementTasks?
 
-• `Optional` **achievementTasks**: [`UserAchievementTask`](UserAchievementTask.md)[]
+> `optional` **achievementTasks?**: [`UserAchievementTask`](UserAchievementTask.md)[]
 
-___
+***
 
-### next\_recurrence\_date\_ts
+### next\_recurrence\_date\_ts?
 
-• `Optional` **next\_recurrence\_date\_ts**: `number`
+> `optional` **next\_recurrence\_date\_ts?**: `number`
 
-___
+***
 
-### ach\_status\_id
+### ach\_status\_id?
 
-• `Optional` **ach\_status\_id**: [`AchievementStatus`](../enums/AchievementStatus.md)
+> `optional` **ach\_status\_id?**: [`AchievementStatus`](../enumerations/AchievementStatus.md)
 
-___
+***
 
-### scheduledMissionType
+### scheduledMissionType?
 
-• `Optional` **scheduledMissionType**: [`ScheduledMissionType`](../enums/ScheduledMissionType.md)
+> `optional` **scheduledMissionType?**: [`ScheduledMissionType`](../enumerations/ScheduledMissionType.md)
 
-___
+***
 
-### related\_games
+### related\_games?
 
-• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame.md)[]
+> `optional` **related\_games?**: [`AchRelatedGame`](AchRelatedGame.md)[]
 
-___
+***
 
-### active\_from\_ts
+### active\_from\_ts?
 
-• `Optional` **active\_from\_ts**: `number`
+> `optional` **active\_from\_ts?**: `number`
 
-___
+***
 
-### active\_till\_ts
+### active\_till\_ts?
 
-• `Optional` **active\_till\_ts**: `number`
+> `optional` **active\_till\_ts?**: `number`
 
-___
+***
 
-### ach\_categories
+### ach\_categories?
 
-• `Optional` **ach\_categories**: `number`[]
+> `optional` **ach\_categories?**: `number`[]
 
-___
+***
 
-### recurring\_quantity
+### recurring\_quantity?
 
-• `Optional` **recurring\_quantity**: `number`
+> `optional` **recurring\_quantity?**: `number`
 
-___
+***
 
-### completed\_count
+### completed\_count?
 
-• `Optional` **completed\_count**: `number`
+> `optional` **completed\_count?**: `number`
 
-___
+***
 
-### ach\_completed\_id
+### ach\_completed\_id?
 
-• `Optional` **ach\_completed\_id**: `number`
+> `optional` **ach\_completed\_id?**: `number`
 
-___
+***
 
-### requires\_prize\_claim
+### requires\_prize\_claim?
 
-• `Optional` **requires\_prize\_claim**: `boolean`
+> `optional` **requires\_prize\_claim?**: `boolean`
 
-___
+***
 
-### prize\_claimed\_date\_ts
+### prize\_claimed\_date\_ts?
 
-• `Optional` **prize\_claimed\_date\_ts**: `number`
+> `optional` **prize\_claimed\_date\_ts?**: `number`
 
-___
+***
 
-### completed\_today
+### completed\_today?
 
-• `Optional` **completed\_today**: `boolean`
+> `optional` **completed\_today?**: `boolean`
 
-___
+***
 
-### completed\_this\_week
+### completed\_this\_week?
 
-• `Optional` **completed\_this\_week**: `boolean`
+> `optional` **completed\_this\_week?**: `boolean`
 
-___
+***
 
-### completed\_this\_month
+### completed\_this\_month?
 
-• `Optional` **completed\_this\_month**: `boolean`
+> `optional` **completed\_this\_month?**: `boolean`
 
-___
+***
 
-### custom\_section\_type\_id
+### custom\_section\_type\_id?
 
-• `Optional` **custom\_section\_type\_id**: `number`
+> `optional` **custom\_section\_type\_id?**: `number`
 
-___
+***
 
-### badgeTimeLimitState
+### badgeTimeLimitState?
 
-• `Optional` **badgeTimeLimitState**: [`BadgesTimeLimitStates`](../enums/BadgesTimeLimitStates.md)
+> `optional` **badgeTimeLimitState?**: [`BadgesTimeLimitStates`](../enumerations/BadgesTimeLimitStates.md)

package/docs/api/interfaces/UserAchievementTask.md

@@ -2,82 +2,82 @@
 
 ## Properties
 
-### task\_id
+### task\_id?
 
-• `Optional` **task\_id**: `number`
+> `optional` **task\_id?**: `number`
 
-___
+***
 
-### task\_public\_meta
+### task\_public\_meta?
 
-• `Optional` **task\_public\_meta**: [`AchievementTaskPublicMeta`](AchievementTaskPublicMeta.md)
+> `optional` **task\_public\_meta?**: [`AchievementTaskPublicMeta`](AchievementTaskPublicMeta.md)
 
-___
+***
 
-### points\_reward
+### points\_reward?
 
-• `Optional` **points\_reward**: `number`
+> `optional` **points\_reward?**: `number`
 
-___
+***
 
 ### task\_type\_id
 
-• **task\_type\_id**: [`AchievementTaskType`](../enums/AchievementTaskType.md)
+> **task\_type\_id**: [`AchievementTaskType`](../enumerations/AchievementTaskType.md)
 
-___
+***
 
-### isCompleted
+### isCompleted?
 
-• `Optional` **isCompleted**: `boolean`
+> `optional` **isCompleted?**: `boolean`
 
-___
+***
 
-### userExecutedCount
+### userExecutedCount?
 
-• `Optional` **userExecutedCount**: `number`
+> `optional` **userExecutedCount?**: `number`
 
-___
+***
 
-### executionCount
+### executionCount?
 
-• `Optional` **executionCount**: `number`
+> `optional` **executionCount?**: `number`
 
-___
+***
 
-### userProgress
+### userProgress?
 
-• `Optional` **userProgress**: `number`
+> `optional` **userProgress?**: `number`
 
-___
+***
 
 ### lastExecutionDate
 
-• **lastExecutionDate**: `string`
+> **lastExecutionDate**: `string`
 
-___
+***
 
-### unlocked\_by\_mission\_id
+### unlocked\_by\_mission\_id?
 
-• `Optional` **unlocked\_by\_mission\_id**: `number`
+> `optional` **unlocked\_by\_mission\_id?**: `number`
 
-___
+***
 
-### unlocked\_by\_level\_id
+### unlocked\_by\_level\_id?
 
-• `Optional` **unlocked\_by\_level\_id**: `number`
+> `optional` **unlocked\_by\_level\_id?**: `number`
 
-___
+***
 
-### user\_state\_params
+### user\_state\_params?
 
-• `Optional` **user\_state\_params**: `Object`
+> `optional` **user\_state\_params?**: `object`
 
-#### Index signature
+#### Index Signature
 
-▪ [key: `string`]: `any`
+\[`key`: `string`\]: `any`
 
-___
+***
 
-### affects\_progress
+### affects\_progress?
 
-• `Optional` **affects\_progress**: [`AffectsProgress`](AffectsProgress.md)
+> `optional` **affects\_progress?**: [`AffectsProgress`](AffectsProgress.md)

package/docs/api/interfaces/UserLevelExtraCountersT.md

@@ -2,16 +2,16 @@
 
 ## Properties
 
-### level\_counter\_1
+### level\_counter\_1?
 
-• `Optional` **level\_counter\_1**: `number`
+> `optional` **level\_counter\_1?**: `number`
 
 The counter of 1st metric used to reach the level.
 
-___
+***
 
-### level\_counter\_2
+### level\_counter\_2?
 
-• `Optional` **level\_counter\_2**: `number`
+> `optional` **level\_counter\_2?**: `number`
 
 The counter of 2nd metric used to reach the level.

package/docs/api/type-aliases/TournamentRegistrationTypeName.md

@@ -0,0 +1,3 @@
+# Type Alias: TournamentRegistrationTypeName
+
+> **TournamentRegistrationTypeName** = `"AUTO"` \| `"OPT_IN"` \| `"BUY_IN_POINTS"` \| `"MANUAL_APPROVAL"` \| `"REQUIRES_QUALIFICATION"` \| `"BUY_IN_GEMS"` \| `"BUY_IN_DIAMONDS"` \| `"UNKNOWN"`

package/docs/api/variables/AllRoundsGameBoardID.md

@@ -0,0 +1,5 @@
+# Variable: AllRoundsGameBoardID
+
+> `const` **AllRoundsGameBoardID**: `-1` = `-1`
+
+Round ID constant used to request the overall/seasonal leaderboard across all rounds

package/docs/api/variables/PrizeModifiersKeysNames.md

@@ -0,0 +1,37 @@
+# Variable: PrizeModifiersKeysNames
+
+> `const` **PrizeModifiersKeysNames**: `object`
+
+## Type Declaration
+
+### 1
+
+> **1**: `string` = `'2x'`
+
+### 2
+
+> **2**: `string` = `'5x'`
+
+### 3
+
+> **3**: `string` = `'10x'`
+
+### 4
+
+> **4**: `string` = `'/2'`
+
+### 5
+
+> **5**: `string` = `'/5'`
+
+### 6
+
+> **6**: `string` = `'/10'`
+
+### 7
+
+> **7**: `string` = `'0'`
+
+### 8
+
+> **8**: `string` = `'Reset to 0'`

package/docs/api/variables/SAWWinSoundFiles.md

@@ -0,0 +1,21 @@
+# Variable: SAWWinSoundFiles
+
+> `const` **SAWWinSoundFiles**: `object`
+
+## Type Declaration
+
+### 4
+
+> **4**: `any` = `null`
+
+### 1
+
+> **1**: `string` = `'saw-disappointed.m4a'`
+
+### 2
+
+> **2**: `string` = `'saw-positive.m4a'`
+
+### 3
+
+> **3**: `string` = `'saw-highly-positive.m4a'`

package/package.json

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

package/src/Base/ClassId.ts

@@ -109,6 +109,18 @@ export enum ClassId {
 	GET_AVATAR_PROMPTS_REQUEST = 564,
 	GET_AVATAR_PROMPTS_RESPONSE = 565,
 
+	GET_CLAN_LIST_REQUEST = 570,
+	GET_CLAN_LIST_RESPONSE = 571,
+
+	GET_CLAN_INFO_REQUEST = 572,
+	GET_CLAN_INFO_RESPONSE = 573,
+
+	JOIN_CLAN_REQUEST = 574,
+	JOIN_CLAN_RESPONSE = 575,
+
+	GET_CLAN_TOURNAMENT_PLAYERS_REQUEST = 576,
+	GET_CLAN_TOURNAMENT_PLAYERS_RESPONSE = 577,
+
 	/*
         !Important, if adding new messages that are 'acting' on behalf of the client,
         you need to include them in the CLASS_ID_IGNORE_FOR_SIMULATION

package/src/Clans/Clan.ts

@@ -0,0 +1,18 @@
+export interface ClanPublicMeta {
+	name: string;
+	description: string;
+	image_url: string;
+}
+
+export interface Clan {
+	clan_id: number;
+	public_meta: ClanPublicMeta;
+	member_count: number;
+	capacity_limit: number;
+	/** ShopPurchaseType: 0=Points, 1=Gems, 2=Diamonds, 3=Free */
+	entry_fee_currency_type_id: number;
+	entry_fee_amount: number;
+	/** F1 rank ASC, 1=best */
+	rating_position: number;
+	rating_score: number;
+}

package/src/Clans/GetClanInfoRequest.ts

@@ -0,0 +1,6 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+
+export interface GetClanInfoRequest extends ProtocolMessage {
+	clan_id: number;
+	force_language?: string;
+}

package/src/Clans/GetClanInfoResponse.ts

@@ -0,0 +1,24 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { Clan } from './Clan';
+
+export interface ClanMember {
+	user_id: number;
+	public_username: string;
+	avatar_id: string;
+	avatar_real_id: number;
+	/** Rank within clan */
+	position: number;
+	/** Aggregated tournament contribution */
+	contribution_score: number;
+	is_me?: boolean;
+	clean_ext_user_id?: string;
+}
+
+export interface GetClanInfoResponse extends ProtocolResponse {
+	clan_info: Clan;
+	members: ClanMember[];
+	entry_fee_currency_type_id: number;
+	entry_fee_amount: number;
+	/** Cooldown until date string; null if no cooldown active */
+	cooldown_until: string | null;
+}

package/src/Clans/GetClanListRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+
+export interface GetClanListRequest extends ProtocolMessage {
+	force_language?: string;
+}

package/src/Clans/GetClanListResponse.ts

@@ -0,0 +1,10 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { Clan } from './Clan';
+
+export interface GetClanListResponse extends ProtocolResponse {
+	clans: Clan[];
+	/** The clan ID the current user belongs to; null if clanless */
+	user_clan_id: number | null;
+	/** Cooldown until date string (e.g. "29/03/2026 10:00:00"); null if no cooldown */
+	cooldown_until: string | null;
+}

package/src/Clans/JoinClanRequest.ts

@@ -0,0 +1,6 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+
+export interface JoinClanRequest extends ProtocolMessage {
+	clan_id: number;
+	join_source_id: number;
+}

package/src/Clans/JoinClanResponse.ts

@@ -0,0 +1,6 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+
+export interface JoinClanResponse extends ProtocolResponse {
+	errCode?: number;
+	errMsg?: string;
+}

package/src/Clans/index.ts

@@ -0,0 +1,7 @@
+export * from './Clan';
+export * from './GetClanListRequest';
+export * from './GetClanListResponse';
+export * from './GetClanInfoRequest';
+export * from './GetClanInfoResponse';
+export * from './JoinClanRequest';
+export * from './JoinClanResponse';