Function ModuleApiFactory

ModuleApi - factory interface

Export

ModuleApiFactory(configuration?, basePath?, axios?): {
    moduleControllerCreate(moduleCreateDTO?: ModuleCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
    moduleControllerExport(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleExportDTOAPI>;
    moduleControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
    moduleControllerImport(builtinModule?: BuiltinModule, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    moduleControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    moduleControllerSearch(moduleSearchInputDTO?: ModuleSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputArrayDTOAPI>;
    moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    moduleControllerCreate(moduleCreateDTO?: ModuleCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
    moduleControllerExport(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleExportDTOAPI>;
    moduleControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
    moduleControllerImport(builtinModule?: BuiltinModule, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    moduleControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    moduleControllerSearch(moduleSearchInputDTO?: ModuleSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputArrayDTOAPI>;
    moduleControllerUpdate(id: string, moduleUpdateDTO?: ModuleUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<ModuleOutputDTOAPI>;
}
- moduleControllerCreate:function
  - moduleControllerCreate(moduleCreateDTO?, options?): AxiosPromise<ModuleOutputDTOAPI>
  - Required permissions: MANAGE_MODULES
    Parameters
    - OptionalmoduleCreateDTO: ModuleCreateDTO
      ModuleCreateDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ModuleOutputDTOAPI>
    Summary
    Create
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:17388
- moduleControllerExport:function
  - moduleControllerExport(id, options?): AxiosPromise<ModuleExportDTOAPI>
  - Required permissions: READ_MODULES
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ModuleExportDTOAPI>
    Summary
    Export
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:17401
- moduleControllerGetOne:function
  - moduleControllerGetOne(id, options?): AxiosPromise<ModuleOutputDTOAPI>
  - Required permissions: READ_MODULES
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ModuleOutputDTOAPI>
    Summary
    Get one
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:17411
- moduleControllerImport:function
  - moduleControllerImport(builtinModule?, options?): AxiosPromise<void>
  - Required permissions: MANAGE_MODULES
    Parameters
    - OptionalbuiltinModule: BuiltinModule
      BuiltinModule
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Summary
    Import
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:17421
- moduleControllerRemove:function
  - moduleControllerRemove(id, options?): AxiosPromise<APIOutput>
  - Required permissions: MANAGE_MODULES
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<APIOutput>
    Summary
    Remove
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:17431
- moduleControllerSearch:function
  - moduleControllerSearch(moduleSearchInputDTO?, options?): AxiosPromise<ModuleOutputArrayDTOAPI>
  - Required permissions: READ_MODULES
    Parameters
    - OptionalmoduleSearchInputDTO: ModuleSearchInputDTO
      ModuleSearchInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ModuleOutputArrayDTOAPI>
    Summary
    Search
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:17441
- moduleControllerUpdate:function
  - moduleControllerUpdate(id, moduleUpdateDTO?, options?): AxiosPromise<ModuleOutputDTOAPI>
  - Required permissions: MANAGE_MODULES
    Parameters
    - id: string
    - OptionalmoduleUpdateDTO: ModuleUpdateDTO
      ModuleUpdateDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ModuleOutputDTOAPI>
    Summary
    Update
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:17457
- Defined in packages/lib-apiclient/src/generated/api.ts:17378

Function ModuleApiFactory

Export

Parameters

moduleControllerCreate:function

Parameters

Returns AxiosPromise<ModuleOutputDTOAPI>

Summary

Throws

moduleControllerExport:function

Parameters

Returns AxiosPromise<ModuleExportDTOAPI>

Summary

Throws

moduleControllerGetOne:function

Parameters

Returns AxiosPromise<ModuleOutputDTOAPI>

Summary

Throws

moduleControllerImport:function

Parameters

Returns AxiosPromise<void>

Summary

Throws

moduleControllerRemove:function

Parameters

Returns AxiosPromise<APIOutput>

Summary

Throws

moduleControllerSearch:function

Parameters

Returns AxiosPromise<ModuleOutputArrayDTOAPI>

Summary

Throws

moduleControllerUpdate:function

Parameters

Returns AxiosPromise<ModuleOutputDTOAPI>

Summary

Throws

Settings