tornapi-typescript 0.2.4 → 0.2.5

package/dist/index.d.ts

@@ -9,6 +9,31 @@
 
 export type RaceClassEnum = "A" | "B" | "C" | "D" | "E";
 
+export type CountryEnum =
+    | "Mexico"
+    | "Hawaii"
+    | "South Africa"
+    | "Japan"
+    | "China"
+    | "Argentina"
+    | "Switzerland"
+    | "Canada"
+    | "United Kingdom"
+    | "UAE"
+    | "Cayman Islands";
+
+export type ReportTypeEnum =
+    | "mostwanted"
+    | "money"
+    | "stats"
+    | "references"
+    | "friendorfoe"
+    | "companyfinancials"
+    | "truelevel"
+    | "stockanalysis"
+    | "anonymousbounties"
+    | "investment";
+
 export type ApiKeyAccessTypeEnum =
     | "Custom"
     | "Public Only"
@@ -4838,6 +4863,132 @@ export interface TimestampResponse {
     timestamp: number;
 }
 
+export interface ReportBase {
+    type: ReportTypeEnum;
+    target_id: UserId | null;
+    reporter_id: UserId;
+    faction_id: FactionId | null;
+    timestamp: number;
+}
+
+export interface ReportWarrantDetails {
+    id: UserId;
+    name: string;
+    warrant: number;
+}
+
+export interface ReportMostWanted {
+    top: ReportWarrantDetails[];
+    notable: ReportWarrantDetails[];
+}
+
+export interface ReportMoney {
+    money: number;
+}
+
+export interface ReportInvestment {
+    amount: number;
+    until: number;
+}
+
+export interface ReportTrueLevel {
+    level: number;
+}
+
+export interface ReportStats {
+    strength: number | null;
+    speed: number | null;
+    dexterity: number | null;
+    defense: number | null;
+    total: number | null;
+}
+
+export interface ReportHistoryFaction {
+    id: FactionId;
+    name: string;
+    joined: string;
+    left: string | null;
+}
+
+export interface ReportHistoryCompany {
+    id: CompanyId;
+    name: string;
+    joined: string;
+    left: string | null;
+}
+
+export interface ReportHistory {
+    factions: ReportHistoryFaction[];
+    companies: ReportHistoryCompany[];
+}
+
+export interface ReportFriendOrFoeUser {
+    id: UserId;
+    name: string;
+}
+
+export interface ReportFriendOrFoe {
+    friends: ReportFriendOrFoeUser[];
+    enemies: ReportFriendOrFoeUser[];
+}
+
+export interface ReportCompanyFinancials {
+    balance: number;
+    employees: number;
+    wages: {
+        highest: number;
+        lowest: number;
+        average: number;
+    };
+}
+
+export interface ReportStockAnalysis {
+    items: {
+        country: CountryEnum;
+        item: {
+            id: ItemId;
+            name: string;
+            price: number;
+            value: number;
+            due: number | null;
+        };
+        trip_duration: number;
+        hourly_profit: number;
+    }[];
+}
+
+export interface ReportAnonymousBounties {
+    bounties: {
+        text: string;
+        bounty: number;
+        user: {
+            id: UserId;
+            name: string;
+        } | null;
+    }[];
+}
+
+export interface ReportReport {
+    report:
+        | ReportMoney
+        | ReportStats
+        | ReportMostWanted
+        | ReportHistory
+        | ReportFriendOrFoe
+        | ReportCompanyFinancials
+        | ReportTrueLevel
+        | ReportStockAnalysis
+        | ReportAnonymousBounties
+        | ReportInvestment;
+}
+
+export interface Report extends ReportBase, ReportReport {}
+
+export interface ReportsResponse {
+    reports: Report[];
+    _metadata: RequestMetadataWithLinks;
+}
+
 export interface UserCurrentEducation {
     id: EducationId;
     until: number;

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": "1.6.1"
+    "version": "1.7.0"
   },
   "servers": [
     {
@@ -1226,6 +1226,69 @@
         "x-stability": "Stable"
       }
     },
