@takaro/apiclient 0.0.0-dev.fdd3e46 → 0.0.0-dev.fe2b054

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.
@@ -746,6 +746,88 @@ export interface BoundingBoxSearchInputDTO {
746
746
  */
747
747
  gameserverId: string;
748
748
  }
749
+ /**
750
+ *
751
+ * @export
752
+ * @interface BulkActionFailureDTO
753
+ */
754
+ export interface BulkActionFailureDTO {
755
+ /**
756
+ *
757
+ * @type {string}
758
+ * @memberof BulkActionFailureDTO
759
+ */
760
+ id: string;
761
+ /**
762
+ *
763
+ * @type {string}
764
+ * @memberof BulkActionFailureDTO
765
+ */
766
+ name: string;
767
+ /**
768
+ *
769
+ * @type {string}
770
+ * @memberof BulkActionFailureDTO
771
+ */
772
+ reason: string;
773
+ }
774
+ /**
775
+ *
776
+ * @export
777
+ * @interface BulkActionResultDTO
778
+ */
779
+ export interface BulkActionResultDTO {
780
+ /**
781
+ *
782
+ * @type {number}
783
+ * @memberof BulkActionResultDTO
784
+ */
785
+ succeeded: number;
786
+ /**
787
+ *
788
+ * @type {Array<BulkActionFailureDTO>}
789
+ * @memberof BulkActionResultDTO
790
+ */
791
+ failed: Array<BulkActionFailureDTO>;
792
+ }
793
+ /**
794
+ *
795
+ * @export
796
+ * @interface BulkActionResultDTOAPI
797
+ */
798
+ export interface BulkActionResultDTOAPI {
799
+ /**
800
+ *
801
+ * @type {BulkActionResultDTO}
802
+ * @memberof BulkActionResultDTOAPI
803
+ */
804
+ data: BulkActionResultDTO;
805
+ /**
806
+ *
807
+ * @type {MetadataOutput}
808
+ * @memberof BulkActionResultDTOAPI
809
+ */
810
+ meta: MetadataOutput;
811
+ }
812
+ /**
813
+ *
814
+ * @export
815
+ * @interface BulkTargetDTO
816
+ */
817
+ export interface BulkTargetDTO {
818
+ /**
819
+ *
820
+ * @type {Array<string>}
821
+ * @memberof BulkTargetDTO
822
+ */
823
+ ids?: Array<string>;
824
+ /**
825
+ *
826
+ * @type {Array<string>}
827
+ * @memberof BulkTargetDTO
828
+ */
829
+ excludedIds?: Array<string>;
830
+ }
749
831
  /**
750
832
  *
751
833
  * @export
@@ -2232,16 +2314,16 @@ export interface DomainCreateInputDTO {
2232
2314
  maxDiscordLinkedRoles?: number;
2233
2315
  /**
2234
2316
  *
2235
- * @type {string}
2317
+ * @type {boolean}
2236
2318
  * @memberof DomainCreateInputDTO
2237
2319
  */
2238
- serverRegistrationToken?: string;
2320
+ skipBuiltinSeeding?: boolean;
2239
2321
  /**
2240
2322
  *
2241
- * @type {boolean}
2323
+ * @type {string}
2242
2324
  * @memberof DomainCreateInputDTO
2243
2325
  */
2244
- skipBuiltinSeeding?: boolean;
2326
+ serverRegistrationToken?: string;
2245
2327
  }
2246
2328
  export declare const DomainCreateInputDTOStateEnum: {
2247
2329
  readonly Active: "ACTIVE";
@@ -3071,19 +3153,19 @@ export interface ErrorOutput {
3071
3153
  * @type {string}
3072
3154
  * @memberof ErrorOutput
3073
3155
  */
3074
- code: string;
3156
+ code?: string;
3075
3157
  /**
3076
3158
  *
3077
3159
  * @type {string}
3078
3160
  * @memberof ErrorOutput
3079
3161
  */
3080
- message: string;
3162
+ message?: string;
3081
3163
  /**
3082
3164
  *
3083
3165
  * @type {string}
3084
3166
  * @memberof ErrorOutput
3085
3167
  */
3086
- details: string;
3168
+ details?: string;
3087
3169
  }
3088
3170
  /**
3089
3171
  *
@@ -3096,7 +3178,7 @@ export interface EventChatMessage {
3096
3178
  * @type {IGamePlayer}
3097
3179
  * @memberof EventChatMessage
3098
3180
  */
3099
- player: IGamePlayer;
3181
+ player?: IGamePlayer;
3100
3182
  /**
3101
3183
  *
3102
3184
  * @type {string}
@@ -8055,7 +8137,7 @@ export interface MetadataOutput {
8055
8137
  * @type {ErrorOutput}
8056
8138
  * @memberof MetadataOutput
8057
8139
  */
8058
- error: ErrorOutput;
8140
+ error?: ErrorOutput;
8059
8141
  /**
8060
8142
  *
8061
8143
  * @type {number}
@@ -10147,7 +10229,13 @@ export interface PlayerBulkAssignRoleInputDTO {
10147
10229
  * @type {Array<string>}
10148
10230
  * @memberof PlayerBulkAssignRoleInputDTO
10149
10231
  */
10150
- playerIds: Array<string>;
10232
+ playerIds?: Array<string>;
10233
+ /**
10234
+ *
10235
+ * @type {PlayerSearchInputDTO}
10236
+ * @memberof PlayerBulkAssignRoleInputDTO
10237
+ */
10238
+ query?: PlayerSearchInputDTO;
10151
10239
  /**
10152
10240
  *
10153
10241
  * @type {string}
@@ -10160,6 +10248,18 @@ export interface PlayerBulkAssignRoleInputDTO {
10160
10248
  * @memberof PlayerBulkAssignRoleInputDTO
10161
10249
  */
10162
10250
  expiresAt?: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
10251
+ /**
10252
+ *
10253
+ * @type {Array<string>}
10254
+ * @memberof PlayerBulkAssignRoleInputDTO
10255
+ */
10256
+ ids?: Array<string>;
10257
+ /**
10258
+ *
10259
+ * @type {Array<string>}
10260
+ * @memberof PlayerBulkAssignRoleInputDTO
10261
+ */
10262
+ excludedIds?: Array<string>;
10163
10263
  }
10164
10264
  /**
10165
10265
  *
@@ -10235,7 +10335,25 @@ export interface PlayerBulkDeleteInputDTO {
10235
10335
  * @type {Array<string>}
10236
10336
  * @memberof PlayerBulkDeleteInputDTO
10237
10337
  */
10238
- playerIds: Array<string>;
10338
+ playerIds?: Array<string>;
10339
+ /**
10340
+ *
10341
+ * @type {PlayerSearchInputDTO}
10342
+ * @memberof PlayerBulkDeleteInputDTO
10343
+ */
10344
+ query?: PlayerSearchInputDTO;
10345
+ /**
10346
+ *
10347
+ * @type {Array<string>}
10348
+ * @memberof PlayerBulkDeleteInputDTO
10349
+ */
10350
+ ids?: Array<string>;
10351
+ /**
10352
+ *
10353
+ * @type {Array<string>}
10354
+ * @memberof PlayerBulkDeleteInputDTO
10355
+ */
10356
+ excludedIds?: Array<string>;
10239
10357
  }
10240
10358
  /**
10241
10359
  *
@@ -10807,6 +10925,12 @@ export interface PlayerOnGameServerSearchInputAllowedRangeFilter {
10807
10925
  * @memberof PlayerOnGameServerSearchInputAllowedRangeFilter
10808
10926
  */
10809
10927
  playtimeSeconds?: number;
10928
+ /**
10929
+ *
10930
+ * @type {number}
10931
+ * @memberof PlayerOnGameServerSearchInputAllowedRangeFilter
10932
+ */
10933
+ currency?: number;
10810
10934
  /**
10811
10935
  *
10812
10936
  * @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
@@ -11728,6 +11852,24 @@ export interface PlayerSearchInputAllowedFilters {
11728
11852
  * @memberof PlayerSearchInputAllowedFilters
11729
11853
  */
11730
11854
  roleId?: Array<string>;
11855
+ /**
11856
+ *
11857
+ * @type {Array<boolean>}
11858
+ * @memberof PlayerSearchInputAllowedFilters
11859
+ */
11860
+ online?: Array<boolean>;
11861
+ /**
11862
+ *
11863
+ * @type {Array<string>}
11864
+ * @memberof PlayerSearchInputAllowedFilters
11865
+ */
11866
+ roleAssignmentScope?: Array<PlayerSearchInputAllowedFiltersRoleAssignmentScopeEnum>;
11867
+ /**
11868
+ *
11869
+ * @type {Array<string>}
11870
+ * @memberof PlayerSearchInputAllowedFilters
11871
+ */
11872
+ roleAssignmentGameServerId?: Array<string>;
11731
11873
  /**
11732
11874
  *
11733
11875
  * @type {Array<string>}
@@ -11735,6 +11877,11 @@ export interface PlayerSearchInputAllowedFilters {
11735
11877
  */
11736
11878
  id?: Array<string>;
11737
11879
  }
11880
+ export declare const PlayerSearchInputAllowedFiltersRoleAssignmentScopeEnum: {
11881
+ readonly Global: "global";
11882
+ readonly GameServer: "gameServer";
11883
+ };
11884
+ export type PlayerSearchInputAllowedFiltersRoleAssignmentScopeEnum = (typeof PlayerSearchInputAllowedFiltersRoleAssignmentScopeEnum)[keyof typeof PlayerSearchInputAllowedFiltersRoleAssignmentScopeEnum];
11738
11885
  /**
11739
11886
  *
11740
11887
  * @export
@@ -11980,13 +12127,31 @@ export interface PogBulkAddCurrencyInputDTO {
11980
12127
  * @type {Array<string>}
11981
12128
  * @memberof PogBulkAddCurrencyInputDTO
11982
12129
  */
11983
- playerIds: Array<string>;
12130
+ playerIds?: Array<string>;
12131
+ /**
12132
+ *
12133
+ * @type {PlayerOnGameServerSearchInputDTO}
12134
+ * @memberof PogBulkAddCurrencyInputDTO
12135
+ */
12136
+ query?: PlayerOnGameServerSearchInputDTO;
11984
12137
  /**
11985
12138
  *
11986
12139
  * @type {number}
11987
12140
  * @memberof PogBulkAddCurrencyInputDTO
11988
12141
  */
11989
12142
  amount: number;
12143
+ /**
12144
+ *
12145
+ * @type {Array<string>}
12146
+ * @memberof PogBulkAddCurrencyInputDTO
12147
+ */
12148
+ ids?: Array<string>;
12149
+ /**
12150
+ *
12151
+ * @type {Array<string>}
12152
+ * @memberof PogBulkAddCurrencyInputDTO
12153
+ */
12154
+ excludedIds?: Array<string>;
11990
12155
  }
11991
12156
  /**
11992
12157
  *
@@ -12305,7 +12470,7 @@ export interface RedirectQs {
12305
12470
  * @type {string}
12306
12471
  * @memberof RedirectQs
12307
12472
  */
12308
- redirect: string;
12473
+ redirect?: string;
12309
12474
  }
12310
12475
  /**
12311
12476
  *
@@ -13833,7 +13998,13 @@ export interface ShopCategoryBulkAssignDTO {
13833
13998
  * @type {Array<string>}
13834
13999
  * @memberof ShopCategoryBulkAssignDTO
13835
14000
  */
13836
- listingIds: Array<string>;
14001
+ listingIds?: Array<string>;
14002
+ /**
14003
+ *
14004
+ * @type {ShopListingSearchInputDTO}
14005
+ * @memberof ShopCategoryBulkAssignDTO
14006
+ */
14007
+ query?: ShopListingSearchInputDTO;
13837
14008
  /**
13838
14009
  *
13839
14010
  * @type {Array<string>}
@@ -13846,6 +14017,18 @@ export interface ShopCategoryBulkAssignDTO {
13846
14017
  * @memberof ShopCategoryBulkAssignDTO
13847
14018
  */
13848
14019
  removeCategoryIds?: Array<string>;
14020
+ /**
14021
+ *
14022
+ * @type {Array<string>}
14023
+ * @memberof ShopCategoryBulkAssignDTO
14024
+ */
14025
+ ids?: Array<string>;
14026
+ /**
14027
+ *
14028
+ * @type {Array<string>}
14029
+ * @memberof ShopCategoryBulkAssignDTO
14030
+ */
14031
+ excludedIds?: Array<string>;
13849
14032
  }
13850
14033
  /**
13851
14034
  *
@@ -14456,6 +14639,56 @@ export interface ShopKpisDTOAPI {
14456
14639
  */
14457
14640
  meta: MetadataOutput;
14458
14641
  }
