Function PlayerApiAxiosParamCreator

PlayerApi - axios parameter creator

Export

  • PlayerApiAxiosParamCreator(configuration?): {
        banControllerCreate: ((banCreateDTO?: BanCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerSearch: ((banSearchInputDTO?: BanSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerUpdate: ((id: string, banUpdateDTO?: BanUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerAssignRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerGetMe: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerRemoveRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerSearch: ((playerSearchInputDTO?: PlayerSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        banControllerCreate: ((banCreateDTO?: BanCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerSearch: ((banSearchInputDTO?: BanSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        banControllerUpdate: ((id: string, banUpdateDTO?: BanUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerAssignRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerGetMe: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerRemoveRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        playerControllerSearch: ((playerSearchInputDTO?: PlayerSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • banControllerCreate: ((banCreateDTO?: BanCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Summary

      Ban player

      Throws

        • (banCreateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalbanCreateDTO: BanCreateDTO

            BanCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • banControllerDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Summary

      Unban player

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • banControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Get a single ban Required permissions: READ_PLAYERS

      Summary

      Get a single ban

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • banControllerSearch: ((banSearchInputDTO?: BanSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Search for bans Required permissions: READ_PLAYERS

      Summary

      Search for bans

      Throws

        • (banSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalbanSearchInputDTO: BanSearchInputDTO

            BanSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • banControllerUpdate: ((id: string, banUpdateDTO?: BanUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Summary

      Update ban

      Throws

        • (id, banUpdateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • OptionalbanUpdateDTO: BanUpdateDTO

            BanUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • playerControllerAssignRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

      Summary

      Assign role

      Throws

        • (id, roleId, playerRoleAssignChangeDTO?, options?): Promise<RequestArgs>

        • Parameters

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

            PlayerRoleAssignChangeDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • playerControllerGetMe: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Summary

      Get current player

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • playerControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_PLAYERS

      Summary

      Get one

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • playerControllerRemoveRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

      Summary

      Remove role

      Throws

        • (id, roleId, playerRoleAssignChangeDTO?, options?): Promise<RequestArgs>

        • Parameters

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

            PlayerRoleAssignChangeDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • playerControllerSearch: ((playerSearchInputDTO?: PlayerSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_PLAYERS

      Summary

      Search

      Throws

        • (playerSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalplayerSearchInputDTO: PlayerSearchInputDTO

            PlayerSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility