tornapi-typescript 5.4.1 → 5.5.0

package/dist/index.d.ts

@@ -81,6 +81,7 @@ export type TerritoryWarId = number;
 export type RaidWarId = number;
 export type ItemUid = number;
 export type UserId = number;
+export type TradeId = number;
 export type StockId = number;
 export type DiscordId = string;
 export type UserDiscordPathId = UserId | DiscordId;
@@ -148,7 +149,7 @@ export type HonorTypeEnum = "attacking" | "camo" | "weapons" | "education" | "cr
 export type TornItemTypeEnum = "Alcohol" | "Armor" | "Artifact" | "Book" | "Booster" | "Candy" | "Car" | "Clothing" | "Collectible" | "Drug" | "Energy Drink" | "Enhancer" | "Flower" | "Jewelry" | "Material" | "Medical" | "Other" | "Plushie" | "Special" | "Supply Pack" | "Tool" | "Unused" | "Weapon";
 export type TornItemCategory = "All" | "Alcohol" | "Armor" | "Artifact" | "Book" | "Booster" | "Candy" | "Car" | "Clothing" | "Collectible" | "Defensive" | "Drug" | "Energy Drink" | "Enhancer" | "Flower" | "Jewelry" | "Material" | "Medical" | "Melee" | "Other" | "Plushie" | "Primary" | "Secondary" | "Special" | "Supply Pack" | "Temporary" | "Tool" | "Unused" | "Weapon";
 export type TornItemArmorCoveragePartEnum = "Full Body" | "Heart" | "Stomach" | "Chest" | "Arm" | "Groin" | "Leg" | "Throat" | "Hand" | "Foot" | "Head";
