Function PlayerApiFp

PlayerApi - functional programming interface

Export

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

  • Parameters

    • Optionalconfiguration: Configuration

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

    • banControllerCreate:function
      • banControllerCreate(banCreateDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>)>

        Summary

        Ban player

        Throws

    • banControllerDelete:function
      • banControllerDelete(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

        Summary

        Unban player

        Throws

    • banControllerGetOne:function
      • banControllerGetOne(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>)>

      • Get a single ban Required permissions: READ_PLAYERS

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>)>

        Summary

        Get a single ban

        Throws

    • banControllerSearch:function
    • banControllerUpdate:function
      • banControllerUpdate(id, banUpdateDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<BanOutputDTOAPI>)>

        Summary

        Update ban

        Throws

    • playerControllerAssignRole:function
      • playerControllerAssignRole(id, roleId, playerRoleAssignChangeDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

      • Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

        Parameters

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

          PlayerRoleAssignChangeDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

        Summary

        Assign role

        Throws

    • playerControllerGetMe:function
      • playerControllerGetMe(options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlayerMeOutputDTO>)>

        Summary

        Get current player

        Throws

    • playerControllerGetOne:function
    • playerControllerRemoveRole:function
      • playerControllerRemoveRole(id, roleId, playerRoleAssignChangeDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

      • Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

        Parameters

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

          PlayerRoleAssignChangeDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

        Summary

        Remove role

        Throws

    • playerControllerSearch:function

Settings

Member Visibility