Function ModuleApiFp

Returns {
    moduleControllerCreate(
        moduleCreateAPIDTO?: ModuleCreateAPIDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputDTOAPI>,
    >;
    moduleControllerExport(
        id: string,
        moduleExportOptionsDTO?: ModuleExportOptionsDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleExportDTOAPI>,
    >;
    moduleControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputDTOAPI>,
    >;
    moduleControllerGetTags(
        id: string,
        page?: number,
        limit?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SmallModuleOutputArrayDTOAPI>,
    >;
    moduleControllerImport(
        body?: any,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    moduleControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
    >;
    moduleControllerSearch(
        moduleSearchInputDTO?: ModuleSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputArrayDTOAPI>,
    >;
    moduleControllerUpdate(
        id: string,
        moduleUpdateDTO?: ModuleUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputDTOAPI>,
    >;
    moduleInstallationsControllerGetInstalledModules(
        moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputArrayDTOAPI>,
    >;
    moduleInstallationsControllerGetModuleInstallation(
        moduleId: string,
        gameServerId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputDTOAPI>,
    >;
    moduleInstallationsControllerInstallModule(
        installModuleDTO?: InstallModuleDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputDTOAPI>,
    >;
    moduleInstallationsControllerUninstallModule(
        moduleId: string,
        gameServerId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputDTOAPI>,
    >;
    moduleVersionControllerGetModuleVersion(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleVersionOutputDTOAPI>,
    >;
    moduleVersionControllerSearchVersions(
        moduleVersionSearchInputDTO?: ModuleVersionSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleVersionOutputArrayDTOAPI>,
    >;
    moduleVersionControllerTagVersion(
        moduleVersionCreateAPIDTO?: ModuleVersionCreateAPIDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleVersionOutputDTOAPI>,
    >;
}

• moduleControllerCreate:function

  • moduleControllerCreate(
        moduleCreateAPIDTO?: ModuleCreateAPIDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputDTOAPI>,
    >

    Create a new module Required permissions: MANAGE_MODULES
    OperationId: ModuleControllerCreate

    Parameters

    • OptionalmoduleCreateAPIDTO: ModuleCreateAPIDTO

      ModuleCreateAPIDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleControllerExport:function

  • moduleControllerExport(
        id: string,
        moduleExportOptionsDTO?: ModuleExportOptionsDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleExportDTOAPI>,
    >

    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

    Parameters

    • id: string
    • OptionalmoduleExportOptionsDTO: ModuleExportOptionsDTO

      ModuleExportOptionsDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleControllerGetOne:function

  • moduleControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputDTOAPI>,
    >

    Required permissions: READ_MODULES
    OperationId: ModuleControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleControllerGetTags:function

  • moduleControllerGetTags(
        id: string,
        page?: number,
        limit?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SmallModuleOutputArrayDTOAPI>,
    >

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

    Parameters

    • id: string
    • Optionalpage: number
    • Optionallimit: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleControllerImport:function

  • moduleControllerImport(
        body?: any,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

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

    Parameters

    • Optionalbody: any
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleControllerRemove:function

  • moduleControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
    >

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

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleControllerSearch:function

  • moduleControllerSearch(
        moduleSearchInputDTO?: ModuleSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputArrayDTOAPI>,
    >

    Required permissions: READ_MODULES
    OperationId: ModuleControllerSearch

    Parameters

    • OptionalmoduleSearchInputDTO: ModuleSearchInputDTO

      ModuleSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleControllerUpdate:function

  • moduleControllerUpdate(
        id: string,
        moduleUpdateDTO?: ModuleUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleOutputDTOAPI>,
    >

    Update a module Required permissions: MANAGE_MODULES
    OperationId: ModuleControllerUpdate

    Parameters

    • id: string
    • OptionalmoduleUpdateDTO: ModuleUpdateDTO

      ModuleUpdateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleInstallationsControllerGetInstalledModules:function

  • moduleInstallationsControllerGetInstalledModules(
        moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputArrayDTOAPI>,
    >

    Required permissions: READ_MODULES
    OperationId: ModuleInstallationsControllerGetInstalledModules

    Parameters

    • OptionalmoduleInstallationSearchInputDTO: ModuleInstallationSearchInputDTO

      ModuleInstallationSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleInstallationsControllerGetModuleInstallation:function

  • moduleInstallationsControllerGetModuleInstallation(
        moduleId: string,
        gameServerId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputDTOAPI>,
    >

    Required permissions: READ_MODULES
    OperationId: ModuleInstallationsControllerGetModuleInstallation

    Parameters

    • moduleId: string
    • gameServerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleInstallationsControllerInstallModule:function

  • moduleInstallationsControllerInstallModule(
        installModuleDTO?: InstallModuleDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputDTOAPI>,
    >

    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

    Parameters

    • OptionalinstallModuleDTO: InstallModuleDTO

      InstallModuleDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleInstallationsControllerUninstallModule:function

  • moduleInstallationsControllerUninstallModule(
        moduleId: string,
        gameServerId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleInstallationOutputDTOAPI>,
    >

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

    Parameters

    • moduleId: string
    • gameServerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleVersionControllerGetModuleVersion:function

  • moduleVersionControllerGetModuleVersion(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleVersionOutputDTOAPI>,
    >

    Required permissions: READ_MODULES
    OperationId: ModuleVersionControllerGetModuleVersion

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleVersionControllerSearchVersions:function

  • moduleVersionControllerSearchVersions(
        moduleVersionSearchInputDTO?: ModuleVersionSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleVersionOutputArrayDTOAPI>,
    >

    Required permissions: READ_MODULES
    OperationId: ModuleVersionControllerSearchVersions

    Parameters

    • OptionalmoduleVersionSearchInputDTO: ModuleVersionSearchInputDTO

      ModuleVersionSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• moduleVersionControllerTagVersion:function

  • moduleVersionControllerTagVersion(
        moduleVersionCreateAPIDTO?: ModuleVersionCreateAPIDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ModuleVersionOutputDTOAPI>,
    >

    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

    Parameters

    • OptionalmoduleVersionCreateAPIDTO: ModuleVersionCreateAPIDTO

      ModuleVersionCreateAPIDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws