@devopness/sdk-js/dist/api/generated/apis/cron-jobs-api.d.ts

Devopness API JS/TS SDK - Painless essential DevOps to everyone

/**
 * devopness API
 * Devopness API - Painless essential DevOps to everyone
 *
 * The version of the OpenAPI document: latest
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { ApiBaseService } from "../../../services/ApiBaseService";
import { ApiResponse } from "../../../common/ApiResponse";
import { CronJob } from '../../generated/models';
import { CronJobEnvironmentCreate } from '../../generated/models';
import { CronJobRelation } from '../../generated/models';
import { CronJobUpdate } from '../../generated/models';
/**
 * CronJobsApiService - Auto-generated
 */
export declare class CronJobsApiService extends ApiBaseService {
    /**
     *
     * @summary Add a Cron Job to the given environment
     * @param {number} environmentId The ID of the environment.
     * @param {CronJobEnvironmentCreate} cronJobEnvironmentCreate A JSON object containing the resource data
     */
    addEnvironmentCronJob(environmentId: number, cronJobEnvironmentCreate: CronJobEnvironmentCreate): Promise<ApiResponse<CronJob>>;
    /**
     *
     * @summary Delete a given Cron Job
     * @param {number} cronJobId The ID of the cron job.
     */
    deleteCronJob(cronJobId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a Cron Job by ID
     * @param {number} cronJobId The ID of the cron job.
     */
    getCronJob(cronJobId: number): Promise<ApiResponse<CronJob>>;
    /**
     *
     * @summary Return a list of all Cron Jobs belonging to an environment
     * @param {number} environmentId The ID of the environment.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listEnvironmentCronJobs(environmentId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<CronJobRelation>>>;
    /**
     *
     * @summary Update an existing Cron Job
     * @param {number} cronJobId The ID of the cron job.
     * @param {CronJobUpdate} cronJobUpdate A JSON object containing the resource data
     */
    updateCronJob(cronJobId: number, cronJobUpdate: CronJobUpdate): Promise<ApiResponse<void>>;
}