Function PlayerApiFp

PlayerApi - functional programming interface

Export

  • PlayerApiFp(
        configuration?: 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?: BanCreateDTO,
            options?: RawAxiosRequestConfig,
        ): 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
        OperationId: BanControllerCreate

        Parameters

        • OptionalbanCreateDTO: BanCreateDTO

          BanCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

        Throws

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

      • Get a single ban Required permissions: READ_PLAYERS
        OperationId: BanControllerGetOne

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • banControllerSearch:function
      • banControllerSearch(
            banSearchInputDTO?: BanSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BanOutputArrayDTOAPI>,
        >

      • Search for bans Required permissions: READ_PLAYERS
        OperationId: BanControllerSearch

        Parameters

        • OptionalbanSearchInputDTO: BanSearchInputDTO

          BanSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • banControllerUpdate:function
      • banControllerUpdate(
            id: string,
            banUpdateDTO?: BanUpdateDTO,
            options?: RawAxiosRequestConfig,
        ): 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
        OperationId: BanControllerUpdate

        Parameters

        • id: string
        • OptionalbanUpdateDTO: BanUpdateDTO

          BanUpdateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

        Throws

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

        Throws

    • playerControllerGetOne:function
      • playerControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlayerOutputWithRolesDTOAPI>,
        >

      • Required permissions: READ_PLAYERS
        OperationId: PlayerControllerGetOne

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

        Throws

    • playerControllerSearch:function
      • playerControllerSearch(
            playerSearchInputDTO?: PlayerSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlayerOutputArrayDTOAPI>,
        >

      • Required permissions: READ_PLAYERS
        OperationId: PlayerControllerSearch

        Parameters

        • OptionalplayerSearchInputDTO: PlayerSearchInputDTO

          PlayerSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility