@devopness/sdk-js/dist/api/generated/apis/pipelines-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 { Pipeline } from '../../generated/models';
import { PipelineCreate } from '../../generated/models';
import { PipelineRelation } from '../../generated/models';
import { PipelineUpdate } from '../../generated/models';
/**
 * PipelinesApiService - Auto-generated
 */
export declare class PipelinesApiService extends ApiBaseService {
    /**
     *
     * @summary Add a Pipeline to a resource
     * @param {number} resourceId The resource ID.
     * @param {string} resourceType The resource type to add a pipeline to.
     * @param {PipelineCreate} pipelineCreate A JSON object containing the resource data
     */
    addPipeline(resourceId: number, resourceType: string, pipelineCreate: PipelineCreate): Promise<ApiResponse<Pipeline>>;
    /**
     *
     * @summary Delete a given Pipeline
     * @param {number} pipelineId The ID of the pipeline.
     */
    deletePipeline(pipelineId: number): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a Pipeline by ID
     * @param {number} pipelineId The ID of the pipeline.
     */
    getPipeline(pipelineId: number): Promise<ApiResponse<Pipeline>>;
    /**
     *
     * @summary Return a list of pipelines to a resource
     * @param {number} resourceId The resource ID.
     * @param {string} resourceType The resource type to get pipelines from.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listPipelinesByResourceType(resourceId: number, resourceType: string, page?: number, perPage?: number): Promise<ApiResponse<Array<PipelineRelation>>>;
    /**
     *
     * @summary Update an existing Pipeline
     * @param {number} pipelineId The ID of the pipeline.
     * @param {PipelineUpdate} pipelineUpdate A JSON object containing the resource data
     */
    updatePipeline(pipelineId: number, pipelineUpdate: PipelineUpdate): Promise<ApiResponse<void>>;
}