Function HookApiAxiosParamCreator

HookApi - axios parameter creator

Export

  • HookApiAxiosParamCreator(configuration?): {
        hookControllerCreate: ((hookCreateDTO?: HookCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerGetExecutions: ((id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerSearch: ((hookSearchInputDTO?: HookSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerTrigger: ((hookTriggerDTO?: HookTriggerDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerUpdate: ((id: string, hookUpdateDTO?: HookUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        hookControllerCreate: ((hookCreateDTO?: HookCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerGetExecutions: ((id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerSearch: ((hookSearchInputDTO?: HookSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerTrigger: ((hookTriggerDTO?: HookTriggerDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        hookControllerUpdate: ((id: string, hookUpdateDTO?: HookUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • hookControllerCreate: ((hookCreateDTO?: HookCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Create

      Throws

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

        • Parameters

          • OptionalhookCreateDTO: HookCreateDTO

            HookCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

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

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

    • hookControllerSearch: ((hookSearchInputDTO?: HookSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_MODULES

      Summary

      Search

      Throws

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

        • Parameters

          • OptionalhookSearchInputDTO: HookSearchInputDTO

            HookSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • hookControllerTrigger: ((hookTriggerDTO?: HookTriggerDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Trigger a hook. This is used for testing purposes, the event will not actually be created but the hook-logic will be executed. You can pass any data you want, but it must validate against the corresponding event metadata. Eg to trigger the chat-message event, you must pass an object with a message property Required permissions: MANAGE_MODULES

      Summary

      Trigger

      Throws

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

        • Parameters

          • OptionalhookTriggerDTO: HookTriggerDTO

            HookTriggerDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • hookControllerUpdate: ((id: string, hookUpdateDTO?: HookUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_MODULES

      Summary

      Update

      Throws

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

        • Parameters

          • id: string
          • OptionalhookUpdateDTO: HookUpdateDTO

            HookUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility