@devopness/sdk-js/dist/api/generated/apis/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 { HookTriggerResponse } from '../../generated/models';
import { HookTypeParam } from '../../generated/models';
import { HookUpdate } from '../../generated/models';
/**
 * HooksApiService - Auto-generated
 */
export declare class HooksApiService extends ApiBaseService {
    /**
     *
     * @summary Delete a given hook
     * @param {string} hookId The ID of the hook.
     * @param {HookTypeParam} hookType The type of the hook.
     */
    deleteHook(hookId: string, hookType: HookTypeParam): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a hook by ID
     * @param {string} hookId The ID of the hook.
     * @param {HookTypeParam} hookType The type of the hook.
     */
    getHook(hookId: string, hookType: HookTypeParam): Promise<ApiResponse<Hook>>;
    /**
     *
     * @summary Trigger an incoming hook associated action
     * @param {string} hookId The ID of the hook.
     */
    triggerHook(hookId: string): Promise<ApiResponse<HookTriggerResponse>>;
    /**
     *
     * @summary Update an existing hook
     * @param {string} hookId The ID of the hook.
     * @param {HookTypeParam} hookType The type of the hook.
     * @param {HookUpdate} hookUpdate A JSON object containing the resource data
     */
    updateHook(hookId: string, hookType: HookTypeParam, hookUpdate: HookUpdate): Promise<ApiResponse<void>>;
}