@takaro/apiclient 0.0.0-dev.e2f5af7 → 0.0.0-dev.e3d9531
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 +5332 -1458
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/generated/api.js +3819 -1711
- package/dist/generated/api.js.map +1 -1
- package/dist/generated/base.d.ts.map +1 -1
- package/dist/generated/base.js.map +1 -1
- package/dist/generated/common.d.ts +1 -1
- package/dist/generated/common.d.ts.map +1 -1
- package/dist/generated/common.js.map +1 -1
- package/dist/generated/configuration.d.ts.map +1 -1
- package/dist/generated/configuration.js.map +1 -1
- package/dist/generated-management/api.d.ts +6576 -4174
- package/dist/generated-management/api.d.ts.map +1 -1
- package/dist/generated-management/api.js +1297 -198
- package/dist/generated-management/api.js.map +1 -1
- package/dist/generated-management/base.d.ts.map +1 -1
- package/dist/generated-management/base.js.map +1 -1
- package/dist/generated-management/common.d.ts +1 -1
- package/dist/generated-management/common.d.ts.map +1 -1
- package/dist/generated-management/common.js.map +1 -1
- package/dist/generated-management/configuration.d.ts.map +1 -1
- package/dist/generated-management/configuration.js.map +1 -1
- package/dist/lib/adminClient.d.ts +3 -1
- package/dist/lib/adminClient.d.ts.map +1 -1
- package/dist/lib/adminClient.js +7 -1
- package/dist/lib/adminClient.js.map +1 -1
- package/dist/lib/apiKey.d.ts +0 -15
- package/dist/lib/apiKey.d.ts.map +1 -1
- package/dist/lib/apiKey.js +2 -19
- package/dist/lib/apiKey.js.map +1 -1
- package/dist/lib/baseClient.d.ts +1 -27
- package/dist/lib/baseClient.d.ts.map +1 -1
- package/dist/lib/baseClient.js +3 -18
- package/dist/lib/baseClient.js.map +1 -1
- package/dist/lib/client.d.ts +7 -23
- package/dist/lib/client.d.ts.map +1 -1
- package/dist/lib/client.js +19 -25
- package/dist/lib/client.js.map +1 -1
- package/dist/lib/distributorClient.d.ts +0 -6
- package/dist/lib/distributorClient.d.ts.map +1 -1
- package/dist/lib/distributorClient.js +1 -7
- package/dist/lib/distributorClient.js.map +1 -1
- package/dist/lib/staffClient.d.ts +3 -12
- package/dist/lib/staffClient.d.ts.map +1 -1
- package/dist/lib/staffClient.js +7 -12
- package/dist/lib/staffClient.js.map +1 -1
- package/dist/main.d.ts +3 -3
- package/dist/main.d.ts.map +1 -1
- package/dist/main.js +3 -5
- package/dist/main.js.map +1 -1
- package/package.json +5 -4
|
@@ -47,14 +47,17 @@ export const ApiKeySearchInputDTOSortDirectionEnum = {
|
|
|
47
47
|
Asc: 'asc',
|
|
48
48
|
Desc: 'desc',
|
|
49
49
|
};
|
|
50
|
-
export const
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
50
|
+
export const ConnectorMigrationOutputDTOStatusEnum = {
|
|
51
|
+
Pending: 'pending',
|
|
52
|
+
Completed: 'completed',
|
|
53
|
+
Cancelled: 'cancelled',
|
|
54
|
+
Reverted: 'reverted',
|
|
54
55
|
};
|
|
55
|
-
export const
|
|
56
|
-
|
|
57
|
-
|
|
56
|
+
export const ConnectorMigrationOutputDTOLegacyTypeEnum = {
|
|
57
|
+
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
58
|
+
Rust: 'RUST',
|
|
59
|
+
Generic: 'GENERIC',
|
|
60
|
+
Mock: 'MOCK',
|
|
58
61
|
};
|
|
59
62
|
export const DistributorDomainSearchInputAllowedFiltersStateEnum = {
|
|
60
63
|
Active: 'ACTIVE',
|
|
@@ -86,6 +89,21 @@ export const DomainCreateInputDTOStateEnum = {
|
|
|
86
89
|
Disabled: 'DISABLED',
|
|
87
90
|
Maintenance: 'MAINTENANCE',
|
|
88
91
|
};
|
|
92
|
+
export const DomainLimitOutputDTOSourceEnum = {
|
|
93
|
+
Plan: 'plan',
|
|
94
|
+
Override: 'override',
|
|
95
|
+
Adoption: 'adoption',
|
|
96
|
+
Unmanaged: 'unmanaged',
|
|
97
|
+
};
|
|
98
|
+
export const DomainLimitOverrideChangeOutputDTOActionEnum = {
|
|
99
|
+
Set: 'set',
|
|
100
|
+
Clear: 'clear',
|
|
101
|
+
};
|
|
102
|
+
export const DomainLimitOverrideChangeOutputDTOActorKindEnum = {
|
|
103
|
+
StaffSession: 'staffSession',
|
|
104
|
+
AdminSecret: 'adminSecret',
|
|
105
|
+
System: 'system',
|
|
106
|
+
};
|
|
89
107
|
export const DomainOutputDTOStateEnum = {
|
|
90
108
|
Active: 'ACTIVE',
|
|
91
109
|
Disabled: 'DISABLED',
|
|
@@ -152,6 +170,7 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
152
170
|
SettingsSet: 'settings-set',
|
|
153
171
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
154
172
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
173
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
155
174
|
ServerStatusChanged: 'server-status-changed',
|
|
156
175
|
ModuleCreated: 'module-created',
|
|
157
176
|
ModuleUpdated: 'module-updated',
|
|
@@ -166,8 +185,11 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
166
185
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
167
186
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
168
187
|
PlayerLinked: 'player-linked',
|
|
188
|
+
PlayerUnlinked: 'player-unlinked',
|
|
189
|
+
PlayerMerged: 'player-merged',
|
|
169
190
|
GameserverCreated: 'gameserver-created',
|
|
170
191
|
GameserverUpdated: 'gameserver-updated',
|
|
192
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
171
193
|
GameserverDeleted: 'gameserver-deleted',
|
|
172
194
|
PlayerBanned: 'player-banned',
|
|
173
195
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -183,6 +205,12 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
183
205
|
DomainCreated: 'domain-created',
|
|
184
206
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
185
207
|
DomainPlanChanged: 'domain-plan-changed',
|
|
208
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
209
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
210
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
211
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
212
|
+
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
213
|
+
ItemsGiven: 'items-given',
|
|
186
214
|
PlayerConnected: 'player-connected',
|
|
187
215
|
PlayerDisconnected: 'player-disconnected',
|
|
188
216
|
ChatMessage: 'chat-message',
|
|
@@ -205,6 +233,7 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
205
233
|
SettingsSet: 'settings-set',
|
|
206
234
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
207
235
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
236
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
208
237
|
ServerStatusChanged: 'server-status-changed',
|
|
209
238
|
ModuleCreated: 'module-created',
|
|
210
239
|
ModuleUpdated: 'module-updated',
|
|
@@ -219,8 +248,11 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
219
248
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
220
249
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
221
250
|
PlayerLinked: 'player-linked',
|
|
251
|
+
PlayerUnlinked: 'player-unlinked',
|
|
252
|
+
PlayerMerged: 'player-merged',
|
|
222
253
|
GameserverCreated: 'gameserver-created',
|
|
223
254
|
GameserverUpdated: 'gameserver-updated',
|
|
255
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
224
256
|
GameserverDeleted: 'gameserver-deleted',
|
|
225
257
|
PlayerBanned: 'player-banned',
|
|
226
258
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -236,6 +268,12 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
236
268
|
DomainCreated: 'domain-created',
|
|
237
269
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
238
270
|
DomainPlanChanged: 'domain-plan-changed',
|
|
271
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
272
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
273
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
274
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
275
|
+
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
276
|
+
ItemsGiven: 'items-given',
|
|
239
277
|
PlayerConnected: 'player-connected',
|
|
240
278
|
PlayerDisconnected: 'player-disconnected',
|
|
241
279
|
ChatMessage: 'chat-message',
|
|
@@ -273,12 +311,24 @@ export const GameServerCreateDTOTypeEnum = {
|
|
|
273
311
|
Generic: 'GENERIC',
|
|
274
312
|
Mock: 'MOCK',
|
|
275
313
|
};
|
|
314
|
+
export const GameServerCreateDTONameSourceEnum = {
|
|
315
|
+
Connector: 'connector',
|
|
316
|
+
Operator: 'operator',
|
|
317
|
+
};
|
|
318
|
+
export const GameServerIdentifyInputDTOProtocolVersionEnum = {
|
|
319
|
+
NUMBER_0: 0,
|
|
320
|
+
NUMBER_1: 1,
|
|
321
|
+
};
|
|
276
322
|
export const GameServerOutputDTOTypeEnum = {
|
|
277
323
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
278
324
|
Rust: 'RUST',
|
|
279
325
|
Generic: 'GENERIC',
|
|
280
326
|
Mock: 'MOCK',
|
|
281
327
|
};
|
|
328
|
+
export const GameServerOutputDTONameSourceEnum = {
|
|
329
|
+
Connector: 'connector',
|
|
330
|
+
Operator: 'operator',
|
|
331
|
+
};
|
|
282
332
|
export const GameServerTypesOutputDTOTypeEnum = {
|
|
283
333
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
284
334
|
Rust: 'RUST',
|
|
@@ -303,11 +353,15 @@ export const GetJobInputDTOTypeEnum = {
|
|
|
303
353
|
SyncBans: 'syncBans',
|
|
304
354
|
SyncMapImages: 'syncMapImages',
|
|
305
355
|
SyncMapUploads: 'syncMapUploads',
|
|
356
|
+
SyncGameIcons: 'syncGameIcons',
|
|
306
357
|
SyncSteam: 'syncSteam',
|
|
307
358
|
SyncDiscordRoles: 'syncDiscordRoles',
|
|
308
359
|
EmitRateLimitSummary: 'emitRateLimitSummary',
|
|
309
360
|
CleanRevokedApiKeys: 'cleanRevokedApiKeys',
|
|
310
361
|
CleanExecutionClaims: 'cleanExecutionClaims',
|
|
362
|
+
DeleteClickHouseEvents: 'deleteClickHouseEvents',
|
|
363
|
+
RepointClickHouseEvents: 'repointClickHouseEvents',
|
|
364
|
+
CleanConnectorMigrations: 'cleanConnectorMigrations',
|
|
311
365
|
};
|
|
312
366
|
export const HookCreateDTOEventTypeEnum = {
|
|
313
367
|
Log: 'log',
|
|
@@ -332,6 +386,7 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
332
386
|
SettingsSet: 'settings-set',
|
|
333
387
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
334
388
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
389
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
335
390
|
ServerStatusChanged: 'server-status-changed',
|
|
336
391
|
ModuleCreated: 'module-created',
|
|
337
392
|
ModuleUpdated: 'module-updated',
|
|
@@ -346,8 +401,11 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
346
401
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
347
402
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
348
403
|
PlayerLinked: 'player-linked',
|
|
404
|
+
PlayerUnlinked: 'player-unlinked',
|
|
405
|
+
PlayerMerged: 'player-merged',
|
|
349
406
|
GameserverCreated: 'gameserver-created',
|
|
350
407
|
GameserverUpdated: 'gameserver-updated',
|
|
408
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
351
409
|
GameserverDeleted: 'gameserver-deleted',
|
|
352
410
|
PlayerBanned: 'player-banned',
|
|
353
411
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -363,6 +421,12 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
363
421
|
DomainCreated: 'domain-created',
|
|
364
422
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
365
423
|
DomainPlanChanged: 'domain-plan-changed',
|
|
424
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
425
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
426
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
427
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
428
|
+
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
429
|
+
ItemsGiven: 'items-given',
|
|
366
430
|
};
|
|
367
431
|
export const HookOutputDTOEventTypeEnum = {
|
|
368
432
|
Log: 'log',
|
|
@@ -387,6 +451,7 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
387
451
|
SettingsSet: 'settings-set',
|
|
388
452
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
389
453
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
454
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
390
455
|
ServerStatusChanged: 'server-status-changed',
|
|
391
456
|
ModuleCreated: 'module-created',
|
|
392
457
|
ModuleUpdated: 'module-updated',
|
|
@@ -401,8 +466,11 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
401
466
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
402
467
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
403
468
|
PlayerLinked: 'player-linked',
|
|
469
|
+
PlayerUnlinked: 'player-unlinked',
|
|
470
|
+
PlayerMerged: 'player-merged',
|
|
404
471
|
GameserverCreated: 'gameserver-created',
|
|
405
472
|
GameserverUpdated: 'gameserver-updated',
|
|
473
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
406
474
|
GameserverDeleted: 'gameserver-deleted',
|
|
407
475
|
PlayerBanned: 'player-banned',
|
|
408
476
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -418,6 +486,12 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
418
486
|
DomainCreated: 'domain-created',
|
|
419
487
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
420
488
|
DomainPlanChanged: 'domain-plan-changed',
|
|
489
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
490
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
491
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
492
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
493
|
+
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
494
|
+
ItemsGiven: 'items-given',
|
|
421
495
|
};
|
|
422
496
|
export const HookTriggerDTOEventTypeEnum = {
|
|
423
497
|
Log: 'log',
|
|
@@ -442,6 +516,7 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
442
516
|
SettingsSet: 'settings-set',
|
|
443
517
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
444
518
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
519
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
445
520
|
ServerStatusChanged: 'server-status-changed',
|
|
446
521
|
ModuleCreated: 'module-created',
|
|
447
522
|
ModuleUpdated: 'module-updated',
|
|
@@ -456,8 +531,11 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
456
531
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
457
532
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
458
533
|
PlayerLinked: 'player-linked',
|
|
534
|
+
PlayerUnlinked: 'player-unlinked',
|
|
535
|
+
PlayerMerged: 'player-merged',
|
|
459
536
|
GameserverCreated: 'gameserver-created',
|
|
460
537
|
GameserverUpdated: 'gameserver-updated',
|
|
538
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
461
539
|
GameserverDeleted: 'gameserver-deleted',
|
|
462
540
|
PlayerBanned: 'player-banned',
|
|
463
541
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -473,6 +551,12 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
473
551
|
DomainCreated: 'domain-created',
|
|
474
552
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
475
553
|
DomainPlanChanged: 'domain-plan-changed',
|
|
554
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
555
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
556
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
557
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
558
|
+
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
559
|
+
ItemsGiven: 'items-given',
|
|
476
560
|
};
|
|
477
561
|
export const HookUpdateDTOEventTypeEnum = {
|
|
478
562
|
Log: 'log',
|
|
@@ -497,6 +581,7 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
497
581
|
SettingsSet: 'settings-set',
|
|
498
582
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
499
583
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
584
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
500
585
|
ServerStatusChanged: 'server-status-changed',
|
|
501
586
|
ModuleCreated: 'module-created',
|
|
502
587
|
ModuleUpdated: 'module-updated',
|
|
@@ -511,8 +596,11 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
511
596
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
512
597
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
513
598
|
PlayerLinked: 'player-linked',
|
|
599
|
+
PlayerUnlinked: 'player-unlinked',
|
|
600
|
+
PlayerMerged: 'player-merged',
|
|
514
601
|
GameserverCreated: 'gameserver-created',
|
|
515
602
|
GameserverUpdated: 'gameserver-updated',
|
|
603
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
516
604
|
GameserverDeleted: 'gameserver-deleted',
|
|
517
605
|
PlayerBanned: 'player-banned',
|
|
518
606
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -528,6 +616,12 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
528
616
|
DomainCreated: 'domain-created',
|
|
529
617
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
530
618
|
DomainPlanChanged: 'domain-plan-changed',
|
|
619
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
620
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
621
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
622
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
623
|
+
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
624
|
+
ItemsGiven: 'items-given',
|
|
531
625
|
};
|
|
532
626
|
export const IEntityDTOTypeEnum = {
|
|
533
627
|
Hostile: 'hostile',
|
|
@@ -557,6 +651,7 @@ export const IHookEventTypeEnum = {
|
|
|
557
651
|
SettingsSet: 'settings-set',
|
|
558
652
|
PlayerNewIpDetected: 'player-new-ip-detected',
|
|
559
653
|
PlayerNewNameDetected: 'player-new-name-detected',
|
|
654
|
+
PlayerIdentityConflict: 'player-identity-conflict',
|
|
560
655
|
ServerStatusChanged: 'server-status-changed',
|
|
561
656
|
ModuleCreated: 'module-created',
|
|
562
657
|
ModuleUpdated: 'module-updated',
|
|
@@ -571,8 +666,11 @@ export const IHookEventTypeEnum = {
|
|
|
571
666
|
ShopOrderStatusChanged: 'shop-order-status-changed',
|
|
572
667
|
ShopOrderDeliveryFailed: 'shop-order-delivery-failed',
|
|
573
668
|
PlayerLinked: 'player-linked',
|
|
669
|
+
PlayerUnlinked: 'player-unlinked',
|
|
670
|
+
PlayerMerged: 'player-merged',
|
|
574
671
|
GameserverCreated: 'gameserver-created',
|
|
575
672
|
GameserverUpdated: 'gameserver-updated',
|
|
673
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
576
674
|
GameserverDeleted: 'gameserver-deleted',
|
|
577
675
|
PlayerBanned: 'player-banned',
|
|
578
676
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -588,6 +686,12 @@ export const IHookEventTypeEnum = {
|
|
|
588
686
|
DomainCreated: 'domain-created',
|
|
589
687
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
590
688
|
DomainPlanChanged: 'domain-plan-changed',
|
|
689
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
690
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
691
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
692
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
693
|
+
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
694
|
+
ItemsGiven: 'items-given',
|
|
591
695
|
};
|
|
592
696
|
export const ITakaroQuerySortDirectionEnum = {
|
|
593
697
|
Asc: 'asc',
|
|
@@ -699,11 +803,15 @@ export const PERMISSIONS = {
|
|
|
699
803
|
SendDiscordMessage: 'SEND_DISCORD_MESSAGE',
|
|
700
804
|
ManageApiKeys: 'MANAGE_API_KEYS',
|
|
701
805
|
};
|
|
702
|
-
export const
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
806
|
+
export const PlanChangeOutputDTOActionEnum = {
|
|
807
|
+
Create: 'create',
|
|
808
|
+
Update: 'update',
|
|
809
|
+
Archive: 'archive',
|
|
810
|
+
};
|
|
811
|
+
export const PlanChangeOutputDTOActorKindEnum = {
|
|
812
|
+
StaffSession: 'staffSession',
|
|
813
|
+
AdminSecret: 'adminSecret',
|
|
814
|
+
System: 'system',
|
|
707
815
|
};
|
|
708
816
|
export const PlayerOnGameServerSearchInputDTOExtendEnum = {
|
|
709
817
|
GameServer: 'gameServer',
|
|
@@ -855,6 +963,12 @@ export const StorefrontDomainOutputDTOCustomDomainStateEnum = {
|
|
|
855
963
|
Verified: 'VERIFIED',
|
|
856
964
|
Failed: 'FAILED',
|
|
857
965
|
};
|
|
966
|
+
export const StripePriceDTOIntervalEnum = {
|
|
967
|
+
Day: 'day',
|
|
968
|
+
Week: 'week',
|
|
969
|
+
Month: 'month',
|
|
970
|
+
Year: 'year',
|
|
971
|
+
};
|
|
858
972
|
export const TakaroAiDomainOutputDTOOverrideStateEnum = {
|
|
859
973
|
None: 'none',
|
|
860
974
|
Active: 'active',
|
|
@@ -887,11 +1001,61 @@ export const TakaroAiUsageOutputDTOStatusEnum = {
|
|
|
887
1001
|
NoAllowance: 'noAllowance',
|
|
888
1002
|
NeedsGameServer: 'needsGameServer',
|
|
889
1003
|
};
|
|
1004
|
+
export const TakaroEventDomainCreatedOriginEnum = {
|
|
1005
|
+
Distributor: 'distributor',
|
|
1006
|
+
Staff: 'staff',
|
|
1007
|
+
Subscription: 'subscription',
|
|
1008
|
+
AdminSecret: 'admin_secret',
|
|
1009
|
+
};
|
|
1010
|
+
export const TakaroEventItemsGivenLineResultEnum = {
|
|
1011
|
+
Delivered: 'DELIVERED',
|
|
1012
|
+
Failed: 'FAILED',
|
|
1013
|
+
Unknown: 'UNKNOWN',
|
|
1014
|
+
};
|
|
1015
|
+
export const TakaroEventPlayerIdentityConflictUnwrittenIdentifiersEnum = {
|
|
1016
|
+
SteamId: 'steamId',
|
|
1017
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1018
|
+
XboxLiveId: 'xboxLiveId',
|
|
1019
|
+
PlatformId: 'platformId',
|
|
1020
|
+
};
|
|
1021
|
+
export const TakaroEventPlayerIdentityConflictMatchMatchedOnEnum = {
|
|
1022
|
+
SteamId: 'steamId',
|
|
1023
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1024
|
+
XboxLiveId: 'xboxLiveId',
|
|
1025
|
+
PlatformId: 'platformId',
|
|
1026
|
+
};
|
|
890
1027
|
export const TakaroEventPlayerInventoryChangedChangeTypeEnum = {
|
|
891
1028
|
Added: 'added',
|
|
892
1029
|
Removed: 'removed',
|
|
893
1030
|
Changed: 'changed',
|
|
894
1031
|
};
|
|
1032
|
+
export const TakaroEventPlayerLinkedSourceEnum = {
|
|
1033
|
+
GameCode: 'game-code',
|
|
1034
|
+
WebCode: 'web-code',
|
|
1035
|
+
SteamAuto: 'steam-auto',
|
|
1036
|
+
Admin: 'admin',
|
|
1037
|
+
Unknown: 'unknown',
|
|
1038
|
+
};
|
|
1039
|
+
export const TakaroEventPlayerMergedMovedIdentifiersEnum = {
|
|
1040
|
+
SteamId: 'steamId',
|
|
1041
|
+
EpicOnlineServicesId: 'epicOnlineServicesId',
|
|
1042
|
+
XboxLiveId: 'xboxLiveId',
|
|
1043
|
+
PlatformId: 'platformId',
|
|
1044
|
+
};
|
|
1045
|
+
export const TakaroEventPlayerMergedServerOutcomeEnum = {
|
|
1046
|
+
Moved: 'moved',
|
|
1047
|
+
Combined: 'combined',
|
|
1048
|
+
};
|
|
1049
|
+
export const TakaroEventPlayerMergedServerKeptPogFromEnum = {
|
|
1050
|
+
Survivor: 'survivor',
|
|
1051
|
+
Absorbed: 'absorbed',
|
|
1052
|
+
};
|
|
1053
|
+
export const TakaroEventPlayerUnlinkedReasonEnum = {
|
|
1054
|
+
Self: 'self',
|
|
1055
|
+
Admin: 'admin',
|
|
1056
|
+
Displaced: 'displaced',
|
|
1057
|
+
Merged: 'merged',
|
|
1058
|
+
};
|
|
895
1059
|
export const TakaroEventRateLimitedScopeEnum = {
|
|
896
1060
|
Server: 'server',
|
|
897
1061
|
Domain: 'domain',
|
|
@@ -1038,9 +1202,24 @@ export const TriggerJobInputDTOTypeEnum = {
|
|
|
1038
1202
|
SyncBans: 'syncBans',
|
|
1039
1203
|
SyncMapImages: 'syncMapImages',
|
|
1040
1204
|
SyncMapUploads: 'syncMapUploads',
|
|
1205
|
+
SyncGameIcons: 'syncGameIcons',
|
|
1041
1206
|
SyncSteam: 'syncSteam',
|
|
1042
1207
|
SyncDiscordRoles: 'syncDiscordRoles',
|
|
1043
1208
|
};
|
|
1209
|
+
export const UserOutputDTOPlayerLinkSourceEnum = {
|
|
1210
|
+
GameCode: 'game-code',
|
|
1211
|
+
WebCode: 'web-code',
|
|
1212
|
+
SteamAuto: 'steam-auto',
|
|
1213
|
+
Admin: 'admin',
|
|
1214
|
+
Unknown: 'unknown',
|
|
1215
|
+
};
|
|
1216
|
+
export const UserOutputWithRolesDTOPlayerLinkSourceEnum = {
|
|
1217
|
+
GameCode: 'game-code',
|
|
1218
|
+
WebCode: 'web-code',
|
|
1219
|
+
SteamAuto: 'steam-auto',
|
|
1220
|
+
Admin: 'admin',
|
|
1221
|
+
Unknown: 'unknown',
|
|
1222
|
+
};
|
|
1044
1223
|
export const UserSearchInputDTOExtendEnum = {
|
|
1045
1224
|
Roles: 'roles',
|
|
1046
1225
|
};
|
|
@@ -1805,7 +1984,7 @@ export class DistributorApi extends BaseAPI {
|
|
|
1805
1984
|
export const DistributorSelfServiceApiAxiosParamCreator = function (configuration) {
|
|
1806
1985
|
return {
|
|
1807
1986
|
/**
|
|
1808
|
-
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan
|
|
1987
|
+
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan and apply at creation; a domain created without a `planId` starts on the platform defaults. A Plan outside `allowedPlans` is refused with a 400. A Distributor Service Account holding the domain’s root role is created with the domain; every management verb on the domain is recorded in its event feed as that account.<br> OperationId: `DistributorSelfServiceControllerCreateDomain`
|
|
1809
1988
|
* @summary Create a domain
|
|
1810
1989
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
1811
1990
|
* @param {*} [options] Override http request option.
|
|
@@ -2115,7 +2294,7 @@ export const DistributorSelfServiceApiAxiosParamCreator = function (configuratio
|
|
|
2115
2294
|
};
|
|
2116
2295
|
},
|
|
2117
2296
|
/**
|
|
2118
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2297
|
+
* Moves the domain onto another of the Plans allowed for the calling distributor; the Plan’s limits apply before the response. Downgrading a customer who cancelled means moving the domain to the free Plan — it keeps running at free limits, and its state never changes. A Plan outside the allowed list is a 400; another distributor’s domain is a 404, never a 403. Idempotent: setting the Plan the domain is already on re-applies its limits and records nothing.<br> OperationId: `DistributorSelfServiceControllerSetDomainPlan`
|
|
2119
2298
|
* @summary Change one of my domains’ Plan
|
|
2120
2299
|
* @param {string} id
|
|
2121
2300
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2158,7 +2337,7 @@ export const DistributorSelfServiceApiFp = function (configuration) {
|
|
|
2158
2337
|
const localVarAxiosParamCreator = DistributorSelfServiceApiAxiosParamCreator(configuration);
|
|
2159
2338
|
return {
|
|
2160
2339
|
/**
|
|
2161
|
-
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan
|
|
2340
|
+
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan and apply at creation; a domain created without a `planId` starts on the platform defaults. A Plan outside `allowedPlans` is refused with a 400. A Distributor Service Account holding the domain’s root role is created with the domain; every management verb on the domain is recorded in its event feed as that account.<br> OperationId: `DistributorSelfServiceControllerCreateDomain`
|
|
2162
2341
|
* @summary Create a domain
|
|
2163
2342
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
2164
2343
|
* @param {*} [options] Override http request option.
|
|
@@ -2288,7 +2467,7 @@ export const DistributorSelfServiceApiFp = function (configuration) {
|
|
|
2288
2467
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2289
2468
|
},
|
|
2290
2469
|
/**
|
|
2291
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2470
|
+
* Moves the domain onto another of the Plans allowed for the calling distributor; the Plan’s limits apply before the response. Downgrading a customer who cancelled means moving the domain to the free Plan — it keeps running at free limits, and its state never changes. A Plan outside the allowed list is a 400; another distributor’s domain is a 404, never a 403. Idempotent: setting the Plan the domain is already on re-applies its limits and records nothing.<br> OperationId: `DistributorSelfServiceControllerSetDomainPlan`
|
|
2292
2471
|
* @summary Change one of my domains’ Plan
|
|
2293
2472
|
* @param {string} id
|
|
2294
2473
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2311,7 +2490,7 @@ export const DistributorSelfServiceApiFactory = function (configuration, basePat
|
|
|
2311
2490
|
const localVarFp = DistributorSelfServiceApiFp(configuration);
|
|
2312
2491
|
return {
|
|
2313
2492
|
/**
|
|
2314
|
-
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan
|
|
2493
|
+
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan and apply at creation; a domain created without a `planId` starts on the platform defaults. A Plan outside `allowedPlans` is refused with a 400. A Distributor Service Account holding the domain’s root role is created with the domain; every management verb on the domain is recorded in its event feed as that account.<br> OperationId: `DistributorSelfServiceControllerCreateDomain`
|
|
2315
2494
|
* @summary Create a domain
|
|
2316
2495
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
2317
2496
|
* @param {*} [options] Override http request option.
|
|
@@ -2429,7 +2608,7 @@ export const DistributorSelfServiceApiFactory = function (configuration, basePat
|
|
|
2429
2608
|
.then((request) => request(axios, basePath));
|
|
2430
2609
|
},
|
|
2431
2610
|
/**
|
|
2432
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2611
|
+
* Moves the domain onto another of the Plans allowed for the calling distributor; the Plan’s limits apply before the response. Downgrading a customer who cancelled means moving the domain to the free Plan — it keeps running at free limits, and its state never changes. A Plan outside the allowed list is a 400; another distributor’s domain is a 404, never a 403. Idempotent: setting the Plan the domain is already on re-applies its limits and records nothing.<br> OperationId: `DistributorSelfServiceControllerSetDomainPlan`
|
|
2433
2612
|
* @summary Change one of my domains’ Plan
|
|
2434
2613
|
* @param {string} id
|
|
2435
2614
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2451,7 +2630,7 @@ export const DistributorSelfServiceApiFactory = function (configuration, basePat
|
|
|
2451
2630
|
*/
|
|
2452
2631
|
export class DistributorSelfServiceApi extends BaseAPI {
|
|
2453
2632
|
/**
|
|
2454
|
-
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan
|
|
2633
|
+
* Creates a domain attributed to the calling distributor (ADR 0024 — attribution, never ownership). The response carries the domain and its `serverRegistrationToken`, so a provisioning script can inject the token into a game server without a second call. Limits come from the chosen Plan and apply at creation; a domain created without a `planId` starts on the platform defaults. A Plan outside `allowedPlans` is refused with a 400. A Distributor Service Account holding the domain’s root role is created with the domain; every management verb on the domain is recorded in its event feed as that account.<br> OperationId: `DistributorSelfServiceControllerCreateDomain`
|
|
2455
2634
|
* @summary Create a domain
|
|
2456
2635
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
2457
2636
|
* @param {*} [options] Override http request option.
|
|
@@ -2581,7 +2760,7 @@ export class DistributorSelfServiceApi extends BaseAPI {
|
|
|
2581
2760
|
.then((request) => request(this.axios, this.basePath));
|
|
2582
2761
|
}
|
|
2583
2762
|
/**
|
|
2584
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2763
|
+
* Moves the domain onto another of the Plans allowed for the calling distributor; the Plan’s limits apply before the response. Downgrading a customer who cancelled means moving the domain to the free Plan — it keeps running at free limits, and its state never changes. A Plan outside the allowed list is a 400; another distributor’s domain is a 404, never a 403. Idempotent: setting the Plan the domain is already on re-applies its limits and records nothing.<br> OperationId: `DistributorSelfServiceControllerSetDomainPlan`
|
|
2585
2764
|
* @summary Change one of my domains’ Plan
|
|
2586
2765
|
* @param {string} id
|
|
2587
2766
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2893,21 +3072,58 @@ export const DomainApiAxiosParamCreator = function (configuration) {
|
|
|
2893
3072
|
};
|
|
2894
3073
|
},
|
|
2895
3074
|
/**
|
|
2896
|
-
*
|
|
2897
|
-
* @summary
|
|
2898
|
-
* @param {
|
|
3075
|
+
* Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set variable, module, function, concurrency and rate limits that differ from the Plan are kept as overrides. Refused for a distributor-backed domain.<br> OperationId: `DomainControllerSetPlan`
|
|
3076
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3077
|
+
* @param {string} id
|
|
3078
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
2899
3079
|
* @param {*} [options] Override http request option.
|
|
2900
3080
|
* @throws {RequiredError}
|
|
2901
3081
|
*/
|
|
2902
|
-
|
|
2903
|
-
|
|
3082
|
+
domainControllerSetPlan: async (id, domainPlanInputDTO, options = {}) => {
|
|
3083
|
+
// verify required parameter 'id' is not null or undefined
|
|
3084
|
+
assertParamExists('domainControllerSetPlan', 'id', id);
|
|
3085
|
+
const localVarPath = `/domain/{id}/plan`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2904
3086
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2905
3087
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2906
3088
|
let baseOptions;
|
|
2907
3089
|
if (configuration) {
|
|
2908
3090
|
baseOptions = configuration.baseOptions;
|
|
2909
3091
|
}
|
|
2910
|
-
const localVarRequestOptions = { method: '
|
|
3092
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
3093
|
+
const localVarHeaderParameter = {};
|
|
3094
|
+
const localVarQueryParameter = {};
|
|
3095
|
+
// authentication staffSession required
|
|
3096
|
+
// authentication adminAuth required
|
|
3097
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
3098
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3099
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3100
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3101
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3102
|
+
localVarRequestOptions.data = serializeDataIfNeeded(domainPlanInputDTO, localVarRequestOptions, configuration);
|
|
3103
|
+
return {
|
|
3104
|
+
url: toPathString(localVarUrlObj),
|
|
3105
|
+
options: localVarRequestOptions,
|
|
3106
|
+
};
|
|
3107
|
+
},
|
|
3108
|
+
/**
|
|
3109
|
+
* For a domain with neither a Subscription nor a Distributor; refused for either, since Stripe or the Distributor chooses those Plans. Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set limits that differ from the Plan are kept as overrides.<br> OperationId: `DomainControllerSetPlanByStaff`
|
|
3110
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3111
|
+
* @param {string} id
|
|
3112
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3113
|
+
* @param {*} [options] Override http request option.
|
|
3114
|
+
* @throws {RequiredError}
|
|
3115
|
+
*/
|
|
3116
|
+
domainControllerSetPlanByStaff: async (id, staffDomainPlanInputDTO, options = {}) => {
|
|
3117
|
+
// verify required parameter 'id' is not null or undefined
|
|
3118
|
+
assertParamExists('domainControllerSetPlanByStaff', 'id', id);
|
|
3119
|
+
const localVarPath = `/staff/domains/{id}/plan`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
3120
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3121
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3122
|
+
let baseOptions;
|
|
3123
|
+
if (configuration) {
|
|
3124
|
+
baseOptions = configuration.baseOptions;
|
|
3125
|
+
}
|
|
3126
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
2911
3127
|
const localVarHeaderParameter = {};
|
|
2912
3128
|
const localVarQueryParameter = {};
|
|
2913
3129
|
// authentication staffSession required
|
|
@@ -2917,7 +3133,7 @@ export const DomainApiAxiosParamCreator = function (configuration) {
|
|
|
2917
3133
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2918
3134
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2919
3135
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2920
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3136
|
+
localVarRequestOptions.data = serializeDataIfNeeded(staffDomainPlanInputDTO, localVarRequestOptions, configuration);
|
|
2921
3137
|
return {
|
|
2922
3138
|
url: toPathString(localVarUrlObj),
|
|
2923
3139
|
options: localVarRequestOptions,
|
|
@@ -3087,16 +3303,31 @@ export const DomainApiFp = function (configuration) {
|
|
|
3087
3303
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3088
3304
|
},
|
|
3089
3305
|
/**
|
|
3090
|
-
*
|
|
3091
|
-
* @summary
|
|
3092
|
-
* @param {
|
|
3306
|
+
* Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set variable, module, function, concurrency and rate limits that differ from the Plan are kept as overrides. Refused for a distributor-backed domain.<br> OperationId: `DomainControllerSetPlan`
|
|
3307
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3308
|
+
* @param {string} id
|
|
3309
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
3310
|
+
* @param {*} [options] Override http request option.
|
|
3311
|
+
* @throws {RequiredError}
|
|
3312
|
+
*/
|
|
3313
|
+
async domainControllerSetPlan(id, domainPlanInputDTO, options) {
|
|
3314
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.domainControllerSetPlan(id, domainPlanInputDTO, options);
|
|
3315
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3316
|
+
const localVarOperationServerBasePath = operationServerMap['DomainApi.domainControllerSetPlan']?.[localVarOperationServerIndex]?.url;
|
|
3317
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3318
|
+
},
|
|
3319
|
+
/**
|
|
3320
|
+
* For a domain with neither a Subscription nor a Distributor; refused for either, since Stripe or the Distributor chooses those Plans. Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set limits that differ from the Plan are kept as overrides.<br> OperationId: `DomainControllerSetPlanByStaff`
|
|
3321
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3322
|
+
* @param {string} id
|
|
3323
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3093
3324
|
* @param {*} [options] Override http request option.
|
|
3094
3325
|
* @throws {RequiredError}
|
|
3095
3326
|
*/
|
|
3096
|
-
async
|
|
3097
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3327
|
+
async domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options) {
|
|
3328
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options);
|
|
3098
3329
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3099
|
-
const localVarOperationServerBasePath = operationServerMap['DomainApi.
|
|
3330
|
+
const localVarOperationServerBasePath = operationServerMap['DomainApi.domainControllerSetPlanByStaff']?.[localVarOperationServerIndex]?.url;
|
|
3100
3331
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3101
3332
|
},
|
|
3102
3333
|
/**
|
|
@@ -3226,15 +3457,29 @@ export const DomainApiFactory = function (configuration, basePath, axios) {
|
|
|
3226
3457
|
.then((request) => request(axios, basePath));
|
|
3227
3458
|
},
|
|
3228
3459
|
/**
|
|
3229
|
-
*
|
|
3230
|
-
* @summary
|
|
3231
|
-
* @param {
|
|
3460
|
+
* Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set variable, module, function, concurrency and rate limits that differ from the Plan are kept as overrides. Refused for a distributor-backed domain.<br> OperationId: `DomainControllerSetPlan`
|
|
3461
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3462
|
+
* @param {string} id
|
|
3463
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
3464
|
+
* @param {*} [options] Override http request option.
|
|
3465
|
+
* @throws {RequiredError}
|
|
3466
|
+
*/
|
|
3467
|
+
domainControllerSetPlan(id, domainPlanInputDTO, options) {
|
|
3468
|
+
return localVarFp
|
|
3469
|
+
.domainControllerSetPlan(id, domainPlanInputDTO, options)
|
|
3470
|
+
.then((request) => request(axios, basePath));
|
|
3471
|
+
},
|
|
3472
|
+
/**
|
|
3473
|
+
* For a domain with neither a Subscription nor a Distributor; refused for either, since Stripe or the Distributor chooses those Plans. Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set limits that differ from the Plan are kept as overrides.<br> OperationId: `DomainControllerSetPlanByStaff`
|
|
3474
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3475
|
+
* @param {string} id
|
|
3476
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3232
3477
|
* @param {*} [options] Override http request option.
|
|
3233
3478
|
* @throws {RequiredError}
|
|
3234
3479
|
*/
|
|
3235
|
-
|
|
3480
|
+
domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options) {
|
|
3236
3481
|
return localVarFp
|
|
3237
|
-
.
|
|
3482
|
+
.domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options)
|
|
3238
3483
|
.then((request) => request(axios, basePath));
|
|
3239
3484
|
},
|
|
3240
3485
|
/**
|
|
@@ -3380,16 +3625,31 @@ export class DomainApi extends BaseAPI {
|
|
|
3380
3625
|
.then((request) => request(this.axios, this.basePath));
|
|
3381
3626
|
}
|
|
3382
3627
|
/**
|
|
3383
|
-
*
|
|
3384
|
-
* @summary
|
|
3385
|
-
* @param {
|
|
3628
|
+
* Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set variable, module, function, concurrency and rate limits that differ from the Plan are kept as overrides. Refused for a distributor-backed domain.<br> OperationId: `DomainControllerSetPlan`
|
|
3629
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3630
|
+
* @param {string} id
|
|
3631
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
3632
|
+
* @param {*} [options] Override http request option.
|
|
3633
|
+
* @throws {RequiredError}
|
|
3634
|
+
* @memberof DomainApi
|
|
3635
|
+
*/
|
|
3636
|
+
domainControllerSetPlan(id, domainPlanInputDTO, options) {
|
|
3637
|
+
return DomainApiFp(this.configuration)
|
|
3638
|
+
.domainControllerSetPlan(id, domainPlanInputDTO, options)
|
|
3639
|
+
.then((request) => request(this.axios, this.basePath));
|
|
3640
|
+
}
|
|
3641
|
+
/**
|
|
3642
|
+
* For a domain with neither a Subscription nor a Distributor; refused for either, since Stripe or the Distributor chooses those Plans. Applies the Plan’s limits at once, keeping any limit override. On the first assignment of a domain that predates Plans, its hand-set limits that differ from the Plan are kept as overrides.<br> OperationId: `DomainControllerSetPlanByStaff`
|
|
3643
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3644
|
+
* @param {string} id
|
|
3645
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3386
3646
|
* @param {*} [options] Override http request option.
|
|
3387
3647
|
* @throws {RequiredError}
|
|
3388
3648
|
* @memberof DomainApi
|
|
3389
3649
|
*/
|
|
3390
|
-
|
|
3650
|
+
domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options) {
|
|
3391
3651
|
return DomainApiFp(this.configuration)
|
|
3392
|
-
.
|
|
3652
|
+
.domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options)
|
|
3393
3653
|
.then((request) => request(this.axios, this.basePath));
|
|
3394
3654
|
}
|
|
3395
3655
|
/**
|
|
@@ -4494,31 +4754,6 @@ export const MetaApiAxiosParamCreator = function (configuration) {
|
|
|
4494
4754
|
options: localVarRequestOptions,
|
|
4495
4755
|
};
|
|
4496
4756
|
},
|
|
4497
|
-
/**
|
|
4498
|
-
* <br> OperationId: `MetaGetMetrics`
|
|
4499
|
-
* @summary Get metrics
|
|
4500
|
-
* @param {*} [options] Override http request option.
|
|
4501
|
-
* @throws {RequiredError}
|
|
4502
|
-
*/
|
|
4503
|
-
metaGetMetrics: async (options = {}) => {
|
|
4504
|
-
const localVarPath = `/metrics`;
|
|
4505
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4506
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4507
|
-
let baseOptions;
|
|
4508
|
-
if (configuration) {
|
|
4509
|
-
baseOptions = configuration.baseOptions;
|
|
4510
|
-
}
|
|
4511
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
4512
|
-
const localVarHeaderParameter = {};
|
|
4513
|
-
const localVarQueryParameter = {};
|
|
4514
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4515
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4516
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
4517
|
-
return {
|
|
4518
|
-
url: toPathString(localVarUrlObj),
|
|
4519
|
-
options: localVarRequestOptions,
|
|
4520
|
-
};
|
|
4521
|
-
},
|
|
4522
4757
|
/**
|
|
4523
4758
|
* <br> OperationId: `MetaGetOpenApi`
|
|
4524
4759
|
* @summary Get open api
|
|
@@ -4652,18 +4887,6 @@ export const MetaApiFp = function (configuration) {
|
|
|
4652
4887
|
const localVarOperationServerBasePath = operationServerMap['MetaApi.metaGetLiveness']?.[localVarOperationServerIndex]?.url;
|
|
4653
4888
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4654
4889
|
},
|
|
4655
|
-
/**
|
|
4656
|
-
* <br> OperationId: `MetaGetMetrics`
|
|
4657
|
-
* @summary Get metrics
|
|
4658
|
-
* @param {*} [options] Override http request option.
|
|
4659
|
-
* @throws {RequiredError}
|
|
4660
|
-
*/
|
|
4661
|
-
async metaGetMetrics(options) {
|
|
4662
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.metaGetMetrics(options);
|
|
4663
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4664
|
-
const localVarOperationServerBasePath = operationServerMap['MetaApi.metaGetMetrics']?.[localVarOperationServerIndex]?.url;
|
|
4665
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4666
|
-
},
|
|
4667
4890
|
/**
|
|
4668
4891
|
* <br> OperationId: `MetaGetOpenApi`
|
|
4669
4892
|
* @summary Get open api
|
|
@@ -4739,15 +4962,6 @@ export const MetaApiFactory = function (configuration, basePath, axios) {
|
|
|
4739
4962
|
metaGetLiveness(options) {
|
|
4740
4963
|
return localVarFp.metaGetLiveness(options).then((request) => request(axios, basePath));
|
|
4741
4964
|
},
|
|
4742
|
-
/**
|
|
4743
|
-
* <br> OperationId: `MetaGetMetrics`
|
|
4744
|
-
* @summary Get metrics
|
|
4745
|
-
* @param {*} [options] Override http request option.
|
|
4746
|
-
* @throws {RequiredError}
|
|
4747
|
-
*/
|
|
4748
|
-
metaGetMetrics(options) {
|
|
4749
|
-
return localVarFp.metaGetMetrics(options).then((request) => request(axios, basePath));
|
|
4750
|
-
},
|
|
4751
4965
|
/**
|
|
4752
4966
|
* <br> OperationId: `MetaGetOpenApi`
|
|
4753
4967
|
* @summary Get open api
|
|
@@ -4817,18 +5031,6 @@ export class MetaApi extends BaseAPI {
|
|
|
4817
5031
|
.metaGetLiveness(options)
|
|
4818
5032
|
.then((request) => request(this.axios, this.basePath));
|
|
4819
5033
|
}
|
|
4820
|
-
/**
|
|
4821
|
-
* <br> OperationId: `MetaGetMetrics`
|
|
4822
|
-
* @summary Get metrics
|
|
4823
|
-
* @param {*} [options] Override http request option.
|
|
4824
|
-
* @throws {RequiredError}
|
|
4825
|
-
* @memberof MetaApi
|
|
4826
|
-
*/
|
|
4827
|
-
metaGetMetrics(options) {
|
|
4828
|
-
return MetaApiFp(this.configuration)
|
|
4829
|
-
.metaGetMetrics(options)
|
|
4830
|
-
.then((request) => request(this.axios, this.basePath));
|
|
4831
|
-
}
|
|
4832
5034
|
/**
|
|
4833
5035
|
* <br> OperationId: `MetaGetOpenApi`
|
|
4834
5036
|
* @summary Get open api
|
|
@@ -5189,114 +5391,92 @@ export class StaffAuthApi extends BaseAPI {
|
|
|
5189
5391
|
}
|
|
5190
5392
|
}
|
|
5191
5393
|
/**
|
|
5192
|
-
*
|
|
5394
|
+
* StaffDomainLimitsApi - axios parameter creator
|
|
5193
5395
|
* @export
|
|
5194
5396
|
*/
|
|
5195
|
-
export const
|
|
5397
|
+
export const StaffDomainLimitsApiAxiosParamCreator = function (configuration) {
|
|
5196
5398
|
return {
|
|
5197
5399
|
/**
|
|
5198
|
-
* The
|
|
5199
|
-
* @summary
|
|
5400
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5401
|
+
* @summary Clear a limit override of a Domain
|
|
5402
|
+
* @param {string} id
|
|
5403
|
+
* @param {string} limitKey
|
|
5404
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5200
5405
|
* @param {*} [options] Override http request option.
|
|
5201
5406
|
* @throws {RequiredError}
|
|
5202
5407
|
*/
|
|
5203
|
-
|
|
5204
|
-
|
|
5408
|
+
staffDomainLimitsControllerClear: async (id, limitKey, domainLimitOverrideClearInputDTO, options = {}) => {
|
|
5409
|
+
// verify required parameter 'id' is not null or undefined
|
|
5410
|
+
assertParamExists('staffDomainLimitsControllerClear', 'id', id);
|
|
5411
|
+
// verify required parameter 'limitKey' is not null or undefined
|
|
5412
|
+
assertParamExists('staffDomainLimitsControllerClear', 'limitKey', limitKey);
|
|
5413
|
+
const localVarPath = `/staff/domains/{id}/limits/{limitKey}`
|
|
5414
|
+
.replace(`{${'id'}}`, encodeURIComponent(String(id)))
|
|
5415
|
+
.replace(`{${'limitKey'}}`, encodeURIComponent(String(limitKey)));
|
|
5205
5416
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5206
5417
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5207
5418
|
let baseOptions;
|
|
5208
5419
|
if (configuration) {
|
|
5209
5420
|
baseOptions = configuration.baseOptions;
|
|
5210
5421
|
}
|
|
5211
|
-
const localVarRequestOptions = { method: '
|
|
5422
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
5212
5423
|
const localVarHeaderParameter = {};
|
|
5213
5424
|
const localVarQueryParameter = {};
|
|
5214
5425
|
// authentication staffSession required
|
|
5215
5426
|
// authentication adminAuth required
|
|
5216
5427
|
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5428
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5217
5429
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5218
5430
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5219
5431
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5432
|
+
localVarRequestOptions.data = serializeDataIfNeeded(domainLimitOverrideClearInputDTO, localVarRequestOptions, configuration);
|
|
5220
5433
|
return {
|
|
5221
5434
|
url: toPathString(localVarUrlObj),
|
|
5222
5435
|
options: localVarRequestOptions,
|
|
5223
5436
|
};
|
|
5224
5437
|
},
|
|
5225
|
-
};
|
|
5226
|
-
};
|
|
5227
|
-
/**
|
|
5228
|
-
* StaffMeApi - functional programming interface
|
|
5229
|
-
* @export
|
|
5230
|
-
*/
|
|
5231
|
-
export const StaffMeApiFp = function (configuration) {
|
|
5232
|
-
const localVarAxiosParamCreator = StaffMeApiAxiosParamCreator(configuration);
|
|
5233
|
-
return {
|
|
5234
|
-
/**
|
|
5235
|
-
* The signed-in Takaro Staff member and their tier (ADR 0026). Deliberately nothing else: no domains, no permissions, and never a token.<br> OperationId: `StaffMeControllerMe`
|
|
5236
|
-
* @summary Who this Staff session belongs to
|
|
5237
|
-
* @param {*} [options] Override http request option.
|
|
5238
|
-
* @throws {RequiredError}
|
|
5239
|
-
*/
|
|
5240
|
-
async staffMeControllerMe(options) {
|
|
5241
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.staffMeControllerMe(options);
|
|
5242
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5243
|
-
const localVarOperationServerBasePath = operationServerMap['StaffMeApi.staffMeControllerMe']?.[localVarOperationServerIndex]?.url;
|
|
5244
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5245
|
-
},
|
|
5246
|
-
};
|
|
5247
|
-
};
|
|
5248
|
-
/**
|
|
5249
|
-
* StaffMeApi - factory interface
|
|
5250
|
-
* @export
|
|
5251
|
-
*/
|
|
5252
|
-
export const StaffMeApiFactory = function (configuration, basePath, axios) {
|
|
5253
|
-
const localVarFp = StaffMeApiFp(configuration);
|
|
5254
|
-
return {
|
|
5255
5438
|
/**
|
|
5256
|
-
*
|
|
5257
|
-
* @summary
|
|
5439
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5440
|
+
* @summary Effective limits of a Domain
|
|
5441
|
+
* @param {string} id
|
|
5258
5442
|
* @param {*} [options] Override http request option.
|
|
5259
5443
|
* @throws {RequiredError}
|
|
5260
5444
|
*/
|
|
5261
|
-
|
|
5262
|
-
|
|
5445
|
+
staffDomainLimitsControllerGet: async (id, options = {}) => {
|
|
5446
|
+
// verify required parameter 'id' is not null or undefined
|
|
5447
|
+
assertParamExists('staffDomainLimitsControllerGet', 'id', id);
|
|
5448
|
+
const localVarPath = `/staff/domains/{id}/limits`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5449
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5450
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5451
|
+
let baseOptions;
|
|
5452
|
+
if (configuration) {
|
|
5453
|
+
baseOptions = configuration.baseOptions;
|
|
5454
|
+
}
|
|
5455
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5456
|
+
const localVarHeaderParameter = {};
|
|
5457
|
+
const localVarQueryParameter = {};
|
|
5458
|
+
// authentication staffSession required
|
|
5459
|
+
// authentication adminAuth required
|
|
5460
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5461
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5462
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5463
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5464
|
+
return {
|
|
5465
|
+
url: toPathString(localVarUrlObj),
|
|
5466
|
+
options: localVarRequestOptions,
|
|
5467
|
+
};
|
|
5263
5468
|
},
|
|
5264
|
-
};
|
|
5265
|
-
};
|
|
5266
|
-
/**
|
|
5267
|
-
* StaffMeApi - object-oriented interface
|
|
5268
|
-
* @export
|
|
5269
|
-
* @class StaffMeApi
|
|
5270
|
-
* @extends {BaseAPI}
|
|
5271
|
-
*/
|
|
5272
|
-
export class StaffMeApi extends BaseAPI {
|
|
5273
|
-
/**
|
|
5274
|
-
* The signed-in Takaro Staff member and their tier (ADR 0026). Deliberately nothing else: no domains, no permissions, and never a token.<br> OperationId: `StaffMeControllerMe`
|
|
5275
|
-
* @summary Who this Staff session belongs to
|
|
5276
|
-
* @param {*} [options] Override http request option.
|
|
5277
|
-
* @throws {RequiredError}
|
|
5278
|
-
* @memberof StaffMeApi
|
|
5279
|
-
*/
|
|
5280
|
-
staffMeControllerMe(options) {
|
|
5281
|
-
return StaffMeApiFp(this.configuration)
|
|
5282
|
-
.staffMeControllerMe(options)
|
|
5283
|
-
.then((request) => request(this.axios, this.basePath));
|
|
5284
|
-
}
|
|
5285
|
-
}
|
|
5286
|
-
/**
|
|
5287
|
-
* StaffPlanApi - axios parameter creator
|
|
5288
|
-
* @export
|
|
5289
|
-
*/
|
|
5290
|
-
export const StaffPlanApiAxiosParamCreator = function (configuration) {
|
|
5291
|
-
return {
|
|
5292
5469
|
/**
|
|
5293
|
-
*
|
|
5294
|
-
* @summary
|
|
5470
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5471
|
+
* @summary Limit override history of a Domain
|
|
5472
|
+
* @param {string} id
|
|
5295
5473
|
* @param {*} [options] Override http request option.
|
|
5296
5474
|
* @throws {RequiredError}
|
|
5297
5475
|
*/
|
|
5298
|
-
|
|
5299
|
-
|
|
5476
|
+
staffDomainLimitsControllerHistory: async (id, options = {}) => {
|
|
5477
|
+
// verify required parameter 'id' is not null or undefined
|
|
5478
|
+
assertParamExists('staffDomainLimitsControllerHistory', 'id', id);
|
|
5479
|
+
const localVarPath = `/staff/domains/{id}/limits/history`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5300
5480
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5301
5481
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5302
5482
|
let baseOptions;
|
|
@@ -5317,26 +5497,747 @@ export const StaffPlanApiAxiosParamCreator = function (configuration) {
|
|
|
5317
5497
|
options: localVarRequestOptions,
|
|
5318
5498
|
};
|
|
5319
5499
|
},
|
|
5320
|
-
};
|
|
5321
|
-
};
|
|
5322
|
-
/**
|
|
5323
|
-
* StaffPlanApi - functional programming interface
|
|
5324
|
-
* @export
|
|
5325
|
-
*/
|
|
5326
|
-
export const StaffPlanApiFp = function (configuration) {
|
|
5327
|
-
const localVarAxiosParamCreator = StaffPlanApiAxiosParamCreator(configuration);
|
|
5328
|
-
return {
|
|
5329
5500
|
/**
|
|
5330
|
-
*
|
|
5331
|
-
* @summary
|
|
5501
|
+
* Applies at once and survives Plan changes, until it expires or is cleared. Only for a Domain on a Plan. Shrinking `maxGameservers` disables the newest excess servers. An expired override reads as the Plan value at once, but the enforced limit follows at the next hourly sweep, so up to an hour later.<br> OperationId: `StaffDomainLimitsControllerSet`
|
|
5502
|
+
* @summary Override one limit of a Domain
|
|
5503
|
+
* @param {string} id
|
|
5504
|
+
* @param {string} limitKey
|
|
5505
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5332
5506
|
* @param {*} [options] Override http request option.
|
|
5333
5507
|
* @throws {RequiredError}
|
|
5334
5508
|
*/
|
|
5335
|
-
async
|
|
5336
|
-
|
|
5337
|
-
|
|
5338
|
-
|
|
5339
|
-
|
|
5509
|
+
staffDomainLimitsControllerSet: async (id, limitKey, domainLimitOverrideInputDTO, options = {}) => {
|
|
5510
|
+
// verify required parameter 'id' is not null or undefined
|
|
5511
|
+
assertParamExists('staffDomainLimitsControllerSet', 'id', id);
|
|
5512
|
+
// verify required parameter 'limitKey' is not null or undefined
|
|
5513
|
+
assertParamExists('staffDomainLimitsControllerSet', 'limitKey', limitKey);
|
|
5514
|
+
const localVarPath = `/staff/domains/{id}/limits/{limitKey}`
|
|
5515
|
+
.replace(`{${'id'}}`, encodeURIComponent(String(id)))
|
|
5516
|
+
.replace(`{${'limitKey'}}`, encodeURIComponent(String(limitKey)));
|
|
5517
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5518
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5519
|
+
let baseOptions;
|
|
5520
|
+
if (configuration) {
|
|
5521
|
+
baseOptions = configuration.baseOptions;
|
|
5522
|
+
}
|
|
5523
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
5524
|
+
const localVarHeaderParameter = {};
|
|
5525
|
+
const localVarQueryParameter = {};
|
|
5526
|
+
// authentication staffSession required
|
|
5527
|
+
// authentication adminAuth required
|
|
5528
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5529
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5530
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5531
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5532
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5533
|
+
localVarRequestOptions.data = serializeDataIfNeeded(domainLimitOverrideInputDTO, localVarRequestOptions, configuration);
|
|
5534
|
+
return {
|
|
5535
|
+
url: toPathString(localVarUrlObj),
|
|
5536
|
+
options: localVarRequestOptions,
|
|
5537
|
+
};
|
|
5538
|
+
},
|
|
5539
|
+
};
|
|
5540
|
+
};
|
|
5541
|
+
/**
|
|
5542
|
+
* StaffDomainLimitsApi - functional programming interface
|
|
5543
|
+
* @export
|
|
5544
|
+
*/
|
|
5545
|
+
export const StaffDomainLimitsApiFp = function (configuration) {
|
|
5546
|
+
const localVarAxiosParamCreator = StaffDomainLimitsApiAxiosParamCreator(configuration);
|
|
5547
|
+
return {
|
|
5548
|
+
/**
|
|
5549
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5550
|
+
* @summary Clear a limit override of a Domain
|
|
5551
|
+
* @param {string} id
|
|
5552
|
+
* @param {string} limitKey
|
|
5553
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5554
|
+
* @param {*} [options] Override http request option.
|
|
5555
|
+
* @throws {RequiredError}
|
|
5556
|
+
*/
|
|
5557
|
+
async staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options) {
|
|
5558
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options);
|
|
5559
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5560
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerClear']?.[localVarOperationServerIndex]
|
|
5561
|
+
?.url;
|
|
5562
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5563
|
+
},
|
|
5564
|
+
/**
|
|
5565
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5566
|
+
* @summary Effective limits of a Domain
|
|
5567
|
+
* @param {string} id
|
|
5568
|
+
* @param {*} [options] Override http request option.
|
|
5569
|
+
* @throws {RequiredError}
|
|
5570
|
+
*/
|
|
5571
|
+
async staffDomainLimitsControllerGet(id, options) {
|
|
5572
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerGet(id, options);
|
|
5573
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5574
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerGet']?.[localVarOperationServerIndex]?.url;
|
|
5575
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5576
|
+
},
|
|
5577
|
+
/**
|
|
5578
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5579
|
+
* @summary Limit override history of a Domain
|
|
5580
|
+
* @param {string} id
|
|
5581
|
+
* @param {*} [options] Override http request option.
|
|
5582
|
+
* @throws {RequiredError}
|
|
5583
|
+
*/
|
|
5584
|
+
async staffDomainLimitsControllerHistory(id, options) {
|
|
5585
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerHistory(id, options);
|
|
5586
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5587
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerHistory']?.[localVarOperationServerIndex]
|
|
5588
|
+
?.url;
|
|
5589
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5590
|
+
},
|
|
5591
|
+
/**
|
|
5592
|
+
* Applies at once and survives Plan changes, until it expires or is cleared. Only for a Domain on a Plan. Shrinking `maxGameservers` disables the newest excess servers. An expired override reads as the Plan value at once, but the enforced limit follows at the next hourly sweep, so up to an hour later.<br> OperationId: `StaffDomainLimitsControllerSet`
|
|
5593
|
+
* @summary Override one limit of a Domain
|
|
5594
|
+
* @param {string} id
|
|
5595
|
+
* @param {string} limitKey
|
|
5596
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5597
|
+
* @param {*} [options] Override http request option.
|
|
5598
|
+
* @throws {RequiredError}
|
|
5599
|
+
*/
|
|
5600
|
+
async staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options) {
|
|
5601
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options);
|
|
5602
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5603
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerSet']?.[localVarOperationServerIndex]?.url;
|
|
5604
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5605
|
+
},
|
|
5606
|
+
};
|
|
5607
|
+
};
|
|
5608
|
+
/**
|
|
5609
|
+
* StaffDomainLimitsApi - factory interface
|
|
5610
|
+
* @export
|
|
5611
|
+
*/
|
|
5612
|
+
export const StaffDomainLimitsApiFactory = function (configuration, basePath, axios) {
|
|
5613
|
+
const localVarFp = StaffDomainLimitsApiFp(configuration);
|
|
5614
|
+
return {
|
|
5615
|
+
/**
|
|
5616
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5617
|
+
* @summary Clear a limit override of a Domain
|
|
5618
|
+
* @param {string} id
|
|
5619
|
+
* @param {string} limitKey
|
|
5620
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5621
|
+
* @param {*} [options] Override http request option.
|
|
5622
|
+
* @throws {RequiredError}
|
|
5623
|
+
*/
|
|
5624
|
+
staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options) {
|
|
5625
|
+
return localVarFp
|
|
5626
|
+
.staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options)
|
|
5627
|
+
.then((request) => request(axios, basePath));
|
|
5628
|
+
},
|
|
5629
|
+
/**
|
|
5630
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5631
|
+
* @summary Effective limits of a Domain
|
|
5632
|
+
* @param {string} id
|
|
5633
|
+
* @param {*} [options] Override http request option.
|
|
5634
|
+
* @throws {RequiredError}
|
|
5635
|
+
*/
|
|
5636
|
+
staffDomainLimitsControllerGet(id, options) {
|
|
5637
|
+
return localVarFp.staffDomainLimitsControllerGet(id, options).then((request) => request(axios, basePath));
|
|
5638
|
+
},
|
|
5639
|
+
/**
|
|
5640
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5641
|
+
* @summary Limit override history of a Domain
|
|
5642
|
+
* @param {string} id
|
|
5643
|
+
* @param {*} [options] Override http request option.
|
|
5644
|
+
* @throws {RequiredError}
|
|
5645
|
+
*/
|
|
5646
|
+
staffDomainLimitsControllerHistory(id, options) {
|
|
5647
|
+
return localVarFp.staffDomainLimitsControllerHistory(id, options).then((request) => request(axios, basePath));
|
|
5648
|
+
},
|
|
5649
|
+
/**
|
|
5650
|
+
* Applies at once and survives Plan changes, until it expires or is cleared. Only for a Domain on a Plan. Shrinking `maxGameservers` disables the newest excess servers. An expired override reads as the Plan value at once, but the enforced limit follows at the next hourly sweep, so up to an hour later.<br> OperationId: `StaffDomainLimitsControllerSet`
|
|
5651
|
+
* @summary Override one limit of a Domain
|
|
5652
|
+
* @param {string} id
|
|
5653
|
+
* @param {string} limitKey
|
|
5654
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5655
|
+
* @param {*} [options] Override http request option.
|
|
5656
|
+
* @throws {RequiredError}
|
|
5657
|
+
*/
|
|
5658
|
+
staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options) {
|
|
5659
|
+
return localVarFp
|
|
5660
|
+
.staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options)
|
|
5661
|
+
.then((request) => request(axios, basePath));
|
|
5662
|
+
},
|
|
5663
|
+
};
|
|
5664
|
+
};
|
|
5665
|
+
/**
|
|
5666
|
+
* StaffDomainLimitsApi - object-oriented interface
|
|
5667
|
+
* @export
|
|
5668
|
+
* @class StaffDomainLimitsApi
|
|
5669
|
+
* @extends {BaseAPI}
|
|
5670
|
+
*/
|
|
5671
|
+
export class StaffDomainLimitsApi extends BaseAPI {
|
|
5672
|
+
/**
|
|
5673
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5674
|
+
* @summary Clear a limit override of a Domain
|
|
5675
|
+
* @param {string} id
|
|
5676
|
+
* @param {string} limitKey
|
|
5677
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5678
|
+
* @param {*} [options] Override http request option.
|
|
5679
|
+
* @throws {RequiredError}
|
|
5680
|
+
* @memberof StaffDomainLimitsApi
|
|
5681
|
+
*/
|
|
5682
|
+
staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options) {
|
|
5683
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5684
|
+
.staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options)
|
|
5685
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5686
|
+
}
|
|
5687
|
+
/**
|
|
5688
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5689
|
+
* @summary Effective limits of a Domain
|
|
5690
|
+
* @param {string} id
|
|
5691
|
+
* @param {*} [options] Override http request option.
|
|
5692
|
+
* @throws {RequiredError}
|
|
5693
|
+
* @memberof StaffDomainLimitsApi
|
|
5694
|
+
*/
|
|
5695
|
+
staffDomainLimitsControllerGet(id, options) {
|
|
5696
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5697
|
+
.staffDomainLimitsControllerGet(id, options)
|
|
5698
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5699
|
+
}
|
|
5700
|
+
/**
|
|
5701
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5702
|
+
* @summary Limit override history of a Domain
|
|
5703
|
+
* @param {string} id
|
|
5704
|
+
* @param {*} [options] Override http request option.
|
|
5705
|
+
* @throws {RequiredError}
|
|
5706
|
+
* @memberof StaffDomainLimitsApi
|
|
5707
|
+
*/
|
|
5708
|
+
staffDomainLimitsControllerHistory(id, options) {
|
|
5709
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5710
|
+
.staffDomainLimitsControllerHistory(id, options)
|
|
5711
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5712
|
+
}
|
|
5713
|
+
/**
|
|
5714
|
+
* Applies at once and survives Plan changes, until it expires or is cleared. Only for a Domain on a Plan. Shrinking `maxGameservers` disables the newest excess servers. An expired override reads as the Plan value at once, but the enforced limit follows at the next hourly sweep, so up to an hour later.<br> OperationId: `StaffDomainLimitsControllerSet`
|
|
5715
|
+
* @summary Override one limit of a Domain
|
|
5716
|
+
* @param {string} id
|
|
5717
|
+
* @param {string} limitKey
|
|
5718
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5719
|
+
* @param {*} [options] Override http request option.
|
|
5720
|
+
* @throws {RequiredError}
|
|
5721
|
+
* @memberof StaffDomainLimitsApi
|
|
5722
|
+
*/
|
|
5723
|
+
staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options) {
|
|
5724
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5725
|
+
.staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options)
|
|
5726
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5727
|
+
}
|
|
5728
|
+
}
|
|
5729
|
+
/**
|
|
5730
|
+
* StaffMeApi - axios parameter creator
|
|
5731
|
+
* @export
|
|
5732
|
+
*/
|
|
5733
|
+
export const StaffMeApiAxiosParamCreator = function (configuration) {
|
|
5734
|
+
return {
|
|
5735
|
+
/**
|
|
5736
|
+
* The signed-in Takaro Staff member and their tier (ADR 0026). Deliberately nothing else: no domains, no permissions, and never a token.<br> OperationId: `StaffMeControllerMe`
|
|
5737
|
+
* @summary Who this Staff session belongs to
|
|
5738
|
+
* @param {*} [options] Override http request option.
|
|
5739
|
+
* @throws {RequiredError}
|
|
5740
|
+
*/
|
|
5741
|
+
staffMeControllerMe: async (options = {}) => {
|
|
5742
|
+
const localVarPath = `/staff/me`;
|
|
5743
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5744
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5745
|
+
let baseOptions;
|
|
5746
|
+
if (configuration) {
|
|
5747
|
+
baseOptions = configuration.baseOptions;
|
|
5748
|
+
}
|
|
5749
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5750
|
+
const localVarHeaderParameter = {};
|
|
5751
|
+
const localVarQueryParameter = {};
|
|
5752
|
+
// authentication staffSession required
|
|
5753
|
+
// authentication adminAuth required
|
|
5754
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5755
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5756
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5757
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5758
|
+
return {
|
|
5759
|
+
url: toPathString(localVarUrlObj),
|
|
5760
|
+
options: localVarRequestOptions,
|
|
5761
|
+
};
|
|
5762
|
+
},
|
|
5763
|
+
};
|
|
5764
|
+
};
|
|
5765
|
+
/**
|
|
5766
|
+
* StaffMeApi - functional programming interface
|
|
5767
|
+
* @export
|
|
5768
|
+
*/
|
|
5769
|
+
export const StaffMeApiFp = function (configuration) {
|
|
5770
|
+
const localVarAxiosParamCreator = StaffMeApiAxiosParamCreator(configuration);
|
|
5771
|
+
return {
|
|
5772
|
+
/**
|
|
5773
|
+
* The signed-in Takaro Staff member and their tier (ADR 0026). Deliberately nothing else: no domains, no permissions, and never a token.<br> OperationId: `StaffMeControllerMe`
|
|
5774
|
+
* @summary Who this Staff session belongs to
|
|
5775
|
+
* @param {*} [options] Override http request option.
|
|
5776
|
+
* @throws {RequiredError}
|
|
5777
|
+
*/
|
|
5778
|
+
async staffMeControllerMe(options) {
|
|
5779
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffMeControllerMe(options);
|
|
5780
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5781
|
+
const localVarOperationServerBasePath = operationServerMap['StaffMeApi.staffMeControllerMe']?.[localVarOperationServerIndex]?.url;
|
|
5782
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5783
|
+
},
|
|
5784
|
+
};
|
|
5785
|
+
};
|
|
5786
|
+
/**
|
|
5787
|
+
* StaffMeApi - factory interface
|
|
5788
|
+
* @export
|
|
5789
|
+
*/
|
|
5790
|
+
export const StaffMeApiFactory = function (configuration, basePath, axios) {
|
|
5791
|
+
const localVarFp = StaffMeApiFp(configuration);
|
|
5792
|
+
return {
|
|
5793
|
+
/**
|
|
5794
|
+
* The signed-in Takaro Staff member and their tier (ADR 0026). Deliberately nothing else: no domains, no permissions, and never a token.<br> OperationId: `StaffMeControllerMe`
|
|
5795
|
+
* @summary Who this Staff session belongs to
|
|
5796
|
+
* @param {*} [options] Override http request option.
|
|
5797
|
+
* @throws {RequiredError}
|
|
5798
|
+
*/
|
|
5799
|
+
staffMeControllerMe(options) {
|
|
5800
|
+
return localVarFp.staffMeControllerMe(options).then((request) => request(axios, basePath));
|
|
5801
|
+
},
|
|
5802
|
+
};
|
|
5803
|
+
};
|
|
5804
|
+
/**
|
|
5805
|
+
* StaffMeApi - object-oriented interface
|
|
5806
|
+
* @export
|
|
5807
|
+
* @class StaffMeApi
|
|
5808
|
+
* @extends {BaseAPI}
|
|
5809
|
+
*/
|
|
5810
|
+
export class StaffMeApi extends BaseAPI {
|
|
5811
|
+
/**
|
|
5812
|
+
* The signed-in Takaro Staff member and their tier (ADR 0026). Deliberately nothing else: no domains, no permissions, and never a token.<br> OperationId: `StaffMeControllerMe`
|
|
5813
|
+
* @summary Who this Staff session belongs to
|
|
5814
|
+
* @param {*} [options] Override http request option.
|
|
5815
|
+
* @throws {RequiredError}
|
|
5816
|
+
* @memberof StaffMeApi
|
|
5817
|
+
*/
|
|
5818
|
+
staffMeControllerMe(options) {
|
|
5819
|
+
return StaffMeApiFp(this.configuration)
|
|
5820
|
+
.staffMeControllerMe(options)
|
|
5821
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5822
|
+
}
|
|
5823
|
+
}
|
|
5824
|
+
/**
|
|
5825
|
+
* StaffPlanApi - axios parameter creator
|
|
5826
|
+
* @export
|
|
5827
|
+
*/
|
|
5828
|
+
export const StaffPlanApiAxiosParamCreator = function (configuration) {
|
|
5829
|
+
return {
|
|
5830
|
+
/**
|
|
5831
|
+
* Refused while any Domain is on the Plan or any Distributor allows it. Frees its billing-provider product for another Plan; the history keeps the old link. Idempotent.<br> OperationId: `StaffPlanControllerArchive`
|
|
5832
|
+
* @summary Archive a Plan
|
|
5833
|
+
* @param {string} id
|
|
5834
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
5835
|
+
* @param {*} [options] Override http request option.
|
|
5836
|
+
* @throws {RequiredError}
|
|
5837
|
+
*/
|
|
5838
|
+
staffPlanControllerArchive: async (id, planArchiveInputDTO, options = {}) => {
|
|
5839
|
+
// verify required parameter 'id' is not null or undefined
|
|
5840
|
+
assertParamExists('staffPlanControllerArchive', 'id', id);
|
|
5841
|
+
const localVarPath = `/staff/plans/{id}/archive`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5842
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5843
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5844
|
+
let baseOptions;
|
|
5845
|
+
if (configuration) {
|
|
5846
|
+
baseOptions = configuration.baseOptions;
|
|
5847
|
+
}
|
|
5848
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5849
|
+
const localVarHeaderParameter = {};
|
|
5850
|
+
const localVarQueryParameter = {};
|
|
5851
|
+
// authentication staffSession required
|
|
5852
|
+
// authentication adminAuth required
|
|
5853
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5854
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5855
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5856
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5857
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5858
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planArchiveInputDTO, localVarRequestOptions, configuration);
|
|
5859
|
+
return {
|
|
5860
|
+
url: toPathString(localVarUrlObj),
|
|
5861
|
+
options: localVarRequestOptions,
|
|
5862
|
+
};
|
|
5863
|
+
},
|
|
5864
|
+
/**
|
|
5865
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
5866
|
+
* @summary Create a Plan
|
|
5867
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
5868
|
+
* @param {*} [options] Override http request option.
|
|
5869
|
+
* @throws {RequiredError}
|
|
5870
|
+
*/
|
|
5871
|
+
staffPlanControllerCreate: async (planCreateInputDTO, options = {}) => {
|
|
5872
|
+
const localVarPath = `/staff/plans`;
|
|
5873
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5874
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5875
|
+
let baseOptions;
|
|
5876
|
+
if (configuration) {
|
|
5877
|
+
baseOptions = configuration.baseOptions;
|
|
5878
|
+
}
|
|
5879
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5880
|
+
const localVarHeaderParameter = {};
|
|
5881
|
+
const localVarQueryParameter = {};
|
|
5882
|
+
// authentication staffSession required
|
|
5883
|
+
// authentication adminAuth required
|
|
5884
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5885
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5886
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5887
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5888
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5889
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planCreateInputDTO, localVarRequestOptions, configuration);
|
|
5890
|
+
return {
|
|
5891
|
+
url: toPathString(localVarUrlObj),
|
|
5892
|
+
options: localVarRequestOptions,
|
|
5893
|
+
};
|
|
5894
|
+
},
|
|
5895
|
+
/**
|
|
5896
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
5897
|
+
* @summary Change history of a Plan
|
|
5898
|
+
* @param {string} id
|
|
5899
|
+
* @param {*} [options] Override http request option.
|
|
5900
|
+
* @throws {RequiredError}
|
|
5901
|
+
*/
|
|
5902
|
+
staffPlanControllerHistory: async (id, options = {}) => {
|
|
5903
|
+
// verify required parameter 'id' is not null or undefined
|
|
5904
|
+
assertParamExists('staffPlanControllerHistory', 'id', id);
|
|
5905
|
+
const localVarPath = `/staff/plans/{id}/history`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5906
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5907
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5908
|
+
let baseOptions;
|
|
5909
|
+
if (configuration) {
|
|
5910
|
+
baseOptions = configuration.baseOptions;
|
|
5911
|
+
}
|
|
5912
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5913
|
+
const localVarHeaderParameter = {};
|
|
5914
|
+
const localVarQueryParameter = {};
|
|
5915
|
+
// authentication staffSession required
|
|
5916
|
+
// authentication adminAuth required
|
|
5917
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5918
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5919
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5920
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5921
|
+
return {
|
|
5922
|
+
url: toPathString(localVarUrlObj),
|
|
5923
|
+
options: localVarRequestOptions,
|
|
5924
|
+
};
|
|
5925
|
+
},
|
|
5926
|
+
/**
|
|
5927
|
+
* Creates a Plan per billing-provider product in one transaction; a no-op once any import was recorded. Domains and Distributors still on a legacy product id move to its Plan, and a Domain that predates Plans keeps its hand-set limits as overrides. A product already linked to a Plan maps to that Plan instead.<br> OperationId: `StaffPlanControllerImport`
|
|
5928
|
+
* @summary Import Plans from the billing provider
|
|
5929
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
5930
|
+
* @param {*} [options] Override http request option.
|
|
5931
|
+
* @throws {RequiredError}
|
|
5932
|
+
*/
|
|
5933
|
+
staffPlanControllerImport: async (planImportInputDTO, options = {}) => {
|
|
5934
|
+
const localVarPath = `/staff/plans/import`;
|
|
5935
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5936
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5937
|
+
let baseOptions;
|
|
5938
|
+
if (configuration) {
|
|
5939
|
+
baseOptions = configuration.baseOptions;
|
|
5940
|
+
}
|
|
5941
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5942
|
+
const localVarHeaderParameter = {};
|
|
5943
|
+
const localVarQueryParameter = {};
|
|
5944
|
+
// authentication staffSession required
|
|
5945
|
+
// authentication adminAuth required
|
|
5946
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5947
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5948
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5949
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5950
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5951
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planImportInputDTO, localVarRequestOptions, configuration);
|
|
5952
|
+
return {
|
|
5953
|
+
url: toPathString(localVarUrlObj),
|
|
5954
|
+
options: localVarRequestOptions,
|
|
5955
|
+
};
|
|
5956
|
+
},
|
|
5957
|
+
/**
|
|
5958
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
5959
|
+
* @summary Whether the billing-provider import ran
|
|
5960
|
+
* @param {*} [options] Override http request option.
|
|
5961
|
+
* @throws {RequiredError}
|
|
5962
|
+
*/
|
|
5963
|
+
staffPlanControllerImportStatus: async (options = {}) => {
|
|
5964
|
+
const localVarPath = `/staff/plans/import`;
|
|
5965
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5966
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5967
|
+
let baseOptions;
|
|
5968
|
+
if (configuration) {
|
|
5969
|
+
baseOptions = configuration.baseOptions;
|
|
5970
|
+
}
|
|
5971
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5972
|
+
const localVarHeaderParameter = {};
|
|
5973
|
+
const localVarQueryParameter = {};
|
|
5974
|
+
// authentication staffSession required
|
|
5975
|
+
// authentication adminAuth required
|
|
5976
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5977
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5978
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5979
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5980
|
+
return {
|
|
5981
|
+
url: toPathString(localVarUrlObj),
|
|
5982
|
+
options: localVarRequestOptions,
|
|
5983
|
+
};
|
|
5984
|
+
},
|
|
5985
|
+
/**
|
|
5986
|
+
* Every Takaro Plan, oldest first. Archived Plans only with `includeArchived=true`. The ids here are what a Distributor’s allowedPlans and a Domain’s planId hold.<br> OperationId: `StaffPlanControllerList`
|
|
5987
|
+
* @summary List Plans
|
|
5988
|
+
* @param {any} [includeArchived]
|
|
5989
|
+
* @param {*} [options] Override http request option.
|
|
5990
|
+
* @throws {RequiredError}
|
|
5991
|
+
*/
|
|
5992
|
+
staffPlanControllerList: async (includeArchived, options = {}) => {
|
|
5993
|
+
const localVarPath = `/staff/plans`;
|
|
5994
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5995
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5996
|
+
let baseOptions;
|
|
5997
|
+
if (configuration) {
|
|
5998
|
+
baseOptions = configuration.baseOptions;
|
|
5999
|
+
}
|
|
6000
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
6001
|
+
const localVarHeaderParameter = {};
|
|
6002
|
+
const localVarQueryParameter = {};
|
|
6003
|
+
// authentication staffSession required
|
|
6004
|
+
// authentication adminAuth required
|
|
6005
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
6006
|
+
if (includeArchived !== undefined) {
|
|
6007
|
+
for (const [key, value] of Object.entries(includeArchived)) {
|
|
6008
|
+
localVarQueryParameter[key] = value;
|
|
6009
|
+
}
|
|
6010
|
+
}
|
|
6011
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6012
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6013
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6014
|
+
return {
|
|
6015
|
+
url: toPathString(localVarUrlObj),
|
|
6016
|
+
options: localVarRequestOptions,
|
|
6017
|
+
};
|
|
6018
|
+
},
|
|
6019
|
+
/**
|
|
6020
|
+
* Every product the billing provider knows about, with its prices, unfiltered by storefront lookup keys. A Plan’s stripeProductId is one of these ids.<br> OperationId: `StaffPlanControllerListStripeProducts`
|
|
6021
|
+
* @summary The billing provider’s products
|
|
6022
|
+
* @param {*} [options] Override http request option.
|
|
6023
|
+
* @throws {RequiredError}
|
|
6024
|
+
*/
|
|
6025
|
+
staffPlanControllerListStripeProducts: async (options = {}) => {
|
|
6026
|
+
const localVarPath = `/staff/stripe-products`;
|
|
6027
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6028
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6029
|
+
let baseOptions;
|
|
6030
|
+
if (configuration) {
|
|
6031
|
+
baseOptions = configuration.baseOptions;
|
|
6032
|
+
}
|
|
6033
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
6034
|
+
const localVarHeaderParameter = {};
|
|
6035
|
+
const localVarQueryParameter = {};
|
|
6036
|
+
// authentication staffSession required
|
|
6037
|
+
// authentication adminAuth required
|
|
6038
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
6039
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6040
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6041
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6042
|
+
return {
|
|
6043
|
+
url: toPathString(localVarUrlObj),
|
|
6044
|
+
options: localVarRequestOptions,
|
|
6045
|
+
};
|
|
6046
|
+
},
|
|
6047
|
+
/**
|
|
6048
|
+
* A dry run of the proposed limits: how many Domains change, how many game servers would be disabled, and how many Domains would be over their user or role limits. Overrides are taken into account.<br> OperationId: `StaffPlanControllerPreview`
|
|
6049
|
+
* @summary Preview a Plan edit
|
|
6050
|
+
* @param {string} id
|
|
6051
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
6052
|
+
* @param {*} [options] Override http request option.
|
|
6053
|
+
* @throws {RequiredError}
|
|
6054
|
+
*/
|
|
6055
|
+
staffPlanControllerPreview: async (id, planPreviewInputDTO, options = {}) => {
|
|
6056
|
+
// verify required parameter 'id' is not null or undefined
|
|
6057
|
+
assertParamExists('staffPlanControllerPreview', 'id', id);
|
|
6058
|
+
const localVarPath = `/staff/plans/{id}/preview`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
6059
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6060
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6061
|
+
let baseOptions;
|
|
6062
|
+
if (configuration) {
|
|
6063
|
+
baseOptions = configuration.baseOptions;
|
|
6064
|
+
}
|
|
6065
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
6066
|
+
const localVarHeaderParameter = {};
|
|
6067
|
+
const localVarQueryParameter = {};
|
|
6068
|
+
// authentication staffSession required
|
|
6069
|
+
// authentication adminAuth required
|
|
6070
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
6071
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6072
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6073
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6074
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6075
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planPreviewInputDTO, localVarRequestOptions, configuration);
|
|
6076
|
+
return {
|
|
6077
|
+
url: toPathString(localVarUrlObj),
|
|
6078
|
+
options: localVarRequestOptions,
|
|
6079
|
+
};
|
|
6080
|
+
},
|
|
6081
|
+
/**
|
|
6082
|
+
* Changed limits reach every Domain on the Plan shortly after, through a queued job. A shrink of `maxGameservers` disables the newest excess servers; preview it first. Changing or removing the billing-provider product is refused with a 409 while a subscription-backed Domain is on the Plan.<br> OperationId: `StaffPlanControllerUpdate`
|
|
6083
|
+
* @summary Update a Plan
|
|
6084
|
+
* @param {string} id
|
|
6085
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
6086
|
+
* @param {*} [options] Override http request option.
|
|
6087
|
+
* @throws {RequiredError}
|
|
6088
|
+
*/
|
|
6089
|
+
staffPlanControllerUpdate: async (id, planUpdateInputDTO, options = {}) => {
|
|
6090
|
+
// verify required parameter 'id' is not null or undefined
|
|
6091
|
+
assertParamExists('staffPlanControllerUpdate', 'id', id);
|
|
6092
|
+
const localVarPath = `/staff/plans/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
6093
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6094
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6095
|
+
let baseOptions;
|
|
6096
|
+
if (configuration) {
|
|
6097
|
+
baseOptions = configuration.baseOptions;
|
|
6098
|
+
}
|
|
6099
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
6100
|
+
const localVarHeaderParameter = {};
|
|
6101
|
+
const localVarQueryParameter = {};
|
|
6102
|
+
// authentication staffSession required
|
|
6103
|
+
// authentication adminAuth required
|
|
6104
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
6105
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6106
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6107
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6108
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6109
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planUpdateInputDTO, localVarRequestOptions, configuration);
|
|
6110
|
+
return {
|
|
6111
|
+
url: toPathString(localVarUrlObj),
|
|
6112
|
+
options: localVarRequestOptions,
|
|
6113
|
+
};
|
|
6114
|
+
},
|
|
6115
|
+
};
|
|
6116
|
+
};
|
|
6117
|
+
/**
|
|
6118
|
+
* StaffPlanApi - functional programming interface
|
|
6119
|
+
* @export
|
|
6120
|
+
*/
|
|
6121
|
+
export const StaffPlanApiFp = function (configuration) {
|
|
6122
|
+
const localVarAxiosParamCreator = StaffPlanApiAxiosParamCreator(configuration);
|
|
6123
|
+
return {
|
|
6124
|
+
/**
|
|
6125
|
+
* Refused while any Domain is on the Plan or any Distributor allows it. Frees its billing-provider product for another Plan; the history keeps the old link. Idempotent.<br> OperationId: `StaffPlanControllerArchive`
|
|
6126
|
+
* @summary Archive a Plan
|
|
6127
|
+
* @param {string} id
|
|
6128
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
6129
|
+
* @param {*} [options] Override http request option.
|
|
6130
|
+
* @throws {RequiredError}
|
|
6131
|
+
*/
|
|
6132
|
+
async staffPlanControllerArchive(id, planArchiveInputDTO, options) {
|
|
6133
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerArchive(id, planArchiveInputDTO, options);
|
|
6134
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6135
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerArchive']?.[localVarOperationServerIndex]?.url;
|
|
6136
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6137
|
+
},
|
|
6138
|
+
/**
|
|
6139
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
6140
|
+
* @summary Create a Plan
|
|
6141
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
6142
|
+
* @param {*} [options] Override http request option.
|
|
6143
|
+
* @throws {RequiredError}
|
|
6144
|
+
*/
|
|
6145
|
+
async staffPlanControllerCreate(planCreateInputDTO, options) {
|
|
6146
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerCreate(planCreateInputDTO, options);
|
|
6147
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6148
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerCreate']?.[localVarOperationServerIndex]?.url;
|
|
6149
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6150
|
+
},
|
|
6151
|
+
/**
|
|
6152
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
6153
|
+
* @summary Change history of a Plan
|
|
6154
|
+
* @param {string} id
|
|
6155
|
+
* @param {*} [options] Override http request option.
|
|
6156
|
+
* @throws {RequiredError}
|
|
6157
|
+
*/
|
|
6158
|
+
async staffPlanControllerHistory(id, options) {
|
|
6159
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerHistory(id, options);
|
|
6160
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6161
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerHistory']?.[localVarOperationServerIndex]?.url;
|
|
6162
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6163
|
+
},
|
|
6164
|
+
/**
|
|
6165
|
+
* Creates a Plan per billing-provider product in one transaction; a no-op once any import was recorded. Domains and Distributors still on a legacy product id move to its Plan, and a Domain that predates Plans keeps its hand-set limits as overrides. A product already linked to a Plan maps to that Plan instead.<br> OperationId: `StaffPlanControllerImport`
|
|
6166
|
+
* @summary Import Plans from the billing provider
|
|
6167
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
6168
|
+
* @param {*} [options] Override http request option.
|
|
6169
|
+
* @throws {RequiredError}
|
|
6170
|
+
*/
|
|
6171
|
+
async staffPlanControllerImport(planImportInputDTO, options) {
|
|
6172
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerImport(planImportInputDTO, options);
|
|
6173
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6174
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerImport']?.[localVarOperationServerIndex]?.url;
|
|
6175
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6176
|
+
},
|
|
6177
|
+
/**
|
|
6178
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
6179
|
+
* @summary Whether the billing-provider import ran
|
|
6180
|
+
* @param {*} [options] Override http request option.
|
|
6181
|
+
* @throws {RequiredError}
|
|
6182
|
+
*/
|
|
6183
|
+
async staffPlanControllerImportStatus(options) {
|
|
6184
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerImportStatus(options);
|
|
6185
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6186
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerImportStatus']?.[localVarOperationServerIndex]?.url;
|
|
6187
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6188
|
+
},
|
|
6189
|
+
/**
|
|
6190
|
+
* Every Takaro Plan, oldest first. Archived Plans only with `includeArchived=true`. The ids here are what a Distributor’s allowedPlans and a Domain’s planId hold.<br> OperationId: `StaffPlanControllerList`
|
|
6191
|
+
* @summary List Plans
|
|
6192
|
+
* @param {any} [includeArchived]
|
|
6193
|
+
* @param {*} [options] Override http request option.
|
|
6194
|
+
* @throws {RequiredError}
|
|
6195
|
+
*/
|
|
6196
|
+
async staffPlanControllerList(includeArchived, options) {
|
|
6197
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerList(includeArchived, options);
|
|
6198
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6199
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerList']?.[localVarOperationServerIndex]?.url;
|
|
6200
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6201
|
+
},
|
|
6202
|
+
/**
|
|
6203
|
+
* Every product the billing provider knows about, with its prices, unfiltered by storefront lookup keys. A Plan’s stripeProductId is one of these ids.<br> OperationId: `StaffPlanControllerListStripeProducts`
|
|
6204
|
+
* @summary The billing provider’s products
|
|
6205
|
+
* @param {*} [options] Override http request option.
|
|
6206
|
+
* @throws {RequiredError}
|
|
6207
|
+
*/
|
|
6208
|
+
async staffPlanControllerListStripeProducts(options) {
|
|
6209
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerListStripeProducts(options);
|
|
6210
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6211
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerListStripeProducts']?.[localVarOperationServerIndex]?.url;
|
|
6212
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6213
|
+
},
|
|
6214
|
+
/**
|
|
6215
|
+
* A dry run of the proposed limits: how many Domains change, how many game servers would be disabled, and how many Domains would be over their user or role limits. Overrides are taken into account.<br> OperationId: `StaffPlanControllerPreview`
|
|
6216
|
+
* @summary Preview a Plan edit
|
|
6217
|
+
* @param {string} id
|
|
6218
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
6219
|
+
* @param {*} [options] Override http request option.
|
|
6220
|
+
* @throws {RequiredError}
|
|
6221
|
+
*/
|
|
6222
|
+
async staffPlanControllerPreview(id, planPreviewInputDTO, options) {
|
|
6223
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerPreview(id, planPreviewInputDTO, options);
|
|
6224
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6225
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerPreview']?.[localVarOperationServerIndex]?.url;
|
|
6226
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6227
|
+
},
|
|
6228
|
+
/**
|
|
6229
|
+
* Changed limits reach every Domain on the Plan shortly after, through a queued job. A shrink of `maxGameservers` disables the newest excess servers; preview it first. Changing or removing the billing-provider product is refused with a 409 while a subscription-backed Domain is on the Plan.<br> OperationId: `StaffPlanControllerUpdate`
|
|
6230
|
+
* @summary Update a Plan
|
|
6231
|
+
* @param {string} id
|
|
6232
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
6233
|
+
* @param {*} [options] Override http request option.
|
|
6234
|
+
* @throws {RequiredError}
|
|
6235
|
+
*/
|
|
6236
|
+
async staffPlanControllerUpdate(id, planUpdateInputDTO, options) {
|
|
6237
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerUpdate(id, planUpdateInputDTO, options);
|
|
6238
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6239
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerUpdate']?.[localVarOperationServerIndex]?.url;
|
|
6240
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5340
6241
|
},
|
|
5341
6242
|
};
|
|
5342
6243
|
};
|
|
@@ -5348,13 +6249,105 @@ export const StaffPlanApiFactory = function (configuration, basePath, axios) {
|
|
|
5348
6249
|
const localVarFp = StaffPlanApiFp(configuration);
|
|
5349
6250
|
return {
|
|
5350
6251
|
/**
|
|
5351
|
-
*
|
|
5352
|
-
* @summary
|
|
6252
|
+
* Refused while any Domain is on the Plan or any Distributor allows it. Frees its billing-provider product for another Plan; the history keeps the old link. Idempotent.<br> OperationId: `StaffPlanControllerArchive`
|
|
6253
|
+
* @summary Archive a Plan
|
|
6254
|
+
* @param {string} id
|
|
6255
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
6256
|
+
* @param {*} [options] Override http request option.
|
|
6257
|
+
* @throws {RequiredError}
|
|
6258
|
+
*/
|
|
6259
|
+
staffPlanControllerArchive(id, planArchiveInputDTO, options) {
|
|
6260
|
+
return localVarFp
|
|
6261
|
+
.staffPlanControllerArchive(id, planArchiveInputDTO, options)
|
|
6262
|
+
.then((request) => request(axios, basePath));
|
|
6263
|
+
},
|
|
6264
|
+
/**
|
|
6265
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
6266
|
+
* @summary Create a Plan
|
|
6267
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
6268
|
+
* @param {*} [options] Override http request option.
|
|
6269
|
+
* @throws {RequiredError}
|
|
6270
|
+
*/
|
|
6271
|
+
staffPlanControllerCreate(planCreateInputDTO, options) {
|
|
6272
|
+
return localVarFp
|
|
6273
|
+
.staffPlanControllerCreate(planCreateInputDTO, options)
|
|
6274
|
+
.then((request) => request(axios, basePath));
|
|
6275
|
+
},
|
|
6276
|
+
/**
|
|
6277
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
6278
|
+
* @summary Change history of a Plan
|
|
6279
|
+
* @param {string} id
|
|
6280
|
+
* @param {*} [options] Override http request option.
|
|
6281
|
+
* @throws {RequiredError}
|
|
6282
|
+
*/
|
|
6283
|
+
staffPlanControllerHistory(id, options) {
|
|
6284
|
+
return localVarFp.staffPlanControllerHistory(id, options).then((request) => request(axios, basePath));
|
|
6285
|
+
},
|
|
6286
|
+
/**
|
|
6287
|
+
* Creates a Plan per billing-provider product in one transaction; a no-op once any import was recorded. Domains and Distributors still on a legacy product id move to its Plan, and a Domain that predates Plans keeps its hand-set limits as overrides. A product already linked to a Plan maps to that Plan instead.<br> OperationId: `StaffPlanControllerImport`
|
|
6288
|
+
* @summary Import Plans from the billing provider
|
|
6289
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
6290
|
+
* @param {*} [options] Override http request option.
|
|
6291
|
+
* @throws {RequiredError}
|
|
6292
|
+
*/
|
|
6293
|
+
staffPlanControllerImport(planImportInputDTO, options) {
|
|
6294
|
+
return localVarFp
|
|
6295
|
+
.staffPlanControllerImport(planImportInputDTO, options)
|
|
6296
|
+
.then((request) => request(axios, basePath));
|
|
6297
|
+
},
|
|
6298
|
+
/**
|
|
6299
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
6300
|
+
* @summary Whether the billing-provider import ran
|
|
6301
|
+
* @param {*} [options] Override http request option.
|
|
6302
|
+
* @throws {RequiredError}
|
|
6303
|
+
*/
|
|
6304
|
+
staffPlanControllerImportStatus(options) {
|
|
6305
|
+
return localVarFp.staffPlanControllerImportStatus(options).then((request) => request(axios, basePath));
|
|
6306
|
+
},
|
|
6307
|
+
/**
|
|
6308
|
+
* Every Takaro Plan, oldest first. Archived Plans only with `includeArchived=true`. The ids here are what a Distributor’s allowedPlans and a Domain’s planId hold.<br> OperationId: `StaffPlanControllerList`
|
|
6309
|
+
* @summary List Plans
|
|
6310
|
+
* @param {any} [includeArchived]
|
|
6311
|
+
* @param {*} [options] Override http request option.
|
|
6312
|
+
* @throws {RequiredError}
|
|
6313
|
+
*/
|
|
6314
|
+
staffPlanControllerList(includeArchived, options) {
|
|
6315
|
+
return localVarFp.staffPlanControllerList(includeArchived, options).then((request) => request(axios, basePath));
|
|
6316
|
+
},
|
|
6317
|
+
/**
|
|
6318
|
+
* Every product the billing provider knows about, with its prices, unfiltered by storefront lookup keys. A Plan’s stripeProductId is one of these ids.<br> OperationId: `StaffPlanControllerListStripeProducts`
|
|
6319
|
+
* @summary The billing provider’s products
|
|
6320
|
+
* @param {*} [options] Override http request option.
|
|
6321
|
+
* @throws {RequiredError}
|
|
6322
|
+
*/
|
|
6323
|
+
staffPlanControllerListStripeProducts(options) {
|
|
6324
|
+
return localVarFp.staffPlanControllerListStripeProducts(options).then((request) => request(axios, basePath));
|
|
6325
|
+
},
|
|
6326
|
+
/**
|
|
6327
|
+
* A dry run of the proposed limits: how many Domains change, how many game servers would be disabled, and how many Domains would be over their user or role limits. Overrides are taken into account.<br> OperationId: `StaffPlanControllerPreview`
|
|
6328
|
+
* @summary Preview a Plan edit
|
|
6329
|
+
* @param {string} id
|
|
6330
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
6331
|
+
* @param {*} [options] Override http request option.
|
|
6332
|
+
* @throws {RequiredError}
|
|
6333
|
+
*/
|
|
6334
|
+
staffPlanControllerPreview(id, planPreviewInputDTO, options) {
|
|
6335
|
+
return localVarFp
|
|
6336
|
+
.staffPlanControllerPreview(id, planPreviewInputDTO, options)
|
|
6337
|
+
.then((request) => request(axios, basePath));
|
|
6338
|
+
},
|
|
6339
|
+
/**
|
|
6340
|
+
* Changed limits reach every Domain on the Plan shortly after, through a queued job. A shrink of `maxGameservers` disables the newest excess servers; preview it first. Changing or removing the billing-provider product is refused with a 409 while a subscription-backed Domain is on the Plan.<br> OperationId: `StaffPlanControllerUpdate`
|
|
6341
|
+
* @summary Update a Plan
|
|
6342
|
+
* @param {string} id
|
|
6343
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
5353
6344
|
* @param {*} [options] Override http request option.
|
|
5354
6345
|
* @throws {RequiredError}
|
|
5355
6346
|
*/
|
|
5356
|
-
|
|
5357
|
-
return localVarFp
|
|
6347
|
+
staffPlanControllerUpdate(id, planUpdateInputDTO, options) {
|
|
6348
|
+
return localVarFp
|
|
6349
|
+
.staffPlanControllerUpdate(id, planUpdateInputDTO, options)
|
|
6350
|
+
.then((request) => request(axios, basePath));
|
|
5358
6351
|
},
|
|
5359
6352
|
};
|
|
5360
6353
|
};
|
|
@@ -5366,15 +6359,121 @@ export const StaffPlanApiFactory = function (configuration, basePath, axios) {
|
|
|
5366
6359
|
*/
|
|
5367
6360
|
export class StaffPlanApi extends BaseAPI {
|
|
5368
6361
|
/**
|
|
5369
|
-
*
|
|
5370
|
-
* @summary
|
|
6362
|
+
* Refused while any Domain is on the Plan or any Distributor allows it. Frees its billing-provider product for another Plan; the history keeps the old link. Idempotent.<br> OperationId: `StaffPlanControllerArchive`
|
|
6363
|
+
* @summary Archive a Plan
|
|
6364
|
+
* @param {string} id
|
|
6365
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
6366
|
+
* @param {*} [options] Override http request option.
|
|
6367
|
+
* @throws {RequiredError}
|
|
6368
|
+
* @memberof StaffPlanApi
|
|
6369
|
+
*/
|
|
6370
|
+
staffPlanControllerArchive(id, planArchiveInputDTO, options) {
|
|
6371
|
+
return StaffPlanApiFp(this.configuration)
|
|
6372
|
+
.staffPlanControllerArchive(id, planArchiveInputDTO, options)
|
|
6373
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6374
|
+
}
|
|
6375
|
+
/**
|
|
6376
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
6377
|
+
* @summary Create a Plan
|
|
6378
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
6379
|
+
* @param {*} [options] Override http request option.
|
|
6380
|
+
* @throws {RequiredError}
|
|
6381
|
+
* @memberof StaffPlanApi
|
|
6382
|
+
*/
|
|
6383
|
+
staffPlanControllerCreate(planCreateInputDTO, options) {
|
|
6384
|
+
return StaffPlanApiFp(this.configuration)
|
|
6385
|
+
.staffPlanControllerCreate(planCreateInputDTO, options)
|
|
6386
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6387
|
+
}
|
|
6388
|
+
/**
|
|
6389
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
6390
|
+
* @summary Change history of a Plan
|
|
6391
|
+
* @param {string} id
|
|
6392
|
+
* @param {*} [options] Override http request option.
|
|
6393
|
+
* @throws {RequiredError}
|
|
6394
|
+
* @memberof StaffPlanApi
|
|
6395
|
+
*/
|
|
6396
|
+
staffPlanControllerHistory(id, options) {
|
|
6397
|
+
return StaffPlanApiFp(this.configuration)
|
|
6398
|
+
.staffPlanControllerHistory(id, options)
|
|
6399
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6400
|
+
}
|
|
6401
|
+
/**
|
|
6402
|
+
* Creates a Plan per billing-provider product in one transaction; a no-op once any import was recorded. Domains and Distributors still on a legacy product id move to its Plan, and a Domain that predates Plans keeps its hand-set limits as overrides. A product already linked to a Plan maps to that Plan instead.<br> OperationId: `StaffPlanControllerImport`
|
|
6403
|
+
* @summary Import Plans from the billing provider
|
|
6404
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
6405
|
+
* @param {*} [options] Override http request option.
|
|
6406
|
+
* @throws {RequiredError}
|
|
6407
|
+
* @memberof StaffPlanApi
|
|
6408
|
+
*/
|
|
6409
|
+
staffPlanControllerImport(planImportInputDTO, options) {
|
|
6410
|
+
return StaffPlanApiFp(this.configuration)
|
|
6411
|
+
.staffPlanControllerImport(planImportInputDTO, options)
|
|
6412
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6413
|
+
}
|
|
6414
|
+
/**
|
|
6415
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
6416
|
+
* @summary Whether the billing-provider import ran
|
|
6417
|
+
* @param {*} [options] Override http request option.
|
|
6418
|
+
* @throws {RequiredError}
|
|
6419
|
+
* @memberof StaffPlanApi
|
|
6420
|
+
*/
|
|
6421
|
+
staffPlanControllerImportStatus(options) {
|
|
6422
|
+
return StaffPlanApiFp(this.configuration)
|
|
6423
|
+
.staffPlanControllerImportStatus(options)
|
|
6424
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6425
|
+
}
|
|
6426
|
+
/**
|
|
6427
|
+
* Every Takaro Plan, oldest first. Archived Plans only with `includeArchived=true`. The ids here are what a Distributor’s allowedPlans and a Domain’s planId hold.<br> OperationId: `StaffPlanControllerList`
|
|
6428
|
+
* @summary List Plans
|
|
6429
|
+
* @param {any} [includeArchived]
|
|
6430
|
+
* @param {*} [options] Override http request option.
|
|
6431
|
+
* @throws {RequiredError}
|
|
6432
|
+
* @memberof StaffPlanApi
|
|
6433
|
+
*/
|
|
6434
|
+
staffPlanControllerList(includeArchived, options) {
|
|
6435
|
+
return StaffPlanApiFp(this.configuration)
|
|
6436
|
+
.staffPlanControllerList(includeArchived, options)
|
|
6437
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6438
|
+
}
|
|
6439
|
+
/**
|
|
6440
|
+
* Every product the billing provider knows about, with its prices, unfiltered by storefront lookup keys. A Plan’s stripeProductId is one of these ids.<br> OperationId: `StaffPlanControllerListStripeProducts`
|
|
6441
|
+
* @summary The billing provider’s products
|
|
6442
|
+
* @param {*} [options] Override http request option.
|
|
6443
|
+
* @throws {RequiredError}
|
|
6444
|
+
* @memberof StaffPlanApi
|
|
6445
|
+
*/
|
|
6446
|
+
staffPlanControllerListStripeProducts(options) {
|
|
6447
|
+
return StaffPlanApiFp(this.configuration)
|
|
6448
|
+
.staffPlanControllerListStripeProducts(options)
|
|
6449
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6450
|
+
}
|
|
6451
|
+
/**
|
|
6452
|
+
* A dry run of the proposed limits: how many Domains change, how many game servers would be disabled, and how many Domains would be over their user or role limits. Overrides are taken into account.<br> OperationId: `StaffPlanControllerPreview`
|
|
6453
|
+
* @summary Preview a Plan edit
|
|
6454
|
+
* @param {string} id
|
|
6455
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
6456
|
+
* @param {*} [options] Override http request option.
|
|
6457
|
+
* @throws {RequiredError}
|
|
6458
|
+
* @memberof StaffPlanApi
|
|
6459
|
+
*/
|
|
6460
|
+
staffPlanControllerPreview(id, planPreviewInputDTO, options) {
|
|
6461
|
+
return StaffPlanApiFp(this.configuration)
|
|
6462
|
+
.staffPlanControllerPreview(id, planPreviewInputDTO, options)
|
|
6463
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6464
|
+
}
|
|
6465
|
+
/**
|
|
6466
|
+
* Changed limits reach every Domain on the Plan shortly after, through a queued job. A shrink of `maxGameservers` disables the newest excess servers; preview it first. Changing or removing the billing-provider product is refused with a 409 while a subscription-backed Domain is on the Plan.<br> OperationId: `StaffPlanControllerUpdate`
|
|
6467
|
+
* @summary Update a Plan
|
|
6468
|
+
* @param {string} id
|
|
6469
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
5371
6470
|
* @param {*} [options] Override http request option.
|
|
5372
6471
|
* @throws {RequiredError}
|
|
5373
6472
|
* @memberof StaffPlanApi
|
|
5374
6473
|
*/
|
|
5375
|
-
|
|
6474
|
+
staffPlanControllerUpdate(id, planUpdateInputDTO, options) {
|
|
5376
6475
|
return StaffPlanApiFp(this.configuration)
|
|
5377
|
-
.
|
|
6476
|
+
.staffPlanControllerUpdate(id, planUpdateInputDTO, options)
|
|
5378
6477
|
.then((request) => request(this.axios, this.basePath));
|
|
5379
6478
|
}
|
|
5380
6479
|
}
|