;
/**
* Gets the build status for a definition, optionally scoped to a specific branch, stage, job, and configuration.
If there are more than one, then it is required to pass in a stageName value when specifying a jobName, and the same rule then applies for both if passing a configuration parameter.
*
* @param {string} project - Project ID or project name
* @param {string} definition - Either the definition name with optional leading folder path, or the definition id.
* @param {string} branchName - Only consider the most recent build for this branch. If not specified, the default branch is used.
* @param {string} stageName - Use this stage within the pipeline to render the status.
* @param {string} jobName - Use this job within a stage of the pipeline to render the status.
* @param {string} configuration - Use this job configuration to render the status
* @param {string} label - Replaces the default text on the left side of the badge.
*/
getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise;
/**
* Adds a tag to a build.
*
* @param {string} project - Project ID or project name
* @param {number} buildId - The ID of the build.
* @param {string} tag - The tag to add.
*/
addBuildTag(project: string, buildId: number, tag: string): Promise;
/**
* Adds tags to a build.
*
* @param {string[]} tags - The tags to add. Request body is composed directly from listed tags.
* @param {string} project - Project ID or project name
* @param {number} buildId - The ID of the build.
*/
addBuildTags(tags: string[], project: string, buildId: number): Promise;
/**
* Removes a tag from a build. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+)
*
* @param {string} project - Project ID or project name
* @param {number} buildId - The ID of the build.
* @param {string} tag - The tag to remove.
*/
deleteBuildTag(project: string, buildId: number, tag: string): Promise;
/**
* Gets the tags for a build.
*
* @param {string} project - Project ID or project name
* @param {number} buildId - The ID of the build.
*/
getBuildTags(project: string, buildId: number): Promise;
/**
* Adds/Removes tags from a build.
*
* @param {BuildInterfaces.UpdateTagParameters} updateParameters - The tags to add/remove.
* @param {string} project - Project ID or project name
* @param {number} buildId - The ID of the build.
*/
updateBuildTags(updateParameters: BuildInterfaces.UpdateTagParameters, project: string, buildId: number): Promise;
/**
* Adds a tag to a definition
*
* @param {string} project - Project ID or project name
* @param {number} definitionId - The ID of the definition.
* @param {string} tag - The tag to add.
*/
addDefinitionTag(project: string, definitionId: number, tag: string): Promise;
/**
* Adds multiple tags to a definition.
*
* @param {string[]} tags - The tags to add.
* @param {string} project - Project ID or project name
* @param {number} definitionId - The ID of the definition.
*/
addDefinitionTags(tags: string[], project: string, definitionId: number): Promise;
/**
* Removes a tag from a definition. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+)
*
* @param {string} project - Project ID or project name
* @param {number} definitionId - The ID of the definition.
* @param {string} tag - The tag to remove.
*/
deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise;
/**
* Gets the tags for a definition.
*
* @param {string} project - Project ID or project name
* @param {number} definitionId - The ID of the definition.
* @param {number} revision - The definition revision number. If not specified, uses the latest revision of the definition.
*/
getDefinitionTags(project: string, definitionId: number, revision?: number): Promise;
/**
* Adds/Removes tags from a definition.
*
* @param {BuildInterfaces.UpdateTagParameters} updateParameters - The tags to add/remove.
* @param {string} project - Project ID or project name
* @param {number} definitionId - The ID of the definition.
*/
updateDefinitionTags(updateParameters: BuildInterfaces.UpdateTagParameters, project: string, definitionId: number): Promise;
/**
* Removes a tag from builds, definitions, and from the tag store
*
* @param {string} project - Project ID or project name
* @param {string} tag - The tag to remove.
*/
deleteTag(project: string, tag: string): Promise;
/**
* Gets a list of all build tags in the project.
*
* @param {string} project - Project ID or project name
*/
getTags(project: string): Promise;
/**
* Deletes a build definition template.
*
* @param {string} project - Project ID or project name
* @param {string} templateId - The ID of the template.
*/
deleteTemplate(project: string, templateId: string): Promise;
/**
* Gets a specific build definition template.
*
* @param {string} project - Project ID or project name
* @param {string} templateId - The ID of the requested template.
*/
getTemplate(project: string, templateId: string): Promise;
/**
* Gets all definition templates.
*
* @param {string} project - Project ID or project name
*/
getTemplates(project: string): Promise;
/**
* Updates an existing build definition template.
*
* @param {BuildInterfaces.BuildDefinitionTemplate} template - The new version of the template.
* @param {string} project - Project ID or project name
* @param {string} templateId - The ID of the template.
*/
saveTemplate(template: BuildInterfaces.BuildDefinitionTemplate, project: string, templateId: string): Promise;
/**
* Gets details for a build
*
* @param {string} project - Project ID or project name
* @param {number} buildId
* @param {string} timelineId
* @param {number} changeId
* @param {string} planId
*/
getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise;
/**
* Recreates the webhooks for the specified triggers in the given source code repository.
*
* @param {BuildInterfaces.DefinitionTriggerType[]} triggerTypes - The types of triggers to restore webhooks for.
* @param {string} project - Project ID or project name
* @param {string} providerName - The name of the source provider.
* @param {string} serviceEndpointId - If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
* @param {string} repository - If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.
*/
restoreWebhooks(triggerTypes: BuildInterfaces.DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise;
/**
* Gets a list of webhooks installed in the given source code repository.
*
* @param {string} project - Project ID or project name
* @param {string} providerName - The name of the source provider.
* @param {string} serviceEndpointId - If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
* @param {string} repository - If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.
*/
listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise;
/**
* Gets the work items associated with a build. Only work items in the same project are returned.
*
* @param {string} project - Project ID or project name
* @param {number} buildId - The ID of the build.
* @param {number} top - The maximum number of work items to return.
*/
getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise;
/**
* Gets the work items associated with a build, filtered to specific commits.
*
* @param {string[]} commitIds - A comma-delimited list of commit IDs.
* @param {string} project - Project ID or project name
* @param {number} buildId - The ID of the build.
* @param {number} top - The maximum number of work items to return, or the number of commits to consider if no commit IDs are specified.
*/
getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise;
/**
* Gets all the work items between two builds.
*
* @param {string} project - Project ID or project name
* @param {number} fromBuildId - The ID of the first build.
* @param {number} toBuildId - The ID of the last build.
* @param {number} top - The maximum number of work items to return.
*/
getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise;
/**
* Converts a definition to YAML, optionally at a specific revision.
*
* @param {string} project - Project ID or project name
* @param {number} definitionId - The ID of the definition.
* @param {number} revision - The revision number to retrieve. If this is not specified, the latest version will be returned.
* @param {Date} minMetricsTime - If specified, indicates the date from which metrics should be included.
* @param {string[]} propertyFilters - A comma-delimited list of properties to include in the results.
* @param {boolean} includeLatestBuilds
*/
getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise;
}