Function ModuleApiAxiosParamCreator

ModuleApi - axios parameter creator

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        moduleControllerCreate: (
            moduleCreateAPIDTO?: ModuleCreateAPIDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleControllerExport: (
            id: string,
            moduleExportOptionsDTO?: ModuleExportOptionsDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleControllerGetOne: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleControllerGetTags: (
            id: string,
            page?: number,
            limit?: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleControllerImport: (
            body?: any,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleControllerRemove: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleControllerSearch: (
            moduleSearchInputDTO?: ModuleSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleControllerUpdate: (
            id: string,
            moduleUpdateDTO?: ModuleUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleInstallationsControllerGetInstalledModules: (
            moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleInstallationsControllerGetModuleInstallation: (
            moduleId: string,
            gameServerId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleInstallationsControllerInstallModule: (
            installModuleDTO?: InstallModuleDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleInstallationsControllerUninstallModule: (
            moduleId: string,
            gameServerId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleVersionControllerGetModuleVersion: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleVersionControllerSearchVersions: (
            moduleVersionSearchInputDTO?: ModuleVersionSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        moduleVersionControllerTagVersion: (
            moduleVersionCreateAPIDTO?: ModuleVersionCreateAPIDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • moduleControllerCreate: (
          moduleCreateAPIDTO?: ModuleCreateAPIDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Create a new module Required permissions: MANAGE_MODULES
      OperationId: ModuleControllerCreate

    • moduleControllerExport: (
          id: string,
          moduleExportOptionsDTO?: ModuleExportOptionsDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Exports a module to a format that can be imported into another Takaro instance. This endpoint will export all known versions of the module Required permissions: READ_MODULES
      OperationId: ModuleControllerExport

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

      Required permissions: READ_MODULES
      OperationId: ModuleControllerGetOne

    • moduleControllerGetTags: (
          id: string,
          page?: number,
          limit?: number,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Get a list of all tags for a module, without including all the underlying data Required permissions: READ_MODULES
      OperationId: ModuleControllerGetTags

    • moduleControllerImport: (body?: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Imports a module from a format that was exported from another Takaro instance Required permissions: MANAGE_MODULES
      OperationId: ModuleControllerImport

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

      Removes a module, including all versions and config Required permissions: MANAGE_MODULES
      OperationId: ModuleControllerRemove

    • moduleControllerSearch: (
          moduleSearchInputDTO?: ModuleSearchInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Required permissions: READ_MODULES
      OperationId: ModuleControllerSearch

    • moduleControllerUpdate: (
          id: string,
          moduleUpdateDTO?: ModuleUpdateDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Update a module Required permissions: MANAGE_MODULES
      OperationId: ModuleControllerUpdate

    • moduleInstallationsControllerGetInstalledModules: (
          moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Required permissions: READ_MODULES
      OperationId: ModuleInstallationsControllerGetInstalledModules

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

      Required permissions: READ_MODULES
      OperationId: ModuleInstallationsControllerGetModuleInstallation

    • moduleInstallationsControllerInstallModule: (
          installModuleDTO?: InstallModuleDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Install a module on a gameserver. You can have multiple installations of the same module on the same gameserver. Required permissions: MANAGE_GAMESERVERS
      OperationId: ModuleInstallationsControllerInstallModule

    • moduleInstallationsControllerUninstallModule: (
          moduleId: string,
          gameServerId: 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: ModuleInstallationsControllerUninstallModule

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

      Required permissions: READ_MODULES
      OperationId: ModuleVersionControllerGetModuleVersion

    • moduleVersionControllerSearchVersions: (
          moduleVersionSearchInputDTO?: ModuleVersionSearchInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Required permissions: READ_MODULES
      OperationId: ModuleVersionControllerSearchVersions

    • moduleVersionControllerTagVersion: (
          moduleVersionCreateAPIDTO?: ModuleVersionCreateAPIDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Creates a new version of a module, copying all config (commands,hooks,cronjobs,...) from the "latest" version into a new, immutable version Required permissions: MANAGE_MODULES
      OperationId: ModuleVersionControllerTagVersion