Class ModuleApi

ModuleApi - object-oriented interface

Export

ModuleApi

Hierarchy

BaseAPI
- ModuleApi

Index

Constructors

constructor

new ModuleApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ModuleApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ModuleApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

moduleControllerCreate

moduleControllerCreate(
moduleCreateAPIDTO?: ModuleCreateAPIDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Create a new module Required permissions: MANAGE_MODULES
OperationId: ModuleControllerCreate
Parameters
- OptionalmoduleCreateAPIDTO: ModuleCreateAPIDTO
  ModuleCreateAPIDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24569

moduleControllerExport

moduleControllerExport(
    id: string,
    moduleExportOptionsDTO?: ModuleExportOptionsDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleExportDTOAPI, any>>
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<AxiosResponse<ModuleExportDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24584

moduleControllerGetOne

moduleControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ModuleControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24602

moduleControllerImport

moduleControllerImport(
body?: any,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24616

moduleControllerRemove

moduleControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
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<AxiosResponse<APIOutput, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24630

moduleControllerSearch

moduleControllerSearch(
moduleSearchInputDTO?: ModuleSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ModuleControllerSearch
Parameters
- OptionalmoduleSearchInputDTO: ModuleSearchInputDTO
  ModuleSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputArrayDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24644

moduleControllerUpdate

moduleControllerUpdate(
    id: string,
    moduleUpdateDTO?: ModuleUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Update a module Required permissions: MANAGE_MODULES
OperationId: ModuleControllerUpdate
Parameters
- id: string
- OptionalmoduleUpdateDTO: ModuleUpdateDTO
  ModuleUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24659

moduleInstallationsControllerGetInstalledModules

moduleInstallationsControllerGetInstalledModules(
moduleInstallationSearchInputDTO?: ModuleInstallationSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ModuleInstallationsControllerGetInstalledModules
Parameters
- OptionalmoduleInstallationSearchInputDTO: ModuleInstallationSearchInputDTO
  ModuleInstallationSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24673

moduleInstallationsControllerGetModuleInstallation

moduleInstallationsControllerGetModuleInstallation(
    moduleId: string,
    gameServerId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ModuleInstallationsControllerGetModuleInstallation
Parameters
- moduleId: string
- gameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24691

moduleInstallationsControllerInstallModule

moduleInstallationsControllerInstallModule(
installModuleDTO?: InstallModuleDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
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<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24709

moduleInstallationsControllerUninstallModule

moduleInstallationsControllerUninstallModule(
    moduleId: string,
    gameServerId: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
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<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24727

moduleVersionControllerGetModuleVersion

moduleVersionControllerGetModuleVersion(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleVersionOutputDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ModuleVersionControllerGetModuleVersion
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleVersionOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24745

moduleVersionControllerSearchVersions

moduleVersionControllerSearchVersions(
moduleVersionSearchInputDTO?: ModuleVersionSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleVersionOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ModuleVersionControllerSearchVersions
Parameters
- OptionalmoduleVersionSearchInputDTO: ModuleVersionSearchInputDTO
  ModuleVersionSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleVersionOutputArrayDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24759

moduleVersionControllerTagVersion

moduleVersionControllerTagVersion(
moduleVersionCreateAPIDTO?: ModuleVersionCreateAPIDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleVersionOutputDTOAPI, any>>
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<AxiosResponse<ModuleVersionOutputDTOAPI, any>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24776

Class ModuleApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ModuleApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

moduleControllerCreate

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>

Throws

Memberof

moduleControllerExport

Parameters

Returns Promise<AxiosResponse<ModuleExportDTOAPI, any>>

Throws

Memberof

moduleControllerGetOne

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>

Throws

Memberof

moduleControllerImport

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

moduleControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Throws

Memberof

moduleControllerSearch

Parameters

Returns Promise<AxiosResponse<ModuleOutputArrayDTOAPI, any>>

Throws

Memberof

moduleControllerUpdate

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>

Throws

Memberof

moduleInstallationsControllerGetInstalledModules

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputArrayDTOAPI, any>>

Throws

Memberof

moduleInstallationsControllerGetModuleInstallation

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>

Throws

Memberof

moduleInstallationsControllerInstallModule

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>

Throws

Memberof

moduleInstallationsControllerUninstallModule

Parameters

Returns Promise<AxiosResponse<ModuleInstallationOutputDTOAPI, any>>

Throws

Memberof

moduleVersionControllerGetModuleVersion

Parameters

Returns Promise<AxiosResponse<ModuleVersionOutputDTOAPI, any>>

Throws

Memberof

moduleVersionControllerSearchVersions

Parameters

Returns Promise<AxiosResponse<ModuleVersionOutputArrayDTOAPI, any>>

Throws

`Protected`axios

`Protected`basePath

`Protected`configuration