14642
+ /**
14643
+ *
14644
+ * @export
14645
+ * @interface ShopListingBulkInputDTO
14646
+ */
14647
+ export interface ShopListingBulkInputDTO {
14648
+ /**
14649
+ *
14650
+ * @type {ShopListingBulkTargetDTO}
14651
+ * @memberof ShopListingBulkInputDTO
14652
+ */
14653
+ target: ShopListingBulkTargetDTO;
14654
+ /**
14655
+ *
14656
+ * @type {string}
14657
+ * @memberof ShopListingBulkInputDTO
14658
+ */
14659
+ action: ShopListingBulkInputDTOActionEnum;
14660
+ }
14661
+ export declare const ShopListingBulkInputDTOActionEnum: {
14662
+ readonly Delete: "delete";
14663
+ readonly Publish: "publish";
14664
+ readonly Unpublish: "unpublish";
14665
+ };
14666
+ export type ShopListingBulkInputDTOActionEnum = (typeof ShopListingBulkInputDTOActionEnum)[keyof typeof ShopListingBulkInputDTOActionEnum];
14667
+ /**
14668
+ *
14669
+ * @export
14670
+ * @interface ShopListingBulkTargetDTO
14671
+ */
14672
+ export interface ShopListingBulkTargetDTO {
14673
+ /**
14674
+ *
14675
+ * @type {ShopListingSearchInputDTO}
14676
+ * @memberof ShopListingBulkTargetDTO
14677
+ */
14678
+ query?: ShopListingSearchInputDTO;
14679
+ /**
14680
+ *
14681
+ * @type {Array<string>}
14682
+ * @memberof ShopListingBulkTargetDTO
14683
+ */
14684
+ ids?: Array<string>;
14685
+ /**
14686
+ *
14687
+ * @type {Array<string>}
14688
+ * @memberof ShopListingBulkTargetDTO
14689
+ */
14690
+ excludedIds?: Array<string>;
14691
+ }
14459
14692
  /**
14460
14693
  *
14461
14694
  * @export
@@ -14504,6 +14737,12 @@ export interface ShopListingCreateDTO {
14504
14737
  * @memberof ShopListingCreateDTO
14505
14738
  */
14506
14739
  categoryIds?: Array<string>;
14740
+ /**
14741
+ *
14742
+ * @type {Array<string>}
14743
+ * @memberof ShopListingCreateDTO
14744
+ */
14745
+ roleIds?: Array<string>;
14507
14746
  /**
14508
14747
  *
14509
14748
  * @type {number}
@@ -14670,6 +14909,12 @@ export interface ShopListingOutputDTO {
14670
14909
  * @memberof ShopListingOutputDTO
14671
14910
  */
14672
14911
  categories?: Array<ShopCategoryOutputDTO>;
14912
+ /**
14913
+ *
14914
+ * @type {Array<ShopListingRoleOutputDTO>}
14915
+ * @memberof ShopListingOutputDTO
14916
+ */
14917
+ roles?: Array<ShopListingRoleOutputDTO>;
14673
14918
  /**
14674
14919
  *
14675
14920
  * @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
@@ -14702,6 +14947,37 @@ export interface ShopListingOutputDTOAPI {
14702
14947
  */
14703
14948
  meta: MetadataOutput;
14704
14949
  }
14950
+ /**
14951
+ *
14952
+ * @export
14953
+ * @interface ShopListingRoleOutputDTO
14954
+ */
14955
+ export interface ShopListingRoleOutputDTO {
14956
+ /**
14957
+ *
14958
+ * @type {string}
14959
+ * @memberof ShopListingRoleOutputDTO
14960
+ */
14961
+ id: string;
14962
+ /**
14963
+ *
14964
+ * @type {string}
14965
+ * @memberof ShopListingRoleOutputDTO
14966
+ */
14967
+ name: string;
14968
+ /**
14969
+ *
14970
+ * @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
14971
+ * @memberof ShopListingRoleOutputDTO
14972
+ */
14973
+ createdAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
14974
+ /**
14975
+ *
14976
+ * @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
14977
+ * @memberof ShopListingRoleOutputDTO
14978
+ */
14979
+ updatedAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
14980
+ }
14705
14981
  /**
14706
14982
  *
14707
14983
  * @export
@@ -14750,6 +15026,12 @@ export interface ShopListingSearchInputAllowedFilters {
14750
15026
  * @memberof ShopListingSearchInputAllowedFilters
14751
15027
  */
14752
15028
  uncategorized?: boolean;
15029
+ /**
15030
+ *
15031
+ * @type {Array<string>}
15032
+ * @memberof ShopListingSearchInputAllowedFilters
15033
+ */
15034
+ visibleToRoleIds?: Array<string>;
14753
15035
  }
14754
15036
  /**
14755
15037
  *
@@ -14890,6 +15172,12 @@ export interface ShopListingUpdateDTO {
14890
15172
  * @memberof ShopListingUpdateDTO
14891
15173
  */
14892
15174
  categoryIds?: Array<string>;
15175
+ /**
15176
+ *
15177
+ * @type {Array<string>}
15178
+ * @memberof ShopListingUpdateDTO
15179
+ */
15180
+ roleIds?: Array<string>;
14893
15181
  }
14894
15182
  /**
14895
15183
  *
@@ -15623,6 +15911,38 @@ export interface StorefrontConfigUpsertDTO {
15623
15911
  */
15624
15912
  values: object;
15625
15913
  }
15914
+ /**
15915
+ *
15916
+ * @export
15917
+ * @interface StorefrontPreviewDTO
15918
+ */
15919
+ export interface StorefrontPreviewDTO {
15920
+ /**
15921
+ *
15922
+ * @type {string}
15923
+ * @memberof StorefrontPreviewDTO
15924
+ */
15925
+ html: string;
15926
+ }
15927
+ /**
15928
+ *
15929
+ * @export
15930
+ * @interface StorefrontPreviewOutputDTOAPI
15931
+ */
15932
+ export interface StorefrontPreviewOutputDTOAPI {
15933
+ /**
15934
+ *
15935
+ * @type {StorefrontPreviewDTO}
15936
+ * @memberof StorefrontPreviewOutputDTOAPI
15937
+ */
15938
+ data: StorefrontPreviewDTO;
15939
+ /**
15940
+ *
15941
+ * @type {MetadataOutput}
15942
+ * @memberof StorefrontPreviewOutputDTOAPI
15943
+ */
15944
+ meta: MetadataOutput;
15945
+ }
15626
15946
  /**
15627
15947
  *
15628
15948
  * @export
@@ -15994,6 +16314,36 @@ export interface TakaroEventHookExecuted {
15994
16314
  * @interface TakaroEventInviteLinkCreated
15995
16315
  */
15996
16316
  export interface TakaroEventInviteLinkCreated {
16317
+ /**
16318
+ *
16319
+ * @type {string}
16320
+ * @memberof TakaroEventInviteLinkCreated
16321
+ */
16322
+ inviteLinkId: string;
16323
+ /**
16324
+ *
16325
+ * @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
16326
+ * @memberof TakaroEventInviteLinkCreated
16327
+ */
16328
+ expiresAt: NOTDOMAINSCOPEDTakaroModelDTOCreatedAt;
16329
+ /**
16330
+ *
16331
+ * @type {number}
16332
+ * @memberof TakaroEventInviteLinkCreated
16333
+ */
16334
+ maxUses: number;
16335
+ /**
16336
+ *
16337
+ * @type {Array<string>}
16338
+ * @memberof TakaroEventInviteLinkCreated
16339
+ */
16340
+ roleIds: Array<string>;
16341
+ /**
16342
+ *
16343
+ * @type {boolean}
16344
+ * @memberof TakaroEventInviteLinkCreated
16345
+ */
16346
+ staffOrigin: boolean;
15997
16347
  /**
15998
16348
  *
15999
16349
  * @type {NOTDOMAINSCOPEDTakaroModelDTOCreatedAt}
@@ -17348,6 +17698,37 @@ export interface UserCreateInputDTO {
17348
17698
  */
17349
17699
  isDashboardUser?: boolean;
17350
17700
  }
17701
+ /**
17702
+ *
17703
+ * @export
17704
+ * @interface UserCreateInviteDTO
17705
+ */
17706
+ export interface UserCreateInviteDTO {
17707
+ /**
17708
+ *
17709
+ * @type {string}
17710
+ * @memberof UserCreateInviteDTO
17711
+ */
17712
+ name: string;
17713
+ /**
17714
+ *
17715
+ * @type {string}
17716
+ * @memberof UserCreateInviteDTO
17717
+ */
17718
+ email: string;
17719
+ /**
17720
+ *
17721
+ * @type {string}
17722
+ * @memberof UserCreateInviteDTO
17723
+ */
17724
+ idpId?: string;
17725
+ /**
17726
+ *
17727
+ * @type {boolean}
17728
+ * @memberof UserCreateInviteDTO
17729
+ */
17730
+ isDashboardUser?: boolean;
17731
+ }
17351
17732
  /**
17352
17733
  *
17353
17734
  * @export
@@ -17451,7 +17832,7 @@ export interface UserOutputDTO {
17451
17832
  * @type {PlayerOutputWithRolesDTO}
17452
17833
  * @memberof UserOutputDTO
17453
17834
  */
17454
- player: PlayerOutputWithRolesDTO;
17835
+ player?: PlayerOutputWithRolesDTO;
17455
17836
  /**
17456
17837
  *
17457
17838
  * @type {boolean}
@@ -17579,7 +17960,7 @@ export interface UserOutputWithRolesDTO {
17579
17960
  * @type {PlayerOutputWithRolesDTO}
17580
17961
  * @memberof UserOutputWithRolesDTO
17581
17962
  */
17582
- player: PlayerOutputWithRolesDTO;
17963
+ player?: PlayerOutputWithRolesDTO;
17583
17964
  /**
17584
17965
  *
17585
17966
  * @type {boolean}
@@ -17826,6 +18207,31 @@ export interface UserUpdateDTO {
17826
18207
  */
17827
18208
  isDashboardUser?: boolean;
17828
18209
  }
18210
+ /**
18211
+ *
18212
+ * @export
18213
+ * @interface VariableBulkDeleteInputDTO
18214
+ */
18215
+ export interface VariableBulkDeleteInputDTO {
18216
+ /**
18217
+ *
18218
+ * @type {VariableSearchInputDTO}
18219
+ * @memberof VariableBulkDeleteInputDTO
18220
+ */
18221
+ query?: VariableSearchInputDTO;
18222
+ /**
18223
+ *
18224
+ * @type {Array<string>}
18225
+ * @memberof VariableBulkDeleteInputDTO
18226
+ */
18227
+ ids?: Array<string>;
18228
+ /**
18229
+ *
18230
+ * @type {Array<string>}
18231
+ * @memberof VariableBulkDeleteInputDTO
18232
+ */
18233
+ excludedIds?: Array<string>;
18234
+ }
17829
18235
  /**
17830
18236
  *
17831
18237
  * @export
@@ -18035,6 +18441,12 @@ export interface VariableSearchInputAllowedSearch {
18035
18441
  * @memberof VariableSearchInputAllowedSearch
18036
18442
  */
18037
18443
  key?: Array<string>;
18444
+ /**
18445
+ *
18446
+ * @type {Array<string>}
18447
+ * @memberof VariableSearchInputAllowedSearch
18448
+ */
18449
+ value?: Array<string>;
18038
18450
  }
18039
18451
  /**
18040
18452
  *
@@ -20616,16 +21028,16 @@ export declare class CommandApi extends BaseAPI {
20616
21028
  */
