tornapi-typescript 4.3.7 → 4.4.0

package/dist/index.d.ts

@@ -48,6 +48,7 @@ export type WeaponBonusEnum = "Any" | "Double" | "Yellow" | "Orange" | "Red" | "
 export type UserListEnum = "Friends" | "Enemies" | "Targets";
 export type JobPositionCasinoEnum = "Gaming Consultant" | "Marketing Manager" | "Revenue Manager" | "Casino Manager" | "Casino President";
 export type AttackFinishingHitEffect = "proficience" | "stricken" | "revitalize" | "warlord" | "plunder" | "irradiate";
+export type ApiFiltersAttacksRevivesEnum = "incoming" | "outgoing" | "idFilter";
 export type JobPositionMedicalEnum = "Medical Student" | "Houseman" | "Senior Houseman" | "GP" | "Consultant" | "Surgeon" | "Brain Surgeon";
 export type JobPositionLawEnum = "Law Student" | "Paralegal" | "Probate Lawyer" | "Trial Lawyer" | "Circuit Court Judge" | "Federal Judge";
 export type JobPositionEducationEnum = "Recess Supervisor" | "Substitute Teacher" | "Elementary Teacher" | "Secondary Teacher" | "Professor" | "Vice-Principal" | "Principal";
@@ -124,6 +125,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" | "Unknown Rarity";
+export type AwardCrimesVersionEnum = "v1" | "v2";
 export type Parameters = string;
 export type ReviveSetting = "Everyone" | "Friends & faction" | "No one" | "Unknown";
 export type FactionWarfareTypeEnum = "ranked" | "territory" | "raid" | "chain" | "chainOngoing" | "db";
@@ -672,6 +674,19 @@ export interface UserBattleStatModifierDetail {
     value: number;
     type: string;
 }
