@devopness/sdk-js/dist/api/generated/apis/resource-links-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 { ResourceLinkRelation } from '../../generated/models';
/**
 * ResourceLinksApiService - Auto-generated
 */
export declare class ResourceLinksApiService extends ApiBaseService {
    /**
     *
     * @summary Link the given resources
     * @param {number} childId The child resource ID.
     * @param {string} childType The resource type of the child resource.
     * @param {number} resourceId The parent resource ID.
     * @param {string} resourceType The resource type of the parent resource.
     */
    linkResourceLinkToResourceLink(childId: number, childType: string, resourceId: number, resourceType: string): Promise<ApiResponse<void>>;
    /**
     *
     * @summary List linked resources of the given resource
     * @param {number} resourceId The resource ID.
     * @param {string} resourceType The resource type to get linked resources.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     */
    listResourceLinksByResourceType(resourceId: number, resourceType: string, page?: number, perPage?: number): Promise<ApiResponse<Array<ResourceLinkRelation>>>;
    /**
     *
     * @summary List resources linked to a base resource.
     * @param {string} linkType The link type of resources to be retrieved: &#x60;child&#x60; or &#x60;parent&#x60;.
     * @param {number} resourceId The ID of the base resource
     * @param {string} resourceType The base resource type used from which linked resources will be retrieved.
     * @param {number} [page] Number of the page to be retrieved
     * @param {number} [perPage] Number of items returned per page
     * @param {string} [linkedResourceType] Filter only linked resources of this resource type.
     */
    listResourceLinksByResourceTypeAndLinkType(linkType: string, resourceId: number, resourceType: string, page?: number, perPage?: number, linkedResourceType?: string): Promise<ApiResponse<Array<ResourceLinkRelation>>>;
    /**
     *
     * @summary Delete a given resource link
     * @param {number} childId The child resource ID.
     * @param {string} childType The resource type of the child resource.
     * @param {number} resourceId The parent resource ID.
     * @param {string} resourceType The resource type of the parent resource.
     */
    unlinkResourceLinkFromResourceLink(childId: number, childType: string, resourceId: number, resourceType: string): Promise<ApiResponse<void>>;
}