tornapi-typescript 6.12.0 → 6.13.1

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 TornItemStatTitleEnum = "Damage" | "Rounds fired" | "Hits" | "Misses" | "Damage taken" | "Reloads" | "Highest damage" | "Hits received" | "Most damage taken" | "Damage mitigated" | "Most damage mitigated" | "Finishing hits" | "Critical hits" | "First owner" | "First faction owner" | "Time created" | "Respect earned";
 export type FactionArmoryCategoryEnum = "weapons" | "armor" | "temporary" | "medical" | "consumables" | "drugs" | "boosters" | "utilities" | "loot";
 export type MissionDifficultyEnum = "Very easy" | "Easy" | "Medium" | "Hard" | "Very hard" | "Expert";
 export type MissionStatusEnum = "Accepted" | "Available" | "Failed" | "Completed";
@@ -80,6 +81,7 @@ export type RaceTrackId = number;
 export type RaceCarId = number;
 export type RaceCarUpgradeId = number;
 export type ItemId = number;
+export type ItemStatId = number;
 export type AuctionListingId = number;
 export type ItemModId = number;
 export type CityShopId = number;
@@ -207,7 +209,7 @@ export interface Attack {
     result: FactionAttackResult;
     respect_gain: number;
     respect_loss: number;
-    chain: number;
+    chain: number | null;
     /** This is an experimental flag which should help determine 'assist' attacks which have not contributed to the chain. For example, attacks such as where the opponent lost to someoene else before the attacker could finish the attack. This flag might not work entirely correctly, so use with caution. */
     is_interrupted: boolean;
     is_stealthed: boolean;
@@ -519,7 +521,11 @@ export interface ErrorFileDoesNotExist {
     code: 30;
     error: string;
 }
-export type ApiError = ErrorUnknown | ErrorKeyEmpty | ErrorIncorrectKey | ErrorWrongType | ErrorWrongFields | ErrorTooManyRequests | ErrorIncorrectId | ErrorIncorrectIdEntityRelation | ErrorIpBlocked | ErrorApiDisabled | ErrorKeyOwnerInFederalJail | ErrorKeyChangeCooldown | ErrorKeyReadError | ErrorKeyTemporaryDisabled | ErrorDailyReadLimitReached | ErrorLogUnavailable | ErrorAccessLevelTooLow | ErrorBackendError | ErrorApiKeyPaused | ErrorMustMigrateToCrimesV2 | ErrorRaceNotFinished | ErrorIncorrectCategory | ErrorOnlyAvailableInApiV1 | ErrorOnlyAvailableInApiV2 | ErrorClosedTemporarily | ErrorInvalidStatRequested | ErrorOnlyCategoryOrStatsAllowed | ErrorMustMigrateToOrganizedCrimesV2 | ErrorIncorrectLogId | ErrorCategorySelectionUnavailableForInteractionLogs | ErrorFileDoesNotExist;
+export interface ErrorCityStatsCronFailed {
+    code: 31;
+    error: string;
+}
+export type ApiError = ErrorUnknown | ErrorKeyEmpty | ErrorIncorrectKey | ErrorWrongType | ErrorWrongFields | ErrorTooManyRequests | ErrorIncorrectId | ErrorIncorrectIdEntityRelation | ErrorIpBlocked | ErrorApiDisabled | ErrorKeyOwnerInFederalJail | ErrorKeyChangeCooldown | ErrorKeyReadError | ErrorKeyTemporaryDisabled | ErrorDailyReadLimitReached | ErrorLogUnavailable | ErrorAccessLevelTooLow | ErrorBackendError | ErrorApiKeyPaused | ErrorMustMigrateToCrimesV2 | ErrorRaceNotFinished | ErrorIncorrectCategory | ErrorOnlyAvailableInApiV1 | ErrorOnlyAvailableInApiV2 | ErrorClosedTemporarily | ErrorInvalidStatRequested | ErrorOnlyCategoryOrStatsAllowed | ErrorMustMigrateToOrganizedCrimesV2 | ErrorIncorrectLogId | ErrorCategorySelectionUnavailableForInteractionLogs | ErrorFileDoesNotExist | ErrorCityStatsCronFailed;
 export interface UserGymResponse {
     gym: {
         id: GymId;
@@ -2103,6 +2109,7 @@ export interface FactionInventoryItem {
     name: string;
     type: MarketSpecializedBazaarCategoryEnum;
     amount: number;
+    /** Returns up to 250 uids. */
     uids: ItemUid[];
     loaned: {
         id: UserId;
@@ -3429,6 +3436,151 @@ export type PropertySelectionName = string;
 export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
+export interface TornItemStat {
+    id: ItemStatId;
+    title: string;
+    value: number;
+}
+export interface TornItemStats {
+    id: ItemId;
+    uid: ItemUid;
+    name: TornItemStatTitleEnum;
+    type: TornItemTypeEnum;
+    sub_type: TornItemWeaponTypeEnum | null;
+    stats: TornItemStat[];
+}
+export interface TornItemStatsResponse {
+    itemdetails: TornItemStats[];
+}
+export interface TornRockPaperScissorsResponse {
+    rockpaperscissors: {
+        type: "rock" | "paper" | "scissors";
+        count: number;
+    }[];
+}
+export interface TornCityStatsResponse {
+    stats: {
+        users: {
+            total: number;
+            male: number;
+            female: number;
+            enby: number;
+            married: number;
+        };
+        items: {
+            found_in_city: number;
+            found_in_dump: number;
+            trashed: number;
+            total: number;
+        };
+        trading: {
+            sold_on_market: number;
+            sold_in_bazaar: number;
+            sold_points: number;
+            bazaar_profit: number;
+            auctions: number;
+            trades: number;
+            items_sent: number;
+        };
+        currency: {
+            money_on_hand: number;
+            money_on_hand_average: number;
+            money_in_bank: number;
+            points_total: number;
+            points_players: number;
+            points_factions: number;
+            points_market: number;
+            points_used: number;
+        };
+        attacking: {
+            attacks_won: number;
+            attacks_lost: number;
+            attacks_stalemated: number;
+            attacks_stealthed: number;
+            escapes: number;
+            hits: number;
+            misses: number;
+            critical_hits: number;
+            rounds_fired: number;
+            money_mugged: number;
+            respect_gained: number;
+        };
+        jobs: {
+            army: number;
+            grocer: number;
+            casino: number;
+            education: number;
+            medical: number;
+            law: number;
+            company: number;
+            unemployed: number;
+        };
+        jail: {
+            jailings: number;
+            busts: number;
+            busts_failed: number;
+            bails: number;
+            bails_spent: number;
+        };
+        hospital: {
+            trips: number;
+            medical_items_used: number;
+            revives: number;
+        };
+        drugs: {
+            total_used: number;
+            overdoses: number;
+            cannabis: number;
+            ecstasy: number;
+            ketamine: number;
+            lsd: number;
+            opium: number;
+            shrooms: number;
+            speed: number;
+            pcp: number;
+            xanax: number;
+            vicodin: number;
+        };
+        traveling: {
+            items_bought_abroad: number;
+            total_trips: number;
+            argentina: number;
+            mexico: number;
+            united_arab_emirates: number;
+            hawaii: number;
+            japan: number;
+            united_kingdom: number;
+            south_africa: number;
+            switzerland: number;
+            china: number;
+            cayman_islands: number;
+        };
+        bounties: {
+            placed: number;
+            money_spent: number;
+        };
+        crimes: {
+            total: number;
+            jail_sentences: number;
+        };
+        communication: {
+            total_messages: number;
+            friends: number;
+            coworkers: number;
+            spouses: number;
+            classified_ads_placed: number;
+            personals_placed: number;
+        };
+        other: {
+            logins: number;
+            years_played: number;
+            merits_bought: number;
+            energy_refills: number;
+            company_trains: number;
+            stat_enhancers_used: number;
+        };
+    };
+}
 export interface TornPokerTable {
     id: PokerTableId;
     name: string;
@@ -4053,7 +4205,7 @@ export interface TornFactionTreeResponse {
     factionTree: TornFactionTree[];
 }
 /**
- * The following selections will fallback to API v1 and may change at any time:'competition','itemstats','organisedcrimes','rockpaperscissors','stats'.
+ * The following selections will fallback to API v1 and may change at any time:'competition','organisedcrimes'.
  *  *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars', 'pawnshop'.
  */
 export type TornSelectionName = string;
@@ -8033,6 +8185,10 @@ export interface TornV2 extends BaseSchema {
             response: TornItemModsResponse;
             params: "timestamp";
         };
+        itemstats: {
+            response: TornItemStatsResponse;
+            params: "ids" | "timestamp";
+        };
         items: {
             response: TornItemsResponse;
             params: "cat" | "sort" | "timestamp";
@@ -8069,6 +8225,10 @@ export interface TornV2 extends BaseSchema {
             response: TornProperties;
             params: "timestamp";
         };
+        rockpaperscissors: {
+            response: TornRockPaperScissorsResponse;
+            params: "timestamp";
+        };
         searchforcash: {
             response: TornSearchForCashResponse;
             params: "timestamp";
@@ -8077,6 +8237,10 @@ export interface TornV2 extends BaseSchema {
             response: TornShopliftingResponse;
             params: "timestamp";
         };
+        stats: {
+            response: TornCityStatsResponse;
+            params: "timestamp";
+        };
         stocks: {
             response: TornStocksResponse;
             params: "timestamp";

package/dist/index.ts

@@ -9,6 +9,25 @@
 
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 
+export type TornItemStatTitleEnum =
+    | "Damage"
+    | "Rounds fired"
+    | "Hits"
+    | "Misses"
+    | "Damage taken"
+    | "Reloads"
+    | "Highest damage"
+    | "Hits received"
+    | "Most damage taken"
+    | "Damage mitigated"
+    | "Most damage mitigated"
+    | "Finishing hits"
+    | "Critical hits"
+    | "First owner"
+    | "First faction owner"
+    | "Time created"
+    | "Respect earned";
+
 export type FactionArmoryCategoryEnum =
     | "weapons"
     | "armor"
@@ -4739,6 +4758,8 @@ export type RaceCarUpgradeId = number;
 
 export type ItemId = number;
 
+export type ItemStatId = number;
+
 export type AuctionListingId = number;
 
 export type ItemModId = number;
@@ -5165,7 +5186,7 @@ export interface Attack {
     result: FactionAttackResult;
     respect_gain: number;
     respect_loss: number;
-    chain: number;
+    chain: number | null;
     /** This is an experimental flag which should help determine 'assist' attacks which have not contributed to the chain. For example, attacks such as where the opponent lost to someoene else before the attacker could finish the attack. This flag might not work entirely correctly, so use with caution. */
     is_interrupted: boolean;
     is_stealthed: boolean;
@@ -5547,6 +5568,11 @@ export interface ErrorFileDoesNotExist {
     error: string;
 }
 
+export interface ErrorCityStatsCronFailed {
+    code: 31;
+    error: string;
+}
+
 export type ApiError =
     | ErrorUnknown
     | ErrorKeyEmpty
@@ -5578,7 +5604,8 @@ export type ApiError =
     | ErrorMustMigrateToOrganizedCrimesV2
     | ErrorIncorrectLogId
     | ErrorCategorySelectionUnavailableForInteractionLogs
-    | ErrorFileDoesNotExist;
+    | ErrorFileDoesNotExist
+    | ErrorCityStatsCronFailed;
 
 export interface UserGymResponse {
     gym: {
@@ -7690,6 +7717,7 @@ export interface FactionInventoryItem {
     name: string;
     type: MarketSpecializedBazaarCategoryEnum;
     amount: number;
+    /** Returns up to 250 uids. */
     uids: ItemUid[];
     loaned: {
         id: UserId;
@@ -9229,6 +9257,156 @@ export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
 
+export interface TornItemStat {
+    id: ItemStatId;
+    title: string;
+    value: number;
+}
+
+export interface TornItemStats {
+    id: ItemId;
+    uid: ItemUid;
+    name: TornItemStatTitleEnum;
+    type: TornItemTypeEnum;
+    sub_type: TornItemWeaponTypeEnum | null;
+    stats: TornItemStat[];
+}
+
+export interface TornItemStatsResponse {
+    itemdetails: TornItemStats[];
+}
+
+export interface TornRockPaperScissorsResponse {
+    rockpaperscissors: {
+        type: "rock" | "paper" | "scissors";
+        count: number;
+    }[];
+}
+
+export interface TornCityStatsResponse {
+    stats: {
+        users: {
+            total: number;
+            male: number;
+            female: number;
+            enby: number;
+            married: number;
+        };
+        items: {
+            found_in_city: number;
+            found_in_dump: number;
+            trashed: number;
+            total: number;
+        };
+        trading: {
+            sold_on_market: number;
+            sold_in_bazaar: number;
+            sold_points: number;
+            bazaar_profit: number;
+            auctions: number;
+            trades: number;
+            items_sent: number;
+        };
+        currency: {
+            money_on_hand: number;
+            money_on_hand_average: number;
+            money_in_bank: number;
+            points_total: number;
+            points_players: number;
+            points_factions: number;
+            points_market: number;
+            points_used: number;
+        };
+        attacking: {
+            attacks_won: number;
+            attacks_lost: number;
+            attacks_stalemated: number;
+            attacks_stealthed: number;
+            escapes: number;
+            hits: number;
+            misses: number;
+            critical_hits: number;
+            rounds_fired: number;
+            money_mugged: number;
+            respect_gained: number;
+        };
+        jobs: {
+            army: number;
+            grocer: number;
+            casino: number;
+            education: number;
+            medical: number;
+            law: number;
+            company: number;
+            unemployed: number;
+        };
+        jail: {
+            jailings: number;
+            busts: number;
+            busts_failed: number;
+            bails: number;
+            bails_spent: number;
+        };
+        hospital: {
+            trips: number;
+            medical_items_used: number;
+            revives: number;
+        };
+        drugs: {
+            total_used: number;
+            overdoses: number;
+            cannabis: number;
+            ecstasy: number;
+            ketamine: number;
+            lsd: number;
+            opium: number;
+            shrooms: number;
+            speed: number;
+            pcp: number;
+            xanax: number;
+            vicodin: number;
+        };
+        traveling: {
+            items_bought_abroad: number;
+            total_trips: number;
+            argentina: number;
+            mexico: number;
+            united_arab_emirates: number;
+            hawaii: number;
+            japan: number;
+            united_kingdom: number;
+            south_africa: number;
+            switzerland: number;
+            china: number;
+            cayman_islands: number;
+        };
+        bounties: {
+            placed: number;
+            money_spent: number;
+        };
+        crimes: {
+            total: number;
+            jail_sentences: number;
+        };
+        communication: {
+            total_messages: number;
+            friends: number;
+            coworkers: number;
+            spouses: number;
+            classified_ads_placed: number;
+            personals_placed: number;
+        };
+        other: {
+            logins: number;
+            years_played: number;
+            merits_bought: number;
+            energy_refills: number;
+            company_trains: number;
+            stat_enhancers_used: number;
+        };
+    };
+}
+
 export interface TornPokerTable {
     id: PokerTableId;
     name: string;
@@ -9952,7 +10130,7 @@ export interface TornFactionTreeResponse {
 }
 
 /**
- * The following selections will fallback to API v1 and may change at any time:'competition','itemstats','organisedcrimes','rockpaperscissors','stats'.
+ * The following selections will fallback to API v1 and may change at any time:'competition','organisedcrimes'.
  *  *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars', 'pawnshop'.
  */
 export type TornSelectionName = string;
@@ -14075,6 +14253,10 @@ export interface TornV2 extends BaseSchema {
             response: TornItemModsResponse;
             params: "timestamp";
         };
+        itemstats: {
+            response: TornItemStatsResponse;
+            params: "ids" | "timestamp";
+        };
         items: {
             response: TornItemsResponse;
             params: "cat" | "sort" | "timestamp";
@@ -14111,6 +14293,10 @@ export interface TornV2 extends BaseSchema {
             response: TornProperties;
             params: "timestamp";
         };
+        rockpaperscissors: {
+            response: TornRockPaperScissorsResponse;
+            params: "timestamp";
+        };
         searchforcash: {
             response: TornSearchForCashResponse;
             params: "timestamp";
@@ -14119,6 +14305,10 @@ export interface TornV2 extends BaseSchema {
             response: TornShopliftingResponse;
             params: "timestamp";
         };
+        stats: {
+            response: TornCityStatsResponse;
+            params: "timestamp";
+        };
         stocks: {
             response: TornStocksResponse;
             params: "timestamp";