Function PlayerOnGameServerApiFactory

Returns {
    playerOnGameServerControllerAddCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerBulkDelete(
        gameServerId: string,
        pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PogBulkDeleteOutputDTOAPI>;
    playerOnGameServerControllerDeductCurrency(
        gameServerId: string,
        playerId: string,
        playerOnGameServerSetCurrencyInputDTO?: PlayerOnGameServerSetCurrencyInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerOnGameserverOutputDTOAPI>;
    playerOnGameServerControllerDelete(
        gameServerId: string,
        playerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    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

• playerOnGameServerControllerBulkDelete: function

  • playerOnGameServerControllerBulkDelete(
        gameServerId: string,
        pogBulkDeleteInputDTO?: PogBulkDeleteInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PogBulkDeleteOutputDTOAPI>

    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 AxiosPromise<PogBulkDeleteOutputDTOAPI>

    Throws

• 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

• playerOnGameServerControllerDelete: function

  • playerOnGameServerControllerDelete(
        gameServerId: string,
        playerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_PLAYERS
    OperationId: PlayerOnGameServerControllerDelete

    Parameters

    • gameServerId: string
    • playerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• 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

• 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

• 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

• 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