tornapi-typescript 4.0.0 → 4.1.0

package/dist/index.d.ts

@@ -6,6 +6,7 @@
  */
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 export type UserDonatorStatusEnum = "Donator" | "Subscriber";
+export type UserMessageTypeEnum = "Company newsletter" | "Faction newsletter" | "Warning" | "User message";
 export type JobTypeEnum = "Army" | "Casino" | "Education" | "Grocer" | "Law" | "Medical";
 export type UserMaritalStatusEnum = "Engaged" | "Newlywed" | "Married";
 export type UserPlaneImageTypeEnum = "private_jet" | "light_aircraft" | "airliner";
@@ -71,6 +72,8 @@ export type TerritoryWarId = number;
 export type RaidWarId = number;
 export type ItemUid = number;
 export type UserId = number;
+export type UserMessageId = number;
+export type UserEventId = string;
 export type UserIconId = number;
 export type ReviveId = number;
 export type LogId = number;
@@ -348,6 +351,34 @@ export interface ReportsResponse {
     _metadata: RequestMetadataWithLinks;
 }
 export type SelectionCategoryEnum = ReportTypeEnum | UserListEnum | PersonalStatsCategoryEnum | RacingRaceTypeEnum;
+export interface UserNewEventsResponse {
+    events: UserEvent[];
+}
+export interface UserEventsResponse {
+    events: UserEvent[];
+    _metadata: RequestMetadataWithLinks;
+}
+export interface UserEvent {
+    id: UserEventId;
+    timestamp: number;
+    event: string;
+}
+export interface UserMessagesResponse {
+    messages: UserMessage[];
+    _metadata: RequestMetadataWithLinks;
+}
+export interface UserNewMessagesResponse {
+    messages: UserMessage[];
+}
+export interface UserMessage {
+    id: UserMessageId;
+    sender: BasicUser;
+    timestamp: number;
+    topic: string;
+    type: UserMessageTypeEnum;
+    seen: boolean;
+    read: boolean;
+}
 export interface UserIconPublic {
     id: UserIconId;
     title: string;
@@ -916,7 +947,7 @@ export interface UserListResponse {
     list: UserList[];
     _metadata: RequestMetadataWithLinks;
 }
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','refills','stocks','travel','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','gym','inventory','missions','networth','notifications','perks','refills','stocks','travel','weaponexp'. */
 export type UserSelectionName = string;
 export interface UserLookupResponse {
     selections: UserSelectionName[];
@@ -6286,6 +6317,10 @@ export interface UserV2 extends BaseSchema {
             response: UserEnlistedCarsResponse;
             params: "timestamp";
         };
+        events: {
+            response: UserEventsResponse;
+            params: "striptags" | "limit" | "from" | "to" | "timestamp";
+        };
         faction: {
             response: UserFactionResponse;
             params: "timestamp";
@@ -6358,10 +6393,22 @@ export interface UserV2 extends BaseSchema {
             response: UserMeritsResponse;
             params: "timestamp";
         };
+        messages: {
+            response: UserMessagesResponse;
+            params: "limit" | "from" | "to" | "sort" | "timestamp";
+        };
         money: {
             response: UserMoneyResponse;
             params: "timestamp";
         };
+        newevents: {
+            response: UserNewEventsResponse;
+            params: "striptags" | "timestamp";
+        };
+        newmessages: {
+            response: UserNewMessagesResponse;
+            params: "timestamp";
+        };
         organizedcrime: {
             response: UserOrganizedCrimeResponse;
             params: "timestamp";

package/dist/index.ts

@@ -11,6 +11,12 @@ export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 
 export type UserDonatorStatusEnum = "Donator" | "Subscriber";
 
+export type UserMessageTypeEnum =
+    | "Company newsletter"
+    | "Faction newsletter"
+    | "Warning"
+    | "User message";
+
 export type JobTypeEnum =
     | "Army"
     | "Casino"
@@ -4736,6 +4742,10 @@ export type ItemUid = number;
 
 export type UserId = number;
 
+export type UserMessageId = number;
+
+export type UserEventId = string;
+
 export type UserIconId = number;
 
 export type ReviveId = number;
@@ -5277,6 +5287,40 @@ export type SelectionCategoryEnum =
     | PersonalStatsCategoryEnum
     | RacingRaceTypeEnum;
 
+export interface UserNewEventsResponse {
+    events: UserEvent[];
+}
+
+export interface UserEventsResponse {
+    events: UserEvent[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface UserEvent {
+    id: UserEventId;
+    timestamp: number;
+    event: string;
+}
+
+export interface UserMessagesResponse {
+    messages: UserMessage[];
+    _metadata: RequestMetadataWithLinks;
+}
+
+export interface UserNewMessagesResponse {
+    messages: UserMessage[];
+}
+
+export interface UserMessage {
+    id: UserMessageId;
+    sender: BasicUser;
+    timestamp: number;
+    topic: string;
+    type: UserMessageTypeEnum;
+    seen: boolean;
+    read: boolean;
+}
+
 export interface UserIconPublic {
     id: UserIconId;
     title: string;
@@ -5958,7 +6002,7 @@ export interface UserListResponse {
     _metadata: RequestMetadataWithLinks;
 }
 
-/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','refills','stocks','travel','weaponexp'. */
+/** The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','gym','inventory','missions','networth','notifications','perks','refills','stocks','travel','weaponexp'. */
 export type UserSelectionName = string;
 
 export interface UserLookupResponse {
@@ -11970,6 +12014,10 @@ export interface UserV2 extends BaseSchema {
             response: UserEnlistedCarsResponse;
             params: "timestamp";
         };
+        events: {
+            response: UserEventsResponse;
+            params: "striptags" | "limit" | "from" | "to" | "timestamp";
+        };
         faction: {
             response: UserFactionResponse;
             params: "timestamp";
@@ -12048,10 +12096,22 @@ export interface UserV2 extends BaseSchema {
             response: UserMeritsResponse;
             params: "timestamp";
         };
+        messages: {
+            response: UserMessagesResponse;
+            params: "limit" | "from" | "to" | "sort" | "timestamp";
+        };
         money: {
             response: UserMoneyResponse;
             params: "timestamp";
         };
+        newevents: {
+            response: UserNewEventsResponse;
+            params: "striptags" | "timestamp";
+        };
+        newmessages: {
+            response: UserNewMessagesResponse;
+            params: "timestamp";
+        };
         organizedcrime: {
             response: UserOrganizedCrimeResponse;
             params: "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.0.0"
+    "version": "4.1.0"
   },
   "servers": [
     {
@@ -557,7 +557,7 @@
         "tags": [
           "User"
         ],
-        "summary": "Get user enlisted cars",
+        "summary": "Get your enlisted cars",
         "description": "Requires minimal access key. <br>Returns a list of all user enlisted cars.",
         "operationId": "dc3deee7629610931240be337c47a8ee",
         "parameters": [
@@ -591,6 +591,57 @@
         "x-stability": "Stable"
       }
     },
+    "/user/events": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your events",
+        "description": "Requires limited access key. <br> Unfortunately, the 'sort' parameter is not available for this selection.",
+        "operationId": "10a22547e0c48046ade435e0b63dfe55",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiStripTagsFalse"
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserEventsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/faction": {
       "get": {
         "tags": [
@@ -1689,6 +1740,57 @@
         "x-stability": "Stable"
       }
     },
+    "/user/messages": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your messages",
+        "description": "Requires limited access key. <br>",
+        "operationId": "20c7b7a3f7395c2afa73597327f401a3",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
+          },
+          {
+            "$ref": "#/components/parameters/ApiSort"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserMessagesResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/money": {
       "get": {
         "tags": [
@@ -1728,6 +1830,87 @@
         "x-stability": "Unstable"
       }
     },
+    "/user/newevents": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your unseen events",
+        "description": "Requires limited access key. <br>",
+        "operationId": "945b8ac03944ca79eb0ae8a640aeab3b",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiStripTagsFalse"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserNewEventsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
+    "/user/newmessages": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your unseen messages",
+        "description": "Requires limited access key. <br>",
+        "operationId": "8859066800e0652740bfb17f8ecd15a2",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UserNewMessagesResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/organizedcrime": {
       "get": {
         "tags": [
@@ -2673,6 +2856,20 @@
               ]
             }
           },
+          {
+            "name": "legacy",
+            "in": "query",
+            "description": "Legacy selection names for which you want or expect API v1 response",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/UserSelectionName"
+              }
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit"
           },
@@ -2861,6 +3058,18 @@
                     {
                       "$ref": "#/components/schemas/UserBattleStatsResponse"
                     },
+                    {
+                      "$ref": "#/components/schemas/UserNewEventsResponse"
+                    },
+                    {
+                      "$ref": "#/components/schemas/UserEventsResponse"
+                    },
+                    {
+                      "$ref": "#/components/schemas/UserMessagesResponse"
+                    },
+                    {
+                      "$ref": "#/components/schemas/UserNewMessagesResponse"
+                    },
                     {
                       "$ref": "#/components/schemas/UserLookupResponse"
                     },
@@ -5101,6 +5310,20 @@
               ]
             }
           },
+          {
+            "name": "legacy",
+            "in": "query",
+            "description": "Legacy selection names for which you want or expect API v1 response",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/FactionSelectionName"
+              }
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiLimit"
           },
@@ -6305,6 +6528,20 @@
               ]
             }
           },
+          {
+            "name": "legacy",
+            "in": "query",
+            "description": "Legacy selection names for which you want or expect API v1 response",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/MarketSelectionName"
+              }
+            }
+          },
           {
             "name": "cat",
             "in": "query",
@@ -8303,6 +8540,20 @@
               ]
             }
           },
