Function ModuleApiAxiosParamCreator

ModuleApi - axios parameter creator

Export

  • ModuleApiAxiosParamCreator(configuration?): {
        moduleControllerCreate: ((moduleCreateDTO?: ModuleCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerExport: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerImport: ((builtinModule?: BuiltinModule, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerSearch: ((moduleSearchInputDTO?: ModuleSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerUpdate: ((id: string, moduleUpdateDTO?: ModuleUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        moduleControllerCreate: ((moduleCreateDTO?: ModuleCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerExport: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerImport: ((builtinModule?: BuiltinModule, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerSearch: ((moduleSearchInputDTO?: ModuleSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        moduleControllerUpdate: ((id: string, moduleUpdateDTO?: ModuleUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • moduleControllerCreate: ((moduleCreateDTO?: ModuleCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Create

      Throws

        • (moduleCreateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalmoduleCreateDTO: ModuleCreateDTO

            ModuleCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • moduleControllerExport: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_MODULES

      Summary

      Export

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • moduleControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_MODULES

      Summary

      Get one

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • moduleControllerImport: ((builtinModule?: BuiltinModule, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Import

      Throws

        • (builtinModule?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalbuiltinModule: BuiltinModule

            BuiltinModule

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • moduleControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Remove

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • moduleControllerSearch: ((moduleSearchInputDTO?: ModuleSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_MODULES

      Summary

      Search

      Throws

        • (moduleSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalmoduleSearchInputDTO: ModuleSearchInputDTO

            ModuleSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • moduleControllerUpdate: ((id: string, moduleUpdateDTO?: ModuleUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Update

      Throws

        • (id, moduleUpdateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • OptionalmoduleUpdateDTO: ModuleUpdateDTO

            ModuleUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility