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>;
    playerControllerBulkDelete(
        playerBulkDeleteInputDTO?: PlayerBulkDeleteInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerBulkDeleteOutputDTOAPI>;
    playerControllerDelete(
        id: string,
        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?: BanCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BanOutputDTOAPI>

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

    Parameters

    • OptionalbanCreateDTO: BanCreateDTO

      BanCreateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputDTOAPI>

    Throws

• banControllerDelete: function

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

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

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• banControllerGetOne: function

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

    Get a single ban Required permissions: READ_PLAYERS
    OperationId: BanControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputDTOAPI>

    Throws

• banControllerSearch: function

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

    Search for bans Required permissions: READ_PLAYERS
    OperationId: BanControllerSearch

    Parameters

    • OptionalbanSearchInputDTO: BanSearchInputDTO

      BanSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputArrayDTOAPI>

    Throws

• banControllerUpdate: function

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

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

    Parameters

    • id: string
    • OptionalbanUpdateDTO: BanUpdateDTO

      BanUpdateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<BanOutputDTOAPI>

    Throws

• playerControllerAssignRole: function

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

    Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
    OperationId: PlayerControllerAssignRole

    Parameters

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

      PlayerRoleAssignChangeDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• playerControllerBulkDelete: function

  • playerControllerBulkDelete(
        playerBulkDeleteInputDTO?: PlayerBulkDeleteInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerBulkDeleteOutputDTOAPI>

    Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: MANAGE_PLAYERS
    OperationId: PlayerControllerBulkDelete

    Parameters

    • OptionalplayerBulkDeleteInputDTO: PlayerBulkDeleteInputDTO

      PlayerBulkDeleteInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlayerBulkDeleteOutputDTOAPI>

    Throws

• playerControllerDelete: function

  • playerControllerDelete(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_PLAYERS
    OperationId: PlayerControllerDelete

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• playerControllerGetMe: function

  • playerControllerGetMe(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PlayerMeOutputDTO>

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlayerMeOutputDTO>

    Throws

• playerControllerGetOne: function

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

    Required permissions: READ_PLAYERS
    OperationId: PlayerControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlayerOutputWithRolesDTOAPI>

    Throws

• playerControllerRemoveRole: function

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

    Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
    OperationId: PlayerControllerRemoveRole

    Parameters

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

      PlayerRoleAssignChangeDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• playerControllerSearch: function

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

    Required permissions: READ_PLAYERS
    OperationId: PlayerControllerSearch

    Parameters

    • OptionalplayerSearchInputDTO: PlayerSearchInputDTO

      PlayerSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlayerOutputArrayDTOAPI>

    Throws