@takaro/apiclient 0.0.0-dev.573074e → 0.0.0-dev.57b3384
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/.source-hash +1 -1
- package/dist/generated/api.d.ts +7101 -2198
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/generated/api.js +2362 -303
- package/dist/generated/api.js.map +1 -1
- package/dist/generated/base.d.ts.map +1 -1
- package/dist/generated/base.js.map +1 -1
- package/dist/generated/common.d.ts.map +1 -1
- package/dist/generated/common.js.map +1 -1
- package/dist/generated/configuration.d.ts.map +1 -1
- package/dist/generated/configuration.js.map +1 -1
- package/dist/generated-management/api.d.ts +7254 -4728
- package/dist/generated-management/api.d.ts.map +1 -1
- package/dist/generated-management/api.js +388 -0
- package/dist/generated-management/api.js.map +1 -1
- package/dist/generated-management/base.d.ts.map +1 -1
- package/dist/generated-management/base.js.map +1 -1
- package/dist/generated-management/common.d.ts.map +1 -1
- package/dist/generated-management/common.js.map +1 -1
- package/dist/generated-management/configuration.d.ts.map +1 -1
- package/dist/generated-management/configuration.js.map +1 -1
- package/dist/lib/adminClient.d.ts.map +1 -1
- package/dist/lib/baseClient.d.ts.map +1 -1
- package/dist/lib/client.d.ts +3 -1
- package/dist/lib/client.d.ts.map +1 -1
- package/dist/lib/client.js +22 -11
- package/dist/lib/client.js.map +1 -1
- package/dist/lib/distributorClient.d.ts.map +1 -1
- package/dist/main.d.ts +1 -1
- package/dist/main.d.ts.map +1 -1
- package/package.json +4 -3
package/dist/generated/api.js
CHANGED
|
@@ -59,6 +59,20 @@ export const ApiKeySearchInputDTOSortDirectionEnum = {
|
|
|
59
59
|
Asc: 'asc',
|
|
60
60
|
Desc: 'desc',
|
|
61
61
|
};
|
|
62
|
+
export const AreaGainDTOCauseEnum = {
|
|
63
|
+
Pickup: 'pickup',
|
|
64
|
+
Drop: 'drop',
|
|
65
|
+
Craft: 'craft',
|
|
66
|
+
Loot: 'loot',
|
|
67
|
+
Trade: 'trade',
|
|
68
|
+
Death: 'death',
|
|
69
|
+
Other: 'other',
|
|
70
|
+
Unknown: 'unknown',
|
|
71
|
+
};
|
|
72
|
+
export const AreaGainDTOPositionSourceEnum = {
|
|
73
|
+
Reported: 'reported',
|
|
74
|
+
Sampled: 'sampled',
|
|
75
|
+
};
|
|
62
76
|
export const BanSearchInputDTOExtendEnum = {
|
|
63
77
|
Player: 'player',
|
|
64
78
|
GameServer: 'gameServer',
|
|
@@ -267,6 +281,7 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
267
281
|
SettingsSet: 'settings-set',
|
|
268
282
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
269
283
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
284
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
270
285
|
ServerStatusChanged: 'server-status-changed',
|
|
271
286
|
ModuleCreated: 'module-created',
|
|
272
287
|
ModuleUpdated: 'module-updated',
|
|
@@ -281,8 +296,11 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
281
296
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
282
297
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
283
298
|
PlayerLinked: 'player-linked',
|
|
299
|
+
PlayerUnlinked: 'player-unlinked',
|
|
300
|
+
PlayerMerged: 'player-merged',
|
|
284
301
|
GameserverCreated: 'gameserver-created',
|
|
285
302
|
GameserverUpdated: 'gameserver-updated',
|
|
303
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
286
304
|
GameserverDeleted: 'gameserver-deleted',
|
|
287
305
|
PlayerBanned: 'player-banned',
|
|
288
306
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -326,6 +344,7 @@ export const EventExploreFiltersDTOEventNameEnum = {
|
|
|
326
344
|
SettingsSet: 'settings-set',
|
|
327
345
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
328
346
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
347
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
329
348
|
ServerStatusChanged: 'server-status-changed',
|
|
330
349
|
ModuleCreated: 'module-created',
|
|
331
350
|
ModuleUpdated: 'module-updated',
|
|
@@ -340,8 +359,11 @@ export const EventExploreFiltersDTOEventNameEnum = {
|
|
|
340
359
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
341
360
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
342
361
|
PlayerLinked: 'player-linked',
|
|
362
|
+
PlayerUnlinked: 'player-unlinked',
|
|
363
|
+
PlayerMerged: 'player-merged',
|
|
343
364
|
GameserverCreated: 'gameserver-created',
|
|
344
365
|
GameserverUpdated: 'gameserver-updated',
|
|
366
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
345
367
|
GameserverDeleted: 'gameserver-deleted',
|
|
346
368
|
PlayerBanned: 'player-banned',
|
|
347
369
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -369,6 +391,15 @@ export const EventExploreFiltersDTOEventNameEnum = {
|
|
|
369
391
|
PlayerDeath: 'player-death',
|
|
370
392
|
EntityKilled: 'entity-killed',
|
|
371
393
|
};
|
|
394
|
+
export const EventInventoryChangedCauseEnum = {
|
|
395
|
+
Pickup: 'pickup',
|
|
396
|
+
Drop: 'drop',
|
|
397
|
+
Craft: 'craft',
|
|
398
|
+
Loot: 'loot',
|
|
399
|
+
Trade: 'trade',
|
|
400
|
+
Death: 'death',
|
|
401
|
+
Other: 'other',
|
|
402
|
+
};
|
|
372
403
|
export const EventOutputDTOEventNameEnum = {
|
|
373
404
|
RoleAssigned: 'role-assigned',
|
|
374
405
|
RoleRemoved: 'role-removed',
|
|
@@ -385,6 +416,7 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
385
416
|
SettingsSet: 'settings-set',
|
|
386
417
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
387
418
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
419
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
388
420
|
ServerStatusChanged: 'server-status-changed',
|
|
389
421
|
ModuleCreated: 'module-created',
|
|
390
422
|
ModuleUpdated: 'module-updated',
|
|
@@ -399,8 +431,11 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
399
431
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
400
432
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
401
433
|
PlayerLinked: 'player-linked',
|
|
434
|
+
PlayerUnlinked: 'player-unlinked',
|
|
435
|
+
PlayerMerged: 'player-merged',
|
|
402
436
|
GameserverCreated: 'gameserver-created',
|
|
403
437
|
GameserverUpdated: 'gameserver-updated',
|
|
438
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
404
439
|
GameserverDeleted: 'gameserver-deleted',
|
|
405
440
|
PlayerBanned: 'player-banned',
|
|
406
441
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -444,6 +479,7 @@ export const EventSearchInputAllowedFiltersEventNameEnum = {
|
|
|
444
479
|
SettingsSet: 'settings-set',
|
|
445
480
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
446
481
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
482
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
447
483
|
ServerStatusChanged: 'server-status-changed',
|
|
448
484
|
ModuleCreated: 'module-created',
|
|
449
485
|
ModuleUpdated: 'module-updated',
|
|
@@ -458,8 +494,11 @@ export const EventSearchInputAllowedFiltersEventNameEnum = {
|
|
|
458
494
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
459
495
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
460
496
|
PlayerLinked: 'player-linked',
|
|
497
|
+
PlayerUnlinked: 'player-unlinked',
|
|
498
|
+
PlayerMerged: 'player-merged',
|
|
461
499
|
GameserverCreated: 'gameserver-created',
|
|
462
500
|
GameserverUpdated: 'gameserver-updated',
|
|
501
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
463
502
|
GameserverDeleted: 'gameserver-deleted',
|
|
464
503
|
PlayerBanned: 'player-banned',
|
|
465
504
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -522,12 +561,24 @@ export const GameServerCreateDTOTypeEnum = {
|
|
|
522
561
|
Generic: 'GENERIC',
|
|
523
562
|
Mock: 'MOCK',
|
|
524
563
|
};
|
|
564
|
+
export const GameServerCreateDTONameSourceEnum = {
|
|
565
|
+
Connector: 'connector',
|
|
566
|
+
Operator: 'operator',
|
|
567
|
+
};
|
|
568
|
+
export const GameServerIdentifyInputDTOProtocolVersionEnum = {
|
|
569
|
+
NUMBER_0: 0,
|
|
570
|
+
NUMBER_1: 1,
|
|
571
|
+
};
|
|
525
572
|
export const GameServerOutputDTOTypeEnum = {
|
|
526
573
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
527
574
|
Rust: 'RUST',
|
|
528
575
|
Generic: 'GENERIC',
|
|
529
576
|
Mock: 'MOCK',
|
|
530
577
|
};
|
|
578
|
+
export const GameServerOutputDTONameSourceEnum = {
|
|
579
|
+
Connector: 'connector',
|
|
580
|
+
Operator: 'operator',
|
|
581
|
+
};
|
|
531
582
|
export const GameServerSearchInputAllowedFiltersTypeEnum = {
|
|
532
583
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
533
584
|
Rust: 'RUST',
|
|
@@ -570,14 +621,17 @@ export const GetJobInputDTOTypeEnum = {
|
|
|
570
621
|
SyncItems: 'syncItems',
|
|
571
622
|
SyncEntities: 'syncEntities',
|
|
572
623
|
SyncBans: 'syncBans',
|
|
624
|
+
SyncLocations: 'syncLocations',
|
|
573
625
|
SyncMapImages: 'syncMapImages',
|
|
574
626
|
SyncMapUploads: 'syncMapUploads',
|
|
627
|
+
SyncGameIcons: 'syncGameIcons',
|
|
575
628
|
SyncSteam: 'syncSteam',
|
|
576
629
|
SyncDiscordRoles: 'syncDiscordRoles',
|
|
577
630
|
EmitRateLimitSummary: 'emitRateLimitSummary',
|
|
578
631
|
CleanRevokedApiKeys: 'cleanRevokedApiKeys',
|
|
579
632
|
CleanExecutionClaims: 'cleanExecutionClaims',
|
|
580
633
|
DeleteClickHouseEvents: 'deleteClickHouseEvents',
|
|
634
|
+
RepointClickHouseEvents: 'repointClickHouseEvents',
|
|
581
635
|
CleanConnectorMigrations: 'cleanConnectorMigrations',
|
|
582
636
|
};
|
|
583
637
|
export const GetSettingsInputKeysEnum = {
|
|
@@ -626,6 +680,7 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
626
680
|
SettingsSet: 'settings-set',
|
|
627
681
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
628
682
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
683
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
629
684
|
ServerStatusChanged: 'server-status-changed',
|
|
630
685
|
ModuleCreated: 'module-created',
|
|
631
686
|
ModuleUpdated: 'module-updated',
|
|
@@ -640,8 +695,11 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
640
695
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
641
696
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
642
697
|
PlayerLinked: 'player-linked',
|
|
698
|
+
PlayerUnlinked: 'player-unlinked',
|
|
699
|
+
PlayerMerged: 'player-merged',
|
|
643
700
|
GameserverCreated: 'gameserver-created',
|
|
644
701
|
GameserverUpdated: 'gameserver-updated',
|
|
702
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
645
703
|
GameserverDeleted: 'gameserver-deleted',
|
|
646
704
|
PlayerBanned: 'player-banned',
|
|
647
705
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -687,6 +745,7 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
687
745
|
SettingsSet: 'settings-set',
|
|
688
746
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
689
747
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
748
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
690
749
|
ServerStatusChanged: 'server-status-changed',
|
|
691
750
|
ModuleCreated: 'module-created',
|
|
692
751
|
ModuleUpdated: 'module-updated',
|
|
@@ -701,8 +760,11 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
701
760
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
702
761
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
703
762
|
PlayerLinked: 'player-linked',
|
|
763
|
+
PlayerUnlinked: 'player-unlinked',
|
|
764
|
+
PlayerMerged: 'player-merged',
|
|
704
765
|
GameserverCreated: 'gameserver-created',
|
|
705
766
|
GameserverUpdated: 'gameserver-updated',
|
|
767
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
706
768
|
GameserverDeleted: 'gameserver-deleted',
|
|
707
769
|
PlayerBanned: 'player-banned',
|
|
708
770
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -748,6 +810,7 @@ export const HookSearchInputAllowedFiltersEventTypeEnum = {
|
|
|
748
810
|
SettingsSet: 'settings-set',
|
|
749
811
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
750
812
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
813
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
751
814
|
ServerStatusChanged: 'server-status-changed',
|
|
752
815
|
ModuleCreated: 'module-created',
|
|
753
816
|
ModuleUpdated: 'module-updated',
|
|
@@ -762,8 +825,11 @@ export const HookSearchInputAllowedFiltersEventTypeEnum = {
|
|
|
762
825
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
763
826
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
764
827
|
PlayerLinked: 'player-linked',
|
|
828
|
+
PlayerUnlinked: 'player-unlinked',
|
|
829
|
+
PlayerMerged: 'player-merged',
|
|
765
830
|
GameserverCreated: 'gameserver-created',
|
|
766
831
|
GameserverUpdated: 'gameserver-updated',
|
|
832
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
767
833
|
GameserverDeleted: 'gameserver-deleted',
|
|
768
834
|
PlayerBanned: 'player-banned',
|
|
769
835
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -817,6 +883,7 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
817
883
|
SettingsSet: 'settings-set',
|
|
818
884
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
819
885
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
886
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
820
887
|
ServerStatusChanged: 'server-status-changed',
|
|
821
888
|
ModuleCreated: 'module-created',
|
|
822
889
|
ModuleUpdated: 'module-updated',
|
|
@@ -831,8 +898,11 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
831
898
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
832
899
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
833
900
|
PlayerLinked: 'player-linked',
|
|
901
|
+
PlayerUnlinked: 'player-unlinked',
|
|
902
|
+
PlayerMerged: 'player-merged',
|
|
834
903
|
GameserverCreated: 'gameserver-created',
|
|
835
904
|
GameserverUpdated: 'gameserver-updated',
|
|
905
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
836
906
|
GameserverDeleted: 'gameserver-deleted',
|
|
837
907
|
PlayerBanned: 'player-banned',
|
|
838
908
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -878,6 +948,7 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
878
948
|
SettingsSet: 'settings-set',
|
|
879
949
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
880
950
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
951
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
881
952
|
ServerStatusChanged: 'server-status-changed',
|
|
882
953
|
ModuleCreated: 'module-created',
|
|
883
954
|
ModuleUpdated: 'module-updated',
|
|
@@ -892,8 +963,11 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
892
963
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
893
964
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
894
965
|
PlayerLinked: 'player-linked',
|
|
966
|
+
PlayerUnlinked: 'player-unlinked',
|
|
967
|
+
PlayerMerged: 'player-merged',
|
|
895
968
|
GameserverCreated: 'gameserver-created',
|
|
896
969
|
GameserverUpdated: 'gameserver-updated',
|
|
970
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
897
971
|
GameserverDeleted: 'gameserver-deleted',
|
|
898
972
|
PlayerBanned: 'player-banned',
|
|
899
973
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -944,6 +1018,7 @@ export const IHookEventTypeEnum = {
|
|
|
944
1018
|
SettingsSet: 'settings-set',
|
|
945
1019
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
946
1020
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
1021
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
947
1022
|
ServerStatusChanged: 'server-status-changed',
|
|
948
1023
|
ModuleCreated: 'module-created',
|
|
949
1024
|
ModuleUpdated: 'module-updated',
|
|
@@ -958,8 +1033,11 @@ export const IHookEventTypeEnum = {
|
|
|
958
1033
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
959
1034
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
960
1035
|
PlayerLinked: 'player-linked',
|
|
1036
|
+
PlayerUnlinked: 'player-unlinked',
|
|
1037
|
+
PlayerMerged: 'player-merged',
|
|
961
1038
|
GameserverCreated: 'gameserver-created',
|
|
962
1039
|
GameserverUpdated: 'gameserver-updated',
|
|
1040
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
963
1041
|
GameserverDeleted: 'gameserver-deleted',
|
|
964
1042
|
PlayerBanned: 'player-banned',
|
|
965
1043
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -986,6 +1064,29 @@ export const ITakaroQuerySortDirectionEnum = {
|
|
|
986
1064
|
Asc: 'asc',
|
|
987
1065
|
Desc: 'desc',
|
|
988
1066
|
};
|
|
1067
|
+
export const InventoryChangeCounterpartDTOKindEnum = {
|
|
1068
|
+
Container: 'container',
|
|
1069
|
+
Player: 'player',
|
|
1070
|
+
};
|
|
1071
|
+
export const InventoryChangeDTOChangeTypeEnum = {
|
|
1072
|
+
Added: 'added',
|
|
1073
|
+
Removed: 'removed',
|
|
1074
|
+
Changed: 'changed',
|
|
1075
|
+
};
|
|
1076
|
+
export const InventoryChangeDTOCauseEnum = {
|
|
1077
|
+
Pickup: 'pickup',
|
|
1078
|
+
Drop: 'drop',
|
|
1079
|
+
Craft: 'craft',
|
|
1080
|
+
Loot: 'loot',
|
|
1081
|
+
Trade: 'trade',
|
|
1082
|
+
Death: 'death',
|
|
1083
|
+
Other: 'other',
|
|
1084
|
+
Unknown: 'unknown',
|
|
1085
|
+
};
|
|
1086
|
+
export const InventoryCounterpartDTOKindEnum = {
|
|
1087
|
+
Container: 'container',
|
|
1088
|
+
Player: 'player',
|
|
1089
|
+
};
|
|
989
1090
|
export const InviteLinkCreateResultDTOStatusEnum = {
|
|
990
1091
|
Active: 'ACTIVE',
|
|
991
1092
|
Revoked: 'REVOKED',
|
|
@@ -1008,6 +1109,21 @@ export const InviteLinkSearchInputDTOSortDirectionEnum = {
|
|
|
1008
1109
|
Asc: 'asc',
|
|
1009
1110
|
Desc: 'desc',
|
|
1010
1111
|
};
|
|
1112
|
+
export const ItemHolderChangeDTOChangeTypeEnum = {
|
|
1113
|
+
Added: 'added',
|
|
1114
|
+
Removed: 'removed',
|
|
1115
|
+
Changed: 'changed',
|
|
1116
|
+
};
|
|
1117
|
+
export const ItemHolderChangeDTOCauseEnum = {
|
|
1118
|
+
Pickup: 'pickup',
|
|
1119
|
+
Drop: 'drop',
|
|
1120
|
+
Craft: 'craft',
|
|
1121
|
+
Loot: 'loot',
|
|
1122
|
+
Trade: 'trade',
|
|
1123
|
+
Death: 'death',
|
|
1124
|
+
Other: 'other',
|
|
1125
|
+
Unknown: 'unknown',
|
|
1126
|
+
};
|
|
1011
1127
|
export const ItemSearchInputDTOExtendEnum = {
|
|
1012
1128
|
Gameserver: 'gameserver',
|
|
1013
1129
|
};
|
|
@@ -1041,6 +1157,10 @@ export const JobStatusOutputDTOStatusEnum = {
|
|
|
1041
1157
|
Waiting: 'waiting',
|
|
1042
1158
|
WaitingChildren: 'waiting-children',
|
|
1043
1159
|
};
|
|
1160
|
+
export const LocationSearchInputDTOSortDirectionEnum = {
|
|
1161
|
+
Asc: 'asc',
|
|
1162
|
+
Desc: 'desc',
|
|
1163
|
+
};
|
|
1044
1164
|
export const LoginQueryParamsLocaleEnum = {
|
|
1045
1165
|
En: 'en',
|
|
1046
1166
|
Nl: 'nl',
|
|
@@ -1160,6 +1280,8 @@ export const PERMISSIONS = {
|
|
|
1160
1280
|
ViewDiscordInfo: 'VIEW_DISCORD_INFO',
|
|
1161
1281
|
SendDiscordMessage: 'SEND_DISCORD_MESSAGE',
|
|
1162
1282
|
ManageApiKeys: 'MANAGE_API_KEYS',
|
|
1283
|
+
ReadMap: 'READ_MAP',
|
|
1284
|
+
ReadTracking: 'READ_TRACKING',
|
|
1163
1285
|
};
|
|
1164
1286
|
export const ParamKeyKeyEnum = {
|
|
1165
1287
|
CommandPrefix: 'commandPrefix',
|
|
@@ -1175,6 +1297,39 @@ export const ParamKeyKeyEnum = {
|
|
|
1175
1297
|
UnknownCommandFeedbackMessage: 'unknownCommandFeedbackMessage',
|
|
1176
1298
|
TakaroAiEnabled: 'takaroAiEnabled',
|
|
1177
1299
|
};
|
|
1300
|
+
export const PlayerMergeGameServerDTOOutcomeEnum = {
|
|
1301
|
+
Moved: 'moved',
|
|
1302
|
+
Combined: 'combined',
|
|
1303
|
+
};
|
|
1304
|
+
export const PlayerMergeGameServerDTOKeptPogFromEnum = {
|
|
1305
|
+
Survivor: 'survivor',
|
|
1306
|
+
Absorbed: 'absorbed',
|
|
1307
|
+
};
|
|
1308
|
+
export const PlayerMergeGameServerDTOInventoryFromEnum = {
|
|
1309
|
+
Survivor: 'survivor',
|
|
1310
|
+
Absorbed: 'absorbed',
|
|
1311
|
+
};
|
|
1312
|
+
export const PlayerMergeIdentifierDTOIdentifierEnum = {
|
|
1313
|
+
SteamId: 'steamId',
|
|
1314
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1315
|
+
XboxLiveId: 'xboxLiveId',
|
|
1316
|
+
PlatformId: 'platformId',
|
|
1317
|
+
};
|
|
1318
|
+
export const PlayerMergeIdentifierDTOFromEnum = {
|
|
1319
|
+
Survivor: 'survivor',
|
|
1320
|
+
Absorbed: 'absorbed',
|
|
1321
|
+
};
|
|
1322
|
+
export const PlayerMergeRefusalDTOCodeEnum = {
|
|
1323
|
+
SamePlayer: 'same-player',
|
|
1324
|
+
IdentifierConflict: 'identifier-conflict',
|
|
1325
|
+
FixturePlayer: 'fixture-player',
|
|
1326
|
+
};
|
|
1327
|
+
export const PlayerMergeRefusalDTOIdentifierEnum = {
|
|
1328
|
+
SteamId: 'steamId',
|
|
1329
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1330
|
+
XboxLiveId: 'xboxLiveId',
|
|
1331
|
+
PlatformId: 'platformId',
|
|
1332
|
+
};
|
|
1178
1333
|
export const PlayerOnGameServerSearchInputDTOExtendEnum = {
|
|
1179
1334
|
GameServer: 'gameServer',
|
|
1180
1335
|
Player: 'player',
|
|
@@ -1183,6 +1338,24 @@ export const PlayerOnGameServerSearchInputDTOSortDirectionEnum = {
|
|
|
1183
1338
|
Asc: 'asc',
|
|
1184
1339
|
Desc: 'desc',
|
|
1185
1340
|
};
|
|
1341
|
+
export const PlayerPortalLinkCodeDTOStatusEnum = {
|
|
1342
|
+
Valid: 'valid',
|
|
1343
|
+
Expired: 'expired',
|
|
1344
|
+
Invalid: 'invalid',
|
|
1345
|
+
};
|
|
1346
|
+
export const PlayerPortalLinkDTOSourceEnum = {
|
|
1347
|
+
GameCode: 'game-code',
|
|
1348
|
+
WebCode: 'web-code',
|
|
1349
|
+
SteamAuto: 'steam-auto',
|
|
1350
|
+
Admin: 'admin',
|
|
1351
|
+
Unknown: 'unknown',
|
|
1352
|
+
};
|
|
1353
|
+
export const PlayerPortalServerDTOGameServerTypeEnum = {
|
|
1354
|
+
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
1355
|
+
Rust: 'RUST',
|
|
1356
|
+
Generic: 'GENERIC',
|
|
1357
|
+
Mock: 'MOCK',
|
|
1358
|
+
};
|
|
1186
1359
|
export const PlayerSearchInputAllowedFiltersRoleAssignmentScopeEnum = {
|
|
1187
1360
|
Global: 'global',
|
|
1188
1361
|
GameServer: 'gameServer',
|
|
@@ -1197,6 +1370,11 @@ export const PlayerSearchInputDTOSortDirectionEnum = {
|
|
|
1197
1370
|
Asc: 'asc',
|
|
1198
1371
|
Desc: 'desc',
|
|
1199
1372
|
};
|
|
1373
|
+
export const PositionAreaShapeDTOTypeEnum = {
|
|
1374
|
+
Circle: 'circle',
|
|
1375
|
+
Rectangle: 'rectangle',
|
|
1376
|
+
Polygon: 'polygon',
|
|
1377
|
+
};
|
|
1200
1378
|
export const RecentOrderDTOStatusEnum = {
|
|
1201
1379
|
Completed: 'COMPLETED',
|
|
1202
1380
|
Paid: 'PAID',
|
|
@@ -1359,16 +1537,68 @@ export const TakaroEventDomainCreatedOriginEnum = {
|
|
|
1359
1537
|
Subscription: 'subscription',
|
|
1360
1538
|
AdminSecret: 'admin_secret',
|
|
1361
1539
|
};
|
|
1540
|
+
export const TakaroEventInventoryCounterpartKindEnum = {
|
|
1541
|
+
Container: 'container',
|
|
1542
|
+
Player: 'player',
|
|
1543
|
+
};
|
|
1362
1544
|
export const TakaroEventItemsGivenLineResultEnum = {
|
|
1363
1545
|
Delivered: 'DELIVERED',
|
|
1364
1546
|
Failed: 'FAILED',
|
|
1365
1547
|
Unknown: 'UNKNOWN',
|
|
1366
1548
|
};
|
|
1549
|
+
export const TakaroEventPlayerIdentityConflictUnwrittenIdentifiersEnum = {
|
|
1550
|
+
SteamId: 'steamId',
|
|
1551
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1552
|
+
XboxLiveId: 'xboxLiveId',
|
|
1553
|
+
PlatformId: 'platformId',
|
|
1554
|
+
};
|
|
1555
|
+
export const TakaroEventPlayerIdentityConflictMatchMatchedOnEnum = {
|
|
1556
|
+
SteamId: 'steamId',
|
|
1557
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1558
|
+
XboxLiveId: 'xboxLiveId',
|
|
1559
|
+
PlatformId: 'platformId',
|
|
1560
|
+
};
|
|
1367
1561
|
export const TakaroEventPlayerInventoryChangedChangeTypeEnum = {
|
|
1368
1562
|
Added: 'added',
|
|
1369
1563
|
Removed: 'removed',
|
|
1370
1564
|
Changed: 'changed',
|
|
1371
1565
|
};
|
|
1566
|
+
export const TakaroEventPlayerInventoryChangedCauseEnum = {
|
|
1567
|
+
Pickup: 'pickup',
|
|
1568
|
+
Drop: 'drop',
|
|
1569
|
+
Craft: 'craft',
|
|
1570
|
+
Loot: 'loot',
|
|
1571
|
+
Trade: 'trade',
|
|
1572
|
+
Death: 'death',
|
|
1573
|
+
Other: 'other',
|
|
1574
|
+
};
|
|
1575
|
+
export const TakaroEventPlayerLinkedSourceEnum = {
|
|
1576
|
+
GameCode: 'game-code',
|
|
1577
|
+
WebCode: 'web-code',
|
|
1578
|
+
SteamAuto: 'steam-auto',
|
|
1579
|
+
Admin: 'admin',
|
|
1580
|
+
Unknown: 'unknown',
|
|
1581
|
+
};
|
|
1582
|
+
export const TakaroEventPlayerMergedMovedIdentifiersEnum = {
|
|
1583
|
+
SteamId: 'steamId',
|
|
1584
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1585
|
+
XboxLiveId: 'xboxLiveId',
|
|
1586
|
+
PlatformId: 'platformId',
|
|
1587
|
+
};
|
|
1588
|
+
export const TakaroEventPlayerMergedServerOutcomeEnum = {
|
|
1589
|
+
Moved: 'moved',
|
|
1590
|
+
Combined: 'combined',
|
|
1591
|
+
};
|
|
1592
|
+
export const TakaroEventPlayerMergedServerKeptPogFromEnum = {
|
|
1593
|
+
Survivor: 'survivor',
|
|
1594
|
+
Absorbed: 'absorbed',
|
|
1595
|
+
};
|
|
1596
|
+
export const TakaroEventPlayerUnlinkedReasonEnum = {
|
|
1597
|
+
Self: 'self',
|
|
1598
|
+
Admin: 'admin',
|
|
1599
|
+
Displaced: 'displaced',
|
|
1600
|
+
Merged: 'merged',
|
|
1601
|
+
};
|
|
1372
1602
|
export const TakaroEventRateLimitedScopeEnum = {
|
|
1373
1603
|
Server: 'server',
|
|
1374
1604
|
Domain: 'domain',
|
|
@@ -1504,6 +1734,16 @@ export const ThreadWithStepsOutputDTOOriginSurfaceEnum = {
|
|
|
1504
1734
|
EventFailure: 'eventFailure',
|
|
1505
1735
|
CsmmMigration: 'csmmMigration',
|
|
1506
1736
|
};
|
|
1737
|
+
export const TrackingEventDTOEventNameEnum = {
|
|
1738
|
+
PlayerDeath: 'player-death',
|
|
1739
|
+
EntityKilled: 'entity-killed',
|
|
1740
|
+
PlayerConnected: 'player-connected',
|
|
1741
|
+
PlayerDisconnected: 'player-disconnected',
|
|
1742
|
+
};
|
|
1743
|
+
export const TrackingEventDTOPositionSourceEnum = {
|
|
1744
|
+
Reported: 'reported',
|
|
1745
|
+
Sampled: 'sampled',
|
|
1746
|
+
};
|
|
1507
1747
|
export const TriggerJobInputDTOTypeEnum = {
|
|
1508
1748
|
SeedModules: 'seedModules',
|
|
1509
1749
|
CleanEvents: 'cleanEvents',
|
|
@@ -1513,11 +1753,27 @@ export const TriggerJobInputDTOTypeEnum = {
|
|
|
1513
1753
|
SyncItems: 'syncItems',
|
|
1514
1754
|
SyncEntities: 'syncEntities',
|
|
1515
1755
|
SyncBans: 'syncBans',
|
|
1756
|
+
SyncLocations: 'syncLocations',
|
|
1516
1757
|
SyncMapImages: 'syncMapImages',
|
|
1517
1758
|
SyncMapUploads: 'syncMapUploads',
|
|
1759
|
+
SyncGameIcons: 'syncGameIcons',
|
|
1518
1760
|
SyncSteam: 'syncSteam',
|
|
1519
1761
|
SyncDiscordRoles: 'syncDiscordRoles',
|
|
1520
1762
|
};
|
|
1763
|
+
export const UserOutputDTOPlayerLinkSourceEnum = {
|
|
1764
|
+
GameCode: 'game-code',
|
|
1765
|
+
WebCode: 'web-code',
|
|
1766
|
+
SteamAuto: 'steam-auto',
|
|
1767
|
+
Admin: 'admin',
|
|
1768
|
+
Unknown: 'unknown',
|
|
1769
|
+
};
|
|
1770
|
+
export const UserOutputWithRolesDTOPlayerLinkSourceEnum = {
|
|
1771
|
+
GameCode: 'game-code',
|
|
1772
|
+
WebCode: 'web-code',
|
|
1773
|
+
SteamAuto: 'steam-auto',
|
|
1774
|
+
Admin: 'admin',
|
|
1775
|
+
Unknown: 'unknown',
|
|
1776
|
+
};
|
|
1521
1777
|
export const UserSearchInputDTOExtendEnum = {
|
|
1522
1778
|
Roles: 'roles',
|
|
1523
1779
|
};
|
|
@@ -5946,7 +6202,7 @@ export const AuthControllerLoginLocaleEnum = {
|
|
|
5946
6202
|
export const CommandApiAxiosParamCreator = function (configuration) {
|
|
5947
6203
|
return {
|
|
5948
6204
|
/**
|
|
5949
|
-
*
|
|
6205
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerCreate`
|
|
5950
6206
|
* @summary Create
|
|
5951
6207
|
* @param {CommandCreateDTO} [commandCreateDTO] CommandCreateDTO
|
|
5952
6208
|
* @param {*} [options] Override http request option.
|
|
@@ -6214,7 +6470,7 @@ export const CommandApiAxiosParamCreator = function (configuration) {
|
|
|
6214
6470
|
};
|
|
6215
6471
|
},
|
|
6216
6472
|
/**
|
|
6217
|
-
*
|
|
6473
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. A command that already has it can still be edited. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerUpdate`
|
|
6218
6474
|
* @summary Update
|
|
6219
6475
|
* @param {string} id
|
|
6220
6476
|
* @param {CommandUpdateDTO} [commandUpdateDTO] CommandUpdateDTO
|
|
@@ -6293,7 +6549,7 @@ export const CommandApiFp = function (configuration) {
|
|
|
6293
6549
|
const localVarAxiosParamCreator = CommandApiAxiosParamCreator(configuration);
|
|
6294
6550
|
return {
|
|
6295
6551
|
/**
|
|
6296
|
-
*
|
|
6552
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerCreate`
|
|
6297
6553
|
* @summary Create
|
|
6298
6554
|
* @param {CommandCreateDTO} [commandCreateDTO] CommandCreateDTO
|
|
6299
6555
|
* @param {*} [options] Override http request option.
|
|
@@ -6400,7 +6656,7 @@ export const CommandApiFp = function (configuration) {
|
|
|
6400
6656
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6401
6657
|
},
|
|
6402
6658
|
/**
|
|
6403
|
-
*
|
|
6659
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. A command that already has it can still be edited. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerUpdate`
|
|
6404
6660
|
* @summary Update
|
|
6405
6661
|
* @param {string} id
|
|
6406
6662
|
* @param {CommandUpdateDTO} [commandUpdateDTO] CommandUpdateDTO
|
|
@@ -6437,7 +6693,7 @@ export const CommandApiFactory = function (configuration, basePath, axios) {
|
|
|
6437
6693
|
const localVarFp = CommandApiFp(configuration);
|
|
6438
6694
|
return {
|
|
6439
6695
|
/**
|
|
6440
|
-
*
|
|
6696
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerCreate`
|
|
6441
6697
|
* @summary Create
|
|
6442
6698
|
* @param {CommandCreateDTO} [commandCreateDTO] CommandCreateDTO
|
|
6443
6699
|
* @param {*} [options] Override http request option.
|
|
@@ -6528,7 +6784,7 @@ export const CommandApiFactory = function (configuration, basePath, axios) {
|
|
|
6528
6784
|
.then((request) => request(axios, basePath));
|
|
6529
6785
|
},
|
|
6530
6786
|
/**
|
|
6531
|
-
*
|
|
6787
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. A command that already has it can still be edited. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerUpdate`
|
|
6532
6788
|
* @summary Update
|
|
6533
6789
|
* @param {string} id
|
|
6534
6790
|
* @param {CommandUpdateDTO} [commandUpdateDTO] CommandUpdateDTO
|
|
@@ -6563,7 +6819,7 @@ export const CommandApiFactory = function (configuration, basePath, axios) {
|
|
|
6563
6819
|
*/
|
|
6564
6820
|
export class CommandApi extends BaseAPI {
|
|
6565
6821
|
/**
|
|
6566
|
-
*
|
|
6822
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerCreate`
|
|
6567
6823
|
* @summary Create
|
|
6568
6824
|
* @param {CommandCreateDTO} [commandCreateDTO] CommandCreateDTO
|
|
6569
6825
|
* @param {*} [options] Override http request option.
|
|
@@ -6670,7 +6926,7 @@ export class CommandApi extends BaseAPI {
|
|
|
6670
6926
|
.then((request) => request(this.axios, this.basePath));
|
|
6671
6927
|
}
|
|
6672
6928
|
/**
|
|
6673
|
-
*
|
|
6929
|
+
* The trigger `link` is reserved for the built-in `/link` command, which links players to their accounts, and is refused. A command that already has it can still be edited. Required permissions: `MANAGE_MODULES`<br> OperationId: `CommandControllerUpdate`
|
|
6674
6930
|
* @summary Update
|
|
6675
6931
|
* @param {string} id
|
|
6676
6932
|
* @param {CommandUpdateDTO} [commandUpdateDTO] CommandUpdateDTO
|
|
@@ -9892,7 +10148,7 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
9892
10148
|
};
|
|
9893
10149
|
},
|
|
9894
10150
|
/**
|
|
9895
|
-
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid
|
|
10151
|
+
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetDimensionMapTile`
|
|
9896
10152
|
* @summary Get dimension map tile
|
|
9897
10153
|
* @param {string} id
|
|
9898
10154
|
* @param {string} dimension
|
|
@@ -9944,6 +10200,42 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
9944
10200
|
options: localVarRequestOptions,
|
|
9945
10201
|
};
|
|
9946
10202
|
},
|
|
10203
|
+
/**
|
|
10204
|
+
* The game\'s icon from its Game Profile as a 128x128 WEBP image. 404 when the game server has no icon. When the optional query parameter v equals the stored revision (iconRevision on the game server) the response is cacheable for a day (immutable), otherwise for a minute.<br> OperationId: `GameServerControllerGetGameIcon`
|
|
10205
|
+
* @summary Get game icon
|
|
10206
|
+
* @param {string} id
|
|
10207
|
+
* @param {string} [v]
|
|
10208
|
+
* @param {*} [options] Override http request option.
|
|
10209
|
+
* @throws {RequiredError}
|
|
10210
|
+
*/
|
|
10211
|
+
gameServerControllerGetGameIcon: async (id, v, options = {}) => {
|
|
10212
|
+
// verify required parameter 'id' is not null or undefined
|
|
10213
|
+
assertParamExists('gameServerControllerGetGameIcon', 'id', id);
|
|
10214
|
+
const localVarPath = `/gameserver/{id}/icon`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
10215
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10216
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10217
|
+
let baseOptions;
|
|
10218
|
+
if (configuration) {
|
|
10219
|
+
baseOptions = configuration.baseOptions;
|
|
10220
|
+
}
|
|
10221
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
10222
|
+
const localVarHeaderParameter = {};
|
|
10223
|
+
const localVarQueryParameter = {};
|
|
10224
|
+
// authentication bearerAuth required
|
|
10225
|
+
// http bearer authentication required
|
|
10226
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
10227
|
+
// authentication domainAuth required
|
|
10228
|
+
if (v !== undefined) {
|
|
10229
|
+
localVarQueryParameter['v'] = v;
|
|
10230
|
+
}
|
|
10231
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10232
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10233
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
10234
|
+
return {
|
|
10235
|
+
url: toPathString(localVarUrlObj),
|
|
10236
|
+
options: localVarRequestOptions,
|
|
10237
|
+
};
|
|
10238
|
+
},
|
|
9947
10239
|
/**
|
|
9948
10240
|
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
9949
10241
|
* @summary Get import
|
|
@@ -10015,7 +10307,7 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
10015
10307
|
};
|
|
10016
10308
|
},
|
|
10017
10309
|
/**
|
|
10018
|
-
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes
|
|
10310
|
+
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMap`
|
|
10019
10311
|
* @summary Get map
|
|
10020
10312
|
* @param {string} id
|
|
10021
10313
|
* @param {*} [options] Override http request option.
|
|
@@ -10047,7 +10339,7 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
10047
10339
|
};
|
|
10048
10340
|
},
|
|
10049
10341
|
/**
|
|
10050
|
-
* Get map metadata
|
|
10342
|
+
* Get map metadata Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapInfo`
|
|
10051
10343
|
* @summary Get map info
|
|
10052
10344
|
* @param {string} id
|
|
10053
10345
|
* @param {*} [options] Override http request option.
|
|
@@ -10079,7 +10371,39 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
10079
10371
|
};
|
|
10080
10372
|
},
|
|
10081
10373
|
/**
|
|
10082
|
-
*
|
|
10374
|
+
* Offline players of a game server at their last known Position, newest first, limited to the Domain\'s retention window and to 1000 players. Positions are raw game coordinates. Required permissions: `READ_MAP`, `READ_PLAYERS`<br> OperationId: `GameServerControllerGetMapOfflinePlayers`
|
|
10375
|
+
* @summary Get map offline players
|
|
10376
|
+
* @param {string} id
|
|
10377
|
+
* @param {*} [options] Override http request option.
|
|
10378
|
+
* @throws {RequiredError}
|
|
10379
|
+
*/
|
|
10380
|
+
gameServerControllerGetMapOfflinePlayers: async (id, options = {}) => {
|
|
10381
|
+
// verify required parameter 'id' is not null or undefined
|
|
10382
|
+
assertParamExists('gameServerControllerGetMapOfflinePlayers', 'id', id);
|
|
10383
|
+
const localVarPath = `/gameserver/{id}/map/offline-players`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
10384
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10385
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10386
|
+
let baseOptions;
|
|
10387
|
+
if (configuration) {
|
|
10388
|
+
baseOptions = configuration.baseOptions;
|
|
10389
|
+
}
|
|
10390
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
10391
|
+
const localVarHeaderParameter = {};
|
|
10392
|
+
const localVarQueryParameter = {};
|
|
10393
|
+
// authentication bearerAuth required
|
|
10394
|
+
// http bearer authentication required
|
|
10395
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
10396
|
+
// authentication domainAuth required
|
|
10397
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10398
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10399
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
10400
|
+
return {
|
|
10401
|
+
url: toPathString(localVarUrlObj),
|
|
10402
|
+
options: localVarRequestOptions,
|
|
10403
|
+
};
|
|
10404
|
+
},
|
|
10405
|
+
/**
|
|
10406
|
+
* Get a map tile Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapTile`
|
|
10083
10407
|
* @summary Get map tile
|
|
10084
10408
|
* @param {string} id
|
|
10085
10409
|
* @param {string} x
|
|
@@ -10400,10 +10724,11 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
10400
10724
|
};
|
|
10401
10725
|
},
|
|
10402
10726
|
/**
|
|
10403
|
-
*
|
|
10727
|
+
* Deprecated: use `POST /location/search`, which reads the stored Locations and works while the server is offline. This asks the game live and requires the game server to be online and to declare `locations.list`; otherwise fails with GameProtocolError `unsupported`. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerListLocations`
|
|
10404
10728
|
* @summary List locations
|
|
10405
10729
|
* @param {string} id
|
|
10406
10730
|
* @param {*} [options] Override http request option.
|
|
10731
|
+
* @deprecated
|
|
10407
10732
|
* @throws {RequiredError}
|
|
10408
10733
|
*/
|
|
10409
10734
|
gameServerControllerListLocations: async (id, options = {}) => {
|
|
@@ -10468,6 +10793,41 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
10468
10793
|
options: localVarRequestOptions,
|
|
10469
10794
|
};
|
|
10470
10795
|
},
|
|
10796
|
+
/**
|
|
10797
|
+
* Records what a connector-based game server reported when it identified: its Capability Manifest, game, connector and protocol version, and its name while the name follows the connector. Emits gameserver-version-changed when the connector, protocol version, game or game version changed, otherwise gameserver-updated when the name or Game Profile changed. Written by the connector; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRecordIdentify`
|
|
10798
|
+
* @summary Record identify
|
|
10799
|
+
* @param {string} id
|
|
10800
|
+
* @param {GameServerIdentifyInputDTO} [gameServerIdentifyInputDTO] GameServerIdentifyInputDTO
|
|
10801
|
+
* @param {*} [options] Override http request option.
|
|
10802
|
+
* @throws {RequiredError}
|
|
10803
|
+
*/
|
|
10804
|
+
gameServerControllerRecordIdentify: async (id, gameServerIdentifyInputDTO, options = {}) => {
|
|
10805
|
+
// verify required parameter 'id' is not null or undefined
|
|
10806
|
+
assertParamExists('gameServerControllerRecordIdentify', 'id', id);
|
|
10807
|
+
const localVarPath = `/gameserver/{id}/identify`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
10808
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10809
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10810
|
+
let baseOptions;
|
|
10811
|
+
if (configuration) {
|
|
10812
|
+
baseOptions = configuration.baseOptions;
|
|
10813
|
+
}
|
|
10814
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
10815
|
+
const localVarHeaderParameter = {};
|
|
10816
|
+
const localVarQueryParameter = {};
|
|
10817
|
+
// authentication bearerAuth required
|
|
10818
|
+
// http bearer authentication required
|
|
10819
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
10820
|
+
// authentication domainAuth required
|
|
10821
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10822
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10823
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10824
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
10825
|
+
localVarRequestOptions.data = serializeDataIfNeeded(gameServerIdentifyInputDTO, localVarRequestOptions, configuration);
|
|
10826
|
+
return {
|
|
10827
|
+
url: toPathString(localVarUrlObj),
|
|
10828
|
+
options: localVarRequestOptions,
|
|
10829
|
+
};
|
|
10830
|
+
},
|
|
10471
10831
|
/**
|
|
10472
10832
|
* Regenerate the registration token for a gameserver. Careful, this will invalidate all existing connections. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRegenerateRegistrationToken`
|
|
10473
10833
|
* @summary Regenerate registration token
|
|
@@ -10732,41 +11092,6 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
10732
11092
|
options: localVarRequestOptions,
|
|
10733
11093
|
};
|
|
10734
11094
|
},
|
|
10735
|
-
/**
|
|
10736
|
-
* Records the game a connector-based game server reported at identify (e.g. \"7d2d\"). Written by the connector on handshake; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetGame`
|
|
10737
|
-
* @summary Set game
|
|
10738
|
-
* @param {string} id
|
|
10739
|
-
* @param {GameServerGameInputDTO} [gameServerGameInputDTO] GameServerGameInputDTO
|
|
10740
|
-
* @param {*} [options] Override http request option.
|
|
10741
|
-
* @throws {RequiredError}
|
|
10742
|
-
*/
|
|
10743
|
-
gameServerControllerSetGame: async (id, gameServerGameInputDTO, options = {}) => {
|
|
10744
|
-
// verify required parameter 'id' is not null or undefined
|
|
10745
|
-
assertParamExists('gameServerControllerSetGame', 'id', id);
|
|
10746
|
-
const localVarPath = `/gameserver/{id}/game`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
10747
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10748
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10749
|
-
let baseOptions;
|
|
10750
|
-
if (configuration) {
|
|
10751
|
-
baseOptions = configuration.baseOptions;
|
|
10752
|
-
}
|
|
10753
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
10754
|
-
const localVarHeaderParameter = {};
|
|
10755
|
-
const localVarQueryParameter = {};
|
|
10756
|
-
// authentication bearerAuth required
|
|
10757
|
-
// http bearer authentication required
|
|
10758
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
10759
|
-
// authentication domainAuth required
|
|
10760
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10761
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10762
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10763
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
10764
|
-
localVarRequestOptions.data = serializeDataIfNeeded(gameServerGameInputDTO, localVarRequestOptions, configuration);
|
|
10765
|
-
return {
|
|
10766
|
-
url: toPathString(localVarUrlObj),
|
|
10767
|
-
options: localVarRequestOptions,
|
|
10768
|
-
};
|
|
10769
|
-
},
|
|
10770
11095
|
/**
|
|
10771
11096
|
* Shuts down the gameserver. This is a \'soft\' shutdown, meaning the gameserver will be stopped gracefully. If the gameserver is not reachable, this will have no effect. Note that most hosting providers will automatically restart the gameserver after a shutdown, which makes this operation act as a \'restart\' instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerShutdown`
|
|
10772
11097
|
* @summary Shutdown
|
|
@@ -11193,7 +11518,7 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11193
11518
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11194
11519
|
},
|
|
11195
11520
|
/**
|
|
11196
|
-
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid
|
|
11521
|
+
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetDimensionMapTile`
|
|
11197
11522
|
* @summary Get dimension map tile
|
|
11198
11523
|
* @param {string} id
|
|
11199
11524
|
* @param {string} dimension
|
|
@@ -11211,6 +11536,20 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11211
11536
|
?.url;
|
|
11212
11537
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11213
11538
|
},
|
|
11539
|
+
/**
|
|
11540
|
+
* The game\'s icon from its Game Profile as a 128x128 WEBP image. 404 when the game server has no icon. When the optional query parameter v equals the stored revision (iconRevision on the game server) the response is cacheable for a day (immutable), otherwise for a minute.<br> OperationId: `GameServerControllerGetGameIcon`
|
|
11541
|
+
* @summary Get game icon
|
|
11542
|
+
* @param {string} id
|
|
11543
|
+
* @param {string} [v]
|
|
11544
|
+
* @param {*} [options] Override http request option.
|
|
11545
|
+
* @throws {RequiredError}
|
|
11546
|
+
*/
|
|
11547
|
+
async gameServerControllerGetGameIcon(id, v, options) {
|
|
11548
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.gameServerControllerGetGameIcon(id, v, options);
|
|
11549
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11550
|
+
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerGetGameIcon']?.[localVarOperationServerIndex]?.url;
|
|
11551
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11552
|
+
},
|
|
11214
11553
|
/**
|
|
11215
11554
|
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
11216
11555
|
* @summary Get import
|
|
@@ -11240,7 +11579,7 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11240
11579
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11241
11580
|
},
|
|
11242
11581
|
/**
|
|
11243
|
-
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes
|
|
11582
|
+
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMap`
|
|
11244
11583
|
* @summary Get map
|
|
11245
11584
|
* @param {string} id
|
|
11246
11585
|
* @param {*} [options] Override http request option.
|
|
@@ -11253,7 +11592,7 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11253
11592
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11254
11593
|
},
|
|
11255
11594
|
/**
|
|
11256
|
-
* Get map metadata
|
|
11595
|
+
* Get map metadata Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapInfo`
|
|
11257
11596
|
* @summary Get map info
|
|
11258
11597
|
* @param {string} id
|
|
11259
11598
|
* @param {*} [options] Override http request option.
|
|
@@ -11266,7 +11605,21 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11266
11605
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11267
11606
|
},
|
|
11268
11607
|
/**
|
|
11269
|
-
*
|
|
11608
|
+
* Offline players of a game server at their last known Position, newest first, limited to the Domain\'s retention window and to 1000 players. Positions are raw game coordinates. Required permissions: `READ_MAP`, `READ_PLAYERS`<br> OperationId: `GameServerControllerGetMapOfflinePlayers`
|
|
11609
|
+
* @summary Get map offline players
|
|
11610
|
+
* @param {string} id
|
|
11611
|
+
* @param {*} [options] Override http request option.
|
|
11612
|
+
* @throws {RequiredError}
|
|
11613
|
+
*/
|
|
11614
|
+
async gameServerControllerGetMapOfflinePlayers(id, options) {
|
|
11615
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.gameServerControllerGetMapOfflinePlayers(id, options);
|
|
11616
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11617
|
+
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerGetMapOfflinePlayers']?.[localVarOperationServerIndex]
|
|
11618
|
+
?.url;
|
|
11619
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11620
|
+
},
|
|
11621
|
+
/**
|
|
11622
|
+
* Get a map tile Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapTile`
|
|
11270
11623
|
* @summary Get map tile
|
|
11271
11624
|
* @param {string} id
|
|
11272
11625
|
* @param {string} x
|
|
@@ -11392,10 +11745,11 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11392
11745
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11393
11746
|
},
|
|
11394
11747
|
/**
|
|
11395
|
-
*
|
|
11748
|
+
* Deprecated: use `POST /location/search`, which reads the stored Locations and works while the server is offline. This asks the game live and requires the game server to be online and to declare `locations.list`; otherwise fails with GameProtocolError `unsupported`. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerListLocations`
|
|
11396
11749
|
* @summary List locations
|
|
11397
11750
|
* @param {string} id
|
|
11398
11751
|
* @param {*} [options] Override http request option.
|
|
11752
|
+
* @deprecated
|
|
11399
11753
|
* @throws {RequiredError}
|
|
11400
11754
|
*/
|
|
11401
11755
|
async gameServerControllerListLocations(id, options) {
|
|
@@ -11418,6 +11772,20 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11418
11772
|
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerPutMapUpload']?.[localVarOperationServerIndex]?.url;
|
|
11419
11773
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11420
11774
|
},
|
|
11775
|
+
/**
|
|
11776
|
+
* Records what a connector-based game server reported when it identified: its Capability Manifest, game, connector and protocol version, and its name while the name follows the connector. Emits gameserver-version-changed when the connector, protocol version, game or game version changed, otherwise gameserver-updated when the name or Game Profile changed. Written by the connector; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRecordIdentify`
|
|
11777
|
+
* @summary Record identify
|
|
11778
|
+
* @param {string} id
|
|
11779
|
+
* @param {GameServerIdentifyInputDTO} [gameServerIdentifyInputDTO] GameServerIdentifyInputDTO
|
|
11780
|
+
* @param {*} [options] Override http request option.
|
|
11781
|
+
* @throws {RequiredError}
|
|
11782
|
+
*/
|
|
11783
|
+
async gameServerControllerRecordIdentify(id, gameServerIdentifyInputDTO, options) {
|
|
11784
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.gameServerControllerRecordIdentify(id, gameServerIdentifyInputDTO, options);
|
|
11785
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11786
|
+
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerRecordIdentify']?.[localVarOperationServerIndex]?.url;
|
|
11787
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11788
|
+
},
|
|
11421
11789
|
/**
|
|
11422
11790
|
* Regenerate the registration token for a gameserver. Careful, this will invalidate all existing connections. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRegenerateRegistrationToken`
|
|
11423
11791
|
* @summary Regenerate registration token
|
|
@@ -11525,20 +11893,6 @@ export const GameServerApiFp = function (configuration) {
|
|
|
11525
11893
|
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerSetCapabilities']?.[localVarOperationServerIndex]?.url;
|
|
11526
11894
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11527
11895
|
},
|
|
11528
|
-
/**
|
|
11529
|
-
* Records the game a connector-based game server reported at identify (e.g. \"7d2d\"). Written by the connector on handshake; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetGame`
|
|
11530
|
-
* @summary Set game
|
|
11531
|
-
* @param {string} id
|
|
11532
|
-
* @param {GameServerGameInputDTO} [gameServerGameInputDTO] GameServerGameInputDTO
|
|
11533
|
-
* @param {*} [options] Override http request option.
|
|
11534
|
-
* @throws {RequiredError}
|
|
11535
|
-
*/
|
|
11536
|
-
async gameServerControllerSetGame(id, gameServerGameInputDTO, options) {
|
|
11537
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.gameServerControllerSetGame(id, gameServerGameInputDTO, options);
|
|
11538
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11539
|
-
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerSetGame']?.[localVarOperationServerIndex]?.url;
|
|
11540
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
11541
|
-
},
|
|
11542
11896
|
/**
|
|
11543
11897
|
* Shuts down the gameserver. This is a \'soft\' shutdown, meaning the gameserver will be stopped gracefully. If the gameserver is not reachable, this will have no effect. Note that most hosting providers will automatically restart the gameserver after a shutdown, which makes this operation act as a \'restart\' instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerShutdown`
|
|
11544
11898
|
* @summary Shutdown
|
|
@@ -11762,7 +12116,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
11762
12116
|
return localVarFp.gameServerControllerGetCapabilities(id, options).then((request) => request(axios, basePath));
|
|
11763
12117
|
},
|
|
11764
12118
|
/**
|
|
11765
|
-
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid
|
|
12119
|
+
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetDimensionMapTile`
|
|
11766
12120
|
* @summary Get dimension map tile
|
|
11767
12121
|
* @param {string} id
|
|
11768
12122
|
* @param {string} dimension
|
|
@@ -11778,6 +12132,17 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
11778
12132
|
.gameServerControllerGetDimensionMapTile(id, dimension, zoom, x, y, v, options)
|
|
11779
12133
|
.then((request) => request(axios, basePath));
|
|
11780
12134
|
},
|
|
12135
|
+
/**
|
|
12136
|
+
* The game\'s icon from its Game Profile as a 128x128 WEBP image. 404 when the game server has no icon. When the optional query parameter v equals the stored revision (iconRevision on the game server) the response is cacheable for a day (immutable), otherwise for a minute.<br> OperationId: `GameServerControllerGetGameIcon`
|
|
12137
|
+
* @summary Get game icon
|
|
12138
|
+
* @param {string} id
|
|
12139
|
+
* @param {string} [v]
|
|
12140
|
+
* @param {*} [options] Override http request option.
|
|
12141
|
+
* @throws {RequiredError}
|
|
12142
|
+
*/
|
|
12143
|
+
gameServerControllerGetGameIcon(id, v, options) {
|
|
12144
|
+
return localVarFp.gameServerControllerGetGameIcon(id, v, options).then((request) => request(axios, basePath));
|
|
12145
|
+
},
|
|
11781
12146
|
/**
|
|
11782
12147
|
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
11783
12148
|
* @summary Get import
|
|
@@ -11801,7 +12166,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
11801
12166
|
return localVarFp.gameServerControllerGetJob(type, id, options).then((request) => request(axios, basePath));
|
|
11802
12167
|
},
|
|
11803
12168
|
/**
|
|
11804
|
-
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes
|
|
12169
|
+
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMap`
|
|
11805
12170
|
* @summary Get map
|
|
11806
12171
|
* @param {string} id
|
|
11807
12172
|
* @param {*} [options] Override http request option.
|
|
@@ -11811,7 +12176,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
11811
12176
|
return localVarFp.gameServerControllerGetMap(id, options).then((request) => request(axios, basePath));
|
|
11812
12177
|
},
|
|
11813
12178
|
/**
|
|
11814
|
-
* Get map metadata
|
|
12179
|
+
* Get map metadata Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapInfo`
|
|
11815
12180
|
* @summary Get map info
|
|
11816
12181
|
* @param {string} id
|
|
11817
12182
|
* @param {*} [options] Override http request option.
|
|
@@ -11821,7 +12186,19 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
11821
12186
|
return localVarFp.gameServerControllerGetMapInfo(id, options).then((request) => request(axios, basePath));
|
|
11822
12187
|
},
|
|
11823
12188
|
/**
|
|
11824
|
-
*
|
|
12189
|
+
* Offline players of a game server at their last known Position, newest first, limited to the Domain\'s retention window and to 1000 players. Positions are raw game coordinates. Required permissions: `READ_MAP`, `READ_PLAYERS`<br> OperationId: `GameServerControllerGetMapOfflinePlayers`
|
|
12190
|
+
* @summary Get map offline players
|
|
12191
|
+
* @param {string} id
|
|
12192
|
+
* @param {*} [options] Override http request option.
|
|
12193
|
+
* @throws {RequiredError}
|
|
12194
|
+
*/
|
|
12195
|
+
gameServerControllerGetMapOfflinePlayers(id, options) {
|
|
12196
|
+
return localVarFp
|
|
12197
|
+
.gameServerControllerGetMapOfflinePlayers(id, options)
|
|
12198
|
+
.then((request) => request(axios, basePath));
|
|
12199
|
+
},
|
|
12200
|
+
/**
|
|
12201
|
+
* Get a map tile Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapTile`
|
|
11825
12202
|
* @summary Get map tile
|
|
11826
12203
|
* @param {string} id
|
|
11827
12204
|
* @param {string} x
|
|
@@ -11928,10 +12305,11 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
11928
12305
|
return localVarFp.gameServerControllerListBans(id, options).then((request) => request(axios, basePath));
|
|
11929
12306
|
},
|
|
11930
12307
|
/**
|
|
11931
|
-
*
|
|
12308
|
+
* Deprecated: use `POST /location/search`, which reads the stored Locations and works while the server is offline. This asks the game live and requires the game server to be online and to declare `locations.list`; otherwise fails with GameProtocolError `unsupported`. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerListLocations`
|
|
11932
12309
|
* @summary List locations
|
|
11933
12310
|
* @param {string} id
|
|
11934
12311
|
* @param {*} [options] Override http request option.
|
|
12312
|
+
* @deprecated
|
|
11935
12313
|
* @throws {RequiredError}
|
|
11936
12314
|
*/
|
|
11937
12315
|
gameServerControllerListLocations(id, options) {
|
|
@@ -11950,6 +12328,19 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
11950
12328
|
.gameServerControllerPutMapUpload(id, dimension, options)
|
|
11951
12329
|
.then((request) => request(axios, basePath));
|
|
11952
12330
|
},
|
|
12331
|
+
/**
|
|
12332
|
+
* Records what a connector-based game server reported when it identified: its Capability Manifest, game, connector and protocol version, and its name while the name follows the connector. Emits gameserver-version-changed when the connector, protocol version, game or game version changed, otherwise gameserver-updated when the name or Game Profile changed. Written by the connector; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRecordIdentify`
|
|
12333
|
+
* @summary Record identify
|
|
12334
|
+
* @param {string} id
|
|
12335
|
+
* @param {GameServerIdentifyInputDTO} [gameServerIdentifyInputDTO] GameServerIdentifyInputDTO
|
|
12336
|
+
* @param {*} [options] Override http request option.
|
|
12337
|
+
* @throws {RequiredError}
|
|
12338
|
+
*/
|
|
12339
|
+
gameServerControllerRecordIdentify(id, gameServerIdentifyInputDTO, options) {
|
|
12340
|
+
return localVarFp
|
|
12341
|
+
.gameServerControllerRecordIdentify(id, gameServerIdentifyInputDTO, options)
|
|
12342
|
+
.then((request) => request(axios, basePath));
|
|
12343
|
+
},
|
|
11953
12344
|
/**
|
|
11954
12345
|
* Regenerate the registration token for a gameserver. Careful, this will invalidate all existing connections. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRegenerateRegistrationToken`
|
|
11955
12346
|
* @summary Regenerate registration token
|
|
@@ -12044,19 +12435,6 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
12044
12435
|
.gameServerControllerSetCapabilities(id, gameServerCapabilitiesInputDTO, options)
|
|
12045
12436
|
.then((request) => request(axios, basePath));
|
|
12046
12437
|
},
|
|
12047
|
-
/**
|
|
12048
|
-
* Records the game a connector-based game server reported at identify (e.g. \"7d2d\"). Written by the connector on handshake; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetGame`
|
|
12049
|
-
* @summary Set game
|
|
12050
|
-
* @param {string} id
|
|
12051
|
-
* @param {GameServerGameInputDTO} [gameServerGameInputDTO] GameServerGameInputDTO
|
|
12052
|
-
* @param {*} [options] Override http request option.
|
|
12053
|
-
* @throws {RequiredError}
|
|
12054
|
-
*/
|
|
12055
|
-
gameServerControllerSetGame(id, gameServerGameInputDTO, options) {
|
|
12056
|
-
return localVarFp
|
|
12057
|
-
.gameServerControllerSetGame(id, gameServerGameInputDTO, options)
|
|
12058
|
-
.then((request) => request(axios, basePath));
|
|
12059
|
-
},
|
|
12060
12438
|
/**
|
|
12061
12439
|
* Shuts down the gameserver. This is a \'soft\' shutdown, meaning the gameserver will be stopped gracefully. If the gameserver is not reachable, this will have no effect. Note that most hosting providers will automatically restart the gameserver after a shutdown, which makes this operation act as a \'restart\' instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerShutdown`
|
|
12062
12440
|
* @summary Shutdown
|
|
@@ -12274,7 +12652,7 @@ export class GameServerApi extends BaseAPI {
|
|
|
12274
12652
|
.then((request) => request(this.axios, this.basePath));
|
|
12275
12653
|
}
|
|
12276
12654
|
/**
|
|
12277
|
-
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid
|
|
12655
|
+
* A map tile of one Dimension in the standard (zoom, x, y) layout, zoom 0 covering the Dimension\'s bounds. Returns the image bytes with their MIME type. A tile the game has not rendered yet is returned as a transparent image with header X-Takaro-Map-Tile: empty. Tiles of a tiled source are cached for a few minutes. Source precedence: the operator\'s uploaded image, then the game\'s tiled source, then the game\'s image; a source that is not built yet is skipped. The response header X-Takaro-Map-Source says which one answered (upload, tiled or image). An upload or image source is served from the tile pyramid Takaro cut: the response carries X-Takaro-Map-Revision, and when the optional query parameter v equals that revision the tile is cacheable for a day (immutable), otherwise for a minute. A v that names a stored pyramid of this Dimension pins that pyramid. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetDimensionMapTile`
|
|
12278
12656
|
* @summary Get dimension map tile
|
|
12279
12657
|
* @param {string} id
|
|
12280
12658
|
* @param {string} dimension
|
|
@@ -12291,6 +12669,20 @@ export class GameServerApi extends BaseAPI {
|
|
|
12291
12669
|
.gameServerControllerGetDimensionMapTile(id, dimension, zoom, x, y, v, options)
|
|
12292
12670
|
.then((request) => request(this.axios, this.basePath));
|
|
12293
12671
|
}
|
|
12672
|
+
/**
|
|
12673
|
+
* The game\'s icon from its Game Profile as a 128x128 WEBP image. 404 when the game server has no icon. When the optional query parameter v equals the stored revision (iconRevision on the game server) the response is cacheable for a day (immutable), otherwise for a minute.<br> OperationId: `GameServerControllerGetGameIcon`
|
|
12674
|
+
* @summary Get game icon
|
|
12675
|
+
* @param {string} id
|
|
12676
|
+
* @param {string} [v]
|
|
12677
|
+
* @param {*} [options] Override http request option.
|
|
12678
|
+
* @throws {RequiredError}
|
|
12679
|
+
* @memberof GameServerApi
|
|
12680
|
+
*/
|
|
12681
|
+
gameServerControllerGetGameIcon(id, v, options) {
|
|
12682
|
+
return GameServerApiFp(this.configuration)
|
|
12683
|
+
.gameServerControllerGetGameIcon(id, v, options)
|
|
12684
|
+
.then((request) => request(this.axios, this.basePath));
|
|
12685
|
+
}
|
|
12294
12686
|
/**
|
|
12295
12687
|
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
12296
12688
|
* @summary Get import
|
|
@@ -12320,7 +12712,7 @@ export class GameServerApi extends BaseAPI {
|
|
|
12320
12712
|
.then((request) => request(this.axios, this.basePath));
|
|
12321
12713
|
}
|
|
12322
12714
|
/**
|
|
12323
|
-
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes
|
|
12715
|
+
* The effective map of a game server: the Dimensions its `map` Capability declares, in declared order (the first is the default), followed by the Dimensions an operator defined by uploading a map image. `supported` is true when there is at least one Dimension; `declared` is true when the game itself declares a map. An operator\'s upload takes precedence over the game\'s map source. Positions are raw game coordinates; clients convert them with each Dimension\'s axes. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMap`
|
|
12324
12716
|
* @summary Get map
|
|
12325
12717
|
* @param {string} id
|
|
12326
12718
|
* @param {*} [options] Override http request option.
|
|
@@ -12333,7 +12725,7 @@ export class GameServerApi extends BaseAPI {
|
|
|
12333
12725
|
.then((request) => request(this.axios, this.basePath));
|
|
12334
12726
|
}
|
|
12335
12727
|
/**
|
|
12336
|
-
* Get map metadata
|
|
12728
|
+
* Get map metadata Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapInfo`
|
|
12337
12729
|
* @summary Get map info
|
|
12338
12730
|
* @param {string} id
|
|
12339
12731
|
* @param {*} [options] Override http request option.
|
|
@@ -12346,7 +12738,20 @@ export class GameServerApi extends BaseAPI {
|
|
|
12346
12738
|
.then((request) => request(this.axios, this.basePath));
|
|
12347
12739
|
}
|
|
12348
12740
|
/**
|
|
12349
|
-
*
|
|
12741
|
+
* Offline players of a game server at their last known Position, newest first, limited to the Domain\'s retention window and to 1000 players. Positions are raw game coordinates. Required permissions: `READ_MAP`, `READ_PLAYERS`<br> OperationId: `GameServerControllerGetMapOfflinePlayers`
|
|
12742
|
+
* @summary Get map offline players
|
|
12743
|
+
* @param {string} id
|
|
12744
|
+
* @param {*} [options] Override http request option.
|
|
12745
|
+
* @throws {RequiredError}
|
|
12746
|
+
* @memberof GameServerApi
|
|
12747
|
+
*/
|
|
12748
|
+
gameServerControllerGetMapOfflinePlayers(id, options) {
|
|
12749
|
+
return GameServerApiFp(this.configuration)
|
|
12750
|
+
.gameServerControllerGetMapOfflinePlayers(id, options)
|
|
12751
|
+
.then((request) => request(this.axios, this.basePath));
|
|
12752
|
+
}
|
|
12753
|
+
/**
|
|
12754
|
+
* Get a map tile Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerGetMapTile`
|
|
12350
12755
|
* @summary Get map tile
|
|
12351
12756
|
* @param {string} id
|
|
12352
12757
|
* @param {string} x
|
|
@@ -12472,10 +12877,11 @@ export class GameServerApi extends BaseAPI {
|
|
|
12472
12877
|
.then((request) => request(this.axios, this.basePath));
|
|
12473
12878
|
}
|
|
12474
12879
|
/**
|
|
12475
|
-
*
|
|
12880
|
+
* Deprecated: use `POST /location/search`, which reads the stored Locations and works while the server is offline. This asks the game live and requires the game server to be online and to declare `locations.list`; otherwise fails with GameProtocolError `unsupported`. Required permissions: `READ_MAP`<br> OperationId: `GameServerControllerListLocations`
|
|
12476
12881
|
* @summary List locations
|
|
12477
12882
|
* @param {string} id
|
|
12478
12883
|
* @param {*} [options] Override http request option.
|
|
12884
|
+
* @deprecated
|
|
12479
12885
|
* @throws {RequiredError}
|
|
12480
12886
|
* @memberof GameServerApi
|
|
12481
12887
|
*/
|
|
@@ -12499,15 +12905,29 @@ export class GameServerApi extends BaseAPI {
|
|
|
12499
12905
|
.then((request) => request(this.axios, this.basePath));
|
|
12500
12906
|
}
|
|
12501
12907
|
/**
|
|
12502
|
-
*
|
|
12503
|
-
* @summary
|
|
12908
|
+
* Records what a connector-based game server reported when it identified: its Capability Manifest, game, connector and protocol version, and its name while the name follows the connector. Emits gameserver-version-changed when the connector, protocol version, game or game version changed, otherwise gameserver-updated when the name or Game Profile changed. Written by the connector; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRecordIdentify`
|
|
12909
|
+
* @summary Record identify
|
|
12910
|
+
* @param {string} id
|
|
12911
|
+
* @param {GameServerIdentifyInputDTO} [gameServerIdentifyInputDTO] GameServerIdentifyInputDTO
|
|
12504
12912
|
* @param {*} [options] Override http request option.
|
|
12505
12913
|
* @throws {RequiredError}
|
|
12506
12914
|
* @memberof GameServerApi
|
|
12507
12915
|
*/
|
|
12508
|
-
|
|
12916
|
+
gameServerControllerRecordIdentify(id, gameServerIdentifyInputDTO, options) {
|
|
12509
12917
|
return GameServerApiFp(this.configuration)
|
|
12510
|
-
.
|
|
12918
|
+
.gameServerControllerRecordIdentify(id, gameServerIdentifyInputDTO, options)
|
|
12919
|
+
.then((request) => request(this.axios, this.basePath));
|
|
12920
|
+
}
|
|
12921
|
+
/**
|
|
12922
|
+
* Regenerate the registration token for a gameserver. Careful, this will invalidate all existing connections. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerRegenerateRegistrationToken`
|
|
12923
|
+
* @summary Regenerate registration token
|
|
12924
|
+
* @param {*} [options] Override http request option.
|
|
12925
|
+
* @throws {RequiredError}
|
|
12926
|
+
* @memberof GameServerApi
|
|
12927
|
+
*/
|
|
12928
|
+
gameServerControllerRegenerateRegistrationToken(options) {
|
|
12929
|
+
return GameServerApiFp(this.configuration)
|
|
12930
|
+
.gameServerControllerRegenerateRegistrationToken(options)
|
|
12511
12931
|
.then((request) => request(this.axios, this.basePath));
|
|
12512
12932
|
}
|
|
12513
12933
|
/**
|
|
@@ -12604,20 +13024,6 @@ export class GameServerApi extends BaseAPI {
|
|
|
12604
13024
|
.gameServerControllerSetCapabilities(id, gameServerCapabilitiesInputDTO, options)
|
|
12605
13025
|
.then((request) => request(this.axios, this.basePath));
|
|
12606
13026
|
}
|
|
12607
|
-
/**
|
|
12608
|
-
* Records the game a connector-based game server reported at identify (e.g. \"7d2d\"). Written by the connector on handshake; users normally never call it. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetGame`
|
|
12609
|
-
* @summary Set game
|
|
12610
|
-
* @param {string} id
|
|
12611
|
-
* @param {GameServerGameInputDTO} [gameServerGameInputDTO] GameServerGameInputDTO
|
|
12612
|
-
* @param {*} [options] Override http request option.
|
|
12613
|
-
* @throws {RequiredError}
|
|
12614
|
-
* @memberof GameServerApi
|
|
12615
|
-
*/
|
|
12616
|
-
gameServerControllerSetGame(id, gameServerGameInputDTO, options) {
|
|
12617
|
-
return GameServerApiFp(this.configuration)
|
|
12618
|
-
.gameServerControllerSetGame(id, gameServerGameInputDTO, options)
|
|
12619
|
-
.then((request) => request(this.axios, this.basePath));
|
|
12620
|
-
}
|
|
12621
13027
|
/**
|
|
12622
13028
|
* Shuts down the gameserver. This is a \'soft\' shutdown, meaning the gameserver will be stopped gracefully. If the gameserver is not reachable, this will have no effect. Note that most hosting providers will automatically restart the gameserver after a shutdown, which makes this operation act as a \'restart\' instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerShutdown`
|
|
12623
13029
|
* @summary Shutdown
|
|
@@ -14285,6 +14691,110 @@ export class ItemSetApi extends BaseAPI {
|
|
|
14285
14691
|
.then((request) => request(this.axios, this.basePath));
|
|
14286
14692
|
}
|
|
14287
14693
|
}
|
|
14694
|
+
/**
|
|
14695
|
+
* LocationApi - axios parameter creator
|
|
14696
|
+
* @export
|
|
14697
|
+
*/
|
|
14698
|
+
export const LocationApiAxiosParamCreator = function (configuration) {
|
|
14699
|
+
return {
|
|
14700
|
+
/**
|
|
14701
|
+
* Search the Locations stored for game servers, as the game last reported them. They stay available while the game server is offline. A Location the game reported without a Dimension is stored under the game server\'s default Dimension. Filterable by category, a free-form string the game chooses. Required permissions: `READ_MAP`<br> OperationId: `LocationControllerSearch`
|
|
14702
|
+
* @summary Search
|
|
14703
|
+
* @param {LocationSearchInputDTO} [locationSearchInputDTO] LocationSearchInputDTO
|
|
14704
|
+
* @param {*} [options] Override http request option.
|
|
14705
|
+
* @throws {RequiredError}
|
|
14706
|
+
*/
|
|
14707
|
+
locationControllerSearch: async (locationSearchInputDTO, options = {}) => {
|
|
14708
|
+
const localVarPath = `/location/search`;
|
|
14709
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14710
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14711
|
+
let baseOptions;
|
|
14712
|
+
if (configuration) {
|
|
14713
|
+
baseOptions = configuration.baseOptions;
|
|
14714
|
+
}
|
|
14715
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
14716
|
+
const localVarHeaderParameter = {};
|
|
14717
|
+
const localVarQueryParameter = {};
|
|
14718
|
+
// authentication bearerAuth required
|
|
14719
|
+
// http bearer authentication required
|
|
14720
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14721
|
+
// authentication domainAuth required
|
|
14722
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14723
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14724
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14725
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
14726
|
+
localVarRequestOptions.data = serializeDataIfNeeded(locationSearchInputDTO, localVarRequestOptions, configuration);
|
|
14727
|
+
return {
|
|
14728
|
+
url: toPathString(localVarUrlObj),
|
|
14729
|
+
options: localVarRequestOptions,
|
|
14730
|
+
};
|
|
14731
|
+
},
|
|
14732
|
+
};
|
|
14733
|
+
};
|
|
14734
|
+
/**
|
|
14735
|
+
* LocationApi - functional programming interface
|
|
14736
|
+
* @export
|
|
14737
|
+
*/
|
|
14738
|
+
export const LocationApiFp = function (configuration) {
|
|
14739
|
+
const localVarAxiosParamCreator = LocationApiAxiosParamCreator(configuration);
|
|
14740
|
+
return {
|
|
14741
|
+
/**
|
|
14742
|
+
* Search the Locations stored for game servers, as the game last reported them. They stay available while the game server is offline. A Location the game reported without a Dimension is stored under the game server\'s default Dimension. Filterable by category, a free-form string the game chooses. Required permissions: `READ_MAP`<br> OperationId: `LocationControllerSearch`
|
|
14743
|
+
* @summary Search
|
|
14744
|
+
* @param {LocationSearchInputDTO} [locationSearchInputDTO] LocationSearchInputDTO
|
|
14745
|
+
* @param {*} [options] Override http request option.
|
|
14746
|
+
* @throws {RequiredError}
|
|
14747
|
+
*/
|
|
14748
|
+
async locationControllerSearch(locationSearchInputDTO, options) {
|
|
14749
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.locationControllerSearch(locationSearchInputDTO, options);
|
|
14750
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14751
|
+
const localVarOperationServerBasePath = operationServerMap['LocationApi.locationControllerSearch']?.[localVarOperationServerIndex]?.url;
|
|
14752
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14753
|
+
},
|
|
14754
|
+
};
|
|
14755
|
+
};
|
|
14756
|
+
/**
|
|
14757
|
+
* LocationApi - factory interface
|
|
14758
|
+
* @export
|
|
14759
|
+
*/
|
|
14760
|
+
export const LocationApiFactory = function (configuration, basePath, axios) {
|
|
14761
|
+
const localVarFp = LocationApiFp(configuration);
|
|
14762
|
+
return {
|
|
14763
|
+
/**
|
|
14764
|
+
* Search the Locations stored for game servers, as the game last reported them. They stay available while the game server is offline. A Location the game reported without a Dimension is stored under the game server\'s default Dimension. Filterable by category, a free-form string the game chooses. Required permissions: `READ_MAP`<br> OperationId: `LocationControllerSearch`
|
|
14765
|
+
* @summary Search
|
|
14766
|
+
* @param {LocationSearchInputDTO} [locationSearchInputDTO] LocationSearchInputDTO
|
|
14767
|
+
* @param {*} [options] Override http request option.
|
|
14768
|
+
* @throws {RequiredError}
|
|
14769
|
+
*/
|
|
14770
|
+
locationControllerSearch(locationSearchInputDTO, options) {
|
|
14771
|
+
return localVarFp
|
|
14772
|
+
.locationControllerSearch(locationSearchInputDTO, options)
|
|
14773
|
+
.then((request) => request(axios, basePath));
|
|
14774
|
+
},
|
|
14775
|
+
};
|
|
14776
|
+
};
|
|
14777
|
+
/**
|
|
14778
|
+
* LocationApi - object-oriented interface
|
|
14779
|
+
* @export
|
|
14780
|
+
* @class LocationApi
|
|
14781
|
+
* @extends {BaseAPI}
|
|
14782
|
+
*/
|
|
14783
|
+
export class LocationApi extends BaseAPI {
|
|
14784
|
+
/**
|
|
14785
|
+
* Search the Locations stored for game servers, as the game last reported them. They stay available while the game server is offline. A Location the game reported without a Dimension is stored under the game server\'s default Dimension. Filterable by category, a free-form string the game chooses. Required permissions: `READ_MAP`<br> OperationId: `LocationControllerSearch`
|
|
14786
|
+
* @summary Search
|
|
14787
|
+
* @param {LocationSearchInputDTO} [locationSearchInputDTO] LocationSearchInputDTO
|
|
14788
|
+
* @param {*} [options] Override http request option.
|
|
14789
|
+
* @throws {RequiredError}
|
|
14790
|
+
* @memberof LocationApi
|
|
14791
|
+
*/
|
|
14792
|
+
locationControllerSearch(locationSearchInputDTO, options) {
|
|
14793
|
+
return LocationApiFp(this.configuration)
|
|
14794
|
+
.locationControllerSearch(locationSearchInputDTO, options)
|
|
14795
|
+
.then((request) => request(this.axios, this.basePath));
|
|
14796
|
+
}
|
|
14797
|
+
}
|
|
14288
14798
|
/**
|
|
14289
14799
|
* MetaApi - axios parameter creator
|
|
14290
14800
|
* @export
|
|
@@ -14804,6 +15314,41 @@ export const ModuleApiAxiosParamCreator = function (configuration) {
|
|
|
14804
15314
|
options: localVarRequestOptions,
|
|
14805
15315
|
};
|
|
14806
15316
|
},
|
|
15317
|
+
/**
|
|
15318
|
+
* Adds the tagged versions of an export to this custom module. Tags the module already has with identical content are skipped; a tag with different content refuses the whole import. The exported latest draft is ignored. Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerImportVersions`
|
|
15319
|
+
* @summary Import versions into an existing module
|
|
15320
|
+
* @param {string} id
|
|
15321
|
+
* @param {any} [body]
|
|
15322
|
+
* @param {*} [options] Override http request option.
|
|
15323
|
+
* @throws {RequiredError}
|
|
15324
|
+
*/
|
|
15325
|
+
moduleControllerImportVersions: async (id, body, options = {}) => {
|
|
15326
|
+
// verify required parameter 'id' is not null or undefined
|
|
15327
|
+
assertParamExists('moduleControllerImportVersions', 'id', id);
|
|
15328
|
+
const localVarPath = `/module/{id}/import`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
15329
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15330
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15331
|
+
let baseOptions;
|
|
15332
|
+
if (configuration) {
|
|
15333
|
+
baseOptions = configuration.baseOptions;
|
|
15334
|
+
}
|
|
15335
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
15336
|
+
const localVarHeaderParameter = {};
|
|
15337
|
+
const localVarQueryParameter = {};
|
|
15338
|
+
// authentication bearerAuth required
|
|
15339
|
+
// http bearer authentication required
|
|
15340
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
15341
|
+
// authentication domainAuth required
|
|
15342
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15343
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15344
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15345
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
15346
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
15347
|
+
return {
|
|
15348
|
+
url: toPathString(localVarUrlObj),
|
|
15349
|
+
options: localVarRequestOptions,
|
|
15350
|
+
};
|
|
15351
|
+
},
|
|
14807
15352
|
/**
|
|
14808
15353
|
* Removes a module, including all versions and config Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerRemove`
|
|
14809
15354
|
* @summary Remove a module
|
|
@@ -15199,6 +15744,20 @@ export const ModuleApiFp = function (configuration) {
|
|
|
15199
15744
|
const localVarOperationServerBasePath = operationServerMap['ModuleApi.moduleControllerImport']?.[localVarOperationServerIndex]?.url;
|
|
15200
15745
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15201
15746
|
},
|
|
15747
|
+
/**
|
|
15748
|
+
* Adds the tagged versions of an export to this custom module. Tags the module already has with identical content are skipped; a tag with different content refuses the whole import. The exported latest draft is ignored. Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerImportVersions`
|
|
15749
|
+
* @summary Import versions into an existing module
|
|
15750
|
+
* @param {string} id
|
|
15751
|
+
* @param {any} [body]
|
|
15752
|
+
* @param {*} [options] Override http request option.
|
|
15753
|
+
* @throws {RequiredError}
|
|
15754
|
+
*/
|
|
15755
|
+
async moduleControllerImportVersions(id, body, options) {
|
|
15756
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.moduleControllerImportVersions(id, body, options);
|
|
15757
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15758
|
+
const localVarOperationServerBasePath = operationServerMap['ModuleApi.moduleControllerImportVersions']?.[localVarOperationServerIndex]?.url;
|
|
15759
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15760
|
+
},
|
|
15202
15761
|
/**
|
|
15203
15762
|
* Removes a module, including all versions and config Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerRemove`
|
|
15204
15763
|
* @summary Remove a module
|
|
@@ -15386,6 +15945,17 @@ export const ModuleApiFactory = function (configuration, basePath, axios) {
|
|
|
15386
15945
|
moduleControllerImport(body, options) {
|
|
15387
15946
|
return localVarFp.moduleControllerImport(body, options).then((request) => request(axios, basePath));
|
|
15388
15947
|
},
|
|
15948
|
+
/**
|
|
15949
|
+
* Adds the tagged versions of an export to this custom module. Tags the module already has with identical content are skipped; a tag with different content refuses the whole import. The exported latest draft is ignored. Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerImportVersions`
|
|
15950
|
+
* @summary Import versions into an existing module
|
|
15951
|
+
* @param {string} id
|
|
15952
|
+
* @param {any} [body]
|
|
15953
|
+
* @param {*} [options] Override http request option.
|
|
15954
|
+
* @throws {RequiredError}
|
|
15955
|
+
*/
|
|
15956
|
+
moduleControllerImportVersions(id, body, options) {
|
|
15957
|
+
return localVarFp.moduleControllerImportVersions(id, body, options).then((request) => request(axios, basePath));
|
|
15958
|
+
},
|
|
15389
15959
|
/**
|
|
15390
15960
|
* Removes a module, including all versions and config Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerRemove`
|
|
15391
15961
|
* @summary Remove a module
|
|
@@ -15569,6 +16139,20 @@ export class ModuleApi extends BaseAPI {
|
|
|
15569
16139
|
.moduleControllerImport(body, options)
|
|
15570
16140
|
.then((request) => request(this.axios, this.basePath));
|
|
15571
16141
|
}
|
|
16142
|
+
/**
|
|
16143
|
+
* Adds the tagged versions of an export to this custom module. Tags the module already has with identical content are skipped; a tag with different content refuses the whole import. The exported latest draft is ignored. Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerImportVersions`
|
|
16144
|
+
* @summary Import versions into an existing module
|
|
16145
|
+
* @param {string} id
|
|
16146
|
+
* @param {any} [body]
|
|
16147
|
+
* @param {*} [options] Override http request option.
|
|
16148
|
+
* @throws {RequiredError}
|
|
16149
|
+
* @memberof ModuleApi
|
|
16150
|
+
*/
|
|
16151
|
+
moduleControllerImportVersions(id, body, options) {
|
|
16152
|
+
return ModuleApiFp(this.configuration)
|
|
16153
|
+
.moduleControllerImportVersions(id, body, options)
|
|
16154
|
+
.then((request) => request(this.axios, this.basePath));
|
|
16155
|
+
}
|
|
15572
16156
|
/**
|
|
15573
16157
|
* Removes a module, including all versions and config Required permissions: `MANAGE_MODULES`<br> OperationId: `ModuleControllerRemove`
|
|
15574
16158
|
* @summary Remove a module
|
|
@@ -16072,6 +16656,111 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
|
|
|
16072
16656
|
options: localVarRequestOptions,
|
|
16073
16657
|
};
|
|
16074
16658
|
},
|
|
16659
|
+
/**
|
|
16660
|
+
* Link a player to a user in this domain, replacing any existing link on either side. Records source `admin` and the acting user. Emits player-linked, and player-unlinked (reason `displaced`) for each link it replaces. Linking a player to the user it is already linked to changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerLinkUser`
|
|
16661
|
+
* @summary Link a player to a user
|
|
16662
|
+
* @param {string} id
|
|
16663
|
+
* @param {PlayerLinkUserInputDTO} [playerLinkUserInputDTO] PlayerLinkUserInputDTO
|
|
16664
|
+
* @param {*} [options] Override http request option.
|
|
16665
|
+
* @throws {RequiredError}
|
|
16666
|
+
*/
|
|
16667
|
+
playerControllerLinkUser: async (id, playerLinkUserInputDTO, options = {}) => {
|
|
16668
|
+
// verify required parameter 'id' is not null or undefined
|
|
16669
|
+
assertParamExists('playerControllerLinkUser', 'id', id);
|
|
16670
|
+
const localVarPath = `/player/{id}/link`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
16671
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16672
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16673
|
+
let baseOptions;
|
|
16674
|
+
if (configuration) {
|
|
16675
|
+
baseOptions = configuration.baseOptions;
|
|
16676
|
+
}
|
|
16677
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
16678
|
+
const localVarHeaderParameter = {};
|
|
16679
|
+
const localVarQueryParameter = {};
|
|
16680
|
+
// authentication bearerAuth required
|
|
16681
|
+
// http bearer authentication required
|
|
16682
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
16683
|
+
// authentication domainAuth required
|
|
16684
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16685
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16686
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16687
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
16688
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playerLinkUserInputDTO, localVarRequestOptions, configuration);
|
|
16689
|
+
return {
|
|
16690
|
+
url: toPathString(localVarUrlObj),
|
|
16691
|
+
options: localVarRequestOptions,
|
|
16692
|
+
};
|
|
16693
|
+
},
|
|
16694
|
+
/**
|
|
16695
|
+
* Merges this player into `intoPlayerId` and deletes it. This cannot be undone. Its game servers, roles, bans, variables, shop orders, name and IP history and events move to the surviving player (event search reflects the move within a minute); on a game server both played on, the most recently seen record is kept and currency and playtime are summed. When both players are linked to a user, `keepUserId` names the user that stays linked and the other is unlinked (player-unlinked, reason `merged`). Emits player-merged. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMerge`
|
|
16696
|
+
* @summary Merge a player into another
|
|
16697
|
+
* @param {string} id
|
|
16698
|
+
* @param {PlayerMergeExecuteInputDTO} [playerMergeExecuteInputDTO] PlayerMergeExecuteInputDTO
|
|
16699
|
+
* @param {*} [options] Override http request option.
|
|
16700
|
+
* @throws {RequiredError}
|
|
16701
|
+
*/
|
|
16702
|
+
playerControllerMerge: async (id, playerMergeExecuteInputDTO, options = {}) => {
|
|
16703
|
+
// verify required parameter 'id' is not null or undefined
|
|
16704
|
+
assertParamExists('playerControllerMerge', 'id', id);
|
|
16705
|
+
const localVarPath = `/player/{id}/merge`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
16706
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16707
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16708
|
+
let baseOptions;
|
|
16709
|
+
if (configuration) {
|
|
16710
|
+
baseOptions = configuration.baseOptions;
|
|
16711
|
+
}
|
|
16712
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
16713
|
+
const localVarHeaderParameter = {};
|
|
16714
|
+
const localVarQueryParameter = {};
|
|
16715
|
+
// authentication bearerAuth required
|
|
16716
|
+
// http bearer authentication required
|
|
16717
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
16718
|
+
// authentication domainAuth required
|
|
16719
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16720
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16721
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16722
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
16723
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playerMergeExecuteInputDTO, localVarRequestOptions, configuration);
|
|
16724
|
+
return {
|
|
16725
|
+
url: toPathString(localVarUrlObj),
|
|
16726
|
+
options: localVarRequestOptions,
|
|
16727
|
+
};
|
|
16728
|
+
},
|
|
16729
|
+
/**
|
|
16730
|
+
* Shows what merging this player into `intoPlayerId` would do: the game servers moved or combined (currency and playtime summed), the identifiers that move, the roles, bans and variables that move or are dropped as duplicates, and any refusal. Changes nothing. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMergePreview`
|
|
16731
|
+
* @summary Preview merging a player into another
|
|
16732
|
+
* @param {string} id
|
|
16733
|
+
* @param {PlayerMergeInputDTO} [playerMergeInputDTO] PlayerMergeInputDTO
|
|
16734
|
+
* @param {*} [options] Override http request option.
|
|
16735
|
+
* @throws {RequiredError}
|
|
16736
|
+
*/
|
|
16737
|
+
playerControllerMergePreview: async (id, playerMergeInputDTO, options = {}) => {
|
|
16738
|
+
// verify required parameter 'id' is not null or undefined
|
|
16739
|
+
assertParamExists('playerControllerMergePreview', 'id', id);
|
|
16740
|
+
const localVarPath = `/player/{id}/merge/preview`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
16741
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16742
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16743
|
+
let baseOptions;
|
|
16744
|
+
if (configuration) {
|
|
16745
|
+
baseOptions = configuration.baseOptions;
|
|
16746
|
+
}
|
|
16747
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
16748
|
+
const localVarHeaderParameter = {};
|
|
16749
|
+
const localVarQueryParameter = {};
|
|
16750
|
+
// authentication bearerAuth required
|
|
16751
|
+
// http bearer authentication required
|
|
16752
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
16753
|
+
// authentication domainAuth required
|
|
16754
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16755
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16756
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16757
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
16758
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playerMergeInputDTO, localVarRequestOptions, configuration);
|
|
16759
|
+
return {
|
|
16760
|
+
url: toPathString(localVarUrlObj),
|
|
16761
|
+
options: localVarRequestOptions,
|
|
16762
|
+
};
|
|
16763
|
+
},
|
|
16075
16764
|
/**
|
|
16076
16765
|
* Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
|
|
16077
16766
|
* @summary Remove a role from a player
|
|
@@ -16144,31 +16833,63 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
|
|
|
16144
16833
|
options: localVarRequestOptions,
|
|
16145
16834
|
};
|
|
16146
16835
|
},
|
|
16147
|
-
};
|
|
16148
|
-
};
|
|
16149
|
-
/**
|
|
16150
|
-
* PlayerApi - functional programming interface
|
|
16151
|
-
* @export
|
|
16152
|
-
*/
|
|
16153
|
-
export const PlayerApiFp = function (configuration) {
|
|
16154
|
-
const localVarAxiosParamCreator = PlayerApiAxiosParamCreator(configuration);
|
|
16155
|
-
return {
|
|
16156
16836
|
/**
|
|
16157
|
-
*
|
|
16158
|
-
* @summary
|
|
16159
|
-
* @param {
|
|
16837
|
+
* End the link between a player and its user. Both are kept. Emits player-unlinked (reason `admin`). Unlinking a player that has no linked user changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerUnlinkUser`
|
|
16838
|
+
* @summary Unlink a player from its user
|
|
16839
|
+
* @param {string} id
|
|
16160
16840
|
* @param {*} [options] Override http request option.
|
|
16161
16841
|
* @throws {RequiredError}
|
|
16162
16842
|
*/
|
|
16163
|
-
async
|
|
16164
|
-
|
|
16165
|
-
|
|
16166
|
-
const
|
|
16167
|
-
|
|
16168
|
-
|
|
16169
|
-
|
|
16170
|
-
|
|
16171
|
-
|
|
16843
|
+
playerControllerUnlinkUser: async (id, options = {}) => {
|
|
16844
|
+
// verify required parameter 'id' is not null or undefined
|
|
16845
|
+
assertParamExists('playerControllerUnlinkUser', 'id', id);
|
|
16846
|
+
const localVarPath = `/player/{id}/link`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
16847
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16848
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16849
|
+
let baseOptions;
|
|
16850
|
+
if (configuration) {
|
|
16851
|
+
baseOptions = configuration.baseOptions;
|
|
16852
|
+
}
|
|
16853
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
16854
|
+
const localVarHeaderParameter = {};
|
|
16855
|
+
const localVarQueryParameter = {};
|
|
16856
|
+
// authentication bearerAuth required
|
|
16857
|
+
// http bearer authentication required
|
|
16858
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
16859
|
+
// authentication domainAuth required
|
|
16860
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16861
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16862
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
16863
|
+
return {
|
|
16864
|
+
url: toPathString(localVarUrlObj),
|
|
16865
|
+
options: localVarRequestOptions,
|
|
16866
|
+
};
|
|
16867
|
+
},
|
|
16868
|
+
};
|
|
16869
|
+
};
|
|
16870
|
+
/**
|
|
16871
|
+
* PlayerApi - functional programming interface
|
|
16872
|
+
* @export
|
|
16873
|
+
*/
|
|
16874
|
+
export const PlayerApiFp = function (configuration) {
|
|
16875
|
+
const localVarAxiosParamCreator = PlayerApiAxiosParamCreator(configuration);
|
|
16876
|
+
return {
|
|
16877
|
+
/**
|
|
16878
|
+
* Ban a player from one game server, or from every game server in the domain with `isGlobal`. Creating a ban via the API always makes it Takaro managed. Replaces the deprecated `GameServerController.banPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerCreate`
|
|
16879
|
+
* @summary Ban a player from a game server
|
|
16880
|
+
* @param {BanCreateDTO} [banCreateDTO] BanCreateDTO
|
|
16881
|
+
* @param {*} [options] Override http request option.
|
|
16882
|
+
* @throws {RequiredError}
|
|
16883
|
+
*/
|
|
16884
|
+
async banControllerCreate(banCreateDTO, options) {
|
|
16885
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.banControllerCreate(banCreateDTO, options);
|
|
16886
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16887
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerApi.banControllerCreate']?.[localVarOperationServerIndex]?.url;
|
|
16888
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16889
|
+
},
|
|
16890
|
+
/**
|
|
16891
|
+
* Unban a player: removes the ban from Takaro and from the game server(s) it applied to. Replaces the deprecated `GameServerController.unbanPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerDelete`
|
|
16892
|
+
* @summary Unban a player
|
|
16172
16893
|
* @param {string} id
|
|
16173
16894
|
* @param {*} [options] Override http request option.
|
|
16174
16895
|
* @throws {RequiredError}
|
|
@@ -16299,6 +17020,48 @@ export const PlayerApiFp = function (configuration) {
|
|
|
16299
17020
|
const localVarOperationServerBasePath = operationServerMap['PlayerApi.playerControllerGetOne']?.[localVarOperationServerIndex]?.url;
|
|
16300
17021
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16301
17022
|
},
|
|
17023
|
+
/**
|
|
17024
|
+
* Link a player to a user in this domain, replacing any existing link on either side. Records source `admin` and the acting user. Emits player-linked, and player-unlinked (reason `displaced`) for each link it replaces. Linking a player to the user it is already linked to changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerLinkUser`
|
|
17025
|
+
* @summary Link a player to a user
|
|
17026
|
+
* @param {string} id
|
|
17027
|
+
* @param {PlayerLinkUserInputDTO} [playerLinkUserInputDTO] PlayerLinkUserInputDTO
|
|
17028
|
+
* @param {*} [options] Override http request option.
|
|
17029
|
+
* @throws {RequiredError}
|
|
17030
|
+
*/
|
|
17031
|
+
async playerControllerLinkUser(id, playerLinkUserInputDTO, options) {
|
|
17032
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerControllerLinkUser(id, playerLinkUserInputDTO, options);
|
|
17033
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17034
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerApi.playerControllerLinkUser']?.[localVarOperationServerIndex]?.url;
|
|
17035
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17036
|
+
},
|
|
17037
|
+
/**
|
|
17038
|
+
* Merges this player into `intoPlayerId` and deletes it. This cannot be undone. Its game servers, roles, bans, variables, shop orders, name and IP history and events move to the surviving player (event search reflects the move within a minute); on a game server both played on, the most recently seen record is kept and currency and playtime are summed. When both players are linked to a user, `keepUserId` names the user that stays linked and the other is unlinked (player-unlinked, reason `merged`). Emits player-merged. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMerge`
|
|
17039
|
+
* @summary Merge a player into another
|
|
17040
|
+
* @param {string} id
|
|
17041
|
+
* @param {PlayerMergeExecuteInputDTO} [playerMergeExecuteInputDTO] PlayerMergeExecuteInputDTO
|
|
17042
|
+
* @param {*} [options] Override http request option.
|
|
17043
|
+
* @throws {RequiredError}
|
|
17044
|
+
*/
|
|
17045
|
+
async playerControllerMerge(id, playerMergeExecuteInputDTO, options) {
|
|
17046
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerControllerMerge(id, playerMergeExecuteInputDTO, options);
|
|
17047
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17048
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerApi.playerControllerMerge']?.[localVarOperationServerIndex]?.url;
|
|
17049
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17050
|
+
},
|
|
17051
|
+
/**
|
|
17052
|
+
* Shows what merging this player into `intoPlayerId` would do: the game servers moved or combined (currency and playtime summed), the identifiers that move, the roles, bans and variables that move or are dropped as duplicates, and any refusal. Changes nothing. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMergePreview`
|
|
17053
|
+
* @summary Preview merging a player into another
|
|
17054
|
+
* @param {string} id
|
|
17055
|
+
* @param {PlayerMergeInputDTO} [playerMergeInputDTO] PlayerMergeInputDTO
|
|
17056
|
+
* @param {*} [options] Override http request option.
|
|
17057
|
+
* @throws {RequiredError}
|
|
17058
|
+
*/
|
|
17059
|
+
async playerControllerMergePreview(id, playerMergeInputDTO, options) {
|
|
17060
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerControllerMergePreview(id, playerMergeInputDTO, options);
|
|
17061
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17062
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerApi.playerControllerMergePreview']?.[localVarOperationServerIndex]?.url;
|
|
17063
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17064
|
+
},
|
|
16302
17065
|
/**
|
|
16303
17066
|
* Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
|
|
16304
17067
|
* @summary Remove a role from a player
|
|
@@ -16327,6 +17090,19 @@ export const PlayerApiFp = function (configuration) {
|
|
|
16327
17090
|
const localVarOperationServerBasePath = operationServerMap['PlayerApi.playerControllerSearch']?.[localVarOperationServerIndex]?.url;
|
|
16328
17091
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16329
17092
|
},
|
|
17093
|
+
/**
|
|
17094
|
+
* End the link between a player and its user. Both are kept. Emits player-unlinked (reason `admin`). Unlinking a player that has no linked user changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerUnlinkUser`
|
|
17095
|
+
* @summary Unlink a player from its user
|
|
17096
|
+
* @param {string} id
|
|
17097
|
+
* @param {*} [options] Override http request option.
|
|
17098
|
+
* @throws {RequiredError}
|
|
17099
|
+
*/
|
|
17100
|
+
async playerControllerUnlinkUser(id, options) {
|
|
17101
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerControllerUnlinkUser(id, options);
|
|
17102
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17103
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerApi.playerControllerUnlinkUser']?.[localVarOperationServerIndex]?.url;
|
|
17104
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17105
|
+
},
|
|
16330
17106
|
};
|
|
16331
17107
|
};
|
|
16332
17108
|
/**
|
|
@@ -16455,6 +17231,45 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
|
|
|
16455
17231
|
playerControllerGetOne(id, options) {
|
|
16456
17232
|
return localVarFp.playerControllerGetOne(id, options).then((request) => request(axios, basePath));
|
|
16457
17233
|
},
|
|
17234
|
+
/**
|
|
17235
|
+
* Link a player to a user in this domain, replacing any existing link on either side. Records source `admin` and the acting user. Emits player-linked, and player-unlinked (reason `displaced`) for each link it replaces. Linking a player to the user it is already linked to changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerLinkUser`
|
|
17236
|
+
* @summary Link a player to a user
|
|
17237
|
+
* @param {string} id
|
|
17238
|
+
* @param {PlayerLinkUserInputDTO} [playerLinkUserInputDTO] PlayerLinkUserInputDTO
|
|
17239
|
+
* @param {*} [options] Override http request option.
|
|
17240
|
+
* @throws {RequiredError}
|
|
17241
|
+
*/
|
|
17242
|
+
playerControllerLinkUser(id, playerLinkUserInputDTO, options) {
|
|
17243
|
+
return localVarFp
|
|
17244
|
+
.playerControllerLinkUser(id, playerLinkUserInputDTO, options)
|
|
17245
|
+
.then((request) => request(axios, basePath));
|
|
17246
|
+
},
|
|
17247
|
+
/**
|
|
17248
|
+
* Merges this player into `intoPlayerId` and deletes it. This cannot be undone. Its game servers, roles, bans, variables, shop orders, name and IP history and events move to the surviving player (event search reflects the move within a minute); on a game server both played on, the most recently seen record is kept and currency and playtime are summed. When both players are linked to a user, `keepUserId` names the user that stays linked and the other is unlinked (player-unlinked, reason `merged`). Emits player-merged. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMerge`
|
|
17249
|
+
* @summary Merge a player into another
|
|
17250
|
+
* @param {string} id
|
|
17251
|
+
* @param {PlayerMergeExecuteInputDTO} [playerMergeExecuteInputDTO] PlayerMergeExecuteInputDTO
|
|
17252
|
+
* @param {*} [options] Override http request option.
|
|
17253
|
+
* @throws {RequiredError}
|
|
17254
|
+
*/
|
|
17255
|
+
playerControllerMerge(id, playerMergeExecuteInputDTO, options) {
|
|
17256
|
+
return localVarFp
|
|
17257
|
+
.playerControllerMerge(id, playerMergeExecuteInputDTO, options)
|
|
17258
|
+
.then((request) => request(axios, basePath));
|
|
17259
|
+
},
|
|
17260
|
+
/**
|
|
17261
|
+
* Shows what merging this player into `intoPlayerId` would do: the game servers moved or combined (currency and playtime summed), the identifiers that move, the roles, bans and variables that move or are dropped as duplicates, and any refusal. Changes nothing. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMergePreview`
|
|
17262
|
+
* @summary Preview merging a player into another
|
|
17263
|
+
* @param {string} id
|
|
17264
|
+
* @param {PlayerMergeInputDTO} [playerMergeInputDTO] PlayerMergeInputDTO
|
|
17265
|
+
* @param {*} [options] Override http request option.
|
|
17266
|
+
* @throws {RequiredError}
|
|
17267
|
+
*/
|
|
17268
|
+
playerControllerMergePreview(id, playerMergeInputDTO, options) {
|
|
17269
|
+
return localVarFp
|
|
17270
|
+
.playerControllerMergePreview(id, playerMergeInputDTO, options)
|
|
17271
|
+
.then((request) => request(axios, basePath));
|
|
17272
|
+
},
|
|
16458
17273
|
/**
|
|
16459
17274
|
* Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
|
|
16460
17275
|
* @summary Remove a role from a player
|
|
@@ -16481,6 +17296,16 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
|
|
|
16481
17296
|
.playerControllerSearch(playerSearchInputDTO, options)
|
|
16482
17297
|
.then((request) => request(axios, basePath));
|
|
16483
17298
|
},
|
|
17299
|
+
/**
|
|
17300
|
+
* End the link between a player and its user. Both are kept. Emits player-unlinked (reason `admin`). Unlinking a player that has no linked user changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerUnlinkUser`
|
|
17301
|
+
* @summary Unlink a player from its user
|
|
17302
|
+
* @param {string} id
|
|
17303
|
+
* @param {*} [options] Override http request option.
|
|
17304
|
+
* @throws {RequiredError}
|
|
17305
|
+
*/
|
|
17306
|
+
playerControllerUnlinkUser(id, options) {
|
|
17307
|
+
return localVarFp.playerControllerUnlinkUser(id, options).then((request) => request(axios, basePath));
|
|
17308
|
+
},
|
|
16484
17309
|
};
|
|
16485
17310
|
};
|
|
16486
17311
|
/**
|
|
@@ -16636,6 +17461,48 @@ export class PlayerApi extends BaseAPI {
|
|
|
16636
17461
|
.playerControllerGetOne(id, options)
|
|
16637
17462
|
.then((request) => request(this.axios, this.basePath));
|
|
16638
17463
|
}
|
|
17464
|
+
/**
|
|
17465
|
+
* Link a player to a user in this domain, replacing any existing link on either side. Records source `admin` and the acting user. Emits player-linked, and player-unlinked (reason `displaced`) for each link it replaces. Linking a player to the user it is already linked to changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerLinkUser`
|
|
17466
|
+
* @summary Link a player to a user
|
|
17467
|
+
* @param {string} id
|
|
17468
|
+
* @param {PlayerLinkUserInputDTO} [playerLinkUserInputDTO] PlayerLinkUserInputDTO
|
|
17469
|
+
* @param {*} [options] Override http request option.
|
|
17470
|
+
* @throws {RequiredError}
|
|
17471
|
+
* @memberof PlayerApi
|
|
17472
|
+
*/
|
|
17473
|
+
playerControllerLinkUser(id, playerLinkUserInputDTO, options) {
|
|
17474
|
+
return PlayerApiFp(this.configuration)
|
|
17475
|
+
.playerControllerLinkUser(id, playerLinkUserInputDTO, options)
|
|
17476
|
+
.then((request) => request(this.axios, this.basePath));
|
|
17477
|
+
}
|
|
17478
|
+
/**
|
|
17479
|
+
* Merges this player into `intoPlayerId` and deletes it. This cannot be undone. Its game servers, roles, bans, variables, shop orders, name and IP history and events move to the surviving player (event search reflects the move within a minute); on a game server both played on, the most recently seen record is kept and currency and playtime are summed. When both players are linked to a user, `keepUserId` names the user that stays linked and the other is unlinked (player-unlinked, reason `merged`). Emits player-merged. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMerge`
|
|
17480
|
+
* @summary Merge a player into another
|
|
17481
|
+
* @param {string} id
|
|
17482
|
+
* @param {PlayerMergeExecuteInputDTO} [playerMergeExecuteInputDTO] PlayerMergeExecuteInputDTO
|
|
17483
|
+
* @param {*} [options] Override http request option.
|
|
17484
|
+
* @throws {RequiredError}
|
|
17485
|
+
* @memberof PlayerApi
|
|
17486
|
+
*/
|
|
17487
|
+
playerControllerMerge(id, playerMergeExecuteInputDTO, options) {
|
|
17488
|
+
return PlayerApiFp(this.configuration)
|
|
17489
|
+
.playerControllerMerge(id, playerMergeExecuteInputDTO, options)
|
|
17490
|
+
.then((request) => request(this.axios, this.basePath));
|
|
17491
|
+
}
|
|
17492
|
+
/**
|
|
17493
|
+
* Shows what merging this player into `intoPlayerId` would do: the game servers moved or combined (currency and playtime summed), the identifiers that move, the roles, bans and variables that move or are dropped as duplicates, and any refusal. Changes nothing. Refused when both players hold different values for the same platform identifier (Steam, EOS, Xbox Live, platform id), when both ids name the same player, or when either player was created by Fixture History. MANAGE_USERS is also required when the player being merged away is linked to a user, and MANAGE_VARIABLES when it holds variables. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerMergePreview`
|
|
17494
|
+
* @summary Preview merging a player into another
|
|
17495
|
+
* @param {string} id
|
|
17496
|
+
* @param {PlayerMergeInputDTO} [playerMergeInputDTO] PlayerMergeInputDTO
|
|
17497
|
+
* @param {*} [options] Override http request option.
|
|
17498
|
+
* @throws {RequiredError}
|
|
17499
|
+
* @memberof PlayerApi
|
|
17500
|
+
*/
|
|
17501
|
+
playerControllerMergePreview(id, playerMergeInputDTO, options) {
|
|
17502
|
+
return PlayerApiFp(this.configuration)
|
|
17503
|
+
.playerControllerMergePreview(id, playerMergeInputDTO, options)
|
|
17504
|
+
.then((request) => request(this.axios, this.basePath));
|
|
17505
|
+
}
|
|
16639
17506
|
/**
|
|
16640
17507
|
* Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
|
|
16641
17508
|
* @summary Remove a role from a player
|
|
@@ -16664,6 +17531,19 @@ export class PlayerApi extends BaseAPI {
|
|
|
16664
17531
|
.playerControllerSearch(playerSearchInputDTO, options)
|
|
16665
17532
|
.then((request) => request(this.axios, this.basePath));
|
|
16666
17533
|
}
|
|
17534
|
+
/**
|
|
17535
|
+
* End the link between a player and its user. Both are kept. Emits player-unlinked (reason `admin`). Unlinking a player that has no linked user changes nothing. Required permissions: `MANAGE_PLAYERS`, `MANAGE_USERS`<br> OperationId: `PlayerControllerUnlinkUser`
|
|
17536
|
+
* @summary Unlink a player from its user
|
|
17537
|
+
* @param {string} id
|
|
17538
|
+
* @param {*} [options] Override http request option.
|
|
17539
|
+
* @throws {RequiredError}
|
|
17540
|
+
* @memberof PlayerApi
|
|
17541
|
+
*/
|
|
17542
|
+
playerControllerUnlinkUser(id, options) {
|
|
17543
|
+
return PlayerApiFp(this.configuration)
|
|
17544
|
+
.playerControllerUnlinkUser(id, options)
|
|
17545
|
+
.then((request) => request(this.axios, this.basePath));
|
|
17546
|
+
}
|
|
16667
17547
|
}
|
|
16668
17548
|
/**
|
|
16669
17549
|
* PlayerOnGameServerApi - axios parameter creator
|
|
@@ -17424,61 +18304,61 @@ export class PlayerOnGameServerApi extends BaseAPI {
|
|
|
17424
18304
|
}
|
|
17425
18305
|
}
|
|
17426
18306
|
/**
|
|
17427
|
-
*
|
|
18307
|
+
* PlayerPortalApi - axios parameter creator
|
|
17428
18308
|
* @export
|
|
17429
18309
|
*/
|
|
17430
|
-
export const
|
|
18310
|
+
export const PlayerPortalApiAxiosParamCreator = function (configuration) {
|
|
17431
18311
|
return {
|
|
17432
18312
|
/**
|
|
17433
|
-
*
|
|
17434
|
-
* @summary
|
|
17435
|
-
* @param {string}
|
|
17436
|
-
* @param {RegistryInstallBody} [registryInstallBody] RegistryInstallBody
|
|
18313
|
+
* Dismisses the signed-in User\'s pending notice that another account\'s link replaced theirs, and returns the Player Portal state. Idempotent. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerDismissDisplacedNotice`
|
|
18314
|
+
* @summary Dismiss the displaced notice
|
|
18315
|
+
* @param {string} domainId
|
|
17437
18316
|
* @param {*} [options] Override http request option.
|
|
17438
18317
|
* @throws {RequiredError}
|
|
17439
18318
|
*/
|
|
17440
|
-
|
|
17441
|
-
// verify required parameter '
|
|
17442
|
-
assertParamExists('
|
|
17443
|
-
const localVarPath = `/
|
|
18319
|
+
playerPortalControllerDismissDisplacedNotice: async (domainId, options = {}) => {
|
|
18320
|
+
// verify required parameter 'domainId' is not null or undefined
|
|
18321
|
+
assertParamExists('playerPortalControllerDismissDisplacedNotice', 'domainId', domainId);
|
|
18322
|
+
const localVarPath = `/player-portal/{domainId}/displaced-notice`.replace(`{${'domainId'}}`, encodeURIComponent(String(domainId)));
|
|
17444
18323
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17445
18324
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17446
18325
|
let baseOptions;
|
|
17447
18326
|
if (configuration) {
|
|
17448
18327
|
baseOptions = configuration.baseOptions;
|
|
17449
18328
|
}
|
|
17450
|
-
const localVarRequestOptions = { method: '
|
|
18329
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
17451
18330
|
const localVarHeaderParameter = {};
|
|
17452
18331
|
const localVarQueryParameter = {};
|
|
17453
18332
|
// authentication bearerAuth required
|
|
17454
18333
|
// http bearer authentication required
|
|
17455
18334
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17456
18335
|
// authentication domainAuth required
|
|
17457
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17458
18336
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17459
18337
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17460
18338
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
17461
|
-
localVarRequestOptions.data = serializeDataIfNeeded(registryInstallBody, localVarRequestOptions, configuration);
|
|
17462
18339
|
return {
|
|
17463
18340
|
url: toPathString(localVarUrlObj),
|
|
17464
18341
|
options: localVarRequestOptions,
|
|
17465
18342
|
};
|
|
17466
18343
|
},
|
|
17467
18344
|
/**
|
|
17468
|
-
*
|
|
17469
|
-
* @summary
|
|
18345
|
+
* Signs the current Identity into the Player Portal of the Domain in the path and returns the Portal state. When the Identity has no User in that Domain, an unlinked Player User is created: it is not a dashboard user, is not billed and does not inherit the `User` role. Idempotent. Never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerEnter`
|
|
18346
|
+
* @summary Enter a Domain\'s Player Portal
|
|
18347
|
+
* @param {string} domainId
|
|
17470
18348
|
* @param {*} [options] Override http request option.
|
|
17471
18349
|
* @throws {RequiredError}
|
|
17472
18350
|
*/
|
|
17473
|
-
|
|
17474
|
-
|
|
18351
|
+
playerPortalControllerEnter: async (domainId, options = {}) => {
|
|
18352
|
+
// verify required parameter 'domainId' is not null or undefined
|
|
18353
|
+
assertParamExists('playerPortalControllerEnter', 'domainId', domainId);
|
|
18354
|
+
const localVarPath = `/player-portal/{domainId}/enter`.replace(`{${'domainId'}}`, encodeURIComponent(String(domainId)));
|
|
17475
18355
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17476
18356
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17477
18357
|
let baseOptions;
|
|
17478
18358
|
if (configuration) {
|
|
17479
18359
|
baseOptions = configuration.baseOptions;
|
|
17480
18360
|
}
|
|
17481
|
-
const localVarRequestOptions = { method: '
|
|
18361
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
17482
18362
|
const localVarHeaderParameter = {};
|
|
17483
18363
|
const localVarQueryParameter = {};
|
|
17484
18364
|
// authentication bearerAuth required
|
|
@@ -17494,16 +18374,17 @@ export const RegistryApiAxiosParamCreator = function (configuration) {
|
|
|
17494
18374
|
};
|
|
17495
18375
|
},
|
|
17496
18376
|
/**
|
|
17497
|
-
*
|
|
17498
|
-
* @summary
|
|
17499
|
-
* @param {string}
|
|
18377
|
+
* Whether a Link Code from `/link` in game is valid, expired or invalid in the Domain in the path. A valid code names its Player and the seconds until it expires. Another Domain\'s codes read as invalid. Signed-in Player Portal only; rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerInspectLinkCode`
|
|
18378
|
+
* @summary Inspect a game-issued Link Code
|
|
18379
|
+
* @param {string} domainId
|
|
18380
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
17500
18381
|
* @param {*} [options] Override http request option.
|
|
17501
18382
|
* @throws {RequiredError}
|
|
17502
18383
|
*/
|
|
17503
|
-
|
|
17504
|
-
// verify required parameter '
|
|
17505
|
-
assertParamExists('
|
|
17506
|
-
const localVarPath = `/
|
|
18384
|
+
playerPortalControllerInspectLinkCode: async (domainId, playerPortalLinkCodeInputDTO, options = {}) => {
|
|
18385
|
+
// verify required parameter 'domainId' is not null or undefined
|
|
18386
|
+
assertParamExists('playerPortalControllerInspectLinkCode', 'domainId', domainId);
|
|
18387
|
+
const localVarPath = `/player-portal/{domainId}/link-code/inspect`.replace(`{${'domainId'}}`, encodeURIComponent(String(domainId)));
|
|
17507
18388
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17508
18389
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17509
18390
|
let baseOptions;
|
|
@@ -17517,23 +18398,28 @@ export const RegistryApiAxiosParamCreator = function (configuration) {
|
|
|
17517
18398
|
// http bearer authentication required
|
|
17518
18399
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17519
18400
|
// authentication domainAuth required
|
|
18401
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17520
18402
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17521
18403
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17522
18404
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
18405
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playerPortalLinkCodeInputDTO, localVarRequestOptions, configuration);
|
|
17523
18406
|
return {
|
|
17524
18407
|
url: toPathString(localVarUrlObj),
|
|
17525
18408
|
options: localVarRequestOptions,
|
|
17526
18409
|
};
|
|
17527
18410
|
},
|
|
17528
18411
|
/**
|
|
17529
|
-
*
|
|
17530
|
-
* @summary
|
|
17531
|
-
* @param {
|
|
18412
|
+
* Returns the signed-in User\'s live Portal-issued Link Code, minting one when there is none; `renew: true` replaces it. Signed-in Player Portal only; one live code per User. The code is 6 digits, valid for 10 minutes, unique within the Domain and works once. Typing `/link <code>` in game links the speaking Player to this User (source `web-code`), replacing an existing link on either side (`player-unlinked`, reason `displaced`). Never reads or sets the `takaro-domain` cookie, and refuses API keys. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerIssuePortalLinkCode`
|
|
18413
|
+
* @summary Get a Link Code to type in game
|
|
18414
|
+
* @param {string} domainId
|
|
18415
|
+
* @param {PlayerPortalIssueLinkCodeInputDTO} [playerPortalIssueLinkCodeInputDTO] PlayerPortalIssueLinkCodeInputDTO
|
|
17532
18416
|
* @param {*} [options] Override http request option.
|
|
17533
18417
|
* @throws {RequiredError}
|
|
17534
18418
|
*/
|
|
17535
|
-
|
|
17536
|
-
|
|
18419
|
+
playerPortalControllerIssuePortalLinkCode: async (domainId, playerPortalIssueLinkCodeInputDTO, options = {}) => {
|
|
18420
|
+
// verify required parameter 'domainId' is not null or undefined
|
|
18421
|
+
assertParamExists('playerPortalControllerIssuePortalLinkCode', 'domainId', domainId);
|
|
18422
|
+
const localVarPath = `/player-portal/{domainId}/portal-link-code`.replace(`{${'domainId'}}`, encodeURIComponent(String(domainId)));
|
|
17537
18423
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17538
18424
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17539
18425
|
let baseOptions;
|
|
@@ -17551,88 +18437,701 @@ export const RegistryApiAxiosParamCreator = function (configuration) {
|
|
|
17551
18437
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17552
18438
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17553
18439
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
17554
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
18440
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playerPortalIssueLinkCodeInputDTO, localVarRequestOptions, configuration);
|
|
17555
18441
|
return {
|
|
17556
18442
|
url: toPathString(localVarUrlObj),
|
|
17557
18443
|
options: localVarRequestOptions,
|
|
17558
18444
|
};
|
|
17559
18445
|
},
|
|
17560
18446
|
/**
|
|
17561
|
-
*
|
|
17562
|
-
* @summary
|
|
17563
|
-
* @param {string}
|
|
18447
|
+
* Links the code\'s Player to the signed-in User and returns the Player Portal state. Takes no email and creates no account. The code works once. An existing link on either side is replaced, emitting `player-unlinked` (reason `displaced`) and then `player-linked` (source `game-code`). Never reads or sets the `takaro-domain` cookie. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerRedeemLinkCode`
|
|
18448
|
+
* @summary Redeem a game-issued Link Code
|
|
18449
|
+
* @param {string} domainId
|
|
18450
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
17564
18451
|
* @param {*} [options] Override http request option.
|
|
17565
18452
|
* @throws {RequiredError}
|
|
17566
18453
|
*/
|
|
17567
|
-
|
|
17568
|
-
// verify required parameter '
|
|
17569
|
-
assertParamExists('
|
|
17570
|
-
const localVarPath = `/
|
|
18454
|
+
playerPortalControllerRedeemLinkCode: async (domainId, playerPortalLinkCodeInputDTO, options = {}) => {
|
|
18455
|
+
// verify required parameter 'domainId' is not null or undefined
|
|
18456
|
+
assertParamExists('playerPortalControllerRedeemLinkCode', 'domainId', domainId);
|
|
18457
|
+
const localVarPath = `/player-portal/{domainId}/link-code/redeem`.replace(`{${'domainId'}}`, encodeURIComponent(String(domainId)));
|
|
17571
18458
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17572
18459
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17573
18460
|
let baseOptions;
|
|
17574
18461
|
if (configuration) {
|
|
17575
18462
|
baseOptions = configuration.baseOptions;
|
|
17576
18463
|
}
|
|
17577
|
-
const localVarRequestOptions = { method: '
|
|
18464
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
17578
18465
|
const localVarHeaderParameter = {};
|
|
17579
18466
|
const localVarQueryParameter = {};
|
|
17580
18467
|
// authentication bearerAuth required
|
|
17581
18468
|
// http bearer authentication required
|
|
17582
18469
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
17583
18470
|
// authentication domainAuth required
|
|
18471
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17584
18472
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17585
18473
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17586
18474
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
18475
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playerPortalLinkCodeInputDTO, localVarRequestOptions, configuration);
|
|
17587
18476
|
return {
|
|
17588
18477
|
url: toPathString(localVarUrlObj),
|
|
17589
18478
|
options: localVarRequestOptions,
|
|
17590
18479
|
};
|
|
17591
18480
|
},
|
|
17592
|
-
};
|
|
17593
|
-
};
|
|
17594
|
-
/**
|
|
17595
|
-
* RegistryApi - functional programming interface
|
|
17596
|
-
* @export
|
|
17597
|
-
*/
|
|
17598
|
-
export const RegistryApiFp = function (configuration) {
|
|
17599
|
-
const localVarAxiosParamCreator = RegistryApiAxiosParamCreator(configuration);
|
|
17600
|
-
return {
|
|
17601
|
-
/**
|
|
17602
|
-
* Fetch a specific module version from the registry and install it into the domain Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerInstall`
|
|
17603
|
-
* @summary Install a module from a registry
|
|
17604
|
-
* @param {string} id
|
|
17605
|
-
* @param {RegistryInstallBody} [registryInstallBody] RegistryInstallBody
|
|
17606
|
-
* @param {*} [options] Override http request option.
|
|
17607
|
-
* @throws {RequiredError}
|
|
17608
|
-
*/
|
|
17609
|
-
async registryControllerInstall(id, registryInstallBody, options) {
|
|
17610
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.registryControllerInstall(id, registryInstallBody, options);
|
|
17611
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17612
|
-
const localVarOperationServerBasePath = operationServerMap['RegistryApi.registryControllerInstall']?.[localVarOperationServerIndex]?.url;
|
|
17613
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17614
|
-
},
|
|
17615
18481
|
/**
|
|
17616
|
-
*
|
|
17617
|
-
* @summary
|
|
18482
|
+
* Public, for old `/link?code=` URLs: returns the Player Portal URL of the Domain a valid or recently expired Link Code belongs to, and nothing else. 404 for an unknown code. Rate-limited per client IP.<br> OperationId: `PlayerPortalControllerResolveLinkCode`
|
|
18483
|
+
* @summary Find a game-issued Link Code\'s Player Portal
|
|
18484
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
17618
18485
|
* @param {*} [options] Override http request option.
|
|
17619
18486
|
* @throws {RequiredError}
|
|
17620
18487
|
*/
|
|
17621
|
-
async
|
|
17622
|
-
const
|
|
17623
|
-
|
|
17624
|
-
const
|
|
17625
|
-
|
|
18488
|
+
playerPortalControllerResolveLinkCode: async (playerPortalLinkCodeInputDTO, options = {}) => {
|
|
18489
|
+
const localVarPath = `/player-portal/link-code/resolve`;
|
|
18490
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18491
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18492
|
+
let baseOptions;
|
|
18493
|
+
if (configuration) {
|
|
18494
|
+
baseOptions = configuration.baseOptions;
|
|
18495
|
+
}
|
|
18496
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
18497
|
+
const localVarHeaderParameter = {};
|
|
18498
|
+
const localVarQueryParameter = {};
|
|
18499
|
+
// authentication bearerAuth required
|
|
18500
|
+
// http bearer authentication required
|
|
18501
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18502
|
+
// authentication domainAuth required
|
|
18503
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
18504
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18505
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18506
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
18507
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playerPortalLinkCodeInputDTO, localVarRequestOptions, configuration);
|
|
18508
|
+
return {
|
|
18509
|
+
url: toPathString(localVarUrlObj),
|
|
18510
|
+
options: localVarRequestOptions,
|
|
18511
|
+
};
|
|
17626
18512
|
},
|
|
17627
18513
|
/**
|
|
17628
|
-
*
|
|
17629
|
-
* @summary
|
|
17630
|
-
* @param {string}
|
|
18514
|
+
* The Player Portal state of the Domain in the path for the current Identity. 404 until the Identity has entered the Portal (`POST /player-portal/{domainId}/enter`). Never reads or sets the `takaro-domain` cookie.<br> OperationId: `PlayerPortalControllerState`
|
|
18515
|
+
* @summary Get a Domain\'s Player Portal state
|
|
18516
|
+
* @param {string} domainId
|
|
17631
18517
|
* @param {*} [options] Override http request option.
|
|
17632
18518
|
* @throws {RequiredError}
|
|
17633
18519
|
*/
|
|
17634
|
-
async
|
|
17635
|
-
|
|
18520
|
+
playerPortalControllerState: async (domainId, options = {}) => {
|
|
18521
|
+
// verify required parameter 'domainId' is not null or undefined
|
|
18522
|
+
assertParamExists('playerPortalControllerState', 'domainId', domainId);
|
|
18523
|
+
const localVarPath = `/player-portal/{domainId}`.replace(`{${'domainId'}}`, encodeURIComponent(String(domainId)));
|
|
18524
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18525
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18526
|
+
let baseOptions;
|
|
18527
|
+
if (configuration) {
|
|
18528
|
+
baseOptions = configuration.baseOptions;
|
|
18529
|
+
}
|
|
18530
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
18531
|
+
const localVarHeaderParameter = {};
|
|
18532
|
+
const localVarQueryParameter = {};
|
|
18533
|
+
// authentication bearerAuth required
|
|
18534
|
+
// http bearer authentication required
|
|
18535
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18536
|
+
// authentication domainAuth required
|
|
18537
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18538
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18539
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
18540
|
+
return {
|
|
18541
|
+
url: toPathString(localVarUrlObj),
|
|
18542
|
+
options: localVarRequestOptions,
|
|
18543
|
+
};
|
|
18544
|
+
},
|
|
18545
|
+
/**
|
|
18546
|
+
* Ends the signed-in User\'s own Player-User Link to the Player in the path and returns the Player Portal state. Both the Player and the User are kept. Emits `player-unlinked` (reason `self`). Steam sign-in will not link this Player to this User again until a Link Code or an admin links them. Unlinking a Player you are not linked to changes nothing; 400 when you are linked to a different Player. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerUnlinkSelf`
|
|
18547
|
+
* @summary Unlink your own Player
|
|
18548
|
+
* @param {string} domainId
|
|
18549
|
+
* @param {string} playerId
|
|
18550
|
+
* @param {*} [options] Override http request option.
|
|
18551
|
+
* @throws {RequiredError}
|
|
18552
|
+
*/
|
|
18553
|
+
playerPortalControllerUnlinkSelf: async (domainId, playerId, options = {}) => {
|
|
18554
|
+
// verify required parameter 'domainId' is not null or undefined
|
|
18555
|
+
assertParamExists('playerPortalControllerUnlinkSelf', 'domainId', domainId);
|
|
18556
|
+
// verify required parameter 'playerId' is not null or undefined
|
|
18557
|
+
assertParamExists('playerPortalControllerUnlinkSelf', 'playerId', playerId);
|
|
18558
|
+
const localVarPath = `/player-portal/{domainId}/link/{playerId}`
|
|
18559
|
+
.replace(`{${'domainId'}}`, encodeURIComponent(String(domainId)))
|
|
18560
|
+
.replace(`{${'playerId'}}`, encodeURIComponent(String(playerId)));
|
|
18561
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18562
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18563
|
+
let baseOptions;
|
|
18564
|
+
if (configuration) {
|
|
18565
|
+
baseOptions = configuration.baseOptions;
|
|
18566
|
+
}
|
|
18567
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
18568
|
+
const localVarHeaderParameter = {};
|
|
18569
|
+
const localVarQueryParameter = {};
|
|
18570
|
+
// authentication bearerAuth required
|
|
18571
|
+
// http bearer authentication required
|
|
18572
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18573
|
+
// authentication domainAuth required
|
|
18574
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18575
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18576
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
18577
|
+
return {
|
|
18578
|
+
url: toPathString(localVarUrlObj),
|
|
18579
|
+
options: localVarRequestOptions,
|
|
18580
|
+
};
|
|
18581
|
+
},
|
|
18582
|
+
};
|
|
18583
|
+
};
|
|
18584
|
+
/**
|
|
18585
|
+
* PlayerPortalApi - functional programming interface
|
|
18586
|
+
* @export
|
|
18587
|
+
*/
|
|
18588
|
+
export const PlayerPortalApiFp = function (configuration) {
|
|
18589
|
+
const localVarAxiosParamCreator = PlayerPortalApiAxiosParamCreator(configuration);
|
|
18590
|
+
return {
|
|
18591
|
+
/**
|
|
18592
|
+
* Dismisses the signed-in User\'s pending notice that another account\'s link replaced theirs, and returns the Player Portal state. Idempotent. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerDismissDisplacedNotice`
|
|
18593
|
+
* @summary Dismiss the displaced notice
|
|
18594
|
+
* @param {string} domainId
|
|
18595
|
+
* @param {*} [options] Override http request option.
|
|
18596
|
+
* @throws {RequiredError}
|
|
18597
|
+
*/
|
|
18598
|
+
async playerPortalControllerDismissDisplacedNotice(domainId, options) {
|
|
18599
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerDismissDisplacedNotice(domainId, options);
|
|
18600
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18601
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerDismissDisplacedNotice']?.[localVarOperationServerIndex]?.url;
|
|
18602
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18603
|
+
},
|
|
18604
|
+
/**
|
|
18605
|
+
* Signs the current Identity into the Player Portal of the Domain in the path and returns the Portal state. When the Identity has no User in that Domain, an unlinked Player User is created: it is not a dashboard user, is not billed and does not inherit the `User` role. Idempotent. Never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerEnter`
|
|
18606
|
+
* @summary Enter a Domain\'s Player Portal
|
|
18607
|
+
* @param {string} domainId
|
|
18608
|
+
* @param {*} [options] Override http request option.
|
|
18609
|
+
* @throws {RequiredError}
|
|
18610
|
+
*/
|
|
18611
|
+
async playerPortalControllerEnter(domainId, options) {
|
|
18612
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerEnter(domainId, options);
|
|
18613
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18614
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerEnter']?.[localVarOperationServerIndex]?.url;
|
|
18615
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18616
|
+
},
|
|
18617
|
+
/**
|
|
18618
|
+
* Whether a Link Code from `/link` in game is valid, expired or invalid in the Domain in the path. A valid code names its Player and the seconds until it expires. Another Domain\'s codes read as invalid. Signed-in Player Portal only; rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerInspectLinkCode`
|
|
18619
|
+
* @summary Inspect a game-issued Link Code
|
|
18620
|
+
* @param {string} domainId
|
|
18621
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18622
|
+
* @param {*} [options] Override http request option.
|
|
18623
|
+
* @throws {RequiredError}
|
|
18624
|
+
*/
|
|
18625
|
+
async playerPortalControllerInspectLinkCode(domainId, playerPortalLinkCodeInputDTO, options) {
|
|
18626
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerInspectLinkCode(domainId, playerPortalLinkCodeInputDTO, options);
|
|
18627
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18628
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerInspectLinkCode']?.[localVarOperationServerIndex]
|
|
18629
|
+
?.url;
|
|
18630
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18631
|
+
},
|
|
18632
|
+
/**
|
|
18633
|
+
* Returns the signed-in User\'s live Portal-issued Link Code, minting one when there is none; `renew: true` replaces it. Signed-in Player Portal only; one live code per User. The code is 6 digits, valid for 10 minutes, unique within the Domain and works once. Typing `/link <code>` in game links the speaking Player to this User (source `web-code`), replacing an existing link on either side (`player-unlinked`, reason `displaced`). Never reads or sets the `takaro-domain` cookie, and refuses API keys. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerIssuePortalLinkCode`
|
|
18634
|
+
* @summary Get a Link Code to type in game
|
|
18635
|
+
* @param {string} domainId
|
|
18636
|
+
* @param {PlayerPortalIssueLinkCodeInputDTO} [playerPortalIssueLinkCodeInputDTO] PlayerPortalIssueLinkCodeInputDTO
|
|
18637
|
+
* @param {*} [options] Override http request option.
|
|
18638
|
+
* @throws {RequiredError}
|
|
18639
|
+
*/
|
|
18640
|
+
async playerPortalControllerIssuePortalLinkCode(domainId, playerPortalIssueLinkCodeInputDTO, options) {
|
|
18641
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerIssuePortalLinkCode(domainId, playerPortalIssueLinkCodeInputDTO, options);
|
|
18642
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18643
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerIssuePortalLinkCode']?.[localVarOperationServerIndex]
|
|
18644
|
+
?.url;
|
|
18645
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18646
|
+
},
|
|
18647
|
+
/**
|
|
18648
|
+
* Links the code\'s Player to the signed-in User and returns the Player Portal state. Takes no email and creates no account. The code works once. An existing link on either side is replaced, emitting `player-unlinked` (reason `displaced`) and then `player-linked` (source `game-code`). Never reads or sets the `takaro-domain` cookie. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerRedeemLinkCode`
|
|
18649
|
+
* @summary Redeem a game-issued Link Code
|
|
18650
|
+
* @param {string} domainId
|
|
18651
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18652
|
+
* @param {*} [options] Override http request option.
|
|
18653
|
+
* @throws {RequiredError}
|
|
18654
|
+
*/
|
|
18655
|
+
async playerPortalControllerRedeemLinkCode(domainId, playerPortalLinkCodeInputDTO, options) {
|
|
18656
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerRedeemLinkCode(domainId, playerPortalLinkCodeInputDTO, options);
|
|
18657
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18658
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerRedeemLinkCode']?.[localVarOperationServerIndex]?.url;
|
|
18659
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18660
|
+
},
|
|
18661
|
+
/**
|
|
18662
|
+
* Public, for old `/link?code=` URLs: returns the Player Portal URL of the Domain a valid or recently expired Link Code belongs to, and nothing else. 404 for an unknown code. Rate-limited per client IP.<br> OperationId: `PlayerPortalControllerResolveLinkCode`
|
|
18663
|
+
* @summary Find a game-issued Link Code\'s Player Portal
|
|
18664
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18665
|
+
* @param {*} [options] Override http request option.
|
|
18666
|
+
* @throws {RequiredError}
|
|
18667
|
+
*/
|
|
18668
|
+
async playerPortalControllerResolveLinkCode(playerPortalLinkCodeInputDTO, options) {
|
|
18669
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerResolveLinkCode(playerPortalLinkCodeInputDTO, options);
|
|
18670
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18671
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerResolveLinkCode']?.[localVarOperationServerIndex]
|
|
18672
|
+
?.url;
|
|
18673
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18674
|
+
},
|
|
18675
|
+
/**
|
|
18676
|
+
* The Player Portal state of the Domain in the path for the current Identity. 404 until the Identity has entered the Portal (`POST /player-portal/{domainId}/enter`). Never reads or sets the `takaro-domain` cookie.<br> OperationId: `PlayerPortalControllerState`
|
|
18677
|
+
* @summary Get a Domain\'s Player Portal state
|
|
18678
|
+
* @param {string} domainId
|
|
18679
|
+
* @param {*} [options] Override http request option.
|
|
18680
|
+
* @throws {RequiredError}
|
|
18681
|
+
*/
|
|
18682
|
+
async playerPortalControllerState(domainId, options) {
|
|
18683
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerState(domainId, options);
|
|
18684
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18685
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerState']?.[localVarOperationServerIndex]?.url;
|
|
18686
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18687
|
+
},
|
|
18688
|
+
/**
|
|
18689
|
+
* Ends the signed-in User\'s own Player-User Link to the Player in the path and returns the Player Portal state. Both the Player and the User are kept. Emits `player-unlinked` (reason `self`). Steam sign-in will not link this Player to this User again until a Link Code or an admin links them. Unlinking a Player you are not linked to changes nothing; 400 when you are linked to a different Player. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerUnlinkSelf`
|
|
18690
|
+
* @summary Unlink your own Player
|
|
18691
|
+
* @param {string} domainId
|
|
18692
|
+
* @param {string} playerId
|
|
18693
|
+
* @param {*} [options] Override http request option.
|
|
18694
|
+
* @throws {RequiredError}
|
|
18695
|
+
*/
|
|
18696
|
+
async playerPortalControllerUnlinkSelf(domainId, playerId, options) {
|
|
18697
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.playerPortalControllerUnlinkSelf(domainId, playerId, options);
|
|
18698
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
18699
|
+
const localVarOperationServerBasePath = operationServerMap['PlayerPortalApi.playerPortalControllerUnlinkSelf']?.[localVarOperationServerIndex]?.url;
|
|
18700
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18701
|
+
},
|
|
18702
|
+
};
|
|
18703
|
+
};
|
|
18704
|
+
/**
|
|
18705
|
+
* PlayerPortalApi - factory interface
|
|
18706
|
+
* @export
|
|
18707
|
+
*/
|
|
18708
|
+
export const PlayerPortalApiFactory = function (configuration, basePath, axios) {
|
|
18709
|
+
const localVarFp = PlayerPortalApiFp(configuration);
|
|
18710
|
+
return {
|
|
18711
|
+
/**
|
|
18712
|
+
* Dismisses the signed-in User\'s pending notice that another account\'s link replaced theirs, and returns the Player Portal state. Idempotent. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerDismissDisplacedNotice`
|
|
18713
|
+
* @summary Dismiss the displaced notice
|
|
18714
|
+
* @param {string} domainId
|
|
18715
|
+
* @param {*} [options] Override http request option.
|
|
18716
|
+
* @throws {RequiredError}
|
|
18717
|
+
*/
|
|
18718
|
+
playerPortalControllerDismissDisplacedNotice(domainId, options) {
|
|
18719
|
+
return localVarFp
|
|
18720
|
+
.playerPortalControllerDismissDisplacedNotice(domainId, options)
|
|
18721
|
+
.then((request) => request(axios, basePath));
|
|
18722
|
+
},
|
|
18723
|
+
/**
|
|
18724
|
+
* Signs the current Identity into the Player Portal of the Domain in the path and returns the Portal state. When the Identity has no User in that Domain, an unlinked Player User is created: it is not a dashboard user, is not billed and does not inherit the `User` role. Idempotent. Never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerEnter`
|
|
18725
|
+
* @summary Enter a Domain\'s Player Portal
|
|
18726
|
+
* @param {string} domainId
|
|
18727
|
+
* @param {*} [options] Override http request option.
|
|
18728
|
+
* @throws {RequiredError}
|
|
18729
|
+
*/
|
|
18730
|
+
playerPortalControllerEnter(domainId, options) {
|
|
18731
|
+
return localVarFp.playerPortalControllerEnter(domainId, options).then((request) => request(axios, basePath));
|
|
18732
|
+
},
|
|
18733
|
+
/**
|
|
18734
|
+
* Whether a Link Code from `/link` in game is valid, expired or invalid in the Domain in the path. A valid code names its Player and the seconds until it expires. Another Domain\'s codes read as invalid. Signed-in Player Portal only; rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerInspectLinkCode`
|
|
18735
|
+
* @summary Inspect a game-issued Link Code
|
|
18736
|
+
* @param {string} domainId
|
|
18737
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18738
|
+
* @param {*} [options] Override http request option.
|
|
18739
|
+
* @throws {RequiredError}
|
|
18740
|
+
*/
|
|
18741
|
+
playerPortalControllerInspectLinkCode(domainId, playerPortalLinkCodeInputDTO, options) {
|
|
18742
|
+
return localVarFp
|
|
18743
|
+
.playerPortalControllerInspectLinkCode(domainId, playerPortalLinkCodeInputDTO, options)
|
|
18744
|
+
.then((request) => request(axios, basePath));
|
|
18745
|
+
},
|
|
18746
|
+
/**
|
|
18747
|
+
* Returns the signed-in User\'s live Portal-issued Link Code, minting one when there is none; `renew: true` replaces it. Signed-in Player Portal only; one live code per User. The code is 6 digits, valid for 10 minutes, unique within the Domain and works once. Typing `/link <code>` in game links the speaking Player to this User (source `web-code`), replacing an existing link on either side (`player-unlinked`, reason `displaced`). Never reads or sets the `takaro-domain` cookie, and refuses API keys. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerIssuePortalLinkCode`
|
|
18748
|
+
* @summary Get a Link Code to type in game
|
|
18749
|
+
* @param {string} domainId
|
|
18750
|
+
* @param {PlayerPortalIssueLinkCodeInputDTO} [playerPortalIssueLinkCodeInputDTO] PlayerPortalIssueLinkCodeInputDTO
|
|
18751
|
+
* @param {*} [options] Override http request option.
|
|
18752
|
+
* @throws {RequiredError}
|
|
18753
|
+
*/
|
|
18754
|
+
playerPortalControllerIssuePortalLinkCode(domainId, playerPortalIssueLinkCodeInputDTO, options) {
|
|
18755
|
+
return localVarFp
|
|
18756
|
+
.playerPortalControllerIssuePortalLinkCode(domainId, playerPortalIssueLinkCodeInputDTO, options)
|
|
18757
|
+
.then((request) => request(axios, basePath));
|
|
18758
|
+
},
|
|
18759
|
+
/**
|
|
18760
|
+
* Links the code\'s Player to the signed-in User and returns the Player Portal state. Takes no email and creates no account. The code works once. An existing link on either side is replaced, emitting `player-unlinked` (reason `displaced`) and then `player-linked` (source `game-code`). Never reads or sets the `takaro-domain` cookie. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerRedeemLinkCode`
|
|
18761
|
+
* @summary Redeem a game-issued Link Code
|
|
18762
|
+
* @param {string} domainId
|
|
18763
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18764
|
+
* @param {*} [options] Override http request option.
|
|
18765
|
+
* @throws {RequiredError}
|
|
18766
|
+
*/
|
|
18767
|
+
playerPortalControllerRedeemLinkCode(domainId, playerPortalLinkCodeInputDTO, options) {
|
|
18768
|
+
return localVarFp
|
|
18769
|
+
.playerPortalControllerRedeemLinkCode(domainId, playerPortalLinkCodeInputDTO, options)
|
|
18770
|
+
.then((request) => request(axios, basePath));
|
|
18771
|
+
},
|
|
18772
|
+
/**
|
|
18773
|
+
* Public, for old `/link?code=` URLs: returns the Player Portal URL of the Domain a valid or recently expired Link Code belongs to, and nothing else. 404 for an unknown code. Rate-limited per client IP.<br> OperationId: `PlayerPortalControllerResolveLinkCode`
|
|
18774
|
+
* @summary Find a game-issued Link Code\'s Player Portal
|
|
18775
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18776
|
+
* @param {*} [options] Override http request option.
|
|
18777
|
+
* @throws {RequiredError}
|
|
18778
|
+
*/
|
|
18779
|
+
playerPortalControllerResolveLinkCode(playerPortalLinkCodeInputDTO, options) {
|
|
18780
|
+
return localVarFp
|
|
18781
|
+
.playerPortalControllerResolveLinkCode(playerPortalLinkCodeInputDTO, options)
|
|
18782
|
+
.then((request) => request(axios, basePath));
|
|
18783
|
+
},
|
|
18784
|
+
/**
|
|
18785
|
+
* The Player Portal state of the Domain in the path for the current Identity. 404 until the Identity has entered the Portal (`POST /player-portal/{domainId}/enter`). Never reads or sets the `takaro-domain` cookie.<br> OperationId: `PlayerPortalControllerState`
|
|
18786
|
+
* @summary Get a Domain\'s Player Portal state
|
|
18787
|
+
* @param {string} domainId
|
|
18788
|
+
* @param {*} [options] Override http request option.
|
|
18789
|
+
* @throws {RequiredError}
|
|
18790
|
+
*/
|
|
18791
|
+
playerPortalControllerState(domainId, options) {
|
|
18792
|
+
return localVarFp.playerPortalControllerState(domainId, options).then((request) => request(axios, basePath));
|
|
18793
|
+
},
|
|
18794
|
+
/**
|
|
18795
|
+
* Ends the signed-in User\'s own Player-User Link to the Player in the path and returns the Player Portal state. Both the Player and the User are kept. Emits `player-unlinked` (reason `self`). Steam sign-in will not link this Player to this User again until a Link Code or an admin links them. Unlinking a Player you are not linked to changes nothing; 400 when you are linked to a different Player. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerUnlinkSelf`
|
|
18796
|
+
* @summary Unlink your own Player
|
|
18797
|
+
* @param {string} domainId
|
|
18798
|
+
* @param {string} playerId
|
|
18799
|
+
* @param {*} [options] Override http request option.
|
|
18800
|
+
* @throws {RequiredError}
|
|
18801
|
+
*/
|
|
18802
|
+
playerPortalControllerUnlinkSelf(domainId, playerId, options) {
|
|
18803
|
+
return localVarFp
|
|
18804
|
+
.playerPortalControllerUnlinkSelf(domainId, playerId, options)
|
|
18805
|
+
.then((request) => request(axios, basePath));
|
|
18806
|
+
},
|
|
18807
|
+
};
|
|
18808
|
+
};
|
|
18809
|
+
/**
|
|
18810
|
+
* PlayerPortalApi - object-oriented interface
|
|
18811
|
+
* @export
|
|
18812
|
+
* @class PlayerPortalApi
|
|
18813
|
+
* @extends {BaseAPI}
|
|
18814
|
+
*/
|
|
18815
|
+
export class PlayerPortalApi extends BaseAPI {
|
|
18816
|
+
/**
|
|
18817
|
+
* Dismisses the signed-in User\'s pending notice that another account\'s link replaced theirs, and returns the Player Portal state. Idempotent. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerDismissDisplacedNotice`
|
|
18818
|
+
* @summary Dismiss the displaced notice
|
|
18819
|
+
* @param {string} domainId
|
|
18820
|
+
* @param {*} [options] Override http request option.
|
|
18821
|
+
* @throws {RequiredError}
|
|
18822
|
+
* @memberof PlayerPortalApi
|
|
18823
|
+
*/
|
|
18824
|
+
playerPortalControllerDismissDisplacedNotice(domainId, options) {
|
|
18825
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18826
|
+
.playerPortalControllerDismissDisplacedNotice(domainId, options)
|
|
18827
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18828
|
+
}
|
|
18829
|
+
/**
|
|
18830
|
+
* Signs the current Identity into the Player Portal of the Domain in the path and returns the Portal state. When the Identity has no User in that Domain, an unlinked Player User is created: it is not a dashboard user, is not billed and does not inherit the `User` role. Idempotent. Never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerEnter`
|
|
18831
|
+
* @summary Enter a Domain\'s Player Portal
|
|
18832
|
+
* @param {string} domainId
|
|
18833
|
+
* @param {*} [options] Override http request option.
|
|
18834
|
+
* @throws {RequiredError}
|
|
18835
|
+
* @memberof PlayerPortalApi
|
|
18836
|
+
*/
|
|
18837
|
+
playerPortalControllerEnter(domainId, options) {
|
|
18838
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18839
|
+
.playerPortalControllerEnter(domainId, options)
|
|
18840
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18841
|
+
}
|
|
18842
|
+
/**
|
|
18843
|
+
* Whether a Link Code from `/link` in game is valid, expired or invalid in the Domain in the path. A valid code names its Player and the seconds until it expires. Another Domain\'s codes read as invalid. Signed-in Player Portal only; rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerInspectLinkCode`
|
|
18844
|
+
* @summary Inspect a game-issued Link Code
|
|
18845
|
+
* @param {string} domainId
|
|
18846
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18847
|
+
* @param {*} [options] Override http request option.
|
|
18848
|
+
* @throws {RequiredError}
|
|
18849
|
+
* @memberof PlayerPortalApi
|
|
18850
|
+
*/
|
|
18851
|
+
playerPortalControllerInspectLinkCode(domainId, playerPortalLinkCodeInputDTO, options) {
|
|
18852
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18853
|
+
.playerPortalControllerInspectLinkCode(domainId, playerPortalLinkCodeInputDTO, options)
|
|
18854
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18855
|
+
}
|
|
18856
|
+
/**
|
|
18857
|
+
* Returns the signed-in User\'s live Portal-issued Link Code, minting one when there is none; `renew: true` replaces it. Signed-in Player Portal only; one live code per User. The code is 6 digits, valid for 10 minutes, unique within the Domain and works once. Typing `/link <code>` in game links the speaking Player to this User (source `web-code`), replacing an existing link on either side (`player-unlinked`, reason `displaced`). Never reads or sets the `takaro-domain` cookie, and refuses API keys. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerIssuePortalLinkCode`
|
|
18858
|
+
* @summary Get a Link Code to type in game
|
|
18859
|
+
* @param {string} domainId
|
|
18860
|
+
* @param {PlayerPortalIssueLinkCodeInputDTO} [playerPortalIssueLinkCodeInputDTO] PlayerPortalIssueLinkCodeInputDTO
|
|
18861
|
+
* @param {*} [options] Override http request option.
|
|
18862
|
+
* @throws {RequiredError}
|
|
18863
|
+
* @memberof PlayerPortalApi
|
|
18864
|
+
*/
|
|
18865
|
+
playerPortalControllerIssuePortalLinkCode(domainId, playerPortalIssueLinkCodeInputDTO, options) {
|
|
18866
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18867
|
+
.playerPortalControllerIssuePortalLinkCode(domainId, playerPortalIssueLinkCodeInputDTO, options)
|
|
18868
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18869
|
+
}
|
|
18870
|
+
/**
|
|
18871
|
+
* Links the code\'s Player to the signed-in User and returns the Player Portal state. Takes no email and creates no account. The code works once. An existing link on either side is replaced, emitting `player-unlinked` (reason `displaced`) and then `player-linked` (source `game-code`). Never reads or sets the `takaro-domain` cookie. Rate-limited per User and per client IP.<br> OperationId: `PlayerPortalControllerRedeemLinkCode`
|
|
18872
|
+
* @summary Redeem a game-issued Link Code
|
|
18873
|
+
* @param {string} domainId
|
|
18874
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18875
|
+
* @param {*} [options] Override http request option.
|
|
18876
|
+
* @throws {RequiredError}
|
|
18877
|
+
* @memberof PlayerPortalApi
|
|
18878
|
+
*/
|
|
18879
|
+
playerPortalControllerRedeemLinkCode(domainId, playerPortalLinkCodeInputDTO, options) {
|
|
18880
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18881
|
+
.playerPortalControllerRedeemLinkCode(domainId, playerPortalLinkCodeInputDTO, options)
|
|
18882
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18883
|
+
}
|
|
18884
|
+
/**
|
|
18885
|
+
* Public, for old `/link?code=` URLs: returns the Player Portal URL of the Domain a valid or recently expired Link Code belongs to, and nothing else. 404 for an unknown code. Rate-limited per client IP.<br> OperationId: `PlayerPortalControllerResolveLinkCode`
|
|
18886
|
+
* @summary Find a game-issued Link Code\'s Player Portal
|
|
18887
|
+
* @param {PlayerPortalLinkCodeInputDTO} [playerPortalLinkCodeInputDTO] PlayerPortalLinkCodeInputDTO
|
|
18888
|
+
* @param {*} [options] Override http request option.
|
|
18889
|
+
* @throws {RequiredError}
|
|
18890
|
+
* @memberof PlayerPortalApi
|
|
18891
|
+
*/
|
|
18892
|
+
playerPortalControllerResolveLinkCode(playerPortalLinkCodeInputDTO, options) {
|
|
18893
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18894
|
+
.playerPortalControllerResolveLinkCode(playerPortalLinkCodeInputDTO, options)
|
|
18895
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18896
|
+
}
|
|
18897
|
+
/**
|
|
18898
|
+
* The Player Portal state of the Domain in the path for the current Identity. 404 until the Identity has entered the Portal (`POST /player-portal/{domainId}/enter`). Never reads or sets the `takaro-domain` cookie.<br> OperationId: `PlayerPortalControllerState`
|
|
18899
|
+
* @summary Get a Domain\'s Player Portal state
|
|
18900
|
+
* @param {string} domainId
|
|
18901
|
+
* @param {*} [options] Override http request option.
|
|
18902
|
+
* @throws {RequiredError}
|
|
18903
|
+
* @memberof PlayerPortalApi
|
|
18904
|
+
*/
|
|
18905
|
+
playerPortalControllerState(domainId, options) {
|
|
18906
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18907
|
+
.playerPortalControllerState(domainId, options)
|
|
18908
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18909
|
+
}
|
|
18910
|
+
/**
|
|
18911
|
+
* Ends the signed-in User\'s own Player-User Link to the Player in the path and returns the Player Portal state. Both the Player and the User are kept. Emits `player-unlinked` (reason `self`). Steam sign-in will not link this Player to this User again until a Link Code or an admin links them. Unlinking a Player you are not linked to changes nothing; 400 when you are linked to a different Player. Signed-in Player Portal only; never reads or sets the `takaro-domain` cookie, and refuses API keys.<br> OperationId: `PlayerPortalControllerUnlinkSelf`
|
|
18912
|
+
* @summary Unlink your own Player
|
|
18913
|
+
* @param {string} domainId
|
|
18914
|
+
* @param {string} playerId
|
|
18915
|
+
* @param {*} [options] Override http request option.
|
|
18916
|
+
* @throws {RequiredError}
|
|
18917
|
+
* @memberof PlayerPortalApi
|
|
18918
|
+
*/
|
|
18919
|
+
playerPortalControllerUnlinkSelf(domainId, playerId, options) {
|
|
18920
|
+
return PlayerPortalApiFp(this.configuration)
|
|
18921
|
+
.playerPortalControllerUnlinkSelf(domainId, playerId, options)
|
|
18922
|
+
.then((request) => request(this.axios, this.basePath));
|
|
18923
|
+
}
|
|
18924
|
+
}
|
|
18925
|
+
/**
|
|
18926
|
+
* RegistryApi - axios parameter creator
|
|
18927
|
+
* @export
|
|
18928
|
+
*/
|
|
18929
|
+
export const RegistryApiAxiosParamCreator = function (configuration) {
|
|
18930
|
+
return {
|
|
18931
|
+
/**
|
|
18932
|
+
* Fetch a specific module version from the registry and install it into the domain Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerInstall`
|
|
18933
|
+
* @summary Install a module from a registry
|
|
18934
|
+
* @param {string} id
|
|
18935
|
+
* @param {RegistryInstallBody} [registryInstallBody] RegistryInstallBody
|
|
18936
|
+
* @param {*} [options] Override http request option.
|
|
18937
|
+
* @throws {RequiredError}
|
|
18938
|
+
*/
|
|
18939
|
+
registryControllerInstall: async (id, registryInstallBody, options = {}) => {
|
|
18940
|
+
// verify required parameter 'id' is not null or undefined
|
|
18941
|
+
assertParamExists('registryControllerInstall', 'id', id);
|
|
18942
|
+
const localVarPath = `/registry/{id}/install`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
18943
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18944
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18945
|
+
let baseOptions;
|
|
18946
|
+
if (configuration) {
|
|
18947
|
+
baseOptions = configuration.baseOptions;
|
|
18948
|
+
}
|
|
18949
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
18950
|
+
const localVarHeaderParameter = {};
|
|
18951
|
+
const localVarQueryParameter = {};
|
|
18952
|
+
// authentication bearerAuth required
|
|
18953
|
+
// http bearer authentication required
|
|
18954
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18955
|
+
// authentication domainAuth required
|
|
18956
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
18957
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18958
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18959
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
18960
|
+
localVarRequestOptions.data = serializeDataIfNeeded(registryInstallBody, localVarRequestOptions, configuration);
|
|
18961
|
+
return {
|
|
18962
|
+
url: toPathString(localVarUrlObj),
|
|
18963
|
+
options: localVarRequestOptions,
|
|
18964
|
+
};
|
|
18965
|
+
},
|
|
18966
|
+
/**
|
|
18967
|
+
* List all subscribed registries with their cached module manifests Required permissions: `READ_MODULES`<br> OperationId: `RegistryControllerList`
|
|
18968
|
+
* @summary List subscribed registries
|
|
18969
|
+
* @param {*} [options] Override http request option.
|
|
18970
|
+
* @throws {RequiredError}
|
|
18971
|
+
*/
|
|
18972
|
+
registryControllerList: async (options = {}) => {
|
|
18973
|
+
const localVarPath = `/registry`;
|
|
18974
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
18975
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
18976
|
+
let baseOptions;
|
|
18977
|
+
if (configuration) {
|
|
18978
|
+
baseOptions = configuration.baseOptions;
|
|
18979
|
+
}
|
|
18980
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
18981
|
+
const localVarHeaderParameter = {};
|
|
18982
|
+
const localVarQueryParameter = {};
|
|
18983
|
+
// authentication bearerAuth required
|
|
18984
|
+
// http bearer authentication required
|
|
18985
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
18986
|
+
// authentication domainAuth required
|
|
18987
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
18988
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
18989
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
18990
|
+
return {
|
|
18991
|
+
url: toPathString(localVarUrlObj),
|
|
18992
|
+
options: localVarRequestOptions,
|
|
18993
|
+
};
|
|
18994
|
+
},
|
|
18995
|
+
/**
|
|
18996
|
+
* Bust the manifest cache and re-fetch from the registry URL. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
18997
|
+
* @summary Refresh registry manifest
|
|
18998
|
+
* @param {string} id
|
|
18999
|
+
* @param {*} [options] Override http request option.
|
|
19000
|
+
* @throws {RequiredError}
|
|
19001
|
+
*/
|
|
19002
|
+
registryControllerRefresh: async (id, options = {}) => {
|
|
19003
|
+
// verify required parameter 'id' is not null or undefined
|
|
19004
|
+
assertParamExists('registryControllerRefresh', 'id', id);
|
|
19005
|
+
const localVarPath = `/registry/{id}/refresh`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
19006
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
19007
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
19008
|
+
let baseOptions;
|
|
19009
|
+
if (configuration) {
|
|
19010
|
+
baseOptions = configuration.baseOptions;
|
|
19011
|
+
}
|
|
19012
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
19013
|
+
const localVarHeaderParameter = {};
|
|
19014
|
+
const localVarQueryParameter = {};
|
|
19015
|
+
// authentication bearerAuth required
|
|
19016
|
+
// http bearer authentication required
|
|
19017
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
19018
|
+
// authentication domainAuth required
|
|
19019
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
19020
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
19021
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
19022
|
+
return {
|
|
19023
|
+
url: toPathString(localVarUrlObj),
|
|
19024
|
+
options: localVarRequestOptions,
|
|
19025
|
+
};
|
|
19026
|
+
},
|
|
19027
|
+
/**
|
|
19028
|
+
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
19029
|
+
* @summary Subscribe to a registry
|
|
19030
|
+
* @param {RegistrySubscribeBody} [registrySubscribeBody] RegistrySubscribeBody
|
|
19031
|
+
* @param {*} [options] Override http request option.
|
|
19032
|
+
* @throws {RequiredError}
|
|
19033
|
+
*/
|
|
19034
|
+
registryControllerSubscribe: async (registrySubscribeBody, options = {}) => {
|
|
19035
|
+
const localVarPath = `/registry`;
|
|
19036
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
19037
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
19038
|
+
let baseOptions;
|
|
19039
|
+
if (configuration) {
|
|
19040
|
+
baseOptions = configuration.baseOptions;
|
|
19041
|
+
}
|
|
19042
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
19043
|
+
const localVarHeaderParameter = {};
|
|
19044
|
+
const localVarQueryParameter = {};
|
|
19045
|
+
// authentication bearerAuth required
|
|
19046
|
+
// http bearer authentication required
|
|
19047
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
19048
|
+
// authentication domainAuth required
|
|
19049
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
19050
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
19051
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
19052
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
19053
|
+
localVarRequestOptions.data = serializeDataIfNeeded(registrySubscribeBody, localVarRequestOptions, configuration);
|
|
19054
|
+
return {
|
|
19055
|
+
url: toPathString(localVarUrlObj),
|
|
19056
|
+
options: localVarRequestOptions,
|
|
19057
|
+
};
|
|
19058
|
+
},
|
|
19059
|
+
/**
|
|
19060
|
+
* Unsubscribe from a registry. Installed modules from this registry will be orphaned (registry_id set to null). Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerUnsubscribe`
|
|
19061
|
+
* @summary Unsubscribe from a registry
|
|
19062
|
+
* @param {string} id
|
|
19063
|
+
* @param {*} [options] Override http request option.
|
|
19064
|
+
* @throws {RequiredError}
|
|
19065
|
+
*/
|
|
19066
|
+
registryControllerUnsubscribe: async (id, options = {}) => {
|
|
19067
|
+
// verify required parameter 'id' is not null or undefined
|
|
19068
|
+
assertParamExists('registryControllerUnsubscribe', 'id', id);
|
|
19069
|
+
const localVarPath = `/registry/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
19070
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
19071
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
19072
|
+
let baseOptions;
|
|
19073
|
+
if (configuration) {
|
|
19074
|
+
baseOptions = configuration.baseOptions;
|
|
19075
|
+
}
|
|
19076
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
19077
|
+
const localVarHeaderParameter = {};
|
|
19078
|
+
const localVarQueryParameter = {};
|
|
19079
|
+
// authentication bearerAuth required
|
|
19080
|
+
// http bearer authentication required
|
|
19081
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
19082
|
+
// authentication domainAuth required
|
|
19083
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
19084
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
19085
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
19086
|
+
return {
|
|
19087
|
+
url: toPathString(localVarUrlObj),
|
|
19088
|
+
options: localVarRequestOptions,
|
|
19089
|
+
};
|
|
19090
|
+
},
|
|
19091
|
+
};
|
|
19092
|
+
};
|
|
19093
|
+
/**
|
|
19094
|
+
* RegistryApi - functional programming interface
|
|
19095
|
+
* @export
|
|
19096
|
+
*/
|
|
19097
|
+
export const RegistryApiFp = function (configuration) {
|
|
19098
|
+
const localVarAxiosParamCreator = RegistryApiAxiosParamCreator(configuration);
|
|
19099
|
+
return {
|
|
19100
|
+
/**
|
|
19101
|
+
* Fetch a specific module version from the registry and install it into the domain Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerInstall`
|
|
19102
|
+
* @summary Install a module from a registry
|
|
19103
|
+
* @param {string} id
|
|
19104
|
+
* @param {RegistryInstallBody} [registryInstallBody] RegistryInstallBody
|
|
19105
|
+
* @param {*} [options] Override http request option.
|
|
19106
|
+
* @throws {RequiredError}
|
|
19107
|
+
*/
|
|
19108
|
+
async registryControllerInstall(id, registryInstallBody, options) {
|
|
19109
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.registryControllerInstall(id, registryInstallBody, options);
|
|
19110
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
19111
|
+
const localVarOperationServerBasePath = operationServerMap['RegistryApi.registryControllerInstall']?.[localVarOperationServerIndex]?.url;
|
|
19112
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
19113
|
+
},
|
|
19114
|
+
/**
|
|
19115
|
+
* List all subscribed registries with their cached module manifests Required permissions: `READ_MODULES`<br> OperationId: `RegistryControllerList`
|
|
19116
|
+
* @summary List subscribed registries
|
|
19117
|
+
* @param {*} [options] Override http request option.
|
|
19118
|
+
* @throws {RequiredError}
|
|
19119
|
+
*/
|
|
19120
|
+
async registryControllerList(options) {
|
|
19121
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.registryControllerList(options);
|
|
19122
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
19123
|
+
const localVarOperationServerBasePath = operationServerMap['RegistryApi.registryControllerList']?.[localVarOperationServerIndex]?.url;
|
|
19124
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
19125
|
+
},
|
|
19126
|
+
/**
|
|
19127
|
+
* Bust the manifest cache and re-fetch from the registry URL. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
19128
|
+
* @summary Refresh registry manifest
|
|
19129
|
+
* @param {string} id
|
|
19130
|
+
* @param {*} [options] Override http request option.
|
|
19131
|
+
* @throws {RequiredError}
|
|
19132
|
+
*/
|
|
19133
|
+
async registryControllerRefresh(id, options) {
|
|
19134
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.registryControllerRefresh(id, options);
|
|
17636
19135
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
17637
19136
|
const localVarOperationServerBasePath = operationServerMap['RegistryApi.registryControllerRefresh']?.[localVarOperationServerIndex]?.url;
|
|
17638
19137
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -22295,7 +23794,7 @@ export class ThreadApi extends BaseAPI {
|
|
|
22295
23794
|
export const TrackingApiAxiosParamCreator = function (configuration) {
|
|
22296
23795
|
return {
|
|
22297
23796
|
/**
|
|
22298
|
-
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
23797
|
+
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
22299
23798
|
* @summary Get bounding box players
|
|
22300
23799
|
* @param {BoundingBoxSearchInputDTO} [boundingBoxSearchInputDTO] BoundingBoxSearchInputDTO
|
|
22301
23800
|
* @param {*} [options] Override http request option.
|
|
@@ -22327,7 +23826,103 @@ export const TrackingApiAxiosParamCreator = function (configuration) {
|
|
|
22327
23826
|
};
|
|
22328
23827
|
},
|
|
22329
23828
|
/**
|
|
22330
|
-
*
|
|
23829
|
+
* A player\'s inventory on a game server at a moment, reconstructed from their latest inventory snapshot at or before the moment (within 31 days) plus the changes after it. snapshotTime is absent when no snapshot exists, meaning the inventory is not known. At most 1000 items; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryAt`
|
|
23830
|
+
* @summary Get inventory at
|
|
23831
|
+
* @param {InventoryAtInputDTO} [inventoryAtInputDTO] InventoryAtInputDTO
|
|
23832
|
+
* @param {*} [options] Override http request option.
|
|
23833
|
+
* @throws {RequiredError}
|
|
23834
|
+
*/
|
|
23835
|
+
trackingControllerGetInventoryAt: async (inventoryAtInputDTO, options = {}) => {
|
|
23836
|
+
const localVarPath = `/tracking/inventory/at`;
|
|
23837
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23838
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23839
|
+
let baseOptions;
|
|
23840
|
+
if (configuration) {
|
|
23841
|
+
baseOptions = configuration.baseOptions;
|
|
23842
|
+
}
|
|
23843
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
23844
|
+
const localVarHeaderParameter = {};
|
|
23845
|
+
const localVarQueryParameter = {};
|
|
23846
|
+
// authentication bearerAuth required
|
|
23847
|
+
// http bearer authentication required
|
|
23848
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23849
|
+
// authentication domainAuth required
|
|
23850
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23851
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23852
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23853
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
23854
|
+
localVarRequestOptions.data = serializeDataIfNeeded(inventoryAtInputDTO, localVarRequestOptions, configuration);
|
|
23855
|
+
return {
|
|
23856
|
+
url: toPathString(localVarUrlObj),
|
|
23857
|
+
options: localVarRequestOptions,
|
|
23858
|
+
};
|
|
23859
|
+
},
|
|
23860
|
+
/**
|
|
23861
|
+
* A player\'s inventory changes on a game server in a time range (at most 31 days), in time order, with cause, Position and counterpart where the game reported them. Cause `unknown` marks a correction found by an hourly snapshot. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryChanges`
|
|
23862
|
+
* @summary Get inventory changes
|
|
23863
|
+
* @param {InventoryChangesInputDTO} [inventoryChangesInputDTO] InventoryChangesInputDTO
|
|
23864
|
+
* @param {*} [options] Override http request option.
|
|
23865
|
+
* @throws {RequiredError}
|
|
23866
|
+
*/
|
|
23867
|
+
trackingControllerGetInventoryChanges: async (inventoryChangesInputDTO, options = {}) => {
|
|
23868
|
+
const localVarPath = `/tracking/inventory/changes`;
|
|
23869
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23870
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23871
|
+
let baseOptions;
|
|
23872
|
+
if (configuration) {
|
|
23873
|
+
baseOptions = configuration.baseOptions;
|
|
23874
|
+
}
|
|
23875
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
23876
|
+
const localVarHeaderParameter = {};
|
|
23877
|
+
const localVarQueryParameter = {};
|
|
23878
|
+
// authentication bearerAuth required
|
|
23879
|
+
// http bearer authentication required
|
|
23880
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23881
|
+
// authentication domainAuth required
|
|
23882
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23883
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23884
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23885
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
23886
|
+
localVarRequestOptions.data = serializeDataIfNeeded(inventoryChangesInputDTO, localVarRequestOptions, configuration);
|
|
23887
|
+
return {
|
|
23888
|
+
url: toPathString(localVarUrlObj),
|
|
23889
|
+
options: localVarRequestOptions,
|
|
23890
|
+
};
|
|
23891
|
+
},
|
|
23892
|
+
/**
|
|
23893
|
+
* Who held an item of a game server during a time range (at most 31 days): per player, the periods they held it, reconstructed from inventory snapshots and changes, plus each gain and loss of the item in time order with cause, Position and counterpart where reported. A period with heldAtStart began before the range; one without end lasted past it. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetItemHolders`
|
|
23894
|
+
* @summary Get item holders
|
|
23895
|
+
* @param {ItemHoldersInputDTO} [itemHoldersInputDTO] ItemHoldersInputDTO
|
|
23896
|
+
* @param {*} [options] Override http request option.
|
|
23897
|
+
* @throws {RequiredError}
|
|
23898
|
+
*/
|
|
23899
|
+
trackingControllerGetItemHolders: async (itemHoldersInputDTO, options = {}) => {
|
|
23900
|
+
const localVarPath = `/tracking/items/holders`;
|
|
23901
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23902
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23903
|
+
let baseOptions;
|
|
23904
|
+
if (configuration) {
|
|
23905
|
+
baseOptions = configuration.baseOptions;
|
|
23906
|
+
}
|
|
23907
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
23908
|
+
const localVarHeaderParameter = {};
|
|
23909
|
+
const localVarQueryParameter = {};
|
|
23910
|
+
// authentication bearerAuth required
|
|
23911
|
+
// http bearer authentication required
|
|
23912
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23913
|
+
// authentication domainAuth required
|
|
23914
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23915
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23916
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23917
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
23918
|
+
localVarRequestOptions.data = serializeDataIfNeeded(itemHoldersInputDTO, localVarRequestOptions, configuration);
|
|
23919
|
+
return {
|
|
23920
|
+
url: toPathString(localVarUrlObj),
|
|
23921
|
+
options: localVarRequestOptions,
|
|
23922
|
+
};
|
|
23923
|
+
},
|
|
23924
|
+
/**
|
|
23925
|
+
* Get inventory changes for a player between two timestamps Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerInventoryHistory`
|
|
22331
23926
|
* @summary Get player inventory history
|
|
22332
23927
|
* @param {PlayerInventoryHistoryInputDTO} [playerInventoryHistoryInputDTO] PlayerInventoryHistoryInputDTO
|
|
22333
23928
|
* @param {*} [options] Override http request option.
|
|
@@ -22359,7 +23954,7 @@ export const TrackingApiAxiosParamCreator = function (configuration) {
|
|
|
22359
23954
|
};
|
|
22360
23955
|
},
|
|
22361
23956
|
/**
|
|
22362
|
-
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
23957
|
+
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
22363
23958
|
* @summary Get player movement history
|
|
22364
23959
|
* @param {PlayerMovementHistoryInputDTO} [playerMovementHistoryInputDTO] PlayerMovementHistoryInputDTO
|
|
22365
23960
|
* @param {*} [options] Override http request option.
|
|
@@ -22391,14 +23986,206 @@ export const TrackingApiAxiosParamCreator = function (configuration) {
|
|
|
22391
23986
|
};
|
|
22392
23987
|
},
|
|
22393
23988
|
/**
|
|
22394
|
-
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
22395
|
-
* @summary Get players by item
|
|
22396
|
-
* @param {PlayersByItemInputDTO} [playersByItemInputDTO] PlayersByItemInputDTO
|
|
23989
|
+
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
23990
|
+
* @summary Get players by item
|
|
23991
|
+
* @param {PlayersByItemInputDTO} [playersByItemInputDTO] PlayersByItemInputDTO
|
|
23992
|
+
* @param {*} [options] Override http request option.
|
|
23993
|
+
* @throws {RequiredError}
|
|
23994
|
+
*/
|
|
23995
|
+
trackingControllerGetPlayersByItem: async (playersByItemInputDTO, options = {}) => {
|
|
23996
|
+
const localVarPath = `/tracking/inventory/item`;
|
|
23997
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23998
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23999
|
+
let baseOptions;
|
|
24000
|
+
if (configuration) {
|
|
24001
|
+
baseOptions = configuration.baseOptions;
|
|
24002
|
+
}
|
|
24003
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
24004
|
+
const localVarHeaderParameter = {};
|
|
24005
|
+
const localVarQueryParameter = {};
|
|
24006
|
+
// authentication bearerAuth required
|
|
24007
|
+
// http bearer authentication required
|
|
24008
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24009
|
+
// authentication domainAuth required
|
|
24010
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24011
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24012
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24013
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
24014
|
+
localVarRequestOptions.data = serializeDataIfNeeded(playersByItemInputDTO, localVarRequestOptions, configuration);
|
|
24015
|
+
return {
|
|
24016
|
+
url: toPathString(localVarUrlObj),
|
|
24017
|
+
options: localVarRequestOptions,
|
|
24018
|
+
};
|
|
24019
|
+
},
|
|
24020
|
+
/**
|
|
24021
|
+
* The Position samples inside an area, in time order, optionally for chosen players. Same input as the area search, within 31 days. At most 10000 samples; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionAreaSamples`
|
|
24022
|
+
* @summary Get position area samples
|
|
24023
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24024
|
+
* @param {*} [options] Override http request option.
|
|
24025
|
+
* @throws {RequiredError}
|
|
24026
|
+
*/
|
|
24027
|
+
trackingControllerGetPositionAreaSamples: async (positionAreaInputDTO, options = {}) => {
|
|
24028
|
+
const localVarPath = `/tracking/positions/area/samples`;
|
|
24029
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24030
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24031
|
+
let baseOptions;
|
|
24032
|
+
if (configuration) {
|
|
24033
|
+
baseOptions = configuration.baseOptions;
|
|
24034
|
+
}
|
|
24035
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
24036
|
+
const localVarHeaderParameter = {};
|
|
24037
|
+
const localVarQueryParameter = {};
|
|
24038
|
+
// authentication bearerAuth required
|
|
24039
|
+
// http bearer authentication required
|
|
24040
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24041
|
+
// authentication domainAuth required
|
|
24042
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24043
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24044
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24045
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
24046
|
+
localVarRequestOptions.data = serializeDataIfNeeded(positionAreaInputDTO, localVarRequestOptions, configuration);
|
|
24047
|
+
return {
|
|
24048
|
+
url: toPathString(localVarUrlObj),
|
|
24049
|
+
options: localVarRequestOptions,
|
|
24050
|
+
};
|
|
24051
|
+
},
|
|
24052
|
+
/**
|
|
24053
|
+
* Where every player of a game server was at a moment, in one Dimension: each player\'s last Position sample at or before the moment, omitting players with no sample in the two minutes before it. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionSnapshot`
|
|
24054
|
+
* @summary Get position snapshot
|
|
24055
|
+
* @param {PositionSnapshotInputDTO} [positionSnapshotInputDTO] PositionSnapshotInputDTO
|
|
24056
|
+
* @param {*} [options] Override http request option.
|
|
24057
|
+
* @throws {RequiredError}
|
|
24058
|
+
*/
|
|
24059
|
+
trackingControllerGetPositionSnapshot: async (positionSnapshotInputDTO, options = {}) => {
|
|
24060
|
+
const localVarPath = `/tracking/positions/snapshot`;
|
|
24061
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24062
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24063
|
+
let baseOptions;
|
|
24064
|
+
if (configuration) {
|
|
24065
|
+
baseOptions = configuration.baseOptions;
|
|
24066
|
+
}
|
|
24067
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
24068
|
+
const localVarHeaderParameter = {};
|
|
24069
|
+
const localVarQueryParameter = {};
|
|
24070
|
+
// authentication bearerAuth required
|
|
24071
|
+
// http bearer authentication required
|
|
24072
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24073
|
+
// authentication domainAuth required
|
|
24074
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24075
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24076
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24077
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
24078
|
+
localVarRequestOptions.data = serializeDataIfNeeded(positionSnapshotInputDTO, localVarRequestOptions, configuration);
|
|
24079
|
+
return {
|
|
24080
|
+
url: toPathString(localVarUrlObj),
|
|
24081
|
+
options: localVarRequestOptions,
|
|
24082
|
+
};
|
|
24083
|
+
},
|
|
24084
|
+
/**
|
|
24085
|
+
* Position samples per player for a game server, Dimension and time range (at most 31 days), optionally for chosen players. Downsampled on the server: one sample per player per bucket, where bucketMs grows with the range. At most 100000 samples in all; `truncated` is true when whole players were left out to stay within that. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionTracks`
|
|
24086
|
+
* @summary Get position tracks
|
|
24087
|
+
* @param {PositionTracksInputDTO} [positionTracksInputDTO] PositionTracksInputDTO
|
|
24088
|
+
* @param {*} [options] Override http request option.
|
|
24089
|
+
* @throws {RequiredError}
|
|
24090
|
+
*/
|
|
24091
|
+
trackingControllerGetPositionTracks: async (positionTracksInputDTO, options = {}) => {
|
|
24092
|
+
const localVarPath = `/tracking/positions/tracks`;
|
|
24093
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24094
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24095
|
+
let baseOptions;
|
|
24096
|
+
if (configuration) {
|
|
24097
|
+
baseOptions = configuration.baseOptions;
|
|
24098
|
+
}
|
|
24099
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
24100
|
+
const localVarHeaderParameter = {};
|
|
24101
|
+
const localVarQueryParameter = {};
|
|
24102
|
+
// authentication bearerAuth required
|
|
24103
|
+
// http bearer authentication required
|
|
24104
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24105
|
+
// authentication domainAuth required
|
|
24106
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24107
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24108
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24109
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
24110
|
+
localVarRequestOptions.data = serializeDataIfNeeded(positionTracksInputDTO, localVarRequestOptions, configuration);
|
|
24111
|
+
return {
|
|
24112
|
+
url: toPathString(localVarUrlObj),
|
|
24113
|
+
options: localVarRequestOptions,
|
|
24114
|
+
};
|
|
24115
|
+
},
|
|
24116
|
+
/**
|
|
24117
|
+
* Find all players within a spherical area from a center point Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetRadiusPlayers`
|
|
24118
|
+
* @summary Get radius players
|
|
24119
|
+
* @param {RadiusSearchInputDTO} [radiusSearchInputDTO] RadiusSearchInputDTO
|
|
24120
|
+
* @param {*} [options] Override http request option.
|
|
24121
|
+
* @throws {RequiredError}
|
|
24122
|
+
*/
|
|
24123
|
+
trackingControllerGetRadiusPlayers: async (radiusSearchInputDTO, options = {}) => {
|
|
24124
|
+
const localVarPath = `/tracking/location/radius`;
|
|
24125
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24126
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24127
|
+
let baseOptions;
|
|
24128
|
+
if (configuration) {
|
|
24129
|
+
baseOptions = configuration.baseOptions;
|
|
24130
|
+
}
|
|
24131
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
24132
|
+
const localVarHeaderParameter = {};
|
|
24133
|
+
const localVarQueryParameter = {};
|
|
24134
|
+
// authentication bearerAuth required
|
|
24135
|
+
// http bearer authentication required
|
|
24136
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24137
|
+
// authentication domainAuth required
|
|
24138
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24139
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24140
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24141
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
24142
|
+
localVarRequestOptions.data = serializeDataIfNeeded(radiusSearchInputDTO, localVarRequestOptions, configuration);
|
|
24143
|
+
return {
|
|
24144
|
+
url: toPathString(localVarUrlObj),
|
|
24145
|
+
options: localVarRequestOptions,
|
|
24146
|
+
};
|
|
24147
|
+
},
|
|
24148
|
+
/**
|
|
24149
|
+
* Inventory gains on a game server during a time range (at most 7 days) by players whose Position at the moment of the gain was inside a shape (circle, rectangle or polygon) in a Dimension, with an optional height range. The Position is the one the game reported with the change, else the player\'s last Position sample at most 2 minutes earlier; `positionSource` says which. In time order, with cause and counterpart where reported. This is evidence, not proof of theft. At most 5000 gains; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchAreaGains`
|
|
24150
|
+
* @summary Search area gains
|
|
24151
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24152
|
+
* @param {*} [options] Override http request option.
|
|
24153
|
+
* @throws {RequiredError}
|
|
24154
|
+
*/
|
|
24155
|
+
trackingControllerSearchAreaGains: async (positionAreaInputDTO, options = {}) => {
|
|
24156
|
+
const localVarPath = `/tracking/inventory/area-gains`;
|
|
24157
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24158
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24159
|
+
let baseOptions;
|
|
24160
|
+
if (configuration) {
|
|
24161
|
+
baseOptions = configuration.baseOptions;
|
|
24162
|
+
}
|
|
24163
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
24164
|
+
const localVarHeaderParameter = {};
|
|
24165
|
+
const localVarQueryParameter = {};
|
|
24166
|
+
// authentication bearerAuth required
|
|
24167
|
+
// http bearer authentication required
|
|
24168
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
24169
|
+
// authentication domainAuth required
|
|
24170
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24171
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24172
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24173
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
24174
|
+
localVarRequestOptions.data = serializeDataIfNeeded(positionAreaInputDTO, localVarRequestOptions, configuration);
|
|
24175
|
+
return {
|
|
24176
|
+
url: toPathString(localVarUrlObj),
|
|
24177
|
+
options: localVarRequestOptions,
|
|
24178
|
+
};
|
|
24179
|
+
},
|
|
24180
|
+
/**
|
|
24181
|
+
* Deaths, kills, connects and disconnects of a game server during a time range (at most 31 days), in time order, each with a Position: the one the game reported with the event, else the player\'s nearest Position sample within 2 minutes before or after (positionSource \'sampled\', approximate), else none. At most 2000 events; truncated is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`, `READ_EVENTS`<br> OperationId: `TrackingControllerSearchEvents`
|
|
24182
|
+
* @summary Search events
|
|
24183
|
+
* @param {TrackingEventsInputDTO} [trackingEventsInputDTO] TrackingEventsInputDTO
|
|
22397
24184
|
* @param {*} [options] Override http request option.
|
|
22398
24185
|
* @throws {RequiredError}
|
|
22399
24186
|
*/
|
|
22400
|
-
|
|
22401
|
-
const localVarPath = `/tracking/
|
|
24187
|
+
trackingControllerSearchEvents: async (trackingEventsInputDTO, options = {}) => {
|
|
24188
|
+
const localVarPath = `/tracking/events`;
|
|
22402
24189
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22403
24190
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22404
24191
|
let baseOptions;
|
|
@@ -22416,21 +24203,21 @@ export const TrackingApiAxiosParamCreator = function (configuration) {
|
|
|
22416
24203
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22417
24204
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22418
24205
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
22419
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
24206
|
+
localVarRequestOptions.data = serializeDataIfNeeded(trackingEventsInputDTO, localVarRequestOptions, configuration);
|
|
22420
24207
|
return {
|
|
22421
24208
|
url: toPathString(localVarUrlObj),
|
|
22422
24209
|
options: localVarRequestOptions,
|
|
22423
24210
|
};
|
|
22424
24211
|
},
|
|
22425
24212
|
/**
|
|
22426
|
-
*
|
|
22427
|
-
* @summary
|
|
22428
|
-
* @param {
|
|
24213
|
+
* Who was inside an area of a game server\'s Dimension during a time range (at most 31 days): per player, first seen, last seen and sample count. The shape (circle, rectangle or polygon) is given in game coordinates on the Dimension\'s two map axes; height (the third axis) is ignored unless minHeight or maxHeight is given. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchPositionArea`
|
|
24214
|
+
* @summary Search position area
|
|
24215
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
22429
24216
|
* @param {*} [options] Override http request option.
|
|
22430
24217
|
* @throws {RequiredError}
|
|
22431
24218
|
*/
|
|
22432
|
-
|
|
22433
|
-
const localVarPath = `/tracking/
|
|
24219
|
+
trackingControllerSearchPositionArea: async (positionAreaInputDTO, options = {}) => {
|
|
24220
|
+
const localVarPath = `/tracking/positions/area`;
|
|
22434
24221
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22435
24222
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22436
24223
|
let baseOptions;
|
|
@@ -22448,7 +24235,7 @@ export const TrackingApiAxiosParamCreator = function (configuration) {
|
|
|
22448
24235
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22449
24236
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22450
24237
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
22451
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
24238
|
+
localVarRequestOptions.data = serializeDataIfNeeded(positionAreaInputDTO, localVarRequestOptions, configuration);
|
|
22452
24239
|
return {
|
|
22453
24240
|
url: toPathString(localVarUrlObj),
|
|
22454
24241
|
options: localVarRequestOptions,
|
|
@@ -22464,7 +24251,7 @@ export const TrackingApiFp = function (configuration) {
|
|
|
22464
24251
|
const localVarAxiosParamCreator = TrackingApiAxiosParamCreator(configuration);
|
|
22465
24252
|
return {
|
|
22466
24253
|
/**
|
|
22467
|
-
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
24254
|
+
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
22468
24255
|
* @summary Get bounding box players
|
|
22469
24256
|
* @param {BoundingBoxSearchInputDTO} [boundingBoxSearchInputDTO] BoundingBoxSearchInputDTO
|
|
22470
24257
|
* @param {*} [options] Override http request option.
|
|
@@ -22477,7 +24264,46 @@ export const TrackingApiFp = function (configuration) {
|
|
|
22477
24264
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22478
24265
|
},
|
|
22479
24266
|
/**
|
|
22480
|
-
*
|
|
24267
|
+
* A player\'s inventory on a game server at a moment, reconstructed from their latest inventory snapshot at or before the moment (within 31 days) plus the changes after it. snapshotTime is absent when no snapshot exists, meaning the inventory is not known. At most 1000 items; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryAt`
|
|
24268
|
+
* @summary Get inventory at
|
|
24269
|
+
* @param {InventoryAtInputDTO} [inventoryAtInputDTO] InventoryAtInputDTO
|
|
24270
|
+
* @param {*} [options] Override http request option.
|
|
24271
|
+
* @throws {RequiredError}
|
|
24272
|
+
*/
|
|
24273
|
+
async trackingControllerGetInventoryAt(inventoryAtInputDTO, options) {
|
|
24274
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerGetInventoryAt(inventoryAtInputDTO, options);
|
|
24275
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24276
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerGetInventoryAt']?.[localVarOperationServerIndex]?.url;
|
|
24277
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24278
|
+
},
|
|
24279
|
+
/**
|
|
24280
|
+
* A player\'s inventory changes on a game server in a time range (at most 31 days), in time order, with cause, Position and counterpart where the game reported them. Cause `unknown` marks a correction found by an hourly snapshot. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryChanges`
|
|
24281
|
+
* @summary Get inventory changes
|
|
24282
|
+
* @param {InventoryChangesInputDTO} [inventoryChangesInputDTO] InventoryChangesInputDTO
|
|
24283
|
+
* @param {*} [options] Override http request option.
|
|
24284
|
+
* @throws {RequiredError}
|
|
24285
|
+
*/
|
|
24286
|
+
async trackingControllerGetInventoryChanges(inventoryChangesInputDTO, options) {
|
|
24287
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerGetInventoryChanges(inventoryChangesInputDTO, options);
|
|
24288
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24289
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerGetInventoryChanges']?.[localVarOperationServerIndex]?.url;
|
|
24290
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24291
|
+
},
|
|
24292
|
+
/**
|
|
24293
|
+
* Who held an item of a game server during a time range (at most 31 days): per player, the periods they held it, reconstructed from inventory snapshots and changes, plus each gain and loss of the item in time order with cause, Position and counterpart where reported. A period with heldAtStart began before the range; one without end lasted past it. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetItemHolders`
|
|
24294
|
+
* @summary Get item holders
|
|
24295
|
+
* @param {ItemHoldersInputDTO} [itemHoldersInputDTO] ItemHoldersInputDTO
|
|
24296
|
+
* @param {*} [options] Override http request option.
|
|
24297
|
+
* @throws {RequiredError}
|
|
24298
|
+
*/
|
|
24299
|
+
async trackingControllerGetItemHolders(itemHoldersInputDTO, options) {
|
|
24300
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerGetItemHolders(itemHoldersInputDTO, options);
|
|
24301
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24302
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerGetItemHolders']?.[localVarOperationServerIndex]?.url;
|
|
24303
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24304
|
+
},
|
|
24305
|
+
/**
|
|
24306
|
+
* Get inventory changes for a player between two timestamps Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerInventoryHistory`
|
|
22481
24307
|
* @summary Get player inventory history
|
|
22482
24308
|
* @param {PlayerInventoryHistoryInputDTO} [playerInventoryHistoryInputDTO] PlayerInventoryHistoryInputDTO
|
|
22483
24309
|
* @param {*} [options] Override http request option.
|
|
@@ -22491,7 +24317,7 @@ export const TrackingApiFp = function (configuration) {
|
|
|
22491
24317
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22492
24318
|
},
|
|
22493
24319
|
/**
|
|
22494
|
-
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
24320
|
+
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
22495
24321
|
* @summary Get player movement history
|
|
22496
24322
|
* @param {PlayerMovementHistoryInputDTO} [playerMovementHistoryInputDTO] PlayerMovementHistoryInputDTO
|
|
22497
24323
|
* @param {*} [options] Override http request option.
|
|
@@ -22505,7 +24331,7 @@ export const TrackingApiFp = function (configuration) {
|
|
|
22505
24331
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22506
24332
|
},
|
|
22507
24333
|
/**
|
|
22508
|
-
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
24334
|
+
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
22509
24335
|
* @summary Get players by item
|
|
22510
24336
|
* @param {PlayersByItemInputDTO} [playersByItemInputDTO] PlayersByItemInputDTO
|
|
22511
24337
|
* @param {*} [options] Override http request option.
|
|
@@ -22518,7 +24344,46 @@ export const TrackingApiFp = function (configuration) {
|
|
|
22518
24344
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22519
24345
|
},
|
|
22520
24346
|
/**
|
|
22521
|
-
*
|
|
24347
|
+
* The Position samples inside an area, in time order, optionally for chosen players. Same input as the area search, within 31 days. At most 10000 samples; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionAreaSamples`
|
|
24348
|
+
* @summary Get position area samples
|
|
24349
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24350
|
+
* @param {*} [options] Override http request option.
|
|
24351
|
+
* @throws {RequiredError}
|
|
24352
|
+
*/
|
|
24353
|
+
async trackingControllerGetPositionAreaSamples(positionAreaInputDTO, options) {
|
|
24354
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerGetPositionAreaSamples(positionAreaInputDTO, options);
|
|
24355
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24356
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerGetPositionAreaSamples']?.[localVarOperationServerIndex]?.url;
|
|
24357
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24358
|
+
},
|
|
24359
|
+
/**
|
|
24360
|
+
* Where every player of a game server was at a moment, in one Dimension: each player\'s last Position sample at or before the moment, omitting players with no sample in the two minutes before it. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionSnapshot`
|
|
24361
|
+
* @summary Get position snapshot
|
|
24362
|
+
* @param {PositionSnapshotInputDTO} [positionSnapshotInputDTO] PositionSnapshotInputDTO
|
|
24363
|
+
* @param {*} [options] Override http request option.
|
|
24364
|
+
* @throws {RequiredError}
|
|
24365
|
+
*/
|
|
24366
|
+
async trackingControllerGetPositionSnapshot(positionSnapshotInputDTO, options) {
|
|
24367
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerGetPositionSnapshot(positionSnapshotInputDTO, options);
|
|
24368
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24369
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerGetPositionSnapshot']?.[localVarOperationServerIndex]?.url;
|
|
24370
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24371
|
+
},
|
|
24372
|
+
/**
|
|
24373
|
+
* Position samples per player for a game server, Dimension and time range (at most 31 days), optionally for chosen players. Downsampled on the server: one sample per player per bucket, where bucketMs grows with the range. At most 100000 samples in all; `truncated` is true when whole players were left out to stay within that. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionTracks`
|
|
24374
|
+
* @summary Get position tracks
|
|
24375
|
+
* @param {PositionTracksInputDTO} [positionTracksInputDTO] PositionTracksInputDTO
|
|
24376
|
+
* @param {*} [options] Override http request option.
|
|
24377
|
+
* @throws {RequiredError}
|
|
24378
|
+
*/
|
|
24379
|
+
async trackingControllerGetPositionTracks(positionTracksInputDTO, options) {
|
|
24380
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerGetPositionTracks(positionTracksInputDTO, options);
|
|
24381
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24382
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerGetPositionTracks']?.[localVarOperationServerIndex]?.url;
|
|
24383
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24384
|
+
},
|
|
24385
|
+
/**
|
|
24386
|
+
* Find all players within a spherical area from a center point Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetRadiusPlayers`
|
|
22522
24387
|
* @summary Get radius players
|
|
22523
24388
|
* @param {RadiusSearchInputDTO} [radiusSearchInputDTO] RadiusSearchInputDTO
|
|
22524
24389
|
* @param {*} [options] Override http request option.
|
|
@@ -22530,6 +24395,45 @@ export const TrackingApiFp = function (configuration) {
|
|
|
22530
24395
|
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerGetRadiusPlayers']?.[localVarOperationServerIndex]?.url;
|
|
22531
24396
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22532
24397
|
},
|
|
24398
|
+
/**
|
|
24399
|
+
* Inventory gains on a game server during a time range (at most 7 days) by players whose Position at the moment of the gain was inside a shape (circle, rectangle or polygon) in a Dimension, with an optional height range. The Position is the one the game reported with the change, else the player\'s last Position sample at most 2 minutes earlier; `positionSource` says which. In time order, with cause and counterpart where reported. This is evidence, not proof of theft. At most 5000 gains; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchAreaGains`
|
|
24400
|
+
* @summary Search area gains
|
|
24401
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24402
|
+
* @param {*} [options] Override http request option.
|
|
24403
|
+
* @throws {RequiredError}
|
|
24404
|
+
*/
|
|
24405
|
+
async trackingControllerSearchAreaGains(positionAreaInputDTO, options) {
|
|
24406
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerSearchAreaGains(positionAreaInputDTO, options);
|
|
24407
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24408
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerSearchAreaGains']?.[localVarOperationServerIndex]?.url;
|
|
24409
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24410
|
+
},
|
|
24411
|
+
/**
|
|
24412
|
+
* Deaths, kills, connects and disconnects of a game server during a time range (at most 31 days), in time order, each with a Position: the one the game reported with the event, else the player\'s nearest Position sample within 2 minutes before or after (positionSource \'sampled\', approximate), else none. At most 2000 events; truncated is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`, `READ_EVENTS`<br> OperationId: `TrackingControllerSearchEvents`
|
|
24413
|
+
* @summary Search events
|
|
24414
|
+
* @param {TrackingEventsInputDTO} [trackingEventsInputDTO] TrackingEventsInputDTO
|
|
24415
|
+
* @param {*} [options] Override http request option.
|
|
24416
|
+
* @throws {RequiredError}
|
|
24417
|
+
*/
|
|
24418
|
+
async trackingControllerSearchEvents(trackingEventsInputDTO, options) {
|
|
24419
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerSearchEvents(trackingEventsInputDTO, options);
|
|
24420
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24421
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerSearchEvents']?.[localVarOperationServerIndex]?.url;
|
|
24422
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24423
|
+
},
|
|
24424
|
+
/**
|
|
24425
|
+
* Who was inside an area of a game server\'s Dimension during a time range (at most 31 days): per player, first seen, last seen and sample count. The shape (circle, rectangle or polygon) is given in game coordinates on the Dimension\'s two map axes; height (the third axis) is ignored unless minHeight or maxHeight is given. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchPositionArea`
|
|
24426
|
+
* @summary Search position area
|
|
24427
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24428
|
+
* @param {*} [options] Override http request option.
|
|
24429
|
+
* @throws {RequiredError}
|
|
24430
|
+
*/
|
|
24431
|
+
async trackingControllerSearchPositionArea(positionAreaInputDTO, options) {
|
|
24432
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.trackingControllerSearchPositionArea(positionAreaInputDTO, options);
|
|
24433
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24434
|
+
const localVarOperationServerBasePath = operationServerMap['TrackingApi.trackingControllerSearchPositionArea']?.[localVarOperationServerIndex]?.url;
|
|
24435
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24436
|
+
},
|
|
22533
24437
|
};
|
|
22534
24438
|
};
|
|
22535
24439
|
/**
|
|
@@ -22540,7 +24444,7 @@ export const TrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
22540
24444
|
const localVarFp = TrackingApiFp(configuration);
|
|
22541
24445
|
return {
|
|
22542
24446
|
/**
|
|
22543
|
-
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
24447
|
+
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
22544
24448
|
* @summary Get bounding box players
|
|
22545
24449
|
* @param {BoundingBoxSearchInputDTO} [boundingBoxSearchInputDTO] BoundingBoxSearchInputDTO
|
|
22546
24450
|
* @param {*} [options] Override http request option.
|
|
@@ -22552,7 +24456,43 @@ export const TrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
22552
24456
|
.then((request) => request(axios, basePath));
|
|
22553
24457
|
},
|
|
22554
24458
|
/**
|
|
22555
|
-
*
|
|
24459
|
+
* A player\'s inventory on a game server at a moment, reconstructed from their latest inventory snapshot at or before the moment (within 31 days) plus the changes after it. snapshotTime is absent when no snapshot exists, meaning the inventory is not known. At most 1000 items; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryAt`
|
|
24460
|
+
* @summary Get inventory at
|
|
24461
|
+
* @param {InventoryAtInputDTO} [inventoryAtInputDTO] InventoryAtInputDTO
|
|
24462
|
+
* @param {*} [options] Override http request option.
|
|
24463
|
+
* @throws {RequiredError}
|
|
24464
|
+
*/
|
|
24465
|
+
trackingControllerGetInventoryAt(inventoryAtInputDTO, options) {
|
|
24466
|
+
return localVarFp
|
|
24467
|
+
.trackingControllerGetInventoryAt(inventoryAtInputDTO, options)
|
|
24468
|
+
.then((request) => request(axios, basePath));
|
|
24469
|
+
},
|
|
24470
|
+
/**
|
|
24471
|
+
* A player\'s inventory changes on a game server in a time range (at most 31 days), in time order, with cause, Position and counterpart where the game reported them. Cause `unknown` marks a correction found by an hourly snapshot. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryChanges`
|
|
24472
|
+
* @summary Get inventory changes
|
|
24473
|
+
* @param {InventoryChangesInputDTO} [inventoryChangesInputDTO] InventoryChangesInputDTO
|
|
24474
|
+
* @param {*} [options] Override http request option.
|
|
24475
|
+
* @throws {RequiredError}
|
|
24476
|
+
*/
|
|
24477
|
+
trackingControllerGetInventoryChanges(inventoryChangesInputDTO, options) {
|
|
24478
|
+
return localVarFp
|
|
24479
|
+
.trackingControllerGetInventoryChanges(inventoryChangesInputDTO, options)
|
|
24480
|
+
.then((request) => request(axios, basePath));
|
|
24481
|
+
},
|
|
24482
|
+
/**
|
|
24483
|
+
* Who held an item of a game server during a time range (at most 31 days): per player, the periods they held it, reconstructed from inventory snapshots and changes, plus each gain and loss of the item in time order with cause, Position and counterpart where reported. A period with heldAtStart began before the range; one without end lasted past it. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetItemHolders`
|
|
24484
|
+
* @summary Get item holders
|
|
24485
|
+
* @param {ItemHoldersInputDTO} [itemHoldersInputDTO] ItemHoldersInputDTO
|
|
24486
|
+
* @param {*} [options] Override http request option.
|
|
24487
|
+
* @throws {RequiredError}
|
|
24488
|
+
*/
|
|
24489
|
+
trackingControllerGetItemHolders(itemHoldersInputDTO, options) {
|
|
24490
|
+
return localVarFp
|
|
24491
|
+
.trackingControllerGetItemHolders(itemHoldersInputDTO, options)
|
|
24492
|
+
.then((request) => request(axios, basePath));
|
|
24493
|
+
},
|
|
24494
|
+
/**
|
|
24495
|
+
* Get inventory changes for a player between two timestamps Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerInventoryHistory`
|
|
22556
24496
|
* @summary Get player inventory history
|
|
22557
24497
|
* @param {PlayerInventoryHistoryInputDTO} [playerInventoryHistoryInputDTO] PlayerInventoryHistoryInputDTO
|
|
22558
24498
|
* @param {*} [options] Override http request option.
|
|
@@ -22564,7 +24504,7 @@ export const TrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
22564
24504
|
.then((request) => request(axios, basePath));
|
|
22565
24505
|
},
|
|
22566
24506
|
/**
|
|
22567
|
-
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
24507
|
+
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
22568
24508
|
* @summary Get player movement history
|
|
22569
24509
|
* @param {PlayerMovementHistoryInputDTO} [playerMovementHistoryInputDTO] PlayerMovementHistoryInputDTO
|
|
22570
24510
|
* @param {*} [options] Override http request option.
|
|
@@ -22576,7 +24516,7 @@ export const TrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
22576
24516
|
.then((request) => request(axios, basePath));
|
|
22577
24517
|
},
|
|
22578
24518
|
/**
|
|
22579
|
-
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
24519
|
+
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
22580
24520
|
* @summary Get players by item
|
|
22581
24521
|
* @param {PlayersByItemInputDTO} [playersByItemInputDTO] PlayersByItemInputDTO
|
|
22582
24522
|
* @param {*} [options] Override http request option.
|
|
@@ -22588,7 +24528,43 @@ export const TrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
22588
24528
|
.then((request) => request(axios, basePath));
|
|
22589
24529
|
},
|
|
22590
24530
|
/**
|
|
22591
|
-
*
|
|
24531
|
+
* The Position samples inside an area, in time order, optionally for chosen players. Same input as the area search, within 31 days. At most 10000 samples; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionAreaSamples`
|
|
24532
|
+
* @summary Get position area samples
|
|
24533
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24534
|
+
* @param {*} [options] Override http request option.
|
|
24535
|
+
* @throws {RequiredError}
|
|
24536
|
+
*/
|
|
24537
|
+
trackingControllerGetPositionAreaSamples(positionAreaInputDTO, options) {
|
|
24538
|
+
return localVarFp
|
|
24539
|
+
.trackingControllerGetPositionAreaSamples(positionAreaInputDTO, options)
|
|
24540
|
+
.then((request) => request(axios, basePath));
|
|
24541
|
+
},
|
|
24542
|
+
/**
|
|
24543
|
+
* Where every player of a game server was at a moment, in one Dimension: each player\'s last Position sample at or before the moment, omitting players with no sample in the two minutes before it. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionSnapshot`
|
|
24544
|
+
* @summary Get position snapshot
|
|
24545
|
+
* @param {PositionSnapshotInputDTO} [positionSnapshotInputDTO] PositionSnapshotInputDTO
|
|
24546
|
+
* @param {*} [options] Override http request option.
|
|
24547
|
+
* @throws {RequiredError}
|
|
24548
|
+
*/
|
|
24549
|
+
trackingControllerGetPositionSnapshot(positionSnapshotInputDTO, options) {
|
|
24550
|
+
return localVarFp
|
|
24551
|
+
.trackingControllerGetPositionSnapshot(positionSnapshotInputDTO, options)
|
|
24552
|
+
.then((request) => request(axios, basePath));
|
|
24553
|
+
},
|
|
24554
|
+
/**
|
|
24555
|
+
* Position samples per player for a game server, Dimension and time range (at most 31 days), optionally for chosen players. Downsampled on the server: one sample per player per bucket, where bucketMs grows with the range. At most 100000 samples in all; `truncated` is true when whole players were left out to stay within that. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionTracks`
|
|
24556
|
+
* @summary Get position tracks
|
|
24557
|
+
* @param {PositionTracksInputDTO} [positionTracksInputDTO] PositionTracksInputDTO
|
|
24558
|
+
* @param {*} [options] Override http request option.
|
|
24559
|
+
* @throws {RequiredError}
|
|
24560
|
+
*/
|
|
24561
|
+
trackingControllerGetPositionTracks(positionTracksInputDTO, options) {
|
|
24562
|
+
return localVarFp
|
|
24563
|
+
.trackingControllerGetPositionTracks(positionTracksInputDTO, options)
|
|
24564
|
+
.then((request) => request(axios, basePath));
|
|
24565
|
+
},
|
|
24566
|
+
/**
|
|
24567
|
+
* Find all players within a spherical area from a center point Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetRadiusPlayers`
|
|
22592
24568
|
* @summary Get radius players
|
|
22593
24569
|
* @param {RadiusSearchInputDTO} [radiusSearchInputDTO] RadiusSearchInputDTO
|
|
22594
24570
|
* @param {*} [options] Override http request option.
|
|
@@ -22599,6 +24575,42 @@ export const TrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
22599
24575
|
.trackingControllerGetRadiusPlayers(radiusSearchInputDTO, options)
|
|
22600
24576
|
.then((request) => request(axios, basePath));
|
|
22601
24577
|
},
|
|
24578
|
+
/**
|
|
24579
|
+
* Inventory gains on a game server during a time range (at most 7 days) by players whose Position at the moment of the gain was inside a shape (circle, rectangle or polygon) in a Dimension, with an optional height range. The Position is the one the game reported with the change, else the player\'s last Position sample at most 2 minutes earlier; `positionSource` says which. In time order, with cause and counterpart where reported. This is evidence, not proof of theft. At most 5000 gains; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchAreaGains`
|
|
24580
|
+
* @summary Search area gains
|
|
24581
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24582
|
+
* @param {*} [options] Override http request option.
|
|
24583
|
+
* @throws {RequiredError}
|
|
24584
|
+
*/
|
|
24585
|
+
trackingControllerSearchAreaGains(positionAreaInputDTO, options) {
|
|
24586
|
+
return localVarFp
|
|
24587
|
+
.trackingControllerSearchAreaGains(positionAreaInputDTO, options)
|
|
24588
|
+
.then((request) => request(axios, basePath));
|
|
24589
|
+
},
|
|
24590
|
+
/**
|
|
24591
|
+
* Deaths, kills, connects and disconnects of a game server during a time range (at most 31 days), in time order, each with a Position: the one the game reported with the event, else the player\'s nearest Position sample within 2 minutes before or after (positionSource \'sampled\', approximate), else none. At most 2000 events; truncated is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`, `READ_EVENTS`<br> OperationId: `TrackingControllerSearchEvents`
|
|
24592
|
+
* @summary Search events
|
|
24593
|
+
* @param {TrackingEventsInputDTO} [trackingEventsInputDTO] TrackingEventsInputDTO
|
|
24594
|
+
* @param {*} [options] Override http request option.
|
|
24595
|
+
* @throws {RequiredError}
|
|
24596
|
+
*/
|
|
24597
|
+
trackingControllerSearchEvents(trackingEventsInputDTO, options) {
|
|
24598
|
+
return localVarFp
|
|
24599
|
+
.trackingControllerSearchEvents(trackingEventsInputDTO, options)
|
|
24600
|
+
.then((request) => request(axios, basePath));
|
|
24601
|
+
},
|
|
24602
|
+
/**
|
|
24603
|
+
* Who was inside an area of a game server\'s Dimension during a time range (at most 31 days): per player, first seen, last seen and sample count. The shape (circle, rectangle or polygon) is given in game coordinates on the Dimension\'s two map axes; height (the third axis) is ignored unless minHeight or maxHeight is given. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchPositionArea`
|
|
24604
|
+
* @summary Search position area
|
|
24605
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24606
|
+
* @param {*} [options] Override http request option.
|
|
24607
|
+
* @throws {RequiredError}
|
|
24608
|
+
*/
|
|
24609
|
+
trackingControllerSearchPositionArea(positionAreaInputDTO, options) {
|
|
24610
|
+
return localVarFp
|
|
24611
|
+
.trackingControllerSearchPositionArea(positionAreaInputDTO, options)
|
|
24612
|
+
.then((request) => request(axios, basePath));
|
|
24613
|
+
},
|
|
22602
24614
|
};
|
|
22603
24615
|
};
|
|
22604
24616
|
/**
|
|
@@ -22609,7 +24621,7 @@ export const TrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
22609
24621
|
*/
|
|
22610
24622
|
export class TrackingApi extends BaseAPI {
|
|
22611
24623
|
/**
|
|
22612
|
-
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
24624
|
+
* Find all players within a 3D rectangular volume at a specific time Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetBoundingBoxPlayers`
|
|
22613
24625
|
* @summary Get bounding box players
|
|
22614
24626
|
* @param {BoundingBoxSearchInputDTO} [boundingBoxSearchInputDTO] BoundingBoxSearchInputDTO
|
|
22615
24627
|
* @param {*} [options] Override http request option.
|
|
@@ -22622,7 +24634,46 @@ export class TrackingApi extends BaseAPI {
|
|
|
22622
24634
|
.then((request) => request(this.axios, this.basePath));
|
|
22623
24635
|
}
|
|
22624
24636
|
/**
|
|
22625
|
-
*
|
|
24637
|
+
* A player\'s inventory on a game server at a moment, reconstructed from their latest inventory snapshot at or before the moment (within 31 days) plus the changes after it. snapshotTime is absent when no snapshot exists, meaning the inventory is not known. At most 1000 items; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryAt`
|
|
24638
|
+
* @summary Get inventory at
|
|
24639
|
+
* @param {InventoryAtInputDTO} [inventoryAtInputDTO] InventoryAtInputDTO
|
|
24640
|
+
* @param {*} [options] Override http request option.
|
|
24641
|
+
* @throws {RequiredError}
|
|
24642
|
+
* @memberof TrackingApi
|
|
24643
|
+
*/
|
|
24644
|
+
trackingControllerGetInventoryAt(inventoryAtInputDTO, options) {
|
|
24645
|
+
return TrackingApiFp(this.configuration)
|
|
24646
|
+
.trackingControllerGetInventoryAt(inventoryAtInputDTO, options)
|
|
24647
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24648
|
+
}
|
|
24649
|
+
/**
|
|
24650
|
+
* A player\'s inventory changes on a game server in a time range (at most 31 days), in time order, with cause, Position and counterpart where the game reported them. Cause `unknown` marks a correction found by an hourly snapshot. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetInventoryChanges`
|
|
24651
|
+
* @summary Get inventory changes
|
|
24652
|
+
* @param {InventoryChangesInputDTO} [inventoryChangesInputDTO] InventoryChangesInputDTO
|
|
24653
|
+
* @param {*} [options] Override http request option.
|
|
24654
|
+
* @throws {RequiredError}
|
|
24655
|
+
* @memberof TrackingApi
|
|
24656
|
+
*/
|
|
24657
|
+
trackingControllerGetInventoryChanges(inventoryChangesInputDTO, options) {
|
|
24658
|
+
return TrackingApiFp(this.configuration)
|
|
24659
|
+
.trackingControllerGetInventoryChanges(inventoryChangesInputDTO, options)
|
|
24660
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24661
|
+
}
|
|
24662
|
+
/**
|
|
24663
|
+
* Who held an item of a game server during a time range (at most 31 days): per player, the periods they held it, reconstructed from inventory snapshots and changes, plus each gain and loss of the item in time order with cause, Position and counterpart where reported. A period with heldAtStart began before the range; one without end lasted past it. At most 5000 changes; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetItemHolders`
|
|
24664
|
+
* @summary Get item holders
|
|
24665
|
+
* @param {ItemHoldersInputDTO} [itemHoldersInputDTO] ItemHoldersInputDTO
|
|
24666
|
+
* @param {*} [options] Override http request option.
|
|
24667
|
+
* @throws {RequiredError}
|
|
24668
|
+
* @memberof TrackingApi
|
|
24669
|
+
*/
|
|
24670
|
+
trackingControllerGetItemHolders(itemHoldersInputDTO, options) {
|
|
24671
|
+
return TrackingApiFp(this.configuration)
|
|
24672
|
+
.trackingControllerGetItemHolders(itemHoldersInputDTO, options)
|
|
24673
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24674
|
+
}
|
|
24675
|
+
/**
|
|
24676
|
+
* Get inventory changes for a player between two timestamps Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerInventoryHistory`
|
|
22626
24677
|
* @summary Get player inventory history
|
|
22627
24678
|
* @param {PlayerInventoryHistoryInputDTO} [playerInventoryHistoryInputDTO] PlayerInventoryHistoryInputDTO
|
|
22628
24679
|
* @param {*} [options] Override http request option.
|
|
@@ -22635,7 +24686,7 @@ export class TrackingApi extends BaseAPI {
|
|
|
22635
24686
|
.then((request) => request(this.axios, this.basePath));
|
|
22636
24687
|
}
|
|
22637
24688
|
/**
|
|
22638
|
-
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
24689
|
+
* Get movement history for players within date bounds Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayerMovementHistory`
|
|
22639
24690
|
* @summary Get player movement history
|
|
22640
24691
|
* @param {PlayerMovementHistoryInputDTO} [playerMovementHistoryInputDTO] PlayerMovementHistoryInputDTO
|
|
22641
24692
|
* @param {*} [options] Override http request option.
|
|
@@ -22648,7 +24699,7 @@ export class TrackingApi extends BaseAPI {
|
|
|
22648
24699
|
.then((request) => request(this.axios, this.basePath));
|
|
22649
24700
|
}
|
|
22650
24701
|
/**
|
|
22651
|
-
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
24702
|
+
* Find all players who have had a specific item in their inventory Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetPlayersByItem`
|
|
22652
24703
|
* @summary Get players by item
|
|
22653
24704
|
* @param {PlayersByItemInputDTO} [playersByItemInputDTO] PlayersByItemInputDTO
|
|
22654
24705
|
* @param {*} [options] Override http request option.
|
|
@@ -22661,7 +24712,46 @@ export class TrackingApi extends BaseAPI {
|
|
|
22661
24712
|
.then((request) => request(this.axios, this.basePath));
|
|
22662
24713
|
}
|
|
22663
24714
|
/**
|
|
22664
|
-
*
|
|
24715
|
+
* The Position samples inside an area, in time order, optionally for chosen players. Same input as the area search, within 31 days. At most 10000 samples; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionAreaSamples`
|
|
24716
|
+
* @summary Get position area samples
|
|
24717
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24718
|
+
* @param {*} [options] Override http request option.
|
|
24719
|
+
* @throws {RequiredError}
|
|
24720
|
+
* @memberof TrackingApi
|
|
24721
|
+
*/
|
|
24722
|
+
trackingControllerGetPositionAreaSamples(positionAreaInputDTO, options) {
|
|
24723
|
+
return TrackingApiFp(this.configuration)
|
|
24724
|
+
.trackingControllerGetPositionAreaSamples(positionAreaInputDTO, options)
|
|
24725
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24726
|
+
}
|
|
24727
|
+
/**
|
|
24728
|
+
* Where every player of a game server was at a moment, in one Dimension: each player\'s last Position sample at or before the moment, omitting players with no sample in the two minutes before it. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionSnapshot`
|
|
24729
|
+
* @summary Get position snapshot
|
|
24730
|
+
* @param {PositionSnapshotInputDTO} [positionSnapshotInputDTO] PositionSnapshotInputDTO
|
|
24731
|
+
* @param {*} [options] Override http request option.
|
|
24732
|
+
* @throws {RequiredError}
|
|
24733
|
+
* @memberof TrackingApi
|
|
24734
|
+
*/
|
|
24735
|
+
trackingControllerGetPositionSnapshot(positionSnapshotInputDTO, options) {
|
|
24736
|
+
return TrackingApiFp(this.configuration)
|
|
24737
|
+
.trackingControllerGetPositionSnapshot(positionSnapshotInputDTO, options)
|
|
24738
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24739
|
+
}
|
|
24740
|
+
/**
|
|
24741
|
+
* Position samples per player for a game server, Dimension and time range (at most 31 days), optionally for chosen players. Downsampled on the server: one sample per player per bucket, where bucketMs grows with the range. At most 100000 samples in all; `truncated` is true when whole players were left out to stay within that. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerGetPositionTracks`
|
|
24742
|
+
* @summary Get position tracks
|
|
24743
|
+
* @param {PositionTracksInputDTO} [positionTracksInputDTO] PositionTracksInputDTO
|
|
24744
|
+
* @param {*} [options] Override http request option.
|
|
24745
|
+
* @throws {RequiredError}
|
|
24746
|
+
* @memberof TrackingApi
|
|
24747
|
+
*/
|
|
24748
|
+
trackingControllerGetPositionTracks(positionTracksInputDTO, options) {
|
|
24749
|
+
return TrackingApiFp(this.configuration)
|
|
24750
|
+
.trackingControllerGetPositionTracks(positionTracksInputDTO, options)
|
|
24751
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24752
|
+
}
|
|
24753
|
+
/**
|
|
24754
|
+
* Find all players within a spherical area from a center point Required permissions: `READ_PLAYERS`, `READ_TRACKING`<br> OperationId: `TrackingControllerGetRadiusPlayers`
|
|
22665
24755
|
* @summary Get radius players
|
|
22666
24756
|
* @param {RadiusSearchInputDTO} [radiusSearchInputDTO] RadiusSearchInputDTO
|
|
22667
24757
|
* @param {*} [options] Override http request option.
|
|
@@ -22673,6 +24763,45 @@ export class TrackingApi extends BaseAPI {
|
|
|
22673
24763
|
.trackingControllerGetRadiusPlayers(radiusSearchInputDTO, options)
|
|
22674
24764
|
.then((request) => request(this.axios, this.basePath));
|
|
22675
24765
|
}
|
|
24766
|
+
/**
|
|
24767
|
+
* Inventory gains on a game server during a time range (at most 7 days) by players whose Position at the moment of the gain was inside a shape (circle, rectangle or polygon) in a Dimension, with an optional height range. The Position is the one the game reported with the change, else the player\'s last Position sample at most 2 minutes earlier; `positionSource` says which. In time order, with cause and counterpart where reported. This is evidence, not proof of theft. At most 5000 gains; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchAreaGains`
|
|
24768
|
+
* @summary Search area gains
|
|
24769
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24770
|
+
* @param {*} [options] Override http request option.
|
|
24771
|
+
* @throws {RequiredError}
|
|
24772
|
+
* @memberof TrackingApi
|
|
24773
|
+
*/
|
|
24774
|
+
trackingControllerSearchAreaGains(positionAreaInputDTO, options) {
|
|
24775
|
+
return TrackingApiFp(this.configuration)
|
|
24776
|
+
.trackingControllerSearchAreaGains(positionAreaInputDTO, options)
|
|
24777
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24778
|
+
}
|
|
24779
|
+
/**
|
|
24780
|
+
* Deaths, kills, connects and disconnects of a game server during a time range (at most 31 days), in time order, each with a Position: the one the game reported with the event, else the player\'s nearest Position sample within 2 minutes before or after (positionSource \'sampled\', approximate), else none. At most 2000 events; truncated is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`, `READ_EVENTS`<br> OperationId: `TrackingControllerSearchEvents`
|
|
24781
|
+
* @summary Search events
|
|
24782
|
+
* @param {TrackingEventsInputDTO} [trackingEventsInputDTO] TrackingEventsInputDTO
|
|
24783
|
+
* @param {*} [options] Override http request option.
|
|
24784
|
+
* @throws {RequiredError}
|
|
24785
|
+
* @memberof TrackingApi
|
|
24786
|
+
*/
|
|
24787
|
+
trackingControllerSearchEvents(trackingEventsInputDTO, options) {
|
|
24788
|
+
return TrackingApiFp(this.configuration)
|
|
24789
|
+
.trackingControllerSearchEvents(trackingEventsInputDTO, options)
|
|
24790
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24791
|
+
}
|
|
24792
|
+
/**
|
|
24793
|
+
* Who was inside an area of a game server\'s Dimension during a time range (at most 31 days): per player, first seen, last seen and sample count. The shape (circle, rectangle or polygon) is given in game coordinates on the Dimension\'s two map axes; height (the third axis) is ignored unless minHeight or maxHeight is given. At most 1000 players; `truncated` is true when there were more. Read from Tracking history; 503 when history is unavailable. Required permissions: `READ_TRACKING`<br> OperationId: `TrackingControllerSearchPositionArea`
|
|
24794
|
+
* @summary Search position area
|
|
24795
|
+
* @param {PositionAreaInputDTO} [positionAreaInputDTO] PositionAreaInputDTO
|
|
24796
|
+
* @param {*} [options] Override http request option.
|
|
24797
|
+
* @throws {RequiredError}
|
|
24798
|
+
* @memberof TrackingApi
|
|
24799
|
+
*/
|
|
24800
|
+
trackingControllerSearchPositionArea(positionAreaInputDTO, options) {
|
|
24801
|
+
return TrackingApiFp(this.configuration)
|
|
24802
|
+
.trackingControllerSearchPositionArea(positionAreaInputDTO, options)
|
|
24803
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24804
|
+
}
|
|
22676
24805
|
}
|
|
22677
24806
|
/**
|
|
22678
24807
|
* UserApi - axios parameter creator
|
|
@@ -22907,38 +25036,6 @@ export const UserApiAxiosParamCreator = function (configuration) {
|
|
|
22907
25036
|
options: localVarRequestOptions,
|
|
22908
25037
|
};
|
|
22909
25038
|
},
|
|
22910
|
-
/**
|
|
22911
|
-
* Link your player profile to Takaro, allowing web access for things like shop and stats. To get the code, use the /link command in the game.<br> OperationId: `UserControllerLinkPlayerProfile`
|
|
22912
|
-
* @summary Link player profile
|
|
22913
|
-
* @param {LinkPlayerUnauthedInputDTO} [linkPlayerUnauthedInputDTO] LinkPlayerUnauthedInputDTO
|
|
22914
|
-
* @param {*} [options] Override http request option.
|
|
22915
|
-
* @throws {RequiredError}
|
|
22916
|
-
*/
|
|
22917
|
-
userControllerLinkPlayerProfile: async (linkPlayerUnauthedInputDTO, options = {}) => {
|
|
22918
|
-
const localVarPath = `/user/player`;
|
|
22919
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22920
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22921
|
-
let baseOptions;
|
|
22922
|
-
if (configuration) {
|
|
22923
|
-
baseOptions = configuration.baseOptions;
|
|
22924
|
-
}
|
|
22925
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
22926
|
-
const localVarHeaderParameter = {};
|
|
22927
|
-
const localVarQueryParameter = {};
|
|
22928
|
-
// authentication bearerAuth required
|
|
22929
|
-
// http bearer authentication required
|
|
22930
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
22931
|
-
// authentication domainAuth required
|
|
22932
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
22933
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22934
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22935
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
22936
|
-
localVarRequestOptions.data = serializeDataIfNeeded(linkPlayerUnauthedInputDTO, localVarRequestOptions, configuration);
|
|
22937
|
-
return {
|
|
22938
|
-
url: toPathString(localVarUrlObj),
|
|
22939
|
-
options: localVarRequestOptions,
|
|
22940
|
-
};
|
|
22941
|
-
},
|
|
22942
25039
|
/**
|
|
22943
25040
|
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
22944
25041
|
* @summary Log in with a username and password
|
|
@@ -23298,19 +25395,6 @@ export const UserApiFp = function (configuration) {
|
|
|
23298
25395
|
const localVarOperationServerBasePath = operationServerMap['UserApi.userControllerInvite']?.[localVarOperationServerIndex]?.url;
|
|
23299
25396
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23300
25397
|
},
|
|
23301
|
-
/**
|
|
23302
|
-
* Link your player profile to Takaro, allowing web access for things like shop and stats. To get the code, use the /link command in the game.<br> OperationId: `UserControllerLinkPlayerProfile`
|
|
23303
|
-
* @summary Link player profile
|
|
23304
|
-
* @param {LinkPlayerUnauthedInputDTO} [linkPlayerUnauthedInputDTO] LinkPlayerUnauthedInputDTO
|
|
23305
|
-
* @param {*} [options] Override http request option.
|
|
23306
|
-
* @throws {RequiredError}
|
|
23307
|
-
*/
|
|
23308
|
-
async userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO, options) {
|
|
23309
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO, options);
|
|
23310
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
23311
|
-
const localVarOperationServerBasePath = operationServerMap['UserApi.userControllerLinkPlayerProfile']?.[localVarOperationServerIndex]?.url;
|
|
23312
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23313
|
-
},
|
|
23314
25398
|
/**
|
|
23315
25399
|
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
23316
25400
|
* @summary Log in with a username and password
|
|
@@ -23499,18 +25583,6 @@ export const UserApiFactory = function (configuration, basePath, axios) {
|
|
|
23499
25583
|
userControllerInvite(inviteCreateDTO, options) {
|
|
23500
25584
|
return localVarFp.userControllerInvite(inviteCreateDTO, options).then((request) => request(axios, basePath));
|
|
23501
25585
|
},
|
|
23502
|
-
/**
|
|
23503
|
-
* Link your player profile to Takaro, allowing web access for things like shop and stats. To get the code, use the /link command in the game.<br> OperationId: `UserControllerLinkPlayerProfile`
|
|
23504
|
-
* @summary Link player profile
|
|
23505
|
-
* @param {LinkPlayerUnauthedInputDTO} [linkPlayerUnauthedInputDTO] LinkPlayerUnauthedInputDTO
|
|
23506
|
-
* @param {*} [options] Override http request option.
|
|
23507
|
-
* @throws {RequiredError}
|
|
23508
|
-
*/
|
|
23509
|
-
userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO, options) {
|
|
23510
|
-
return localVarFp
|
|
23511
|
-
.userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO, options)
|
|
23512
|
-
.then((request) => request(axios, basePath));
|
|
23513
|
-
},
|
|
23514
25586
|
/**
|
|
23515
25587
|
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
23516
25588
|
* @summary Log in with a username and password
|
|
@@ -23692,19 +25764,6 @@ export class UserApi extends BaseAPI {
|
|
|
23692
25764
|
.userControllerInvite(inviteCreateDTO, options)
|
|
23693
25765
|
.then((request) => request(this.axios, this.basePath));
|
|
23694
25766
|
}
|
|
23695
|
-
/**
|
|
23696
|
-
* Link your player profile to Takaro, allowing web access for things like shop and stats. To get the code, use the /link command in the game.<br> OperationId: `UserControllerLinkPlayerProfile`
|
|
23697
|
-
* @summary Link player profile
|
|
23698
|
-
* @param {LinkPlayerUnauthedInputDTO} [linkPlayerUnauthedInputDTO] LinkPlayerUnauthedInputDTO
|
|
23699
|
-
* @param {*} [options] Override http request option.
|
|
23700
|
-
* @throws {RequiredError}
|
|
23701
|
-
* @memberof UserApi
|
|
23702
|
-
*/
|
|
23703
|
-
userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO, options) {
|
|
23704
|
-
return UserApiFp(this.configuration)
|
|
23705
|
-
.userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO, options)
|
|
23706
|
-
.then((request) => request(this.axios, this.basePath));
|
|
23707
|
-
}
|
|
23708
25767
|
/**
|
|
23709
25768
|
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
23710
25769
|
* @summary Log in with a username and password
|