tornapi-typescript 6.11.1 → 6.12.0

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 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";
 export type MissionRewardUpgrade = "Item" | "Ammo" | "Upgrade";
@@ -2094,6 +2095,25 @@ export interface UserPersonalStatsFullPublic {
 export type UserPersonalStatsResponse = UserPersonalStatsFull | UserPersonalStatsFullPublic | UserPersonalStatsPopular | UserPersonalStatsCategory | UserPersonalStatsHistoric;
 export type PersonalStatsCategoryEnum = "all" | "popular" | "attacking" | "battle_stats" | "jobs" | "trading" | "jail" | "hospital" | "finishing_hits" | "communication" | "crimes" | "bounties" | "investments" | "items" | "travel" | "drugs" | "missions" | "racing" | "networth" | "other" | "itemmarketcustomers" | "itemmarketsales" | "itemmarketrevenue" | "itemmarketfees";
 export type PersonalStatsStatName = "attackswon" | "attackslost" | "attacksdraw" | "attacksassisted" | "defendswon" | "defendslost" | "defendsstalemated" | "elo" | "yourunaway" | "theyrunaway" | "unarmoredwon" | "bestkillstreak" | "attackhits" | "attackmisses" | "attackdamage" | "bestdamage" | "onehitkills" | "attackcriticalhits" | "roundsfired" | "specialammoused" | "hollowammoused" | "tracerammoused" | "piercingammoused" | "incendiaryammoused" | "attacksstealthed" | "retals" | "moneymugged" | "largestmug" | "itemslooted" | "highestbeaten" | "respectforfaction" | "rankedwarhits" | "raidhits" | "territoryjoins" | "territoryclears" | "territorytime" | "jobpointsused" | "trainsreceived" | "marketitemsbought" | "auctionswon" | "auctionsells" | "itemssent" | "trades" | "cityitemsbought" | "pointsbought" | "pointssold" | "bazaarcustomers" | "bazaarsales" | "bazaarprofit" | "jailed" | "peoplebusted" | "failedbusts" | "peoplebought" | "peopleboughtspent" | "hospital" | "medicalitemsused" | "bloodwithdrawn" | "reviveskill" | "revives" | "revivesreceived" | "heavyhits" | "machinehits" | "riflehits" | "smghits" | "shotgunhits" | "pistolhits" | "temphits" | "piercinghits" | "slashinghits" | "clubbinghits" | "mechanicalhits" | "h2hhits" | "mailssent" | "friendmailssent" | "factionmailssent" | "companymailssent" | "spousemailssent" | "classifiedadsplaced" | "personalsplaced" | "criminaloffensesold" | "sellillegalgoods" | "theftold" | "autotheftcrime" | "drugdealscrime" | "computercrime" | "fraudold" | "murdercrime" | "othercrime" | "organizedcrimes" | "bountiesplaced" | "totalbountyspent" | "bountiescollected" | "totalbountyreward" | "bountiesreceived" | "receivedbountyvalue" | "cityfinds" | "dumpfinds" | "itemsdumped" | "booksread" | "boostersused" | "consumablesused" | "candyused" | "alcoholused" | "energydrinkused" | "statenhancersused" | "eastereggsfound" | "eastereggsused" | "virusescoded" | "traveltimes" | "timespenttraveling" | "itemsboughtabroad" | "attackswonabroad" | "defendslostabroad" | "argtravel" | "mextravel" | "uaetravel" | "hawtravel" | "japtravel" | "uktravel" | "satravel" | "switravel" | "chitravel" | "cantravel" | "caytravel" | "drugsused" | "overdosed" | "rehabs" | "rehabcost" | "cantaken" | "exttaken" | "kettaken" | "lsdtaken" | "opitaken" | "pcptaken" | "shrtaken" | "spetaken" | "victaken" | "xantaken" | "missionscompleted" | "contractscompleted" | "dukecontractscompleted" | "missioncreditsearned" | "racingskill" | "racingpointsearned" | "racesentered" | "raceswon" | "networth" | "timeplayed" | "activestreak" | "bestactivestreak" | "awards" | "refills" | "nerverefills" | "tokenrefills" | "meritsbought" | "daysbeendonator" | "criminaloffenses" | "vandalism" | "theft" | "counterfeiting" | "fraud" | "illicitservices" | "cybercrime" | "extortion" | "illegalproduction" | "currentkillstreak" | "strength" | "defense" | "speed" | "dexterity" | "totalstats" | "manuallabor" | "intelligence" | "endurance" | "totalworkingstats" | "moneyinvested" | "investedprofit" | "investamount" | "banktimeleft" | "stockprofits" | "stocklosses" | "stockfees" | "stocknetprofits" | "stockpayouts" | "networthwallet" | "networthvault" | "networthbank" | "networthcayman" | "networthpoints" | "networthitems" | "networthdisplaycase" | "networthbazaar" | "networthitemmarket" | "networthproperties" | "networthstockmarket" | "networthauctionhouse" | "networthbookie" | "networthcompany" | "networthenlistedcars" | "networthpiggybank" | "networthpending" | "networthloan" | "networthunpaidfees" | "huntingskill" | "searchforcashskill" | "bootleggingskill" | "graffitiskill" | "shopliftingskill" | "pickpocketingskill" | "cardskimmingskill" | "burglaryskill" | "hustlingskill" | "disposalskill" | "crackingskill" | "forgeryskill" | "scammingskill" | "arsonskill";
+export interface FactionCrimeExpResponse {
+    crimeexp: UserId[];
+}
+export interface FactionInventoryItem {
+    id: ItemId;
+    name: string;
+    type: MarketSpecializedBazaarCategoryEnum;
+    amount: number;
+    uids: ItemUid[];
+    loaned: {
+        id: UserId;
+        name: string;
+    } | null;
+}
+export interface FactionInventoryResponse {
+    inventory_timestamp: number;
+    inventory: FactionInventoryItem[];
+    _metadata: RequestMetadataWithLinksAndTotal;
+}
 export interface FactionRaidReport {
     id: RaidWarId;
     start: number;
@@ -2712,10 +2732,7 @@ export interface FactionBalance {
 export interface FactionBalanceResponse {
     balance: FactionBalance;
 }
-/**
- * The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'crimeexp', 'drugs', 'medical', 'utilities', 'temporary', 'weapons'.
- *  *  The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews'.
- */
+/** The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews', 'armor', 'boosters', 'caches', 'cesium', 'drugs', 'medical', 'utilities', 'temporary', 'weapons'. */
 export type FactionSelectionName = string;
 export interface FactionLookupResponse {
     selections: FactionSelectionName[];
@@ -3639,8 +3656,14 @@ export interface TornItemDetails extends ItemMarketListingItemDetails {
     type: TornItemTypeEnum;
     sub_type: TornItemWeaponTypeEnum | null;
 }
+export interface TornItemDetailsDeprecated extends ItemMarketListingItemDetails {
+    id: ItemId;
+    name: string;
+    type: TornItemTypeEnum;
+    sub_type: TornItemWeaponTypeEnum | null;
+}
 export interface TornItemDetailsResponse {
-    itemdetails: TornItemDetails;
+    itemdetails: TornItemDetails[] | TornItemDetailsDeprecated;
 }
 export interface TornMerit {
     id: MeritId;
@@ -7622,6 +7645,10 @@ export interface FactionV2 extends BaseSchema {
             response: FactionContributorsResponse;
             params: "stat" | "cat" | "timestamp";
         };
+        crimeexp: {
+            response: FactionCrimeExpResponse;
+            params: "timestamp";
+        };
         crimes: {
             response: FactionCrimesResponse;
             params: "cat" | "filters" | "limit" | "offset" | "from" | "to" | "sort" | "timestamp";
@@ -7638,6 +7665,10 @@ export interface FactionV2 extends BaseSchema {
             response: FactionHofResponse;
             params: "timestamp";
         };
+        inventory: {
+            response: FactionInventoryResponse;
+            params: "cat" | "limit" | "offset" | "timestamp";
+        };
         members: {
             response: FactionMembersResponse;
             params: "striptags" | "timestamp";
@@ -7996,7 +8027,7 @@ export interface TornV2 extends BaseSchema {
         };
         itemdetails: {
             response: TornItemDetailsResponse;
-            params: "id" | "timestamp";
+            params: "ids" | "timestamp";
         };
         itemmods: {
             response: TornItemModsResponse;

package/dist/index.ts

@@ -9,6 +9,17 @@
 
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 
+export type FactionArmoryCategoryEnum =
+    | "weapons"
+    | "armor"
+    | "temporary"
+    | "medical"
+    | "consumables"
+    | "drugs"
+    | "boosters"
+    | "utilities"
+    | "loot";
+
 export type MissionDifficultyEnum =
     "Very easy" | "Easy" | "Medium" | "Hard" | "Very hard" | "Expert";
 
@@ -7670,6 +7681,28 @@ export type PersonalStatsStatName =
     | "scammingskill"
     | "arsonskill";
 
+export interface FactionCrimeExpResponse {
+    crimeexp: UserId[];
+}
+
+export interface FactionInventoryItem {
+    id: ItemId;
+    name: string;
+    type: MarketSpecializedBazaarCategoryEnum;
+    amount: number;
+    uids: ItemUid[];
+    loaned: {
+        id: UserId;
+        name: string;
+    } | null;
+}
+
+export interface FactionInventoryResponse {
+    inventory_timestamp: number;
+    inventory: FactionInventoryItem[];
+    _metadata: RequestMetadataWithLinksAndTotal;
+}
+
 export interface FactionRaidReport {
     id: RaidWarId;
     start: number;
@@ -8379,10 +8412,7 @@ export interface FactionBalanceResponse {
     balance: FactionBalance;
 }
 
-/**
- * The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'crimeexp', 'drugs', 'medical', 'utilities', 'temporary', 'weapons'.
- *  *  The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews'.
- */
+/** The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews', 'armor', 'boosters', 'caches', 'cesium', 'drugs', 'medical', 'utilities', 'temporary', 'weapons'. */
 export type FactionSelectionName = string;
 
 export interface FactionLookupResponse {
@@ -9462,8 +9492,15 @@ export interface TornItemDetails extends ItemMarketListingItemDetails {
     sub_type: TornItemWeaponTypeEnum | null;
 }
 
+export interface TornItemDetailsDeprecated extends ItemMarketListingItemDetails {
+    id: ItemId;
+    name: string;
+    type: TornItemTypeEnum;
+    sub_type: TornItemWeaponTypeEnum | null;
+}
+
 export interface TornItemDetailsResponse {
-    itemdetails: TornItemDetails;
+    itemdetails: TornItemDetails[] | TornItemDetailsDeprecated;
 }
 
 export interface TornMerit {
@@ -13604,6 +13641,10 @@ export interface FactionV2 extends BaseSchema {
             response: FactionContributorsResponse;
             params: "stat" | "cat" | "timestamp";
         };
+        crimeexp: {
+            response: FactionCrimeExpResponse;
+            params: "timestamp";
+        };
         crimes: {
             response: FactionCrimesResponse;
             params:
@@ -13628,6 +13669,10 @@ export interface FactionV2 extends BaseSchema {
             response: FactionHofResponse;
             params: "timestamp";
         };
+        inventory: {
+            response: FactionInventoryResponse;
+            params: "cat" | "limit" | "offset" | "timestamp";
+        };
         members: {
             response: FactionMembersResponse;
             params: "striptags" | "timestamp";
@@ -14024,7 +14069,7 @@ export interface TornV2 extends BaseSchema {
         };
         itemdetails: {
             response: TornItemDetailsResponse;
-            params: "id" | "timestamp";
+            params: "ids" | "timestamp";
         };
         itemmods: {
             response: TornItemModsResponse;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Torn API",
     "description": "\n * The development of Torn's API v2 is still ongoing.\n * If selections remain unaltered, they will default to the API v1 version.\n * Unlike API v1, API v2 accepts both selections and IDs as path and query parameters.\n * If any discrepancies or errors are found, please submit a [bug report](https://www.torn.com/forums.php#/p=forums&f=19&b=0&a=0) on the Torn Forums.\n * In case you're using bots to check for changes on openapi.json file, make sure to specificy a custom user-agent header - CloudFlare sometimes prevents requests from default user-agents.",
-    "version": "6.11.1"
+    "version": "6.12.0"
   },
   "servers": [
     {
@@ -4823,6 +4823,45 @@
         "x-stability": "Stable"
       }
     },
+    "/faction/crimeexp": {
+      "get": {
+        "tags": [
+          "Faction"
+        ],
+        "summary": "Get your faction members crime experience",
+        "description": "Requires minimal access key. <br>Members are ordered descending, from highest crime experience to lowest.",
+        "operationId": "getMyFactionCrimeExp",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyMinimal"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FactionCrimeExpResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/faction/crimes": {
       "get": {
         "tags": [
@@ -5085,6 +5124,60 @@
         "x-stability": "Stable"
       }
     },
+    "/faction/inventory": {
+      "get": {
+        "tags": [
+          "Faction"
+        ],
+        "summary": "Get your faction's inventory items.",
+        "description": "<b>Cached selection (1 hour, all items cached at once).</b><br><br>Requires limited access key. <br> ",
+        "operationId": "getMyFactionInventory",
+        "parameters": [
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Armory category",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/FactionArmoryCategoryEnum"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffset"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FactionInventoryResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/faction/members": {
       "get": {
         "tags": [
@@ -6824,6 +6917,9 @@
                 {
                   "$ref": "#/components/schemas/FactionRankedWarsCategoryEnum"
                 },
+                {
+                  "$ref": "#/components/schemas/FactionArmoryCategoryEnum"
+                },
                 {
                   "$ref": "#/components/schemas/ReportTypeEnum"
                 },
@@ -6971,6 +7067,12 @@
                     {
                       "$ref": "#/components/schemas/FactionContributorsResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/FactionInventoryResponse"
+                    },
+                    {
+                      "$ref": "#/components/schemas/FactionCrimeExpResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/FactionRacketsResponse"
                     },
@@ -10572,7 +10674,7 @@
         "x-stability": "Stable"
       }
     },
-    "/torn/{id}/itemdetails": {
+    "/torn/{ids}/itemdetails": {
       "get": {
         "tags": [
           "Torn"
@@ -10582,12 +10684,17 @@
         "operationId": "getTornItemDetails",
         "parameters": [
           {
-            "name": "id",
+            "name": "ids",
             "in": "path",
-            "description": "Item uid",
+            "description": "Item uid or a list of item uids (comma separated)",
             "required": true,
+            "style": "form",
+            "explode": false,
             "schema": {
-              "$ref": "#/components/schemas/ItemUid"
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/ItemUid"
+              }
             }
           },
           {
@@ -11801,6 +11908,20 @@
           "E"
         ]
       },
+      "FactionArmoryCategoryEnum": {
+        "type": "string",
+        "enum": [
+          "weapons",
+          "armor",
+          "temporary",
+          "medical",
+          "consumables",
+          "drugs",
+          "boosters",
+          "utilities",
+          "loot"
+        ]
+      },
       "MissionDifficultyEnum": {
         "type": "string",
         "enum": [
@@ -27254,6 +27375,97 @@
           "arsonskill"
         ]
       },
+      "FactionCrimeExpResponse": {
+        "required": [
+          "crimeexp"
+        ],
+        "properties": {
+          "crimeexp": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserId"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "FactionInventoryItem": {
+        "required": [
+          "id",
+          "name",
+          "type",
+          "amount",
+          "uids",
+          "loaned"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/ItemId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "type": {
+            "$ref": "#/components/schemas/MarketSpecializedBazaarCategoryEnum"
+          },
+          "amount": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "uids": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ItemUid"
+            }
+          },
+          "loaned": {
+            "oneOf": [
+              {
+                "required": [
+                  "id",
+                  "name"
+                ],
+                "properties": {
+                  "id": {
+                    "$ref": "#/components/schemas/UserId"
+                  },
+                  "name": {
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "FactionInventoryResponse": {
+        "required": [
+          "inventory_timestamp",
+          "inventory",
+          "_metadata"
+        ],
+        "properties": {
+          "inventory_timestamp": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "inventory": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/FactionInventoryItem"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinksAndTotal"
+          }
+        },
+        "type": "object"
+      },
       "FactionRaidReport": {
         "required": [
           "id",
@@ -30076,7 +30288,7 @@
       "FactionSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'crimeexp', 'drugs', 'medical', 'utilities', 'temporary', 'weapons'.\n *  The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews'.",
+            "description": "The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews', 'armor', 'boosters', 'caches', 'cesium', 'drugs', 'medical', 'utilities', 'temporary', 'weapons'.",
             "type": "string",
             "enum": [
               "applications",
@@ -30090,6 +30302,7 @@
               "contributors",
               "crime",
               "crimes",
+              "crimeexp",
               "dirtbombs",
               "hof",
               "lookup",
@@ -30116,17 +30329,7 @@
               "warfareraids",
               "warfareranked",
               "warfareterritory",
-              "wars",
-              "armor",
-              "boosters",
-              "caches",
-              "cesium",
-              "crimeexp",
-              "drugs",
-              "medical",
-              "utilities",
-              "temporary",
-              "weapons"
+              "wars"
             ]
           },
           {
@@ -34616,13 +34819,64 @@
           }
         ]
       },
+      "TornItemDetailsDeprecated": {
+        "description": "This object is deprecated, and starting on 1st January 2027 it will be replaced with an array of TornItemDetails.",
+        "deprecated": true,
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ItemMarketListingItemDetails"
+          },
+          {
+            "required": [
+              "id",
+              "name",
+              "type",
+              "sub_type"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/ItemId"
+              },
+              "name": {
+                "type": "string"
+              },
+              "type": {
+                "$ref": "#/components/schemas/TornItemTypeEnum"
+              },
+              "sub_type": {
+                "oneOf": [
+                  {
+                    "$ref": "#/components/schemas/TornItemWeaponTypeEnum"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "type": "object"
+          }
+        ]
+      },
       "TornItemDetailsResponse": {
         "required": [
           "itemdetails"
         ],
         "properties": {
           "itemdetails": {
-            "$ref": "#/components/schemas/TornItemDetails"
+            "description": "Starting 1st January 2027, this response will return only an array of TornItemDetails.",
+            "oneOf": [
+              {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/TornItemDetails"
+                }
+              },
+              {
+                "$ref": "#/components/schemas/TornItemDetailsDeprecated",
+                "description": "This object is deprecated, and starting on 1st January 2027 it will be replaced with an array of TornItemDetails."
+              }
+            ]
           }
         },
         "type": "object"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "6.11.1",
+  "version": "6.12.0",
   "repository": {
     "url": "git+https://github.com/Torn-Playground/tornapi-typescript.git"
   },