@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.
@@ -831,6 +831,10 @@ export const PlayerOnGameServerSearchInputDTOSortDirectionEnum = {
831
831
  Asc: 'asc',
832
832
  Desc: 'desc',
833
833
  };
834
+ export const PlayerSearchInputAllowedFiltersRoleAssignmentScopeEnum = {
835
+ Global: 'global',
836
+ GameServer: 'gameServer',
837
+ };
834
838
  export const PlayerSearchInputDTOExtendEnum = {
835
839
  PlayerOnGameServers: 'playerOnGameServers',
836
840
  Roles: 'roles',
@@ -880,6 +884,11 @@ export const ShopCategorySearchInputDTOSortDirectionEnum = {
880
884
  Asc: 'asc',
881
885
  Desc: 'desc',
882
886
  };
887
+ export const ShopListingBulkInputDTOActionEnum = {
888
+ Delete: 'delete',
889
+ Publish: 'publish',
890
+ Unpublish: 'unpublish',
891
+ };
883
892
  export const ShopListingSearchInputDTOExtendEnum = {
884
893
  GameServer: 'gameServer',
885
894
  Items: 'items',
@@ -5417,8 +5426,8 @@ export class CommandApi extends BaseAPI {
5417
5426
  export const CronJobApiAxiosParamCreator = function (configuration) {
5418
5427
  return {
5419
5428
  /**
5420
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5421
- * @summary Create
5429
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5430
+ * @summary Create a cron job
5422
5431
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
5423
5432
  * @param {*} [options] Override http request option.
5424
5433
  * @throws {RequiredError}
@@ -5446,8 +5455,8 @@ export const CronJobApiAxiosParamCreator = function (configuration) {
5446
5455
  };
5447
5456
  },
5448
5457
  /**
5449
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
5450
- * @summary Get executions
5458
+ * 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`
5459
+ * @summary Get the execution history of a cron job
5451
5460
  * @param {string} id
5452
5461
  * @param {any} [success]
5453
5462
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -5484,8 +5493,8 @@ export const CronJobApiAxiosParamCreator = function (configuration) {
5484
5493
  };
5485
5494
  },
5486
5495
  /**
5487
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5488
- * @summary Get one
5496
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5497
+ * @summary Get one cron job
5489
5498
  * @param {string} id
5490
5499
  * @param {*} [options] Override http request option.
5491
5500
  * @throws {RequiredError}
@@ -5513,8 +5522,8 @@ export const CronJobApiAxiosParamCreator = function (configuration) {
5513
5522
  };
5514
5523
  },
5515
5524
  /**
5516
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5517
- * @summary Remove
5525
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5526
+ * @summary Delete a cron job
5518
5527
  * @param {string} id
5519
5528
  * @param {*} [options] Override http request option.
5520
5529
  * @throws {RequiredError}
@@ -5542,8 +5551,8 @@ export const CronJobApiAxiosParamCreator = function (configuration) {
5542
5551
  };
5543
5552
  },
5544
5553
  /**
5545
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
5546
- * @summary Search
5554
+ * 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`
5555
+ * @summary Search cron jobs
5547
5556
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
5548
5557
  * @param {*} [options] Override http request option.
5549
5558
  * @throws {RequiredError}
@@ -5571,8 +5580,8 @@ export const CronJobApiAxiosParamCreator = function (configuration) {
5571
5580
  };
5572
5581
  },
5573
5582
  /**
5574
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
5575
- * @summary Trigger
5583
+ * 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`
5584
+ * @summary Trigger a cron job manually
5576
5585
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
5577
5586
  * @param {*} [options] Override http request option.
5578
5587
  * @throws {RequiredError}
@@ -5600,8 +5609,8 @@ export const CronJobApiAxiosParamCreator = function (configuration) {
5600
5609
  };
5601
5610
  },
5602
5611
  /**
5603
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5604
- * @summary Update
5612
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5613
+ * @summary Update a cron job
5605
5614
  * @param {string} id
5606
5615
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
5607
5616
  * @param {*} [options] Override http request option.
@@ -5641,8 +5650,8 @@ export const CronJobApiFp = function (configuration) {
5641
5650
  const localVarAxiosParamCreator = CronJobApiAxiosParamCreator(configuration);
5642
5651
  return {
5643
5652
  /**
5644
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5645
- * @summary Create
5653
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5654
+ * @summary Create a cron job
5646
5655
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
5647
5656
  * @param {*} [options] Override http request option.
5648
5657
  * @throws {RequiredError}
@@ -5654,8 +5663,8 @@ export const CronJobApiFp = function (configuration) {
5654
5663
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5655
5664
  },
5656
5665
  /**
5657
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
5658
- * @summary Get executions
5666
+ * 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`
5667
+ * @summary Get the execution history of a cron job
5659
5668
  * @param {string} id
5660
5669
  * @param {any} [success]
5661
5670
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -5669,8 +5678,8 @@ export const CronJobApiFp = function (configuration) {
5669
5678
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5670
5679
  },
5671
5680
  /**
5672
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5673
- * @summary Get one
5681
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5682
+ * @summary Get one cron job
5674
5683
  * @param {string} id
5675
5684
  * @param {*} [options] Override http request option.
5676
5685
  * @throws {RequiredError}
@@ -5682,8 +5691,8 @@ export const CronJobApiFp = function (configuration) {
5682
5691
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5683
5692
  },
5684
5693
  /**
5685
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5686
- * @summary Remove
5694
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5695
+ * @summary Delete a cron job
5687
5696
  * @param {string} id
5688
5697
  * @param {*} [options] Override http request option.
5689
5698
  * @throws {RequiredError}
@@ -5695,8 +5704,8 @@ export const CronJobApiFp = function (configuration) {
5695
5704
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5696
5705
  },
5697
5706
  /**
5698
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
5699
- * @summary Search
5707
+ * 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`
5708
+ * @summary Search cron jobs
5700
5709
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
5701
5710
  * @param {*} [options] Override http request option.
5702
5711
  * @throws {RequiredError}
@@ -5708,8 +5717,8 @@ export const CronJobApiFp = function (configuration) {
5708
5717
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5709
5718
  },
5710
5719
  /**
5711
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
5712
- * @summary Trigger
5720
+ * 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`
5721
+ * @summary Trigger a cron job manually
5713
5722
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
5714
5723
  * @param {*} [options] Override http request option.
5715
5724
  * @throws {RequiredError}
@@ -5721,8 +5730,8 @@ export const CronJobApiFp = function (configuration) {
5721
5730
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5722
5731
  },
5723
5732
  /**
5724
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5725
- * @summary Update
5733
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5734
+ * @summary Update a cron job
5726
5735
  * @param {string} id
5727
5736
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
5728
5737
  * @param {*} [options] Override http request option.
@@ -5744,8 +5753,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5744
5753
  const localVarFp = CronJobApiFp(configuration);
5745
5754
  return {
5746
5755
  /**
5747
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5748
- * @summary Create
5756
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5757
+ * @summary Create a cron job
5749
5758
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
5750
5759
  * @param {*} [options] Override http request option.
5751
5760
  * @throws {RequiredError}
@@ -5754,8 +5763,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5754
5763
  return localVarFp.cronJobControllerCreate(cronJobCreateDTO, options).then((request) => request(axios, basePath));
5755
5764
  },
5756
5765
  /**
5757
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
5758
- * @summary Get executions
5766
+ * 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`
5767
+ * @summary Get the execution history of a cron job
5759
5768
  * @param {string} id
5760
5769
  * @param {any} [success]
5761
5770
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -5768,8 +5777,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5768
5777
  .then((request) => request(axios, basePath));
5769
5778
  },
5770
5779
  /**
5771
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5772
- * @summary Get one
5780
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5781
+ * @summary Get one cron job
5773
5782
  * @param {string} id
5774
5783
  * @param {*} [options] Override http request option.
5775
5784
  * @throws {RequiredError}
@@ -5778,8 +5787,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5778
5787
  return localVarFp.cronJobControllerGetOne(id, options).then((request) => request(axios, basePath));
5779
5788
  },
5780
5789
  /**
5781
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5782
- * @summary Remove
5790
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5791
+ * @summary Delete a cron job
5783
5792
  * @param {string} id
5784
5793
  * @param {*} [options] Override http request option.
5785
5794
  * @throws {RequiredError}
@@ -5788,8 +5797,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5788
5797
  return localVarFp.cronJobControllerRemove(id, options).then((request) => request(axios, basePath));
5789
5798
  },
5790
5799
  /**
5791
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
5792
- * @summary Search
5800
+ * 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`
5801
+ * @summary Search cron jobs
5793
5802
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
5794
5803
  * @param {*} [options] Override http request option.
5795
5804
  * @throws {RequiredError}
@@ -5800,8 +5809,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5800
5809
  .then((request) => request(axios, basePath));
5801
5810
  },
5802
5811
  /**
5803
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
5804
- * @summary Trigger
5812
+ * 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`
5813
+ * @summary Trigger a cron job manually
5805
5814
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
5806
5815
  * @param {*} [options] Override http request option.
5807
5816
  * @throws {RequiredError}
@@ -5812,8 +5821,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5812
5821
  .then((request) => request(axios, basePath));
5813
5822
  },
5814
5823
  /**
5815
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5816
- * @summary Update
5824
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5825
+ * @summary Update a cron job
5817
5826
  * @param {string} id
5818
5827
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
5819
5828
  * @param {*} [options] Override http request option.
@@ -5834,8 +5843,8 @@ export const CronJobApiFactory = function (configuration, basePath, axios) {
5834
5843
  */
5835
5844
  export class CronJobApi extends BaseAPI {
5836
5845
  /**
5837
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5838
- * @summary Create
5846
+ * Adds a cron job to a module version, running a function on a schedule. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerCreate`
5847
+ * @summary Create a cron job
5839
5848
  * @param {CronJobCreateDTO} [cronJobCreateDTO] CronJobCreateDTO
5840
5849
  * @param {*} [options] Override http request option.
5841
5850
  * @throws {RequiredError}
@@ -5847,8 +5856,8 @@ export class CronJobApi extends BaseAPI {
5847
5856
  .then((request) => request(this.axios, this.basePath));
5848
5857
  }
5849
5858
  /**
5850
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetExecutions`
5851
- * @summary Get executions
5859
+ * 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`
5860
+ * @summary Get the execution history of a cron job
5852
5861
  * @param {string} id
5853
5862
  * @param {any} [success]
5854
5863
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
@@ -5862,8 +5871,8 @@ export class CronJobApi extends BaseAPI {
5862
5871
  .then((request) => request(this.axios, this.basePath));
5863
5872
  }
5864
5873
  /**
5865
- * Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5866
- * @summary Get one
5874
+ * Fetch a single cron job with its schedule and the function it runs. Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerGetOne`
5875
+ * @summary Get one cron job
5867
5876
  * @param {string} id
5868
5877
  * @param {*} [options] Override http request option.
5869
5878
  * @throws {RequiredError}
@@ -5875,8 +5884,8 @@ export class CronJobApi extends BaseAPI {
5875
5884
  .then((request) => request(this.axios, this.basePath));
5876
5885
  }
5877
5886
  /**
5878
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5879
- * @summary Remove
5887
+ * Removes a cron job from its module version. Installed game servers stop running it. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerRemove`
5888
+ * @summary Delete a cron job
5880
5889
  * @param {string} id
5881
5890
  * @param {*} [options] Override http request option.
5882
5891
  * @throws {RequiredError}
@@ -5888,8 +5897,8 @@ export class CronJobApi extends BaseAPI {
5888
5897
  .then((request) => request(this.axios, this.basePath));
5889
5898
  }
5890
5899
  /**
5891
- * Search cronjobs Required permissions: `READ_MODULES`<br> OperationId: `CronJobControllerSearch`
5892
- * @summary Search
5900
+ * 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`
5901
+ * @summary Search cron jobs
5893
5902
  * @param {CronJobSearchInputDTO} [cronJobSearchInputDTO] CronJobSearchInputDTO
5894
5903
  * @param {*} [options] Override http request option.
5895
5904
  * @throws {RequiredError}
@@ -5901,8 +5910,8 @@ export class CronJobApi extends BaseAPI {
5901
5910
  .then((request) => request(this.axios, this.basePath));
5902
5911
  }
5903
5912
  /**
5904
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerTrigger`
5905
- * @summary Trigger
5913
+ * 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`
5914
+ * @summary Trigger a cron job manually
5906
5915
  * @param {CronJobTriggerDTO} [cronJobTriggerDTO] CronJobTriggerDTO
5907
5916
  * @param {*} [options] Override http request option.
5908
5917
  * @throws {RequiredError}
@@ -5914,8 +5923,8 @@ export class CronJobApi extends BaseAPI {
5914
5923
  .then((request) => request(this.axios, this.basePath));
5915
5924
  }
5916
5925
  /**
5917
- * Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5918
- * @summary Update
5926
+ * Change a cron job\'s name, schedule or the function it runs. Required permissions: `MANAGE_MODULES`<br> OperationId: `CronJobControllerUpdate`
5927
+ * @summary Update a cron job
5919
5928
  * @param {string} id
5920
5929
  * @param {CronJobUpdateDTO} [cronJobUpdateDTO] CronJobUpdateDTO
5921
5930
  * @param {*} [options] Override http request option.
@@ -7452,8 +7461,8 @@ export const EventApiAxiosParamCreator = function (configuration) {
7452
7461
  };
7453
7462
  },
7454
7463
  /**
7455
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
7456
- * @summary Search
7464
+ * 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`
7465
+ * @summary Find recent activity: chat messages, deaths, connections
7457
7466
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
7458
7467
  * @param {*} [options] Override http request option.
7459
7468
  * @throws {RequiredError}
@@ -7568,8 +7577,8 @@ export const EventApiFp = function (configuration) {
7568
7577
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7569
7578
  },
7570
7579
  /**
7571
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
7572
- * @summary Search
7580
+ * 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`
7581
+ * @summary Find recent activity: chat messages, deaths, connections
7573
7582
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
7574
7583
  * @param {*} [options] Override http request option.
7575
7584
  * @throws {RequiredError}
@@ -7656,8 +7665,8 @@ export const EventApiFactory = function (configuration, basePath, axios) {
7656
7665
  return localVarFp.eventControllerGetOne(id, options).then((request) => request(axios, basePath));
7657
7666
  },
7658
7667
  /**
7659
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
7660
- * @summary Search
7668
+ * 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`
7669
+ * @summary Find recent activity: chat messages, deaths, connections
7661
7670
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
7662
7671
  * @param {*} [options] Override http request option.
7663
7672
  * @throws {RequiredError}
@@ -7753,8 +7762,8 @@ export class EventApi extends BaseAPI {
7753
7762
  .then((request) => request(this.axios, this.basePath));
7754
7763
  }
7755
7764
  /**
7756
- * Search events Required permissions: `READ_EVENTS`<br> OperationId: `EventControllerSearch`
7757
- * @summary Search
7765
+ * 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`
7766
+ * @summary Find recent activity: chat messages, deaths, connections
7758
7767
  * @param {EventSearchInputDTO} [eventSearchInputDTO] EventSearchInputDTO
7759
7768
  * @param {*} [options] Override http request option.
7760
7769
  * @throws {RequiredError}
@@ -8568,7 +8577,7 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
8568
8577
  },
8569
8578
  /**
8570
8579
  * 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`
8571
- * @summary Get players
8580
+ * @summary List the players currently online on a game server
8572
8581
  * @param {string} id
8573
8582
  * @param {*} [options] Override http request option.
8574
8583
  * @deprecated
@@ -8964,8 +8973,8 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
8964
8973
  };
8965
8974
  },
8966
8975
  /**
8967
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
8968
- * @summary Test reachability
8976
+ * 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`
8977
+ * @summary Test connection settings before creating a game server
8969
8978
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
8970
8979
  * @param {*} [options] Override http request option.
8971
8980
  * @throws {RequiredError}
@@ -8993,8 +9002,8 @@ export const GameServerApiAxiosParamCreator = function (configuration) {
8993
9002
  };
8994
9003
  },
8995
9004
  /**
8996
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
8997
- * @summary Test reachability for id
9005
+ * 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`
9006
+ * @summary Test whether an existing game server is reachable
8998
9007
  * @param {string} id
8999
9008
  * @param {*} [options] Override http request option.
9000
9009
  * @throws {RequiredError}
@@ -9246,7 +9255,7 @@ export const GameServerApiFp = function (configuration) {
9246
9255
  },
9247
9256
  /**
9248
9257
  * 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`
9249
- * @summary Get players
9258
+ * @summary List the players currently online on a game server
9250
9259
  * @param {string} id
9251
9260
  * @param {*} [options] Override http request option.
9252
9261
  * @deprecated
@@ -9420,8 +9429,8 @@ export const GameServerApiFp = function (configuration) {
9420
9429
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9421
9430
  },
9422
9431
  /**
9423
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
9424
- * @summary Test reachability
9432
+ * 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`
9433
+ * @summary Test connection settings before creating a game server
9425
9434
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
9426
9435
  * @param {*} [options] Override http request option.
9427
9436
  * @throws {RequiredError}
@@ -9433,8 +9442,8 @@ export const GameServerApiFp = function (configuration) {
9433
9442
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9434
9443
  },
9435
9444
  /**
9436
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
9437
- * @summary Test reachability for id
9445
+ * 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`
9446
+ * @summary Test whether an existing game server is reachable
9438
9447
  * @param {string} id
9439
9448
  * @param {*} [options] Override http request option.
9440
9449
  * @throws {RequiredError}
@@ -9597,7 +9606,7 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
9597
9606
  },
9598
9607
  /**
9599
9608
  * 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`
9600
- * @summary Get players
9609
+ * @summary List the players currently online on a game server
9601
9610
  * @param {string} id
9602
9611
  * @param {*} [options] Override http request option.
9603
9612
  * @deprecated
@@ -9744,8 +9753,8 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
9744
9753
  .then((request) => request(axios, basePath));
9745
9754
  },
9746
9755
  /**
9747
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
9748
- * @summary Test reachability
9756
+ * 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`
9757
+ * @summary Test connection settings before creating a game server
9749
9758
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
9750
9759
  * @param {*} [options] Override http request option.
9751
9760
  * @throws {RequiredError}
@@ -9756,8 +9765,8 @@ export const GameServerApiFactory = function (configuration, basePath, axios) {
9756
9765
  .then((request) => request(axios, basePath));
9757
9766
  },
9758
9767
  /**
9759
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
9760
- * @summary Test reachability for id
9768
+ * 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`
9769
+ * @summary Test whether an existing game server is reachable
9761
9770
  * @param {string} id
9762
9771
  * @param {*} [options] Override http request option.
9763
9772
  * @throws {RequiredError}
@@ -9929,7 +9938,7 @@ export class GameServerApi extends BaseAPI {
9929
9938
  }
9930
9939
  /**
9931
9940
  * 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`
9932
- * @summary Get players
9941
+ * @summary List the players currently online on a game server
9933
9942
  * @param {string} id
9934
9943
  * @param {*} [options] Override http request option.
9935
9944
  * @deprecated
@@ -10103,8 +10112,8 @@ export class GameServerApi extends BaseAPI {
10103
10112
  .then((request) => request(this.axios, this.basePath));
10104
10113
  }
10105
10114
  /**
10106
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachability`
10107
- * @summary Test reachability
10115
+ * 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`
10116
+ * @summary Test connection settings before creating a game server
10108
10117
  * @param {GameServerTestReachabilityInputDTO} [gameServerTestReachabilityInputDTO] GameServerTestReachabilityInputDTO
10109
10118
  * @param {*} [options] Override http request option.
10110
10119
  * @throws {RequiredError}
@@ -10116,8 +10125,8 @@ export class GameServerApi extends BaseAPI {
10116
10125
  .then((request) => request(this.axios, this.basePath));
10117
10126
  }
10118
10127
  /**
10119
- * Test if Takaro can connect to a gameserver. Will do a thorough check and report details.<br> OperationId: `GameServerControllerTestReachabilityForId`
10120
- * @summary Test reachability for id
10128
+ * 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`
10129
+ * @summary Test whether an existing game server is reachable
10121
10130
  * @param {string} id
10122
10131
  * @param {*} [options] Override http request option.
10123
10132
  * @throws {RequiredError}
@@ -11867,8 +11876,8 @@ export const ModuleApiAxiosParamCreator = function (configuration) {
11867
11876
  };
11868
11877
  },
11869
11878
  /**
11870
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
11871
- * @summary Search module installations
11879
+ * 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`
11880
+ * @summary List the modules installed on a game server
11872
11881
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
11873
11882
  * @param {*} [options] Override http request option.
11874
11883
  * @throws {RequiredError}
@@ -11896,8 +11905,8 @@ export const ModuleApiAxiosParamCreator = function (configuration) {
11896
11905
  };
11897
11906
  },
11898
11907
  /**
11899
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
11900
- * @summary Get one installation
11908
+ * 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`
11909
+ * @summary Get one module installation
11901
11910
  * @param {string} moduleId
11902
11911
  * @param {string} gameServerId
11903
11912
  * @param {*} [options] Override http request option.
@@ -11930,8 +11939,8 @@ export const ModuleApiAxiosParamCreator = function (configuration) {
11930
11939
  };
11931
11940
  },
11932
11941
  /**
11933
- * 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`
11934
- * @summary Install module
11942
+ * 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`
11943
+ * @summary Install a module on a game server
11935
11944
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
11936
11945
  * @param {*} [options] Override http request option.
11937
11946
  * @throws {RequiredError}
@@ -11960,7 +11969,7 @@ export const ModuleApiAxiosParamCreator = function (configuration) {
11960
11969
  },
11961
11970
  /**
11962
11971
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
11963
- * @summary Uninstall module
11972
+ * @summary Uninstall a module from a game server
11964
11973
  * @param {string} moduleId
11965
11974
  * @param {string} gameServerId
11966
11975
  * @param {*} [options] Override http request option.
@@ -12182,8 +12191,8 @@ export const ModuleApiFp = function (configuration) {
12182
12191
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12183
12192
  },
12184
12193
  /**
12185
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
12186
- * @summary Search module installations
12194
+ * 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`
12195
+ * @summary List the modules installed on a game server
12187
12196
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
12188
12197
  * @param {*} [options] Override http request option.
12189
12198
  * @throws {RequiredError}
@@ -12196,8 +12205,8 @@ export const ModuleApiFp = function (configuration) {
12196
12205
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12197
12206
  },
12198
12207
  /**
12199
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
12200
- * @summary Get one installation
12208
+ * 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`
12209
+ * @summary Get one module installation
12201
12210
  * @param {string} moduleId
12202
12211
  * @param {string} gameServerId
12203
12212
  * @param {*} [options] Override http request option.
@@ -12210,8 +12219,8 @@ export const ModuleApiFp = function (configuration) {
12210
12219
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12211
12220
  },
12212
12221
  /**
12213
- * 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`
12214
- * @summary Install module
12222
+ * 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`
12223
+ * @summary Install a module on a game server
12215
12224
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
12216
12225
  * @param {*} [options] Override http request option.
12217
12226
  * @throws {RequiredError}
@@ -12224,7 +12233,7 @@ export const ModuleApiFp = function (configuration) {
12224
12233
  },
12225
12234
  /**
12226
12235
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
12227
- * @summary Uninstall module
12236
+ * @summary Uninstall a module from a game server
12228
12237
  * @param {string} moduleId
12229
12238
  * @param {string} gameServerId
12230
12239
  * @param {*} [options] Override http request option.
@@ -12364,8 +12373,8 @@ export const ModuleApiFactory = function (configuration, basePath, axios) {
12364
12373
  .then((request) => request(axios, basePath));
12365
12374
  },
12366
12375
  /**
12367
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
12368
- * @summary Search module installations
12376
+ * 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`
12377
+ * @summary List the modules installed on a game server
12369
12378
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
12370
12379
  * @param {*} [options] Override http request option.
12371
12380
  * @throws {RequiredError}
@@ -12376,8 +12385,8 @@ export const ModuleApiFactory = function (configuration, basePath, axios) {
12376
12385
  .then((request) => request(axios, basePath));
12377
12386
  },
12378
12387
  /**
12379
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
12380
- * @summary Get one installation
12388
+ * 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`
12389
+ * @summary Get one module installation
12381
12390
  * @param {string} moduleId
12382
12391
  * @param {string} gameServerId
12383
12392
  * @param {*} [options] Override http request option.
@@ -12389,8 +12398,8 @@ export const ModuleApiFactory = function (configuration, basePath, axios) {
12389
12398
  .then((request) => request(axios, basePath));
12390
12399
  },
12391
12400
  /**
12392
- * 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`
12393
- * @summary Install module
12401
+ * 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`
12402
+ * @summary Install a module on a game server
12394
12403
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
12395
12404
  * @param {*} [options] Override http request option.
12396
12405
  * @throws {RequiredError}
@@ -12402,7 +12411,7 @@ export const ModuleApiFactory = function (configuration, basePath, axios) {
12402
12411
  },
12403
12412
  /**
12404
12413
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
12405
- * @summary Uninstall module
12414
+ * @summary Uninstall a module from a game server
12406
12415
  * @param {string} moduleId
12407
12416
  * @param {string} gameServerId
12408
12417
  * @param {*} [options] Override http request option.
@@ -12552,8 +12561,8 @@ export class ModuleApi extends BaseAPI {
12552
12561
  .then((request) => request(this.axios, this.basePath));
12553
12562
  }
12554
12563
  /**
12555
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetInstalledModules`
12556
- * @summary Search module installations
12564
+ * 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`
12565
+ * @summary List the modules installed on a game server
12557
12566
  * @param {ModuleInstallationSearchInputDTO} [moduleInstallationSearchInputDTO] ModuleInstallationSearchInputDTO
12558
12567
  * @param {*} [options] Override http request option.
12559
12568
  * @throws {RequiredError}
@@ -12565,8 +12574,8 @@ export class ModuleApi extends BaseAPI {
12565
12574
  .then((request) => request(this.axios, this.basePath));
12566
12575
  }
12567
12576
  /**
12568
- * Required permissions: `READ_MODULES`<br> OperationId: `ModuleInstallationsControllerGetModuleInstallation`
12569
- * @summary Get one installation
12577
+ * 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`
12578
+ * @summary Get one module installation
12570
12579
  * @param {string} moduleId
12571
12580
  * @param {string} gameServerId
12572
12581
  * @param {*} [options] Override http request option.
@@ -12579,8 +12588,8 @@ export class ModuleApi extends BaseAPI {
12579
12588
  .then((request) => request(this.axios, this.basePath));
12580
12589
  }
12581
12590
  /**
12582
- * 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`
12583
- * @summary Install module
12591
+ * 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`
12592
+ * @summary Install a module on a game server
12584
12593
  * @param {InstallModuleDTO} [installModuleDTO] InstallModuleDTO
12585
12594
  * @param {*} [options] Override http request option.
12586
12595
  * @throws {RequiredError}
@@ -12593,7 +12602,7 @@ export class ModuleApi extends BaseAPI {
12593
12602
  }
12594
12603
  /**
12595
12604
  * Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: `MANAGE_GAMESERVERS`<br> OperationId: `ModuleInstallationsControllerUninstallModule`
12596
- * @summary Uninstall module
12605
+ * @summary Uninstall a module from a game server
12597
12606
  * @param {string} moduleId
12598
12607
  * @param {string} gameServerId
12599
12608
  * @param {*} [options] Override http request option.
@@ -12800,8 +12809,8 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
12800
12809
  };
12801
12810
  },
12802
12811
  /**
12803
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
12804
- * @summary Assign role
12812
+ * 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`
12813
+ * @summary Assign a role to a player
12805
12814
  * @param {string} id
12806
12815
  * @param {string} roleId
12807
12816
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -12837,8 +12846,8 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
12837
12846
  };
12838
12847
  },
12839
12848
  /**
12840
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
12841
- * @summary Bulk assign role
12849
+ * 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`
12850
+ * @summary Assign a role to many players at once
12842
12851
  * @param {string} roleId
12843
12852
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
12844
12853
  * @param {*} [options] Override http request option.
@@ -12869,7 +12878,7 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
12869
12878
  };
12870
12879
  },
12871
12880
  /**
12872
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
12881
+ * 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`
12873
12882
  * @summary Bulk delete
12874
12883
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
12875
12884
  * @param {*} [options] Override http request option.
@@ -12953,8 +12962,8 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
12953
12962
  };
12954
12963
  },
12955
12964
  /**
12956
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
12957
- * @summary Get one
12965
+ * 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`
12966
+ * @summary Get one player
12958
12967
  * @param {string} id
12959
12968
  * @param {*} [options] Override http request option.
12960
12969
  * @throws {RequiredError}
@@ -12982,8 +12991,8 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
12982
12991
  };
12983
12992
  },
12984
12993
  /**
12985
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
12986
- * @summary Remove role
12994
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
12995
+ * @summary Remove a role from a player
12987
12996
  * @param {string} id
12988
12997
  * @param {string} roleId
12989
12998
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -13019,8 +13028,8 @@ export const PlayerApiAxiosParamCreator = function (configuration) {
13019
13028
  };
13020
13029
  },
13021
13030
  /**
13022
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
13023
- * @summary Search
13031
+ * 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`
13032
+ * @summary Find a player by name or platform id
13024
13033
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
13025
13034
  * @param {*} [options] Override http request option.
13026
13035
  * @throws {RequiredError}
@@ -13123,8 +13132,8 @@ export const PlayerApiFp = function (configuration) {
13123
13132
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13124
13133
  },
13125
13134
  /**
13126
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
13127
- * @summary Assign role
13135
+ * 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`
13136
+ * @summary Assign a role to a player
13128
13137
  * @param {string} id
13129
13138
  * @param {string} roleId
13130
13139
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -13138,8 +13147,8 @@ export const PlayerApiFp = function (configuration) {
13138
13147
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13139
13148
  },
13140
13149
  /**
13141
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
13142
- * @summary Bulk assign role
13150
+ * 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`
13151
+ * @summary Assign a role to many players at once
13143
13152
  * @param {string} roleId
13144
13153
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
13145
13154
  * @param {*} [options] Override http request option.
@@ -13152,7 +13161,7 @@ export const PlayerApiFp = function (configuration) {
13152
13161
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13153
13162
  },
13154
13163
  /**
13155
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
13164
+ * 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`
13156
13165
  * @summary Bulk delete
13157
13166
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
13158
13167
  * @param {*} [options] Override http request option.
@@ -13190,8 +13199,8 @@ export const PlayerApiFp = function (configuration) {
13190
13199
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13191
13200
  },
13192
13201
  /**
13193
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
13194
- * @summary Get one
13202
+ * 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`
13203
+ * @summary Get one player
13195
13204
  * @param {string} id
13196
13205
  * @param {*} [options] Override http request option.
13197
13206
  * @throws {RequiredError}
@@ -13203,8 +13212,8 @@ export const PlayerApiFp = function (configuration) {
13203
13212
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13204
13213
  },
13205
13214
  /**
13206
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
13207
- * @summary Remove role
13215
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
13216
+ * @summary Remove a role from a player
13208
13217
  * @param {string} id
13209
13218
  * @param {string} roleId
13210
13219
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -13218,8 +13227,8 @@ export const PlayerApiFp = function (configuration) {
13218
13227
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13219
13228
  },
13220
13229
  /**
13221
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
13222
- * @summary Search
13230
+ * 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`
13231
+ * @summary Find a player by name or platform id
13223
13232
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
13224
13233
  * @param {*} [options] Override http request option.
13225
13234
  * @throws {RequiredError}
@@ -13291,8 +13300,8 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
13291
13300
  return localVarFp.banControllerUpdate(id, banUpdateDTO, options).then((request) => request(axios, basePath));
13292
13301
  },
13293
13302
  /**
13294
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
13295
- * @summary Assign role
13303
+ * 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`
13304
+ * @summary Assign a role to a player
13296
13305
  * @param {string} id
13297
13306
  * @param {string} roleId
13298
13307
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -13305,8 +13314,8 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
13305
13314
  .then((request) => request(axios, basePath));
13306
13315
  },
13307
13316
  /**
13308
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
13309
- * @summary Bulk assign role
13317
+ * 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`
13318
+ * @summary Assign a role to many players at once
13310
13319
  * @param {string} roleId
13311
13320
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
13312
13321
  * @param {*} [options] Override http request option.
@@ -13318,7 +13327,7 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
13318
13327
  .then((request) => request(axios, basePath));
13319
13328
  },
13320
13329
  /**
13321
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
13330
+ * 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`
13322
13331
  * @summary Bulk delete
13323
13332
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
13324
13333
  * @param {*} [options] Override http request option.
@@ -13349,8 +13358,8 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
13349
13358
  return localVarFp.playerControllerGetMe(options).then((request) => request(axios, basePath));
13350
13359
  },
13351
13360
  /**
13352
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
13353
- * @summary Get one
13361
+ * 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`
13362
+ * @summary Get one player
13354
13363
  * @param {string} id
13355
13364
  * @param {*} [options] Override http request option.
13356
13365
  * @throws {RequiredError}
@@ -13359,8 +13368,8 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
13359
13368
  return localVarFp.playerControllerGetOne(id, options).then((request) => request(axios, basePath));
13360
13369
  },
13361
13370
  /**
13362
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
13363
- * @summary Remove role
13371
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
13372
+ * @summary Remove a role from a player
13364
13373
  * @param {string} id
13365
13374
  * @param {string} roleId
13366
13375
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -13373,8 +13382,8 @@ export const PlayerApiFactory = function (configuration, basePath, axios) {
13373
13382
  .then((request) => request(axios, basePath));
13374
13383
  },
13375
13384
  /**
13376
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
13377
- * @summary Search
13385
+ * 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`
13386
+ * @summary Find a player by name or platform id
13378
13387
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
13379
13388
  * @param {*} [options] Override http request option.
13380
13389
  * @throws {RequiredError}
@@ -13460,8 +13469,8 @@ export class PlayerApi extends BaseAPI {
13460
13469
  .then((request) => request(this.axios, this.basePath));
13461
13470
  }
13462
13471
  /**
13463
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerAssignRole`
13464
- * @summary Assign role
13472
+ * 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`
13473
+ * @summary Assign a role to a player
13465
13474
  * @param {string} id
13466
13475
  * @param {string} roleId
13467
13476
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -13475,8 +13484,8 @@ export class PlayerApi extends BaseAPI {
13475
13484
  .then((request) => request(this.axios, this.basePath));
13476
13485
  }
13477
13486
  /**
13478
- * Bulk assign a role to multiple players. Processes each player individually and reports partial failures. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerBulkAssignRole`
13479
- * @summary Bulk assign role
13487
+ * 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`
13488
+ * @summary Assign a role to many players at once
13480
13489
  * @param {string} roleId
13481
13490
  * @param {PlayerBulkAssignRoleInputDTO} [playerBulkAssignRoleInputDTO] PlayerBulkAssignRoleInputDTO
13482
13491
  * @param {*} [options] Override http request option.
@@ -13489,7 +13498,7 @@ export class PlayerApi extends BaseAPI {
13489
13498
  .then((request) => request(this.axios, this.basePath));
13490
13499
  }
13491
13500
  /**
13492
- * Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerControllerBulkDelete`
13501
+ * 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`
13493
13502
  * @summary Bulk delete
13494
13503
  * @param {PlayerBulkDeleteInputDTO} [playerBulkDeleteInputDTO] PlayerBulkDeleteInputDTO
13495
13504
  * @param {*} [options] Override http request option.
@@ -13527,8 +13536,8 @@ export class PlayerApi extends BaseAPI {
13527
13536
  .then((request) => request(this.axios, this.basePath));
13528
13537
  }
13529
13538
  /**
13530
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerGetOne`
13531
- * @summary Get one
13539
+ * 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`
13540
+ * @summary Get one player
13532
13541
  * @param {string} id
13533
13542
  * @param {*} [options] Override http request option.
13534
13543
  * @throws {RequiredError}
@@ -13540,8 +13549,8 @@ export class PlayerApi extends BaseAPI {
13540
13549
  .then((request) => request(this.axios, this.basePath));
13541
13550
  }
13542
13551
  /**
13543
- * Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
13544
- * @summary Remove role
13552
+ * Takes a role away from a player, revoking the permissions it granted them. Required permissions: `MANAGE_PLAYERS`, `MANAGE_ROLES`<br> OperationId: `PlayerControllerRemoveRole`
13553
+ * @summary Remove a role from a player
13545
13554
  * @param {string} id
13546
13555
  * @param {string} roleId
13547
13556
  * @param {PlayerRoleAssignChangeDTO} [playerRoleAssignChangeDTO] PlayerRoleAssignChangeDTO
@@ -13555,8 +13564,8 @@ export class PlayerApi extends BaseAPI {
13555
13564
  .then((request) => request(this.axios, this.basePath));
13556
13565
  }
13557
13566
  /**
13558
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerControllerSearch`
13559
- * @summary Search
13567
+ * 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`
13568
+ * @summary Find a player by name or platform id
13560
13569
  * @param {PlayerSearchInputDTO} [playerSearchInputDTO] PlayerSearchInputDTO
13561
13570
  * @param {*} [options] Override http request option.
13562
13571
  * @throws {RequiredError}
@@ -13575,8 +13584,8 @@ export class PlayerApi extends BaseAPI {
13575
13584
  export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13576
13585
  return {
13577
13586
  /**
13578
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
13579
- * @summary Add currency
13587
+ * 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`
13588
+ * @summary Give a player currency
13580
13589
  * @param {string} gameServerId
13581
13590
  * @param {string} playerId
13582
13591
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -13612,8 +13621,8 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13612
13621
  };
13613
13622
  },
13614
13623
  /**
13615
- * 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`
13616
- * @summary Bulk add currency
13624
+ * 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`
13625
+ * @summary Give several players currency at once
13617
13626
  * @param {string} gameServerId
13618
13627
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
13619
13628
  * @param {*} [options] Override http request option.
@@ -13645,7 +13654,7 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13645
13654
  },
13646
13655
  /**
13647
13656
  * 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`
13648
- * @summary Bulk delete
13657
+ * @summary Permanently delete several players\' records and their history
13649
13658
  * @param {string} gameServerId
13650
13659
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
13651
13660
  * @param {*} [options] Override http request option.
@@ -13676,8 +13685,8 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13676
13685
  };
13677
13686
  },
13678
13687
  /**
13679
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
13680
- * @summary Deduct currency
13688
+ * 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`
13689
+ * @summary Take currency away from a player
13681
13690
  * @param {string} gameServerId
13682
13691
  * @param {string} playerId
13683
13692
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -13713,8 +13722,8 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13713
13722
  };
13714
13723
  },
13715
13724
  /**
13716
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
13717
- * @summary Delete
13725
+ * 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`
13726
+ * @summary Permanently delete a player\'s record and its history
13718
13727
  * @param {string} gameServerId
13719
13728
  * @param {string} playerId
13720
13729
  * @param {*} [options] Override http request option.
@@ -13747,8 +13756,8 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13747
13756
  };
13748
13757
  },
13749
13758
  /**
13750
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
13751
- * @summary Get one
13759
+ * 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`
13760
+ * @summary Get one player on a game server
13752
13761
  * @param {string} gameServerId
13753
13762
  * @param {string} playerId
13754
13763
  * @param {*} [options] Override http request option.
@@ -13781,8 +13790,8 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13781
13790
  };
13782
13791
  },
13783
13792
  /**
13784
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
13785
- * @summary Search
13793
+ * 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`
13794
+ * @summary Search players on a game server
13786
13795
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
13787
13796
  * @param {*} [options] Override http request option.
13788
13797
  * @throws {RequiredError}
@@ -13810,8 +13819,8 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13810
13819
  };
13811
13820
  },
13812
13821
  /**
13813
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
13814
- * @summary Set currency
13822
+ * 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`
13823
+ * @summary Set a player\'s currency balance
13815
13824
  * @param {string} gameServerId
13816
13825
  * @param {string} playerId
13817
13826
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -13847,8 +13856,8 @@ export const PlayerOnGameServerApiAxiosParamCreator = function (configuration) {
13847
13856
  };
13848
13857
  },
13849
13858
  /**
13850
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
13851
- * @summary Transact between players
13859
+ * 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`
13860
+ * @summary Transfer currency between two players
13852
13861
  * @param {string} gameServerId
13853
13862
  * @param {string} sender
13854
13863
  * @param {string} receiver
@@ -13897,8 +13906,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13897
13906
  const localVarAxiosParamCreator = PlayerOnGameServerApiAxiosParamCreator(configuration);
13898
13907
  return {
13899
13908
  /**
13900
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
13901
- * @summary Add currency
13909
+ * 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`
13910
+ * @summary Give a player currency
13902
13911
  * @param {string} gameServerId
13903
13912
  * @param {string} playerId
13904
13913
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -13912,8 +13921,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13912
13921
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13913
13922
  },
13914
13923
  /**
13915
- * 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`
13916
- * @summary Bulk add currency
13924
+ * 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`
13925
+ * @summary Give several players currency at once
13917
13926
  * @param {string} gameServerId
13918
13927
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
13919
13928
  * @param {*} [options] Override http request option.
@@ -13927,7 +13936,7 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13927
13936
  },
13928
13937
  /**
13929
13938
  * 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`
13930
- * @summary Bulk delete
13939
+ * @summary Permanently delete several players\' records and their history
13931
13940
  * @param {string} gameServerId
13932
13941
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
13933
13942
  * @param {*} [options] Override http request option.
@@ -13940,8 +13949,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13940
13949
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13941
13950
  },
13942
13951
  /**
13943
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
13944
- * @summary Deduct currency
13952
+ * 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`
13953
+ * @summary Take currency away from a player
13945
13954
  * @param {string} gameServerId
13946
13955
  * @param {string} playerId
13947
13956
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -13955,8 +13964,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13955
13964
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13956
13965
  },
13957
13966
  /**
13958
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
13959
- * @summary Delete
13967
+ * 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`
13968
+ * @summary Permanently delete a player\'s record and its history
13960
13969
  * @param {string} gameServerId
13961
13970
  * @param {string} playerId
13962
13971
  * @param {*} [options] Override http request option.
@@ -13970,8 +13979,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13970
13979
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13971
13980
  },
13972
13981
  /**
13973
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
13974
- * @summary Get one
13982
+ * 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`
13983
+ * @summary Get one player on a game server
13975
13984
  * @param {string} gameServerId
13976
13985
  * @param {string} playerId
13977
13986
  * @param {*} [options] Override http request option.
@@ -13985,8 +13994,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13985
13994
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
13986
13995
  },
13987
13996
  /**
13988
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
13989
- * @summary Search
13997
+ * 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`
13998
+ * @summary Search players on a game server
13990
13999
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
13991
14000
  * @param {*} [options] Override http request option.
13992
14001
  * @throws {RequiredError}
@@ -13999,8 +14008,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
13999
14008
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14000
14009
  },
14001
14010
  /**
14002
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
14003
- * @summary Set currency
14011
+ * 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`
14012
+ * @summary Set a player\'s currency balance
14004
14013
  * @param {string} gameServerId
14005
14014
  * @param {string} playerId
14006
14015
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -14014,8 +14023,8 @@ export const PlayerOnGameServerApiFp = function (configuration) {
14014
14023
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14015
14024
  },
14016
14025
  /**
14017
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
14018
- * @summary Transact between players
14026
+ * 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`
14027
+ * @summary Transfer currency between two players
14019
14028
  * @param {string} gameServerId
14020
14029
  * @param {string} sender
14021
14030
  * @param {string} receiver
@@ -14039,8 +14048,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14039
14048
  const localVarFp = PlayerOnGameServerApiFp(configuration);
14040
14049
  return {
14041
14050
  /**
14042
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
14043
- * @summary Add currency
14051
+ * 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`
14052
+ * @summary Give a player currency
14044
14053
  * @param {string} gameServerId
14045
14054
  * @param {string} playerId
14046
14055
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -14053,8 +14062,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14053
14062
  .then((request) => request(axios, basePath));
14054
14063
  },
14055
14064
  /**
14056
- * 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`
14057
- * @summary Bulk add currency
14065
+ * 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`
14066
+ * @summary Give several players currency at once
14058
14067
  * @param {string} gameServerId
14059
14068
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
14060
14069
  * @param {*} [options] Override http request option.
@@ -14067,7 +14076,7 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14067
14076
  },
14068
14077
  /**
14069
14078
  * 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`
14070
- * @summary Bulk delete
14079
+ * @summary Permanently delete several players\' records and their history
14071
14080
  * @param {string} gameServerId
14072
14081
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
14073
14082
  * @param {*} [options] Override http request option.
@@ -14079,8 +14088,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14079
14088
  .then((request) => request(axios, basePath));
14080
14089
  },
14081
14090
  /**
14082
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
14083
- * @summary Deduct currency
14091
+ * 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`
14092
+ * @summary Take currency away from a player
14084
14093
  * @param {string} gameServerId
14085
14094
  * @param {string} playerId
14086
14095
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -14093,8 +14102,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14093
14102
  .then((request) => request(axios, basePath));
14094
14103
  },
14095
14104
  /**
14096
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
14097
- * @summary Delete
14105
+ * 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`
14106
+ * @summary Permanently delete a player\'s record and its history
14098
14107
  * @param {string} gameServerId
14099
14108
  * @param {string} playerId
14100
14109
  * @param {*} [options] Override http request option.
@@ -14106,8 +14115,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14106
14115
  .then((request) => request(axios, basePath));
14107
14116
  },
14108
14117
  /**
14109
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
14110
- * @summary Get one
14118
+ * 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`
14119
+ * @summary Get one player on a game server
14111
14120
  * @param {string} gameServerId
14112
14121
  * @param {string} playerId
14113
14122
  * @param {*} [options] Override http request option.
@@ -14119,8 +14128,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14119
14128
  .then((request) => request(axios, basePath));
14120
14129
  },
14121
14130
  /**
14122
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
14123
- * @summary Search
14131
+ * 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`
14132
+ * @summary Search players on a game server
14124
14133
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
14125
14134
  * @param {*} [options] Override http request option.
14126
14135
  * @throws {RequiredError}
@@ -14131,8 +14140,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14131
14140
  .then((request) => request(axios, basePath));
14132
14141
  },
14133
14142
  /**
14134
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
14135
- * @summary Set currency
14143
+ * 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`
14144
+ * @summary Set a player\'s currency balance
14136
14145
  * @param {string} gameServerId
14137
14146
  * @param {string} playerId
14138
14147
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -14145,8 +14154,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14145
14154
  .then((request) => request(axios, basePath));
14146
14155
  },
14147
14156
  /**
14148
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
14149
- * @summary Transact between players
14157
+ * 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`
14158
+ * @summary Transfer currency between two players
14150
14159
  * @param {string} gameServerId
14151
14160
  * @param {string} sender
14152
14161
  * @param {string} receiver
@@ -14169,8 +14178,8 @@ export const PlayerOnGameServerApiFactory = function (configuration, basePath, a
14169
14178
  */
14170
14179
  export class PlayerOnGameServerApi extends BaseAPI {
14171
14180
  /**
14172
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerAddCurrency`
14173
- * @summary Add currency
14181
+ * 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`
14182
+ * @summary Give a player currency
14174
14183
  * @param {string} gameServerId
14175
14184
  * @param {string} playerId
14176
14185
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -14184,8 +14193,8 @@ export class PlayerOnGameServerApi extends BaseAPI {
14184
14193
  .then((request) => request(this.axios, this.basePath));
14185
14194
  }
14186
14195
  /**
14187
- * 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`
14188
- * @summary Bulk add currency
14196
+ * 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`
14197
+ * @summary Give several players currency at once
14189
14198
  * @param {string} gameServerId
14190
14199
  * @param {PogBulkAddCurrencyInputDTO} [pogBulkAddCurrencyInputDTO] PogBulkAddCurrencyInputDTO
14191
14200
  * @param {*} [options] Override http request option.
@@ -14199,7 +14208,7 @@ export class PlayerOnGameServerApi extends BaseAPI {
14199
14208
  }
14200
14209
  /**
14201
14210
  * 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`
14202
- * @summary Bulk delete
14211
+ * @summary Permanently delete several players\' records and their history
14203
14212
  * @param {string} gameServerId
14204
14213
  * @param {PogBulkDeleteInputDTO} [pogBulkDeleteInputDTO] PogBulkDeleteInputDTO
14205
14214
  * @param {*} [options] Override http request option.
@@ -14212,8 +14221,8 @@ export class PlayerOnGameServerApi extends BaseAPI {
14212
14221
  .then((request) => request(this.axios, this.basePath));
14213
14222
  }
14214
14223
  /**
14215
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDeductCurrency`
14216
- * @summary Deduct currency
14224
+ * 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`
14225
+ * @summary Take currency away from a player
14217
14226
  * @param {string} gameServerId
14218
14227
  * @param {string} playerId
14219
14228
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -14227,8 +14236,8 @@ export class PlayerOnGameServerApi extends BaseAPI {
14227
14236
  .then((request) => request(this.axios, this.basePath));
14228
14237
  }
14229
14238
  /**
14230
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerDelete`
14231
- * @summary Delete
14239
+ * 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`
14240
+ * @summary Permanently delete a player\'s record and its history
14232
14241
  * @param {string} gameServerId
14233
14242
  * @param {string} playerId
14234
14243
  * @param {*} [options] Override http request option.
@@ -14241,8 +14250,8 @@ export class PlayerOnGameServerApi extends BaseAPI {
14241
14250
  .then((request) => request(this.axios, this.basePath));
14242
14251
  }
14243
14252
  /**
14244
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerGetOne`
14245
- * @summary Get one
14253
+ * 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`
14254
+ * @summary Get one player on a game server
14246
14255
  * @param {string} gameServerId
14247
14256
  * @param {string} playerId
14248
14257
  * @param {*} [options] Override http request option.
@@ -14255,8 +14264,8 @@ export class PlayerOnGameServerApi extends BaseAPI {
14255
14264
  .then((request) => request(this.axios, this.basePath));
14256
14265
  }
14257
14266
  /**
14258
- * Required permissions: `READ_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSearch`
14259
- * @summary Search
14267
+ * 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`
14268
+ * @summary Search players on a game server
14260
14269
  * @param {PlayerOnGameServerSearchInputDTO} [playerOnGameServerSearchInputDTO] PlayerOnGameServerSearchInputDTO
14261
14270
  * @param {*} [options] Override http request option.
14262
14271
  * @throws {RequiredError}
@@ -14268,8 +14277,8 @@ export class PlayerOnGameServerApi extends BaseAPI {
14268
14277
  .then((request) => request(this.axios, this.basePath));
14269
14278
  }
14270
14279
  /**
14271
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerSetCurrency`
14272
- * @summary Set currency
14280
+ * 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`
14281
+ * @summary Set a player\'s currency balance
14273
14282
  * @param {string} gameServerId
14274
14283
  * @param {string} playerId
14275
14284
  * @param {PlayerOnGameServerSetCurrencyInputDTO} [playerOnGameServerSetCurrencyInputDTO] PlayerOnGameServerSetCurrencyInputDTO
@@ -14283,8 +14292,8 @@ export class PlayerOnGameServerApi extends BaseAPI {
14283
14292
  .then((request) => request(this.axios, this.basePath));
14284
14293
  }
14285
14294
  /**
14286
- * Required permissions: `MANAGE_PLAYERS`<br> OperationId: `PlayerOnGameServerControllerTransactBetweenPlayers`
14287
- * @summary Transact between players
14295
+ * 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`
14296
+ * @summary Transfer currency between two players
14288
14297
  * @param {string} gameServerId
14289
14298
  * @param {string} sender
14290
14299
  * @param {string} receiver
@@ -14727,8 +14736,8 @@ export const RoleApiAxiosParamCreator = function (configuration) {
14727
14736
  };
14728
14737
  },
14729
14738
  /**
14730
- * <br> OperationId: `RoleControllerGetPermissions`
14731
- * @summary Get permissions
14739
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
14740
+ * @summary List every permission a role can grant
14732
14741
  * @param {*} [options] Override http request option.
14733
14742
  * @throws {RequiredError}
14734
14743
  */
@@ -14878,8 +14887,8 @@ export const RoleApiFp = function (configuration) {
14878
14887
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14879
14888
  },
14880
14889
  /**
14881
- * <br> OperationId: `RoleControllerGetPermissions`
14882
- * @summary Get permissions
14890
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
14891
+ * @summary List every permission a role can grant
14883
14892
  * @param {*} [options] Override http request option.
14884
14893
  * @throws {RequiredError}
14885
14894
  */
@@ -14959,8 +14968,8 @@ export const RoleApiFactory = function (configuration, basePath, axios) {
14959
14968
  return localVarFp.roleControllerGetOne(id, options).then((request) => request(axios, basePath));
14960
14969
  },
14961
14970
  /**
14962
- * <br> OperationId: `RoleControllerGetPermissions`
14963
- * @summary Get permissions
14971
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
14972
+ * @summary List every permission a role can grant
14964
14973
  * @param {*} [options] Override http request option.
14965
14974
  * @throws {RequiredError}
14966
14975
  */
@@ -15036,8 +15045,8 @@ export class RoleApi extends BaseAPI {
15036
15045
  .then((request) => request(this.axios, this.basePath));
15037
15046
  }
15038
15047
  /**
15039
- * <br> OperationId: `RoleControllerGetPermissions`
15040
- * @summary Get permissions
15048
+ * Returns the full catalogue of permissions that can be assigned to a role, including the ones modules contribute.<br> OperationId: `RoleControllerGetPermissions`
15049
+ * @summary List every permission a role can grant
15041
15050
  * @param {*} [options] Override http request option.
15042
15051
  * @throws {RequiredError}
15043
15052
  * @memberof RoleApi
@@ -15957,7 +15966,7 @@ export class ShopActionApi extends BaseAPI {
15957
15966
  export const ShopCategoryApiAxiosParamCreator = function (configuration) {
15958
15967
  return {
15959
15968
  /**
15960
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
15969
+ * 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`
15961
15970
  * @summary Bulk assign
15962
15971
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
15963
15972
  * @param {*} [options] Override http request option.
@@ -16209,7 +16218,7 @@ export const ShopCategoryApiFp = function (configuration) {
16209
16218
  const localVarAxiosParamCreator = ShopCategoryApiAxiosParamCreator(configuration);
16210
16219
  return {
16211
16220
  /**
16212
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
16221
+ * 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`
16213
16222
  * @summary Bulk assign
16214
16223
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
16215
16224
  * @param {*} [options] Override http request option.
@@ -16325,7 +16334,7 @@ export const ShopCategoryApiFactory = function (configuration, basePath, axios)
16325
16334
  const localVarFp = ShopCategoryApiFp(configuration);
16326
16335
  return {
16327
16336
  /**
16328
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
16337
+ * 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`
16329
16338
  * @summary Bulk assign
16330
16339
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
16331
16340
  * @param {*} [options] Override http request option.
@@ -16429,7 +16438,7 @@ export const ShopCategoryApiFactory = function (configuration, basePath, axios)
16429
16438
  */
16430
16439
  export class ShopCategoryApi extends BaseAPI {
16431
16440
  /**
16432
- * Bulk assign categories to multiple shop listings Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopCategoryControllerBulkAssign`
16441
+ * 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`
16433
16442
  * @summary Bulk assign
16434
16443
  * @param {ShopCategoryBulkAssignDTO} [shopCategoryBulkAssignDTO] ShopCategoryBulkAssignDTO
16435
16444
  * @param {*} [options] Override http request option.
@@ -16542,6 +16551,35 @@ export class ShopCategoryApi extends BaseAPI {
16542
16551
  */
16543
16552
  export const ShopListingApiAxiosParamCreator = function (configuration) {
16544
16553
  return {
16554
+ /**
16555
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
16556
+ * @summary Bulk
16557
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
16558
+ * @param {*} [options] Override http request option.
16559
+ * @throws {RequiredError}
16560
+ */
16561
+ shopListingControllerBulk: async (shopListingBulkInputDTO, options = {}) => {
16562
+ const localVarPath = `/shop/listing/bulk`;
16563
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16564
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16565
+ let baseOptions;
16566
+ if (configuration) {
16567
+ baseOptions = configuration.baseOptions;
16568
+ }
16569
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
16570
+ const localVarHeaderParameter = {};
16571
+ const localVarQueryParameter = {};
16572
+ // authentication domainAuth required
16573
+ localVarHeaderParameter['Content-Type'] = 'application/json';
16574
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16575
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16576
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
16577
+ localVarRequestOptions.data = serializeDataIfNeeded(shopListingBulkInputDTO, localVarRequestOptions, configuration);
16578
+ return {
16579
+ url: toPathString(localVarUrlObj),
16580
+ options: localVarRequestOptions,
16581
+ };
16582
+ },
16545
16583
  /**
16546
16584
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
16547
16585
  * @summary Create
@@ -16725,6 +16763,19 @@ export const ShopListingApiAxiosParamCreator = function (configuration) {
16725
16763
  export const ShopListingApiFp = function (configuration) {
16726
16764
  const localVarAxiosParamCreator = ShopListingApiAxiosParamCreator(configuration);
16727
16765
  return {
16766
+ /**
16767
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
16768
+ * @summary Bulk
16769
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
16770
+ * @param {*} [options] Override http request option.
16771
+ * @throws {RequiredError}
16772
+ */
16773
+ async shopListingControllerBulk(shopListingBulkInputDTO, options) {
16774
+ const localVarAxiosArgs = await localVarAxiosParamCreator.shopListingControllerBulk(shopListingBulkInputDTO, options);
16775
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16776
+ const localVarOperationServerBasePath = operationServerMap['ShopListingApi.shopListingControllerBulk']?.[localVarOperationServerIndex]?.url;
16777
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16778
+ },
16728
16779
  /**
16729
16780
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
16730
16781
  * @summary Create
@@ -16812,6 +16863,18 @@ export const ShopListingApiFp = function (configuration) {
16812
16863
  export const ShopListingApiFactory = function (configuration, basePath, axios) {
16813
16864
  const localVarFp = ShopListingApiFp(configuration);
16814
16865
  return {
16866
+ /**
16867
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
16868
+ * @summary Bulk
16869
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
16870
+ * @param {*} [options] Override http request option.
16871
+ * @throws {RequiredError}
16872
+ */
16873
+ shopListingControllerBulk(shopListingBulkInputDTO, options) {
16874
+ return localVarFp
16875
+ .shopListingControllerBulk(shopListingBulkInputDTO, options)
16876
+ .then((request) => request(axios, basePath));
16877
+ },
16815
16878
  /**
16816
16879
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
16817
16880
  * @summary Create
@@ -16887,6 +16950,19 @@ export const ShopListingApiFactory = function (configuration, basePath, axios) {
16887
16950
  * @extends {BaseAPI}
16888
16951
  */
16889
16952
  export class ShopListingApi extends BaseAPI {
16953
+ /**
16954
+ * Bulk delete/publish/unpublish shop listings, targeted by ids or by a search query. Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerBulk`
16955
+ * @summary Bulk
16956
+ * @param {ShopListingBulkInputDTO} [shopListingBulkInputDTO] ShopListingBulkInputDTO
16957
+ * @param {*} [options] Override http request option.
16958
+ * @throws {RequiredError}
16959
+ * @memberof ShopListingApi
16960
+ */
16961
+ shopListingControllerBulk(shopListingBulkInputDTO, options) {
16962
+ return ShopListingApiFp(this.configuration)
16963
+ .shopListingControllerBulk(shopListingBulkInputDTO, options)
16964
+ .then((request) => request(this.axios, this.basePath));
16965
+ }
16890
16966
  /**
16891
16967
  * Required permissions: `MANAGE_SHOP_LISTINGS`<br> OperationId: `ShopListingControllerCreate`
16892
16968
  * @summary Create
@@ -17390,6 +17466,38 @@ export const StorefrontConfigApiAxiosParamCreator = function (configuration) {
17390
17466
  options: localVarRequestOptions,
17391
17467
  };
17392
17468
  },
17469
+ /**
17470
+ * 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`
17471
+ * @summary Preview config
17472
+ * @param {string} gameServerId
17473
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
17474
+ * @param {*} [options] Override http request option.
17475
+ * @throws {RequiredError}
17476
+ */
17477
+ storefrontConfigControllerPreviewConfig: async (gameServerId, storefrontConfigUpsertBody, options = {}) => {
17478
+ // verify required parameter 'gameServerId' is not null or undefined
17479
+ assertParamExists('storefrontConfigControllerPreviewConfig', 'gameServerId', gameServerId);
17480
+ const localVarPath = `/gameserver/{gameServerId}/storefront-config/preview`.replace(`{${'gameServerId'}}`, encodeURIComponent(String(gameServerId)));
17481
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
17482
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
17483
+ let baseOptions;
17484
+ if (configuration) {
17485
+ baseOptions = configuration.baseOptions;
17486
+ }
17487
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
17488
+ const localVarHeaderParameter = {};
17489
+ const localVarQueryParameter = {};
17490
+ // authentication domainAuth required
17491
+ localVarHeaderParameter['Content-Type'] = 'application/json';
17492
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
17493
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
17494
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
17495
+ localVarRequestOptions.data = serializeDataIfNeeded(storefrontConfigUpsertBody, localVarRequestOptions, configuration);
17496
+ return {
17497
+ url: toPathString(localVarUrlObj),
17498
+ options: localVarRequestOptions,
17499
+ };
17500
+ },
17393
17501
  /**
17394
17502
  * 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`
17395
17503
  * @summary Set config
@@ -17456,6 +17564,20 @@ export const StorefrontConfigApiFp = function (configuration) {
17456
17564
  const localVarOperationServerBasePath = operationServerMap['StorefrontConfigApi.storefrontConfigControllerListTemplates']?.[localVarOperationServerIndex]?.url;
17457
17565
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17458
17566
  },
17567
+ /**
17568
+ * 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`
17569
+ * @summary Preview config
17570
+ * @param {string} gameServerId
17571
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
17572
+ * @param {*} [options] Override http request option.
17573
+ * @throws {RequiredError}
17574
+ */
17575
+ async storefrontConfigControllerPreviewConfig(gameServerId, storefrontConfigUpsertBody, options) {
17576
+ const localVarAxiosArgs = await localVarAxiosParamCreator.storefrontConfigControllerPreviewConfig(gameServerId, storefrontConfigUpsertBody, options);
17577
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
17578
+ const localVarOperationServerBasePath = operationServerMap['StorefrontConfigApi.storefrontConfigControllerPreviewConfig']?.[localVarOperationServerIndex]?.url;
17579
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
17580
+ },
17459
17581
  /**
17460
17582
  * 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`
17461
17583
  * @summary Set config
@@ -17501,6 +17623,19 @@ export const StorefrontConfigApiFactory = function (configuration, basePath, axi
17501
17623
  storefrontConfigControllerListTemplates(options) {
17502
17624
  return localVarFp.storefrontConfigControllerListTemplates(options).then((request) => request(axios, basePath));
17503
17625
  },
17626
+ /**
17627
+ * 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`
17628
+ * @summary Preview config
17629
+ * @param {string} gameServerId
17630
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
17631
+ * @param {*} [options] Override http request option.
17632
+ * @throws {RequiredError}
17633
+ */
17634
+ storefrontConfigControllerPreviewConfig(gameServerId, storefrontConfigUpsertBody, options) {
17635
+ return localVarFp
17636
+ .storefrontConfigControllerPreviewConfig(gameServerId, storefrontConfigUpsertBody, options)
17637
+ .then((request) => request(axios, basePath));
17638
+ },
17504
17639
  /**
17505
17640
  * 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`
17506
17641
  * @summary Set config
@@ -17548,6 +17683,20 @@ export class StorefrontConfigApi extends BaseAPI {
17548
17683
  .storefrontConfigControllerListTemplates(options)
17549
17684
  .then((request) => request(this.axios, this.basePath));
17550
17685
  }
17686
+ /**
17687
+ * 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`
17688
+ * @summary Preview config
17689
+ * @param {string} gameServerId
17690
+ * @param {StorefrontConfigUpsertBody} [storefrontConfigUpsertBody] StorefrontConfigUpsertBody
17691
+ * @param {*} [options] Override http request option.
17692
+ * @throws {RequiredError}
17693
+ * @memberof StorefrontConfigApi
17694
+ */
17695
+ storefrontConfigControllerPreviewConfig(gameServerId, storefrontConfigUpsertBody, options) {
17696
+ return StorefrontConfigApiFp(this.configuration)
17697
+ .storefrontConfigControllerPreviewConfig(gameServerId, storefrontConfigUpsertBody, options)
17698
+ .then((request) => request(this.axios, this.basePath));
17699
+ }
17551
17700
  /**
17552
17701
  * 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`
17553
17702
  * @summary Set config
@@ -18961,6 +19110,35 @@ export class UserApi extends BaseAPI {
18961
19110
  */
18962
19111
  export const VariableApiAxiosParamCreator = function (configuration) {
18963
19112
  return {
19113
+ /**
19114
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
19115
+ * @summary Bulk delete
19116
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
19117
+ * @param {*} [options] Override http request option.
19118
+ * @throws {RequiredError}
19119
+ */
19120
+ variableControllerBulkDelete: async (variableBulkDeleteInputDTO, options = {}) => {
19121
+ const localVarPath = `/variables`;
19122
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
19123
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
19124
+ let baseOptions;
19125
+ if (configuration) {
19126
+ baseOptions = configuration.baseOptions;
19127
+ }
19128
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
19129
+ const localVarHeaderParameter = {};
19130
+ const localVarQueryParameter = {};
19131
+ // authentication domainAuth required
19132
+ localVarHeaderParameter['Content-Type'] = 'application/json';
19133
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
19134
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
19135
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
19136
+ localVarRequestOptions.data = serializeDataIfNeeded(variableBulkDeleteInputDTO, localVarRequestOptions, configuration);
19137
+ return {
19138
+ url: toPathString(localVarUrlObj),
19139
+ options: localVarRequestOptions,
19140
+ };
19141
+ },
18964
19142
  /**
18965
19143
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
18966
19144
  * @summary Create
@@ -19118,6 +19296,19 @@ export const VariableApiAxiosParamCreator = function (configuration) {
19118
19296
  export const VariableApiFp = function (configuration) {
19119
19297
  const localVarAxiosParamCreator = VariableApiAxiosParamCreator(configuration);
19120
19298
  return {
19299
+ /**
19300
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
19301
+ * @summary Bulk delete
19302
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
19303
+ * @param {*} [options] Override http request option.
19304
+ * @throws {RequiredError}
19305
+ */
19306
+ async variableControllerBulkDelete(variableBulkDeleteInputDTO, options) {
19307
+ const localVarAxiosArgs = await localVarAxiosParamCreator.variableControllerBulkDelete(variableBulkDeleteInputDTO, options);
19308
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
19309
+ const localVarOperationServerBasePath = operationServerMap['VariableApi.variableControllerBulkDelete']?.[localVarOperationServerIndex]?.url;
19310
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
19311
+ },
19121
19312
  /**
19122
19313
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
19123
19314
  * @summary Create
@@ -19193,6 +19384,18 @@ export const VariableApiFp = function (configuration) {
19193
19384
  export const VariableApiFactory = function (configuration, basePath, axios) {
19194
19385
  const localVarFp = VariableApiFp(configuration);
19195
19386
  return {
19387
+ /**
19388
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
19389
+ * @summary Bulk delete
19390
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
19391
+ * @param {*} [options] Override http request option.
19392
+ * @throws {RequiredError}
19393
+ */
19394
+ variableControllerBulkDelete(variableBulkDeleteInputDTO, options) {
19395
+ return localVarFp
19396
+ .variableControllerBulkDelete(variableBulkDeleteInputDTO, options)
19397
+ .then((request) => request(axios, basePath));
19398
+ },
19196
19399
  /**
19197
19400
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
19198
19401
  * @summary Create
@@ -19259,6 +19462,19 @@ export const VariableApiFactory = function (configuration, basePath, axios) {
19259
19462
  * @extends {BaseAPI}
19260
19463
  */
19261
19464
  export class VariableApi extends BaseAPI {
19465
+ /**
19466
+ * Bulk delete variables by ids or by a search query. Reports per-item failures. Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerBulkDelete`
19467
+ * @summary Bulk delete
19468
+ * @param {VariableBulkDeleteInputDTO} [variableBulkDeleteInputDTO] VariableBulkDeleteInputDTO
19469
+ * @param {*} [options] Override http request option.
19470
+ * @throws {RequiredError}
19471
+ * @memberof VariableApi
19472
+ */
19473
+ variableControllerBulkDelete(variableBulkDeleteInputDTO, options) {
19474
+ return VariableApiFp(this.configuration)
19475
+ .variableControllerBulkDelete(variableBulkDeleteInputDTO, options)
19476
+ .then((request) => request(this.axios, this.basePath));
19477
+ }
19262
19478
  /**
19263
19479
  * Required permissions: `MANAGE_VARIABLES`<br> OperationId: `VariableControllerCreate`
19264
19480
  * @summary Create