Function HookApiFactory

HookApi - factory interface

Export

  • HookApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        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>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    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
    • hookControllerGetExecutions:function
    • hookControllerGetOne:function
    • hookControllerRemove:function
      • hookControllerRemove(
            id: string,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<APIOutput>

      • Required permissions: MANAGE_MODULES
        OperationId: HookControllerRemove

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<APIOutput>

        Throws

    • hookControllerSearch:function
    • hookControllerTrigger:function
      • hookControllerTrigger(
            hookTriggerDTO?: HookTriggerDTO,
            options?: RawAxiosRequestConfig,
        ): 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
        OperationId: HookControllerTrigger

        Parameters

        • OptionalhookTriggerDTO: HookTriggerDTO

          HookTriggerDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • hookControllerUpdate:function

Settings

Member Visibility