Takaro - v0.6.0
    Preparing search index...

    Function CronJobApiFp

    • CronJobApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          cronJobControllerCreate(
              cronJobCreateDTO?: CronJobCreateDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<CronJobOutputDTOAPI>,
          >;
          cronJobControllerGetExecutions(
              id: string,
              success?: any,
              eventSearchInputDTO?: EventSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<EventOutputArrayDTOAPI>,
          >;
          cronJobControllerGetOne(
              id: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<CronJobOutputDTOAPI>,
          >;
          cronJobControllerRemove(
              id: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
          >;
          cronJobControllerSearch(
              cronJobSearchInputDTO?: CronJobSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<CronJobOutputArrayDTOAPI>,
          >;
          cronJobControllerTrigger(
              cronJobTriggerDTO?: CronJobTriggerDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          cronJobControllerUpdate(
              id: string,
              cronJobUpdateDTO?: CronJobUpdateDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<CronJobOutputDTOAPI>,
          >;
      }

      • cronJobControllerCreate: function
        • Required permissions: MANAGE_MODULES
          OperationId: CronJobControllerCreate

          Parameters

          • OptionalcronJobCreateDTO: CronJobCreateDTO

            CronJobCreateDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • cronJobControllerGetExecutions: function
        • Required permissions: READ_MODULES
          OperationId: CronJobControllerGetExecutions

          Parameters

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

            EventSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • cronJobControllerGetOne: function
        • Required permissions: READ_MODULES
          OperationId: CronJobControllerGetOne

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • cronJobControllerRemove: function
        • Required permissions: MANAGE_MODULES
          OperationId: CronJobControllerRemove

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • cronJobControllerSearch: function
        • Search cronjobs Required permissions: READ_MODULES
          OperationId: CronJobControllerSearch

          Parameters

          • OptionalcronJobSearchInputDTO: CronJobSearchInputDTO

            CronJobSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • cronJobControllerTrigger: function
        • Required permissions: MANAGE_MODULES
          OperationId: CronJobControllerTrigger

          Parameters

          • OptionalcronJobTriggerDTO: CronJobTriggerDTO

            CronJobTriggerDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • cronJobControllerUpdate: function
        • Required permissions: MANAGE_MODULES
          OperationId: CronJobControllerUpdate

          Parameters

          • id: string
          • OptionalcronJobUpdateDTO: CronJobUpdateDTO

            CronJobUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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