tornapi-typescript 3.0.8 → 3.0.10

package/dist/index.d.ts

@@ -44,6 +44,9 @@ export type FactionCrimeUserOutcome = "Successful" | "Failed" | "Jailed" | "Inju
 export type FactionCrimeUserItemOutcomeEnum = "user" | "faction";
 export type FactionCrimeItemOutcomeEnum = "lost" | "used";
 export type RaceId = number;
+export type HonorId = number;
+export type MedalId = number;
+export type MeritId = number;
 export type OrganizedCrimeName = string;
 export type PropertyTypeId = number;
 export type PropertyId = number;
@@ -102,6 +105,7 @@ export interface RequestMetadataWithLinksAndTotal {
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 export type UserGenderEnum = "Male" | "Female" | "Enby";
+export type HonorRarityEnum = "Extremely Rare" | "Very Rare" | "Rare" | "Limited" | "Uncommon" | "Common" | "Very Common" | "Unknown";
 export type Parameters = string;
 export type ReviveSetting = "Everyone" | "Friends & faction" | "No one" | "Unknown";
 export type FactionWarfareTypeEnum = "ranked" | "territory" | "raid" | "chain" | "db";
@@ -112,6 +116,8 @@ export type AttackActionEnum = "attackerhosp" | "busy" | "critical hit" | "attac
 export type TornItemAmmoTypeEnum = "Standard" | "Hollow Point" | "Piercing" | "Tracer" | "Incendiary";
 export type TornItemWeaponTypeEnum = "Heavy artillery" | "Machine gun" | "Pistol" | "Rifle" | "Shotgun" | "SMG" | "Temporary" | "Clubbing" | "Piercing" | "Slashing" | "Mechanical";
 export type TornItemWeaponCategoryEnum = "Melee" | "Secondary" | "Primary" | "Temporary";
+export type MedalTypeEnum = "combat" | "commitment" | "crime" | "level" | "miscellaneous" | "networth" | "rank";
+export type HonorTypeEnum = "attacking" | "camo" | "weapons" | "education" | "crimes" | "drugs" | "jail" | "hospital" | "travel" | "gym" | "level" | "competitions" | "money" | "items" | "commitment" | "casino" | "missions" | "misc" | "default";
 export type TornItemTypeEnum = "Alcohol" | "Armor" | "Artifact" | "Book" | "Booster" | "Candy" | "Car" | "Clothing" | "Collectible" | "Drug" | "Energy Drink" | "Enhancer" | "Flower" | "Jewelry" | "Material" | "Medical" | "Other" | "Plushie" | "Special" | "Supply Pack" | "Tool" | "Unused" | "Weapon";
 export type TornItemCategory = "All" | "Alcohol" | "Armor" | "Artifact" | "Book" | "Booster" | "Candy" | "Car" | "Clothing" | "Collectible" | "Defensive" | "Drug" | "Energy Drink" | "Enhancer" | "Flower" | "Jewelry" | "Material" | "Medical" | "Melee" | "Other" | "Plushie" | "Primary" | "Secondary" | "Special" | "Supply Pack" | "Temporary" | "Tool" | "Unused" | "Weapon";
 export type TornItemArmorCoveragePartEnum = "Full Body" | "Heart" | "Stomach" | "Chest" | "Arm" | "Groin" | "Leg" | "Throat" | "Hand" | "Foot" | "Head";
@@ -472,6 +478,11 @@ export interface UserPropertyDetailsExtendedRented extends UserPropertyBasicDeta
     rental_period: number;
     rental_period_remaining: number;
     rented_by: BasicUser;
+    lease_extension: {
+        cost: number;
+        period: number;
+        created_at: number;
+    } | null;
 }
 export interface UserPropertyDetailsExtendedForRent extends UserPropertyBasicDetails {
     used_by: BasicUser[];
@@ -786,11 +797,39 @@ export interface UserListResponse {
     list: UserList[];
     _metadata: RequestMetadataWithLinks;
 }
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','log','medals','merits','messages','missions','networth','newevents','newmessages','notifications','perks','profile','refills','stocks','travel','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','icons','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','profile','refills','stocks','travel','weaponexp'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
     selections: UserSelectionName[];
 }
