Function PlayerOnGameServerApiFactory

PlayerOnGameServerApi - factory interface

Export

PlayerOnGameServerApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    playerOnGameServerControllerAddCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerDeductCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerGetOne(
        gameServerId: string,
        playerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerSearch(
        playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>;
    playerOnGameServerControllerSetCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerTransactBetweenPlayers(
        gameServerId: string,
        sender: string,
        receiver: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    playerOnGameServerControllerAddCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerDeductCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerGetOne(
        gameServerId: string,
        playerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerSearch(
        playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>;
    playerOnGameServerControllerSetCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerTransactBetweenPlayers(
        gameServerId: string,
        sender: string,
        receiver: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
}
- playerOnGameServerControllerAddCurrency:function
  - playerOnGameServerControllerAddCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>
  - Required permissions: MANAGE_PLAYERS
    OperationId: PlayerOnGameServerControllerAddCurrency
    Parameters
    - gameServerId: string
    - playerId: string
    - OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
      PlayerOnGameServerSetCurrencyInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:19992
- playerOnGameServerControllerDeductCurrency:function
  - playerOnGameServerControllerDeductCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>
  - Required permissions: MANAGE_PLAYERS
    OperationId: PlayerOnGameServerControllerDeductCurrency
    Parameters
    - gameServerId: string
    - playerId: string
    - OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
      PlayerOnGameServerSetCurrencyInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:20011
- playerOnGameServerControllerGetOne:function
  - playerOnGameServerControllerGetOne(
        gameServerId: string,
        playerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>
  - Required permissions: READ_PLAYERS
    OperationId: PlayerOnGameServerControllerGetOne
    Parameters
    - gameServerId: string
    - playerId: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:20034
- playerOnGameServerControllerSearch:function
  - playerOnGameServerControllerSearch(
    playerOnGameServerSearchInputDTO?: PlayerOnGameServerSearchInputDTO,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>
  - Required permissions: READ_PLAYERS
    OperationId: PlayerOnGameServerControllerSearch
    Parameters
    - OptionalplayerOnGameServerSearchInputDTO: PlayerOnGameServerSearchInputDTO
      PlayerOnGameServerSearchInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:20050
- playerOnGameServerControllerSetCurrency:function
  - playerOnGameServerControllerSetCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>
  - Required permissions: MANAGE_PLAYERS
    OperationId: PlayerOnGameServerControllerSetCurrency
    Parameters
    - gameServerId: string
    - playerId: string
    - OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
      PlayerOnGameServerSetCurrencyInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:20067
- playerOnGameServerControllerTransactBetweenPlayers:function
  - playerOnGameServerControllerTransactBetweenPlayers(
        gameServerId: string,
        sender: string,
        receiver: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>
  - Required permissions: MANAGE_PLAYERS
    OperationId: PlayerOnGameServerControllerTransactBetweenPlayers
    Parameters
    - gameServerId: string
    - sender: string
    - receiver: string
    - OptionalplayerOnGameServerSetCurrencyInputDTO: PlayerOnGameServerSetCurrencyInputDTO
      PlayerOnGameServerSetCurrencyInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:20087
- Defined in packages/lib-apiclient/src/generated/api.ts:19976

Function PlayerOnGameServerApiFactory

Export

Parameters

playerOnGameServerControllerAddCurrency:function

Parameters

Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>

Throws

playerOnGameServerControllerDeductCurrency:function

Parameters

Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>

Throws

playerOnGameServerControllerGetOne:function

Parameters

Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>

Throws

playerOnGameServerControllerSearch:function

Parameters

Returns AxiosPromise<PlayerOnGameserverOutputArrayDTOAPI>

Throws

playerOnGameServerControllerSetCurrency:function

Parameters

Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>

Throws

playerOnGameServerControllerTransactBetweenPlayers:function

Parameters

Returns AxiosPromise<PlayerOnGameserverOutputDTOAPI>

Throws

Settings