@itwin/imodels-client-authoring
Version:
iModels API client wrapper for applications that author iModels.
23 lines • 1.47 kB
TypeScript
import { Briefcase, BriefcaseOperations as ManagementBriefcaseOperations } from "@itwin/imodels-client-management";
import { OperationOptions } from "../OperationOptions";
import { AcquireBriefcaseParams, ReleaseBriefcaseParams } from "./BriefcaseOperationParams";
export declare class BriefcaseOperations<TOptions extends OperationOptions> extends ManagementBriefcaseOperations<TOptions> {
/**
* Acquires a new Briefcase with specified properties. Wraps the
* {@link https://developer.bentley.com/apis/imodels-v2/operations/acquire-imodel-briefcase/ Acquire iModel Briefcase}
* operation from iModels API.
* @param {AcquireBriefcaseParams} params parameters for this operation. See {@link AcquireBriefcaseParams}.
* @returns {Promise<Briefcase>} newly acquired Briefcase. See {@link Briefcase}.
*/
acquire(params: AcquireBriefcaseParams): Promise<Briefcase>;
/**
* Releases the specified Briefcase. Wraps the
* {@link https://developer.bentley.com/apis/imodels-v2/operations/release-imodel-briefcase/ Release iModel Briefcase}
* operation from iModels API.
* @param {ReleaseBriefcaseParams} params parameters for this operation. See {@link ReleaseBriefcaseParams}.
* @returns {Promise<void>} a promise that resolves after operation completes.
*/
release(params: ReleaseBriefcaseParams): Promise<void>;
private getAcquireBriefcaseRequestBody;
}
//# sourceMappingURL=BriefcaseOperations.d.ts.map