Function PlayerApiFactory

Returns {
    banControllerCreate(banCreateDTO?: BanCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputDTOAPI>;
    banControllerDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    banControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputDTOAPI>;
    banControllerSearch(banSearchInputDTO?: BanSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputArrayDTOAPI>;
    banControllerUpdate(id: string, banUpdateDTO?: BanUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<BanOutputDTOAPI>;
    playerControllerAssignRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    playerControllerGetMe(options?: RawAxiosRequestConfig): AxiosPromise<PlayerMeOutputDTO>;
    playerControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOutputWithRolesDTOAPI>;
    playerControllerRemoveRole(id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    playerControllerSearch(playerSearchInputDTO?: PlayerSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<PlayerOutputArrayDTOAPI>;
}

• banControllerCreate:function

  • banControllerCreate(banCreateDTO?, options?): AxiosPromise<BanOutputDTOAPI>

  • Create a new ban, creating a ban via the API will always make it takaro managed. Required permissions: MANAGE_PLAYERS

    Parameters

    • OptionalbanCreateDTO: BanCreateDTO

      BanCreateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputDTOAPI>

    Summary

    Ban player

    Throws

• banControllerDelete:function

  • banControllerDelete(id, options?): AxiosPromise<APIOutput>

  • Unban player. This will remove the ban from Takaro and the gameserver(s) Required permissions: MANAGE_PLAYERS

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Summary

    Unban player

    Throws

• banControllerGetOne:function

  • banControllerGetOne(id, options?): AxiosPromise<BanOutputDTOAPI>

  • Get a single ban Required permissions: READ_PLAYERS

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputDTOAPI>

    Summary

    Get a single ban

    Throws

• banControllerSearch:function

  • banControllerSearch(banSearchInputDTO?, options?): AxiosPromise<BanOutputArrayDTOAPI>

  • Search for bans Required permissions: READ_PLAYERS

    Parameters

    • OptionalbanSearchInputDTO: BanSearchInputDTO

      BanSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputArrayDTOAPI>

    Summary

    Search for bans

    Throws

• banControllerUpdate:function

  • banControllerUpdate(id, banUpdateDTO?, options?): AxiosPromise<BanOutputDTOAPI>

  • Update an existing ban, updating a ban via the API will always make it takaro managed. Required permissions: MANAGE_PLAYERS

    Parameters

    • id: string
    • OptionalbanUpdateDTO: BanUpdateDTO

      BanUpdateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputDTOAPI>

    Summary

    Update ban

    Throws

• playerControllerAssignRole:function

  • playerControllerAssignRole(id, roleId, playerRoleAssignChangeDTO?, options?): AxiosPromise<APIOutput>

  • Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

    Parameters

    • id: string
    • roleId: string
    • OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO

      PlayerRoleAssignChangeDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Summary

    Assign role

    Throws

• playerControllerGetMe:function

  • playerControllerGetMe(options?): AxiosPromise<PlayerMeOutputDTO>

  • Get the player that is currently authenticated. This is a low-privilege route, returning limited data.

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlayerMeOutputDTO>

    Summary

    Get current player

    Throws

• playerControllerGetOne:function

  • playerControllerGetOne(id, options?): AxiosPromise<PlayerOutputWithRolesDTOAPI>

  • Required permissions: READ_PLAYERS

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlayerOutputWithRolesDTOAPI>

    Summary

    Get one

    Throws

• playerControllerRemoveRole:function

  • playerControllerRemoveRole(id, roleId, playerRoleAssignChangeDTO?, options?): AxiosPromise<APIOutput>

  • Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

    Parameters

    • id: string
    • roleId: string
    • OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO

      PlayerRoleAssignChangeDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Summary

    Remove role

    Throws

• playerControllerSearch:function

  • playerControllerSearch(playerSearchInputDTO?, options?): AxiosPromise<PlayerOutputArrayDTOAPI>

  • Required permissions: READ_PLAYERS

    Parameters

    • OptionalplayerSearchInputDTO: PlayerSearchInputDTO

      PlayerSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlayerOutputArrayDTOAPI>

    Summary

    Search

    Throws