tornapi-typescript 1.10.2 → 1.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Torn API",
5
5
  "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.",
6
- "version": "1.10.2"
6
+ "version": "1.11.1"
7
7
  },
8
8
  "servers": [
9
9
  {
@@ -1161,6 +1161,192 @@
1161
1161
  "x-stability": "Stable"
1162
1162
  }
1163
1163
  },
1164
+ "/user/properties": {
1165
+ "get": {
1166
+ "tags": [
1167
+ "User"
1168
+ ],
1169
+ "summary": "Get your own properties",
1170
+ "description": "Requires public access key. <br>Extended responses are available when requesting the data with Limited or higher access keys.",
1171
+ "operationId": "574a416ca46717830f03a2f685955b87",
1172
+ "parameters": [
1173
+ {
1174
+ "$ref": "#/components/parameters/ApiOffset"
1175
+ },
1176
+ {
1177
+ "$ref": "#/components/parameters/ApiLimit100Default20"
1178
+ },
1179
+ {
1180
+ "$ref": "#/components/parameters/ApiTimestamp"
1181
+ },
1182
+ {
1183
+ "$ref": "#/components/parameters/ApiComment"
1184
+ },
1185
+ {
1186
+ "$ref": "#/components/parameters/ApiKeyPublic"
1187
+ }
1188
+ ],
1189
+ "responses": {
1190
+ "200": {
1191
+ "description": "Successful operation",
1192
+ "content": {
1193
+ "application/json": {
1194
+ "schema": {
1195
+ "$ref": "#/components/schemas/UserPropertiesResponse"
1196
+ }
1197
+ }
1198
+ }
1199
+ }
1200
+ },
1201
+ "security": [
1202
+ {
1203
+ "api_key": []
1204
+ }
1205
+ ],
1206
+ "x-stability": "Unstable"
1207
+ }
1208
+ },
1209
+ "/user/{id}/properties": {
1210
+ "get": {
1211
+ "tags": [
1212
+ "User"
1213
+ ],
1214
+ "summary": "Get specific user's properties",
1215
+ "description": "Requires public access key. <br>Extended responses are available when requesting the data with Limited or higher access keys for yourself or your spouse.",
1216
+ "operationId": "601f7b38ac25e1ac47b33fb64120198b",
1217
+ "parameters": [
1218
+ {
1219
+ "name": "id",
1220
+ "in": "path",
1221
+ "description": "User id",
1222
+ "required": true,
1223
+ "schema": {
1224
+ "$ref": "#/components/schemas/UserId"
1225
+ }
1226
+ },
1227
+ {
1228
+ "$ref": "#/components/parameters/ApiOffset"
1229
+ },
1230
+ {
1231
+ "$ref": "#/components/parameters/ApiLimit100Default20"
1232
+ },
1233
+ {
1234
+ "$ref": "#/components/parameters/ApiTimestamp"
1235
+ },
1236
+ {
1237
+ "$ref": "#/components/parameters/ApiComment"
1238
+ },
1239
+ {
1240
+ "$ref": "#/components/parameters/ApiKeyPublic"
1241
+ }
1242
+ ],
1243
+ "responses": {
1244
+ "200": {
1245
+ "description": "Successful operation",
1246
+ "content": {
1247
+ "application/json": {
1248
+ "schema": {
1249
+ "$ref": "#/components/schemas/UserPropertiesResponse"
1250
+ }
1251
+ }
1252
+ }
1253
+ }
1254
+ },
1255
+ "security": [
1256
+ {
1257
+ "api_key": []
1258
+ }
1259
+ ],
1260
+ "x-stability": "Unstable"
1261
+ }
1262
+ },
1263
+ "/user/property": {
1264
+ "get": {
1265
+ "tags": [
1266
+ "User"
1267
+ ],
1268
+ "summary": "Get your current property",
1269
+ "description": "Requires public access key. <br>",
1270
+ "operationId": "0452cb8fd031b80d3b7e9fcb7b0bdf09",
1271
+ "parameters": [
1272
+ {
1273
+ "$ref": "#/components/parameters/ApiTimestamp"
1274
+ },
1275
+ {
1276
+ "$ref": "#/components/parameters/ApiComment"
1277
+ },
1278
+ {
1279
+ "$ref": "#/components/parameters/ApiKeyPublic"
1280
+ }
1281
+ ],
1282
+ "responses": {
1283
+ "200": {
1284
+ "description": "Successful operation",
1285
+ "content": {
1286
+ "application/json": {
1287
+ "schema": {
1288
+ "$ref": "#/components/schemas/UserPropertyResponse"
1289
+ }
1290
+ }
1291
+ }
1292
+ }
1293
+ },
1294
+ "security": [
1295
+ {
1296
+ "api_key": []
1297
+ }
1298
+ ],
1299
+ "x-stability": "Unstable"
1300
+ }
1301
+ },
1302
+ "/user/{id}/property": {
1303
+ "get": {
1304
+ "tags": [
1305
+ "User"
1306
+ ],
1307
+ "summary": "Get specific user's property",
1308
+ "description": "Requires public access key. <br>",
1309
+ "operationId": "f36ce18449194dd9d2b62bccd4bb8343",
1310
+ "parameters": [
1311
+ {
1312
+ "name": "id",
1313
+ "in": "path",
1314
+ "description": "User id",
1315
+ "required": true,
1316
+ "schema": {
1317
+ "$ref": "#/components/schemas/UserId"
1318
+ }
1319
+ },
1320
+ {
1321
+ "$ref": "#/components/parameters/ApiTimestamp"
1322
+ },
1323
+ {
1324
+ "$ref": "#/components/parameters/ApiComment"
1325
+ },
1326
+ {
1327
+ "$ref": "#/components/parameters/ApiKeyPublic"
1328
+ }
1329
+ ],
1330
+ "responses": {
1331
+ "200": {
1332
+ "description": "Successful operation",
1333
+ "content": {
1334
+ "application/json": {
1335
+ "schema": {
1336
+ "$ref": "#/components/schemas/UserPropertyResponse"
1337
+ }
1338
+ }
1339
+ }
1340
+ }
1341
+ },
1342
+ "security": [
1343
+ {
1344
+ "api_key": []
1345
+ }
1346
+ ],
1347
+ "x-stability": "Unstable"
1348
+ }
1349
+ },
1164
1350
  "/user/races": {
1165
1351
  "get": {
1166
1352
  "tags": [
@@ -1622,6 +1808,9 @@
1622
1808
  {
1623
1809
  "$ref": "#/components/schemas/UserJobRanksResponse"
1624
1810
  },
1811
+ {
1812
+ "$ref": "#/components/schemas/UserPropertiesResponse"
1813
+ },
1625
1814
  {
1626
1815
  "$ref": "#/components/schemas/UserFactionBalanceResponse"
1627
1816
  },
@@ -2288,13 +2477,13 @@
2288
2477
  "Faction"
2289
2478
  ],
2290
2479
  "summary": "Get your faction's organized crimes",
2291
- "description": "Requires minimal access key with faction API access permissions. <br> It's possible to get older entries either by timestamp range (from, to) or with offset.",
2480
+ "description": "Requires minimal access key with faction API access permissions. <br> It's possible to get older entries either by timestamp range (from, to) or with offset.<br> Crimes are ordered depending on the category chosen:\n * For categories 'all' & 'available', the ordering field is 'created_at'.\n * For categories 'successful', 'failed' & 'completed', the ordering field is 'executed_at'.\n * For categories 'recruiting' & 'expired', the ordering field is 'expired_at'.\n * For category 'planning', the ordering field is 'ready_at'.",
2292
2481
  "operationId": "72e5db8a773908fedff4bb002f3f4406",
2293
2482
  "parameters": [
2294
2483
  {
2295
2484
  "name": "cat",
2296
2485
  "in": "query",
2297
- "description": "Category of organized crimes returned. Category 'available' includes both 'recruiting' & 'planning', and category 'completed' includes both 'successful' & 'failure'<br>Default category is 'all'",
2486
+ "description": "Category of organized crimes returned. Category 'available' includes both 'recruiting' & 'planning', and category 'completed' includes both 'successful' & 'failure'<br>Default category is 'all'.",
2298
2487
  "required": false,
2299
2488
  "schema": {
2300
2489
  "type": "string",
@@ -4833,6 +5022,120 @@
4833
5022
  "x-stability": "Unstable"
4834
5023
  }
4835
5024
  },
5025
+ "/market/{propertyTypeId}/properties": {
5026
+ "get": {
5027
+ "tags": [
5028
+ "Market"
5029
+ ],
5030
+ "summary": "Get properties market listings",
5031
+ "description": "Requires public access key. <br>",
5032
+ "operationId": "17e406574ff1eb686891c0fb0e15343a",
5033
+ "parameters": [
5034
+ {
5035
+ "name": "propertyTypeId",
5036
+ "in": "path",
5037
+ "description": "Property type id",
5038
+ "required": true,
5039
+ "schema": {
5040
+ "$ref": "#/components/schemas/PropertyTypeId"
5041
+ }
5042
+ },
5043
+ {
5044
+ "$ref": "#/components/parameters/ApiOffset"
5045
+ },
5046
+ {
5047
+ "$ref": "#/components/parameters/ApiLimit100Default20"
5048
+ },
5049
+ {
5050
+ "$ref": "#/components/parameters/ApiSort"
5051
+ },
5052
+ {
5053
+ "$ref": "#/components/parameters/ApiTimestamp"
5054
+ },
5055
+ {
5056
+ "$ref": "#/components/parameters/ApiComment"
5057
+ },
5058
+ {
5059
+ "$ref": "#/components/parameters/ApiKeyPublic"
5060
+ }
5061
+ ],
5062
+ "responses": {
5063
+ "200": {
5064
+ "description": "Successful operation",
5065
+ "content": {
5066
+ "application/json": {
5067
+ "schema": {
5068
+ "$ref": "#/components/schemas/MarketPropertiesResponse"
5069
+ }
5070
+ }
5071
+ }
5072
+ }
5073
+ },
5074
+ "security": [
5075
+ {
5076
+ "api_key": []
5077
+ }
5078
+ ],
5079
+ "x-stability": "Unstable"
5080
+ }
5081
+ },
5082
+ "/market/{propertyTypeId}/rentals": {
5083
+ "get": {
5084
+ "tags": [
5085
+ "Market"
5086
+ ],
5087
+ "summary": "Get properties rental listings",
5088
+ "description": "Requires public access key. <br>",
5089
+ "operationId": "38cd1a2c47e266a703a13e0dd401f4a9",
5090
+ "parameters": [
5091
+ {
5092
+ "name": "propertyTypeId",
5093
+ "in": "path",
5094
+ "description": "Property type id",
5095
+ "required": true,
5096
+ "schema": {
5097
+ "$ref": "#/components/schemas/PropertyTypeId"
5098
+ }
5099
+ },
5100
+ {
5101
+ "$ref": "#/components/parameters/ApiOffset"
5102
+ },
5103
+ {
5104
+ "$ref": "#/components/parameters/ApiLimit100Default20"
5105
+ },
5106
+ {
5107
+ "$ref": "#/components/parameters/ApiSort"
5108
+ },
5109
+ {
5110
+ "$ref": "#/components/parameters/ApiTimestamp"
5111
+ },
5112
+ {
5113
+ "$ref": "#/components/parameters/ApiComment"
5114
+ },
5115
+ {
5116
+ "$ref": "#/components/parameters/ApiKeyPublic"
5117
+ }
5118
+ ],
5119
+ "responses": {
5120
+ "200": {
5121
+ "description": "Successful operation",
5122
+ "content": {
5123
+ "application/json": {
5124
+ "schema": {
5125
+ "$ref": "#/components/schemas/MarketRentalsResponse"
5126
+ }
5127
+ }
5128
+ }
5129
+ }
5130
+ },
5131
+ "security": [
5132
+ {
5133
+ "api_key": []
5134
+ }
5135
+ ],
5136
+ "x-stability": "Unstable"
5137
+ }
5138
+ },
4836
5139
  "/market/lookup": {
4837
5140
  "get": {
4838
5141
  "tags": [
@@ -4940,7 +5243,14 @@
4940
5243
  "description": "selection id",
4941
5244
  "required": false,
4942
5245
  "schema": {
4943
- "$ref": "#/components/schemas/ItemId"
5246
+ "oneOf": [
5247
+ {
5248
+ "$ref": "#/components/schemas/ItemId"
5249
+ },
5250
+ {
5251
+ "$ref": "#/components/schemas/PropertyTypeId"
5252
+ }
5253
+ ]
4944
5254
  }
4945
5255
  },
4946
5256
  {
@@ -4977,6 +5287,9 @@
4977
5287
  {
4978
5288
  "$ref": "#/components/parameters/ApiOffsetNoDefault"
4979
5289
  },
5290
+ {
5291
+ "$ref": "#/components/parameters/ApiLimit100Default20"
5292
+ },
4980
5293
  {
4981
5294
  "$ref": "#/components/parameters/ApiTimestamp"
4982
5295
  },
@@ -5003,6 +5316,15 @@
5003
5316
  {
5004
5317
  "$ref": "#/components/schemas/MarketItemMarketResponse"
5005
5318
  },
5319
+ {
5320
+ "$ref": "#/components/schemas/MarketRentalsResponse"
5321
+ },
5322
+ {
5323
+ "$ref": "#/components/schemas/MarketPropertiesResponse"
5324
+ },
5325
+ {
5326
+ "$ref": "#/components/schemas/MarketItemMarketResponse"
5327
+ },
5006
5328
  {
5007
5329
  "$ref": "#/components/schemas/MarketLookupResponse"
5008
5330
  },
@@ -5508,6 +5830,54 @@
5508
5830
  "x-stability": "Stable"
5509
5831
  }
5510
5832
  },
5833
+ "/property/{id}/property": {
5834
+ "get": {
5835
+ "tags": [
5836
+ "Property"
5837
+ ],
5838
+ "summary": "Get a specific property",
5839
+ "description": "Requires public access key. <br>",
5840
+ "operationId": "87bd73ddaf3749bce7cbf5aa28e921e2",
5841
+ "parameters": [
5842
+ {
5843
+ "name": "id",
5844
+ "in": "path",
5845
+ "description": "Property id",
5846
+ "required": true,
5847
+ "schema": {
5848
+ "$ref": "#/components/schemas/PropertyId"
5849
+ }
5850
+ },
5851
+ {
5852
+ "$ref": "#/components/parameters/ApiTimestamp"
5853
+ },
5854
+ {
5855
+ "$ref": "#/components/parameters/ApiComment"
5856
+ },
5857
+ {
5858
+ "$ref": "#/components/parameters/ApiKeyPublic"
5859
+ }
5860
+ ],
5861
+ "responses": {
5862
+ "200": {
5863
+ "description": "Successful operation",
5864
+ "content": {
5865
+ "application/json": {
5866
+ "schema": {
5867
+ "$ref": "#/components/schemas/UserPropertyResponse"
5868
+ }
5869
+ }
5870
+ }
5871
+ }
5872
+ },
5873
+ "security": [
5874
+ {
5875
+ "api_key": []
5876
+ }
5877
+ ],
5878
+ "x-stability": "Unstable"
5879
+ }
5880
+ },
5511
5881
  "/torn/attacklog": {
5512
5882
  "get": {
5513
5883
  "tags": [
@@ -6185,6 +6555,45 @@
6185
6555
  "x-stability": "Stable"
6186
6556
  }
6187
6557
  },
6558
+ "/torn/properties": {
6559
+ "get": {
6560
+ "tags": [
6561
+ "Torn"
6562
+ ],
6563
+ "summary": "Get properties details",
6564
+ "description": "Requires public access key. <br>",
6565
+ "operationId": "c44f572f4672071280a28e6f8217c3b6",
6566
+ "parameters": [
6567
+ {
6568
+ "$ref": "#/components/parameters/ApiTimestamp"
6569
+ },
6570
+ {
6571
+ "$ref": "#/components/parameters/ApiComment"
6572
+ },
6573
+ {
6574
+ "$ref": "#/components/parameters/ApiKeyPublic"
6575
+ }
6576
+ ],
6577
+ "responses": {
6578
+ "200": {
6579
+ "description": "Successful operation",
6580
+ "content": {
6581
+ "application/json": {
6582
+ "schema": {
6583
+ "$ref": "#/components/schemas/TornProperties"
6584
+ }
6585
+ }
6586
+ }
6587
+ }
6588
+ },
6589
+ "security": [
6590
+ {
6591
+ "api_key": []
6592
+ }
6593
+ ],
6594
+ "x-stability": "Unstable"
6595
+ }
6596
+ },
6188
6597
  "/torn/{crimeId}/subcrimes": {
6189
6598
  "get": {
6190
6599
  "tags": [
@@ -6508,6 +6917,9 @@
6508
6917
  {
6509
6918
  "$ref": "#/components/schemas/TornItemAmmoResponse"
6510
6919
  },
6920
+ {
6921
+ "$ref": "#/components/schemas/TornProperties"
6922
+ },
6511
6923
  {
6512
6924
  "$ref": "#/components/schemas/TornFactionTreeResponse"
6513
6925
  },
@@ -10734,6 +11146,7 @@
10734
11146
  "gymtrains",
10735
11147
  "gymstrength",
10736
11148
  "gymspeed",
11149
+ "gymenergy",
10737
11150
  "gymdefense",
10738
11151
  "gymdexterity",
10739
11152
  "candyused",
@@ -11220,6 +11633,14 @@
11220
11633
  "type": "integer",
11221
11634
  "format": "int32"
11222
11635
  },
11636
+ "PropertyTypeId": {
11637
+ "type": "integer",
11638
+ "format": "int32"
11639
+ },
11640
+ "PropertyId": {
11641
+ "type": "integer",
11642
+ "format": "int64"
11643
+ },
11223
11644
  "DirtyBombId": {
11224
11645
  "type": "integer",
11225
11646
  "format": "int32"
@@ -11445,6 +11866,37 @@
11445
11866
  "db"
11446
11867
  ]
11447
11868
  },
11869
+ "PropertyModificationEnum": {
11870
+ "type": "string",
11871
+ "enum": [
11872
+ "Hot Tub",
11873
+ "Sauna",
11874
+ "Open Bar",
11875
+ "Small Pool",
11876
+ "Medium Pool",
11877
+ "Large Pool",
11878
+ "Small Vault",
11879
+ "Medium Vault",
11880
+ "Large Vault",
11881
+ "Extra Large Vault",
11882
+ "Medical Facility",
11883
+ "Advanced Shooting Range",
11884
+ "Airstrip",
11885
+ "Private Yacht",
11886
+ "Sufficient Interior Modification",
11887
+ "Superior Interior Modification"
11888
+ ]
11889
+ },
11890
+ "PropertyStaffEnum": {
11891
+ "type": "string",
11892
+ "enum": [
11893
+ "Maid",
11894
+ "Guard",
11895
+ "Doctor",
11896
+ "Pilot",
11897
+ "Butler"
11898
+ ]
11899
+ },
11448
11900
  "FactionCrimeStatusEnum": {
11449
11901
  "type": "string",
11450
11902
  "enum": [
@@ -12608,98 +13060,407 @@
12608
13060
  ]
12609
13061
  }
12610
13062
  },
12611
- "type": "object"
12612
- }
13063
+ "type": "object"
13064
+ }
13065
+ }
13066
+ },
13067
+ "type": "object"
13068
+ },
13069
+ "ReportReport": {
13070
+ "required": [
13071
+ "report"
13072
+ ],
13073
+ "properties": {
13074
+ "report": {
13075
+ "oneOf": [
13076
+ {
13077
+ "$ref": "#/components/schemas/ReportMoney"
13078
+ },
13079
+ {
13080
+ "$ref": "#/components/schemas/ReportStats"
13081
+ },
13082
+ {
13083
+ "$ref": "#/components/schemas/ReportMostWanted"
13084
+ },
13085
+ {
13086
+ "$ref": "#/components/schemas/ReportHistory"
13087
+ },
13088
+ {
13089
+ "$ref": "#/components/schemas/ReportFriendOrFoe"
13090
+ },
13091
+ {
13092
+ "$ref": "#/components/schemas/ReportCompanyFinancials"
13093
+ },
13094
+ {
13095
+ "$ref": "#/components/schemas/ReportTrueLevel"
13096
+ },
13097
+ {
13098
+ "$ref": "#/components/schemas/ReportStockAnalysis"
13099
+ },
13100
+ {
13101
+ "$ref": "#/components/schemas/ReportAnonymousBounties"
13102
+ },
13103
+ {
13104
+ "$ref": "#/components/schemas/ReportInvestment"
13105
+ }
13106
+ ]
13107
+ }
13108
+ },
13109
+ "type": "object"
13110
+ },
13111
+ "Report": {
13112
+ "allOf": [
13113
+ {
13114
+ "$ref": "#/components/schemas/ReportBase"
13115
+ },
13116
+ {
13117
+ "$ref": "#/components/schemas/ReportReport"
13118
+ }
13119
+ ]
13120
+ },
13121
+ "ReportsResponse": {
13122
+ "required": [
13123
+ "reports",
13124
+ "_metadata"
13125
+ ],
13126
+ "properties": {
13127
+ "reports": {
13128
+ "type": "array",
13129
+ "items": {
13130
+ "$ref": "#/components/schemas/Report"
13131
+ }
13132
+ },
13133
+ "_metadata": {
13134
+ "$ref": "#/components/schemas/RequestMetadataWithLinks"
13135
+ }
13136
+ },
13137
+ "type": "object"
13138
+ },
13139
+ "SelectionCategoryEnum": {
13140
+ "oneOf": [
13141
+ {
13142
+ "$ref": "#/components/schemas/ReportTypeEnum"
13143
+ },
13144
+ {
13145
+ "$ref": "#/components/schemas/UserListEnum"
13146
+ },
13147
+ {
13148
+ "$ref": "#/components/schemas/PersonalStatsCategoryEnum"
13149
+ },
13150
+ {
13151
+ "$ref": "#/components/schemas/RacingRaceTypeEnum"
13152
+ }
13153
+ ]
13154
+ },
13155
+ "BasicUser": {
13156
+ "required": [
13157
+ "id",
13158
+ "name"
13159
+ ],
13160
+ "properties": {
13161
+ "id": {
13162
+ "$ref": "#/components/schemas/UserId"
13163
+ },
13164
+ "name": {
13165
+ "type": "string"
13166
+ }
13167
+ },
13168
+ "type": "object"
13169
+ },
13170
+ "UserPropertyBasicDetails": {
13171
+ "required": [
13172
+ "id",
13173
+ "owner",
13174
+ "property",
13175
+ "happy",
13176
+ "upkeep",
13177
+ "market_price",
13178
+ "modifications",
13179
+ "staff"
13180
+ ],
13181
+ "properties": {
13182
+ "id": {
13183
+ "$ref": "#/components/schemas/PropertyId"
13184
+ },
13185
+ "owner": {
13186
+ "$ref": "#/components/schemas/BasicUser"
13187
+ },
13188
+ "property": {
13189
+ "$ref": "#/components/schemas/BasicProperty"
13190
+ },
13191
+ "happy": {
13192
+ "type": "integer",
13193
+ "format": "int32"
13194
+ },
13195
+ "upkeep": {
13196
+ "required": [
13197
+ "property",
13198
+ "staff"
13199
+ ],
13200
+ "properties": {
13201
+ "property": {
13202
+ "type": "integer",
13203
+ "format": "int32"
13204
+ },
13205
+ "staff": {
13206
+ "type": "integer",
13207
+ "format": "int32"
13208
+ }
13209
+ },
13210
+ "type": "object"
13211
+ },
13212
+ "market_price": {
13213
+ "type": "integer",
13214
+ "format": "int64"
13215
+ },
13216
+ "modifications": {
13217
+ "type": "array",
13218
+ "items": {
13219
+ "$ref": "#/components/schemas/PropertyModificationEnum"
13220
+ }
13221
+ },
13222
+ "staff": {
13223
+ "type": "array",
13224
+ "items": {
13225
+ "required": [
13226
+ "type",
13227
+ "amount"
13228
+ ],
13229
+ "properties": {
13230
+ "type": {
13231
+ "$ref": "#/components/schemas/PropertyStaffEnum"
13232
+ },
13233
+ "amount": {
13234
+ "type": "integer",
13235
+ "format": "int32"
13236
+ }
13237
+ },
13238
+ "type": "object"
13239
+ }
13240
+ }
13241
+ },
13242
+ "type": "object"
13243
+ },
13244
+ "UserPropertyDetailsExtended": {
13245
+ "allOf": [
13246
+ {
13247
+ "$ref": "#/components/schemas/UserPropertyBasicDetails"
13248
+ },
13249
+ {
13250
+ "required": [
13251
+ "status",
13252
+ "used_by"
13253
+ ],
13254
+ "properties": {
13255
+ "used_by": {
13256
+ "type": "array",
13257
+ "items": {
13258
+ "$ref": "#/components/schemas/BasicUser"
13259
+ }
13260
+ },
13261
+ "status": {
13262
+ "type": "string",
13263
+ "enum": [
13264
+ "none",
13265
+ "in_use"
13266
+ ]
13267
+ }
13268
+ },
13269
+ "type": "object"
13270
+ }
13271
+ ]
13272
+ },
13273
+ "UserPropertyDetails": {
13274
+ "allOf": [
13275
+ {
13276
+ "$ref": "#/components/schemas/UserPropertyBasicDetails"
13277
+ },
13278
+ {
13279
+ "required": [
13280
+ "used_by"
13281
+ ],
13282
+ "properties": {
13283
+ "used_by": {
13284
+ "type": "array",
13285
+ "items": {
13286
+ "$ref": "#/components/schemas/BasicUser"
13287
+ }
13288
+ }
13289
+ },
13290
+ "type": "object"
13291
+ }
13292
+ ]
13293
+ },
13294
+ "UserPropertyDetailsExtendedRented": {
13295
+ "allOf": [
13296
+ {
13297
+ "$ref": "#/components/schemas/UserPropertyBasicDetails"
13298
+ },
13299
+ {
13300
+ "required": [
13301
+ "status",
13302
+ "used_by",
13303
+ "cost",
13304
+ "cost_per_day",
13305
+ "rental_period",
13306
+ "rental_period_remaining"
13307
+ ],
13308
+ "properties": {
13309
+ "used_by": {
13310
+ "type": "array",
13311
+ "items": {
13312
+ "$ref": "#/components/schemas/BasicUser"
13313
+ }
13314
+ },
13315
+ "status": {
13316
+ "type": "string",
13317
+ "enum": [
13318
+ "rented"
13319
+ ]
13320
+ },
13321
+ "cost": {
13322
+ "type": "integer",
13323
+ "format": "int64"
13324
+ },
13325
+ "cost_per_day": {
13326
+ "type": "integer",
13327
+ "format": "int64"
13328
+ },
13329
+ "rental_period": {
13330
+ "type": "integer",
13331
+ "format": "int32"
13332
+ },
13333
+ "rental_period_remaining": {
13334
+ "type": "integer",
13335
+ "format": "int32"
13336
+ }
13337
+ },
13338
+ "type": "object"
13339
+ }
13340
+ ]
13341
+ },
13342
+ "UserPropertyDetailsExtendedForRent": {
13343
+ "allOf": [
13344
+ {
13345
+ "$ref": "#/components/schemas/UserPropertyBasicDetails"
13346
+ },
13347
+ {
13348
+ "required": [
13349
+ "status",
13350
+ "used_by",
13351
+ "cost",
13352
+ "cost_per_day",
13353
+ "rental_period"
13354
+ ],
13355
+ "properties": {
13356
+ "used_by": {
13357
+ "type": "array",
13358
+ "items": {
13359
+ "$ref": "#/components/schemas/BasicUser"
13360
+ }
13361
+ },
13362
+ "status": {
13363
+ "type": "string",
13364
+ "enum": [
13365
+ "for_rent"
13366
+ ]
13367
+ },
13368
+ "cost": {
13369
+ "type": "integer",
13370
+ "format": "int64"
13371
+ },
13372
+ "cost_per_day": {
13373
+ "type": "integer",
13374
+ "format": "int64"
13375
+ },
13376
+ "rental_period": {
13377
+ "type": "integer",
13378
+ "format": "int32"
13379
+ },
13380
+ "renter_asked": {
13381
+ "$ref": "#/components/schemas/BasicUser"
13382
+ }
13383
+ },
13384
+ "type": "object"
13385
+ }
13386
+ ]
13387
+ },
13388
+ "UserPropertyDetailsExtendedForSale": {
13389
+ "allOf": [
13390
+ {
13391
+ "$ref": "#/components/schemas/UserPropertyBasicDetails"
13392
+ },
13393
+ {
13394
+ "required": [
13395
+ "status",
13396
+ "used_by",
13397
+ "cost"
13398
+ ],
13399
+ "properties": {
13400
+ "used_by": {
13401
+ "type": "array",
13402
+ "items": {
13403
+ "$ref": "#/components/schemas/BasicUser"
13404
+ }
13405
+ },
13406
+ "status": {
13407
+ "type": "string",
13408
+ "enum": [
13409
+ "for_sale"
13410
+ ]
13411
+ },
13412
+ "cost": {
13413
+ "type": "integer",
13414
+ "format": "int64"
13415
+ }
13416
+ },
13417
+ "type": "object"
12613
13418
  }
12614
- },
12615
- "type": "object"
13419
+ ]
12616
13420
  },
