Class PlayerApi

PlayerApi - object-oriented interface

Export

PlayerApi

Hierarchy

BaseAPI
- PlayerApi

Index

Constructors

constructor

new PlayerApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): PlayerApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PlayerApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

banControllerCreate

banControllerCreate(
banCreateDTO?: BanCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<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 Promise<AxiosResponse<BanOutputDTOAPI>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19318

banControllerDelete

banControllerDelete(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<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 Promise<AxiosResponse<APIOutput>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19332

banControllerGetOne

banControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BanOutputDTOAPI>>
Get a single ban Required permissions: READ_PLAYERS
OperationId: BanControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanOutputDTOAPI>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19346

banControllerSearch

banControllerSearch(
banSearchInputDTO?: BanSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BanOutputArrayDTOAPI>>
Search for bans Required permissions: READ_PLAYERS
OperationId: BanControllerSearch
Parameters
- OptionalbanSearchInputDTO: BanSearchInputDTO
  BanSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BanOutputArrayDTOAPI>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19360

banControllerUpdate

banControllerUpdate(
    id: string,
    banUpdateDTO?: BanUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<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 Promise<AxiosResponse<BanOutputDTOAPI>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19375

playerControllerAssignRole

playerControllerAssignRole(
    id: string,
    roleId: string,
    playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
OperationId: PlayerControllerAssignRole
Parameters
- id: string
- roleId: string
- OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO
  PlayerRoleAssignChangeDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19391

playerControllerGetMe

playerControllerGetMe(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<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 Promise<AxiosResponse<PlayerMeOutputDTO>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19409

playerControllerGetOne

playerControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOutputWithRolesDTOAPI>>
Required permissions: READ_PLAYERS
OperationId: PlayerControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOutputWithRolesDTOAPI>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19423

playerControllerRemoveRole

playerControllerRemoveRole(
    id: string,
    roleId: string,
    playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
OperationId: PlayerControllerRemoveRole
Parameters
- id: string
- roleId: string
- OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO
  PlayerRoleAssignChangeDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19439

playerControllerSearch

playerControllerSearch(
playerSearchInputDTO?: PlayerSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PlayerOutputArrayDTOAPI>>
Required permissions: READ_PLAYERS
OperationId: PlayerControllerSearch
Parameters
- OptionalplayerSearchInputDTO: PlayerSearchInputDTO
  PlayerSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlayerOutputArrayDTOAPI>>
Throws
Memberof
PlayerApi
- Defined in packages/lib-apiclient/src/generated/api.ts:19458

Class PlayerApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlayerApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

banControllerCreate

Parameters

Returns Promise<AxiosResponse<BanOutputDTOAPI>>

Throws

Memberof

banControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

banControllerGetOne

Parameters

Returns Promise<AxiosResponse<BanOutputDTOAPI>>

Throws

Memberof

banControllerSearch

Parameters

Returns Promise<AxiosResponse<BanOutputArrayDTOAPI>>

Throws

Memberof

banControllerUpdate

Parameters

Returns Promise<AxiosResponse<BanOutputDTOAPI>>

Throws

Memberof

playerControllerAssignRole

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

playerControllerGetMe

Parameters

Returns Promise<AxiosResponse<PlayerMeOutputDTO>>

Throws

Memberof

playerControllerGetOne

Parameters

Returns Promise<AxiosResponse<PlayerOutputWithRolesDTOAPI>>

Throws

Memberof

playerControllerRemoveRole

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

playerControllerSearch

Parameters

Returns Promise<AxiosResponse<PlayerOutputArrayDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration