@takaro/apiclient 2.3.2 → 2.4.0
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 +3568 -412
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/generated/api.js +1383 -213
- package/dist/generated/api.js.map +1 -1
- package/dist/generated-management/api.d.ts +352 -90
- package/dist/generated-management/api.d.ts.map +1 -1
- package/dist/generated-management/api.js +54 -0
- package/dist/generated-management/api.js.map +1 -1
- package/dist/lib/adminClient.js +7 -7
- package/dist/lib/adminClient.js.map +1 -1
- package/dist/lib/client.d.ts +2 -1
- package/dist/lib/client.d.ts.map +1 -1
- package/dist/lib/client.js +4 -1
- package/dist/lib/client.js.map +1 -1
- package/dist/lib/distributorClient.js +1 -1
- package/dist/lib/distributorClient.js.map +1 -1
- package/dist/lib/staffClient.js +7 -7
- package/dist/lib/staffClient.js.map +1 -1
- package/package.json +2 -2
package/dist/generated/api.js
CHANGED
|
@@ -85,6 +85,121 @@ export const BillingPortalSessionInputDTOFlowEnum = {
|
|
|
85
85
|
Manage: 'manage',
|
|
86
86
|
Upgrade: 'upgrade',
|
|
87
87
|
};
|
|
88
|
+
export const BlueprintApplicationOutputDTOStatusEnum = {
|
|
89
|
+
Running: 'running',
|
|
90
|
+
Succeeded: 'succeeded',
|
|
91
|
+
VerificationFailed: 'verificationFailed',
|
|
92
|
+
Failed: 'failed',
|
|
93
|
+
};
|
|
94
|
+
export const BlueprintBindingInputDTOModeEnum = {
|
|
95
|
+
Create: 'create',
|
|
96
|
+
Adopt: 'adopt',
|
|
97
|
+
Keep: 'keep',
|
|
98
|
+
Skip: 'skip',
|
|
99
|
+
};
|
|
100
|
+
export const BlueprintEntityOutputDTOModeEnum = {
|
|
101
|
+
Created: 'created',
|
|
102
|
+
Adopted: 'adopted',
|
|
103
|
+
};
|
|
104
|
+
export const BlueprintEntityOutputDTOStateEnum = {
|
|
105
|
+
Active: 'active',
|
|
106
|
+
Pending: 'pending',
|
|
107
|
+
Uncertain: 'uncertain',
|
|
108
|
+
Deleting: 'deleting',
|
|
109
|
+
Released: 'released',
|
|
110
|
+
DeleteFailed: 'delete_failed',
|
|
111
|
+
};
|
|
112
|
+
export const BlueprintFindingDTOSeverityEnum = {
|
|
113
|
+
Block: 'block',
|
|
114
|
+
Warn: 'warn',
|
|
115
|
+
};
|
|
116
|
+
export const BlueprintOperationDTOKindEnum = {
|
|
117
|
+
ModuleImport: 'moduleImport',
|
|
118
|
+
ModuleInstall: 'moduleInstall',
|
|
119
|
+
Setting: 'setting',
|
|
120
|
+
ItemSet: 'itemSet',
|
|
121
|
+
PlayerRolePermissions: 'playerRolePermissions',
|
|
122
|
+
Role: 'role',
|
|
123
|
+
Listing: 'listing',
|
|
124
|
+
ListingPublish: 'listingPublish',
|
|
125
|
+
};
|
|
126
|
+
export const BlueprintOperationDTOPhaseEnum = {
|
|
127
|
+
A: 'A',
|
|
128
|
+
B: 'B',
|
|
129
|
+
};
|
|
130
|
+
export const BlueprintOperationDTOActionEnum = {
|
|
131
|
+
Create: 'create',
|
|
132
|
+
Update: 'update',
|
|
133
|
+
Noop: 'noop',
|
|
134
|
+
Keep: 'keep',
|
|
135
|
+
Skip: 'skip',
|
|
136
|
+
};
|
|
137
|
+
export const BlueprintOperationDTOBindingEnum = {
|
|
138
|
+
Create: 'create',
|
|
139
|
+
Adopt: 'adopt',
|
|
140
|
+
Keep: 'keep',
|
|
141
|
+
Skip: 'skip',
|
|
142
|
+
};
|
|
143
|
+
export const BlueprintOperationDTOReasonEnum = {
|
|
144
|
+
AwaitingAnswer: 'awaitingAnswer',
|
|
145
|
+
Declined: 'declined',
|
|
146
|
+
ReferenceSkipped: 'referenceSkipped',
|
|
147
|
+
Bound: 'bound',
|
|
148
|
+
};
|
|
149
|
+
export const BlueprintOperationPermissionDTOActionEnum = {
|
|
150
|
+
Add: 'add',
|
|
151
|
+
Noop: 'noop',
|
|
152
|
+
Keep: 'keep',
|
|
153
|
+
};
|
|
154
|
+
export const BlueprintOperationRolePermissionDTOActionEnum = {
|
|
155
|
+
Add: 'add',
|
|
156
|
+
Noop: 'noop',
|
|
157
|
+
Keep: 'keep',
|
|
158
|
+
};
|
|
159
|
+
export const BlueprintPlanInputDTOBindingsValueModeEnum = {
|
|
160
|
+
Create: 'create',
|
|
161
|
+
Adopt: 'adopt',
|
|
162
|
+
Keep: 'keep',
|
|
163
|
+
Skip: 'skip',
|
|
164
|
+
};
|
|
165
|
+
export const BlueprintQuestionDTOTypeEnum = {
|
|
166
|
+
Bool: 'bool',
|
|
167
|
+
};
|
|
168
|
+
export const BlueprintResolutionOutputDTOStatusEnum = {
|
|
169
|
+
Resolving: 'resolving',
|
|
170
|
+
Ready: 'ready',
|
|
171
|
+
};
|
|
172
|
+
export const BlueprintResolutionOutputDTOSourceEnum = {
|
|
173
|
+
TakaroAi: 'takaroAi',
|
|
174
|
+
Engine: 'engine',
|
|
175
|
+
};
|
|
176
|
+
export const BlueprintResolutionProposalQuestionDTOSourceEnum = {
|
|
177
|
+
TakaroAi: 'takaroAi',
|
|
178
|
+
Engine: 'engine',
|
|
179
|
+
};
|
|
180
|
+
export const BlueprintResolutionQuestionDTOSourceEnum = {
|
|
181
|
+
TakaroAi: 'takaroAi',
|
|
182
|
+
Engine: 'engine',
|
|
183
|
+
};
|
|
184
|
+
export const BlueprintResolutionSlotDTOKindEnum = {
|
|
185
|
+
Module: 'module',
|
|
186
|
+
Setting: 'setting',
|
|
187
|
+
ItemSet: 'itemSet',
|
|
188
|
+
Listing: 'listing',
|
|
189
|
+
PlayerRolePermissions: 'playerRolePermissions',
|
|
190
|
+
Role: 'role',
|
|
191
|
+
};
|
|
192
|
+
export const BlueprintSnapshotInstallationDTOSourceEnum = {
|
|
193
|
+
Official: 'official',
|
|
194
|
+
Community: 'community',
|
|
195
|
+
Custom: 'custom',
|
|
196
|
+
};
|
|
197
|
+
export const BlueprintSnapshotSettingDTOSourceEnum = {
|
|
198
|
+
Override: 'override',
|
|
199
|
+
Global: 'global',
|
|
200
|
+
Inherit: 'inherit',
|
|
201
|
+
Default: 'default',
|
|
202
|
+
};
|
|
88
203
|
export const BoardChartOutcomeDTOStatusEnum = {
|
|
89
204
|
Ok: 'ok',
|
|
90
205
|
NeedsPermission: 'needs-permission',
|
|
@@ -373,6 +488,7 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
373
488
|
GameserverUpdated: 'gameserver-updated',
|
|
374
489
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
375
490
|
GameserverDeleted: 'gameserver-deleted',
|
|
491
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
376
492
|
PlayerBanned: 'player-banned',
|
|
377
493
|
PlayerUnbanned: 'player-unbanned',
|
|
378
494
|
PlayerKicked: 'player-kicked',
|
|
@@ -446,6 +562,7 @@ export const EventExploreFiltersDTOEventNameEnum = {
|
|
|
446
562
|
GameserverUpdated: 'gameserver-updated',
|
|
447
563
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
448
564
|
GameserverDeleted: 'gameserver-deleted',
|
|
565
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
449
566
|
PlayerBanned: 'player-banned',
|
|
450
567
|
PlayerUnbanned: 'player-unbanned',
|
|
451
568
|
PlayerKicked: 'player-kicked',
|
|
@@ -528,6 +645,7 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
528
645
|
GameserverUpdated: 'gameserver-updated',
|
|
529
646
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
530
647
|
GameserverDeleted: 'gameserver-deleted',
|
|
648
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
531
649
|
PlayerBanned: 'player-banned',
|
|
532
650
|
PlayerUnbanned: 'player-unbanned',
|
|
533
651
|
PlayerKicked: 'player-kicked',
|
|
@@ -601,6 +719,7 @@ export const EventSearchInputAllowedFiltersEventNameEnum = {
|
|
|
601
719
|
GameserverUpdated: 'gameserver-updated',
|
|
602
720
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
603
721
|
GameserverDeleted: 'gameserver-deleted',
|
|
722
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
604
723
|
PlayerBanned: 'player-banned',
|
|
605
724
|
PlayerUnbanned: 'player-unbanned',
|
|
606
725
|
PlayerKicked: 'player-kicked',
|
|
@@ -680,6 +799,11 @@ export const FunctionSearchInputDTOSortDirectionEnum = {
|
|
|
680
799
|
Asc: 'asc',
|
|
681
800
|
Desc: 'desc',
|
|
682
801
|
};
|
|
802
|
+
export const GameServerCapabilitiesOutputDTOStatusEnum = {
|
|
803
|
+
Declared: 'declared',
|
|
804
|
+
Implied: 'implied',
|
|
805
|
+
Unknown: 'unknown',
|
|
806
|
+
};
|
|
683
807
|
export const GameServerCreateDTOTypeEnum = {
|
|
684
808
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
685
809
|
Rust: 'RUST',
|
|
@@ -708,6 +832,18 @@ export const GameServerOutputDTOServerStatsVisibilityEnum = {
|
|
|
708
832
|
Public: 'public',
|
|
709
833
|
Admin: 'admin',
|
|
710
834
|
};
|
|
835
|
+
export const GameServerRegistrationFailureInputDTOReasonEnum = {
|
|
836
|
+
LimitReached: 'limit_reached',
|
|
837
|
+
Invalid: 'invalid',
|
|
838
|
+
UnsupportedProtocol: 'unsupported_protocol',
|
|
839
|
+
Internal: 'internal',
|
|
840
|
+
};
|
|
841
|
+
export const GameServerRegistrationFailureOutputDTOReasonEnum = {
|
|
842
|
+
LimitReached: 'limit_reached',
|
|
843
|
+
Invalid: 'invalid',
|
|
844
|
+
UnsupportedProtocol: 'unsupported_protocol',
|
|
845
|
+
Internal: 'internal',
|
|
846
|
+
};
|
|
711
847
|
export const GameServerSearchInputAllowedFiltersTypeEnum = {
|
|
712
848
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
713
849
|
Rust: 'RUST',
|
|
@@ -839,6 +975,7 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
839
975
|
GameserverUpdated: 'gameserver-updated',
|
|
840
976
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
841
977
|
GameserverDeleted: 'gameserver-deleted',
|
|
978
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
842
979
|
PlayerBanned: 'player-banned',
|
|
843
980
|
PlayerUnbanned: 'player-unbanned',
|
|
844
981
|
PlayerKicked: 'player-kicked',
|
|
@@ -914,6 +1051,7 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
914
1051
|
GameserverUpdated: 'gameserver-updated',
|
|
915
1052
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
916
1053
|
GameserverDeleted: 'gameserver-deleted',
|
|
1054
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
917
1055
|
PlayerBanned: 'player-banned',
|
|
918
1056
|
PlayerUnbanned: 'player-unbanned',
|
|
919
1057
|
PlayerKicked: 'player-kicked',
|
|
@@ -989,6 +1127,7 @@ export const HookSearchInputAllowedFiltersEventTypeEnum = {
|
|
|
989
1127
|
GameserverUpdated: 'gameserver-updated',
|
|
990
1128
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
991
1129
|
GameserverDeleted: 'gameserver-deleted',
|
|
1130
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
992
1131
|
PlayerBanned: 'player-banned',
|
|
993
1132
|
PlayerUnbanned: 'player-unbanned',
|
|
994
1133
|
PlayerKicked: 'player-kicked',
|
|
@@ -1072,6 +1211,7 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
1072
1211
|
GameserverUpdated: 'gameserver-updated',
|
|
1073
1212
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
1074
1213
|
GameserverDeleted: 'gameserver-deleted',
|
|
1214
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
1075
1215
|
PlayerBanned: 'player-banned',
|
|
1076
1216
|
PlayerUnbanned: 'player-unbanned',
|
|
1077
1217
|
PlayerKicked: 'player-kicked',
|
|
@@ -1147,6 +1287,7 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
1147
1287
|
GameserverUpdated: 'gameserver-updated',
|
|
1148
1288
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
1149
1289
|
GameserverDeleted: 'gameserver-deleted',
|
|
1290
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
1150
1291
|
PlayerBanned: 'player-banned',
|
|
1151
1292
|
PlayerUnbanned: 'player-unbanned',
|
|
1152
1293
|
PlayerKicked: 'player-kicked',
|
|
@@ -1227,6 +1368,7 @@ export const IHookEventTypeEnum = {
|
|
|
1227
1368
|
GameserverUpdated: 'gameserver-updated',
|
|
1228
1369
|
GameserverVersionChanged: 'gameserver-version-changed',
|
|
1229
1370
|
GameserverDeleted: 'gameserver-deleted',
|
|
1371
|
+
GameserverRegistrationFailed: 'gameserver-registration-failed',
|
|
1230
1372
|
PlayerBanned: 'player-banned',
|
|
1231
1373
|
PlayerUnbanned: 'player-unbanned',
|
|
1232
1374
|
PlayerKicked: 'player-kicked',
|
|
@@ -1453,6 +1595,7 @@ export const MetaFilterGroupOrLeafDTOOperatorEnum = {
|
|
|
1453
1595
|
export const ModuleCompatibilityOutputDTOManifestEnum = {
|
|
1454
1596
|
Declared: 'declared',
|
|
1455
1597
|
Implied: 'implied',
|
|
1598
|
+
Unknown: 'unknown',
|
|
1456
1599
|
};
|
|
1457
1600
|
export const ModuleInstallationComponentKpiDTOTypeEnum = {
|
|
1458
1601
|
Hook: 'hook',
|
|
@@ -1466,6 +1609,15 @@ export const ModuleInstallationKpisQueryDTOPeriodEnum = {
|
|
|
1466
1609
|
_30d: '30d',
|
|
1467
1610
|
_90d: '90d',
|
|
1468
1611
|
};
|
|
1612
|
+
export const ModuleInstallationSearchInputDTOSortByEnum = {
|
|
1613
|
+
Id: 'id',
|
|
1614
|
+
CreatedAt: 'createdAt',
|
|
1615
|
+
UpdatedAt: 'updatedAt',
|
|
1616
|
+
GameserverId: 'gameserverId',
|
|
1617
|
+
ModuleId: 'moduleId',
|
|
1618
|
+
VersionId: 'versionId',
|
|
1619
|
+
ModuleName: 'moduleName',
|
|
1620
|
+
};
|
|
1469
1621
|
export const ModuleInstallationSearchInputDTOSortDirectionEnum = {
|
|
1470
1622
|
Asc: 'asc',
|
|
1471
1623
|
Desc: 'desc',
|
|
@@ -1832,6 +1984,12 @@ export const ShopListingUpdateDTORequiredVariableOperatorEnum = {
|
|
|
1832
1984
|
Gt: 'gt',
|
|
1833
1985
|
Lt: 'lt',
|
|
1834
1986
|
};
|
|
1987
|
+
export const ShopOrderActionOutcomeDTOStatusEnum = {
|
|
1988
|
+
Pending: 'PENDING',
|
|
1989
|
+
Succeeded: 'SUCCEEDED',
|
|
1990
|
+
Failed: 'FAILED',
|
|
1991
|
+
Skipped: 'SKIPPED',
|
|
1992
|
+
};
|
|
1835
1993
|
export const ShopOrderDeliveryItemDTOResultEnum = {
|
|
1836
1994
|
Delivered: 'DELIVERED',
|
|
1837
1995
|
Failed: 'FAILED',
|
|
@@ -1886,6 +2044,8 @@ export const ShopPurchaseResultDTOOutcomeEnum = {
|
|
|
1886
2044
|
NoLongerAvailable: 'no-longer-available',
|
|
1887
2045
|
RequirementNotMet: 'requirement-not-met',
|
|
1888
2046
|
ListingChanged: 'listing-changed',
|
|
2047
|
+
EconomyDisabled: 'economy-disabled',
|
|
2048
|
+
PriceChanged: 'price-changed',
|
|
1889
2049
|
PurchaseRefused: 'purchase-refused',
|
|
1890
2050
|
};
|
|
1891
2051
|
export const SignupCheckoutStatusDTOStatusEnum = {
|
|
@@ -2028,6 +2188,12 @@ export const TakaroEventFeatureFlagSwitchedChoiceEnum = {
|
|
|
2028
2188
|
On: 'on',
|
|
2029
2189
|
Off: 'off',
|
|
2030
2190
|
};
|
|
2191
|
+
export const TakaroEventGameserverRegistrationFailedReasonEnum = {
|
|
2192
|
+
LimitReached: 'limit_reached',
|
|
2193
|
+
Invalid: 'invalid',
|
|
2194
|
+
UnsupportedProtocol: 'unsupported_protocol',
|
|
2195
|
+
Internal: 'internal',
|
|
2196
|
+
};
|
|
2031
2197
|
export const TakaroEventInventoryCounterpartKindEnum = {
|
|
2032
2198
|
Container: 'container',
|
|
2033
2199
|
Player: 'player',
|
|
@@ -2144,6 +2310,7 @@ export const ThreadContextInputDTOTypeEnum = {
|
|
|
2144
2310
|
Event: 'event',
|
|
2145
2311
|
CsmmImport: 'csmmImport',
|
|
2146
2312
|
Board: 'board',
|
|
2313
|
+
BlueprintResolution: 'blueprintResolution',
|
|
2147
2314
|
};
|
|
2148
2315
|
export const ThreadCreateInputDTOOriginSurfaceEnum = {
|
|
2149
2316
|
CommandPalette: 'commandPalette',
|
|
@@ -2162,6 +2329,15 @@ export const ThreadCreateInputDTOOriginSurfaceEnum = {
|
|
|
2162
2329
|
EventFailure: 'eventFailure',
|
|
2163
2330
|
CsmmMigration: 'csmmMigration',
|
|
2164
2331
|
Analytics: 'analytics',
|
|
2332
|
+
Panel: 'panel',
|
|
2333
|
+
Blueprint: 'blueprint',
|
|
2334
|
+
};
|
|
2335
|
+
export const ThreadMessageContextInputDTOTypeEnum = {
|
|
2336
|
+
Player: 'player',
|
|
2337
|
+
GameServer: 'gameServer',
|
|
2338
|
+
Module: 'module',
|
|
2339
|
+
Event: 'event',
|
|
2340
|
+
Board: 'board',
|
|
2165
2341
|
};
|
|
2166
2342
|
export const ThreadOutputDTOStatusEnum = {
|
|
2167
2343
|
Idle: 'idle',
|
|
@@ -2188,6 +2364,8 @@ export const ThreadOutputDTOOriginSurfaceEnum = {
|
|
|
2188
2364
|
EventFailure: 'eventFailure',
|
|
2189
2365
|
CsmmMigration: 'csmmMigration',
|
|
2190
2366
|
Analytics: 'analytics',
|
|
2367
|
+
Panel: 'panel',
|
|
2368
|
+
Blueprint: 'blueprint',
|
|
2191
2369
|
};
|
|
2192
2370
|
export const ThreadSearchInputAllowedFiltersStatusEnum = {
|
|
2193
2371
|
Idle: 'idle',
|
|
@@ -2214,6 +2392,18 @@ export const ThreadSearchInputAllowedFiltersOriginSurfaceEnum = {
|
|
|
2214
2392
|
EventFailure: 'eventFailure',
|
|
2215
2393
|
CsmmMigration: 'csmmMigration',
|
|
2216
2394
|
Analytics: 'analytics',
|
|
2395
|
+
Panel: 'panel',
|
|
2396
|
+
Blueprint: 'blueprint',
|
|
2397
|
+
};
|
|
2398
|
+
export const ThreadSearchInputAllowedFiltersContextTypeEnum = {
|
|
2399
|
+
Player: 'player',
|
|
2400
|
+
GameServer: 'gameServer',
|
|
2401
|
+
Module: 'module',
|
|
2402
|
+
ModuleVersion: 'moduleVersion',
|
|
2403
|
+
Event: 'event',
|
|
2404
|
+
CsmmImport: 'csmmImport',
|
|
2405
|
+
Board: 'board',
|
|
2406
|
+
BlueprintResolution: 'blueprintResolution',
|
|
2217
2407
|
};
|
|
2218
2408
|
export const ThreadSearchInputDTOSortDirectionEnum = {
|
|
2219
2409
|
Asc: 'asc',
|
|
@@ -2244,6 +2434,7 @@ export const ThreadStepReferenceDTOTypeEnum = {
|
|
|
2244
2434
|
Event: 'event',
|
|
2245
2435
|
CsmmImport: 'csmmImport',
|
|
2246
2436
|
Board: 'board',
|
|
2437
|
+
BlueprintResolution: 'blueprintResolution',
|
|
2247
2438
|
};
|
|
2248
2439
|
export const ThreadStepsQueryDTOSortDirectionEnum = {
|
|
2249
2440
|
Asc: 'asc',
|
|
@@ -2274,6 +2465,8 @@ export const ThreadWithStepsOutputDTOOriginSurfaceEnum = {
|
|
|
2274
2465
|
EventFailure: 'eventFailure',
|
|
2275
2466
|
CsmmMigration: 'csmmMigration',
|
|
2276
2467
|
Analytics: 'analytics',
|
|
2468
|
+
Panel: 'panel',
|
|
2469
|
+
Blueprint: 'blueprint',
|
|
2277
2470
|
};
|
|
2278
2471
|
export const TqlSchemaTableDTOKindEnum = {
|
|
2279
2472
|
Table: 'table',
|
|
@@ -3637,7 +3830,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
3637
3830
|
};
|
|
3638
3831
|
},
|
|
3639
3832
|
/**
|
|
3640
|
-
*
|
|
3833
|
+
* Orders, revenue and buyers in the window and the previous window of the same length. Cancelled orders are left out. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopKpis`
|
|
3641
3834
|
* @summary Get shop KPI summary
|
|
3642
3835
|
* @param {string} [startDate]
|
|
3643
3836
|
* @param {string} [endDate]
|
|
@@ -3727,7 +3920,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
3727
3920
|
};
|
|
3728
3921
|
},
|
|
3729
3922
|
/**
|
|
3730
|
-
* Sums totalPrice
|
|
3923
|
+
* Sums totalPrice of shop orders that were not cancelled, by hour and day-of-week. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopRevenueHeatmap`
|
|
3731
3924
|
* @summary Get shop revenue heatmap (hour × day-of-week)
|
|
3732
3925
|
* @param {string} [startDate]
|
|
3733
3926
|
* @param {string} [endDate]
|
|
@@ -4446,7 +4639,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
4446
4639
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4447
4640
|
},
|
|
4448
4641
|
/**
|
|
4449
|
-
*
|
|
4642
|
+
* Orders, revenue and buyers in the window and the previous window of the same length. Cancelled orders are left out. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopKpis`
|
|
4450
4643
|
* @summary Get shop KPI summary
|
|
4451
4644
|
* @param {string} [startDate]
|
|
4452
4645
|
* @param {string} [endDate]
|
|
@@ -4478,7 +4671,7 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
4478
4671
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4479
4672
|
},
|
|
4480
4673
|
/**
|
|
4481
|
-
* Sums totalPrice
|
|
4674
|
+
* Sums totalPrice of shop orders that were not cancelled, by hour and day-of-week. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopRevenueHeatmap`
|
|
4482
4675
|
* @summary Get shop revenue heatmap (hour × day-of-week)
|
|
4483
4676
|
* @param {string} [startDate]
|
|
4484
4677
|
* @param {string} [endDate]
|
|
@@ -4986,7 +5179,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
4986
5179
|
.then((request) => request(axios, basePath));
|
|
4987
5180
|
},
|
|
4988
5181
|
/**
|
|
4989
|
-
*
|
|
5182
|
+
* Orders, revenue and buyers in the window and the previous window of the same length. Cancelled orders are left out. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopKpis`
|
|
4990
5183
|
* @summary Get shop KPI summary
|
|
4991
5184
|
* @param {string} [startDate]
|
|
4992
5185
|
* @param {string} [endDate]
|
|
@@ -5016,7 +5209,7 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
5016
5209
|
.then((request) => request(axios, basePath));
|
|
5017
5210
|
},
|
|
5018
5211
|
/**
|
|
5019
|
-
* Sums totalPrice
|
|
5212
|
+
* Sums totalPrice of shop orders that were not cancelled, by hour and day-of-week. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopRevenueHeatmap`
|
|
5020
5213
|
* @summary Get shop revenue heatmap (hour × day-of-week)
|
|
5021
5214
|
* @param {string} [startDate]
|
|
5022
5215
|
* @param {string} [endDate]
|
|
@@ -5545,7 +5738,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
5545
5738
|
.then((request) => request(this.axios, this.basePath));
|
|
5546
5739
|
}
|
|
5547
5740
|
/**
|
|
5548
|
-
*
|
|
5741
|
+
* Orders, revenue and buyers in the window and the previous window of the same length. Cancelled orders are left out. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopKpis`
|
|
5549
5742
|
* @summary Get shop KPI summary
|
|
5550
5743
|
* @param {string} [startDate]
|
|
5551
5744
|
* @param {string} [endDate]
|
|
@@ -5577,7 +5770,7 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
5577
5770
|
.then((request) => request(this.axios, this.basePath));
|
|
5578
5771
|
}
|
|
5579
5772
|
/**
|
|
5580
|
-
* Sums totalPrice
|
|
5773
|
+
* Sums totalPrice of shop orders that were not cancelled, by hour and day-of-week. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `AnalyticsControllerGetShopRevenueHeatmap`
|
|
5581
5774
|
* @summary Get shop revenue heatmap (hour × day-of-week)
|
|
5582
5775
|
* @param {string} [startDate]
|
|
5583
5776
|
* @param {string} [endDate]
|
|
@@ -7084,6 +7277,680 @@ export class BillingApi extends BaseAPI {
|
|
|
7084
7277
|
.then((request) => request(this.axios, this.basePath));
|
|
7085
7278
|
}
|
|
7086
7279
|
}
|
|
7280
|
+
/**
|
|
7281
|
+
* BlueprintApi - axios parameter creator
|
|
7282
|
+
* @export
|
|
7283
|
+
*/
|
|
7284
|
+
export const BlueprintApiAxiosParamCreator = function (configuration) {
|
|
7285
|
+
return {
|
|
7286
|
+
/**
|
|
7287
|
+
* Records which option the admin chose for each question (`answers`: question id to option index; an unknown question or an index out of range is a 400) and re-plans with the merged bindings, storing the block findings in `findings`. No model is called. Answers can be given in several calls; a later answer to the same question replaces the earlier one. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerAnswerResolution`
|
|
7288
|
+
* @summary Answer a Blueprint Resolution\'s questions
|
|
7289
|
+
* @param {string} id
|
|
7290
|
+
* @param {BlueprintResolutionAnswersInputDTO} [blueprintResolutionAnswersInputDTO] BlueprintResolutionAnswersInputDTO
|
|
7291
|
+
* @param {*} [options] Override http request option.
|
|
7292
|
+
* @throws {RequiredError}
|
|
7293
|
+
*/
|
|
7294
|
+
blueprintControllerAnswerResolution: async (id, blueprintResolutionAnswersInputDTO, options = {}) => {
|
|
7295
|
+
// verify required parameter 'id' is not null or undefined
|
|
7296
|
+
assertParamExists('blueprintControllerAnswerResolution', 'id', id);
|
|
7297
|
+
const localVarPath = `/blueprint/resolution/{id}/answers`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
7298
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7299
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7300
|
+
let baseOptions;
|
|
7301
|
+
if (configuration) {
|
|
7302
|
+
baseOptions = configuration.baseOptions;
|
|
7303
|
+
}
|
|
7304
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
7305
|
+
const localVarHeaderParameter = {};
|
|
7306
|
+
const localVarQueryParameter = {};
|
|
7307
|
+
// authentication bearerAuth required
|
|
7308
|
+
// http bearer authentication required
|
|
7309
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7310
|
+
// authentication domainAuth required
|
|
7311
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7312
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7313
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7314
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7315
|
+
localVarRequestOptions.data = serializeDataIfNeeded(blueprintResolutionAnswersInputDTO, localVarRequestOptions, configuration);
|
|
7316
|
+
return {
|
|
7317
|
+
url: toPathString(localVarUrlObj),
|
|
7318
|
+
options: localVarRequestOptions,
|
|
7319
|
+
};
|
|
7320
|
+
},
|
|
7321
|
+
/**
|
|
7322
|
+
* Send the same inputs as the plan, including the same `bindings`, plus its `planHash`. If a game server no longer matches the plan the answer is 409 and nothing is written: plan again. Applying a plan that was already applied returns that application unchanged. A plan with a blocking finding is a 400. The answer is the application: its `status` (`succeeded`, `verificationFailed` or `failed`), the verification `report` and one entity per slot it owns. A failure during execution is not an error response: it is a 200 with a `failed` application whose `report` says what failed (`failure`), what was undone, kept or left (`compensation`) and what to do next (`nextStep`). Everything the attempt wrote is undone in a safe order; anything still referenced by a live listing or installation is kept. The game servers are applied one after another. A failure is compensated on the server where it happened; servers applied before it are kept and later ones are not attempted (`report.servers` says which). To retry, plan the same servers again: servers already applied plan as no-ops. Apply the new `planHash`. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerApply`
|
|
7323
|
+
* @summary Apply a planned Blueprint
|
|
7324
|
+
* @param {BlueprintApplyInputDTO} [blueprintApplyInputDTO] BlueprintApplyInputDTO
|
|
7325
|
+
* @param {*} [options] Override http request option.
|
|
7326
|
+
* @throws {RequiredError}
|
|
7327
|
+
*/
|
|
7328
|
+
blueprintControllerApply: async (blueprintApplyInputDTO, options = {}) => {
|
|
7329
|
+
const localVarPath = `/blueprint/apply`;
|
|
7330
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7331
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7332
|
+
let baseOptions;
|
|
7333
|
+
if (configuration) {
|
|
7334
|
+
baseOptions = configuration.baseOptions;
|
|
7335
|
+
}
|
|
7336
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
7337
|
+
const localVarHeaderParameter = {};
|
|
7338
|
+
const localVarQueryParameter = {};
|
|
7339
|
+
// authentication bearerAuth required
|
|
7340
|
+
// http bearer authentication required
|
|
7341
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7342
|
+
// authentication domainAuth required
|
|
7343
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7344
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7345
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7346
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7347
|
+
localVarRequestOptions.data = serializeDataIfNeeded(blueprintApplyInputDTO, localVarRequestOptions, configuration);
|
|
7348
|
+
return {
|
|
7349
|
+
url: toPathString(localVarUrlObj),
|
|
7350
|
+
options: localVarRequestOptions,
|
|
7351
|
+
};
|
|
7352
|
+
},
|
|
7353
|
+
/**
|
|
7354
|
+
* Lists every Blueprint that ships with Takaro, with whether it can run on the game server (`supported`, and a `reason` when it cannot) and the same for each of its Packs. Unsupported Blueprints are listed so the reason is visible. `requiredPermissions` lists what the Blueprint and each Pack need; plan still checks the caller\'s actual permissions. A Pack whose module the official registry cannot provide is listed as unsupported with a `reason` of `moduleUnavailable: <module>` (or `registryBlocked`). Each Pack also lists its `slots` ids and, best effort, the command triggers of its modules (`commands`, empty when the registry payload is not cached). Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerCatalogue`
|
|
7355
|
+
* @summary List the Blueprints available for a game server
|
|
7356
|
+
* @param {string} gameServerId
|
|
7357
|
+
* @param {*} [options] Override http request option.
|
|
7358
|
+
* @throws {RequiredError}
|
|
7359
|
+
*/
|
|
7360
|
+
blueprintControllerCatalogue: async (gameServerId, options = {}) => {
|
|
7361
|
+
// verify required parameter 'gameServerId' is not null or undefined
|
|
7362
|
+
assertParamExists('blueprintControllerCatalogue', 'gameServerId', gameServerId);
|
|
7363
|
+
const localVarPath = `/blueprint/`;
|
|
7364
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7365
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7366
|
+
let baseOptions;
|
|
7367
|
+
if (configuration) {
|
|
7368
|
+
baseOptions = configuration.baseOptions;
|
|
7369
|
+
}
|
|
7370
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7371
|
+
const localVarHeaderParameter = {};
|
|
7372
|
+
const localVarQueryParameter = {};
|
|
7373
|
+
// authentication bearerAuth required
|
|
7374
|
+
// http bearer authentication required
|
|
7375
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7376
|
+
// authentication domainAuth required
|
|
7377
|
+
if (gameServerId !== undefined) {
|
|
7378
|
+
localVarQueryParameter['gameServerId'] = gameServerId;
|
|
7379
|
+
}
|
|
7380
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7381
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7382
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7383
|
+
return {
|
|
7384
|
+
url: toPathString(localVarUrlObj),
|
|
7385
|
+
options: localVarRequestOptions,
|
|
7386
|
+
};
|
|
7387
|
+
},
|
|
7388
|
+
/**
|
|
7389
|
+
* Judges a proposal and writes nothing: every slot has a binding or a question, modes are allowed for the slot kind, adopt targets exist, are not system roles and are not staff roles a listing sells, params fit the Blueprint, and the plan with the bindings has no block finding on a slot that is not a question. All errors are returned at once. `fallback` is the proposal with every errored slot turned into an engine question whose options are all valid. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerCheckResolution`
|
|
7390
|
+
* @summary Check a proposed set of bindings against a Blueprint Resolution
|
|
7391
|
+
* @param {string} id
|
|
7392
|
+
* @param {BlueprintResolutionCheckInputDTO} [blueprintResolutionCheckInputDTO] BlueprintResolutionCheckInputDTO
|
|
7393
|
+
* @param {*} [options] Override http request option.
|
|
7394
|
+
* @throws {RequiredError}
|
|
7395
|
+
*/
|
|
7396
|
+
blueprintControllerCheckResolution: async (id, blueprintResolutionCheckInputDTO, options = {}) => {
|
|
7397
|
+
// verify required parameter 'id' is not null or undefined
|
|
7398
|
+
assertParamExists('blueprintControllerCheckResolution', 'id', id);
|
|
7399
|
+
const localVarPath = `/blueprint/resolution/{id}/check`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
7400
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7401
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7402
|
+
let baseOptions;
|
|
7403
|
+
if (configuration) {
|
|
7404
|
+
baseOptions = configuration.baseOptions;
|
|
7405
|
+
}
|
|
7406
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
7407
|
+
const localVarHeaderParameter = {};
|
|
7408
|
+
const localVarQueryParameter = {};
|
|
7409
|
+
// authentication bearerAuth required
|
|
7410
|
+
// http bearer authentication required
|
|
7411
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7412
|
+
// authentication domainAuth required
|
|
7413
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7414
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7415
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7416
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7417
|
+
localVarRequestOptions.data = serializeDataIfNeeded(blueprintResolutionCheckInputDTO, localVarRequestOptions, configuration);
|
|
7418
|
+
return {
|
|
7419
|
+
url: toPathString(localVarUrlObj),
|
|
7420
|
+
options: localVarRequestOptions,
|
|
7421
|
+
};
|
|
7422
|
+
},
|
|
7423
|
+
/**
|
|
7424
|
+
* Gets an application with the entities it created. Each entity is checked against Takaro on read: `present` is false when what it points at (an installation, a setting) no longer exists. Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerGetApplication`
|
|
7425
|
+
* @summary Get a Blueprint application
|
|
7426
|
+
* @param {string} id
|
|
7427
|
+
* @param {*} [options] Override http request option.
|
|
7428
|
+
* @throws {RequiredError}
|
|
7429
|
+
*/
|
|
7430
|
+
blueprintControllerGetApplication: async (id, options = {}) => {
|
|
7431
|
+
// verify required parameter 'id' is not null or undefined
|
|
7432
|
+
assertParamExists('blueprintControllerGetApplication', 'id', id);
|
|
7433
|
+
const localVarPath = `/blueprint/application/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
7434
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7435
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7436
|
+
let baseOptions;
|
|
7437
|
+
if (configuration) {
|
|
7438
|
+
baseOptions = configuration.baseOptions;
|
|
7439
|
+
}
|
|
7440
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7441
|
+
const localVarHeaderParameter = {};
|
|
7442
|
+
const localVarQueryParameter = {};
|
|
7443
|
+
// authentication bearerAuth required
|
|
7444
|
+
// http bearer authentication required
|
|
7445
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7446
|
+
// authentication domainAuth required
|
|
7447
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7448
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7449
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7450
|
+
return {
|
|
7451
|
+
url: toPathString(localVarUrlObj),
|
|
7452
|
+
options: localVarRequestOptions,
|
|
7453
|
+
};
|
|
7454
|
+
},
|
|
7455
|
+
/**
|
|
7456
|
+
* Reads a resolution of the calling user (another user\'s is a 404): its `status`, the frozen `context` (slots, findings and one snapshot per game server), the `proposal` and its numbered `questions` with the answers given so far, the merged `bindings` and `params` to plan with, whether it is `complete`, the block `findings` of the last answer and whether the shipped Blueprint changed since (`stale`). Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerGetResolution`
|
|
7457
|
+
* @summary Get a Blueprint Resolution
|
|
7458
|
+
* @param {string} id
|
|
7459
|
+
* @param {*} [options] Override http request option.
|
|
7460
|
+
* @throws {RequiredError}
|
|
7461
|
+
*/
|
|
7462
|
+
blueprintControllerGetResolution: async (id, options = {}) => {
|
|
7463
|
+
// verify required parameter 'id' is not null or undefined
|
|
7464
|
+
assertParamExists('blueprintControllerGetResolution', 'id', id);
|
|
7465
|
+
const localVarPath = `/blueprint/resolution/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
7466
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7467
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7468
|
+
let baseOptions;
|
|
7469
|
+
if (configuration) {
|
|
7470
|
+
baseOptions = configuration.baseOptions;
|
|
7471
|
+
}
|
|
7472
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7473
|
+
const localVarHeaderParameter = {};
|
|
7474
|
+
const localVarQueryParameter = {};
|
|
7475
|
+
// authentication bearerAuth required
|
|
7476
|
+
// http bearer authentication required
|
|
7477
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7478
|
+
// authentication domainAuth required
|
|
7479
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7480
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7481
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7482
|
+
return {
|
|
7483
|
+
url: toPathString(localVarUrlObj),
|
|
7484
|
+
options: localVarRequestOptions,
|
|
7485
|
+
};
|
|
7486
|
+
},
|
|
7487
|
+
/**
|
|
7488
|
+
* Plans the Blueprint without bindings, as `POST /blueprint/plan` does (the same inputs minus `bindings`, and the same 403 naming every missing permission), freezes what the merge is decided on and returns the resolution. When the Domain has roles, installations, item sets or listings the Blueprint could touch, or a finding already blocks a slot, the resolution opens one Blueprint Thread in which Takaro AI proposes a binding or a question for every slot; `status` is `resolving` until it is done. There is one Thread per resolution. It does not count against the Domain\'s allowance and is held against its own Blueprint budget (`budget` shows whether it is reached, never an amount). With nothing to merge, or without Takaro AI (`aiUnavailableReason` says why), the resolution is decided by the engine alone: every slot is created, and a slot a finding blocks becomes a question with options that are all valid. Takaro AI only proposes: it has no write tool and every proposal is checked by the engine before the resolution shows it. Send the resolution\'s `bindings` and `params` to `POST /blueprint/plan` and `POST /blueprint/apply`. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerOpenResolution`
|
|
7489
|
+
* @summary Open a Blueprint Resolution: decide how a Blueprint fits the existing configuration
|
|
7490
|
+
* @param {BlueprintResolutionCreateInputDTO} [blueprintResolutionCreateInputDTO] BlueprintResolutionCreateInputDTO
|
|
7491
|
+
* @param {*} [options] Override http request option.
|
|
7492
|
+
* @throws {RequiredError}
|
|
7493
|
+
*/
|
|
7494
|
+
blueprintControllerOpenResolution: async (blueprintResolutionCreateInputDTO, options = {}) => {
|
|
7495
|
+
const localVarPath = `/blueprint/resolution`;
|
|
7496
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7497
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7498
|
+
let baseOptions;
|
|
7499
|
+
if (configuration) {
|
|
7500
|
+
baseOptions = configuration.baseOptions;
|
|
7501
|
+
}
|
|
7502
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
7503
|
+
const localVarHeaderParameter = {};
|
|
7504
|
+
const localVarQueryParameter = {};
|
|
7505
|
+
// authentication bearerAuth required
|
|
7506
|
+
// http bearer authentication required
|
|
7507
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7508
|
+
// authentication domainAuth required
|
|
7509
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7510
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7511
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7512
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7513
|
+
localVarRequestOptions.data = serializeDataIfNeeded(blueprintResolutionCreateInputDTO, localVarRequestOptions, configuration);
|
|
7514
|
+
return {
|
|
7515
|
+
url: toPathString(localVarUrlObj),
|
|
7516
|
+
options: localVarRequestOptions,
|
|
7517
|
+
};
|
|
7518
|
+
},
|
|
7519
|
+
/**
|
|
7520
|
+
* Works out what applying the Blueprint would do to the game servers in `gameServerIds` and returns it as one plan with a `planHash`. The servers are applied in the order given. Roles and Player-role grants are domain-wide: they are planned and applied once and appear once, without a `gameServerId`; every other operation, pack, item and finding names its `gameServerId`. A block on any server makes the whole plan not `applicable`. Module versions are resolved here, to exact versions, from a refreshed Official Registry manifest. Every operation is `create` (it will be written), `noop` (a previous application already did it), `keep` (the existing configuration stays as it is) or `skip`. `bindings` tells the planner what to do with a Slot, keyed by slot id: `{ mode: create | adopt | keep | skip, targetId?, version? }`. Without a binding a Slot is created when nothing conflicts, keeps its existing ownership, or is blocked by a finding that a binding resolves. `adopt` reuses an existing role (`targetId` is the role id) or the installation of the same official module (`targetId` is the installation id) and only adds to it: a role gets the union of its permissions and the Blueprint\'s, an installation gets the config keys it does not have and keeps its version and system config unless `version` names another one (the plan then lists the listings that would draft). A setting is kept, or overwritten with `create` or when an answered question consents. A malformed binding is a 400; everything else is a finding with a stable code, such as `adoptTargetMissing`, `staffRoleForSale`, `commandCollision` or `adoptedVersionOutOfRange`. A `block` finding makes the plan not `applicable`. The caller needs every permission in `requiredPermissions`; all that are missing are listed in the 403. Nothing is written to a game server. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerPlan`
|
|
7521
|
+
* @summary Plan a Blueprint for one or more game servers
|
|
7522
|
+
* @param {BlueprintPlanInputDTO} [blueprintPlanInputDTO] BlueprintPlanInputDTO
|
|
7523
|
+
* @param {*} [options] Override http request option.
|
|
7524
|
+
* @throws {RequiredError}
|
|
7525
|
+
*/
|
|
7526
|
+
blueprintControllerPlan: async (blueprintPlanInputDTO, options = {}) => {
|
|
7527
|
+
const localVarPath = `/blueprint/plan`;
|
|
7528
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7529
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7530
|
+
let baseOptions;
|
|
7531
|
+
if (configuration) {
|
|
7532
|
+
baseOptions = configuration.baseOptions;
|
|
7533
|
+
}
|
|
7534
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
7535
|
+
const localVarHeaderParameter = {};
|
|
7536
|
+
const localVarQueryParameter = {};
|
|
7537
|
+
// authentication bearerAuth required
|
|
7538
|
+
// http bearer authentication required
|
|
7539
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7540
|
+
// authentication domainAuth required
|
|
7541
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
7542
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7543
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7544
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7545
|
+
localVarRequestOptions.data = serializeDataIfNeeded(blueprintPlanInputDTO, localVarRequestOptions, configuration);
|
|
7546
|
+
return {
|
|
7547
|
+
url: toPathString(localVarUrlObj),
|
|
7548
|
+
options: localVarRequestOptions,
|
|
7549
|
+
};
|
|
7550
|
+
},
|
|
7551
|
+
/**
|
|
7552
|
+
* The slim read a Blueprint merge is decided on: settings with their source, roles with permissions and player counts, installations with source, installed version, config and command triggers, item sets and listings. A few KB; no schemas or code. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerSnapshot`
|
|
7553
|
+
* @summary Read the configuration a Blueprint merge is decided on
|
|
7554
|
+
* @param {string} gameServerId
|
|
7555
|
+
* @param {*} [options] Override http request option.
|
|
7556
|
+
* @throws {RequiredError}
|
|
7557
|
+
*/
|
|
7558
|
+
blueprintControllerSnapshot: async (gameServerId, options = {}) => {
|
|
7559
|
+
// verify required parameter 'gameServerId' is not null or undefined
|
|
7560
|
+
assertParamExists('blueprintControllerSnapshot', 'gameServerId', gameServerId);
|
|
7561
|
+
const localVarPath = `/blueprint/snapshot`;
|
|
7562
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
7563
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
7564
|
+
let baseOptions;
|
|
7565
|
+
if (configuration) {
|
|
7566
|
+
baseOptions = configuration.baseOptions;
|
|
7567
|
+
}
|
|
7568
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
7569
|
+
const localVarHeaderParameter = {};
|
|
7570
|
+
const localVarQueryParameter = {};
|
|
7571
|
+
// authentication bearerAuth required
|
|
7572
|
+
// http bearer authentication required
|
|
7573
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7574
|
+
// authentication domainAuth required
|
|
7575
|
+
if (gameServerId !== undefined) {
|
|
7576
|
+
localVarQueryParameter['gameServerId'] = gameServerId;
|
|
7577
|
+
}
|
|
7578
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7579
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7580
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
7581
|
+
return {
|
|
7582
|
+
url: toPathString(localVarUrlObj),
|
|
7583
|
+
options: localVarRequestOptions,
|
|
7584
|
+
};
|
|
7585
|
+
},
|
|
7586
|
+
};
|
|
7587
|
+
};
|
|
7588
|
+
/**
|
|
7589
|
+
* BlueprintApi - functional programming interface
|
|
7590
|
+
* @export
|
|
7591
|
+
*/
|
|
7592
|
+
export const BlueprintApiFp = function (configuration) {
|
|
7593
|
+
const localVarAxiosParamCreator = BlueprintApiAxiosParamCreator(configuration);
|
|
7594
|
+
return {
|
|
7595
|
+
/**
|
|
7596
|
+
* Records which option the admin chose for each question (`answers`: question id to option index; an unknown question or an index out of range is a 400) and re-plans with the merged bindings, storing the block findings in `findings`. No model is called. Answers can be given in several calls; a later answer to the same question replaces the earlier one. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerAnswerResolution`
|
|
7597
|
+
* @summary Answer a Blueprint Resolution\'s questions
|
|
7598
|
+
* @param {string} id
|
|
7599
|
+
* @param {BlueprintResolutionAnswersInputDTO} [blueprintResolutionAnswersInputDTO] BlueprintResolutionAnswersInputDTO
|
|
7600
|
+
* @param {*} [options] Override http request option.
|
|
7601
|
+
* @throws {RequiredError}
|
|
7602
|
+
*/
|
|
7603
|
+
async blueprintControllerAnswerResolution(id, blueprintResolutionAnswersInputDTO, options) {
|
|
7604
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerAnswerResolution(id, blueprintResolutionAnswersInputDTO, options);
|
|
7605
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7606
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerAnswerResolution']?.[localVarOperationServerIndex]?.url;
|
|
7607
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7608
|
+
},
|
|
7609
|
+
/**
|
|
7610
|
+
* Send the same inputs as the plan, including the same `bindings`, plus its `planHash`. If a game server no longer matches the plan the answer is 409 and nothing is written: plan again. Applying a plan that was already applied returns that application unchanged. A plan with a blocking finding is a 400. The answer is the application: its `status` (`succeeded`, `verificationFailed` or `failed`), the verification `report` and one entity per slot it owns. A failure during execution is not an error response: it is a 200 with a `failed` application whose `report` says what failed (`failure`), what was undone, kept or left (`compensation`) and what to do next (`nextStep`). Everything the attempt wrote is undone in a safe order; anything still referenced by a live listing or installation is kept. The game servers are applied one after another. A failure is compensated on the server where it happened; servers applied before it are kept and later ones are not attempted (`report.servers` says which). To retry, plan the same servers again: servers already applied plan as no-ops. Apply the new `planHash`. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerApply`
|
|
7611
|
+
* @summary Apply a planned Blueprint
|
|
7612
|
+
* @param {BlueprintApplyInputDTO} [blueprintApplyInputDTO] BlueprintApplyInputDTO
|
|
7613
|
+
* @param {*} [options] Override http request option.
|
|
7614
|
+
* @throws {RequiredError}
|
|
7615
|
+
*/
|
|
7616
|
+
async blueprintControllerApply(blueprintApplyInputDTO, options) {
|
|
7617
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerApply(blueprintApplyInputDTO, options);
|
|
7618
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7619
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerApply']?.[localVarOperationServerIndex]?.url;
|
|
7620
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7621
|
+
},
|
|
7622
|
+
/**
|
|
7623
|
+
* Lists every Blueprint that ships with Takaro, with whether it can run on the game server (`supported`, and a `reason` when it cannot) and the same for each of its Packs. Unsupported Blueprints are listed so the reason is visible. `requiredPermissions` lists what the Blueprint and each Pack need; plan still checks the caller\'s actual permissions. A Pack whose module the official registry cannot provide is listed as unsupported with a `reason` of `moduleUnavailable: <module>` (or `registryBlocked`). Each Pack also lists its `slots` ids and, best effort, the command triggers of its modules (`commands`, empty when the registry payload is not cached). Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerCatalogue`
|
|
7624
|
+
* @summary List the Blueprints available for a game server
|
|
7625
|
+
* @param {string} gameServerId
|
|
7626
|
+
* @param {*} [options] Override http request option.
|
|
7627
|
+
* @throws {RequiredError}
|
|
7628
|
+
*/
|
|
7629
|
+
async blueprintControllerCatalogue(gameServerId, options) {
|
|
7630
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerCatalogue(gameServerId, options);
|
|
7631
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7632
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerCatalogue']?.[localVarOperationServerIndex]?.url;
|
|
7633
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7634
|
+
},
|
|
7635
|
+
/**
|
|
7636
|
+
* Judges a proposal and writes nothing: every slot has a binding or a question, modes are allowed for the slot kind, adopt targets exist, are not system roles and are not staff roles a listing sells, params fit the Blueprint, and the plan with the bindings has no block finding on a slot that is not a question. All errors are returned at once. `fallback` is the proposal with every errored slot turned into an engine question whose options are all valid. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerCheckResolution`
|
|
7637
|
+
* @summary Check a proposed set of bindings against a Blueprint Resolution
|
|
7638
|
+
* @param {string} id
|
|
7639
|
+
* @param {BlueprintResolutionCheckInputDTO} [blueprintResolutionCheckInputDTO] BlueprintResolutionCheckInputDTO
|
|
7640
|
+
* @param {*} [options] Override http request option.
|
|
7641
|
+
* @throws {RequiredError}
|
|
7642
|
+
*/
|
|
7643
|
+
async blueprintControllerCheckResolution(id, blueprintResolutionCheckInputDTO, options) {
|
|
7644
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerCheckResolution(id, blueprintResolutionCheckInputDTO, options);
|
|
7645
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7646
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerCheckResolution']?.[localVarOperationServerIndex]?.url;
|
|
7647
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7648
|
+
},
|
|
7649
|
+
/**
|
|
7650
|
+
* Gets an application with the entities it created. Each entity is checked against Takaro on read: `present` is false when what it points at (an installation, a setting) no longer exists. Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerGetApplication`
|
|
7651
|
+
* @summary Get a Blueprint application
|
|
7652
|
+
* @param {string} id
|
|
7653
|
+
* @param {*} [options] Override http request option.
|
|
7654
|
+
* @throws {RequiredError}
|
|
7655
|
+
*/
|
|
7656
|
+
async blueprintControllerGetApplication(id, options) {
|
|
7657
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerGetApplication(id, options);
|
|
7658
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7659
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerGetApplication']?.[localVarOperationServerIndex]?.url;
|
|
7660
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7661
|
+
},
|
|
7662
|
+
/**
|
|
7663
|
+
* Reads a resolution of the calling user (another user\'s is a 404): its `status`, the frozen `context` (slots, findings and one snapshot per game server), the `proposal` and its numbered `questions` with the answers given so far, the merged `bindings` and `params` to plan with, whether it is `complete`, the block `findings` of the last answer and whether the shipped Blueprint changed since (`stale`). Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerGetResolution`
|
|
7664
|
+
* @summary Get a Blueprint Resolution
|
|
7665
|
+
* @param {string} id
|
|
7666
|
+
* @param {*} [options] Override http request option.
|
|
7667
|
+
* @throws {RequiredError}
|
|
7668
|
+
*/
|
|
7669
|
+
async blueprintControllerGetResolution(id, options) {
|
|
7670
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerGetResolution(id, options);
|
|
7671
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7672
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerGetResolution']?.[localVarOperationServerIndex]?.url;
|
|
7673
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7674
|
+
},
|
|
7675
|
+
/**
|
|
7676
|
+
* Plans the Blueprint without bindings, as `POST /blueprint/plan` does (the same inputs minus `bindings`, and the same 403 naming every missing permission), freezes what the merge is decided on and returns the resolution. When the Domain has roles, installations, item sets or listings the Blueprint could touch, or a finding already blocks a slot, the resolution opens one Blueprint Thread in which Takaro AI proposes a binding or a question for every slot; `status` is `resolving` until it is done. There is one Thread per resolution. It does not count against the Domain\'s allowance and is held against its own Blueprint budget (`budget` shows whether it is reached, never an amount). With nothing to merge, or without Takaro AI (`aiUnavailableReason` says why), the resolution is decided by the engine alone: every slot is created, and a slot a finding blocks becomes a question with options that are all valid. Takaro AI only proposes: it has no write tool and every proposal is checked by the engine before the resolution shows it. Send the resolution\'s `bindings` and `params` to `POST /blueprint/plan` and `POST /blueprint/apply`. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerOpenResolution`
|
|
7677
|
+
* @summary Open a Blueprint Resolution: decide how a Blueprint fits the existing configuration
|
|
7678
|
+
* @param {BlueprintResolutionCreateInputDTO} [blueprintResolutionCreateInputDTO] BlueprintResolutionCreateInputDTO
|
|
7679
|
+
* @param {*} [options] Override http request option.
|
|
7680
|
+
* @throws {RequiredError}
|
|
7681
|
+
*/
|
|
7682
|
+
async blueprintControllerOpenResolution(blueprintResolutionCreateInputDTO, options) {
|
|
7683
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerOpenResolution(blueprintResolutionCreateInputDTO, options);
|
|
7684
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7685
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerOpenResolution']?.[localVarOperationServerIndex]?.url;
|
|
7686
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7687
|
+
},
|
|
7688
|
+
/**
|
|
7689
|
+
* Works out what applying the Blueprint would do to the game servers in `gameServerIds` and returns it as one plan with a `planHash`. The servers are applied in the order given. Roles and Player-role grants are domain-wide: they are planned and applied once and appear once, without a `gameServerId`; every other operation, pack, item and finding names its `gameServerId`. A block on any server makes the whole plan not `applicable`. Module versions are resolved here, to exact versions, from a refreshed Official Registry manifest. Every operation is `create` (it will be written), `noop` (a previous application already did it), `keep` (the existing configuration stays as it is) or `skip`. `bindings` tells the planner what to do with a Slot, keyed by slot id: `{ mode: create | adopt | keep | skip, targetId?, version? }`. Without a binding a Slot is created when nothing conflicts, keeps its existing ownership, or is blocked by a finding that a binding resolves. `adopt` reuses an existing role (`targetId` is the role id) or the installation of the same official module (`targetId` is the installation id) and only adds to it: a role gets the union of its permissions and the Blueprint\'s, an installation gets the config keys it does not have and keeps its version and system config unless `version` names another one (the plan then lists the listings that would draft). A setting is kept, or overwritten with `create` or when an answered question consents. A malformed binding is a 400; everything else is a finding with a stable code, such as `adoptTargetMissing`, `staffRoleForSale`, `commandCollision` or `adoptedVersionOutOfRange`. A `block` finding makes the plan not `applicable`. The caller needs every permission in `requiredPermissions`; all that are missing are listed in the 403. Nothing is written to a game server. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerPlan`
|
|
7690
|
+
* @summary Plan a Blueprint for one or more game servers
|
|
7691
|
+
* @param {BlueprintPlanInputDTO} [blueprintPlanInputDTO] BlueprintPlanInputDTO
|
|
7692
|
+
* @param {*} [options] Override http request option.
|
|
7693
|
+
* @throws {RequiredError}
|
|
7694
|
+
*/
|
|
7695
|
+
async blueprintControllerPlan(blueprintPlanInputDTO, options) {
|
|
7696
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerPlan(blueprintPlanInputDTO, options);
|
|
7697
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7698
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerPlan']?.[localVarOperationServerIndex]?.url;
|
|
7699
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7700
|
+
},
|
|
7701
|
+
/**
|
|
7702
|
+
* The slim read a Blueprint merge is decided on: settings with their source, roles with permissions and player counts, installations with source, installed version, config and command triggers, item sets and listings. A few KB; no schemas or code. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerSnapshot`
|
|
7703
|
+
* @summary Read the configuration a Blueprint merge is decided on
|
|
7704
|
+
* @param {string} gameServerId
|
|
7705
|
+
* @param {*} [options] Override http request option.
|
|
7706
|
+
* @throws {RequiredError}
|
|
7707
|
+
*/
|
|
7708
|
+
async blueprintControllerSnapshot(gameServerId, options) {
|
|
7709
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blueprintControllerSnapshot(gameServerId, options);
|
|
7710
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7711
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintApi.blueprintControllerSnapshot']?.[localVarOperationServerIndex]?.url;
|
|
7712
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7713
|
+
},
|
|
7714
|
+
};
|
|
7715
|
+
};
|
|
7716
|
+
/**
|
|
7717
|
+
* BlueprintApi - factory interface
|
|
7718
|
+
* @export
|
|
7719
|
+
*/
|
|
7720
|
+
export const BlueprintApiFactory = function (configuration, basePath, axios) {
|
|
7721
|
+
const localVarFp = BlueprintApiFp(configuration);
|
|
7722
|
+
return {
|
|
7723
|
+
/**
|
|
7724
|
+
* Records which option the admin chose for each question (`answers`: question id to option index; an unknown question or an index out of range is a 400) and re-plans with the merged bindings, storing the block findings in `findings`. No model is called. Answers can be given in several calls; a later answer to the same question replaces the earlier one. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerAnswerResolution`
|
|
7725
|
+
* @summary Answer a Blueprint Resolution\'s questions
|
|
7726
|
+
* @param {string} id
|
|
7727
|
+
* @param {BlueprintResolutionAnswersInputDTO} [blueprintResolutionAnswersInputDTO] BlueprintResolutionAnswersInputDTO
|
|
7728
|
+
* @param {*} [options] Override http request option.
|
|
7729
|
+
* @throws {RequiredError}
|
|
7730
|
+
*/
|
|
7731
|
+
blueprintControllerAnswerResolution(id, blueprintResolutionAnswersInputDTO, options) {
|
|
7732
|
+
return localVarFp
|
|
7733
|
+
.blueprintControllerAnswerResolution(id, blueprintResolutionAnswersInputDTO, options)
|
|
7734
|
+
.then((request) => request(axios, basePath));
|
|
7735
|
+
},
|
|
7736
|
+
/**
|
|
7737
|
+
* Send the same inputs as the plan, including the same `bindings`, plus its `planHash`. If a game server no longer matches the plan the answer is 409 and nothing is written: plan again. Applying a plan that was already applied returns that application unchanged. A plan with a blocking finding is a 400. The answer is the application: its `status` (`succeeded`, `verificationFailed` or `failed`), the verification `report` and one entity per slot it owns. A failure during execution is not an error response: it is a 200 with a `failed` application whose `report` says what failed (`failure`), what was undone, kept or left (`compensation`) and what to do next (`nextStep`). Everything the attempt wrote is undone in a safe order; anything still referenced by a live listing or installation is kept. The game servers are applied one after another. A failure is compensated on the server where it happened; servers applied before it are kept and later ones are not attempted (`report.servers` says which). To retry, plan the same servers again: servers already applied plan as no-ops. Apply the new `planHash`. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerApply`
|
|
7738
|
+
* @summary Apply a planned Blueprint
|
|
7739
|
+
* @param {BlueprintApplyInputDTO} [blueprintApplyInputDTO] BlueprintApplyInputDTO
|
|
7740
|
+
* @param {*} [options] Override http request option.
|
|
7741
|
+
* @throws {RequiredError}
|
|
7742
|
+
*/
|
|
7743
|
+
blueprintControllerApply(blueprintApplyInputDTO, options) {
|
|
7744
|
+
return localVarFp
|
|
7745
|
+
.blueprintControllerApply(blueprintApplyInputDTO, options)
|
|
7746
|
+
.then((request) => request(axios, basePath));
|
|
7747
|
+
},
|
|
7748
|
+
/**
|
|
7749
|
+
* Lists every Blueprint that ships with Takaro, with whether it can run on the game server (`supported`, and a `reason` when it cannot) and the same for each of its Packs. Unsupported Blueprints are listed so the reason is visible. `requiredPermissions` lists what the Blueprint and each Pack need; plan still checks the caller\'s actual permissions. A Pack whose module the official registry cannot provide is listed as unsupported with a `reason` of `moduleUnavailable: <module>` (or `registryBlocked`). Each Pack also lists its `slots` ids and, best effort, the command triggers of its modules (`commands`, empty when the registry payload is not cached). Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerCatalogue`
|
|
7750
|
+
* @summary List the Blueprints available for a game server
|
|
7751
|
+
* @param {string} gameServerId
|
|
7752
|
+
* @param {*} [options] Override http request option.
|
|
7753
|
+
* @throws {RequiredError}
|
|
7754
|
+
*/
|
|
7755
|
+
blueprintControllerCatalogue(gameServerId, options) {
|
|
7756
|
+
return localVarFp.blueprintControllerCatalogue(gameServerId, options).then((request) => request(axios, basePath));
|
|
7757
|
+
},
|
|
7758
|
+
/**
|
|
7759
|
+
* Judges a proposal and writes nothing: every slot has a binding or a question, modes are allowed for the slot kind, adopt targets exist, are not system roles and are not staff roles a listing sells, params fit the Blueprint, and the plan with the bindings has no block finding on a slot that is not a question. All errors are returned at once. `fallback` is the proposal with every errored slot turned into an engine question whose options are all valid. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerCheckResolution`
|
|
7760
|
+
* @summary Check a proposed set of bindings against a Blueprint Resolution
|
|
7761
|
+
* @param {string} id
|
|
7762
|
+
* @param {BlueprintResolutionCheckInputDTO} [blueprintResolutionCheckInputDTO] BlueprintResolutionCheckInputDTO
|
|
7763
|
+
* @param {*} [options] Override http request option.
|
|
7764
|
+
* @throws {RequiredError}
|
|
7765
|
+
*/
|
|
7766
|
+
blueprintControllerCheckResolution(id, blueprintResolutionCheckInputDTO, options) {
|
|
7767
|
+
return localVarFp
|
|
7768
|
+
.blueprintControllerCheckResolution(id, blueprintResolutionCheckInputDTO, options)
|
|
7769
|
+
.then((request) => request(axios, basePath));
|
|
7770
|
+
},
|
|
7771
|
+
/**
|
|
7772
|
+
* Gets an application with the entities it created. Each entity is checked against Takaro on read: `present` is false when what it points at (an installation, a setting) no longer exists. Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerGetApplication`
|
|
7773
|
+
* @summary Get a Blueprint application
|
|
7774
|
+
* @param {string} id
|
|
7775
|
+
* @param {*} [options] Override http request option.
|
|
7776
|
+
* @throws {RequiredError}
|
|
7777
|
+
*/
|
|
7778
|
+
blueprintControllerGetApplication(id, options) {
|
|
7779
|
+
return localVarFp.blueprintControllerGetApplication(id, options).then((request) => request(axios, basePath));
|
|
7780
|
+
},
|
|
7781
|
+
/**
|
|
7782
|
+
* Reads a resolution of the calling user (another user\'s is a 404): its `status`, the frozen `context` (slots, findings and one snapshot per game server), the `proposal` and its numbered `questions` with the answers given so far, the merged `bindings` and `params` to plan with, whether it is `complete`, the block `findings` of the last answer and whether the shipped Blueprint changed since (`stale`). Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerGetResolution`
|
|
7783
|
+
* @summary Get a Blueprint Resolution
|
|
7784
|
+
* @param {string} id
|
|
7785
|
+
* @param {*} [options] Override http request option.
|
|
7786
|
+
* @throws {RequiredError}
|
|
7787
|
+
*/
|
|
7788
|
+
blueprintControllerGetResolution(id, options) {
|
|
7789
|
+
return localVarFp.blueprintControllerGetResolution(id, options).then((request) => request(axios, basePath));
|
|
7790
|
+
},
|
|
7791
|
+
/**
|
|
7792
|
+
* Plans the Blueprint without bindings, as `POST /blueprint/plan` does (the same inputs minus `bindings`, and the same 403 naming every missing permission), freezes what the merge is decided on and returns the resolution. When the Domain has roles, installations, item sets or listings the Blueprint could touch, or a finding already blocks a slot, the resolution opens one Blueprint Thread in which Takaro AI proposes a binding or a question for every slot; `status` is `resolving` until it is done. There is one Thread per resolution. It does not count against the Domain\'s allowance and is held against its own Blueprint budget (`budget` shows whether it is reached, never an amount). With nothing to merge, or without Takaro AI (`aiUnavailableReason` says why), the resolution is decided by the engine alone: every slot is created, and a slot a finding blocks becomes a question with options that are all valid. Takaro AI only proposes: it has no write tool and every proposal is checked by the engine before the resolution shows it. Send the resolution\'s `bindings` and `params` to `POST /blueprint/plan` and `POST /blueprint/apply`. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerOpenResolution`
|
|
7793
|
+
* @summary Open a Blueprint Resolution: decide how a Blueprint fits the existing configuration
|
|
7794
|
+
* @param {BlueprintResolutionCreateInputDTO} [blueprintResolutionCreateInputDTO] BlueprintResolutionCreateInputDTO
|
|
7795
|
+
* @param {*} [options] Override http request option.
|
|
7796
|
+
* @throws {RequiredError}
|
|
7797
|
+
*/
|
|
7798
|
+
blueprintControllerOpenResolution(blueprintResolutionCreateInputDTO, options) {
|
|
7799
|
+
return localVarFp
|
|
7800
|
+
.blueprintControllerOpenResolution(blueprintResolutionCreateInputDTO, options)
|
|
7801
|
+
.then((request) => request(axios, basePath));
|
|
7802
|
+
},
|
|
7803
|
+
/**
|
|
7804
|
+
* Works out what applying the Blueprint would do to the game servers in `gameServerIds` and returns it as one plan with a `planHash`. The servers are applied in the order given. Roles and Player-role grants are domain-wide: they are planned and applied once and appear once, without a `gameServerId`; every other operation, pack, item and finding names its `gameServerId`. A block on any server makes the whole plan not `applicable`. Module versions are resolved here, to exact versions, from a refreshed Official Registry manifest. Every operation is `create` (it will be written), `noop` (a previous application already did it), `keep` (the existing configuration stays as it is) or `skip`. `bindings` tells the planner what to do with a Slot, keyed by slot id: `{ mode: create | adopt | keep | skip, targetId?, version? }`. Without a binding a Slot is created when nothing conflicts, keeps its existing ownership, or is blocked by a finding that a binding resolves. `adopt` reuses an existing role (`targetId` is the role id) or the installation of the same official module (`targetId` is the installation id) and only adds to it: a role gets the union of its permissions and the Blueprint\'s, an installation gets the config keys it does not have and keeps its version and system config unless `version` names another one (the plan then lists the listings that would draft). A setting is kept, or overwritten with `create` or when an answered question consents. A malformed binding is a 400; everything else is a finding with a stable code, such as `adoptTargetMissing`, `staffRoleForSale`, `commandCollision` or `adoptedVersionOutOfRange`. A `block` finding makes the plan not `applicable`. The caller needs every permission in `requiredPermissions`; all that are missing are listed in the 403. Nothing is written to a game server. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerPlan`
|
|
7805
|
+
* @summary Plan a Blueprint for one or more game servers
|
|
7806
|
+
* @param {BlueprintPlanInputDTO} [blueprintPlanInputDTO] BlueprintPlanInputDTO
|
|
7807
|
+
* @param {*} [options] Override http request option.
|
|
7808
|
+
* @throws {RequiredError}
|
|
7809
|
+
*/
|
|
7810
|
+
blueprintControllerPlan(blueprintPlanInputDTO, options) {
|
|
7811
|
+
return localVarFp
|
|
7812
|
+
.blueprintControllerPlan(blueprintPlanInputDTO, options)
|
|
7813
|
+
.then((request) => request(axios, basePath));
|
|
7814
|
+
},
|
|
7815
|
+
/**
|
|
7816
|
+
* The slim read a Blueprint merge is decided on: settings with their source, roles with permissions and player counts, installations with source, installed version, config and command triggers, item sets and listings. A few KB; no schemas or code. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerSnapshot`
|
|
7817
|
+
* @summary Read the configuration a Blueprint merge is decided on
|
|
7818
|
+
* @param {string} gameServerId
|
|
7819
|
+
* @param {*} [options] Override http request option.
|
|
7820
|
+
* @throws {RequiredError}
|
|
7821
|
+
*/
|
|
7822
|
+
blueprintControllerSnapshot(gameServerId, options) {
|
|
7823
|
+
return localVarFp.blueprintControllerSnapshot(gameServerId, options).then((request) => request(axios, basePath));
|
|
7824
|
+
},
|
|
7825
|
+
};
|
|
7826
|
+
};
|
|
7827
|
+
/**
|
|
7828
|
+
* BlueprintApi - object-oriented interface
|
|
7829
|
+
* @export
|
|
7830
|
+
* @class BlueprintApi
|
|
7831
|
+
* @extends {BaseAPI}
|
|
7832
|
+
*/
|
|
7833
|
+
export class BlueprintApi extends BaseAPI {
|
|
7834
|
+
/**
|
|
7835
|
+
* Records which option the admin chose for each question (`answers`: question id to option index; an unknown question or an index out of range is a 400) and re-plans with the merged bindings, storing the block findings in `findings`. No model is called. Answers can be given in several calls; a later answer to the same question replaces the earlier one. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerAnswerResolution`
|
|
7836
|
+
* @summary Answer a Blueprint Resolution\'s questions
|
|
7837
|
+
* @param {string} id
|
|
7838
|
+
* @param {BlueprintResolutionAnswersInputDTO} [blueprintResolutionAnswersInputDTO] BlueprintResolutionAnswersInputDTO
|
|
7839
|
+
* @param {*} [options] Override http request option.
|
|
7840
|
+
* @throws {RequiredError}
|
|
7841
|
+
* @memberof BlueprintApi
|
|
7842
|
+
*/
|
|
7843
|
+
blueprintControllerAnswerResolution(id, blueprintResolutionAnswersInputDTO, options) {
|
|
7844
|
+
return BlueprintApiFp(this.configuration)
|
|
7845
|
+
.blueprintControllerAnswerResolution(id, blueprintResolutionAnswersInputDTO, options)
|
|
7846
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7847
|
+
}
|
|
7848
|
+
/**
|
|
7849
|
+
* Send the same inputs as the plan, including the same `bindings`, plus its `planHash`. If a game server no longer matches the plan the answer is 409 and nothing is written: plan again. Applying a plan that was already applied returns that application unchanged. A plan with a blocking finding is a 400. The answer is the application: its `status` (`succeeded`, `verificationFailed` or `failed`), the verification `report` and one entity per slot it owns. A failure during execution is not an error response: it is a 200 with a `failed` application whose `report` says what failed (`failure`), what was undone, kept or left (`compensation`) and what to do next (`nextStep`). Everything the attempt wrote is undone in a safe order; anything still referenced by a live listing or installation is kept. The game servers are applied one after another. A failure is compensated on the server where it happened; servers applied before it are kept and later ones are not attempted (`report.servers` says which). To retry, plan the same servers again: servers already applied plan as no-ops. Apply the new `planHash`. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerApply`
|
|
7850
|
+
* @summary Apply a planned Blueprint
|
|
7851
|
+
* @param {BlueprintApplyInputDTO} [blueprintApplyInputDTO] BlueprintApplyInputDTO
|
|
7852
|
+
* @param {*} [options] Override http request option.
|
|
7853
|
+
* @throws {RequiredError}
|
|
7854
|
+
* @memberof BlueprintApi
|
|
7855
|
+
*/
|
|
7856
|
+
blueprintControllerApply(blueprintApplyInputDTO, options) {
|
|
7857
|
+
return BlueprintApiFp(this.configuration)
|
|
7858
|
+
.blueprintControllerApply(blueprintApplyInputDTO, options)
|
|
7859
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7860
|
+
}
|
|
7861
|
+
/**
|
|
7862
|
+
* Lists every Blueprint that ships with Takaro, with whether it can run on the game server (`supported`, and a `reason` when it cannot) and the same for each of its Packs. Unsupported Blueprints are listed so the reason is visible. `requiredPermissions` lists what the Blueprint and each Pack need; plan still checks the caller\'s actual permissions. A Pack whose module the official registry cannot provide is listed as unsupported with a `reason` of `moduleUnavailable: <module>` (or `registryBlocked`). Each Pack also lists its `slots` ids and, best effort, the command triggers of its modules (`commands`, empty when the registry payload is not cached). Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerCatalogue`
|
|
7863
|
+
* @summary List the Blueprints available for a game server
|
|
7864
|
+
* @param {string} gameServerId
|
|
7865
|
+
* @param {*} [options] Override http request option.
|
|
7866
|
+
* @throws {RequiredError}
|
|
7867
|
+
* @memberof BlueprintApi
|
|
7868
|
+
*/
|
|
7869
|
+
blueprintControllerCatalogue(gameServerId, options) {
|
|
7870
|
+
return BlueprintApiFp(this.configuration)
|
|
7871
|
+
.blueprintControllerCatalogue(gameServerId, options)
|
|
7872
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7873
|
+
}
|
|
7874
|
+
/**
|
|
7875
|
+
* Judges a proposal and writes nothing: every slot has a binding or a question, modes are allowed for the slot kind, adopt targets exist, are not system roles and are not staff roles a listing sells, params fit the Blueprint, and the plan with the bindings has no block finding on a slot that is not a question. All errors are returned at once. `fallback` is the proposal with every errored slot turned into an engine question whose options are all valid. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerCheckResolution`
|
|
7876
|
+
* @summary Check a proposed set of bindings against a Blueprint Resolution
|
|
7877
|
+
* @param {string} id
|
|
7878
|
+
* @param {BlueprintResolutionCheckInputDTO} [blueprintResolutionCheckInputDTO] BlueprintResolutionCheckInputDTO
|
|
7879
|
+
* @param {*} [options] Override http request option.
|
|
7880
|
+
* @throws {RequiredError}
|
|
7881
|
+
* @memberof BlueprintApi
|
|
7882
|
+
*/
|
|
7883
|
+
blueprintControllerCheckResolution(id, blueprintResolutionCheckInputDTO, options) {
|
|
7884
|
+
return BlueprintApiFp(this.configuration)
|
|
7885
|
+
.blueprintControllerCheckResolution(id, blueprintResolutionCheckInputDTO, options)
|
|
7886
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7887
|
+
}
|
|
7888
|
+
/**
|
|
7889
|
+
* Gets an application with the entities it created. Each entity is checked against Takaro on read: `present` is false when what it points at (an installation, a setting) no longer exists. Required permissions: `READ_MODULES`<br> OperationId: `BlueprintControllerGetApplication`
|
|
7890
|
+
* @summary Get a Blueprint application
|
|
7891
|
+
* @param {string} id
|
|
7892
|
+
* @param {*} [options] Override http request option.
|
|
7893
|
+
* @throws {RequiredError}
|
|
7894
|
+
* @memberof BlueprintApi
|
|
7895
|
+
*/
|
|
7896
|
+
blueprintControllerGetApplication(id, options) {
|
|
7897
|
+
return BlueprintApiFp(this.configuration)
|
|
7898
|
+
.blueprintControllerGetApplication(id, options)
|
|
7899
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7900
|
+
}
|
|
7901
|
+
/**
|
|
7902
|
+
* Reads a resolution of the calling user (another user\'s is a 404): its `status`, the frozen `context` (slots, findings and one snapshot per game server), the `proposal` and its numbered `questions` with the answers given so far, the merged `bindings` and `params` to plan with, whether it is `complete`, the block `findings` of the last answer and whether the shipped Blueprint changed since (`stale`). Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerGetResolution`
|
|
7903
|
+
* @summary Get a Blueprint Resolution
|
|
7904
|
+
* @param {string} id
|
|
7905
|
+
* @param {*} [options] Override http request option.
|
|
7906
|
+
* @throws {RequiredError}
|
|
7907
|
+
* @memberof BlueprintApi
|
|
7908
|
+
*/
|
|
7909
|
+
blueprintControllerGetResolution(id, options) {
|
|
7910
|
+
return BlueprintApiFp(this.configuration)
|
|
7911
|
+
.blueprintControllerGetResolution(id, options)
|
|
7912
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7913
|
+
}
|
|
7914
|
+
/**
|
|
7915
|
+
* Plans the Blueprint without bindings, as `POST /blueprint/plan` does (the same inputs minus `bindings`, and the same 403 naming every missing permission), freezes what the merge is decided on and returns the resolution. When the Domain has roles, installations, item sets or listings the Blueprint could touch, or a finding already blocks a slot, the resolution opens one Blueprint Thread in which Takaro AI proposes a binding or a question for every slot; `status` is `resolving` until it is done. There is one Thread per resolution. It does not count against the Domain\'s allowance and is held against its own Blueprint budget (`budget` shows whether it is reached, never an amount). With nothing to merge, or without Takaro AI (`aiUnavailableReason` says why), the resolution is decided by the engine alone: every slot is created, and a slot a finding blocks becomes a question with options that are all valid. Takaro AI only proposes: it has no write tool and every proposal is checked by the engine before the resolution shows it. Send the resolution\'s `bindings` and `params` to `POST /blueprint/plan` and `POST /blueprint/apply`. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerOpenResolution`
|
|
7916
|
+
* @summary Open a Blueprint Resolution: decide how a Blueprint fits the existing configuration
|
|
7917
|
+
* @param {BlueprintResolutionCreateInputDTO} [blueprintResolutionCreateInputDTO] BlueprintResolutionCreateInputDTO
|
|
7918
|
+
* @param {*} [options] Override http request option.
|
|
7919
|
+
* @throws {RequiredError}
|
|
7920
|
+
* @memberof BlueprintApi
|
|
7921
|
+
*/
|
|
7922
|
+
blueprintControllerOpenResolution(blueprintResolutionCreateInputDTO, options) {
|
|
7923
|
+
return BlueprintApiFp(this.configuration)
|
|
7924
|
+
.blueprintControllerOpenResolution(blueprintResolutionCreateInputDTO, options)
|
|
7925
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7926
|
+
}
|
|
7927
|
+
/**
|
|
7928
|
+
* Works out what applying the Blueprint would do to the game servers in `gameServerIds` and returns it as one plan with a `planHash`. The servers are applied in the order given. Roles and Player-role grants are domain-wide: they are planned and applied once and appear once, without a `gameServerId`; every other operation, pack, item and finding names its `gameServerId`. A block on any server makes the whole plan not `applicable`. Module versions are resolved here, to exact versions, from a refreshed Official Registry manifest. Every operation is `create` (it will be written), `noop` (a previous application already did it), `keep` (the existing configuration stays as it is) or `skip`. `bindings` tells the planner what to do with a Slot, keyed by slot id: `{ mode: create | adopt | keep | skip, targetId?, version? }`. Without a binding a Slot is created when nothing conflicts, keeps its existing ownership, or is blocked by a finding that a binding resolves. `adopt` reuses an existing role (`targetId` is the role id) or the installation of the same official module (`targetId` is the installation id) and only adds to it: a role gets the union of its permissions and the Blueprint\'s, an installation gets the config keys it does not have and keeps its version and system config unless `version` names another one (the plan then lists the listings that would draft). A setting is kept, or overwritten with `create` or when an answered question consents. A malformed binding is a 400; everything else is a finding with a stable code, such as `adoptTargetMissing`, `staffRoleForSale`, `commandCollision` or `adoptedVersionOutOfRange`. A `block` finding makes the plan not `applicable`. The caller needs every permission in `requiredPermissions`; all that are missing are listed in the 403. Nothing is written to a game server. Required permissions: `READ_MODULES`, `READ_SETTINGS`<br> OperationId: `BlueprintControllerPlan`
|
|
7929
|
+
* @summary Plan a Blueprint for one or more game servers
|
|
7930
|
+
* @param {BlueprintPlanInputDTO} [blueprintPlanInputDTO] BlueprintPlanInputDTO
|
|
7931
|
+
* @param {*} [options] Override http request option.
|
|
7932
|
+
* @throws {RequiredError}
|
|
7933
|
+
* @memberof BlueprintApi
|
|
7934
|
+
*/
|
|
7935
|
+
blueprintControllerPlan(blueprintPlanInputDTO, options) {
|
|
7936
|
+
return BlueprintApiFp(this.configuration)
|
|
7937
|
+
.blueprintControllerPlan(blueprintPlanInputDTO, options)
|
|
7938
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7939
|
+
}
|
|
7940
|
+
/**
|
|
7941
|
+
* The slim read a Blueprint merge is decided on: settings with their source, roles with permissions and player counts, installations with source, installed version, config and command triggers, item sets and listings. A few KB; no schemas or code. Required permissions: `READ_MODULES`, `READ_SETTINGS`, `READ_ROLES`, `READ_ITEMS`<br> OperationId: `BlueprintControllerSnapshot`
|
|
7942
|
+
* @summary Read the configuration a Blueprint merge is decided on
|
|
7943
|
+
* @param {string} gameServerId
|
|
7944
|
+
* @param {*} [options] Override http request option.
|
|
7945
|
+
* @throws {RequiredError}
|
|
7946
|
+
* @memberof BlueprintApi
|
|
7947
|
+
*/
|
|
7948
|
+
blueprintControllerSnapshot(gameServerId, options) {
|
|
7949
|
+
return BlueprintApiFp(this.configuration)
|
|
7950
|
+
.blueprintControllerSnapshot(gameServerId, options)
|
|
7951
|
+
.then((request) => request(this.axios, this.basePath));
|
|
7952
|
+
}
|
|
7953
|
+
}
|
|
7087
7954
|
/**
|
|
7088
7955
|
* BoardApi - axios parameter creator
|
|
7089
7956
|
* @export
|
|
@@ -7091,7 +7958,7 @@ export class BillingApi extends BaseAPI {
|
|
|
7091
7958
|
export const BoardApiAxiosParamCreator = function (configuration) {
|
|
7092
7959
|
return {
|
|
7093
7960
|
/**
|
|
7094
|
-
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
7961
|
+
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
7095
7962
|
* @summary Create a Board
|
|
7096
7963
|
* @param {BoardCreateDTO} [boardCreateDTO] BoardCreateDTO
|
|
7097
7964
|
* @param {*} [options] Override http request option.
|
|
@@ -7123,7 +7990,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7123
7990
|
};
|
|
7124
7991
|
},
|
|
7125
7992
|
/**
|
|
7126
|
-
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
7993
|
+
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
7127
7994
|
* @summary Duplicate a Board
|
|
7128
7995
|
* @param {string} id
|
|
7129
7996
|
* @param {BoardDuplicateDTO} [boardDuplicateDTO] BoardDuplicateDTO
|
|
@@ -7158,7 +8025,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7158
8025
|
};
|
|
7159
8026
|
},
|
|
7160
8027
|
/**
|
|
7161
|
-
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
8028
|
+
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
7162
8029
|
* @summary Get a Board
|
|
7163
8030
|
* @param {string} id
|
|
7164
8031
|
* @param {*} [options] Override http request option.
|
|
@@ -7190,7 +8057,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7190
8057
|
};
|
|
7191
8058
|
},
|
|
7192
8059
|
/**
|
|
7193
|
-
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
8060
|
+
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
7194
8061
|
* @summary List the built-in Boards
|
|
7195
8062
|
* @param {*} [options] Override http request option.
|
|
7196
8063
|
* @throws {RequiredError}
|
|
@@ -7219,7 +8086,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7219
8086
|
};
|
|
7220
8087
|
},
|
|
7221
8088
|
/**
|
|
7222
|
-
* Deletes a Board of the Domain. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
8089
|
+
* Deletes a Board of the Domain. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
7223
8090
|
* @summary Delete a Board
|
|
7224
8091
|
* @param {string} id
|
|
7225
8092
|
* @param {*} [options] Override http request option.
|
|
@@ -7251,7 +8118,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7251
8118
|
};
|
|
7252
8119
|
},
|
|
7253
8120
|
/**
|
|
7254
|
-
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
8121
|
+
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
7255
8122
|
* @summary Run a Board
|
|
7256
8123
|
* @param {string} id
|
|
7257
8124
|
* @param {BoardRunInputDTO} [boardRunInputDTO] BoardRunInputDTO
|
|
@@ -7286,7 +8153,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7286
8153
|
};
|
|
7287
8154
|
},
|
|
7288
8155
|
/**
|
|
7289
|
-
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
8156
|
+
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
7290
8157
|
* @summary Get the Board JSON Schema
|
|
7291
8158
|
* @param {*} [options] Override http request option.
|
|
7292
8159
|
* @throws {RequiredError}
|
|
@@ -7315,7 +8182,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7315
8182
|
};
|
|
7316
8183
|
},
|
|
7317
8184
|
/**
|
|
7318
|
-
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
8185
|
+
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
7319
8186
|
* @summary Search Boards
|
|
7320
8187
|
* @param {BoardSearchInputDTO} [boardSearchInputDTO] BoardSearchInputDTO
|
|
7321
8188
|
* @param {*} [options] Override http request option.
|
|
@@ -7347,7 +8214,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7347
8214
|
};
|
|
7348
8215
|
},
|
|
7349
8216
|
/**
|
|
7350
|
-
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
8217
|
+
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
7351
8218
|
* @summary Update a Board
|
|
7352
8219
|
* @param {string} id
|
|
7353
8220
|
* @param {BoardUpdateDTO} [boardUpdateDTO] BoardUpdateDTO
|
|
@@ -7382,7 +8249,7 @@ export const BoardApiAxiosParamCreator = function (configuration) {
|
|
|
7382
8249
|
};
|
|
7383
8250
|
},
|
|
7384
8251
|
/**
|
|
7385
|
-
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
8252
|
+
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
7386
8253
|
* @summary Validate a Board
|
|
7387
8254
|
* @param {BoardValidateInputDTO} [boardValidateInputDTO] BoardValidateInputDTO
|
|
7388
8255
|
* @param {*} [options] Override http request option.
|
|
@@ -7423,7 +8290,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7423
8290
|
const localVarAxiosParamCreator = BoardApiAxiosParamCreator(configuration);
|
|
7424
8291
|
return {
|
|
7425
8292
|
/**
|
|
7426
|
-
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
8293
|
+
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
7427
8294
|
* @summary Create a Board
|
|
7428
8295
|
* @param {BoardCreateDTO} [boardCreateDTO] BoardCreateDTO
|
|
7429
8296
|
* @param {*} [options] Override http request option.
|
|
@@ -7436,7 +8303,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7436
8303
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7437
8304
|
},
|
|
7438
8305
|
/**
|
|
7439
|
-
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
8306
|
+
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
7440
8307
|
* @summary Duplicate a Board
|
|
7441
8308
|
* @param {string} id
|
|
7442
8309
|
* @param {BoardDuplicateDTO} [boardDuplicateDTO] BoardDuplicateDTO
|
|
@@ -7450,7 +8317,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7450
8317
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7451
8318
|
},
|
|
7452
8319
|
/**
|
|
7453
|
-
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
8320
|
+
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
7454
8321
|
* @summary Get a Board
|
|
7455
8322
|
* @param {string} id
|
|
7456
8323
|
* @param {*} [options] Override http request option.
|
|
@@ -7463,7 +8330,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7463
8330
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7464
8331
|
},
|
|
7465
8332
|
/**
|
|
7466
|
-
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
8333
|
+
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
7467
8334
|
* @summary List the built-in Boards
|
|
7468
8335
|
* @param {*} [options] Override http request option.
|
|
7469
8336
|
* @throws {RequiredError}
|
|
@@ -7475,7 +8342,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7475
8342
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7476
8343
|
},
|
|
7477
8344
|
/**
|
|
7478
|
-
* Deletes a Board of the Domain. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
8345
|
+
* Deletes a Board of the Domain. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
7479
8346
|
* @summary Delete a Board
|
|
7480
8347
|
* @param {string} id
|
|
7481
8348
|
* @param {*} [options] Override http request option.
|
|
@@ -7488,7 +8355,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7488
8355
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7489
8356
|
},
|
|
7490
8357
|
/**
|
|
7491
|
-
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
8358
|
+
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
7492
8359
|
* @summary Run a Board
|
|
7493
8360
|
* @param {string} id
|
|
7494
8361
|
* @param {BoardRunInputDTO} [boardRunInputDTO] BoardRunInputDTO
|
|
@@ -7502,7 +8369,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7502
8369
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7503
8370
|
},
|
|
7504
8371
|
/**
|
|
7505
|
-
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
8372
|
+
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
7506
8373
|
* @summary Get the Board JSON Schema
|
|
7507
8374
|
* @param {*} [options] Override http request option.
|
|
7508
8375
|
* @throws {RequiredError}
|
|
@@ -7514,7 +8381,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7514
8381
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7515
8382
|
},
|
|
7516
8383
|
/**
|
|
7517
|
-
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
8384
|
+
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
7518
8385
|
* @summary Search Boards
|
|
7519
8386
|
* @param {BoardSearchInputDTO} [boardSearchInputDTO] BoardSearchInputDTO
|
|
7520
8387
|
* @param {*} [options] Override http request option.
|
|
@@ -7527,7 +8394,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7527
8394
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7528
8395
|
},
|
|
7529
8396
|
/**
|
|
7530
|
-
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
8397
|
+
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
7531
8398
|
* @summary Update a Board
|
|
7532
8399
|
* @param {string} id
|
|
7533
8400
|
* @param {BoardUpdateDTO} [boardUpdateDTO] BoardUpdateDTO
|
|
@@ -7541,7 +8408,7 @@ export const BoardApiFp = function (configuration) {
|
|
|
7541
8408
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7542
8409
|
},
|
|
7543
8410
|
/**
|
|
7544
|
-
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
8411
|
+
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
7545
8412
|
* @summary Validate a Board
|
|
7546
8413
|
* @param {BoardValidateInputDTO} [boardValidateInputDTO] BoardValidateInputDTO
|
|
7547
8414
|
* @param {*} [options] Override http request option.
|
|
@@ -7563,7 +8430,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7563
8430
|
const localVarFp = BoardApiFp(configuration);
|
|
7564
8431
|
return {
|
|
7565
8432
|
/**
|
|
7566
|
-
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
8433
|
+
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
7567
8434
|
* @summary Create a Board
|
|
7568
8435
|
* @param {BoardCreateDTO} [boardCreateDTO] BoardCreateDTO
|
|
7569
8436
|
* @param {*} [options] Override http request option.
|
|
@@ -7573,7 +8440,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7573
8440
|
return localVarFp.boardControllerCreate(boardCreateDTO, options).then((request) => request(axios, basePath));
|
|
7574
8441
|
},
|
|
7575
8442
|
/**
|
|
7576
|
-
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
8443
|
+
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
7577
8444
|
* @summary Duplicate a Board
|
|
7578
8445
|
* @param {string} id
|
|
7579
8446
|
* @param {BoardDuplicateDTO} [boardDuplicateDTO] BoardDuplicateDTO
|
|
@@ -7586,7 +8453,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7586
8453
|
.then((request) => request(axios, basePath));
|
|
7587
8454
|
},
|
|
7588
8455
|
/**
|
|
7589
|
-
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
8456
|
+
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
7590
8457
|
* @summary Get a Board
|
|
7591
8458
|
* @param {string} id
|
|
7592
8459
|
* @param {*} [options] Override http request option.
|
|
@@ -7596,7 +8463,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7596
8463
|
return localVarFp.boardControllerGetOne(id, options).then((request) => request(axios, basePath));
|
|
7597
8464
|
},
|
|
7598
8465
|
/**
|
|
7599
|
-
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
8466
|
+
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
7600
8467
|
* @summary List the built-in Boards
|
|
7601
8468
|
* @param {*} [options] Override http request option.
|
|
7602
8469
|
* @throws {RequiredError}
|
|
@@ -7605,7 +8472,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7605
8472
|
return localVarFp.boardControllerListBuiltin(options).then((request) => request(axios, basePath));
|
|
7606
8473
|
},
|
|
7607
8474
|
/**
|
|
7608
|
-
* Deletes a Board of the Domain. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
8475
|
+
* Deletes a Board of the Domain. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
7609
8476
|
* @summary Delete a Board
|
|
7610
8477
|
* @param {string} id
|
|
7611
8478
|
* @param {*} [options] Override http request option.
|
|
@@ -7615,7 +8482,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7615
8482
|
return localVarFp.boardControllerRemove(id, options).then((request) => request(axios, basePath));
|
|
7616
8483
|
},
|
|
7617
8484
|
/**
|
|
7618
|
-
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
8485
|
+
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
7619
8486
|
* @summary Run a Board
|
|
7620
8487
|
* @param {string} id
|
|
7621
8488
|
* @param {BoardRunInputDTO} [boardRunInputDTO] BoardRunInputDTO
|
|
@@ -7626,7 +8493,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7626
8493
|
return localVarFp.boardControllerRun(id, boardRunInputDTO, options).then((request) => request(axios, basePath));
|
|
7627
8494
|
},
|
|
7628
8495
|
/**
|
|
7629
|
-
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
8496
|
+
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
7630
8497
|
* @summary Get the Board JSON Schema
|
|
7631
8498
|
* @param {*} [options] Override http request option.
|
|
7632
8499
|
* @throws {RequiredError}
|
|
@@ -7635,7 +8502,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7635
8502
|
return localVarFp.boardControllerSchema(options).then((request) => request(axios, basePath));
|
|
7636
8503
|
},
|
|
7637
8504
|
/**
|
|
7638
|
-
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
8505
|
+
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
7639
8506
|
* @summary Search Boards
|
|
7640
8507
|
* @param {BoardSearchInputDTO} [boardSearchInputDTO] BoardSearchInputDTO
|
|
7641
8508
|
* @param {*} [options] Override http request option.
|
|
@@ -7645,7 +8512,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7645
8512
|
return localVarFp.boardControllerSearch(boardSearchInputDTO, options).then((request) => request(axios, basePath));
|
|
7646
8513
|
},
|
|
7647
8514
|
/**
|
|
7648
|
-
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
8515
|
+
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
7649
8516
|
* @summary Update a Board
|
|
7650
8517
|
* @param {string} id
|
|
7651
8518
|
* @param {BoardUpdateDTO} [boardUpdateDTO] BoardUpdateDTO
|
|
@@ -7656,7 +8523,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7656
8523
|
return localVarFp.boardControllerUpdate(id, boardUpdateDTO, options).then((request) => request(axios, basePath));
|
|
7657
8524
|
},
|
|
7658
8525
|
/**
|
|
7659
|
-
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
8526
|
+
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
7660
8527
|
* @summary Validate a Board
|
|
7661
8528
|
* @param {BoardValidateInputDTO} [boardValidateInputDTO] BoardValidateInputDTO
|
|
7662
8529
|
* @param {*} [options] Override http request option.
|
|
@@ -7677,7 +8544,7 @@ export const BoardApiFactory = function (configuration, basePath, axios) {
|
|
|
7677
8544
|
*/
|
|
7678
8545
|
export class BoardApi extends BaseAPI {
|
|
7679
8546
|
/**
|
|
7680
|
-
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
8547
|
+
* Creates a Board owned by the Domain. Send the document as `document` (JSON) or `yaml`, not both; the canonical JSON is stored and returned, and YAML comments are not kept. A document with problems is refused with 400, code BOARD_INVALID, and every problem in meta.error.details.errors as { code, message, path, suggestion? } with JSON Pointer paths. Queries are compiled as the caller. Saved Queries are referenced by name. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerCreate`
|
|
7681
8548
|
* @summary Create a Board
|
|
7682
8549
|
* @param {BoardCreateDTO} [boardCreateDTO] BoardCreateDTO
|
|
7683
8550
|
* @param {*} [options] Override http request option.
|
|
@@ -7690,7 +8557,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7690
8557
|
.then((request) => request(this.axios, this.basePath));
|
|
7691
8558
|
}
|
|
7692
8559
|
/**
|
|
7693
|
-
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
8560
|
+
* Copies a Board, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerDuplicate`
|
|
7694
8561
|
* @summary Duplicate a Board
|
|
7695
8562
|
* @param {string} id
|
|
7696
8563
|
* @param {BoardDuplicateDTO} [boardDuplicateDTO] BoardDuplicateDTO
|
|
@@ -7704,7 +8571,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7704
8571
|
.then((request) => request(this.axios, this.basePath));
|
|
7705
8572
|
}
|
|
7706
8573
|
/**
|
|
7707
|
-
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
8574
|
+
* Gets a Board, built-in or the Domain’s, by id, with its canonical JSON document. Nothing is run; use POST /boards/{id}/run for that. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerGetOne`
|
|
7708
8575
|
* @summary Get a Board
|
|
7709
8576
|
* @param {string} id
|
|
7710
8577
|
* @param {*} [options] Override http request option.
|
|
@@ -7717,7 +8584,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7717
8584
|
.then((request) => request(this.axios, this.basePath));
|
|
7718
8585
|
}
|
|
7719
8586
|
/**
|
|
7720
|
-
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
8587
|
+
* Lists the Boards that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Board with POST /boards/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerListBuiltin`
|
|
7721
8588
|
* @summary List the built-in Boards
|
|
7722
8589
|
* @param {*} [options] Override http request option.
|
|
7723
8590
|
* @throws {RequiredError}
|
|
@@ -7729,7 +8596,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7729
8596
|
.then((request) => request(this.axios, this.basePath));
|
|
7730
8597
|
}
|
|
7731
8598
|
/**
|
|
7732
|
-
* Deletes a Board of the Domain. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
8599
|
+
* Deletes a Board of the Domain. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerRemove`
|
|
7733
8600
|
* @summary Delete a Board
|
|
7734
8601
|
* @param {string} id
|
|
7735
8602
|
* @param {*} [options] Override http request option.
|
|
@@ -7742,7 +8609,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7742
8609
|
.then((request) => request(this.axios, this.basePath));
|
|
7743
8610
|
}
|
|
7744
8611
|
/**
|
|
7745
|
-
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
8612
|
+
* Runs every query a Chart of the Board uses, recompiled for the caller, so the rows depend on their permissions. Queries with identical text run once per run, and `executed` counts the distinct queries run. It answers 200 for a Board that exists, unless its filters are refused (see below): each query and each Chart carries a `status`. `ok` has the result. `needs-permission` means the caller may not read the data, with `requiredPermission` when the compiler names one. `query-missing` means a Saved Query the Board names no longer exists. `error` carries the `code` and `message`, for example `TQL_CONCURRENCY_LIMIT` or `TQL_TIMEOUT`. Takes optional `timezone` and `filters`, the selected value of each filter the Board declares by id (a range preset or a game server id; absent or null takes the default). A value that is not valid, or a range longer than the Domain’s event retention, makes the whole run a 400 with TQL_INVALID_FILTER or TQL_UNKNOWN_FILTER. The answer lists the `filters` the run used, in declaration order, with the presets the Domain’s `retentionDays` allows and, for a range, `comparable`: whether twice the range fits the retention, so a previous-period comparison is possible. A Chart that declares `requires: { history }` beyond `retentionDays` has status `needs-history` and `history`; a query only such Charts use is not run. `hidden` means the Chart\'s `when` condition is false for these filter values; its query was not run unless a visible Chart uses it. Results are cached for 60 seconds per compiled query and `cachedAt` is set on a cached result; `refresh: true` re-runs every query and replaces the cache entries. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerRun`
|
|
7746
8613
|
* @summary Run a Board
|
|
7747
8614
|
* @param {string} id
|
|
7748
8615
|
* @param {BoardRunInputDTO} [boardRunInputDTO] BoardRunInputDTO
|
|
@@ -7756,7 +8623,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7756
8623
|
.then((request) => request(this.axios, this.basePath));
|
|
7757
8624
|
}
|
|
7758
8625
|
/**
|
|
7759
|
-
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
8626
|
+
* The JSON Schema (draft 7) of a Board document. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Rules that JSON Schema cannot express, such as references between queries, Charts and the layout, and column checks, are applied by POST /boards/validate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSchema`
|
|
7760
8627
|
* @summary Get the Board JSON Schema
|
|
7761
8628
|
* @param {*} [options] Override http request option.
|
|
7762
8629
|
* @throws {RequiredError}
|
|
@@ -7768,7 +8635,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7768
8635
|
.then((request) => request(this.axios, this.basePath));
|
|
7769
8636
|
}
|
|
7770
8637
|
/**
|
|
7771
|
-
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
8638
|
+
* Searches the Domain\'s Boards: documents of TQL queries, Charts and layout that belong to the Domain. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Filter by id and name, search by name. Built-in Boards are not included; list them with GET /boards/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerSearch`
|
|
7772
8639
|
* @summary Search Boards
|
|
7773
8640
|
* @param {BoardSearchInputDTO} [boardSearchInputDTO] BoardSearchInputDTO
|
|
7774
8641
|
* @param {*} [options] Override http request option.
|
|
@@ -7781,7 +8648,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7781
8648
|
.then((request) => request(this.axios, this.basePath));
|
|
7782
8649
|
}
|
|
7783
8650
|
/**
|
|
7784
|
-
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
8651
|
+
* Updates a Board. `updatedAt` must be the value last read; when someone else changed the Board since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` clears on null. A changed `document` or `yaml` (at most one) is checked as in create. Built-in Boards answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `BoardControllerUpdate`
|
|
7785
8652
|
* @summary Update a Board
|
|
7786
8653
|
* @param {string} id
|
|
7787
8654
|
* @param {BoardUpdateDTO} [boardUpdateDTO] BoardUpdateDTO
|
|
@@ -7795,7 +8662,7 @@ export class BoardApi extends BaseAPI {
|
|
|
7795
8662
|
.then((request) => request(this.axios, this.basePath));
|
|
7796
8663
|
}
|
|
7797
8664
|
/**
|
|
7798
|
-
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
8665
|
+
* Checks a Board document without saving it. Send it as `document` (JSON) or `yaml`. It answers 200 with `valid` and, when not valid, every problem as { code, message, path, suggestion? } where `path` is a JSON Pointer from the document root; `BOARD_QUERY_INVALID` carries the compiler\'s `tqlCode` and `position`; `BOARD_UNKNOWN_FILTER` is a Chart `when` naming a filter the Board does not declare. Queries are compiled as the caller. A query the caller\'s own permissions cannot compile is not an error but a `BOARD_QUERY_UNCHECKED` warning. `document` is the canonical form when valid. A Board is one document of optional typed `filters` (a `range` filter with a preset default of 24h, 7d, 30d or 90d, or a `gameServer` filter; queries read them as {id.start}, {id.end}, {id.prevStart}, {id.prevEnd}, {id.bucket} and `matches(column, {id})`), `queries` (an id mapped to inline TQL in `tql`, or to a Saved Query by name in `savedQuery`), `charts` (an id mapped to a Chart spec plus the `query` that feeds it) and `layout` (rows of `{ chart, span? }` cells on a 12-column grid). GET /boards/schema describes it. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `BoardControllerValidate`
|
|
7799
8666
|
* @summary Validate a Board
|
|
7800
8667
|
* @param {BoardValidateInputDTO} [boardValidateInputDTO] BoardValidateInputDTO
|
|
7801
8668
|
* @param {*} [options] Override http request option.
|
|
@@ -12178,7 +13045,7 @@ export class FunctionApi extends BaseAPI {
|
|
|
12178
13045
|
export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
12179
13046
|
return {
|
|
12180
13047
|
/**
|
|
12181
|
-
*
|
|
13048
|
+
* Deprecated: use `BanController.create`. Records a Takaro-managed ban for the player on this game server and applies it in game, with the same rules as `BanController.create` (409 when the player already has an active ban on this server). Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
12182
13049
|
* @summary Ban player
|
|
12183
13050
|
* @param {string} gameServerId
|
|
12184
13051
|
* @param {string} playerId
|
|
@@ -12417,7 +13284,7 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
12417
13284
|
};
|
|
12418
13285
|
},
|
|
12419
13286
|
/**
|
|
12420
|
-
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true).<br> OperationId: `GameServerControllerGetCapabilities`
|
|
13287
|
+
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true), or an empty one with status unknown while a connector-based gameserver has not reported yet.<br> OperationId: `GameServerControllerGetCapabilities`
|
|
12421
13288
|
* @summary Get capabilities
|
|
12422
13289
|
* @param {string} id
|
|
12423
13290
|
* @param {*} [options] Override http request option.
|
|
@@ -12813,6 +13680,35 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
12813
13680
|
options: localVarRequestOptions,
|
|
12814
13681
|
};
|
|
12815
13682
|
},
|
|
13683
|
+
/**
|
|
13684
|
+
* Active Registration Failures, newest first: Game Integrations turned away in the last 24 hours that have not identified successfully since and whose cause still applies. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetRegistrationFailures`
|
|
13685
|
+
* @summary Get registration failures
|
|
13686
|
+
* @param {*} [options] Override http request option.
|
|
13687
|
+
* @throws {RequiredError}
|
|
13688
|
+
*/
|
|
13689
|
+
gameServerControllerGetRegistrationFailures: async (options = {}) => {
|
|
13690
|
+
const localVarPath = `/gameserver/registration-failures`;
|
|
13691
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13692
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13693
|
+
let baseOptions;
|
|
13694
|
+
if (configuration) {
|
|
13695
|
+
baseOptions = configuration.baseOptions;
|
|
13696
|
+
}
|
|
13697
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
13698
|
+
const localVarHeaderParameter = {};
|
|
13699
|
+
const localVarQueryParameter = {};
|
|
13700
|
+
// authentication bearerAuth required
|
|
13701
|
+
// http bearer authentication required
|
|
13702
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
13703
|
+
// authentication domainAuth required
|
|
13704
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13705
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13706
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
13707
|
+
return {
|
|
13708
|
+
url: toPathString(localVarUrlObj),
|
|
13709
|
+
options: localVarRequestOptions,
|
|
13710
|
+
};
|
|
13711
|
+
},
|
|
12816
13712
|
/**
|
|
12817
13713
|
* Fetch gameserver types (7dtd, Rust, ...)<br> OperationId: `GameServerControllerGetTypes`
|
|
12818
13714
|
* @summary Get types
|
|
@@ -13227,6 +14123,38 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
13227
14123
|
options: localVarRequestOptions,
|
|
13228
14124
|
};
|
|
13229
14125
|
},
|
|
14126
|
+
/**
|
|
14127
|
+
* Records a Registration Failure: a Game Integration that identified with this domain\'s registration token was turned away. Written by the connector; users never call it. Emits gameserver-registration-failed at most once an hour per identity token. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerReportRegistrationFailure`
|
|
14128
|
+
* @summary Report registration failure
|
|
14129
|
+
* @param {GameServerRegistrationFailureInputDTO} [gameServerRegistrationFailureInputDTO] GameServerRegistrationFailureInputDTO
|
|
14130
|
+
* @param {*} [options] Override http request option.
|
|
14131
|
+
* @throws {RequiredError}
|
|
14132
|
+
*/
|
|
14133
|
+
gameServerControllerReportRegistrationFailure: async (gameServerRegistrationFailureInputDTO, options = {}) => {
|
|
14134
|
+
const localVarPath = `/gameserver/registration-failures`;
|
|
14135
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14136
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14137
|
+
let baseOptions;
|
|
14138
|
+
if (configuration) {
|
|
14139
|
+
baseOptions = configuration.baseOptions;
|
|
14140
|
+
}
|
|
14141
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
14142
|
+
const localVarHeaderParameter = {};
|
|
14143
|
+
const localVarQueryParameter = {};
|
|
14144
|
+
// authentication bearerAuth required
|
|
14145
|
+
// http bearer authentication required
|
|
14146
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14147
|
+
// authentication domainAuth required
|
|
14148
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14149
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14150
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14151
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
14152
|
+
localVarRequestOptions.data = serializeDataIfNeeded(gameServerRegistrationFailureInputDTO, localVarRequestOptions, configuration);
|
|
14153
|
+
return {
|
|
14154
|
+
url: toPathString(localVarUrlObj),
|
|
14155
|
+
options: localVarRequestOptions,
|
|
14156
|
+
};
|
|
14157
|
+
},
|
|
13230
14158
|
/**
|
|
13231
14159
|
* Resets all players\' currency to 0 on the specified game server. This action is irreversible. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerResetCurrency`
|
|
13232
14160
|
* @summary Reset currency
|
|
@@ -13359,7 +14287,7 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
13359
14287
|
};
|
|
13360
14288
|
},
|
|
13361
14289
|
/**
|
|
13362
|
-
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to the implied protocol version 0 manifest. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
14290
|
+
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to what the server last reported: the implied protocol version 0 manifest for a version 0 connection, unknown for a server that has not identified. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
13363
14291
|
* @summary Set capabilities
|
|
13364
14292
|
* @param {string} id
|
|
13365
14293
|
* @param {GameServerCapabilitiesInputDTO} [gameServerCapabilitiesInputDTO] GameServerCapabilitiesInputDTO
|
|
@@ -13599,7 +14527,7 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
|
|
|
13599
14527
|
};
|
|
13600
14528
|
},
|
|
13601
14529
|
/**
|
|
13602
|
-
*
|
|
14530
|
+
* Deprecated: use `BanController.delete`. Removes the player\'s ban on this game server from Takaro and from the game, with the same rules as `BanController.delete`. Refuses with 409 while a global ban covers the player. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
13603
14531
|
* @summary Unban player
|
|
13604
14532
|
* @param {string} gameServerId
|
|
13605
14533
|
* @param {string} playerId
|
|
@@ -13721,7 +14649,7 @@ export const GameServerApiFp = function (configuration) {
|
|
|
13721
14649
|
const localVarAxiosParamCreator = GameServerApiAxiosParamCreator(configuration);
|
|
13722
14650
|
return {
|
|
13723
14651
|
/**
|
|
13724
|
-
*
|
|
14652
|
+
* Deprecated: use `BanController.create`. Records a Takaro-managed ban for the player on this game server and applies it in game, with the same rules as `BanController.create` (409 when the player already has an active ban on this server). Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
13725
14653
|
* @summary Ban player
|
|
13726
14654
|
* @param {string} gameServerId
|
|
13727
14655
|
* @param {string} playerId
|
|
@@ -13820,7 +14748,7 @@ export const GameServerApiFp = function (configuration) {
|
|
|
13820
14748
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13821
14749
|
},
|
|
13822
14750
|
/**
|
|
13823
|
-
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true).<br> OperationId: `GameServerControllerGetCapabilities`
|
|
14751
|
+
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true), or an empty one with status unknown while a connector-based gameserver has not reported yet.<br> OperationId: `GameServerControllerGetCapabilities`
|
|
13824
14752
|
* @summary Get capabilities
|
|
13825
14753
|
* @param {string} id
|
|
13826
14754
|
* @param {*} [options] Override http request option.
|
|
@@ -13976,6 +14904,19 @@ export const GameServerApiFp = function (configuration) {
|
|
|
13976
14904
|
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerGetPlayers']?.[localVarOperationServerIndex]?.url;
|
|
13977
14905
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13978
14906
|
},
|
|
14907
|
+
/**
|
|
14908
|
+
* Active Registration Failures, newest first: Game Integrations turned away in the last 24 hours that have not identified successfully since and whose cause still applies. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetRegistrationFailures`
|
|
14909
|
+
* @summary Get registration failures
|
|
14910
|
+
* @param {*} [options] Override http request option.
|
|
14911
|
+
* @throws {RequiredError}
|
|
14912
|
+
*/
|
|
14913
|
+
async gameServerControllerGetRegistrationFailures(options) {
|
|
14914
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.gameServerControllerGetRegistrationFailures(options);
|
|
14915
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
14916
|
+
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerGetRegistrationFailures']?.[localVarOperationServerIndex]
|
|
14917
|
+
?.url;
|
|
14918
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14919
|
+
},
|
|
13979
14920
|
/**
|
|
13980
14921
|
* Fetch gameserver types (7dtd, Rust, ...)<br> OperationId: `GameServerControllerGetTypes`
|
|
13981
14922
|
* @summary Get types
|
|
@@ -14140,6 +15081,19 @@ export const GameServerApiFp = function (configuration) {
|
|
|
14140
15081
|
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerRemoveMapUpload']?.[localVarOperationServerIndex]?.url;
|
|
14141
15082
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14142
15083
|
},
|
|
15084
|
+
/**
|
|
15085
|
+
* Records a Registration Failure: a Game Integration that identified with this domain\'s registration token was turned away. Written by the connector; users never call it. Emits gameserver-registration-failed at most once an hour per identity token. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerReportRegistrationFailure`
|
|
15086
|
+
* @summary Report registration failure
|
|
15087
|
+
* @param {GameServerRegistrationFailureInputDTO} [gameServerRegistrationFailureInputDTO] GameServerRegistrationFailureInputDTO
|
|
15088
|
+
* @param {*} [options] Override http request option.
|
|
15089
|
+
* @throws {RequiredError}
|
|
15090
|
+
*/
|
|
15091
|
+
async gameServerControllerReportRegistrationFailure(gameServerRegistrationFailureInputDTO, options) {
|
|
15092
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.gameServerControllerReportRegistrationFailure(gameServerRegistrationFailureInputDTO, options);
|
|
15093
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15094
|
+
const localVarOperationServerBasePath = operationServerMap['GameServerApi.gameServerControllerReportRegistrationFailure']?.[localVarOperationServerIndex]?.url;
|
|
15095
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15096
|
+
},
|
|
14143
15097
|
/**
|
|
14144
15098
|
* Resets all players\' currency to 0 on the specified game server. This action is irreversible. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerResetCurrency`
|
|
14145
15099
|
* @summary Reset currency
|
|
@@ -14195,7 +15149,7 @@ export const GameServerApiFp = function (configuration) {
|
|
|
14195
15149
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14196
15150
|
},
|
|
14197
15151
|
/**
|
|
14198
|
-
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to the implied protocol version 0 manifest. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
15152
|
+
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to what the server last reported: the implied protocol version 0 manifest for a version 0 connection, unknown for a server that has not identified. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
14199
15153
|
* @summary Set capabilities
|
|
14200
15154
|
* @param {string} id
|
|
14201
15155
|
* @param {GameServerCapabilitiesInputDTO} [gameServerCapabilitiesInputDTO] GameServerCapabilitiesInputDTO
|
|
@@ -14292,7 +15246,7 @@ export const GameServerApiFp = function (configuration) {
|
|
|
14292
15246
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14293
15247
|
},
|
|
14294
15248
|
/**
|
|
14295
|
-
*
|
|
15249
|
+
* Deprecated: use `BanController.delete`. Removes the player\'s ban on this game server from Takaro and from the game, with the same rules as `BanController.delete`. Refuses with 409 while a global ban covers the player. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
14296
15250
|
* @summary Unban player
|
|
14297
15251
|
* @param {string} gameServerId
|
|
14298
15252
|
* @param {string} playerId
|
|
@@ -14345,7 +15299,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
14345
15299
|
const localVarFp = GameServerApiFp(configuration);
|
|
14346
15300
|
return {
|
|
14347
15301
|
/**
|
|
14348
|
-
*
|
|
15302
|
+
* Deprecated: use `BanController.create`. Records a Takaro-managed ban for the player on this game server and applies it in game, with the same rules as `BanController.create` (409 when the player already has an active ban on this server). Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
14349
15303
|
* @summary Ban player
|
|
14350
15304
|
* @param {string} gameServerId
|
|
14351
15305
|
* @param {string} playerId
|
|
@@ -14434,7 +15388,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
14434
15388
|
.then((request) => request(axios, basePath));
|
|
14435
15389
|
},
|
|
14436
15390
|
/**
|
|
14437
|
-
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true).<br> OperationId: `GameServerControllerGetCapabilities`
|
|
15391
|
+
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true), or an empty one with status unknown while a connector-based gameserver has not reported yet.<br> OperationId: `GameServerControllerGetCapabilities`
|
|
14438
15392
|
* @summary Get capabilities
|
|
14439
15393
|
* @param {string} id
|
|
14440
15394
|
* @param {*} [options] Override http request option.
|
|
@@ -14561,6 +15515,17 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
14561
15515
|
gameServerControllerGetPlayers(id, options) {
|
|
14562
15516
|
return localVarFp.gameServerControllerGetPlayers(id, options).then((request) => request(axios, basePath));
|
|
14563
15517
|
},
|
|
15518
|
+
/**
|
|
15519
|
+
* Active Registration Failures, newest first: Game Integrations turned away in the last 24 hours that have not identified successfully since and whose cause still applies. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetRegistrationFailures`
|
|
15520
|
+
* @summary Get registration failures
|
|
15521
|
+
* @param {*} [options] Override http request option.
|
|
15522
|
+
* @throws {RequiredError}
|
|
15523
|
+
*/
|
|
15524
|
+
gameServerControllerGetRegistrationFailures(options) {
|
|
15525
|
+
return localVarFp
|
|
15526
|
+
.gameServerControllerGetRegistrationFailures(options)
|
|
15527
|
+
.then((request) => request(axios, basePath));
|
|
15528
|
+
},
|
|
14564
15529
|
/**
|
|
14565
15530
|
* Fetch gameserver types (7dtd, Rust, ...)<br> OperationId: `GameServerControllerGetTypes`
|
|
14566
15531
|
* @summary Get types
|
|
@@ -14703,6 +15668,18 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
14703
15668
|
.gameServerControllerRemoveMapUpload(id, dimension, options)
|
|
14704
15669
|
.then((request) => request(axios, basePath));
|
|
14705
15670
|
},
|
|
15671
|
+
/**
|
|
15672
|
+
* Records a Registration Failure: a Game Integration that identified with this domain\'s registration token was turned away. Written by the connector; users never call it. Emits gameserver-registration-failed at most once an hour per identity token. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerReportRegistrationFailure`
|
|
15673
|
+
* @summary Report registration failure
|
|
15674
|
+
* @param {GameServerRegistrationFailureInputDTO} [gameServerRegistrationFailureInputDTO] GameServerRegistrationFailureInputDTO
|
|
15675
|
+
* @param {*} [options] Override http request option.
|
|
15676
|
+
* @throws {RequiredError}
|
|
15677
|
+
*/
|
|
15678
|
+
gameServerControllerReportRegistrationFailure(gameServerRegistrationFailureInputDTO, options) {
|
|
15679
|
+
return localVarFp
|
|
15680
|
+
.gameServerControllerReportRegistrationFailure(gameServerRegistrationFailureInputDTO, options)
|
|
15681
|
+
.then((request) => request(axios, basePath));
|
|
15682
|
+
},
|
|
14706
15683
|
/**
|
|
14707
15684
|
* Resets all players\' currency to 0 on the specified game server. This action is irreversible. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerResetCurrency`
|
|
14708
15685
|
* @summary Reset currency
|
|
@@ -14751,7 +15728,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
14751
15728
|
.then((request) => request(axios, basePath));
|
|
14752
15729
|
},
|
|
14753
15730
|
/**
|
|
14754
|
-
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to the implied protocol version 0 manifest. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
15731
|
+
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to what the server last reported: the implied protocol version 0 manifest for a version 0 connection, unknown for a server that has not identified. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
14755
15732
|
* @summary Set capabilities
|
|
14756
15733
|
* @param {string} id
|
|
14757
15734
|
* @param {GameServerCapabilitiesInputDTO} [gameServerCapabilitiesInputDTO] GameServerCapabilitiesInputDTO
|
|
@@ -14835,7 +15812,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
14835
15812
|
return localVarFp.gameServerControllerTriggerJob(type, id, options).then((request) => request(axios, basePath));
|
|
14836
15813
|
},
|
|
14837
15814
|
/**
|
|
14838
|
-
*
|
|
15815
|
+
* Deprecated: use `BanController.delete`. Removes the player\'s ban on this game server from Takaro and from the game, with the same rules as `BanController.delete`. Refuses with 409 while a global ban covers the player. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
14839
15816
|
* @summary Unban player
|
|
14840
15817
|
* @param {string} gameServerId
|
|
14841
15818
|
* @param {string} playerId
|
|
@@ -14885,7 +15862,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
|
|
|
14885
15862
|
*/
|
|
14886
15863
|
export class GameServerApi extends BaseAPI {
|
|
14887
15864
|
/**
|
|
14888
|
-
*
|
|
15865
|
+
* Deprecated: use `BanController.create`. Records a Takaro-managed ban for the player on this game server and applies it in game, with the same rules as `BanController.create` (409 when the player already has an active ban on this server). Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
14889
15866
|
* @summary Ban player
|
|
14890
15867
|
* @param {string} gameServerId
|
|
14891
15868
|
* @param {string} playerId
|
|
@@ -14981,7 +15958,7 @@ export class GameServerApi extends BaseAPI {
|
|
|
14981
15958
|
.then((request) => request(this.axios, this.basePath));
|
|
14982
15959
|
}
|
|
14983
15960
|
/**
|
|
14984
|
-
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true).<br> OperationId: `GameServerControllerGetCapabilities`
|
|
15961
|
+
* The Capability Manifest of a gameserver: the capabilities its connector declared. A gameserver that declared none reports the implied protocol version 0 manifest (implied: true), or an empty one with status unknown while a connector-based gameserver has not reported yet.<br> OperationId: `GameServerControllerGetCapabilities`
|
|
14985
15962
|
* @summary Get capabilities
|
|
14986
15963
|
* @param {string} id
|
|
14987
15964
|
* @param {*} [options] Override http request option.
|
|
@@ -15135,6 +16112,18 @@ export class GameServerApi extends BaseAPI {
|
|
|
15135
16112
|
.gameServerControllerGetPlayers(id, options)
|
|
15136
16113
|
.then((request) => request(this.axios, this.basePath));
|
|
15137
16114
|
}
|
|
16115
|
+
/**
|
|
16116
|
+
* Active Registration Failures, newest first: Game Integrations turned away in the last 24 hours that have not identified successfully since and whose cause still applies. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetRegistrationFailures`
|
|
16117
|
+
* @summary Get registration failures
|
|
16118
|
+
* @param {*} [options] Override http request option.
|
|
16119
|
+
* @throws {RequiredError}
|
|
16120
|
+
* @memberof GameServerApi
|
|
16121
|
+
*/
|
|
16122
|
+
gameServerControllerGetRegistrationFailures(options) {
|
|
16123
|
+
return GameServerApiFp(this.configuration)
|
|
16124
|
+
.gameServerControllerGetRegistrationFailures(options)
|
|
16125
|
+
.then((request) => request(this.axios, this.basePath));
|
|
16126
|
+
}
|
|
15138
16127
|
/**
|
|
15139
16128
|
* Fetch gameserver types (7dtd, Rust, ...)<br> OperationId: `GameServerControllerGetTypes`
|
|
15140
16129
|
* @summary Get types
|
|
@@ -15299,6 +16288,19 @@ export class GameServerApi extends BaseAPI {
|
|
|
15299
16288
|
.gameServerControllerRemoveMapUpload(id, dimension, options)
|
|
15300
16289
|
.then((request) => request(this.axios, this.basePath));
|
|
15301
16290
|
}
|
|
16291
|
+
/**
|
|
16292
|
+
* Records a Registration Failure: a Game Integration that identified with this domain\'s registration token was turned away. Written by the connector; users never call it. Emits gameserver-registration-failed at most once an hour per identity token. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerReportRegistrationFailure`
|
|
16293
|
+
* @summary Report registration failure
|
|
16294
|
+
* @param {GameServerRegistrationFailureInputDTO} [gameServerRegistrationFailureInputDTO] GameServerRegistrationFailureInputDTO
|
|
16295
|
+
* @param {*} [options] Override http request option.
|
|
16296
|
+
* @throws {RequiredError}
|
|
16297
|
+
* @memberof GameServerApi
|
|
16298
|
+
*/
|
|
16299
|
+
gameServerControllerReportRegistrationFailure(gameServerRegistrationFailureInputDTO, options) {
|
|
16300
|
+
return GameServerApiFp(this.configuration)
|
|
16301
|
+
.gameServerControllerReportRegistrationFailure(gameServerRegistrationFailureInputDTO, options)
|
|
16302
|
+
.then((request) => request(this.axios, this.basePath));
|
|
16303
|
+
}
|
|
15302
16304
|
/**
|
|
15303
16305
|
* Resets all players\' currency to 0 on the specified game server. This action is irreversible. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerResetCurrency`
|
|
15304
16306
|
* @summary Reset currency
|
|
@@ -15353,7 +16355,7 @@ export class GameServerApi extends BaseAPI {
|
|
|
15353
16355
|
.then((request) => request(this.axios, this.basePath));
|
|
15354
16356
|
}
|
|
15355
16357
|
/**
|
|
15356
|
-
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to the implied protocol version 0 manifest. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
16358
|
+
* Replace the Capability Manifest of a generic gameserver. Written by the connector on handshake; users normally only read it. A null manifest returns to what the server last reported: the implied protocol version 0 manifest for a version 0 connection, unknown for a server that has not identified. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerSetCapabilities`
|
|
15357
16359
|
* @summary Set capabilities
|
|
15358
16360
|
* @param {string} id
|
|
15359
16361
|
* @param {GameServerCapabilitiesInputDTO} [gameServerCapabilitiesInputDTO] GameServerCapabilitiesInputDTO
|
|
@@ -15448,7 +16450,7 @@ export class GameServerApi extends BaseAPI {
|
|
|
15448
16450
|
.then((request) => request(this.axios, this.basePath));
|
|
15449
16451
|
}
|
|
15450
16452
|
/**
|
|
15451
|
-
*
|
|
16453
|
+
* Deprecated: use `BanController.delete`. Removes the player\'s ban on this game server from Takaro and from the game, with the same rules as `BanController.delete`. Refuses with 409 while a global ban covers the player. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
15452
16454
|
* @summary Unban player
|
|
15453
16455
|
* @param {string} gameServerId
|
|
15454
16456
|
* @param {string} playerId
|
|
@@ -18423,7 +19425,7 @@ export const ModuleApiAxiosParamCreator = function (configuration) {
|
|
|
18423
19425
|
};
|
|
18424
19426
|
},
|
|
18425
19427
|
/**
|
|
18426
|
-
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given.
|
|
19428
|
+
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. `sortBy` accepts `id`, `createdAt`, `updatedAt`, `gameserverId`, `moduleId`, `versionId`, or `moduleName` to order by the installed module\'s name, case-insensitively. `filters.enabled` matches `systemConfig.enabled`, and an installation without the value counts as enabled. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
|
|
18427
19429
|
* @summary List the modules installed on a game server
|
|
18428
19430
|
* @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
|
|
18429
19431
|
* @param {*} [options] Override http request option.
|
|
@@ -18492,7 +19494,7 @@ export const ModuleApiAxiosParamCreator = function (configuration) {
|
|
|
18492
19494
|
};
|
|
18493
19495
|
},
|
|
18494
19496
|
/**
|
|
18495
|
-
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
19497
|
+
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Send the `installationId` you loaded when saving a configuration: if the installation was replaced or removed since, the save is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
18496
19498
|
* @summary Install a module on a game server
|
|
18497
19499
|
* @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
|
|
18498
19500
|
* @param {*} [options] Override http request option.
|
|
@@ -18827,7 +19829,7 @@ export const ModuleApiFp = function (configuration) {
|
|
|
18827
19829
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18828
19830
|
},
|
|
18829
19831
|
/**
|
|
18830
|
-
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given.
|
|
19832
|
+
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. `sortBy` accepts `id`, `createdAt`, `updatedAt`, `gameserverId`, `moduleId`, `versionId`, or `moduleName` to order by the installed module\'s name, case-insensitively. `filters.enabled` matches `systemConfig.enabled`, and an installation without the value counts as enabled. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
|
|
18831
19833
|
* @summary List the modules installed on a game server
|
|
18832
19834
|
* @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
|
|
18833
19835
|
* @param {*} [options] Override http request option.
|
|
@@ -18855,7 +19857,7 @@ export const ModuleApiFp = function (configuration) {
|
|
|
18855
19857
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
18856
19858
|
},
|
|
18857
19859
|
/**
|
|
18858
|
-
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
19860
|
+
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Send the `installationId` you loaded when saving a configuration: if the installation was replaced or removed since, the save is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
18859
19861
|
* @summary Install a module on a game server
|
|
18860
19862
|
* @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
|
|
18861
19863
|
* @param {*} [options] Override http request option.
|
|
@@ -19047,7 +20049,7 @@ export const ModuleApiFactory = function (configuration, basePath, axios) {
|
|
|
19047
20049
|
.then((request) => request(axios, basePath));
|
|
19048
20050
|
},
|
|
19049
20051
|
/**
|
|
19050
|
-
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given.
|
|
20052
|
+
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. `sortBy` accepts `id`, `createdAt`, `updatedAt`, `gameserverId`, `moduleId`, `versionId`, or `moduleName` to order by the installed module\'s name, case-insensitively. `filters.enabled` matches `systemConfig.enabled`, and an installation without the value counts as enabled. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
|
|
19051
20053
|
* @summary List the modules installed on a game server
|
|
19052
20054
|
* @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
|
|
19053
20055
|
* @param {*} [options] Override http request option.
|
|
@@ -19072,7 +20074,7 @@ export const ModuleApiFactory = function (configuration, basePath, axios) {
|
|
|
19072
20074
|
.then((request) => request(axios, basePath));
|
|
19073
20075
|
},
|
|
19074
20076
|
/**
|
|
19075
|
-
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
20077
|
+
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Send the `installationId` you loaded when saving a configuration: if the installation was replaced or removed since, the save is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
19076
20078
|
* @summary Install a module on a game server
|
|
19077
20079
|
* @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
|
|
19078
20080
|
* @param {*} [options] Override http request option.
|
|
@@ -19276,7 +20278,7 @@ export class ModuleApi extends BaseAPI {
|
|
|
19276
20278
|
.then((request) => request(this.axios, this.basePath));
|
|
19277
20279
|
}
|
|
19278
20280
|
/**
|
|
19279
|
-
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given.
|
|
20281
|
+
* Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. `sortBy` accepts `id`, `createdAt`, `updatedAt`, `gameserverId`, `moduleId`, `versionId`, or `moduleName` to order by the installed module\'s name, case-insensitively. `filters.enabled` matches `systemConfig.enabled`, and an installation without the value counts as enabled. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
|
|
19280
20282
|
* @summary List the modules installed on a game server
|
|
19281
20283
|
* @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
|
|
19282
20284
|
* @param {*} [options] Override http request option.
|
|
@@ -19303,7 +20305,7 @@ export class ModuleApi extends BaseAPI {
|
|
|
19303
20305
|
.then((request) => request(this.axios, this.basePath));
|
|
19304
20306
|
}
|
|
19305
20307
|
/**
|
|
19306
|
-
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
20308
|
+
* Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. When the game server declares a Capability Manifest that lacks capabilities the version needs, the request fails with a 400 unless acknowledgeMissingCapabilities is true; re-installing the already installed version (a config change) is never refused. Refused when Takaro has blocked the version or registry. Installing a different version than the one installed moves to draft every live shop listing on this game server whose shop action that version lacks, and cancels and refunds its paid orders; switching back does not undo this. Item picker values in userConfig that refer to an item on another game server are re-pointed to the item with the same code on this game server; the request fails with 400 when this game server has no item with that code. Send the `installationId` you loaded when saving a configuration: if the installation was replaced or removed since, the save is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
|
|
19307
20309
|
* @summary Install a module on a game server
|
|
19308
20310
|
* @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
|
|
19309
20311
|
* @param {*} [options] Override http request option.
|
|
@@ -19519,7 +20521,7 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
|
|
|
19519
20521
|
};
|
|
19520
20522
|
},
|
|
19521
20523
|
/**
|
|
19522
|
-
* Update
|
|
20524
|
+
* Update a ban\'s reason and expiry and apply them on the game server(s) the ban covers; global bans need no gameServerId. A ban\'s player and scope cannot be changed (400). Updating a ban via the API will always make it takaro managed. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerUpdate`
|
|
19523
20525
|
* @summary Update ban
|
|
19524
20526
|
* @param {string} id
|
|
19525
20527
|
* @param {BanUpdateDTO} [banUpdateDTO] BanUpdateDTO
|
|
@@ -20024,7 +21026,7 @@ export const PlayerApiFp = function (configuration) {
|
|
|
20024
21026
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20025
21027
|
},
|
|
20026
21028
|
/**
|
|
20027
|
-
* Update
|
|
21029
|
+
* Update a ban\'s reason and expiry and apply them on the game server(s) the ban covers; global bans need no gameServerId. A ban\'s player and scope cannot be changed (400). Updating a ban via the API will always make it takaro managed. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerUpdate`
|
|
20028
21030
|
* @summary Update ban
|
|
20029
21031
|
* @param {string} id
|
|
20030
21032
|
* @param {BanUpdateDTO} [banUpdateDTO] BanUpdateDTO
|
|
@@ -20250,7 +21252,7 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
|
|
|
20250
21252
|
return localVarFp.banControllerSearch(banSearchInputDTO, options).then((request) => request(axios, basePath));
|
|
20251
21253
|
},
|
|
20252
21254
|
/**
|
|
20253
|
-
* Update
|
|
21255
|
+
* Update a ban\'s reason and expiry and apply them on the game server(s) the ban covers; global bans need no gameServerId. A ban\'s player and scope cannot be changed (400). Updating a ban via the API will always make it takaro managed. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerUpdate`
|
|
20254
21256
|
* @summary Update ban
|
|
20255
21257
|
* @param {string} id
|
|
20256
21258
|
* @param {BanUpdateDTO} [banUpdateDTO] BanUpdateDTO
|
|
@@ -20465,7 +21467,7 @@ export class PlayerApi extends BaseAPI {
|
|
|
20465
21467
|
.then((request) => request(this.axios, this.basePath));
|
|
20466
21468
|
}
|
|
20467
21469
|
/**
|
|
20468
|
-
* Update
|
|
21470
|
+
* Update a ban\'s reason and expiry and apply them on the game server(s) the ban covers; global bans need no gameServerId. A ban\'s player and scope cannot be changed (400). Updating a ban via the API will always make it takaro managed. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerUpdate`
|
|
20469
21471
|
* @summary Update ban
|
|
20470
21472
|
* @param {string} id
|
|
20471
21473
|
* @param {BanUpdateDTO} [banUpdateDTO] BanUpdateDTO
|
|
@@ -22093,7 +23095,7 @@ export const RegistryApiAxiosParamCreator = function (configuration) {
|
|
|
22093
23095
|
};
|
|
22094
23096
|
},
|
|
22095
23097
|
/**
|
|
22096
|
-
* List
|
|
23098
|
+
* List subscribed registries with their cached module manifests. A registry whose manifest was never fetched successfully is fetched on read, at most every 30 seconds. Required permissions: `READ_MODULES`<br> OperationId: `RegistryControllerList`
|
|
22097
23099
|
* @summary List subscribed registries
|
|
22098
23100
|
* @param {*} [options] Override http request option.
|
|
22099
23101
|
* @throws {RequiredError}
|
|
@@ -22163,7 +23165,7 @@ export const RegistryApiAxiosParamCreator = function (configuration) {
|
|
|
22163
23165
|
};
|
|
22164
23166
|
},
|
|
22165
23167
|
/**
|
|
22166
|
-
* Bust the manifest cache and re-fetch from the registry URL. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
23168
|
+
* Bust the manifest cache and re-fetch from the registry URL, and return the registry in the same shape as GET /registry. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
22167
23169
|
* @summary Refresh registry manifest
|
|
22168
23170
|
* @param {string} id
|
|
22169
23171
|
* @param {*} [options] Override http request option.
|
|
@@ -22195,7 +23197,7 @@ export const RegistryApiAxiosParamCreator = function (configuration) {
|
|
|
22195
23197
|
};
|
|
22196
23198
|
},
|
|
22197
23199
|
/**
|
|
22198
|
-
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
23200
|
+
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Returns the registry in the same shape as GET /registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
22199
23201
|
* @summary Subscribe to a registry
|
|
22200
23202
|
* @param {RegistrySubscribeBody} [registrySubscribeBody] RegistrySubscribeBody
|
|
22201
23203
|
* @param {*} [options] Override http request option.
|
|
@@ -22295,7 +23297,7 @@ export const RegistryApiFp = function (configuration) {
|
|
|
22295
23297
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22296
23298
|
},
|
|
22297
23299
|
/**
|
|
22298
|
-
* List
|
|
23300
|
+
* List subscribed registries with their cached module manifests. A registry whose manifest was never fetched successfully is fetched on read, at most every 30 seconds. Required permissions: `READ_MODULES`<br> OperationId: `RegistryControllerList`
|
|
22299
23301
|
* @summary List subscribed registries
|
|
22300
23302
|
* @param {*} [options] Override http request option.
|
|
22301
23303
|
* @throws {RequiredError}
|
|
@@ -22322,7 +23324,7 @@ export const RegistryApiFp = function (configuration) {
|
|
|
22322
23324
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22323
23325
|
},
|
|
22324
23326
|
/**
|
|
22325
|
-
* Bust the manifest cache and re-fetch from the registry URL. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
23327
|
+
* Bust the manifest cache and re-fetch from the registry URL, and return the registry in the same shape as GET /registry. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
22326
23328
|
* @summary Refresh registry manifest
|
|
22327
23329
|
* @param {string} id
|
|
22328
23330
|
* @param {*} [options] Override http request option.
|
|
@@ -22335,7 +23337,7 @@ export const RegistryApiFp = function (configuration) {
|
|
|
22335
23337
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22336
23338
|
},
|
|
22337
23339
|
/**
|
|
22338
|
-
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
23340
|
+
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Returns the registry in the same shape as GET /registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
22339
23341
|
* @summary Subscribe to a registry
|
|
22340
23342
|
* @param {RegistrySubscribeBody} [registrySubscribeBody] RegistrySubscribeBody
|
|
22341
23343
|
* @param {*} [options] Override http request option.
|
|
@@ -22395,7 +23397,7 @@ export const RegistryApiFactory = function (configuration, basePath, axios) {
|
|
|
22395
23397
|
.then((request) => request(axios, basePath));
|
|
22396
23398
|
},
|
|
22397
23399
|
/**
|
|
22398
|
-
* List
|
|
23400
|
+
* List subscribed registries with their cached module manifests. A registry whose manifest was never fetched successfully is fetched on read, at most every 30 seconds. Required permissions: `READ_MODULES`<br> OperationId: `RegistryControllerList`
|
|
22399
23401
|
* @summary List subscribed registries
|
|
22400
23402
|
* @param {*} [options] Override http request option.
|
|
22401
23403
|
* @throws {RequiredError}
|
|
@@ -22418,7 +23420,7 @@ export const RegistryApiFactory = function (configuration, basePath, axios) {
|
|
|
22418
23420
|
.then((request) => request(axios, basePath));
|
|
22419
23421
|
},
|
|
22420
23422
|
/**
|
|
22421
|
-
* Bust the manifest cache and re-fetch from the registry URL. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
23423
|
+
* Bust the manifest cache and re-fetch from the registry URL, and return the registry in the same shape as GET /registry. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
22422
23424
|
* @summary Refresh registry manifest
|
|
22423
23425
|
* @param {string} id
|
|
22424
23426
|
* @param {*} [options] Override http request option.
|
|
@@ -22428,7 +23430,7 @@ export const RegistryApiFactory = function (configuration, basePath, axios) {
|
|
|
22428
23430
|
return localVarFp.registryControllerRefresh(id, options).then((request) => request(axios, basePath));
|
|
22429
23431
|
},
|
|
22430
23432
|
/**
|
|
22431
|
-
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
23433
|
+
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Returns the registry in the same shape as GET /registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
22432
23434
|
* @summary Subscribe to a registry
|
|
22433
23435
|
* @param {RegistrySubscribeBody} [registrySubscribeBody] RegistrySubscribeBody
|
|
22434
23436
|
* @param {*} [options] Override http request option.
|
|
@@ -22486,7 +23488,7 @@ export class RegistryApi extends BaseAPI {
|
|
|
22486
23488
|
.then((request) => request(this.axios, this.basePath));
|
|
22487
23489
|
}
|
|
22488
23490
|
/**
|
|
22489
|
-
* List
|
|
23491
|
+
* List subscribed registries with their cached module manifests. A registry whose manifest was never fetched successfully is fetched on read, at most every 30 seconds. Required permissions: `READ_MODULES`<br> OperationId: `RegistryControllerList`
|
|
22490
23492
|
* @summary List subscribed registries
|
|
22491
23493
|
* @param {*} [options] Override http request option.
|
|
22492
23494
|
* @throws {RequiredError}
|
|
@@ -22513,7 +23515,7 @@ export class RegistryApi extends BaseAPI {
|
|
|
22513
23515
|
.then((request) => request(this.axios, this.basePath));
|
|
22514
23516
|
}
|
|
22515
23517
|
/**
|
|
22516
|
-
* Bust the manifest cache and re-fetch from the registry URL. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
23518
|
+
* Bust the manifest cache and re-fetch from the registry URL, and return the registry in the same shape as GET /registry. Requires MANAGE_MODULES permission. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerRefresh`
|
|
22517
23519
|
* @summary Refresh registry manifest
|
|
22518
23520
|
* @param {string} id
|
|
22519
23521
|
* @param {*} [options] Override http request option.
|
|
@@ -22526,7 +23528,7 @@ export class RegistryApi extends BaseAPI {
|
|
|
22526
23528
|
.then((request) => request(this.axios, this.basePath));
|
|
22527
23529
|
}
|
|
22528
23530
|
/**
|
|
22529
|
-
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
23531
|
+
* Subscribe to a module registry by URL. The URL must serve a valid registry.json manifest. Refused when Takaro has blocked the registry. Returns the registry in the same shape as GET /registry. Required permissions: `MANAGE_MODULES`<br> OperationId: `RegistryControllerSubscribe`
|
|
22530
23532
|
* @summary Subscribe to a registry
|
|
22531
23533
|
* @param {RegistrySubscribeBody} [registrySubscribeBody] RegistrySubscribeBody
|
|
22532
23534
|
* @param {*} [options] Override http request option.
|
|
@@ -22558,6 +23560,46 @@ export class RegistryApi extends BaseAPI {
|
|
|
22558
23560
|
*/
|
|
22559
23561
|
export const RoleApiAxiosParamCreator = function (configuration) {
|
|
22560
23562
|
return {
|
|
23563
|
+
/**
|
|
23564
|
+
* Adds the named permission, or sets its count when the role already holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerAddPermission`
|
|
23565
|
+
* @summary Add a permission to a role
|
|
23566
|
+
* @param {string} id
|
|
23567
|
+
* @param {string} permissionId
|
|
23568
|
+
* @param {RolePermissionAddInputDTO} [rolePermissionAddInputDTO] RolePermissionAddInputDTO
|
|
23569
|
+
* @param {*} [options] Override http request option.
|
|
23570
|
+
* @throws {RequiredError}
|
|
23571
|
+
*/
|
|
23572
|
+
roleControllerAddPermission: async (id, permissionId, rolePermissionAddInputDTO, options = {}) => {
|
|
23573
|
+
// verify required parameter 'id' is not null or undefined
|
|
23574
|
+
assertParamExists('roleControllerAddPermission', 'id', id);
|
|
23575
|
+
// verify required parameter 'permissionId' is not null or undefined
|
|
23576
|
+
assertParamExists('roleControllerAddPermission', 'permissionId', permissionId);
|
|
23577
|
+
const localVarPath = `/role/{id}/permission/{permissionId}`
|
|
23578
|
+
.replace(`{${'id'}}`, encodeURIComponent(String(id)))
|
|
23579
|
+
.replace(`{${'permissionId'}}`, encodeURIComponent(String(permissionId)));
|
|
23580
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23581
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23582
|
+
let baseOptions;
|
|
23583
|
+
if (configuration) {
|
|
23584
|
+
baseOptions = configuration.baseOptions;
|
|
23585
|
+
}
|
|
23586
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
23587
|
+
const localVarHeaderParameter = {};
|
|
23588
|
+
const localVarQueryParameter = {};
|
|
23589
|
+
// authentication bearerAuth required
|
|
23590
|
+
// http bearer authentication required
|
|
23591
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23592
|
+
// authentication domainAuth required
|
|
23593
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23594
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23595
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23596
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
23597
|
+
localVarRequestOptions.data = serializeDataIfNeeded(rolePermissionAddInputDTO, localVarRequestOptions, configuration);
|
|
23598
|
+
return {
|
|
23599
|
+
url: toPathString(localVarUrlObj),
|
|
23600
|
+
options: localVarRequestOptions,
|
|
23601
|
+
};
|
|
23602
|
+
},
|
|
22561
23603
|
/**
|
|
22562
23604
|
* Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerCreate`
|
|
22563
23605
|
* @summary Create
|
|
@@ -22683,6 +23725,43 @@ export const RoleApiAxiosParamCreator = function (configuration) {
|
|
|
22683
23725
|
options: localVarRequestOptions,
|
|
22684
23726
|
};
|
|
22685
23727
|
},
|
|
23728
|
+
/**
|
|
23729
|
+
* Removes the named permission if the role holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerRemovePermission`
|
|
23730
|
+
* @summary Remove a permission from a role
|
|
23731
|
+
* @param {string} id
|
|
23732
|
+
* @param {string} permissionId
|
|
23733
|
+
* @param {*} [options] Override http request option.
|
|
23734
|
+
* @throws {RequiredError}
|
|
23735
|
+
*/
|
|
23736
|
+
roleControllerRemovePermission: async (id, permissionId, options = {}) => {
|
|
23737
|
+
// verify required parameter 'id' is not null or undefined
|
|
23738
|
+
assertParamExists('roleControllerRemovePermission', 'id', id);
|
|
23739
|
+
// verify required parameter 'permissionId' is not null or undefined
|
|
23740
|
+
assertParamExists('roleControllerRemovePermission', 'permissionId', permissionId);
|
|
23741
|
+
const localVarPath = `/role/{id}/permission/{permissionId}`
|
|
23742
|
+
.replace(`{${'id'}}`, encodeURIComponent(String(id)))
|
|
23743
|
+
.replace(`{${'permissionId'}}`, encodeURIComponent(String(permissionId)));
|
|
23744
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23745
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23746
|
+
let baseOptions;
|
|
23747
|
+
if (configuration) {
|
|
23748
|
+
baseOptions = configuration.baseOptions;
|
|
23749
|
+
}
|
|
23750
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
23751
|
+
const localVarHeaderParameter = {};
|
|
23752
|
+
const localVarQueryParameter = {};
|
|
23753
|
+
// authentication bearerAuth required
|
|
23754
|
+
// http bearer authentication required
|
|
23755
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
23756
|
+
// authentication domainAuth required
|
|
23757
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23758
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23759
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
23760
|
+
return {
|
|
23761
|
+
url: toPathString(localVarUrlObj),
|
|
23762
|
+
options: localVarRequestOptions,
|
|
23763
|
+
};
|
|
23764
|
+
},
|
|
22686
23765
|
/**
|
|
22687
23766
|
* Required permissions: `READ_ROLES`<br> OperationId: `RoleControllerSearch`
|
|
22688
23767
|
* @summary Search
|
|
@@ -22759,6 +23838,21 @@ export const RoleApiAxiosParamCreator = function (configuration) {
|
|
|
22759
23838
|
export const RoleApiFp = function (configuration) {
|
|
22760
23839
|
const localVarAxiosParamCreator = RoleApiAxiosParamCreator(configuration);
|
|
22761
23840
|
return {
|
|
23841
|
+
/**
|
|
23842
|
+
* Adds the named permission, or sets its count when the role already holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerAddPermission`
|
|
23843
|
+
* @summary Add a permission to a role
|
|
23844
|
+
* @param {string} id
|
|
23845
|
+
* @param {string} permissionId
|
|
23846
|
+
* @param {RolePermissionAddInputDTO} [rolePermissionAddInputDTO] RolePermissionAddInputDTO
|
|
23847
|
+
* @param {*} [options] Override http request option.
|
|
23848
|
+
* @throws {RequiredError}
|
|
23849
|
+
*/
|
|
23850
|
+
async roleControllerAddPermission(id, permissionId, rolePermissionAddInputDTO, options) {
|
|
23851
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.roleControllerAddPermission(id, permissionId, rolePermissionAddInputDTO, options);
|
|
23852
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
23853
|
+
const localVarOperationServerBasePath = operationServerMap['RoleApi.roleControllerAddPermission']?.[localVarOperationServerIndex]?.url;
|
|
23854
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23855
|
+
},
|
|
22762
23856
|
/**
|
|
22763
23857
|
* Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerCreate`
|
|
22764
23858
|
* @summary Create
|
|
@@ -22810,6 +23904,20 @@ export const RoleApiFp = function (configuration) {
|
|
|
22810
23904
|
const localVarOperationServerBasePath = operationServerMap['RoleApi.roleControllerRemove']?.[localVarOperationServerIndex]?.url;
|
|
22811
23905
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22812
23906
|
},
|
|
23907
|
+
/**
|
|
23908
|
+
* Removes the named permission if the role holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerRemovePermission`
|
|
23909
|
+
* @summary Remove a permission from a role
|
|
23910
|
+
* @param {string} id
|
|
23911
|
+
* @param {string} permissionId
|
|
23912
|
+
* @param {*} [options] Override http request option.
|
|
23913
|
+
* @throws {RequiredError}
|
|
23914
|
+
*/
|
|
23915
|
+
async roleControllerRemovePermission(id, permissionId, options) {
|
|
23916
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.roleControllerRemovePermission(id, permissionId, options);
|
|
23917
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
23918
|
+
const localVarOperationServerBasePath = operationServerMap['RoleApi.roleControllerRemovePermission']?.[localVarOperationServerIndex]?.url;
|
|
23919
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23920
|
+
},
|
|
22813
23921
|
/**
|
|
22814
23922
|
* Required permissions: `READ_ROLES`<br> OperationId: `RoleControllerSearch`
|
|
22815
23923
|
* @summary Search
|
|
@@ -22846,6 +23954,20 @@ export const RoleApiFp = function (configuration) {
|
|
|
22846
23954
|
export const RoleApiFactory = function (configuration, basePath, axios) {
|
|
22847
23955
|
const localVarFp = RoleApiFp(configuration);
|
|
22848
23956
|
return {
|
|
23957
|
+
/**
|
|
23958
|
+
* Adds the named permission, or sets its count when the role already holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerAddPermission`
|
|
23959
|
+
* @summary Add a permission to a role
|
|
23960
|
+
* @param {string} id
|
|
23961
|
+
* @param {string} permissionId
|
|
23962
|
+
* @param {RolePermissionAddInputDTO} [rolePermissionAddInputDTO] RolePermissionAddInputDTO
|
|
23963
|
+
* @param {*} [options] Override http request option.
|
|
23964
|
+
* @throws {RequiredError}
|
|
23965
|
+
*/
|
|
23966
|
+
roleControllerAddPermission(id, permissionId, rolePermissionAddInputDTO, options) {
|
|
23967
|
+
return localVarFp
|
|
23968
|
+
.roleControllerAddPermission(id, permissionId, rolePermissionAddInputDTO, options)
|
|
23969
|
+
.then((request) => request(axios, basePath));
|
|
23970
|
+
},
|
|
22849
23971
|
/**
|
|
22850
23972
|
* Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerCreate`
|
|
22851
23973
|
* @summary Create
|
|
@@ -22885,6 +24007,19 @@ export const RoleApiFactory = function (configuration, basePath, axios) {
|
|
|
22885
24007
|
roleControllerRemove(id, options) {
|
|
22886
24008
|
return localVarFp.roleControllerRemove(id, options).then((request) => request(axios, basePath));
|
|
22887
24009
|
},
|
|
24010
|
+
/**
|
|
24011
|
+
* Removes the named permission if the role holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerRemovePermission`
|
|
24012
|
+
* @summary Remove a permission from a role
|
|
24013
|
+
* @param {string} id
|
|
24014
|
+
* @param {string} permissionId
|
|
24015
|
+
* @param {*} [options] Override http request option.
|
|
24016
|
+
* @throws {RequiredError}
|
|
24017
|
+
*/
|
|
24018
|
+
roleControllerRemovePermission(id, permissionId, options) {
|
|
24019
|
+
return localVarFp
|
|
24020
|
+
.roleControllerRemovePermission(id, permissionId, options)
|
|
24021
|
+
.then((request) => request(axios, basePath));
|
|
24022
|
+
},
|
|
22888
24023
|
/**
|
|
22889
24024
|
* Required permissions: `READ_ROLES`<br> OperationId: `RoleControllerSearch`
|
|
22890
24025
|
* @summary Search
|
|
@@ -22917,6 +24052,21 @@ export const RoleApiFactory = function (configuration, basePath, axios) {
|
|
|
22917
24052
|
* @extends {BaseAPI}
|
|
22918
24053
|
*/
|
|
22919
24054
|
export class RoleApi extends BaseAPI {
|
|
24055
|
+
/**
|
|
24056
|
+
* Adds the named permission, or sets its count when the role already holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerAddPermission`
|
|
24057
|
+
* @summary Add a permission to a role
|
|
24058
|
+
* @param {string} id
|
|
24059
|
+
* @param {string} permissionId
|
|
24060
|
+
* @param {RolePermissionAddInputDTO} [rolePermissionAddInputDTO] RolePermissionAddInputDTO
|
|
24061
|
+
* @param {*} [options] Override http request option.
|
|
24062
|
+
* @throws {RequiredError}
|
|
24063
|
+
* @memberof RoleApi
|
|
24064
|
+
*/
|
|
24065
|
+
roleControllerAddPermission(id, permissionId, rolePermissionAddInputDTO, options) {
|
|
24066
|
+
return RoleApiFp(this.configuration)
|
|
24067
|
+
.roleControllerAddPermission(id, permissionId, rolePermissionAddInputDTO, options)
|
|
24068
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24069
|
+
}
|
|
22920
24070
|
/**
|
|
22921
24071
|
* Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerCreate`
|
|
22922
24072
|
* @summary Create
|
|
@@ -22968,6 +24118,20 @@ export class RoleApi extends BaseAPI {
|
|
|
22968
24118
|
.roleControllerRemove(id, options)
|
|
22969
24119
|
.then((request) => request(this.axios, this.basePath));
|
|
22970
24120
|
}
|
|
24121
|
+
/**
|
|
24122
|
+
* Removes the named permission if the role holds it. Changes only this permission and leaves the role\'s other permissions alone. Required permissions: `MANAGE_ROLES`<br> OperationId: `RoleControllerRemovePermission`
|
|
24123
|
+
* @summary Remove a permission from a role
|
|
24124
|
+
* @param {string} id
|
|
24125
|
+
* @param {string} permissionId
|
|
24126
|
+
* @param {*} [options] Override http request option.
|
|
24127
|
+
* @throws {RequiredError}
|
|
24128
|
+
* @memberof RoleApi
|
|
24129
|
+
*/
|
|
24130
|
+
roleControllerRemovePermission(id, permissionId, options) {
|
|
24131
|
+
return RoleApiFp(this.configuration)
|
|
24132
|
+
.roleControllerRemovePermission(id, permissionId, options)
|
|
24133
|
+
.then((request) => request(this.axios, this.basePath));
|
|
24134
|
+
}
|
|
22971
24135
|
/**
|
|
22972
24136
|
* Required permissions: `READ_ROLES`<br> OperationId: `RoleControllerSearch`
|
|
22973
24137
|
* @summary Search
|
|
@@ -23003,7 +24167,7 @@ export class RoleApi extends BaseAPI {
|
|
|
23003
24167
|
export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
23004
24168
|
return {
|
|
23005
24169
|
/**
|
|
23006
|
-
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
24170
|
+
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
23007
24171
|
* @summary Create a Saved Query
|
|
23008
24172
|
* @param {SavedQueryCreateDTO} [savedQueryCreateDTO] SavedQueryCreateDTO
|
|
23009
24173
|
* @param {*} [options] Override http request option.
|
|
@@ -23035,7 +24199,7 @@ export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
|
23035
24199
|
};
|
|
23036
24200
|
},
|
|
23037
24201
|
/**
|
|
23038
|
-
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
24202
|
+
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
23039
24203
|
* @summary Duplicate a Saved Query
|
|
23040
24204
|
* @param {string} id
|
|
23041
24205
|
* @param {SavedQueryDuplicateDTO} [savedQueryDuplicateDTO] SavedQueryDuplicateDTO
|
|
@@ -23070,7 +24234,7 @@ export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
|
23070
24234
|
};
|
|
23071
24235
|
},
|
|
23072
24236
|
/**
|
|
23073
|
-
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
24237
|
+
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
23074
24238
|
* @summary Get a Saved Query
|
|
23075
24239
|
* @param {string} id
|
|
23076
24240
|
* @param {*} [options] Override http request option.
|
|
@@ -23102,7 +24266,7 @@ export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
|
23102
24266
|
};
|
|
23103
24267
|
},
|
|
23104
24268
|
/**
|
|
23105
|
-
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
24269
|
+
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
23106
24270
|
* @summary List the built-in Saved Queries
|
|
23107
24271
|
* @param {*} [options] Override http request option.
|
|
23108
24272
|
* @throws {RequiredError}
|
|
@@ -23131,7 +24295,7 @@ export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
|
23131
24295
|
};
|
|
23132
24296
|
},
|
|
23133
24297
|
/**
|
|
23134
|
-
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
24298
|
+
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
23135
24299
|
* @summary Delete a Saved Query
|
|
23136
24300
|
* @param {string} id
|
|
23137
24301
|
* @param {*} [options] Override http request option.
|
|
@@ -23163,7 +24327,7 @@ export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
|
23163
24327
|
};
|
|
23164
24328
|
},
|
|
23165
24329
|
/**
|
|
23166
|
-
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
24330
|
+
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
23167
24331
|
* @summary Run a Saved Query
|
|
23168
24332
|
* @param {string} id
|
|
23169
24333
|
* @param {SavedQueryRunInputDTO} [savedQueryRunInputDTO] SavedQueryRunInputDTO
|
|
@@ -23198,7 +24362,7 @@ export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
|
23198
24362
|
};
|
|
23199
24363
|
},
|
|
23200
24364
|
/**
|
|
23201
|
-
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
24365
|
+
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
23202
24366
|
* @summary Search Saved Queries
|
|
23203
24367
|
* @param {SavedQuerySearchInputDTO} [savedQuerySearchInputDTO] SavedQuerySearchInputDTO
|
|
23204
24368
|
* @param {*} [options] Override http request option.
|
|
@@ -23230,7 +24394,7 @@ export const SavedQueryApiAxiosParamCreator = function (configuration) {
|
|
|
23230
24394
|
};
|
|
23231
24395
|
},
|
|
23232
24396
|
/**
|
|
23233
|
-
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
24397
|
+
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
23234
24398
|
* @summary Update a Saved Query
|
|
23235
24399
|
* @param {string} id
|
|
23236
24400
|
* @param {SavedQueryUpdateDTO} [savedQueryUpdateDTO] SavedQueryUpdateDTO
|
|
@@ -23274,7 +24438,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23274
24438
|
const localVarAxiosParamCreator = SavedQueryApiAxiosParamCreator(configuration);
|
|
23275
24439
|
return {
|
|
23276
24440
|
/**
|
|
23277
|
-
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
24441
|
+
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
23278
24442
|
* @summary Create a Saved Query
|
|
23279
24443
|
* @param {SavedQueryCreateDTO} [savedQueryCreateDTO] SavedQueryCreateDTO
|
|
23280
24444
|
* @param {*} [options] Override http request option.
|
|
@@ -23287,7 +24451,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23287
24451
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23288
24452
|
},
|
|
23289
24453
|
/**
|
|
23290
|
-
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
24454
|
+
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
23291
24455
|
* @summary Duplicate a Saved Query
|
|
23292
24456
|
* @param {string} id
|
|
23293
24457
|
* @param {SavedQueryDuplicateDTO} [savedQueryDuplicateDTO] SavedQueryDuplicateDTO
|
|
@@ -23301,7 +24465,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23301
24465
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23302
24466
|
},
|
|
23303
24467
|
/**
|
|
23304
|
-
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
24468
|
+
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
23305
24469
|
* @summary Get a Saved Query
|
|
23306
24470
|
* @param {string} id
|
|
23307
24471
|
* @param {*} [options] Override http request option.
|
|
@@ -23314,7 +24478,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23314
24478
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23315
24479
|
},
|
|
23316
24480
|
/**
|
|
23317
|
-
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
24481
|
+
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
23318
24482
|
* @summary List the built-in Saved Queries
|
|
23319
24483
|
* @param {*} [options] Override http request option.
|
|
23320
24484
|
* @throws {RequiredError}
|
|
@@ -23326,7 +24490,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23326
24490
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23327
24491
|
},
|
|
23328
24492
|
/**
|
|
23329
|
-
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
24493
|
+
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
23330
24494
|
* @summary Delete a Saved Query
|
|
23331
24495
|
* @param {string} id
|
|
23332
24496
|
* @param {*} [options] Override http request option.
|
|
@@ -23339,7 +24503,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23339
24503
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23340
24504
|
},
|
|
23341
24505
|
/**
|
|
23342
|
-
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
24506
|
+
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
23343
24507
|
* @summary Run a Saved Query
|
|
23344
24508
|
* @param {string} id
|
|
23345
24509
|
* @param {SavedQueryRunInputDTO} [savedQueryRunInputDTO] SavedQueryRunInputDTO
|
|
@@ -23353,7 +24517,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23353
24517
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23354
24518
|
},
|
|
23355
24519
|
/**
|
|
23356
|
-
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
24520
|
+
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
23357
24521
|
* @summary Search Saved Queries
|
|
23358
24522
|
* @param {SavedQuerySearchInputDTO} [savedQuerySearchInputDTO] SavedQuerySearchInputDTO
|
|
23359
24523
|
* @param {*} [options] Override http request option.
|
|
@@ -23366,7 +24530,7 @@ export const SavedQueryApiFp = function (configuration) {
|
|
|
23366
24530
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23367
24531
|
},
|
|
23368
24532
|
/**
|
|
23369
|
-
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
24533
|
+
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
23370
24534
|
* @summary Update a Saved Query
|
|
23371
24535
|
* @param {string} id
|
|
23372
24536
|
* @param {SavedQueryUpdateDTO} [savedQueryUpdateDTO] SavedQueryUpdateDTO
|
|
@@ -23389,7 +24553,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23389
24553
|
const localVarFp = SavedQueryApiFp(configuration);
|
|
23390
24554
|
return {
|
|
23391
24555
|
/**
|
|
23392
|
-
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
24556
|
+
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
23393
24557
|
* @summary Create a Saved Query
|
|
23394
24558
|
* @param {SavedQueryCreateDTO} [savedQueryCreateDTO] SavedQueryCreateDTO
|
|
23395
24559
|
* @param {*} [options] Override http request option.
|
|
@@ -23401,7 +24565,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23401
24565
|
.then((request) => request(axios, basePath));
|
|
23402
24566
|
},
|
|
23403
24567
|
/**
|
|
23404
|
-
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
24568
|
+
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
23405
24569
|
* @summary Duplicate a Saved Query
|
|
23406
24570
|
* @param {string} id
|
|
23407
24571
|
* @param {SavedQueryDuplicateDTO} [savedQueryDuplicateDTO] SavedQueryDuplicateDTO
|
|
@@ -23414,7 +24578,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23414
24578
|
.then((request) => request(axios, basePath));
|
|
23415
24579
|
},
|
|
23416
24580
|
/**
|
|
23417
|
-
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
24581
|
+
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
23418
24582
|
* @summary Get a Saved Query
|
|
23419
24583
|
* @param {string} id
|
|
23420
24584
|
* @param {*} [options] Override http request option.
|
|
@@ -23424,7 +24588,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23424
24588
|
return localVarFp.savedQueryControllerGetOne(id, options).then((request) => request(axios, basePath));
|
|
23425
24589
|
},
|
|
23426
24590
|
/**
|
|
23427
|
-
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
24591
|
+
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
23428
24592
|
* @summary List the built-in Saved Queries
|
|
23429
24593
|
* @param {*} [options] Override http request option.
|
|
23430
24594
|
* @throws {RequiredError}
|
|
@@ -23433,7 +24597,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23433
24597
|
return localVarFp.savedQueryControllerListBuiltin(options).then((request) => request(axios, basePath));
|
|
23434
24598
|
},
|
|
23435
24599
|
/**
|
|
23436
|
-
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
24600
|
+
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
23437
24601
|
* @summary Delete a Saved Query
|
|
23438
24602
|
* @param {string} id
|
|
23439
24603
|
* @param {*} [options] Override http request option.
|
|
@@ -23443,7 +24607,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23443
24607
|
return localVarFp.savedQueryControllerRemove(id, options).then((request) => request(axios, basePath));
|
|
23444
24608
|
},
|
|
23445
24609
|
/**
|
|
23446
|
-
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
24610
|
+
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
23447
24611
|
* @summary Run a Saved Query
|
|
23448
24612
|
* @param {string} id
|
|
23449
24613
|
* @param {SavedQueryRunInputDTO} [savedQueryRunInputDTO] SavedQueryRunInputDTO
|
|
@@ -23456,7 +24620,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23456
24620
|
.then((request) => request(axios, basePath));
|
|
23457
24621
|
},
|
|
23458
24622
|
/**
|
|
23459
|
-
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
24623
|
+
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
23460
24624
|
* @summary Search Saved Queries
|
|
23461
24625
|
* @param {SavedQuerySearchInputDTO} [savedQuerySearchInputDTO] SavedQuerySearchInputDTO
|
|
23462
24626
|
* @param {*} [options] Override http request option.
|
|
@@ -23468,7 +24632,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23468
24632
|
.then((request) => request(axios, basePath));
|
|
23469
24633
|
},
|
|
23470
24634
|
/**
|
|
23471
|
-
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
24635
|
+
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
23472
24636
|
* @summary Update a Saved Query
|
|
23473
24637
|
* @param {string} id
|
|
23474
24638
|
* @param {SavedQueryUpdateDTO} [savedQueryUpdateDTO] SavedQueryUpdateDTO
|
|
@@ -23490,7 +24654,7 @@ export const SavedQueryApiFactory = function (configuration, basePath, axios) {
|
|
|
23490
24654
|
*/
|
|
23491
24655
|
export class SavedQueryApi extends BaseAPI {
|
|
23492
24656
|
/**
|
|
23493
|
-
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
24657
|
+
* Creates a Saved Query owned by the Domain. The Query is compiled as the caller and refused like POST /tql/query would refuse it (400, or 403 when it reads data the caller may not), and a Chart spec is checked against its columns and stored in canonical form. Names are unique per Domain, case-insensitively, and may not equal a built-in name (409). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerCreate`
|
|
23494
24658
|
* @summary Create a Saved Query
|
|
23495
24659
|
* @param {SavedQueryCreateDTO} [savedQueryCreateDTO] SavedQueryCreateDTO
|
|
23496
24660
|
* @param {*} [options] Override http request option.
|
|
@@ -23503,7 +24667,7 @@ export class SavedQueryApi extends BaseAPI {
|
|
|
23503
24667
|
.then((request) => request(this.axios, this.basePath));
|
|
23504
24668
|
}
|
|
23505
24669
|
/**
|
|
23506
|
-
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
24670
|
+
* Copies a Saved Query, built-in or the Domain’s, into a new editable one. The copy is named `{name} (copy)`, then `(copy 2)` and so on, unless `name` is given (409 when taken). Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerDuplicate`
|
|
23507
24671
|
* @summary Duplicate a Saved Query
|
|
23508
24672
|
* @param {string} id
|
|
23509
24673
|
* @param {SavedQueryDuplicateDTO} [savedQueryDuplicateDTO] SavedQueryDuplicateDTO
|
|
@@ -23517,7 +24681,7 @@ export class SavedQueryApi extends BaseAPI {
|
|
|
23517
24681
|
.then((request) => request(this.axios, this.basePath));
|
|
23518
24682
|
}
|
|
23519
24683
|
/**
|
|
23520
|
-
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
24684
|
+
* Gets a Saved Query, built-in or the Domain’s, by id. `viewer` is the Query compiled for the caller: their result columns and warnings, or the diagnostic their permissions produce (for example TQL_PERMISSION_DENIED naming the missing permission), so two callers can see different results for the same Saved Query. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerGetOne`
|
|
23521
24685
|
* @summary Get a Saved Query
|
|
23522
24686
|
* @param {string} id
|
|
23523
24687
|
* @param {*} [options] Override http request option.
|
|
@@ -23530,7 +24694,7 @@ export class SavedQueryApi extends BaseAPI {
|
|
|
23530
24694
|
.then((request) => request(this.axios, this.basePath));
|
|
23531
24695
|
}
|
|
23532
24696
|
/**
|
|
23533
|
-
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
24697
|
+
* Lists the Saved Queries that ship with Takaro. They are the same in every Domain, read-only (PUT and DELETE answer 400), and can be copied into an editable Saved Query with POST /saved-queries/{id}/duplicate. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerListBuiltin`
|
|
23534
24698
|
* @summary List the built-in Saved Queries
|
|
23535
24699
|
* @param {*} [options] Override http request option.
|
|
23536
24700
|
* @throws {RequiredError}
|
|
@@ -23542,7 +24706,7 @@ export class SavedQueryApi extends BaseAPI {
|
|
|
23542
24706
|
.then((request) => request(this.axios, this.basePath));
|
|
23543
24707
|
}
|
|
23544
24708
|
/**
|
|
23545
|
-
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
24709
|
+
* Deletes a Saved Query of the Domain. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerRemove`
|
|
23546
24710
|
* @summary Delete a Saved Query
|
|
23547
24711
|
* @param {string} id
|
|
23548
24712
|
* @param {*} [options] Override http request option.
|
|
@@ -23555,7 +24719,7 @@ export class SavedQueryApi extends BaseAPI {
|
|
|
23555
24719
|
.then((request) => request(this.axios, this.basePath));
|
|
23556
24720
|
}
|
|
23557
24721
|
/**
|
|
23558
|
-
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
24722
|
+
* Runs a Saved Query, built-in or the Domain’s, recompiled for the caller, so the rows depend on their permissions. Takes optional `timezone` and `filters` (the standard `range` and `gameServer` Board Filters, validated as in POST /tql/query; a Saved Query reads them as {range.start} and `matches(column, {gameServer})`) and answers exactly like POST /tql/query: 400 or 403 with `details.code` when the Query cannot be compiled for the caller, 503 when the query database is unavailable. Results are cached for 60 seconds per compiled Query, shared by viewers whose permissions compile it identically; `cachedAt` is set on a cached answer and `refresh: true` re-runs it and replaces the cached entry. A cached answer does not count against the limits. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerRun`
|
|
23559
24723
|
* @summary Run a Saved Query
|
|
23560
24724
|
* @param {string} id
|
|
23561
24725
|
* @param {SavedQueryRunInputDTO} [savedQueryRunInputDTO] SavedQueryRunInputDTO
|
|
@@ -23569,7 +24733,7 @@ export class SavedQueryApi extends BaseAPI {
|
|
|
23569
24733
|
.then((request) => request(this.axios, this.basePath));
|
|
23570
24734
|
}
|
|
23571
24735
|
/**
|
|
23572
|
-
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
24736
|
+
* Searches the Domain\'s Saved Queries: named TQL queries, optionally with a Chart spec, that belong to the Domain and are recompiled for each viewer. Filter by id and name, search by name. Built-in Saved Queries are not included; list them with GET /saved-queries/builtin. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `SavedQueryControllerSearch`
|
|
23573
24737
|
* @summary Search Saved Queries
|
|
23574
24738
|
* @param {SavedQuerySearchInputDTO} [savedQuerySearchInputDTO] SavedQuerySearchInputDTO
|
|
23575
24739
|
* @param {*} [options] Override http request option.
|
|
@@ -23582,7 +24746,7 @@ export class SavedQueryApi extends BaseAPI {
|
|
|
23582
24746
|
.then((request) => request(this.axios, this.basePath));
|
|
23583
24747
|
}
|
|
23584
24748
|
/**
|
|
23585
|
-
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
24749
|
+
* Updates a Saved Query. `updatedAt` must be the value last read; when someone else changed the Saved Query since, the answer is 409 and nothing is changed. Omitted fields are kept; `description` and `chart` clear on null. A changed Query or Chart is checked as in create. Built-in Saved Queries answer 400. Requires the `analytics` Feature Flag (Beta). Required permissions: `MANAGE_SAVED_QUERIES`<br> OperationId: `SavedQueryControllerUpdate`
|
|
23586
24750
|
* @summary Update a Saved Query
|
|
23587
24751
|
* @param {string} id
|
|
23588
24752
|
* @param {SavedQueryUpdateDTO} [savedQueryUpdateDTO] SavedQueryUpdateDTO
|
|
@@ -24446,7 +25610,7 @@ export const ShopActionApiAxiosParamCreator = function (configuration) {
|
|
|
24446
25610
|
};
|
|
24447
25611
|
},
|
|
24448
25612
|
/**
|
|
24449
|
-
* Search shop actions Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
25613
|
+
* Search shop actions. `filters.gameServerId` narrows to the actions of the module versions installed on those game servers, whether or not the installation or action is enabled; for what a server currently offers, use GET /shopaction/gameserver/{gameServerId}/available. Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
24450
25614
|
* @summary Search
|
|
24451
25615
|
* @param {ShopActionSearchInputDTO} [shopActionSearchInputDTO] ShopActionSearchInputDTO
|
|
24452
25616
|
* @param {*} [options] Override http request option.
|
|
@@ -24589,7 +25753,7 @@ export const ShopActionApiFp = function (configuration) {
|
|
|
24589
25753
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24590
25754
|
},
|
|
24591
25755
|
/**
|
|
24592
|
-
* Search shop actions Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
25756
|
+
* Search shop actions. `filters.gameServerId` narrows to the actions of the module versions installed on those game servers, whether or not the installation or action is enabled; for what a server currently offers, use GET /shopaction/gameserver/{gameServerId}/available. Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
24593
25757
|
* @summary Search
|
|
24594
25758
|
* @param {ShopActionSearchInputDTO} [shopActionSearchInputDTO] ShopActionSearchInputDTO
|
|
24595
25759
|
* @param {*} [options] Override http request option.
|
|
@@ -24683,7 +25847,7 @@ export const ShopActionApiFactory = function (configuration, basePath, axios) {
|
|
|
24683
25847
|
return localVarFp.shopActionControllerRemove(id, options).then((request) => request(axios, basePath));
|
|
24684
25848
|
},
|
|
24685
25849
|
/**
|
|
24686
|
-
* Search shop actions Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
25850
|
+
* Search shop actions. `filters.gameServerId` narrows to the actions of the module versions installed on those game servers, whether or not the installation or action is enabled; for what a server currently offers, use GET /shopaction/gameserver/{gameServerId}/available. Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
24687
25851
|
* @summary Search
|
|
24688
25852
|
* @param {ShopActionSearchInputDTO} [shopActionSearchInputDTO] ShopActionSearchInputDTO
|
|
24689
25853
|
* @param {*} [options] Override http request option.
|
|
@@ -24784,7 +25948,7 @@ export class ShopActionApi extends BaseAPI {
|
|
|
24784
25948
|
.then((request) => request(this.axios, this.basePath));
|
|
24785
25949
|
}
|
|
24786
25950
|
/**
|
|
24787
|
-
* Search shop actions Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
25951
|
+
* Search shop actions. `filters.gameServerId` narrows to the actions of the module versions installed on those game servers, whether or not the installation or action is enabled; for what a server currently offers, use GET /shopaction/gameserver/{gameServerId}/available. Required permissions: `READ_MODULES`<br> OperationId: `ShopActionControllerSearch`
|
|
24788
25952
|
* @summary Search
|
|
24789
25953
|
* @param {ShopActionSearchInputDTO} [shopActionSearchInputDTO] ShopActionSearchInputDTO
|
|
24790
25954
|
* @param {*} [options] Override http request option.
|
|
@@ -26153,8 +27317,8 @@ export class ShopListingApi extends BaseAPI {
|
|
|
26153
27317
|
export const ShopOrderApiAxiosParamCreator = function (configuration) {
|
|
26154
27318
|
return {
|
|
26155
27319
|
/**
|
|
26156
|
-
*
|
|
26157
|
-
* @summary Cancel
|
|
27320
|
+
* Cancels the order and refunds what was paid. A PAID order can be cancelled unless its orderCreated shop action already succeeded. A COMPLETED order can be cancelled when part of it failed: its delivery, or its shop action for either trigger. It is refused with 400 when a shop action succeeded and nothing failed, and with 409 while a shop action has no result yet or the items are being delivered. When part of the order reached the player and part failed (for example the items were delivered and the action failed), only a shop manager can cancel it; the player gets 403, and the manager resolves it by hand knowing the player keeps what they received. A refund still works while the economy is off.<br> OperationId: `ShopOrderControllerCancel`
|
|
27321
|
+
* @summary Cancel and refund an order
|
|
26158
27322
|
* @param {string} id
|
|
26159
27323
|
* @param {*} [options] Override http request option.
|
|
26160
27324
|
* @throws {RequiredError}
|
|
@@ -26217,7 +27381,7 @@ export const ShopOrderApiAxiosParamCreator = function (configuration) {
|
|
|
26217
27381
|
};
|
|
26218
27382
|
},
|
|
26219
27383
|
/**
|
|
26220
|
-
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search.<br> OperationId: `ShopOrderControllerCreate`
|
|
27384
|
+
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search. expectedUnitPrice is the listing unit price the buyer confirmed: when it differs from the current price the order is refused with 409 and nothing is charged.<br> OperationId: `ShopOrderControllerCreate`
|
|
26221
27385
|
* @summary Create an order
|
|
26222
27386
|
* @param {ShopOrderCreateDTO} [shopOrderCreateDTO] ShopOrderCreateDTO
|
|
26223
27387
|
* @param {*} [options] Override http request option.
|
|
@@ -26354,8 +27518,8 @@ export const ShopOrderApiFp = function (configuration) {
|
|
|
26354
27518
|
const localVarAxiosParamCreator = ShopOrderApiAxiosParamCreator(configuration);
|
|
26355
27519
|
return {
|
|
26356
27520
|
/**
|
|
26357
|
-
*
|
|
26358
|
-
* @summary Cancel
|
|
27521
|
+
* Cancels the order and refunds what was paid. A PAID order can be cancelled unless its orderCreated shop action already succeeded. A COMPLETED order can be cancelled when part of it failed: its delivery, or its shop action for either trigger. It is refused with 400 when a shop action succeeded and nothing failed, and with 409 while a shop action has no result yet or the items are being delivered. When part of the order reached the player and part failed (for example the items were delivered and the action failed), only a shop manager can cancel it; the player gets 403, and the manager resolves it by hand knowing the player keeps what they received. A refund still works while the economy is off.<br> OperationId: `ShopOrderControllerCancel`
|
|
27522
|
+
* @summary Cancel and refund an order
|
|
26359
27523
|
* @param {string} id
|
|
26360
27524
|
* @param {*} [options] Override http request option.
|
|
26361
27525
|
* @throws {RequiredError}
|
|
@@ -26380,7 +27544,7 @@ export const ShopOrderApiFp = function (configuration) {
|
|
|
26380
27544
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26381
27545
|
},
|
|
26382
27546
|
/**
|
|
26383
|
-
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search.<br> OperationId: `ShopOrderControllerCreate`
|
|
27547
|
+
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search. expectedUnitPrice is the listing unit price the buyer confirmed: when it differs from the current price the order is refused with 409 and nothing is charged.<br> OperationId: `ShopOrderControllerCreate`
|
|
26384
27548
|
* @summary Create an order
|
|
26385
27549
|
* @param {ShopOrderCreateDTO} [shopOrderCreateDTO] ShopOrderCreateDTO
|
|
26386
27550
|
* @param {*} [options] Override http request option.
|
|
@@ -26441,8 +27605,8 @@ export const ShopOrderApiFactory = function (configuration, basePath, axios) {
|
|
|
26441
27605
|
const localVarFp = ShopOrderApiFp(configuration);
|
|
26442
27606
|
return {
|
|
26443
27607
|
/**
|
|
26444
|
-
*
|
|
26445
|
-
* @summary Cancel
|
|
27608
|
+
* Cancels the order and refunds what was paid. A PAID order can be cancelled unless its orderCreated shop action already succeeded. A COMPLETED order can be cancelled when part of it failed: its delivery, or its shop action for either trigger. It is refused with 400 when a shop action succeeded and nothing failed, and with 409 while a shop action has no result yet or the items are being delivered. When part of the order reached the player and part failed (for example the items were delivered and the action failed), only a shop manager can cancel it; the player gets 403, and the manager resolves it by hand knowing the player keeps what they received. A refund still works while the economy is off.<br> OperationId: `ShopOrderControllerCancel`
|
|
27609
|
+
* @summary Cancel and refund an order
|
|
26446
27610
|
* @param {string} id
|
|
26447
27611
|
* @param {*} [options] Override http request option.
|
|
26448
27612
|
* @throws {RequiredError}
|
|
@@ -26461,7 +27625,7 @@ export const ShopOrderApiFactory = function (configuration, basePath, axios) {
|
|
|
26461
27625
|
return localVarFp.shopOrderControllerClaim(id, options).then((request) => request(axios, basePath));
|
|
26462
27626
|
},
|
|
26463
27627
|
/**
|
|
26464
|
-
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search.<br> OperationId: `ShopOrderControllerCreate`
|
|
27628
|
+
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search. expectedUnitPrice is the listing unit price the buyer confirmed: when it differs from the current price the order is refused with 409 and nothing is charged.<br> OperationId: `ShopOrderControllerCreate`
|
|
26465
27629
|
* @summary Create an order
|
|
26466
27630
|
* @param {ShopOrderCreateDTO} [shopOrderCreateDTO] ShopOrderCreateDTO
|
|
26467
27631
|
* @param {*} [options] Override http request option.
|
|
@@ -26514,8 +27678,8 @@ export const ShopOrderApiFactory = function (configuration, basePath, axios) {
|
|
|
26514
27678
|
*/
|
|
26515
27679
|
export class ShopOrderApi extends BaseAPI {
|
|
26516
27680
|
/**
|
|
26517
|
-
*
|
|
26518
|
-
* @summary Cancel
|
|
27681
|
+
* Cancels the order and refunds what was paid. A PAID order can be cancelled unless its orderCreated shop action already succeeded. A COMPLETED order can be cancelled when part of it failed: its delivery, or its shop action for either trigger. It is refused with 400 when a shop action succeeded and nothing failed, and with 409 while a shop action has no result yet or the items are being delivered. When part of the order reached the player and part failed (for example the items were delivered and the action failed), only a shop manager can cancel it; the player gets 403, and the manager resolves it by hand knowing the player keeps what they received. A refund still works while the economy is off.<br> OperationId: `ShopOrderControllerCancel`
|
|
27682
|
+
* @summary Cancel and refund an order
|
|
26519
27683
|
* @param {string} id
|
|
26520
27684
|
* @param {*} [options] Override http request option.
|
|
26521
27685
|
* @throws {RequiredError}
|
|
@@ -26540,7 +27704,7 @@ export class ShopOrderApi extends BaseAPI {
|
|
|
26540
27704
|
.then((request) => request(this.axios, this.basePath));
|
|
26541
27705
|
}
|
|
26542
27706
|
/**
|
|
26543
|
-
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search.<br> OperationId: `ShopOrderControllerCreate`
|
|
27707
|
+
* Create a new shop order. Accepts an optional caller-chosen idempotencyKey that makes this request recoverable: retrying with the same key and the same listing, amount and player returns the original order (HTTP 200) without charging again; reusing a key with different input fails with 409. Use a fresh random value (e.g. a UUIDv4) per intended purchase. Keys are unique per domain and are also a supported search filter on POST /shop/order/search, for reconciling a lost response without an ambiguous player/listing/time search. expectedUnitPrice is the listing unit price the buyer confirmed: when it differs from the current price the order is refused with 409 and nothing is charged.<br> OperationId: `ShopOrderControllerCreate`
|
|
26544
27708
|
* @summary Create an order
|
|
26545
27709
|
* @param {ShopOrderCreateDTO} [shopOrderCreateDTO] ShopOrderCreateDTO
|
|
26546
27710
|
* @param {*} [options] Override http request option.
|
|
@@ -30569,7 +31733,7 @@ export class StorefrontDomainApi extends BaseAPI {
|
|
|
30569
31733
|
export const ThreadApiAxiosParamCreator = function (configuration) {
|
|
30570
31734
|
return {
|
|
30571
31735
|
/**
|
|
30572
|
-
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
31736
|
+
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). For `originSurface: panel` it is optional and may be a `player`, `gameServer` or `module`. Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
30573
31737
|
* @summary Create a Thread
|
|
30574
31738
|
* @param {ThreadCreateInputDTO} [threadCreateInputDTO] ThreadCreateInputDTO
|
|
30575
31739
|
* @param {*} [options] Override http request option.
|
|
@@ -30778,14 +31942,17 @@ export const ThreadApiAxiosParamCreator = function (configuration) {
|
|
|
30778
31942
|
};
|
|
30779
31943
|
},
|
|
30780
31944
|
/**
|
|
30781
|
-
*
|
|
30782
|
-
* @summary
|
|
30783
|
-
* @param {
|
|
31945
|
+
* Stores the message as the next step of the Thread and starts a turn of Takaro AI. The answer is not part of this response: it arrives over the realtime connection and is stored on the Thread. While Takaro AI is working the message is queued (its `position` is null) and Takaro AI reads it after its current step. Responds with 409 while the Thread is stopping or waits for an approval, and with 400 when Takaro AI is switched off for the Domain, its usage limit is reached or the Thread has reached its length limit. `context` names the `player`, `gameServer` or `module` of the page the message is sent from: it is stored on the step with a name snapshot, and Takaro AI is told only its type and id. Responds with 403 when the calling User may not read that entity, with 404 when it does not exist, and with 400 on a Thread that takes no message context (a structured request or a CSMM Migration).<br> OperationId: `ThreadControllerPostMessage`
|
|
31946
|
+
* @summary Post a message to a Thread
|
|
31947
|
+
* @param {string} id
|
|
31948
|
+
* @param {ThreadMessagePostInputDTO} [threadMessagePostInputDTO] ThreadMessagePostInputDTO
|
|
30784
31949
|
* @param {*} [options] Override http request option.
|
|
30785
31950
|
* @throws {RequiredError}
|
|
30786
31951
|
*/
|
|
30787
|
-
|
|
30788
|
-
|
|
31952
|
+
threadControllerPostMessage: async (id, threadMessagePostInputDTO, options = {}) => {
|
|
31953
|
+
// verify required parameter 'id' is not null or undefined
|
|
31954
|
+
assertParamExists('threadControllerPostMessage', 'id', id);
|
|
31955
|
+
const localVarPath = `/thread/{id}/message`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
30789
31956
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30790
31957
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30791
31958
|
let baseOptions;
|
|
@@ -30803,24 +31970,24 @@ export const ThreadApiAxiosParamCreator = function (configuration) {
|
|
|
30803
31970
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30804
31971
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30805
31972
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
30806
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
31973
|
+
localVarRequestOptions.data = serializeDataIfNeeded(threadMessagePostInputDTO, localVarRequestOptions, configuration);
|
|
30807
31974
|
return {
|
|
30808
31975
|
url: toPathString(localVarUrlObj),
|
|
30809
31976
|
options: localVarRequestOptions,
|
|
30810
31977
|
};
|
|
30811
31978
|
},
|
|
30812
31979
|
/**
|
|
30813
|
-
*
|
|
30814
|
-
* @summary
|
|
31980
|
+
* Sets the title of one of the calling User\'s Threads, 1 to 80 characters after trimming. A renamed Thread is never retitled automatically. Responds with 404 for another User\'s Thread.<br> OperationId: `ThreadControllerRename`
|
|
31981
|
+
* @summary Rename a Thread
|
|
30815
31982
|
* @param {string} id
|
|
30816
|
-
* @param {
|
|
31983
|
+
* @param {ThreadRenameInputDTO} [threadRenameInputDTO] ThreadRenameInputDTO
|
|
30817
31984
|
* @param {*} [options] Override http request option.
|
|
30818
31985
|
* @throws {RequiredError}
|
|
30819
31986
|
*/
|
|
30820
|
-
|
|
31987
|
+
threadControllerRename: async (id, threadRenameInputDTO, options = {}) => {
|
|
30821
31988
|
// verify required parameter 'id' is not null or undefined
|
|
30822
|
-
assertParamExists('
|
|
30823
|
-
const localVarPath = `/thread/{id}/
|
|
31989
|
+
assertParamExists('threadControllerRename', 'id', id);
|
|
31990
|
+
const localVarPath = `/thread/{id}/title`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
30824
31991
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30825
31992
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30826
31993
|
let baseOptions;
|
|
@@ -30838,14 +32005,14 @@ export const ThreadApiAxiosParamCreator = function (configuration) {
|
|
|
30838
32005
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30839
32006
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30840
32007
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
30841
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
32008
|
+
localVarRequestOptions.data = serializeDataIfNeeded(threadRenameInputDTO, localVarRequestOptions, configuration);
|
|
30842
32009
|
return {
|
|
30843
32010
|
url: toPathString(localVarUrlObj),
|
|
30844
32011
|
options: localVarRequestOptions,
|
|
30845
32012
|
};
|
|
30846
32013
|
},
|
|
30847
32014
|
/**
|
|
30848
|
-
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status and by
|
|
32015
|
+
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status, by origin surface and by the Thread context’s type and id (`filters.contextType`, `filters.contextId`), which match the entity a Thread was opened about, not a message’s context. Another User’s Threads are never listed.<br> OperationId: `ThreadControllerSearch`
|
|
30849
32016
|
* @summary Search Threads
|
|
30850
32017
|
* @param {ThreadSearchInputDTO} [threadSearchInputDTO] ThreadSearchInputDTO
|
|
30851
32018
|
* @param {*} [options] Override http request option.
|
|
@@ -30988,7 +32155,7 @@ export const ThreadApiFp = function (configuration) {
|
|
|
30988
32155
|
const localVarAxiosParamCreator = ThreadApiAxiosParamCreator(configuration);
|
|
30989
32156
|
return {
|
|
30990
32157
|
/**
|
|
30991
|
-
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
32158
|
+
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). For `originSurface: panel` it is optional and may be a `player`, `gameServer` or `module`. Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
30992
32159
|
* @summary Create a Thread
|
|
30993
32160
|
* @param {ThreadCreateInputDTO} [threadCreateInputDTO] ThreadCreateInputDTO
|
|
30994
32161
|
* @param {*} [options] Override http request option.
|
|
@@ -31070,34 +32237,35 @@ export const ThreadApiFp = function (configuration) {
|
|
|
31070
32237
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31071
32238
|
},
|
|
31072
32239
|
/**
|
|
31073
|
-
*
|
|
31074
|
-
* @summary
|
|
31075
|
-
* @param {
|
|
32240
|
+
* Stores the message as the next step of the Thread and starts a turn of Takaro AI. The answer is not part of this response: it arrives over the realtime connection and is stored on the Thread. While Takaro AI is working the message is queued (its `position` is null) and Takaro AI reads it after its current step. Responds with 409 while the Thread is stopping or waits for an approval, and with 400 when Takaro AI is switched off for the Domain, its usage limit is reached or the Thread has reached its length limit. `context` names the `player`, `gameServer` or `module` of the page the message is sent from: it is stored on the step with a name snapshot, and Takaro AI is told only its type and id. Responds with 403 when the calling User may not read that entity, with 404 when it does not exist, and with 400 on a Thread that takes no message context (a structured request or a CSMM Migration).<br> OperationId: `ThreadControllerPostMessage`
|
|
32241
|
+
* @summary Post a message to a Thread
|
|
32242
|
+
* @param {string} id
|
|
32243
|
+
* @param {ThreadMessagePostInputDTO} [threadMessagePostInputDTO] ThreadMessagePostInputDTO
|
|
31076
32244
|
* @param {*} [options] Override http request option.
|
|
31077
32245
|
* @throws {RequiredError}
|
|
31078
32246
|
*/
|
|
31079
|
-
async
|
|
31080
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
32247
|
+
async threadControllerPostMessage(id, threadMessagePostInputDTO, options) {
|
|
32248
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.threadControllerPostMessage(id, threadMessagePostInputDTO, options);
|
|
31081
32249
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
31082
|
-
const localVarOperationServerBasePath = operationServerMap['ThreadApi.
|
|
32250
|
+
const localVarOperationServerBasePath = operationServerMap['ThreadApi.threadControllerPostMessage']?.[localVarOperationServerIndex]?.url;
|
|
31083
32251
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31084
32252
|
},
|
|
31085
32253
|
/**
|
|
31086
|
-
*
|
|
31087
|
-
* @summary
|
|
32254
|
+
* Sets the title of one of the calling User\'s Threads, 1 to 80 characters after trimming. A renamed Thread is never retitled automatically. Responds with 404 for another User\'s Thread.<br> OperationId: `ThreadControllerRename`
|
|
32255
|
+
* @summary Rename a Thread
|
|
31088
32256
|
* @param {string} id
|
|
31089
|
-
* @param {
|
|
32257
|
+
* @param {ThreadRenameInputDTO} [threadRenameInputDTO] ThreadRenameInputDTO
|
|
31090
32258
|
* @param {*} [options] Override http request option.
|
|
31091
32259
|
* @throws {RequiredError}
|
|
31092
32260
|
*/
|
|
31093
|
-
async
|
|
31094
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
32261
|
+
async threadControllerRename(id, threadRenameInputDTO, options) {
|
|
32262
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.threadControllerRename(id, threadRenameInputDTO, options);
|
|
31095
32263
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
31096
|
-
const localVarOperationServerBasePath = operationServerMap['ThreadApi.
|
|
32264
|
+
const localVarOperationServerBasePath = operationServerMap['ThreadApi.threadControllerRename']?.[localVarOperationServerIndex]?.url;
|
|
31097
32265
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31098
32266
|
},
|
|
31099
32267
|
/**
|
|
31100
|
-
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status and by
|
|
32268
|
+
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status, by origin surface and by the Thread context’s type and id (`filters.contextType`, `filters.contextId`), which match the entity a Thread was opened about, not a message’s context. Another User’s Threads are never listed.<br> OperationId: `ThreadControllerSearch`
|
|
31101
32269
|
* @summary Search Threads
|
|
31102
32270
|
* @param {ThreadSearchInputDTO} [threadSearchInputDTO] ThreadSearchInputDTO
|
|
31103
32271
|
* @param {*} [options] Override http request option.
|
|
@@ -31160,7 +32328,7 @@ export const ThreadApiFactory = function (configuration, basePath, axios) {
|
|
|
31160
32328
|
const localVarFp = ThreadApiFp(configuration);
|
|
31161
32329
|
return {
|
|
31162
32330
|
/**
|
|
31163
|
-
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
32331
|
+
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). For `originSurface: panel` it is optional and may be a `player`, `gameServer` or `module`. Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
31164
32332
|
* @summary Create a Thread
|
|
31165
32333
|
* @param {ThreadCreateInputDTO} [threadCreateInputDTO] ThreadCreateInputDTO
|
|
31166
32334
|
* @param {*} [options] Override http request option.
|
|
@@ -31230,32 +32398,33 @@ export const ThreadApiFactory = function (configuration, basePath, axios) {
|
|
|
31230
32398
|
return localVarFp.threadControllerGetUsage(options).then((request) => request(axios, basePath));
|
|
31231
32399
|
},
|
|
31232
32400
|
/**
|
|
31233
|
-
*
|
|
31234
|
-
* @summary
|
|
31235
|
-
* @param {
|
|
32401
|
+
* Stores the message as the next step of the Thread and starts a turn of Takaro AI. The answer is not part of this response: it arrives over the realtime connection and is stored on the Thread. While Takaro AI is working the message is queued (its `position` is null) and Takaro AI reads it after its current step. Responds with 409 while the Thread is stopping or waits for an approval, and with 400 when Takaro AI is switched off for the Domain, its usage limit is reached or the Thread has reached its length limit. `context` names the `player`, `gameServer` or `module` of the page the message is sent from: it is stored on the step with a name snapshot, and Takaro AI is told only its type and id. Responds with 403 when the calling User may not read that entity, with 404 when it does not exist, and with 400 on a Thread that takes no message context (a structured request or a CSMM Migration).<br> OperationId: `ThreadControllerPostMessage`
|
|
32402
|
+
* @summary Post a message to a Thread
|
|
32403
|
+
* @param {string} id
|
|
32404
|
+
* @param {ThreadMessagePostInputDTO} [threadMessagePostInputDTO] ThreadMessagePostInputDTO
|
|
31236
32405
|
* @param {*} [options] Override http request option.
|
|
31237
32406
|
* @throws {RequiredError}
|
|
31238
32407
|
*/
|
|
31239
|
-
|
|
32408
|
+
threadControllerPostMessage(id, threadMessagePostInputDTO, options) {
|
|
31240
32409
|
return localVarFp
|
|
31241
|
-
.
|
|
32410
|
+
.threadControllerPostMessage(id, threadMessagePostInputDTO, options)
|
|
31242
32411
|
.then((request) => request(axios, basePath));
|
|
31243
32412
|
},
|
|
31244
32413
|
/**
|
|
31245
|
-
*
|
|
31246
|
-
* @summary
|
|
32414
|
+
* Sets the title of one of the calling User\'s Threads, 1 to 80 characters after trimming. A renamed Thread is never retitled automatically. Responds with 404 for another User\'s Thread.<br> OperationId: `ThreadControllerRename`
|
|
32415
|
+
* @summary Rename a Thread
|
|
31247
32416
|
* @param {string} id
|
|
31248
|
-
* @param {
|
|
32417
|
+
* @param {ThreadRenameInputDTO} [threadRenameInputDTO] ThreadRenameInputDTO
|
|
31249
32418
|
* @param {*} [options] Override http request option.
|
|
31250
32419
|
* @throws {RequiredError}
|
|
31251
32420
|
*/
|
|
31252
|
-
|
|
32421
|
+
threadControllerRename(id, threadRenameInputDTO, options) {
|
|
31253
32422
|
return localVarFp
|
|
31254
|
-
.
|
|
32423
|
+
.threadControllerRename(id, threadRenameInputDTO, options)
|
|
31255
32424
|
.then((request) => request(axios, basePath));
|
|
31256
32425
|
},
|
|
31257
32426
|
/**
|
|
31258
|
-
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status and by
|
|
32427
|
+
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status, by origin surface and by the Thread context’s type and id (`filters.contextType`, `filters.contextId`), which match the entity a Thread was opened about, not a message’s context. Another User’s Threads are never listed.<br> OperationId: `ThreadControllerSearch`
|
|
31259
32428
|
* @summary Search Threads
|
|
31260
32429
|
* @param {ThreadSearchInputDTO} [threadSearchInputDTO] ThreadSearchInputDTO
|
|
31261
32430
|
* @param {*} [options] Override http request option.
|
|
@@ -31312,7 +32481,7 @@ export const ThreadApiFactory = function (configuration, basePath, axios) {
|
|
|
31312
32481
|
*/
|
|
31313
32482
|
export class ThreadApi extends BaseAPI {
|
|
31314
32483
|
/**
|
|
31315
|
-
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
32484
|
+
* Starts a new, empty Takaro AI Thread owned by the calling User. A Thread is private: only the User who created it can read it or post to it. Responds with 400 when Takaro AI is switched off for the Domain or its usage limit is reached. `context` names the entity the Thread is opened about; whether it is required depends on `originSurface`. For `originSurface: analytics` it is a `board` context with `id`, `chart` and `filters`: a Board, one of its Chart ids and the Board Filter values selected (a range preset or a game server id by filter id). For `originSurface: panel` it is optional and may be a `player`, `gameServer` or `module`. Responds with 403 when the calling User may not read that entity and with 404 when it does not exist.<br> OperationId: `ThreadControllerCreate`
|
|
31316
32485
|
* @summary Create a Thread
|
|
31317
32486
|
* @param {ThreadCreateInputDTO} [threadCreateInputDTO] ThreadCreateInputDTO
|
|
31318
32487
|
* @param {*} [options] Override http request option.
|
|
@@ -31394,34 +32563,35 @@ export class ThreadApi extends BaseAPI {
|
|
|
31394
32563
|
.then((request) => request(this.axios, this.basePath));
|
|
31395
32564
|
}
|
|
31396
32565
|
/**
|
|
31397
|
-
*
|
|
31398
|
-
* @summary
|
|
31399
|
-
* @param {
|
|
32566
|
+
* Stores the message as the next step of the Thread and starts a turn of Takaro AI. The answer is not part of this response: it arrives over the realtime connection and is stored on the Thread. While Takaro AI is working the message is queued (its `position` is null) and Takaro AI reads it after its current step. Responds with 409 while the Thread is stopping or waits for an approval, and with 400 when Takaro AI is switched off for the Domain, its usage limit is reached or the Thread has reached its length limit. `context` names the `player`, `gameServer` or `module` of the page the message is sent from: it is stored on the step with a name snapshot, and Takaro AI is told only its type and id. Responds with 403 when the calling User may not read that entity, with 404 when it does not exist, and with 400 on a Thread that takes no message context (a structured request or a CSMM Migration).<br> OperationId: `ThreadControllerPostMessage`
|
|
32567
|
+
* @summary Post a message to a Thread
|
|
32568
|
+
* @param {string} id
|
|
32569
|
+
* @param {ThreadMessagePostInputDTO} [threadMessagePostInputDTO] ThreadMessagePostInputDTO
|
|
31400
32570
|
* @param {*} [options] Override http request option.
|
|
31401
32571
|
* @throws {RequiredError}
|
|
31402
32572
|
* @memberof ThreadApi
|
|
31403
32573
|
*/
|
|
31404
|
-
|
|
32574
|
+
threadControllerPostMessage(id, threadMessagePostInputDTO, options) {
|
|
31405
32575
|
return ThreadApiFp(this.configuration)
|
|
31406
|
-
.
|
|
32576
|
+
.threadControllerPostMessage(id, threadMessagePostInputDTO, options)
|
|
31407
32577
|
.then((request) => request(this.axios, this.basePath));
|
|
31408
32578
|
}
|
|
31409
32579
|
/**
|
|
31410
|
-
*
|
|
31411
|
-
* @summary
|
|
32580
|
+
* Sets the title of one of the calling User\'s Threads, 1 to 80 characters after trimming. A renamed Thread is never retitled automatically. Responds with 404 for another User\'s Thread.<br> OperationId: `ThreadControllerRename`
|
|
32581
|
+
* @summary Rename a Thread
|
|
31412
32582
|
* @param {string} id
|
|
31413
|
-
* @param {
|
|
32583
|
+
* @param {ThreadRenameInputDTO} [threadRenameInputDTO] ThreadRenameInputDTO
|
|
31414
32584
|
* @param {*} [options] Override http request option.
|
|
31415
32585
|
* @throws {RequiredError}
|
|
31416
32586
|
* @memberof ThreadApi
|
|
31417
32587
|
*/
|
|
31418
|
-
|
|
32588
|
+
threadControllerRename(id, threadRenameInputDTO, options) {
|
|
31419
32589
|
return ThreadApiFp(this.configuration)
|
|
31420
|
-
.
|
|
32590
|
+
.threadControllerRename(id, threadRenameInputDTO, options)
|
|
31421
32591
|
.then((request) => request(this.axios, this.basePath));
|
|
31422
32592
|
}
|
|
31423
32593
|
/**
|
|
31424
|
-
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status and by
|
|
32594
|
+
* Lists the calling User’s Threads that hold at least one message, most recently active first. The list can be narrowed by status, by origin surface and by the Thread context’s type and id (`filters.contextType`, `filters.contextId`), which match the entity a Thread was opened about, not a message’s context. Another User’s Threads are never listed.<br> OperationId: `ThreadControllerSearch`
|
|
31425
32595
|
* @summary Search Threads
|
|
31426
32596
|
* @param {ThreadSearchInputDTO} [threadSearchInputDTO] ThreadSearchInputDTO
|
|
31427
32597
|
* @param {*} [options] Override http request option.
|
|
@@ -31489,7 +32659,7 @@ export const ThreadControllerGetStepsSortDirectionEnum = {
|
|
|
31489
32659
|
export const TqlApiAxiosParamCreator = function (configuration) {
|
|
31490
32660
|
return {
|
|
31491
32661
|
/**
|
|
31492
|
-
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
32662
|
+
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
31493
32663
|
* @summary Get the JSON Schema of a Chart spec
|
|
31494
32664
|
* @param {*} [options] Override http request option.
|
|
31495
32665
|
* @throws {RequiredError}
|
|
@@ -31518,7 +32688,7 @@ export const TqlApiAxiosParamCreator = function (configuration) {
|
|
|
31518
32688
|
};
|
|
31519
32689
|
},
|
|
31520
32690
|
/**
|
|
31521
|
-
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
32691
|
+
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
31522
32692
|
* @summary Run a TQL query
|
|
31523
32693
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31524
32694
|
* @param {*} [options] Override http request option.
|
|
@@ -31550,7 +32720,7 @@ export const TqlApiAxiosParamCreator = function (configuration) {
|
|
|
31550
32720
|
};
|
|
31551
32721
|
},
|
|
31552
32722
|
/**
|
|
31553
|
-
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
32723
|
+
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
31554
32724
|
* @summary List the tables, columns and functions available to TQL queries
|
|
31555
32725
|
* @param {*} [options] Override http request option.
|
|
31556
32726
|
* @throws {RequiredError}
|
|
@@ -31579,7 +32749,7 @@ export const TqlApiAxiosParamCreator = function (configuration) {
|
|
|
31579
32749
|
};
|
|
31580
32750
|
},
|
|
31581
32751
|
/**
|
|
31582
|
-
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
32752
|
+
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
31583
32753
|
* @summary Check a TQL query for errors
|
|
31584
32754
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31585
32755
|
* @param {*} [options] Override http request option.
|
|
@@ -31611,7 +32781,7 @@ export const TqlApiAxiosParamCreator = function (configuration) {
|
|
|
31611
32781
|
};
|
|
31612
32782
|
},
|
|
31613
32783
|
/**
|
|
31614
|
-
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
32784
|
+
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
31615
32785
|
* @summary Check a Chart spec against a TQL query
|
|
31616
32786
|
* @param {TqlChartValidateInputDTO} [tqlChartValidateInputDTO] TqlChartValidateInputDTO
|
|
31617
32787
|
* @param {*} [options] Override http request option.
|
|
@@ -31652,7 +32822,7 @@ export const TqlApiFp = function (configuration) {
|
|
|
31652
32822
|
const localVarAxiosParamCreator = TqlApiAxiosParamCreator(configuration);
|
|
31653
32823
|
return {
|
|
31654
32824
|
/**
|
|
31655
|
-
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
32825
|
+
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
31656
32826
|
* @summary Get the JSON Schema of a Chart spec
|
|
31657
32827
|
* @param {*} [options] Override http request option.
|
|
31658
32828
|
* @throws {RequiredError}
|
|
@@ -31664,7 +32834,7 @@ export const TqlApiFp = function (configuration) {
|
|
|
31664
32834
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31665
32835
|
},
|
|
31666
32836
|
/**
|
|
31667
|
-
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
32837
|
+
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
31668
32838
|
* @summary Run a TQL query
|
|
31669
32839
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31670
32840
|
* @param {*} [options] Override http request option.
|
|
@@ -31677,7 +32847,7 @@ export const TqlApiFp = function (configuration) {
|
|
|
31677
32847
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31678
32848
|
},
|
|
31679
32849
|
/**
|
|
31680
|
-
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
32850
|
+
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
31681
32851
|
* @summary List the tables, columns and functions available to TQL queries
|
|
31682
32852
|
* @param {*} [options] Override http request option.
|
|
31683
32853
|
* @throws {RequiredError}
|
|
@@ -31689,7 +32859,7 @@ export const TqlApiFp = function (configuration) {
|
|
|
31689
32859
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31690
32860
|
},
|
|
31691
32861
|
/**
|
|
31692
|
-
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
32862
|
+
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
31693
32863
|
* @summary Check a TQL query for errors
|
|
31694
32864
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31695
32865
|
* @param {*} [options] Override http request option.
|
|
@@ -31702,7 +32872,7 @@ export const TqlApiFp = function (configuration) {
|
|
|
31702
32872
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31703
32873
|
},
|
|
31704
32874
|
/**
|
|
31705
|
-
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
32875
|
+
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
31706
32876
|
* @summary Check a Chart spec against a TQL query
|
|
31707
32877
|
* @param {TqlChartValidateInputDTO} [tqlChartValidateInputDTO] TqlChartValidateInputDTO
|
|
31708
32878
|
* @param {*} [options] Override http request option.
|
|
@@ -31724,7 +32894,7 @@ export const TqlApiFactory = function (configuration, basePath, axios) {
|
|
|
31724
32894
|
const localVarFp = TqlApiFp(configuration);
|
|
31725
32895
|
return {
|
|
31726
32896
|
/**
|
|
31727
|
-
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
32897
|
+
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
31728
32898
|
* @summary Get the JSON Schema of a Chart spec
|
|
31729
32899
|
* @param {*} [options] Override http request option.
|
|
31730
32900
|
* @throws {RequiredError}
|
|
@@ -31733,7 +32903,7 @@ export const TqlApiFactory = function (configuration, basePath, axios) {
|
|
|
31733
32903
|
return localVarFp.tqlControllerChartSchema(options).then((request) => request(axios, basePath));
|
|
31734
32904
|
},
|
|
31735
32905
|
/**
|
|
31736
|
-
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
32906
|
+
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
31737
32907
|
* @summary Run a TQL query
|
|
31738
32908
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31739
32909
|
* @param {*} [options] Override http request option.
|
|
@@ -31743,7 +32913,7 @@ export const TqlApiFactory = function (configuration, basePath, axios) {
|
|
|
31743
32913
|
return localVarFp.tqlControllerQuery(tqlQueryInputDTO, options).then((request) => request(axios, basePath));
|
|
31744
32914
|
},
|
|
31745
32915
|
/**
|
|
31746
|
-
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
32916
|
+
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
31747
32917
|
* @summary List the tables, columns and functions available to TQL queries
|
|
31748
32918
|
* @param {*} [options] Override http request option.
|
|
31749
32919
|
* @throws {RequiredError}
|
|
@@ -31752,7 +32922,7 @@ export const TqlApiFactory = function (configuration, basePath, axios) {
|
|
|
31752
32922
|
return localVarFp.tqlControllerSchema(options).then((request) => request(axios, basePath));
|
|
31753
32923
|
},
|
|
31754
32924
|
/**
|
|
31755
|
-
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
32925
|
+
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
31756
32926
|
* @summary Check a TQL query for errors
|
|
31757
32927
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31758
32928
|
* @param {*} [options] Override http request option.
|
|
@@ -31762,7 +32932,7 @@ export const TqlApiFactory = function (configuration, basePath, axios) {
|
|
|
31762
32932
|
return localVarFp.tqlControllerValidate(tqlQueryInputDTO, options).then((request) => request(axios, basePath));
|
|
31763
32933
|
},
|
|
31764
32934
|
/**
|
|
31765
|
-
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
32935
|
+
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
31766
32936
|
* @summary Check a Chart spec against a TQL query
|
|
31767
32937
|
* @param {TqlChartValidateInputDTO} [tqlChartValidateInputDTO] TqlChartValidateInputDTO
|
|
31768
32938
|
* @param {*} [options] Override http request option.
|
|
@@ -31783,7 +32953,7 @@ export const TqlApiFactory = function (configuration, basePath, axios) {
|
|
|
31783
32953
|
*/
|
|
31784
32954
|
export class TqlApi extends BaseAPI {
|
|
31785
32955
|
/**
|
|
31786
|
-
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
32956
|
+
* Returns the JSON Schema of a Chart spec, the declarative description of how a TQL result is drawn. A Chart is a flat object discriminated by `type` (kpi, line, area, bar, pie, scatter, heatmap or table) whose fields name columns of the result, with `title`, a named `format` on every type but table, and options such as `stack`, `orientation`, `zeroFill`, `donut`, KPI `compare` and `goodDirection`, and `when` for conditional visibility on a Board. The schema is pure data: it has no expressions, URLs or formatter functions, and unknown keys are rejected. It describes structure only; which column may feed which field depends on the Query, and POST /tql/chart/validate checks that. Use it to build or validate a Chart spec before calling POST /tql/chart/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerChartSchema`
|
|
31787
32957
|
* @summary Get the JSON Schema of a Chart spec
|
|
31788
32958
|
* @param {*} [options] Override http request option.
|
|
31789
32959
|
* @throws {RequiredError}
|
|
@@ -31795,7 +32965,7 @@ export class TqlApi extends BaseAPI {
|
|
|
31795
32965
|
.then((request) => request(this.axios, this.basePath));
|
|
31796
32966
|
}
|
|
31797
32967
|
/**
|
|
31798
|
-
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
32968
|
+
* Runs a read-only TQL query over this Domain\'s events and returns typed columns, rows, warnings and timing. TQL is a SELECT subset of ClickHouse SQL: SELECT, FROM events, WHERE, GROUP BY, HAVING, ORDER BY, LIMIT and OFFSET, plus INNER, LEFT, RIGHT, FULL, CROSS, SEMI and ANTI joins with ON, subqueries in FROM and IN, WITH common table expressions, window functions with OVER, CASE, INTERVAL, UNION ALL and ARRAY JOIN over catalogued payload arrays of objects such as meta.lines. Only an allowlist of aggregate, date, string, math and conditional functions exists; functions that can raise an error for some values (such as toInt64) are refused in favour of their OrNull forms. Correlated subqueries, UNION without ALL and USING are not supported. Outer-join columns that find no match are NULL. Event payload fields are read as meta.player.ping, meta.`player`.`ping` or meta[\'player\'][\'ping\'], matched case-insensitively; only fields the event types declare exist, and a field naming a player (names, IPs, geo, platform ids) needs READ_PLAYERS. The events a caller sees depend on their permissions: role-* events need READ_ROLES, api-key-* events MANAGE_API_KEYS, settings-set and domain-* events READ_SETTINGS, player-banned, player-unbanned, player-kicked, player-new-ip-detected and player-new-name-detected events READ_PLAYERS, player-inventory-changed events READ_TRACKING and shop-order-* events MANAGE_SHOP_ORDERS, all on top of READ_EVENTS; other events are absent for a caller without them. SELECT * expands to the readable columns of the table, and a bare meta item expands to one column per readable payload field of the event types the WHERE pins; fields left out for lack of permission come back in a TQL_FIELDS_OMITTED warning. Without a LIMIT, 100 rows are returned and a TQL_DEFAULT_LIMIT warning is added; the maximum is 10000. A query that cannot be compiled is a 400 whose meta.error.details holds a TQL_* code, the 0-based character position and, when there is one, a suggestion. A query the caller lacks the permission for is a 403 whose details name the permission. Beside events there are Takaro-defined views, ordinary TQL that follow the same rules as your own Queries and need the permissions of the events they read: sessions (player-connected and player-disconnected pairs; a session with no disconnect is closed at its last evidence once a later connect exists or it is 15 minutes stale, else it is open with a NULL ended_at), chat_messages, command_executions, shop_orders (needs MANAGE_SHOP_ORDERS), deaths, kills, currency_changes and concurrent_players (5-minute slots per game server). The tables position_samples, inventory_changes and inventory_snapshots need READ_TRACKING. The name fields player.name (READ_PLAYERS), gameserver.name, module.name (READ_MODULES) and item.name (READ_ITEMS) are looked up after the Query runs from the matching player_id, game_server_id, module_id or item_id column of FROM; they may only be a whole select item or a GROUP BY key, never in WHERE, HAVING, ORDER BY, a function or a join, and are left out with a TQL_FIELDS_OMITTED warning when the caller lacks the permission. When the query database is not available the answer is 503. To check a query without running it use POST /tql/validate, and to list the tables, columns and functions the caller may use call GET /tql/schema. Results are never cached. Each Domain may run at most `tqlMaxConcurrentQueries` Queries at once and use `tqlReadMsPerHour` milliseconds of query time in any rolling hour (Plan limits); past either, the answer is 429 with `TQL_CONCURRENCY_LIMIT` or `TQL_BUDGET_EXHAUSTED` in meta.error.details.code, the latter with retryAfterSeconds. Board Filters: a query reads the selected range as {range.start}, {range.end}, {range.prevStart} and {range.prevEnd} (the previous period of the same length, ending where the range starts), and {range.bucket}, an interval for toStartOfInterval that is an hour for ranges up to 2 days, a day up to 31 days and a week beyond; write the braces exactly, with no spaces. `matches(column, {gameServer})` is true for every row when no game server is selected and otherwise compares the UUID column with the selected game server. Bucketing and every other date function follow `timezone`. The optional `filters` body is `{ \"range\": \"7d\", \"gameServer\": \"<uuid>\" }`: `range` is one of 24h, 7d, 30d or 90d (default 7d, at most the Domain\'s event retention in days) and an unset `gameServer` means all game servers. The range ends at the current time rounded up to a whole minute. A value that is not valid, or a range longer than the Domain\'s event retention, is a 400 with TQL_INVALID_FILTER, and an unknown filter name or a reference to one in the query is TQL_UNKNOWN_FILTER. Filter values are always bound as query parameters, never written into the SQL text. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerQuery`
|
|
31799
32969
|
* @summary Run a TQL query
|
|
31800
32970
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31801
32971
|
* @param {*} [options] Override http request option.
|
|
@@ -31808,7 +32978,7 @@ export class TqlApi extends BaseAPI {
|
|
|
31808
32978
|
.then((request) => request(this.axios, this.basePath));
|
|
31809
32979
|
}
|
|
31810
32980
|
/**
|
|
31811
|
-
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
32981
|
+
* Lists what the caller may use in a TQL query: the tables and views with their columns and ClickHouse types, the functions with their argument counts, and the name fields such as player.name. The list reflects the caller\'s permissions and API key scope; what the caller cannot read is absent rather than marked. The events table lists the readable event types, and its `payload` lists every readable scalar `meta.*` path with its type and the event types that carry it. Use it to discover what to write before calling POST /tql/query or POST /tql/validate. It does not read any data. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerSchema`
|
|
31812
32982
|
* @summary List the tables, columns and functions available to TQL queries
|
|
31813
32983
|
* @param {*} [options] Override http request option.
|
|
31814
32984
|
* @throws {RequiredError}
|
|
@@ -31820,7 +32990,7 @@ export class TqlApi extends BaseAPI {
|
|
|
31820
32990
|
.then((request) => request(this.axios, this.basePath));
|
|
31821
32991
|
}
|
|
31822
32992
|
/**
|
|
31823
|
-
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
32993
|
+
* Checks a TQL query for errors without running it: nothing is executed and no data is read. Takes the same body as POST /tql/query (its `filters` are ignored: filter references compile against standard sample values, and a reference to a filter other than range and gameServer is TQL_UNKNOWN_FILTER) and answers 200 with `valid` and an `errors` array. When the query is valid, `columns` holds the result columns with the compiler\'s types (nullability and timezone can differ from the types the server reports when the query runs) and `warnings` the compiler warnings. When it is not, `errors` holds one diagnostic with a stable `TQL_*` `code`, a `message`, `position` (a 0-based character offset into `query`), 1-based `line` and `column`, and, where one exists, a `suggestion`. A query the caller lacks the permission for is also a diagnostic, with `requiredPermission`, not a 403. Suggestions only name tables, columns and functions the caller can read. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidate`
|
|
31824
32994
|
* @summary Check a TQL query for errors
|
|
31825
32995
|
* @param {TqlQueryInputDTO} [tqlQueryInputDTO] TqlQueryInputDTO
|
|
31826
32996
|
* @param {*} [options] Override http request option.
|
|
@@ -31833,7 +33003,7 @@ export class TqlApi extends BaseAPI {
|
|
|
31833
33003
|
.then((request) => request(this.axios, this.basePath));
|
|
31834
33004
|
}
|
|
31835
33005
|
/**
|
|
31836
|
-
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
33006
|
+
* Checks a Chart spec (see GET /tql/chart/schema for its JSON Schema) against a TQL query without running either: the query is compiled with the caller\'s permissions to learn its result columns and their types, and nothing is executed. Takes the same `query` and `timezone` as POST /tql/query (`filters` are ignored, as in POST /tql/validate) plus `chart`, and answers 200. `valid` is true when the spec is well formed and every field fits a column of the query; `chart` is then the canonical spec, with `y` always a list. Otherwise `errors` lists coded problems, each with a stable `code`, a `message`, a `path` that is an RFC 6901 JSON Pointer into `chart` (an empty string is the whole spec), and where one exists a `suggestion` that is a literal replacement value. The codes are CHART_INVALID_VALUE, CHART_MISSING_FIELD, CHART_UNKNOWN_KEY, CHART_UNKNOWN_TYPE, CHART_UNKNOWN_COLUMN, CHART_FIELD_TYPE (a column of the wrong type for its field, for example a line chart whose `x` is not a date or datetime) CHART_SERIES_CONFLICT (`color` together with several `y` columns) and CHART_OPTION_CONFLICT (options that cannot be combined, for example a heatmap with `time` and `x`, or `goodDirection` without `compare`). When the query cannot be compiled, or the caller lacks a permission it needs, `queryErrors` holds the same diagnostic POST /tql/validate returns and the spec is only checked for structure. Only an internal compiler failure is a 500. Requires the `analytics` Feature Flag (Beta). Required permissions: `READ_EVENTS`<br> OperationId: `TqlControllerValidateChart`
|
|
31837
33007
|
* @summary Check a Chart spec against a TQL query
|
|
31838
33008
|
* @param {TqlChartValidateInputDTO} [tqlChartValidateInputDTO] TqlChartValidateInputDTO
|
|
31839
33009
|
* @param {*} [options] Override http request option.
|
|
@@ -33813,7 +34983,7 @@ export const VariableApiAxiosParamCreator = function (configuration) {
|
|
|
33813
34983
|
};
|
|
33814
34984
|
},
|
|
33815
34985
|
/**
|
|
33816
|
-
*
|
|
34986
|
+
* Update a variable. Send the `version` you read: if the variable changed since, the update is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerUpdate`
|
|
33817
34987
|
* @summary Update
|
|
33818
34988
|
* @param {string} id
|
|
33819
34989
|
* @param {VariableUpdateDTO} [variableUpdateDTO] VariableUpdateDTO
|
|
@@ -33922,7 +35092,7 @@ export const VariableApiFp = function (configuration) {
|
|
|
33922
35092
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
33923
35093
|
},
|
|
33924
35094
|
/**
|
|
33925
|
-
*
|
|
35095
|
+
* Update a variable. Send the `version` you read: if the variable changed since, the update is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerUpdate`
|
|
33926
35096
|
* @summary Update
|
|
33927
35097
|
* @param {string} id
|
|
33928
35098
|
* @param {VariableUpdateDTO} [variableUpdateDTO] VariableUpdateDTO
|
|
@@ -34001,7 +35171,7 @@ export const VariableApiFactory = function (configuration, basePath, axios) {
|
|
|
34001
35171
|
.then((request) => request(axios, basePath));
|
|
34002
35172
|
},
|
|
34003
35173
|
/**
|
|
34004
|
-
*
|
|
35174
|
+
* Update a variable. Send the `version` you read: if the variable changed since, the update is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerUpdate`
|
|
34005
35175
|
* @summary Update
|
|
34006
35176
|
* @param {string} id
|
|
34007
35177
|
* @param {VariableUpdateDTO} [variableUpdateDTO] VariableUpdateDTO
|
|
@@ -34088,7 +35258,7 @@ export class VariableApi extends BaseAPI {
|
|
|
34088
35258
|
.then((request) => request(this.axios, this.basePath));
|
|
34089
35259
|
}
|
|
34090
35260
|
/**
|
|
34091
|
-
*
|
|
35261
|
+
* Update a variable. Send the `version` you read: if the variable changed since, the update is refused with 409 `StaleRecordError`. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerUpdate`
|
|
34092
35262
|
* @summary Update
|
|
34093
35263
|
* @param {string} id
|
|
34094
35264
|
* @param {VariableUpdateDTO} [variableUpdateDTO] VariableUpdateDTO
|