Interface ITestResultsApi

interface ITestResultsApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addCustomFields(
        newFields: CustomTestFieldDefinition[],
        project: string,
    ): Promise<CustomTestFieldDefinition[]>;
    addTestResultsToTestRun(
        results: TestCaseResult[],
        project: string,
        runId: number,
    ): Promise<TestCaseResult[]>;
    addTestResultsToTestRunSession(
        results: TestCaseResult[],
        project: string,
        runId: number,
    ): Promise<TestCaseResult[]>;
    addWorkItemToTestLinks(
        workItemToTestLinks: WorkItemToTestLinks,
        project: string,
    ): Promise<WorkItemToTestLinks>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createBuildAttachmentInLogStore(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        buildId: number,
    ): Promise<void>;
    createEnvironment(
        environments: TestSessionEnvironment[],
        project: string,
    ): Promise<void>;
    createFailureType(
        testResultFailureType: TestResultFailureTypeRequestModel,
        project: string,
    ): Promise<TestResultFailureType>;
    createNotification(
        notifications: TestSessionNotification[],
        project: string,
        sessionId: number,
    ): Promise<number[]>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createTestIterationResultAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
        testCaseResultId: number,
        iterationId: number,
        actionPath?: string,
    ): Promise<TestAttachmentReference>;
    createTestResultAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
        testCaseResultId: number,
    ): Promise<TestAttachmentReference>;
    createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>;
    createTestRunAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
    ): Promise<TestAttachmentReference>;
    createTestRunLogStoreAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
    ): Promise<TestLogStoreAttachmentReference>;
    createTestSession(
        session: TestResultsSession,
        project: string,
    ): Promise<number>;
    createTestSettings(
        testSettings: TestSettings,
        project: string,
    ): Promise<number>;
    createTestSubResultAttachment(
        attachmentRequestModel: TestAttachmentRequestModel,
        project: string,
        runId: number,
        testCaseResultId: number,
        testSubResultId: number,
    ): Promise<TestAttachmentReference>;
    deleteFailureType(project: string, failureTypeId: number): Promise<void>;
    deleteTestMethodToWorkItemLink(
        project: string,
        testName: string,
        workItemId: number,
    ): Promise<boolean>;
    deleteTestResultAttachment(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
    ): Promise<void>;
    deleteTestRun(project: string, runId: number): Promise<void>;
    deleteTestRunAttachment(
        project: string,
        runId: number,
        attachmentId: number,
    ): Promise<void>;
    deleteTestRunLogStoreAttachment(
        project: string,
        runId: number,
        filename: string,
    ): Promise<void>;
    deleteTestSettings(project: string, testSettingsId: number): Promise<void>;
    fetchSourceCodeCoverageReport(
        project: string,
        buildId: number,
    ): Promise<SourceViewBuildCoverage[]>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getBugsLinkedToTestResult(
        project: string,
        runId: number,
        testCaseResultId: number,
    ): Promise<WorkItemReference[]>;
    getBuildCodeCoverage(
        project: string,
        buildId: number,
        flags: number,
    ): Promise<BuildCoverage[]>;
    getCodeCoverageSummary(
        project: string,
        buildId: number,
        deltaBuildId?: number,
    ): Promise<CodeCoverageSummary>;
    getCoverageStatusBadge(
        project: string,
        definition: string,
        branchName?: string,
        label?: string,
    ): Promise<string>;
    getFailureTypes(project: string): Promise<TestResultFailureType[]>;
    getFileLevelCodeCoverage(
        fileCoverageRequest: FileCoverageRequest,
        project: string,
    ): Promise<ReadableStream>;
    getFlakyTestResultsByBuildDefinitionId(
        project: string,
        buildDefinitionId: number,
        minBuildCreatedDate: Date,
    ): Promise<TestCaseResult[]>;
    getFlakyTestResultsByTestRun(
        project: string,
        runId: number,
    ): Promise<TestCaseResult[]>;
    getResultGroupsByBuild(
        project: string,
        buildId: number,
        publishContext: string,
        fields?: string[],
        continuationToken?: string,
    ): Promise<PagedList<FieldDetailsForTestResults>>;
    getResultGroupsByRelease(
        project: string,
        releaseId: number,
        publishContext: string,
        releaseEnvId?: number,
        fields?: string[],
        continuationToken?: string,
    ): Promise<PagedList<FieldDetailsForTestResults>>;
    getSessionNotifications(
        project: string,
        sessionId: number,
    ): Promise<TestSessionNotification[]>;
    getSimilarTestResults(
        customHeaders: any,
        project: string,
        runId: number,
        testResultId: number,
        testSubResultId: number,
        top?: number,
        continuationToken?: String,
    ): Promise<TestCaseResult[]>;
    getTestIterationAttachmentContent(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
        iterationId: number,
    ): Promise<ReadableStream>;
    getTestIterationAttachmentZip(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
        iterationId: number,
    ): Promise<ReadableStream>;
    getTestLogsForBuild(
        customHeaders: any,
        project: string,
        buildId: number,
        type: TestLogType,
        directoryPath?: string,
        fileNamePrefix?: string,
        fetchMetaData?: boolean,
        top?: number,
        continuationToken?: String,
    ): Promise<PagedList<TestLog>>;
    getTestLogStoreEndpointDetailsForBuildLog(
        project: string,
        build: number,
        type: TestLogType,
        filePath: string,
    ): Promise<TestLogStoreEndpointDetails>;
    getTestLogStoreEndpointDetailsForResultLog(
        project: string,
        runId: number,
        resultId: number,
        type: TestLogType,
        filePath: string,
    ): Promise<TestLogStoreEndpointDetails>;
    getTestLogStoreEndpointDetailsForRunLog(
        project: string,
        runId: number,
        type: TestLogType,
        filePath: string,
    ): Promise<TestLogStoreEndpointDetails>;
    getTestLogStoreEndpointDetailsForSubResultLog(
        project: string,
        runId: number,
        resultId: number,
        subResultId: number,
        type: TestLogType,
        filePath: string,
    ): Promise<TestLogStoreEndpointDetails>;
    getTestPipelineMetrics(
        project: string,
        pipelineId: number,
        stageName?: string,
        phaseName?: string,
        jobName?: string,
        metricNames?: Metrics[],
        groupByNode?: boolean,
    ): Promise<PipelineTestMetrics>;
    getTestResultAttachmentContent(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestResultAttachments(
        project: string,
        runId: number,
        testCaseResultId: number,
    ): Promise<TestAttachment[]>;
    getTestResultAttachmentZip(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestResultById(
        project: string,
        runId: number,
        testResultId: number,
        detailsToInclude?: ResultDetails,
    ): Promise<TestCaseResult>;
    getTestResultDetailsForBuild(
        project: string,
        buildId: number,
        publishContext?: string,
        groupBy?: string,
        filter?: string,
        orderby?: string,
        shouldIncludeResults?: boolean,
        queryRunSummaryForInProgress?: boolean,
    ): Promise<TestResultsDetails>;
    getTestResultDetailsForRelease(
        project: string,
        releaseId: number,
        releaseEnvId: number,
        publishContext?: string,
        groupBy?: string,
        filter?: string,
        orderby?: string,
        shouldIncludeResults?: boolean,
        queryRunSummaryForInProgress?: boolean,
    ): Promise<TestResultsDetails>;
    getTestResultLogs(
        customHeaders: any,
        project: string,
        runId: number,
        resultId: number,
        type: TestLogType,
        directoryPath?: string,
        fileNamePrefix?: string,
        fetchMetaData?: boolean,
        top?: number,
        continuationToken?: String,
    ): Promise<PagedList<TestLog>>;
    getTestResults(
        project: string,
        runId: number,
        detailsToInclude?: ResultDetails,
        skip?: number,
        top?: number,
        outcomes?: TestOutcome[],
        newTestsOnly?: boolean,
    ): Promise<TestCaseResult[]>;
    getTestResultsByBuild(
        project: string,
        buildId: number,
        publishContext?: string,
        outcomes?: TestOutcome[],
        top?: number,
        continuationToken?: string,
    ): Promise<PagedList<ShallowTestCaseResult>>;
    getTestResultsByPipeline(
        customHeaders: any,
        project: string,
        pipelineId: number,
        stageName?: string,
        phaseName?: string,
        jobName?: string,
        outcomes?: TestOutcome[],
        top?: number,
        continuationToken?: String,
    ): Promise<PagedList<ShallowTestCaseResult>>;
    getTestResultsByQuery(
        query: TestResultsQuery,
        project: string,
    ): Promise<TestResultsQuery>;
    getTestResultsByQueryWiql(
        queryModel: QueryModel,
        project: string,
        includeResultDetails?: boolean,
        includeIterationDetails?: boolean,
        skip?: number,
        top?: number,
    ): Promise<TestCaseResult[]>;
    getTestResultsByRelease(
        project: string,
        releaseId: number,
        releaseEnvid?: number,
        publishContext?: string,
        outcomes?: TestOutcome[],
        top?: number,
        continuationToken?: string,
    ): Promise<PagedList<ShallowTestCaseResult>>;
    getTestResultsSettings(
        project: string,
        settingsType?: TestResultsSettingsType,
    ): Promise<TestResultsSettings>;
    getTestResultWorkItemsById(
        project: string,
        runId: number,
        testCaseResultId: number,
    ): Promise<WorkItemReference[]>;
    getTestRunAttachmentContent(
        project: string,
        runId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestRunAttachments(
        project: string,
        runId: number,
    ): Promise<TestAttachment[]>;
    getTestRunAttachmentZip(
        project: string,
        runId: number,
        attachmentId: number,
    ): Promise<ReadableStream>;
    getTestRunById(
        project: string,
        runId: number,
        includeDetails?: boolean,
        includeTags?: boolean,
    ): Promise<TestRun>;
    getTestRunCodeCoverage(
        project: string,
        runId: number,
        flags: number,
    ): Promise<TestRunCoverage[]>;
    getTestRunLogs(
        customHeaders: any,
        project: string,
        runId: number,
        type: TestLogType,
        directoryPath?: string,
        fileNamePrefix?: string,
        fetchMetaData?: boolean,
        top?: number,
        continuationToken?: String,
    ): Promise<PagedList<TestLog>>;
    getTestRunLogStoreAttachmentContent(
        project: string,
        runId: number,
        filename: string,
    ): Promise<ReadableStream>;
    getTestRunLogStoreAttachments(
        project: string,
        runId: number,
    ): Promise<TestLogStoreAttachment[]>;
    getTestRunLogStoreAttachmentZip(
        project: string,
        runId: number,
        filename: string,
    ): Promise<ReadableStream>;
    getTestRunMessageLogs(
        project: string,
        runId: number,
    ): Promise<TestMessageLogDetails[]>;
    getTestRuns(
        project: string,
        buildUri?: string,
        owner?: string,
        tmiRunId?: string,
        planId?: number,
        includeRunDetails?: boolean,
        automated?: boolean,
        skip?: number,
        top?: number,
    ): Promise<TestRun[]>;
    getTestRunsBySessionId(
        project: string,
        sessionId: number,
    ): Promise<number[]>;
    getTestRunStatistics(
        project: string,
        runId: number,
    ): Promise<TestRunStatistic>;
    getTestRunSummaryByOutcome(
        project: string,
        runId: number,
    ): Promise<TestRunStatistic>;
    getTestSession(
        project: string,
        buildId: number,
    ): Promise<TestResultsSession[]>;
    getTestSessionLayout(project: string, sessionId: string): Promise<any[]>;
    getTestSessionResults(
        project: string,
        runId: number,
        detailsToInclude?: ResultDetails,
        skip?: number,
        top?: number,
        outcomes?: TestOutcome[],
        newTestsOnly?: boolean,
    ): Promise<TestCaseResult[]>;
    getTestSettingsById(
        project: string,
        testSettingsId: number,
    ): Promise<TestSettings>;
    getTestSubResultAttachmentContent(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
        testSubResultId: number,
    ): Promise<ReadableStream>;
    getTestSubResultAttachments(
        project: string,
        runId: number,
        testCaseResultId: number,
        testSubResultId: number,
    ): Promise<TestAttachment[]>;
    getTestSubResultAttachmentZip(
        project: string,
        runId: number,
        testCaseResultId: number,
        attachmentId: number,
        testSubResultId: number,
    ): Promise<ReadableStream>;
    getTestSubResultLogs(
        customHeaders: any,
        project: string,
        runId: number,
        resultId: number,
        subResultId: number,
        type: TestLogType,
        directoryPath?: string,
        fileNamePrefix?: string,
        fetchMetaData?: boolean,
        top?: number,
        continuationToken?: String,
    ): Promise<PagedList<TestLog>>;
    getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>;
    getTestTagsForRelease(
        project: string,
        releaseId: number,
        releaseEnvId: number,
    ): Promise<TestTag[]>;
    getTestTagSummaryForBuild(
        project: string,
        buildId: number,
    ): Promise<TestTagSummary>;
    getTestTagSummaryForRelease(
        project: string,
        releaseId: number,
        releaseEnvId: number,
    ): Promise<TestTagSummary>;
    publishTestResultDocument(
        document: TestResultDocument,
        project: string,
        runId: number,
    ): Promise<TestResultDocument>;
    queryCustomFields(
        project: string,
        scopeFilter: CustomTestFieldScope,
    ): Promise<CustomTestFieldDefinition[]>;
    queryResultTrendForBuild(
        filter: TestResultTrendFilter,
        project: string,
    ): Promise<AggregatedDataForResultTrend[]>;
    queryResultTrendForRelease(
        filter: TestResultTrendFilter,
        project: string,
    ): Promise<AggregatedDataForResultTrend[]>;
    queryTestHistory(
        filter: TestHistoryQuery,
        project: string,
    ): Promise<TestHistoryQuery>;
    queryTestMethodLinkedWorkItems(
        project: string,
        testName: string,
    ): Promise<TestToWorkItemLinks>;
    queryTestResultHistory(
        filter: ResultsFilter,
        project: string,
    ): Promise<TestResultHistory>;
    queryTestResultsMetaData(
        testCaseReferenceIds: string[],
        project: string,
        detailsToInclude?: ResultMetaDataDetails,
    ): Promise<TestResultMetaData[]>;
    queryTestResultsReportForBuild(
        project: string,
        buildId: number,
        publishContext?: string,
        includeFailureDetails?: boolean,
        buildToCompare?: BuildReference,
    ): Promise<TestResultSummary>;
    queryTestResultsReportForPipeline(
        project: string,
        pipelineId: number,
        stageName?: string,
        phaseName?: string,
        jobName?: string,
        includeFailureDetails?: boolean,
    ): Promise<TestResultSummary>;
    queryTestResultsReportForRelease(
        project: string,
        releaseId: number,
        releaseEnvId: number,
        publishContext?: string,
        includeFailureDetails?: boolean,
        releaseToCompare?: ReleaseReference,
    ): Promise<TestResultSummary>;
    queryTestResultsSummaryForReleases(
        releases: ReleaseReference[],
        project: string,
    ): Promise<TestResultSummary[]>;
    queryTestResultWorkItems(
        project: string,
        workItemCategory: string,
        automatedTestName?: string,
        testCaseId?: number,
        maxCompleteDate?: Date,
        days?: number,
        workItemCount?: number,
    ): Promise<WorkItemReference[]>;
    queryTestRuns(
        project: string,
        minLastUpdatedDate: Date,
        maxLastUpdatedDate: Date,
        state?: TestRunState,
        planIds?: number[],
        isAutomated?: boolean,
        publishContext?: TestRunPublishContext,
        buildIds?: number[],
        buildDefIds?: number[],
        branchName?: string,
        releaseIds?: number[],
        releaseDefIds?: number[],
        releaseEnvIds?: number[],
        releaseEnvDefIds?: number[],
        runTitle?: string,
        top?: number,
        continuationToken?: string,
    ): Promise<PagedList<TestRun>>;
    queryTestSummaryByRequirement(
        resultsContext: TestResultsContext,
        project: string,
        workItemIds?: number[],
    ): Promise<TestSummaryForWorkItem[]>;
    testLogStoreEndpointDetailsForBuild(
        project: string,
        buildId: number,
        testLogStoreOperationType: TestLogStoreOperationType,
    ): Promise<TestLogStoreEndpointDetails>;
    testLogStoreEndpointDetailsForResult(
        project: string,
        runId: number,
        resultId: number,
        subResultId: number,
        filePath: string,
        type: TestLogType,
    ): Promise<TestLogStoreEndpointDetails>;
    testLogStoreEndpointDetailsForRun(
        project: string,
        runId: number,
        testLogStoreOperationType: TestLogStoreOperationType,
        filePath?: string,
        type?: TestLogType,
    ): Promise<TestLogStoreEndpointDetails>;
    testResultsGroupDetails(
        project: string,
        pipelineId: number,
        stageName?: string,
        phaseName?: string,
        jobName?: string,
        shouldIncludeFailedAndAbortedResults?: boolean,
        queryGroupSummaryForInProgress?: boolean,
    ): Promise<TestResultsDetails>;
    updateCodeCoverageSummary(
        project: string,
        buildId: number,
        coverageData?: CodeCoverageData,
    ): Promise<void>;
    updatePipelinesTestSettings(
        testResultsUpdateSettings: TestResultsUpdateSettings,
        project: string,
    ): Promise<TestResultsSettings>;
    updateTestResults(
        results: TestCaseResult[],
        project: string,
        runId: number,
    ): Promise<TestCaseResult[]>;
    updateTestResultsMetaData(
        testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput,
        project: string,
        testCaseReferenceId: number,
    ): Promise<TestResultMetaData>;
    updateTestResultsToTestRunSession(
        results: TestCaseResult[],
        project: string,
        runId: number,
    ): Promise<number[]>;
    updateTestRun(
        runUpdateModel: RunUpdateModel,
        project: string,
        runId: number,
    ): Promise<TestRun>;
    updateTestRunTags(
        testTagsUpdateModel: TestTagsUpdateModel,
        project: string,
        runId: number,
    ): Promise<TestTag[]>;
}