tornapi-typescript 3.0.2 → 3.0.4

package/dist/index.d.ts

@@ -58,6 +58,7 @@ export type ItemUid = number;
 export type UserId = number;
 export type ReviveId = number;
 export type LogId = number;
+export type UserLogId = string;
 export type LogCategoryId = number;
 export type FactionId = number;
 export type CompanyId = number;
@@ -326,6 +327,23 @@ export interface ReportsResponse {
     _metadata: RequestMetadataWithLinks;
 }
 export type SelectionCategoryEnum = ReportTypeEnum | UserListEnum | PersonalStatsCategoryEnum | RacingRaceTypeEnum;
+export interface UserLog {
+    id: UserLogId;
+    timestamp: number;
+    details: {
+        id: LogId;
+        title: string;
+        category: string;
+    };
+    /** Dynamic key-value pairs related to the log. */
+    data: {};
+    /** Dynamic key-value pairs related to the log. */
+    params: {};
+}
+export interface UserLogsResponse {
+    log: UserLog[];
+    _metadata: RequestMetadataWithLinks;
+}
 export interface BasicUser {
     id: UserId;
     name: string;
@@ -2047,6 +2065,10 @@ export interface KeyLogResponse {
         ip: string;
     }[];
 }
+export interface KeyInfoAvailableLog {
+    category_id: LogCategoryId;
+    log_ids: LogId[];
+}
 export interface KeyInfoResponse {
     info: {
         selections: {
@@ -2072,6 +2094,11 @@ export interface KeyInfoResponse {
             faction_id?: FactionId | null;
             company: boolean;
             company_id?: CompanyId | null;
+            log: {
+                /** Shows if key has custom log permissions enabled. */
+                custom_permissions: boolean;
+                available: KeyInfoAvailableLog[];
+            };
         };
     };
 }
@@ -5930,11 +5957,11 @@ export interface UserV2 extends BaseSchema {
     selections: {
         attacks: {
             response: FactionAttacksResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         attacksfull: {
             response: FactionAttacksFullResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         bounties: {
             response: UserBountiesResponse;
@@ -5996,6 +6023,10 @@ export interface UserV2 extends BaseSchema {
             response: UserListResponse;
             params: "cat" | "limit" | "offset" | "sort" | "timestamp";
         };
+        log: {
+            response: UserLogsResponse;
+            params: "log" | "cat" | "limit" | "to" | "from" | "timestamp";
+        };
         organizedcrime: {
             response: UserOrganizedCrimeResponse;
             params: "timestamp";
@@ -6026,11 +6057,11 @@ export interface UserV2 extends BaseSchema {
         };
         revives: {
             response: RevivesResponse;
-            params: "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
         };
         revivesFull: {
             response: RevivesFullResponse;
-            params: "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
         };
         lookup: {
             response: UserLookupResponse;
@@ -6050,11 +6081,11 @@ export interface FactionV2 extends BaseSchema {
         };
         attacks: {
             response: FactionAttacksResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         attacksfull: {
             response: FactionAttacksFullResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         balance: {
             response: FactionBalanceResponse;
@@ -6130,11 +6161,11 @@ export interface FactionV2 extends BaseSchema {
         };
         revives: {
             response: RevivesResponse;
-            params: "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
         };
         revivesFull: {
             response: RevivesFullResponse;
-            params: "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "striptags" | "timestamp";
         };
         search: {
             response: FactionSearchResponse;

package/dist/index.ts

@@ -4590,6 +4590,8 @@ export type ReviveId = number;
 
 export type LogId = number;
 
+export type UserLogId = string;
+
 export type LogCategoryId = number;
 
 export type FactionId = number;
@@ -5078,6 +5080,25 @@ export type SelectionCategoryEnum =
     | PersonalStatsCategoryEnum
     | RacingRaceTypeEnum;
 
+export interface UserLog {
+    id: UserLogId;
+    timestamp: number;
+    details: {
+        id: LogId;
+        title: string;
+        category: string;
+    };
+    /** Dynamic key-value pairs related to the log. */
+    data: {};
+    /** Dynamic key-value pairs related to the log. */
+    params: {};
+}
+
+export interface UserLogsResponse {
+    log: UserLog[];
+    _metadata: RequestMetadataWithLinks;
+}
+
 export interface BasicUser {
     id: UserId;
     name: string;
@@ -7334,6 +7355,11 @@ export interface KeyLogResponse {
     }[];
 }
 
+export interface KeyInfoAvailableLog {
+    category_id: LogCategoryId;
+    log_ids: LogId[];
+}
+
 export interface KeyInfoResponse {
     info: {
         selections: {
@@ -7359,6 +7385,11 @@ export interface KeyInfoResponse {
             faction_id?: FactionId | null;
             company: boolean;
             company_id?: CompanyId | null;
+            log: {
+                /** Shows if key has custom log permissions enabled. */
+                custom_permissions: boolean;
+                available: KeyInfoAvailableLog[];
+            };
         };
     };
 }
@@ -11386,11 +11417,11 @@ export interface UserV2 extends BaseSchema {
     selections: {
         attacks: {
             response: FactionAttacksResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         attacksfull: {
             response: FactionAttacksFullResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         bounties: {
             response: UserBountiesResponse;
@@ -11458,6 +11489,10 @@ export interface UserV2 extends BaseSchema {
             response: UserListResponse;
             params: "cat" | "limit" | "offset" | "sort" | "timestamp";
         };
+        log: {
+            response: UserLogsResponse;
+            params: "log" | "cat" | "limit" | "to" | "from" | "timestamp";
+        };
         organizedcrime: {
             response: UserOrganizedCrimeResponse;
             params: "timestamp";
@@ -11489,6 +11524,7 @@ export interface UserV2 extends BaseSchema {
         revives: {
             response: RevivesResponse;
             params:
+                | "filters"
                 | "limit"
                 | "sort"
                 | "to"
@@ -11499,6 +11535,7 @@ export interface UserV2 extends BaseSchema {
         revivesFull: {
             response: RevivesFullResponse;
             params:
+                | "filters"
                 | "limit"
                 | "sort"
                 | "to"
@@ -11524,11 +11561,11 @@ export interface FactionV2 extends BaseSchema {
         };
         attacks: {
             response: FactionAttacksResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         attacksfull: {
             response: FactionAttacksFullResponse;
-            params: "limit" | "sort" | "to" | "from" | "timestamp";
+            params: "filters" | "limit" | "sort" | "to" | "from" | "timestamp";
         };
         balance: {
             response: FactionBalanceResponse;
@@ -11619,6 +11656,7 @@ export interface FactionV2 extends BaseSchema {
         revives: {
             response: RevivesResponse;
             params:
+                | "filters"
                 | "limit"
                 | "sort"
                 | "to"
@@ -11629,6 +11667,7 @@ export interface FactionV2 extends BaseSchema {
         revivesFull: {
             response: RevivesFullResponse;
             params:
+                | "filters"
                 | "limit"
                 | "sort"
                 | "to"

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": "3.0.2"
+    "version": "3.0.4"
   },
   "servers": [
     {
@@ -21,6 +21,19 @@
         "description": "Requires limited access key. <br>",
         "operationId": "3acc98a3016974b786cb01e04e1ced04",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing attacks. If not specified, this selection will return both incoming and outgoing attacks.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit100"
           },
@@ -72,6 +85,19 @@
         "description": "Requires limited access key. <br>Returns up to 1,000 rows. <br>",
         "operationId": "e995691fd9845c8b4a91f065ac9c8420",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing attacks. If not specified, this selection will return both incoming and outgoing attacks.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit1000"
           },
@@ -975,6 +1001,77 @@
         "x-stability": "Stable"
       }
     },
+    "/user/log": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your logs",
+        "description": "Requires limited access key. <br> It's possible to pass a list of log ids or a log category id.<br>",
+        "operationId": "f354f40bc5d6cbadf57fdecb453c976f",
+        "parameters": [
+          {
+            "name": "log",
+            "in": "query",
+            "description": "Log ids, comma separated, e.g. 105,4900,4905",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/LogId"
+              }
+            }
+          },
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Log category id",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/LogCategoryId"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
+          },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyFull"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserLogsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/organizedcrime": {
       "get": {
         "tags": [
@@ -1518,6 +1615,19 @@
         "description": "Requires limited access key. <br>",
         "operationId": "3c847eb1325040798f37a7492108e094",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing revives. If not specified, this selection will return both incoming and outgoing revives.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit100Default20"
           },
@@ -1572,6 +1682,19 @@
         "description": "Requires limited access key. <br>",
         "operationId": "8820cd889afde899353037ca5a0f9a07",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing revives. If not specified, this selection will return both incoming and outgoing revives.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit1000Default20"
           },
@@ -1948,6 +2071,19 @@
         "description": "Requires limited access key with faction API access permissions. <br>",
         "operationId": "cb5b38ba64c389e706526df8bc8af9b6",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing attacks. If not specified, this selection will return both incoming and outgoing attacks.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit100"
           },
@@ -1999,6 +2135,19 @@
         "description": "Requires limited access key with faction API access permissions. <br>",
         "operationId": "8551280aaaf9819aa94be5c469a523de",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing attacks. If not specified, this selection will return both incoming and outgoing attacks.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit1000"
           },
@@ -3337,6 +3486,19 @@
         "description": "Requires limited access key with faction API access permissions. <br>",
         "operationId": "486fcda26ed1aa6aba8ec7091080723b",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing revives. If not specified, this selection will return both incoming and outgoing revives.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit100"
           },
@@ -3391,6 +3553,19 @@
         "description": "Requires limited access key with faction API access permissions. <br>",
         "operationId": "f17a4064779e8de5200238816c233c02",
         "parameters": [
+          {
+            "name": "filters",
+            "in": "query",
+            "description": "It's possible to use this query parameter to only get incoming or outgoing revives. If not specified, this selection will return both incoming and outgoing revives.",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "incoming",
+                "outgoing"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit1000"
           },
@@ -11968,6 +12143,9 @@
         "type": "integer",
         "format": "int32"
       },
+      "UserLogId": {
+        "type": "string"
+      },
       "LogCategoryId": {
         "type": "integer",
         "format": "int32"
@@ -13423,6 +13601,70 @@
           }
         ]
       },
+      "UserLog": {
+        "required": [
+          "id",
+          "timestamp",
+          "details",
+          "data",
+          "params"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserLogId"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "details": {
+            "required": [
+              "id",
+              "title",
+              "category"
+            ],
+            "properties": {
+              "id": {
+                "$ref": "#/components/schemas/LogId"
+              },
+              "title": {
+                "type": "string"
+              },
+              "category": {
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "data": {
+            "description": "Dynamic key-value pairs related to the log.",
+            "type": "object"
+          },
+          "params": {
+            "description": "Dynamic key-value pairs related to the log.",
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "UserLogsResponse": {
+        "required": [
+          "log",
+          "_metadata"
+        ],
+        "properties": {
+          "log": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserLog"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object"
+      },
       "BasicUser": {
         "required": [
           "id",
@@ -21955,6 +22197,24 @@
         },
         "type": "object"
       },
+      "KeyInfoAvailableLog": {
+        "required": [
+          "category_id",
+          "log_ids"
+        ],
+        "properties": {
+          "category_id": {
+            "$ref": "#/components/schemas/LogCategoryId"
+          },
+          "log_ids": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/LogId"
+            }
+          }
+        },
+        "type": "object"
+      },
       "KeyInfoResponse": {
         "required": [
           "info"
@@ -22077,7 +22337,8 @@
                   "level",
                   "type",
                   "faction",
-                  "company"
+                  "company",
+                  "log"
                 ],
                 "properties": {
                   "level": {
@@ -22116,6 +22377,25 @@
                         "type": "null"
                       }
                     ]
+                  },
+                  "log": {
+                    "required": [
+                      "custom_permissions",
+                      "available"
+                    ],
+                    "properties": {
+                      "custom_permissions": {
+                        "description": "Shows if key has custom log permissions enabled.",
+                        "type": "boolean"
+                      },
+                      "available": {
+                        "type": "array",
+                        "items": {
+                          "$ref": "#/components/schemas/KeyInfoAvailableLog"
+                        }
+                      }
+                    },
+                    "type": "object"
                   }
                 },
                 "type": "object"
@@ -25225,6 +25505,15 @@
           "type": "string"
         }
       },
+      "ApiKeyFull": {
+        "name": "key",
+        "in": "query",
+        "description": "API key (Full).<br>It's not required to use this parameter when passing the API key via the Authorization header.",
+        "required": false,
+        "schema": {
+          "type": "string"
+        }
+      },
       "ApiTimestamp": {
         "name": "timestamp",
         "in": "query",

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "tornapi-typescript",
   "type": "module",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "scripts": {
     "generate-types": "tsc && node build/index.js"
   },
   "devDependencies": {
-    "@scalar/openapi-types": "^0.3.6",
-    "@types/node": "^22.16.5",
+    "@scalar/openapi-types": "^0.3.7",
+    "@types/node": "^22.17.0",
     "prettier": "^3.6.2",
     "typeconv": "^2.3.1",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.2"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",