12617
- "ReportReport": {
13421
+ "UserPropertiesResponse": {
12618
13422
  "required": [
12619
- "report"
13423
+ "properties",
13424
+ "_metadata"
12620
13425
  ],
12621
13426
  "properties": {
12622
- "report": {
13427
+ "properties": {
13428
+ "type": "object",
12623
13429
  "oneOf": [
12624
13430
  {
12625
- "$ref": "#/components/schemas/ReportMoney"
12626
- },
12627
- {
12628
- "$ref": "#/components/schemas/ReportStats"
12629
- },
12630
- {
12631
- "$ref": "#/components/schemas/ReportMostWanted"
12632
- },
12633
- {
12634
- "$ref": "#/components/schemas/ReportHistory"
12635
- },
12636
- {
12637
- "$ref": "#/components/schemas/ReportFriendOrFoe"
12638
- },
12639
- {
12640
- "$ref": "#/components/schemas/ReportCompanyFinancials"
13431
+ "$ref": "#/components/schemas/UserPropertyBasicDetails"
12641
13432
  },
12642
13433
  {
12643
- "$ref": "#/components/schemas/ReportTrueLevel"
13434
+ "$ref": "#/components/schemas/UserPropertyDetailsExtended"
12644
13435
  },
12645
13436
  {
12646
- "$ref": "#/components/schemas/ReportStockAnalysis"
13437
+ "$ref": "#/components/schemas/UserPropertyDetailsExtendedRented"
12647
13438
  },
12648
13439
  {
12649
- "$ref": "#/components/schemas/ReportAnonymousBounties"
13440
+ "$ref": "#/components/schemas/UserPropertyDetailsExtendedForRent"
12650
13441
  },
12651
13442
  {
12652
- "$ref": "#/components/schemas/ReportInvestment"
13443
+ "$ref": "#/components/schemas/UserPropertyDetailsExtendedForSale"
12653
13444
  }
12654
13445
  ]
13446
+ },
13447
+ "_metadata": {
13448
+ "$ref": "#/components/schemas/RequestMetadataWithLinks"
12655
13449
  }
12656
13450
  },
12657
13451
  "type": "object"
12658
13452
  },
12659
- "Report": {
12660
- "allOf": [
12661
- {
12662
- "$ref": "#/components/schemas/ReportBase"
12663
- },
12664
- {
12665
- "$ref": "#/components/schemas/ReportReport"
12666
- }
12667
- ]
12668
- },
12669
- "ReportsResponse": {
13453
+ "UserPropertyResponse": {
12670
13454
  "required": [
12671
- "reports",
12672
- "_metadata"
13455
+ "property"
12673
13456
  ],
12674
13457
  "properties": {
12675
- "reports": {
12676
- "type": "array",
12677
- "items": {
12678
- "$ref": "#/components/schemas/Report"
12679
- }
12680
- },
12681
- "_metadata": {
12682
- "$ref": "#/components/schemas/RequestMetadataWithLinks"
13458
+ "property": {
13459
+ "$ref": "#/components/schemas/UserPropertyDetails"
12683
13460
  }
12684
13461
  },
12685
13462
  "type": "object"
12686
13463
  },
12687
- "SelectionCategoryEnum": {
12688
- "oneOf": [
12689
- {
12690
- "$ref": "#/components/schemas/ReportTypeEnum"
12691
- },
12692
- {
12693
- "$ref": "#/components/schemas/UserListEnum"
12694
- },
12695
- {
12696
- "$ref": "#/components/schemas/PersonalStatsCategoryEnum"
12697
- },
12698
- {
12699
- "$ref": "#/components/schemas/RacingRaceTypeEnum"
12700
- }
12701
- ]
12702
- },
12703
13464
  "UserCurrentEducation": {
12704
13465
  "required": [
12705
13466
  "id",
@@ -20977,6 +21738,159 @@
20977
21738
  }
20978
21739
  ]
20979
21740
  },
21741
+ "BasicProperty": {
21742
+ "required": [
21743
+ "id",
21744
+ "name"
21745
+ ],
21746
+ "properties": {
21747
+ "id": {
21748
+ "$ref": "#/components/schemas/PropertyTypeId"
21749
+ },
21750
+ "name": {
21751
+ "type": "string"
21752
+ }
21753
+ },
21754
+ "type": "object"
21755
+ },
21756
+ "MarketRentalDetails": {
21757
+ "required": [
21758
+ "listings",
21759
+ "property"
21760
+ ],
21761
+ "properties": {
21762
+ "listings": {
21763
+ "type": "array",
21764
+ "items": {
21765
+ "required": [
21766
+ "happy",
21767
+ "cost",
21768
+ "cost_per_day",
21769
+ "rental_period",
21770
+ "market_price",
21771
+ "upkeep",
21772
+ "modifications"
21773
+ ],
21774
+ "properties": {
21775
+ "happy": {
21776
+ "type": "integer",
21777
+ "format": "int32"
21778
+ },
21779
+ "cost": {
21780
+ "type": "integer",
21781
+ "format": "int64"
21782
+ },
21783
+ "cost_per_day": {
21784
+ "type": "integer",
21785
+ "format": "int64"
21786
+ },
21787
+ "rental_period": {
21788
+ "type": "integer",
21789
+ "format": "int32"
21790
+ },
21791
+ "market_price": {
21792
+ "type": "integer",
21793
+ "format": "int64"
21794
+ },
21795
+ "upkeep": {
21796
+ "type": "integer",
21797
+ "format": "int32"
21798
+ },
21799
+ "modifications": {
21800
+ "type": "array",
21801
+ "items": {
21802
+ "$ref": "#/components/schemas/PropertyModificationEnum"
21803
+ }
21804
+ }
21805
+ },
21806
+ "type": "object"
21807
+ }
21808
+ },
21809
+ "property": {
21810
+ "$ref": "#/components/schemas/BasicProperty"
21811
+ }
21812
+ },
21813
+ "type": "object"
21814
+ },
21815
+ "MarketRentalsResponse": {
21816
+ "required": [
21817
+ "properties",
21818
+ "_metadata"
21819
+ ],
21820
+ "properties": {
21821
+ "properties": {
21822
+ "$ref": "#/components/schemas/MarketRentalDetails"
21823
+ },
21824
+ "_metadata": {
21825
+ "$ref": "#/components/schemas/RequestMetadataWithLinks"
21826
+ }
21827
+ },
21828
+ "type": "object"
21829
+ },
21830
+ "MarketPropertyDetails": {
21831
+ "required": [
21832
+ "listings",
21833
+ "property"
21834
+ ],
21835
+ "properties": {
21836
+ "listings": {
21837
+ "type": "array",
21838
+ "items": {
21839
+ "required": [
21840
+ "happy",
21841
+ "cost",
21842
+ "market_price",
21843
+ "upkeep",
21844
+ "modifications"
21845
+ ],
21846
+ "properties": {
21847
+ "happy": {
21848
+ "type": "integer",
21849
+ "format": "int32"
21850
+ },
21851
+ "cost": {
21852
+ "type": "integer",
21853
+ "format": "int64"
21854
+ },
21855
+ "market_price": {
21856
+ "type": "integer",
21857
+ "format": "int64"
21858
+ },
21859
+ "upkeep": {
21860
+ "type": "integer",
21861
+ "format": "int32"
21862
+ },
21863
+ "modifications": {
21864
+ "type": "array",
21865
+ "items": {
21866
+ "$ref": "#/components/schemas/PropertyModificationEnum"
21867
+ }
21868
+ }
21869
+ },
21870
+ "type": "object"
21871
+ }
21872
+ },
21873
+ "property": {
21874
+ "$ref": "#/components/schemas/BasicProperty"
21875
+ }
21876
+ },
21877
+ "type": "object"
21878
+ },
21879
+ "MarketPropertiesResponse": {
21880
+ "required": [
21881
+ "properties",
21882
+ "_metadata"
21883
+ ],
21884
+ "properties": {
21885
+ "properties": {
21886
+ "$ref": "#/components/schemas/MarketPropertyDetails"
21887
+ },
21888
+ "_metadata": {
21889
+ "$ref": "#/components/schemas/RequestMetadataWithLinks"
21890
+ }
21891
+ },
21892
+ "type": "object"
21893
+ },
20980
21894
  "BazaarWeekly": {
20981
21895
  "required": [
20982
21896
  "busiest",
@@ -22067,6 +22981,58 @@
22067
22981
  },
22068
22982
  "type": "object"
22069
22983
  },
22984
+ "TornProperties": {
22985
+ "properties": {
22986
+ "properties": {
22987
+ "type": "array",
22988
+ "items": {
22989
+ "required": [
22990
+ "id",
22991
+ "name",
22992
+ "cost",
22993
+ "happy",
22994
+ "upkeep",
22995
+ "modifications",
22996
+ "staff"
22997
+ ],
22998
+ "properties": {
22999
+ "id": {
23000
+ "$ref": "#/components/schemas/PropertyTypeId"
23001
+ },
23002
+ "name": {
23003
+ "type": "string"
23004
+ },
23005
+ "cost": {
23006
+ "type": "integer",
23007
+ "format": "int32"
23008
+ },
23009
+ "happy": {
23010
+ "type": "integer",
23011
+ "format": "int32"
23012
+ },
23013
+ "upkeep": {
23014
+ "type": "integer",
23015
+ "format": "int32"
23016
+ },
23017
+ "modifications": {
23018
+ "type": "array",
23019
+ "items": {
23020
+ "$ref": "#/components/schemas/PropertyModificationEnum"
23021
+ }
23022
+ },
23023
+ "staff": {
23024
+ "type": "array",
23025
+ "items": {
23026
+ "$ref": "#/components/schemas/PropertyStaffEnum"
23027
+ }
23028
+ }
23029
+ },
23030
+ "type": "object"
23031
+ }
23032
+ }
23033
+ },
23034
+ "type": "object"
23035
+ },
22070
23036
  "TornEducationRewards": {
22071
23037
  "required": [
22072
23038
  "working_stats",
@@ -23487,7 +24453,7 @@
23487
24453
  "TornSelectionName": {
23488
24454
  "oneOf": [
23489
24455
  {
23490
- "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','properties','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'.",
24456
+ "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'.",
23491
24457
  "type": "string",
23492
24458
  "enum": [
23493
24459
  "attacklog",
@@ -23504,6 +24470,7 @@
23504
24470
  "logcategories",
23505
24471
  "logtypes",
23506
24472
  "lookup",
24473
+ "properties",
23507
24474
  "subcrimes",
23508
24475
  "territory",
23509
24476
  "timestamp",
@@ -23520,7 +24487,6 @@
23520
24487
  "organisedcrimes",
23521
24488
  "pawnshop",
23522
24489
  "pokertables",
23523
- "properties",
23524
24490
  "rockpaperscissors",
23525
24491
  "searchforcash",
23526
24492
  "shoplifting",
@@ -23902,6 +24868,10 @@
23902
24868
  "name": "Forum",
23903
24869
  "description": "Part of Forum section"
23904
24870
  },
24871
+ {
24872
+ "name": "Property",
24873
+ "description": "Part of Property section"
24874
+ },
23905
24875
  {
23906
24876
  "name": "Key",
23907
24877
  "description": "Part of Key section"