Function HookApiFp

HookApi - functional programming interface

Export

  • HookApiFp(
        configuration?: 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?: HookCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<HookOutputDTOAPI>,
        >

      • Required permissions: MANAGE_MODULES
        OperationId: HookControllerCreate

        Parameters

        • OptionalhookCreateDTO: HookCreateDTO

          HookCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Required permissions: READ_MODULES
        OperationId: HookControllerGetExecutions

        Parameters

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

          EventSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Required permissions: READ_MODULES
        OperationId: HookControllerGetOne

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Required permissions: MANAGE_MODULES
        OperationId: HookControllerRemove

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • hookControllerSearch:function
      • hookControllerSearch(
            hookSearchInputDTO?: HookSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<HookOutputArrayDTOAPI>,
        >

      • Required permissions: READ_MODULES
        OperationId: HookControllerSearch

        Parameters

        • OptionalhookSearchInputDTO: HookSearchInputDTO

          HookSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

        Parameters

        • OptionalhookTriggerDTO: HookTriggerDTO

          HookTriggerDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Required permissions: MANAGE_MODULES
        OperationId: HookControllerUpdate

        Parameters

        • id: string
        • OptionalhookUpdateDTO: HookUpdateDTO

          HookUpdateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility