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: undefined | Configuration

Methods

moduleControllerCreate

moduleControllerCreate(
moduleCreateDTO?: ModuleCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ModuleOutputDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: ModuleControllerCreate
Parameters
- OptionalmoduleCreateDTO: ModuleCreateDTO
  ModuleCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ModuleOutputDTOAPI>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18421

moduleControllerExport

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

moduleControllerGetOne

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

moduleControllerImport

moduleControllerImport(
builtinModule?: BuiltinModule,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Required permissions: MANAGE_MODULES
OperationId: ModuleControllerImport
Parameters
- OptionalbuiltinModule: BuiltinModule
  BuiltinModule
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18463

moduleControllerRemove

moduleControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_MODULES
OperationId: ModuleControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
ModuleApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18477

moduleControllerSearch

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

moduleControllerUpdate

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

Class ModuleApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ModuleApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

moduleControllerCreate

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI>>

Throws

Memberof

moduleControllerExport

Parameters

Returns Promise<AxiosResponse<ModuleExportDTOAPI>>

Throws

Memberof

moduleControllerGetOne

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI>>

Throws

Memberof

moduleControllerImport

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

moduleControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

moduleControllerSearch

Parameters

Returns Promise<AxiosResponse<ModuleOutputArrayDTOAPI>>

Throws

Memberof

moduleControllerUpdate

Parameters

Returns Promise<AxiosResponse<ModuleOutputDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration