Function EventApiFp

EventApi - functional programming interface

Export

  • EventApiFp(
        configuration?: Configuration,
    ): {
        eventControllerCreate(
            eventCreateDTO?: EventCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputDTO>,
        >;
        eventControllerGetFailedFunctions(
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputArrayDTOAPI>,
        >;
        eventControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputDTO>,
        >;
        eventControllerSearch(
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputArrayDTOAPI>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        eventControllerCreate(
            eventCreateDTO?: EventCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputDTO>,
        >;
        eventControllerGetFailedFunctions(
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputArrayDTOAPI>,
        >;
        eventControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputDTO>,
        >;
        eventControllerSearch(
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputArrayDTOAPI>,
        >;
    }

    • eventControllerCreate:function
      • eventControllerCreate(
            eventCreateDTO?: EventCreateDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<EventOutputDTO>,
        >

      • Required permissions: MANAGE_EVENTS
        OperationId: EventControllerCreate

        Parameters

        • OptionaleventCreateDTO: EventCreateDTO

          EventCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Fetches events where cronjob, hook and command failed. Supports all the common query parameters Required permissions: READ_MODULES, READ_EVENTS
        OperationId: EventControllerGetFailedFunctions

        Parameters

        • OptionaleventSearchInputDTO: EventSearchInputDTO

          EventSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Required permissions: READ_EVENTS
        OperationId: EventControllerGetOne

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Required permissions: READ_EVENTS
        OperationId: EventControllerSearch

        Parameters

        • OptionaleventSearchInputDTO: EventSearchInputDTO

          EventSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility