Function HookApiFactory

Returns {
    hookControllerCreate(hookCreateDTO?: HookCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<HookOutputDTOAPI>;
    hookControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
    hookControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<HookOutputDTOAPI>;
    hookControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    hookControllerSearch(hookSearchInputDTO?: HookSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<HookOutputArrayDTOAPI>;
    hookControllerTrigger(hookTriggerDTO?: HookTriggerDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    hookControllerUpdate(id: string, hookUpdateDTO?: HookUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<HookOutputDTOAPI>;
}

• hookControllerCreate:function

  • hookControllerCreate(hookCreateDTO?, options?): AxiosPromise<HookOutputDTOAPI>

  • Required permissions: MANAGE_MODULES

    Parameters

    • OptionalhookCreateDTO: HookCreateDTO

      HookCreateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<HookOutputDTOAPI>

    Summary

    Create

    Throws

• hookControllerGetExecutions:function

  • hookControllerGetExecutions(id, success?, eventSearchInputDTO?, options?): AxiosPromise<EventOutputArrayDTOAPI>

  • Required permissions: READ_MODULES

    Parameters

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

      EventSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EventOutputArrayDTOAPI>

    Summary

    Get executions

    Throws

• hookControllerGetOne:function

  • hookControllerGetOne(id, options?): AxiosPromise<HookOutputDTOAPI>

  • Required permissions: READ_MODULES

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<HookOutputDTOAPI>

    Summary

    Get one

    Throws

• hookControllerRemove:function

  • hookControllerRemove(id, options?): AxiosPromise<APIOutput>

  • Required permissions: MANAGE_MODULES

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Summary

    Remove

    Throws

• hookControllerSearch:function

  • hookControllerSearch(hookSearchInputDTO?, options?): AxiosPromise<HookOutputArrayDTOAPI>

  • Required permissions: READ_MODULES

    Parameters

    • OptionalhookSearchInputDTO: HookSearchInputDTO

      HookSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<HookOutputArrayDTOAPI>

    Summary

    Search

    Throws

• hookControllerTrigger:function

  • hookControllerTrigger(hookTriggerDTO?, options?): AxiosPromise<void>

  • 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

    Parameters

    • OptionalhookTriggerDTO: HookTriggerDTO

      HookTriggerDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Trigger

    Throws

• hookControllerUpdate:function

  • hookControllerUpdate(id, hookUpdateDTO?, options?): AxiosPromise<HookOutputDTOAPI>

  • Required permissions: MANAGE_MODULES

    Parameters

    • id: string
    • OptionalhookUpdateDTO: HookUpdateDTO

      HookUpdateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<HookOutputDTOAPI>

    Summary

    Update

    Throws