@itwin/clash-detection-client/lib/esm/operations/run/RunOperations.d.ts

Clash Detection client for the iTwin platform

import { OperationsBase } from "../../base/OperationsBase";
import type { MinimalRun, RunDetails } from "../../base/interfaces/apiEntities/RunInterfaces";
import type { OperationOptions } from "../OperationOptions";
import type { ParamsToDeleteRun, ParamsToGetRun, ParamsToGetRunList } from "./RunOperationParams";
export declare class RunOperations<TOptions extends OperationOptions> extends OperationsBase<TOptions> {
    constructor(options: TOptions);
    /**
     * Gets Runs for a specific project. This method returns Runs in their minimal representation. The
     * returned iterator internally queries entities in pages. Wraps the
     * {@link https://developer.bentley.com/apis/clash-detection/operations/get-clashdetection-runs/ Get Runs}
     * operation from Clash Detection API.
     * @param {ParamsToGetRunList} params parameters for this operation. See {@link ParamsToGetRunList}.
     * @returns {Promise<MinimalRun[]>} minimal Run list. See {@link MinimalRun}.
     */
    getMinimalList(params: ParamsToGetRunList): Promise<MinimalRun[]>;
    /**
     * Gets Runs for a specific project. This method returns Runs in their full representation. The returned
     * iterator internally queries entities in pages. Wraps the
     * {@link https://developer.bentley.com/apis/clash-detection/operations/get-clashdetection-runs/ Get Runs}
     * operation from Clash Detection API.
     * @param {ParamsToGetRunList} params parameters for this operation. See {@link ParamsToGetRunList}.
     * @returns {Promise<RunDetails[]>} array of Run details. See {@link RunDetails}.
     */
    getRepresentationList(params: ParamsToGetRunList): Promise<RunDetails[]>;
    /**
     * Gets a single Run identified by id. This method returns a Run in its full representation.
     * Wraps the {@link https://developer.bentley.com/apis/clash-detection/operations/get-clashdetection-run/
     * Get Run} operation from Clash Detection API.
     * @param {ParamsToGetRun} params parameters for this operation. See {@link ParamsToGetRun}.
     * @returns {Promise<RunDetails>} a Run with specified id. See {@link RunDetails}.
     */
    getSingle(params: ParamsToGetRun): Promise<RunDetails>;
    /**
     * Deletes a Run. Wraps the {@link https://developer.bentley.com/apis/clash-detection/operations/delete-clashdetection-run/
     * Delete Run} operation from Clash Detection API.
     * @param {ParamsToDeleteRun} params parameters for this operation. See {@link ParamsToDeleteRun}.
     * @returns {Promise<void>}.
     */
    delete(params: ParamsToDeleteRun): Promise<void>;
}
//# sourceMappingURL=RunOperations.d.ts.map