tornapi-typescript 0.0.4 → 0.0.6

package/dist/index.d.ts

@@ -178,6 +178,8 @@ export type WeaponBonusEnum =
     | "Wind-up"
     | "Wither";
 
+export type UserListEnum = "Friends" | "Enemies" | "Targets";
+
 export type JobPositionCasinoEnum =
     | "Gaming Consultant"
     | "Marketing Manager"
@@ -281,6 +283,13 @@ export type FactionApplicationStatusEnum =
 
 export type FactionRankedWarsCategoryEnum = "all" | "ongoing";
 
+export type FactionCrimeUserOutcome =
+    | "Successful"
+    | "Failed"
+    | "Jailed"
+    | "Injured"
+    | "Hospitalized";
+
 export type RaceId = number;
 
 export type RaceTrackId = number;
@@ -301,6 +310,13 @@ export type ItemUid = number;
 
 export type UserId = number;
 
+export type UserIdNullable = number | null;
+
+export type UserIdNullableDeprecated =
+    /** This field is replaced with the 'user.id' and will be removed on the 1st of May 2025. */
+    | number /** This field is replaced with the 'user.id' and will be removed on the 1st of May 2025. */
+    | null;
+
 export type ReviveId = number;
 
 export type LogId = number;
@@ -309,6 +325,8 @@ export type LogCategoryId = number;
 
 export type FactionId = number;
 
+export type FactionIdNullable = number | null;
+
 export type FactionCrimeId = number;
 
 export type ChainId = number;
