tornapi-typescript 3.0.8 → 3.0.10

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.8"
+    "version": "3.0.10"
   },
   "servers": [
     {
@@ -976,6 +976,45 @@
         "x-stability": "Stable"
       }
     },
+    "/user/honors": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your achieved honors",
+        "description": "Requires minimal access key. <br>",
+        "operationId": "03bcd69dc16d287da5a5c1239b1e35ae",
+        "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/UserHonorsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/user/itemmarket": {
       "get": {
         "tags": [
@@ -1224,6 +1263,84 @@
         "x-stability": "Unstable"
       }
     },
+    "/user/medals": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your achieved medals",
+        "description": "Requires minimal access key. <br>",
+        "operationId": "5c1d150273feb0c553f6cfb96071bf1b",
+        "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/UserMedalsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
+    "/user/merits": {
+      "get": {
+        "tags": [
+          "User"
+        ],
+        "summary": "Get your merits",
+        "description": "Requires minimal access key. <br>",
+        "operationId": "af17d832a1ff8c1d327f262886b39fec",
+        "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/UserMeritsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/user/money": {
       "get": {
         "tags": [
@@ -1458,6 +1575,9 @@
         "description": "Requires public access key. <br>Extended responses are available when requesting the data with Limited or higher access keys.",
         "operationId": "574a416ca46717830f03a2f685955b87",
         "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiFiltersUserProperties"
+          },
           {
             "$ref": "#/components/parameters/ApiOffset"
           },
@@ -1512,6 +1632,9 @@
               "$ref": "#/components/schemas/UserId"
             }
           },
+          {
+            "$ref": "#/components/parameters/ApiFiltersUserProperties"
+          },
           {
             "$ref": "#/components/parameters/ApiOffset"
           },
@@ -2158,7 +2281,7 @@
             }
           },
           {
-            "$ref": "#/components/parameters/ApiFiltersIncomingOutgoing"
+            "$ref": "#/components/parameters/ApiFiltersUser"
           },
           {
             "$ref": "#/components/parameters/ApiStripTags"
@@ -4796,14 +4919,23 @@
           "Forum"
         ],
         "summary": "Get specific forum thread posts",
-        "description": "Requires public access key. <br>Returns 20 posts per page for a specific thread.",
+        "description": "Requires public access key. <br>Returns 20 posts per page for a specific thread. <br> By default, it uses 'offset', but it's possible to filter posts with 'from' & 'to' parameters.",
         "operationId": "9c5eeb1aebb102b7c62fab11974c359a",
         "parameters": [
+          {
+            "$ref": "#/components/parameters/ApiStripTagsTrue"
+          },
           {
             "$ref": "#/components/parameters/ApiOffsetNoDefault"
           },
           {
-            "$ref": "#/components/parameters/ApiStripTagsTrue"
+            "$ref": "#/components/parameters/ApiSort"
+          },
+          {
+            "$ref": "#/components/parameters/ApiFrom"
+          },
+          {
+            "$ref": "#/components/parameters/ApiTo"
           },
           {
             "name": "threadId",
@@ -6815,6 +6947,98 @@
         "x-stability": "Unstable"
       }
     },
+    "/torn/honors": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get all honors",
+        "description": "Requires public access key. <br>",
+        "operationId": "4b7322594732b4e263f2e612f648e6a4",
+        "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/TornHonorsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
+    "/torn/{ids}/honors": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get specific honors",
+        "description": "Requires public access key. <br>",
+        "operationId": "bdbbefa4dc1cd7f146f500816ccbec1a",
+        "parameters": [
+          {
+            "name": "ids",
+            "in": "path",
+            "description": "Honor id or a list of honor ids (comma separated)",
+            "required": true,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/HonorId"
+              }
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TornHonorsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/torn/hof": {
       "get": {
         "tags": [
@@ -7180,6 +7404,137 @@
         "x-stability": "Stable"
       }
     },
+    "/torn/medals": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get all medals",
+        "description": "Requires public access key. <br>",
+        "operationId": "c6e00a242c309a53a98852b225de5e0b",
+        "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/TornMedalsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
+    "/torn/{ids}/medals": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get specific medals",
+        "description": "Requires public access key. <br>",
+        "operationId": "a2f817c8fb95707aa71a7b28bed08a56",
+        "parameters": [
+          {
+            "name": "ids",
+            "in": "path",
+            "description": "Medal id or a list of medal ids (comma separated)",
+            "required": true,
+            "style": "form",
+            "explode": false,
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/MedalId"
+              }
+            }
+          },
+          {
+            "$ref": "#/components/parameters/ApiTimestamp"
+          },
+          {
+            "$ref": "#/components/parameters/ApiComment"
+          },
+          {
+            "$ref": "#/components/parameters/ApiKeyPublic"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TornMedalsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
+    "/torn/merits": {
+      "get": {
+        "tags": [
+          "Torn"
+        ],
+        "summary": "Get all merits",
+        "description": "Requires public access key. <br>",
+        "operationId": "06198712e3cfdee6b3d5ea11fb6754ef",
+        "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/TornMeritsResponse"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "api_key": []
+          }
+        ],
+        "x-stability": "Stable"
+      }
+    },
     "/torn/organizedcrimes": {
       "get": {
         "tags": [
@@ -12343,6 +12698,18 @@
         "type": "integer",
         "format": "int32"
       },
+      "HonorId": {
+        "type": "integer",
+        "format": "int32"
+      },
+      "MedalId": {
+        "type": "integer",
+        "format": "int32"
+      },
+      "MeritId": {
+        "type": "integer",
+        "format": "int32"
+      },
       "OrganizedCrimeName": {
         "type": "string"
       },
@@ -12558,6 +12925,19 @@
           "Enby"
         ]
       },
