ModuleApi - functional programming interface

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        moduleControllerCreate(moduleCreateDTO?: ModuleCreateDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleOutputDTOAPI>)>;
        moduleControllerExport(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleExportDTOAPI>)>;
        moduleControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModuleOutputDTOAPI>)>;
        moduleControllerImport(builtinModule?: BuiltinModule, 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>)>;
    }

    • moduleControllerCreate:function
    • moduleControllerExport:function
      • Required permissions: READ_MODULES

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Export

    • moduleControllerGetOne:function
      • Required permissions: READ_MODULES

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Get one

    • moduleControllerImport:function
      • Required permissions: MANAGE_MODULES

        Parameters

        • OptionalbuiltinModule: BuiltinModule

          BuiltinModule

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Import

    • moduleControllerRemove:function
      • Required permissions: MANAGE_MODULES

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Remove

    • moduleControllerSearch:function
    • moduleControllerUpdate:function
      • Required permissions: MANAGE_MODULES

        Parameters

        • id: string
        • OptionalmoduleUpdateDTO: ModuleUpdateDTO

          ModuleUpdateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Update