20617
21029
  export declare const CronJobApiAxiosParamCreator: (configuration?: Configuration) => {
20618
21030
  /**
20619
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20620
- * @summary Create
21031
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
21032
+ * @summary Create a cron job
20621
21033
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20622
21034
  * @param {*} [options] Override http request option.
20623
21035
  * @throws {RequiredError}
20624
21036
  */
20625
21037
  cronJobControllerCreate: (cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20626
21038
  /**
20627
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20628
- * @summary Get executions
21039
+ * Returns the executions of a cron job on a game server. By default it returns only the runs that fail, with the error output each one produced; pass success=true for the runs that succeeded instead. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
21040
+ * @summary Get the execution history of a cron job
20629
21041
  * @param {string} id
20630
21042
  * @param {any} [success]
20631
21043
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20634,40 +21046,40 @@ export declare const CronJobApiAxiosParamCreator: (configuration?: Configuration
20634
21046
  */
20635
21047
  cronJobControllerGetExecutions: (id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20636
21048
  /**
20637
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20638
- * @summary Get one
21049
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
21050
+ * @summary Get one cron job
20639
21051
  * @param {string} id
20640
21052
  * @param {*} [options] Override http request option.
20641
21053
  * @throws {RequiredError}
20642
21054
  */
20643
21055
  cronJobControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20644
21056
  /**
20645
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20646
- * @summary Remove
21057
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
21058
+ * @summary Delete a cron job
20647
21059
  * @param {string} id
20648
21060
  * @param {*} [options] Override http request option.
20649
21061
  * @throws {RequiredError}
20650
21062
  */
20651
21063
  cronJobControllerRemove: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20652
21064
  /**
20653
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20654
- * @summary Search
21065
+ * Find the cron jobs defined in a module version, by name or by the module they belong to. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
21066
+ * @summary Search cron jobs
20655
21067
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20656
21068
  * @param {*} [options] Override http request option.
20657
21069
  * @throws {RequiredError}
20658
21070
  */
20659
21071
  cronJobControllerSearch: (cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20660
21072
  /**
20661
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20662
- * @summary Trigger
21073
+ * Runs a cron job now on a specific game server, without waiting for its schedule. Every installation of the module on that server runs it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
21074
+ * @summary Trigger a cron job manually
20663
21075
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20664
21076
  * @param {*} [options] Override http request option.
20665
21077
  * @throws {RequiredError}
20666
21078
  */
20667
21079
  cronJobControllerTrigger: (cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20668
21080
  /**
20669
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20670
- * @summary Update
21081
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
21082
+ * @summary Update a cron job
20671
21083
  * @param {string} id
20672
21084
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20673
21085
  * @param {*} [options] Override http request option.
@@ -20681,16 +21093,16 @@ export declare const CronJobApiAxiosParamCreator: (configuration?: Configuration
20681
21093
  */
20682
21094
  export declare const CronJobApiFp: (configuration?: Configuration) => {
20683
21095
  /**
20684
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20685
- * @summary Create
21096
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
21097
+ * @summary Create a cron job
20686
21098
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20687
21099
  * @param {*} [options] Override http request option.
20688
21100
  * @throws {RequiredError}
20689
21101
  */
20690
21102
  cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CronJobOutputDTOAPI>>;
20691
21103
  /**
20692
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20693
- * @summary Get executions
21104
+ * Returns the executions of a cron job on a game server. By default it returns only the runs that fail, with the error output each one produced; pass success=true for the runs that succeeded instead. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
21105
+ * @summary Get the execution history of a cron job
20694
21106
  * @param {string} id
20695
21107
  * @param {any} [success]
20696
21108
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20699,40 +21111,40 @@ export declare const CronJobApiFp: (configuration?: Configuration) => {
20699
21111
  */
20700
21112
  cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventOutputArrayDTOAPI>>;
20701
21113
  /**
20702
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20703
- * @summary Get one
21114
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
21115
+ * @summary Get one cron job
20704
21116
  * @param {string} id
20705
21117
  * @param {*} [options] Override http request option.
20706
21118
  * @throws {RequiredError}
20707
21119
  */
20708
21120
  cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CronJobOutputDTOAPI>>;
20709
21121
  /**
20710
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20711
- * @summary Remove
21122
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
21123
+ * @summary Delete a cron job
20712
21124
  * @param {string} id
20713
21125
  * @param {*} [options] Override http request option.
20714
21126
  * @throws {RequiredError}
20715
21127
  */
20716
21128
  cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
20717
21129
  /**
20718
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20719
- * @summary Search
21130
+ * Find the cron jobs defined in a module version, by name or by the module they belong to. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
21131
+ * @summary Search cron jobs
20720
21132
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20721
21133
  * @param {*} [options] Override http request option.
20722
21134
  * @throws {RequiredError}
20723
21135
  */
20724
21136
  cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CronJobOutputArrayDTOAPI>>;
20725
21137
  /**
20726
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20727
- * @summary Trigger
21138
+ * Runs a cron job now on a specific game server, without waiting for its schedule. Every installation of the module on that server runs it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
21139
+ * @summary Trigger a cron job manually
20728
21140
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20729
21141
  * @param {*} [options] Override http request option.
20730
21142
  * @throws {RequiredError}
20731
21143
  */
20732
21144
  cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
20733
21145
  /**
20734
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20735
- * @summary Update
21146
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
21147
+ * @summary Update a cron job
20736
21148
  * @param {string} id
20737
21149
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20738
21150
  * @param {*} [options] Override http request option.
@@ -20746,16 +21158,16 @@ export declare const CronJobApiFp: (configuration?: Configuration) => {
20746
21158
  */
20747
21159
  export declare const CronJobApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
20748
21160
  /**
20749
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20750
- * @summary Create
21161
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
21162
+ * @summary Create a cron job
20751
21163
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20752
21164
  * @param {*} [options] Override http request option.
20753
21165
  * @throws {RequiredError}
20754
21166
  */
20755
21167
  cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
20756
21168
  /**
20757
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20758
- * @summary Get executions
21169
+ * Returns the executions of a cron job on a game server. By default it returns only the runs that fail, with the error output each one produced; pass success=true for the runs that succeeded instead. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
21170
+ * @summary Get the execution history of a cron job
20759
21171
  * @param {string} id
20760
21172
  * @param {any} [success]
20761
21173
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20764,40 +21176,40 @@ export declare const CronJobApiFactory: (configuration?: Configuration, basePath
20764
21176
  */
20765
21177
  cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
20766
21178
  /**
20767
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20768
- * @summary Get one
21179
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
21180
+ * @summary Get one cron job
20769
21181
  * @param {string} id
20770
21182
  * @param {*} [options] Override http request option.
20771
21183
  * @throws {RequiredError}
20772
21184
  */
20773
21185
  cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
20774
21186
  /**
20775
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20776
- * @summary Remove
21187
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
21188
+ * @summary Delete a cron job
20777
21189
  * @param {string} id
20778
21190
  * @param {*} [options] Override http request option.
20779
21191
  * @throws {RequiredError}
20780
21192
  */
20781
21193
  cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
20782
21194
  /**
20783
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20784
- * @summary Search
21195
+ * Find the cron jobs defined in a module version, by name or by the module they belong to. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
21196
+ * @summary Search cron jobs
20785
21197
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20786
21198
  * @param {*} [options] Override http request option.
20787
21199
  * @throws {RequiredError}
20788
21200
  */
20789
21201
  cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputArrayDTOAPI>;
20790
21202
  /**
20791
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20792
- * @summary Trigger
21203
+ * Runs a cron job now on a specific game server, without waiting for its schedule. Every installation of the module on that server runs it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
21204
+ * @summary Trigger a cron job manually
20793
21205
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20794
21206
  * @param {*} [options] Override http request option.
20795
21207
  * @throws {RequiredError}
20796
21208
  */
20797
21209
  cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
20798
21210
  /**
20799
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20800
- * @summary Update
21211
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
21212
+ * @summary Update a cron job
20801
21213
  * @param {string} id
20802
21214
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20803
21215
  * @param {*} [options] Override http request option.
@@ -20813,8 +21225,8 @@ export declare const CronJobApiFactory: (configuration?: Configuration, basePath
20813
21225
  */
20814
21226
  export declare class CronJobApi extends BaseAPI {
20815
21227
  /**
20816
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20817
- * @summary Create
21228
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
21229
+ * @summary Create a cron job
20818
21230
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20819
21231
  * @param {*} [options] Override http request option.
20820
21232
  * @throws {RequiredError}
@@ -20822,8 +21234,8 @@ export declare class CronJobApi extends BaseAPI {
20822
21234
  */
20823
21235
  cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CronJobOutputDTOAPI, any>>;
20824
21236
  /**
20825
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20826
- * @summary Get executions
21237
+ * Returns the executions of a cron job on a game server. By default it returns only the runs that fail, with the error output each one produced; pass success=true for the runs that succeeded instead. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
21238
+ * @summary Get the execution history of a cron job
20827
21239
  * @param {string} id
20828
21240
  * @param {any} [success]
20829
21241
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20833,8 +21245,8 @@ export declare class CronJobApi extends BaseAPI {
20833
21245
  */
20834
21246
  cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventOutputArrayDTOAPI, any>>;
20835
21247
  /**
20836
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20837
- * @summary Get one
21248
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
21249
+ * @summary Get one cron job
20838
21250
  * @param {string} id
20839
21251
  * @param {*} [options] Override http request option.
20840
21252
  * @throws {RequiredError}
@@ -20842,8 +21254,8 @@ export declare class CronJobApi extends BaseAPI {
20842
21254
  */
20843
21255
  cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CronJobOutputDTOAPI, any>>;
20844
21256
  /**
20845
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20846
- * @summary Remove
21257
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
21258
+ * @summary Delete a cron job
20847
21259
  * @param {string} id
20848
21260
  * @param {*} [options] Override http request option.
20849
21261
  * @throws {RequiredError}
@@ -20851,8 +21263,8 @@ export declare class CronJobApi extends BaseAPI {
20851
21263
  */
20852
21264
  cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
20853
21265
  /**
20854
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20855
- * @summary Search
21266
+ * Find the cron jobs defined in a module version, by name or by the module they belong to. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
21267
+ * @summary Search cron jobs
20856
21268
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20857
21269
  * @param {*} [options] Override http request option.
20858
21270
  * @throws {RequiredError}
@@ -20860,8 +21272,8 @@ export declare class CronJobApi extends BaseAPI {
20860
21272
  */
20861
21273
  cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CronJobOutputArrayDTOAPI, any>>;
20862
21274
  /**
20863
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20864
- * @summary Trigger
21275
+ * Runs a cron job now on a specific game server, without waiting for its schedule. Every installation of the module on that server runs it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
21276
+ * @summary Trigger a cron job manually
20865
21277
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20866
21278
  * @param {*} [options] Override http request option.
20867
21279
  * @throws {RequiredError}
@@ -20869,8 +21281,8 @@ export declare class CronJobApi extends BaseAPI {
20869
21281
  */
20870
21282
  cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
20871
21283
  /**
20872
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20873
- * @summary Update
21284
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
21285
+ * @summary Update a cron job
20874
21286
  * @param {string} id
20875
21287
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20876
21288
  * @param {*} [options] Override http request option.
@@ -21200,7 +21612,7 @@ export declare const DomainApiAxiosParamCreator: (configuration?: Configuration)
21200
21612
  domainControllerCreate: (domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21201
21613
  /**
21202
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`
21203
- * @summary Create admin invite link for a domain
21615
+ * @summary Create staff-recovery invite link for a domain
21204
21616
  * @param {string} id
21205
21617
  * @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
21206
21618
  * @param {*} [options] Override http request option.
@@ -21273,7 +21685,7 @@ export declare const DomainApiFp: (configuration?: Configuration) => {
21273
21685
  domainControllerCreate(domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DomainCreateOutputDTOAPI>>;
21274
21686
  /**
21275
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`
21276
- * @summary Create admin invite link for a domain
21688
+ * @summary Create staff-recovery invite link for a domain
21277
21689
  * @param {string} id
21278
21690
  * @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
21279
21691
  * @param {*} [options] Override http request option.
@@ -21346,7 +21758,7 @@ export declare const DomainApiFactory: (configuration?: Configuration, basePath?
21346
21758
  domainControllerCreate(domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<DomainCreateOutputDTOAPI>;
21347
21759
  /**
21348
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`
21349
- * @summary Create admin invite link for a domain
21761
+ * @summary Create staff-recovery invite link for a domain
21350
21762
  * @param {string} id
21351
21763
  * @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
21352
21764
  * @param {*} [options] Override http request option.
@@ -21422,7 +21834,7 @@ export declare class DomainApi extends BaseAPI {
21422
21834
  domainControllerCreate(domainCreateInputDTO?: DomainCreateInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DomainCreateOutputDTOAPI, any>>;
21423
21835
  /**
21424
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`
21425
- * @summary Create admin invite link for a domain
21837
+ * @summary Create staff-recovery invite link for a domain
21426
21838
  * @param {string} id
21427
21839
  * @param {InviteLinkCreateInputDTO} [inviteLinkCreateInputDTO] InviteLinkCreateInputDTO
21428
21840
  * @param {*} [options] Override http request option.
@@ -21633,8 +22045,8 @@ export declare const EventApiAxiosParamCreator: (configuration?: Configuration)
21633
22045
  */
21634
22046
  eventControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21635
22047
  /**
21636
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21637
- * @summary Search
22048
+ * Find what happened on your game servers: chat messages, player deaths and kills, connects and disconnects, commands executed, and module activity. Filter by event name, player, game server or time range, and sort by createdAt descending for the most recent first. Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
22049
+ * @summary Find recent activity: chat messages, deaths, connections
21638
22050
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21639
22051
  * @param {*} [options] Override http request option.
21640
22052
  * @throws {RequiredError}
@@ -21695,8 +22107,8 @@ export declare const EventApiFp: (configuration?: Configuration) => {
21695
22107
  */
21696
22108
  eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventOutputDTO>>;
21697
22109
  /**
21698
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21699
- * @summary Search
22110
+ * Find what happened on your game servers: chat messages, player deaths and kills, connects and disconnects, commands executed, and module activity. Filter by event name, player, game server or time range, and sort by createdAt descending for the most recent first. Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
22111
+ * @summary Find recent activity: chat messages, deaths, connections
21700
22112
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21701
22113
  * @param {*} [options] Override http request option.
21702
22114
  * @throws {RequiredError}
@@ -21757,8 +22169,8 @@ export declare const EventApiFactory: (configuration?: Configuration, basePath?:
21757
22169
  */
21758
22170
  eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputDTO>;
21759
22171
  /**
21760
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21761
- * @summary Search
22172
+ * Find what happened on your game servers: chat messages, player deaths and kills, connects and disconnects, commands executed, and module activity. Filter by event name, player, game server or time range, and sort by createdAt descending for the most recent first. Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
22173
+ * @summary Find recent activity: chat messages, deaths, connections
21762
22174
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21763
22175
  * @param {*} [options] Override http request option.
21764
22176
  * @throws {RequiredError}
@@ -21827,8 +22239,8 @@ export declare class EventApi extends BaseAPI {
21827
22239
  */
21828
22240
  eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventOutputDTO, any>>;
21829
22241
  /**
21830
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21831
- * @summary Search
22242
+ * Find what happened on your game servers: chat messages, player deaths and kills, connects and disconnects, commands executed, and module activity. Filter by event name, player, game server or time range, and sort by createdAt descending for the most recent first. Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
22243
+ * @summary Find recent activity: chat messages, deaths, connections
21832
22244
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21833
22245
  * @param {*} [options] Override http request option.
21834
22246
  * @throws {RequiredError}
@@ -21844,11 +22256,11 @@ export declare const ExternalAuthApiAxiosParamCreator: (configuration?: Configur
21844
22256
  /**
21845
22257
  * <br> OperationId: `ExternalAuthControllerAuthDiscord`
21846
22258
  * @summary Auth discord
21847
- * @param {string} redirect
22259
+ * @param {string} [redirect]
21848
22260
  * @param {*} [options] Override http request option.
21849
22261
  * @throws {RequiredError}
21850
22262
  */
21851
- externalAuthControllerAuthDiscord: (redirect: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22263
+ externalAuthControllerAuthDiscord: (redirect?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21852
22264
  /**
21853
22265
  * <br> OperationId: `ExternalAuthControllerAuthDiscordReturn`
21854
22266
  * @summary Auth discord return
@@ -21865,11 +22277,11 @@ export declare const ExternalAuthApiFp: (configuration?: Configuration) => {
21865
22277
  /**
21866
22278
  * <br> OperationId: `ExternalAuthControllerAuthDiscord`
21867
22279
  * @summary Auth discord
21868
- * @param {string} redirect
22280
+ * @param {string} [redirect]
21869
22281
  * @param {*} [options] Override http request option.
21870
22282
  * @throws {RequiredError}
21871
22283
  */
21872
- externalAuthControllerAuthDiscord(redirect: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
22284
+ externalAuthControllerAuthDiscord(redirect?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
21873
22285
  /**
21874
22286
  * <br> OperationId: `ExternalAuthControllerAuthDiscordReturn`
21875
22287
  * @summary Auth discord return
@@ -21886,11 +22298,11 @@ export declare const ExternalAuthApiFactory: (configuration?: Configuration, bas
21886
22298
  /**
21887
22299
  * <br> OperationId: `ExternalAuthControllerAuthDiscord`
21888
22300
  * @summary Auth discord
21889
- * @param {string} redirect
22301
+ * @param {string} [redirect]
21890
22302
  * @param {*} [options] Override http request option.
21891
22303
  * @throws {RequiredError}
21892
22304
  */
21893
- externalAuthControllerAuthDiscord(redirect: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
22305
+ externalAuthControllerAuthDiscord(redirect?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
21894
22306
  /**
21895
22307
  * <br> OperationId: `ExternalAuthControllerAuthDiscordReturn`
21896
22308
  * @summary Auth discord return
@@ -21909,12 +22321,12 @@ export declare class ExternalAuthApi extends BaseAPI {
21909
22321
  /**
21910
22322
  * <br> OperationId: `ExternalAuthControllerAuthDiscord`
21911
22323
  * @summary Auth discord
21912
- * @param {string} redirect
22324
+ * @param {string} [redirect]
21913
22325
  * @param {*} [options] Override http request option.
21914
22326
  * @throws {RequiredError}
21915
22327
  * @memberof ExternalAuthApi
21916
22328
  */
21917
- externalAuthControllerAuthDiscord(redirect: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
22329
+ externalAuthControllerAuthDiscord(redirect?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
21918
22330
  /**
21919
22331
  * <br> OperationId: `ExternalAuthControllerAuthDiscordReturn`
21920
22332
  * @summary Auth discord return
@@ -22199,7 +22611,7 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
22199
22611
  gameServerControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22200
22612
  /**
22201
22613
  * Fetch a list of players on a gameserver. Requires gameserver to be online and reachable. Please use the Player on GameServer (PoG) search endpoint instead: `POST /gameserver/player/search` for more flexible filtering, sorting, and pagination options. Required permissions: `READ_PLAYERS`<br> OperationId: `GameServerControllerGetPlayers`
22202
- * @summary Get players
22614
+ * @summary List the players currently online on a game server
22203
22615
  * @param {string} id
22204
22616
  * @param {*} [options] Override http request option.
22205
22617
  * @deprecated
@@ -22308,16 +22720,16 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
22308
22720
  */
22309
22721
  gameServerControllerTeleportPlayer: (gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22310
22722
  /**
22311
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
22312
- * @summary Test reachability
22723
+ * Checks whether the connection details you are about to save can actually reach a game server that Takaro does not know about yet. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachability`
22724
+ * @summary Test connection settings before creating a game server
22313
22725
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
22314
22726
  * @param {*} [options] Override http request option.
22315
22727
  * @throws {RequiredError}
22316
22728
  */
22317
22729
  gameServerControllerTestReachability: (gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22318
22730
  /**
22319
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22320
- * @summary Test reachability for id
22731
+ * Checks whether Takaro can still reach a game server it already knows about, using the connection details stored for it. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22732
+ * @summary Test whether an existing game server is reachable
22321
22733
  * @param {string} id
22322
22734
  * @param {*} [options] Override http request option.
22323
22735
  * @throws {RequiredError}
@@ -22432,7 +22844,7 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
22432
22844
  gameServerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GameServerOutputDTOAPI>>;
22433
22845
  /**
22434
22846
  * Fetch a list of players on a gameserver. Requires gameserver to be online and reachable. Please use the Player on GameServer (PoG) search endpoint instead: `POST /gameserver/player/search` for more flexible filtering, sorting, and pagination options. Required permissions: `READ_PLAYERS`<br> OperationId: `GameServerControllerGetPlayers`
22435
- * @summary Get players
22847
+ * @summary List the players currently online on a game server
22436
22848
  * @param {string} id
22437
22849
  * @param {*} [options] Override http request option.
22438
22850
  * @deprecated
@@ -22541,16 +22953,16 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
22541
22953
  */
22542
22954
  gameServerControllerTeleportPlayer(gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
22543
22955
  /**
22544
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
22545
- * @summary Test reachability
22956
+ * Checks whether the connection details you are about to save can actually reach a game server that Takaro does not know about yet. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachability`
22957
+ * @summary Test connection settings before creating a game server
22546
22958
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
22547
22959
  * @param {*} [options] Override http request option.
22548
22960
  * @throws {RequiredError}
22549
22961
  */
22550
22962
  gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GameServerTestReachabilityDTOAPI>>;
22551
22963
  /**
22552
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22553
- * @summary Test reachability for id
22964
+ * Checks whether Takaro can still reach a game server it already knows about, using the connection details stored for it. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22965
+ * @summary Test whether an existing game server is reachable
22554
22966
  * @param {string} id
22555
22967
  * @param {*} [options] Override http request option.
22556
22968
  * @throws {RequiredError}
@@ -22665,7 +23077,7 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
22665
23077
  gameServerControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GameServerOutputDTOAPI>;
22666
23078
  /**
22667
23079
  * Fetch a list of players on a gameserver. Requires gameserver to be online and reachable. Please use the Player on GameServer (PoG) search endpoint instead: `POST /gameserver/player/search` for more flexible filtering, sorting, and pagination options. Required permissions: `READ_PLAYERS`<br> OperationId: `GameServerControllerGetPlayers`
22668
- * @summary Get players
23080
+ * @summary List the players currently online on a game server
22669
23081
  * @param {string} id
22670
23082
  * @param {*} [options] Override http request option.
22671
23083
  * @deprecated
@@ -22774,16 +23186,16 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
22774
23186
  */
22775
23187
  gameServerControllerTeleportPlayer(gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
22776
23188
  /**
22777
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
22778
- * @summary Test reachability
23189
+ * Checks whether the connection details you are about to save can actually reach a game server that Takaro does not know about yet. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachability`
23190
+ * @summary Test connection settings before creating a game server
22779
23191
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
22780
23192
  * @param {*} [options] Override http request option.
22781
23193
  * @throws {RequiredError}
22782
23194
  */
22783
23195
  gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<GameServerTestReachabilityDTOAPI>;
22784
23196
  /**
22785
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22786
- * @summary Test reachability for id
23197
+ * Checks whether Takaro can still reach a game server it already knows about, using the connection details stored for it. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachabilityForId`
23198
+ * @summary Test whether an existing game server is reachable
22787
23199
  * @param {string} id
22788
23200
  * @param {*} [options] Override http request option.
22789
23201
  * @throws {RequiredError}
@@ -22908,7 +23320,7 @@ export declare class GameServerApi extends BaseAPI {
22908
23320
  gameServerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GameServerOutputDTOAPI, any>>;
22909
23321
  /**
22910
23322
  * Fetch a list of players on a gameserver. Requires gameserver to be online and reachable. Please use the Player on GameServer (PoG) search endpoint instead: `POST /gameserver/player/search` for more flexible filtering, sorting, and pagination options. Required permissions: `READ_PLAYERS`<br> OperationId: `GameServerControllerGetPlayers`
22911
- * @summary Get players
23323
+ * @summary List the players currently online on a game server
22912
23324
  * @param {string} id
22913
23325
  * @param {*} [options] Override http request option.
22914
23326
  * @deprecated
@@ -23030,8 +23442,8 @@ export declare class GameServerApi extends BaseAPI {
23030
23442
  */
23031
23443
  gameServerControllerTeleportPlayer(gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
23032
23444
  /**
23033
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
23034
- * @summary Test reachability
23445
+ * Checks whether the connection details you are about to save can actually reach a game server that Takaro does not know about yet. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachability`
23446
+ * @summary Test connection settings before creating a game server
23035
23447
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
23036
23448
  * @param {*} [options] Override http request option.
23037
23449
  * @throws {RequiredError}
@@ -23039,8 +23451,8 @@ export declare class GameServerApi extends BaseAPI {
23039
23451
  */
23040
23452
  gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GameServerTestReachabilityDTOAPI, any>>;
23041
23453
  /**
23042
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
23043
- * @summary Test reachability for id
23454
+ * Checks whether Takaro can still reach a game server it already knows about, using the connection details stored for it. Does a thorough check and reports details.<br> OperationId: `GameServerControllerTestReachabilityForId`
23455
+ * @summary Test whether an existing game server is reachable
23044
23456
  * @param {string} id
23045
23457
  * @param {*} [options] Override http request option.
23046
23458
  * @throws {RequiredError}
@@ -23643,6 +24055,13 @@ export declare const MetaApiAxiosParamCreator: (configuration?: Configuration) =
23643
24055
  * @throws {RequiredError}
23644
24056
  */
23645
24057
  metaGetHealth: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24058
+ /**
24059
+ * <br> OperationId: `MetaGetLiveness`
24060
+ * @summary Get liveness
24061
+ * @param {*} [options] Override http request option.
24062
+ * @throws {RequiredError}
24063
+ */
24064
+ metaGetLiveness: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23646
24065
  /**
23647
24066
  * <br> OperationId: `MetaGetMetrics`
23648
24067
  * @summary Get metrics
@@ -23691,6 +24110,13 @@ export declare const MetaApiFp: (configuration?: Configuration) => {
23691
24110
  * @throws {RequiredError}
23692
24111
  */
23693
24112
  metaGetHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthOutputDTO>>;
24113
+ /**
24114
+ * <br> OperationId: `MetaGetLiveness`
24115
+ * @summary Get liveness
24116
+ * @param {*} [options] Override http request option.
24117
+ * @throws {RequiredError}
24118
+ */
24119
+ metaGetLiveness(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthOutputDTO>>;
23694
24120
  /**
23695
24121
  * <br> OperationId: `MetaGetMetrics`
23696
24122
  * @summary Get metrics
@@ -23739,6 +24165,13 @@ export declare const MetaApiFactory: (configuration?: Configuration, basePath?:
23739
24165
  * @throws {RequiredError}
23740
24166
  */
23741
24167
  metaGetHealth(options?: RawAxiosRequestConfig): AxiosPromise<HealthOutputDTO>;
24168
+ /**
24169
+ * <br> OperationId: `MetaGetLiveness`
24170
+ * @summary Get liveness
24171
+ * @param {*} [options] Override http request option.
24172
+ * @throws {RequiredError}
24173
+ */
24174
+ metaGetLiveness(options?: RawAxiosRequestConfig): AxiosPromise<HealthOutputDTO>;
23742
24175
  /**
23743
24176
  * <br> OperationId: `MetaGetMetrics`
23744
24177
  * @summary Get metrics
@@ -23790,6 +24223,14 @@ export declare class MetaApi extends BaseAPI {
23790
24223
  * @memberof MetaApi
23791
24224
  */
23792
24225
  metaGetHealth(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthOutputDTO, any>>;
24226
+ /**
24227
+ * <br> OperationId: `MetaGetLiveness`
24228
+ * @summary Get liveness
24229
+ * @param {*} [options] Override http request option.
24230
+ * @throws {RequiredError}
24231
+ * @memberof MetaApi
24232
+ */
24233
+ metaGetLiveness(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HealthOutputDTO, any>>;
23793
24234
  /**
23794
24235
  * <br> OperationId: `MetaGetMetrics`
23795
24236
  * @summary Get metrics
@@ -23895,16 +24336,16 @@ export declare const ModuleApiAxiosParamCreator: (configuration?: Configuration)
23895
24336
  */
23896
24337
  moduleControllerUpdate: (id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23897
24338
  /**
23898
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
23899
- * @summary Search module installations
24339
+ * Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24340
+ * @summary List the modules installed on a game server
23900
24341
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
23901
24342
  * @param {*} [options] Override http request option.
23902
24343
  * @throws {RequiredError}
23903
24344
  */
23904
24345
  moduleInstallationsControllerGetInstalledModules: (moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23905
24346
  /**
23906
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
23907
- * @summary Get one installation
24347
+ * Fetch the installation of a specific module on a specific game server, with the configuration it was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24348
+ * @summary Get one module installation
23908
24349
  * @param {string} moduleId
23909
24350
  * @param {string} gameServerId
23910
24351
  * @param {*} [options] Override http request option.
@@ -23912,8 +24353,8 @@ export declare const ModuleApiAxiosParamCreator: (configuration?: Configuration)
23912
24353
  */
23913
24354
  moduleInstallationsControllerGetModuleInstallation: (moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23914
24355
  /**
23915
- * Install a module on a gameserver. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
23916
- * @summary Install module
24356
+ * Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
24357
+ * @summary Install a module on a game server
23917
24358
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
23918
24359
  * @param {*} [options] Override http request option.
23919
24360
  * @throws {RequiredError}
@@ -23921,7 +24362,7 @@ export declare const ModuleApiAxiosParamCreator: (configuration?: Configuration)
23921
24362
  moduleInstallationsControllerInstallModule: (installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23922
24363
  /**
23923
24364
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
23924
- * @summary Uninstall module
24365
+ * @summary Uninstall a module from a game server
23925
24366
  * @param {string} moduleId
23926
24367
  * @param {string} gameServerId
23927
24368
  * @param {*} [options] Override http request option.
@@ -24017,16 +24458,16 @@ export declare const ModuleApiFp: (configuration?: Configuration) => {
24017
24458
  */
24018
24459
  moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleOutputDTOAPI>>;
24019
24460
  /**
24020
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24021
- * @summary Search module installations
24461
+ * Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24462
+ * @summary List the modules installed on a game server
24022
24463
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
24023
24464
  * @param {*} [options] Override http request option.
24024
24465
  * @throws {RequiredError}
24025
24466
  */
24026
24467
  moduleInstallationsControllerGetInstalledModules(moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleInstallationOutputArrayDTOAPI>>;
24027
24468
  /**
24028
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24029
- * @summary Get one installation
24469
+ * Fetch the installation of a specific module on a specific game server, with the configuration it was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24470
+ * @summary Get one module installation
24030
24471
  * @param {string} moduleId
24031
24472
  * @param {string} gameServerId
24032
24473
  * @param {*} [options] Override http request option.
@@ -24034,8 +24475,8 @@ export declare const ModuleApiFp: (configuration?: Configuration) => {
24034
24475
  */
24035
24476
  moduleInstallationsControllerGetModuleInstallation(moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleInstallationOutputDTOAPI>>;
24036
24477
  /**
24037
- * Install a module on a gameserver. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
24038
- * @summary Install module
24478
+ * Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
24479
+ * @summary Install a module on a game server
24039
24480
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
24040
24481
  * @param {*} [options] Override http request option.
24041
24482
  * @throws {RequiredError}
@@ -24043,7 +24484,7 @@ export declare const ModuleApiFp: (configuration?: Configuration) => {
24043
24484
  moduleInstallationsControllerInstallModule(installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleInstallationOutputDTOAPI>>;
24044
24485
  /**
24045
24486
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
24046
- * @summary Uninstall module
24487
+ * @summary Uninstall a module from a game server
24047
24488
  * @param {string} moduleId
24048
24489
  * @param {string} gameServerId
24049
24490
  * @param {*} [options] Override http request option.
@@ -24139,16 +24580,16 @@ export declare const ModuleApiFactory: (configuration?: Configuration, basePath?
24139
24580
  */
24140
24581
  moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
24141
24582
  /**
24142
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24143
- * @summary Search module installations
24583
+ * Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24584
+ * @summary List the modules installed on a game server
24144
24585
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
24145
24586
  * @param {*} [options] Override http request option.
24146
24587
  * @throws {RequiredError}
24147
24588
  */
24148
24589
  moduleInstallationsControllerGetInstalledModules(moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputArrayDTOAPI>;
24149
24590
  /**
24150
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24151
- * @summary Get one installation
24591
+ * Fetch the installation of a specific module on a specific game server, with the configuration it was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24592
+ * @summary Get one module installation
24152
24593
  * @param {string} moduleId
24153
24594
  * @param {string} gameServerId
24154
24595
  * @param {*} [options] Override http request option.
@@ -24156,8 +24597,8 @@ export declare const ModuleApiFactory: (configuration?: Configuration, basePath?
24156
24597
  */
24157
24598
  moduleInstallationsControllerGetModuleInstallation(moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputDTOAPI>;
24158
24599
  /**
24159
- * Install a module on a gameserver. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
24160
- * @summary Install module
24600
+ * Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
24601
+ * @summary Install a module on a game server
24161
24602
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
24162
24603
  * @param {*} [options] Override http request option.
24163
24604
  * @throws {RequiredError}
@@ -24165,7 +24606,7 @@ export declare const ModuleApiFactory: (configuration?: Configuration, basePath?
24165
24606
  moduleInstallationsControllerInstallModule(installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputDTOAPI>;
24166
24607
  /**
24167
24608
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
24168
- * @summary Uninstall module
24609
+ * @summary Uninstall a module from a game server
24169
24610
  * @param {string} moduleId
24170
24611
  * @param {string} gameServerId
24171
24612
  * @param {*} [options] Override http request option.
@@ -24270,8 +24711,8 @@ export declare class ModuleApi extends BaseAPI {
24270
24711
  */
24271
24712
  moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleOutputDTOAPI, any>>;
24272
24713
  /**
24273
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24274
- * @summary Search module installations
24714
+ * Find module installations, optionally narrowed to one game server or one module, with the configuration each installation was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24715
+ * @summary List the modules installed on a game server
24275
24716
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
24276
24717
  * @param {*} [options] Override http request option.
24277
24718
  * @throws {RequiredError}
@@ -24279,8 +24720,8 @@ export declare class ModuleApi extends BaseAPI {
24279
24720
  */
24280
24721
  moduleInstallationsControllerGetInstalledModules(moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>;
24281
24722
  /**
24282
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24283
- * @summary Get one installation
24723
+ * Fetch the installation of a specific module on a specific game server, with the configuration it was given. Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24724
+ * @summary Get one module installation
24284
24725
  * @param {string} moduleId
24285
24726
  * @param {string} gameServerId
24286
24727
  * @param {*} [options] Override http request option.
@@ -24289,8 +24730,8 @@ export declare class ModuleApi extends BaseAPI {
24289
24730
  */
24290
24731
  moduleInstallationsControllerGetModuleInstallation(moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleInstallationOutputDTOAPI, any>>;
24291
24732
  /**
24292
- * Install a module on a gameserver. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
24293
- * @summary Install module
24733
+ * Installs a module version on a game server, so its commands, hooks and cron jobs start running there. You can have multiple installations of the same module on the same gameserver. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerInstallModule`
24734
+ * @summary Install a module on a game server
24294
24735
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
24295
24736
  * @param {*} [options] Override http request option.
24296
24737
  * @throws {RequiredError}
@@ -24299,7 +24740,7 @@ export declare class ModuleApi extends BaseAPI {
24299
24740
  moduleInstallationsControllerInstallModule(installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleInstallationOutputDTOAPI, any>>;
24300
24741
  /**
24301
24742
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
24302
- * @summary Uninstall module
24743
+ * @summary Uninstall a module from a game server
24303
24744
  * @param {string} moduleId
24304
24745
  * @param {string} gameServerId
24305
24746
  * @param {*} [options] Override http request option.
@@ -24382,8 +24823,8 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24382
24823
  */
24383
24824
  banControllerUpdate: (id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24384
24825
  /**
24385
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24386
- * @summary Assign role
24826
+ * Gives a role to a player, granting them its permissions. The role can be scoped to a single game server and can be set to expire. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24827
+ * @summary Assign a role to a player
24387
24828
  * @param {string} id
24388
24829
  * @param {string} roleId
24389
24830
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24392,8 +24833,8 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24392
24833
  */
24393
24834
  playerControllerAssignRole: (id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24394
24835
  /**
24395
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24396
- * @summary Bulk assign role
24836
+ * Bulk assign a role to multiple players, targeted by ids or by a search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24837
+ * @summary Assign a role to many players at once
24397
24838
  * @param {string} roleId
24398
24839
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24399
24840
  * @param {*} [options] Override http request option.
@@ -24401,7 +24842,7 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24401
24842
  */
24402
24843
  playerControllerBulkAssignRole: (roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24403
24844
  /**
24404
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
24845
+ * Bulk delete players, targeted by ids or by a search query. Deletes Player records which cascades to POG records. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
24405
24846
  * @summary Bulk delete
24406
24847
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24407
24848
  * @param {*} [options] Override http request option.
@@ -24424,16 +24865,16 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24424
24865
  */
24425
24866
  playerControllerGetMe: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24426
24867
  /**
24427
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24428
- * @summary Get one
24868
+ * Fetch a single player by their Takaro player id, with the platform identifiers and roles attached to them. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24869
+ * @summary Get one player
24429
24870
  * @param {string} id
24430
24871
  * @param {*} [options] Override http request option.
24431
24872
  * @throws {RequiredError}
24432
24873
  */
24433
24874
  playerControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24434
24875
  /**
24435
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24436
- * @summary Remove role
24876
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24877
+ * @summary Remove a role from a player
24437
24878
  * @param {string} id
24438
24879
  * @param {string} roleId
24439
24880
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24442,8 +24883,8 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24442
24883
  */
24443
24884
  playerControllerRemoveRole: (id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24444
24885
  /**
24445
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24446
- * @summary Search
24886
+ * Search every player Takaro knows about, across all game servers. Match on their name or on a platform identifier: Steam ID, Xbox live ID, Epic Online Services ID, or their Takaro player id. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24887
+ * @summary Find a player by name or platform id
24447
24888
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24448
24889
  * @param {*} [options] Override http request option.
24449
24890
  * @throws {RequiredError}
@@ -24497,8 +24938,8 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24497
24938
  */
24498
24939
  banControllerUpdate(id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>>;
24499
24940
  /**
24500
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24501
- * @summary Assign role
24941
+ * Gives a role to a player, granting them its permissions. The role can be scoped to a single game server and can be set to expire. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24942
+ * @summary Assign a role to a player
24502
24943
  * @param {string} id
24503
24944
  * @param {string} roleId
24504
24945
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24507,8 +24948,8 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24507
24948
  */
24508
24949
  playerControllerAssignRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
24509
24950
  /**
24510
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24511
- * @summary Bulk assign role
24951
+ * Bulk assign a role to multiple players, targeted by ids or by a search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24952
+ * @summary Assign a role to many players at once
24512
24953
  * @param {string} roleId
24513
24954
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24514
24955
  * @param {*} [options] Override http request option.
@@ -24516,7 +24957,7 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24516
24957
  */
24517
24958
  playerControllerBulkAssignRole(roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerBulkAssignRoleOutputDTOAPI>>;
24518
24959
  /**
24519
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
24960
+ * Bulk delete players, targeted by ids or by a search query. Deletes Player records which cascades to POG records. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
24520
24961
  * @summary Bulk delete
24521
24962
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24522
24963
  * @param {*} [options] Override http request option.
@@ -24539,16 +24980,16 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24539
24980
  */
24540
24981
  playerControllerGetMe(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerMeOutputDTO>>;
24541
24982
  /**
24542
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24543
- * @summary Get one
24983
+ * Fetch a single player by their Takaro player id, with the platform identifiers and roles attached to them. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24984
+ * @summary Get one player
24544
24985
  * @param {string} id
24545
24986
  * @param {*} [options] Override http request option.
24546
24987
  * @throws {RequiredError}
24547
24988
  */
24548
24989
  playerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOutputWithRolesDTOAPI>>;
24549
24990
  /**
24550
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24551
- * @summary Remove role
24991
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24992
+ * @summary Remove a role from a player
24552
24993
  * @param {string} id
24553
24994
  * @param {string} roleId
24554
24995
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24557,8 +24998,8 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24557
24998
  */
24558
24999
  playerControllerRemoveRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
24559
25000
  /**
24560
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24561
- * @summary Search
25001
+ * Search every player Takaro knows about, across all game servers. Match on their name or on a platform identifier: Steam ID, Xbox live ID, Epic Online Services ID, or their Takaro player id. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
25002
+ * @summary Find a player by name or platform id
24562
25003
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24563
25004
  * @param {*} [options] Override http request option.
24564
25005
  * @throws {RequiredError}
@@ -24612,8 +25053,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24612
25053
  */
24613
25054
  banControllerUpdate(id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputDTOAPI>;
24614
25055
  /**
24615
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24616
- * @summary Assign role
25056
+ * Gives a role to a player, granting them its permissions. The role can be scoped to a single game server and can be set to expire. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
25057
+ * @summary Assign a role to a player
24617
25058
  * @param {string} id
24618
25059
  * @param {string} roleId
24619
25060
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24622,8 +25063,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24622
25063
  */
24623
25064
  playerControllerAssignRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
24624
25065
  /**
24625
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24626
- * @summary Bulk assign role
25066
+ * Bulk assign a role to multiple players, targeted by ids or by a search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
25067
+ * @summary Assign a role to many players at once
24627
25068
  * @param {string} roleId
24628
25069
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24629
25070
  * @param {*} [options] Override http request option.
@@ -24631,7 +25072,7 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24631
25072
  */
24632
25073
  playerControllerBulkAssignRole(roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerBulkAssignRoleOutputDTOAPI>;
24633
25074
  /**
24634
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
25075
+ * Bulk delete players, targeted by ids or by a search query. Deletes Player records which cascades to POG records. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
24635
25076
  * @summary Bulk delete
24636
25077
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24637
25078
  * @param {*} [options] Override http request option.
@@ -24654,16 +25095,16 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24654
25095
  */
24655
25096
  playerControllerGetMe(options?: RawAxiosRequestConfig): AxiosPromise<PlayerMeOutputDTO>;
24656
25097
  /**
24657
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24658
- * @summary Get one
25098
+ * Fetch a single player by their Takaro player id, with the platform identifiers and roles attached to them. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
25099
+ * @summary Get one player
24659
25100
  * @param {string} id
24660
25101
  * @param {*} [options] Override http request option.
24661
25102
  * @throws {RequiredError}
24662
25103
  */
24663
25104
  playerControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOutputWithRolesDTOAPI>;
24664
25105
  /**
24665
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24666
- * @summary Remove role
25106
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
25107
+ * @summary Remove a role from a player
24667
25108
  * @param {string} id
24668
25109
  * @param {string} roleId
24669
25110
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24672,8 +25113,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24672
25113
  */
24673
25114
  playerControllerRemoveRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
24674
25115
  /**
24675
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24676
- * @summary Search
25116
+ * Search every player Takaro knows about, across all game servers. Match on their name or on a platform identifier: Steam ID, Xbox live ID, Epic Online Services ID, or their Takaro player id. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
25117
+ * @summary Find a player by name or platform id
24677
25118
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24678
25119
  * @param {*} [options] Override http request option.
24679
25120
  * @throws {RequiredError}
@@ -24734,8 +25175,8 @@ export declare class PlayerApi extends BaseAPI {
24734
25175
  */
24735
25176
  banControllerUpdate(id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BanOutputDTOAPI, any>>;
24736
25177
  /**
24737
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24738
- * @summary Assign role
25178
+ * Gives a role to a player, granting them its permissions. The role can be scoped to a single game server and can be set to expire. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
25179
+ * @summary Assign a role to a player
24739
25180
  * @param {string} id
24740
25181
  * @param {string} roleId
24741
25182
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24745,8 +25186,8 @@ export declare class PlayerApi extends BaseAPI {
24745
25186
  */
24746
25187
  playerControllerAssignRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
24747
25188
  /**
24748
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24749
- * @summary Bulk assign role
25189
+ * Bulk assign a role to multiple players, targeted by ids or by a search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
25190
+ * @summary Assign a role to many players at once
24750
25191
  * @param {string} roleId
24751
25192
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24752
25193
  * @param {*} [options] Override http request option.
@@ -24755,7 +25196,7 @@ export declare class PlayerApi extends BaseAPI {
24755
25196
  */
24756
25197
  playerControllerBulkAssignRole(roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerBulkAssignRoleOutputDTOAPI, any>>;
24757
25198
  /**
24758
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
25199
+ * Bulk delete players, targeted by ids or by a search query. Deletes Player records which cascades to POG records. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
24759
25200
  * @summary Bulk delete
24760
25201
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24761
25202
  * @param {*} [options] Override http request option.
@@ -24781,8 +25222,8 @@ export declare class PlayerApi extends BaseAPI {
24781
25222
  */
24782
25223
  playerControllerGetMe(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerMeOutputDTO, any>>;
24783
25224
  /**
24784
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24785
- * @summary Get one
25225
+ * Fetch a single player by their Takaro player id, with the platform identifiers and roles attached to them. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
25226
+ * @summary Get one player
24786
25227
  * @param {string} id
24787
25228
  * @param {*} [options] Override http request option.
24788
25229
  * @throws {RequiredError}
@@ -24790,8 +25231,8 @@ export declare class PlayerApi extends BaseAPI {
24790
25231
  */
24791
25232
  playerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOutputWithRolesDTOAPI, any>>;
24792
25233
  /**
24793
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24794
- * @summary Remove role
25234
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
25235
+ * @summary Remove a role from a player
24795
25236
  * @param {string} id
24796
25237
  * @param {string} roleId
24797
25238
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24801,8 +25242,8 @@ export declare class PlayerApi extends BaseAPI {
24801
25242
  */
24802
25243
  playerControllerRemoveRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
24803
25244
  /**
24804
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24805
- * @summary Search
25245
+ * Search every player Takaro knows about, across all game servers. Match on their name or on a platform identifier: Steam ID, Xbox live ID, Epic Online Services ID, or their Takaro player id. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
25246
+ * @summary Find a player by name or platform id
24806
25247
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24807
25248
  * @param {*} [options] Override http request option.
24808
25249
  * @throws {RequiredError}
@@ -24816,8 +25257,8 @@ export declare class PlayerApi extends BaseAPI {
24816
25257
  */
24817
25258
  export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Configuration) => {
24818
25259
  /**
24819
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
24820
- * @summary Add currency
25260
+ * Grant currency to a player on a game server as a reward, a payout or a manual correction. The amount is added to the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25261
+ * @summary Give a player currency
24821
25262
  * @param {string} gameServerId
24822
25263
  * @param {string} playerId
24823
25264
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24826,8 +25267,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24826
25267
  */
24827
25268
  playerOnGameServerControllerAddCurrency: (gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24828
25269
  /**
24829
- * Bulk add currency to multiple players on a game server. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
24830
- * @summary Bulk add currency
25270
+ * Bulk add currency to players on a game server, targeted by player ids or by a player-on-game-server search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
25271
+ * @summary Give several players currency at once
24831
25272
  * @param {string} gameServerId
24832
25273
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
24833
25274
  * @param {*} [options] Override http request option.
@@ -24836,7 +25277,7 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24836
25277
  playerOnGameServerControllerBulkAddCurrency: (gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24837
25278
  /**
24838
25279
  * Bulk delete POG records by player IDs for a specific gameserver. Deletes POG records only, Player records remain intact. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkDelete`
24839
- * @summary Bulk delete
25280
+ * @summary Permanently delete several players\' records and their history
24840
25281
  * @param {string} gameServerId
24841
25282
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
24842
25283
  * @param {*} [options] Override http request option.
@@ -24844,8 +25285,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24844
25285
  */
24845
25286
  playerOnGameServerControllerBulkDelete: (gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24846
25287
  /**
24847
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
24848
- * @summary Deduct currency
25288
+ * Remove currency from a player on a game server as a fine or a manual correction. The amount is subtracted from the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25289
+ * @summary Take currency away from a player
24849
25290
  * @param {string} gameServerId
24850
25291
  * @param {string} playerId
24851
25292
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24854,8 +25295,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24854
25295
  */
24855
25296
  playerOnGameServerControllerDeductCurrency: (gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24856
25297
  /**
24857
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
24858
- * @summary Delete
25298
+ * Removes the per-server record only. The player themselves, and their records on other game servers, remain untouched. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25299
+ * @summary Permanently delete a player\'s record and its history
24859
25300
  * @param {string} gameServerId
24860
25301
  * @param {string} playerId
24861
25302
  * @param {*} [options] Override http request option.
@@ -24863,8 +25304,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24863
25304
  */
24864
25305
  playerOnGameServerControllerDelete: (gameServerId: string, playerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24865
25306
  /**
24866
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
24867
- * @summary Get one
25307
+ * Fetch a single player\'s record on a specific game server, with their currency balance, playtime and online status. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25308
+ * @summary Get one player on a game server
24868
25309
  * @param {string} gameServerId
24869
25310
  * @param {string} playerId
24870
25311
  * @param {*} [options] Override http request option.
@@ -24872,16 +25313,16 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24872
25313
  */
24873
25314
  playerOnGameServerControllerGetOne: (gameServerId: string, playerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24874
25315
  /**
24875
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
24876
- * @summary Search
25316
+ * Find the per-server record of a player: their currency balance, playtime, online status and when they were last seen on that game server. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25317
+ * @summary Search players on a game server
24877
25318
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
24878
25319
  * @param {*} [options] Override http request option.
24879
25320
  * @throws {RequiredError}
24880
25321
  */
24881
25322
  playerOnGameServerControllerSearch: (playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24882
25323
  /**
24883
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
24884
- * @summary Set currency
25324
+ * Overwrite a player\'s currency balance on a game server with an exact amount, rather than adding to or subtracting from it. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25325
+ * @summary Set a player\'s currency balance
24885
25326
  * @param {string} gameServerId
24886
25327
  * @param {string} playerId
24887
25328
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24890,8 +25331,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24890
25331
  */
24891
25332
  playerOnGameServerControllerSetCurrency: (gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24892
25333
  /**
24893
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
24894
- * @summary Transact between players
25334
+ * Move currency from one player to another on the same game server, deducting from the sender and adding to the receiver in a single operation. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25335
+ * @summary Transfer currency between two players
24895
25336
  * @param {string} gameServerId
24896
25337
  * @param {string} sender
24897
25338
  * @param {string} receiver
@@ -24907,8 +25348,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24907
25348
  */
24908
25349
  export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) => {
24909
25350
  /**
24910
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
24911
- * @summary Add currency
25351
+ * Grant currency to a player on a game server as a reward, a payout or a manual correction. The amount is added to the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25352
+ * @summary Give a player currency
24912
25353
  * @param {string} gameServerId
24913
25354
  * @param {string} playerId
24914
25355
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24917,8 +25358,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24917
25358
  */
24918
25359
  playerOnGameServerControllerAddCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
24919
25360
  /**
24920
- * Bulk add currency to multiple players on a game server. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
24921
- * @summary Bulk add currency
25361
+ * Bulk add currency to players on a game server, targeted by player ids or by a player-on-game-server search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
25362
+ * @summary Give several players currency at once
24922
25363
  * @param {string} gameServerId
24923
25364
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
24924
25365
  * @param {*} [options] Override http request option.
@@ -24927,7 +25368,7 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24927
25368
  playerOnGameServerControllerBulkAddCurrency(gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PogBulkAddCurrencyOutputDTOAPI>>;
24928
25369
  /**
24929
25370
  * Bulk delete POG records by player IDs for a specific gameserver. Deletes POG records only, Player records remain intact. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkDelete`
24930
- * @summary Bulk delete
25371
+ * @summary Permanently delete several players\' records and their history
24931
25372
  * @param {string} gameServerId
24932
25373
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
24933
25374
  * @param {*} [options] Override http request option.
@@ -24935,8 +25376,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24935
25376
  */
24936
25377
  playerOnGameServerControllerBulkDelete(gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PogBulkDeleteOutputDTOAPI>>;
24937
25378
  /**
24938
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
24939
- * @summary Deduct currency
25379
+ * Remove currency from a player on a game server as a fine or a manual correction. The amount is subtracted from the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25380
+ * @summary Take currency away from a player
24940
25381
  * @param {string} gameServerId
24941
25382
  * @param {string} playerId
24942
25383
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24945,8 +25386,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24945
25386
  */
24946
25387
  playerOnGameServerControllerDeductCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
24947
25388
  /**
24948
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
24949
- * @summary Delete
25389
+ * Removes the per-server record only. The player themselves, and their records on other game servers, remain untouched. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25390
+ * @summary Permanently delete a player\'s record and its history
24950
25391
  * @param {string} gameServerId
24951
25392
  * @param {string} playerId
24952
25393
  * @param {*} [options] Override http request option.
@@ -24954,8 +25395,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24954
25395
  */
24955
25396
  playerOnGameServerControllerDelete(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
24956
25397
  /**
24957
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
24958
- * @summary Get one
25398
+ * Fetch a single player\'s record on a specific game server, with their currency balance, playtime and online status. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25399
+ * @summary Get one player on a game server
24959
25400
  * @param {string} gameServerId
24960
25401
  * @param {string} playerId
24961
25402
  * @param {*} [options] Override http request option.
@@ -24963,16 +25404,16 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24963
25404
  */
24964
25405
  playerOnGameServerControllerGetOne(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
24965
25406
  /**
24966
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
24967
- * @summary Search
25407
+ * Find the per-server record of a player: their currency balance, playtime, online status and when they were last seen on that game server. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25408
+ * @summary Search players on a game server
24968
25409
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
24969
25410
  * @param {*} [options] Override http request option.
24970
25411
  * @throws {RequiredError}
24971
25412
  */
24972
25413
  playerOnGameServerControllerSearch(playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>>;
24973
25414
  /**
24974
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
24975
- * @summary Set currency
25415
+ * Overwrite a player\'s currency balance on a game server with an exact amount, rather than adding to or subtracting from it. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25416
+ * @summary Set a player\'s currency balance
24976
25417
  * @param {string} gameServerId
24977
25418
  * @param {string} playerId
24978
25419
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24981,8 +25422,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24981
25422
  */
24982
25423
  playerOnGameServerControllerSetCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
24983
25424
  /**
24984
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
24985
- * @summary Transact between players
25425
+ * Move currency from one player to another on the same game server, deducting from the sender and adding to the receiver in a single operation. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25426
+ * @summary Transfer currency between two players
24986
25427
  * @param {string} gameServerId
24987
25428
  * @param {string} sender
24988
25429
  * @param {string} receiver
@@ -24998,8 +25439,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
24998
25439
  */
24999
25440
  export declare const PlayerOnGameServerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
25000
25441
  /**
25001
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25002
- * @summary Add currency
25442
+ * Grant currency to a player on a game server as a reward, a payout or a manual correction. The amount is added to the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25443
+ * @summary Give a player currency
25003
25444
  * @param {string} gameServerId
25004
25445
  * @param {string} playerId
25005
25446
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25008,8 +25449,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25008
25449
  */
25009
25450
  playerOnGameServerControllerAddCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25010
25451
  /**
25011
- * Bulk add currency to multiple players on a game server. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
25012
- * @summary Bulk add currency
25452
+ * Bulk add currency to players on a game server, targeted by player ids or by a player-on-game-server search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
25453
+ * @summary Give several players currency at once
25013
25454
  * @param {string} gameServerId
25014
25455
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
25015
25456
  * @param {*} [options] Override http request option.
@@ -25018,7 +25459,7 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25018
25459
  playerOnGameServerControllerBulkAddCurrency(gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PogBulkAddCurrencyOutputDTOAPI>;
25019
25460
  /**
25020
25461
  * Bulk delete POG records by player IDs for a specific gameserver. Deletes POG records only, Player records remain intact. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkDelete`
25021
- * @summary Bulk delete
25462
+ * @summary Permanently delete several players\' records and their history
25022
25463
  * @param {string} gameServerId
25023
25464
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
25024
25465
  * @param {*} [options] Override http request option.
@@ -25026,8 +25467,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25026
25467
  */
25027
25468
  playerOnGameServerControllerBulkDelete(gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PogBulkDeleteOutputDTOAPI>;
25028
25469
  /**
25029
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25030
- * @summary Deduct currency
25470
+ * Remove currency from a player on a game server as a fine or a manual correction. The amount is subtracted from the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25471
+ * @summary Take currency away from a player
25031
25472
  * @param {string} gameServerId
25032
25473
  * @param {string} playerId
25033
25474
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25036,8 +25477,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25036
25477
  */
25037
25478
  playerOnGameServerControllerDeductCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25038
25479
  /**
25039
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25040
- * @summary Delete
25480
+ * Removes the per-server record only. The player themselves, and their records on other game servers, remain untouched. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25481
+ * @summary Permanently delete a player\'s record and its history
25041
25482
  * @param {string} gameServerId
25042
25483
  * @param {string} playerId
25043
25484
  * @param {*} [options] Override http request option.
@@ -25045,8 +25486,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25045
25486
  */
25046
25487
  playerOnGameServerControllerDelete(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
25047
25488
  /**
25048
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25049
- * @summary Get one
25489
+ * Fetch a single player\'s record on a specific game server, with their currency balance, playtime and online status. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25490
+ * @summary Get one player on a game server
25050
25491
  * @param {string} gameServerId
25051
25492
  * @param {string} playerId
25052
25493
  * @param {*} [options] Override http request option.
@@ -25054,16 +25495,16 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25054
25495
  */
25055
25496
  playerOnGameServerControllerGetOne(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25056
25497
  /**
25057
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25058
- * @summary Search
25498
+ * Find the per-server record of a player: their currency balance, playtime, online status and when they were last seen on that game server. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25499
+ * @summary Search players on a game server
25059
25500
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
25060
25501
  * @param {*} [options] Override http request option.
25061
25502
  * @throws {RequiredError}
25062
25503
  */
25063
25504
  playerOnGameServerControllerSearch(playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>;
25064
25505
  /**
25065
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25066
- * @summary Set currency
25506
+ * Overwrite a player\'s currency balance on a game server with an exact amount, rather than adding to or subtracting from it. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25507
+ * @summary Set a player\'s currency balance
25067
25508
  * @param {string} gameServerId
25068
25509
  * @param {string} playerId
25069
25510
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25072,8 +25513,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25072
25513
  */
25073
25514
  playerOnGameServerControllerSetCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25074
25515
  /**
25075
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25076
- * @summary Transact between players
25516
+ * Move currency from one player to another on the same game server, deducting from the sender and adding to the receiver in a single operation. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25517
+ * @summary Transfer currency between two players
25077
25518
  * @param {string} gameServerId
25078
25519
  * @param {string} sender
25079
25520
  * @param {string} receiver
@@ -25091,8 +25532,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25091
25532
  */
25092
25533
  export declare class PlayerOnGameServerApi extends BaseAPI {
25093
25534
  /**
25094
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25095
- * @summary Add currency
25535
+ * Grant currency to a player on a game server as a reward, a payout or a manual correction. The amount is added to the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25536
+ * @summary Give a player currency
25096
25537
  * @param {string} gameServerId
25097
25538
  * @param {string} playerId
25098
25539
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25102,8 +25543,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25102
25543
  */
25103
25544
  playerOnGameServerControllerAddCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25104
25545
  /**
25105
- * Bulk add currency to multiple players on a game server. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
25106
- * @summary Bulk add currency
25546
+ * Bulk add currency to players on a game server, targeted by player ids or by a player-on-game-server search query (at most 1000 resolved players). Processes each player individually and reports partial failures. `playerIds` is deprecated; use `ids`. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkAddCurrency`
25547
+ * @summary Give several players currency at once
25107
25548
  * @param {string} gameServerId
25108
25549
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
25109
25550
  * @param {*} [options] Override http request option.
@@ -25113,7 +25554,7 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25113
25554
  playerOnGameServerControllerBulkAddCurrency(gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PogBulkAddCurrencyOutputDTOAPI, any>>;
25114
25555
  /**
25115
25556
  * Bulk delete POG records by player IDs for a specific gameserver. Deletes POG records only, Player records remain intact. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerBulkDelete`
25116
- * @summary Bulk delete
25557
+ * @summary Permanently delete several players\' records and their history
25117
25558
  * @param {string} gameServerId
25118
25559
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
25119
25560
  * @param {*} [options] Override http request option.
@@ -25122,8 +25563,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25122
25563
  */
25123
25564
  playerOnGameServerControllerBulkDelete(gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PogBulkDeleteOutputDTOAPI, any>>;
25124
25565
  /**
25125
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25126
- * @summary Deduct currency
25566
+ * Remove currency from a player on a game server as a fine or a manual correction. The amount is subtracted from the balance they already have. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25567
+ * @summary Take currency away from a player
25127
25568
  * @param {string} gameServerId
25128
25569
  * @param {string} playerId
25129
25570
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25133,8 +25574,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25133
25574
  */
25134
25575
  playerOnGameServerControllerDeductCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25135
25576
  /**
25136
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25137
- * @summary Delete
25577
+ * Removes the per-server record only. The player themselves, and their records on other game servers, remain untouched. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25578
+ * @summary Permanently delete a player\'s record and its history
25138
25579
  * @param {string} gameServerId
25139
25580
  * @param {string} playerId
25140
25581
  * @param {*} [options] Override http request option.
@@ -25143,8 +25584,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25143
25584
  */
25144
25585
  playerOnGameServerControllerDelete(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
25145
25586
  /**
25146
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25147
- * @summary Get one
25587
+ * Fetch a single player\'s record on a specific game server, with their currency balance, playtime and online status. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25588
+ * @summary Get one player on a game server
25148
25589
  * @param {string} gameServerId
25149
25590
  * @param {string} playerId
25150
25591
  * @param {*} [options] Override http request option.
@@ -25153,8 +25594,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25153
25594
  */
25154
25595
  playerOnGameServerControllerGetOne(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25155
25596
  /**
25156
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25157
- * @summary Search
25597
+ * Find the per-server record of a player: their currency balance, playtime, online status and when they were last seen on that game server. Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25598
+ * @summary Search players on a game server
25158
25599
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
25159
25600
  * @param {*} [options] Override http request option.
25160
25601
  * @throws {RequiredError}
@@ -25162,8 +25603,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25162
25603
  */
25163
25604
  playerOnGameServerControllerSearch(playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>;
25164
25605
  /**
25165
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25166
- * @summary Set currency
25606
+ * Overwrite a player\'s currency balance on a game server with an exact amount, rather than adding to or subtracting from it. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25607
+ * @summary Set a player\'s currency balance
25167
25608
  * @param {string} gameServerId
25168
25609
  * @param {string} playerId
25169
25610
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25173,8 +25614,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25173
25614
  */
25174
25615
  playerOnGameServerControllerSetCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25175
25616
  /**
25176
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25177
- * @summary Transact between players
25617
+ * Move currency from one player to another on the same game server, deducting from the sender and adding to the receiver in a single operation. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25618
+ * @summary Transfer currency between two players
25178
25619
  * @param {string} gameServerId
25179
25620
  * @param {string} sender
25180
25621
  * @param {string} receiver
@@ -25398,8 +25839,8 @@ export declare const RoleApiAxiosParamCreator: (configuration?: Configuration) =
25398
25839
  */
25399
25840
  roleControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
25400
25841
  /**
25401
- * <br> OperationId: `RoleControllerGetPermissions`
25402
- * @summary Get permissions
25842
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
25843
+ * @summary List every permission a role can grant
25403
25844
  * @param {*} [options] Override http request option.
25404
25845
  * @throws {RequiredError}
25405
25846
  */
@@ -25452,8 +25893,8 @@ export declare const RoleApiFp: (configuration?: Configuration) => {
25452
25893
  */
25453
25894
  roleControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleOutputDTOAPI>>;
25454
25895
  /**
25455
- * <br> OperationId: `RoleControllerGetPermissions`
25456
- * @summary Get permissions
25896
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
25897
+ * @summary List every permission a role can grant
25457
25898
  * @param {*} [options] Override http request option.
25458
25899
  * @throws {RequiredError}
25459
25900
  */
@@ -25506,8 +25947,8 @@ export declare const RoleApiFactory: (configuration?: Configuration, basePath?:
25506
25947
  */
25507
25948
  roleControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RoleOutputDTOAPI>;
25508
25949
  /**
25509
- * <br> OperationId: `RoleControllerGetPermissions`
25510
- * @summary Get permissions
25950
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
25951
+ * @summary List every permission a role can grant
25511
25952
  * @param {*} [options] Override http request option.
25512
25953
  * @throws {RequiredError}
25513
25954
  */
@@ -25564,8 +26005,8 @@ export declare class RoleApi extends BaseAPI {
25564
26005
  */
25565
26006
  roleControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleOutputDTOAPI, any>>;
25566
26007
  /**
25567
- * <br> OperationId: `RoleControllerGetPermissions`
25568
- * @summary Get permissions
26008
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
26009
+ * @summary List every permission a role can grant
25569
26010
  * @param {*} [options] Override http request option.
25570
26011
  * @throws {RequiredError}
25571
26012
  * @memberof RoleApi
@@ -26066,7 +26507,7 @@ export declare class ShopActionApi extends BaseAPI {
26066
26507
  */
26067
26508
  export declare const ShopCategoryApiAxiosParamCreator: (configuration?: Configuration) => {
26068
26509
  /**
26069
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26510
+ * Bulk assign categories to shop listings, targeted by ids or by a listing search query. `listingIds` is deprecated; use `ids`. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26070
26511
  * @summary Bulk assign
26071
26512
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26072
26513
  * @param {*} [options] Override http request option.
@@ -26139,7 +26580,7 @@ export declare const ShopCategoryApiAxiosParamCreator: (configuration?: Configur
26139
26580
  */
26140
26581
  export declare const ShopCategoryApiFp: (configuration?: Configuration) => {
26141
26582
  /**
26142
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26583
+ * Bulk assign categories to shop listings, targeted by ids or by a listing search query. `listingIds` is deprecated; use `ids`. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26143
26584
  * @summary Bulk assign
26144
26585
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26145
26586
  * @param {*} [options] Override http request option.
@@ -26212,7 +26653,7 @@ export declare const ShopCategoryApiFp: (configuration?: Configuration) => {
26212
26653
  */
26213
26654
  export declare const ShopCategoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
26214
26655
  /**
26215
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26656
+ * Bulk assign categories to shop listings, targeted by ids or by a listing search query. `listingIds` is deprecated; use `ids`. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26216
26657
  * @summary Bulk assign
26217
26658
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26218
26659
  * @param {*} [options] Override http request option.
@@ -26287,7 +26728,7 @@ export declare const ShopCategoryApiFactory: (configuration?: Configuration, bas
26287
26728
  */
26288
26729
  export declare class ShopCategoryApi extends BaseAPI {
26289
26730
  /**
26290
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26731
+ * Bulk assign categories to shop listings, targeted by ids or by a listing search query. `listingIds` is deprecated; use `ids`. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
26291
26732
  * @summary Bulk assign
26292
26733
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26293
26734
  * @param {*} [options] Override http request option.
@@ -26367,6 +26808,14 @@ export declare class ShopCategoryApi extends BaseAPI {
26367
26808
  * @export
26368
26809
  */
26369
26810
  export declare const ShopListingApiAxiosParamCreator: (configuration?: Configuration) => {
26811
+ /**
26812
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
26813
+ * @summary Bulk
26814
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
26815
+ * @param {*} [options] Override http request option.
26816
+ * @throws {RequiredError}
26817
+ */
26818
+ shopListingControllerBulk: (shopListingBulkInputDTO?: ShopListingBulkInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
26370
26819
  /**
26371
26820
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26372
26821
  * @summary Create
@@ -26421,6 +26870,14 @@ export declare const ShopListingApiAxiosParamCreator: (configuration?: Configura
26421
26870
  * @export
26422
26871
  */
26423
26872
  export declare const ShopListingApiFp: (configuration?: Configuration) => {
26873
+ /**
26874
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
26875
+ * @summary Bulk
26876
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
26877
+ * @param {*} [options] Override http request option.
26878
+ * @throws {RequiredError}
26879
+ */
26880
+ shopListingControllerBulk(shopListingBulkInputDTO?: ShopListingBulkInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkActionResultDTOAPI>>;
26424
26881
  /**
26425
26882
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26426
26883
  * @summary Create
@@ -26475,6 +26932,14 @@ export declare const ShopListingApiFp: (configuration?: Configuration) => {
26475
26932
  * @export
26476
26933
  */
26477
26934
  export declare const ShopListingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
26935
+ /**
26936
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
26937
+ * @summary Bulk
26938
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
26939
+ * @param {*} [options] Override http request option.
26940
+ * @throws {RequiredError}
26941
+ */
26942
+ shopListingControllerBulk(shopListingBulkInputDTO?: ShopListingBulkInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<BulkActionResultDTOAPI>;
26478
26943
  /**
26479
26944
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26480
26945
  * @summary Create
@@ -26531,6 +26996,15 @@ export declare const ShopListingApiFactory: (configuration?: Configuration, base
26531
26996
  * @extends {BaseAPI}
26532
26997
  */
26533
26998
  export declare class ShopListingApi extends BaseAPI {
26999
+ /**
27000
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
27001
+ * @summary Bulk
27002
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
27003
+ * @param {*} [options] Override http request option.
27004
+ * @throws {RequiredError}
27005
+ * @memberof ShopListingApi
27006
+ */
27007
+ shopListingControllerBulk(shopListingBulkInputDTO?: ShopListingBulkInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkActionResultDTOAPI, any>>;
26534
27008
  /**
26535
27009
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26536
27010
  * @summary Create
@@ -26797,6 +27271,15 @@ export declare const StorefrontConfigApiAxiosParamCreator: (configuration?: Conf
26797
27271
  * @throws {RequiredError}
26798
27272
  */
26799
27273
  storefrontConfigControllerListTemplates: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
27274
+ /**
27275
+ * Render the storefront for a game server from an unsaved template id and values, using the same validation and render path as the public page. Persists nothing. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerPreviewConfig`
27276
+ * @summary Preview config
27277
+ * @param {string} gameServerId
27278
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
27279
+ * @param {*} [options] Override http request option.
27280
+ * @throws {RequiredError}
27281
+ */
27282
+ storefrontConfigControllerPreviewConfig: (gameServerId: string, storefrontConfigUpsertBody?: StorefrontConfigUpsertBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
26800
27283
  /**
26801
27284
  * Set the storefront configuration for a game server. Validates the template id and values against the template schema. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerSetConfig`
26802
27285
  * @summary Set config
@@ -26827,6 +27310,15 @@ export declare const StorefrontConfigApiFp: (configuration?: Configuration) => {
26827
27310
  * @throws {RequiredError}
26828
27311
  */
26829
27312
  storefrontConfigControllerListTemplates(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StorefrontTemplateOutputArrayDTOAPI>>;
27313
+ /**
27314
+ * Render the storefront for a game server from an unsaved template id and values, using the same validation and render path as the public page. Persists nothing. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerPreviewConfig`
27315
+ * @summary Preview config
27316
+ * @param {string} gameServerId
27317
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
27318
+ * @param {*} [options] Override http request option.
27319
+ * @throws {RequiredError}
27320
+ */
27321
+ storefrontConfigControllerPreviewConfig(gameServerId: string, storefrontConfigUpsertBody?: StorefrontConfigUpsertBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StorefrontPreviewOutputDTOAPI>>;
26830
27322
  /**
26831
27323
  * Set the storefront configuration for a game server. Validates the template id and values against the template schema. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerSetConfig`
26832
27324
  * @summary Set config
@@ -26857,6 +27349,15 @@ export declare const StorefrontConfigApiFactory: (configuration?: Configuration,
26857
27349
  * @throws {RequiredError}
26858
27350
  */
26859
27351
  storefrontConfigControllerListTemplates(options?: RawAxiosRequestConfig): AxiosPromise<StorefrontTemplateOutputArrayDTOAPI>;
27352
+ /**
27353
+ * Render the storefront for a game server from an unsaved template id and values, using the same validation and render path as the public page. Persists nothing. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerPreviewConfig`
27354
+ * @summary Preview config
27355
+ * @param {string} gameServerId
27356
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
27357
+ * @param {*} [options] Override http request option.
27358
+ * @throws {RequiredError}
27359
+ */
27360
+ storefrontConfigControllerPreviewConfig(gameServerId: string, storefrontConfigUpsertBody?: StorefrontConfigUpsertBody, options?: RawAxiosRequestConfig): AxiosPromise<StorefrontPreviewOutputDTOAPI>;
26860
27361
  /**
26861
27362
  * Set the storefront configuration for a game server. Validates the template id and values against the template schema. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerSetConfig`
26862
27363
  * @summary Set config
@@ -26891,6 +27392,16 @@ export declare class StorefrontConfigApi extends BaseAPI {
26891
27392
  * @memberof StorefrontConfigApi
26892
27393
  */
26893
27394
  storefrontConfigControllerListTemplates(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StorefrontTemplateOutputArrayDTOAPI, any>>;
27395
+ /**
27396
+ * Render the storefront for a game server from an unsaved template id and values, using the same validation and render path as the public page. Persists nothing. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerPreviewConfig`
27397
+ * @summary Preview config
27398
+ * @param {string} gameServerId
27399
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
27400
+ * @param {*} [options] Override http request option.
27401
+ * @throws {RequiredError}
27402
+ * @memberof StorefrontConfigApi
27403
+ */
27404
+ storefrontConfigControllerPreviewConfig(gameServerId: string, storefrontConfigUpsertBody?: StorefrontConfigUpsertBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StorefrontPreviewOutputDTOAPI, any>>;
26894
27405
  /**
26895
27406
  * Set the storefront configuration for a game server. Validates the template id and values against the template schema. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `StorefrontConfigControllerSetConfig`
26896
27407
  * @summary Set config
@@ -27623,6 +28134,14 @@ export declare class UserApi extends BaseAPI {
27623
28134
  * @export
27624
28135
  */
27625
28136
  export declare const VariableApiAxiosParamCreator: (configuration?: Configuration) => {
28137
+ /**
28138
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
28139
+ * @summary Bulk delete
28140
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
28141
+ * @param {*} [options] Override http request option.
28142
+ * @throws {RequiredError}
28143
+ */
28144
+ variableControllerBulkDelete: (variableBulkDeleteInputDTO?: VariableBulkDeleteInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
27626
28145
  /**
27627
28146
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27628
28147
  * @summary Create
@@ -27670,6 +28189,14 @@ export declare const VariableApiAxiosParamCreator: (configuration?: Configuratio
27670
28189
  * @export
27671
28190
  */
27672
28191
  export declare const VariableApiFp: (configuration?: Configuration) => {
28192
+ /**
28193
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
28194
+ * @summary Bulk delete
28195
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
28196
+ * @param {*} [options] Override http request option.
28197
+ * @throws {RequiredError}
28198
+ */
28199
+ variableControllerBulkDelete(variableBulkDeleteInputDTO?: VariableBulkDeleteInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkActionResultDTOAPI>>;
27673
28200
  /**
27674
28201
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27675
28202
  * @summary Create
@@ -27717,6 +28244,14 @@ export declare const VariableApiFp: (configuration?: Configuration) => {
27717
28244
  * @export
27718
28245
  */
27719
28246
  export declare const VariableApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
28247
+ /**
28248
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
28249
+ * @summary Bulk delete
28250
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
28251
+ * @param {*} [options] Override http request option.
28252
+ * @throws {RequiredError}
28253
+ */
28254
+ variableControllerBulkDelete(variableBulkDeleteInputDTO?: VariableBulkDeleteInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<BulkActionResultDTOAPI>;
27720
28255
  /**
27721
28256
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27722
28257
  * @summary Create
@@ -27766,6 +28301,15 @@ export declare const VariableApiFactory: (configuration?: Configuration, basePat
27766
28301
  * @extends {BaseAPI}
27767
28302
  */
27768
28303
  export declare class VariableApi extends BaseAPI {
28304
+ /**
28305
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
28306
+ * @summary Bulk delete
28307
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
28308
+ * @param {*} [options] Override http request option.
28309
+ * @throws {RequiredError}
28310
+ * @memberof VariableApi
28311
+ */
28312
+ variableControllerBulkDelete(variableBulkDeleteInputDTO?: VariableBulkDeleteInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkActionResultDTOAPI, any>>;
27769
28313
  /**
27770
28314
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27771
28315
  * @summary Create