@takaro/apiclient 0.0.0-dev.688cf60 → 0.0.0-dev.692cd5e
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 +2299 -1449
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/generated/api.js +593 -5
- package/dist/generated/api.js.map +1 -1
- package/dist/generated/base.d.ts.map +1 -1
- package/dist/generated/base.js.map +1 -1
- package/dist/generated/common.d.ts.map +1 -1
- package/dist/generated/common.js.map +1 -1
- package/dist/generated/configuration.d.ts.map +1 -1
- package/dist/generated/configuration.js.map +1 -1
- package/dist/generated-management/api.d.ts +3136 -1379
- package/dist/generated-management/api.d.ts.map +1 -1
- package/dist/generated-management/api.js +1195 -138
- package/dist/generated-management/api.js.map +1 -1
- package/dist/generated-management/base.d.ts.map +1 -1
- package/dist/generated-management/base.js.map +1 -1
- package/dist/generated-management/common.d.ts.map +1 -1
- package/dist/generated-management/common.js.map +1 -1
- package/dist/generated-management/configuration.d.ts.map +1 -1
- package/dist/generated-management/configuration.js.map +1 -1
- package/dist/lib/adminClient.d.ts +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/baseClient.d.ts.map +1 -1
- package/dist/lib/client.d.ts.map +1 -1
- package/dist/lib/client.js +2 -2
- package/dist/lib/client.js.map +1 -1
- package/dist/lib/distributorClient.d.ts.map +1 -1
- package/dist/lib/staffClient.d.ts +3 -1
- package/dist/lib/staffClient.d.ts.map +1 -1
- package/dist/lib/staffClient.js +5 -1
- package/dist/lib/staffClient.js.map +1 -1
- package/dist/main.d.ts +2 -2
- package/dist/main.d.ts.map +1 -1
- package/dist/main.js +1 -1
- package/dist/main.js.map +1 -1
- package/package.json +4 -3
|
@@ -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',
|
|
@@ -168,6 +186,7 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
168
186
|
PlayerLinked: 'player-linked',
|
|
169
187
|
GameserverCreated: 'gameserver-created',
|
|
170
188
|
GameserverUpdated: 'gameserver-updated',
|
|
189
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
171
190
|
GameserverDeleted: 'gameserver-deleted',
|
|
172
191
|
PlayerBanned: 'player-banned',
|
|
173
192
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -183,6 +202,10 @@ export const EventCreateDTOEventNameEnum = {
|
|
|
183
202
|
DomainCreated: 'domain-created',
|
|
184
203
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
185
204
|
DomainPlanChanged: 'domain-plan-changed',
|
|
205
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
206
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
207
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
208
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
186
209
|
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
187
210
|
ItemsGiven: 'items-given',
|
|
188
211
|
PlayerConnected: 'player-connected',
|
|
@@ -223,6 +246,7 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
223
246
|
PlayerLinked: 'player-linked',
|
|
224
247
|
GameserverCreated: 'gameserver-created',
|
|
225
248
|
GameserverUpdated: 'gameserver-updated',
|
|
249
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
226
250
|
GameserverDeleted: 'gameserver-deleted',
|
|
227
251
|
PlayerBanned: 'player-banned',
|
|
228
252
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -238,6 +262,10 @@ export const EventOutputDTOEventNameEnum = {
|
|
|
238
262
|
DomainCreated: 'domain-created',
|
|
239
263
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
240
264
|
DomainPlanChanged: 'domain-plan-changed',
|
|
265
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
266
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
267
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
268
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
241
269
|
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
242
270
|
ItemsGiven: 'items-given',
|
|
243
271
|
PlayerConnected: 'player-connected',
|
|
@@ -277,12 +305,24 @@ export const GameServerCreateDTOTypeEnum = {
|
|
|
277
305
|
Generic: 'GENERIC',
|
|
278
306
|
Mock: 'MOCK',
|
|
279
307
|
};
|
|
308
|
+
export const GameServerCreateDTONameSourceEnum = {
|
|
309
|
+
Connector: 'connector',
|
|
310
|
+
Operator: 'operator',
|
|
311
|
+
};
|
|
312
|
+
export const GameServerIdentifyInputDTOProtocolVersionEnum = {
|
|
313
|
+
NUMBER_0: 0,
|
|
314
|
+
NUMBER_1: 1,
|
|
315
|
+
};
|
|
280
316
|
export const GameServerOutputDTOTypeEnum = {
|
|
281
317
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
282
318
|
Rust: 'RUST',
|
|
283
319
|
Generic: 'GENERIC',
|
|
284
320
|
Mock: 'MOCK',
|
|
285
321
|
};
|
|
322
|
+
export const GameServerOutputDTONameSourceEnum = {
|
|
323
|
+
Connector: 'connector',
|
|
324
|
+
Operator: 'operator',
|
|
325
|
+
};
|
|
286
326
|
export const GameServerTypesOutputDTOTypeEnum = {
|
|
287
327
|
Sevendaystodie: 'SEVENDAYSTODIE',
|
|
288
328
|
Rust: 'RUST',
|
|
@@ -307,11 +347,14 @@ export const GetJobInputDTOTypeEnum = {
|
|
|
307
347
|
SyncBans: 'syncBans',
|
|
308
348
|
SyncMapImages: 'syncMapImages',
|
|
309
349
|
SyncMapUploads: 'syncMapUploads',
|
|
350
|
+
SyncGameIcons: 'syncGameIcons',
|
|
310
351
|
SyncSteam: 'syncSteam',
|
|
311
352
|
SyncDiscordRoles: 'syncDiscordRoles',
|
|
312
353
|
EmitRateLimitSummary: 'emitRateLimitSummary',
|
|
313
354
|
CleanRevokedApiKeys: 'cleanRevokedApiKeys',
|
|
314
355
|
CleanExecutionClaims: 'cleanExecutionClaims',
|
|
356
|
+
DeleteClickHouseEvents: 'deleteClickHouseEvents',
|
|
357
|
+
CleanConnectorMigrations: 'cleanConnectorMigrations',
|
|
315
358
|
};
|
|
316
359
|
export const HookCreateDTOEventTypeEnum = {
|
|
317
360
|
Log: 'log',
|
|
@@ -352,6 +395,7 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
352
395
|
PlayerLinked: 'player-linked',
|
|
353
396
|
GameserverCreated: 'gameserver-created',
|
|
354
397
|
GameserverUpdated: 'gameserver-updated',
|
|
398
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
355
399
|
GameserverDeleted: 'gameserver-deleted',
|
|
356
400
|
PlayerBanned: 'player-banned',
|
|
357
401
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -367,6 +411,10 @@ export const HookCreateDTOEventTypeEnum = {
|
|
|
367
411
|
DomainCreated: 'domain-created',
|
|
368
412
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
369
413
|
DomainPlanChanged: 'domain-plan-changed',
|
|
414
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
415
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
416
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
417
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
370
418
|
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
371
419
|
ItemsGiven: 'items-given',
|
|
372
420
|
};
|
|
@@ -409,6 +457,7 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
409
457
|
PlayerLinked: 'player-linked',
|
|
410
458
|
GameserverCreated: 'gameserver-created',
|
|
411
459
|
GameserverUpdated: 'gameserver-updated',
|
|
460
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
412
461
|
GameserverDeleted: 'gameserver-deleted',
|
|
413
462
|
PlayerBanned: 'player-banned',
|
|
414
463
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -424,6 +473,10 @@ export const HookOutputDTOEventTypeEnum = {
|
|
|
424
473
|
DomainCreated: 'domain-created',
|
|
425
474
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
426
475
|
DomainPlanChanged: 'domain-plan-changed',
|
|
476
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
477
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
478
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
479
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
427
480
|
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
428
481
|
ItemsGiven: 'items-given',
|
|
429
482
|
};
|
|
@@ -466,6 +519,7 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
466
519
|
PlayerLinked: 'player-linked',
|
|
467
520
|
GameserverCreated: 'gameserver-created',
|
|
468
521
|
GameserverUpdated: 'gameserver-updated',
|
|
522
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
469
523
|
GameserverDeleted: 'gameserver-deleted',
|
|
470
524
|
PlayerBanned: 'player-banned',
|
|
471
525
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -481,6 +535,10 @@ export const HookTriggerDTOEventTypeEnum = {
|
|
|
481
535
|
DomainCreated: 'domain-created',
|
|
482
536
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
483
537
|
DomainPlanChanged: 'domain-plan-changed',
|
|
538
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
539
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
540
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
541
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
484
542
|
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
485
543
|
ItemsGiven: 'items-given',
|
|
486
544
|
};
|
|
@@ -523,6 +581,7 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
523
581
|
PlayerLinked: 'player-linked',
|
|
524
582
|
GameserverCreated: 'gameserver-created',
|
|
525
583
|
GameserverUpdated: 'gameserver-updated',
|
|
584
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
526
585
|
GameserverDeleted: 'gameserver-deleted',
|
|
527
586
|
PlayerBanned: 'player-banned',
|
|
528
587
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -538,6 +597,10 @@ export const HookUpdateDTOEventTypeEnum = {
|
|
|
538
597
|
DomainCreated: 'domain-created',
|
|
539
598
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
540
599
|
DomainPlanChanged: 'domain-plan-changed',
|
|
600
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
601
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
602
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
603
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
541
604
|
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
542
605
|
ItemsGiven: 'items-given',
|
|
543
606
|
};
|
|
@@ -585,6 +648,7 @@ export const IHookEventTypeEnum = {
|
|
|
585
648
|
PlayerLinked: 'player-linked',
|
|
586
649
|
GameserverCreated: 'gameserver-created',
|
|
587
650
|
GameserverUpdated: 'gameserver-updated',
|
|
651
|
+
GameserverVersionChanged: 'gameserver-version-changed',
|
|
588
652
|
GameserverDeleted: 'gameserver-deleted',
|
|
589
653
|
PlayerBanned: 'player-banned',
|
|
590
654
|
PlayerUnbanned: 'player-unbanned',
|
|
@@ -600,6 +664,10 @@ export const IHookEventTypeEnum = {
|
|
|
600
664
|
DomainCreated: 'domain-created',
|
|
601
665
|
DomainRegistrationTokenRegenerated: 'domain-registration-token-regenerated',
|
|
602
666
|
DomainPlanChanged: 'domain-plan-changed',
|
|
667
|
+
ConnectorMigrationStarted: 'connector-migration-started',
|
|
668
|
+
ConnectorMigrationCompleted: 'connector-migration-completed',
|
|
669
|
+
ConnectorMigrationCancelled: 'connector-migration-cancelled',
|
|
670
|
+
ConnectorMigrationReverted: 'connector-migration-reverted',
|
|
603
671
|
DiscordGuildEnabled: 'discord-guild-enabled',
|
|
604
672
|
ItemsGiven: 'items-given',
|
|
605
673
|
};
|
|
@@ -713,11 +781,15 @@ export const PERMISSIONS = {
|
|
|
713
781
|
SendDiscordMessage: 'SEND_DISCORD_MESSAGE',
|
|
714
782
|
ManageApiKeys: 'MANAGE_API_KEYS',
|
|
715
783
|
};
|
|
716
|
-
export const
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
784
|
+
export const PlanChangeOutputDTOActionEnum = {
|
|
785
|
+
Create: 'create',
|
|
786
|
+
Update: 'update',
|
|
787
|
+
Archive: 'archive',
|
|
788
|
+
};
|
|
789
|
+
export const PlanChangeOutputDTOActorKindEnum = {
|
|
790
|
+
StaffSession: 'staffSession',
|
|
791
|
+
AdminSecret: 'adminSecret',
|
|
792
|
+
System: 'system',
|
|
721
793
|
};
|
|
722
794
|
export const PlayerOnGameServerSearchInputDTOExtendEnum = {
|
|
723
795
|
GameServer: 'gameServer',
|
|
@@ -869,6 +941,12 @@ export const StorefrontDomainOutputDTOCustomDomainStateEnum = {
|
|
|
869
941
|
Verified: 'VERIFIED',
|
|
870
942
|
Failed: 'FAILED',
|
|
871
943
|
};
|
|
944
|
+
export const StripePriceDTOIntervalEnum = {
|
|
945
|
+
Day: 'day',
|
|
946
|
+
Week: 'week',
|
|
947
|
+
Month: 'month',
|
|
948
|
+
Year: 'year',
|
|
949
|
+
};
|
|
872
950
|
export const TakaroAiDomainOutputDTOOverrideStateEnum = {
|
|
873
951
|
None: 'none',
|
|
874
952
|
Active: 'active',
|
|
@@ -1063,6 +1141,7 @@ export const TriggerJobInputDTOTypeEnum = {
|
|
|
1063
1141
|
SyncBans: 'syncBans',
|
|
1064
1142
|
SyncMapImages: 'syncMapImages',
|
|
1065
1143
|
SyncMapUploads: 'syncMapUploads',
|
|
1144
|
+
SyncGameIcons: 'syncGameIcons',
|
|
1066
1145
|
SyncSteam: 'syncSteam',
|
|
1067
1146
|
SyncDiscordRoles: 'syncDiscordRoles',
|
|
1068
1147
|
};
|
|
@@ -1830,7 +1909,7 @@ export class DistributorApi extends BaseAPI {
|
|
|
1830
1909
|
export const DistributorSelfServiceApiAxiosParamCreator = function (configuration) {
|
|
1831
1910
|
return {
|
|
1832
1911
|
/**
|
|
1833
|
-
* 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
|
|
1912
|
+
* 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`
|
|
1834
1913
|
* @summary Create a domain
|
|
1835
1914
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
1836
1915
|
* @param {*} [options] Override http request option.
|
|
@@ -2140,7 +2219,7 @@ export const DistributorSelfServiceApiAxiosParamCreator = function (configuratio
|
|
|
2140
2219
|
};
|
|
2141
2220
|
},
|
|
2142
2221
|
/**
|
|
2143
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2222
|
+
* 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`
|
|
2144
2223
|
* @summary Change one of my domains’ Plan
|
|
2145
2224
|
* @param {string} id
|
|
2146
2225
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2183,7 +2262,7 @@ export const DistributorSelfServiceApiFp = function (configuration) {
|
|
|
2183
2262
|
const localVarAxiosParamCreator = DistributorSelfServiceApiAxiosParamCreator(configuration);
|
|
2184
2263
|
return {
|
|
2185
2264
|
/**
|
|
2186
|
-
* 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
|
|
2265
|
+
* 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`
|
|
2187
2266
|
* @summary Create a domain
|
|
2188
2267
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
2189
2268
|
* @param {*} [options] Override http request option.
|
|
@@ -2313,7 +2392,7 @@ export const DistributorSelfServiceApiFp = function (configuration) {
|
|
|
2313
2392
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2314
2393
|
},
|
|
2315
2394
|
/**
|
|
2316
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2395
|
+
* 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`
|
|
2317
2396
|
* @summary Change one of my domains’ Plan
|
|
2318
2397
|
* @param {string} id
|
|
2319
2398
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2336,7 +2415,7 @@ export const DistributorSelfServiceApiFactory = function (configuration, basePat
|
|
|
2336
2415
|
const localVarFp = DistributorSelfServiceApiFp(configuration);
|
|
2337
2416
|
return {
|
|
2338
2417
|
/**
|
|
2339
|
-
* 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
|
|
2418
|
+
* 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`
|
|
2340
2419
|
* @summary Create a domain
|
|
2341
2420
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
2342
2421
|
* @param {*} [options] Override http request option.
|
|
@@ -2454,7 +2533,7 @@ export const DistributorSelfServiceApiFactory = function (configuration, basePat
|
|
|
2454
2533
|
.then((request) => request(axios, basePath));
|
|
2455
2534
|
},
|
|
2456
2535
|
/**
|
|
2457
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2536
|
+
* 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`
|
|
2458
2537
|
* @summary Change one of my domains’ Plan
|
|
2459
2538
|
* @param {string} id
|
|
2460
2539
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2476,7 +2555,7 @@ export const DistributorSelfServiceApiFactory = function (configuration, basePat
|
|
|
2476
2555
|
*/
|
|
2477
2556
|
export class DistributorSelfServiceApi extends BaseAPI {
|
|
2478
2557
|
/**
|
|
2479
|
-
* 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
|
|
2558
|
+
* 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`
|
|
2480
2559
|
* @summary Create a domain
|
|
2481
2560
|
* @param {DistributorDomainCreateInputDTO} [distributorDomainCreateInputDTO] DistributorDomainCreateInputDTO
|
|
2482
2561
|
* @param {*} [options] Override http request option.
|
|
@@ -2606,7 +2685,7 @@ export class DistributorSelfServiceApi extends BaseAPI {
|
|
|
2606
2685
|
.then((request) => request(this.axios, this.basePath));
|
|
2607
2686
|
}
|
|
2608
2687
|
/**
|
|
2609
|
-
* Moves the domain onto another of the Plans allowed for the calling distributor
|
|
2688
|
+
* 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`
|
|
2610
2689
|
* @summary Change one of my domains’ Plan
|
|
2611
2690
|
* @param {string} id
|
|
2612
2691
|
* @param {DistributorDomainPlanInputDTO} [distributorDomainPlanInputDTO] DistributorDomainPlanInputDTO
|
|
@@ -2918,21 +2997,58 @@ export const DomainApiAxiosParamCreator = function (configuration) {
|
|
|
2918
2997
|
};
|
|
2919
2998
|
},
|
|
2920
2999
|
/**
|
|
2921
|
-
*
|
|
2922
|
-
* @summary
|
|
2923
|
-
* @param {
|
|
3000
|
+
* 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`
|
|
3001
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3002
|
+
* @param {string} id
|
|
3003
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
2924
3004
|
* @param {*} [options] Override http request option.
|
|
2925
3005
|
* @throws {RequiredError}
|
|
2926
3006
|
*/
|
|
2927
|
-
|
|
2928
|
-
|
|
3007
|
+
domainControllerSetPlan: async (id, domainPlanInputDTO, options = {}) => {
|
|
3008
|
+
// verify required parameter 'id' is not null or undefined
|
|
3009
|
+
assertParamExists('domainControllerSetPlan', 'id', id);
|
|
3010
|
+
const localVarPath = `/domain/{id}/plan`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
2929
3011
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2930
3012
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2931
3013
|
let baseOptions;
|
|
2932
3014
|
if (configuration) {
|
|
2933
3015
|
baseOptions = configuration.baseOptions;
|
|
2934
3016
|
}
|
|
2935
|
-
const localVarRequestOptions = { method: '
|
|
3017
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
3018
|
+
const localVarHeaderParameter = {};
|
|
3019
|
+
const localVarQueryParameter = {};
|
|
3020
|
+
// authentication staffSession required
|
|
3021
|
+
// authentication adminAuth required
|
|
3022
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
3023
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3024
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3025
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3026
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3027
|
+
localVarRequestOptions.data = serializeDataIfNeeded(domainPlanInputDTO, localVarRequestOptions, configuration);
|
|
3028
|
+
return {
|
|
3029
|
+
url: toPathString(localVarUrlObj),
|
|
3030
|
+
options: localVarRequestOptions,
|
|
3031
|
+
};
|
|
3032
|
+
},
|
|
3033
|
+
/**
|
|
3034
|
+
* 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`
|
|
3035
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3036
|
+
* @param {string} id
|
|
3037
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3038
|
+
* @param {*} [options] Override http request option.
|
|
3039
|
+
* @throws {RequiredError}
|
|
3040
|
+
*/
|
|
3041
|
+
domainControllerSetPlanByStaff: async (id, staffDomainPlanInputDTO, options = {}) => {
|
|
3042
|
+
// verify required parameter 'id' is not null or undefined
|
|
3043
|
+
assertParamExists('domainControllerSetPlanByStaff', 'id', id);
|
|
3044
|
+
const localVarPath = `/staff/domains/{id}/plan`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
3045
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3046
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3047
|
+
let baseOptions;
|
|
3048
|
+
if (configuration) {
|
|
3049
|
+
baseOptions = configuration.baseOptions;
|
|
3050
|
+
}
|
|
3051
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
2936
3052
|
const localVarHeaderParameter = {};
|
|
2937
3053
|
const localVarQueryParameter = {};
|
|
2938
3054
|
// authentication staffSession required
|
|
@@ -2942,7 +3058,7 @@ export const DomainApiAxiosParamCreator = function (configuration) {
|
|
|
2942
3058
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2943
3059
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2944
3060
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2945
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3061
|
+
localVarRequestOptions.data = serializeDataIfNeeded(staffDomainPlanInputDTO, localVarRequestOptions, configuration);
|
|
2946
3062
|
return {
|
|
2947
3063
|
url: toPathString(localVarUrlObj),
|
|
2948
3064
|
options: localVarRequestOptions,
|
|
@@ -3112,16 +3228,31 @@ export const DomainApiFp = function (configuration) {
|
|
|
3112
3228
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3113
3229
|
},
|
|
3114
3230
|
/**
|
|
3115
|
-
*
|
|
3116
|
-
* @summary
|
|
3117
|
-
* @param {
|
|
3231
|
+
* 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`
|
|
3232
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3233
|
+
* @param {string} id
|
|
3234
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
3235
|
+
* @param {*} [options] Override http request option.
|
|
3236
|
+
* @throws {RequiredError}
|
|
3237
|
+
*/
|
|
3238
|
+
async domainControllerSetPlan(id, domainPlanInputDTO, options) {
|
|
3239
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.domainControllerSetPlan(id, domainPlanInputDTO, options);
|
|
3240
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3241
|
+
const localVarOperationServerBasePath = operationServerMap['DomainApi.domainControllerSetPlan']?.[localVarOperationServerIndex]?.url;
|
|
3242
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3243
|
+
},
|
|
3244
|
+
/**
|
|
3245
|
+
* 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`
|
|
3246
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3247
|
+
* @param {string} id
|
|
3248
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3118
3249
|
* @param {*} [options] Override http request option.
|
|
3119
3250
|
* @throws {RequiredError}
|
|
3120
3251
|
*/
|
|
3121
|
-
async
|
|
3122
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3252
|
+
async domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options) {
|
|
3253
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options);
|
|
3123
3254
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3124
|
-
const localVarOperationServerBasePath = operationServerMap['DomainApi.
|
|
3255
|
+
const localVarOperationServerBasePath = operationServerMap['DomainApi.domainControllerSetPlanByStaff']?.[localVarOperationServerIndex]?.url;
|
|
3125
3256
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3126
3257
|
},
|
|
3127
3258
|
/**
|
|
@@ -3251,15 +3382,29 @@ export const DomainApiFactory = function (configuration, basePath, axios) {
|
|
|
3251
3382
|
.then((request) => request(axios, basePath));
|
|
3252
3383
|
},
|
|
3253
3384
|
/**
|
|
3254
|
-
*
|
|
3255
|
-
* @summary
|
|
3256
|
-
* @param {
|
|
3385
|
+
* 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`
|
|
3386
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3387
|
+
* @param {string} id
|
|
3388
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
3389
|
+
* @param {*} [options] Override http request option.
|
|
3390
|
+
* @throws {RequiredError}
|
|
3391
|
+
*/
|
|
3392
|
+
domainControllerSetPlan(id, domainPlanInputDTO, options) {
|
|
3393
|
+
return localVarFp
|
|
3394
|
+
.domainControllerSetPlan(id, domainPlanInputDTO, options)
|
|
3395
|
+
.then((request) => request(axios, basePath));
|
|
3396
|
+
},
|
|
3397
|
+
/**
|
|
3398
|
+
* 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`
|
|
3399
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3400
|
+
* @param {string} id
|
|
3401
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3257
3402
|
* @param {*} [options] Override http request option.
|
|
3258
3403
|
* @throws {RequiredError}
|
|
3259
3404
|
*/
|
|
3260
|
-
|
|
3405
|
+
domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options) {
|
|
3261
3406
|
return localVarFp
|
|
3262
|
-
.
|
|
3407
|
+
.domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options)
|
|
3263
3408
|
.then((request) => request(axios, basePath));
|
|
3264
3409
|
},
|
|
3265
3410
|
/**
|
|
@@ -3405,16 +3550,31 @@ export class DomainApi extends BaseAPI {
|
|
|
3405
3550
|
.then((request) => request(this.axios, this.basePath));
|
|
3406
3551
|
}
|
|
3407
3552
|
/**
|
|
3408
|
-
*
|
|
3409
|
-
* @summary
|
|
3410
|
-
* @param {
|
|
3553
|
+
* 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`
|
|
3554
|
+
* @summary Put a subscription-backed domain on a Plan
|
|
3555
|
+
* @param {string} id
|
|
3556
|
+
* @param {DomainPlanInputDTO} [domainPlanInputDTO] DomainPlanInputDTO
|
|
3557
|
+
* @param {*} [options] Override http request option.
|
|
3558
|
+
* @throws {RequiredError}
|
|
3559
|
+
* @memberof DomainApi
|
|
3560
|
+
*/
|
|
3561
|
+
domainControllerSetPlan(id, domainPlanInputDTO, options) {
|
|
3562
|
+
return DomainApiFp(this.configuration)
|
|
3563
|
+
.domainControllerSetPlan(id, domainPlanInputDTO, options)
|
|
3564
|
+
.then((request) => request(this.axios, this.basePath));
|
|
3565
|
+
}
|
|
3566
|
+
/**
|
|
3567
|
+
* 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`
|
|
3568
|
+
* @summary Put an Unbacked domain on a Plan
|
|
3569
|
+
* @param {string} id
|
|
3570
|
+
* @param {StaffDomainPlanInputDTO} [staffDomainPlanInputDTO] StaffDomainPlanInputDTO
|
|
3411
3571
|
* @param {*} [options] Override http request option.
|
|
3412
3572
|
* @throws {RequiredError}
|
|
3413
3573
|
* @memberof DomainApi
|
|
3414
3574
|
*/
|
|
3415
|
-
|
|
3575
|
+
domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options) {
|
|
3416
3576
|
return DomainApiFp(this.configuration)
|
|
3417
|
-
.
|
|
3577
|
+
.domainControllerSetPlanByStaff(id, staffDomainPlanInputDTO, options)
|
|
3418
3578
|
.then((request) => request(this.axios, this.basePath));
|
|
3419
3579
|
}
|
|
3420
3580
|
/**
|
|
@@ -5156,129 +5316,146 @@ export class StaffAuthApi extends BaseAPI {
|
|
|
5156
5316
|
}
|
|
5157
5317
|
}
|
|
5158
5318
|
/**
|
|
5159
|
-
*
|
|
5319
|
+
* StaffDomainLimitsApi - axios parameter creator
|
|
5160
5320
|
* @export
|
|
5161
5321
|
*/
|
|
5162
|
-
export const
|
|
5322
|
+
export const StaffDomainLimitsApiAxiosParamCreator = function (configuration) {
|
|
5163
5323
|
return {
|
|
5164
5324
|
/**
|
|
5165
|
-
* The
|
|
5166
|
-
* @summary
|
|
5325
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5326
|
+
* @summary Clear a limit override of a Domain
|
|
5327
|
+
* @param {string} id
|
|
5328
|
+
* @param {string} limitKey
|
|
5329
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5167
5330
|
* @param {*} [options] Override http request option.
|
|
5168
5331
|
* @throws {RequiredError}
|
|
5169
5332
|
*/
|
|
5170
|
-
|
|
5171
|
-
|
|
5333
|
+
staffDomainLimitsControllerClear: async (id, limitKey, domainLimitOverrideClearInputDTO, options = {}) => {
|
|
5334
|
+
// verify required parameter 'id' is not null or undefined
|
|
5335
|
+
assertParamExists('staffDomainLimitsControllerClear', 'id', id);
|
|
5336
|
+
// verify required parameter 'limitKey' is not null or undefined
|
|
5337
|
+
assertParamExists('staffDomainLimitsControllerClear', 'limitKey', limitKey);
|
|
5338
|
+
const localVarPath = `/staff/domains/{id}/limits/{limitKey}`
|
|
5339
|
+
.replace(`{${'id'}}`, encodeURIComponent(String(id)))
|
|
5340
|
+
.replace(`{${'limitKey'}}`, encodeURIComponent(String(limitKey)));
|
|
5172
5341
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5173
5342
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5174
5343
|
let baseOptions;
|
|
5175
5344
|
if (configuration) {
|
|
5176
5345
|
baseOptions = configuration.baseOptions;
|
|
5177
5346
|
}
|
|
5178
|
-
const localVarRequestOptions = { method: '
|
|
5347
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
5179
5348
|
const localVarHeaderParameter = {};
|
|
5180
5349
|
const localVarQueryParameter = {};
|
|
5181
5350
|
// authentication staffSession required
|
|
5182
5351
|
// authentication adminAuth required
|
|
5183
5352
|
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5353
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5184
5354
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5185
5355
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5186
5356
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5357
|
+
localVarRequestOptions.data = serializeDataIfNeeded(domainLimitOverrideClearInputDTO, localVarRequestOptions, configuration);
|
|
5187
5358
|
return {
|
|
5188
5359
|
url: toPathString(localVarUrlObj),
|
|
5189
5360
|
options: localVarRequestOptions,
|
|
5190
5361
|
};
|
|
5191
5362
|
},
|
|
5192
|
-
};
|
|
5193
|
-
};
|
|
5194
|
-
/**
|
|
5195
|
-
* StaffMeApi - functional programming interface
|
|
5196
|
-
* @export
|
|
5197
|
-
*/
|
|
5198
|
-
export const StaffMeApiFp = function (configuration) {
|
|
5199
|
-
const localVarAxiosParamCreator = StaffMeApiAxiosParamCreator(configuration);
|
|
5200
|
-
return {
|
|
5201
5363
|
/**
|
|
5202
|
-
*
|
|
5203
|
-
* @summary
|
|
5364
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5365
|
+
* @summary Effective limits of a Domain
|
|
5366
|
+
* @param {string} id
|
|
5204
5367
|
* @param {*} [options] Override http request option.
|
|
5205
5368
|
* @throws {RequiredError}
|
|
5206
5369
|
*/
|
|
5207
|
-
async
|
|
5208
|
-
|
|
5209
|
-
|
|
5210
|
-
const
|
|
5211
|
-
|
|
5370
|
+
staffDomainLimitsControllerGet: async (id, options = {}) => {
|
|
5371
|
+
// verify required parameter 'id' is not null or undefined
|
|
5372
|
+
assertParamExists('staffDomainLimitsControllerGet', 'id', id);
|
|
5373
|
+
const localVarPath = `/staff/domains/{id}/limits`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5374
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5375
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5376
|
+
let baseOptions;
|
|
5377
|
+
if (configuration) {
|
|
5378
|
+
baseOptions = configuration.baseOptions;
|
|
5379
|
+
}
|
|
5380
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5381
|
+
const localVarHeaderParameter = {};
|
|
5382
|
+
const localVarQueryParameter = {};
|
|
5383
|
+
// authentication staffSession required
|
|
5384
|
+
// authentication adminAuth required
|
|
5385
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5386
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5387
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5388
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5389
|
+
return {
|
|
5390
|
+
url: toPathString(localVarUrlObj),
|
|
5391
|
+
options: localVarRequestOptions,
|
|
5392
|
+
};
|
|
5212
5393
|
},
|
|
5213
|
-
};
|
|
5214
|
-
};
|
|
5215
|
-
/**
|
|
5216
|
-
* StaffMeApi - factory interface
|
|
5217
|
-
* @export
|
|
5218
|
-
*/
|
|
5219
|
-
export const StaffMeApiFactory = function (configuration, basePath, axios) {
|
|
5220
|
-
const localVarFp = StaffMeApiFp(configuration);
|
|
5221
|
-
return {
|
|
5222
5394
|
/**
|
|
5223
|
-
*
|
|
5224
|
-
* @summary
|
|
5395
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5396
|
+
* @summary Limit override history of a Domain
|
|
5397
|
+
* @param {string} id
|
|
5225
5398
|
* @param {*} [options] Override http request option.
|
|
5226
5399
|
* @throws {RequiredError}
|
|
5227
5400
|
*/
|
|
5228
|
-
|
|
5229
|
-
|
|
5401
|
+
staffDomainLimitsControllerHistory: async (id, options = {}) => {
|
|
5402
|
+
// verify required parameter 'id' is not null or undefined
|
|
5403
|
+
assertParamExists('staffDomainLimitsControllerHistory', 'id', id);
|
|
5404
|
+
const localVarPath = `/staff/domains/{id}/limits/history`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5405
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5406
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5407
|
+
let baseOptions;
|
|
5408
|
+
if (configuration) {
|
|
5409
|
+
baseOptions = configuration.baseOptions;
|
|
5410
|
+
}
|
|
5411
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5412
|
+
const localVarHeaderParameter = {};
|
|
5413
|
+
const localVarQueryParameter = {};
|
|
5414
|
+
// authentication staffSession required
|
|
5415
|
+
// authentication adminAuth required
|
|
5416
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5417
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5418
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5419
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5420
|
+
return {
|
|
5421
|
+
url: toPathString(localVarUrlObj),
|
|
5422
|
+
options: localVarRequestOptions,
|
|
5423
|
+
};
|
|
5230
5424
|
},
|
|
5231
|
-
};
|
|
5232
|
-
};
|
|
5233
|
-
/**
|
|
5234
|
-
* StaffMeApi - object-oriented interface
|
|
5235
|
-
* @export
|
|
5236
|
-
* @class StaffMeApi
|
|
5237
|
-
* @extends {BaseAPI}
|
|
5238
|
-
*/
|
|
5239
|
-
export class StaffMeApi extends BaseAPI {
|
|
5240
|
-
/**
|
|
5241
|
-
* 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`
|
|
5242
|
-
* @summary Who this Staff session belongs to
|
|
5243
|
-
* @param {*} [options] Override http request option.
|
|
5244
|
-
* @throws {RequiredError}
|
|
5245
|
-
* @memberof StaffMeApi
|
|
5246
|
-
*/
|
|
5247
|
-
staffMeControllerMe(options) {
|
|
5248
|
-
return StaffMeApiFp(this.configuration)
|
|
5249
|
-
.staffMeControllerMe(options)
|
|
5250
|
-
.then((request) => request(this.axios, this.basePath));
|
|
5251
|
-
}
|
|
5252
|
-
}
|
|
5253
|
-
/**
|
|
5254
|
-
* StaffPlanApi - axios parameter creator
|
|
5255
|
-
* @export
|
|
5256
|
-
*/
|
|
5257
|
-
export const StaffPlanApiAxiosParamCreator = function (configuration) {
|
|
5258
|
-
return {
|
|
5259
5425
|
/**
|
|
5260
|
-
*
|
|
5261
|
-
* @summary
|
|
5426
|
+
* 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`
|
|
5427
|
+
* @summary Override one limit of a Domain
|
|
5428
|
+
* @param {string} id
|
|
5429
|
+
* @param {string} limitKey
|
|
5430
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5262
5431
|
* @param {*} [options] Override http request option.
|
|
5263
5432
|
* @throws {RequiredError}
|
|
5264
5433
|
*/
|
|
5265
|
-
|
|
5266
|
-
|
|
5434
|
+
staffDomainLimitsControllerSet: async (id, limitKey, domainLimitOverrideInputDTO, options = {}) => {
|
|
5435
|
+
// verify required parameter 'id' is not null or undefined
|
|
5436
|
+
assertParamExists('staffDomainLimitsControllerSet', 'id', id);
|
|
5437
|
+
// verify required parameter 'limitKey' is not null or undefined
|
|
5438
|
+
assertParamExists('staffDomainLimitsControllerSet', 'limitKey', limitKey);
|
|
5439
|
+
const localVarPath = `/staff/domains/{id}/limits/{limitKey}`
|
|
5440
|
+
.replace(`{${'id'}}`, encodeURIComponent(String(id)))
|
|
5441
|
+
.replace(`{${'limitKey'}}`, encodeURIComponent(String(limitKey)));
|
|
5267
5442
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5268
5443
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5269
5444
|
let baseOptions;
|
|
5270
5445
|
if (configuration) {
|
|
5271
5446
|
baseOptions = configuration.baseOptions;
|
|
5272
5447
|
}
|
|
5273
|
-
const localVarRequestOptions = { method: '
|
|
5448
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
5274
5449
|
const localVarHeaderParameter = {};
|
|
5275
5450
|
const localVarQueryParameter = {};
|
|
5276
5451
|
// authentication staffSession required
|
|
5277
5452
|
// authentication adminAuth required
|
|
5278
5453
|
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5454
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5279
5455
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5280
5456
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5281
5457
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5458
|
+
localVarRequestOptions.data = serializeDataIfNeeded(domainLimitOverrideInputDTO, localVarRequestOptions, configuration);
|
|
5282
5459
|
return {
|
|
5283
5460
|
url: toPathString(localVarUrlObj),
|
|
5284
5461
|
options: localVarRequestOptions,
|
|
@@ -5287,61 +5464,941 @@ export const StaffPlanApiAxiosParamCreator = function (configuration) {
|
|
|
5287
5464
|
};
|
|
5288
5465
|
};
|
|
5289
5466
|
/**
|
|
5290
|
-
*
|
|
5467
|
+
* StaffDomainLimitsApi - functional programming interface
|
|
5291
5468
|
* @export
|
|
5292
5469
|
*/
|
|
5293
|
-
export const
|
|
5294
|
-
const localVarAxiosParamCreator =
|
|
5470
|
+
export const StaffDomainLimitsApiFp = function (configuration) {
|
|
5471
|
+
const localVarAxiosParamCreator = StaffDomainLimitsApiAxiosParamCreator(configuration);
|
|
5295
5472
|
return {
|
|
5296
5473
|
/**
|
|
5297
|
-
*
|
|
5298
|
-
* @summary
|
|
5474
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5475
|
+
* @summary Clear a limit override of a Domain
|
|
5476
|
+
* @param {string} id
|
|
5477
|
+
* @param {string} limitKey
|
|
5478
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5299
5479
|
* @param {*} [options] Override http request option.
|
|
5300
5480
|
* @throws {RequiredError}
|
|
5301
5481
|
*/
|
|
5302
|
-
async
|
|
5303
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
5482
|
+
async staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options) {
|
|
5483
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options);
|
|
5304
5484
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5305
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
5485
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerClear']?.[localVarOperationServerIndex]
|
|
5486
|
+
?.url;
|
|
5487
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5488
|
+
},
|
|
5489
|
+
/**
|
|
5490
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5491
|
+
* @summary Effective limits of a Domain
|
|
5492
|
+
* @param {string} id
|
|
5493
|
+
* @param {*} [options] Override http request option.
|
|
5494
|
+
* @throws {RequiredError}
|
|
5495
|
+
*/
|
|
5496
|
+
async staffDomainLimitsControllerGet(id, options) {
|
|
5497
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerGet(id, options);
|
|
5498
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5499
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerGet']?.[localVarOperationServerIndex]?.url;
|
|
5500
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5501
|
+
},
|
|
5502
|
+
/**
|
|
5503
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5504
|
+
* @summary Limit override history of a Domain
|
|
5505
|
+
* @param {string} id
|
|
5506
|
+
* @param {*} [options] Override http request option.
|
|
5507
|
+
* @throws {RequiredError}
|
|
5508
|
+
*/
|
|
5509
|
+
async staffDomainLimitsControllerHistory(id, options) {
|
|
5510
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerHistory(id, options);
|
|
5511
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5512
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerHistory']?.[localVarOperationServerIndex]
|
|
5513
|
+
?.url;
|
|
5514
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5515
|
+
},
|
|
5516
|
+
/**
|
|
5517
|
+
* 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`
|
|
5518
|
+
* @summary Override one limit of a Domain
|
|
5519
|
+
* @param {string} id
|
|
5520
|
+
* @param {string} limitKey
|
|
5521
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5522
|
+
* @param {*} [options] Override http request option.
|
|
5523
|
+
* @throws {RequiredError}
|
|
5524
|
+
*/
|
|
5525
|
+
async staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options) {
|
|
5526
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options);
|
|
5527
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5528
|
+
const localVarOperationServerBasePath = operationServerMap['StaffDomainLimitsApi.staffDomainLimitsControllerSet']?.[localVarOperationServerIndex]?.url;
|
|
5306
5529
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5307
5530
|
},
|
|
5308
5531
|
};
|
|
5309
5532
|
};
|
|
5310
5533
|
/**
|
|
5311
|
-
*
|
|
5534
|
+
* StaffDomainLimitsApi - factory interface
|
|
5312
5535
|
* @export
|
|
5313
5536
|
*/
|
|
5314
|
-
export const
|
|
5315
|
-
const localVarFp =
|
|
5537
|
+
export const StaffDomainLimitsApiFactory = function (configuration, basePath, axios) {
|
|
5538
|
+
const localVarFp = StaffDomainLimitsApiFp(configuration);
|
|
5316
5539
|
return {
|
|
5317
5540
|
/**
|
|
5318
|
-
*
|
|
5319
|
-
* @summary
|
|
5541
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5542
|
+
* @summary Clear a limit override of a Domain
|
|
5543
|
+
* @param {string} id
|
|
5544
|
+
* @param {string} limitKey
|
|
5545
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5320
5546
|
* @param {*} [options] Override http request option.
|
|
5321
5547
|
* @throws {RequiredError}
|
|
5322
5548
|
*/
|
|
5323
|
-
|
|
5324
|
-
return localVarFp
|
|
5549
|
+
staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options) {
|
|
5550
|
+
return localVarFp
|
|
5551
|
+
.staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options)
|
|
5552
|
+
.then((request) => request(axios, basePath));
|
|
5325
5553
|
},
|
|
5326
|
-
|
|
5327
|
-
|
|
5328
|
-
|
|
5329
|
-
|
|
5330
|
-
*
|
|
5331
|
-
|
|
5332
|
-
|
|
5554
|
+
/**
|
|
5555
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5556
|
+
* @summary Effective limits of a Domain
|
|
5557
|
+
* @param {string} id
|
|
5558
|
+
* @param {*} [options] Override http request option.
|
|
5559
|
+
* @throws {RequiredError}
|
|
5560
|
+
*/
|
|
5561
|
+
staffDomainLimitsControllerGet(id, options) {
|
|
5562
|
+
return localVarFp.staffDomainLimitsControllerGet(id, options).then((request) => request(axios, basePath));
|
|
5563
|
+
},
|
|
5564
|
+
/**
|
|
5565
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5566
|
+
* @summary Limit override history of a Domain
|
|
5567
|
+
* @param {string} id
|
|
5568
|
+
* @param {*} [options] Override http request option.
|
|
5569
|
+
* @throws {RequiredError}
|
|
5570
|
+
*/
|
|
5571
|
+
staffDomainLimitsControllerHistory(id, options) {
|
|
5572
|
+
return localVarFp.staffDomainLimitsControllerHistory(id, options).then((request) => request(axios, basePath));
|
|
5573
|
+
},
|
|
5574
|
+
/**
|
|
5575
|
+
* 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`
|
|
5576
|
+
* @summary Override one limit of a Domain
|
|
5577
|
+
* @param {string} id
|
|
5578
|
+
* @param {string} limitKey
|
|
5579
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5580
|
+
* @param {*} [options] Override http request option.
|
|
5581
|
+
* @throws {RequiredError}
|
|
5582
|
+
*/
|
|
5583
|
+
staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options) {
|
|
5584
|
+
return localVarFp
|
|
5585
|
+
.staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options)
|
|
5586
|
+
.then((request) => request(axios, basePath));
|
|
5587
|
+
},
|
|
5588
|
+
};
|
|
5589
|
+
};
|
|
5590
|
+
/**
|
|
5591
|
+
* StaffDomainLimitsApi - object-oriented interface
|
|
5592
|
+
* @export
|
|
5593
|
+
* @class StaffDomainLimitsApi
|
|
5594
|
+
* @extends {BaseAPI}
|
|
5595
|
+
*/
|
|
5596
|
+
export class StaffDomainLimitsApi extends BaseAPI {
|
|
5597
|
+
/**
|
|
5598
|
+
* The Plan’s value applies again at once.<br> OperationId: `StaffDomainLimitsControllerClear`
|
|
5599
|
+
* @summary Clear a limit override of a Domain
|
|
5600
|
+
* @param {string} id
|
|
5601
|
+
* @param {string} limitKey
|
|
5602
|
+
* @param {DomainLimitOverrideClearInputDTO} [domainLimitOverrideClearInputDTO] DomainLimitOverrideClearInputDTO
|
|
5603
|
+
* @param {*} [options] Override http request option.
|
|
5604
|
+
* @throws {RequiredError}
|
|
5605
|
+
* @memberof StaffDomainLimitsApi
|
|
5606
|
+
*/
|
|
5607
|
+
staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options) {
|
|
5608
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5609
|
+
.staffDomainLimitsControllerClear(id, limitKey, domainLimitOverrideClearInputDTO, options)
|
|
5610
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5611
|
+
}
|
|
5612
|
+
/**
|
|
5613
|
+
* Every limit with its value and source: the Plan, an override, or `unmanaged` for a Domain with no Plan.<br> OperationId: `StaffDomainLimitsControllerGet`
|
|
5614
|
+
* @summary Effective limits of a Domain
|
|
5615
|
+
* @param {string} id
|
|
5616
|
+
* @param {*} [options] Override http request option.
|
|
5617
|
+
* @throws {RequiredError}
|
|
5618
|
+
* @memberof StaffDomainLimitsApi
|
|
5619
|
+
*/
|
|
5620
|
+
staffDomainLimitsControllerGet(id, options) {
|
|
5621
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5622
|
+
.staffDomainLimitsControllerGet(id, options)
|
|
5623
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5624
|
+
}
|
|
5625
|
+
/**
|
|
5626
|
+
* Newest first.<br> OperationId: `StaffDomainLimitsControllerHistory`
|
|
5627
|
+
* @summary Limit override history of a Domain
|
|
5628
|
+
* @param {string} id
|
|
5629
|
+
* @param {*} [options] Override http request option.
|
|
5630
|
+
* @throws {RequiredError}
|
|
5631
|
+
* @memberof StaffDomainLimitsApi
|
|
5632
|
+
*/
|
|
5633
|
+
staffDomainLimitsControllerHistory(id, options) {
|
|
5634
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5635
|
+
.staffDomainLimitsControllerHistory(id, options)
|
|
5636
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5637
|
+
}
|
|
5638
|
+
/**
|
|
5639
|
+
* 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`
|
|
5640
|
+
* @summary Override one limit of a Domain
|
|
5641
|
+
* @param {string} id
|
|
5642
|
+
* @param {string} limitKey
|
|
5643
|
+
* @param {DomainLimitOverrideInputDTO} [domainLimitOverrideInputDTO] DomainLimitOverrideInputDTO
|
|
5644
|
+
* @param {*} [options] Override http request option.
|
|
5645
|
+
* @throws {RequiredError}
|
|
5646
|
+
* @memberof StaffDomainLimitsApi
|
|
5647
|
+
*/
|
|
5648
|
+
staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options) {
|
|
5649
|
+
return StaffDomainLimitsApiFp(this.configuration)
|
|
5650
|
+
.staffDomainLimitsControllerSet(id, limitKey, domainLimitOverrideInputDTO, options)
|
|
5651
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5652
|
+
}
|
|
5653
|
+
}
|
|
5654
|
+
/**
|
|
5655
|
+
* StaffMeApi - axios parameter creator
|
|
5656
|
+
* @export
|
|
5657
|
+
*/
|
|
5658
|
+
export const StaffMeApiAxiosParamCreator = function (configuration) {
|
|
5659
|
+
return {
|
|
5660
|
+
/**
|
|
5661
|
+
* 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`
|
|
5662
|
+
* @summary Who this Staff session belongs to
|
|
5663
|
+
* @param {*} [options] Override http request option.
|
|
5664
|
+
* @throws {RequiredError}
|
|
5665
|
+
*/
|
|
5666
|
+
staffMeControllerMe: async (options = {}) => {
|
|
5667
|
+
const localVarPath = `/staff/me`;
|
|
5668
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5669
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5670
|
+
let baseOptions;
|
|
5671
|
+
if (configuration) {
|
|
5672
|
+
baseOptions = configuration.baseOptions;
|
|
5673
|
+
}
|
|
5674
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5675
|
+
const localVarHeaderParameter = {};
|
|
5676
|
+
const localVarQueryParameter = {};
|
|
5677
|
+
// authentication staffSession required
|
|
5678
|
+
// authentication adminAuth required
|
|
5679
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5680
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5681
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5682
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5683
|
+
return {
|
|
5684
|
+
url: toPathString(localVarUrlObj),
|
|
5685
|
+
options: localVarRequestOptions,
|
|
5686
|
+
};
|
|
5687
|
+
},
|
|
5688
|
+
};
|
|
5689
|
+
};
|
|
5690
|
+
/**
|
|
5691
|
+
* StaffMeApi - functional programming interface
|
|
5692
|
+
* @export
|
|
5693
|
+
*/
|
|
5694
|
+
export const StaffMeApiFp = function (configuration) {
|
|
5695
|
+
const localVarAxiosParamCreator = StaffMeApiAxiosParamCreator(configuration);
|
|
5696
|
+
return {
|
|
5697
|
+
/**
|
|
5698
|
+
* 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`
|
|
5699
|
+
* @summary Who this Staff session belongs to
|
|
5700
|
+
* @param {*} [options] Override http request option.
|
|
5701
|
+
* @throws {RequiredError}
|
|
5702
|
+
*/
|
|
5703
|
+
async staffMeControllerMe(options) {
|
|
5704
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffMeControllerMe(options);
|
|
5705
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5706
|
+
const localVarOperationServerBasePath = operationServerMap['StaffMeApi.staffMeControllerMe']?.[localVarOperationServerIndex]?.url;
|
|
5707
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5708
|
+
},
|
|
5709
|
+
};
|
|
5710
|
+
};
|
|
5711
|
+
/**
|
|
5712
|
+
* StaffMeApi - factory interface
|
|
5713
|
+
* @export
|
|
5714
|
+
*/
|
|
5715
|
+
export const StaffMeApiFactory = function (configuration, basePath, axios) {
|
|
5716
|
+
const localVarFp = StaffMeApiFp(configuration);
|
|
5717
|
+
return {
|
|
5718
|
+
/**
|
|
5719
|
+
* 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`
|
|
5720
|
+
* @summary Who this Staff session belongs to
|
|
5721
|
+
* @param {*} [options] Override http request option.
|
|
5722
|
+
* @throws {RequiredError}
|
|
5723
|
+
*/
|
|
5724
|
+
staffMeControllerMe(options) {
|
|
5725
|
+
return localVarFp.staffMeControllerMe(options).then((request) => request(axios, basePath));
|
|
5726
|
+
},
|
|
5727
|
+
};
|
|
5728
|
+
};
|
|
5729
|
+
/**
|
|
5730
|
+
* StaffMeApi - object-oriented interface
|
|
5731
|
+
* @export
|
|
5732
|
+
* @class StaffMeApi
|
|
5733
|
+
* @extends {BaseAPI}
|
|
5734
|
+
*/
|
|
5735
|
+
export class StaffMeApi extends BaseAPI {
|
|
5736
|
+
/**
|
|
5737
|
+
* 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`
|
|
5738
|
+
* @summary Who this Staff session belongs to
|
|
5739
|
+
* @param {*} [options] Override http request option.
|
|
5740
|
+
* @throws {RequiredError}
|
|
5741
|
+
* @memberof StaffMeApi
|
|
5742
|
+
*/
|
|
5743
|
+
staffMeControllerMe(options) {
|
|
5744
|
+
return StaffMeApiFp(this.configuration)
|
|
5745
|
+
.staffMeControllerMe(options)
|
|
5746
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5747
|
+
}
|
|
5748
|
+
}
|
|
5749
|
+
/**
|
|
5750
|
+
* StaffPlanApi - axios parameter creator
|
|
5751
|
+
* @export
|
|
5752
|
+
*/
|
|
5753
|
+
export const StaffPlanApiAxiosParamCreator = function (configuration) {
|
|
5754
|
+
return {
|
|
5755
|
+
/**
|
|
5756
|
+
* 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`
|
|
5757
|
+
* @summary Archive a Plan
|
|
5758
|
+
* @param {string} id
|
|
5759
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
5760
|
+
* @param {*} [options] Override http request option.
|
|
5761
|
+
* @throws {RequiredError}
|
|
5762
|
+
*/
|
|
5763
|
+
staffPlanControllerArchive: async (id, planArchiveInputDTO, options = {}) => {
|
|
5764
|
+
// verify required parameter 'id' is not null or undefined
|
|
5765
|
+
assertParamExists('staffPlanControllerArchive', 'id', id);
|
|
5766
|
+
const localVarPath = `/staff/plans/{id}/archive`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5767
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5768
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5769
|
+
let baseOptions;
|
|
5770
|
+
if (configuration) {
|
|
5771
|
+
baseOptions = configuration.baseOptions;
|
|
5772
|
+
}
|
|
5773
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5774
|
+
const localVarHeaderParameter = {};
|
|
5775
|
+
const localVarQueryParameter = {};
|
|
5776
|
+
// authentication staffSession required
|
|
5777
|
+
// authentication adminAuth required
|
|
5778
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5779
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5780
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5781
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5782
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5783
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planArchiveInputDTO, localVarRequestOptions, configuration);
|
|
5784
|
+
return {
|
|
5785
|
+
url: toPathString(localVarUrlObj),
|
|
5786
|
+
options: localVarRequestOptions,
|
|
5787
|
+
};
|
|
5788
|
+
},
|
|
5789
|
+
/**
|
|
5790
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
5791
|
+
* @summary Create a Plan
|
|
5792
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
5793
|
+
* @param {*} [options] Override http request option.
|
|
5794
|
+
* @throws {RequiredError}
|
|
5795
|
+
*/
|
|
5796
|
+
staffPlanControllerCreate: async (planCreateInputDTO, options = {}) => {
|
|
5797
|
+
const localVarPath = `/staff/plans`;
|
|
5798
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5799
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5800
|
+
let baseOptions;
|
|
5801
|
+
if (configuration) {
|
|
5802
|
+
baseOptions = configuration.baseOptions;
|
|
5803
|
+
}
|
|
5804
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5805
|
+
const localVarHeaderParameter = {};
|
|
5806
|
+
const localVarQueryParameter = {};
|
|
5807
|
+
// authentication staffSession required
|
|
5808
|
+
// authentication adminAuth required
|
|
5809
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5810
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5811
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5812
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5813
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5814
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planCreateInputDTO, localVarRequestOptions, configuration);
|
|
5815
|
+
return {
|
|
5816
|
+
url: toPathString(localVarUrlObj),
|
|
5817
|
+
options: localVarRequestOptions,
|
|
5818
|
+
};
|
|
5819
|
+
},
|
|
5820
|
+
/**
|
|
5821
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
5822
|
+
* @summary Change history of a Plan
|
|
5823
|
+
* @param {string} id
|
|
5824
|
+
* @param {*} [options] Override http request option.
|
|
5825
|
+
* @throws {RequiredError}
|
|
5826
|
+
*/
|
|
5827
|
+
staffPlanControllerHistory: async (id, options = {}) => {
|
|
5828
|
+
// verify required parameter 'id' is not null or undefined
|
|
5829
|
+
assertParamExists('staffPlanControllerHistory', 'id', id);
|
|
5830
|
+
const localVarPath = `/staff/plans/{id}/history`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5831
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5832
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5833
|
+
let baseOptions;
|
|
5834
|
+
if (configuration) {
|
|
5835
|
+
baseOptions = configuration.baseOptions;
|
|
5836
|
+
}
|
|
5837
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5838
|
+
const localVarHeaderParameter = {};
|
|
5839
|
+
const localVarQueryParameter = {};
|
|
5840
|
+
// authentication staffSession required
|
|
5841
|
+
// authentication adminAuth required
|
|
5842
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5843
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5844
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5845
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5846
|
+
return {
|
|
5847
|
+
url: toPathString(localVarUrlObj),
|
|
5848
|
+
options: localVarRequestOptions,
|
|
5849
|
+
};
|
|
5850
|
+
},
|
|
5851
|
+
/**
|
|
5852
|
+
* 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`
|
|
5853
|
+
* @summary Import Plans from the billing provider
|
|
5854
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
5855
|
+
* @param {*} [options] Override http request option.
|
|
5856
|
+
* @throws {RequiredError}
|
|
5857
|
+
*/
|
|
5858
|
+
staffPlanControllerImport: async (planImportInputDTO, options = {}) => {
|
|
5859
|
+
const localVarPath = `/staff/plans/import`;
|
|
5860
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5861
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5862
|
+
let baseOptions;
|
|
5863
|
+
if (configuration) {
|
|
5864
|
+
baseOptions = configuration.baseOptions;
|
|
5865
|
+
}
|
|
5866
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5867
|
+
const localVarHeaderParameter = {};
|
|
5868
|
+
const localVarQueryParameter = {};
|
|
5869
|
+
// authentication staffSession required
|
|
5870
|
+
// authentication adminAuth required
|
|
5871
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5872
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5873
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5874
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5875
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5876
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planImportInputDTO, localVarRequestOptions, configuration);
|
|
5877
|
+
return {
|
|
5878
|
+
url: toPathString(localVarUrlObj),
|
|
5879
|
+
options: localVarRequestOptions,
|
|
5880
|
+
};
|
|
5881
|
+
},
|
|
5882
|
+
/**
|
|
5883
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
5884
|
+
* @summary Whether the billing-provider import ran
|
|
5885
|
+
* @param {*} [options] Override http request option.
|
|
5886
|
+
* @throws {RequiredError}
|
|
5887
|
+
*/
|
|
5888
|
+
staffPlanControllerImportStatus: async (options = {}) => {
|
|
5889
|
+
const localVarPath = `/staff/plans/import`;
|
|
5890
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5891
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5892
|
+
let baseOptions;
|
|
5893
|
+
if (configuration) {
|
|
5894
|
+
baseOptions = configuration.baseOptions;
|
|
5895
|
+
}
|
|
5896
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5897
|
+
const localVarHeaderParameter = {};
|
|
5898
|
+
const localVarQueryParameter = {};
|
|
5899
|
+
// authentication staffSession required
|
|
5900
|
+
// authentication adminAuth required
|
|
5901
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5902
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5903
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5904
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5905
|
+
return {
|
|
5906
|
+
url: toPathString(localVarUrlObj),
|
|
5907
|
+
options: localVarRequestOptions,
|
|
5908
|
+
};
|
|
5909
|
+
},
|
|
5910
|
+
/**
|
|
5911
|
+
* 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`
|
|
5912
|
+
* @summary List Plans
|
|
5913
|
+
* @param {any} [includeArchived]
|
|
5914
|
+
* @param {*} [options] Override http request option.
|
|
5915
|
+
* @throws {RequiredError}
|
|
5916
|
+
*/
|
|
5917
|
+
staffPlanControllerList: async (includeArchived, options = {}) => {
|
|
5918
|
+
const localVarPath = `/staff/plans`;
|
|
5919
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5920
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5921
|
+
let baseOptions;
|
|
5922
|
+
if (configuration) {
|
|
5923
|
+
baseOptions = configuration.baseOptions;
|
|
5924
|
+
}
|
|
5925
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5926
|
+
const localVarHeaderParameter = {};
|
|
5927
|
+
const localVarQueryParameter = {};
|
|
5928
|
+
// authentication staffSession required
|
|
5929
|
+
// authentication adminAuth required
|
|
5930
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5931
|
+
if (includeArchived !== undefined) {
|
|
5932
|
+
for (const [key, value] of Object.entries(includeArchived)) {
|
|
5933
|
+
localVarQueryParameter[key] = value;
|
|
5934
|
+
}
|
|
5935
|
+
}
|
|
5936
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5937
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5938
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5939
|
+
return {
|
|
5940
|
+
url: toPathString(localVarUrlObj),
|
|
5941
|
+
options: localVarRequestOptions,
|
|
5942
|
+
};
|
|
5943
|
+
},
|
|
5944
|
+
/**
|
|
5945
|
+
* 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`
|
|
5946
|
+
* @summary The billing provider’s products
|
|
5947
|
+
* @param {*} [options] Override http request option.
|
|
5948
|
+
* @throws {RequiredError}
|
|
5949
|
+
*/
|
|
5950
|
+
staffPlanControllerListStripeProducts: async (options = {}) => {
|
|
5951
|
+
const localVarPath = `/staff/stripe-products`;
|
|
5952
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5953
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5954
|
+
let baseOptions;
|
|
5955
|
+
if (configuration) {
|
|
5956
|
+
baseOptions = configuration.baseOptions;
|
|
5957
|
+
}
|
|
5958
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5959
|
+
const localVarHeaderParameter = {};
|
|
5960
|
+
const localVarQueryParameter = {};
|
|
5961
|
+
// authentication staffSession required
|
|
5962
|
+
// authentication adminAuth required
|
|
5963
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5964
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5965
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5966
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5967
|
+
return {
|
|
5968
|
+
url: toPathString(localVarUrlObj),
|
|
5969
|
+
options: localVarRequestOptions,
|
|
5970
|
+
};
|
|
5971
|
+
},
|
|
5972
|
+
/**
|
|
5973
|
+
* 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`
|
|
5974
|
+
* @summary Preview a Plan edit
|
|
5975
|
+
* @param {string} id
|
|
5976
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
5977
|
+
* @param {*} [options] Override http request option.
|
|
5978
|
+
* @throws {RequiredError}
|
|
5979
|
+
*/
|
|
5980
|
+
staffPlanControllerPreview: async (id, planPreviewInputDTO, options = {}) => {
|
|
5981
|
+
// verify required parameter 'id' is not null or undefined
|
|
5982
|
+
assertParamExists('staffPlanControllerPreview', 'id', id);
|
|
5983
|
+
const localVarPath = `/staff/plans/{id}/preview`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5984
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5985
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5986
|
+
let baseOptions;
|
|
5987
|
+
if (configuration) {
|
|
5988
|
+
baseOptions = configuration.baseOptions;
|
|
5989
|
+
}
|
|
5990
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5991
|
+
const localVarHeaderParameter = {};
|
|
5992
|
+
const localVarQueryParameter = {};
|
|
5993
|
+
// authentication staffSession required
|
|
5994
|
+
// authentication adminAuth required
|
|
5995
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
5996
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5997
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5998
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5999
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6000
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planPreviewInputDTO, localVarRequestOptions, configuration);
|
|
6001
|
+
return {
|
|
6002
|
+
url: toPathString(localVarUrlObj),
|
|
6003
|
+
options: localVarRequestOptions,
|
|
6004
|
+
};
|
|
6005
|
+
},
|
|
6006
|
+
/**
|
|
6007
|
+
* 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`
|
|
6008
|
+
* @summary Update a Plan
|
|
6009
|
+
* @param {string} id
|
|
6010
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
6011
|
+
* @param {*} [options] Override http request option.
|
|
6012
|
+
* @throws {RequiredError}
|
|
6013
|
+
*/
|
|
6014
|
+
staffPlanControllerUpdate: async (id, planUpdateInputDTO, options = {}) => {
|
|
6015
|
+
// verify required parameter 'id' is not null or undefined
|
|
6016
|
+
assertParamExists('staffPlanControllerUpdate', 'id', id);
|
|
6017
|
+
const localVarPath = `/staff/plans/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
6018
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6019
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6020
|
+
let baseOptions;
|
|
6021
|
+
if (configuration) {
|
|
6022
|
+
baseOptions = configuration.baseOptions;
|
|
6023
|
+
}
|
|
6024
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
6025
|
+
const localVarHeaderParameter = {};
|
|
6026
|
+
const localVarQueryParameter = {};
|
|
6027
|
+
// authentication staffSession required
|
|
6028
|
+
// authentication adminAuth required
|
|
6029
|
+
await setApiKeyToObject(localVarHeaderParameter, 'x-takaro-admin-token', configuration);
|
|
6030
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
6031
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6032
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6033
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6034
|
+
localVarRequestOptions.data = serializeDataIfNeeded(planUpdateInputDTO, localVarRequestOptions, configuration);
|
|
6035
|
+
return {
|
|
6036
|
+
url: toPathString(localVarUrlObj),
|
|
6037
|
+
options: localVarRequestOptions,
|
|
6038
|
+
};
|
|
6039
|
+
},
|
|
6040
|
+
};
|
|
6041
|
+
};
|
|
6042
|
+
/**
|
|
6043
|
+
* StaffPlanApi - functional programming interface
|
|
6044
|
+
* @export
|
|
6045
|
+
*/
|
|
6046
|
+
export const StaffPlanApiFp = function (configuration) {
|
|
6047
|
+
const localVarAxiosParamCreator = StaffPlanApiAxiosParamCreator(configuration);
|
|
6048
|
+
return {
|
|
6049
|
+
/**
|
|
6050
|
+
* 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`
|
|
6051
|
+
* @summary Archive a Plan
|
|
6052
|
+
* @param {string} id
|
|
6053
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
6054
|
+
* @param {*} [options] Override http request option.
|
|
6055
|
+
* @throws {RequiredError}
|
|
6056
|
+
*/
|
|
6057
|
+
async staffPlanControllerArchive(id, planArchiveInputDTO, options) {
|
|
6058
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerArchive(id, planArchiveInputDTO, options);
|
|
6059
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6060
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerArchive']?.[localVarOperationServerIndex]?.url;
|
|
6061
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6062
|
+
},
|
|
6063
|
+
/**
|
|
6064
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
6065
|
+
* @summary Create a Plan
|
|
6066
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
6067
|
+
* @param {*} [options] Override http request option.
|
|
6068
|
+
* @throws {RequiredError}
|
|
6069
|
+
*/
|
|
6070
|
+
async staffPlanControllerCreate(planCreateInputDTO, options) {
|
|
6071
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerCreate(planCreateInputDTO, options);
|
|
6072
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6073
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerCreate']?.[localVarOperationServerIndex]?.url;
|
|
6074
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6075
|
+
},
|
|
6076
|
+
/**
|
|
6077
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
6078
|
+
* @summary Change history of a Plan
|
|
6079
|
+
* @param {string} id
|
|
6080
|
+
* @param {*} [options] Override http request option.
|
|
6081
|
+
* @throws {RequiredError}
|
|
6082
|
+
*/
|
|
6083
|
+
async staffPlanControllerHistory(id, options) {
|
|
6084
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerHistory(id, options);
|
|
6085
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6086
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerHistory']?.[localVarOperationServerIndex]?.url;
|
|
6087
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6088
|
+
},
|
|
6089
|
+
/**
|
|
6090
|
+
* 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`
|
|
6091
|
+
* @summary Import Plans from the billing provider
|
|
6092
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
6093
|
+
* @param {*} [options] Override http request option.
|
|
6094
|
+
* @throws {RequiredError}
|
|
6095
|
+
*/
|
|
6096
|
+
async staffPlanControllerImport(planImportInputDTO, options) {
|
|
6097
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerImport(planImportInputDTO, options);
|
|
6098
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6099
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerImport']?.[localVarOperationServerIndex]?.url;
|
|
6100
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6101
|
+
},
|
|
6102
|
+
/**
|
|
6103
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
6104
|
+
* @summary Whether the billing-provider import ran
|
|
6105
|
+
* @param {*} [options] Override http request option.
|
|
6106
|
+
* @throws {RequiredError}
|
|
6107
|
+
*/
|
|
6108
|
+
async staffPlanControllerImportStatus(options) {
|
|
6109
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerImportStatus(options);
|
|
6110
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6111
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerImportStatus']?.[localVarOperationServerIndex]?.url;
|
|
6112
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6113
|
+
},
|
|
6114
|
+
/**
|
|
6115
|
+
* 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`
|
|
6116
|
+
* @summary List Plans
|
|
6117
|
+
* @param {any} [includeArchived]
|
|
6118
|
+
* @param {*} [options] Override http request option.
|
|
6119
|
+
* @throws {RequiredError}
|
|
6120
|
+
*/
|
|
6121
|
+
async staffPlanControllerList(includeArchived, options) {
|
|
6122
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerList(includeArchived, options);
|
|
6123
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6124
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerList']?.[localVarOperationServerIndex]?.url;
|
|
6125
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6126
|
+
},
|
|
6127
|
+
/**
|
|
6128
|
+
* 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`
|
|
6129
|
+
* @summary The billing provider’s products
|
|
6130
|
+
* @param {*} [options] Override http request option.
|
|
6131
|
+
* @throws {RequiredError}
|
|
6132
|
+
*/
|
|
6133
|
+
async staffPlanControllerListStripeProducts(options) {
|
|
6134
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerListStripeProducts(options);
|
|
6135
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6136
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerListStripeProducts']?.[localVarOperationServerIndex]?.url;
|
|
6137
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6138
|
+
},
|
|
6139
|
+
/**
|
|
6140
|
+
* 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`
|
|
6141
|
+
* @summary Preview a Plan edit
|
|
6142
|
+
* @param {string} id
|
|
6143
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
6144
|
+
* @param {*} [options] Override http request option.
|
|
6145
|
+
* @throws {RequiredError}
|
|
6146
|
+
*/
|
|
6147
|
+
async staffPlanControllerPreview(id, planPreviewInputDTO, options) {
|
|
6148
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerPreview(id, planPreviewInputDTO, options);
|
|
6149
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6150
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerPreview']?.[localVarOperationServerIndex]?.url;
|
|
6151
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6152
|
+
},
|
|
6153
|
+
/**
|
|
6154
|
+
* 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`
|
|
6155
|
+
* @summary Update a Plan
|
|
6156
|
+
* @param {string} id
|
|
6157
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
6158
|
+
* @param {*} [options] Override http request option.
|
|
6159
|
+
* @throws {RequiredError}
|
|
6160
|
+
*/
|
|
6161
|
+
async staffPlanControllerUpdate(id, planUpdateInputDTO, options) {
|
|
6162
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffPlanControllerUpdate(id, planUpdateInputDTO, options);
|
|
6163
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6164
|
+
const localVarOperationServerBasePath = operationServerMap['StaffPlanApi.staffPlanControllerUpdate']?.[localVarOperationServerIndex]?.url;
|
|
6165
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6166
|
+
},
|
|
6167
|
+
};
|
|
6168
|
+
};
|
|
6169
|
+
/**
|
|
6170
|
+
* StaffPlanApi - factory interface
|
|
6171
|
+
* @export
|
|
6172
|
+
*/
|
|
6173
|
+
export const StaffPlanApiFactory = function (configuration, basePath, axios) {
|
|
6174
|
+
const localVarFp = StaffPlanApiFp(configuration);
|
|
6175
|
+
return {
|
|
6176
|
+
/**
|
|
6177
|
+
* 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`
|
|
6178
|
+
* @summary Archive a Plan
|
|
6179
|
+
* @param {string} id
|
|
6180
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
6181
|
+
* @param {*} [options] Override http request option.
|
|
6182
|
+
* @throws {RequiredError}
|
|
6183
|
+
*/
|
|
6184
|
+
staffPlanControllerArchive(id, planArchiveInputDTO, options) {
|
|
6185
|
+
return localVarFp
|
|
6186
|
+
.staffPlanControllerArchive(id, planArchiveInputDTO, options)
|
|
6187
|
+
.then((request) => request(axios, basePath));
|
|
6188
|
+
},
|
|
6189
|
+
/**
|
|
6190
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
6191
|
+
* @summary Create a Plan
|
|
6192
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
6193
|
+
* @param {*} [options] Override http request option.
|
|
6194
|
+
* @throws {RequiredError}
|
|
6195
|
+
*/
|
|
6196
|
+
staffPlanControllerCreate(planCreateInputDTO, options) {
|
|
6197
|
+
return localVarFp
|
|
6198
|
+
.staffPlanControllerCreate(planCreateInputDTO, options)
|
|
6199
|
+
.then((request) => request(axios, basePath));
|
|
6200
|
+
},
|
|
6201
|
+
/**
|
|
6202
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
6203
|
+
* @summary Change history of a Plan
|
|
6204
|
+
* @param {string} id
|
|
6205
|
+
* @param {*} [options] Override http request option.
|
|
6206
|
+
* @throws {RequiredError}
|
|
6207
|
+
*/
|
|
6208
|
+
staffPlanControllerHistory(id, options) {
|
|
6209
|
+
return localVarFp.staffPlanControllerHistory(id, options).then((request) => request(axios, basePath));
|
|
6210
|
+
},
|
|
6211
|
+
/**
|
|
6212
|
+
* 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`
|
|
6213
|
+
* @summary Import Plans from the billing provider
|
|
6214
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
6215
|
+
* @param {*} [options] Override http request option.
|
|
6216
|
+
* @throws {RequiredError}
|
|
6217
|
+
*/
|
|
6218
|
+
staffPlanControllerImport(planImportInputDTO, options) {
|
|
6219
|
+
return localVarFp
|
|
6220
|
+
.staffPlanControllerImport(planImportInputDTO, options)
|
|
6221
|
+
.then((request) => request(axios, basePath));
|
|
6222
|
+
},
|
|
6223
|
+
/**
|
|
6224
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
6225
|
+
* @summary Whether the billing-provider import ran
|
|
6226
|
+
* @param {*} [options] Override http request option.
|
|
6227
|
+
* @throws {RequiredError}
|
|
6228
|
+
*/
|
|
6229
|
+
staffPlanControllerImportStatus(options) {
|
|
6230
|
+
return localVarFp.staffPlanControllerImportStatus(options).then((request) => request(axios, basePath));
|
|
6231
|
+
},
|
|
6232
|
+
/**
|
|
6233
|
+
* 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`
|
|
6234
|
+
* @summary List Plans
|
|
6235
|
+
* @param {any} [includeArchived]
|
|
6236
|
+
* @param {*} [options] Override http request option.
|
|
6237
|
+
* @throws {RequiredError}
|
|
6238
|
+
*/
|
|
6239
|
+
staffPlanControllerList(includeArchived, options) {
|
|
6240
|
+
return localVarFp.staffPlanControllerList(includeArchived, options).then((request) => request(axios, basePath));
|
|
6241
|
+
},
|
|
6242
|
+
/**
|
|
6243
|
+
* 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`
|
|
6244
|
+
* @summary The billing provider’s products
|
|
6245
|
+
* @param {*} [options] Override http request option.
|
|
6246
|
+
* @throws {RequiredError}
|
|
6247
|
+
*/
|
|
6248
|
+
staffPlanControllerListStripeProducts(options) {
|
|
6249
|
+
return localVarFp.staffPlanControllerListStripeProducts(options).then((request) => request(axios, basePath));
|
|
6250
|
+
},
|
|
6251
|
+
/**
|
|
6252
|
+
* 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`
|
|
6253
|
+
* @summary Preview a Plan edit
|
|
6254
|
+
* @param {string} id
|
|
6255
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
6256
|
+
* @param {*} [options] Override http request option.
|
|
6257
|
+
* @throws {RequiredError}
|
|
6258
|
+
*/
|
|
6259
|
+
staffPlanControllerPreview(id, planPreviewInputDTO, options) {
|
|
6260
|
+
return localVarFp
|
|
6261
|
+
.staffPlanControllerPreview(id, planPreviewInputDTO, options)
|
|
6262
|
+
.then((request) => request(axios, basePath));
|
|
6263
|
+
},
|
|
6264
|
+
/**
|
|
6265
|
+
* 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`
|
|
6266
|
+
* @summary Update a Plan
|
|
6267
|
+
* @param {string} id
|
|
6268
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
6269
|
+
* @param {*} [options] Override http request option.
|
|
6270
|
+
* @throws {RequiredError}
|
|
6271
|
+
*/
|
|
6272
|
+
staffPlanControllerUpdate(id, planUpdateInputDTO, options) {
|
|
6273
|
+
return localVarFp
|
|
6274
|
+
.staffPlanControllerUpdate(id, planUpdateInputDTO, options)
|
|
6275
|
+
.then((request) => request(axios, basePath));
|
|
6276
|
+
},
|
|
6277
|
+
};
|
|
6278
|
+
};
|
|
6279
|
+
/**
|
|
6280
|
+
* StaffPlanApi - object-oriented interface
|
|
6281
|
+
* @export
|
|
6282
|
+
* @class StaffPlanApi
|
|
6283
|
+
* @extends {BaseAPI}
|
|
5333
6284
|
*/
|
|
5334
6285
|
export class StaffPlanApi extends BaseAPI {
|
|
5335
6286
|
/**
|
|
5336
|
-
*
|
|
5337
|
-
* @summary
|
|
6287
|
+
* 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`
|
|
6288
|
+
* @summary Archive a Plan
|
|
6289
|
+
* @param {string} id
|
|
6290
|
+
* @param {PlanArchiveInputDTO} [planArchiveInputDTO] PlanArchiveInputDTO
|
|
6291
|
+
* @param {*} [options] Override http request option.
|
|
6292
|
+
* @throws {RequiredError}
|
|
6293
|
+
* @memberof StaffPlanApi
|
|
6294
|
+
*/
|
|
6295
|
+
staffPlanControllerArchive(id, planArchiveInputDTO, options) {
|
|
6296
|
+
return StaffPlanApiFp(this.configuration)
|
|
6297
|
+
.staffPlanControllerArchive(id, planArchiveInputDTO, options)
|
|
6298
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6299
|
+
}
|
|
6300
|
+
/**
|
|
6301
|
+
* Omitted limits take the Domain column defaults. Recorded with who, when and the reason.<br> OperationId: `StaffPlanControllerCreate`
|
|
6302
|
+
* @summary Create a Plan
|
|
6303
|
+
* @param {PlanCreateInputDTO} [planCreateInputDTO] PlanCreateInputDTO
|
|
6304
|
+
* @param {*} [options] Override http request option.
|
|
6305
|
+
* @throws {RequiredError}
|
|
6306
|
+
* @memberof StaffPlanApi
|
|
6307
|
+
*/
|
|
6308
|
+
staffPlanControllerCreate(planCreateInputDTO, options) {
|
|
6309
|
+
return StaffPlanApiFp(this.configuration)
|
|
6310
|
+
.staffPlanControllerCreate(planCreateInputDTO, options)
|
|
6311
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6312
|
+
}
|
|
6313
|
+
/**
|
|
6314
|
+
* Newest first, each with the Plan as it was after.<br> OperationId: `StaffPlanControllerHistory`
|
|
6315
|
+
* @summary Change history of a Plan
|
|
6316
|
+
* @param {string} id
|
|
6317
|
+
* @param {*} [options] Override http request option.
|
|
6318
|
+
* @throws {RequiredError}
|
|
6319
|
+
* @memberof StaffPlanApi
|
|
6320
|
+
*/
|
|
6321
|
+
staffPlanControllerHistory(id, options) {
|
|
6322
|
+
return StaffPlanApiFp(this.configuration)
|
|
6323
|
+
.staffPlanControllerHistory(id, options)
|
|
6324
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6325
|
+
}
|
|
6326
|
+
/**
|
|
6327
|
+
* 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`
|
|
6328
|
+
* @summary Import Plans from the billing provider
|
|
6329
|
+
* @param {PlanImportInputDTO} [planImportInputDTO] PlanImportInputDTO
|
|
6330
|
+
* @param {*} [options] Override http request option.
|
|
6331
|
+
* @throws {RequiredError}
|
|
6332
|
+
* @memberof StaffPlanApi
|
|
6333
|
+
*/
|
|
6334
|
+
staffPlanControllerImport(planImportInputDTO, options) {
|
|
6335
|
+
return StaffPlanApiFp(this.configuration)
|
|
6336
|
+
.staffPlanControllerImport(planImportInputDTO, options)
|
|
6337
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6338
|
+
}
|
|
6339
|
+
/**
|
|
6340
|
+
* True once an import has created any Plan, even if those Plans were later unlinked or archived.<br> OperationId: `StaffPlanControllerImportStatus`
|
|
6341
|
+
* @summary Whether the billing-provider import ran
|
|
6342
|
+
* @param {*} [options] Override http request option.
|
|
6343
|
+
* @throws {RequiredError}
|
|
6344
|
+
* @memberof StaffPlanApi
|
|
6345
|
+
*/
|
|
6346
|
+
staffPlanControllerImportStatus(options) {
|
|
6347
|
+
return StaffPlanApiFp(this.configuration)
|
|
6348
|
+
.staffPlanControllerImportStatus(options)
|
|
6349
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6350
|
+
}
|
|
6351
|
+
/**
|
|
6352
|
+
* 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`
|
|
6353
|
+
* @summary List Plans
|
|
6354
|
+
* @param {any} [includeArchived]
|
|
6355
|
+
* @param {*} [options] Override http request option.
|
|
6356
|
+
* @throws {RequiredError}
|
|
6357
|
+
* @memberof StaffPlanApi
|
|
6358
|
+
*/
|
|
6359
|
+
staffPlanControllerList(includeArchived, options) {
|
|
6360
|
+
return StaffPlanApiFp(this.configuration)
|
|
6361
|
+
.staffPlanControllerList(includeArchived, options)
|
|
6362
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6363
|
+
}
|
|
6364
|
+
/**
|
|
6365
|
+
* 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`
|
|
6366
|
+
* @summary The billing provider’s products
|
|
6367
|
+
* @param {*} [options] Override http request option.
|
|
6368
|
+
* @throws {RequiredError}
|
|
6369
|
+
* @memberof StaffPlanApi
|
|
6370
|
+
*/
|
|
6371
|
+
staffPlanControllerListStripeProducts(options) {
|
|
6372
|
+
return StaffPlanApiFp(this.configuration)
|
|
6373
|
+
.staffPlanControllerListStripeProducts(options)
|
|
6374
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6375
|
+
}
|
|
6376
|
+
/**
|
|
6377
|
+
* 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`
|
|
6378
|
+
* @summary Preview a Plan edit
|
|
6379
|
+
* @param {string} id
|
|
6380
|
+
* @param {PlanPreviewInputDTO} [planPreviewInputDTO] PlanPreviewInputDTO
|
|
6381
|
+
* @param {*} [options] Override http request option.
|
|
6382
|
+
* @throws {RequiredError}
|
|
6383
|
+
* @memberof StaffPlanApi
|
|
6384
|
+
*/
|
|
6385
|
+
staffPlanControllerPreview(id, planPreviewInputDTO, options) {
|
|
6386
|
+
return StaffPlanApiFp(this.configuration)
|
|
6387
|
+
.staffPlanControllerPreview(id, planPreviewInputDTO, options)
|
|
6388
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6389
|
+
}
|
|
6390
|
+
/**
|
|
6391
|
+
* 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`
|
|
6392
|
+
* @summary Update a Plan
|
|
6393
|
+
* @param {string} id
|
|
6394
|
+
* @param {PlanUpdateInputDTO} [planUpdateInputDTO] PlanUpdateInputDTO
|
|
5338
6395
|
* @param {*} [options] Override http request option.
|
|
5339
6396
|
* @throws {RequiredError}
|
|
5340
6397
|
* @memberof StaffPlanApi
|
|
5341
6398
|
*/
|
|
5342
|
-
|
|
6399
|
+
staffPlanControllerUpdate(id, planUpdateInputDTO, options) {
|
|
5343
6400
|
return StaffPlanApiFp(this.configuration)
|
|
5344
|
-
.
|
|
6401
|
+
.staffPlanControllerUpdate(id, planUpdateInputDTO, options)
|
|
5345
6402
|
.then((request) => request(this.axios, this.basePath));
|
|
5346
6403
|
}
|
|
5347
6404
|
}
|