+export interface UserHonor {
+    id: HonorId;
+    timestamp: number;
+}
+export interface UserHonorsResponse {
+    honors: UserHonor[];
+}
+export interface UserMedal {
+    id: MedalId;
+    timestamp: number;
+}
+export interface UserMedalsResponse {
+    medals: UserMedal[];
+}
+export interface UserMeritUpgrade {
+    id: MeritId;
+    level: number;
+}
+export interface UserMerits {
+    upgrades: UserMeritUpgrade[];
+    available: number;
+    used: number;
+    medals: number;
+    honors: number;
+}
+export interface UserMeritsResponse {
+    merits: UserMerits;
+}
 export interface PersonalStatsOther {
     other: {
         activity: {
@@ -2458,6 +2497,44 @@ export type PropertySelectionName = string;
 export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
+export interface TornMerit {
+    id: MeritId;
+    name: string;
+    description: string;
+}
+export interface TornMeritsResponse {
+    merits: TornMerit[];
+}
+/** Properties 'circulation', 'equipped' & 'rarity' are only populated for honors which do not have type.id value 1. */
+export interface TornHonor {
+    id: HonorId;
+    name: string;
+    description: string;
+    type: {
+        id: number;
+        title: HonorTypeEnum;
+    };
+    circulation?: number;
+    equipped?: number;
+    rarity?: HonorRarityEnum;
+}
+export interface TornHonorsResponse {
+    honors: TornHonor[];
+}
+export interface TornMedal {
+    id: MedalId;
+    name: string;
+    description: string;
+    type: {
+        id: string;
+        title: MedalTypeEnum;
+    };
+    circulation: number;
+    rarity: HonorRarityEnum;
+}
+export interface TornMedalsResponse {
+    medals: TornMedal[];
+}
 export interface TornOrganizedCrimeResponse {
     organizedcrimes: TornOrganizedCrime[];
 }
@@ -2791,7 +2868,7 @@ export interface TornFactionTreeResponse {
     factionTree: TornFactionTree[];
 }
 /**
- * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.
+ * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','itemdetails','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.
  *  *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.
  */
 export type TornSelectionName = string;
@@ -6115,6 +6192,10 @@ export interface UserV2 extends BaseSchema {
             response: UserHofResponse;
             params: "timestamp";
         };
+        honors: {
+            response: UserHonorsResponse;
+            params: "timestamp";
+        };
         itemmarket: {
             response: UserItemMarketResponse;
             params: "offset" | "timestamp";
@@ -6135,6 +6216,14 @@ export interface UserV2 extends BaseSchema {
             response: UserLogsResponse;
             params: "log" | "cat" | "limit" | "to" | "from" | "timestamp";
         };
+        medals: {
+            response: UserMedalsResponse;
+            params: "timestamp";
+        };
+        merits: {
+            response: UserMeritsResponse;
+            params: "timestamp";
+        };
         money: {
             response: UserMoneyResponse;
             params: "timestamp";
@@ -6149,7 +6238,7 @@ export interface UserV2 extends BaseSchema {
         };
         properties: {
             response: UserPropertiesResponse;
-            params: "offset" | "limit" | "timestamp";
+            params: "filters" | "offset" | "limit" | "timestamp";
         };
         property: {
             response: UserPropertyResponse;
@@ -6341,7 +6430,7 @@ export interface ForumV2 extends BaseSchema {
         };
         posts: {
             response: ForumPostsResponse;
-            params: "offset" | "striptags" | "threadId" | "timestamp";
+            params: "striptags" | "offset" | "sort" | "from" | "to" | "threadId" | "timestamp";
         };
         thread: {
             response: ForumThreadResponse;
@@ -6483,6 +6572,10 @@ export interface TornV2 extends BaseSchema {
             response: TornFactionTreeResponse;
             params: "timestamp";
         };
+        honors: {
+            response: TornHonorsResponse;
+            params: "timestamp";
+        };
         hof: {
             response: TornHofResponse;
             params: "limit" | "offset" | "cat" | "timestamp";
@@ -6507,6 +6600,14 @@ export interface TornV2 extends BaseSchema {
             response: TornLogTypesResponse;
             params: "timestamp";
         };
+        medals: {
+            response: TornMedalsResponse;
+            params: "timestamp";
+        };
+        merits: {
+            response: TornMeritsResponse;
+            params: "timestamp";
+        };
         organizedcrimes: {
             response: TornOrganizedCrimeResponse;
             params: "timestamp";

package/dist/index.ts

@@ -4578,6 +4578,12 @@ export type FactionCrimeItemOutcomeEnum = "lost" | "used";
 
 export type RaceId = number;
 
+export type HonorId = number;
+
+export type MedalId = number;
+
+export type MeritId = number;
+
 export type OrganizedCrimeName = string;
 
 export type PropertyTypeId = number;
@@ -4674,6 +4680,16 @@ export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 
 export type UserGenderEnum = "Male" | "Female" | "Enby";
 
+export type HonorRarityEnum =
+    | "Extremely Rare"
+    | "Very Rare"
+    | "Rare"
+    | "Limited"
+    | "Uncommon"
+    | "Common"
+    | "Very Common"
+    | "Unknown";
+
 export type Parameters = string;
 
 export type ReviveSetting =
@@ -4777,6 +4793,36 @@ export type TornItemWeaponCategoryEnum =
     | "Primary"
     | "Temporary";
 
+export type MedalTypeEnum =
+    | "combat"
+    | "commitment"
+    | "crime"
+    | "level"
+    | "miscellaneous"
+    | "networth"
+    | "rank";
+
+export type HonorTypeEnum =
+    | "attacking"
+    | "camo"
+    | "weapons"
+    | "education"
+    | "crimes"
+    | "drugs"
+    | "jail"
+    | "hospital"
+    | "travel"
+    | "gym"
+    | "level"
+    | "competitions"
+    | "money"
+    | "items"
+    | "commitment"
+    | "casino"
+    | "missions"
+    | "misc"
+    | "default";
+
 export type TornItemTypeEnum =
     | "Alcohol"
     | "Armor"
@@ -5266,6 +5312,11 @@ export interface UserPropertyDetailsExtendedRented
     rental_period: number;
     rental_period_remaining: number;
     rented_by: BasicUser;
+    lease_extension: {
+        cost: number;
+        period: number;
+        created_at: number;
+    } | null;
 }
 
 export interface UserPropertyDetailsExtendedForRent
@@ -5649,13 +5700,48 @@ export interface UserListResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','log','medals','merits','messages','missions','networth','newevents','newmessages','notifications','perks','profile','refills','stocks','travel','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','icons','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','profile','refills','stocks','travel','weaponexp'. */
 export type UserSelectionName = string;
 
 export interface UserLookupResponse {
     selections: UserSelectionName[];
 }
 
+export interface UserHonor {
+    id: HonorId;
+    timestamp: number;
+}
+
+export interface UserHonorsResponse {
+    honors: UserHonor[];
+}
+
+export interface UserMedal {
+    id: MedalId;
+    timestamp: number;
+}
+
+export interface UserMedalsResponse {
+    medals: UserMedal[];
+}
+
+export interface UserMeritUpgrade {
+    id: MeritId;
+    level: number;
+}
+
+export interface UserMerits {
+    upgrades: UserMeritUpgrade[];
+    available: number;
+    used: number;
+    medals: number;
+    honors: number;
+}
+
+export interface UserMeritsResponse {
+    merits: UserMerits;
+}
+
 export interface PersonalStatsOther {
     other: {
         activity: {
@@ -7830,6 +7916,50 @@ export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
 
+export interface TornMerit {
+    id: MeritId;
+    name: string;
+    description: string;
+}
+
+export interface TornMeritsResponse {
+    merits: TornMerit[];
+}
+
+/** Properties 'circulation', 'equipped' & 'rarity' are only populated for honors which do not have type.id value 1. */
+export interface TornHonor {
+    id: HonorId;
+    name: string;
+    description: string;
+    type: {
+        id: number;
+        title: HonorTypeEnum;
+    };
+    circulation?: number;
+    equipped?: number;
+    rarity?: HonorRarityEnum;
+}
+
+export interface TornHonorsResponse {
+    honors: TornHonor[];
+}
+
+export interface TornMedal {
+    id: MedalId;
+    name: string;
+    description: string;
+    type: {
+        id: string;
+        title: MedalTypeEnum;
+    };
+    circulation: number;
+    rarity: HonorRarityEnum;
+}
+
+export interface TornMedalsResponse {
+    medals: TornMedal[];
+}
+
 export interface TornOrganizedCrimeResponse {
     organizedcrimes: TornOrganizedCrime[];
 }
@@ -8218,7 +8348,7 @@ export interface TornFactionTreeResponse {
 }
 
 /**
- * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.
+ * The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','itemdetails','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.
  *  *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.
  */
 export type TornSelectionName = string;
@@ -11614,6 +11744,10 @@ export interface UserV2 extends BaseSchema {
             response: UserHofResponse;
             params: "timestamp";
         };
+        honors: {
+            response: UserHonorsResponse;
+            params: "timestamp";
+        };
         itemmarket: {
             response: UserItemMarketResponse;
             params: "offset" | "timestamp";
@@ -11634,6 +11768,14 @@ export interface UserV2 extends BaseSchema {
             response: UserLogsResponse;
             params: "log" | "cat" | "limit" | "to" | "from" | "timestamp";
         };
+        medals: {
+            response: UserMedalsResponse;
+            params: "timestamp";
+        };
+        merits: {
+            response: UserMeritsResponse;
+            params: "timestamp";
+        };
         money: {
             response: UserMoneyResponse;
             params: "timestamp";
@@ -11648,7 +11790,7 @@ export interface UserV2 extends BaseSchema {
         };
         properties: {
             response: UserPropertiesResponse;
-            params: "offset" | "limit" | "timestamp";
+            params: "filters" | "offset" | "limit" | "timestamp";
         };
         property: {
             response: UserPropertyResponse;
@@ -11882,7 +12024,14 @@ export interface ForumV2 extends BaseSchema {
         };
         posts: {
             response: ForumPostsResponse;
-            params: "offset" | "striptags" | "threadId" | "timestamp";
+            params:
+                | "striptags"
+                | "offset"
+                | "sort"
+                | "from"
+                | "to"
+                | "threadId"
+                | "timestamp";
         };
         thread: {
             response: ForumThreadResponse;
@@ -12034,6 +12183,10 @@ export interface TornV2 extends BaseSchema {
             response: TornFactionTreeResponse;
             params: "timestamp";
         };
+        honors: {
+            response: TornHonorsResponse;
+            params: "timestamp";
+        };
         hof: {
             response: TornHofResponse;
             params: "limit" | "offset" | "cat" | "timestamp";
@@ -12058,6 +12211,14 @@ export interface TornV2 extends BaseSchema {
             response: TornLogTypesResponse;
             params: "timestamp";
         };
+        medals: {
+            response: TornMedalsResponse;
+            params: "timestamp";
+        };
+        merits: {
+            response: TornMeritsResponse;
+            params: "timestamp";
+        };
         organizedcrimes: {
             response: TornOrganizedCrimeResponse;
             params: "timestamp";