Function EventApiAxiosParamCreator

EventApi - axios parameter creator

Export

  • EventApiAxiosParamCreator(configuration?): {
        eventControllerCreate: ((eventCreateDTO?: EventCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        eventControllerGetFailedFunctions: ((eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        eventControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        eventControllerSearch: ((eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        eventControllerCreate: ((eventCreateDTO?: EventCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        eventControllerGetFailedFunctions: ((eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        eventControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        eventControllerSearch: ((eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • eventControllerCreate: ((eventCreateDTO?: EventCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_EVENTS

      Summary

      Create

      Throws

        • (eventCreateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionaleventCreateDTO: EventCreateDTO

            EventCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • eventControllerGetFailedFunctions: ((eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Summary

      Get failed functions

      Throws

        • (eventSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionaleventSearchInputDTO: EventSearchInputDTO

            EventSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • eventControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_EVENTS

      Summary

      Get one

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • eventControllerSearch: ((eventSearchInputDTO?: EventSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_EVENTS

      Summary

      Search

      Throws

        • (eventSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionaleventSearchInputDTO: EventSearchInputDTO

            EventSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility