tornapi-typescript 6.4.0 → 6.5.0

package/dist/index.d.ts

@@ -504,6 +504,18 @@ export interface ErrorFileDoesNotExist {
     error: string;
 }
 export type ApiError = ErrorUnknown | ErrorKeyEmpty | ErrorIncorrectKey | ErrorWrongType | ErrorWrongFields | ErrorTooManyRequests | ErrorIncorrectId | ErrorIncorrectIdEntityRelation | ErrorIpBlocked | ErrorApiDisabled | ErrorKeyOwnerInFederalJail | ErrorKeyChangeCooldown | ErrorKeyReadError | ErrorKeyTemporaryDisabled | ErrorDailyReadLimitReached | ErrorLogUnavailable | ErrorAccessLevelTooLow | ErrorBackendError | ErrorApiKeyPaused | ErrorMustMigrateToCrimesV2 | ErrorRaceNotFinished | ErrorIncorrectCategory | ErrorOnlyAvailableInApiV1 | ErrorOnlyAvailableInApiV2 | ErrorClosedTemporarily | ErrorInvalidStatRequested | ErrorOnlyCategoryOrStatsAllowed | ErrorMustMigrateToOrganizedCrimesV2 | ErrorIncorrectLogId | ErrorCategorySelectionUnavailableForInteractionLogs | ErrorFileDoesNotExist;
+export interface UserPerksResponse {
+    perks: {
+        faction: string[];
+        job: string[];
+        property: string[];
+        education: string[];
+        enhancer: string[];
+        book: string[];
+        stock: string[];
+        merit: string[];
+    };
+}
 export interface UserNetworthResponse {
     networth: {
         money: {
@@ -7274,6 +7286,10 @@ export interface UserV2 extends BaseSchema {
             response: UserOrganizedCrimesResponse;
             params: "timestamp";
         };
+        perks: {
+            response: UserPerksResponse;
+            params: "timestamp";
+        };
         personalstats: {
             response: UserPersonalStatsResponse;
             params: "cat" | "stat" | "timestamp";

package/dist/index.ts

@@ -5517,6 +5517,19 @@ export type ApiError =
     | ErrorCategorySelectionUnavailableForInteractionLogs
     | ErrorFileDoesNotExist;
 
+export interface UserPerksResponse {
+    perks: {
+        faction: string[];
+        job: string[];
+        property: string[];
+        education: string[];
+        enhancer: string[];
+        book: string[];
+        stock: string[];
+        merit: string[];
+    };
+}
+
 export interface UserNetworthResponse {
     networth: {
         money: {
@@ -13169,6 +13182,10 @@ export interface UserV2 extends BaseSchema {
             response: UserOrganizedCrimesResponse;
             params: "timestamp";
         };
+        perks: {
+            response: UserPerksResponse;
+            params: "timestamp";
+        };
         personalstats: {
             response: UserPersonalStatsResponse;
             params: "cat" | "stat" | "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.4.0"
+    "version": "6.5.0"
   },
   "servers": [
     {
@@ -492,7 +492,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/competition": {
@@ -2453,6 +2453,45 @@
         "x-stability": "Stable"
       }
     },
+    "/user/perks": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your current perks",
+        "description": "Requires minimal access key. <br>",
+        "operationId": "getMyPerks",
+        "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/UserPerksResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/user/personalstats": {
       "get": {
         "tags": [
@@ -3252,7 +3291,7 @@
         "operationId": "getUsersSnapshot",
         "parameters": [
           {
-            "$ref": "#/components/parameters/ApiTimestamp"
+            "$ref": "#/components/parameters/ApiTimestampSpecificPointInTime"
           },
           {
             "$ref": "#/components/parameters/ApiComment"
@@ -3378,7 +3417,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/{tradeId}/trade": {
@@ -3426,7 +3465,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/user/travel": {
@@ -3934,6 +3973,9 @@
                     {
                       "$ref": "#/components/schemas/UserNotificationsResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserPerksResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserRefillsResponse"
                     },
@@ -5656,7 +5698,7 @@
         "operationId": "getFactionsSnapshot",
         "parameters": [
           {
-            "$ref": "#/components/parameters/ApiTimestamp"
+            "$ref": "#/components/parameters/ApiTimestampSpecificPointInTime"
           },
           {
             "$ref": "#/components/parameters/ApiComment"
@@ -6594,7 +6636,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/employees": {
@@ -6636,7 +6678,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/{id}/employees": {
@@ -6687,7 +6729,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/news": {
@@ -6750,7 +6792,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/{typeId}/companies": {
@@ -6807,7 +6849,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/profile": {
@@ -6849,7 +6891,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/{id}/profile": {
@@ -6900,7 +6942,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/search": {
@@ -6951,7 +6993,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/snapshot": {
@@ -6964,7 +7006,7 @@
         "operationId": "getCompaniesSnapshot",
         "parameters": [
           {
-            "$ref": "#/components/parameters/ApiTimestamp"
+            "$ref": "#/components/parameters/ApiTimestampSpecificPointInTime"
           },
           {
             "$ref": "#/components/parameters/ApiComment"
@@ -6991,7 +7033,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/stock": {
@@ -7030,7 +7072,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/company/lookup": {
@@ -10272,7 +10314,7 @@
             "api_key": []
           }
         ],
-        "x-stability": "Unstable"
+        "x-stability": "Stable"
       }
     },
     "/torn/organizedcrimes": {
@@ -18266,6 +18308,77 @@
           }
         ]
       },
+      "UserPerksResponse": {
+        "required": [
+          "perks"
+        ],
+        "properties": {
+          "perks": {
+            "required": [
+              "faction",
+              "job",
+              "property",
+              "education",
+              "enhancer",
+              "book",
+              "stock",
+              "merit"
+            ],
+            "properties": {
+              "faction": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "job": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "property": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "education": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "enhancer": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "book": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "stock": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "merit": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
       "UserNetworthResponse": {
         "required": [
           "networth"
@@ -34693,7 +34806,24 @@
       "ApiTimestamp": {
         "name": "timestamp",
         "in": "query",
-        "description": "Timestamp to bypass cache or get the data in specific point in time",
+        "description": "Timestamp to bypass cache",
+        "required": false,
+        "schema": {
+          "oneOf": [
+            {
+              "type": "integer",
+              "format": "int32"
+            },
+            {
+              "type": "string"
+            }
+          ]
+        }
+      },
+      "ApiTimestampSpecificPointInTime": {
+        "name": "timestamp",
+        "in": "query",
+        "description": "Timestamp to get the data in specific point in time",
         "required": false,
         "schema": {
           "oneOf": [

package/package.json

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