tornapi-typescript 5.8.1 → 5.9.0

package/README.md

@@ -27,12 +27,12 @@ generated above.
 
 The V2 types are generated in the following way:
 
-* load [openapi specification](https://www.torn.com/swagger/openapi.json)
-* convert the specification to TypeScript definitions using [typeconv](https://github.com/grantila/typeconv)
-* clean the type definitions
-    * remove all "[key: string]: any;", because typeconv adds it everywhere for some reason
-    * remove all empty objects (caused by the above cleaning)
-    * run through prettier to have it look decent
+- load [openapi specification](https://www.torn.com/swagger/openapi.json)
+- convert the specification to TypeScript definitions using [typeconv](https://github.com/grantila/typeconv)
+- clean the type definitions
+    - remove all "[key: string]: any;", because typeconv adds it everywhere for some reason
+    - remove all empty objects (caused by the above cleaning)
+    - run through prettier to have it look decent
 
 ### V2 client
 

package/dist/index.d.ts

@@ -33,6 +33,7 @@ export type FactionPositionAbilityEnum = "Medical Usage" | "Booster Usage" | "Dr
 export type FactionOrganizedCrimePayoutType = "balance" | "wallet" | "inventory";
 export type TornRacketType = "Item" | "Points" | "Money";
 export type FactionNewsCategory = "main" | "attack" | "armoryDeposit" | "armoryAction" | "territoryWar" | "rankedWar" | "territoryGain" | "chain" | "crime" | "membership" | "depositFunds" | "giveFunds";
+export type CompanyNewsCategory = "main" | "funds" | "training" | "employees" | "all";
 export type FactionRankEnum = "Unranked" | "Bronze" | "Silver" | "Gold" | "Platinum" | "Diamond";
 export type UserCrimeUniquesRewardAmmoEnum = "standard" | "special";
 export type RaceStatusEnum = "open" | "in_progress" | "finished";
@@ -2170,6 +2171,7 @@ export interface FactionTerritoryWarReportResponse {
 }
 export interface FactionTerritoryOwnership {
     id: string;
+    irradiated: boolean;
     owned_by: FactionId | null;
     acquired_at: number | null;
 }
@@ -2395,13 +2397,13 @@ export interface FactionWarsResponse {
     pacts: FactionPact[];
     wars: FactionWars;
 }
-export interface FactionNews {
+export interface News {
     id: string;
     text: string;
     timestamp: number;
 }
-export interface FactionNewsResponse {
-    news: FactionNews[];
+export interface NewsResponse {
+    news: News[];
     _metadata: RequestMetadataWithLinks;
 }
 export interface FactionRaidsResponse {
@@ -2688,13 +2690,20 @@ export interface FactionRankedWarReportResponse {
     };
 }
 /**
- * The following selections will fallback to API v1 and may change at any time: 'companies', 'news', 'search'.
+ * The following selections will fallback to API v1 and may change at any time: 'companies', 'search'.
  *  *  The following selections are not available in API v2: 'details'.
  */
 export type CompanySelectionName = string;
 export interface CompanyLookupResponse {
     selections: CompanySelectionName[];
 }
+export interface CompaniesResponse {
+    companies: CompanyProfile[];
+    companies_timestamp: number;
+    /** The minimum amount of time needed before the cache timestamp can change. */
+    companies_delay: number;
+    _metadata: RequestMetadataWithLinksAndTotal;
+}
 export interface CompanyProfileResponse {
     profile: CompanyProfile;
 }
@@ -3639,7 +3648,7 @@ export interface TornBountiesResponse {
     bounties: Bounty[];
     bounties_timestamp: number;
     /** The minimum amount of time needed before the cache timestamp can change. */
-    bounties_delay?: number;
+    bounties_delay: number;
     _metadata: RequestMetadataWithLinksAndTotal;
 }
 export interface TornItemAmmo {
@@ -7328,7 +7337,7 @@ export interface FactionV2 extends BaseSchema {
             params: "striptags" | "timestamp";
         };
         news: {
-            response: FactionNewsResponse;
+            response: NewsResponse;
             params: "striptags" | "limit" | "sort" | "to" | "from" | "cat" | "timestamp";
         };
         positions: {
@@ -7423,6 +7432,14 @@ export interface CompanyV2 extends BaseSchema {
             response: CompanyEmployeesResponse;
             params: "striptags" | "timestamp";
         };
+        news: {
+            response: NewsResponse;
+            params: "striptags" | "limit" | "sort" | "to" | "from" | "cat" | "timestamp";
+        };
+        companies: {
+            response: CompaniesResponse;
+            params: "typeId" | "limit" | "offset" | "striptags" | "timestamp";
+        };
         profile: {
             response: CompanyProfileResponseMixed;
             params: "striptags" | "timestamp";

package/dist/index.ts

@@ -4447,6 +4447,13 @@ export type FactionNewsCategory =
     | "depositFunds"
     | "giveFunds";
 
+export type CompanyNewsCategory =
+    | "main"
+    | "funds"
+    | "training"
+    | "employees"
+    | "all";
+
 export type FactionRankEnum =
     | "Unranked"
     | "Bronze"
@@ -7796,6 +7803,7 @@ export interface FactionTerritoryWarReportResponse {
 
 export interface FactionTerritoryOwnership {
     id: string;
+    irradiated: boolean;
     owned_by: FactionId | null;
     acquired_at: number | null;
 }
@@ -8056,14 +8064,14 @@ export interface FactionWarsResponse {
     wars: FactionWars;
 }
 
-export interface FactionNews {
+export interface News {
     id: string;
     text: string;
     timestamp: number;
 }
 
-export interface FactionNewsResponse {
-    news: FactionNews[];
+export interface NewsResponse {
+    news: News[];
     _metadata: RequestMetadataWithLinks;
 }
 
@@ -8390,7 +8398,7 @@ export interface FactionRankedWarReportResponse {
 }
 
 /**
- * The following selections will fallback to API v1 and may change at any time: 'companies', 'news', 'search'.
+ * The following selections will fallback to API v1 and may change at any time: 'companies', 'search'.
  *  *  The following selections are not available in API v2: 'details'.
  */
 export type CompanySelectionName = string;
@@ -8399,6 +8407,14 @@ export interface CompanyLookupResponse {
     selections: CompanySelectionName[];
 }
 
+export interface CompaniesResponse {
+    companies: CompanyProfile[];
+    companies_timestamp: number;
+    /** The minimum amount of time needed before the cache timestamp can change. */
+    companies_delay: number;
+    _metadata: RequestMetadataWithLinksAndTotal;
+}
+
 export interface CompanyProfileResponse {
     profile: CompanyProfile;
 }
@@ -9502,7 +9518,7 @@ export interface TornBountiesResponse {
     bounties: Bounty[];
     bounties_timestamp: number;
     /** The minimum amount of time needed before the cache timestamp can change. */
-    bounties_delay?: number;
+    bounties_delay: number;
     _metadata: RequestMetadataWithLinksAndTotal;
 }
 
@@ -13333,7 +13349,7 @@ export interface FactionV2 extends BaseSchema {
             params: "striptags" | "timestamp";
         };
         news: {
-            response: FactionNewsResponse;
+            response: NewsResponse;
             params:
                 | "striptags"
                 | "limit"
@@ -13455,6 +13471,21 @@ export interface CompanyV2 extends BaseSchema {
             response: CompanyEmployeesResponse;
             params: "striptags" | "timestamp";
         };
+        news: {
+            response: NewsResponse;
+            params:
+                | "striptags"
+                | "limit"
+                | "sort"
+                | "to"
+                | "from"
+                | "cat"
+                | "timestamp";
+        };
+        companies: {
+            response: CompaniesResponse;
+            params: "typeId" | "limit" | "offset" | "striptags" | "timestamp";
+        };
         profile: {
             response: CompanyProfileResponseMixed;
             params: "striptags" | "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.8.1"
+    "version": "5.9.0"
   },
   "servers": [
     {
@@ -4923,7 +4923,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/FactionNewsResponse"
+                  "$ref": "#/components/schemas/NewsResponse"
                 }
               }
             }
@@ -6339,7 +6339,7 @@
                       "$ref": "#/components/schemas/FactionWarsResponse"
                     },
                     {
-                      "$ref": "#/components/schemas/FactionNewsResponse"
+                      "$ref": "#/components/schemas/NewsResponse"
                     },
                     {
                       "$ref": "#/components/schemas/RevivesResponse"
@@ -6568,6 +6568,126 @@
         "x-stability": "Unstable"
       }
     },
+    "/company/news": {
+      "get": {
+        "tags": [
+          "Company"
+        ],
+        "summary": "Get your company's news details",
+        "description": "Requires minimal access key. <br>",
+        "operationId": "getMyCompanyNews",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiStripTagsFalse"
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSortDesc"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
+          },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "News category type",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/CompanyNewsCategory"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyMinimal"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/NewsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
+    "/company/{typeId}/companies": {
+      "get": {
+        "tags": [
+          "Company"
+        ],
+        "summary": "Get a list of companies for a specific company type",
+        "description": "Requires public access key. <br>",
+        "operationId": "getCompaniesList",
+        "parameters": [
+          {
+            "name": "typeId",
+            "in": "path",
+            "description": "Company type id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/CompanyTypeId"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffsetNoDefault"
+          },
+          {
+            "$ref": "#/components/parameters/ApiStripTagsTrue"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CompaniesResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/company/profile": {
       "get": {
         "tags": [
@@ -6827,6 +6947,19 @@
               }
             }
           },
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Selection category",
+            "required": false,
+            "schema": {
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/CompanyNewsCategory"
+                }
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit"
           },
@@ -6868,6 +7001,9 @@
                     {
                       "$ref": "#/components/schemas/CompanyProfileResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/NewsResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/CompanyStockResponse"
                     },
@@ -15031,6 +15167,16 @@
           "giveFunds"
         ]
       },
+      "CompanyNewsCategory": {
+        "type": "string",
+        "enum": [
+          "main",
+          "funds",
+          "training",
+          "employees",
+          "all"
+        ]
+      },
       "FactionRankEnum": {
         "type": "string",
         "enum": [
@@ -26124,12 +26270,16 @@
         "required": [
           "id",
           "owned_by",
-          "acquired_at"
+          "acquired_at",
+          "irradiated"
         ],
         "properties": {
           "id": {
             "type": "string"
           },
+          "irradiated": {
+            "type": "boolean"
+          },
           "owned_by": {
             "oneOf": [
               {
@@ -27143,7 +27293,7 @@
         },
         "type": "object"
       },
-      "FactionNews": {
+      "News": {
         "required": [
           "id",
           "text",
@@ -27163,7 +27313,7 @@
         },
         "type": "object"
       },
-      "FactionNewsResponse": {
+      "NewsResponse": {
         "required": [
           "news",
           "_metadata"
@@ -27172,7 +27322,7 @@
           "news": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/FactionNews"
+              "$ref": "#/components/schemas/News"
             }
           },
           "_metadata": {
@@ -28559,17 +28709,17 @@
       "CompanySelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'companies', 'news', 'search'.\n *  The following selections are not available in API v2: 'details'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'companies', 'search'.\n *  The following selections are not available in API v2: 'details'.",
             "type": "string",
             "enum": [
               "applications",
               "employees",
               "lookup",
+              "news",
               "profile",
               "stock",
               "timestamp",
               "companies",
-              "news",
               "search"
             ]
           },
@@ -28592,6 +28742,35 @@
         },
         "type": "object"
       },
+      "CompaniesResponse": {
+        "required": [
+          "companies",
+          "companies_timestamp",
+          "companies_delay",
+          "_metadata"
+        ],
+        "properties": {
+          "companies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CompanyProfile"
+            }
+          },
+          "companies_timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "companies_delay": {
+            "description": "The minimum amount of time needed before the cache timestamp can change.",
+            "type": "integer",
+            "format": "int32"
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinksAndTotal"
+          }
+        },
+        "type": "object"
+      },
       "CompanyProfileResponse": {
         "required": [
           "profile"
@@ -33202,6 +33381,7 @@
         "required": [
           "bounties",
           "bounties_timestamp",
+          "bounties_delay",
           "_metadata"
         ],
         "properties": {

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "5.8.1",
+  "version": "5.9.0",
+  "repository": {
+    "url": "https://github.com/Torn-Playground/tornapi-typescript"
+  },
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.8.0",
-    "@types/node": "^24.12.3",
+    "@scalar/openapi-types": "^0.9.0",
+    "@types/node": "^25.9.1",
     "prettier": "^3.8.3",
     "typeconv": "^2.3.1",
     "typescript": "^6.0.3"