+export interface UserAmmoResponse {
+    ammo?: UserAmmo[];
+}
+export interface UserAmmo {
+    id: AmmoId;
+    name: string;
+    types: UserAmmoType[];
+}
+export interface UserAmmoType {
+    name: TornItemAmmoTypeEnum;
+    quantity: number;
+    equipped: boolean;
+}
 export interface UserBasic {
     id: UserId;
     name: string;
@@ -1062,7 +1077,7 @@ export interface UserListResponse {
     list: UserList[];
     _metadata: RequestMetadataWithLinks;
 }
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
     selections: UserSelectionName[];
@@ -2782,6 +2797,7 @@ export interface TornHonor {
     circulation?: number;
     equipped?: number;
     rarity?: HonorRarityEnum;
+    crimes_version?: AwardCrimesVersionEnum;
 }
 export interface TornHonorsResponse {
     honors: TornHonor[];
@@ -2796,6 +2812,7 @@ export interface TornMedal {
     };
     circulation: number;
     rarity: HonorRarityEnum;
+    crimes_version?: AwardCrimesVersionEnum;
 }
 export interface TornMedalsResponse {
     medals: TornMedal[];
@@ -6407,6 +6424,10 @@ export interface SectionsV1Map {
 }
 export interface UserV2 extends BaseSchema {
     selections: {
+        ammo: {
+            response: UserAmmoResponse;
+            params: "timestamp";
+        };
         attacks: {
             response: FactionAttacksResponse;
             params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";

package/dist/index.ts

@@ -4629,6 +4629,8 @@ export type AttackFinishingHitEffect =
     | "plunder"
     | "irradiate";
 
+export type ApiFiltersAttacksRevivesEnum = "incoming" | "outgoing" | "idFilter";
+
 export type JobPositionMedicalEnum =
     | "Medical Student"
     | "Houseman"
@@ -4852,6 +4854,8 @@ export type HonorRarityEnum =
     | "Unknown"
     | "Unknown Rarity";
 
+export type AwardCrimesVersionEnum = "v1" | "v2";
+
 export type Parameters = string;
 
 export type ReviveSetting =
@@ -5685,6 +5689,22 @@ export interface UserBattleStatModifierDetail {
     type: string;
 }
 
+export interface UserAmmoResponse {
+    ammo?: UserAmmo[];
+}
+
+export interface UserAmmo {
+    id: AmmoId;
+    name: string;
+    types: UserAmmoType[];
+}
+
+export interface UserAmmoType {
+    name: TornItemAmmoTypeEnum;
+    quantity: number;
+    equipped: boolean;
+}
+
 export interface UserBasic {
     id: UserId;
     name: string;
@@ -6156,7 +6176,7 @@ export interface UserListResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'. */
 export type UserSelectionName = string;
 
 export interface UserLookupResponse {
@@ -8394,6 +8414,7 @@ export interface TornHonor {
     circulation?: number;
     equipped?: number;
     rarity?: HonorRarityEnum;
+    crimes_version?: AwardCrimesVersionEnum;
 }
 
 export interface TornHonorsResponse {
@@ -8410,6 +8431,7 @@ export interface TornMedal {
     };
     circulation: number;
     rarity: HonorRarityEnum;
+    crimes_version?: AwardCrimesVersionEnum;
 }
 
 export interface TornMedalsResponse {
@@ -12140,6 +12162,10 @@ export interface SectionsV1Map {
 }
 export interface UserV2 extends BaseSchema {
     selections: {
+        ammo: {
+            response: UserAmmoResponse;
+            params: "timestamp";
+        };
         attacks: {
             response: FactionAttacksResponse;
             params: "filters" | "limit" | "sort" | "to" | "from" | "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": "4.3.7"
+    "version": "4.4.0"
   },
   "servers": [
     {
@@ -12,6 +12,45 @@
     }
   ],
   "paths": {
+    "/user/ammo": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your ammo information",
+        "description": "Requires public minimal key. <br>",
+        "operationId": "39826224a85f3a0dde89080ce7489685",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyMinimal"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserAmmoResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/attacks": {
       "get": {
         "tags": [
@@ -13856,6 +13895,14 @@
           "irradiate"
         ]
       },
+      "ApiFiltersAttacksRevivesEnum": {
+        "type": "string",
+        "enum": [
+          "incoming",
+          "outgoing",
+          "idFilter"
+        ]
+      },
       "JobPositionMedicalEnum": {
         "type": "string",
         "enum": [
@@ -14252,6 +14299,13 @@
           "Unknown Rarity"
         ]
       },
+      "AwardCrimesVersionEnum": {
+        "type": "string",
+        "enum": [
+          "v1",
+          "v2"
+        ]
+      },
       "Parameters": {
         "oneOf": [
           {
@@ -17158,6 +17212,59 @@
         },
         "type": "object"
       },
+      "UserAmmoResponse": {
+        "properties": {
+          "ammo": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserAmmo"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserAmmo": {
+        "required": [
+          "id",
+          "name",
+          "types"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/AmmoId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "types": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserAmmoType"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserAmmoType": {
+        "required": [
+          "name",
+          "quantity",
+          "equipped"
+        ],
+        "properties": {
+          "name": {
+            "$ref": "#/components/schemas/TornItemAmmoTypeEnum"
+          },
+          "quantity": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "equipped": {
+            "type": "boolean"
+          }
+        },
+        "type": "object"
+      },
       "UserBasic": {
         "required": [
           "id",
@@ -19062,9 +19169,10 @@
       "UserSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'bazaar','criminalrecord','discord','display','equipment','gym','inventory','networth','perks','stocks','weaponexp'.",
             "type": "string",
             "enum": [
+              "ammo",
               "attacks",
               "attacksfull",
               "bars",
@@ -19117,7 +19225,6 @@
               "timestamp",
               "travel",
               "workstats",
-              "ammo",
               "bazaar",
               "criminalrecord",
               "discord",
@@ -27636,6 +27743,10 @@
           },
           "rarity": {
             "$ref": "#/components/schemas/HonorRarityEnum"
+          },
+          "crimes_version": {
+            "$ref": "#/components/schemas/AwardCrimesVersionEnum",
+            "description": "Populated only when the type.id is 5."
           }
         },
         "type": "object"
@@ -27695,6 +27806,10 @@
           },
           "rarity": {
             "$ref": "#/components/schemas/HonorRarityEnum"
+          },
+          "crimes_version": {
+            "$ref": "#/components/schemas/AwardCrimesVersionEnum",
+            "description": "Populated only when the type.id is 'CRM'."
           }
         },
         "type": "object"
@@ -29482,14 +29597,15 @@
       "ApiFiltersIncomingOutgoing": {
         "name": "filters",
         "in": "query",
-        "description": "It's possible to use this query parameter to only get incoming or outgoing attacks / revives. If not specified, this selection will return both incoming and outgoing attacks / revives.",
+        "description": "It's possible to use this query parameter to only get incoming or outgoing attacks / revives. If not specified, this selection will return both incoming and outgoing attacks / revives.\nIt's also possible to combine this with 'idFilter'. This filter allows using from/to to filter by ids instead of timestamps.",
         "required": false,
+        "style": "form",
+        "explode": false,
         "schema": {
-          "type": "string",
-          "enum": [
-            "incoming",
-            "outgoing"
-          ]
+          "type": "array",
+          "items": {
+            "$ref": "#/components/schemas/ApiFiltersAttacksRevivesEnum"
+          }
         }
       },
       "ApiFiltersUser": {

package/package.json

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