@devopness/sdk-js/dist/api/generated/apis/actions-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 { Action } from '../../generated/models';
import { ActionRelation } from '../../generated/models';
import { ActionRetryResponse } from '../../generated/models';
/**
 * ActionsApiService - Auto-generated
 */
export declare class ActionsApiService extends ApiBaseService {
    /**
     *
     * @summary Get an action by ID
     * @param {number} actionId The ID of the action.
     */
    getAction(actionId: number): Promise<ApiResponse<Action>>;
    /**
     *
     * @summary Return a list of all actions belonging to current user
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listActions(page?: number, perPage?: number): Promise<ApiResponse<Array<ActionRelation>>>;
    /**
     *
     * @summary List resource actions of an action type
     * @param {number} resourceId The resource ID.
     * @param {string} resourceType The resource type to get related actions.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listActionsByResourceType(resourceId: number, resourceType: string, page?: number, perPage?: number): Promise<ApiResponse<Array<ActionRelation>>>;
    /**
     *
     * @summary List actions triggered to a given action target resource
     * @param {number} targetResourceId The resource ID of the action target.
     * @param {string} targetResourceType The resource type of the action target on which this action will be executed to perform operations on the action resource.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listActionsByTargetResourceType(targetResourceId: number, targetResourceType: string, page?: number, perPage?: number): Promise<ApiResponse<Array<ActionRelation>>>;
    /**
     *
     * @summary Retry an action
     * @param {number} actionId The ID of the action.
     */
    retryAction(actionId: number): Promise<ApiResponse<ActionRetryResponse>>;
}