tornapi-typescript 5.5.3 → 5.6.0

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": "5.5.3"
+    "version": "5.6.0"
   },
   "servers": [
     {
@@ -336,7 +336,7 @@
           "User"
         ],
         "summary": "Get bounties placed on you",
-        "description": "Requires public access key. <br>",
+        "description": "<b>Globally cached selection.</b><br><br>Requires public access key. <br>",
         "operationId": "getMyBounties",
         "parameters": [
           {
@@ -1530,6 +1530,60 @@
         "x-stability": "Stable"
       }
     },
+    "/user/inventory": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your inventory",
+        "description": "<b>Cached selection (1 hour per category).</b><br><br>Requires limited access key. <br>",
+        "operationId": "getMyInventory",
+        "parameters": [
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Items category",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/TornInventoryItemType"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffset"
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit250Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserInventoryResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/user/itemmarket": {
       "get": {
         "tags": [
@@ -2858,7 +2912,7 @@
           "User"
         ],
         "summary": "Get your reports",
-        "description": "Requires limited access key. <br>\n * The default limit is set to 25. However, the limit can be set to 100 for the 'stats' category.",
+        "description": "Requires limited access key. <br>\nThe limit is set to 25 when requesting any category other than 'stats'.<br>\nWhen requesting the 'stats' category, limit can be increased up to 100.",
         "operationId": "getMyReports",
         "parameters": [
           {
@@ -3542,6 +3596,9 @@
                 {
                   "$ref": "#/components/schemas/RacingRaceTypeEnum"
                 },
+                {
+                  "$ref": "#/components/schemas/TornInventoryItemType"
+                },
                 {
                   "$ref": "#/components/schemas/TradeCategoryEnum"
                 }
@@ -3765,6 +3822,9 @@
                     {
                       "$ref": "#/components/schemas/UserLookupResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserInventoryResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/TimestampResponse"
                     }
@@ -4457,6 +4517,9 @@
               ]
             }
           },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
           {
             "$ref": "#/components/parameters/ApiOffset"
           },
@@ -5192,7 +5255,7 @@
           "Faction"
         ],
         "summary": "Get faction reports",
-        "description": "Requires limited access key. <br>\n *  The default limit is set to 25. However, the limit can be set to 100 for the 'stats' category.",
+        "description": "Requires limited access key. <br>\nThe limit is set to 25 when requesting any category other than 'stats'.<br>\nWhen requesting the 'stats' category, limit can be increased up to 100.",
         "operationId": "getMyFactionReports",
         "parameters": [
           {
@@ -7152,7 +7215,7 @@
           "Market"
         ],
         "summary": "Get item market listings",
-        "description": "Requires public access key. <br>",
+        "description": "<b>Globally cached selection.</b><br><br>Requires public access key. <br>",
         "operationId": "getMarketItemMarketItem",
         "parameters": [
           {
@@ -7215,7 +7278,7 @@
           "Market"
         ],
         "summary": "Get properties market listings",
-        "description": "Requires public access key. <br>",
+        "description": "<b>Globally cached selection.</b><br><br>Requires public access key. <br>",
         "operationId": "getMarketProperties",
         "parameters": [
           {
@@ -7272,7 +7335,7 @@
           "Market"
         ],
         "summary": "Get properties rental listings",
-        "description": "Requires public access key. <br>",
+        "description": "<b>Globally cached selection.</b><br><br>Requires public access key. <br>",
         "operationId": "getMarketPropertiesRental",
         "parameters": [
           {
@@ -8298,7 +8361,7 @@
           "Torn"
         ],
         "summary": "Get bounties",
-        "description": "Requires public key. <br>",
+        "description": "<b>Globally cached selection.</b><br><br>Requires public key. <br>",
         "operationId": "getTornBounties",
         "parameters": [
           {
@@ -15369,6 +15432,36 @@
           "Weapon"
         ]
       },
+      "TornInventoryItemType": {
+        "type": "string",
+        "enum": [
+          "Collectible",
+          "Clothing",
+          "Other",
+          "Tool",
+          "Melee",
+          "Defensive",
+          "Material",
+          "Car",
+          "Primary",
+          "Secondary",
+          "Book",
+          "Special",
+          "Supply Pack",
+          "Temporary",
+          "Enhancer",
+          "Artifact",
+          "Flower",
+          "Booster",
+          "Medical",
+          "Candy",
+          "Jewelry",
+          "Alcohol",
+          "Plushie",
+          "Drug",
+          "Energy Drink"
+        ]
+      },
       "TornItemArmorCoveragePartEnum": {
         "type": "string",
         "enum": [
@@ -17166,6 +17259,79 @@
         },
         "type": "object"
       },
+      "UserInventoryItem": {
+        "required": [
+          "id",
+          "amount",
+          "equipped",
+          "name",
+          "faction_owned",
+          "uid"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/ItemId"
+          },
+          "amount": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "equipped": {
+            "type": "boolean"
+          },
+          "name": {
+            "type": "string"
+          },
+          "faction_owned": {
+            "type": "boolean"
+          },
+          "uid": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/ItemUid"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "UserInventory": {
+        "required": [
+          "items",
+          "timestamp"
+        ],
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserInventoryItem"
+            }
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserInventoryResponse": {
+        "required": [
+          "inventory",
+          "_metadata"
+        ],
+        "properties": {
+          "inventory": {
+            "$ref": "#/components/schemas/UserInventory"
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinksAndTotal"
+          }
+        },
+        "type": "object"
+      },
       "UserTradeResponse": {
         "required": [
           "trade"
@@ -20946,6 +21112,11 @@
           "bounties_timestamp": {
             "type": "integer",
             "format": "int32"
+          },
+          "bounties_delay": {
+            "description": "The minimum amount of time needed before the cache timestamp can change.",
+            "type": "integer",
+            "format": "int32"
           }
         },
         "type": "object"
@@ -21251,7 +21422,7 @@
       "UserSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','inventory','networth','perks'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','display','gym','networth','perks'.",
             "type": "string",
             "enum": [
               "ammo",
@@ -21279,6 +21450,7 @@
               "hof",
               "honors",
               "icons",
+              "inventory",
               "itemmarket",
               "job",
               "jobpoints",
@@ -21318,7 +21490,6 @@
               "display",
               "education",
               "gym",
-              "inventory",
               "networth",
               "perks"
             ]
@@ -26998,8 +27169,8 @@
           },
           "percentage": {
             "description": "Total percentage split between all participants.",
-            "type": "integer",
-            "format": "int32"
+            "type": "number",
+            "format": "float"
           },
           "paid_by": {
             "$ref": "#/components/schemas/UserId"
@@ -28607,6 +28778,11 @@
             "type": "integer",
             "format": "int32"
           },
+          "rentals_delay": {
+            "description": "The minimum amount of time needed before the cache timestamp can change.",
+            "type": "integer",
+            "format": "int32"
+          },
           "_metadata": {
             "$ref": "#/components/schemas/RequestMetadataWithLinks"
           }
@@ -28676,6 +28852,11 @@
             "type": "integer",
             "format": "int32"
           },
+          "properties_delay": {
+            "description": "The minimum amount of time needed before the cache timestamp can change.",
+            "type": "integer",
+            "format": "int32"
+          },
           "_metadata": {
             "$ref": "#/components/schemas/RequestMetadataWithLinks"
           }
@@ -29160,6 +29341,11 @@
             "description": "Timestamp when the data was globally cached at.",
             "type": "integer",
             "format": "int32"
+          },
+          "cache_delay": {
+            "description": "The minimum amount of time needed before the cache timestamp can change.",
+            "type": "integer",
+            "format": "int32"
           }
         },
         "type": "object"
@@ -31661,6 +31847,11 @@
             "type": "integer",
             "format": "int32"
           },
+          "bounties_delay": {
+            "description": "The minimum amount of time needed before the cache timestamp can change.",
+            "type": "integer",
+            "format": "int32"
+          },
           "_metadata": {
             "$ref": "#/components/schemas/RequestMetadataWithLinks"
           }

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "5.5.3",
+  "version": "5.6.0",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.6.0",
-    "@types/node": "^24.12.0",
-    "prettier": "^3.8.1",
+    "@scalar/openapi-types": "^0.7.0",
+    "@types/node": "^24.12.2",
+    "prettier": "^3.8.2",
     "typeconv": "^2.3.1",
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.2"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",