tornapi-typescript 3.0.11 → 3.0.12

package/dist/index.d.ts

@@ -5,6 +5,12 @@
  *  - {@link https://github.com/grantila/typeconv}
  */
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
+export type JobTypeEnum = "Army" | "Casino" | "Education" | "Grocer" | "Law" | "Medical";
+export type UserMaritalStatusEnum = "Engaged" | "Newlywed" | "Married";
+export type UserRoleEnum = "Admin" | "Officer" | "Moderator" | "Helper" | "Tester" | "NPC" | "Committee" | "Reporter" | "Wiki Contributor" | "Wiki Editor" | "Civilian";
+export type UserTitleEnum = "Alcoholic" | "Sharpshooter" | "Accomplice" | "Loser" | "Silent Killer" | "Killer" | "Merchant" | "Medalist" | "Tycoon" | "Damage Dealer" | "Slayer" | "Hired Gun" | "Egotist" | "Outcast" | "Punchbag" | "Tank" | "Antagonist" | "Druggy" | "Scavenger" | "Boxer" | "Importer" | "Looter" | "Samaritan" | "Felon" | "Socialite" | "Mercenary" | "Investor" | "Thief" | "One Hit Killer" | "Mobster" | "Addict" | "Bonds Agent" | "Buster" | "Hoarder" | "Racer" | "Soldier" | "Avenger" | "Healer" | "Booster" | "Intimidator" | "Trader" | "Jobsworth" | "Tourist" | "Nudist" | "Sage" | "Coward";
+export type UserRankEnum = "Absolute beginner" | "Beginner" | "Inexperienced" | "Rookie" | "Novice" | "Below average" | "Average" | "Reasonable" | "Above average" | "Competent" | "Highly competent" | "Veteran" | "Distinguished" | "Highly distinguished" | "Professional" | "Star" | "Master" | "Outstanding" | "Celebrity" | "Supreme" | "Idolized" | "Champion" | "Heroic" | "Legendary" | "Elite" | "Invincible";
+export type UserRpsStatus = "scissors" | "rock" | "paper";
 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";
@@ -62,6 +68,7 @@ export type TerritoryWarId = number;
 export type RaidWarId = number;
 export type ItemUid = number;
 export type UserId = number;
+export type UserIconId = number;
 export type ReviveId = number;
 export type LogId = number;
 export type UserLogId = string;
@@ -338,6 +345,108 @@ export interface ReportsResponse {
     _metadata: RequestMetadataWithLinks;
 }
 export type SelectionCategoryEnum = ReportTypeEnum | UserListEnum | PersonalStatsCategoryEnum | RacingRaceTypeEnum;
+export interface UserIconPublic {
+    id: UserIconId;
+    title: string;
+    description: string;
+}
+export interface UserIconPrivate extends UserIconPublic {
+    until: number | null;
+}
+export interface UserIconsResponse {
+    icons: UserIconPrivate[] | UserIconPublic[];
+}
+export interface UserCompetitionHalloween {
+    name: "Halloween";
+    treats_collected: number;
+    basket: {
+        id: ItemId;
+        name: string;
+    };
+}
+export interface UserCompetitionEasterEggs {
+    name: "Easter Egg Hunt";
+    score: number;
+    total: number;
+}
+export interface UserCompetitionRps {
+    name: "Rock, Paper, Scissors";
+    status: UserRpsStatus;
+    hp: {
+        current: number;
+        maximum: number;
+    };
+}
+export interface UserCompetitionResponse {
+    competition: UserCompetitionHalloween | UserCompetitionEasterEggs | UserCompetitionRps;
+}
+export interface UserFaction {
+    id: FactionId;
+    name: string;
+    tag: string;
+    tag_image: string;
+    position: string;
+    days_in_faction: number;
+}
+export interface UserFactionResponse {
+    faction: UserFaction | null;
+}
+export interface UserJob {
+    type: "job";
+    name: JobTypeEnum;
+    position: JobPositionArmyEnum | JobPositionGrocerEnum | JobPositionCasinoEnum | JobPositionMedicalEnum | JobPositionLawEnum | JobPositionEducationEnum;
+}
+export interface UserCompany {
+    type: "company";
+    id: CompanyId;
+    type_id: CompanyTypeId;
+    name: string;
+    position: string;
+    days_in_company: number;
+}
+export interface UserJobResponse {
+    job: UserJob | UserCompany | null;
+}
+export interface ProfileSpouse {
+    id: UserId;
+    name: string;
+    status: UserMaritalStatusEnum;
+    days_married: number;
+}
+export interface UserProfileResponse {
+    profile: {
+        id: UserId;
+        name: string;
+        level: number;
+        rank: UserRankEnum;
+        title: UserTitleEnum;
+        /** Age in days. */
+        age: number;
+        signed_up: number;
+        faction_id: FactionId | null;
+        honor_id: HonorId;
+        property: {
+            id: PropertyId;
+            name: string;
+        };
+        image: string | null;
+        gender: UserGenderEnum;
+        revivable: boolean;
+        role: UserRoleEnum;
+        status: UserStatus;
+        spouse: ProfileSpouse | null;
+        awards: number;
+        friends: number;
+        enemies: number;
+        forum_posts: number;
+        karma: number;
+        last_action: UserLastAction;
+        life: {
+            current: number;
+            maximum: number;
+        };
+    };
+}
 export interface UserMoneyResponse {
     money: {
         points: number;
@@ -797,7 +906,7 @@ 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','icons','inventory','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','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','refills','stocks','travel','weaponexp'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
     selections: UserSelectionName[];
@@ -1703,6 +1812,8 @@ export interface UserStatus {
     details: string | null;
     state: string;
     until: number | null;
+    /** This field is populated only if the state is 'Traveling'. */
+    travel_type?: string;
 }
 export interface FactionMembersResponse {
     members: FactionMember[];
@@ -2667,7 +2778,7 @@ export interface TornHofBasic {
     faction_id: FactionId;
     level: number;
     last_action: number;
-    rank_name: string;
+    rank_name: UserRankEnum;
     rank_number: number;
     position: number;
     signed_up: number;
@@ -6152,6 +6263,10 @@ export interface UserV2 extends BaseSchema {
             response: UserCalendarResponse;
             params: "timestamp";
         };
+        competition: {
+            response: UserCompetitionResponse;
+            params: "timestamp";
+        };
         crimes: {
             response: UserCrimesResponse;
             params: "crimeId" | "timestamp";
@@ -6164,6 +6279,10 @@ export interface UserV2 extends BaseSchema {
             response: UserEnlistedCarsResponse;
             params: "timestamp";
         };
+        faction: {
+            response: UserFactionResponse;
+            params: "timestamp";
+        };
         factionbalance: {
             response: UserFactionBalanceResponse;
             params: "timestamp";
@@ -6196,10 +6315,18 @@ export interface UserV2 extends BaseSchema {
             response: UserHonorsResponse;
             params: "timestamp";
         };
+        icons: {
+            response: UserIconsResponse;
+            params: "timestamp";
+        };
         itemmarket: {
             response: UserItemMarketResponse;
             params: "offset" | "timestamp";
         };
+        job: {
+            response: UserJobResponse;
+            params: "timestamp";
+        };
         jobpoints: {
             response: UserJobPointsResponse;
             params: "timestamp";
@@ -6236,6 +6363,10 @@ export interface UserV2 extends BaseSchema {
             response: UserPersonalStatsResponse;
             params: "cat" | "stat" | "timestamp";
         };
+        profile: {
+            response: UserProfileResponse;
+            params: "striptags" | "timestamp";
+        };
         properties: {
             response: UserPropertiesResponse;
             params: "filters" | "offset" | "limit" | "timestamp";

package/dist/index.ts

@@ -9,6 +9,107 @@
 
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 
+export type JobTypeEnum =
+    | "Army"
+    | "Casino"
+    | "Education"
+    | "Grocer"
+    | "Law"
+    | "Medical";
+
+export type UserMaritalStatusEnum = "Engaged" | "Newlywed" | "Married";
+
+export type UserRoleEnum =
+    | "Admin"
+    | "Officer"
+    | "Moderator"
+    | "Helper"
+    | "Tester"
+    | "NPC"
+    | "Committee"
+    | "Reporter"
+    | "Wiki Contributor"
+    | "Wiki Editor"
+    | "Civilian";
+
+export type UserTitleEnum =
+    | "Alcoholic"
+    | "Sharpshooter"
+    | "Accomplice"
+    | "Loser"
+    | "Silent Killer"
+    | "Killer"
+    | "Merchant"
+    | "Medalist"
+    | "Tycoon"
+    | "Damage Dealer"
+    | "Slayer"
+    | "Hired Gun"
+    | "Egotist"
+    | "Outcast"
+    | "Punchbag"
+    | "Tank"
+    | "Antagonist"
+    | "Druggy"
+    | "Scavenger"
+    | "Boxer"
+    | "Importer"
+    | "Looter"
+    | "Samaritan"
+    | "Felon"
+    | "Socialite"
+    | "Mercenary"
+    | "Investor"
+    | "Thief"
+    | "One Hit Killer"
+    | "Mobster"
+    | "Addict"
+    | "Bonds Agent"
+    | "Buster"
+    | "Hoarder"
+    | "Racer"
+    | "Soldier"
+    | "Avenger"
+    | "Healer"
+    | "Booster"
+    | "Intimidator"
+    | "Trader"
+    | "Jobsworth"
+    | "Tourist"
+    | "Nudist"
+    | "Sage"
+    | "Coward";
+
+export type UserRankEnum =
+    | "Absolute beginner"
+    | "Beginner"
+    | "Inexperienced"
+    | "Rookie"
+    | "Novice"
+    | "Below average"
+    | "Average"
+    | "Reasonable"
+    | "Above average"
+    | "Competent"
+    | "Highly competent"
+    | "Veteran"
+    | "Distinguished"
+    | "Highly distinguished"
+    | "Professional"
+    | "Star"
+    | "Master"
+    | "Outstanding"
+    | "Celebrity"
+    | "Supreme"
+    | "Idolized"
+    | "Champion"
+    | "Heroic"
+    | "Legendary"
+    | "Elite"
+    | "Invincible";
+
+export type UserRpsStatus = "scissors" | "rock" | "paper";
+
 export type UserSkillSlugEnum =
     | "hunting"
     | "racing"
@@ -4614,6 +4715,8 @@ export type ItemUid = number;
 
 export type UserId = number;
 
+export type UserIconId = number;
+
 export type ReviveId = number;
 
 export type LogId = number;
@@ -5152,6 +5255,131 @@ export type SelectionCategoryEnum =
     | PersonalStatsCategoryEnum
     | RacingRaceTypeEnum;
 
+export interface UserIconPublic {
+    id: UserIconId;
+    title: string;
+    description: string;
+}
+
+export interface UserIconPrivate extends UserIconPublic {
+    until: number | null;
+}
+
+export interface UserIconsResponse {
+    icons: UserIconPrivate[] | UserIconPublic[];
+}
+
+export interface UserCompetitionHalloween {
+    name: "Halloween";
+    treats_collected: number;
+    basket: {
+        id: ItemId;
+        name: string;
+    };
+}
+
+export interface UserCompetitionEasterEggs {
+    name: "Easter Egg Hunt";
+    score: number;
+    total: number;
+}
+
+export interface UserCompetitionRps {
+    name: "Rock, Paper, Scissors";
+    status: UserRpsStatus;
+    hp: {
+        current: number;
+        maximum: number;
+    };
+}
+
+export interface UserCompetitionResponse {
+    competition:
+        | UserCompetitionHalloween
+        | UserCompetitionEasterEggs
+        | UserCompetitionRps;
+}
+
+export interface UserFaction {
+    id: FactionId;
+    name: string;
+    tag: string;
+    tag_image: string;
+    position: string;
+    days_in_faction: number;
+}
+
+export interface UserFactionResponse {
+    faction: UserFaction | null;
+}
+
+export interface UserJob {
+    type: "job";
+    name: JobTypeEnum;
+    position:
+        | JobPositionArmyEnum
+        | JobPositionGrocerEnum
+        | JobPositionCasinoEnum
+        | JobPositionMedicalEnum
+        | JobPositionLawEnum
+        | JobPositionEducationEnum;
+}
+
+export interface UserCompany {
+    type: "company";
+    id: CompanyId;
+    type_id: CompanyTypeId;
+    name: string;
+    position: string;
+    days_in_company: number;
+}
+
+export interface UserJobResponse {
+    job: UserJob | UserCompany | null;
+}
+
+export interface ProfileSpouse {
+    id: UserId;
+    name: string;
+    status: UserMaritalStatusEnum;
+    days_married: number;
+}
+
+export interface UserProfileResponse {
+    profile: {
+        id: UserId;
+        name: string;
+        level: number;
+        rank: UserRankEnum;
+        title: UserTitleEnum;
+        /** Age in days. */
+        age: number;
+        signed_up: number;
+        faction_id: FactionId | null;
+        honor_id: HonorId;
+        property: {
+            id: PropertyId;
+            name: string;
+        };
+        image: string | null;
+        gender: UserGenderEnum;
+        revivable: boolean;
+        role: UserRoleEnum;
+        status: UserStatus;
+        spouse: ProfileSpouse | null;
+        awards: number;
+        friends: number;
+        enemies: number;
+        forum_posts: number;
+        karma: number;
+        last_action: UserLastAction;
+        life: {
+            current: number;
+            maximum: number;
+        };
+    };
+}
+
 export interface UserMoneyResponse {
     money: {
         points: number;
@@ -5700,7 +5928,7 @@ 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','icons','inventory','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','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','refills','stocks','travel','weaponexp'. */
 export type UserSelectionName = string;
 
 export interface UserLookupResponse {
@@ -7001,6 +7229,8 @@ export interface UserStatus {
     details: string | null;
     state: string;
     until: number | null;
+    /** This field is populated only if the state is 'Traveling'. */
+    travel_type?: string;
 }
 
 export interface FactionMembersResponse {
@@ -8114,7 +8344,7 @@ export interface TornHofBasic {
     faction_id: FactionId;
     level: number;
     last_action: number;
-    rank_name: string;
+    rank_name: UserRankEnum;
     rank_number: number;
     position: number;
     signed_up: number;
@@ -11698,6 +11928,10 @@ export interface UserV2 extends BaseSchema {
             response: UserCalendarResponse;
             params: "timestamp";
         };
+        competition: {
+            response: UserCompetitionResponse;
+            params: "timestamp";
+        };
         crimes: {
             response: UserCrimesResponse;
             params: "crimeId" | "timestamp";
@@ -11710,6 +11944,10 @@ export interface UserV2 extends BaseSchema {
             response: UserEnlistedCarsResponse;
             params: "timestamp";
         };
+        faction: {
+            response: UserFactionResponse;
+            params: "timestamp";
+        };
         factionbalance: {
             response: UserFactionBalanceResponse;
             params: "timestamp";
@@ -11748,10 +11986,18 @@ export interface UserV2 extends BaseSchema {
             response: UserHonorsResponse;
             params: "timestamp";
         };
+        icons: {
+            response: UserIconsResponse;
+            params: "timestamp";
+        };
         itemmarket: {
             response: UserItemMarketResponse;
             params: "offset" | "timestamp";
         };
+        job: {
+            response: UserJobResponse;
+            params: "timestamp";
+        };
         jobpoints: {
             response: UserJobPointsResponse;
             params: "timestamp";
@@ -11788,6 +12034,10 @@ export interface UserV2 extends BaseSchema {
             response: UserPersonalStatsResponse;
             params: "cat" | "stat" | "timestamp";
         };
+        profile: {
+            response: UserProfileResponse;
+            params: "striptags" | "timestamp";
+        };
         properties: {
             response: UserPropertiesResponse;
             params: "filters" | "offset" | "limit" | "timestamp";