@itwin/property-validation-client/lib/cjs/base/interfaces/apiEntities/TestInterfaces.d.ts

Property Validation client for the iTwin platform

import type { AllUserMetadata, CollectionResponse, Link } from "../CommonInterfaces";
/** Links that belong to Test entity returned from Property Validation API. */
export interface TestDetailLinks {
    /** Link to get user info of creator. */
    createdBy: Link;
    /** Link to get user info of last modifier. */
    lastModifiedBy: Link;
}
export interface TestLinks {
    /** Link to get user info of creator. */
    createdBy: Link;
    /** Link to get user info of last modifier. */
    lastModifiedBy: Link;
    /** Link to get Test details. */
    test: Link;
}
/** Test item. */
export interface TestItem {
    /** Test id. */
    id: string;
    /** Test display name. */
    displayName: string;
    /** Test description. */
    description: string;
    /** Test creation date. */
    creationDateTime: string;
    /** Test modification date. */
    modificationDateTime: string;
    _links: TestLinks;
}
/** Test details. */
export interface TestDetails {
    /** Test display name. */
    displayName: string;
    /** Test description. */
    description: string;
    /** Test creation date. */
    creationDateTime: string;
    /** Test modification date. */
    modificationDateTime: string;
    /** Test rule ids. */
    rules: string[];
    /** Stop execution on failure flag. */
    stopExecutionOnFailure: boolean;
    /** User metadata. */
    userMetadata: AllUserMetadata;
    _links: TestDetailLinks;
}
/** Get Test API response. */
export interface ResponseFromGetTest {
    test: TestDetails;
}
/** Test list API response. */
export interface ResponseFromGetTestList extends CollectionResponse {
    tests: TestItem[];
}
export interface TestSelfLink {
    /** Link to get created test. */
    self: Link;
}
/** Test details. */
export interface Test {
    /** Test id. */
    id: string;
    /** Test display name. */
    displayName: string;
    /** Test description. */
    description: string;
    /** Test rule ids. */
    rules: string[];
    /** Stop execution on failure flag. */
    stopExecutionOnFailure: boolean;
    _links: TestSelfLink;
}
/** Create Test API Response. */
export interface ResponseFromCreateTest {
    test: Test;
}
/** Create Test API Response. */
export declare type ResponseFromUpdateTest = ResponseFromCreateTest;
export interface RunLink {
    /** Link to get Run. */
    run: Link;
}
/** Minimal representation of a Run. */
export interface Run {
    /** Run id. */
    id: string;
    _links: RunLink;
}
/** Run test API Response. */
export interface ResponseFromRunTest {
    run: Run;
}
//# sourceMappingURL=TestInterfaces.d.ts.map