Class PlayerOnGameServerApi

PlayerOnGameServerApi - object-oriented interface

Export

PlayerOnGameServerApi

Hierarchy

BaseAPI
- PlayerOnGameServerApi

Index

Constructors

constructor

new PlayerOnGameServerApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): PlayerOnGameServerApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PlayerOnGameServerApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

playerOnGameServerControllerAddCurrency

playerOnGameServerControllerAddCurrency(
    gameServerId: string,
    playerId: string,
    playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
OperationId: PlayerOnGameServerControllerAddCurrency
Parameters
- gameServerId: string
- playerId: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26721

playerOnGameServerControllerBulkDelete

playerOnGameServerControllerBulkDelete(
    gameServerId: string,
    pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PogBulkDeleteOutputDTOAPI, any>>
Bulk delete POG records by player IDs for a specific gameserver. Deletes POG records only, Player records remain intact. Required permissions: MANAGE_PLAYERS
OperationId: PlayerOnGameServerControllerBulkDelete
Parameters
- gameServerId: string
- OptionalpogBulkDeleteInputDTO: PogBulkDeleteInputDTO
  PogBulkDeleteInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PogBulkDeleteOutputDTOAPI, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26741

playerOnGameServerControllerDeductCurrency

playerOnGameServerControllerDeductCurrency(
    gameServerId: string,
    playerId: string,
    playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
OperationId: PlayerOnGameServerControllerDeductCurrency
Parameters
- gameServerId: string
- playerId: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26761

playerOnGameServerControllerDelete

playerOnGameServerControllerDelete(
    gameServerId: string,
    playerId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_PLAYERS
OperationId: PlayerOnGameServerControllerDelete
Parameters
- gameServerId: string
- playerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26786

playerOnGameServerControllerGetOne

playerOnGameServerControllerGetOne(
    gameServerId: string,
    playerId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: READ_PLAYERS
OperationId: PlayerOnGameServerControllerGetOne
Parameters
- gameServerId: string
- playerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26801

playerOnGameServerControllerSearch

playerOnGameServerControllerSearch(
playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>
Required permissions: READ_PLAYERS
OperationId: PlayerOnGameServerControllerSearch
Parameters
- OptionalplayerOnGameServerSearchInputDTO: PlayerOnGameServerSearchInputDTO
  PlayerOnGameServerSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26815

playerOnGameServerControllerSetCurrency

playerOnGameServerControllerSetCurrency(
    gameServerId: string,
    playerId: string,
    playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
OperationId: PlayerOnGameServerControllerSetCurrency
Parameters
- gameServerId: string
- playerId: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26834

playerOnGameServerControllerTransactBetweenPlayers

playerOnGameServerControllerTransactBetweenPlayers(
    gameServerId: string,
    sender: string,
    receiver: string,
    playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Required permissions: MANAGE_PLAYERS
OperationId: PlayerOnGameServerControllerTransactBetweenPlayers
Parameters
- gameServerId: string
- sender: string
- receiver: string
- OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
  PlayerOnGameServerSetCurrencyInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>
Throws
Memberof
PlayerOnGameServerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:26856

Class PlayerOnGameServerApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlayerOnGameServerApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

playerOnGameServerControllerAddCurrency

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Throws

Memberof

playerOnGameServerControllerBulkDelete

Parameters

Returns Promise<AxiosResponse<PogBulkDeleteOutputDTOAPI, any>>

Throws

Memberof

playerOnGameServerControllerDeductCurrency

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Throws

Memberof

playerOnGameServerControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Throws

Memberof

playerOnGameServerControllerGetOne

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Throws

Memberof

playerOnGameServerControllerSearch

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputArrayDTOAPI, any>>

Throws

Memberof

playerOnGameServerControllerSetCurrency

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Throws

Memberof

playerOnGameServerControllerTransactBetweenPlayers

Parameters

Returns Promise<AxiosResponse<PlayerOnGameserverOutputDTOAPI, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration