Class ModuleApi

ModuleApi - object-oriented interface

Export

ModuleApi

Hierarchy

BaseAPI
- ModuleApi

Index

Constructors

constructor

new ModuleApi(configuration?, basePath?, axios?): 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: undefined | Configuration

Methods

moduleControllerCreate

moduleControllerCreate(moduleCreateDTO?, options?): Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalmoduleCreateDTO: ModuleCreateDTO
  ModuleCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18070

moduleControllerExport

moduleControllerExport(id, options?): Promise<AxiosResponse<ModuleExportDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleExportDTOAPI, any>>
Summary
Export

Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18084

moduleControllerGetOne

moduleControllerGetOne(id, options?): Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18098

moduleControllerImport

moduleControllerImport(builtinModule?, options?): Promise<AxiosResponse<void, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalbuiltinModule: BuiltinModule
  BuiltinModule
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Import

Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18112

moduleControllerRemove

moduleControllerRemove(id, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove

Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18126

moduleControllerSearch

moduleControllerSearch(moduleSearchInputDTO?, options?): Promise<AxiosResponse<ModuleOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- OptionalmoduleSearchInputDTO: ModuleSearchInputDTO
  ModuleSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18140

moduleControllerUpdate

moduleControllerUpdate(id, moduleUpdateDTO?, options?): Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- OptionalmoduleUpdateDTO: ModuleUpdateDTO
  ModuleUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18155

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>>

Summary

Throws

Memberof

moduleControllerExport

Parameters

Returns Promise<AxiosResponse<ModuleExportDTOAPI, any>>

Summary

Throws

Memberof

moduleControllerGetOne

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>

Summary

Throws

Memberof

moduleControllerImport

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

moduleControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

moduleControllerSearch

Parameters

Returns Promise<AxiosResponse<ModuleOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

moduleControllerUpdate

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration