@devopness/sdk-js/dist/api/generated/apis/pipelines-hooks-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 { Hook } from '../../generated/models';
import { HookPipelineCreate } from '../../generated/models';
import { HookRelation } from '../../generated/models';
import { HookTypeParam } from '../../generated/models';
/**
 * PipelinesHooksApiService - Auto-generated
 */
export declare class PipelinesHooksApiService extends ApiBaseService {
    /**
     *
     * @summary Create a hook to a specific pipeline
     * @param {HookTypeParam} hookType The type of the hook.
     * @param {number} pipelineId The ID of the pipeline that will be executed by the created action
     * @param {HookPipelineCreate} hookPipelineCreate A JSON object containing the resource data
     */
    addPipelineHook(hookType: HookTypeParam, pipelineId: number, hookPipelineCreate: HookPipelineCreate): Promise<ApiResponse<Hook>>;
    /**
     *
     * @summary List all hooks in a pipeline
     * @param {number} pipelineId The ID of the pipeline.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listPipelineHooks(pipelineId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<HookRelation>>>;
}