tornapi-typescript 0.2.4 → 0.2.7

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.
Files changed (3) hide show
  1. package/dist/index.d.ts +198 -184
  2. package/dist/openapi.json +1496 -396
  3. package/package.json +3 -3
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.6.1"
6
+ "version": "1.8.1"
7
7
  },
8
8
  "servers": [
9
9
  {
@@ -1188,12 +1188,7 @@
1188
1188
  "description": "Category of races returned",
1189
1189
  "required": false,
1190
1190
  "schema": {
1191
- "type": "string",
1192
- "default": "custom",
1193
- "enum": [
1194
- "official",
1195
- "custom"
1196
- ]
1191
+ "$ref": "#/components/schemas/RacingRaceTypeEnum"
1197
1192
  }
1198
1193
  },
1199
1194
  {
@@ -1226,6 +1221,69 @@
1226
1221
  "x-stability": "Stable"
1227
1222
  }
1228
1223
  },
1224
+ "/user/reports": {
1225
+ "get": {
1226
+ "tags": [
1227
+ "User"
1228
+ ],
1229
+ "summary": "Get your reports",
1230
+ "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.",
1231
+ "operationId": "6ba15a813fe1cc014564e9dba892e022",
1232
+ "parameters": [
1233
+ {
1234
+ "name": "cat",
1235
+ "in": "query",
1236
+ "description": "Used to filter reports with a specific type.",
1237
+ "required": false,
1238
+ "schema": {
1239
+ "$ref": "#/components/schemas/ReportTypeEnum"
1240
+ }
1241
+ },
1242
+ {
1243
+ "name": "target",
1244
+ "in": "query",
1245
+ "description": "Get reports for a specific player by passing their player ID.",
1246
+ "required": false,
1247
+ "schema": {
1248
+ "$ref": "#/components/schemas/UserId"
1249
+ }
1250
+ },
1251
+ {
1252
+ "$ref": "#/components/parameters/ApiLimit100Default20"
1253
+ },
1254
+ {
1255
+ "$ref": "#/components/parameters/ApiOffset"
1256
+ },
1257
+ {
1258
+ "$ref": "#/components/parameters/ApiTimestamp"
1259
+ },
1260
+ {
1261
+ "$ref": "#/components/parameters/ApiComment"
1262
+ },
1263
+ {
1264
+ "$ref": "#/components/parameters/ApiKeyLimited"
1265
+ }
1266
+ ],
1267
+ "responses": {
1268
+ "200": {
1269
+ "description": "Successful operation",
1270
+ "content": {
1271
+ "application/json": {
1272
+ "schema": {
1273
+ "$ref": "#/components/schemas/ReportsResponse"
1274
+ }
1275
+ }
1276
+ }
1277
+ }
1278
+ },
1279
+ "security": [
1280
+ {
1281
+ "api_key": []
1282
+ }
1283
+ ],
1284
+ "x-stability": "Unstable"
1285
+ }
1286
+ },
1229
1287
  "/user/revives": {
1230
1288
  "get": {
1231
1289
  "tags": [
@@ -1441,7 +1499,17 @@
1441
1499
  "description": "selection id",
1442
1500
  "required": false,
1443
1501
  "schema": {
1444
- "type": "string"
1502
+ "oneOf": [
1503
+ {
1504
+ "$ref": "#/components/schemas/UserId"
1505
+ },
1506
+ {
1507
+ "$ref": "#/components/schemas/TornCrimeId"
1508
+ },
1509
+ {
1510
+ "type": "string"
1511
+ }
1512
+ ]
1445
1513
  }
1446
1514
  },
1447
1515
  {
@@ -1459,10 +1527,23 @@
1459
1527
  {
1460
1528
  "name": "cat",
1461
1529
  "in": "query",
1462
- "description": "Selection category",
1530
+ "description": "Selection category. Can belong to one of the specified types.",
1463
1531
  "required": false,
1464
1532
  "schema": {
1465
- "type": "string"
1533
+ "oneOf": [
1534
+ {
1535
+ "$ref": "#/components/schemas/ReportTypeEnum"
1536
+ },
1537
+ {
1538
+ "$ref": "#/components/schemas/UserListEnum"
1539
+ },
1540
+ {
1541
+ "$ref": "#/components/schemas/PersonalStatsCategoryEnum"
1542
+ },
1543
+ {
1544
+ "$ref": "#/components/schemas/RacingRaceTypeEnum"
1545
+ }
1546
+ ]
1466
1547
  }
1467
1548
  },
1468
1549
  {
@@ -1470,8 +1551,13 @@
1470
1551
  "in": "query",
1471
1552
  "description": "Selection stat",
1472
1553
  "required": false,
1554
+ "style": "form",
1555
+ "explode": false,
1473
1556
  "schema": {
1474
- "type": "string"
1557
+ "type": "array",
1558
+ "items": {
1559
+ "$ref": "#/components/schemas/PersonalStatsStatName"
1560
+ }
1475
1561
  }
1476
1562
  },
1477
1563
  {
@@ -2787,6 +2873,69 @@
2787
2873
  "x-stability": "Stable"
2788
2874
  }
2789
2875
  },
2876
+ "/faction/reports": {
2877
+ "get": {
2878
+ "tags": [
2879
+ "Faction"
2880
+ ],
2881
+ "summary": "Get faction reports",
2882
+ "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.",
2883
+ "operationId": "e8bd37f10cc5e0e8d6694bb306f3a1e4",
2884
+ "parameters": [
2885
+ {
2886
+ "name": "cat",
2887
+ "in": "query",
2888
+ "description": "Used to filter reports with a specific type.",
2889
+ "required": false,
2890
+ "schema": {
2891
+ "$ref": "#/components/schemas/ReportTypeEnum"
2892
+ }
2893
+ },
2894
+ {
2895
+ "name": "target",
2896
+ "in": "query",
2897
+ "description": "Get reports for a specific player by passing their player ID.",
2898
+ "required": false,
2899
+ "schema": {
2900
+ "$ref": "#/components/schemas/UserId"
2901
+ }
2902
+ },
2903
+ {
2904
+ "$ref": "#/components/parameters/ApiLimit100Default20"
2905
+ },
2906
+ {
2907
+ "$ref": "#/components/parameters/ApiOffset"
2908
+ },
2909
+ {
2910
+ "$ref": "#/components/parameters/ApiTimestamp"
2911
+ },
2912
+ {
2913
+ "$ref": "#/components/parameters/ApiComment"
2914
+ },
2915
+ {
2916
+ "$ref": "#/components/parameters/ApiKeyLimited"
2917
+ }
2918
+ ],
2919
+ "responses": {
2920
+ "200": {
2921
+ "description": "Successful operation",
2922
+ "content": {
2923
+ "application/json": {
2924
+ "schema": {
2925
+ "$ref": "#/components/schemas/ReportsResponse"
2926
+ }
2927
+ }
2928
+ }
2929
+ }
2930
+ },
2931
+ "security": [
2932
+ {
2933
+ "api_key": []
2934
+ }
2935
+ ],
2936
+ "x-stability": "Unstable"
2937
+ }
2938
+ },
2790
2939
  "/faction/revives": {
2791
2940
  "get": {
2792
2941
  "tags": [
@@ -2895,6 +3044,57 @@
2895
3044
  "x-stability": "Stable"
2896
3045
  }
2897
3046
  },
3047
+ "/faction/search": {
3048
+ "get": {
3049
+ "tags": [
3050
+ "Faction"
3051
+ ],
3052
+ "summary": "Search factions by name or other criteria",
3053
+ "description": "Requires public access key. <br>This selection is standalone and cannot be used together with other selections.",
3054
+ "operationId": "01c192f9b41ce29372df54667bea2b43",
3055
+ "parameters": [
3056
+ {
3057
+ "$ref": "#/components/parameters/ApiName"
3058
+ },
3059
+ {
3060
+ "$ref": "#/components/parameters/ApiFactionSearchFilter"
3061
+ },
3062
+ {
3063
+ "$ref": "#/components/parameters/ApiLimit20"
3064
+ },
3065
+ {
3066
+ "$ref": "#/components/parameters/ApiOffset"
3067
+ },
3068
+ {
3069
+ "$ref": "#/components/parameters/ApiTimestamp"
3070
+ },
3071
+ {
3072
+ "$ref": "#/components/parameters/ApiComment"
3073
+ },
3074
+ {
3075
+ "$ref": "#/components/parameters/ApiKeyPublic"
3076
+ }
3077
+ ],
3078
+ "responses": {
3079
+ "200": {
3080
+ "description": "Successful operation",
3081
+ "content": {
3082
+ "application/json": {
3083
+ "schema": {
3084
+ "$ref": "#/components/schemas/FactionSearchResponse"
3085
+ }
3086
+ }
3087
+ }
3088
+ }
3089
+ },
3090
+ "security": [
3091
+ {
3092
+ "api_key": []
3093
+ }
3094
+ ],
3095
+ "x-stability": "Unstable"
3096
+ }
3097
+ },
2898
3098
  "/faction/stats": {
2899
3099
  "get": {
2900
3100
  "tags": [
@@ -3453,7 +3653,23 @@
3453
3653
  "description": "selection id",
3454
3654
  "required": false,
3455
3655
  "schema": {
3456
- "type": "string"
3656
+ "oneOf": [
3657
+ {
3658
+ "$ref": "#/components/schemas/FactionId"
3659
+ },
3660
+ {
3661
+ "$ref": "#/components/schemas/FactionCrimeId"
3662
+ },
3663
+ {
3664
+ "$ref": "#/components/schemas/ChainId"
3665
+ },
3666
+ {
3667
+ "$ref": "#/components/schemas/RankedWarId"
3668
+ },
3669
+ {
3670
+ "$ref": "#/components/schemas/TerritoryWarId"
3671
+ }
3672
+ ]
3457
3673
  }
3458
3674
  },
3459
3675
  {
@@ -3471,7 +3687,40 @@
3471
3687
  "description": "Selection category",
3472
3688
  "required": false,
3473
3689
  "schema": {
3474
- "type": "string"
3690
+ "oneOf": [
3691
+ {
3692
+ "type": "string",
3693
+ "enum": [
3694
+ "all",
3695
+ "current"
3696
+ ]
3697
+ },
3698
+ {
3699
+ "type": "string",
3700
+ "enum": [
3701
+ "all",
3702
+ "recruiting",
3703
+ "planning",
3704
+ "failure",
3705
+ "successful",
3706
+ "expired",
3707
+ "available",
3708
+ "completed"
3709
+ ]
3710
+ },
3711
+ {
3712
+ "$ref": "#/components/schemas/FactionNewsCategory"
3713
+ },
3714
+ {
3715
+ "$ref": "#/components/schemas/FactionRankedWarsCategoryEnum"
3716
+ },
3717
+ {
3718
+ "$ref": "#/components/schemas/ReportTypeEnum"
3719
+ },
3720
+ {
3721
+ "$ref": "#/components/schemas/FactionTerritoryWarsCategoryEnum"
3722
+ }
3723
+ ]
3475
3724
  }
3476
3725
  },
3477
3726
  {
@@ -3480,7 +3729,7 @@
3480
3729
  "description": "Stat category",
3481
3730
  "required": false,
3482
3731
  "schema": {
3483
- "type": "string"
3732
+ "$ref": "#/components/schemas/FactionStatEnum"
3484
3733
  }
3485
3734
  },
3486
3735
  {
@@ -3977,7 +4226,17 @@
3977
4226
  "description": "selection id",
3978
4227
  "required": false,
3979
4228
  "schema": {
3980
- "type": "string"
4229
+ "oneOf": [
4230
+ {
4231
+ "$ref": "#/components/schemas/ForumThreadId"
4232
+ },
4233
+ {
4234
+ "type": "array",
4235
+ "items": {
4236
+ "$ref": "#/components/schemas/ForumId"
4237
+ }
4238
+ }
4239
+ ]
3981
4240
  }
3982
4241
  },
3983
4242
  {
@@ -3998,15 +4257,6 @@
3998
4257
  {
3999
4258
  "$ref": "#/components/parameters/ApiOffsetNoDefault"
4000
4259
  },
4001
- {
4002
- "name": "cat",
4003
- "in": "query",
4004
- "description": "Selection category",
4005
- "required": false,
4006
- "schema": {
4007
- "type": "string"
4008
- }
4009
- },
4010
4260
  {
4011
4261
  "$ref": "#/components/parameters/ApiTimestamp"
4012
4262
  },
@@ -4372,7 +4622,7 @@
4372
4622
  "description": "selection id",
4373
4623
  "required": false,
4374
4624
  "schema": {
4375
- "type": "string"
4625
+ "$ref": "#/components/schemas/ItemId"
4376
4626
  }
4377
4627
  },
4378
4628
  {
@@ -4384,15 +4634,6 @@
4384
4634
  "$ref": "#/components/schemas/WeaponBonusEnum"
4385
4635
  }
4386
4636
  },
4387
- {
4388
- "name": "cat",
4389
- "in": "query",
4390
- "description": "Selection category",
4391
- "required": false,
4392
- "schema": {
4393
- "type": "string"
4394
- }
4395
- },
4396
4637
  {
4397
4638
  "name": "sort",
4398
4639
  "in": "query",
@@ -4554,12 +4795,7 @@
4554
4795
  "description": "Category of races returned",
4555
4796
  "required": false,
4556
4797
  "schema": {
4557
- "type": "string",
4558
- "default": "custom",
4559
- "enum": [
4560
- "official",
4561
- "custom"
4562
- ]
4798
+ "$ref": "#/components/schemas/RacingRaceTypeEnum"
4563
4799
  }
4564
4800
  },
4565
4801
  {
@@ -4843,7 +5079,14 @@
4843
5079
  "description": "selection id",
4844
5080
  "required": false,
4845
5081
  "schema": {
4846
- "type": "string"
5082
+ "oneOf": [
5083
+ {
5084
+ "$ref": "#/components/schemas/RaceId"
5085
+ },
5086
+ {
5087
+ "$ref": "#/components/schemas/RaceTrackId"
5088
+ }
5089
+ ]
4847
5090
  }
4848
5091
  },
4849
5092
  {
@@ -4864,7 +5107,14 @@
4864
5107
  "description": "Selection category",
4865
5108
  "required": false,
4866
5109
  "schema": {
4867
- "type": "string"
5110
+ "oneOf": [
5111
+ {
5112
+ "$ref": "#/components/schemas/RacingRaceTypeEnum"
5113
+ },
5114
+ {
5115
+ "$ref": "#/components/schemas/RaceClassEnum"
5116
+ }
5117
+ ]
4868
5118
  }
4869
5119
  },
4870
5120
  {
@@ -5855,7 +6105,26 @@
5855
6105
  "description": "selection id",
5856
6106
  "required": false,
5857
6107
  "schema": {
5858
- "type": "string"
6108
+ "oneOf": [
6109
+ {
6110
+ "$ref": "#/components/schemas/LogCategoryId"
6111
+ },
6112
+ {
6113
+ "$ref": "#/components/schemas/TornCrimeId"
6114
+ },
6115
+ {
6116
+ "type": "array",
6117
+ "items": {
6118
+ "$ref": "#/components/schemas/ItemId"
6119
+ }
6120
+ },
6121
+ {
6122
+ "type": "array",
6123
+ "items": {
6124
+ "$ref": "#/components/schemas/FactionTerritoryEnum"
6125
+ }
6126
+ }
6127
+ ]
5859
6128
  }
5860
6129
  },
5861
6130
  {
@@ -5879,7 +6148,17 @@
5879
6148
  "description": "Selection category",
5880
6149
  "required": false,
5881
6150
  "schema": {
5882
- "type": "string"
6151
+ "oneOf": [
6152
+ {
6153
+ "$ref": "#/components/schemas/TornFactionHofCategory"
6154
+ },
6155
+ {
6156
+ "$ref": "#/components/schemas/TornHofCategory"
6157
+ },
6158
+ {
6159
+ "$ref": "#/components/schemas/TornItemCategory"
6160
+ }
6161
+ ]
5883
6162
  }
5884
6163
  },
5885
6164
  {
@@ -5983,6 +6262,37 @@
5983
6262
  "E"
5984
6263
  ]
5985
6264
  },
6265
+ "CountryEnum": {
6266
+ "type": "string",
6267
+ "enum": [
6268
+ "Mexico",
6269
+ "Hawaii",
6270
+ "South Africa",
6271
+ "Japan",
6272
+ "China",
6273
+ "Argentina",
6274
+ "Switzerland",
6275
+ "Canada",
6276
+ "United Kingdom",
6277
+ "UAE",
6278
+ "Cayman Islands"
6279
+ ]
6280
+ },
6281
+ "ReportTypeEnum": {
6282
+ "type": "string",
6283
+ "enum": [
6284
+ "mostwanted",
6285
+ "money",
6286
+ "stats",
6287
+ "references",
6288
+ "friendorfoe",
6289
+ "companyfinancials",
6290
+ "truelevel",
6291
+ "stockanalysis",
6292
+ "anonymousbounties",
6293
+ "investment"
6294
+ ]
6295
+ },
5986
6296
  "ApiKeyAccessTypeEnum": {
5987
6297
  "type": "string",
5988
6298
  "enum": [
@@ -10162,6 +10472,13 @@
10162
10472
  "peace"
10163
10473
  ]
10164
10474
  },
10475
+ "RacingRaceTypeEnum": {
10476
+ "type": "string",
10477
+ "enum": [
10478
+ "official",
10479
+ "custom"
10480
+ ]
10481
+ },
10165
10482
  "FactionPositionAbilityEnum": {
10166
10483
  "type": "string",
10167
10484
  "enum": [
@@ -10760,6 +11077,23 @@
10760
11077
  7
10761
11078
  ]
10762
11079
  },
11080
+ "Parameters": {
11081
+ "oneOf": [
11082
+ {
11083
+ "type": "string",
11084
+ "enum": [
11085
+ "destroyed",
11086
+ "notDestroyed",
11087
+ "recruiting",
11088
+ "notRecruiting"
11089
+ ]
11090
+ },
11091
+ {
11092
+ "type": "string",
11093
+ "pattern": "^(id|respect|members)(Equal|NotEqual|Less|LessOrEqual|GreaterOrEqual|Greater)\\d+$"
11094
+ }
11095
+ ]
11096
+ },
10763
11097
  "ReviveSetting": {
10764
11098
  "type": "string",
10765
11099
  "enum": [
@@ -11450,213 +11784,774 @@
11450
11784
  },
11451
11785
  "type": "object"
11452
11786
  },
11453
- "UserCurrentEducation": {
11787
+ "ReportBase": {
11454
11788
  "required": [
11455
- "id",
11456
- "until"
11789
+ "type",
11790
+ "target_id",
11791
+ "reporter_id",
11792
+ "faction_id",
11793
+ "timestamp"
11457
11794
  ],
11458
11795
  "properties": {
11459
- "id": {
11460
- "$ref": "#/components/schemas/EducationId"
11796
+ "type": {
11797
+ "$ref": "#/components/schemas/ReportTypeEnum"
11461
11798
  },
11462
- "until": {
11799
+ "target_id": {
11800
+ "description": "The target ID if applicable.",
11801
+ "oneOf": [
11802
+ {
11803
+ "$ref": "#/components/schemas/UserId"
11804
+ },
11805
+ {
11806
+ "type": "null"
11807
+ }
11808
+ ]
11809
+ },
11810
+ "reporter_id": {
11811
+ "$ref": "#/components/schemas/UserId"
11812
+ },
11813
+ "faction_id": {
11814
+ "description": "Reporter's faction ID if applicable.",
11815
+ "oneOf": [
11816
+ {
11817
+ "$ref": "#/components/schemas/FactionId"
11818
+ },
11819
+ {
11820
+ "type": "null"
11821
+ }
11822
+ ]
11823
+ },
11824
+ "timestamp": {
11463
11825
  "type": "integer",
11464
11826
  "format": "int32"
11465
11827
  }
11466
11828
  },
11467
11829
  "type": "object"
11468
11830
  },
11469
- "UserEducation": {
11831
+ "ReportWarrantDetails": {
11470
11832
  "required": [
11471
- "complete",
11472
- "current"
11833
+ "id",
11834
+ "name",
11835
+ "warrant"
11473
11836
  ],
11474
11837
  "properties": {
11475
- "complete": {
11476
- "type": "array",
11477
- "items": {
11478
- "$ref": "#/components/schemas/EducationId"
11479
- }
11838
+ "id": {
11839
+ "$ref": "#/components/schemas/UserId"
11480
11840
  },
11481
- "current": {
11482
- "oneOf": [
11483
- {
11484
- "$ref": "#/components/schemas/UserCurrentEducation"
11485
- },
11486
- {
11487
- "type": "null"
11488
- }
11489
- ]
11841
+ "name": {
11842
+ "type": "string"
11843
+ },
11844
+ "warrant": {
11845
+ "type": "integer",
11846
+ "format": "int32"
11490
11847
  }
11491
11848
  },
11492
11849
  "type": "object"
11493
11850
  },
11494
- "UserEducationResponse": {
11851
+ "ReportMostWanted": {
11495
11852
  "required": [
11496
- "education"
11853
+ "top",
11854
+ "notable"
11497
11855
  ],
11498
11856
  "properties": {
11499
- "education": {
11500
- "$ref": "#/components/schemas/UserEducation"
11857
+ "top": {
11858
+ "type": "array",
11859
+ "items": {
11860
+ "$ref": "#/components/schemas/ReportWarrantDetails"
11861
+ }
11862
+ },
11863
+ "notable": {
11864
+ "type": "array",
11865
+ "items": {
11866
+ "$ref": "#/components/schemas/ReportWarrantDetails"
11867
+ }
11501
11868
  }
11502
11869
  },
11503
11870
  "type": "object"
11504
11871
  },
11505
- "UserCrimeDetailsBootlegging": {
11872
+ "ReportMoney": {
11506
11873
  "required": [
11507
- "online_store",
11508
- "dvd_sales",
11509
- "dvd_copies"
11874
+ "money"
11510
11875
  ],
11511
11876
  "properties": {
11512
- "online_store": {
11513
- "description": "Online store statistics.",
11514
- "required": [
11515
- "earnings",
11516
- "visits",
11517
- "customers",
11518
- "sales"
11519
- ],
11520
- "properties": {
11521
- "earnings": {
11522
- "type": "integer",
11523
- "format": "int32"
11524
- },
11525
- "visits": {
11526
- "type": "integer",
11527
- "format": "int32"
11528
- },
11529
- "customers": {
11530
- "type": "integer",
11531
- "format": "int32"
11532
- },
11533
- "sales": {
11534
- "type": "integer",
11535
- "format": "int32"
11536
- }
11537
- },
11538
- "type": "object"
11539
- },
11540
- "dvd_sales": {
11541
- "description": "DVD sales statistics.",
11542
- "required": [
11543
- "action",
11544
- "comedy",
11545
- "drama",
11546
- "fantasy",
11547
- "horror",
11548
- "romance",
11549
- "thriller",
11550
- "sci_fi",
11551
- "total",
11552
- "earnings"
11553
- ],
11554
- "properties": {
11555
- "action": {
11556
- "type": "integer",
11557
- "format": "int32"
11558
- },
11559
- "comedy": {
11560
- "type": "integer",
11561
- "format": "int32"
11562
- },
11563
- "drama": {
11564
- "type": "integer",
11565
- "format": "int32"
11566
- },
11567
- "fantasy": {
11568
- "type": "integer",
11569
- "format": "int32"
11570
- },
11571
- "horror": {
11572
- "type": "integer",
11573
- "format": "int32"
11574
- },
11575
- "romance": {
11576
- "type": "integer",
11577
- "format": "int32"
11578
- },
11579
- "thriller": {
11580
- "type": "integer",
11581
- "format": "int32"
11582
- },
11583
- "sci-fi": {
11584
- "description": "This is replaced with 'sci_fi' field and will be removed on 1st June 2025.",
11585
- "type": "integer",
11586
- "format": "int32",
11587
- "deprecated": true
11588
- },
11589
- "sci_fi": {
11590
- "type": "integer",
11591
- "format": "int32"
11592
- },
11593
- "total": {
11594
- "type": "integer",
11595
- "format": "int32"
11596
- },
11597
- "earnings": {
11598
- "type": "integer",
11599
- "format": "int32"
11600
- }
11601
- },
11602
- "type": "object"
11603
- },
11604
- "dvds_copied": {
11877
+ "money": {
11605
11878
  "type": "integer",
11606
11879
  "format": "int32"
11607
11880
  }
11608
11881
  },
11609
11882
  "type": "object"
11610
11883
  },
11611
- "UserCrimeDetailsGraffiti": {
11884
+ "ReportInvestment": {
11612
11885
  "required": [
11613
- "cans_used",
11614
- "most_graffiti_in_one_area",
11615
- "most_graffiti_simultaneously",
11616
- "graffiti_removed",
11617
- "cost_to_city"
11886
+ "amount",
11887
+ "until"
11618
11888
  ],
11619
11889
  "properties": {
11620
- "cans_used": {
11621
- "type": "integer",
11622
- "format": "int32"
11623
- },
11624
- "most_graffiti_in_one_area": {
11625
- "type": "integer",
11626
- "format": "int32"
11627
- },
11628
- "most_graffiti_simultaneously": {
11629
- "type": "integer",
11630
- "format": "int32"
11631
- },
11632
- "graffiti_removed": {
11890
+ "amount": {
11633
11891
  "type": "integer",
11634
- "format": "int32"
11892
+ "format": "int64"
11635
11893
  },
11636
- "cost_to_city": {
11894
+ "until": {
11637
11895
  "type": "integer",
11638
11896
  "format": "int32"
11639
11897
  }
11640
11898
  },
11641
11899
  "type": "object"
11642
11900
  },
11643
- "UserCrimeDetailsShoplifting": {
11901
+ "ReportTrueLevel": {
11644
11902
  "required": [
11645
- "average_notoriety"
11903
+ "level"
11646
11904
  ],
11647
11905
  "properties": {
11648
- "average_notoriety": {
11906
+ "level": {
11649
11907
  "type": "integer",
11650
11908
  "format": "int32"
11651
11909
  }
11652
11910
  },
11653
11911
  "type": "object"
11654
11912
  },
11655
- "UserCrimeDetailsCardSkimming": {
11913
+ "ReportStats": {
11656
11914
  "required": [
11657
- "card_details",
11658
- "skimmers"
11659
- ],
11915
+ "strength",
11916
+ "speed",
11917
+ "dexterity",
11918
+ "defense",
11919
+ "total"
11920
+ ],
11921
+ "properties": {
11922
+ "strength": {
11923
+ "oneOf": [
11924
+ {
11925
+ "type": "integer",
11926
+ "format": "int64"
11927
+ },
11928
+ {
11929
+ "type": "null"
11930
+ }
11931
+ ]
11932
+ },
11933
+ "speed": {
11934
+ "oneOf": [
11935
+ {
11936
+ "type": "integer",
11937
+ "format": "int64"
11938
+ },
11939
+ {
11940
+ "type": "null"
11941
+ }
11942
+ ]
11943
+ },
11944
+ "dexterity": {
11945
+ "oneOf": [
11946
+ {
11947
+ "type": "integer",
11948
+ "format": "int64"
11949
+ },
11950
+ {
11951
+ "type": "null"
11952
+ }
11953
+ ]
11954
+ },
11955
+ "defense": {
11956
+ "oneOf": [
11957
+ {
11958
+ "type": "integer",
11959
+ "format": "int64"
11960
+ },
11961
+ {
11962
+ "type": "null"
11963
+ }
11964
+ ]
11965
+ },
11966
+ "total": {
11967
+ "oneOf": [
11968
+ {
11969
+ "type": "integer",
11970
+ "format": "int64"
11971
+ },
11972
+ {
11973
+ "type": "null"
11974
+ }
11975
+ ]
11976
+ }
11977
+ },
11978
+ "type": "object"
11979
+ },
11980
+ "ReportHistoryFaction": {
11981
+ "required": [
11982
+ "id",
11983
+ "name",
11984
+ "joined",
11985
+ "left"
11986
+ ],
11987
+ "properties": {
11988
+ "id": {
11989
+ "$ref": "#/components/schemas/FactionId"
11990
+ },
11991
+ "name": {
11992
+ "type": "string"
11993
+ },
11994
+ "joined": {
11995
+ "type": "string",
11996
+ "format": "date"
11997
+ },
11998
+ "left": {
11999
+ "oneOf": [
12000
+ {
12001
+ "type": "string",
12002
+ "format": "date"
12003
+ },
12004
+ {
12005
+ "type": "null"
12006
+ }
12007
+ ]
12008
+ }
12009
+ },
12010
+ "type": "object"
12011
+ },
12012
+ "ReportHistoryCompany": {
12013
+ "required": [
12014
+ "id",
12015
+ "name",
12016
+ "joined",
12017
+ "left"
12018
+ ],
12019
+ "properties": {
12020
+ "id": {
12021
+ "$ref": "#/components/schemas/CompanyId"
12022
+ },
12023
+ "name": {
12024
+ "type": "string"
12025
+ },
12026
+ "joined": {
12027
+ "type": "string",
12028
+ "format": "date"
12029
+ },
12030
+ "left": {
12031
+ "oneOf": [
12032
+ {
12033
+ "type": "string",
12034
+ "format": "date"
12035
+ },
12036
+ {
12037
+ "type": "null"
12038
+ }
12039
+ ]
12040
+ }
12041
+ },
12042
+ "type": "object"
12043
+ },
12044
+ "ReportHistory": {
12045
+ "required": [
12046
+ "factions",
12047
+ "companies"
12048
+ ],
12049
+ "properties": {
12050
+ "factions": {
12051
+ "type": "array",
12052
+ "items": {
12053
+ "$ref": "#/components/schemas/ReportHistoryFaction"
12054
+ }
12055
+ },
12056
+ "companies": {
12057
+ "type": "array",
12058
+ "items": {
12059
+ "$ref": "#/components/schemas/ReportHistoryCompany"
12060
+ }
12061
+ }
12062
+ },
12063
+ "type": "object"
12064
+ },
12065
+ "ReportFriendOrFoeUser": {
12066
+ "required": [
12067
+ "id",
12068
+ "name"
12069
+ ],
12070
+ "properties": {
12071
+ "id": {
12072
+ "$ref": "#/components/schemas/UserId"
12073
+ },
12074
+ "name": {
12075
+ "type": "string"
12076
+ }
12077
+ },
12078
+ "type": "object"
12079
+ },
12080
+ "ReportFriendOrFoe": {
12081
+ "required": [
12082
+ "friends",
12083
+ "enemies"
12084
+ ],
12085
+ "properties": {
12086
+ "friends": {
12087
+ "type": "array",
12088
+ "items": {
12089
+ "$ref": "#/components/schemas/ReportFriendOrFoeUser"
12090
+ }
12091
+ },
12092
+ "enemies": {
12093
+ "type": "array",
12094
+ "items": {
12095
+ "$ref": "#/components/schemas/ReportFriendOrFoeUser"
12096
+ }
12097
+ }
12098
+ },
12099
+ "type": "object"
12100
+ },
12101
+ "ReportCompanyFinancials": {
12102
+ "required": [
12103
+ "balance",
12104
+ "employees",
12105
+ "wages"
12106
+ ],
12107
+ "properties": {
12108
+ "balance": {
12109
+ "type": "integer",
12110
+ "format": "int64"
12111
+ },
12112
+ "employees": {
12113
+ "type": "integer",
12114
+ "format": "int32"
12115
+ },
12116
+ "wages": {
12117
+ "required": [
12118
+ "highest",
12119
+ "lowest",
12120
+ "average"
12121
+ ],
12122
+ "properties": {
12123
+ "highest": {
12124
+ "type": "integer",
12125
+ "format": "int32"
12126
+ },
12127
+ "lowest": {
12128
+ "type": "integer",
12129
+ "format": "int32"
12130
+ },
12131
+ "average": {
12132
+ "type": "integer",
12133
+ "format": "int32"
12134
+ }
12135
+ },
12136
+ "type": "object"
12137
+ }
12138
+ },
12139
+ "type": "object"
12140
+ },
12141
+ "ReportStockAnalysis": {
12142
+ "required": [
12143
+ "items"
12144
+ ],
12145
+ "properties": {
12146
+ "items": {
12147
+ "type": "array",
12148
+ "items": {
12149
+ "required": [
12150
+ "country",
12151
+ "item",
12152
+ "trip_duration",
12153
+ "hourly_profit"
12154
+ ],
12155
+ "properties": {
12156
+ "country": {
12157
+ "$ref": "#/components/schemas/CountryEnum"
12158
+ },
12159
+ "item": {
12160
+ "required": [
12161
+ "id",
12162
+ "name",
12163
+ "stock",
12164
+ "price",
12165
+ "value",
12166
+ "due"
12167
+ ],
12168
+ "properties": {
12169
+ "id": {
12170
+ "$ref": "#/components/schemas/ItemId"
12171
+ },
12172
+ "name": {
12173
+ "type": "string"
12174
+ },
12175
+ "price": {
12176
+ "type": "integer",
12177
+ "format": "int32"
12178
+ },
12179
+ "value": {
12180
+ "type": "integer",
12181
+ "format": "int32"
12182
+ },
12183
+ "due": {
12184
+ "oneOf": [
12185
+ {
12186
+ "type": "integer",
12187
+ "format": "int32"
12188
+ },
12189
+ {
12190
+ "type": "null"
12191
+ }
12192
+ ]
12193
+ }
12194
+ },
12195
+ "type": "object"
12196
+ },
12197
+ "trip_duration": {
12198
+ "type": "integer",
12199
+ "format": "int32"
12200
+ },
12201
+ "hourly_profit": {
12202
+ "type": "integer",
12203
+ "format": "int32"
12204
+ }
12205
+ },
12206
+ "type": "object"
12207
+ }
12208
+ }
12209
+ },
12210
+ "type": "object"
12211
+ },
12212
+ "ReportAnonymousBounties": {
12213
+ "required": [
12214
+ "bounties"
12215
+ ],
12216
+ "properties": {
12217
+ "bounties": {
12218
+ "type": "array",
12219
+ "items": {
12220
+ "required": [
12221
+ "bounty",
12222
+ "user",
12223
+ "text"
12224
+ ],
12225
+ "properties": {
12226
+ "text": {
12227
+ "type": "string"
12228
+ },
12229
+ "bounty": {
12230
+ "type": "integer",
12231
+ "format": "int64"
12232
+ },
12233
+ "user": {
12234
+ "oneOf": [
12235
+ {
12236
+ "required": [
12237
+ "id",
12238
+ "name"
12239
+ ],
12240
+ "properties": {
12241
+ "id": {
12242
+ "$ref": "#/components/schemas/UserId"
12243
+ },
12244
+ "name": {
12245
+ "type": "string"
12246
+ }
12247
+ },
12248
+ "type": "object"
12249
+ },
12250
+ {
12251
+ "type": "null"
12252
+ }
12253
+ ]
12254
+ }
12255
+ },
12256
+ "type": "object"
12257
+ }
12258
+ }
12259
+ },
12260
+ "type": "object"
12261
+ },
12262
+ "ReportReport": {
12263
+ "required": [
12264
+ "report"
12265
+ ],
12266
+ "properties": {
12267
+ "report": {
12268
+ "oneOf": [
12269
+ {
12270
+ "$ref": "#/components/schemas/ReportMoney"
12271
+ },
12272
+ {
12273
+ "$ref": "#/components/schemas/ReportStats"
12274
+ },
12275
+ {
12276
+ "$ref": "#/components/schemas/ReportMostWanted"
12277
+ },
12278
+ {
12279
+ "$ref": "#/components/schemas/ReportHistory"
12280
+ },
12281
+ {
12282
+ "$ref": "#/components/schemas/ReportFriendOrFoe"
12283
+ },
12284
+ {
12285
+ "$ref": "#/components/schemas/ReportCompanyFinancials"
12286
+ },
12287
+ {
12288
+ "$ref": "#/components/schemas/ReportTrueLevel"
12289
+ },
12290
+ {
12291
+ "$ref": "#/components/schemas/ReportStockAnalysis"
12292
+ },
12293
+ {
12294
+ "$ref": "#/components/schemas/ReportAnonymousBounties"
12295
+ },
12296
+ {
12297
+ "$ref": "#/components/schemas/ReportInvestment"
12298
+ }
12299
+ ]
12300
+ }
12301
+ },
12302
+ "type": "object"
12303
+ },
12304
+ "Report": {
12305
+ "allOf": [
12306
+ {
12307
+ "$ref": "#/components/schemas/ReportBase"
12308
+ },
12309
+ {
12310
+ "$ref": "#/components/schemas/ReportReport"
12311
+ }
12312
+ ]
12313
+ },
12314
+ "ReportsResponse": {
12315
+ "required": [
12316
+ "reports",
12317
+ "_metadata"
12318
+ ],
12319
+ "properties": {
12320
+ "reports": {
12321
+ "type": "array",
12322
+ "items": {
12323
+ "$ref": "#/components/schemas/Report"
12324
+ }
12325
+ },
12326
+ "_metadata": {
12327
+ "$ref": "#/components/schemas/RequestMetadataWithLinks"
12328
+ }
12329
+ },
12330
+ "type": "object"
12331
+ },
12332
+ "SelectionCategoryEnum": {
12333
+ "oneOf": [
12334
+ {
12335
+ "$ref": "#/components/schemas/ReportTypeEnum"
12336
+ },
12337
+ {
12338
+ "$ref": "#/components/schemas/UserListEnum"
12339
+ },
12340
+ {
12341
+ "$ref": "#/components/schemas/PersonalStatsCategoryEnum"
12342
+ },
12343
+ {
12344
+ "$ref": "#/components/schemas/RacingRaceTypeEnum"
12345
+ }
12346
+ ]
12347
+ },
12348
+ "UserCurrentEducation": {
12349
+ "required": [
12350
+ "id",
12351
+ "until"
12352
+ ],
12353
+ "properties": {
12354
+ "id": {
12355
+ "$ref": "#/components/schemas/EducationId"
12356
+ },
12357
+ "until": {
12358
+ "type": "integer",
12359
+ "format": "int32"
12360
+ }
12361
+ },
12362
+ "type": "object"
12363
+ },
12364
+ "UserEducation": {
12365
+ "required": [
12366
+ "complete",
12367
+ "current"
12368
+ ],
12369
+ "properties": {
12370
+ "complete": {
12371
+ "type": "array",
12372
+ "items": {
12373
+ "$ref": "#/components/schemas/EducationId"
12374
+ }
12375
+ },
12376
+ "current": {
12377
+ "oneOf": [
12378
+ {
12379
+ "$ref": "#/components/schemas/UserCurrentEducation"
12380
+ },
12381
+ {
12382
+ "type": "null"
12383
+ }
12384
+ ]
12385
+ }
12386
+ },
12387
+ "type": "object"
12388
+ },
12389
+ "UserEducationResponse": {
12390
+ "required": [
12391
+ "education"
12392
+ ],
12393
+ "properties": {
12394
+ "education": {
12395
+ "$ref": "#/components/schemas/UserEducation"
12396
+ }
12397
+ },
12398
+ "type": "object"
12399
+ },
12400
+ "UserCrimeDetailsBootlegging": {
12401
+ "required": [
12402
+ "online_store",
12403
+ "dvd_sales",
12404
+ "dvd_copies"
12405
+ ],
12406
+ "properties": {
12407
+ "online_store": {
12408
+ "description": "Online store statistics.",
12409
+ "required": [
12410
+ "earnings",
12411
+ "visits",
12412
+ "customers",
12413
+ "sales"
12414
+ ],
12415
+ "properties": {
12416
+ "earnings": {
12417
+ "type": "integer",
12418
+ "format": "int32"
12419
+ },
12420
+ "visits": {
12421
+ "type": "integer",
12422
+ "format": "int32"
12423
+ },
12424
+ "customers": {
12425
+ "type": "integer",
12426
+ "format": "int32"
12427
+ },
12428
+ "sales": {
12429
+ "type": "integer",
12430
+ "format": "int32"
12431
+ }
12432
+ },
12433
+ "type": "object"
12434
+ },
12435
+ "dvd_sales": {
12436
+ "description": "DVD sales statistics.",
12437
+ "required": [
12438
+ "action",
12439
+ "comedy",
12440
+ "drama",
12441
+ "fantasy",
12442
+ "horror",
12443
+ "romance",
12444
+ "thriller",
12445
+ "sci_fi",
12446
+ "total",
12447
+ "earnings"
12448
+ ],
12449
+ "properties": {
12450
+ "action": {
12451
+ "type": "integer",
12452
+ "format": "int32"
12453
+ },
12454
+ "comedy": {
12455
+ "type": "integer",
12456
+ "format": "int32"
12457
+ },
12458
+ "drama": {
12459
+ "type": "integer",
12460
+ "format": "int32"
12461
+ },
12462
+ "fantasy": {
12463
+ "type": "integer",
12464
+ "format": "int32"
12465
+ },
12466
+ "horror": {
12467
+ "type": "integer",
12468
+ "format": "int32"
12469
+ },
12470
+ "romance": {
12471
+ "type": "integer",
12472
+ "format": "int32"
12473
+ },
12474
+ "thriller": {
12475
+ "type": "integer",
12476
+ "format": "int32"
12477
+ },
12478
+ "sci-fi": {
12479
+ "description": "This is replaced with 'sci_fi' field and will be removed on 1st June 2025.",
12480
+ "type": "integer",
12481
+ "format": "int32",
12482
+ "deprecated": true
12483
+ },
12484
+ "sci_fi": {
12485
+ "type": "integer",
12486
+ "format": "int32"
12487
+ },
12488
+ "total": {
12489
+ "type": "integer",
12490
+ "format": "int32"
12491
+ },
12492
+ "earnings": {
12493
+ "type": "integer",
12494
+ "format": "int32"
12495
+ }
12496
+ },
12497
+ "type": "object"
12498
+ },
12499
+ "dvds_copied": {
12500
+ "type": "integer",
12501
+ "format": "int32"
12502
+ }
12503
+ },
12504
+ "type": "object"
12505
+ },
12506
+ "UserCrimeDetailsGraffiti": {
12507
+ "required": [
12508
+ "cans_used",
12509
+ "most_graffiti_in_one_area",
12510
+ "most_graffiti_simultaneously",
12511
+ "graffiti_removed",
12512
+ "cost_to_city"
12513
+ ],
12514
+ "properties": {
12515
+ "cans_used": {
12516
+ "type": "integer",
12517
+ "format": "int32"
12518
+ },
12519
+ "most_graffiti_in_one_area": {
12520
+ "type": "integer",
12521
+ "format": "int32"
12522
+ },
12523
+ "most_graffiti_simultaneously": {
12524
+ "type": "integer",
12525
+ "format": "int32"
12526
+ },
12527
+ "graffiti_removed": {
12528
+ "type": "integer",
12529
+ "format": "int32"
12530
+ },
12531
+ "cost_to_city": {
12532
+ "type": "integer",
12533
+ "format": "int32"
12534
+ }
12535
+ },
12536
+ "type": "object"
12537
+ },
12538
+ "UserCrimeDetailsShoplifting": {
12539
+ "required": [
12540
+ "average_notoriety"
12541
+ ],
12542
+ "properties": {
12543
+ "average_notoriety": {
12544
+ "type": "integer",
12545
+ "format": "int32"
12546
+ }
12547
+ },
12548
+ "type": "object"
12549
+ },
12550
+ "UserCrimeDetailsCardSkimming": {
12551
+ "required": [
12552
+ "card_details",
12553
+ "skimmers"
12554
+ ],
11660
12555
  "properties": {
11661
12556
  "card_details": {
11662
12557
  "required": [
@@ -12412,7 +13307,7 @@
12412
13307
  ],
12413
13308
  "properties": {
12414
13309
  "value": {
12415
- "type": "integer",
13310
+ "type": "number",
12416
13311
  "format": "float"
12417
13312
  },
12418
13313
  "rank": {
@@ -12434,7 +13329,7 @@
12434
13329
  "rank": {
12435
13330
  "oneOf": [
12436
13331
  {
12437
- "type": "number",
13332
+ "type": "integer",
12438
13333
  "format": "int32"
12439
13334
  },
12440
13335
  {
@@ -12841,73 +13736,80 @@
12841
13736
  "_metadata": {
12842
13737
  "$ref": "#/components/schemas/RequestMetadataWithLinks"
12843
13738
  }
12844
- },
12845
- "type": "object"
12846
- },
12847
- "UserSelectionName": {
12848
- "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','properties','refills','reports','skills','stocks','travel','weaponexp','workstats'.",
12849
- "type": "string",
12850
- "enum": [
12851
- "attacks",
12852
- "attacksfull",
12853
- "bounties",
12854
- "calendar",
12855
- "crimes",
12856
- "enlistedcars",
12857
- "factionbalance",
12858
- "forumfeed",
12859
- "forumfriends",
12860
- "forumposts",
12861
- "forumsubscribedthreads",
12862
- "forumthreads",
12863
- "hof",
12864
- "itemmarket",
12865
- "jobranks",
12866
- "list",
12867
- "lookup",
12868
- "organizedcrime",
12869
- "personalstats",
12870
- "races",
12871
- "revives",
12872
- "revivesfull",
12873
- "timestamp",
12874
- "ammo",
12875
- "bars",
12876
- "basic",
12877
- "battlestats",
12878
- "bazaar",
12879
- "cooldowns",
12880
- "criminalrecord",
12881
- "discord",
12882
- "display",
12883
- "education",
12884
- "equipment",
12885
- "events",
12886
- "gym",
12887
- "honors",
12888
- "icons",
12889
- "inventory",
12890
- "jobpoints",
12891
- "log",
12892
- "medals",
12893
- "merits",
12894
- "messages",
12895
- "missions",
12896
- "money",
12897
- "networth",
12898
- "newevents",
12899
- "newmessages",
12900
- "notifications",
12901
- "perks",
12902
- "profile",
12903
- "properties",
12904
- "refills",
12905
- "reports",
12906
- "skills",
12907
- "stocks",
12908
- "travel",
12909
- "weaponexp",
12910
- "workstats"
13739
+ },
13740
+ "type": "object"
13741
+ },
13742
+ "UserSelectionName": {
13743
+ "oneOf": [
13744
+ {
13745
+ "description": "The following selections will fallback to API v1 and may change at any time: 'ammo','bars','basic','battlestats','bazaar','cooldowns','criminalrecord','discord','display','education','equipment','events','gym','honors','icons','inventory','jobpoints','log','medals','merits','messages','missions','money','networth','newevents','newmessages','notifications','perks','profile','properties','refills','reports','skills','stocks','travel','weaponexp','workstats'.",
13746
+ "type": "string",
13747
+ "enum": [
13748
+ "attacks",
13749
+ "attacksfull",
13750
+ "bounties",
13751
+ "calendar",
13752
+ "crimes",
13753
+ "enlistedcars",
13754
+ "factionbalance",
13755
+ "forumfeed",
13756
+ "forumfriends",
13757
+ "forumposts",
13758
+ "forumsubscribedthreads",
13759
+ "forumthreads",
13760
+ "hof",
13761
+ "itemmarket",
13762
+ "jobranks",
13763
+ "list",
13764
+ "lookup",
13765
+ "organizedcrime",
13766
+ "personalstats",
13767
+ "races",
13768
+ "revives",
13769
+ "revivesfull",
13770
+ "timestamp",
13771
+ "ammo",
13772
+ "bars",
13773
+ "basic",
13774
+ "battlestats",
13775
+ "bazaar",
13776
+ "cooldowns",
13777
+ "criminalrecord",
13778
+ "discord",
13779
+ "display",
13780
+ "education",
13781
+ "equipment",
13782
+ "events",
13783
+ "gym",
13784
+ "honors",
13785
+ "icons",
13786
+ "inventory",
13787
+ "jobpoints",
13788
+ "log",
13789
+ "medals",
13790
+ "merits",
13791
+ "messages",
13792
+ "missions",
13793
+ "money",
13794
+ "networth",
13795
+ "newevents",
13796
+ "newmessages",
13797
+ "notifications",
13798
+ "perks",
13799
+ "profile",
13800
+ "properties",
13801
+ "refills",
13802
+ "reports",
13803
+ "skills",
13804
+ "stocks",
13805
+ "travel",
13806
+ "weaponexp",
13807
+ "workstats"
13808
+ ]
13809
+ },
13810
+ {
13811
+ "type": "string"
13812
+ }
12911
13813
  ]
12912
13814
  },
12913
13815
  "UserLookupResponse": {
@@ -15987,6 +16889,120 @@
15987
16889
  },
15988
16890
  "type": "object"
15989
16891
  },
16892
+ "FactionSearchLeader": {
16893
+ "required": [
16894
+ "id",
16895
+ "name"
16896
+ ],
16897
+ "properties": {
16898
+ "id": {
16899
+ "$ref": "#/components/schemas/UserId"
16900
+ },
16901
+ "name": {
16902
+ "type": "string"
16903
+ }
16904
+ },
16905
+ "type": "object"
16906
+ },
16907
+ "FactionSearch": {
16908
+ "required": [
16909
+ "id",
16910
+ "name",
16911
+ "respect",
16912
+ "members",
16913
+ "leader",
16914
+ "co_leader",
16915
+ "image",
16916
+ "tag_image",
16917
+ "tag",
16918
+ "is_destroyed",
16919
+ "is_recruiting"
16920
+ ],
16921
+ "properties": {
16922
+ "id": {
16923
+ "$ref": "#/components/schemas/FactionId"
16924
+ },
16925
+ "name": {
16926
+ "type": "string"
16927
+ },
16928
+ "respect": {
16929
+ "type": "integer",
16930
+ "format": "int32"
16931
+ },
16932
+ "members": {
16933
+ "type": "integer",
16934
+ "format": "int32"
16935
+ },
16936
+ "leader": {
16937
+ "$ref": "#/components/schemas/FactionSearchLeader"
16938
+ },
16939
+ "co_leader": {
16940
+ "oneOf": [
16941
+ {
16942
+ "$ref": "#/components/schemas/FactionSearchLeader"
16943
+ },
16944
+ {
16945
+ "type": "null"
16946
+ }
16947
+ ]
16948
+ },
16949
+ "image": {
16950
+ "oneOf": [
16951
+ {
16952
+ "type": "string"
16953
+ },
16954
+ {
16955
+ "type": "null"
16956
+ }
16957
+ ]
16958
+ },
16959
+ "tag_image": {
16960
+ "oneOf": [
16961
+ {
16962
+ "type": "string"
16963
+ },
16964
+ {
16965
+ "type": "null"
16966
+ }
16967
+ ]
16968
+ },
16969
+ "tag": {
16970
+ "oneOf": [
16971
+ {
16972
+ "type": "string"
16973
+ },
16974
+ {
16975
+ "type": "null"
16976
+ }
16977
+ ]
16978
+ },
16979
+ "is_destroyed": {
16980
+ "type": "boolean"
16981
+ },
16982
+ "is_recruiting": {
16983
+ "type": "boolean"
16984
+ }
16985
+ },
16986
+ "type": "object"
16987
+ },
16988
+ "FactionSearchResponse": {
16989
+ "required": [
16990
+ "search",
16991
+ "_metadata"
16992
+ ],
16993
+ "properties": {
16994
+ "search": {
16995
+ "type": "array",
16996
+ "items": {
16997
+ "$ref": "#/components/schemas/FactionSearch"
16998
+ }
16999
+ },
17000
+ "_metadata": {
17001
+ "$ref": "#/components/schemas/RequestMetadataWithLinks"
17002
+ }
17003
+ },
17004
+ "type": "object"
17005
+ },
15990
17006
  "FactionTerritoryWarFinished": {
15991
17007
  "required": [
15992
17008
  "id",
@@ -18212,57 +19228,56 @@
18212
19228
  "type": "object"
18213
19229
  },
18214
19230
  "FactionSelectionName": {
18215
- "description": "The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'crimeexp', 'drugs', 'medical', 'positions', 'reports', 'temporary', 'weapons'.\n * The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews'.",
18216
- "type": "string",
18217
- "enum": [
18218
- "applications",
18219
- "attacks",
18220
- "attacksfull",
18221
- "balance",
18222
- "basic",
18223
- "chain",
18224
- "chainreport",
18225
- "chains",
18226
- "contributors",
18227
- "crime",
18228
- "crimes",
18229
- "hof",
18230
- "lookup",
18231
- "members",
18232
- "news",
18233
- "rackets",
18234
- "rankedwars",
18235
- "rankedwarreport",
18236
- "revives",
18237
- "revivesfull",
18238
- "stats",
18239
- "territory",
18240
- "territoryownership",
18241
- "territorywarreport",
18242
- "territorywars",
18243
- "timestamp",
18244
- "upgrades",
18245
- "wars",
18246
- "armor",
18247
- "boosters",
18248
- "caches",
18249
- "cesium",
18250
- "crimeexp",
18251
- "drugs",
18252
- "medical",
18253
- "positions",
18254
- "reports",
18255
- "temporary",
18256
- "weapons",
18257
- "armorynews",
18258
- "attacknews",
18259
- "crimenews",
18260
- "currency",
18261
- "donations",
18262
- "fundsnews",
18263
- "mainnews",
18264
- "membershipnews",
18265
- "territorynews"
19231
+ "oneOf": [
19232
+ {
19233
+ "description": "The following selections will fallback to API v1 and may change at any time: 'armor', 'boosters', 'caches', 'cesium', 'crimeexp', 'drugs', 'medical', 'temporary', 'weapons'.\n * The following selections are not available in API v2: 'armorynews', 'attacknews', 'crimenews', 'currency', 'donations', 'fundsnews', 'mainnews', 'membershipnews', 'territorynews'.",
19234
+ "type": "string",
19235
+ "enum": [
19236
+ "applications",
19237
+ "attacks",
19238
+ "attacksfull",
19239
+ "balance",
19240
+ "basic",
19241
+ "chain",
19242
+ "chainreport",
19243
+ "chains",
19244
+ "contributors",
19245
+ "crime",
19246
+ "crimes",
19247
+ "hof",
19248
+ "lookup",
19249
+ "members",
19250
+ "news",
19251
+ "positions",
19252
+ "rackets",
19253
+ "rankedwars",
19254
+ "rankedwarreport",
19255
+ "reports",
19256
+ "revives",
19257
+ "revivesfull",
19258
+ "search",
19259
+ "stats",
19260
+ "territory",
19261
+ "territoryownership",
19262
+ "territorywarreport",
19263
+ "territorywars",
19264
+ "timestamp",
19265
+ "upgrades",
19266
+ "wars",
19267
+ "armor",
19268
+ "boosters",
19269
+ "caches",
19270
+ "cesium",
19271
+ "crimeexp",
19272
+ "drugs",
19273
+ "medical",
19274
+ "temporary",
19275
+ "weapons"
19276
+ ]
19277
+ },
19278
+ {
19279
+ "type": "string"
19280
+ }
18266
19281
  ]
18267
19282
  },
18268
19283
  "FactionLookupResponse": {
@@ -18976,14 +19991,21 @@
18976
19991
  "type": "object"
18977
19992
  },
18978
19993
  "ForumSelectionName": {
18979
- "type": "string",
18980
- "enum": [
18981
- "categories",
18982
- "lookup",
18983
- "posts",
18984
- "thread",
18985
- "threads",
18986
- "timestamp"
19994
+ "oneOf": [
19995
+ {
19996
+ "type": "string",
19997
+ "enum": [
19998
+ "categories",
19999
+ "lookup",
20000
+ "posts",
20001
+ "thread",
20002
+ "threads",
20003
+ "timestamp"
20004
+ ]
20005
+ },
20006
+ {
20007
+ "type": "string"
20008
+ }
18987
20009
  ]
18988
20010
  },
18989
20011
  "ForumLookupResponse": {
@@ -19032,6 +20054,9 @@
19032
20054
  "type": "integer",
19033
20055
  "format": "int64"
19034
20056
  },
20057
+ {
20058
+ "type": "string"
20059
+ },
19035
20060
  {
19036
20061
  "type": "null"
19037
20062
  }
@@ -19189,10 +20214,17 @@
19189
20214
  "type": "object"
19190
20215
  },
19191
20216
  "KeySelectionName": {
19192
- "type": "string",
19193
- "enum": [
19194
- "info",
19195
- "log"
20217
+ "oneOf": [
20218
+ {
20219
+ "type": "string",
20220
+ "enum": [
20221
+ "info",
20222
+ "log"
20223
+ ]
20224
+ },
20225
+ {
20226
+ "type": "string"
20227
+ }
19196
20228
  ]
19197
20229
  },
19198
20230
  "ItemMarketListingItemBonus": {
@@ -19371,7 +20403,8 @@
19371
20403
  "ItemMarket": {
19372
20404
  "required": [
19373
20405
  "item",
19374
- "listings"
20406
+ "listings",
20407
+ "cache_timestamp"
19375
20408
  ],
19376
20409
  "properties": {
19377
20410
  "item": {
@@ -19389,6 +20422,11 @@
19389
20422
  }
19390
20423
  ]
19391
20424
  }
20425
+ },
20426
+ "cache_timestamp": {
20427
+ "description": "Timestamp when the data was globally cached at.",
20428
+ "type": "integer",
20429
+ "format": "int32"
19392
20430
  }
19393
20431
  },
19394
20432
  "type": "object"
@@ -19409,14 +20447,21 @@
19409
20447
  "type": "object"
19410
20448
  },
19411
20449
  "MarketSelectionName": {
19412
- "description": "The following selections will fallback to API v1 and may change at any time: 'pointsmarket'.",
19413
- "type": "string",
19414
- "enum": [
19415
- "itemmarket",
19416
- "lookup",
19417
- "timestamp",
19418
- "pointsmarket",
19419
- "bazaar"
20450
+ "oneOf": [
20451
+ {
20452
+ "description": "The following selections will fallback to API v1 and may change at any time: 'pointsmarket'.",
20453
+ "type": "string",
20454
+ "enum": [
20455
+ "itemmarket",
20456
+ "lookup",
20457
+ "timestamp",
20458
+ "pointsmarket",
20459
+ "bazaar"
20460
+ ]
20461
+ },
20462
+ {
20463
+ "type": "string"
20464
+ }
19420
20465
  ]
19421
20466
  },
19422
20467
  "MarketLookupResponse": {
@@ -19957,16 +21002,23 @@
19957
21002
  "type": "object"
19958
21003
  },
19959
21004
  "RacingSelectionName": {
19960
- "type": "string",
19961
- "enum": [
19962
- "cars",
19963
- "carupgrades",
19964
- "lookup",
19965
- "race",
19966
- "races",
19967
- "records",
19968
- "timestamp",
19969
- "tracks"
21005
+ "oneOf": [
21006
+ {
21007
+ "type": "string",
21008
+ "enum": [
21009
+ "cars",
21010
+ "carupgrades",
21011
+ "lookup",
21012
+ "race",
21013
+ "races",
21014
+ "records",
21015
+ "timestamp",
21016
+ "tracks"
21017
+ ]
21018
+ },
21019
+ {
21020
+ "type": "string"
21021
+ }
19970
21022
  ]
19971
21023
  },
19972
21024
  "RacingLookupResponse": {
@@ -21385,55 +22437,55 @@
21385
22437
  "type": "object"
21386
22438
  },
21387
22439
  "TornSelectionName": {
21388
- "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','dirtybombs','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','raidreport','raids','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.\n * The following selections are not available in API v2: 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.",
21389
- "type": "string",
21390
- "enum": [
21391
- "attacklog",
21392
- "bounties",
21393
- "calendar",
21394
- "crimes",
21395
- "education",
21396
- "factionhof",
21397
- "factiontree",
21398
- "hof",
21399
- "itemammo",
21400
- "itemmods",
21401
- "items",
21402
- "logcategories",
21403
- "logtypes",
21404
- "lookup",
21405
- "subcrimes",
21406
- "territory",
21407
- "timestamp",
21408
- "bank",
21409
- "cards",
21410
- "cityshops",
21411
- "companies",
21412
- "competition",
21413
- "dirtybombs",
21414
- "gyms",
21415
- "honors",
21416
- "itemdetails",
21417
- "itemstats",
21418
- "medals",
21419
- "organisedcrimes",
21420
- "pawnshop",
21421
- "pokertables",
21422
- "properties",
21423
- "raidreport",
21424
- "raids",
21425
- "rockpaperscissors",
21426
- "searchforcash",
21427
- "shoplifting",
21428
- "stats",
21429
- "stocks",
21430
- "chainreport",
21431
- "rackets",
21432
- "rankedwarreport",
21433
- "rankedwars",
21434
- "territorynames",
21435
- "territorywarreport",
21436
- "territorywars"
22440
+ "oneOf": [
22441
+ {
22442
+ "description": "The following selections will fallback to API v1 and may change at any time: 'bank','cards','cityshops','companies','competition','dirtybombs','gyms','honors','itemdetails','itemstats','medals','organisedcrimes','pawnshop','pokertables','properties','raidreport','raids','rockpaperscissors','searchforcash','shoplifting','stats','stocks'.\n * The following selections are not available in API v2: 'chainreport', 'rackets', 'rankedwarreport', 'rankedwars', 'territorynames', 'territorywarreport', 'territorywars'.",
22443
+ "type": "string",
22444
+ "enum": [
22445
+ "attacklog",
22446
+ "bounties",
22447
+ "calendar",
22448
+ "crimes",
22449
+ "education",
22450
+ "factionhof",
22451
+ "factiontree",
22452
+ "hof",
22453
+ "itemammo",
22454
+ "itemmods",
22455
+ "items",
22456
+ "logcategories",
22457
+ "logtypes",
22458
+ "lookup",
22459
+ "subcrimes",
22460
+ "territory",
22461
+ "timestamp",
22462
+ "bank",
22463
+ "cards",
22464
+ "cityshops",
22465
+ "companies",
22466
+ "competition",
22467
+ "dirtybombs",
22468
+ "gyms",
22469
+ "honors",
22470
+ "itemdetails",
22471
+ "itemstats",
22472
+ "medals",
22473
+ "organisedcrimes",
22474
+ "pawnshop",
22475
+ "pokertables",
22476
+ "properties",
22477
+ "raidreport",
22478
+ "raids",
22479
+ "rockpaperscissors",
22480
+ "searchforcash",
22481
+ "shoplifting",
22482
+ "stats",
22483
+ "stocks"
22484
+ ]
22485
+ },
22486
+ {
22487
+ "type": "string"
22488
+ }
21437
22489
  ]
21438
22490
  },
21439
22491
  "TornLookupResponse": {
@@ -21488,6 +22540,35 @@
21488
22540
  "type": "string"
21489
22541
  }
21490
22542
  },
22543
+ "ApiFactionSearchFilter": {
22544
+ "name": "filters",
22545
+ "in": "query",
22546
+ "description": "A filtering query parameter allowing a comma-separated list of filters. <br>\n * Each filter can be one of the following:\n * Fixed options: 'destroyed', 'notDestroyed', 'recruiting', 'notRecruiting'\n * Dynamic options: `fieldName`+`condition`+`number`, where:\n * * `fieldName` is one of: `id`, `respect`, `members`\n * * `condition` is one of: `Equal`, `NotEqual`, `Less`, `LessOrEqual`, `GreaterOrEqual`, `Greater`\n * * `number`: any integer value\n * Examples: `filters=destroyed`, `filters=notDestroyed,recruiting`, `filters=respectLessOrEqual20000,idGreater100,notRecruiting`",
22547
+ "required": false,
22548
+ "style": "form",
22549
+ "explode": false,
22550
+ "schema": {
22551
+ "type": "array",
22552
+ "items": {
22553
+ "schema": "Parameters",
22554
+ "oneOf": [
22555
+ {
22556
+ "type": "string",
22557
+ "enum": [
22558
+ "destroyed",
22559
+ "notDestroyed",
22560
+ "recruiting",
22561
+ "notRecruiting"
22562
+ ]
22563
+ },
22564
+ {
22565
+ "type": "string",
22566
+ "pattern": "^(id|respect|members)(Equal|NotEqual|Less|LessOrEqual|GreaterOrEqual|Greater)\\d+$"
22567
+ }
22568
+ ]
22569
+ }
22570
+ }
22571
+ },
21491
22572
  "ApiComment": {
21492
22573
  "name": "comment",
21493
22574
  "in": "query",
@@ -21497,6 +22578,15 @@
21497
22578
  "type": "string"
21498
22579
  }
21499
22580
  },
22581
+ "ApiName": {
22582
+ "name": "name",
22583
+ "in": "query",
22584
+ "description": "Name to search for.",
22585
+ "required": false,
22586
+ "schema": {
22587
+ "type": "string"
22588
+ }
22589
+ },
21500
22590
  "ApiLimit20": {
21501
22591
  "name": "limit",
21502
22592
  "in": "query",
@@ -21603,6 +22693,16 @@
21603
22693
  "minimum": 1
21604
22694
  }
21605
22695
  },
22696
+ "ApiTarget": {
22697
+ "name": "target",
22698
+ "in": "query",
22699
+ "required": false,
22700
+ "schema": {
22701
+ "type": "integer",
22702
+ "format": "int32",
22703
+ "minimum": 1
22704
+ }
22705
+ },
21606
22706
  "ApiSort": {
21607
22707
  "name": "sort",
21608
22708
  "in": "query",