Function EventApiFp

EventApi - functional programming interface

Export

  • EventApiFp(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?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventOutputDTO>)>

      • Required permissions: MANAGE_EVENTS

        Parameters

        • OptionaleventCreateDTO: EventCreateDTO

          EventCreateDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Create

        Throws

    • eventControllerGetFailedFunctions:function
      • eventControllerGetFailedFunctions(eventSearchInputDTO?, options?): 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

        Parameters

        • OptionaleventSearchInputDTO: EventSearchInputDTO

          EventSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get failed functions

        Throws

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

      • Required permissions: READ_EVENTS

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Get one

        Throws

    • eventControllerSearch:function

Settings

Member Visibility