tornapi-typescript 3.0.19 → 3.1.0

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 export type UserDonatorStatusEnum = "Donator" | "Subscriber";
 export type JobTypeEnum = "Army" | "Casino" | "Education" | "Grocer" | "Law" | "Medical";
 export type UserMaritalStatusEnum = "Engaged" | "Newlywed" | "Married";
+export type UserPlaneImageTypeEnum = "private_jet" | "light_aircraft" | "airliner";
 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" | "Newcomer" | "Deserter";
 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";
@@ -113,7 +114,7 @@ export interface RequestMetadataWithLinksAndTotal {
  */
 export type ForumFeedTypeEnum = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 export type UserGenderEnum = "Male" | "Female" | "Enby";
-export type HonorRarityEnum = "Extremely Rare" | "Very Rare" | "Rare" | "Limited" | "Uncommon" | "Common" | "Very Common" | "Unknown";
+export type HonorRarityEnum = "Extremely Rare" | "Very Rare" | "Rare" | "Limited" | "Uncommon" | "Common" | "Very Common" | "Unknown" | "Unknown Rarity";
 export type Parameters = string;
 export type ReviveSetting = "Everyone" | "Friends & faction" | "No one" | "Unknown";
 export type FactionWarfareTypeEnum = "ranked" | "territory" | "raid" | "chain" | "db";
@@ -1659,9 +1660,6 @@ export interface FactionTerritoryWarOngoing {
     target: number;
     factions: FactionTerritoryWarOngoingFaction[];
 }
-export interface FactionTerritoryWarsResponse {
-    territorywars: FactionTerritoryWarOngoing[] | FactionTerritoryWarFinished[];
-}
 export interface FactionTerritoryWarsHistoryResponse {
     territorywars: FactionTerritoryWarFinished[];
 }
@@ -1821,8 +1819,9 @@ export interface UserStatus {
     state: string;
     color: string;
     until: number | null;
-    /** This field is populated only if the state is 'Traveling'. */
+    /** This field is replaced by the 'plane_image_type' field and will be removed on October 1st 2025. */
     travel_type?: string;
+    plane_image_type?: UserPlaneImageTypeEnum;
 }
 export interface FactionMembersResponse {
     members: FactionMember[];
@@ -2346,9 +2345,7 @@ export interface KeyInfoResponse {
             level: number;
             type: ApiKeyAccessTypeEnum;
             faction: boolean;
-            faction_id?: FactionId | null;
             company: boolean;
-            company_id?: CompanyId | null;
             log: {
                 /** Shows if key has custom log permissions enabled. */
                 custom_permissions: boolean;
@@ -6498,7 +6495,7 @@ export interface FactionV2 extends BaseSchema {
         };
         rankedwars: {
             response: FactionRankedWarResponse;
-            params: "cat" | "from" | "to" | "sort" | "timestamp";
+            params: "from" | "to" | "sort" | "timestamp";
         };
         rankedwarreport: {
             response: FactionRankedWarReportResponse;
@@ -6533,8 +6530,8 @@ export interface FactionV2 extends BaseSchema {
             params: "offset" | "limit" | "timestamp";
         };
         territorywars: {
-            response: FactionTerritoryWarsResponse;
-            params: "cat" | "from" | "to" | "sort" | "limit" | "timestamp";
+            response: FactionTerritoryWarsHistoryResponse;
+            params: "from" | "to" | "sort" | "limit" | "timestamp";
         };
         territorywarreport: {
             response: FactionTerritoryWarReportResponse;

package/dist/index.ts

@@ -21,6 +21,11 @@ export type JobTypeEnum =
 
 export type UserMaritalStatusEnum = "Engaged" | "Newlywed" | "Married";
 
+export type UserPlaneImageTypeEnum =
+    | "private_jet"
+    | "light_aircraft"
+    | "airliner";
+
 export type UserRoleEnum =
     | "Admin"
     | "Officer"
@@ -4795,7 +4800,8 @@ export type HonorRarityEnum =
     | "Uncommon"
     | "Common"
     | "Very Common"
-    | "Unknown";
+    | "Unknown"
+    | "Unknown Rarity";
 
 export type Parameters = string;
 
@@ -7053,10 +7059,6 @@ export interface FactionTerritoryWarOngoing {
     factions: FactionTerritoryWarOngoingFaction[];
 }
 
-export interface FactionTerritoryWarsResponse {
-    territorywars: FactionTerritoryWarOngoing[] | FactionTerritoryWarFinished[];
-}
-
 export interface FactionTerritoryWarsHistoryResponse {
     territorywars: FactionTerritoryWarFinished[];
 }
@@ -7242,8 +7244,9 @@ export interface UserStatus {
     state: string;
     color: string;
     until: number | null;
-    /** This field is populated only if the state is 'Traveling'. */
+    /** This field is replaced by the 'plane_image_type' field and will be removed on October 1st 2025. */
     travel_type?: string;
+    plane_image_type?: UserPlaneImageTypeEnum;
 }
 
 export interface FactionMembersResponse {
@@ -7840,9 +7843,7 @@ export interface KeyInfoResponse {
             level: number;
             type: ApiKeyAccessTypeEnum;
             faction: boolean;
-            faction_id?: FactionId | null;
             company: boolean;
-            company_id?: CompanyId | null;
             log: {
                 /** Shows if key has custom log permissions enabled. */
                 custom_permissions: boolean;
@@ -12201,7 +12202,7 @@ export interface FactionV2 extends BaseSchema {
         };
         rankedwars: {
             response: FactionRankedWarResponse;
-            params: "cat" | "from" | "to" | "sort" | "timestamp";
+            params: "from" | "to" | "sort" | "timestamp";
         };
         rankedwarreport: {
             response: FactionRankedWarReportResponse;
@@ -12250,8 +12251,8 @@ export interface FactionV2 extends BaseSchema {
             params: "offset" | "limit" | "timestamp";
         };
         territorywars: {
-            response: FactionTerritoryWarsResponse;
-            params: "cat" | "from" | "to" | "sort" | "limit" | "timestamp";
+            response: FactionTerritoryWarsHistoryResponse;
+            params: "from" | "to" | "sort" | "limit" | "timestamp";
         };
         territorywarreport: {
             response: FactionTerritoryWarReportResponse;

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": "3.0.19"
+    "version": "3.1.0"
   },
   "servers": [
     {
@@ -1773,7 +1773,7 @@
           "User"
         ],
         "summary": "Get your personal stats",
-        "description": "Requires public access key. <br>\n * UserPersonalStatsFull is returned only when this selection is requested with Limited, Full or Custom key access key.\n * UserPersonalStatsFullPublic is returned when the requested category is 'all'.\n * UserPersonalStatsPopular is returned when the requested category is 'popular'. Please try to use UserPersonalStatsPopular over UserPersonalStatsFullPublic wherever possible in order to reduce the server load.\n * Otherwise, UserPersonalStatsCategory is returned for the matched category.\n * It's possible to request specific stats via 'stat' parameter. In this case the response will vary depending on the stats requested. Private stats are still available only to the key owner (with Limited or higher key).\n * Additionally, historical stats can also be fetched via 'stat' query parameter, but 'timestamp' parameter must be provided as well. It's only possible to pass up to 10 historical stats at once (the rest is trimmed). When requesting historical stats the response will be of type UserPersonalStatsHistoric.",
+        "description": "Requires public access key. <br>\n * UserPersonalStatsFull is returned only when this selection is requested with Limited, Full or Custom key access key.\n * UserPersonalStatsFullPublic is returned when the requested category is 'all'.\n * UserPersonalStatsPopular is returned when the requested category is 'popular'. Please try to use UserPersonalStatsPopular over UserPersonalStatsFullPublic wherever possible in order to reduce the server load.\n * Otherwise, UserPersonalStatsCategory is returned for the matched category.\n * Historical stats can be fetched via 'stat' query parameter. It's only possible to pass up to 10 historical stats at once (the rest is trimmed). When requesting historical stats the response will be of type UserPersonalStatsHistoric.\n * Use 'timestamp' query parameter to get historical stats at the certain point in time. It's possible some historical stats didn't exist at the given timestamp, and for such stats you will not receive anything back.",
         "operationId": "388e8008ae1c2645819af76d71ef92a5",
         "parameters": [
           {
@@ -4107,16 +4107,6 @@
         "description": "Requires public access key. <br>",
         "operationId": "4f5d624a86e2d389a7a738b6b3ce8c9e",
         "parameters": [
-          {
-            "name": "cat",
-            "in": "query",
-            "description": "This parameter is deprecated. The ranked wars list can now instead be fetched via 'faction' -> 'warfare' endpoint. This functionality will be removed on 1st of September 2025.",
-            "required": false,
-            "deprecated": true,
-            "schema": {
-              "$ref": "#/components/schemas/FactionRankedWarsCategoryEnum"
-            }
-          },
           {
             "$ref": "#/components/parameters/ApiFrom"
           },
@@ -4660,16 +4650,6 @@
         "description": "Requires public access key. <br>",
         "operationId": "0258963246159d1e3e54547c32aac7c8",
         "parameters": [
-          {
-            "name": "cat",
-            "in": "query",
-            "description": "This parameter is deprecated. The territory wars list can now instead be fetched via 'faction' -> 'warfare' endpoint. This functionality will be removed on 1st of September 2025.",
-            "required": false,
-            "deprecated": true,
-            "schema": {
-              "$ref": "#/components/schemas/FactionTerritoryWarsCategoryEnum"
-            }
-          },
           {
             "$ref": "#/components/parameters/ApiFrom"
           },
@@ -4698,7 +4678,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/FactionTerritoryWarsResponse"
+                  "$ref": "#/components/schemas/FactionTerritoryWarsHistoryResponse"
                 }
               }
             }
@@ -5307,9 +5287,6 @@
                     {
                       "$ref": "#/components/schemas/FactionStatsResponse"
                     },
-                    {
-                      "$ref": "#/components/schemas/FactionTerritoryWarsResponse"
-                    },
                     {
                       "$ref": "#/components/schemas/FactionContributorsResponse"
                     },
@@ -8499,6 +8476,14 @@
           "Married"
         ]
       },
+      "UserPlaneImageTypeEnum": {
+        "type": "string",
+        "enum": [
+          "private_jet",
+          "light_aircraft",
+          "airliner"
+        ]
+      },
       "UserRoleEnum": {
         "type": "string",
         "enum": [
@@ -13559,7 +13544,8 @@
           "Uncommon",
           "Common",
           "Very Common",
-          "Unknown"
+          "Unknown",
+          "Unknown Rarity"
         ]
       },
       "Parameters": {
@@ -21520,31 +21506,6 @@
         },
         "type": "object"
       },
-      "FactionTerritoryWarsResponse": {
-        "required": [
-          "territorywars"
-        ],
-        "properties": {
-          "territorywars": {
-            "description": "If the chosen category is 'ongoing' the response will be of 'FactionTerritoryWarOngoing' type, otherwise, the type will be 'FactionTerritoryWarFinished'.",
-            "oneOf": [
-              {
-                "type": "array",
-                "items": {
-                  "$ref": "#/components/schemas/FactionTerritoryWarOngoing"
-                }
-              },
-              {
-                "type": "array",
-                "items": {
-                  "$ref": "#/components/schemas/FactionTerritoryWarFinished"
-                }
-              }
-            ]
-          }
-        },
-        "type": "object"
-      },
       "FactionTerritoryWarsHistoryResponse": {
         "required": [
           "territorywars"
@@ -22251,8 +22212,13 @@
             ]
           },
           "travel_type": {
-            "description": "This field is populated only if the state is 'Traveling'.",
-            "type": "string"
+            "description": "This field is replaced by the 'plane_image_type' field and will be removed on October 1st 2025.",
+            "type": "string",
+            "deprecated": true
+          },
+          "plane_image_type": {
+            "$ref": "#/components/schemas/UserPlaneImageTypeEnum",
+            "description": "This field is populated only if the state is 'Traveling'."
           }
         },
         "type": "object"
@@ -24802,33 +24768,9 @@
                   "faction": {
                     "type": "boolean"
                   },
-                  "faction_id": {
-                    "description": "This field is replaced with 'user'.'faction_id' field and will be removed on 1st of September 2025. Populated only if 'faction' field is true.",
-                    "deprecated": true,
-                    "oneOf": [
-                      {
-                        "$ref": "#/components/schemas/FactionId"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
                   "company": {
                     "type": "boolean"
                   },
-                  "company_id": {
-                    "description": "This field is replaced with 'user'.'company_id' field and will be removed on 1st of September 2025. Populated only if 'company' field is true.",
-                    "deprecated": true,
-                    "oneOf": [
-                      {
-                        "$ref": "#/components/schemas/CompanyId"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
                   "log": {
                     "required": [
                       "custom_permissions",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "3.0.19",
+  "version": "3.1.0",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },