Function ModuleApiFp

ModuleApi - functional programming interface

Export

  • ModuleApiFp(
        configuration?: Configuration,
    ): {
        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>,
        >;
    }

  • 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
      • moduleControllerCreate(
            moduleCreateDTO?: ModuleCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ModuleOutputDTOAPI>,
        >

      • Required permissions: MANAGE_MODULES
        OperationId: ModuleControllerCreate

        Parameters

        • OptionalmoduleCreateDTO: ModuleCreateDTO

          ModuleCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • moduleControllerExport:function
      • moduleControllerExport(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ModuleExportDTOAPI>,
        >

      • Required permissions: READ_MODULES
        OperationId: ModuleControllerExport

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • moduleControllerGetOne:function
      • moduleControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ModuleOutputDTOAPI>,
        >

      • Required permissions: READ_MODULES
        OperationId: ModuleControllerGetOne

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • moduleControllerImport:function
      • moduleControllerImport(
            builtinModule?: BuiltinModule,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Required permissions: MANAGE_MODULES
        OperationId: ModuleControllerImport

        Parameters

        • OptionalbuiltinModule: BuiltinModule

          BuiltinModule

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • moduleControllerRemove:function
      • moduleControllerRemove(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
        >

      • Required permissions: MANAGE_MODULES
        OperationId: ModuleControllerRemove

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • moduleControllerSearch:function
      • moduleControllerSearch(
            moduleSearchInputDTO?: ModuleSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ModuleOutputArrayDTOAPI>,
        >

      • Required permissions: READ_MODULES
        OperationId: ModuleControllerSearch

        Parameters

        • OptionalmoduleSearchInputDTO: ModuleSearchInputDTO

          ModuleSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • moduleControllerUpdate:function
      • moduleControllerUpdate(
            id: string,
            moduleUpdateDTO?: ModuleUpdateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ModuleOutputDTOAPI>,
        >

      • Required permissions: MANAGE_MODULES
        OperationId: ModuleControllerUpdate

        Parameters

        • id: string
        • OptionalmoduleUpdateDTO: ModuleUpdateDTO

          ModuleUpdateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility