tornapi-typescript 3.0.6 → 3.0.9

package/dist/index.d.ts

@@ -5,6 +5,7 @@
  *  - {@link https://github.com/grantila/typeconv}
  */
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
+export type UserSkillSlugEnum = "hunting" | "racing" | "reviving" | "search_for_cash" | "bootlegging" | "graffiti" | "shoplifting" | "pickpocketing" | "card_skimming" | "burglary" | "hustling" | "disposal" | "cracking" | "forgery" | "scamming" | "arson";
 export type CountryEnum = "Mexico" | "Hawaii" | "South Africa" | "Japan" | "China" | "Argentina" | "Switzerland" | "Canada" | "United Kingdom" | "UAE" | "Cayman Islands";
 export type ReportTypeEnum = "mostwanted" | "money" | "stats" | "references" | "friendorfoe" | "companyfinancials" | "truelevel" | "stockanalysis" | "anonymousbounties" | "investment";
 export type ApiKeyAccessTypeEnum = "Custom" | "Public Only" | "Minimal Access" | "Limited Access" | "Full Access";
@@ -64,6 +65,7 @@ export type UserLogId = string;
 export type LogCategoryId = number;
 export type FactionId = number;
 export type CompanyId = number;
+export type CompanyTypeId = number;
 export type EducationId = number;
 export type FactionBranchId = number;
 export type FactionCrimeId = number;
@@ -99,6 +101,7 @@ export interface RequestMetadataWithLinksAndTotal {
  *  *                    7 = 'X quoted your post'.
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
+export type UserGenderEnum = "Male" | "Female" | "Enby";
 export type Parameters = string;
 export type ReviveSetting = "Everyone" | "Friends & faction" | "No one" | "Unknown";
 export type FactionWarfareTypeEnum = "ranked" | "territory" | "raid" | "chain" | "db";
@@ -329,6 +332,89 @@ export interface ReportsResponse {
     _metadata: RequestMetadataWithLinks;
 }
 export type SelectionCategoryEnum = ReportTypeEnum | UserListEnum | PersonalStatsCategoryEnum | RacingRaceTypeEnum;
+export interface UserMoneyResponse {
+    money: {
+        points: number;
+        wallet: number;
+        company: number;
+        vault: number;
+        cayman_bank: number;
+        city_bank: {
+            amount: number;
+            until: number;
+        };
+        faction: {
+            money: number;
+            points: number;
+        };
+        daily_networth: number;
+    };
+}
+export interface UserSkillsResponse {
+    skills: UserSkillDetail[];
+}
+export interface UserSkillDetail {
+    slug: string & (UserSkillSlugEnum | string);
+    name: string;
+    level: number;
+}
+export interface UserJobPointsResponse {
+    jobpoints: {
+        jobs: {
+            army: number;
+            casino: number;
+            education: number;
+            grocer: number;
+            law: number;
+            medical: number;
+        };
+        companies: UserCompanyPoints[];
+    };
+}
+export interface UserCompanyPoints {
+    company: {
+        id: CompanyTypeId;
+        name: string;
+    };
+    points: number;
+}
+export interface UserWorkStatsResponse {
+    workstats: {
+        endurance: number;
+        intelligence: number;
+        manual_labor: number;
+        total: number;
+    };
+}
+export interface UserBattleStatsResponse {
+    battlestats: {
+        strength: UserBattleStatDetail;
+        defense: UserBattleStatDetail;
+        speed: UserBattleStatDetail;
+        dexterity: UserBattleStatDetail;
+        total: number;
+    };
+}
+export interface UserBattleStatDetail {
+    value: number;
+    modifier: number;
+    modifiers: UserBattleStatModifierDetail[];
+}
+export interface UserBattleStatModifierDetail {
+    effect: string;
+    value: number;
+    type: string;
+}
+export interface UserBasic {
+    id: UserId;
+    name: string;
+    level: number;
+    gender: UserGenderEnum;
+    status: UserStatus;
+}
+export interface UserBasicResponse {
+    profile: UserBasic;
+}
 export interface UserLog {
     id: UserLogId;
     timestamp: number;
@@ -386,6 +472,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[];
@@ -700,7 +791,7 @@ export interface UserListResponse {
     list: UserList[];
     _metadata: RequestMetadataWithLinks;
 }
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','refills','reports','skills','stocks','travel','weaponexp','workstats'. */
+/** 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'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
     selections: UserSelectionName[];
@@ -5973,10 +6064,18 @@ export interface UserV2 extends BaseSchema {
             response: FactionAttacksFullResponse;
             params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
+        basic: {
+            response: UserBasicResponse;
+            params: "striptags" | "timestamp";
+        };
         bounties: {
             response: UserBountiesResponse;
             params: "timestamp";
         };
+        battlestats: {
+            response: UserBattleStatsResponse;
+            params: "timestamp";
+        };
         calendar: {
             response: UserCalendarResponse;
             params: "timestamp";
@@ -6025,6 +6124,10 @@ export interface UserV2 extends BaseSchema {
             response: UserItemMarketResponse;
             params: "offset" | "timestamp";
         };
+        jobpoints: {
+            response: UserJobPointsResponse;
+            params: "timestamp";
+        };
         jobranks: {
             response: UserJobRanksResponse;
             params: "timestamp";
@@ -6037,6 +6140,10 @@ export interface UserV2 extends BaseSchema {
             response: UserLogsResponse;
             params: "log" | "cat" | "limit" | "to" | "from" | "timestamp";
         };
+        money: {
+            response: UserMoneyResponse;
+            params: "timestamp";
+        };
         organizedcrime: {
             response: UserOrganizedCrimeResponse;
             params: "timestamp";
@@ -6047,7 +6154,7 @@ export interface UserV2 extends BaseSchema {
         };
         properties: {
             response: UserPropertiesResponse;
-            params: "offset" | "limit" | "timestamp";
+            params: "filters" | "offset" | "limit" | "timestamp";
         };
         property: {
             response: UserPropertyResponse;
@@ -6073,6 +6180,14 @@ export interface UserV2 extends BaseSchema {
             response: RevivesFullResponse;
             params: "filters" | "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
         };
+        skills: {
+            response: UserSkillsResponse;
+            params: "timestamp";
+        };
+        workstats: {
+            response: UserWorkStatsResponse;
+            params: "timestamp";
+        };
         lookup: {
             response: UserLookupResponse;
             params: "timestamp";
@@ -6231,7 +6346,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;

package/dist/index.ts

@@ -9,6 +9,24 @@
 
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 
+export type UserSkillSlugEnum =
+    | "hunting"
+    | "racing"
+    | "reviving"
+    | "search_for_cash"
+    | "bootlegging"
+    | "graffiti"
+    | "shoplifting"
+    | "pickpocketing"
+    | "card_skimming"
+    | "burglary"
+    | "hustling"
+    | "disposal"
+    | "cracking"
+    | "forgery"
+    | "scamming"
+    | "arson";
+
 export type CountryEnum =
     | "Mexico"
     | "Hawaii"
@@ -4602,6 +4620,8 @@ export type FactionId = number;
 
 export type CompanyId = number;
 
+export type CompanyTypeId = number;
+
 export type EducationId = number;
 
 export type FactionBranchId = number;
@@ -4652,6 +4672,8 @@ export interface RequestMetadataWithLinksAndTotal {
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 
+export type UserGenderEnum = "Male" | "Female" | "Enby";
+
 export type Parameters = string;
 
 export type ReviveSetting =
@@ -5084,6 +5106,100 @@ export type SelectionCategoryEnum =
     | PersonalStatsCategoryEnum
     | RacingRaceTypeEnum;
 
+export interface UserMoneyResponse {
+    money: {
+        points: number;
+        wallet: number;
+        company: number;
+        vault: number;
+        cayman_bank: number;
+        city_bank: {
+            amount: number;
+            until: number;
+        };
+        faction: {
+            money: number;
+            points: number;
+        };
+        daily_networth: number;
+    };
+}
+
+export interface UserSkillsResponse {
+    skills: UserSkillDetail[];
+}
+
+export interface UserSkillDetail {
+    slug: string & (UserSkillSlugEnum | string);
+    name: string;
+    level: number;
+}
+
+export interface UserJobPointsResponse {
+    jobpoints: {
+        jobs: {
+            army: number;
+            casino: number;
+            education: number;
+            grocer: number;
+            law: number;
+            medical: number;
+        };
+        companies: UserCompanyPoints[];
+    };
+}
+
+export interface UserCompanyPoints {
+    company: {
+        id: CompanyTypeId;
+        name: string;
+    };
+    points: number;
+}
+
+export interface UserWorkStatsResponse {
+    workstats: {
+        endurance: number;
+        intelligence: number;
+        manual_labor: number;
+        total: number;
+    };
+}
+
+export interface UserBattleStatsResponse {
+    battlestats: {
+        strength: UserBattleStatDetail;
+        defense: UserBattleStatDetail;
+        speed: UserBattleStatDetail;
+        dexterity: UserBattleStatDetail;
+        total: number;
+    };
+}
+
+export interface UserBattleStatDetail {
+    value: number;
+    modifier: number;
+    modifiers: UserBattleStatModifierDetail[];
+}
+
+export interface UserBattleStatModifierDetail {
+    effect: string;
+    value: number;
+    type: string;
+}
+
+export interface UserBasic {
+    id: UserId;
+    name: string;
+    level: number;
+    gender: UserGenderEnum;
+    status: UserStatus;
+}
+
+export interface UserBasicResponse {
+    profile: UserBasic;
+}
+
 export interface UserLog {
     id: UserLogId;
     timestamp: number;
@@ -5150,6 +5266,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
@@ -5533,7 +5654,7 @@ export interface UserListResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','refills','reports','skills','stocks','travel','weaponexp','workstats'. */
+/** 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'. */
 export type UserSelectionName = string;
 
 export interface UserLookupResponse {
@@ -11436,10 +11557,18 @@ export interface UserV2 extends BaseSchema {
             response: FactionAttacksFullResponse;
             params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
+        basic: {
+            response: UserBasicResponse;
+            params: "striptags" | "timestamp";
+        };
         bounties: {
             response: UserBountiesResponse;
             params: "timestamp";
         };
+        battlestats: {
+            response: UserBattleStatsResponse;
+            params: "timestamp";
+        };
         calendar: {
             response: UserCalendarResponse;
             params: "timestamp";
@@ -11494,6 +11623,10 @@ export interface UserV2 extends BaseSchema {
             response: UserItemMarketResponse;
             params: "offset" | "timestamp";
         };
+        jobpoints: {
+            response: UserJobPointsResponse;
+            params: "timestamp";
+        };
         jobranks: {
             response: UserJobRanksResponse;
             params: "timestamp";
@@ -11506,6 +11639,10 @@ export interface UserV2 extends BaseSchema {
             response: UserLogsResponse;
             params: "log" | "cat" | "limit" | "to" | "from" | "timestamp";
         };
+        money: {
+            response: UserMoneyResponse;
+            params: "timestamp";
+        };
         organizedcrime: {
             response: UserOrganizedCrimeResponse;
             params: "timestamp";
@@ -11516,7 +11653,7 @@ export interface UserV2 extends BaseSchema {
         };
         properties: {
             response: UserPropertiesResponse;
-            params: "offset" | "limit" | "timestamp";
+            params: "filters" | "offset" | "limit" | "timestamp";
         };
         property: {
             response: UserPropertyResponse;
@@ -11556,6 +11693,14 @@ export interface UserV2 extends BaseSchema {
                 | "striptags"
                 | "timestamp";
         };
+        skills: {
+            response: UserSkillsResponse;
+            params: "timestamp";
+        };
+        workstats: {
+            response: UserWorkStatsResponse;
+            params: "timestamp";
+        };
         lookup: {
             response: UserLookupResponse;
             params: "timestamp";
@@ -11742,7 +11887,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;