Function CommandApiAxiosParamCreator

CommandApi - axios parameter creator

Export

  • CommandApiAxiosParamCreator(configuration?): {
        commandControllerCreate: ((commandCreateDTO?: CommandCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerCreateArgument: ((commandArgumentCreateDTO?: CommandArgumentCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerGetExecutions: ((id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerRemoveArgument: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerSearch: ((commandSearchInputDTO?: CommandSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerTrigger: ((id: string, commandTriggerDTO?: CommandTriggerDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerUpdate: ((id: string, commandUpdateDTO?: CommandUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerUpdateArgument: ((id: string, commandArgumentUpdateDTO?: CommandArgumentUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        commandControllerCreate: ((commandCreateDTO?: CommandCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerCreateArgument: ((commandArgumentCreateDTO?: CommandArgumentCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerGetExecutions: ((id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerRemoveArgument: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerSearch: ((commandSearchInputDTO?: CommandSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerTrigger: ((id: string, commandTriggerDTO?: CommandTriggerDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerUpdate: ((id: string, commandUpdateDTO?: CommandUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        commandControllerUpdateArgument: ((id: string, commandArgumentUpdateDTO?: CommandArgumentUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • commandControllerCreate: ((commandCreateDTO?: CommandCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Create

      Throws

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

        • Parameters

          • OptionalcommandCreateDTO: CommandCreateDTO

            CommandCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • commandControllerCreateArgument: ((commandArgumentCreateDTO?: CommandArgumentCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Create argument

      Throws

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

        • Parameters

          • OptionalcommandArgumentCreateDTO: CommandArgumentCreateDTO

            CommandArgumentCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • commandControllerGetExecutions: ((id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_MODULES

      Summary

      Get executions

      Throws

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

        • Parameters

          • id: string
          • Optionalsuccess: any
          • OptionaleventSearchInputDTO: EventSearchInputDTO

            EventSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • commandControllerGetOne: ((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>

    • commandControllerRemove: ((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>

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

      Required permissions: MANAGE_MODULES

      Summary

      Remove argument

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • commandControllerSearch: ((commandSearchInputDTO?: CommandSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_MODULES

      Summary

      Search

      Throws

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

        • Parameters

          • OptionalcommandSearchInputDTO: CommandSearchInputDTO

            CommandSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • commandControllerTrigger: ((id: string, commandTriggerDTO?: CommandTriggerDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Trigger

      Throws

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

        • Parameters

          • id: string
          • OptionalcommandTriggerDTO: CommandTriggerDTO

            CommandTriggerDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • commandControllerUpdate: ((id: string, commandUpdateDTO?: CommandUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Update

      Throws

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

        • Parameters

          • id: string
          • OptionalcommandUpdateDTO: CommandUpdateDTO

            CommandUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • commandControllerUpdateArgument: ((id: string, commandArgumentUpdateDTO?: CommandArgumentUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Update argument

      Throws

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

        • Parameters

          • id: string
          • OptionalcommandArgumentUpdateDTO: CommandArgumentUpdateDTO

            CommandArgumentUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility