tornapi-typescript 6.6.0 → 6.7.0

package/dist/index.d.ts

@@ -88,6 +88,8 @@ export type RaidWarId = number;
 export type ItemUid = number;
 export type UserId = number;
 export type CompanyPositionId = number;
+export type CompanySpecialId = number;
+export type CompanyStockId = number;
 export type TradeId = number;
 export type StockId = number;
 export type DiscordId = string;
@@ -2883,7 +2885,7 @@ export interface CompanyStockResponse {
 }
 export interface CompanyStockItem {
     name: string;
-    id: number;
+    id: CompanyStockId;
     cost: number;
     rrp: number;
     price: number;
@@ -3358,6 +3360,49 @@ export type PropertySelectionName = string;
 export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
+export interface TornCompaniesResponse {
+    companies: TornCompany[];
+}
+export interface TornCompany {
+    id: CompanyTypeId;
+    name: string;
+    cost: number;
+    employees: number;
+    positions: TornCompanyPosition[];
+    specials: TornCompanySpecial[];
+    stock: TornCompanyStock[];
+}
+export interface TornCompanyPosition {
+    id: CompanyPositionId;
+    name: string;
+    description: string;
+    ability: string;
+    working_stats: {
+        required: {
+            intelligence: number;
+            manual_labor: number;
+            endurance: number;
+        };
+        daily_gains: {
+            intelligence: number;
+            manual_labor: number;
+            endurance: number;
+        };
+    };
+}
+export interface TornCompanySpecial {
+    id: CompanySpecialId;
+    name: string;
+    effect: string;
+    cost: number;
+    rating: number;
+}
+export interface TornCompanyStock {
+    id: CompanyStockId;
+    name: string;
+    cost: number;
+    rrp: number;
+}
 export interface TornStock {
     id: StockId;
     name: string;
@@ -7717,6 +7762,10 @@ export interface TornV2 extends BaseSchema {
             response: TornCalendarResponse;
             params: "timestamp";
         };
+        companies: {
+            response: TornCompaniesResponse;
+            params: "timestamp";
+        };
         crimes: {
             response: TornCrimesResponse;
             params: "timestamp";

package/dist/index.ts

@@ -4745,6 +4745,10 @@ export type UserId = number;
 
 export type CompanyPositionId = number;
 
+export type CompanySpecialId = number;
+
+export type CompanyStockId = number;
+
 export type TradeId = number;
 
 export type StockId = number;
@@ -8547,7 +8551,7 @@ export interface CompanyStockResponse {
 
 export interface CompanyStockItem {
     name: string;
-    id: number;
+    id: CompanyStockId;
     cost: number;
     rrp: number;
     price: number;
@@ -9099,6 +9103,54 @@ export interface PropertyLookupResponse {
     selections: PropertySelectionName[];
 }
 
+export interface TornCompaniesResponse {
+    companies: TornCompany[];
+}
+
+export interface TornCompany {
+    id: CompanyTypeId;
+    name: string;
+    cost: number;
+    employees: number;
+    positions: TornCompanyPosition[];
+    specials: TornCompanySpecial[];
+    stock: TornCompanyStock[];
+}
+
+export interface TornCompanyPosition {
+    id: CompanyPositionId;
+    name: string;
+    description: string;
+    ability: string;
+    working_stats: {
+        required: {
+            intelligence: number;
+            manual_labor: number;
+            endurance: number;
+        };
+        daily_gains: {
+            intelligence: number;
+            manual_labor: number;
+            endurance: number;
+        };
+    };
+}
+
+export interface TornCompanySpecial {
+    id: CompanySpecialId;
+    name: string;
+    effect: string;
+    cost: number;
+    rating: number;
+}
+
+export interface TornCompanyStock {
+    id: CompanyStockId;
+    name: string;
+    cost: number;
+    rrp: number;
+}
+
 export interface TornStock {
     id: StockId;
     name: string;
@@ -13675,6 +13727,10 @@ export interface TornV2 extends BaseSchema {
             response: TornCalendarResponse;
             params: "timestamp";
         };
+        companies: {
+            response: TornCompaniesResponse;
+            params: "timestamp";
+        };
         crimes: {
             response: TornCrimesResponse;
             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": "6.6.0"
+    "version": "6.7.0"
   },
   "servers": [
     {
@@ -3287,7 +3287,7 @@
           "User"
         ],
         "summary": "Get daily active players snapshot CSV",
-        "description": "Requires public access key.<br>Returns a CSV daily snapshot of active players.<br>This selection is standalone and cannot be used together with other selections.<br>\nCSV columns: id, name, gender, role, signed_up, last_action, level, rank, donator, networth, faction, company, spouse, display_case, bazaar, location, fed, fed_reason",
+        "description": "Requires public access key.<br>Returns a CSV daily snapshot of active players.<br>This selection is standalone and cannot be used together with other selections.<br>\nCSV columns: id, name, gender, signed_up, level, rank, donator, faction, company, job, spouse, display_case, bazaar, fed, fed_reason, time_played, awards",
         "operationId": "getUsersSnapshot",
         "parameters": [
           {
@@ -3307,7 +3307,7 @@
               "text/csv": {
                 "schema": {
                   "type": "string",
-                  "example": "id,name,gender,role,signed_up,last_action,level,rank,donator,networth,faction,company,spouse,display_case,bazaar,location,fed,fed_reason\\n33,1,Chedburn,Male,Admin,1100521336,1785154349,15,Outstanding,1,299829600590,40992,79286,2103253,1,1,Torn,0,"
+                  "example": "id,name,gender,signed_up,level,rank,donator,faction,company,job,spouse,display_case,bazaar,fed,fed_reason,time_played,awards\\n33,1,Chedburn,Male,1100521336,15,Outstanding,1,40992,79286,,2103253,1,1,0,,48076299,1388"
                 }
               }
             }
@@ -9411,6 +9411,93 @@
         "x-stability": "Stable"
       }
     },
+    "/torn/companies": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get all companies details",
+        "description": "Requires public access key. <br>",
+        "operationId": "getTornCompanies",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TornCompaniesResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
+    "/torn/{typeId}/companies": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get specific company details",
+        "description": "Requires public access key. <br>",
+        "operationId": "getTornCompaniesSpecific",
+        "parameters": [
+          {
+            "name": "typeId",
+            "in": "path",
+            "description": "Company type id",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/CompanyTypeId"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TornCompaniesResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/torn/crimes": {
       "get": {
         "tags": [
@@ -16008,6 +16095,14 @@
         "type": "integer",
         "format": "int32"
       },
+      "CompanySpecialId": {
+        "type": "integer",
+        "format": "int32"
+      },
+      "CompanyStockId": {
+        "type": "integer",
+        "format": "int32"
+      },
       "TradeId": {
         "type": "integer",
         "format": "int64"
@@ -30046,8 +30141,7 @@
             "type": "string"
           },
           "id": {
-            "type": "integer",
-            "format": "int32"
+            "$ref": "#/components/schemas/CompanyStockId"
           },
           "cost": {
             "type": "integer",
@@ -32443,6 +32537,197 @@
         },
         "type": "object"
       },
+      "TornCompaniesResponse": {
+        "required": [
+          "companies"
+        ],
+        "properties": {
+          "companies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornCompany"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "TornCompany": {
+        "required": [
+          "id",
+          "name",
+          "cost",
+          "employees",
+          "positions",
+          "specials",
+          "stock"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/CompanyTypeId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "cost": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "employees": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "positions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornCompanyPosition"
+            }
+          },
+          "specials": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornCompanySpecial"
+            }
+          },
+          "stock": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornCompanyStock"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "TornCompanyPosition": {
+        "required": [
+          "id",
+          "name",
+          "description",
+          "ability",
+          "working_stats"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/CompanyPositionId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "ability": {
+            "type": "string"
+          },
+          "working_stats": {
+            "required": [
+              "required",
+              "daily_gains"
+            ],
+            "properties": {
+              "required": {
+                "required": [
+                  "intelligence",
+                  "manual_labor",
+                  "endurance"
+                ],
+                "properties": {
+                  "intelligence": {
+                    "type": "integer",
+                    "format": "int32"
+                  },
+                  "manual_labor": {
+                    "type": "integer",
+                    "format": "int32"
+                  },
+                  "endurance": {
+                    "type": "integer",
+                    "format": "int32"
+                  }
+                },
+                "type": "object"
+              },
+              "daily_gains": {
+                "required": [
+                  "intelligence",
+                  "manual_labor",
+                  "endurance"
+                ],
+                "properties": {
+                  "intelligence": {
+                    "type": "integer",
+                    "format": "int32"
+                  },
+                  "manual_labor": {
+                    "type": "integer",
+                    "format": "int32"
+                  },
+                  "endurance": {
+                    "type": "integer",
+                    "format": "int32"
+                  }
+                },
+                "type": "object"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "TornCompanySpecial": {
+        "required": [
+          "id",
+          "name",
+          "effect",
+          "cost",
+          "rating"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/CompanySpecialId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "effect": {
+            "type": "string"
+          },
+          "cost": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "rating": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "TornCompanyStock": {
+        "required": [
+          "id",
+          "name",
+          "cost",
+          "rrp"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/CompanyStockId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "cost": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "rrp": {
+            "type": "integer",
+            "format": "int64"
+          }
+        },
+        "type": "object"
+      },
       "TornStock": {
         "required": [
           "id",

package/package.json

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