Function HookApiFp

HookApi - functional programming interface

Export

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

  • Parameters

    • Optionalconfiguration: Configuration

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

    • hookControllerCreate:function
      • hookControllerCreate(hookCreateDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HookOutputDTOAPI>)>

      • Required permissions: MANAGE_MODULES

        Parameters

        • OptionalhookCreateDTO: HookCreateDTO

          HookCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Create

        Throws

    • hookControllerGetExecutions:function
      • hookControllerGetExecutions(id, success?, eventSearchInputDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventOutputArrayDTOAPI>)>

      • Required permissions: READ_MODULES

        Parameters

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

          EventSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get executions

        Throws

    • hookControllerGetOne:function
      • hookControllerGetOne(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HookOutputDTOAPI>)>

      • Required permissions: READ_MODULES

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get one

        Throws

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

      • Required permissions: MANAGE_MODULES

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Remove

        Throws

    • hookControllerSearch:function
    • hookControllerTrigger:function
      • hookControllerTrigger(hookTriggerDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Summary

        Trigger

        Throws

    • hookControllerUpdate:function
      • hookControllerUpdate(id, hookUpdateDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<HookOutputDTOAPI>)>

      • Required permissions: MANAGE_MODULES

        Parameters

        • id: string
        • OptionalhookUpdateDTO: HookUpdateDTO

          HookUpdateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Update

        Throws

Settings

Member Visibility