+    "/user/reports": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your reports",
+        "description": "Requires limited access key. <br>\n * The default limit is set to 25. However, the limit can be set to 100 for the 'stats' category.",
+        "operationId": "6ba15a813fe1cc014564e9dba892e022",
+        "parameters": [
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Used to filter reports with a specific type.",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/ReportTypeEnum"
+            }
+          },
+          {
+            "name": "target",
+            "in": "query",
+            "description": "Get reports for a specific player by passing their player ID.",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/UserId"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffset"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ReportsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/user/revives": {
       "get": {
         "tags": [
@@ -2787,6 +2850,69 @@
         "x-stability": "Stable"
       }
     },
+    "/faction/reports": {
+      "get": {
+        "tags": [
+          "Faction"
+        ],
+        "summary": "Get faction reports",
+        "description": "Requires limited access key. <br>\n *  The default limit is set to 25. However, the limit can be set to 100 for the 'stats' category.",
+        "operationId": "e8bd37f10cc5e0e8d6694bb306f3a1e4",
+        "parameters": [
+          {
+            "name": "cat",
+            "in": "query",
+            "description": "Used to filter reports with a specific type.",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/ReportTypeEnum"
+            }
+          },
+          {
+            "name": "target",
+            "in": "query",
+            "description": "Get reports for a specific player by passing their player ID.",
+            "required": false,
+            "schema": {
+              "$ref": "#/components/schemas/UserId"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiLimit100Default20"
+          },
+          {
+            "$ref": "#/components/parameters/ApiOffset"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyLimited"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ReportsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Unstable"
+      }
+    },
     "/faction/revives": {
       "get": {
         "tags": [
@@ -3998,15 +4124,6 @@
           {
             "$ref": "#/components/parameters/ApiOffsetNoDefault"
           },
-          {
-            "name": "cat",
-            "in": "query",
-            "description": "Selection category",
-            "required": false,
-            "schema": {
-              "type": "string"
-            }
-          },
           {
             "$ref": "#/components/parameters/ApiTimestamp"
           },
@@ -5983,6 +6100,37 @@
           "E"
         ]
       },
+      "CountryEnum": {
+        "type": "string",
+        "enum": [
+          "Mexico",
+          "Hawaii",
+          "South Africa",
+          "Japan",
+          "China",
+          "Argentina",
+          "Switzerland",
+          "Canada",
+          "United Kingdom",
+          "UAE",
+          "Cayman Islands"
+        ]
+      },
+      "ReportTypeEnum": {
+        "type": "string",
+        "enum": [
+          "mostwanted",
+          "money",
+          "stats",
+          "references",
+          "friendorfoe",
+          "companyfinancials",
+          "truelevel",
+          "stockanalysis",
+          "anonymousbounties",
+          "investment"
+        ]
+      },
       "ApiKeyAccessTypeEnum": {
         "type": "string",
         "enum": [
@@ -11450,79 +11598,624 @@
         },
         "type": "object"
       },
-      "UserCurrentEducation": {
+      "ReportBase": {
+        "required": [
+          "type",
+          "target_id",
+          "reporter_id",
+          "faction_id",
+          "timestamp"
+        ],
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/ReportTypeEnum"
+          },
+          "target_id": {
+            "description": "The target ID if applicable.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/UserId"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "reporter_id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "faction_id": {
+            "description": "Reporter's faction ID if applicable.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/FactionId"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "ReportWarrantDetails": {
         "required": [
           "id",
-          "until"
+          "name",
+          "warrant"
         ],
         "properties": {
           "id": {
-            "$ref": "#/components/schemas/EducationId"
+            "$ref": "#/components/schemas/UserId"
           },
-          "until": {
+          "name": {
+            "type": "string"
+          },
+          "warrant": {
             "type": "integer",
             "format": "int32"
           }
         },
         "type": "object"
       },
-      "UserEducation": {
+      "ReportMostWanted": {
         "required": [
-          "complete",
-          "current"
+          "top",
+          "notable"
         ],
         "properties": {
-          "complete": {
+          "top": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/EducationId"
+              "$ref": "#/components/schemas/ReportWarrantDetails"
             }
           },
-          "current": {
-            "oneOf": [
-              {
-                "$ref": "#/components/schemas/UserCurrentEducation"
-              },
-              {
-                "type": "null"
-              }
-            ]
+          "notable": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ReportWarrantDetails"
+            }
           }
         },
         "type": "object"
       },
-      "UserEducationResponse": {
+      "ReportMoney": {
         "required": [
-          "education"
+          "money"
         ],
         "properties": {
-          "education": {
-            "$ref": "#/components/schemas/UserEducation"
+          "money": {
+            "type": "integer",
+            "format": "int32"
           }
         },
         "type": "object"
       },
-      "UserCrimeDetailsBootlegging": {
+      "ReportInvestment": {
         "required": [
-          "online_store",
-          "dvd_sales",
-          "dvd_copies"
+          "amount",
+          "until"
         ],
         "properties": {
-          "online_store": {
-            "description": "Online store statistics.",
-            "required": [
-              "earnings",
-              "visits",
-              "customers",
-              "sales"
-            ],
-            "properties": {
-              "earnings": {
+          "amount": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "until": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "ReportTrueLevel": {
+        "required": [
+          "level"
+        ],
+        "properties": {
+          "level": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "ReportStats": {
+        "required": [
+          "strength",
+          "speed",
+          "dexterity",
+          "defense",
+          "total"
+        ],
+        "properties": {
+          "strength": {
+            "oneOf": [
+              {
                 "type": "integer",
-                "format": "int32"
+                "format": "int64"
               },
-              "visits": {
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "speed": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "format": "int64"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "dexterity": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "format": "int64"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "defense": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "format": "int64"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "total": {
+            "oneOf": [
+              {
+                "type": "integer",
+                "format": "int64"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "ReportHistoryFaction": {
+        "required": [
+          "id",
+          "name",
+          "joined",
+          "left"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/FactionId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "joined": {
+            "type": "string",
+            "format": "date"
+          },
+          "left": {
+            "oneOf": [
+              {
+                "type": "string",
+                "format": "date"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "ReportHistoryCompany": {
+        "required": [
+          "id",
+          "name",
+          "joined",
+          "left"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/CompanyId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "joined": {
+            "type": "string",
+            "format": "date"
+          },
+          "left": {
+            "oneOf": [
+              {
+                "type": "string",
+                "format": "date"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "ReportHistory": {
+        "required": [
+          "factions",
+          "companies"
+        ],
+        "properties": {
+          "factions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ReportHistoryFaction"
+            }
+          },
+          "companies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ReportHistoryCompany"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "ReportFriendOrFoeUser": {
+        "required": [
+          "id",
+          "name"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/UserId"
+          },
+          "name": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "ReportFriendOrFoe": {
+        "required": [
+          "friends",
+          "enemies"
+        ],
+        "properties": {
+          "friends": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ReportFriendOrFoeUser"
+            }
+          },
+          "enemies": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ReportFriendOrFoeUser"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "ReportCompanyFinancials": {
+        "required": [
+          "balance",
+          "employees",
+          "wages"
+        ],
+        "properties": {
+          "balance": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "employees": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "wages": {
+            "required": [
+              "highest",
+              "lowest",
+              "average"
+            ],
+            "properties": {
+              "highest": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "lowest": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "average": {
+                "type": "integer",
+                "format": "int32"
+              }
+            },
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "ReportStockAnalysis": {
+        "required": [
+          "items"
+        ],
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "required": [
+                "country",
+                "item",
+                "trip_duration",
+                "hourly_profit"
+              ],
+              "properties": {
+                "country": {
+                  "$ref": "#/components/schemas/CountryEnum"
+                },
+                "item": {
+                  "required": [
+                    "id",
+                    "name",
+                    "stock",
+                    "price",
+                    "value",
+                    "due"
+                  ],
+                  "properties": {
+                    "id": {
+                      "$ref": "#/components/schemas/ItemId"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "price": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "value": {
+                      "type": "integer",
+                      "format": "int32"
+                    },
+                    "due": {
+                      "oneOf": [
+                        {
+                          "type": "integer",
+                          "format": "int32"
+                        },
+                        {
+                          "type": "null"
+                        }
+                      ]
+                    }
+                  },
+                  "type": "object"
+                },
+                "trip_duration": {
+                  "type": "integer",
+                  "format": "int32"
+                },
+                "hourly_profit": {
+                  "type": "integer",
+                  "format": "int32"
+                }
+              },
+              "type": "object"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "ReportAnonymousBounties": {
+        "required": [
+          "bounties"
+        ],
+        "properties": {
+          "bounties": {
+            "type": "array",
+            "items": {
+              "required": [
+                "bounty",
+                "user",
+                "text"
+              ],
+              "properties": {
+                "text": {
+                  "type": "string"
+                },
+                "bounty": {
+                  "type": "integer",
+                  "format": "int64"
+                },
+                "user": {
+                  "oneOf": [
+                    {
+                      "required": [
+                        "id",
+                        "name"
+                      ],
+                      "properties": {
+                        "id": {
+                          "$ref": "#/components/schemas/UserId"
+                        },
+                        "name": {
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                }
+              },
+              "type": "object"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "ReportReport": {
+        "required": [
+          "report"
+        ],
+        "properties": {
+          "report": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/ReportMoney"
+              },
+              {
+                "$ref": "#/components/schemas/ReportStats"
+              },
+              {
+                "$ref": "#/components/schemas/ReportMostWanted"
+              },
+              {
+                "$ref": "#/components/schemas/ReportHistory"
+              },
+              {
+                "$ref": "#/components/schemas/ReportFriendOrFoe"
+              },
+              {
+                "$ref": "#/components/schemas/ReportCompanyFinancials"
+              },
+              {
+                "$ref": "#/components/schemas/ReportTrueLevel"
+              },
+              {
+                "$ref": "#/components/schemas/ReportStockAnalysis"
+              },
+              {
+                "$ref": "#/components/schemas/ReportAnonymousBounties"
+              },
+              {
+                "$ref": "#/components/schemas/ReportInvestment"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "Report": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ReportBase"
+          },
+          {
+            "$ref": "#/components/schemas/ReportReport"
+          }
+        ]
+      },
+      "ReportsResponse": {
+        "required": [
+          "reports",
+          "_metadata"
+        ],
+        "properties": {
+          "reports": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Report"
+            }
+          },
+          "_metadata": {
+            "$ref": "#/components/schemas/RequestMetadataWithLinks"
+          }
+        },
+        "type": "object"
+      },
+      "UserCurrentEducation": {
+        "required": [
+          "id",
+          "until"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/EducationId"
+          },
+          "until": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserEducation": {
+        "required": [
+          "complete",
+          "current"
+        ],
+        "properties": {
+          "complete": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EducationId"
+            }
+          },
+          "current": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/UserCurrentEducation"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object"
+      },
+      "UserEducationResponse": {
+        "required": [
+          "education"
+        ],
+        "properties": {
+          "education": {
+            "$ref": "#/components/schemas/UserEducation"
+          }
+        },
+        "type": "object"
+      },
+      "UserCrimeDetailsBootlegging": {
+        "required": [
+          "online_store",
+          "dvd_sales",
+          "dvd_copies"
+        ],
+        "properties": {
+          "online_store": {
+            "description": "Online store statistics.",
+            "required": [
+              "earnings",
+              "visits",
+              "customers",
+              "sales"
+            ],
+            "properties": {
+              "earnings": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "visits": {
                 "type": "integer",
                 "format": "int32"
               },
@@ -12412,7 +13105,7 @@
         ],
         "properties": {
           "value": {
-            "type": "integer",
+            "type": "number",
             "format": "float"
           },
           "rank": {
@@ -12434,7 +13127,7 @@
           "rank": {
             "oneOf": [
               {
-                "type": "number",
+                "type": "integer",
                 "format": "int32"
               },
               {
@@ -21603,6 +22296,16 @@
           "minimum": 1
         }
       },
+      "ApiTarget": {
+        "name": "target",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "integer",
+          "format": "int32",
+          "minimum": 1
+        }
+      },
       "ApiSort": {
         "name": "sort",
         "in": "query",

package/package.json

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