@@ -919,6 +937,7 @@ export interface FactionChainReportAttackerAttacks {
 
 export interface FactionCrimeUser {
     id: UserId;
+    outcome: FactionCrimeUserOutcome;
     /** The timestamp at which the user joined the slot. */
     joined_at: number;
     /** Current planning progress on the slot. */
@@ -942,23 +961,27 @@ export interface FactionCrimeReward {
     money: number;
     items: FactionCrimeRewardItem[];
     respect: number;
+    scope: number;
     payout: FactionCrimeRewardPayout | null;
 }
 
 export interface FactionCrimeSlot {
     position: string;
     item_requirement: {
-        id?: ItemId;
+        id: ItemId;
         /** Shows if the item is reusable or consumed during the crime. */
-        is_reusable?: boolean;
+        is_reusable: boolean;
         /** Shows if user has the required item. */
-        is_available?: boolean;
+        is_available: boolean;
     } | null;
-    user_id: UserId;
+    user_id: UserIdNullableDeprecated;
     user: FactionCrimeUser | null;
-    /** This field is replaced with 'crime_pass_rate' field and will be removed on 1st of May 2025. */
+    /** This field is replaced with 'checkpoint_pass_rate' field and will be removed on 1st of May 2025. */
     success_chance: number;
+    /** This field is replaced with 'checkpoint_pass_rate' field and will be removed on 1st of May 2025. */
     crime_pass_rate: number;
+    /** Returns CPR for the player who joined the slot. If the slot is empty (availalbe), it shows your CPR for that slot. This value is 0 for expired crimes. */
+    checkpoint_pass_rate: number;
 }
 
 export interface FactionCrime {
@@ -1614,7 +1637,7 @@ export interface TornItemWeaponDetails {
     base_stats: TornItemBaseStats;
     category: TornItemWeaponCategoryEnum;
     ammo: {
-        "": AmmoId;
+        id: AmmoId;
         name: string;
         magazine_rounds: number;
         rate_of_fire: {
@@ -2938,6 +2961,20 @@ export interface UserOrganizedCrimeResponse {
     organizedCrime: FactionCrime | null;
 }
 
+export interface UserList {
+    id: UserId;
+    name: string;
+    level: number;
+    faction_id: FactionId & (number | null);
+    last_action: UserLastAction;
+    status: UserStatus;
+}
+
+export interface UserListResponse {
+    list: UserList[];
+    _metadata: RequestMetadataWithLinks;
+}
+
 /** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','properties','refills','reports','skills','stocks','travel','weaponexp','workstats'. */
 export type UserSelectionName =
     | "attacks"
@@ -2955,6 +2992,7 @@ export type UserSelectionName =
     | "hof"
     | "itemmarket"
     | "jobranks"
+    | "list"
     | "lookup"
     | "organizedcrime"
     | "personalstats"

package/dist/openapi.json

@@ -795,6 +795,53 @@
         ]
       }
     },
+    "/user/list": {
+      "get": {
+        "tags": [
+          "User",
+          "Unstable"
+        ],
+        "summary": "Get your friends, enemies or targets list",
+        "description": "Requires limited access key. <br>",
+        "parameters": [
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Select list type",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UserListEnum"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit50"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffsetNoDefault"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSortAsc"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserListResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ]
+      }
+    },
     "/user/organizedcrime": {
       "get": {
         "tags": [
@@ -1310,6 +1357,9 @@
                     {
                       "$ref": "#/components/schemas/UserItemMarketResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserListResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserPersonalStatsResponse"
                     },
@@ -4494,6 +4544,14 @@
           "Wither"
         ]
       },
+      "UserListEnum": {
+        "type": "string",
+        "enum": [
+          "Friends",
+          "Enemies",
+          "Targets"
+        ]
+      },
       "JobPositionCasinoEnum": {
         "type": "string",
         "enum": [
@@ -4623,6 +4681,16 @@
           "ongoing"
         ]
       },
+      "FactionCrimeUserOutcome": {
+        "type": "string",
+        "enum": [
+          "Successful",
+          "Failed",
+          "Jailed",
+          "Injured",
+          "Hospitalized"
+        ]
+      },
       "RaceId": {
         "type": "integer"
       },
@@ -4653,6 +4721,16 @@
       "UserId": {
         "type": "integer"
       },
+      "UserIdNullable": {
+        "type": "integer",
+        "nullable": true
+      },
+      "UserIdNullableDeprecated": {
+        "description": "This field is replaced with the 'user.id' and will be removed on the 1st of May 2025.",
+        "type": "integer",
+        "nullable": true,
+        "deprecated": true
+      },
       "ReviveId": {
         "type": "integer"
       },
@@ -4665,6 +4743,10 @@
       "FactionId": {
         "type": "integer"
       },
+      "FactionIdNullable": {
+        "type": "integer",
+        "nullable": true
+      },
       "FactionCrimeId": {
         "type": "integer"
       },
@@ -6458,6 +6540,9 @@
           "id": {
             "$ref": "#/components/schemas/UserId"
           },
+          "outcome": {
+            "$ref": "#/components/schemas/FactionCrimeUserOutcome"
+          },
           "joined_at": {
             "description": "The timestamp at which the user joined the slot.",
             "type": "integer"
@@ -6471,11 +6556,16 @@
         "type": "object",
         "required": [
           "id",
+          "outcome",
           "joined_at",
           "progress"
         ]
       },
       "FactionCrimeRewardItem": {
+        "required": [
+          "id",
+          "quantity"
+        ],
         "properties": {
           "id": {
             "$ref": "#/components/schemas/ItemId"
@@ -6484,13 +6574,15 @@
             "type": "integer"
           }
         },
-        "type": "object",
-        "required": [
-          "id",
-          "quantity"
-        ]
+        "type": "object"
       },
       "FactionCrimeRewardPayout": {
+        "required": [
+          "type",
+          "percentage",
+          "paid_by",
+          "paid_at"
+        ],
         "properties": {
           "type": {
             "$ref": "#/components/schemas/FactionOrganizedCrimePayoutType"
@@ -6506,15 +6598,16 @@
             "type": "integer"
           }
         },
-        "type": "object",
-        "required": [
-          "type",
-          "percentage",
-          "paid_by",
-          "paid_at"
-        ]
+        "type": "object"
       },
       "FactionCrimeReward": {
+        "required": [
+          "money",
+          "items",
+          "respect",
+          "scope",
+          "payout"
+        ],
         "properties": {
           "money": {
             "type": "integer"
@@ -6528,6 +6621,9 @@
           "respect": {
             "type": "integer"
           },
+          "scope": {
+            "type": "integer"
+          },
           "payout": {
             "description": "Details about the crime payouts. This field is null if the crime has not been paid via the automatic payouts system.",
             "allOf": [
@@ -6541,21 +6637,29 @@
             ]
           }
         },
-        "type": "object",
-        "required": [
-          "money",
-          "items",
-          "respect",
-          "payout"
-        ]
+        "type": "object"
       },
       "FactionCrimeSlot": {
+        "required": [
+          "position",
+          "item_requirement",
+          "user_id",
+          "user",
+          "success_chance",
+          "crime_pass_rate",
+          "checkpoint_pass_rate"
+        ],
         "properties": {
           "position": {
             "type": "string"
           },
           "item_requirement": {
             "description": "Details of item required for the slot, if applicable.",
+            "required": [
+              "id",
+              "is_reusable",
+              "is_available"
+            ],
             "allOf": [
               {
                 "properties": {
@@ -6580,7 +6684,7 @@
             ]
           },
           "user_id": {
-            "$ref": "#/components/schemas/UserId"
+            "$ref": "#/components/schemas/UserIdNullableDeprecated"
           },
           "user": {
             "description": "Details about the user joined the slot, if any.",
@@ -6595,25 +6699,36 @@
             ]
           },
           "success_chance": {
-            "description": "This field is replaced with 'crime_pass_rate' field and will be removed on 1st of May 2025.",
+            "description": "This field is replaced with 'checkpoint_pass_rate' field and will be removed on 1st of May 2025.",
             "type": "integer",
             "deprecated": true
           },
           "crime_pass_rate": {
+            "description": "This field is replaced with 'checkpoint_pass_rate' field and will be removed on 1st of May 2025.",
+            "type": "integer",
+            "deprecated": true
+          },
+          "checkpoint_pass_rate": {
+            "description": "Returns CPR for the player who joined the slot. If the slot is empty (availalbe), it shows your CPR for that slot. This value is 0 for expired crimes.",
             "type": "integer"
           }
         },
-        "type": "object",
-        "required": [
-          "position",
-          "item_requirement",
-          "user_id",
-          "user",
-          "success_chance",
-          "crime_pass_rate"
-        ]
+        "type": "object"
       },
       "FactionCrime": {
+        "required": [
+          "id",
+          "name",
+          "difficulty",
+          "status",
+          "created_at",
+          "planning_at",
+          "ready_at",
+          "expired_at",
+          "executed_at",
+          "slots",
+          "rewards"
+        ],
         "properties": {
           "id": {
             "$ref": "#/components/schemas/FactionCrimeId"
@@ -6669,20 +6784,7 @@
             ]
           }
         },
-        "type": "object",
-        "required": [
-          "id",
-          "name",
-          "difficulty",
-          "status",
-          "created_at",
-          "planning_at",
-          "ready_at",
-          "expired_at",
-          "executed_at",
-          "slots",
-          "rewards"
-        ]
+        "type": "object"
       },
       "FactionCrimesResponse": {
         "properties": {
@@ -8732,7 +8834,7 @@
           },
           "ammo": {
             "properties": {
-              "": {
+              "id": {
                 "$ref": "#/components/schemas/AmmoId"
               },
               "name": {
@@ -8760,7 +8862,7 @@
             "type": "object",
             "nullable": true,
             "required": [
-              "",
+              "id",
               "name",
               "magazine_rounds",
               "rate_of_fire"
@@ -12848,6 +12950,64 @@
           "organizedCrime"
         ]
       },
+      "UserList": {
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "level": {
+            "type": "integer"
+          },
+          "faction_id": {
+            "nullable": true,
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/FactionId"
+              },
+              {
+                "type": "integer",
+                "nullable": true
+              }
+            ]
+          },
+          "last_action": {
+            "$ref": "#/components/schemas/UserLastAction"
+          },
+          "status": {
+            "$ref": "#/components/schemas/UserStatus"
+          }
+        },
+        "type": "object",
+        "required": [
+          "id",
+          "name",
+          "level",
+          "faction_id",
+          "last_action",
+          "status"
+        ]
+      },
+      "UserListResponse": {
+        "properties": {
+          "list": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserList"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object",
+        "required": [
+          "list",
+          "_metadata"
+        ]
+      },
       "UserSelectionName": {
         "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','properties','refills','reports','skills','stocks','travel','weaponexp','workstats'.",
         "type": "string",
@@ -12867,6 +13027,7 @@
           "hof",
           "itemmarket",
           "jobranks",
+          "list",
           "lookup",
           "organizedcrime",
           "personalstats",
@@ -12956,6 +13117,17 @@
           "type": "string"
         }
       },
+      "ApiLimit50": {
+        "name": "limit",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "default": 50,
+          "maximum": 50,
+          "minimum": 1
+        }
+      },
       "ApiLimit100": {
         "name": "limit",
         "in": "query",

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.1.7",
-    "@types/node": "^22.13.1",
-    "prettier": "^3.5.1",
+    "@scalar/openapi-types": "^0.1.9",
+    "@types/node": "^22.13.10",
+    "prettier": "^3.5.3",
     "typeconv": "^2.3.1",
-    "typescript": "^5.7.3"
+    "typescript": "^5.8.2"
   },
   "types": "./dist/index.d.ts",
   "files": [