-export interface AttackPlayerFaction {
+export interface UserFactionBasic {
     id: FactionId;
     name: string;
 }
@@ -156,7 +157,7 @@ export interface AttackPlayer {
     id: UserId;
     name: string;
     level: number;
-    faction: AttackPlayerFaction | null;
+    faction: UserFactionBasic | null;
 }
 export interface AttackPlayerSimplified {
     id: UserId;
@@ -486,6 +487,78 @@ export interface ErrorCategorySelectionUnavailableForInteractionLogs {
     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;
+export interface UserTradesResponse {
+    trades: UserTrade[];
+    _metadata: RequestMetadataWithLinks;
+}
+export interface UserTradeResponse {
+    trade: UserTradeDetailed;
+}
+export interface UserTrade {
+    id: TradeId;
+    timestamp: number;
+    user: UserTradeParticipant;
+    trader: UserTradeParticipant;
+}
+export interface UserTradeParticipant {
+    id: UserId;
+    name: string;
+    summary: string[];
+}
+export interface UserTradeDetailed extends UserTrade {
+    items: TradeItem[];
+}
+export interface TradeItemNap {
+    user_id: UserId;
+    type: "NAP";
+    details: {
+        days: number;
+        factions: UserFactionBasic[];
+    };
+}
+export interface TradeItemMoney {
+    user_id: UserId;
+    type: "Money";
+    details: {
+        amount: number;
+    };
+}
+export interface TradeItemFaction {
+    user_id: UserId;
+    type: "Faction";
+    details: {
+        id: FactionId;
+        name: string;
+        respect: number;
+    };
+}
+export interface TradeItemProperty {
+    user_id: UserId;
+    type: "Property";
+    details: {
+        id: PropertyId;
+        happiness: number;
+    };
+}
+export interface TradeItemCompany {
+    user_id: UserId;
+    type: "Company";
+    details: {
+        id: CompanyId;
+        name: string;
+        value: string;
+    };
+}
+export interface TradeItemItem {
+    user_id: UserId;
+    type: "Item";
+    details: {
+        id: ItemId;
+        uid: ItemUid | null;
+        amount: number;
+    };
+}
+export type TradeItem = TradeItemMoney | TradeItemItem | TradeItemFaction | TradeItemCompany | TradeItemProperty | TradeItemNap;
 export interface UserStockTransaction {
     id: number;
     shares: number;
@@ -6945,6 +7018,14 @@ export interface UserV2 extends BaseSchema {
             response: UserStocksResponse;
             params: "timestamp";
         };
+        trades: {
+            response: UserTradesResponse;
+            params: "striptags" | "limit" | "sort" | "to" | "from" | "timestamp";
+        };
+        trade: {
+            response: UserTradeResponse;
+            params: "id" | "striptags" | "timestamp";
+        };
         travel: {
             response: UserTravelResponse;
             params: "timestamp";

package/dist/index.ts

@@ -4779,6 +4779,8 @@ export type ItemUid = number;
 
 export type UserId = number;
 
+export type TradeId = number;
+
 export type StockId = number;
 
 export type DiscordId = string;
@@ -5075,7 +5077,7 @@ export type TornItemArmorCoveragePartEnum =
     | "Foot"
     | "Head";
 
-export interface AttackPlayerFaction {
+export interface UserFactionBasic {
     id: FactionId;
     name: string;
 }
@@ -5084,7 +5086,7 @@ export interface AttackPlayer {
     id: UserId;
     name: string;
     level: number;
-    faction: AttackPlayerFaction | null;
+    faction: UserFactionBasic | null;
 }
 
 export interface AttackPlayerSimplified {
@@ -5517,6 +5519,96 @@ export type ApiError =
     | ErrorIncorrectLogId
     | ErrorCategorySelectionUnavailableForInteractionLogs;
 
+export interface UserTradesResponse {
+    trades: UserTrade[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface UserTradeResponse {
+    trade: UserTradeDetailed;
+}
+
+export interface UserTrade {
+    id: TradeId;
+    timestamp: number;
+    user: UserTradeParticipant;
+    trader: UserTradeParticipant;
+}
+
+export interface UserTradeParticipant {
+    id: UserId;
+    name: string;
+    summary: string[];
+}
+
+export interface UserTradeDetailed extends UserTrade {
+    items: TradeItem[];
+}
+
+export interface TradeItemNap {
+    user_id: UserId;
+    type: "NAP";
+    details: {
+        days: number;
+        factions: UserFactionBasic[];
+    };
+}
+
+export interface TradeItemMoney {
+    user_id: UserId;
+    type: "Money";
+    details: {
+        amount: number;
+    };
+}
+
+export interface TradeItemFaction {
+    user_id: UserId;
+    type: "Faction";
+    details: {
+        id: FactionId;
+        name: string;
+        respect: number;
+    };
+}
+
+export interface TradeItemProperty {
+    user_id: UserId;
+    type: "Property";
+    details: {
+        id: PropertyId;
+        happiness: number;
+    };
+}
+
+export interface TradeItemCompany {
+    user_id: UserId;
+    type: "Company";
+    details: {
+        id: CompanyId;
+        name: string;
+        value: string;
+    };
+}
+
+export interface TradeItemItem {
+    user_id: UserId;
+    type: "Item";
+    details: {
+        id: ItemId;
+        uid: ItemUid | null;
+        amount: number;
+    };
+}
+
+export type TradeItem =
+    | TradeItemMoney
+    | TradeItemItem
+    | TradeItemFaction
+    | TradeItemCompany
+    | TradeItemProperty
+    | TradeItemNap;
+
 export interface UserStockTransaction {
     id: number;
     shares: number;
@@ -12818,6 +12910,20 @@ export interface UserV2 extends BaseSchema {
             response: UserStocksResponse;
             params: "timestamp";
         };
+        trades: {
+            response: UserTradesResponse;
+            params:
+                | "striptags"
+                | "limit"
+                | "sort"
+                | "to"
+                | "from"
+                | "timestamp";
+        };
+        trade: {
+            response: UserTradeResponse;
+            params: "id" | "striptags" | "timestamp";
+        };
         travel: {
             response: UserTravelResponse;
             params: "timestamp";

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.4.1"
+    "version": "5.5.0"
   },
   "servers": [
     {
@@ -3110,6 +3110,111 @@
         "x-stability": "Unstable"
       }
     },
+    "/user/trades": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your trades",
+        "description": "Requires limited access key. <br>",
+        "operationId": "getMyTrades",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiStripTagsTrue"
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSortDesc"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
+          },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserTradesResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
+    "/user/{tradeId}/trade": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your detailed trade",
+        "description": "Requires limited access key. <br>Only possible to get trades you participated in.",
+        "operationId": "getMyDetailedTrade",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Trade id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/TradeId"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiStripTagsTrue"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserTradeResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/travel": {
       "get": {
         "tags": [
@@ -3380,6 +3485,9 @@
                 {
                   "$ref": "#/components/schemas/TornCrimeId"
                 },
+                {
+                  "$ref": "#/components/schemas/TradeId"
+                },
                 {
                   "type": "string"
                 }
@@ -3630,6 +3738,12 @@
                     {
                       "$ref": "#/components/schemas/UserBattleStatsResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserTradeResponse"
+                    },
+                    {
+                      "$ref": "#/components/schemas/UserTradesResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserNewEventsResponse"
                     },
@@ -14784,6 +14898,10 @@
         "type": "integer",
         "format": "int32"
       },
+      "TradeId": {
+        "type": "integer",
+        "format": "int64"
+      },
       "StockId": {
         "type": "integer",
         "format": "int32"
@@ -15253,7 +15371,7 @@
           "Head"
         ]
       },
-      "AttackPlayerFaction": {
+      "UserFactionBasic": {
         "required": [
           "id",
           "name"
@@ -15289,7 +15407,7 @@
           "faction": {
             "oneOf": [
               {
-                "$ref": "#/components/schemas/AttackPlayerFaction"
+                "$ref": "#/components/schemas/UserFactionBasic"
               },
               {
                 "type": "null"
@@ -17016,6 +17134,352 @@
           }
         ]
       },
+      "UserTradesResponse": {
+        "required": [
+          "trades",
+          "_metadata"
+        ],
+        "properties": {
+          "trades": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserTrade"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object"
+      },
+      "UserTradeResponse": {
+        "required": [
+          "trade"
+        ],
+        "properties": {
+          "trade": {
+            "$ref": "#/components/schemas/UserTradeDetailed"
+          }
+        },
+        "type": "object"
+      },
+      "UserTrade": {
+        "required": [
+          "id",
+          "timestamp",
+          "user",
+          "trader",
+          "items"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/TradeId"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "user": {
+            "$ref": "#/components/schemas/UserTradeParticipant"
+          },
+          "trader": {
+            "$ref": "#/components/schemas/UserTradeParticipant"
+          }
+        },
+        "type": "object"
+      },
+      "UserTradeParticipant": {
+        "required": [
+          "id",
+          "name",
+          "summary"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "summary": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserTradeDetailed": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/UserTrade"
+          },
+          {
+            "required": [
+              "items"
+            ],
+            "properties": {
+              "items": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/TradeItem"
+                }
+              }
+            },
+            "type": "object"
+          }
+        ]
+      },
+      "TradeItemNap": {
+        "required": [
+          "user_id",
+          "type",
+          "details"
+        ],
+        "properties": {
+          "user_id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "NAP"
+            ]
+          },
+          "details": {
+            "required": [
+              "days",
+              "factions"
+            ],
+            "properties": {
+              "days": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "factions": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/UserFactionBasic"
+                }
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TradeItemMoney": {
+        "required": [
+          "user_id",
+          "type",
+          "details"
+        ],
+        "properties": {
+          "user_id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "Money"
+            ]
+          },
+          "details": {
+            "required": [
+              "amount"
+            ],
+            "properties": {
+              "amount": {
+                "type": "integer",
+                "format": "int64"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TradeItemFaction": {
+        "required": [
+          "user_id",
+          "type",
+          "details"
+        ],
+        "properties": {
+          "user_id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "Faction"
+            ]
+          },
+          "details": {
+            "required": [
+              "id",
+              "name",
+              "respect"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/FactionId"
+              },
+              "name": {
+                "type": "string"
+              },
+              "respect": {
+                "type": "integer",
+                "format": "int32"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TradeItemProperty": {
+        "required": [
+          "user_id",
+          "type",
+          "details"
+        ],
+        "properties": {
+          "user_id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "Property"
+            ]
+          },
+          "details": {
+            "required": [
+              "id",
+              "happiness"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/PropertyId"
+              },
+              "happiness": {
+                "type": "integer",
+                "format": "int32"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TradeItemCompany": {
+        "required": [
+          "user_id",
+          "type",
+          "details"
+        ],
+        "properties": {
+          "user_id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "Company"
+            ]
+          },
+          "details": {
+            "required": [
+              "id",
+              "name",
+              "value"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/CompanyId"
+              },
+              "name": {
+                "type": "string"
+              },
+              "value": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TradeItemItem": {
+        "required": [
+          "user_id",
+          "type",
+          "details"
+        ],
+        "properties": {
+          "user_id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "Item"
+            ]
+          },
+          "details": {
+            "required": [
+              "id",
+              "uid",
+              "amount"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/ItemId"
+              },
+              "uid": {
+                "oneOf": [
+                  {
+                    "$ref": "#/components/schemas/ItemUid"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "amount": {
+                "type": "integer",
+                "format": "int64"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TradeItem": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/TradeItemMoney"
+          },
+          {
+            "$ref": "#/components/schemas/TradeItemItem"
+          },
+          {
+            "$ref": "#/components/schemas/TradeItemFaction"
+          },
+          {
+            "$ref": "#/components/schemas/TradeItemCompany"
+          },
+          {
+            "$ref": "#/components/schemas/TradeItemProperty"
+          },
+          {
+            "$ref": "#/components/schemas/TradeItemNap"
+          }
+        ]
+      },
       "UserStockTransaction": {
         "required": [
           "id",
@@ -20835,8 +21299,10 @@
               "revivesfull",
               "skills",
               "stocks",
-              "timestamp",
+              "trades",
+              "trade",
               "travel",
+              "timestamp",
               "weaponexp",
               "workstats",
               "bazaar",

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "5.4.1",
+  "version": "5.5.0",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.5.3",
-    "@types/node": "^24.10.13",
+    "@scalar/openapi-types": "^0.6.0",
+    "@types/node": "^24.12.0",
     "prettier": "^3.8.1",
     "typeconv": "^2.3.1",
     "typescript": "^5.9.3"