UNPKG

30.3 kBTypeScriptView Raw
1import basem = require('./ClientApiBases');
2import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
3import TfsCoreInterfaces = require("./interfaces/CoreInterfaces");
4import WorkInterfaces = require("./interfaces/WorkInterfaces");
5export interface IWorkApi extends basem.ClientApiBase {
6 updateAutomationRule(ruleRequestModel: WorkInterfaces.TeamAutomationRulesSettingsRequestModel, teamContext: TfsCoreInterfaces.TeamContext): Promise<void>;
7 getBacklogConfigurations(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.BacklogConfiguration>;
8 getBacklogLevelWorkItems(teamContext: TfsCoreInterfaces.TeamContext, backlogId: string): Promise<WorkInterfaces.BacklogLevelWorkItems>;
9 getBacklog(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<WorkInterfaces.BacklogLevelConfiguration>;
10 getBacklogs(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.BacklogLevelConfiguration[]>;
11 getBoardBadge(teamContext: TfsCoreInterfaces.TeamContext, id: string, columnOptions?: WorkInterfaces.BoardBadgeColumnOptions, columns?: string[]): Promise<WorkInterfaces.BoardBadge>;
12 getBoardBadgeData(teamContext: TfsCoreInterfaces.TeamContext, id: string, columnOptions?: WorkInterfaces.BoardBadgeColumnOptions, columns?: string[]): Promise<string>;
13 getColumnSuggestedValues(project?: string): Promise<WorkInterfaces.BoardSuggestedValue[]>;
14 getBoardMappingParentItems(teamContext: TfsCoreInterfaces.TeamContext, childBacklogContextCategoryRefName: string, workitemIds: number[]): Promise<WorkInterfaces.ParentChildWIMap[]>;
15 getRowSuggestedValues(project?: string): Promise<WorkInterfaces.BoardSuggestedValue[]>;
16 getBoard(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<WorkInterfaces.Board>;
17 getBoards(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.BoardReference[]>;
18 setBoardOptions(options: {
19 [key: string]: string;
20 }, teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<{
21 [key: string]: string;
22 }>;
23 getBoardUserSettings(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardUserSettings>;
24 updateBoardUserSettings(boardUserSettings: {
25 [key: string]: string;
26 }, teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardUserSettings>;
27 getCapacitiesWithIdentityRefAndTotals(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamCapacity>;
28 getCapacityWithIdentityRef(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string, teamMemberId: string): Promise<WorkInterfaces.TeamMemberCapacityIdentityRef>;
29 replaceCapacitiesWithIdentityRef(capacities: WorkInterfaces.TeamMemberCapacityIdentityRef[], teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamMemberCapacityIdentityRef[]>;
30 updateCapacityWithIdentityRef(patch: WorkInterfaces.CapacityPatch, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string, teamMemberId: string): Promise<WorkInterfaces.TeamMemberCapacityIdentityRef>;
31 getBoardCardRuleSettings(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardRuleSettings>;
32 updateBoardCardRuleSettings(boardCardRuleSettings: WorkInterfaces.BoardCardRuleSettings, teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardRuleSettings>;
33 updateTaskboardCardRuleSettings(boardCardRuleSettings: WorkInterfaces.BoardCardRuleSettings, teamContext: TfsCoreInterfaces.TeamContext): Promise<void>;
34 getBoardCardSettings(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardSettings>;
35 updateBoardCardSettings(boardCardSettingsToSave: WorkInterfaces.BoardCardSettings, teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardSettings>;
36 updateTaskboardCardSettings(boardCardSettingsToSave: WorkInterfaces.BoardCardSettings, teamContext: TfsCoreInterfaces.TeamContext): Promise<void>;
37 getBoardChart(teamContext: TfsCoreInterfaces.TeamContext, board: string, name: string): Promise<WorkInterfaces.BoardChart>;
38 getBoardCharts(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardChartReference[]>;
39 updateBoardChart(chart: WorkInterfaces.BoardChart, teamContext: TfsCoreInterfaces.TeamContext, board: string, name: string): Promise<WorkInterfaces.BoardChart>;
40 getBoardColumns(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardColumn[]>;
41 updateBoardColumns(boardColumns: WorkInterfaces.BoardColumn[], teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardColumn[]>;
42 getDeliveryTimelineData(project: string, id: string, revision?: number, startDate?: Date, endDate?: Date): Promise<WorkInterfaces.DeliveryViewData>;
43 getTotalIterationCapacities(project: string, iterationId: string): Promise<WorkInterfaces.IterationCapacity>;
44 deleteTeamIteration(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<void>;
45 getTeamIteration(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<WorkInterfaces.TeamSettingsIteration>;
46 getTeamIterations(teamContext: TfsCoreInterfaces.TeamContext, timeframe?: string): Promise<WorkInterfaces.TeamSettingsIteration[]>;
47 postTeamIteration(iteration: WorkInterfaces.TeamSettingsIteration, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamSettingsIteration>;
48 createPlan(postedPlan: WorkInterfaces.CreatePlan, project: string): Promise<WorkInterfaces.Plan>;
49 deletePlan(project: string, id: string): Promise<void>;
50 getPlan(project: string, id: string): Promise<WorkInterfaces.Plan>;
51 getPlans(project: string): Promise<WorkInterfaces.Plan[]>;
52 updatePlan(updatedPlan: WorkInterfaces.UpdatePlan, project: string, id: string): Promise<WorkInterfaces.Plan>;
53 getProcessConfiguration(project: string): Promise<WorkInterfaces.ProcessConfiguration>;
54 getBoardRows(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardRow[]>;
55 updateBoardRows(boardRows: WorkInterfaces.BoardRow[], teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardRow[]>;
56 getColumns(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TaskboardColumns>;
57 updateColumns(updateColumns: WorkInterfaces.UpdateTaskboardColumn[], teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TaskboardColumns>;
58 getWorkItemColumns(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TaskboardWorkItemColumn[]>;
59 updateWorkItemColumn(updateColumn: WorkInterfaces.UpdateTaskboardWorkItemColumn, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string, workItemId: number): Promise<void>;
60 getTeamDaysOff(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamSettingsDaysOff>;
61 updateTeamDaysOff(daysOffPatch: WorkInterfaces.TeamSettingsDaysOffPatch, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamSettingsDaysOff>;
62 getTeamFieldValues(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamFieldValues>;
63 updateTeamFieldValues(patch: WorkInterfaces.TeamFieldValuesPatch, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamFieldValues>;
64 getTeamSettings(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamSetting>;
65 updateTeamSettings(teamSettingsPatch: WorkInterfaces.TeamSettingsPatch, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamSetting>;
66 getIterationWorkItems(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.IterationWorkItems>;
67 reorderBacklogWorkItems(operation: WorkInterfaces.ReorderOperation, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.ReorderResult[]>;
68 reorderIterationWorkItems(operation: WorkInterfaces.ReorderOperation, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.ReorderResult[]>;
69}
70export declare class WorkApi extends basem.ClientApiBase implements IWorkApi {
71 constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions);
72 static readonly RESOURCE_AREA_ID = "1d4f49f9-02b9-4e26-b826-2cdb6195f2a9";
73 /**
74 * Creates/updates an automation rules settings
75 *
76 * @param {WorkInterfaces.TeamAutomationRulesSettingsRequestModel} ruleRequestModel - Required parameters to create/update an automation rules settings
77 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
78 */
79 updateAutomationRule(ruleRequestModel: WorkInterfaces.TeamAutomationRulesSettingsRequestModel, teamContext: TfsCoreInterfaces.TeamContext): Promise<void>;
80 /**
81 * Gets backlog configuration for a team
82 *
83 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
84 */
85 getBacklogConfigurations(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.BacklogConfiguration>;
86 /**
87 * Get a list of work items within a backlog level
88 *
89 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
90 * @param {string} backlogId
91 */
92 getBacklogLevelWorkItems(teamContext: TfsCoreInterfaces.TeamContext, backlogId: string): Promise<WorkInterfaces.BacklogLevelWorkItems>;
93 /**
94 * Get a backlog level
95 *
96 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
97 * @param {string} id - The id of the backlog level
98 */
99 getBacklog(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<WorkInterfaces.BacklogLevelConfiguration>;
100 /**
101 * List all backlog levels
102 *
103 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
104 */
105 getBacklogs(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.BacklogLevelConfiguration[]>;
106 /**
107 * Gets a badge that displays the status of columns on the board.
108 *
109 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
110 * @param {string} id - The id of the board.
111 * @param {WorkInterfaces.BoardBadgeColumnOptions} columnOptions - Determines what columns to show.
112 * @param {string[]} columns - If columnOptions is set to custom, specify the list of column names.
113 */
114 getBoardBadge(teamContext: TfsCoreInterfaces.TeamContext, id: string, columnOptions?: WorkInterfaces.BoardBadgeColumnOptions, columns?: string[]): Promise<WorkInterfaces.BoardBadge>;
115 /**
116 * Gets a badge that displays the status of columns on the board.
117 *
118 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
119 * @param {string} id - The id of the board.
120 * @param {WorkInterfaces.BoardBadgeColumnOptions} columnOptions - Determines what columns to show.
121 * @param {string[]} columns - If columnOptions is set to custom, specify the list of column names.
122 */
123 getBoardBadgeData(teamContext: TfsCoreInterfaces.TeamContext, id: string, columnOptions?: WorkInterfaces.BoardBadgeColumnOptions, columns?: string[]): Promise<string>;
124 /**
125 * Get available board columns in a project
126 *
127 * @param {string} project - Project ID or project name
128 */
129 getColumnSuggestedValues(project?: string): Promise<WorkInterfaces.BoardSuggestedValue[]>;
130 /**
131 * Returns the list of parent field filter model for the given list of workitem ids
132 *
133 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
134 * @param {string} childBacklogContextCategoryRefName
135 * @param {number[]} workitemIds
136 */
137 getBoardMappingParentItems(teamContext: TfsCoreInterfaces.TeamContext, childBacklogContextCategoryRefName: string, workitemIds: number[]): Promise<WorkInterfaces.ParentChildWIMap[]>;
138 /**
139 * Get available board rows in a project
140 *
141 * @param {string} project - Project ID or project name
142 */
143 getRowSuggestedValues(project?: string): Promise<WorkInterfaces.BoardSuggestedValue[]>;
144 /**
145 * Get board
146 *
147 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
148 * @param {string} id - identifier for board, either board's backlog level name (Eg:"Stories") or Id
149 */
150 getBoard(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<WorkInterfaces.Board>;
151 /**
152 * Get boards
153 *
154 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
155 */
156 getBoards(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.BoardReference[]>;
157 /**
158 * Update board options
159 *
160 * @param {{ [key: string] : string; }} options - options to updated
161 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
162 * @param {string} id - identifier for board, either category plural name (Eg:"Stories") or guid
163 */
164 setBoardOptions(options: {
165 [key: string]: string;
166 }, teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<{
167 [key: string]: string;
168 }>;
169 /**
170 * Get board user settings for a board id
171 *
172 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
173 * @param {string} board - Board ID or Name
174 */
175 getBoardUserSettings(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardUserSettings>;
176 /**
177 * Update board user settings for the board id
178 *
179 * @param {{ [key: string] : string; }} boardUserSettings
180 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
181 * @param {string} board
182 */
183 updateBoardUserSettings(boardUserSettings: {
184 [key: string]: string;
185 }, teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardUserSettings>;
186 /**
187 * Get a team's capacity including total capacity and days off
188 *
189 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
190 * @param {string} iterationId - ID of the iteration
191 */
192 getCapacitiesWithIdentityRefAndTotals(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamCapacity>;
193 /**
194 * Get a team member's capacity
195 *
196 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
197 * @param {string} iterationId - ID of the iteration
198 * @param {string} teamMemberId - ID of the team member
199 */
200 getCapacityWithIdentityRef(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string, teamMemberId: string): Promise<WorkInterfaces.TeamMemberCapacityIdentityRef>;
201 /**
202 * Replace a team's capacity
203 *
204 * @param {WorkInterfaces.TeamMemberCapacityIdentityRef[]} capacities - Team capacity to replace
205 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
206 * @param {string} iterationId - ID of the iteration
207 */
208 replaceCapacitiesWithIdentityRef(capacities: WorkInterfaces.TeamMemberCapacityIdentityRef[], teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamMemberCapacityIdentityRef[]>;
209 /**
210 * Update a team member's capacity
211 *
212 * @param {WorkInterfaces.CapacityPatch} patch - Updated capacity
213 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
214 * @param {string} iterationId - ID of the iteration
215 * @param {string} teamMemberId - ID of the team member
216 */
217 updateCapacityWithIdentityRef(patch: WorkInterfaces.CapacityPatch, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string, teamMemberId: string): Promise<WorkInterfaces.TeamMemberCapacityIdentityRef>;
218 /**
219 * Get board card Rule settings for the board id or board by name
220 *
221 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
222 * @param {string} board
223 */
224 getBoardCardRuleSettings(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardRuleSettings>;
225 /**
226 * Update board card Rule settings for the board id or board by name
227 *
228 * @param {WorkInterfaces.BoardCardRuleSettings} boardCardRuleSettings
229 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
230 * @param {string} board
231 */
232 updateBoardCardRuleSettings(boardCardRuleSettings: WorkInterfaces.BoardCardRuleSettings, teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardRuleSettings>;
233 /**
234 * Update taskboard card Rule settings
235 *
236 * @param {WorkInterfaces.BoardCardRuleSettings} boardCardRuleSettings
237 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
238 */
239 updateTaskboardCardRuleSettings(boardCardRuleSettings: WorkInterfaces.BoardCardRuleSettings, teamContext: TfsCoreInterfaces.TeamContext): Promise<void>;
240 /**
241 * Get board card settings for the board id or board by name
242 *
243 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
244 * @param {string} board
245 */
246 getBoardCardSettings(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardSettings>;
247 /**
248 * Update board card settings for the board id or board by name
249 *
250 * @param {WorkInterfaces.BoardCardSettings} boardCardSettingsToSave
251 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
252 * @param {string} board
253 */
254 updateBoardCardSettings(boardCardSettingsToSave: WorkInterfaces.BoardCardSettings, teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardCardSettings>;
255 /**
256 * Update taskboard card settings
257 *
258 * @param {WorkInterfaces.BoardCardSettings} boardCardSettingsToSave
259 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
260 */
261 updateTaskboardCardSettings(boardCardSettingsToSave: WorkInterfaces.BoardCardSettings, teamContext: TfsCoreInterfaces.TeamContext): Promise<void>;
262 /**
263 * Get a board chart
264 *
265 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
266 * @param {string} board - Identifier for board, either board's backlog level name (Eg:"Stories") or Id
267 * @param {string} name - The chart name
268 */
269 getBoardChart(teamContext: TfsCoreInterfaces.TeamContext, board: string, name: string): Promise<WorkInterfaces.BoardChart>;
270 /**
271 * Get board charts
272 *
273 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
274 * @param {string} board - Identifier for board, either board's backlog level name (Eg:"Stories") or Id
275 */
276 getBoardCharts(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardChartReference[]>;
277 /**
278 * Update a board chart
279 *
280 * @param {WorkInterfaces.BoardChart} chart
281 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
282 * @param {string} board - Identifier for board, either board's backlog level name (Eg:"Stories") or Id
283 * @param {string} name - The chart name
284 */
285 updateBoardChart(chart: WorkInterfaces.BoardChart, teamContext: TfsCoreInterfaces.TeamContext, board: string, name: string): Promise<WorkInterfaces.BoardChart>;
286 /**
287 * Get columns on a board
288 *
289 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
290 * @param {string} board - Name or ID of the specific board
291 */
292 getBoardColumns(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardColumn[]>;
293 /**
294 * Update columns on a board
295 *
296 * @param {WorkInterfaces.BoardColumn[]} boardColumns - List of board columns to update
297 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
298 * @param {string} board - Name or ID of the specific board
299 */
300 updateBoardColumns(boardColumns: WorkInterfaces.BoardColumn[], teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardColumn[]>;
301 /**
302 * Get Delivery View Data
303 *
304 * @param {string} project - Project ID or project name
305 * @param {string} id - Identifier for delivery view
306 * @param {number} revision - Revision of the plan for which you want data. If the current plan is a different revision you will get an ViewRevisionMismatchException exception. If you do not supply a revision you will get data for the latest revision.
307 * @param {Date} startDate - The start date of timeline
308 * @param {Date} endDate - The end date of timeline
309 */
310 getDeliveryTimelineData(project: string, id: string, revision?: number, startDate?: Date, endDate?: Date): Promise<WorkInterfaces.DeliveryViewData>;
311 /**
312 * Get an iteration's capacity for all teams in iteration
313 *
314 * @param {string} project - Project ID or project name
315 * @param {string} iterationId - ID of the iteration
316 */
317 getTotalIterationCapacities(project: string, iterationId: string): Promise<WorkInterfaces.IterationCapacity>;
318 /**
319 * Delete a team's iteration by iterationId
320 *
321 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
322 * @param {string} id - ID of the iteration
323 */
324 deleteTeamIteration(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<void>;
325 /**
326 * Get team's iteration by iterationId
327 *
328 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
329 * @param {string} id - ID of the iteration
330 */
331 getTeamIteration(teamContext: TfsCoreInterfaces.TeamContext, id: string): Promise<WorkInterfaces.TeamSettingsIteration>;
332 /**
333 * Get a team's iterations using timeframe filter
334 *
335 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
336 * @param {string} timeframe - A filter for which iterations are returned based on relative time. Only Current is supported currently.
337 */
338 getTeamIterations(teamContext: TfsCoreInterfaces.TeamContext, timeframe?: string): Promise<WorkInterfaces.TeamSettingsIteration[]>;
339 /**
340 * Add an iteration to the team
341 *
342 * @param {WorkInterfaces.TeamSettingsIteration} iteration - Iteration to add
343 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
344 */
345 postTeamIteration(iteration: WorkInterfaces.TeamSettingsIteration, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamSettingsIteration>;
346 /**
347 * Add a new plan for the team
348 *
349 * @param {WorkInterfaces.CreatePlan} postedPlan - Plan definition
350 * @param {string} project - Project ID or project name
351 */
352 createPlan(postedPlan: WorkInterfaces.CreatePlan, project: string): Promise<WorkInterfaces.Plan>;
353 /**
354 * Delete the specified plan
355 *
356 * @param {string} project - Project ID or project name
357 * @param {string} id - Identifier of the plan
358 */
359 deletePlan(project: string, id: string): Promise<void>;
360 /**
361 * Get the information for the specified plan
362 *
363 * @param {string} project - Project ID or project name
364 * @param {string} id - Identifier of the plan
365 */
366 getPlan(project: string, id: string): Promise<WorkInterfaces.Plan>;
367 /**
368 * Get the information for all the plans configured for the given team
369 *
370 * @param {string} project - Project ID or project name
371 */
372 getPlans(project: string): Promise<WorkInterfaces.Plan[]>;
373 /**
374 * Update the information for the specified plan
375 *
376 * @param {WorkInterfaces.UpdatePlan} updatedPlan - Plan definition to be updated
377 * @param {string} project - Project ID or project name
378 * @param {string} id - Identifier of the plan
379 */
380 updatePlan(updatedPlan: WorkInterfaces.UpdatePlan, project: string, id: string): Promise<WorkInterfaces.Plan>;
381 /**
382 * Get process configuration
383 *
384 * @param {string} project - Project ID or project name
385 */
386 getProcessConfiguration(project: string): Promise<WorkInterfaces.ProcessConfiguration>;
387 /**
388 * Get rows on a board
389 *
390 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
391 * @param {string} board - Name or ID of the specific board
392 */
393 getBoardRows(teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardRow[]>;
394 /**
395 * Update rows on a board
396 *
397 * @param {WorkInterfaces.BoardRow[]} boardRows - List of board rows to update
398 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
399 * @param {string} board - Name or ID of the specific board
400 */
401 updateBoardRows(boardRows: WorkInterfaces.BoardRow[], teamContext: TfsCoreInterfaces.TeamContext, board: string): Promise<WorkInterfaces.BoardRow[]>;
402 /**
403 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
404 */
405 getColumns(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TaskboardColumns>;
406 /**
407 * @param {WorkInterfaces.UpdateTaskboardColumn[]} updateColumns
408 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
409 */
410 updateColumns(updateColumns: WorkInterfaces.UpdateTaskboardColumn[], teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TaskboardColumns>;
411 /**
412 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
413 * @param {string} iterationId
414 */
415 getWorkItemColumns(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TaskboardWorkItemColumn[]>;
416 /**
417 * @param {WorkInterfaces.UpdateTaskboardWorkItemColumn} updateColumn
418 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
419 * @param {string} iterationId
420 * @param {number} workItemId
421 */
422 updateWorkItemColumn(updateColumn: WorkInterfaces.UpdateTaskboardWorkItemColumn, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string, workItemId: number): Promise<void>;
423 /**
424 * Get team's days off for an iteration
425 *
426 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
427 * @param {string} iterationId - ID of the iteration
428 */
429 getTeamDaysOff(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamSettingsDaysOff>;
430 /**
431 * Set a team's days off for an iteration
432 *
433 * @param {WorkInterfaces.TeamSettingsDaysOffPatch} daysOffPatch - Team's days off patch containing a list of start and end dates
434 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
435 * @param {string} iterationId - ID of the iteration
436 */
437 updateTeamDaysOff(daysOffPatch: WorkInterfaces.TeamSettingsDaysOffPatch, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.TeamSettingsDaysOff>;
438 /**
439 * Get a collection of team field values
440 *
441 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
442 */
443 getTeamFieldValues(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamFieldValues>;
444 /**
445 * Update team field values
446 *
447 * @param {WorkInterfaces.TeamFieldValuesPatch} patch
448 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
449 */
450 updateTeamFieldValues(patch: WorkInterfaces.TeamFieldValuesPatch, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamFieldValues>;
451 /**
452 * Get a team's settings
453 *
454 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
455 */
456 getTeamSettings(teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamSetting>;
457 /**
458 * Update a team's settings
459 *
460 * @param {WorkInterfaces.TeamSettingsPatch} teamSettingsPatch - TeamSettings changes
461 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
462 */
463 updateTeamSettings(teamSettingsPatch: WorkInterfaces.TeamSettingsPatch, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.TeamSetting>;
464 /**
465 * Get work items for iteration
466 *
467 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
468 * @param {string} iterationId - ID of the iteration
469 */
470 getIterationWorkItems(teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.IterationWorkItems>;
471 /**
472 * Reorder Product Backlog/Boards Work Items
473 *
474 * @param {WorkInterfaces.ReorderOperation} operation
475 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
476 */
477 reorderBacklogWorkItems(operation: WorkInterfaces.ReorderOperation, teamContext: TfsCoreInterfaces.TeamContext): Promise<WorkInterfaces.ReorderResult[]>;
478 /**
479 * Reorder Sprint Backlog/Taskboard Work Items
480 *
481 * @param {WorkInterfaces.ReorderOperation} operation
482 * @param {TfsCoreInterfaces.TeamContext} teamContext - The team context for the operation
483 * @param {string} iterationId - The id of the iteration
484 */
485 reorderIterationWorkItems(operation: WorkInterfaces.ReorderOperation, teamContext: TfsCoreInterfaces.TeamContext, iterationId: string): Promise<WorkInterfaces.ReorderResult[]>;
486}