UNPKG

56.4 kBTypeScriptView Raw
1/// <reference types="node" />
2import basem = require('./ClientApiBases');
3import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
4import FormInputInterfaces = require("./interfaces/common/FormInputInterfaces");
5import ReleaseInterfaces = require("./interfaces/ReleaseInterfaces");
6import VSSInterfaces = require("./interfaces/common/VSSInterfaces");
7export interface IReleaseApi extends basem.ClientApiBase {
8 getAgentArtifactDefinitions(project: string, releaseId: number): Promise<ReleaseInterfaces.AgentArtifactDefinition[]>;
9 getApprovals(project: string, assignedToFilter?: string, statusFilter?: ReleaseInterfaces.ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ReleaseInterfaces.ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseInterfaces.ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.ReleaseApproval>>;
10 getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseInterfaces.ReleaseApproval>;
11 getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseInterfaces.ReleaseApproval>;
12 updateReleaseApproval(approval: ReleaseInterfaces.ReleaseApproval, project: string, approvalId: number): Promise<ReleaseInterfaces.ReleaseApproval>;
13 updateReleaseApprovals(approvals: ReleaseInterfaces.ReleaseApproval[], project: string): Promise<ReleaseInterfaces.ReleaseApproval[]>;
14 getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<NodeJS.ReadableStream>;
15 getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<NodeJS.ReadableStream>;
16 getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseInterfaces.ReleaseTaskAttachment[]>;
17 getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseInterfaces.ReleaseTaskAttachment[]>;
18 getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<ReleaseInterfaces.AutoTriggerIssue[]>;
19 getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>;
20 getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseInterfaces.Change[]>;
21 getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<ReleaseInterfaces.DefinitionEnvironmentReference[]>;
22 createReleaseDefinition(releaseDefinition: ReleaseInterfaces.ReleaseDefinition, project: string): Promise<ReleaseInterfaces.ReleaseDefinition>;
23 deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>;
24 getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): Promise<ReleaseInterfaces.ReleaseDefinition>;
25 getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<NodeJS.ReadableStream>;
26 getReleaseDefinitions(project: string, searchText?: string, expand?: ReleaseInterfaces.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: ReleaseInterfaces.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean, searchTextContainsFolderName?: boolean): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.ReleaseDefinition>>;
27 undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseInterfaces.ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseInterfaces.ReleaseDefinition>;
28 updateReleaseDefinition(releaseDefinition: ReleaseInterfaces.ReleaseDefinition, project: string): Promise<ReleaseInterfaces.ReleaseDefinition>;
29 getDeployments(project: string, definitionId?: number, definitionEnvironmentId?: number, createdBy?: string, minModifiedTime?: Date, maxModifiedTime?: Date, deploymentStatus?: ReleaseInterfaces.DeploymentStatus, operationStatus?: ReleaseInterfaces.DeploymentOperationStatus, latestAttemptsOnly?: boolean, queryOrder?: ReleaseInterfaces.ReleaseQueryOrder, top?: number, continuationToken?: number, createdFor?: string, minStartedTime?: Date, maxStartedTime?: Date, sourceBranch?: string): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.Deployment>>;
30 getDeploymentsForMultipleEnvironments(queryParameters: ReleaseInterfaces.DeploymentQueryParameters, project: string): Promise<ReleaseInterfaces.Deployment[]>;
31 getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseInterfaces.ReleaseEnvironmentExpands): Promise<ReleaseInterfaces.ReleaseEnvironment>;
32 updateReleaseEnvironment(environmentUpdateData: ReleaseInterfaces.ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseInterfaces.ReleaseEnvironment>;
33 createDefinitionEnvironmentTemplate(template: ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate>;
34 deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>;
35 getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate>;
36 listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate[]>;
37 undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate>;
38 createFavorites(favoriteItems: ReleaseInterfaces.FavoriteItem[], project: string, scope: string, identityId?: string): Promise<ReleaseInterfaces.FavoriteItem[]>;
39 deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>;
40 getFavorites(project: string, scope: string, identityId?: string): Promise<ReleaseInterfaces.FavoriteItem[]>;
41 getFlightAssignments(flightName?: string): Promise<string[]>;
42 createFolder(folder: ReleaseInterfaces.Folder, project: string, path?: string): Promise<ReleaseInterfaces.Folder>;
43 deleteFolder(project: string, path: string): Promise<void>;
44 getFolders(project: string, path?: string, queryOrder?: ReleaseInterfaces.FolderPathQueryOrder): Promise<ReleaseInterfaces.Folder[]>;
45 updateFolder(folder: ReleaseInterfaces.Folder, project: string, path: string): Promise<ReleaseInterfaces.Folder>;
46 updateGates(gateUpdateMetadata: ReleaseInterfaces.GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseInterfaces.ReleaseGates>;
47 getReleaseHistory(project: string, releaseId: number): Promise<ReleaseInterfaces.ReleaseRevision[]>;
48 getInputValues(query: FormInputInterfaces.InputValuesQuery, project: string): Promise<FormInputInterfaces.InputValuesQuery>;
49 getIssues(project: string, buildId: number, sourceId?: string): Promise<ReleaseInterfaces.AutoTriggerIssue[]>;
50 getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<NodeJS.ReadableStream>;
51 getLogs(project: string, releaseId: number): Promise<NodeJS.ReadableStream>;
52 getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<NodeJS.ReadableStream>;
53 getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<NodeJS.ReadableStream>;
54 getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<NodeJS.ReadableStream>;
55 getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ReleaseInterfaces.ManualIntervention>;
56 getManualInterventions(project: string, releaseId: number): Promise<ReleaseInterfaces.ManualIntervention[]>;
57 updateManualIntervention(manualInterventionUpdateMetadata: ReleaseInterfaces.ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ReleaseInterfaces.ManualIntervention>;
58 getMetrics(project: string, minMetricsTime?: Date): Promise<ReleaseInterfaces.Metric[]>;
59 getOrgPipelineReleaseSettings(): Promise<ReleaseInterfaces.OrgPipelineReleaseSettings>;
60 updateOrgPipelineReleaseSettings(newSettings: ReleaseInterfaces.OrgPipelineReleaseSettingsUpdateParameters): Promise<ReleaseInterfaces.OrgPipelineReleaseSettings>;
61 getPipelineReleaseSettings(project: string): Promise<ReleaseInterfaces.ProjectPipelineReleaseSettings>;
62 updatePipelineReleaseSettings(newSettings: ReleaseInterfaces.ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ReleaseInterfaces.ProjectPipelineReleaseSettings>;
63 getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ReleaseInterfaces.ProjectReference[]>;
64 getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseInterfaces.ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseInterfaces.ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseInterfaces.ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.Release>>;
65 createRelease(releaseStartMetadata: ReleaseInterfaces.ReleaseStartMetadata, project: string): Promise<ReleaseInterfaces.Release>;
66 deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>;
67 getRelease(project: string, releaseId: number, approvalFilters?: ReleaseInterfaces.ApprovalFilters, propertyFilters?: string[], expand?: ReleaseInterfaces.SingleReleaseExpands, topGateRecords?: number): Promise<ReleaseInterfaces.Release>;
68 getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseInterfaces.ReleaseDefinitionSummary>;
69 getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<NodeJS.ReadableStream>;
70 undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>;
71 updateRelease(release: ReleaseInterfaces.Release, project: string, releaseId: number): Promise<ReleaseInterfaces.Release>;
72 updateReleaseResource(releaseUpdateMetadata: ReleaseInterfaces.ReleaseUpdateMetadata, project: string, releaseId: number): Promise<ReleaseInterfaces.Release>;
73 getReleaseSettings(project: string): Promise<ReleaseInterfaces.ReleaseSettings>;
74 updateReleaseSettings(releaseSettings: ReleaseInterfaces.ReleaseSettings, project: string): Promise<ReleaseInterfaces.ReleaseSettings>;
75 getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<NodeJS.ReadableStream>;
76 getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseInterfaces.ReleaseDefinitionRevision[]>;
77 getSummaryMailSections(project: string, releaseId: number): Promise<ReleaseInterfaces.SummaryMailSection[]>;
78 sendSummaryMail(mailMessage: ReleaseInterfaces.MailMessage, project: string, releaseId: number): Promise<void>;
79 getSourceBranches(project: string, definitionId: number): Promise<string[]>;
80 addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>;
81 addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>;
82 deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>;
83 getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>;
84 addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>;
85 addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>;
86 deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>;
87 getReleaseTags(project: string, releaseId: number): Promise<string[]>;
88 getTags(project: string): Promise<string[]>;
89 getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseInterfaces.ReleaseTask[]>;
90 getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseInterfaces.ReleaseTask[]>;
91 getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseInterfaces.ReleaseTask[]>;
92 getArtifactTypeDefinitions(project: string): Promise<ReleaseInterfaces.ArtifactTypeDefinition[]>;
93 getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ReleaseInterfaces.ArtifactVersionQueryResult>;
94 getArtifactVersionsForSources(artifacts: ReleaseInterfaces.Artifact[], project: string): Promise<ReleaseInterfaces.ArtifactVersionQueryResult>;
95 getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseInterfaces.ReleaseWorkItemRef[]>;
96}
97export declare class ReleaseApi extends basem.ClientApiBase implements IReleaseApi {
98 constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions);
99 static readonly RESOURCE_AREA_ID = "efc2f575-36ef-48e9-b672-0c6fb4a48ac5";
100 /**
101 * Returns the artifact details that automation agent requires
102 *
103 * @param {string} project - Project ID or project name
104 * @param {number} releaseId
105 */
106 getAgentArtifactDefinitions(project: string, releaseId: number): Promise<ReleaseInterfaces.AgentArtifactDefinition[]>;
107 /**
108 * Get a list of approvals
109 *
110 * @param {string} project - Project ID or project name
111 * @param {string} assignedToFilter - Approvals assigned to this user.
112 * @param {ReleaseInterfaces.ApprovalStatus} statusFilter - Approvals with this status. Default is 'pending'.
113 * @param {number[]} releaseIdsFilter - Approvals for release id(s) mentioned in the filter. Multiple releases can be mentioned by separating them with ',' e.g. releaseIdsFilter=1,2,3,4.
114 * @param {ReleaseInterfaces.ApprovalType} typeFilter - Approval with this type.
115 * @param {number} top - Number of approvals to get. Default is 50.
116 * @param {number} continuationToken - Gets the approvals after the continuation token provided.
117 * @param {ReleaseInterfaces.ReleaseQueryOrder} queryOrder - Gets the results in the defined order of created approvals. Default is 'descending'.
118 * @param {boolean} includeMyGroupApprovals - 'true' to include my group approvals. Default is 'false'.
119 */
120 getApprovals(project: string, assignedToFilter?: string, statusFilter?: ReleaseInterfaces.ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ReleaseInterfaces.ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseInterfaces.ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.ReleaseApproval>>;
121 /**
122 * Get approval history.
123 *
124 * @param {string} project - Project ID or project name
125 * @param {number} approvalStepId - Id of the approval.
126 */
127 getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseInterfaces.ReleaseApproval>;
128 /**
129 * Get an approval.
130 *
131 * @param {string} project - Project ID or project name
132 * @param {number} approvalId - Id of the approval.
133 * @param {boolean} includeHistory - 'true' to include history of the approval. Default is 'false'.
134 */
135 getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseInterfaces.ReleaseApproval>;
136 /**
137 * Update status of an approval
138 *
139 * @param {ReleaseInterfaces.ReleaseApproval} approval - ReleaseApproval object having status, approver and comments.
140 * @param {string} project - Project ID or project name
141 * @param {number} approvalId - Id of the approval.
142 */
143 updateReleaseApproval(approval: ReleaseInterfaces.ReleaseApproval, project: string, approvalId: number): Promise<ReleaseInterfaces.ReleaseApproval>;
144 /**
145 * @param {ReleaseInterfaces.ReleaseApproval[]} approvals
146 * @param {string} project - Project ID or project name
147 */
148 updateReleaseApprovals(approvals: ReleaseInterfaces.ReleaseApproval[], project: string): Promise<ReleaseInterfaces.ReleaseApproval[]>;
149 /**
150 * Get a task attachment.
151 *
152 * @param {string} project - Project ID or project name
153 * @param {number} releaseId - Id of the release.
154 * @param {number} environmentId - Id of the release environment.
155 * @param {number} attemptId - Attempt number of deployment.
156 * @param {string} timelineId - Timeline Id of the task.
157 * @param {string} recordId - Record Id of attachment.
158 * @param {string} type - Type of the attachment.
159 * @param {string} name - Name of the attachment.
160 */
161 getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<NodeJS.ReadableStream>;
162 /**
163 * Get a release task attachment.
164 *
165 * @param {string} project - Project ID or project name
166 * @param {number} releaseId - Id of the release.
167 * @param {number} environmentId - Id of the release environment.
168 * @param {number} attemptId - Attempt number of deployment.
169 * @param {string} planId - Plan Id of the deploy phase.
170 * @param {string} timelineId - Timeline Id of the task.
171 * @param {string} recordId - Record Id of attachment.
172 * @param {string} type - Type of the attachment.
173 * @param {string} name - Name of the attachment.
174 */
175 getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<NodeJS.ReadableStream>;
176 /**
177 * Get the task attachments.
178 *
179 * @param {string} project - Project ID or project name
180 * @param {number} releaseId - Id of the release.
181 * @param {number} environmentId - Id of the release environment.
182 * @param {number} attemptId - Attempt number of deployment.
183 * @param {string} timelineId - Timeline Id of the task.
184 * @param {string} type - Type of the attachment.
185 */
186 getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseInterfaces.ReleaseTaskAttachment[]>;
187 /**
188 * Get the release task attachments.
189 *
190 * @param {string} project - Project ID or project name
191 * @param {number} releaseId - Id of the release.
192 * @param {number} environmentId - Id of the release environment.
193 * @param {number} attemptId - Attempt number of deployment.
194 * @param {string} planId - Plan Id of the deploy phase.
195 * @param {string} type - Type of the attachment.
196 */
197 getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseInterfaces.ReleaseTaskAttachment[]>;
198 /**
199 * @param {string} artifactType
200 * @param {string} sourceId
201 * @param {string} artifactVersionId
202 * @param {string} project - Project ID or project name
203 */
204 getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<ReleaseInterfaces.AutoTriggerIssue[]>;
205 /**
206 * Gets a badge that indicates the status of the most recent deployment for an environment.
207 *
208 * @param {string} projectId - The ID of the Project.
209 * @param {number} releaseDefinitionId - The ID of the Release Definition.
210 * @param {number} environmentId - The ID of the Environment.
211 * @param {string} branchName - The name of the branch.
212 */
213 getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>;
214 /**
215 * @param {string} project - Project ID or project name
216 * @param {number} releaseId
217 * @param {number} baseReleaseId
218 * @param {number} top
219 * @param {string} artifactAlias
220 */
221 getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseInterfaces.Change[]>;
222 /**
223 * @param {string} project - Project ID or project name
224 * @param {string} taskGroupId
225 * @param {string[]} propertyFilters
226 */
227 getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<ReleaseInterfaces.DefinitionEnvironmentReference[]>;
228 /**
229 * Create a release definition
230 *
231 * @param {ReleaseInterfaces.ReleaseDefinition} releaseDefinition - release definition object to create.
232 * @param {string} project - Project ID or project name
233 */
234 createReleaseDefinition(releaseDefinition: ReleaseInterfaces.ReleaseDefinition, project: string): Promise<ReleaseInterfaces.ReleaseDefinition>;
235 /**
236 * Delete a release definition.
237 *
238 * @param {string} project - Project ID or project name
239 * @param {number} definitionId - Id of the release definition.
240 * @param {string} comment - Comment for deleting a release definition.
241 * @param {boolean} forceDelete - 'true' to automatically cancel any in-progress release deployments and proceed with release definition deletion . Default is 'false'.
242 */
243 deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>;
244 /**
245 * Get a release definition.
246 *
247 * @param {string} project - Project ID or project name
248 * @param {number} definitionId - Id of the release definition.
249 * @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definition will contain values for the specified property Ids (if they exist). If not set, properties will not be included.
250 */
251 getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): Promise<ReleaseInterfaces.ReleaseDefinition>;
252 /**
253 * Get release definition of a given revision.
254 *
255 * @param {string} project - Project ID or project name
256 * @param {number} definitionId - Id of the release definition.
257 * @param {number} revision - Revision number of the release definition.
258 */
259 getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<NodeJS.ReadableStream>;
260 /**
261 * Get a list of release definitions.
262 *
263 * @param {string} project - Project ID or project name
264 * @param {string} searchText - Get release definitions with names containing searchText.
265 * @param {ReleaseInterfaces.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
266 * @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
267 * @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
268 * @param {number} top - Number of release definitions to get.
269 * @param {string} continuationToken - Gets the release definitions after the continuation token provided.
270 * @param {ReleaseInterfaces.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
271 * @param {string} path - Gets the release definitions under the specified path.
272 * @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
273 * @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
274 * @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definitions will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release Definition from results irrespective of whether it has property set or not.
275 * @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
276 * @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
277 * @param {boolean} searchTextContainsFolderName - 'true' to get the release definitions under the folder with name as specified in searchText. Default is 'false'.
278 */
279 getReleaseDefinitions(project: string, searchText?: string, expand?: ReleaseInterfaces.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: ReleaseInterfaces.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean, searchTextContainsFolderName?: boolean): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.ReleaseDefinition>>;
280 /**
281 * Undelete a release definition.
282 *
283 * @param {ReleaseInterfaces.ReleaseDefinitionUndeleteParameter} releaseDefinitionUndeleteParameter - Object for undelete release definition.
284 * @param {string} project - Project ID or project name
285 * @param {number} definitionId - Id of the release definition to be undeleted
286 */
287 undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseInterfaces.ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseInterfaces.ReleaseDefinition>;
288 /**
289 * Update a release definition.
290 *
291 * @param {ReleaseInterfaces.ReleaseDefinition} releaseDefinition - Release definition object to update.
292 * @param {string} project - Project ID or project name
293 */
294 updateReleaseDefinition(releaseDefinition: ReleaseInterfaces.ReleaseDefinition, project: string): Promise<ReleaseInterfaces.ReleaseDefinition>;
295 /**
296 * Get a list of deployments
297 *
298 * @param {string} project - Project ID or project name
299 * @param {number} definitionId - List the deployments for a given definition id.
300 * @param {number} definitionEnvironmentId - List the deployments for a given definition environment id.
301 * @param {string} createdBy - List the deployments for which deployments are created as identity specified.
302 * @param {Date} minModifiedTime - List the deployments with LastModified time >= minModifiedTime.
303 * @param {Date} maxModifiedTime - List the deployments with LastModified time <= maxModifiedTime.
304 * @param {ReleaseInterfaces.DeploymentStatus} deploymentStatus - List the deployments with given deployment status. Defult is 'All'.
305 * @param {ReleaseInterfaces.DeploymentOperationStatus} operationStatus - List the deployments with given operation status. Default is 'All'.
306 * @param {boolean} latestAttemptsOnly - 'true' to include deployments with latest attempt only. Default is 'false'.
307 * @param {ReleaseInterfaces.ReleaseQueryOrder} queryOrder - List the deployments with given query order. Default is 'Descending'.
308 * @param {number} top - List the deployments with given top. Default top is '50' and Max top is '100'.
309 * @param {number} continuationToken - List the deployments with deployment id >= continuationToken.
310 * @param {string} createdFor - List the deployments for which deployments are requested as identity specified.
311 * @param {Date} minStartedTime - List the deployments with StartedOn time >= minStartedTime.
312 * @param {Date} maxStartedTime - List the deployments with StartedOn time <= maxStartedTime.
313 * @param {string} sourceBranch - List the deployments that are deployed from given branch name.
314 */
315 getDeployments(project: string, definitionId?: number, definitionEnvironmentId?: number, createdBy?: string, minModifiedTime?: Date, maxModifiedTime?: Date, deploymentStatus?: ReleaseInterfaces.DeploymentStatus, operationStatus?: ReleaseInterfaces.DeploymentOperationStatus, latestAttemptsOnly?: boolean, queryOrder?: ReleaseInterfaces.ReleaseQueryOrder, top?: number, continuationToken?: number, createdFor?: string, minStartedTime?: Date, maxStartedTime?: Date, sourceBranch?: string): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.Deployment>>;
316 /**
317 * @param {ReleaseInterfaces.DeploymentQueryParameters} queryParameters
318 * @param {string} project - Project ID or project name
319 */
320 getDeploymentsForMultipleEnvironments(queryParameters: ReleaseInterfaces.DeploymentQueryParameters, project: string): Promise<ReleaseInterfaces.Deployment[]>;
321 /**
322 * Get a release environment.
323 *
324 * @param {string} project - Project ID or project name
325 * @param {number} releaseId - Id of the release.
326 * @param {number} environmentId - Id of the release environment.
327 * @param {ReleaseInterfaces.ReleaseEnvironmentExpands} expand - A property that should be expanded in the environment.
328 */
329 getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseInterfaces.ReleaseEnvironmentExpands): Promise<ReleaseInterfaces.ReleaseEnvironment>;
330 /**
331 * Update the status of a release environment
332 *
333 * @param {ReleaseInterfaces.ReleaseEnvironmentUpdateMetadata} environmentUpdateData - Environment update meta data.
334 * @param {string} project - Project ID or project name
335 * @param {number} releaseId - Id of the release.
336 * @param {number} environmentId - Id of release environment.
337 */
338 updateReleaseEnvironment(environmentUpdateData: ReleaseInterfaces.ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseInterfaces.ReleaseEnvironment>;
339 /**
340 * Creates a definition environment template
341 *
342 * @param {ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate} template - Definition environment template to create
343 * @param {string} project - Project ID or project name
344 */
345 createDefinitionEnvironmentTemplate(template: ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate>;
346 /**
347 * Delete a definition environment template
348 *
349 * @param {string} project - Project ID or project name
350 * @param {string} templateId - Id of the definition environment template
351 */
352 deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>;
353 /**
354 * Gets a definition environment template
355 *
356 * @param {string} project - Project ID or project name
357 * @param {string} templateId - Id of the definition environment template
358 */
359 getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate>;
360 /**
361 * Gets a list of definition environment templates
362 *
363 * @param {string} project - Project ID or project name
364 * @param {boolean} isDeleted - 'true' to get definition environment templates that have been deleted. Default is 'false'
365 */
366 listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate[]>;
367 /**
368 * Undelete a release definition environment template.
369 *
370 * @param {string} project - Project ID or project name
371 * @param {string} templateId - Id of the definition environment template to be undeleted
372 */
373 undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseInterfaces.ReleaseDefinitionEnvironmentTemplate>;
374 /**
375 * @param {ReleaseInterfaces.FavoriteItem[]} favoriteItems
376 * @param {string} project - Project ID or project name
377 * @param {string} scope
378 * @param {string} identityId
379 */
380 createFavorites(favoriteItems: ReleaseInterfaces.FavoriteItem[], project: string, scope: string, identityId?: string): Promise<ReleaseInterfaces.FavoriteItem[]>;
381 /**
382 * @param {string} project - Project ID or project name
383 * @param {string} scope
384 * @param {string} identityId
385 * @param {string} favoriteItemIds
386 */
387 deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>;
388 /**
389 * @param {string} project - Project ID or project name
390 * @param {string} scope
391 * @param {string} identityId
392 */
393 getFavorites(project: string, scope: string, identityId?: string): Promise<ReleaseInterfaces.FavoriteItem[]>;
394 /**
395 * @param {string} flightName
396 */
397 getFlightAssignments(flightName?: string): Promise<string[]>;
398 /**
399 * Creates a new folder.
400 *
401 * @param {ReleaseInterfaces.Folder} folder - folder.
402 * @param {string} project - Project ID or project name
403 * @param {string} path - Path of the folder.
404 */
405 createFolder(folder: ReleaseInterfaces.Folder, project: string, path?: string): Promise<ReleaseInterfaces.Folder>;
406 /**
407 * Deletes a definition folder for given folder name and path and all it's existing definitions.
408 *
409 * @param {string} project - Project ID or project name
410 * @param {string} path - Path of the folder to delete.
411 */
412 deleteFolder(project: string, path: string): Promise<void>;
413 /**
414 * Gets folders.
415 *
416 * @param {string} project - Project ID or project name
417 * @param {string} path - Path of the folder.
418 * @param {ReleaseInterfaces.FolderPathQueryOrder} queryOrder - Gets the results in the defined order. Default is 'None'.
419 */
420 getFolders(project: string, path?: string, queryOrder?: ReleaseInterfaces.FolderPathQueryOrder): Promise<ReleaseInterfaces.Folder[]>;
421 /**
422 * Updates an existing folder at given existing path.
423 *
424 * @param {ReleaseInterfaces.Folder} folder - folder.
425 * @param {string} project - Project ID or project name
426 * @param {string} path - Path of the folder to update.
427 */
428 updateFolder(folder: ReleaseInterfaces.Folder, project: string, path: string): Promise<ReleaseInterfaces.Folder>;
429 /**
430 * Updates the gate for a deployment.
431 *
432 * @param {ReleaseInterfaces.GateUpdateMetadata} gateUpdateMetadata - Metadata to patch the Release Gates.
433 * @param {string} project - Project ID or project name
434 * @param {number} gateStepId - Gate step Id.
435 */
436 updateGates(gateUpdateMetadata: ReleaseInterfaces.GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseInterfaces.ReleaseGates>;
437 /**
438 * @param {string} project - Project ID or project name
439 * @param {number} releaseId
440 */
441 getReleaseHistory(project: string, releaseId: number): Promise<ReleaseInterfaces.ReleaseRevision[]>;
442 /**
443 * @param {FormInputInterfaces.InputValuesQuery} query
444 * @param {string} project - Project ID or project name
445 */
446 getInputValues(query: FormInputInterfaces.InputValuesQuery, project: string): Promise<FormInputInterfaces.InputValuesQuery>;
447 /**
448 * @param {string} project - Project ID or project name
449 * @param {number} buildId
450 * @param {string} sourceId
451 */
452 getIssues(project: string, buildId: number, sourceId?: string): Promise<ReleaseInterfaces.AutoTriggerIssue[]>;
453 /**
454 * Gets gate logs
455 *
456 * @param {string} project - Project ID or project name
457 * @param {number} releaseId - Id of the release.
458 * @param {number} environmentId - Id of release environment.
459 * @param {number} gateId - Id of the gate.
460 * @param {number} taskId - ReleaseTask Id for the log.
461 */
462 getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<NodeJS.ReadableStream>;
463 /**
464 * Get logs for a release Id.
465 *
466 * @param {string} project - Project ID or project name
467 * @param {number} releaseId - Id of the release.
468 */
469 getLogs(project: string, releaseId: number): Promise<NodeJS.ReadableStream>;
470 /**
471 * Gets logs
472 *
473 * @param {string} project - Project ID or project name
474 * @param {number} releaseId - Id of the release.
475 * @param {number} environmentId - Id of release environment.
476 * @param {number} taskId - ReleaseTask Id for the log.
477 * @param {number} attemptId - Id of the attempt.
478 */
479 getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<NodeJS.ReadableStream>;
480 /**
481 * Gets the task log of a release as a plain text file.
482 *
483 * @param {string} project - Project ID or project name
484 * @param {number} releaseId - Id of the release.
485 * @param {number} environmentId - Id of release environment.
486 * @param {number} attemptId
487 * @param {string} timelineId
488 * @param {number} taskId - ReleaseTask Id for the log.
489 * @param {number} startLine - Starting line number for logs
490 * @param {number} endLine - Ending line number for logs
491 */
492 getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<NodeJS.ReadableStream>;
493 /**
494 * Gets the task log of a release as a plain text file.
495 *
496 * @param {string} project - Project ID or project name
497 * @param {number} releaseId - Id of the release.
498 * @param {number} environmentId - Id of release environment.
499 * @param {number} releaseDeployPhaseId - Release deploy phase Id.
500 * @param {number} taskId - ReleaseTask Id for the log.
501 * @param {number} startLine - Starting line number for logs
502 * @param {number} endLine - Ending line number for logs
503 */
504 getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<NodeJS.ReadableStream>;
505 /**
506 * Get manual intervention for a given release and manual intervention id.
507 *
508 * @param {string} project - Project ID or project name
509 * @param {number} releaseId - Id of the release.
510 * @param {number} manualInterventionId - Id of the manual intervention.
511 */
512 getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ReleaseInterfaces.ManualIntervention>;
513 /**
514 * List all manual interventions for a given release.
515 *
516 * @param {string} project - Project ID or project name
517 * @param {number} releaseId - Id of the release.
518 */
519 getManualInterventions(project: string, releaseId: number): Promise<ReleaseInterfaces.ManualIntervention[]>;
520 /**
521 * Update manual intervention.
522 *
523 * @param {ReleaseInterfaces.ManualInterventionUpdateMetadata} manualInterventionUpdateMetadata - Meta data to update manual intervention.
524 * @param {string} project - Project ID or project name
525 * @param {number} releaseId - Id of the release.
526 * @param {number} manualInterventionId - Id of the manual intervention.
527 */
528 updateManualIntervention(manualInterventionUpdateMetadata: ReleaseInterfaces.ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ReleaseInterfaces.ManualIntervention>;
529 /**
530 * @param {string} project - Project ID or project name
531 * @param {Date} minMetricsTime
532 */
533 getMetrics(project: string, minMetricsTime?: Date): Promise<ReleaseInterfaces.Metric[]>;
534 /**
535 * Gets Org pipeline release settings
536 *
537 */
538 getOrgPipelineReleaseSettings(): Promise<ReleaseInterfaces.OrgPipelineReleaseSettings>;
539 /**
540 * Updates Org pipeline release settings
541 *
542 * @param {ReleaseInterfaces.OrgPipelineReleaseSettingsUpdateParameters} newSettings
543 */
544 updateOrgPipelineReleaseSettings(newSettings: ReleaseInterfaces.OrgPipelineReleaseSettingsUpdateParameters): Promise<ReleaseInterfaces.OrgPipelineReleaseSettings>;
545 /**
546 * Gets pipeline release settings
547 *
548 * @param {string} project - Project ID or project name
549 */
550 getPipelineReleaseSettings(project: string): Promise<ReleaseInterfaces.ProjectPipelineReleaseSettings>;
551 /**
552 * Updates pipeline release settings
553 *
554 * @param {ReleaseInterfaces.ProjectPipelineReleaseSettingsUpdateParameters} newSettings
555 * @param {string} project - Project ID or project name
556 */
557 updatePipelineReleaseSettings(newSettings: ReleaseInterfaces.ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ReleaseInterfaces.ProjectPipelineReleaseSettings>;
558 /**
559 * @param {string} artifactType
560 * @param {string} artifactSourceId
561 */
562 getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ReleaseInterfaces.ProjectReference[]>;
563 /**
564 * Get a list of releases
565 *
566 * @param {string} project - Project ID or project name
567 * @param {number} definitionId - Releases from this release definition Id.
568 * @param {number} definitionEnvironmentId
569 * @param {string} searchText - Releases with names containing searchText.
570 * @param {string} createdBy - Releases created by this user.
571 * @param {ReleaseInterfaces.ReleaseStatus} statusFilter - Releases that have this status.
572 * @param {number} environmentStatusFilter
573 * @param {Date} minCreatedTime - Releases that were created after this time.
574 * @param {Date} maxCreatedTime - Releases that were created before this time.
575 * @param {ReleaseInterfaces.ReleaseQueryOrder} queryOrder - Gets the results in the defined order of created date for releases. Default is descending.
576 * @param {number} top - Number of releases to get. Default is 50.
577 * @param {number} continuationToken - Gets the releases after the continuation token provided.
578 * @param {ReleaseInterfaces.ReleaseExpands} expand - The property that should be expanded in the list of releases.
579 * @param {string} artifactTypeId - Releases with given artifactTypeId will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
580 * @param {string} sourceId - Unique identifier of the artifact used. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
581 * @param {string} artifactVersionId - Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId.
582 * @param {string} sourceBranchFilter - Releases with given sourceBranchFilter will be returned.
583 * @param {boolean} isDeleted - Gets the soft deleted releases, if true.
584 * @param {string[]} tagFilter - A comma-delimited list of tags. Only releases with these tags will be returned.
585 * @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Releases will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release from results irrespective of whether it has property set or not.
586 * @param {number[]} releaseIdFilter - A comma-delimited list of releases Ids. Only releases with these Ids will be returned.
587 * @param {string} path - Releases under this folder path will be returned
588 */
589 getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseInterfaces.ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseInterfaces.ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseInterfaces.ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<VSSInterfaces.PagedList<ReleaseInterfaces.Release>>;
590 /**
591 * Create a release.
592 *
593 * @param {ReleaseInterfaces.ReleaseStartMetadata} releaseStartMetadata - Metadata to create a release.
594 * @param {string} project - Project ID or project name
595 */
596 createRelease(releaseStartMetadata: ReleaseInterfaces.ReleaseStartMetadata, project: string): Promise<ReleaseInterfaces.Release>;
597 /**
598 * Soft delete a release
599 *
600 * @param {string} project - Project ID or project name
601 * @param {number} releaseId - Id of the release.
602 * @param {string} comment - Comment for deleting a release.
603 */
604 deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>;
605 /**
606 * Get a Release
607 *
608 * @param {string} project - Project ID or project name
609 * @param {number} releaseId - Id of the release.
610 * @param {ReleaseInterfaces.ApprovalFilters} approvalFilters - A filter which would allow fetching approval steps selectively based on whether it is automated, or manual. This would also decide whether we should fetch pre and post approval snapshots. Assumes All by default
611 * @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Release will contain values for the specified property Ids (if they exist). If not set, properties will not be included.
612 * @param {ReleaseInterfaces.SingleReleaseExpands} expand - A property that should be expanded in the release.
613 * @param {number} topGateRecords - Number of release gate records to get. Default is 5.
614 */
615 getRelease(project: string, releaseId: number, approvalFilters?: ReleaseInterfaces.ApprovalFilters, propertyFilters?: string[], expand?: ReleaseInterfaces.SingleReleaseExpands, topGateRecords?: number): Promise<ReleaseInterfaces.Release>;
616 /**
617 * Get release summary of a given definition Id.
618 *
619 * @param {string} project - Project ID or project name
620 * @param {number} definitionId - Id of the definition to get release summary.
621 * @param {number} releaseCount - Count of releases to be included in summary.
622 * @param {boolean} includeArtifact - Include artifact details.Default is 'false'.
623 * @param {number[]} definitionEnvironmentIdsFilter
624 */
625 getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseInterfaces.ReleaseDefinitionSummary>;
626 /**
627 * Get release for a given revision number.
628 *
629 * @param {string} project - Project ID or project name
630 * @param {number} releaseId - Id of the release.
631 * @param {number} definitionSnapshotRevision - Definition snapshot revision number.
632 */
633 getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<NodeJS.ReadableStream>;
634 /**
635 * Undelete a soft deleted release.
636 *
637 * @param {string} project - Project ID or project name
638 * @param {number} releaseId - Id of release to be undeleted.
639 * @param {string} comment - Any comment for undeleting.
640 */
641 undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>;
642 /**
643 * Update a complete release object.
644 *
645 * @param {ReleaseInterfaces.Release} release - Release object for update.
646 * @param {string} project - Project ID or project name
647 * @param {number} releaseId - Id of the release to update.
648 */
649 updateRelease(release: ReleaseInterfaces.Release, project: string, releaseId: number): Promise<ReleaseInterfaces.Release>;
650 /**
651 * Update few properties of a release.
652 *
653 * @param {ReleaseInterfaces.ReleaseUpdateMetadata} releaseUpdateMetadata - Properties of release to update.
654 * @param {string} project - Project ID or project name
655 * @param {number} releaseId - Id of the release to update.
656 */
657 updateReleaseResource(releaseUpdateMetadata: ReleaseInterfaces.ReleaseUpdateMetadata, project: string, releaseId: number): Promise<ReleaseInterfaces.Release>;
658 /**
659 * Gets the release settings
660 *
661 * @param {string} project - Project ID or project name
662 */
663 getReleaseSettings(project: string): Promise<ReleaseInterfaces.ReleaseSettings>;
664 /**
665 * Updates the release settings
666 *
667 * @param {ReleaseInterfaces.ReleaseSettings} releaseSettings
668 * @param {string} project - Project ID or project name
669 */
670 updateReleaseSettings(releaseSettings: ReleaseInterfaces.ReleaseSettings, project: string): Promise<ReleaseInterfaces.ReleaseSettings>;
671 /**
672 * Get release definition for a given definitionId and revision
673 *
674 * @param {string} project - Project ID or project name
675 * @param {number} definitionId - Id of the definition.
676 * @param {number} revision - Id of the revision.
677 */
678 getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<NodeJS.ReadableStream>;
679 /**
680 * Get revision history for a release definition
681 *
682 * @param {string} project - Project ID or project name
683 * @param {number} definitionId - Id of the definition.
684 */
685 getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseInterfaces.ReleaseDefinitionRevision[]>;
686 /**
687 * @param {string} project - Project ID or project name
688 * @param {number} releaseId
689 */
690 getSummaryMailSections(project: string, releaseId: number): Promise<ReleaseInterfaces.SummaryMailSection[]>;
691 /**
692 * @param {ReleaseInterfaces.MailMessage} mailMessage
693 * @param {string} project - Project ID or project name
694 * @param {number} releaseId
695 */
696 sendSummaryMail(mailMessage: ReleaseInterfaces.MailMessage, project: string, releaseId: number): Promise<void>;
697 /**
698 * @param {string} project - Project ID or project name
699 * @param {number} definitionId
700 */
701 getSourceBranches(project: string, definitionId: number): Promise<string[]>;
702 /**
703 * Adds a tag to a definition
704 *
705 * @param {string} project - Project ID or project name
706 * @param {number} releaseDefinitionId
707 * @param {string} tag
708 */
709 addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>;
710 /**
711 * Adds multiple tags to a definition
712 *
713 * @param {string[]} tags
714 * @param {string} project - Project ID or project name
715 * @param {number} releaseDefinitionId
716 */
717 addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>;
718 /**
719 * Deletes a tag from a definition
720 *
721 * @param {string} project - Project ID or project name
722 * @param {number} releaseDefinitionId
723 * @param {string} tag
724 */
725 deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>;
726 /**
727 * Gets the tags for a definition
728 *
729 * @param {string} project - Project ID or project name
730 * @param {number} releaseDefinitionId
731 */
732 getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>;
733 /**
734 * Adds a tag to a releaseId
735 *
736 * @param {string} project - Project ID or project name
737 * @param {number} releaseId
738 * @param {string} tag
739 */
740 addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>;
741 /**
742 * Adds tag to a release
743 *
744 * @param {string[]} tags
745 * @param {string} project - Project ID or project name
746 * @param {number} releaseId
747 */
748 addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>;
749 /**
750 * Deletes a tag from a release
751 *
752 * @param {string} project - Project ID or project name
753 * @param {number} releaseId
754 * @param {string} tag
755 */
756 deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>;
757 /**
758 * Gets the tags for a release
759 *
760 * @param {string} project - Project ID or project name
761 * @param {number} releaseId
762 */
763 getReleaseTags(project: string, releaseId: number): Promise<string[]>;
764 /**
765 * @param {string} project - Project ID or project name
766 */
767 getTags(project: string): Promise<string[]>;
768 /**
769 * @param {string} project - Project ID or project name
770 * @param {number} releaseId
771 * @param {number} environmentId
772 * @param {number} releaseDeployPhaseId
773 */
774 getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseInterfaces.ReleaseTask[]>;
775 /**
776 * @param {string} project - Project ID or project name
777 * @param {number} releaseId
778 * @param {number} environmentId
779 * @param {number} attemptId
780 * @param {string} timelineId
781 */
782 getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseInterfaces.ReleaseTask[]>;
783 /**
784 * @param {string} project - Project ID or project name
785 * @param {number} releaseId
786 * @param {number} environmentId
787 * @param {number} attemptId
788 */
789 getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseInterfaces.ReleaseTask[]>;
790 /**
791 * @param {string} project - Project ID or project name
792 */
793 getArtifactTypeDefinitions(project: string): Promise<ReleaseInterfaces.ArtifactTypeDefinition[]>;
794 /**
795 * @param {string} project - Project ID or project name
796 * @param {number} releaseDefinitionId
797 */
798 getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ReleaseInterfaces.ArtifactVersionQueryResult>;
799 /**
800 * @param {ReleaseInterfaces.Artifact[]} artifacts
801 * @param {string} project - Project ID or project name
802 */
803 getArtifactVersionsForSources(artifacts: ReleaseInterfaces.Artifact[], project: string): Promise<ReleaseInterfaces.ArtifactVersionQueryResult>;
804 /**
805 * @param {string} project - Project ID or project name
806 * @param {number} releaseId
807 * @param {number} baseReleaseId
808 * @param {number} top
809 * @param {string} artifactAlias
810 */
811 getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseInterfaces.ReleaseWorkItemRef[]>;
812}