@takaro/apiclient 0.0.0-dev.2446c45 → 0.0.0-dev.2513f9a
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/README.md +27 -0
- package/dist/generated/api.d.ts +1527 -607
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/generated/api.js +2084 -1409
- package/dist/generated/api.js.map +1 -1
- package/dist/generated-management/api.d.ts +14494 -0
- package/dist/generated-management/api.d.ts.map +1 -0
- package/dist/generated-management/api.js +3413 -0
- package/dist/generated-management/api.js.map +1 -0
- package/dist/generated-management/base.d.ts +67 -0
- package/dist/generated-management/base.d.ts.map +1 -0
- package/dist/generated-management/base.js +59 -0
- package/dist/generated-management/base.js.map +1 -0
- package/dist/generated-management/common.d.ts +66 -0
- package/dist/generated-management/common.d.ts.map +1 -0
- package/dist/generated-management/common.js +135 -0
- package/dist/generated-management/common.js.map +1 -0
- package/dist/generated-management/configuration.d.ts +92 -0
- package/dist/generated-management/configuration.d.ts.map +1 -0
- package/dist/generated-management/configuration.js +46 -0
- package/dist/generated-management/configuration.js.map +1 -0
- package/dist/generated-management/index.d.ts +14 -0
- package/dist/generated-management/index.d.ts.map +1 -0
- package/dist/generated-management/index.js +16 -0
- package/dist/generated-management/index.js.map +1 -0
- package/dist/lib/adminClient.d.ts +2 -1
- package/dist/lib/adminClient.d.ts.map +1 -1
- package/dist/lib/adminClient.js +6 -1
- package/dist/lib/adminClient.js.map +1 -1
- package/dist/lib/apiKey.d.ts +18 -0
- package/dist/lib/apiKey.d.ts.map +1 -0
- package/dist/lib/apiKey.js +71 -0
- package/dist/lib/apiKey.js.map +1 -0
- package/dist/lib/client.d.ts +30 -1
- package/dist/lib/client.d.ts.map +1 -1
- package/dist/lib/client.js +47 -2
- package/dist/lib/client.js.map +1 -1
- package/dist/lib/distributorClient.d.ts +18 -0
- package/dist/lib/distributorClient.d.ts.map +1 -0
- package/dist/lib/distributorClient.js +21 -0
- package/dist/lib/distributorClient.js.map +1 -0
- package/dist/main.d.ts +4 -0
- package/dist/main.d.ts.map +1 -1
- package/dist/main.js +7 -0
- package/dist/main.js.map +1 -1
- package/package.json +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -234,6 +234,653 @@ export declare const AnalyticsQueryDTOPeriodEnum: {
|
|
|
234
234
|
readonly _90d: "90d";
|
|
235
235
|
};
|
|
236
236
|
export type AnalyticsQueryDTOPeriodEnum = (typeof AnalyticsQueryDTOPeriodEnum)[keyof typeof AnalyticsQueryDTOPeriodEnum];
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* @export
|
|
240
|
+
* @interface ApiKeyCreateInputDTO
|
|
241
|
+
*/
|
|
242
|
+
export interface ApiKeyCreateInputDTO {
|
|
243
|
+
/**
|
|
244
|
+
*
|
|
245
|
+
* @type {string}
|
|
246
|
+
* @memberof ApiKeyCreateInputDTO
|
|
247
|
+
*/
|
|
248
|
+
name: string;
|
|
249
|
+
/**
|
|
250
|
+
*
|
|
251
|
+
* @type {Array<string>}
|
|
252
|
+
* @memberof ApiKeyCreateInputDTO
|
|
253
|
+
*/
|
|
254
|
+
scope?: Array<string>;
|
|
255
|
+
/**
|
|
256
|
+
*
|
|
257
|
+
* @type {Array<string>}
|
|
258
|
+
* @memberof ApiKeyCreateInputDTO
|
|
259
|
+
*/
|
|
260
|
+
ipAllowlist?: Array<string>;
|
|
261
|
+
/**
|
|
262
|
+
*
|
|
263
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
264
|
+
* @memberof ApiKeyCreateInputDTO
|
|
265
|
+
*/
|
|
266
|
+
expiresAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
267
|
+
/**
|
|
268
|
+
*
|
|
269
|
+
* @type {string}
|
|
270
|
+
* @memberof ApiKeyCreateInputDTO
|
|
271
|
+
*/
|
|
272
|
+
kind?: ApiKeyCreateInputDTOKindEnum;
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @type {Array<string>}
|
|
276
|
+
* @memberof ApiKeyCreateInputDTO
|
|
277
|
+
*/
|
|
278
|
+
roleIds?: Array<string>;
|
|
279
|
+
}
|
|
280
|
+
export declare const ApiKeyCreateInputDTOKindEnum: {
|
|
281
|
+
readonly Personal: "personal";
|
|
282
|
+
readonly Domain: "domain";
|
|
283
|
+
};
|
|
284
|
+
export type ApiKeyCreateInputDTOKindEnum = (typeof ApiKeyCreateInputDTOKindEnum)[keyof typeof ApiKeyCreateInputDTOKindEnum];
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @export
|
|
288
|
+
* @interface ApiKeyCreateResultDTO
|
|
289
|
+
*/
|
|
290
|
+
export interface ApiKeyCreateResultDTO {
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof ApiKeyCreateResultDTO
|
|
295
|
+
*/
|
|
296
|
+
key: string;
|
|
297
|
+
/**
|
|
298
|
+
*
|
|
299
|
+
* @type {string}
|
|
300
|
+
* @memberof ApiKeyCreateResultDTO
|
|
301
|
+
*/
|
|
302
|
+
id: string;
|
|
303
|
+
/**
|
|
304
|
+
*
|
|
305
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
306
|
+
* @memberof ApiKeyCreateResultDTO
|
|
307
|
+
*/
|
|
308
|
+
createdAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
309
|
+
/**
|
|
310
|
+
*
|
|
311
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
312
|
+
* @memberof ApiKeyCreateResultDTO
|
|
313
|
+
*/
|
|
314
|
+
updatedAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
315
|
+
/**
|
|
316
|
+
*
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof ApiKeyCreateResultDTO
|
|
319
|
+
*/
|
|
320
|
+
userId: string;
|
|
321
|
+
/**
|
|
322
|
+
*
|
|
323
|
+
* @type {string}
|
|
324
|
+
* @memberof ApiKeyCreateResultDTO
|
|
325
|
+
*/
|
|
326
|
+
name: string;
|
|
327
|
+
/**
|
|
328
|
+
*
|
|
329
|
+
* @type {string}
|
|
330
|
+
* @memberof ApiKeyCreateResultDTO
|
|
331
|
+
*/
|
|
332
|
+
kind: ApiKeyCreateResultDTOKindEnum;
|
|
333
|
+
/**
|
|
334
|
+
*
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof ApiKeyCreateResultDTO
|
|
337
|
+
*/
|
|
338
|
+
keyPrefix: string;
|
|
339
|
+
/**
|
|
340
|
+
*
|
|
341
|
+
* @type {string}
|
|
342
|
+
* @memberof ApiKeyCreateResultDTO
|
|
343
|
+
*/
|
|
344
|
+
keySuffix: string;
|
|
345
|
+
/**
|
|
346
|
+
*
|
|
347
|
+
* @type {Array<string>}
|
|
348
|
+
* @memberof ApiKeyCreateResultDTO
|
|
349
|
+
*/
|
|
350
|
+
scope?: Array<string>;
|
|
351
|
+
/**
|
|
352
|
+
*
|
|
353
|
+
* @type {Array<string>}
|
|
354
|
+
* @memberof ApiKeyCreateResultDTO
|
|
355
|
+
*/
|
|
356
|
+
ipAllowlist?: Array<string>;
|
|
357
|
+
/**
|
|
358
|
+
*
|
|
359
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
360
|
+
* @memberof ApiKeyCreateResultDTO
|
|
361
|
+
*/
|
|
362
|
+
expiresAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
363
|
+
/**
|
|
364
|
+
*
|
|
365
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
366
|
+
* @memberof ApiKeyCreateResultDTO
|
|
367
|
+
*/
|
|
368
|
+
lastUsedAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
369
|
+
/**
|
|
370
|
+
*
|
|
371
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
372
|
+
* @memberof ApiKeyCreateResultDTO
|
|
373
|
+
*/
|
|
374
|
+
revokedAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
375
|
+
/**
|
|
376
|
+
*
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof ApiKeyCreateResultDTO
|
|
379
|
+
*/
|
|
380
|
+
createdBy?: string;
|
|
381
|
+
/**
|
|
382
|
+
*
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof ApiKeyCreateResultDTO
|
|
385
|
+
*/
|
|
386
|
+
status: ApiKeyCreateResultDTOStatusEnum;
|
|
387
|
+
/**
|
|
388
|
+
*
|
|
389
|
+
* @type {boolean}
|
|
390
|
+
* @memberof ApiKeyCreateResultDTO
|
|
391
|
+
*/
|
|
392
|
+
exceedsOwner: boolean;
|
|
393
|
+
/**
|
|
394
|
+
*
|
|
395
|
+
* @type {Array<string>}
|
|
396
|
+
* @memberof ApiKeyCreateResultDTO
|
|
397
|
+
*/
|
|
398
|
+
roleIds: Array<string>;
|
|
399
|
+
}
|
|
400
|
+
export declare const ApiKeyCreateResultDTOKindEnum: {
|
|
401
|
+
readonly Personal: "personal";
|
|
402
|
+
readonly Domain: "domain";
|
|
403
|
+
};
|
|
404
|
+
export type ApiKeyCreateResultDTOKindEnum = (typeof ApiKeyCreateResultDTOKindEnum)[keyof typeof ApiKeyCreateResultDTOKindEnum];
|
|
405
|
+
export declare const ApiKeyCreateResultDTOStatusEnum: {
|
|
406
|
+
readonly Active: "ACTIVE";
|
|
407
|
+
readonly Expired: "EXPIRED";
|
|
408
|
+
readonly Revoked: "REVOKED";
|
|
409
|
+
};
|
|
410
|
+
export type ApiKeyCreateResultDTOStatusEnum = (typeof ApiKeyCreateResultDTOStatusEnum)[keyof typeof ApiKeyCreateResultDTOStatusEnum];
|
|
411
|
+
/**
|
|
412
|
+
*
|
|
413
|
+
* @export
|
|
414
|
+
* @interface ApiKeyCreateResultDTOAPI
|
|
415
|
+
*/
|
|
416
|
+
export interface ApiKeyCreateResultDTOAPI {
|
|
417
|
+
/**
|
|
418
|
+
*
|
|
419
|
+
* @type {ApiKeyCreateResultDTO}
|
|
420
|
+
* @memberof ApiKeyCreateResultDTOAPI
|
|
421
|
+
*/
|
|
422
|
+
data: ApiKeyCreateResultDTO;
|
|
423
|
+
/**
|
|
424
|
+
*
|
|
425
|
+
* @type {MetadataOutput}
|
|
426
|
+
* @memberof ApiKeyCreateResultDTOAPI
|
|
427
|
+
*/
|
|
428
|
+
meta: MetadataOutput;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
*
|
|
432
|
+
* @export
|
|
433
|
+
* @interface ApiKeyOutputArrayDTOAPI
|
|
434
|
+
*/
|
|
435
|
+
export interface ApiKeyOutputArrayDTOAPI {
|
|
436
|
+
/**
|
|
437
|
+
*
|
|
438
|
+
* @type {Array<ApiKeyOutputDTO>}
|
|
439
|
+
* @memberof ApiKeyOutputArrayDTOAPI
|
|
440
|
+
*/
|
|
441
|
+
data: Array<ApiKeyOutputDTO>;
|
|
442
|
+
/**
|
|
443
|
+
*
|
|
444
|
+
* @type {MetadataOutput}
|
|
445
|
+
* @memberof ApiKeyOutputArrayDTOAPI
|
|
446
|
+
*/
|
|
447
|
+
meta: MetadataOutput;
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
*
|
|
451
|
+
* @export
|
|
452
|
+
* @interface ApiKeyOutputDTO
|
|
453
|
+
*/
|
|
454
|
+
export interface ApiKeyOutputDTO {
|
|
455
|
+
/**
|
|
456
|
+
*
|
|
457
|
+
* @type {string}
|
|
458
|
+
* @memberof ApiKeyOutputDTO
|
|
459
|
+
*/
|
|
460
|
+
userId: string;
|
|
461
|
+
/**
|
|
462
|
+
*
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof ApiKeyOutputDTO
|
|
465
|
+
*/
|
|
466
|
+
name: string;
|
|
467
|
+
/**
|
|
468
|
+
*
|
|
469
|
+
* @type {string}
|
|
470
|
+
* @memberof ApiKeyOutputDTO
|
|
471
|
+
*/
|
|
472
|
+
kind: ApiKeyOutputDTOKindEnum;
|
|
473
|
+
/**
|
|
474
|
+
*
|
|
475
|
+
* @type {string}
|
|
476
|
+
* @memberof ApiKeyOutputDTO
|
|
477
|
+
*/
|
|
478
|
+
keyPrefix: string;
|
|
479
|
+
/**
|
|
480
|
+
*
|
|
481
|
+
* @type {string}
|
|
482
|
+
* @memberof ApiKeyOutputDTO
|
|
483
|
+
*/
|
|
484
|
+
keySuffix: string;
|
|
485
|
+
/**
|
|
486
|
+
*
|
|
487
|
+
* @type {Array<string>}
|
|
488
|
+
* @memberof ApiKeyOutputDTO
|
|
489
|
+
*/
|
|
490
|
+
scope?: Array<string>;
|
|
491
|
+
/**
|
|
492
|
+
*
|
|
493
|
+
* @type {Array<string>}
|
|
494
|
+
* @memberof ApiKeyOutputDTO
|
|
495
|
+
*/
|
|
496
|
+
ipAllowlist?: Array<string>;
|
|
497
|
+
/**
|
|
498
|
+
*
|
|
499
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
500
|
+
* @memberof ApiKeyOutputDTO
|
|
501
|
+
*/
|
|
502
|
+
expiresAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
503
|
+
/**
|
|
504
|
+
*
|
|
505
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
506
|
+
* @memberof ApiKeyOutputDTO
|
|
507
|
+
*/
|
|
508
|
+
lastUsedAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
509
|
+
/**
|
|
510
|
+
*
|
|
511
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
512
|
+
* @memberof ApiKeyOutputDTO
|
|
513
|
+
*/
|
|
514
|
+
revokedAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
515
|
+
/**
|
|
516
|
+
*
|
|
517
|
+
* @type {string}
|
|
518
|
+
* @memberof ApiKeyOutputDTO
|
|
519
|
+
*/
|
|
520
|
+
createdBy?: string;
|
|
521
|
+
/**
|
|
522
|
+
*
|
|
523
|
+
* @type {string}
|
|
524
|
+
* @memberof ApiKeyOutputDTO
|
|
525
|
+
*/
|
|
526
|
+
status: ApiKeyOutputDTOStatusEnum;
|
|
527
|
+
/**
|
|
528
|
+
*
|
|
529
|
+
* @type {boolean}
|
|
530
|
+
* @memberof ApiKeyOutputDTO
|
|
531
|
+
*/
|
|
532
|
+
exceedsOwner: boolean;
|
|
533
|
+
/**
|
|
534
|
+
*
|
|
535
|
+
* @type {Array<string>}
|
|
536
|
+
* @memberof ApiKeyOutputDTO
|
|
537
|
+
*/
|
|
538
|
+
roleIds: Array<string>;
|
|
539
|
+
/**
|
|
540
|
+
*
|
|
541
|
+
* @type {string}
|
|
542
|
+
* @memberof ApiKeyOutputDTO
|
|
543
|
+
*/
|
|
544
|
+
id: string;
|
|
545
|
+
/**
|
|
546
|
+
*
|
|
547
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
548
|
+
* @memberof ApiKeyOutputDTO
|
|
549
|
+
*/
|
|
550
|
+
createdAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
551
|
+
/**
|
|
552
|
+
*
|
|
553
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
554
|
+
* @memberof ApiKeyOutputDTO
|
|
555
|
+
*/
|
|
556
|
+
updatedAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
557
|
+
}
|
|
558
|
+
export declare const ApiKeyOutputDTOKindEnum: {
|
|
559
|
+
readonly Personal: "personal";
|
|
560
|
+
readonly Domain: "domain";
|
|
561
|
+
};
|
|
562
|
+
export type ApiKeyOutputDTOKindEnum = (typeof ApiKeyOutputDTOKindEnum)[keyof typeof ApiKeyOutputDTOKindEnum];
|
|
563
|
+
export declare const ApiKeyOutputDTOStatusEnum: {
|
|
564
|
+
readonly Active: "ACTIVE";
|
|
565
|
+
readonly Expired: "EXPIRED";
|
|
566
|
+
readonly Revoked: "REVOKED";
|
|
567
|
+
};
|
|
568
|
+
export type ApiKeyOutputDTOStatusEnum = (typeof ApiKeyOutputDTOStatusEnum)[keyof typeof ApiKeyOutputDTOStatusEnum];
|
|
569
|
+
/**
|
|
570
|
+
*
|
|
571
|
+
* @export
|
|
572
|
+
* @interface ApiKeyOutputDTOAPI
|
|
573
|
+
*/
|
|
574
|
+
export interface ApiKeyOutputDTOAPI {
|
|
575
|
+
/**
|
|
576
|
+
*
|
|
577
|
+
* @type {ApiKeyOutputDTO}
|
|
578
|
+
* @memberof ApiKeyOutputDTOAPI
|
|
579
|
+
*/
|
|
580
|
+
data: ApiKeyOutputDTO;
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @type {MetadataOutput}
|
|
584
|
+
* @memberof ApiKeyOutputDTOAPI
|
|
585
|
+
*/
|
|
586
|
+
meta: MetadataOutput;
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
*
|
|
590
|
+
* @export
|
|
591
|
+
* @interface ApiKeySearchInputAllowedFilters
|
|
592
|
+
*/
|
|
593
|
+
export interface ApiKeySearchInputAllowedFilters {
|
|
594
|
+
/**
|
|
595
|
+
*
|
|
596
|
+
* @type {Array<string>}
|
|
597
|
+
* @memberof ApiKeySearchInputAllowedFilters
|
|
598
|
+
*/
|
|
599
|
+
userId?: Array<string>;
|
|
600
|
+
/**
|
|
601
|
+
*
|
|
602
|
+
* @type {Array<string>}
|
|
603
|
+
* @memberof ApiKeySearchInputAllowedFilters
|
|
604
|
+
*/
|
|
605
|
+
kind?: Array<ApiKeySearchInputAllowedFiltersKindEnum>;
|
|
606
|
+
/**
|
|
607
|
+
*
|
|
608
|
+
* @type {Array<string>}
|
|
609
|
+
* @memberof ApiKeySearchInputAllowedFilters
|
|
610
|
+
*/
|
|
611
|
+
id?: Array<string>;
|
|
612
|
+
}
|
|
613
|
+
export declare const ApiKeySearchInputAllowedFiltersKindEnum: {
|
|
614
|
+
readonly Personal: "personal";
|
|
615
|
+
readonly Domain: "domain";
|
|
616
|
+
};
|
|
617
|
+
export type ApiKeySearchInputAllowedFiltersKindEnum = (typeof ApiKeySearchInputAllowedFiltersKindEnum)[keyof typeof ApiKeySearchInputAllowedFiltersKindEnum];
|
|
618
|
+
/**
|
|
619
|
+
*
|
|
620
|
+
* @export
|
|
621
|
+
* @interface ApiKeySearchInputAllowedRangeFilter
|
|
622
|
+
*/
|
|
623
|
+
export interface ApiKeySearchInputAllowedRangeFilter {
|
|
624
|
+
/**
|
|
625
|
+
*
|
|
626
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
627
|
+
* @memberof ApiKeySearchInputAllowedRangeFilter
|
|
628
|
+
*/
|
|
629
|
+
lastUsedAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
630
|
+
/**
|
|
631
|
+
*
|
|
632
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
633
|
+
* @memberof ApiKeySearchInputAllowedRangeFilter
|
|
634
|
+
*/
|
|
635
|
+
expiresAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
636
|
+
/**
|
|
637
|
+
*
|
|
638
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
639
|
+
* @memberof ApiKeySearchInputAllowedRangeFilter
|
|
640
|
+
*/
|
|
641
|
+
createdAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
642
|
+
/**
|
|
643
|
+
*
|
|
644
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
645
|
+
* @memberof ApiKeySearchInputAllowedRangeFilter
|
|
646
|
+
*/
|
|
647
|
+
updatedAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
*
|
|
651
|
+
* @export
|
|
652
|
+
* @interface ApiKeySearchInputAllowedSearch
|
|
653
|
+
*/
|
|
654
|
+
export interface ApiKeySearchInputAllowedSearch {
|
|
655
|
+
/**
|
|
656
|
+
*
|
|
657
|
+
* @type {Array<string>}
|
|
658
|
+
* @memberof ApiKeySearchInputAllowedSearch
|
|
659
|
+
*/
|
|
660
|
+
name?: Array<string>;
|
|
661
|
+
}
|
|
662
|
+
/**
|
|
663
|
+
*
|
|
664
|
+
* @export
|
|
665
|
+
* @interface ApiKeySearchInputDTO
|
|
666
|
+
*/
|
|
667
|
+
export interface ApiKeySearchInputDTO {
|
|
668
|
+
/**
|
|
669
|
+
*
|
|
670
|
+
* @type {ApiKeySearchInputAllowedFilters}
|
|
671
|
+
* @memberof ApiKeySearchInputDTO
|
|
672
|
+
*/
|
|
673
|
+
filters?: ApiKeySearchInputAllowedFilters;
|
|
674
|
+
/**
|
|
675
|
+
*
|
|
676
|
+
* @type {ApiKeySearchInputAllowedSearch}
|
|
677
|
+
* @memberof ApiKeySearchInputDTO
|
|
678
|
+
*/
|
|
679
|
+
search?: ApiKeySearchInputAllowedSearch;
|
|
680
|
+
/**
|
|
681
|
+
*
|
|
682
|
+
* @type {ApiKeySearchInputAllowedRangeFilter}
|
|
683
|
+
* @memberof ApiKeySearchInputDTO
|
|
684
|
+
*/
|
|
685
|
+
greaterThan?: ApiKeySearchInputAllowedRangeFilter;
|
|
686
|
+
/**
|
|
687
|
+
*
|
|
688
|
+
* @type {ApiKeySearchInputAllowedRangeFilter}
|
|
689
|
+
* @memberof ApiKeySearchInputDTO
|
|
690
|
+
*/
|
|
691
|
+
lessThan?: ApiKeySearchInputAllowedRangeFilter;
|
|
692
|
+
/**
|
|
693
|
+
*
|
|
694
|
+
* @type {number}
|
|
695
|
+
* @memberof ApiKeySearchInputDTO
|
|
696
|
+
*/
|
|
697
|
+
page?: number;
|
|
698
|
+
/**
|
|
699
|
+
*
|
|
700
|
+
* @type {number}
|
|
701
|
+
* @memberof ApiKeySearchInputDTO
|
|
702
|
+
*/
|
|
703
|
+
limit?: number;
|
|
704
|
+
/**
|
|
705
|
+
*
|
|
706
|
+
* @type {string}
|
|
707
|
+
* @memberof ApiKeySearchInputDTO
|
|
708
|
+
*/
|
|
709
|
+
sortBy?: string;
|
|
710
|
+
/**
|
|
711
|
+
*
|
|
712
|
+
* @type {string}
|
|
713
|
+
* @memberof ApiKeySearchInputDTO
|
|
714
|
+
*/
|
|
715
|
+
sortDirection?: ApiKeySearchInputDTOSortDirectionEnum;
|
|
716
|
+
/**
|
|
717
|
+
*
|
|
718
|
+
* @type {Array<string>}
|
|
719
|
+
* @memberof ApiKeySearchInputDTO
|
|
720
|
+
*/
|
|
721
|
+
extend?: Array<string>;
|
|
722
|
+
}
|
|
723
|
+
export declare const ApiKeySearchInputDTOSortDirectionEnum: {
|
|
724
|
+
readonly Asc: "asc";
|
|
725
|
+
readonly Desc: "desc";
|
|
726
|
+
};
|
|
727
|
+
export type ApiKeySearchInputDTOSortDirectionEnum = (typeof ApiKeySearchInputDTOSortDirectionEnum)[keyof typeof ApiKeySearchInputDTOSortDirectionEnum];
|
|
728
|
+
/**
|
|
729
|
+
*
|
|
730
|
+
* @export
|
|
731
|
+
* @interface ApiKeyUpdateDTO
|
|
732
|
+
*/
|
|
733
|
+
export interface ApiKeyUpdateDTO {
|
|
734
|
+
/**
|
|
735
|
+
*
|
|
736
|
+
* @type {string}
|
|
737
|
+
* @memberof ApiKeyUpdateDTO
|
|
738
|
+
*/
|
|
739
|
+
name?: string;
|
|
740
|
+
/**
|
|
741
|
+
*
|
|
742
|
+
* @type {Array<string>}
|
|
743
|
+
* @memberof ApiKeyUpdateDTO
|
|
744
|
+
*/
|
|
745
|
+
scope?: Array<string>;
|
|
746
|
+
/**
|
|
747
|
+
*
|
|
748
|
+
* @type {Array<string>}
|
|
749
|
+
* @memberof ApiKeyUpdateDTO
|
|
750
|
+
*/
|
|
751
|
+
ipAllowlist?: Array<string>;
|
|
752
|
+
/**
|
|
753
|
+
*
|
|
754
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
755
|
+
* @memberof ApiKeyUpdateDTO
|
|
756
|
+
*/
|
|
757
|
+
expiresAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
758
|
+
}
|
|
759
|
+
/**
|
|
760
|
+
*
|
|
761
|
+
* @export
|
|
762
|
+
* @interface ApiKeyUpdateInputDTO
|
|
763
|
+
*/
|
|
764
|
+
export interface ApiKeyUpdateInputDTO {
|
|
765
|
+
/**
|
|
766
|
+
*
|
|
767
|
+
* @type {string}
|
|
768
|
+
* @memberof ApiKeyUpdateInputDTO
|
|
769
|
+
*/
|
|
770
|
+
name?: string;
|
|
771
|
+
/**
|
|
772
|
+
*
|
|
773
|
+
* @type {Array<string>}
|
|
774
|
+
* @memberof ApiKeyUpdateInputDTO
|
|
775
|
+
*/
|
|
776
|
+
scope?: Array<string>;
|
|
777
|
+
/**
|
|
778
|
+
*
|
|
779
|
+
* @type {Array<string>}
|
|
780
|
+
* @memberof ApiKeyUpdateInputDTO
|
|
781
|
+
*/
|
|
782
|
+
ipAllowlist?: Array<string>;
|
|
783
|
+
/**
|
|
784
|
+
*
|
|
785
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
786
|
+
* @memberof ApiKeyUpdateInputDTO
|
|
787
|
+
*/
|
|
788
|
+
expiresAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
789
|
+
/**
|
|
790
|
+
*
|
|
791
|
+
* @type {Array<string>}
|
|
792
|
+
* @memberof ApiKeyUpdateInputDTO
|
|
793
|
+
*/
|
|
794
|
+
roleIds?: Array<string>;
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
*
|
|
798
|
+
* @export
|
|
799
|
+
* @interface ApiKeyUsageOutputDTO
|
|
800
|
+
*/
|
|
801
|
+
export interface ApiKeyUsageOutputDTO {
|
|
802
|
+
/**
|
|
803
|
+
*
|
|
804
|
+
* @type {Array<ApiKeyUsagePointDTO>}
|
|
805
|
+
* @memberof ApiKeyUsageOutputDTO
|
|
806
|
+
*/
|
|
807
|
+
points: Array<ApiKeyUsagePointDTO>;
|
|
808
|
+
/**
|
|
809
|
+
*
|
|
810
|
+
* @type {number}
|
|
811
|
+
* @memberof ApiKeyUsageOutputDTO
|
|
812
|
+
*/
|
|
813
|
+
total: number;
|
|
814
|
+
/**
|
|
815
|
+
*
|
|
816
|
+
* @type {string}
|
|
817
|
+
* @memberof ApiKeyUsageOutputDTO
|
|
818
|
+
*/
|
|
819
|
+
startDate: string;
|
|
820
|
+
/**
|
|
821
|
+
*
|
|
822
|
+
* @type {string}
|
|
823
|
+
* @memberof ApiKeyUsageOutputDTO
|
|
824
|
+
*/
|
|
825
|
+
endDate: string;
|
|
826
|
+
}
|
|
827
|
+
/**
|
|
828
|
+
*
|
|
829
|
+
* @export
|
|
830
|
+
* @interface ApiKeyUsageOutputDTOAPI
|
|
831
|
+
*/
|
|
832
|
+
export interface ApiKeyUsageOutputDTOAPI {
|
|
833
|
+
/**
|
|
834
|
+
*
|
|
835
|
+
* @type {ApiKeyUsageOutputDTO}
|
|
836
|
+
* @memberof ApiKeyUsageOutputDTOAPI
|
|
837
|
+
*/
|
|
838
|
+
data: ApiKeyUsageOutputDTO;
|
|
839
|
+
/**
|
|
840
|
+
*
|
|
841
|
+
* @type {MetadataOutput}
|
|
842
|
+
* @memberof ApiKeyUsageOutputDTOAPI
|
|
843
|
+
*/
|
|
844
|
+
meta: MetadataOutput;
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
*
|
|
848
|
+
* @export
|
|
849
|
+
* @interface ApiKeyUsagePointDTO
|
|
850
|
+
*/
|
|
851
|
+
export interface ApiKeyUsagePointDTO {
|
|
852
|
+
/**
|
|
853
|
+
*
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof ApiKeyUsagePointDTO
|
|
856
|
+
*/
|
|
857
|
+
date: string;
|
|
858
|
+
/**
|
|
859
|
+
*
|
|
860
|
+
* @type {number}
|
|
861
|
+
* @memberof ApiKeyUsagePointDTO
|
|
862
|
+
*/
|
|
863
|
+
count: number;
|
|
864
|
+
}
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
* @export
|
|
868
|
+
* @interface ApiKeyUsageQueryDTO
|
|
869
|
+
*/
|
|
870
|
+
export interface ApiKeyUsageQueryDTO {
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {string}
|
|
874
|
+
* @memberof ApiKeyUsageQueryDTO
|
|
875
|
+
*/
|
|
876
|
+
startDate?: string;
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @type {string}
|
|
880
|
+
* @memberof ApiKeyUsageQueryDTO
|
|
881
|
+
*/
|
|
882
|
+
endDate?: string;
|
|
883
|
+
}
|
|
237
884
|
/**
|
|
238
885
|
*
|
|
239
886
|
* @export
|
|
@@ -2207,32 +2854,246 @@ export interface DiscordRoleOutputArrayDTOAPI {
|
|
|
2207
2854
|
* @type {MetadataOutput}
|
|
2208
2855
|
* @memberof DiscordRoleOutputArrayDTOAPI
|
|
2209
2856
|
*/
|
|
2210
|
-
meta: MetadataOutput;
|
|
2857
|
+
meta: MetadataOutput;
|
|
2858
|
+
}
|
|
2859
|
+
/**
|
|
2860
|
+
*
|
|
2861
|
+
* @export
|
|
2862
|
+
* @interface DiscordRoleOutputDTO
|
|
2863
|
+
*/
|
|
2864
|
+
export interface DiscordRoleOutputDTO {
|
|
2865
|
+
/**
|
|
2866
|
+
*
|
|
2867
|
+
* @type {string}
|
|
2868
|
+
* @memberof DiscordRoleOutputDTO
|
|
2869
|
+
*/
|
|
2870
|
+
id: string;
|
|
2871
|
+
/**
|
|
2872
|
+
*
|
|
2873
|
+
* @type {string}
|
|
2874
|
+
* @memberof DiscordRoleOutputDTO
|
|
2875
|
+
*/
|
|
2876
|
+
name: string;
|
|
2877
|
+
/**
|
|
2878
|
+
*
|
|
2879
|
+
* @type {number}
|
|
2880
|
+
* @memberof DiscordRoleOutputDTO
|
|
2881
|
+
*/
|
|
2882
|
+
color: number;
|
|
2883
|
+
}
|
|
2884
|
+
/**
|
|
2885
|
+
*
|
|
2886
|
+
* @export
|
|
2887
|
+
* @interface DistributorBackedDomainOutputDTO
|
|
2888
|
+
*/
|
|
2889
|
+
export interface DistributorBackedDomainOutputDTO {
|
|
2890
|
+
/**
|
|
2891
|
+
*
|
|
2892
|
+
* @type {string}
|
|
2893
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2894
|
+
*/
|
|
2895
|
+
name: string;
|
|
2896
|
+
/**
|
|
2897
|
+
*
|
|
2898
|
+
* @type {string}
|
|
2899
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2900
|
+
*/
|
|
2901
|
+
state: DistributorBackedDomainOutputDTOStateEnum;
|
|
2902
|
+
/**
|
|
2903
|
+
*
|
|
2904
|
+
* @type {string}
|
|
2905
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2906
|
+
*/
|
|
2907
|
+
distributorId: string;
|
|
2908
|
+
/**
|
|
2909
|
+
*
|
|
2910
|
+
* @type {string}
|
|
2911
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2912
|
+
*/
|
|
2913
|
+
planId?: string;
|
|
2914
|
+
/**
|
|
2915
|
+
*
|
|
2916
|
+
* @type {string}
|
|
2917
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2918
|
+
*/
|
|
2919
|
+
externalReference?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
*
|
|
2922
|
+
* @type {number}
|
|
2923
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2924
|
+
*/
|
|
2925
|
+
maxGameservers: number;
|
|
2926
|
+
/**
|
|
2927
|
+
*
|
|
2928
|
+
* @type {number}
|
|
2929
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2930
|
+
*/
|
|
2931
|
+
maxUsers: number;
|
|
2932
|
+
/**
|
|
2933
|
+
*
|
|
2934
|
+
* @type {number}
|
|
2935
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2936
|
+
*/
|
|
2937
|
+
eventRetentionDays: number;
|
|
2938
|
+
/**
|
|
2939
|
+
*
|
|
2940
|
+
* @type {number}
|
|
2941
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2942
|
+
*/
|
|
2943
|
+
maxCustomRoles: number;
|
|
2944
|
+
/**
|
|
2945
|
+
*
|
|
2946
|
+
* @type {number}
|
|
2947
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2948
|
+
*/
|
|
2949
|
+
maxDiscordLinkedRoles: number;
|
|
2950
|
+
/**
|
|
2951
|
+
*
|
|
2952
|
+
* @type {string}
|
|
2953
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2954
|
+
*/
|
|
2955
|
+
id: string;
|
|
2956
|
+
/**
|
|
2957
|
+
*
|
|
2958
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
2959
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2960
|
+
*/
|
|
2961
|
+
createdAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
2962
|
+
/**
|
|
2963
|
+
*
|
|
2964
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
2965
|
+
* @memberof DistributorBackedDomainOutputDTO
|
|
2966
|
+
*/
|
|
2967
|
+
updatedAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
2968
|
+
}
|
|
2969
|
+
export declare const DistributorBackedDomainOutputDTOStateEnum: {
|
|
2970
|
+
readonly Active: "ACTIVE";
|
|
2971
|
+
readonly Disabled: "DISABLED";
|
|
2972
|
+
readonly Maintenance: "MAINTENANCE";
|
|
2973
|
+
};
|
|
2974
|
+
export type DistributorBackedDomainOutputDTOStateEnum = (typeof DistributorBackedDomainOutputDTOStateEnum)[keyof typeof DistributorBackedDomainOutputDTOStateEnum];
|
|
2975
|
+
/**
|
|
2976
|
+
*
|
|
2977
|
+
* @export
|
|
2978
|
+
* @interface DistributorCreateInputDTO
|
|
2979
|
+
*/
|
|
2980
|
+
export interface DistributorCreateInputDTO {
|
|
2981
|
+
/**
|
|
2982
|
+
*
|
|
2983
|
+
* @type {string}
|
|
2984
|
+
* @memberof DistributorCreateInputDTO
|
|
2985
|
+
*/
|
|
2986
|
+
name: string;
|
|
2987
|
+
/**
|
|
2988
|
+
*
|
|
2989
|
+
* @type {string}
|
|
2990
|
+
* @memberof DistributorCreateInputDTO
|
|
2991
|
+
*/
|
|
2992
|
+
contactEmail: string;
|
|
2993
|
+
/**
|
|
2994
|
+
*
|
|
2995
|
+
* @type {string}
|
|
2996
|
+
* @memberof DistributorCreateInputDTO
|
|
2997
|
+
*/
|
|
2998
|
+
billingCustomerId?: string;
|
|
2999
|
+
/**
|
|
3000
|
+
*
|
|
3001
|
+
* @type {Array<string>}
|
|
3002
|
+
* @memberof DistributorCreateInputDTO
|
|
3003
|
+
*/
|
|
3004
|
+
allowedPlans?: Array<string>;
|
|
3005
|
+
}
|
|
3006
|
+
/**
|
|
3007
|
+
*
|
|
3008
|
+
* @export
|
|
3009
|
+
* @interface DistributorOutputDTO
|
|
3010
|
+
*/
|
|
3011
|
+
export interface DistributorOutputDTO {
|
|
3012
|
+
/**
|
|
3013
|
+
*
|
|
3014
|
+
* @type {string}
|
|
3015
|
+
* @memberof DistributorOutputDTO
|
|
3016
|
+
*/
|
|
3017
|
+
name: string;
|
|
3018
|
+
/**
|
|
3019
|
+
*
|
|
3020
|
+
* @type {string}
|
|
3021
|
+
* @memberof DistributorOutputDTO
|
|
3022
|
+
*/
|
|
3023
|
+
contactEmail: string;
|
|
3024
|
+
/**
|
|
3025
|
+
*
|
|
3026
|
+
* @type {string}
|
|
3027
|
+
* @memberof DistributorOutputDTO
|
|
3028
|
+
*/
|
|
3029
|
+
billingCustomerId?: string;
|
|
3030
|
+
/**
|
|
3031
|
+
*
|
|
3032
|
+
* @type {Array<string>}
|
|
3033
|
+
* @memberof DistributorOutputDTO
|
|
3034
|
+
*/
|
|
3035
|
+
allowedPlans: Array<string>;
|
|
3036
|
+
/**
|
|
3037
|
+
*
|
|
3038
|
+
* @type {boolean}
|
|
3039
|
+
* @memberof DistributorOutputDTO
|
|
3040
|
+
*/
|
|
3041
|
+
enabled: boolean;
|
|
3042
|
+
/**
|
|
3043
|
+
*
|
|
3044
|
+
* @type {number}
|
|
3045
|
+
* @memberof DistributorOutputDTO
|
|
3046
|
+
*/
|
|
3047
|
+
domainCount: number;
|
|
3048
|
+
/**
|
|
3049
|
+
*
|
|
3050
|
+
* @type {string}
|
|
3051
|
+
* @memberof DistributorOutputDTO
|
|
3052
|
+
*/
|
|
3053
|
+
id: string;
|
|
3054
|
+
/**
|
|
3055
|
+
*
|
|
3056
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
3057
|
+
* @memberof DistributorOutputDTO
|
|
3058
|
+
*/
|
|
3059
|
+
createdAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
3060
|
+
/**
|
|
3061
|
+
*
|
|
3062
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
3063
|
+
* @memberof DistributorOutputDTO
|
|
3064
|
+
*/
|
|
3065
|
+
updatedAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
2211
3066
|
}
|
|
2212
3067
|
/**
|
|
2213
3068
|
*
|
|
2214
3069
|
* @export
|
|
2215
|
-
* @interface
|
|
3070
|
+
* @interface DistributorUpdateInputDTO
|
|
2216
3071
|
*/
|
|
2217
|
-
export interface
|
|
3072
|
+
export interface DistributorUpdateInputDTO {
|
|
2218
3073
|
/**
|
|
2219
3074
|
*
|
|
2220
3075
|
* @type {string}
|
|
2221
|
-
* @memberof
|
|
3076
|
+
* @memberof DistributorUpdateInputDTO
|
|
2222
3077
|
*/
|
|
2223
|
-
|
|
3078
|
+
name?: string;
|
|
2224
3079
|
/**
|
|
2225
3080
|
*
|
|
2226
3081
|
* @type {string}
|
|
2227
|
-
* @memberof
|
|
3082
|
+
* @memberof DistributorUpdateInputDTO
|
|
2228
3083
|
*/
|
|
2229
|
-
|
|
3084
|
+
contactEmail?: string;
|
|
2230
3085
|
/**
|
|
2231
3086
|
*
|
|
2232
|
-
* @type {
|
|
2233
|
-
* @memberof
|
|
3087
|
+
* @type {string}
|
|
3088
|
+
* @memberof DistributorUpdateInputDTO
|
|
2234
3089
|
*/
|
|
2235
|
-
|
|
3090
|
+
billingCustomerId?: string;
|
|
3091
|
+
/**
|
|
3092
|
+
*
|
|
3093
|
+
* @type {Array<string>}
|
|
3094
|
+
* @memberof DistributorUpdateInputDTO
|
|
3095
|
+
*/
|
|
3096
|
+
allowedPlans?: Array<string>;
|
|
2236
3097
|
}
|
|
2237
3098
|
/**
|
|
2238
3099
|
*
|
|
@@ -2324,6 +3185,18 @@ export interface DomainCreateInputDTO {
|
|
|
2324
3185
|
* @memberof DomainCreateInputDTO
|
|
2325
3186
|
*/
|
|
2326
3187
|
serverRegistrationToken?: string;
|
|
3188
|
+
/**
|
|
3189
|
+
*
|
|
3190
|
+
* @type {string}
|
|
3191
|
+
* @memberof DomainCreateInputDTO
|
|
3192
|
+
*/
|
|
3193
|
+
distributorId?: string;
|
|
3194
|
+
/**
|
|
3195
|
+
*
|
|
3196
|
+
* @type {string}
|
|
3197
|
+
* @memberof DomainCreateInputDTO
|
|
3198
|
+
*/
|
|
3199
|
+
planId?: string;
|
|
2327
3200
|
}
|
|
2328
3201
|
export declare const DomainCreateInputDTOStateEnum: {
|
|
2329
3202
|
readonly Active: "ACTIVE";
|
|
@@ -2362,44 +3235,6 @@ export interface DomainCreateOutputDTO {
|
|
|
2362
3235
|
*/
|
|
2363
3236
|
password: string;
|
|
2364
3237
|
}
|
|
2365
|
-
/**
|
|
2366
|
-
*
|
|
2367
|
-
* @export
|
|
2368
|
-
* @interface DomainCreateOutputDTOAPI
|
|
2369
|
-
*/
|
|
2370
|
-
export interface DomainCreateOutputDTOAPI {
|
|
2371
|
-
/**
|
|
2372
|
-
*
|
|
2373
|
-
* @type {DomainCreateOutputDTO}
|
|
2374
|
-
* @memberof DomainCreateOutputDTOAPI
|
|
2375
|
-
*/
|
|
2376
|
-
data: DomainCreateOutputDTO;
|
|
2377
|
-
/**
|
|
2378
|
-
*
|
|
2379
|
-
* @type {MetadataOutput}
|
|
2380
|
-
* @memberof DomainCreateOutputDTOAPI
|
|
2381
|
-
*/
|
|
2382
|
-
meta: MetadataOutput;
|
|
2383
|
-
}
|
|
2384
|
-
/**
|
|
2385
|
-
*
|
|
2386
|
-
* @export
|
|
2387
|
-
* @interface DomainOutputArrayDTOAPI
|
|
2388
|
-
*/
|
|
2389
|
-
export interface DomainOutputArrayDTOAPI {
|
|
2390
|
-
/**
|
|
2391
|
-
*
|
|
2392
|
-
* @type {Array<DomainOutputDTO>}
|
|
2393
|
-
* @memberof DomainOutputArrayDTOAPI
|
|
2394
|
-
*/
|
|
2395
|
-
data: Array<DomainOutputDTO>;
|
|
2396
|
-
/**
|
|
2397
|
-
*
|
|
2398
|
-
* @type {MetadataOutput}
|
|
2399
|
-
* @memberof DomainOutputArrayDTOAPI
|
|
2400
|
-
*/
|
|
2401
|
-
meta: MetadataOutput;
|
|
2402
|
-
}
|
|
2403
3238
|
/**
|
|
2404
3239
|
*
|
|
2405
3240
|
* @export
|
|
@@ -2490,6 +3325,12 @@ export interface DomainOutputDTO {
|
|
|
2490
3325
|
* @memberof DomainOutputDTO
|
|
2491
3326
|
*/
|
|
2492
3327
|
maxDiscordLinkedRoles: number;
|
|
3328
|
+
/**
|
|
3329
|
+
*
|
|
3330
|
+
* @type {boolean}
|
|
3331
|
+
* @memberof DomainOutputDTO
|
|
3332
|
+
*/
|
|
3333
|
+
distributorBacked: boolean;
|
|
2493
3334
|
/**
|
|
2494
3335
|
*
|
|
2495
3336
|
* @type {string}
|
|
@@ -2515,141 +3356,6 @@ export declare const DomainOutputDTOStateEnum: {
|
|
|
2515
3356
|
readonly Maintenance: "MAINTENANCE";
|
|
2516
3357
|
};
|
|
2517
3358
|
export type DomainOutputDTOStateEnum = (typeof DomainOutputDTOStateEnum)[keyof typeof DomainOutputDTOStateEnum];
|
|
2518
|
-
/**
|
|
2519
|
-
*
|
|
2520
|
-
* @export
|
|
2521
|
-
* @interface DomainOutputDTOAPI
|
|
2522
|
-
*/
|
|
2523
|
-
export interface DomainOutputDTOAPI {
|
|
2524
|
-
/**
|
|
2525
|
-
*
|
|
2526
|
-
* @type {DomainOutputDTO}
|
|
2527
|
-
* @memberof DomainOutputDTOAPI
|
|
2528
|
-
*/
|
|
2529
|
-
data: DomainOutputDTO;
|
|
2530
|
-
/**
|
|
2531
|
-
*
|
|
2532
|
-
* @type {MetadataOutput}
|
|
2533
|
-
* @memberof DomainOutputDTOAPI
|
|
2534
|
-
*/
|
|
2535
|
-
meta: MetadataOutput;
|
|
2536
|
-
}
|
|
2537
|
-
/**
|
|
2538
|
-
*
|
|
2539
|
-
* @export
|
|
2540
|
-
* @interface DomainSearchInputAllowedFilters
|
|
2541
|
-
*/
|
|
2542
|
-
export interface DomainSearchInputAllowedFilters {
|
|
2543
|
-
/**
|
|
2544
|
-
*
|
|
2545
|
-
* @type {Array<string>}
|
|
2546
|
-
* @memberof DomainSearchInputAllowedFilters
|
|
2547
|
-
*/
|
|
2548
|
-
id?: Array<string>;
|
|
2549
|
-
/**
|
|
2550
|
-
*
|
|
2551
|
-
* @type {Array<string>}
|
|
2552
|
-
* @memberof DomainSearchInputAllowedFilters
|
|
2553
|
-
*/
|
|
2554
|
-
name?: Array<string>;
|
|
2555
|
-
/**
|
|
2556
|
-
*
|
|
2557
|
-
* @type {Array<string>}
|
|
2558
|
-
* @memberof DomainSearchInputAllowedFilters
|
|
2559
|
-
*/
|
|
2560
|
-
state?: Array<DomainSearchInputAllowedFiltersStateEnum>;
|
|
2561
|
-
/**
|
|
2562
|
-
*
|
|
2563
|
-
* @type {Array<string>}
|
|
2564
|
-
* @memberof DomainSearchInputAllowedFilters
|
|
2565
|
-
*/
|
|
2566
|
-
externalReference?: Array<string>;
|
|
2567
|
-
}
|
|
2568
|
-
export declare const DomainSearchInputAllowedFiltersStateEnum: {
|
|
2569
|
-
readonly Active: "ACTIVE";
|
|
2570
|
-
readonly Disabled: "DISABLED";
|
|
2571
|
-
readonly Maintenance: "MAINTENANCE";
|
|
2572
|
-
};
|
|
2573
|
-
export type DomainSearchInputAllowedFiltersStateEnum = (typeof DomainSearchInputAllowedFiltersStateEnum)[keyof typeof DomainSearchInputAllowedFiltersStateEnum];
|
|
2574
|
-
/**
|
|
2575
|
-
*
|
|
2576
|
-
* @export
|
|
2577
|
-
* @interface DomainSearchInputAllowedSearch
|
|
2578
|
-
*/
|
|
2579
|
-
export interface DomainSearchInputAllowedSearch {
|
|
2580
|
-
/**
|
|
2581
|
-
*
|
|
2582
|
-
* @type {Array<string>}
|
|
2583
|
-
* @memberof DomainSearchInputAllowedSearch
|
|
2584
|
-
*/
|
|
2585
|
-
name?: Array<string>;
|
|
2586
|
-
/**
|
|
2587
|
-
*
|
|
2588
|
-
* @type {Array<string>}
|
|
2589
|
-
* @memberof DomainSearchInputAllowedSearch
|
|
2590
|
-
*/
|
|
2591
|
-
externalReference?: Array<string>;
|
|
2592
|
-
}
|
|
2593
|
-
/**
|
|
2594
|
-
*
|
|
2595
|
-
* @export
|
|
2596
|
-
* @interface DomainSearchInputDTO
|
|
2597
|
-
*/
|
|
2598
|
-
export interface DomainSearchInputDTO {
|
|
2599
|
-
/**
|
|
2600
|
-
*
|
|
2601
|
-
* @type {DomainSearchInputAllowedFilters}
|
|
2602
|
-
* @memberof DomainSearchInputDTO
|
|
2603
|
-
*/
|
|
2604
|
-
filters?: DomainSearchInputAllowedFilters;
|
|
2605
|
-
/**
|
|
2606
|
-
*
|
|
2607
|
-
* @type {DomainSearchInputAllowedSearch}
|
|
2608
|
-
* @memberof DomainSearchInputDTO
|
|
2609
|
-
*/
|
|
2610
|
-
search?: DomainSearchInputAllowedSearch;
|
|
2611
|
-
/**
|
|
2612
|
-
*
|
|
2613
|
-
* @type {any}
|
|
2614
|
-
* @memberof DomainSearchInputDTO
|
|
2615
|
-
*/
|
|
2616
|
-
greaterThan?: any;
|
|
2617
|
-
/**
|
|
2618
|
-
*
|
|
2619
|
-
* @type {any}
|
|
2620
|
-
* @memberof DomainSearchInputDTO
|
|
2621
|
-
*/
|
|
2622
|
-
lessThan?: any;
|
|
2623
|
-
/**
|
|
2624
|
-
*
|
|
2625
|
-
* @type {number}
|
|
2626
|
-
* @memberof DomainSearchInputDTO
|
|
2627
|
-
*/
|
|
2628
|
-
page?: number;
|
|
2629
|
-
/**
|
|
2630
|
-
*
|
|
2631
|
-
* @type {number}
|
|
2632
|
-
* @memberof DomainSearchInputDTO
|
|
2633
|
-
*/
|
|
2634
|
-
limit?: number;
|
|
2635
|
-
/**
|
|
2636
|
-
*
|
|
2637
|
-
* @type {string}
|
|
2638
|
-
* @memberof DomainSearchInputDTO
|
|
2639
|
-
*/
|
|
2640
|
-
sortBy?: string;
|
|
2641
|
-
/**
|
|
2642
|
-
*
|
|
2643
|
-
* @type {string}
|
|
2644
|
-
* @memberof DomainSearchInputDTO
|
|
2645
|
-
*/
|
|
2646
|
-
sortDirection?: DomainSearchInputDTOSortDirectionEnum;
|
|
2647
|
-
}
|
|
2648
|
-
export declare const DomainSearchInputDTOSortDirectionEnum: {
|
|
2649
|
-
readonly Asc: "asc";
|
|
2650
|
-
readonly Desc: "desc";
|
|
2651
|
-
};
|
|
2652
|
-
export type DomainSearchInputDTOSortDirectionEnum = (typeof DomainSearchInputDTOSortDirectionEnum)[keyof typeof DomainSearchInputDTOSortDirectionEnum];
|
|
2653
3359
|
/**
|
|
2654
3360
|
*
|
|
2655
3361
|
* @export
|
|
@@ -3307,6 +4013,12 @@ export declare const EventCreateDTOEventNameEnum: {
|
|
|
3307
4013
|
readonly EventRateLimited: "event-rate-limited";
|
|
3308
4014
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
3309
4015
|
readonly InviteLinkCreated: "invite-link-created";
|
|
4016
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
4017
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
4018
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
4019
|
+
readonly DomainCreated: "domain-created";
|
|
4020
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
4021
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
3310
4022
|
readonly PlayerConnected: "player-connected";
|
|
3311
4023
|
readonly PlayerDisconnected: "player-disconnected";
|
|
3312
4024
|
readonly ChatMessage: "chat-message";
|
|
@@ -3522,6 +4234,12 @@ export declare const EventExploreFiltersDTOEventNameEnum: {
|
|
|
3522
4234
|
readonly EventRateLimited: "event-rate-limited";
|
|
3523
4235
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
3524
4236
|
readonly InviteLinkCreated: "invite-link-created";
|
|
4237
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
4238
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
4239
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
4240
|
+
readonly DomainCreated: "domain-created";
|
|
4241
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
4242
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
3525
4243
|
readonly PlayerConnected: "player-connected";
|
|
3526
4244
|
readonly PlayerDisconnected: "player-disconnected";
|
|
3527
4245
|
readonly ChatMessage: "chat-message";
|
|
@@ -3889,6 +4607,12 @@ export declare const EventOutputDTOEventNameEnum: {
|
|
|
3889
4607
|
readonly EventRateLimited: "event-rate-limited";
|
|
3890
4608
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
3891
4609
|
readonly InviteLinkCreated: "invite-link-created";
|
|
4610
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
4611
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
4612
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
4613
|
+
readonly DomainCreated: "domain-created";
|
|
4614
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
4615
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
3892
4616
|
readonly PlayerConnected: "player-connected";
|
|
3893
4617
|
readonly PlayerDisconnected: "player-disconnected";
|
|
3894
4618
|
readonly ChatMessage: "chat-message";
|
|
@@ -3900,7 +4624,7 @@ export type EventOutputDTOEventNameEnum = (typeof EventOutputDTOEventNameEnum)[k
|
|
|
3900
4624
|
* @type EventOutputDTOMeta
|
|
3901
4625
|
* @export
|
|
3902
4626
|
*/
|
|
3903
|
-
export type EventOutputDTOMeta = EventChatMessage | EventEntityKilled | EventLogLine | EventPlayerConnected | EventPlayerDeath | EventPlayerDisconnected | HookEventDiscordMessage | TakaroEventCommandExecuted | TakaroEventCommandExecutionDenied | TakaroEventCronjobExecuted | TakaroEventCurrencyAdded | TakaroEventCurrencyDeducted | TakaroEventCurrencyResetAll | TakaroEventGameserverCreated | TakaroEventGameserverDeleted | TakaroEventGameserverUpdated | TakaroEventHookExecuted | TakaroEventInviteLinkCreated | TakaroEventModuleCreated | TakaroEventModuleDeleted | TakaroEventModuleInstalled | TakaroEventModuleUninstalled | TakaroEventModuleUpdated | TakaroEventPlayerBanned | TakaroEventPlayerCreated | TakaroEventPlayerDeleted | TakaroEventPlayerInventoryChanged | TakaroEventPlayerLinked | TakaroEventPlayerNewIpDetected | TakaroEventPlayerNewNameDetected | TakaroEventPlayerSyncSnapshot | TakaroEventPlayerUnbanned | TakaroEventRateLimited | TakaroEventRoleAssigned | TakaroEventRoleCreated | TakaroEventRoleDeleted | TakaroEventRoleRemoved | TakaroEventRoleUpdated | TakaroEventServerStatusChanged | TakaroEventSettingsSet | TakaroEventShopActionExecuted | TakaroEventShopListingCreated | TakaroEventShopListingDeleted | TakaroEventShopListingUpdated | TakaroEventShopOrderCreated | TakaroEventShopOrderDeliveryFailed | TakaroEventShopOrderStatusChanged;
|
|
4627
|
+
export type EventOutputDTOMeta = EventChatMessage | EventEntityKilled | EventLogLine | EventPlayerConnected | EventPlayerDeath | EventPlayerDisconnected | HookEventDiscordMessage | TakaroEventApiKeyCreated | TakaroEventApiKeyRevoked | TakaroEventApiKeyRotated | TakaroEventCommandExecuted | TakaroEventCommandExecutionDenied | TakaroEventCronjobExecuted | TakaroEventCurrencyAdded | TakaroEventCurrencyDeducted | TakaroEventCurrencyResetAll | TakaroEventDomainCreated | TakaroEventDomainPlanChanged | TakaroEventDomainRegistrationTokenRegenerated | TakaroEventGameserverCreated | TakaroEventGameserverDeleted | TakaroEventGameserverUpdated | TakaroEventHookExecuted | TakaroEventInviteLinkCreated | TakaroEventModuleCreated | TakaroEventModuleDeleted | TakaroEventModuleInstalled | TakaroEventModuleUninstalled | TakaroEventModuleUpdated | TakaroEventPlayerBanned | TakaroEventPlayerCreated | TakaroEventPlayerDeleted | TakaroEventPlayerInventoryChanged | TakaroEventPlayerLinked | TakaroEventPlayerNewIpDetected | TakaroEventPlayerNewNameDetected | TakaroEventPlayerSyncSnapshot | TakaroEventPlayerUnbanned | TakaroEventRateLimited | TakaroEventRoleAssigned | TakaroEventRoleCreated | TakaroEventRoleDeleted | TakaroEventRoleRemoved | TakaroEventRoleUpdated | TakaroEventServerStatusChanged | TakaroEventSettingsSet | TakaroEventShopActionExecuted | TakaroEventShopListingCreated | TakaroEventShopListingDeleted | TakaroEventShopListingUpdated | TakaroEventShopOrderCreated | TakaroEventShopOrderDeliveryFailed | TakaroEventShopOrderStatusChanged;
|
|
3904
4628
|
/**
|
|
3905
4629
|
*
|
|
3906
4630
|
* @export
|
|
@@ -4078,6 +4802,12 @@ export declare const EventSearchInputAllowedFiltersEventNameEnum: {
|
|
|
4078
4802
|
readonly EventRateLimited: "event-rate-limited";
|
|
4079
4803
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
4080
4804
|
readonly InviteLinkCreated: "invite-link-created";
|
|
4805
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
4806
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
4807
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
4808
|
+
readonly DomainCreated: "domain-created";
|
|
4809
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
4810
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
4081
4811
|
readonly PlayerConnected: "player-connected";
|
|
4082
4812
|
readonly PlayerDisconnected: "player-disconnected";
|
|
4083
4813
|
readonly ChatMessage: "chat-message";
|
|
@@ -5056,6 +5786,7 @@ export declare const GetJobInputDTOTypeEnum: {
|
|
|
5056
5786
|
readonly SyncSteam: "syncSteam";
|
|
5057
5787
|
readonly SyncDiscordRoles: "syncDiscordRoles";
|
|
5058
5788
|
readonly EmitRateLimitSummary: "emitRateLimitSummary";
|
|
5789
|
+
readonly CleanRevokedApiKeys: "cleanRevokedApiKeys";
|
|
5059
5790
|
};
|
|
5060
5791
|
export type GetJobInputDTOTypeEnum = (typeof GetJobInputDTOTypeEnum)[keyof typeof GetJobInputDTOTypeEnum];
|
|
5061
5792
|
/**
|
|
@@ -5513,6 +6244,12 @@ export declare const HookCreateDTOEventTypeEnum: {
|
|
|
5513
6244
|
readonly EventRateLimited: "event-rate-limited";
|
|
5514
6245
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
5515
6246
|
readonly InviteLinkCreated: "invite-link-created";
|
|
6247
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
6248
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
6249
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
6250
|
+
readonly DomainCreated: "domain-created";
|
|
6251
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
6252
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
5516
6253
|
};
|
|
5517
6254
|
export type HookCreateDTOEventTypeEnum = (typeof HookCreateDTOEventTypeEnum)[keyof typeof HookCreateDTOEventTypeEnum];
|
|
5518
6255
|
/**
|
|
@@ -5674,6 +6411,12 @@ export declare const HookOutputDTOEventTypeEnum: {
|
|
|
5674
6411
|
readonly EventRateLimited: "event-rate-limited";
|
|
5675
6412
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
5676
6413
|
readonly InviteLinkCreated: "invite-link-created";
|
|
6414
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
6415
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
6416
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
6417
|
+
readonly DomainCreated: "domain-created";
|
|
6418
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
6419
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
5677
6420
|
};
|
|
5678
6421
|
export type HookOutputDTOEventTypeEnum = (typeof HookOutputDTOEventTypeEnum)[keyof typeof HookOutputDTOEventTypeEnum];
|
|
5679
6422
|
/**
|
|
@@ -5780,6 +6523,12 @@ export declare const HookSearchInputAllowedFiltersEventTypeEnum: {
|
|
|
5780
6523
|
readonly EventRateLimited: "event-rate-limited";
|
|
5781
6524
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
5782
6525
|
readonly InviteLinkCreated: "invite-link-created";
|
|
6526
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
6527
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
6528
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
6529
|
+
readonly DomainCreated: "domain-created";
|
|
6530
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
6531
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
5783
6532
|
};
|
|
5784
6533
|
export type HookSearchInputAllowedFiltersEventTypeEnum = (typeof HookSearchInputAllowedFiltersEventTypeEnum)[keyof typeof HookSearchInputAllowedFiltersEventTypeEnum];
|
|
5785
6534
|
/**
|
|
@@ -5951,6 +6700,12 @@ export declare const HookTriggerDTOEventTypeEnum: {
|
|
|
5951
6700
|
readonly EventRateLimited: "event-rate-limited";
|
|
5952
6701
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
5953
6702
|
readonly InviteLinkCreated: "invite-link-created";
|
|
6703
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
6704
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
6705
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
6706
|
+
readonly DomainCreated: "domain-created";
|
|
6707
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
6708
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
5954
6709
|
};
|
|
5955
6710
|
export type HookTriggerDTOEventTypeEnum = (typeof HookTriggerDTOEventTypeEnum)[keyof typeof HookTriggerDTOEventTypeEnum];
|
|
5956
6711
|
/**
|
|
@@ -6038,6 +6793,12 @@ export declare const HookUpdateDTOEventTypeEnum: {
|
|
|
6038
6793
|
readonly EventRateLimited: "event-rate-limited";
|
|
6039
6794
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
6040
6795
|
readonly InviteLinkCreated: "invite-link-created";
|
|
6796
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
6797
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
6798
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
6799
|
+
readonly DomainCreated: "domain-created";
|
|
6800
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
6801
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
6041
6802
|
};
|
|
6042
6803
|
export type HookUpdateDTOEventTypeEnum = (typeof HookUpdateDTOEventTypeEnum)[keyof typeof HookUpdateDTOEventTypeEnum];
|
|
6043
6804
|
/**
|
|
@@ -6365,6 +7126,12 @@ export declare const IHookEventTypeEnum: {
|
|
|
6365
7126
|
readonly EventRateLimited: "event-rate-limited";
|
|
6366
7127
|
readonly PlayerSyncSnapshot: "player-sync-snapshot";
|
|
6367
7128
|
readonly InviteLinkCreated: "invite-link-created";
|
|
7129
|
+
readonly ApiKeyCreated: "api-key-created";
|
|
7130
|
+
readonly ApiKeyRotated: "api-key-rotated";
|
|
7131
|
+
readonly ApiKeyRevoked: "api-key-revoked";
|
|
7132
|
+
readonly DomainCreated: "domain-created";
|
|
7133
|
+
readonly DomainRegistrationTokenRegenerated: "domain-registration-token-regenerated";
|
|
7134
|
+
readonly DomainPlanChanged: "domain-plan-changed";
|
|
6368
7135
|
};
|
|
6369
7136
|
export type IHookEventTypeEnum = (typeof IHookEventTypeEnum)[keyof typeof IHookEventTypeEnum];
|
|
6370
7137
|
/**
|
|
@@ -9744,6 +10511,7 @@ export declare const PERMISSIONS: {
|
|
|
9744
10511
|
readonly ManageShopOrders: "MANAGE_SHOP_ORDERS";
|
|
9745
10512
|
readonly ViewDiscordInfo: "VIEW_DISCORD_INFO";
|
|
9746
10513
|
readonly SendDiscordMessage: "SEND_DISCORD_MESSAGE";
|
|
10514
|
+
readonly ManageApiKeys: "MANAGE_API_KEYS";
|
|
9747
10515
|
};
|
|
9748
10516
|
export type PERMISSIONS = (typeof PERMISSIONS)[keyof typeof PERMISSIONS];
|
|
9749
10517
|
/**
|
|
@@ -12852,19 +13620,6 @@ export interface RegistryWithManifestOutputDTOAPI {
|
|
|
12852
13620
|
*/
|
|
12853
13621
|
meta: MetadataOutput;
|
|
12854
13622
|
}
|
|
12855
|
-
/**
|
|
12856
|
-
*
|
|
12857
|
-
* @export
|
|
12858
|
-
* @interface ResolveRegistrationTokenInputDTO
|
|
12859
|
-
*/
|
|
12860
|
-
export interface ResolveRegistrationTokenInputDTO {
|
|
12861
|
-
/**
|
|
12862
|
-
*
|
|
12863
|
-
* @type {string}
|
|
12864
|
-
* @memberof ResolveRegistrationTokenInputDTO
|
|
12865
|
-
*/
|
|
12866
|
-
registrationToken: string;
|
|
12867
|
-
}
|
|
12868
13623
|
/**
|
|
12869
13624
|
*
|
|
12870
13625
|
* @export
|
|
@@ -15927,65 +16682,176 @@ export interface StorefrontPreviewDTO {
|
|
|
15927
16682
|
/**
|
|
15928
16683
|
*
|
|
15929
16684
|
* @export
|
|
15930
|
-
* @interface StorefrontPreviewOutputDTOAPI
|
|
16685
|
+
* @interface StorefrontPreviewOutputDTOAPI
|
|
16686
|
+
*/
|
|
16687
|
+
export interface StorefrontPreviewOutputDTOAPI {
|
|
16688
|
+
/**
|
|
16689
|
+
*
|
|
16690
|
+
* @type {StorefrontPreviewDTO}
|
|
16691
|
+
* @memberof StorefrontPreviewOutputDTOAPI
|
|
16692
|
+
*/
|
|
16693
|
+
data: StorefrontPreviewDTO;
|
|
16694
|
+
/**
|
|
16695
|
+
*
|
|
16696
|
+
* @type {MetadataOutput}
|
|
16697
|
+
* @memberof StorefrontPreviewOutputDTOAPI
|
|
16698
|
+
*/
|
|
16699
|
+
meta: MetadataOutput;
|
|
16700
|
+
}
|
|
16701
|
+
/**
|
|
16702
|
+
*
|
|
16703
|
+
* @export
|
|
16704
|
+
* @interface StorefrontTemplateDTO
|
|
16705
|
+
*/
|
|
16706
|
+
export interface StorefrontTemplateDTO {
|
|
16707
|
+
/**
|
|
16708
|
+
*
|
|
16709
|
+
* @type {string}
|
|
16710
|
+
* @memberof StorefrontTemplateDTO
|
|
16711
|
+
*/
|
|
16712
|
+
id: string;
|
|
16713
|
+
/**
|
|
16714
|
+
*
|
|
16715
|
+
* @type {string}
|
|
16716
|
+
* @memberof StorefrontTemplateDTO
|
|
16717
|
+
*/
|
|
16718
|
+
name: string;
|
|
16719
|
+
/**
|
|
16720
|
+
*
|
|
16721
|
+
* @type {object}
|
|
16722
|
+
* @memberof StorefrontTemplateDTO
|
|
16723
|
+
*/
|
|
16724
|
+
schema: object;
|
|
16725
|
+
}
|
|
16726
|
+
/**
|
|
16727
|
+
*
|
|
16728
|
+
* @export
|
|
16729
|
+
* @interface StorefrontTemplateOutputArrayDTOAPI
|
|
16730
|
+
*/
|
|
16731
|
+
export interface StorefrontTemplateOutputArrayDTOAPI {
|
|
16732
|
+
/**
|
|
16733
|
+
*
|
|
16734
|
+
* @type {Array<StorefrontTemplateDTO>}
|
|
16735
|
+
* @memberof StorefrontTemplateOutputArrayDTOAPI
|
|
16736
|
+
*/
|
|
16737
|
+
data: Array<StorefrontTemplateDTO>;
|
|
16738
|
+
/**
|
|
16739
|
+
*
|
|
16740
|
+
* @type {MetadataOutput}
|
|
16741
|
+
* @memberof StorefrontTemplateOutputArrayDTOAPI
|
|
16742
|
+
*/
|
|
16743
|
+
meta: MetadataOutput;
|
|
16744
|
+
}
|
|
16745
|
+
/**
|
|
16746
|
+
*
|
|
16747
|
+
* @export
|
|
16748
|
+
* @interface TakaroEventApiKeyCreated
|
|
16749
|
+
*/
|
|
16750
|
+
export interface TakaroEventApiKeyCreated {
|
|
16751
|
+
/**
|
|
16752
|
+
*
|
|
16753
|
+
* @type {string}
|
|
16754
|
+
* @memberof TakaroEventApiKeyCreated
|
|
16755
|
+
*/
|
|
16756
|
+
apiKeyId: string;
|
|
16757
|
+
/**
|
|
16758
|
+
*
|
|
16759
|
+
* @type {string}
|
|
16760
|
+
* @memberof TakaroEventApiKeyCreated
|
|
16761
|
+
*/
|
|
16762
|
+
name: string;
|
|
16763
|
+
/**
|
|
16764
|
+
*
|
|
16765
|
+
* @type {string}
|
|
16766
|
+
* @memberof TakaroEventApiKeyCreated
|
|
16767
|
+
*/
|
|
16768
|
+
kind: string;
|
|
16769
|
+
/**
|
|
16770
|
+
*
|
|
16771
|
+
* @type {Array<string>}
|
|
16772
|
+
* @memberof TakaroEventApiKeyCreated
|
|
16773
|
+
*/
|
|
16774
|
+
scope?: Array<string>;
|
|
16775
|
+
/**
|
|
16776
|
+
*
|
|
16777
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
16778
|
+
* @memberof TakaroEventApiKeyCreated
|
|
16779
|
+
*/
|
|
16780
|
+
timestamp: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
16781
|
+
}
|
|
16782
|
+
/**
|
|
16783
|
+
*
|
|
16784
|
+
* @export
|
|
16785
|
+
* @interface TakaroEventApiKeyRevoked
|
|
15931
16786
|
*/
|
|
15932
|
-
export interface
|
|
16787
|
+
export interface TakaroEventApiKeyRevoked {
|
|
15933
16788
|
/**
|
|
15934
16789
|
*
|
|
15935
|
-
* @type {
|
|
15936
|
-
* @memberof
|
|
16790
|
+
* @type {string}
|
|
16791
|
+
* @memberof TakaroEventApiKeyRevoked
|
|
15937
16792
|
*/
|
|
15938
|
-
|
|
16793
|
+
apiKeyId: string;
|
|
15939
16794
|
/**
|
|
15940
16795
|
*
|
|
15941
|
-
* @type {
|
|
15942
|
-
* @memberof
|
|
16796
|
+
* @type {string}
|
|
16797
|
+
* @memberof TakaroEventApiKeyRevoked
|
|
15943
16798
|
*/
|
|
15944
|
-
|
|
16799
|
+
name: string;
|
|
16800
|
+
/**
|
|
16801
|
+
*
|
|
16802
|
+
* @type {string}
|
|
16803
|
+
* @memberof TakaroEventApiKeyRevoked
|
|
16804
|
+
*/
|
|
16805
|
+
kind: string;
|
|
16806
|
+
/**
|
|
16807
|
+
*
|
|
16808
|
+
* @type {Array<string>}
|
|
16809
|
+
* @memberof TakaroEventApiKeyRevoked
|
|
16810
|
+
*/
|
|
16811
|
+
scope?: Array<string>;
|
|
16812
|
+
/**
|
|
16813
|
+
*
|
|
16814
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
16815
|
+
* @memberof TakaroEventApiKeyRevoked
|
|
16816
|
+
*/
|
|
16817
|
+
timestamp: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
15945
16818
|
}
|
|
15946
16819
|
/**
|
|
15947
16820
|
*
|
|
15948
16821
|
* @export
|
|
15949
|
-
* @interface
|
|
16822
|
+
* @interface TakaroEventApiKeyRotated
|
|
15950
16823
|
*/
|
|
15951
|
-
export interface
|
|
16824
|
+
export interface TakaroEventApiKeyRotated {
|
|
15952
16825
|
/**
|
|
15953
16826
|
*
|
|
15954
16827
|
* @type {string}
|
|
15955
|
-
* @memberof
|
|
16828
|
+
* @memberof TakaroEventApiKeyRotated
|
|
15956
16829
|
*/
|
|
15957
|
-
|
|
16830
|
+
apiKeyId: string;
|
|
15958
16831
|
/**
|
|
15959
16832
|
*
|
|
15960
16833
|
* @type {string}
|
|
15961
|
-
* @memberof
|
|
16834
|
+
* @memberof TakaroEventApiKeyRotated
|
|
15962
16835
|
*/
|
|
15963
16836
|
name: string;
|
|
15964
16837
|
/**
|
|
15965
16838
|
*
|
|
15966
|
-
* @type {
|
|
15967
|
-
* @memberof
|
|
16839
|
+
* @type {string}
|
|
16840
|
+
* @memberof TakaroEventApiKeyRotated
|
|
15968
16841
|
*/
|
|
15969
|
-
|
|
15970
|
-
}
|
|
15971
|
-
/**
|
|
15972
|
-
*
|
|
15973
|
-
* @export
|
|
15974
|
-
* @interface StorefrontTemplateOutputArrayDTOAPI
|
|
15975
|
-
*/
|
|
15976
|
-
export interface StorefrontTemplateOutputArrayDTOAPI {
|
|
16842
|
+
kind: string;
|
|
15977
16843
|
/**
|
|
15978
16844
|
*
|
|
15979
|
-
* @type {Array<
|
|
15980
|
-
* @memberof
|
|
16845
|
+
* @type {Array<string>}
|
|
16846
|
+
* @memberof TakaroEventApiKeyRotated
|
|
15981
16847
|
*/
|
|
15982
|
-
|
|
16848
|
+
scope?: Array<string>;
|
|
15983
16849
|
/**
|
|
15984
16850
|
*
|
|
15985
|
-
* @type {
|
|
15986
|
-
* @memberof
|
|
16851
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
16852
|
+
* @memberof TakaroEventApiKeyRotated
|
|
15987
16853
|
*/
|
|
15988
|
-
|
|
16854
|
+
timestamp: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
15989
16855
|
}
|
|
15990
16856
|
/**
|
|
15991
16857
|
*
|
|
@@ -16175,6 +17041,63 @@ export interface TakaroEventCurrencyResetAll {
|
|
|
16175
17041
|
*/
|
|
16176
17042
|
timestamp: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
16177
17043
|
}
|
|
17044
|
+
/**
|
|
17045
|
+
*
|
|
17046
|
+
* @export
|
|
17047
|
+
* @interface TakaroEventDomainCreated
|
|
17048
|
+
*/
|
|
17049
|
+
export interface TakaroEventDomainCreated {
|
|
17050
|
+
/**
|
|
17051
|
+
*
|
|
17052
|
+
* @type {string}
|
|
17053
|
+
* @memberof TakaroEventDomainCreated
|
|
17054
|
+
*/
|
|
17055
|
+
distributorId: string;
|
|
17056
|
+
/**
|
|
17057
|
+
*
|
|
17058
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
17059
|
+
* @memberof TakaroEventDomainCreated
|
|
17060
|
+
*/
|
|
17061
|
+
timestamp: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
17062
|
+
}
|
|
17063
|
+
/**
|
|
17064
|
+
*
|
|
17065
|
+
* @export
|
|
17066
|
+
* @interface TakaroEventDomainPlanChanged
|
|
17067
|
+
*/
|
|
17068
|
+
export interface TakaroEventDomainPlanChanged {
|
|
17069
|
+
/**
|
|
17070
|
+
*
|
|
17071
|
+
* @type {string}
|
|
17072
|
+
* @memberof TakaroEventDomainPlanChanged
|
|
17073
|
+
*/
|
|
17074
|
+
planId: string;
|
|
17075
|
+
/**
|
|
17076
|
+
*
|
|
17077
|
+
* @type {string}
|
|
17078
|
+
* @memberof TakaroEventDomainPlanChanged
|
|
17079
|
+
*/
|
|
17080
|
+
previousPlanId?: string;
|
|
17081
|
+
/**
|
|
17082
|
+
*
|
|
17083
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
17084
|
+
* @memberof TakaroEventDomainPlanChanged
|
|
17085
|
+
*/
|
|
17086
|
+
timestamp: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
17087
|
+
}
|
|
17088
|
+
/**
|
|
17089
|
+
*
|
|
17090
|
+
* @export
|
|
17091
|
+
* @interface TakaroEventDomainRegistrationTokenRegenerated
|
|
17092
|
+
*/
|
|
17093
|
+
export interface TakaroEventDomainRegistrationTokenRegenerated {
|
|
17094
|
+
/**
|
|
17095
|
+
*
|
|
17096
|
+
* @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
|
|
17097
|
+
* @memberof TakaroEventDomainRegistrationTokenRegenerated
|
|
17098
|
+
*/
|
|
17099
|
+
timestamp: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
|
|
17100
|
+
}
|
|
16178
17101
|
/**
|
|
16179
17102
|
*
|
|
16180
17103
|
* @export
|
|
@@ -17449,25 +18372,6 @@ export interface TokenOutputDTO {
|
|
|
17449
18372
|
*/
|
|
17450
18373
|
token: string;
|
|
17451
18374
|
}
|
|
17452
|
-
/**
|
|
17453
|
-
*
|
|
17454
|
-
* @export
|
|
17455
|
-
* @interface TokenOutputDTOAPI
|
|
17456
|
-
*/
|
|
17457
|
-
export interface TokenOutputDTOAPI {
|
|
17458
|
-
/**
|
|
17459
|
-
*
|
|
17460
|
-
* @type {TokenOutputDTO}
|
|
17461
|
-
* @memberof TokenOutputDTOAPI
|
|
17462
|
-
*/
|
|
17463
|
-
data: TokenOutputDTO;
|
|
17464
|
-
/**
|
|
17465
|
-
*
|
|
17466
|
-
* @type {MetadataOutput}
|
|
17467
|
-
* @memberof TokenOutputDTOAPI
|
|
17468
|
-
*/
|
|
17469
|
-
meta: MetadataOutput;
|
|
17470
|
-
}
|
|
17471
18375
|
/**
|
|
17472
18376
|
*
|
|
17473
18377
|
* @export
|
|
@@ -17729,6 +18633,43 @@ export interface UserCreateInviteDTO {
|
|
|
17729
18633
|
*/
|
|
17730
18634
|
isDashboardUser?: boolean;
|
|
17731
18635
|
}
|
|
18636
|
+
/**
|
|
18637
|
+
*
|
|
18638
|
+
* @export
|
|
18639
|
+
* @interface UserCreateServiceAccountDTO
|
|
18640
|
+
*/
|
|
18641
|
+
export interface UserCreateServiceAccountDTO {
|
|
18642
|
+
/**
|
|
18643
|
+
*
|
|
18644
|
+
* @type {string}
|
|
18645
|
+
* @memberof UserCreateServiceAccountDTO
|
|
18646
|
+
*/
|
|
18647
|
+
name: string;
|
|
18648
|
+
/**
|
|
18649
|
+
*
|
|
18650
|
+
* @type {string}
|
|
18651
|
+
* @memberof UserCreateServiceAccountDTO
|
|
18652
|
+
*/
|
|
18653
|
+
idpId: string;
|
|
18654
|
+
/**
|
|
18655
|
+
*
|
|
18656
|
+
* @type {boolean}
|
|
18657
|
+
* @memberof UserCreateServiceAccountDTO
|
|
18658
|
+
*/
|
|
18659
|
+
isDashboardUser?: boolean;
|
|
18660
|
+
/**
|
|
18661
|
+
*
|
|
18662
|
+
* @type {boolean}
|
|
18663
|
+
* @memberof UserCreateServiceAccountDTO
|
|
18664
|
+
*/
|
|
18665
|
+
isServiceAccount?: boolean;
|
|
18666
|
+
/**
|
|
18667
|
+
*
|
|
18668
|
+
* @type {string}
|
|
18669
|
+
* @memberof UserCreateServiceAccountDTO
|
|
18670
|
+
*/
|
|
18671
|
+
distributorId?: string;
|
|
18672
|
+
}
|
|
17732
18673
|
/**
|
|
17733
18674
|
*
|
|
17734
18675
|
* @export
|
|
@@ -17845,6 +18786,12 @@ export interface UserOutputDTO {
|
|
|
17845
18786
|
* @memberof UserOutputDTO
|
|
17846
18787
|
*/
|
|
17847
18788
|
isSupportAccount: boolean;
|
|
18789
|
+
/**
|
|
18790
|
+
*
|
|
18791
|
+
* @type {boolean}
|
|
18792
|
+
* @memberof UserOutputDTO
|
|
18793
|
+
*/
|
|
18794
|
+
isServiceAccount: boolean;
|
|
17848
18795
|
/**
|
|
17849
18796
|
*
|
|
17850
18797
|
* @type {string}
|
|
@@ -17973,6 +18920,12 @@ export interface UserOutputWithRolesDTO {
|
|
|
17973
18920
|
* @memberof UserOutputWithRolesDTO
|
|
17974
18921
|
*/
|
|
17975
18922
|
isSupportAccount: boolean;
|
|
18923
|
+
/**
|
|
18924
|
+
*
|
|
18925
|
+
* @type {boolean}
|
|
18926
|
+
* @memberof UserOutputWithRolesDTO
|
|
18927
|
+
*/
|
|
18928
|
+
isServiceAccount: boolean;
|
|
17976
18929
|
/**
|
|
17977
18930
|
*
|
|
17978
18931
|
* @type {string}
|
|
@@ -20485,17 +21438,286 @@ export declare const AnalyticsControllerGetTopModulesByVolumePeriodEnum: {
|
|
|
20485
21438
|
readonly _30d: "30d";
|
|
20486
21439
|
readonly _90d: "90d";
|
|
20487
21440
|
};
|
|
20488
|
-
export type AnalyticsControllerGetTopModulesByVolumePeriodEnum = (typeof AnalyticsControllerGetTopModulesByVolumePeriodEnum)[keyof typeof AnalyticsControllerGetTopModulesByVolumePeriodEnum];
|
|
21441
|
+
export type AnalyticsControllerGetTopModulesByVolumePeriodEnum = (typeof AnalyticsControllerGetTopModulesByVolumePeriodEnum)[keyof typeof AnalyticsControllerGetTopModulesByVolumePeriodEnum];
|
|
21442
|
+
/**
|
|
21443
|
+
* @export
|
|
21444
|
+
*/
|
|
21445
|
+
export declare const AnalyticsControllerGetTopServersPeriodEnum: {
|
|
21446
|
+
readonly _24h: "24h";
|
|
21447
|
+
readonly _7d: "7d";
|
|
21448
|
+
readonly _30d: "30d";
|
|
21449
|
+
readonly _90d: "90d";
|
|
21450
|
+
};
|
|
21451
|
+
export type AnalyticsControllerGetTopServersPeriodEnum = (typeof AnalyticsControllerGetTopServersPeriodEnum)[keyof typeof AnalyticsControllerGetTopServersPeriodEnum];
|
|
21452
|
+
/**
|
|
21453
|
+
* ApiKeyApi - axios parameter creator
|
|
21454
|
+
* @export
|
|
21455
|
+
*/
|
|
21456
|
+
export declare const ApiKeyApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21457
|
+
/**
|
|
21458
|
+
* Creates an API Key. `kind: \"personal\"` (the default) creates a Personal Key for the calling user, which acts as them. `kind: \"domain\"` requires the MANAGE_API_KEYS permission and creates a Domain Key that belongs to the Domain and acts through a Service Account holding the roles in `roleIds`; `roleIds` is rejected for a Personal Key. The `key` field is returned ONCE in this response — Takaro stores only a hash and cannot show it again. Optionally restricts the key to a list of source CIDR ranges (`ipAllowlist`); a request from any other address is rejected with a 401, provided the deployment’s gateway overwrites `X-Forwarded-For` — pinning that is tracked as a follow-up to GH #3814 (see docs/api/authentication.md).<br> OperationId: `ApiKeyControllerCreate`
|
|
21459
|
+
* @summary Create API key
|
|
21460
|
+
* @param {ApiKeyCreateInputDTO} [apiKeyCreateInputDTO] ApiKeyCreateInputDTO
|
|
21461
|
+
* @param {*} [options] Override http request option.
|
|
21462
|
+
* @throws {RequiredError}
|
|
21463
|
+
*/
|
|
21464
|
+
apiKeyControllerCreate: (apiKeyCreateInputDTO?: ApiKeyCreateInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21465
|
+
/**
|
|
21466
|
+
* Returns one key: the caller’s own, or any key in the Domain for a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerGetOne`
|
|
21467
|
+
* @summary Get API key
|
|
21468
|
+
* @param {string} id
|
|
21469
|
+
* @param {*} [options] Override http request option.
|
|
21470
|
+
* @throws {RequiredError}
|
|
21471
|
+
*/
|
|
21472
|
+
apiKeyControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21473
|
+
/**
|
|
21474
|
+
* Revokes a key: the next request with its secret is rejected. The key stays listed as revoked for 30 days and is then hard-deleted — for a Domain Key, that hard delete also removes its Service Account. Revoking a Domain Key immediately strips its Service Account’s roles as well. Idempotent. The owner may revoke their own key; a MANAGE_API_KEYS holder may revoke any key in the Domain.<br> OperationId: `ApiKeyControllerRevoke`
|
|
21475
|
+
* @summary Revoke API key
|
|
21476
|
+
* @param {string} id
|
|
21477
|
+
* @param {*} [options] Override http request option.
|
|
21478
|
+
* @throws {RequiredError}
|
|
21479
|
+
*/
|
|
21480
|
+
apiKeyControllerRevoke: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21481
|
+
/**
|
|
21482
|
+
* Issues a fresh secret on the same row, preserving name, scope and history. The `key` field is returned ONCE in this response and cannot be shown again. Only the owner may rotate a Personal Key; a Domain Key requires MANAGE_API_KEYS.<br> OperationId: `ApiKeyControllerRotate`
|
|
21483
|
+
* @summary Rotate API key
|
|
21484
|
+
* @param {string} id
|
|
21485
|
+
* @param {*} [options] Override http request option.
|
|
21486
|
+
* @throws {RequiredError}
|
|
21487
|
+
*/
|
|
21488
|
+
apiKeyControllerRotate: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21489
|
+
/**
|
|
21490
|
+
* Returns the calling user’s own keys. A MANAGE_API_KEYS holder instead sees every key in the Domain and may filter by `userId` or `kind`. Public fields only: never the secret or its hash.<br> OperationId: `ApiKeyControllerSearch`
|
|
21491
|
+
* @summary Search API keys
|
|
21492
|
+
* @param {ApiKeySearchInputDTO} [apiKeySearchInputDTO] ApiKeySearchInputDTO
|
|
21493
|
+
* @param {*} [options] Override http request option.
|
|
21494
|
+
* @throws {RequiredError}
|
|
21495
|
+
*/
|
|
21496
|
+
apiKeyControllerSearch: (apiKeySearchInputDTO?: ApiKeySearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21497
|
+
/**
|
|
21498
|
+
* Renames, rescopes or changes the expiry of a key. A Personal Key may only be updated by its owner — a MANAGE_API_KEYS holder gets a 403, because editing someone else’s credential is not theirs to do. A Domain Key requires MANAGE_API_KEYS and additionally accepts `roleIds`, which REPLACES its Service Account’s roles (an empty array strips them all). A scope is revalidated against the caller’s current permissions. Omitted fields are left untouched; an explicit null clears the scope restriction or removes the expiry. `ipAllowlist` replaces the list wholesale; an explicit null removes the restriction — and it is only enforceable against the real client address if the deployment’s gateway overwrites `X-Forwarded-For` (a follow-up to GH #3814; see docs/api/authentication.md). A credential acting as ITSELF may not send `expiresAt` or `ipAllowlist` at all: a key cannot relax its own restrictions (403).<br> OperationId: `ApiKeyControllerUpdate`
|
|
21499
|
+
* @summary Update API key
|
|
21500
|
+
* @param {string} id
|
|
21501
|
+
* @param {ApiKeyUpdateInputDTO} [apiKeyUpdateInputDTO] ApiKeyUpdateInputDTO
|
|
21502
|
+
* @param {*} [options] Override http request option.
|
|
21503
|
+
* @throws {RequiredError}
|
|
21504
|
+
*/
|
|
21505
|
+
apiKeyControllerUpdate: (id: string, apiKeyUpdateInputDTO?: ApiKeyUpdateInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21506
|
+
/**
|
|
21507
|
+
* Request counts for one key, bucketed per UTC day over the window (default: the last 30 days, maximum 366). Every day in the window is present, zero-filled. Counts every request that authenticated with the key, including ones later refused for a missing permission or by the per-key rate limit; a request with an invalid, revoked or expired secret is not counted. Counters are flushed every few seconds, so the most recent requests can lag slightly. History is kept for 90 days. Visible to the key’s owner, or to a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerUsage`
|
|
21508
|
+
* @summary Get API key usage
|
|
21509
|
+
* @param {string} id
|
|
21510
|
+
* @param {string} [startDate]
|
|
21511
|
+
* @param {string} [endDate]
|
|
21512
|
+
* @param {*} [options] Override http request option.
|
|
21513
|
+
* @throws {RequiredError}
|
|
21514
|
+
*/
|
|
21515
|
+
apiKeyControllerUsage: (id: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21516
|
+
};
|
|
21517
|
+
/**
|
|
21518
|
+
* ApiKeyApi - functional programming interface
|
|
21519
|
+
* @export
|
|
21520
|
+
*/
|
|
21521
|
+
export declare const ApiKeyApiFp: (configuration?: Configuration) => {
|
|
21522
|
+
/**
|
|
21523
|
+
* Creates an API Key. `kind: \"personal\"` (the default) creates a Personal Key for the calling user, which acts as them. `kind: \"domain\"` requires the MANAGE_API_KEYS permission and creates a Domain Key that belongs to the Domain and acts through a Service Account holding the roles in `roleIds`; `roleIds` is rejected for a Personal Key. The `key` field is returned ONCE in this response — Takaro stores only a hash and cannot show it again. Optionally restricts the key to a list of source CIDR ranges (`ipAllowlist`); a request from any other address is rejected with a 401, provided the deployment’s gateway overwrites `X-Forwarded-For` — pinning that is tracked as a follow-up to GH #3814 (see docs/api/authentication.md).<br> OperationId: `ApiKeyControllerCreate`
|
|
21524
|
+
* @summary Create API key
|
|
21525
|
+
* @param {ApiKeyCreateInputDTO} [apiKeyCreateInputDTO] ApiKeyCreateInputDTO
|
|
21526
|
+
* @param {*} [options] Override http request option.
|
|
21527
|
+
* @throws {RequiredError}
|
|
21528
|
+
*/
|
|
21529
|
+
apiKeyControllerCreate(apiKeyCreateInputDTO?: ApiKeyCreateInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKeyCreateResultDTOAPI>>;
|
|
21530
|
+
/**
|
|
21531
|
+
* Returns one key: the caller’s own, or any key in the Domain for a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerGetOne`
|
|
21532
|
+
* @summary Get API key
|
|
21533
|
+
* @param {string} id
|
|
21534
|
+
* @param {*} [options] Override http request option.
|
|
21535
|
+
* @throws {RequiredError}
|
|
21536
|
+
*/
|
|
21537
|
+
apiKeyControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKeyOutputDTOAPI>>;
|
|
21538
|
+
/**
|
|
21539
|
+
* Revokes a key: the next request with its secret is rejected. The key stays listed as revoked for 30 days and is then hard-deleted — for a Domain Key, that hard delete also removes its Service Account. Revoking a Domain Key immediately strips its Service Account’s roles as well. Idempotent. The owner may revoke their own key; a MANAGE_API_KEYS holder may revoke any key in the Domain.<br> OperationId: `ApiKeyControllerRevoke`
|
|
21540
|
+
* @summary Revoke API key
|
|
21541
|
+
* @param {string} id
|
|
21542
|
+
* @param {*} [options] Override http request option.
|
|
21543
|
+
* @throws {RequiredError}
|
|
21544
|
+
*/
|
|
21545
|
+
apiKeyControllerRevoke(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
|
|
21546
|
+
/**
|
|
21547
|
+
* Issues a fresh secret on the same row, preserving name, scope and history. The `key` field is returned ONCE in this response and cannot be shown again. Only the owner may rotate a Personal Key; a Domain Key requires MANAGE_API_KEYS.<br> OperationId: `ApiKeyControllerRotate`
|
|
21548
|
+
* @summary Rotate API key
|
|
21549
|
+
* @param {string} id
|
|
21550
|
+
* @param {*} [options] Override http request option.
|
|
21551
|
+
* @throws {RequiredError}
|
|
21552
|
+
*/
|
|
21553
|
+
apiKeyControllerRotate(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKeyCreateResultDTOAPI>>;
|
|
21554
|
+
/**
|
|
21555
|
+
* Returns the calling user’s own keys. A MANAGE_API_KEYS holder instead sees every key in the Domain and may filter by `userId` or `kind`. Public fields only: never the secret or its hash.<br> OperationId: `ApiKeyControllerSearch`
|
|
21556
|
+
* @summary Search API keys
|
|
21557
|
+
* @param {ApiKeySearchInputDTO} [apiKeySearchInputDTO] ApiKeySearchInputDTO
|
|
21558
|
+
* @param {*} [options] Override http request option.
|
|
21559
|
+
* @throws {RequiredError}
|
|
21560
|
+
*/
|
|
21561
|
+
apiKeyControllerSearch(apiKeySearchInputDTO?: ApiKeySearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKeyOutputArrayDTOAPI>>;
|
|
21562
|
+
/**
|
|
21563
|
+
* Renames, rescopes or changes the expiry of a key. A Personal Key may only be updated by its owner — a MANAGE_API_KEYS holder gets a 403, because editing someone else’s credential is not theirs to do. A Domain Key requires MANAGE_API_KEYS and additionally accepts `roleIds`, which REPLACES its Service Account’s roles (an empty array strips them all). A scope is revalidated against the caller’s current permissions. Omitted fields are left untouched; an explicit null clears the scope restriction or removes the expiry. `ipAllowlist` replaces the list wholesale; an explicit null removes the restriction — and it is only enforceable against the real client address if the deployment’s gateway overwrites `X-Forwarded-For` (a follow-up to GH #3814; see docs/api/authentication.md). A credential acting as ITSELF may not send `expiresAt` or `ipAllowlist` at all: a key cannot relax its own restrictions (403).<br> OperationId: `ApiKeyControllerUpdate`
|
|
21564
|
+
* @summary Update API key
|
|
21565
|
+
* @param {string} id
|
|
21566
|
+
* @param {ApiKeyUpdateInputDTO} [apiKeyUpdateInputDTO] ApiKeyUpdateInputDTO
|
|
21567
|
+
* @param {*} [options] Override http request option.
|
|
21568
|
+
* @throws {RequiredError}
|
|
21569
|
+
*/
|
|
21570
|
+
apiKeyControllerUpdate(id: string, apiKeyUpdateInputDTO?: ApiKeyUpdateInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKeyOutputDTOAPI>>;
|
|
21571
|
+
/**
|
|
21572
|
+
* Request counts for one key, bucketed per UTC day over the window (default: the last 30 days, maximum 366). Every day in the window is present, zero-filled. Counts every request that authenticated with the key, including ones later refused for a missing permission or by the per-key rate limit; a request with an invalid, revoked or expired secret is not counted. Counters are flushed every few seconds, so the most recent requests can lag slightly. History is kept for 90 days. Visible to the key’s owner, or to a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerUsage`
|
|
21573
|
+
* @summary Get API key usage
|
|
21574
|
+
* @param {string} id
|
|
21575
|
+
* @param {string} [startDate]
|
|
21576
|
+
* @param {string} [endDate]
|
|
21577
|
+
* @param {*} [options] Override http request option.
|
|
21578
|
+
* @throws {RequiredError}
|
|
21579
|
+
*/
|
|
21580
|
+
apiKeyControllerUsage(id: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKeyUsageOutputDTOAPI>>;
|
|
21581
|
+
};
|
|
21582
|
+
/**
|
|
21583
|
+
* ApiKeyApi - factory interface
|
|
21584
|
+
* @export
|
|
21585
|
+
*/
|
|
21586
|
+
export declare const ApiKeyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
21587
|
+
/**
|
|
21588
|
+
* Creates an API Key. `kind: \"personal\"` (the default) creates a Personal Key for the calling user, which acts as them. `kind: \"domain\"` requires the MANAGE_API_KEYS permission and creates a Domain Key that belongs to the Domain and acts through a Service Account holding the roles in `roleIds`; `roleIds` is rejected for a Personal Key. The `key` field is returned ONCE in this response — Takaro stores only a hash and cannot show it again. Optionally restricts the key to a list of source CIDR ranges (`ipAllowlist`); a request from any other address is rejected with a 401, provided the deployment’s gateway overwrites `X-Forwarded-For` — pinning that is tracked as a follow-up to GH #3814 (see docs/api/authentication.md).<br> OperationId: `ApiKeyControllerCreate`
|
|
21589
|
+
* @summary Create API key
|
|
21590
|
+
* @param {ApiKeyCreateInputDTO} [apiKeyCreateInputDTO] ApiKeyCreateInputDTO
|
|
21591
|
+
* @param {*} [options] Override http request option.
|
|
21592
|
+
* @throws {RequiredError}
|
|
21593
|
+
*/
|
|
21594
|
+
apiKeyControllerCreate(apiKeyCreateInputDTO?: ApiKeyCreateInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ApiKeyCreateResultDTOAPI>;
|
|
21595
|
+
/**
|
|
21596
|
+
* Returns one key: the caller’s own, or any key in the Domain for a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerGetOne`
|
|
21597
|
+
* @summary Get API key
|
|
21598
|
+
* @param {string} id
|
|
21599
|
+
* @param {*} [options] Override http request option.
|
|
21600
|
+
* @throws {RequiredError}
|
|
21601
|
+
*/
|
|
21602
|
+
apiKeyControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiKeyOutputDTOAPI>;
|
|
21603
|
+
/**
|
|
21604
|
+
* Revokes a key: the next request with its secret is rejected. The key stays listed as revoked for 30 days and is then hard-deleted — for a Domain Key, that hard delete also removes its Service Account. Revoking a Domain Key immediately strips its Service Account’s roles as well. Idempotent. The owner may revoke their own key; a MANAGE_API_KEYS holder may revoke any key in the Domain.<br> OperationId: `ApiKeyControllerRevoke`
|
|
21605
|
+
* @summary Revoke API key
|
|
21606
|
+
* @param {string} id
|
|
21607
|
+
* @param {*} [options] Override http request option.
|
|
21608
|
+
* @throws {RequiredError}
|
|
21609
|
+
*/
|
|
21610
|
+
apiKeyControllerRevoke(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
|
|
21611
|
+
/**
|
|
21612
|
+
* Issues a fresh secret on the same row, preserving name, scope and history. The `key` field is returned ONCE in this response and cannot be shown again. Only the owner may rotate a Personal Key; a Domain Key requires MANAGE_API_KEYS.<br> OperationId: `ApiKeyControllerRotate`
|
|
21613
|
+
* @summary Rotate API key
|
|
21614
|
+
* @param {string} id
|
|
21615
|
+
* @param {*} [options] Override http request option.
|
|
21616
|
+
* @throws {RequiredError}
|
|
21617
|
+
*/
|
|
21618
|
+
apiKeyControllerRotate(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiKeyCreateResultDTOAPI>;
|
|
21619
|
+
/**
|
|
21620
|
+
* Returns the calling user’s own keys. A MANAGE_API_KEYS holder instead sees every key in the Domain and may filter by `userId` or `kind`. Public fields only: never the secret or its hash.<br> OperationId: `ApiKeyControllerSearch`
|
|
21621
|
+
* @summary Search API keys
|
|
21622
|
+
* @param {ApiKeySearchInputDTO} [apiKeySearchInputDTO] ApiKeySearchInputDTO
|
|
21623
|
+
* @param {*} [options] Override http request option.
|
|
21624
|
+
* @throws {RequiredError}
|
|
21625
|
+
*/
|
|
21626
|
+
apiKeyControllerSearch(apiKeySearchInputDTO?: ApiKeySearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ApiKeyOutputArrayDTOAPI>;
|
|
21627
|
+
/**
|
|
21628
|
+
* Renames, rescopes or changes the expiry of a key. A Personal Key may only be updated by its owner — a MANAGE_API_KEYS holder gets a 403, because editing someone else’s credential is not theirs to do. A Domain Key requires MANAGE_API_KEYS and additionally accepts `roleIds`, which REPLACES its Service Account’s roles (an empty array strips them all). A scope is revalidated against the caller’s current permissions. Omitted fields are left untouched; an explicit null clears the scope restriction or removes the expiry. `ipAllowlist` replaces the list wholesale; an explicit null removes the restriction — and it is only enforceable against the real client address if the deployment’s gateway overwrites `X-Forwarded-For` (a follow-up to GH #3814; see docs/api/authentication.md). A credential acting as ITSELF may not send `expiresAt` or `ipAllowlist` at all: a key cannot relax its own restrictions (403).<br> OperationId: `ApiKeyControllerUpdate`
|
|
21629
|
+
* @summary Update API key
|
|
21630
|
+
* @param {string} id
|
|
21631
|
+
* @param {ApiKeyUpdateInputDTO} [apiKeyUpdateInputDTO] ApiKeyUpdateInputDTO
|
|
21632
|
+
* @param {*} [options] Override http request option.
|
|
21633
|
+
* @throws {RequiredError}
|
|
21634
|
+
*/
|
|
21635
|
+
apiKeyControllerUpdate(id: string, apiKeyUpdateInputDTO?: ApiKeyUpdateInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ApiKeyOutputDTOAPI>;
|
|
21636
|
+
/**
|
|
21637
|
+
* Request counts for one key, bucketed per UTC day over the window (default: the last 30 days, maximum 366). Every day in the window is present, zero-filled. Counts every request that authenticated with the key, including ones later refused for a missing permission or by the per-key rate limit; a request with an invalid, revoked or expired secret is not counted. Counters are flushed every few seconds, so the most recent requests can lag slightly. History is kept for 90 days. Visible to the key’s owner, or to a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerUsage`
|
|
21638
|
+
* @summary Get API key usage
|
|
21639
|
+
* @param {string} id
|
|
21640
|
+
* @param {string} [startDate]
|
|
21641
|
+
* @param {string} [endDate]
|
|
21642
|
+
* @param {*} [options] Override http request option.
|
|
21643
|
+
* @throws {RequiredError}
|
|
21644
|
+
*/
|
|
21645
|
+
apiKeyControllerUsage(id: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): AxiosPromise<ApiKeyUsageOutputDTOAPI>;
|
|
21646
|
+
};
|
|
20489
21647
|
/**
|
|
21648
|
+
* ApiKeyApi - object-oriented interface
|
|
20490
21649
|
* @export
|
|
21650
|
+
* @class ApiKeyApi
|
|
21651
|
+
* @extends {BaseAPI}
|
|
20491
21652
|
*/
|
|
20492
|
-
export declare
|
|
20493
|
-
|
|
20494
|
-
|
|
20495
|
-
|
|
20496
|
-
|
|
20497
|
-
}
|
|
20498
|
-
|
|
21653
|
+
export declare class ApiKeyApi extends BaseAPI {
|
|
21654
|
+
/**
|
|
21655
|
+
* Creates an API Key. `kind: \"personal\"` (the default) creates a Personal Key for the calling user, which acts as them. `kind: \"domain\"` requires the MANAGE_API_KEYS permission and creates a Domain Key that belongs to the Domain and acts through a Service Account holding the roles in `roleIds`; `roleIds` is rejected for a Personal Key. The `key` field is returned ONCE in this response — Takaro stores only a hash and cannot show it again. Optionally restricts the key to a list of source CIDR ranges (`ipAllowlist`); a request from any other address is rejected with a 401, provided the deployment’s gateway overwrites `X-Forwarded-For` — pinning that is tracked as a follow-up to GH #3814 (see docs/api/authentication.md).<br> OperationId: `ApiKeyControllerCreate`
|
|
21656
|
+
* @summary Create API key
|
|
21657
|
+
* @param {ApiKeyCreateInputDTO} [apiKeyCreateInputDTO] ApiKeyCreateInputDTO
|
|
21658
|
+
* @param {*} [options] Override http request option.
|
|
21659
|
+
* @throws {RequiredError}
|
|
21660
|
+
* @memberof ApiKeyApi
|
|
21661
|
+
*/
|
|
21662
|
+
apiKeyControllerCreate(apiKeyCreateInputDTO?: ApiKeyCreateInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKeyCreateResultDTOAPI, any>>;
|
|
21663
|
+
/**
|
|
21664
|
+
* Returns one key: the caller’s own, or any key in the Domain for a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerGetOne`
|
|
21665
|
+
* @summary Get API key
|
|
21666
|
+
* @param {string} id
|
|
21667
|
+
* @param {*} [options] Override http request option.
|
|
21668
|
+
* @throws {RequiredError}
|
|
21669
|
+
* @memberof ApiKeyApi
|
|
21670
|
+
*/
|
|
21671
|
+
apiKeyControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKeyOutputDTOAPI, any>>;
|
|
21672
|
+
/**
|
|
21673
|
+
* Revokes a key: the next request with its secret is rejected. The key stays listed as revoked for 30 days and is then hard-deleted — for a Domain Key, that hard delete also removes its Service Account. Revoking a Domain Key immediately strips its Service Account’s roles as well. Idempotent. The owner may revoke their own key; a MANAGE_API_KEYS holder may revoke any key in the Domain.<br> OperationId: `ApiKeyControllerRevoke`
|
|
21674
|
+
* @summary Revoke API key
|
|
21675
|
+
* @param {string} id
|
|
21676
|
+
* @param {*} [options] Override http request option.
|
|
21677
|
+
* @throws {RequiredError}
|
|
21678
|
+
* @memberof ApiKeyApi
|
|
21679
|
+
*/
|
|
21680
|
+
apiKeyControllerRevoke(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
|
|
21681
|
+
/**
|
|
21682
|
+
* Issues a fresh secret on the same row, preserving name, scope and history. The `key` field is returned ONCE in this response and cannot be shown again. Only the owner may rotate a Personal Key; a Domain Key requires MANAGE_API_KEYS.<br> OperationId: `ApiKeyControllerRotate`
|
|
21683
|
+
* @summary Rotate API key
|
|
21684
|
+
* @param {string} id
|
|
21685
|
+
* @param {*} [options] Override http request option.
|
|
21686
|
+
* @throws {RequiredError}
|
|
21687
|
+
* @memberof ApiKeyApi
|
|
21688
|
+
*/
|
|
21689
|
+
apiKeyControllerRotate(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKeyCreateResultDTOAPI, any>>;
|
|
21690
|
+
/**
|
|
21691
|
+
* Returns the calling user’s own keys. A MANAGE_API_KEYS holder instead sees every key in the Domain and may filter by `userId` or `kind`. Public fields only: never the secret or its hash.<br> OperationId: `ApiKeyControllerSearch`
|
|
21692
|
+
* @summary Search API keys
|
|
21693
|
+
* @param {ApiKeySearchInputDTO} [apiKeySearchInputDTO] ApiKeySearchInputDTO
|
|
21694
|
+
* @param {*} [options] Override http request option.
|
|
21695
|
+
* @throws {RequiredError}
|
|
21696
|
+
* @memberof ApiKeyApi
|
|
21697
|
+
*/
|
|
21698
|
+
apiKeyControllerSearch(apiKeySearchInputDTO?: ApiKeySearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKeyOutputArrayDTOAPI, any>>;
|
|
21699
|
+
/**
|
|
21700
|
+
* Renames, rescopes or changes the expiry of a key. A Personal Key may only be updated by its owner — a MANAGE_API_KEYS holder gets a 403, because editing someone else’s credential is not theirs to do. A Domain Key requires MANAGE_API_KEYS and additionally accepts `roleIds`, which REPLACES its Service Account’s roles (an empty array strips them all). A scope is revalidated against the caller’s current permissions. Omitted fields are left untouched; an explicit null clears the scope restriction or removes the expiry. `ipAllowlist` replaces the list wholesale; an explicit null removes the restriction — and it is only enforceable against the real client address if the deployment’s gateway overwrites `X-Forwarded-For` (a follow-up to GH #3814; see docs/api/authentication.md). A credential acting as ITSELF may not send `expiresAt` or `ipAllowlist` at all: a key cannot relax its own restrictions (403).<br> OperationId: `ApiKeyControllerUpdate`
|
|
21701
|
+
* @summary Update API key
|
|
21702
|
+
* @param {string} id
|
|
21703
|
+
* @param {ApiKeyUpdateInputDTO} [apiKeyUpdateInputDTO] ApiKeyUpdateInputDTO
|
|
21704
|
+
* @param {*} [options] Override http request option.
|
|
21705
|
+
* @throws {RequiredError}
|
|
21706
|
+
* @memberof ApiKeyApi
|
|
21707
|
+
*/
|
|
21708
|
+
apiKeyControllerUpdate(id: string, apiKeyUpdateInputDTO?: ApiKeyUpdateInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKeyOutputDTOAPI, any>>;
|
|
21709
|
+
/**
|
|
21710
|
+
* Request counts for one key, bucketed per UTC day over the window (default: the last 30 days, maximum 366). Every day in the window is present, zero-filled. Counts every request that authenticated with the key, including ones later refused for a missing permission or by the per-key rate limit; a request with an invalid, revoked or expired secret is not counted. Counters are flushed every few seconds, so the most recent requests can lag slightly. History is kept for 90 days. Visible to the key’s owner, or to a MANAGE_API_KEYS holder.<br> OperationId: `ApiKeyControllerUsage`
|
|
21711
|
+
* @summary Get API key usage
|
|
21712
|
+
* @param {string} id
|
|
21713
|
+
* @param {string} [startDate]
|
|
21714
|
+
* @param {string} [endDate]
|
|
21715
|
+
* @param {*} [options] Override http request option.
|
|
21716
|
+
* @throws {RequiredError}
|
|
21717
|
+
* @memberof ApiKeyApi
|
|
21718
|
+
*/
|
|
21719
|
+
apiKeyControllerUsage(id: string, startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApiKeyUsageOutputDTOAPI, any>>;
|
|
21720
|
+
}
|
|
20499
21721
|
/**
|
|
20500
21722
|
* AuthApi - axios parameter creator
|
|
20501
21723
|
* @export
|
|
@@ -21597,308 +22819,6 @@ export declare class DiscordApi extends BaseAPI {
|
|
|
21597
22819
|
*/
|
|
21598
22820
|
discordControllerUpdateMessage(channelId: string, messageId: string, sendMessageInputDTO?: SendMessageInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageOutputDTOAPI, any>>;
|
|
21599
22821
|
}
|
|
21600
|
-
/**
|
|
21601
|
-
* DomainApi - axios parameter creator
|
|
21602
|
-
* @export
|
|
21603
|
-
*/
|
|
21604
|
-
export declare const DomainApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21605
|
-
/**
|
|
21606
|
-
* <br> OperationId: `DomainControllerCreate`
|
|
21607
|
-
* @summary Create
|
|
21608
|
-
* @param {DomainCreateInputDTO} [domainCreateInputDTO] DomainCreateInputDTO
|
|
21609
|
-
* @param {*} [options] Override http request option.
|
|
21610
|
-
* @throws {RequiredError}
|
|
21611
|
-
*/
|
|
21612
|
-
domainControllerCreate: (domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21613
|
-
/**
|
|
21614
|
-
* Creates a staff-recovery invite link scoped to the target domain. The `token` and `inviteUrl` fields are returned ONCE and are not stored on the server — distribute securely. Hardened for recovery use: expiry is forced to 24 hours and maxUses is forced to 1, regardless of request body values. roleIds is passed through as-is; omit it to grant no extra roles (plain member). Attribution is limited: the admin secret is a single shared identity; this event records that staff acted on the domain but cannot name the individual.<br> OperationId: `DomainControllerCreateInviteLink`
|
|
21615
|
-
* @summary Create staff-recovery invite link for a domain
|
|
21616
|
-
* @param {string} id
|
|
21617
|
-
* @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
|
|
21618
|
-
* @param {*} [options] Override http request option.
|
|
21619
|
-
* @throws {RequiredError}
|
|
21620
|
-
*/
|
|
21621
|
-
domainControllerCreateInviteLink: (id: string, inviteLinkCreateInputDTO?: InviteLinkCreateInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21622
|
-
/**
|
|
21623
|
-
* <br> OperationId: `DomainControllerGetOne`
|
|
21624
|
-
* @summary Get one
|
|
21625
|
-
* @param {string} id
|
|
21626
|
-
* @param {*} [options] Override http request option.
|
|
21627
|
-
* @throws {RequiredError}
|
|
21628
|
-
*/
|
|
21629
|
-
domainControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21630
|
-
/**
|
|
21631
|
-
* <br> OperationId: `DomainControllerGetToken`
|
|
21632
|
-
* @summary Get token
|
|
21633
|
-
* @param {TokenInputDTO} [tokenInputDTO] TokenInputDTO
|
|
21634
|
-
* @param {*} [options] Override http request option.
|
|
21635
|
-
* @throws {RequiredError}
|
|
21636
|
-
*/
|
|
21637
|
-
domainControllerGetToken: (tokenInputDTO?: TokenInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21638
|
-
/**
|
|
21639
|
-
* <br> OperationId: `DomainControllerRemove`
|
|
21640
|
-
* @summary Remove
|
|
21641
|
-
* @param {string} id
|
|
21642
|
-
* @param {any} [hardDelete]
|
|
21643
|
-
* @param {*} [options] Override http request option.
|
|
21644
|
-
* @throws {RequiredError}
|
|
21645
|
-
*/
|
|
21646
|
-
domainControllerRemove: (id: string, hardDelete?: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21647
|
-
/**
|
|
21648
|
-
* <br> OperationId: `DomainControllerResolveRegistrationToken`
|
|
21649
|
-
* @summary Resolve registration token
|
|
21650
|
-
* @param {ResolveRegistrationTokenInputDTO} [resolveRegistrationTokenInputDTO] ResolveRegistrationTokenInputDTO
|
|
21651
|
-
* @param {*} [options] Override http request option.
|
|
21652
|
-
* @throws {RequiredError}
|
|
21653
|
-
*/
|
|
21654
|
-
domainControllerResolveRegistrationToken: (resolveRegistrationTokenInputDTO?: ResolveRegistrationTokenInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21655
|
-
/**
|
|
21656
|
-
* <br> OperationId: `DomainControllerSearch`
|
|
21657
|
-
* @summary Search
|
|
21658
|
-
* @param {DomainSearchInputDTO} [domainSearchInputDTO] DomainSearchInputDTO
|
|
21659
|
-
* @param {*} [options] Override http request option.
|
|
21660
|
-
* @throws {RequiredError}
|
|
21661
|
-
*/
|
|
21662
|
-
domainControllerSearch: (domainSearchInputDTO?: DomainSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21663
|
-
/**
|
|
21664
|
-
* <br> OperationId: `DomainControllerUpdate`
|
|
21665
|
-
* @summary Update
|
|
21666
|
-
* @param {string} id
|
|
21667
|
-
* @param {DomainUpdateInputDTO} [domainUpdateInputDTO] DomainUpdateInputDTO
|
|
21668
|
-
* @param {*} [options] Override http request option.
|
|
21669
|
-
* @throws {RequiredError}
|
|
21670
|
-
*/
|
|
21671
|
-
domainControllerUpdate: (id: string, domainUpdateInputDTO?: DomainUpdateInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21672
|
-
};
|
|
21673
|
-
/**
|
|
21674
|
-
* DomainApi - functional programming interface
|
|
21675
|
-
* @export
|
|
21676
|
-
*/
|
|
21677
|
-
export declare const DomainApiFp: (configuration?: Configuration) => {
|
|
21678
|
-
/**
|
|
21679
|
-
* <br> OperationId: `DomainControllerCreate`
|
|
21680
|
-
* @summary Create
|
|
21681
|
-
* @param {DomainCreateInputDTO} [domainCreateInputDTO] DomainCreateInputDTO
|
|
21682
|
-
* @param {*} [options] Override http request option.
|
|
21683
|
-
* @throws {RequiredError}
|
|
21684
|
-
*/
|
|
21685
|
-
domainControllerCreate(domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainCreateOutputDTOAPI>>;
|
|
21686
|
-
/**
|
|
21687
|
-
* Creates a staff-recovery invite link scoped to the target domain. The `token` and `inviteUrl` fields are returned ONCE and are not stored on the server — distribute securely. Hardened for recovery use: expiry is forced to 24 hours and maxUses is forced to 1, regardless of request body values. roleIds is passed through as-is; omit it to grant no extra roles (plain member). Attribution is limited: the admin secret is a single shared identity; this event records that staff acted on the domain but cannot name the individual.<br> OperationId: `DomainControllerCreateInviteLink`
|
|
21688
|
-
* @summary Create staff-recovery invite link for a domain
|
|
21689
|
-
* @param {string} id
|
|
21690
|
-
* @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
|
|
21691
|
-
* @param {*} [options] Override http request option.
|
|
21692
|
-
* @throws {RequiredError}
|
|
21693
|
-
*/
|
|
21694
|
-
domainControllerCreateInviteLink(id: string, inviteLinkCreateInputDTO?: InviteLinkCreateInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteLinkCreateResultDTOAPI>>;
|
|
21695
|
-
/**
|
|
21696
|
-
* <br> OperationId: `DomainControllerGetOne`
|
|
21697
|
-
* @summary Get one
|
|
21698
|
-
* @param {string} id
|
|
21699
|
-
* @param {*} [options] Override http request option.
|
|
21700
|
-
* @throws {RequiredError}
|
|
21701
|
-
*/
|
|
21702
|
-
domainControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainOutputDTOAPI>>;
|
|
21703
|
-
/**
|
|
21704
|
-
* <br> OperationId: `DomainControllerGetToken`
|
|
21705
|
-
* @summary Get token
|
|
21706
|
-
* @param {TokenInputDTO} [tokenInputDTO] TokenInputDTO
|
|
21707
|
-
* @param {*} [options] Override http request option.
|
|
21708
|
-
* @throws {RequiredError}
|
|
21709
|
-
*/
|
|
21710
|
-
domainControllerGetToken(tokenInputDTO?: TokenInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenOutputDTOAPI>>;
|
|
21711
|
-
/**
|
|
21712
|
-
* <br> OperationId: `DomainControllerRemove`
|
|
21713
|
-
* @summary Remove
|
|
21714
|
-
* @param {string} id
|
|
21715
|
-
* @param {any} [hardDelete]
|
|
21716
|
-
* @param {*} [options] Override http request option.
|
|
21717
|
-
* @throws {RequiredError}
|
|
21718
|
-
*/
|
|
21719
|
-
domainControllerRemove(id: string, hardDelete?: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
|
|
21720
|
-
/**
|
|
21721
|
-
* <br> OperationId: `DomainControllerResolveRegistrationToken`
|
|
21722
|
-
* @summary Resolve registration token
|
|
21723
|
-
* @param {ResolveRegistrationTokenInputDTO} [resolveRegistrationTokenInputDTO] ResolveRegistrationTokenInputDTO
|
|
21724
|
-
* @param {*} [options] Override http request option.
|
|
21725
|
-
* @throws {RequiredError}
|
|
21726
|
-
*/
|
|
21727
|
-
domainControllerResolveRegistrationToken(resolveRegistrationTokenInputDTO?: ResolveRegistrationTokenInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainOutputDTOAPI>>;
|
|
21728
|
-
/**
|
|
21729
|
-
* <br> OperationId: `DomainControllerSearch`
|
|
21730
|
-
* @summary Search
|
|
21731
|
-
* @param {DomainSearchInputDTO} [domainSearchInputDTO] DomainSearchInputDTO
|
|
21732
|
-
* @param {*} [options] Override http request option.
|
|
21733
|
-
* @throws {RequiredError}
|
|
21734
|
-
*/
|
|
21735
|
-
domainControllerSearch(domainSearchInputDTO?: DomainSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainOutputArrayDTOAPI>>;
|
|
21736
|
-
/**
|
|
21737
|
-
* <br> OperationId: `DomainControllerUpdate`
|
|
21738
|
-
* @summary Update
|
|
21739
|
-
* @param {string} id
|
|
21740
|
-
* @param {DomainUpdateInputDTO} [domainUpdateInputDTO] DomainUpdateInputDTO
|
|
21741
|
-
* @param {*} [options] Override http request option.
|
|
21742
|
-
* @throws {RequiredError}
|
|
21743
|
-
*/
|
|
21744
|
-
domainControllerUpdate(id: string, domainUpdateInputDTO?: DomainUpdateInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainOutputDTOAPI>>;
|
|
21745
|
-
};
|
|
21746
|
-
/**
|
|
21747
|
-
* DomainApi - factory interface
|
|
21748
|
-
* @export
|
|
21749
|
-
*/
|
|
21750
|
-
export declare const DomainApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
21751
|
-
/**
|
|
21752
|
-
* <br> OperationId: `DomainControllerCreate`
|
|
21753
|
-
* @summary Create
|
|
21754
|
-
* @param {DomainCreateInputDTO} [domainCreateInputDTO] DomainCreateInputDTO
|
|
21755
|
-
* @param {*} [options] Override http request option.
|
|
21756
|
-
* @throws {RequiredError}
|
|
21757
|
-
*/
|
|
21758
|
-
domainControllerCreate(domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<DomainCreateOutputDTOAPI>;
|
|
21759
|
-
/**
|
|
21760
|
-
* Creates a staff-recovery invite link scoped to the target domain. The `token` and `inviteUrl` fields are returned ONCE and are not stored on the server — distribute securely. Hardened for recovery use: expiry is forced to 24 hours and maxUses is forced to 1, regardless of request body values. roleIds is passed through as-is; omit it to grant no extra roles (plain member). Attribution is limited: the admin secret is a single shared identity; this event records that staff acted on the domain but cannot name the individual.<br> OperationId: `DomainControllerCreateInviteLink`
|
|
21761
|
-
* @summary Create staff-recovery invite link for a domain
|
|
21762
|
-
* @param {string} id
|
|
21763
|
-
* @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
|
|
21764
|
-
* @param {*} [options] Override http request option.
|
|
21765
|
-
* @throws {RequiredError}
|
|
21766
|
-
*/
|
|
21767
|
-
domainControllerCreateInviteLink(id: string, inviteLinkCreateInputDTO?: InviteLinkCreateInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<InviteLinkCreateResultDTOAPI>;
|
|
21768
|
-
/**
|
|
21769
|
-
* <br> OperationId: `DomainControllerGetOne`
|
|
21770
|
-
* @summary Get one
|
|
21771
|
-
* @param {string} id
|
|
21772
|
-
* @param {*} [options] Override http request option.
|
|
21773
|
-
* @throws {RequiredError}
|
|
21774
|
-
*/
|
|
21775
|
-
domainControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<DomainOutputDTOAPI>;
|
|
21776
|
-
/**
|
|
21777
|
-
* <br> OperationId: `DomainControllerGetToken`
|
|
21778
|
-
* @summary Get token
|
|
21779
|
-
* @param {TokenInputDTO} [tokenInputDTO] TokenInputDTO
|
|
21780
|
-
* @param {*} [options] Override http request option.
|
|
21781
|
-
* @throws {RequiredError}
|
|
21782
|
-
*/
|
|
21783
|
-
domainControllerGetToken(tokenInputDTO?: TokenInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<TokenOutputDTOAPI>;
|
|
21784
|
-
/**
|
|
21785
|
-
* <br> OperationId: `DomainControllerRemove`
|
|
21786
|
-
* @summary Remove
|
|
21787
|
-
* @param {string} id
|
|
21788
|
-
* @param {any} [hardDelete]
|
|
21789
|
-
* @param {*} [options] Override http request option.
|
|
21790
|
-
* @throws {RequiredError}
|
|
21791
|
-
*/
|
|
21792
|
-
domainControllerRemove(id: string, hardDelete?: any, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
|
|
21793
|
-
/**
|
|
21794
|
-
* <br> OperationId: `DomainControllerResolveRegistrationToken`
|
|
21795
|
-
* @summary Resolve registration token
|
|
21796
|
-
* @param {ResolveRegistrationTokenInputDTO} [resolveRegistrationTokenInputDTO] ResolveRegistrationTokenInputDTO
|
|
21797
|
-
* @param {*} [options] Override http request option.
|
|
21798
|
-
* @throws {RequiredError}
|
|
21799
|
-
*/
|
|
21800
|
-
domainControllerResolveRegistrationToken(resolveRegistrationTokenInputDTO?: ResolveRegistrationTokenInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<DomainOutputDTOAPI>;
|
|
21801
|
-
/**
|
|
21802
|
-
* <br> OperationId: `DomainControllerSearch`
|
|
21803
|
-
* @summary Search
|
|
21804
|
-
* @param {DomainSearchInputDTO} [domainSearchInputDTO] DomainSearchInputDTO
|
|
21805
|
-
* @param {*} [options] Override http request option.
|
|
21806
|
-
* @throws {RequiredError}
|
|
21807
|
-
*/
|
|
21808
|
-
domainControllerSearch(domainSearchInputDTO?: DomainSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<DomainOutputArrayDTOAPI>;
|
|
21809
|
-
/**
|
|
21810
|
-
* <br> OperationId: `DomainControllerUpdate`
|
|
21811
|
-
* @summary Update
|
|
21812
|
-
* @param {string} id
|
|
21813
|
-
* @param {DomainUpdateInputDTO} [domainUpdateInputDTO] DomainUpdateInputDTO
|
|
21814
|
-
* @param {*} [options] Override http request option.
|
|
21815
|
-
* @throws {RequiredError}
|
|
21816
|
-
*/
|
|
21817
|
-
domainControllerUpdate(id: string, domainUpdateInputDTO?: DomainUpdateInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<DomainOutputDTOAPI>;
|
|
21818
|
-
};
|
|
21819
|
-
/**
|
|
21820
|
-
* DomainApi - object-oriented interface
|
|
21821
|
-
* @export
|
|
21822
|
-
* @class DomainApi
|
|
21823
|
-
* @extends {BaseAPI}
|
|
21824
|
-
*/
|
|
21825
|
-
export declare class DomainApi extends BaseAPI {
|
|
21826
|
-
/**
|
|
21827
|
-
* <br> OperationId: `DomainControllerCreate`
|
|
21828
|
-
* @summary Create
|
|
21829
|
-
* @param {DomainCreateInputDTO} [domainCreateInputDTO] DomainCreateInputDTO
|
|
21830
|
-
* @param {*} [options] Override http request option.
|
|
21831
|
-
* @throws {RequiredError}
|
|
21832
|
-
* @memberof DomainApi
|
|
21833
|
-
*/
|
|
21834
|
-
domainControllerCreate(domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainCreateOutputDTOAPI, any>>;
|
|
21835
|
-
/**
|
|
21836
|
-
* Creates a staff-recovery invite link scoped to the target domain. The `token` and `inviteUrl` fields are returned ONCE and are not stored on the server — distribute securely. Hardened for recovery use: expiry is forced to 24 hours and maxUses is forced to 1, regardless of request body values. roleIds is passed through as-is; omit it to grant no extra roles (plain member). Attribution is limited: the admin secret is a single shared identity; this event records that staff acted on the domain but cannot name the individual.<br> OperationId: `DomainControllerCreateInviteLink`
|
|
21837
|
-
* @summary Create staff-recovery invite link for a domain
|
|
21838
|
-
* @param {string} id
|
|
21839
|
-
* @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
|
|
21840
|
-
* @param {*} [options] Override http request option.
|
|
21841
|
-
* @throws {RequiredError}
|
|
21842
|
-
* @memberof DomainApi
|
|
21843
|
-
*/
|
|
21844
|
-
domainControllerCreateInviteLink(id: string, inviteLinkCreateInputDTO?: InviteLinkCreateInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteLinkCreateResultDTOAPI, any>>;
|
|
21845
|
-
/**
|
|
21846
|
-
* <br> OperationId: `DomainControllerGetOne`
|
|
21847
|
-
* @summary Get one
|
|
21848
|
-
* @param {string} id
|
|
21849
|
-
* @param {*} [options] Override http request option.
|
|
21850
|
-
* @throws {RequiredError}
|
|
21851
|
-
* @memberof DomainApi
|
|
21852
|
-
*/
|
|
21853
|
-
domainControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainOutputDTOAPI, any>>;
|
|
21854
|
-
/**
|
|
21855
|
-
* <br> OperationId: `DomainControllerGetToken`
|
|
21856
|
-
* @summary Get token
|
|
21857
|
-
* @param {TokenInputDTO} [tokenInputDTO] TokenInputDTO
|
|
21858
|
-
* @param {*} [options] Override http request option.
|
|
21859
|
-
* @throws {RequiredError}
|
|
21860
|
-
* @memberof DomainApi
|
|
21861
|
-
*/
|
|
21862
|
-
domainControllerGetToken(tokenInputDTO?: TokenInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TokenOutputDTOAPI, any>>;
|
|
21863
|
-
/**
|
|
21864
|
-
* <br> OperationId: `DomainControllerRemove`
|
|
21865
|
-
* @summary Remove
|
|
21866
|
-
* @param {string} id
|
|
21867
|
-
* @param {any} [hardDelete]
|
|
21868
|
-
* @param {*} [options] Override http request option.
|
|
21869
|
-
* @throws {RequiredError}
|
|
21870
|
-
* @memberof DomainApi
|
|
21871
|
-
*/
|
|
21872
|
-
domainControllerRemove(id: string, hardDelete?: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
|
|
21873
|
-
/**
|
|
21874
|
-
* <br> OperationId: `DomainControllerResolveRegistrationToken`
|
|
21875
|
-
* @summary Resolve registration token
|
|
21876
|
-
* @param {ResolveRegistrationTokenInputDTO} [resolveRegistrationTokenInputDTO] ResolveRegistrationTokenInputDTO
|
|
21877
|
-
* @param {*} [options] Override http request option.
|
|
21878
|
-
* @throws {RequiredError}
|
|
21879
|
-
* @memberof DomainApi
|
|
21880
|
-
*/
|
|
21881
|
-
domainControllerResolveRegistrationToken(resolveRegistrationTokenInputDTO?: ResolveRegistrationTokenInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainOutputDTOAPI, any>>;
|
|
21882
|
-
/**
|
|
21883
|
-
* <br> OperationId: `DomainControllerSearch`
|
|
21884
|
-
* @summary Search
|
|
21885
|
-
* @param {DomainSearchInputDTO} [domainSearchInputDTO] DomainSearchInputDTO
|
|
21886
|
-
* @param {*} [options] Override http request option.
|
|
21887
|
-
* @throws {RequiredError}
|
|
21888
|
-
* @memberof DomainApi
|
|
21889
|
-
*/
|
|
21890
|
-
domainControllerSearch(domainSearchInputDTO?: DomainSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainOutputArrayDTOAPI, any>>;
|
|
21891
|
-
/**
|
|
21892
|
-
* <br> OperationId: `DomainControllerUpdate`
|
|
21893
|
-
* @summary Update
|
|
21894
|
-
* @param {string} id
|
|
21895
|
-
* @param {DomainUpdateInputDTO} [domainUpdateInputDTO] DomainUpdateInputDTO
|
|
21896
|
-
* @param {*} [options] Override http request option.
|
|
21897
|
-
* @throws {RequiredError}
|
|
21898
|
-
* @memberof DomainApi
|
|
21899
|
-
*/
|
|
21900
|
-
domainControllerUpdate(id: string, domainUpdateInputDTO?: DomainUpdateInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainOutputDTOAPI, any>>;
|
|
21901
|
-
}
|
|
21902
22822
|
/**
|
|
21903
22823
|
* EntityApi - axios parameter creator
|
|
21904
22824
|
* @export
|
|
@@ -22537,7 +23457,7 @@ export declare class FunctionApi extends BaseAPI {
|
|
|
22537
23457
|
*/
|
|
22538
23458
|
export declare const GameServerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22539
23459
|
/**
|
|
22540
|
-
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
23460
|
+
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.create`, which records the ban in Takaro and applies it to the game server. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
22541
23461
|
* @summary Ban player
|
|
22542
23462
|
* @param {string} gameServerId
|
|
22543
23463
|
* @param {string} playerId
|
|
@@ -22565,7 +23485,7 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
22565
23485
|
*/
|
|
22566
23486
|
gameServerControllerExecuteCommand: (id: string, commandExecuteInputDTO?: CommandExecuteInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22567
23487
|
/**
|
|
22568
|
-
* Fetch status of an import from CSMM Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
23488
|
+
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
22569
23489
|
* @summary Get import
|
|
22570
23490
|
* @param {string} id
|
|
22571
23491
|
* @param {*} [options] Override http request option.
|
|
@@ -22653,7 +23573,7 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
22653
23573
|
*/
|
|
22654
23574
|
gameServerControllerKickPlayer: (gameServerId: string, playerId: string, kickPlayerInputDTO?: KickPlayerInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22655
23575
|
/**
|
|
22656
|
-
* List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
23576
|
+
* List bans for a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.search` filtered by `gameServerId` instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
22657
23577
|
* @summary List bans
|
|
22658
23578
|
* @param {string} id
|
|
22659
23579
|
* @param {*} [options] Override http request option.
|
|
@@ -22745,7 +23665,7 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
22745
23665
|
*/
|
|
22746
23666
|
gameServerControllerTriggerJob: (type: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22747
23667
|
/**
|
|
22748
|
-
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
23668
|
+
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.delete` on the ban record instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
22749
23669
|
* @summary Unban player
|
|
22750
23670
|
* @param {string} gameServerId
|
|
22751
23671
|
* @param {string} playerId
|
|
@@ -22770,7 +23690,7 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
22770
23690
|
*/
|
|
22771
23691
|
export declare const GameServerApiFp: (configuration?: Configuration) => {
|
|
22772
23692
|
/**
|
|
22773
|
-
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
23693
|
+
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.create`, which records the ban in Takaro and applies it to the game server. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
22774
23694
|
* @summary Ban player
|
|
22775
23695
|
* @param {string} gameServerId
|
|
22776
23696
|
* @param {string} playerId
|
|
@@ -22798,7 +23718,7 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
|
|
|
22798
23718
|
*/
|
|
22799
23719
|
gameServerControllerExecuteCommand(id: string, commandExecuteInputDTO?: CommandExecuteInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommandExecuteDTOAPI>>;
|
|
22800
23720
|
/**
|
|
22801
|
-
* Fetch status of an import from CSMM Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
23721
|
+
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
22802
23722
|
* @summary Get import
|
|
22803
23723
|
* @param {string} id
|
|
22804
23724
|
* @param {*} [options] Override http request option.
|
|
@@ -22886,7 +23806,7 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
|
|
|
22886
23806
|
*/
|
|
22887
23807
|
gameServerControllerKickPlayer(gameServerId: string, playerId: string, kickPlayerInputDTO?: KickPlayerInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
|
|
22888
23808
|
/**
|
|
22889
|
-
* List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
23809
|
+
* List bans for a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.search` filtered by `gameServerId` instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
22890
23810
|
* @summary List bans
|
|
22891
23811
|
* @param {string} id
|
|
22892
23812
|
* @param {*} [options] Override http request option.
|
|
@@ -22978,7 +23898,7 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
|
|
|
22978
23898
|
*/
|
|
22979
23899
|
gameServerControllerTriggerJob(type: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobStatusOutputDTOAPI>>;
|
|
22980
23900
|
/**
|
|
22981
|
-
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
23901
|
+
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.delete` on the ban record instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
22982
23902
|
* @summary Unban player
|
|
22983
23903
|
* @param {string} gameServerId
|
|
22984
23904
|
* @param {string} playerId
|
|
@@ -23003,7 +23923,7 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
|
|
|
23003
23923
|
*/
|
|
23004
23924
|
export declare const GameServerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23005
23925
|
/**
|
|
23006
|
-
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
23926
|
+
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.create`, which records the ban in Takaro and applies it to the game server. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
23007
23927
|
* @summary Ban player
|
|
23008
23928
|
* @param {string} gameServerId
|
|
23009
23929
|
* @param {string} playerId
|
|
@@ -23031,7 +23951,7 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
|
|
|
23031
23951
|
*/
|
|
23032
23952
|
gameServerControllerExecuteCommand(id: string, commandExecuteInputDTO?: CommandExecuteInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<CommandExecuteDTOAPI>;
|
|
23033
23953
|
/**
|
|
23034
|
-
* Fetch status of an import from CSMM Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
23954
|
+
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
23035
23955
|
* @summary Get import
|
|
23036
23956
|
* @param {string} id
|
|
23037
23957
|
* @param {*} [options] Override http request option.
|
|
@@ -23119,7 +24039,7 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
|
|
|
23119
24039
|
*/
|
|
23120
24040
|
gameServerControllerKickPlayer(gameServerId: string, playerId: string, kickPlayerInputDTO?: KickPlayerInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
|
|
23121
24041
|
/**
|
|
23122
|
-
* List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
24042
|
+
* List bans for a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.search` filtered by `gameServerId` instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
23123
24043
|
* @summary List bans
|
|
23124
24044
|
* @param {string} id
|
|
23125
24045
|
* @param {*} [options] Override http request option.
|
|
@@ -23211,7 +24131,7 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
|
|
|
23211
24131
|
*/
|
|
23212
24132
|
gameServerControllerTriggerJob(type: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<JobStatusOutputDTOAPI>;
|
|
23213
24133
|
/**
|
|
23214
|
-
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
24134
|
+
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.delete` on the ban record instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
23215
24135
|
* @summary Unban player
|
|
23216
24136
|
* @param {string} gameServerId
|
|
23217
24137
|
* @param {string} playerId
|
|
@@ -23238,7 +24158,7 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
|
|
|
23238
24158
|
*/
|
|
23239
24159
|
export declare class GameServerApi extends BaseAPI {
|
|
23240
24160
|
/**
|
|
23241
|
-
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
24161
|
+
* Ban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.create`, which records the ban in Takaro and applies it to the game server. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerBanPlayer`
|
|
23242
24162
|
* @summary Ban player
|
|
23243
24163
|
* @param {string} gameServerId
|
|
23244
24164
|
* @param {string} playerId
|
|
@@ -23269,7 +24189,7 @@ export declare class GameServerApi extends BaseAPI {
|
|
|
23269
24189
|
*/
|
|
23270
24190
|
gameServerControllerExecuteCommand(id: string, commandExecuteInputDTO?: CommandExecuteInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommandExecuteDTOAPI, any>>;
|
|
23271
24191
|
/**
|
|
23272
|
-
* Fetch status of an import from CSMM Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
24192
|
+
* Fetch status of an import from CSMM. Deprecated: use `GameServerController.getJob` with the import job type instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerGetImport`
|
|
23273
24193
|
* @summary Get import
|
|
23274
24194
|
* @param {string} id
|
|
23275
24195
|
* @param {*} [options] Override http request option.
|
|
@@ -23367,7 +24287,7 @@ export declare class GameServerApi extends BaseAPI {
|
|
|
23367
24287
|
*/
|
|
23368
24288
|
gameServerControllerKickPlayer(gameServerId: string, playerId: string, kickPlayerInputDTO?: KickPlayerInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
|
|
23369
24289
|
/**
|
|
23370
|
-
* List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
24290
|
+
* List bans for a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.search` filtered by `gameServerId` instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerListBans`
|
|
23371
24291
|
* @summary List bans
|
|
23372
24292
|
* @param {string} id
|
|
23373
24293
|
* @param {*} [options] Override http request option.
|
|
@@ -23470,7 +24390,7 @@ export declare class GameServerApi extends BaseAPI {
|
|
|
23470
24390
|
*/
|
|
23471
24391
|
gameServerControllerTriggerJob(type: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobStatusOutputDTOAPI, any>>;
|
|
23472
24392
|
/**
|
|
23473
|
-
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
24393
|
+
* Unban a player from a gameserver. Requires gameserver to be online and reachable. Deprecated: use `BanController.delete` on the ban record instead. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `GameServerControllerUnbanPlayer`
|
|
23474
24394
|
* @summary Unban player
|
|
23475
24395
|
* @param {string} gameServerId
|
|
23476
24396
|
* @param {string} playerId
|
|
@@ -24782,16 +25702,16 @@ export declare class ModuleApi extends BaseAPI {
|
|
|
24782
25702
|
*/
|
|
24783
25703
|
export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24784
25704
|
/**
|
|
24785
|
-
*
|
|
24786
|
-
* @summary Ban player
|
|
25705
|
+
* Ban a player from one game server, or from every game server in the domain with `isGlobal`. Creating a ban via the API always makes it Takaro managed. Replaces the deprecated `GameServerController.banPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerCreate`
|
|
25706
|
+
* @summary Ban a player from a game server
|
|
24787
25707
|
* @param {BanCreateDTO} [banCreateDTO] BanCreateDTO
|
|
24788
25708
|
* @param {*} [options] Override http request option.
|
|
24789
25709
|
* @throws {RequiredError}
|
|
24790
25710
|
*/
|
|
24791
25711
|
banControllerCreate: (banCreateDTO?: BanCreateDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24792
25712
|
/**
|
|
24793
|
-
* Unban player
|
|
24794
|
-
* @summary Unban player
|
|
25713
|
+
* Unban a player: removes the ban from Takaro and from the game server(s) it applied to. Replaces the deprecated `GameServerController.unbanPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerDelete`
|
|
25714
|
+
* @summary Unban a player
|
|
24795
25715
|
* @param {string} id
|
|
24796
25716
|
* @param {*} [options] Override http request option.
|
|
24797
25717
|
* @throws {RequiredError}
|
|
@@ -24806,8 +25726,8 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
24806
25726
|
*/
|
|
24807
25727
|
banControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24808
25728
|
/**
|
|
24809
|
-
* Search
|
|
24810
|
-
* @summary
|
|
25729
|
+
* Search and list bans, filterable by game server, player, and whether the ban is global. Replaces the deprecated `GameServerController.listBans`. Required permissions: `READ_PLAYERS`<br> OperationId: `BanControllerSearch`
|
|
25730
|
+
* @summary List bans on a game server
|
|
24811
25731
|
* @param {BanSearchInputDTO} [banSearchInputDTO] BanSearchInputDTO
|
|
24812
25732
|
* @param {*} [options] Override http request option.
|
|
24813
25733
|
* @throws {RequiredError}
|
|
@@ -24897,16 +25817,16 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
24897
25817
|
*/
|
|
24898
25818
|
export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
24899
25819
|
/**
|
|
24900
|
-
*
|
|
24901
|
-
* @summary Ban player
|
|
25820
|
+
* Ban a player from one game server, or from every game server in the domain with `isGlobal`. Creating a ban via the API always makes it Takaro managed. Replaces the deprecated `GameServerController.banPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerCreate`
|
|
25821
|
+
* @summary Ban a player from a game server
|
|
24902
25822
|
* @param {BanCreateDTO} [banCreateDTO] BanCreateDTO
|
|
24903
25823
|
* @param {*} [options] Override http request option.
|
|
24904
25824
|
* @throws {RequiredError}
|
|
24905
25825
|
*/
|
|
24906
25826
|
banControllerCreate(banCreateDTO?: BanCreateDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>>;
|
|
24907
25827
|
/**
|
|
24908
|
-
* Unban player
|
|
24909
|
-
* @summary Unban player
|
|
25828
|
+
* Unban a player: removes the ban from Takaro and from the game server(s) it applied to. Replaces the deprecated `GameServerController.unbanPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerDelete`
|
|
25829
|
+
* @summary Unban a player
|
|
24910
25830
|
* @param {string} id
|
|
24911
25831
|
* @param {*} [options] Override http request option.
|
|
24912
25832
|
* @throws {RequiredError}
|
|
@@ -24921,8 +25841,8 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
|
24921
25841
|
*/
|
|
24922
25842
|
banControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>>;
|
|
24923
25843
|
/**
|
|
24924
|
-
* Search
|
|
24925
|
-
* @summary
|
|
25844
|
+
* Search and list bans, filterable by game server, player, and whether the ban is global. Replaces the deprecated `GameServerController.listBans`. Required permissions: `READ_PLAYERS`<br> OperationId: `BanControllerSearch`
|
|
25845
|
+
* @summary List bans on a game server
|
|
24926
25846
|
* @param {BanSearchInputDTO} [banSearchInputDTO] BanSearchInputDTO
|
|
24927
25847
|
* @param {*} [options] Override http request option.
|
|
24928
25848
|
* @throws {RequiredError}
|
|
@@ -25012,16 +25932,16 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
|
|
|
25012
25932
|
*/
|
|
25013
25933
|
export declare const PlayerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
25014
25934
|
/**
|
|
25015
|
-
*
|
|
25016
|
-
* @summary Ban player
|
|
25935
|
+
* Ban a player from one game server, or from every game server in the domain with `isGlobal`. Creating a ban via the API always makes it Takaro managed. Replaces the deprecated `GameServerController.banPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerCreate`
|
|
25936
|
+
* @summary Ban a player from a game server
|
|
25017
25937
|
* @param {BanCreateDTO} [banCreateDTO] BanCreateDTO
|
|
25018
25938
|
* @param {*} [options] Override http request option.
|
|
25019
25939
|
* @throws {RequiredError}
|
|
25020
25940
|
*/
|
|
25021
25941
|
banControllerCreate(banCreateDTO?: BanCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputDTOAPI>;
|
|
25022
25942
|
/**
|
|
25023
|
-
* Unban player
|
|
25024
|
-
* @summary Unban player
|
|
25943
|
+
* Unban a player: removes the ban from Takaro and from the game server(s) it applied to. Replaces the deprecated `GameServerController.unbanPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerDelete`
|
|
25944
|
+
* @summary Unban a player
|
|
25025
25945
|
* @param {string} id
|
|
25026
25946
|
* @param {*} [options] Override http request option.
|
|
25027
25947
|
* @throws {RequiredError}
|
|
@@ -25036,8 +25956,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
|
|
|
25036
25956
|
*/
|
|
25037
25957
|
banControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputDTOAPI>;
|
|
25038
25958
|
/**
|
|
25039
|
-
* Search
|
|
25040
|
-
* @summary
|
|
25959
|
+
* Search and list bans, filterable by game server, player, and whether the ban is global. Replaces the deprecated `GameServerController.listBans`. Required permissions: `READ_PLAYERS`<br> OperationId: `BanControllerSearch`
|
|
25960
|
+
* @summary List bans on a game server
|
|
25041
25961
|
* @param {BanSearchInputDTO} [banSearchInputDTO] BanSearchInputDTO
|
|
25042
25962
|
* @param {*} [options] Override http request option.
|
|
25043
25963
|
* @throws {RequiredError}
|
|
@@ -25129,8 +26049,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
|
|
|
25129
26049
|
*/
|
|
25130
26050
|
export declare class PlayerApi extends BaseAPI {
|
|
25131
26051
|
/**
|
|
25132
|
-
*
|
|
25133
|
-
* @summary Ban player
|
|
26052
|
+
* Ban a player from one game server, or from every game server in the domain with `isGlobal`. Creating a ban via the API always makes it Takaro managed. Replaces the deprecated `GameServerController.banPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerCreate`
|
|
26053
|
+
* @summary Ban a player from a game server
|
|
25134
26054
|
* @param {BanCreateDTO} [banCreateDTO] BanCreateDTO
|
|
25135
26055
|
* @param {*} [options] Override http request option.
|
|
25136
26056
|
* @throws {RequiredError}
|
|
@@ -25138,8 +26058,8 @@ export declare class PlayerApi extends BaseAPI {
|
|
|
25138
26058
|
*/
|
|
25139
26059
|
banControllerCreate(banCreateDTO?: BanCreateDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BanOutputDTOAPI, any>>;
|
|
25140
26060
|
/**
|
|
25141
|
-
* Unban player
|
|
25142
|
-
* @summary Unban player
|
|
26061
|
+
* Unban a player: removes the ban from Takaro and from the game server(s) it applied to. Replaces the deprecated `GameServerController.unbanPlayer`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `BanControllerDelete`
|
|
26062
|
+
* @summary Unban a player
|
|
25143
26063
|
* @param {string} id
|
|
25144
26064
|
* @param {*} [options] Override http request option.
|
|
25145
26065
|
* @throws {RequiredError}
|
|
@@ -25156,8 +26076,8 @@ export declare class PlayerApi extends BaseAPI {
|
|
|
25156
26076
|
*/
|
|
25157
26077
|
banControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BanOutputDTOAPI, any>>;
|
|
25158
26078
|
/**
|
|
25159
|
-
* Search
|
|
25160
|
-
* @summary
|
|
26079
|
+
* Search and list bans, filterable by game server, player, and whether the ban is global. Replaces the deprecated `GameServerController.listBans`. Required permissions: `READ_PLAYERS`<br> OperationId: `BanControllerSearch`
|
|
26080
|
+
* @summary List bans on a game server
|
|
25161
26081
|
* @param {BanSearchInputDTO} [banSearchInputDTO] BanSearchInputDTO
|
|
25162
26082
|
* @param {*} [options] Override http request option.
|
|
25163
26083
|
* @throws {RequiredError}
|
|
@@ -27650,7 +28570,7 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
27650
28570
|
*/
|
|
27651
28571
|
userControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27652
28572
|
/**
|
|
27653
|
-
*
|
|
28573
|
+
* Invite a user by email. Deprecated: use `InviteLinkController.create` and share the link instead. Required permissions: `MANAGE_USERS`<br> OperationId: `UserControllerInvite`
|
|
27654
28574
|
* @summary Invite
|
|
27655
28575
|
* @param {InviteCreateDTO} [inviteCreateDTO] InviteCreateDTO
|
|
27656
28576
|
* @param {*} [options] Override http request option.
|
|
@@ -27667,8 +28587,8 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
27667
28587
|
*/
|
|
27668
28588
|
userControllerLinkPlayerProfile: (linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27669
28589
|
/**
|
|
27670
|
-
*
|
|
27671
|
-
* @summary
|
|
28590
|
+
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
28591
|
+
* @summary Log in with a username and password
|
|
27672
28592
|
* @param {LoginDTO} [loginDTO] LoginDTO
|
|
27673
28593
|
* @param {*} [options] Override http request option.
|
|
27674
28594
|
* @throws {RequiredError}
|
|
@@ -27777,7 +28697,7 @@ export declare const UserApiFp: (configuration?: Configuration) => {
|
|
|
27777
28697
|
*/
|
|
27778
28698
|
userControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>>;
|
|
27779
28699
|
/**
|
|
27780
|
-
*
|
|
28700
|
+
* Invite a user by email. Deprecated: use `InviteLinkController.create` and share the link instead. Required permissions: `MANAGE_USERS`<br> OperationId: `UserControllerInvite`
|
|
27781
28701
|
* @summary Invite
|
|
27782
28702
|
* @param {InviteCreateDTO} [inviteCreateDTO] InviteCreateDTO
|
|
27783
28703
|
* @param {*} [options] Override http request option.
|
|
@@ -27794,8 +28714,8 @@ export declare const UserApiFp: (configuration?: Configuration) => {
|
|
|
27794
28714
|
*/
|
|
27795
28715
|
userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
27796
28716
|
/**
|
|
27797
|
-
*
|
|
27798
|
-
* @summary
|
|
28717
|
+
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
28718
|
+
* @summary Log in with a username and password
|
|
27799
28719
|
* @param {LoginDTO} [loginDTO] LoginDTO
|
|
27800
28720
|
* @param {*} [options] Override http request option.
|
|
27801
28721
|
* @throws {RequiredError}
|
|
@@ -27904,7 +28824,7 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
|
|
|
27904
28824
|
*/
|
|
27905
28825
|
userControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<UserOutputDTOAPI>;
|
|
27906
28826
|
/**
|
|
27907
|
-
*
|
|
28827
|
+
* Invite a user by email. Deprecated: use `InviteLinkController.create` and share the link instead. Required permissions: `MANAGE_USERS`<br> OperationId: `UserControllerInvite`
|
|
27908
28828
|
* @summary Invite
|
|
27909
28829
|
* @param {InviteCreateDTO} [inviteCreateDTO] InviteCreateDTO
|
|
27910
28830
|
* @param {*} [options] Override http request option.
|
|
@@ -27921,8 +28841,8 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
|
|
|
27921
28841
|
*/
|
|
27922
28842
|
userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
27923
28843
|
/**
|
|
27924
|
-
*
|
|
27925
|
-
* @summary
|
|
28844
|
+
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
28845
|
+
* @summary Log in with a username and password
|
|
27926
28846
|
* @param {LoginDTO} [loginDTO] LoginDTO
|
|
27927
28847
|
* @param {*} [options] Override http request option.
|
|
27928
28848
|
* @throws {RequiredError}
|
|
@@ -28038,7 +28958,7 @@ export declare class UserApi extends BaseAPI {
|
|
|
28038
28958
|
*/
|
|
28039
28959
|
userControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserOutputDTOAPI, any>>;
|
|
28040
28960
|
/**
|
|
28041
|
-
*
|
|
28961
|
+
* Invite a user by email. Deprecated: use `InviteLinkController.create` and share the link instead. Required permissions: `MANAGE_USERS`<br> OperationId: `UserControllerInvite`
|
|
28042
28962
|
* @summary Invite
|
|
28043
28963
|
* @param {InviteCreateDTO} [inviteCreateDTO] InviteCreateDTO
|
|
28044
28964
|
* @param {*} [options] Override http request option.
|
|
@@ -28057,8 +28977,8 @@ export declare class UserApi extends BaseAPI {
|
|
|
28057
28977
|
*/
|
|
28058
28978
|
userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
28059
28979
|
/**
|
|
28060
|
-
*
|
|
28061
|
-
* @summary
|
|
28980
|
+
* Exchanges a username and password for a token through Keycloak\'s resource-owner password grant. This route exists for the hosted browser login page and nothing else. Scripts, bots, CI and integrations authenticate with an API Key sent as `Authorization: Bearer takaro_...` (create one with `POST /apikey`) — see docs/api/authentication.md. The route is not being removed and existing callers keep working.<br> OperationId: `UserControllerLogin`
|
|
28981
|
+
* @summary Log in with a username and password
|
|
28062
28982
|
* @param {LoginDTO} [loginDTO] LoginDTO
|
|
28063
28983
|
* @param {*} [options] Override http request option.
|
|
28064
28984
|
* @throws {RequiredError}
|