+      "HonorRarityEnum": {
+        "type": "string",
+        "enum": [
+          "Extremely Rare",
+          "Very Rare",
+          "Rare",
+          "Limited",
+          "Uncommon",
+          "Common",
+          "Very Common",
+          "Unknown"
+        ]
+      },
       "Parameters": {
         "oneOf": [
           {
@@ -12703,6 +13083,42 @@
           "Temporary"
         ]
       },
+      "MedalTypeEnum": {
+        "type": "string",
+        "enum": [
+          "combat",
+          "commitment",
+          "crime",
+          "level",
+          "miscellaneous",
+          "networth",
+          "rank"
+        ]
+      },
+      "HonorTypeEnum": {
+        "type": "string",
+        "enum": [
+          "attacking",
+          "camo",
+          "weapons",
+          "education",
+          "crimes",
+          "drugs",
+          "jail",
+          "hospital",
+          "travel",
+          "gym",
+          "level",
+          "competitions",
+          "money",
+          "items",
+          "commitment",
+          "casino",
+          "missions",
+          "misc",
+          "default"
+        ]
+      },
       "TornItemTypeEnum": {
         "type": "string",
         "enum": [
@@ -14493,7 +14909,8 @@
               "cost",
               "cost_per_day",
               "rental_period",
-              "rental_period_remaining"
+              "rental_period_remaining",
+              "lease_extension"
             ],
             "properties": {
               "used_by": {
@@ -14526,6 +14943,35 @@
               },
               "rented_by": {
                 "$ref": "#/components/schemas/BasicUser"
+              },
+              "lease_extension": {
+                "oneOf": [
+                  {
+                    "required": [
+                      "cost",
+                      "period",
+                      "created_at"
+                    ],
+                    "properties": {
+                      "cost": {
+                        "type": "integer",
+                        "format": "int64"
+                      },
+                      "period": {
+                        "type": "integer",
+                        "format": "int32"
+                      },
+                      "created_at": {
+                        "type": "integer",
+                        "format": "int32"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
               }
             },
             "type": "object"
@@ -16058,7 +16504,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','honors','icons','inventory','log','medals','merits','messages','missions','networth','newevents','newmessages','notifications','perks','profile','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','events','gym','icons','inventory','messages','missions','networth','newevents','newmessages','notifications','perks','profile','refills','stocks','travel','weaponexp'.",
             "type": "string",
             "enum": [
               "attacks",
@@ -16076,11 +16522,15 @@
               "forumsubscribedthreads",
               "forumthreads",
               "hof",
+              "honors",
               "itemmarket",
               "jobpoints",
               "jobranks",
               "list",
+              "log",
               "lookup",
+              "medals",
+              "merits",
               "money",
               "organizedcrime",
               "personalstats",
@@ -16105,12 +16555,8 @@
               "equipment",
               "events",
               "gym",
-              "honors",
               "icons",
               "inventory",
-              "log",
-              "medals",
-              "merits",
               "messages",
               "missions",
               "networth",
@@ -16144,6 +16590,127 @@
         },
         "type": "object"
       },
+      "UserHonor": {
+        "required": [
+          "id",
+          "timestamp"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/HonorId"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserHonorsResponse": {
+        "required": [
+          "honors"
+        ],
+        "properties": {
+          "honors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserHonor"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserMedal": {
+        "required": [
+          "id",
+          "timestamp"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/MedalId"
+          },
+          "timestamp": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserMedalsResponse": {
+        "required": [
+          "medals"
+        ],
+        "properties": {
+          "medals": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserMedal"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "UserMeritUpgrade": {
+        "required": [
+          "id",
+          "level"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/MeritId"
+          },
+          "level": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserMerits": {
+        "required": [
+          "upgrades",
+          "available",
+          "used",
+          "medals",
+          "honors"
+        ],
+        "properties": {
+          "upgrades": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserMeritUpgrade"
+            }
+          },
+          "available": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "used": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "medals": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "honors": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "type": "object"
+      },
+      "UserMeritsResponse": {
+        "required": [
+          "merits"
+        ],
+        "properties": {
+          "merits": {
+            "$ref": "#/components/schemas/UserMerits"
+          }
+        },
+        "type": "object"
+      },
       "PersonalStatsOther": {
         "required": [
           "other"
@@ -24453,6 +25020,160 @@
         },
         "type": "object"
       },
+      "TornMerit": {
+        "required": [
+          "id",
+          "name",
+          "description"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/MeritId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "TornMeritsResponse": {
+        "required": [
+          "merits"
+        ],
+        "properties": {
+          "merits": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornMerit"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "TornHonor": {
+        "description": "Properties 'circulation', 'equipped' & 'rarity' are only populated for honors which do not have type.id value 1.",
+        "required": [
+          "id",
+          "name",
+          "description",
+          "type"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/HonorId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "type": {
+            "required": [
+              "id",
+              "title"
+            ],
+            "properties": {
+              "id": {
+                "type": "integer",
+                "format": "int32"
+              },
+              "title": {
+                "$ref": "#/components/schemas/HonorTypeEnum"
+              }
+            },
+            "type": "object"
+          },
+          "circulation": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "equipped": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "rarity": {
+            "$ref": "#/components/schemas/HonorRarityEnum"
+          }
+        },
+        "type": "object"
+      },
+      "TornHonorsResponse": {
+        "required": [
+          "honors"
+        ],
+        "properties": {
+          "honors": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornHonor"
+            }
+          }
+        },
+        "type": "object"
+      },
+      "TornMedal": {
+        "required": [
+          "id",
+          "name",
+          "description",
+          "type",
+          "circulation",
+          "equipped",
+          "rarity"
+        ],
+        "properties": {
+          "id": {
+            "$ref": "#/components/schemas/MedalId"
+          },
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "type": {
+            "required": [
+              "id",
+              "title"
+            ],
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "title": {
+                "$ref": "#/components/schemas/MedalTypeEnum"
+              }
+            },
+            "type": "object"
+          },
+          "circulation": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "rarity": {
+            "$ref": "#/components/schemas/HonorRarityEnum"
+          }
+        },
+        "type": "object"
+      },
+      "TornMedalsResponse": {
+        "required": [
+          "medals"
+        ],
+        "properties": {
+          "medals": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TornMedal"
+            }
+          }
+        },
+        "type": "object"
+      },
       "TornOrganizedCrimeResponse": {
         "required": [
           "organizedcrimes"
@@ -26106,7 +26827,7 @@
       "TornSelectionName": {
         "oneOf": [
           {
-            "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.\n *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.",
+            "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','gyms','itemdetails','itemstats','organisedcrimes','pawnshop','pokertables','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.\n *   The following selections are not available in API v2: 'dirtybombs','raidreport','raids', 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.",
             "type": "string",
             "enum": [
               "attacklog",
@@ -26117,12 +26838,15 @@
               "factionhof",
               "factiontree",
               "hof",
+              "honors",
               "itemammo",
               "itemmods",
               "items",
               "logcategories",
               "logtypes",
               "lookup",
+              "medals",
+              "merits",
               "organizedcrimes",
               "properties",
               "subcrimes",
@@ -26134,10 +26858,8 @@
               "companies",
               "competition",
               "gyms",
-              "honors",
               "itemdetails",
               "itemstats",
-              "medals",
               "organisedcrimes",
               "pawnshop",
               "pokertables",
@@ -26227,6 +26949,34 @@
           ]
         }
       },
+      "ApiFiltersUser": {
+        "name": "filters",
+        "in": "query",
+        "description": "It's possible to use this query parameter to only get incoming or outgoing attacks / revives. If not specified, this selection will return both incoming and outgoing attacks / revives.",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "enum": [
+            "incoming",
+            "outgoing",
+            "ownedByUser",
+            "ownedBySpouse"
+          ]
+        }
+      },
+      "ApiFiltersUserProperties": {
+        "name": "filters",
+        "in": "query",
+        "description": "It's possible to use this query parameter to filter properties by the key owner or their spouse.",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "enum": [
+            "ownedByUser",
+            "ownedBySpouse"
+          ]
+        }
+      },
       "ApiFactionSearchFilter": {
         "name": "filters",
         "in": "query",