@takaro/apiclient 0.0.0-dev.db9320f → 0.0.0-dev.dc6ba0b

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
@@ -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
  *
@@ -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
@@ -17887,6 +18207,31 @@ export interface UserUpdateDTO {
17887
18207
  */
17888
18208
  isDashboardUser?: boolean;
17889
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
+ }
17890
18235
  /**
17891
18236
  *
17892
18237
  * @export
@@ -18096,6 +18441,12 @@ export interface VariableSearchInputAllowedSearch {
18096
18441
  * @memberof VariableSearchInputAllowedSearch
18097
18442
  */
18098
18443
  key?: Array<string>;
18444
+ /**
18445
+ *
18446
+ * @type {Array<string>}
18447
+ * @memberof VariableSearchInputAllowedSearch
18448
+ */
18449
+ value?: Array<string>;
18099
18450
  }
18100
18451
  /**
18101
18452
  *
@@ -20677,16 +21028,16 @@ export declare class CommandApi extends BaseAPI {
20677
21028
  */
20678
21029
  export declare const CronJobApiAxiosParamCreator: (configuration?: Configuration) => {
20679
21030
  /**
20680
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20681
- * @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
20682
21033
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20683
21034
  * @param {*} [options] Override http request option.
20684
21035
  * @throws {RequiredError}
20685
21036
  */
20686
21037
  cronJobControllerCreate: (cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20687
21038
  /**
20688
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20689
- * @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
20690
21041
  * @param {string} id
20691
21042
  * @param {any} [success]
20692
21043
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20695,40 +21046,40 @@ export declare const CronJobApiAxiosParamCreator: (configuration?: Configuration
20695
21046
  */
20696
21047
  cronJobControllerGetExecutions: (id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20697
21048
  /**
20698
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20699
- * @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
20700
21051
  * @param {string} id
20701
21052
  * @param {*} [options] Override http request option.
20702
21053
  * @throws {RequiredError}
20703
21054
  */
20704
21055
  cronJobControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20705
21056
  /**
20706
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20707
- * @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
20708
21059
  * @param {string} id
20709
21060
  * @param {*} [options] Override http request option.
20710
21061
  * @throws {RequiredError}
20711
21062
  */
20712
21063
  cronJobControllerRemove: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20713
21064
  /**
20714
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20715
- * @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
20716
21067
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20717
21068
  * @param {*} [options] Override http request option.
20718
21069
  * @throws {RequiredError}
20719
21070
  */
20720
21071
  cronJobControllerSearch: (cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20721
21072
  /**
20722
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20723
- * @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
20724
21075
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20725
21076
  * @param {*} [options] Override http request option.
20726
21077
  * @throws {RequiredError}
20727
21078
  */
20728
21079
  cronJobControllerTrigger: (cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
20729
21080
  /**
20730
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20731
- * @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
20732
21083
  * @param {string} id
20733
21084
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20734
21085
  * @param {*} [options] Override http request option.
@@ -20742,16 +21093,16 @@ export declare const CronJobApiAxiosParamCreator: (configuration?: Configuration
20742
21093
  */
20743
21094
  export declare const CronJobApiFp: (configuration?: Configuration) => {
20744
21095
  /**
20745
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20746
- * @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
20747
21098
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20748
21099
  * @param {*} [options] Override http request option.
20749
21100
  * @throws {RequiredError}
20750
21101
  */
20751
21102
  cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CronJobOutputDTOAPI>>;
20752
21103
  /**
20753
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20754
- * @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
20755
21106
  * @param {string} id
20756
21107
  * @param {any} [success]
20757
21108
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20760,40 +21111,40 @@ export declare const CronJobApiFp: (configuration?: Configuration) => {
20760
21111
  */
20761
21112
  cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventOutputArrayDTOAPI>>;
20762
21113
  /**
20763
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20764
- * @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
20765
21116
  * @param {string} id
20766
21117
  * @param {*} [options] Override http request option.
20767
21118
  * @throws {RequiredError}
20768
21119
  */
20769
21120
  cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CronJobOutputDTOAPI>>;
20770
21121
  /**
20771
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20772
- * @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
20773
21124
  * @param {string} id
20774
21125
  * @param {*} [options] Override http request option.
20775
21126
  * @throws {RequiredError}
20776
21127
  */
20777
21128
  cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
20778
21129
  /**
20779
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20780
- * @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
20781
21132
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20782
21133
  * @param {*} [options] Override http request option.
20783
21134
  * @throws {RequiredError}
20784
21135
  */
20785
21136
  cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CronJobOutputArrayDTOAPI>>;
20786
21137
  /**
20787
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20788
- * @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
20789
21140
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20790
21141
  * @param {*} [options] Override http request option.
20791
21142
  * @throws {RequiredError}
20792
21143
  */
20793
21144
  cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
20794
21145
  /**
20795
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20796
- * @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
20797
21148
  * @param {string} id
20798
21149
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20799
21150
  * @param {*} [options] Override http request option.
@@ -20807,16 +21158,16 @@ export declare const CronJobApiFp: (configuration?: Configuration) => {
20807
21158
  */
20808
21159
  export declare const CronJobApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
20809
21160
  /**
20810
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20811
- * @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
20812
21163
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20813
21164
  * @param {*} [options] Override http request option.
20814
21165
  * @throws {RequiredError}
20815
21166
  */
20816
21167
  cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
20817
21168
  /**
20818
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20819
- * @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
20820
21171
  * @param {string} id
20821
21172
  * @param {any} [success]
20822
21173
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20825,40 +21176,40 @@ export declare const CronJobApiFactory: (configuration?: Configuration, basePath
20825
21176
  */
20826
21177
  cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
20827
21178
  /**
20828
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20829
- * @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
20830
21181
  * @param {string} id
20831
21182
  * @param {*} [options] Override http request option.
20832
21183
  * @throws {RequiredError}
20833
21184
  */
20834
21185
  cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
20835
21186
  /**
20836
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20837
- * @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
20838
21189
  * @param {string} id
20839
21190
  * @param {*} [options] Override http request option.
20840
21191
  * @throws {RequiredError}
20841
21192
  */
20842
21193
  cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
20843
21194
  /**
20844
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20845
- * @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
20846
21197
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20847
21198
  * @param {*} [options] Override http request option.
20848
21199
  * @throws {RequiredError}
20849
21200
  */
20850
21201
  cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputArrayDTOAPI>;
20851
21202
  /**
20852
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20853
- * @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
20854
21205
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20855
21206
  * @param {*} [options] Override http request option.
20856
21207
  * @throws {RequiredError}
20857
21208
  */
20858
21209
  cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
20859
21210
  /**
20860
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20861
- * @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
20862
21213
  * @param {string} id
20863
21214
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20864
21215
  * @param {*} [options] Override http request option.
@@ -20874,8 +21225,8 @@ export declare const CronJobApiFactory: (configuration?: Configuration, basePath
20874
21225
  */
20875
21226
  export declare class CronJobApi extends BaseAPI {
20876
21227
  /**
20877
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
20878
- * @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
20879
21230
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
20880
21231
  * @param {*} [options] Override http request option.
20881
21232
  * @throws {RequiredError}
@@ -20883,8 +21234,8 @@ export declare class CronJobApi extends BaseAPI {
20883
21234
  */
20884
21235
  cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CronJobOutputDTOAPI, any>>;
20885
21236
  /**
20886
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
20887
- * @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
20888
21239
  * @param {string} id
20889
21240
  * @param {any} [success]
20890
21241
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -20894,8 +21245,8 @@ export declare class CronJobApi extends BaseAPI {
20894
21245
  */
20895
21246
  cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventOutputArrayDTOAPI, any>>;
20896
21247
  /**
20897
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
20898
- * @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
20899
21250
  * @param {string} id
20900
21251
  * @param {*} [options] Override http request option.
20901
21252
  * @throws {RequiredError}
@@ -20903,8 +21254,8 @@ export declare class CronJobApi extends BaseAPI {
20903
21254
  */
20904
21255
  cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CronJobOutputDTOAPI, any>>;
20905
21256
  /**
20906
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
20907
- * @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
20908
21259
  * @param {string} id
20909
21260
  * @param {*} [options] Override http request option.
20910
21261
  * @throws {RequiredError}
@@ -20912,8 +21263,8 @@ export declare class CronJobApi extends BaseAPI {
20912
21263
  */
20913
21264
  cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
20914
21265
  /**
20915
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
20916
- * @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
20917
21268
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
20918
21269
  * @param {*} [options] Override http request option.
20919
21270
  * @throws {RequiredError}
@@ -20921,8 +21272,8 @@ export declare class CronJobApi extends BaseAPI {
20921
21272
  */
20922
21273
  cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CronJobOutputArrayDTOAPI, any>>;
20923
21274
  /**
20924
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
20925
- * @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
20926
21277
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
20927
21278
  * @param {*} [options] Override http request option.
20928
21279
  * @throws {RequiredError}
@@ -20930,8 +21281,8 @@ export declare class CronJobApi extends BaseAPI {
20930
21281
  */
20931
21282
  cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
20932
21283
  /**
20933
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
20934
- * @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
20935
21286
  * @param {string} id
20936
21287
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
20937
21288
  * @param {*} [options] Override http request option.
@@ -21694,8 +22045,8 @@ export declare const EventApiAxiosParamCreator: (configuration?: Configuration)
21694
22045
  */
21695
22046
  eventControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21696
22047
  /**
21697
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21698
- * @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
21699
22050
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21700
22051
  * @param {*} [options] Override http request option.
21701
22052
  * @throws {RequiredError}
@@ -21756,8 +22107,8 @@ export declare const EventApiFp: (configuration?: Configuration) => {
21756
22107
  */
21757
22108
  eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventOutputDTO>>;
21758
22109
  /**
21759
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21760
- * @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
21761
22112
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21762
22113
  * @param {*} [options] Override http request option.
21763
22114
  * @throws {RequiredError}
@@ -21818,8 +22169,8 @@ export declare const EventApiFactory: (configuration?: Configuration, basePath?:
21818
22169
  */
21819
22170
  eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputDTO>;
21820
22171
  /**
21821
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21822
- * @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
21823
22174
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21824
22175
  * @param {*} [options] Override http request option.
21825
22176
  * @throws {RequiredError}
@@ -21888,8 +22239,8 @@ export declare class EventApi extends BaseAPI {
21888
22239
  */
21889
22240
  eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventOutputDTO, any>>;
21890
22241
  /**
21891
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
21892
- * @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
21893
22244
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
21894
22245
  * @param {*} [options] Override http request option.
21895
22246
  * @throws {RequiredError}
@@ -22260,7 +22611,7 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
22260
22611
  gameServerControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22261
22612
  /**
22262
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`
22263
- * @summary Get players
22614
+ * @summary List the players currently online on a game server
22264
22615
  * @param {string} id
22265
22616
  * @param {*} [options] Override http request option.
22266
22617
  * @deprecated
@@ -22369,16 +22720,16 @@ export declare const GameServerApiAxiosParamCreator: (configuration?: Configurat
22369
22720
  */
22370
22721
  gameServerControllerTeleportPlayer: (gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22371
22722
  /**
22372
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
22373
- * @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
22374
22725
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
22375
22726
  * @param {*} [options] Override http request option.
22376
22727
  * @throws {RequiredError}
22377
22728
  */
22378
22729
  gameServerControllerTestReachability: (gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
22379
22730
  /**
22380
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22381
- * @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
22382
22733
  * @param {string} id
22383
22734
  * @param {*} [options] Override http request option.
22384
22735
  * @throws {RequiredError}
@@ -22493,7 +22844,7 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
22493
22844
  gameServerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GameServerOutputDTOAPI>>;
22494
22845
  /**
22495
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`
22496
- * @summary Get players
22847
+ * @summary List the players currently online on a game server
22497
22848
  * @param {string} id
22498
22849
  * @param {*} [options] Override http request option.
22499
22850
  * @deprecated
@@ -22602,16 +22953,16 @@ export declare const GameServerApiFp: (configuration?: Configuration) => {
22602
22953
  */
22603
22954
  gameServerControllerTeleportPlayer(gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
22604
22955
  /**
22605
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
22606
- * @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
22607
22958
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
22608
22959
  * @param {*} [options] Override http request option.
22609
22960
  * @throws {RequiredError}
22610
22961
  */
22611
22962
  gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GameServerTestReachabilityDTOAPI>>;
22612
22963
  /**
22613
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22614
- * @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
22615
22966
  * @param {string} id
22616
22967
  * @param {*} [options] Override http request option.
22617
22968
  * @throws {RequiredError}
@@ -22726,7 +23077,7 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
22726
23077
  gameServerControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<GameServerOutputDTOAPI>;
22727
23078
  /**
22728
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`
22729
- * @summary Get players
23080
+ * @summary List the players currently online on a game server
22730
23081
  * @param {string} id
22731
23082
  * @param {*} [options] Override http request option.
22732
23083
  * @deprecated
@@ -22835,16 +23186,16 @@ export declare const GameServerApiFactory: (configuration?: Configuration, baseP
22835
23186
  */
22836
23187
  gameServerControllerTeleportPlayer(gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
22837
23188
  /**
22838
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
22839
- * @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
22840
23191
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
22841
23192
  * @param {*} [options] Override http request option.
22842
23193
  * @throws {RequiredError}
22843
23194
  */
22844
23195
  gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<GameServerTestReachabilityDTOAPI>;
22845
23196
  /**
22846
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
22847
- * @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
22848
23199
  * @param {string} id
22849
23200
  * @param {*} [options] Override http request option.
22850
23201
  * @throws {RequiredError}
@@ -22969,7 +23320,7 @@ export declare class GameServerApi extends BaseAPI {
22969
23320
  gameServerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GameServerOutputDTOAPI, any>>;
22970
23321
  /**
22971
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`
22972
- * @summary Get players
23323
+ * @summary List the players currently online on a game server
22973
23324
  * @param {string} id
22974
23325
  * @param {*} [options] Override http request option.
22975
23326
  * @deprecated
@@ -23091,8 +23442,8 @@ export declare class GameServerApi extends BaseAPI {
23091
23442
  */
23092
23443
  gameServerControllerTeleportPlayer(gameServerId: string, playerId: string, teleportPlayerInputDTO?: TeleportPlayerInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
23093
23444
  /**
23094
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
23095
- * @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
23096
23447
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
23097
23448
  * @param {*} [options] Override http request option.
23098
23449
  * @throws {RequiredError}
@@ -23100,8 +23451,8 @@ export declare class GameServerApi extends BaseAPI {
23100
23451
  */
23101
23452
  gameServerControllerTestReachability(gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GameServerTestReachabilityDTOAPI, any>>;
23102
23453
  /**
23103
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
23104
- * @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
23105
23456
  * @param {string} id
23106
23457
  * @param {*} [options] Override http request option.
23107
23458
  * @throws {RequiredError}
@@ -23985,16 +24336,16 @@ export declare const ModuleApiAxiosParamCreator: (configuration?: Configuration)
23985
24336
  */
23986
24337
  moduleControllerUpdate: (id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23987
24338
  /**
23988
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
23989
- * @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
23990
24341
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
23991
24342
  * @param {*} [options] Override http request option.
23992
24343
  * @throws {RequiredError}
23993
24344
  */
23994
24345
  moduleInstallationsControllerGetInstalledModules: (moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23995
24346
  /**
23996
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
23997
- * @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
23998
24349
  * @param {string} moduleId
23999
24350
  * @param {string} gameServerId
24000
24351
  * @param {*} [options] Override http request option.
@@ -24002,8 +24353,8 @@ export declare const ModuleApiAxiosParamCreator: (configuration?: Configuration)
24002
24353
  */
24003
24354
  moduleInstallationsControllerGetModuleInstallation: (moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24004
24355
  /**
24005
- * 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`
24006
- * @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
24007
24358
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
24008
24359
  * @param {*} [options] Override http request option.
24009
24360
  * @throws {RequiredError}
@@ -24011,7 +24362,7 @@ export declare const ModuleApiAxiosParamCreator: (configuration?: Configuration)
24011
24362
  moduleInstallationsControllerInstallModule: (installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24012
24363
  /**
24013
24364
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
24014
- * @summary Uninstall module
24365
+ * @summary Uninstall a module from a game server
24015
24366
  * @param {string} moduleId
24016
24367
  * @param {string} gameServerId
24017
24368
  * @param {*} [options] Override http request option.
@@ -24107,16 +24458,16 @@ export declare const ModuleApiFp: (configuration?: Configuration) => {
24107
24458
  */
24108
24459
  moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleOutputDTOAPI>>;
24109
24460
  /**
24110
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24111
- * @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
24112
24463
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
24113
24464
  * @param {*} [options] Override http request option.
24114
24465
  * @throws {RequiredError}
24115
24466
  */
24116
24467
  moduleInstallationsControllerGetInstalledModules(moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleInstallationOutputArrayDTOAPI>>;
24117
24468
  /**
24118
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24119
- * @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
24120
24471
  * @param {string} moduleId
24121
24472
  * @param {string} gameServerId
24122
24473
  * @param {*} [options] Override http request option.
@@ -24124,8 +24475,8 @@ export declare const ModuleApiFp: (configuration?: Configuration) => {
24124
24475
  */
24125
24476
  moduleInstallationsControllerGetModuleInstallation(moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleInstallationOutputDTOAPI>>;
24126
24477
  /**
24127
- * 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`
24128
- * @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
24129
24480
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
24130
24481
  * @param {*} [options] Override http request option.
24131
24482
  * @throws {RequiredError}
@@ -24133,7 +24484,7 @@ export declare const ModuleApiFp: (configuration?: Configuration) => {
24133
24484
  moduleInstallationsControllerInstallModule(installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleInstallationOutputDTOAPI>>;
24134
24485
  /**
24135
24486
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
24136
- * @summary Uninstall module
24487
+ * @summary Uninstall a module from a game server
24137
24488
  * @param {string} moduleId
24138
24489
  * @param {string} gameServerId
24139
24490
  * @param {*} [options] Override http request option.
@@ -24229,16 +24580,16 @@ export declare const ModuleApiFactory: (configuration?: Configuration, basePath?
24229
24580
  */
24230
24581
  moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
24231
24582
  /**
24232
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24233
- * @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
24234
24585
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
24235
24586
  * @param {*} [options] Override http request option.
24236
24587
  * @throws {RequiredError}
24237
24588
  */
24238
24589
  moduleInstallationsControllerGetInstalledModules(moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputArrayDTOAPI>;
24239
24590
  /**
24240
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24241
- * @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
24242
24593
  * @param {string} moduleId
24243
24594
  * @param {string} gameServerId
24244
24595
  * @param {*} [options] Override http request option.
@@ -24246,8 +24597,8 @@ export declare const ModuleApiFactory: (configuration?: Configuration, basePath?
24246
24597
  */
24247
24598
  moduleInstallationsControllerGetModuleInstallation(moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputDTOAPI>;
24248
24599
  /**
24249
- * 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`
24250
- * @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
24251
24602
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
24252
24603
  * @param {*} [options] Override http request option.
24253
24604
  * @throws {RequiredError}
@@ -24255,7 +24606,7 @@ export declare const ModuleApiFactory: (configuration?: Configuration, basePath?
24255
24606
  moduleInstallationsControllerInstallModule(installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleInstallationOutputDTOAPI>;
24256
24607
  /**
24257
24608
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
24258
- * @summary Uninstall module
24609
+ * @summary Uninstall a module from a game server
24259
24610
  * @param {string} moduleId
24260
24611
  * @param {string} gameServerId
24261
24612
  * @param {*} [options] Override http request option.
@@ -24360,8 +24711,8 @@ export declare class ModuleApi extends BaseAPI {
24360
24711
  */
24361
24712
  moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleOutputDTOAPI, any>>;
24362
24713
  /**
24363
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
24364
- * @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
24365
24716
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
24366
24717
  * @param {*} [options] Override http request option.
24367
24718
  * @throws {RequiredError}
@@ -24369,8 +24720,8 @@ export declare class ModuleApi extends BaseAPI {
24369
24720
  */
24370
24721
  moduleInstallationsControllerGetInstalledModules(moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>;
24371
24722
  /**
24372
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
24373
- * @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
24374
24725
  * @param {string} moduleId
24375
24726
  * @param {string} gameServerId
24376
24727
  * @param {*} [options] Override http request option.
@@ -24379,8 +24730,8 @@ export declare class ModuleApi extends BaseAPI {
24379
24730
  */
24380
24731
  moduleInstallationsControllerGetModuleInstallation(moduleId: string, gameServerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleInstallationOutputDTOAPI, any>>;
24381
24732
  /**
24382
- * 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`
24383
- * @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
24384
24735
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
24385
24736
  * @param {*} [options] Override http request option.
24386
24737
  * @throws {RequiredError}
@@ -24389,7 +24740,7 @@ export declare class ModuleApi extends BaseAPI {
24389
24740
  moduleInstallationsControllerInstallModule(installModuleDTO?: InstallModuleDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModuleInstallationOutputDTOAPI, any>>;
24390
24741
  /**
24391
24742
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
24392
- * @summary Uninstall module
24743
+ * @summary Uninstall a module from a game server
24393
24744
  * @param {string} moduleId
24394
24745
  * @param {string} gameServerId
24395
24746
  * @param {*} [options] Override http request option.
@@ -24472,8 +24823,8 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24472
24823
  */
24473
24824
  banControllerUpdate: (id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24474
24825
  /**
24475
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24476
- * @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
24477
24828
  * @param {string} id
24478
24829
  * @param {string} roleId
24479
24830
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24482,8 +24833,8 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24482
24833
  */
24483
24834
  playerControllerAssignRole: (id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24484
24835
  /**
24485
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24486
- * @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
24487
24838
  * @param {string} roleId
24488
24839
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24489
24840
  * @param {*} [options] Override http request option.
@@ -24491,7 +24842,7 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24491
24842
  */
24492
24843
  playerControllerBulkAssignRole: (roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24493
24844
  /**
24494
- * 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`
24495
24846
  * @summary Bulk delete
24496
24847
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24497
24848
  * @param {*} [options] Override http request option.
@@ -24514,16 +24865,16 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24514
24865
  */
24515
24866
  playerControllerGetMe: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24516
24867
  /**
24517
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24518
- * @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
24519
24870
  * @param {string} id
24520
24871
  * @param {*} [options] Override http request option.
24521
24872
  * @throws {RequiredError}
24522
24873
  */
24523
24874
  playerControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24524
24875
  /**
24525
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24526
- * @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
24527
24878
  * @param {string} id
24528
24879
  * @param {string} roleId
24529
24880
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24532,8 +24883,8 @@ export declare const PlayerApiAxiosParamCreator: (configuration?: Configuration)
24532
24883
  */
24533
24884
  playerControllerRemoveRole: (id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24534
24885
  /**
24535
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24536
- * @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
24537
24888
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24538
24889
  * @param {*} [options] Override http request option.
24539
24890
  * @throws {RequiredError}
@@ -24587,8 +24938,8 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24587
24938
  */
24588
24939
  banControllerUpdate(id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>>;
24589
24940
  /**
24590
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24591
- * @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
24592
24943
  * @param {string} id
24593
24944
  * @param {string} roleId
24594
24945
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24597,8 +24948,8 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24597
24948
  */
24598
24949
  playerControllerAssignRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
24599
24950
  /**
24600
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24601
- * @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
24602
24953
  * @param {string} roleId
24603
24954
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24604
24955
  * @param {*} [options] Override http request option.
@@ -24606,7 +24957,7 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24606
24957
  */
24607
24958
  playerControllerBulkAssignRole(roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerBulkAssignRoleOutputDTOAPI>>;
24608
24959
  /**
24609
- * 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`
24610
24961
  * @summary Bulk delete
24611
24962
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24612
24963
  * @param {*} [options] Override http request option.
@@ -24629,16 +24980,16 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24629
24980
  */
24630
24981
  playerControllerGetMe(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerMeOutputDTO>>;
24631
24982
  /**
24632
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24633
- * @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
24634
24985
  * @param {string} id
24635
24986
  * @param {*} [options] Override http request option.
24636
24987
  * @throws {RequiredError}
24637
24988
  */
24638
24989
  playerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOutputWithRolesDTOAPI>>;
24639
24990
  /**
24640
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24641
- * @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
24642
24993
  * @param {string} id
24643
24994
  * @param {string} roleId
24644
24995
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24647,8 +24998,8 @@ export declare const PlayerApiFp: (configuration?: Configuration) => {
24647
24998
  */
24648
24999
  playerControllerRemoveRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
24649
25000
  /**
24650
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24651
- * @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
24652
25003
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24653
25004
  * @param {*} [options] Override http request option.
24654
25005
  * @throws {RequiredError}
@@ -24702,8 +25053,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24702
25053
  */
24703
25054
  banControllerUpdate(id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputDTOAPI>;
24704
25055
  /**
24705
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24706
- * @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
24707
25058
  * @param {string} id
24708
25059
  * @param {string} roleId
24709
25060
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24712,8 +25063,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24712
25063
  */
24713
25064
  playerControllerAssignRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
24714
25065
  /**
24715
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24716
- * @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
24717
25068
  * @param {string} roleId
24718
25069
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24719
25070
  * @param {*} [options] Override http request option.
@@ -24721,7 +25072,7 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24721
25072
  */
24722
25073
  playerControllerBulkAssignRole(roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerBulkAssignRoleOutputDTOAPI>;
24723
25074
  /**
24724
- * 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`
24725
25076
  * @summary Bulk delete
24726
25077
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24727
25078
  * @param {*} [options] Override http request option.
@@ -24744,16 +25095,16 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24744
25095
  */
24745
25096
  playerControllerGetMe(options?: RawAxiosRequestConfig): AxiosPromise<PlayerMeOutputDTO>;
24746
25097
  /**
24747
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24748
- * @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
24749
25100
  * @param {string} id
24750
25101
  * @param {*} [options] Override http request option.
24751
25102
  * @throws {RequiredError}
24752
25103
  */
24753
25104
  playerControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOutputWithRolesDTOAPI>;
24754
25105
  /**
24755
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24756
- * @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
24757
25108
  * @param {string} id
24758
25109
  * @param {string} roleId
24759
25110
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24762,8 +25113,8 @@ export declare const PlayerApiFactory: (configuration?: Configuration, basePath?
24762
25113
  */
24763
25114
  playerControllerRemoveRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
24764
25115
  /**
24765
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24766
- * @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
24767
25118
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24768
25119
  * @param {*} [options] Override http request option.
24769
25120
  * @throws {RequiredError}
@@ -24824,8 +25175,8 @@ export declare class PlayerApi extends BaseAPI {
24824
25175
  */
24825
25176
  banControllerUpdate(id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BanOutputDTOAPI, any>>;
24826
25177
  /**
24827
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
24828
- * @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
24829
25180
  * @param {string} id
24830
25181
  * @param {string} roleId
24831
25182
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24835,8 +25186,8 @@ export declare class PlayerApi extends BaseAPI {
24835
25186
  */
24836
25187
  playerControllerAssignRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
24837
25188
  /**
24838
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
24839
- * @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
24840
25191
  * @param {string} roleId
24841
25192
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
24842
25193
  * @param {*} [options] Override http request option.
@@ -24845,7 +25196,7 @@ export declare class PlayerApi extends BaseAPI {
24845
25196
  */
24846
25197
  playerControllerBulkAssignRole(roleId: string, playerBulkAssignRoleInputDTO?: PlayerBulkAssignRoleInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerBulkAssignRoleOutputDTOAPI, any>>;
24847
25198
  /**
24848
- * 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`
24849
25200
  * @summary Bulk delete
24850
25201
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
24851
25202
  * @param {*} [options] Override http request option.
@@ -24871,8 +25222,8 @@ export declare class PlayerApi extends BaseAPI {
24871
25222
  */
24872
25223
  playerControllerGetMe(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerMeOutputDTO, any>>;
24873
25224
  /**
24874
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
24875
- * @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
24876
25227
  * @param {string} id
24877
25228
  * @param {*} [options] Override http request option.
24878
25229
  * @throws {RequiredError}
@@ -24880,8 +25231,8 @@ export declare class PlayerApi extends BaseAPI {
24880
25231
  */
24881
25232
  playerControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOutputWithRolesDTOAPI, any>>;
24882
25233
  /**
24883
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
24884
- * @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
24885
25236
  * @param {string} id
24886
25237
  * @param {string} roleId
24887
25238
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -24891,8 +25242,8 @@ export declare class PlayerApi extends BaseAPI {
24891
25242
  */
24892
25243
  playerControllerRemoveRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
24893
25244
  /**
24894
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
24895
- * @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
24896
25247
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
24897
25248
  * @param {*} [options] Override http request option.
24898
25249
  * @throws {RequiredError}
@@ -24906,8 +25257,8 @@ export declare class PlayerApi extends BaseAPI {
24906
25257
  */
24907
25258
  export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Configuration) => {
24908
25259
  /**
24909
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
24910
- * @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
24911
25262
  * @param {string} gameServerId
24912
25263
  * @param {string} playerId
24913
25264
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24916,8 +25267,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24916
25267
  */
24917
25268
  playerOnGameServerControllerAddCurrency: (gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24918
25269
  /**
24919
- * 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`
24920
- * @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
24921
25272
  * @param {string} gameServerId
24922
25273
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
24923
25274
  * @param {*} [options] Override http request option.
@@ -24926,7 +25277,7 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24926
25277
  playerOnGameServerControllerBulkAddCurrency: (gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24927
25278
  /**
24928
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`
24929
- * @summary Bulk delete
25280
+ * @summary Permanently delete several players\' records and their history
24930
25281
  * @param {string} gameServerId
24931
25282
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
24932
25283
  * @param {*} [options] Override http request option.
@@ -24934,8 +25285,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24934
25285
  */
24935
25286
  playerOnGameServerControllerBulkDelete: (gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24936
25287
  /**
24937
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
24938
- * @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
24939
25290
  * @param {string} gameServerId
24940
25291
  * @param {string} playerId
24941
25292
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24944,8 +25295,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24944
25295
  */
24945
25296
  playerOnGameServerControllerDeductCurrency: (gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24946
25297
  /**
24947
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
24948
- * @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
24949
25300
  * @param {string} gameServerId
24950
25301
  * @param {string} playerId
24951
25302
  * @param {*} [options] Override http request option.
@@ -24953,8 +25304,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24953
25304
  */
24954
25305
  playerOnGameServerControllerDelete: (gameServerId: string, playerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24955
25306
  /**
24956
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
24957
- * @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
24958
25309
  * @param {string} gameServerId
24959
25310
  * @param {string} playerId
24960
25311
  * @param {*} [options] Override http request option.
@@ -24962,16 +25313,16 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24962
25313
  */
24963
25314
  playerOnGameServerControllerGetOne: (gameServerId: string, playerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24964
25315
  /**
24965
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
24966
- * @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
24967
25318
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
24968
25319
  * @param {*} [options] Override http request option.
24969
25320
  * @throws {RequiredError}
24970
25321
  */
24971
25322
  playerOnGameServerControllerSearch: (playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24972
25323
  /**
24973
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
24974
- * @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
24975
25326
  * @param {string} gameServerId
24976
25327
  * @param {string} playerId
24977
25328
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -24980,8 +25331,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24980
25331
  */
24981
25332
  playerOnGameServerControllerSetCurrency: (gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
24982
25333
  /**
24983
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
24984
- * @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
24985
25336
  * @param {string} gameServerId
24986
25337
  * @param {string} sender
24987
25338
  * @param {string} receiver
@@ -24997,8 +25348,8 @@ export declare const PlayerOnGameServerApiAxiosParamCreator: (configuration?: Co
24997
25348
  */
24998
25349
  export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) => {
24999
25350
  /**
25000
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25001
- * @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
25002
25353
  * @param {string} gameServerId
25003
25354
  * @param {string} playerId
25004
25355
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25007,8 +25358,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25007
25358
  */
25008
25359
  playerOnGameServerControllerAddCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
25009
25360
  /**
25010
- * 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`
25011
- * @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
25012
25363
  * @param {string} gameServerId
25013
25364
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
25014
25365
  * @param {*} [options] Override http request option.
@@ -25017,7 +25368,7 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25017
25368
  playerOnGameServerControllerBulkAddCurrency(gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PogBulkAddCurrencyOutputDTOAPI>>;
25018
25369
  /**
25019
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`
25020
- * @summary Bulk delete
25371
+ * @summary Permanently delete several players\' records and their history
25021
25372
  * @param {string} gameServerId
25022
25373
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
25023
25374
  * @param {*} [options] Override http request option.
@@ -25025,8 +25376,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25025
25376
  */
25026
25377
  playerOnGameServerControllerBulkDelete(gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PogBulkDeleteOutputDTOAPI>>;
25027
25378
  /**
25028
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25029
- * @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
25030
25381
  * @param {string} gameServerId
25031
25382
  * @param {string} playerId
25032
25383
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25035,8 +25386,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25035
25386
  */
25036
25387
  playerOnGameServerControllerDeductCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
25037
25388
  /**
25038
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25039
- * @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
25040
25391
  * @param {string} gameServerId
25041
25392
  * @param {string} playerId
25042
25393
  * @param {*} [options] Override http request option.
@@ -25044,8 +25395,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25044
25395
  */
25045
25396
  playerOnGameServerControllerDelete(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>;
25046
25397
  /**
25047
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25048
- * @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
25049
25400
  * @param {string} gameServerId
25050
25401
  * @param {string} playerId
25051
25402
  * @param {*} [options] Override http request option.
@@ -25053,16 +25404,16 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25053
25404
  */
25054
25405
  playerOnGameServerControllerGetOne(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
25055
25406
  /**
25056
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25057
- * @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
25058
25409
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
25059
25410
  * @param {*} [options] Override http request option.
25060
25411
  * @throws {RequiredError}
25061
25412
  */
25062
25413
  playerOnGameServerControllerSearch(playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>>;
25063
25414
  /**
25064
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25065
- * @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
25066
25417
  * @param {string} gameServerId
25067
25418
  * @param {string} playerId
25068
25419
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25071,8 +25422,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25071
25422
  */
25072
25423
  playerOnGameServerControllerSetCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerOnGameserverOutputDTOAPI>>;
25073
25424
  /**
25074
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25075
- * @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
25076
25427
  * @param {string} gameServerId
25077
25428
  * @param {string} sender
25078
25429
  * @param {string} receiver
@@ -25088,8 +25439,8 @@ export declare const PlayerOnGameServerApiFp: (configuration?: Configuration) =>
25088
25439
  */
25089
25440
  export declare const PlayerOnGameServerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
25090
25441
  /**
25091
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25092
- * @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
25093
25444
  * @param {string} gameServerId
25094
25445
  * @param {string} playerId
25095
25446
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25098,8 +25449,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25098
25449
  */
25099
25450
  playerOnGameServerControllerAddCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25100
25451
  /**
25101
- * 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`
25102
- * @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
25103
25454
  * @param {string} gameServerId
25104
25455
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
25105
25456
  * @param {*} [options] Override http request option.
@@ -25108,7 +25459,7 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25108
25459
  playerOnGameServerControllerBulkAddCurrency(gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PogBulkAddCurrencyOutputDTOAPI>;
25109
25460
  /**
25110
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`
25111
- * @summary Bulk delete
25462
+ * @summary Permanently delete several players\' records and their history
25112
25463
  * @param {string} gameServerId
25113
25464
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
25114
25465
  * @param {*} [options] Override http request option.
@@ -25116,8 +25467,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25116
25467
  */
25117
25468
  playerOnGameServerControllerBulkDelete(gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PogBulkDeleteOutputDTOAPI>;
25118
25469
  /**
25119
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25120
- * @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
25121
25472
  * @param {string} gameServerId
25122
25473
  * @param {string} playerId
25123
25474
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25126,8 +25477,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25126
25477
  */
25127
25478
  playerOnGameServerControllerDeductCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25128
25479
  /**
25129
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25130
- * @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
25131
25482
  * @param {string} gameServerId
25132
25483
  * @param {string} playerId
25133
25484
  * @param {*} [options] Override http request option.
@@ -25135,8 +25486,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25135
25486
  */
25136
25487
  playerOnGameServerControllerDelete(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
25137
25488
  /**
25138
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25139
- * @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
25140
25491
  * @param {string} gameServerId
25141
25492
  * @param {string} playerId
25142
25493
  * @param {*} [options] Override http request option.
@@ -25144,16 +25495,16 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25144
25495
  */
25145
25496
  playerOnGameServerControllerGetOne(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25146
25497
  /**
25147
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25148
- * @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
25149
25500
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
25150
25501
  * @param {*} [options] Override http request option.
25151
25502
  * @throws {RequiredError}
25152
25503
  */
25153
25504
  playerOnGameServerControllerSearch(playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>;
25154
25505
  /**
25155
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25156
- * @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
25157
25508
  * @param {string} gameServerId
25158
25509
  * @param {string} playerId
25159
25510
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25162,8 +25513,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25162
25513
  */
25163
25514
  playerOnGameServerControllerSetCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
25164
25515
  /**
25165
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25166
- * @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
25167
25518
  * @param {string} gameServerId
25168
25519
  * @param {string} sender
25169
25520
  * @param {string} receiver
@@ -25181,8 +25532,8 @@ export declare const PlayerOnGameServerApiFactory: (configuration?: Configuratio
25181
25532
  */
25182
25533
  export declare class PlayerOnGameServerApi extends BaseAPI {
25183
25534
  /**
25184
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
25185
- * @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
25186
25537
  * @param {string} gameServerId
25187
25538
  * @param {string} playerId
25188
25539
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25192,8 +25543,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25192
25543
  */
25193
25544
  playerOnGameServerControllerAddCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25194
25545
  /**
25195
- * 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`
25196
- * @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
25197
25548
  * @param {string} gameServerId
25198
25549
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
25199
25550
  * @param {*} [options] Override http request option.
@@ -25203,7 +25554,7 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25203
25554
  playerOnGameServerControllerBulkAddCurrency(gameServerId: string, pogBulkAddCurrencyInputDTO?: PogBulkAddCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PogBulkAddCurrencyOutputDTOAPI, any>>;
25204
25555
  /**
25205
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`
25206
- * @summary Bulk delete
25557
+ * @summary Permanently delete several players\' records and their history
25207
25558
  * @param {string} gameServerId
25208
25559
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
25209
25560
  * @param {*} [options] Override http request option.
@@ -25212,8 +25563,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25212
25563
  */
25213
25564
  playerOnGameServerControllerBulkDelete(gameServerId: string, pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PogBulkDeleteOutputDTOAPI, any>>;
25214
25565
  /**
25215
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
25216
- * @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
25217
25568
  * @param {string} gameServerId
25218
25569
  * @param {string} playerId
25219
25570
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25223,8 +25574,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25223
25574
  */
25224
25575
  playerOnGameServerControllerDeductCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25225
25576
  /**
25226
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
25227
- * @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
25228
25579
  * @param {string} gameServerId
25229
25580
  * @param {string} playerId
25230
25581
  * @param {*} [options] Override http request option.
@@ -25233,8 +25584,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25233
25584
  */
25234
25585
  playerOnGameServerControllerDelete(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<APIOutput, any>>;
25235
25586
  /**
25236
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
25237
- * @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
25238
25589
  * @param {string} gameServerId
25239
25590
  * @param {string} playerId
25240
25591
  * @param {*} [options] Override http request option.
@@ -25243,8 +25594,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25243
25594
  */
25244
25595
  playerOnGameServerControllerGetOne(gameServerId: string, playerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25245
25596
  /**
25246
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
25247
- * @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
25248
25599
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
25249
25600
  * @param {*} [options] Override http request option.
25250
25601
  * @throws {RequiredError}
@@ -25252,8 +25603,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25252
25603
  */
25253
25604
  playerOnGameServerControllerSearch(playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>;
25254
25605
  /**
25255
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
25256
- * @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
25257
25608
  * @param {string} gameServerId
25258
25609
  * @param {string} playerId
25259
25610
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -25263,8 +25614,8 @@ export declare class PlayerOnGameServerApi extends BaseAPI {
25263
25614
  */
25264
25615
  playerOnGameServerControllerSetCurrency(gameServerId: string, playerId: string, playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>;
25265
25616
  /**
25266
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
25267
- * @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
25268
25619
  * @param {string} gameServerId
25269
25620
  * @param {string} sender
25270
25621
  * @param {string} receiver
@@ -25488,8 +25839,8 @@ export declare const RoleApiAxiosParamCreator: (configuration?: Configuration) =
25488
25839
  */
25489
25840
  roleControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
25490
25841
  /**
25491
- * <br> OperationId: `RoleControllerGetPermissions`
25492
- * @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
25493
25844
  * @param {*} [options] Override http request option.
25494
25845
  * @throws {RequiredError}
25495
25846
  */
@@ -25542,8 +25893,8 @@ export declare const RoleApiFp: (configuration?: Configuration) => {
25542
25893
  */
25543
25894
  roleControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoleOutputDTOAPI>>;
25544
25895
  /**
25545
- * <br> OperationId: `RoleControllerGetPermissions`
25546
- * @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
25547
25898
  * @param {*} [options] Override http request option.
25548
25899
  * @throws {RequiredError}
25549
25900
  */
@@ -25596,8 +25947,8 @@ export declare const RoleApiFactory: (configuration?: Configuration, basePath?:
25596
25947
  */
25597
25948
  roleControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<RoleOutputDTOAPI>;
25598
25949
  /**
25599
- * <br> OperationId: `RoleControllerGetPermissions`
25600
- * @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
25601
25952
  * @param {*} [options] Override http request option.
25602
25953
  * @throws {RequiredError}
25603
25954
  */
@@ -25654,8 +26005,8 @@ export declare class RoleApi extends BaseAPI {
25654
26005
  */
25655
26006
  roleControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleOutputDTOAPI, any>>;
25656
26007
  /**
25657
- * <br> OperationId: `RoleControllerGetPermissions`
25658
- * @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
25659
26010
  * @param {*} [options] Override http request option.
25660
26011
  * @throws {RequiredError}
25661
26012
  * @memberof RoleApi
@@ -26156,7 +26507,7 @@ export declare class ShopActionApi extends BaseAPI {
26156
26507
  */
26157
26508
  export declare const ShopCategoryApiAxiosParamCreator: (configuration?: Configuration) => {
26158
26509
  /**
26159
- * 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`
26160
26511
  * @summary Bulk assign
26161
26512
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26162
26513
  * @param {*} [options] Override http request option.
@@ -26229,7 +26580,7 @@ export declare const ShopCategoryApiAxiosParamCreator: (configuration?: Configur
26229
26580
  */
26230
26581
  export declare const ShopCategoryApiFp: (configuration?: Configuration) => {
26231
26582
  /**
26232
- * 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`
26233
26584
  * @summary Bulk assign
26234
26585
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26235
26586
  * @param {*} [options] Override http request option.
@@ -26302,7 +26653,7 @@ export declare const ShopCategoryApiFp: (configuration?: Configuration) => {
26302
26653
  */
26303
26654
  export declare const ShopCategoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
26304
26655
  /**
26305
- * 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`
26306
26657
  * @summary Bulk assign
26307
26658
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26308
26659
  * @param {*} [options] Override http request option.
@@ -26377,7 +26728,7 @@ export declare const ShopCategoryApiFactory: (configuration?: Configuration, bas
26377
26728
  */
26378
26729
  export declare class ShopCategoryApi extends BaseAPI {
26379
26730
  /**
26380
- * 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`
26381
26732
  * @summary Bulk assign
26382
26733
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
26383
26734
  * @param {*} [options] Override http request option.
@@ -26457,6 +26808,14 @@ export declare class ShopCategoryApi extends BaseAPI {
26457
26808
  * @export
26458
26809
  */
26459
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>;
26460
26819
  /**
26461
26820
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26462
26821
  * @summary Create
@@ -26511,6 +26870,14 @@ export declare const ShopListingApiAxiosParamCreator: (configuration?: Configura
26511
26870
  * @export
26512
26871
  */
26513
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>>;
26514
26881
  /**
26515
26882
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26516
26883
  * @summary Create
@@ -26565,6 +26932,14 @@ export declare const ShopListingApiFp: (configuration?: Configuration) => {
26565
26932
  * @export
26566
26933
  */
26567
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>;
26568
26943
  /**
26569
26944
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26570
26945
  * @summary Create
@@ -26621,6 +26996,15 @@ export declare const ShopListingApiFactory: (configuration?: Configuration, base
26621
26996
  * @extends {BaseAPI}
26622
26997
  */
26623
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>>;
26624
27008
  /**
26625
27009
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
26626
27010
  * @summary Create
@@ -26887,6 +27271,15 @@ export declare const StorefrontConfigApiAxiosParamCreator: (configuration?: Conf
26887
27271
  * @throws {RequiredError}
26888
27272
  */
26889
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>;
26890
27283
  /**
26891
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`
26892
27285
  * @summary Set config
@@ -26917,6 +27310,15 @@ export declare const StorefrontConfigApiFp: (configuration?: Configuration) => {
26917
27310
  * @throws {RequiredError}
26918
27311
  */
26919
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>>;
26920
27322
  /**
26921
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`
26922
27324
  * @summary Set config
@@ -26947,6 +27349,15 @@ export declare const StorefrontConfigApiFactory: (configuration?: Configuration,
26947
27349
  * @throws {RequiredError}
26948
27350
  */
26949
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>;
26950
27361
  /**
26951
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`
26952
27363
  * @summary Set config
@@ -26981,6 +27392,16 @@ export declare class StorefrontConfigApi extends BaseAPI {
26981
27392
  * @memberof StorefrontConfigApi
26982
27393
  */
26983
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>>;
26984
27405
  /**
26985
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`
26986
27407
  * @summary Set config
@@ -27713,6 +28134,14 @@ export declare class UserApi extends BaseAPI {
27713
28134
  * @export
27714
28135
  */
27715
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>;
27716
28145
  /**
27717
28146
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27718
28147
  * @summary Create
@@ -27760,6 +28189,14 @@ export declare const VariableApiAxiosParamCreator: (configuration?: Configuratio
27760
28189
  * @export
27761
28190
  */
27762
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>>;
27763
28200
  /**
27764
28201
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27765
28202
  * @summary Create
@@ -27807,6 +28244,14 @@ export declare const VariableApiFp: (configuration?: Configuration) => {
27807
28244
  * @export
27808
28245
  */
27809
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>;
27810
28255
  /**
27811
28256
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27812
28257
  * @summary Create
@@ -27856,6 +28301,15 @@ export declare const VariableApiFactory: (configuration?: Configuration, basePat
27856
28301
  * @extends {BaseAPI}
27857
28302
  */
27858
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>>;
27859
28313
  /**
27860
28314
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
27861
28315
  * @summary Create