+          {
+            "name": "legacy",
+            "in": "query",
+            "description": "Legacy selection names for which you want or expect API v1 response",
+            "required": false,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/TornSelectionName"
+              }
+            }
+          },
           {
             "$ref": "#/components/parameters/ApiStripTags"
           },
@@ -8457,6 +8708,15 @@
           "Subscriber"
         ]
       },
+      "UserMessageTypeEnum": {
+        "type": "string",
+        "enum": [
+          "Company newsletter",
+          "Faction newsletter",
+          "Warning",
+          "User message"
+        ]
+      },
       "JobTypeEnum": {
         "type": "string",
         "enum": [
@@ -13389,6 +13649,13 @@
         "type": "integer",
         "format": "int32"
       },
+      "UserMessageId": {
+        "type": "integer",
+        "format": "int64"
+      },
+      "UserEventId": {
+        "type": "string"
+      },
       "UserIconId": {
         "type": "integer",
         "format": "int32"
@@ -14921,6 +15188,126 @@
           }
         ]
       },
+      "UserNewEventsResponse": {
+        "required": [
+          "events"
+        ],
+        "properties": {
+          "events": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserEvent"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserEventsResponse": {
+        "required": [
+          "events",
+          "_metadata"
+        ],
+        "properties": {
+          "events": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserEvent"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object"
+      },
+      "UserEvent": {
+        "required": [
+          "id",
+          "timestamp",
+          "event"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserEventId"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "event": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "UserMessagesResponse": {
+        "required": [
+          "messages",
+          "_metadata"
+        ],
+        "properties": {
+          "messages": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserMessage"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object"
+      },
+      "UserNewMessagesResponse": {
+        "required": [
+          "messages"
+        ],
+        "properties": {
+          "messages": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserMessage"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserMessage": {
+        "required": [
+          "id",
+          "sender",
+          "timestamp",
+          "topic",
+          "type",
+          "seen",
+          "read"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserMessageId"
+          },
+          "sender": {
+            "$ref": "#/components/schemas/BasicUser"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "topic": {
+            "type": "string"
+          },
+          "type": {
+            "$ref": "#/components/schemas/UserMessageTypeEnum"
+          },
+          "seen": {
+            "type": "boolean"
+          },
+          "read": {
+            "type": "boolean"
+          }
+        },
+        "type": "object"
+      },
       "UserIconPublic": {
         "required": [
           "id",
@@ -17687,7 +18074,7 @@
       "UserSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','refills','stocks','travel','weaponexp'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bars','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','gym','inventory','missions','networth','notifications','perks','refills','stocks','travel','weaponexp'.",
             "type": "string",
             "enum": [
               "attacks",
@@ -17699,6 +18086,7 @@
               "competition",
               "crimes",
               "enlistedcars",
+              "events",
               "faction",
               "factionbalance",
               "forumfeed",
@@ -17718,7 +18106,10 @@
               "lookup",
               "medals",
               "merits",
+              "messages",
               "money",
+              "newevents",
+              "newmessages",
               "organizedcrime",
               "personalstats",
               "profile",
@@ -17741,14 +18132,10 @@
               "display",
               "education",
               "equipment",
-              "events",
               "gym",
               "inventory",
-              "messages",
               "missions",
               "networth",
-              "newevents",
-              "newmessages",
               "notifications",
               "perks",
               "refills",

package/package.json

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