@itwin/imodels-client-management/lib/esm/base/internal/ApiResponseInterfaces.d.ts

iModels API client wrapper for applications that manage iModels.

import { Briefcase, Changeset, ChangesetGroup, Checkpoint, CreateIModelOperationDetails, IModel, Link, Lock, MinimalBriefcase, MinimalChangeset, MinimalIModel, MinimalNamedVersion, MinimalUser, NamedVersion, User } from "../types";
/**
 * Links that are included in all entity list page responses. They simplify pagination implementation because users
 * can send requests using these urls that already include pagination url parameters without having to
 * manually keep track of queried entity count.
 */
export interface CollectionLinks {
    /** Link to the current page. */
    self: Link | null;
    /** Link to the previous page. If `null` it means that the previous page is empty. */
    prev: Link | null;
    /** Link to the next page. If `null` it means that the next page is empty. */
    next: Link | null;
}
export interface ChangesetExtendedDataApiResponse {
    changesetId: string;
    changesetIndex: number;
    data: string;
}
export interface CollectionResponse {
    _links: CollectionLinks;
}
export interface IModelsResponse<TIModel extends MinimalIModel> extends CollectionResponse {
    iModels: TIModel[];
}
export interface BriefcasesResponse<TBriefcase extends MinimalBriefcase> extends CollectionResponse {
    briefcases: TBriefcase[];
}
export interface NamedVersionsResponse<TNamedVersion extends MinimalNamedVersion> extends CollectionResponse {
    namedVersions: TNamedVersion[];
}
export interface ChangesetsResponse<TChangeset extends MinimalChangeset> extends CollectionResponse {
    changesets: TChangeset[];
}
export interface ChangesetExtendedDataListResponse extends CollectionResponse {
    extendedData: ChangesetExtendedDataApiResponse[];
}
export interface ChangesetGroupsResponse extends CollectionResponse {
    changesetGroups: ChangesetGroup[];
}
export interface UsersResponse<TUser extends MinimalUser> extends CollectionResponse {
    users: TUser[];
}
export interface BriefcaseResponse {
    briefcase: Briefcase;
}
export interface ChangesetResponse {
    changeset: Changeset;
}
export interface ChangesetExtendedDataResponse {
    extendedData: ChangesetExtendedDataApiResponse;
}
export interface ChangesetGroupResponse {
    changesetGroup: ChangesetGroup;
}
export interface CheckpointResponse {
    checkpoint: Checkpoint;
}
export interface IModelResponse {
    iModel: IModel;
}
export interface UserResponse {
    user: User;
}
export interface NamedVersionResponse {
    namedVersion: NamedVersion;
}
export interface CreateIModelOperationDetailsResponse {
    createOperation: CreateIModelOperationDetails;
}
export interface LocksResponse extends CollectionResponse {
    locks: Lock[];
}
export interface LockResponse {
    lock: Lock;
}
export interface ReleaseLocksChunkResponse {
    isLastChunk: boolean;
}
//# sourceMappingURL=ApiResponseInterfaces.d.ts.map