tornapi-typescript 0.1.3 → 0.1.4

package/dist/index.d.ts

@@ -4511,6 +4511,8 @@ export type LogCategoryId = number;
 
 export type FactionId = number;
 
+export type EducationId = number;
+
 export type FactionBranchId = number;
 
 export type FactionCrimeId = number;
@@ -5410,11 +5412,16 @@ export type FactionSelectionName =
     | "lookup"
     | "members"
     | "news"
+    | "rackets"
     | "rankedwars"
     | "rankedwarreport"
     | "revives"
     | "revivesfull"
     | "stats"
+    | "territory"
+    | "territoryownership"
+    | "territorywarreport"
+    | "territorywars"
     | "timestamp"
     | "upgrades"
     | "wars"
@@ -5428,7 +5435,6 @@ export type FactionSelectionName =
     | "positions"
     | "reports"
     | "temporary"
-    | "territory"
     | "weapons";
 
 export interface FactionLookupResponse {
@@ -5806,6 +5812,41 @@ export interface RacingLookupResponse {
     selections: RacingSelectionName[];
 }
 
+export interface TornEducationRewards {
+    working_stats: {
+        manual_labor: number | null;
+        intelligence: number | null;
+        endurance: number | null;
+    };
+    effect: string | null;
+    honor: string | null;
+}
+
+export interface TornEducationPrerequisites {
+    cost: number;
+    courses: number[];
+}
+
+export interface TornEducationCourses {
+    id: EducationId;
+    code: string;
+    name: string;
+    description: string;
+    duration: number;
+    rewards: TornEducationRewards;
+    prerequisites: TornEducationPrerequisites;
+}
+
+export interface TornEducation {
+    id: number;
+    name: string;
+    courses: TornEducationCourses[];
+}
+
+export interface TornEducationResponse {
+    education: TornEducation[];
+}
+
 export interface TornTerritoryCoordinates {
     x: number;
     y: number;
@@ -6099,12 +6140,13 @@ export interface TornFactionTreeResponse {
     factionTree: TornFactionTree;
 }
 
-/** The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','dirtybombs','education','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','rackets','raidreport','raids','rockpaperscissors','searchforcash','shoplifting','stats','stocks'. */
+/** The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','dirtybombs','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','raidreport','raids','rockpaperscissors','searchforcash','shoplifting','stats','stocks'. */
 export type TornSelectionName =
     | "attacklog"
     | "bounties"
     | "calendar"
     | "crimes"
+    | "education"
     | "factionHof"
     | "factiontree"
     | "hof"
@@ -6123,7 +6165,6 @@ export type TornSelectionName =
     | "companies"
     | "competition"
     | "dirtybombs"
-    | "education"
     | "gyms"
     | "honors"
     | "itemdetails"
@@ -6133,11 +6174,8 @@ export type TornSelectionName =
     | "pawnshop"
     | "pokertables"
     | "properties"
-    | "rackets"
     | "raidreport"
     | "raids"
-    | "rankedwarreport"
-    | "rankedwars"
     | "rockpaperscissors"
     | "searchforcash"
     | "shoplifting"
@@ -7059,6 +7097,20 @@ export type PersonalStatsStatName =
     | "forgeryskill"
     | "scammingskill";
 
+export interface UserCurrentEducation {
+    id: EducationId;
+    until: number;
+}
+
+export interface UserEducation {
+    complete: EducationId[];
+    current: UserCurrentEducation | null;
+}
+
+export interface UserEducationResponse {
+    education: UserEducation;
+}
+
 export interface UserCrimeDetailsBootlegging {
     /** Online store statistics. */
     online_store: {

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": "1.2.0"
+    "version": "1.3.0"
   },
   "servers": [
     {
@@ -224,6 +224,33 @@
         "x-stability": "Stable"
       }
     },
+    "/user/education": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your education information",
+        "description": "The response contains a list of complete eduactions and of a current education (if any).",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserEducationResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/enlistedcars": {
       "get": {
         "tags": [
@@ -1180,6 +1207,9 @@
                     {
                       "$ref": "#/components/schemas/UserCalendarResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserEducationResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserBountiesResponse"
                     },
@@ -3865,6 +3895,33 @@
         "x-stability": "Stable"
       }
     },
+    "/torn/education": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get education information",
+        "description": "Requires public access key.<br>",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TornEducationResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/torn/factionhof": {
       "get": {
         "tags": [
@@ -4283,7 +4340,7 @@
         "x-stability": "Unstable"
       }
     },
-    "/torn/{territoryIds}/territories": {
+    "/torn/{territoryIds}/territory": {
       "get": {
         "tags": [
           "Torn"
@@ -4486,6 +4543,9 @@
                     {
                       "$ref": "#/components/schemas/TornLogCategoriesResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/TornEducationResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/TornBountiesResponse"
                     },
@@ -9176,6 +9236,10 @@
         "type": "integer",
         "format": "int32"
       },
+      "EducationId": {
+        "type": "integer",
+        "format": "int32"
+      },
       "FactionBranchId": {
         "type": "integer",
         "format": "int32"
@@ -12263,11 +12327,16 @@
           "lookup",
           "members",
           "news",
+          "rackets",
           "rankedwars",
           "rankedwarreport",
           "revives",
           "revivesfull",
           "stats",
+          "territory",
+          "territoryownership",
+          "territorywarreport",
+          "territorywars",
           "timestamp",
           "upgrades",
           "wars",
@@ -12281,7 +12350,6 @@
           "positions",
           "reports",
           "temporary",
-          "territory",
           "weapons"
         ]
       },
@@ -13811,6 +13879,172 @@
         },
         "type": "object"
       },
+      "TornEducationRewards": {
+        "required": [
+          "working_stats",
+          "effect",
+          "honor"
+        ],
+        "properties": {
+          "working_stats": {
+            "required": [
+              "manual_labor",
+              "intelligence",
+              "endurance"
+            ],
+            "properties": {
+              "manual_labor": {
+                "oneOf": [
+                  {
+                    "type": "integer",
+                    "format": "int32"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "intelligence": {
+                "oneOf": [
+                  {
+                    "type": "integer",
+                    "format": "int32"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "endurance": {
+                "oneOf": [
+                  {
+                    "type": "integer",
+                    "format": "int32"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "type": "object"
+          },
+          "effect": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "honor": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "TornEducationPrerequisites": {
+        "required": [
+          "cost",
+          "courses"
+        ],
+        "properties": {
+          "cost": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "courses": {
+            "type": "array",
+            "items": {
+              "type": "integer",
+              "format": "int32"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "TornEducationCourses": {
+        "required": [
+          "id",
+          "code",
+          "name",
+          "description",
+          "duration",
+          "rewards",
+          "prerequisites"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/EducationId"
+          },
+          "code": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "duration": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "rewards": {
+            "$ref": "#/components/schemas/TornEducationRewards"
+          },
+          "prerequisites": {
+            "$ref": "#/components/schemas/TornEducationPrerequisites"
+          }
+        },
+        "type": "object"
+      },
+      "TornEducation": {
+        "required": [
+          "id",
+          "name",
+          "courses"
+        ],
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "name": {
+            "type": "string"
+          },
+          "courses": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornEducationCourses"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "TornEducationResponse": {
+        "required": [
+          "education"
+        ],
+        "properties": {
+          "education": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornEducation"
+            }
+          }
+        },
+        "type": "object"
+      },
       "TornTerritoryCoordinates": {
         "required": [
           "x",
@@ -15044,13 +15278,14 @@
         "type": "object"
       },
       "TornSelectionName": {
-        "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','dirtybombs','education','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','rackets','raidreport','raids','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.",
+        "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','dirtybombs','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','raidreport','raids','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.",
         "type": "string",
         "enum": [
           "attacklog",
           "bounties",
           "calendar",
           "crimes",
+          "education",
           "factionHof",
           "factiontree",
           "hof",
@@ -15069,7 +15304,6 @@
           "companies",
           "competition",
           "dirtybombs",
-          "education",
           "gyms",
           "honors",
           "itemdetails",
@@ -15079,11 +15313,8 @@
           "pawnshop",
           "pokertables",
           "properties",
-          "rackets",
           "raidreport",
           "raids",
-          "rankedwarreport",
-          "rankedwars",
           "rockpaperscissors",
           "searchforcash",
           "shoplifting",
@@ -18113,6 +18344,58 @@
           "scammingskill"
         ]
       },
+      "UserCurrentEducation": {
+        "required": [
+          "id",
+          "until"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/EducationId"
+          },
+          "until": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserEducation": {
+        "required": [
+          "complete",
+          "current"
+        ],
+        "properties": {
+          "complete": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EducationId"
+            }
+          },
+          "current": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/UserCurrentEducation"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "UserEducationResponse": {
+        "required": [
+          "education"
+        ],
+        "properties": {
+          "education": {
+            "$ref": "#/components/schemas/UserEducation"
+          }
+        },
+        "type": "object"
+      },
       "UserCrimeDetailsBootlegging": {
         "required": [
           "online_store",

package/package.json

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