;
/**
* Gets the coverage status for the last successful build of a definition, optionally scoped to a specific branch
*
* @param {string} project - Project ID or project name
* @param {string} definition - The ID or name of the definition.
* @param {string} branchName - The branch name.
* @param {string} label - The String to replace the default text on the left side of the badge.
*/
getCoverageStatusBadge(project: string, definition: string, branchName?: string, label?: string): Promise;
/**
* Get all the tags in a build.
*
* @param {string} project - Project ID or project name
* @param {number} buildId - Build ID
*/
getTestTagsForBuild(project: string, buildId: number): Promise;
/**
* Get all the tags in a release.
*
* @param {string} project - Project ID or project name
* @param {number} releaseId - Release ID
* @param {number} releaseEnvId - Release environment ID
*/
getTestTagsForRelease(project: string, releaseId: number, releaseEnvId: number): Promise;
/**
* Update tags of a run, Tags can be Added and Deleted
*
* @param {Contracts.TestTagsUpdateModel} testTagsUpdateModel - TestTagsUpdateModel
* @param {string} project - Project ID or project name
* @param {number} runId - RunId of the run
*/
updateTestRunTags(testTagsUpdateModel: Contracts.TestTagsUpdateModel, project: string, runId: number): Promise;
/**
* Get all the tags in a build.
*
* @param {string} project - Project ID or project name
* @param {number} buildId - Build ID
*/
getTestTagSummaryForBuild(project: string, buildId: number): Promise;
/**
* Get all the tags in a release.
*
* @param {string} project - Project ID or project name
* @param {number} releaseId - Release ID
* @param {number} releaseEnvId - Release environment ID
*/
getTestTagSummaryForRelease(project: string, releaseId: number, releaseEnvId: number): Promise;
/**
* Creates an attachment in the LogStore for the specified buildId.
*
* @param {Contracts.TestAttachmentRequestModel} attachmentRequestModel - Contains attachment info like stream, filename, comment, attachmentType
* @param {string} project - Project ID or project name
* @param {number} buildId - BuildId
*/
createBuildAttachmentInLogStore(attachmentRequestModel: Contracts.TestAttachmentRequestModel, project: string, buildId: number): Promise;
/**
* Creates an attachment in the LogStore for the specified runId.
*
* @param {Contracts.TestAttachmentRequestModel} attachmentRequestModel - Contains attachment info like stream, filename, comment, attachmentType
* @param {string} project - Project ID or project name
* @param {number} runId - Test RunId
*/
createTestRunLogStoreAttachment(attachmentRequestModel: Contracts.TestAttachmentRequestModel, project: string, runId: number): Promise;
/**
* Deletes the attachment with the specified filename for the specified runId from the LogStore.
*
* @param {string} project - Project ID or project name
* @param {number} runId - Test RunId
* @param {string} filename - Attachment FileName
*/
deleteTestRunLogStoreAttachment(project: string, runId: number, filename: string): Promise;
/**
* Returns the attachment with the specified filename for the specified runId from the LogStore.
*
* @param {string} project - Project ID or project name
* @param {number} runId - Test RunId
* @param {string} filename - Attachment FileName
*/
getTestRunLogStoreAttachmentContent(project: string, runId: number, filename: string): Promise;
/**
* Returns a list of attachments for the specified runId from the LogStore.
*
* @param {string} project - Project ID or project name
* @param {number} runId - Test RunId
*/
getTestRunLogStoreAttachments(project: string, runId: number): Promise;
/**
* Returns the attachment with the specified filename for the specified runId from the LogStore.
*
* @param {string} project - Project ID or project name
* @param {number} runId - Test RunId
* @param {string} filename - Attachment FileName
*/
getTestRunLogStoreAttachmentZip(project: string, runId: number, filename: string): Promise;
/**
* Creates a new test failure type
*
* @param {Contracts.TestResultFailureTypeRequestModel} testResultFailureType
* @param {string} project - Project ID or project name
*/
createFailureType(testResultFailureType: Contracts.TestResultFailureTypeRequestModel, project: string): Promise;
/**
* Deletes a test failure type with specified failureTypeId
*
* @param {string} project - Project ID or project name
* @param {number} failureTypeId
*/
deleteFailureType(project: string, failureTypeId: number): Promise;
/**
* Returns the list of test failure types.
*
* @param {string} project - Project ID or project name
*/
getFailureTypes(project: string): Promise;
/**
* Get history of a test method using TestHistoryQuery
*
* @param {Contracts.TestHistoryQuery} filter - TestHistoryQuery to get history
* @param {string} project - Project ID or project name
*/
queryTestHistory(filter: Contracts.TestHistoryQuery, project: string): Promise;
/**
* Get list of build attachments reference
*
* @param {string} project - Project ID or project name
* @param {number} buildId - Id of the build to get
* @param {Contracts.TestLogType} type - type of the attachment to get
* @param {string} directoryPath - directory path for which attachments are needed
* @param {string} fileNamePrefix - file name prefix to filter the list of attachment
* @param {boolean} fetchMetaData - Default is false, set if metadata is needed
* @param {number} top - Number of test attachments reference to return
* @param {String} continuationToken - Header to pass the continuationToken
*/
getTestLogsForBuild(customHeaders: any, project: string, buildId: number, type: Contracts.TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise>;
/**
* Get list of test result attachments reference
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the test run that contains the result
* @param {number} resultId - Id of the test result
* @param {Contracts.TestLogType} type - type of attachments to get
* @param {string} directoryPath - directory path of attachments to get
* @param {string} fileNamePrefix - file name prefix to filter the list of attachment
* @param {boolean} fetchMetaData - Default is false, set if metadata is needed
* @param {number} top - Numbe of attachments reference to return
* @param {String} continuationToken - Header to pass the continuationToken
*/
getTestResultLogs(customHeaders: any, project: string, runId: number, resultId: number, type: Contracts.TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise>;
/**
* Get list of test subresult attachments reference
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the test run that contains the results
* @param {number} resultId - Id of the test result that contains subresult
* @param {number} subResultId - Id of the test subresult
* @param {Contracts.TestLogType} type - type of the attachments to get
* @param {string} directoryPath - directory path of the attachment to get
* @param {string} fileNamePrefix - file name prefix to filter the list of attachments
* @param {boolean} fetchMetaData - Default is false, set if metadata is needed
* @param {number} top - Number of attachments reference to return
* @param {String} continuationToken - Header to pass the continuationToken
*/
getTestSubResultLogs(customHeaders: any, project: string, runId: number, resultId: number, subResultId: number, type: Contracts.TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise>;
/**
* Get list of test run attachments reference
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the test run
* @param {Contracts.TestLogType} type - type of the attachments to get
* @param {string} directoryPath - directory path for which attachments are needed
* @param {string} fileNamePrefix - file name prefix to filter the list of attachment
* @param {boolean} fetchMetaData - Default is false, set if metadata is needed
* @param {number} top - Number of attachments reference to return
* @param {String} continuationToken - Header to pass the continuationToken
*/
getTestRunLogs(customHeaders: any, project: string, runId: number, type: Contracts.TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise>;
/**
* Get SAS Uri of a build attachment
*
* @param {string} project - Project ID or project name
* @param {number} build - Id of the build to get
* @param {Contracts.TestLogType} type - type of the file
* @param {string} filePath - filePath for which sas uri is needed
*/
getTestLogStoreEndpointDetailsForBuildLog(project: string, build: number, type: Contracts.TestLogType, filePath: string): Promise;
/**
* Create and Get sas uri of the build container
*
* @param {string} project - Project ID or project name
* @param {number} buildId - Id of the build to get
* @param {Contracts.TestLogStoreOperationType} testLogStoreOperationType - Type of operation to perform using sas uri
*/
testLogStoreEndpointDetailsForBuild(project: string, buildId: number, testLogStoreOperationType: Contracts.TestLogStoreOperationType): Promise;
/**
* Get SAS Uri of a test results attachment
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the test run that contains result
* @param {number} resultId - Id of the test result whose files need to be downloaded
* @param {Contracts.TestLogType} type - type of the file
* @param {string} filePath - filePath for which sas uri is needed
*/
getTestLogStoreEndpointDetailsForResultLog(project: string, runId: number, resultId: number, type: Contracts.TestLogType, filePath: string): Promise;
/**
* Get SAS Uri of a test subresults attachment
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the test run that contains result
* @param {number} resultId - Id of the test result that contains subresult
* @param {number} subResultId - Id of the test subresult whose file sas uri is needed
* @param {Contracts.TestLogType} type - type of the file
* @param {string} filePath - filePath for which sas uri is needed
*/
getTestLogStoreEndpointDetailsForSubResultLog(project: string, runId: number, resultId: number, subResultId: number, type: Contracts.TestLogType, filePath: string): Promise;
/**
* Create empty file for a result and Get Sas uri for the file
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the test run that contains the result
* @param {number} resultId - Id of the test results that contains sub result
* @param {number} subResultId - Id of the test sub result whose file sas uri is needed
* @param {string} filePath - file path inside the sub result for which sas uri is needed
* @param {Contracts.TestLogType} type - Type of the file for download
*/
testLogStoreEndpointDetailsForResult(project: string, runId: number, resultId: number, subResultId: number, filePath: string, type: Contracts.TestLogType): Promise;
/**
* Get SAS Uri of a test run attachment
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the test run whose file has to be downloaded
* @param {Contracts.TestLogType} type - type of the file
* @param {string} filePath - filePath for which sas uri is needed
*/
getTestLogStoreEndpointDetailsForRunLog(project: string, runId: number, type: Contracts.TestLogType, filePath: string): Promise;
/**
* Create empty file for a run and Get Sas uri for the file
*
* @param {string} project - Project ID or project name
* @param {number} runId - Id of the run to get endpoint details
* @param {Contracts.TestLogStoreOperationType} testLogStoreOperationType - Type of operation to perform using sas uri
* @param {string} filePath - file path to create an empty file
* @param {Contracts.TestLogType} type - Default is GeneralAttachment, type of empty file to be created
*/
testLogStoreEndpointDetailsForRun(project: string, runId: number, testLogStoreOperationType: Contracts.TestLogStoreOperationType, filePath?: string, type?: Contracts.TestLogType): Promise;
/**
* Retrieves Test runs associated to a session
*
* @param {string} project - Project ID or project name
* @param {number} sessionId - Id of TestResults session to obtain Test Runs for.
*/
getTestRunsBySessionId(project: string, sessionId: number): Promise;
/**
* Creates TestResultsSession object in TCM data store
*
* @param {Contracts.TestResultsSession} session - Received session object.
* @param {string} project - Project ID or project name
*/
createTestSession(session: Contracts.TestResultsSession, project: string): Promise;
/**
* Retrieves TestResultsSession metadata object in TCM data store
*
* @param {string} project - Project ID or project name
* @param {number} buildId
*/
getTestSession(project: string, buildId: number): Promise;
/**
* Retrieves TestResultsSession Layout object in TCM data store
*
* @param {string} project - Project ID or project name
* @param {string} sessionId
*/
getTestSessionLayout(project: string, sessionId: string): Promise;
/**
* Creates Environment object in TCM data store
*
* @param {Contracts.TestSessionEnvironment[]} environments - Received Environment object.
* @param {string} project - Project ID or project name
*/
createEnvironment(environments: Contracts.TestSessionEnvironment[], project: string): Promise;
/**
* Creates Notification object in TCM data store for a given session
*
* @param {Contracts.TestSessionNotification[]} notifications - Notification(s) to add for the specified sessionId
* @param {string} project - Project ID or project name
* @param {number} sessionId - ID of Session to add Notification
*/
createNotification(notifications: Contracts.TestSessionNotification[], project: string, sessionId: number): Promise;
/**
* Retrieves TestResultsSession Notification objects in TCM data store
*
* @param {string} project - Project ID or project name
* @param {number} sessionId - Id of TestResults session to obtain Notifications for.
*/
getSessionNotifications(project: string, sessionId: number): Promise;
/**
* Add Test Results to test run session
*
* @param {Contracts.TestCaseResult[]} results
* @param {string} project - Project ID or project name
* @param {number} runId - RunId of test run
*/
addTestResultsToTestRunSession(results: Contracts.TestCaseResult[], project: string, runId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} runId
* @param {Contracts.ResultDetails} detailsToInclude
* @param {number} skip
* @param {number} top
* @param {Contracts.TestOutcome[]} outcomes
* @param {boolean} newTestsOnly
*/
getTestSessionResults(project: string, runId: number, detailsToInclude?: Contracts.ResultDetails, skip?: number, top?: number, outcomes?: Contracts.TestOutcome[], newTestsOnly?: boolean): Promise;
/**
* Creates TestResultsMRX objects in TCM data store for existing test results
*
* @param {Contracts.TestCaseResult[]} results - Results object with only test results MRX properties and existing testResultId
* @param {string} project - Project ID or project name
* @param {number} runId - RunId of test run
*/
updateTestResultsToTestRunSession(results: Contracts.TestCaseResult[], project: string, runId: number): Promise;
/**
* @param {Contracts.TestSettings} testSettings
* @param {string} project - Project ID or project name
*/
createTestSettings(testSettings: Contracts.TestSettings, project: string): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} testSettingsId
*/
deleteTestSettings(project: string, testSettingsId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} testSettingsId
*/
getTestSettingsById(project: string, testSettingsId: number): Promise;
/**
* @param {Contracts.WorkItemToTestLinks} workItemToTestLinks
* @param {string} project - Project ID or project name
*/
addWorkItemToTestLinks(workItemToTestLinks: Contracts.WorkItemToTestLinks, project: string): Promise;
/**
* @param {string} project - Project ID or project name
* @param {string} testName
* @param {number} workItemId
*/
deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {string} testName
*/
queryTestMethodLinkedWorkItems(project: string, testName: string): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} runId
* @param {number} testCaseResultId
*/
getTestResultWorkItemsById(project: string, runId: number, testCaseResultId: number): Promise;
/**
* Query Test Result WorkItems based on filter
*
* @param {string} project - Project ID or project name
* @param {string} workItemCategory - can take values Microsoft.BugCategory or all(for getting all workitems)
* @param {string} automatedTestName
* @param {number} testCaseId
* @param {Date} maxCompleteDate
* @param {number} days
* @param {number} workItemCount
*/
queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise;
}