Function GameServerApiAxiosParamCreator

GameServerApi - axios parameter creator

Export

  • GameServerApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        gameServerControllerBanPlayer: (
            gameServerId: string,
            playerId: string,
            banPlayerInputDTO?: BanPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerCreate: (
            gameServerCreateDTO?: GameServerCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerExecuteCommand: (
            id: string,
            commandExecuteInputDTO?: CommandExecuteInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetImport: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetInstalledModules: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetMapInfo: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetMapTile: (
            id: string,
            x: string,
            y: string,
            z: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetModuleInstallation: (
            gameServerId: string,
            moduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetOne: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetPlayers: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetTypes: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGiveItem: (
            gameServerId: string,
            playerId: string,
            giveItemInputDTO?: GiveItemInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerImportFromCSMM: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerInstallModule: (
            gameServerId: string,
            moduleId: string,
            moduleInstallDTO?: ModuleInstallDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerKickPlayer: (
            gameServerId: string,
            playerId: string,
            kickPlayerInputDTO?: KickPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerListBans: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerRemove: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerSearch: (
            gameServerSearchInputDTO?: GameServerSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerSendMessage: (
            id: string,
            messageSendInputDTO?: MessageSendInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerShutdown: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerTeleportPlayer: (
            gameServerId: string,
            playerId: string,
            teleportPlayerInputDTO?: TeleportPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerTestReachability: (
            gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerTestReachabilityForId: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerUnbanPlayer: (
            gameServerId: string,
            playerId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerUninstallModule: (
            gameServerId: string,
            moduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerUpdate: (
            id: string,
            gameServerUpdateDTO?: GameServerUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        gameServerControllerBanPlayer: (
            gameServerId: string,
            playerId: string,
            banPlayerInputDTO?: BanPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerCreate: (
            gameServerCreateDTO?: GameServerCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerExecuteCommand: (
            id: string,
            commandExecuteInputDTO?: CommandExecuteInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetImport: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetInstalledModules: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetMapInfo: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetMapTile: (
            id: string,
            x: string,
            y: string,
            z: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetModuleInstallation: (
            gameServerId: string,
            moduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetOne: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetPlayers: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGetTypes: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerGiveItem: (
            gameServerId: string,
            playerId: string,
            giveItemInputDTO?: GiveItemInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerImportFromCSMM: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerInstallModule: (
            gameServerId: string,
            moduleId: string,
            moduleInstallDTO?: ModuleInstallDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerKickPlayer: (
            gameServerId: string,
            playerId: string,
            kickPlayerInputDTO?: KickPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerListBans: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerRemove: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerSearch: (
            gameServerSearchInputDTO?: GameServerSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerSendMessage: (
            id: string,
            messageSendInputDTO?: MessageSendInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerShutdown: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerTeleportPlayer: (
            gameServerId: string,
            playerId: string,
            teleportPlayerInputDTO?: TeleportPlayerInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerTestReachability: (
            gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerTestReachabilityForId: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerUnbanPlayer: (
            gameServerId: string,
            playerId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerUninstallModule: (
            gameServerId: string,
            moduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        gameServerControllerUpdate: (
            id: string,
            gameServerUpdateDTO?: GameServerUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • gameServerControllerBanPlayer: (
          gameServerId: string,
          playerId: string,
          banPlayerInputDTO?: BanPlayerInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Ban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerBanPlayer

      Deprecated

      Throws

    • gameServerControllerCreate: (
          gameServerCreateDTO?: GameServerCreateDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Create a gameserver Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerCreate

      Throws

    • gameServerControllerExecuteCommand: (
          id: string,
          commandExecuteInputDTO?: CommandExecuteInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Execute a raw command on a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerExecuteCommand

      Throws

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

      Fetch status of an import from CSMM Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerGetImport

      Throws

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

      Get all module installations for a gameserver
      OperationId: GameServerControllerGetInstalledModules

      Throws

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

      Get map metadata for Leaflet
      OperationId: GameServerControllerGetMapInfo

      Throws

    • gameServerControllerGetMapTile: (
          id: string,
          x: string,
          y: string,
          z: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Get a map tile for Leaflet
      OperationId: GameServerControllerGetMapTile

      Throws

    • gameServerControllerGetModuleInstallation: (
          gameServerId: string,
          moduleId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Get a module installation by id
      OperationId: GameServerControllerGetModuleInstallation

      Throws

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

      Fetch a gameserver by id
      OperationId: GameServerControllerGetOne

      Throws

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

      Fetch a list of players on a gameserver. Requires gameserver to be online and reachable. Required permissions: READ_PLAYERS
      OperationId: GameServerControllerGetPlayers

      Throws

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

      Fetch gameserver types (7dtd, Rust, ...)
      OperationId: GameServerControllerGetTypes

      Throws

    • gameServerControllerGiveItem: (
          gameServerId: string,
          playerId: string,
          giveItemInputDTO?: GiveItemInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Give an item to a player. Requires gameserver to be online and reachable. Depending on the underlying game implementation, it's possible that the item is dropped on the ground instead of placed directly in the player's inventory. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerGiveItem

      Throws

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

      Import a gameserver from CSMM. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerImportFromCSMM

      Throws

    • gameServerControllerInstallModule: (
          gameServerId: string,
          moduleId: string,
          moduleInstallDTO?: ModuleInstallDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Install a module on a gameserver. If the module is already installed, it will be updated. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerInstallModule

      Throws

    • gameServerControllerKickPlayer: (
          gameServerId: string,
          playerId: string,
          kickPlayerInputDTO?: KickPlayerInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Kick a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerKickPlayer

      Throws

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

      List bans for a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerListBans

      Deprecated

      Throws

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

      Delete a gameserver Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerRemove

      Throws

    • gameServerControllerSearch: (
          gameServerSearchInputDTO?: GameServerSearchInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Fetch gameservers
      OperationId: GameServerControllerSearch

      Throws

    • gameServerControllerSendMessage: (
          id: string,
          messageSendInputDTO?: MessageSendInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Send a message in gameserver chat. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerSendMessage

      Throws

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

      Shuts down the gameserver. This is a 'soft' shutdown, meaning the gameserver will be stopped gracefully. If the gameserver is not reachable, this will have no effect. Note that most hosting providers will automatically restart the gameserver after a shutdown, which makes this operation act as a 'restart' instead. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerShutdown

      Throws

    • gameServerControllerTeleportPlayer: (
          gameServerId: string,
          playerId: string,
          teleportPlayerInputDTO?: TeleportPlayerInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Teleport a player to a location. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerTeleportPlayer

      Throws

    • gameServerControllerTestReachability: (
          gameServerTestReachabilityInputDTO?: GameServerTestReachabilityInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
      OperationId: GameServerControllerTestReachability

      Throws

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

      Test if Takaro can connect to a gameserver. Will do a thorough check and report details.
      OperationId: GameServerControllerTestReachabilityForId

      Throws

    • gameServerControllerUnbanPlayer: (
          gameServerId: string,
          playerId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Unban a player from a gameserver. Requires gameserver to be online and reachable. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerUnbanPlayer

      Deprecated

      Throws

    • gameServerControllerUninstallModule: (
          gameServerId: string,
          moduleId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Uninstall a module from a gameserver. This will not delete the module from the database. Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerUninstallModule

      Throws

    • gameServerControllerUpdate: (
          id: string,
          gameServerUpdateDTO?: GameServerUpdateDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Update a gameserver Required permissions: MANAGE_GAMESERVERS
      OperationId: GameServerControllerUpdate

      Throws

Settings

Member Visibility