Function PlayerApiAxiosParamCreator

PlayerApi - axios parameter creator

Export

  • PlayerApiAxiosParamCreator(
        configuration?: 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
      OperationId: BanControllerCreate

      Throws

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

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

      Throws

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

      Get a single ban Required permissions: READ_PLAYERS
      OperationId: BanControllerGetOne

      Throws

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

      Search for bans Required permissions: READ_PLAYERS
      OperationId: BanControllerSearch

      Throws

    • 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
      OperationId: BanControllerUpdate

      Throws

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

      Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
      OperationId: PlayerControllerAssignRole

      Throws

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

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

      Throws

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

      Required permissions: READ_PLAYERS
      OperationId: PlayerControllerGetOne

      Throws

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

      Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
      OperationId: PlayerControllerRemoveRole

      Throws

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

      Required permissions: READ_PLAYERS
      OperationId: PlayerControllerSearch

      Throws

Settings

Member Visibility