Function PlayerApiFactory

Returns {
    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>;
}

• 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