UNPKG

30.9 kBTypeScriptView Raw
1/// <reference types="node" />
2import basem = require('./ClientApiBases');
3import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
4import TestPlanInterfaces = require("./interfaces/TestPlanInterfaces");
5import VSSInterfaces = require("./interfaces/common/VSSInterfaces");
6export interface ITestPlanApi extends basem.ClientApiBase {
7 createTestConfiguration(testConfigurationCreateUpdateParameters: TestPlanInterfaces.TestConfigurationCreateUpdateParameters, project: string): Promise<TestPlanInterfaces.TestConfiguration>;
8 deleteTestConfguration(project: string, testConfiguartionId: number): Promise<void>;
9 getTestConfigurationById(project: string, testConfigurationId: number): Promise<TestPlanInterfaces.TestConfiguration>;
10 getTestConfigurations(project: string, continuationToken?: string): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestConfiguration>>;
11 updateTestConfiguration(testConfigurationCreateUpdateParameters: TestPlanInterfaces.TestConfigurationCreateUpdateParameters, project: string, testConfiguartionId: number): Promise<TestPlanInterfaces.TestConfiguration>;
12 getTestEntityCountByPlanId(project: string, planId: number, states?: string, outcome?: TestPlanInterfaces.UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string, entity?: TestPlanInterfaces.TestEntityTypes): Promise<TestPlanInterfaces.TestEntityCount[]>;
13 createTestPlan(testPlanCreateParams: TestPlanInterfaces.TestPlanCreateParams, project: string): Promise<TestPlanInterfaces.TestPlan>;
14 deleteTestPlan(project: string, planId: number): Promise<void>;
15 getTestPlanById(project: string, planId: number): Promise<TestPlanInterfaces.TestPlan>;
16 getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestPlan>>;
17 updateTestPlan(testPlanUpdateParams: TestPlanInterfaces.TestPlanUpdateParams, project: string, planId: number): Promise<TestPlanInterfaces.TestPlan>;
18 getSuiteEntries(project: string, suiteId: number, suiteEntryType?: TestPlanInterfaces.SuiteEntryTypes): Promise<TestPlanInterfaces.SuiteEntry[]>;
19 reorderSuiteEntries(suiteEntries: TestPlanInterfaces.SuiteEntryUpdateParams[], project: string, suiteId: number): Promise<TestPlanInterfaces.SuiteEntry[]>;
20 createBulkTestSuites(testSuiteCreateParams: TestPlanInterfaces.TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestPlanInterfaces.TestSuite[]>;
21 createTestSuite(testSuiteCreateParams: TestPlanInterfaces.TestSuiteCreateParams, project: string, planId: number): Promise<TestPlanInterfaces.TestSuite>;
22 deleteTestSuite(project: string, planId: number, suiteId: number): Promise<void>;
23 getTestSuiteById(project: string, planId: number, suiteId: number, expand?: TestPlanInterfaces.SuiteExpand): Promise<TestPlanInterfaces.TestSuite>;
24 getTestSuitesForPlan(project: string, planId: number, expand?: TestPlanInterfaces.SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestSuite>>;
25 updateTestSuite(testSuiteUpdateParams: TestPlanInterfaces.TestSuiteUpdateParams, project: string, planId: number, suiteId: number): Promise<TestPlanInterfaces.TestSuite>;
26 getSuitesByTestCaseId(testCaseId: number): Promise<TestPlanInterfaces.TestSuite[]>;
27 addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: TestPlanInterfaces.SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestPlanInterfaces.TestCase[]>;
28 getTestCase(project: string, planId: number, suiteId: number, testCaseId: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestPlanInterfaces.TestCase[]>;
29 getTestCaseList(project: string, planId: number, suiteId: number, testIds?: string, configurationIds?: string, witFields?: string, continuationToken?: string, returnIdentityRef?: boolean, expand?: boolean, excludeFlags?: TestPlanInterfaces.ExcludeFlags, isRecursive?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestCase>>;
30 removeTestCasesFromSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>;
31 removeTestCasesListFromSuite(project: string, planId: number, suiteId: number, testIds: string): Promise<void>;
32 updateSuiteTestCases(suiteTestCaseCreateUpdateParameters: TestPlanInterfaces.SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestPlanInterfaces.TestCase[]>;
33 cloneTestCase(cloneRequestBody: TestPlanInterfaces.CloneTestCaseParams, project: string): Promise<TestPlanInterfaces.CloneTestCaseOperationInformation>;
34 getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<TestPlanInterfaces.CloneTestCaseOperationInformation>;
35 exportTestCases(exportTestCaseRequestBody: TestPlanInterfaces.ExportTestCaseParams, project: string): Promise<NodeJS.ReadableStream>;
36 deleteTestCase(project: string, testCaseId: number): Promise<void>;
37 cloneTestPlan(cloneRequestBody: TestPlanInterfaces.CloneTestPlanParams, project: string, deepClone?: boolean): Promise<TestPlanInterfaces.CloneTestPlanOperationInformation>;
38 getCloneInformation(project: string, cloneOperationId: number): Promise<TestPlanInterfaces.CloneTestPlanOperationInformation>;
39 getPoints(project: string, planId: number, suiteId: number, pointId: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPlanInterfaces.TestPoint[]>;
40 getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean, isRecursive?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestPoint>>;
41 updateTestPoints(testPointUpdateParams: TestPlanInterfaces.TestPointUpdateParams[], project: string, planId: number, suiteId: number, includePointDetails?: boolean, returnIdentityRef?: boolean): Promise<TestPlanInterfaces.TestPoint[]>;
42 cloneTestSuite(cloneRequestBody: TestPlanInterfaces.CloneTestSuiteParams, project: string, deepClone?: boolean): Promise<TestPlanInterfaces.CloneTestSuiteOperationInformation>;
43 getSuiteCloneInformation(project: string, cloneOperationId: number): Promise<TestPlanInterfaces.CloneTestSuiteOperationInformation>;
44 createTestVariable(testVariableCreateUpdateParameters: TestPlanInterfaces.TestVariableCreateUpdateParameters, project: string): Promise<TestPlanInterfaces.TestVariable>;
45 deleteTestVariable(project: string, testVariableId: number): Promise<void>;
46 getTestVariableById(project: string, testVariableId: number): Promise<TestPlanInterfaces.TestVariable>;
47 getTestVariables(project: string, continuationToken?: string): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestVariable>>;
48 updateTestVariable(testVariableCreateUpdateParameters: TestPlanInterfaces.TestVariableCreateUpdateParameters, project: string, testVariableId: number): Promise<TestPlanInterfaces.TestVariable>;
49}
50export declare class TestPlanApi extends basem.ClientApiBase implements ITestPlanApi {
51 constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions);
52 /**
53 * Create a test configuration.
54 *
55 * @param {TestPlanInterfaces.TestConfigurationCreateUpdateParameters} testConfigurationCreateUpdateParameters - TestConfigurationCreateUpdateParameters
56 * @param {string} project - Project ID or project name
57 */
58 createTestConfiguration(testConfigurationCreateUpdateParameters: TestPlanInterfaces.TestConfigurationCreateUpdateParameters, project: string): Promise<TestPlanInterfaces.TestConfiguration>;
59 /**
60 * Delete a test configuration by its ID.
61 *
62 * @param {string} project - Project ID or project name
63 * @param {number} testConfiguartionId - ID of the test configuration to delete.
64 */
65 deleteTestConfguration(project: string, testConfiguartionId: number): Promise<void>;
66 /**
67 * Get a test configuration
68 *
69 * @param {string} project - Project ID or project name
70 * @param {number} testConfigurationId - ID of the test configuration to get.
71 */
72 getTestConfigurationById(project: string, testConfigurationId: number): Promise<TestPlanInterfaces.TestConfiguration>;
73 /**
74 * Get a list of test configurations.
75 *
76 * @param {string} project - Project ID or project name
77 * @param {string} continuationToken - If the list of configurations returned is not complete, a continuation token to query next batch of configurations is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test configurations.
78 */
79 getTestConfigurations(project: string, continuationToken?: string): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestConfiguration>>;
80 /**
81 * Update a test configuration by its ID.
82 *
83 * @param {TestPlanInterfaces.TestConfigurationCreateUpdateParameters} testConfigurationCreateUpdateParameters - TestConfigurationCreateUpdateParameters
84 * @param {string} project - Project ID or project name
85 * @param {number} testConfiguartionId - ID of the test configuration to update.
86 */
87 updateTestConfiguration(testConfigurationCreateUpdateParameters: TestPlanInterfaces.TestConfigurationCreateUpdateParameters, project: string, testConfiguartionId: number): Promise<TestPlanInterfaces.TestConfiguration>;
88 /**
89 * @param {string} project - Project ID or project name
90 * @param {number} planId
91 * @param {string} states
92 * @param {TestPlanInterfaces.UserFriendlyTestOutcome} outcome
93 * @param {string} configurations
94 * @param {string} testers
95 * @param {string} assignedTo
96 * @param {TestPlanInterfaces.TestEntityTypes} entity
97 */
98 getTestEntityCountByPlanId(project: string, planId: number, states?: string, outcome?: TestPlanInterfaces.UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string, entity?: TestPlanInterfaces.TestEntityTypes): Promise<TestPlanInterfaces.TestEntityCount[]>;
99 /**
100 * Create a test plan.
101 *
102 * @param {TestPlanInterfaces.TestPlanCreateParams} testPlanCreateParams - A testPlanCreateParams object.TestPlanCreateParams
103 * @param {string} project - Project ID or project name
104 */
105 createTestPlan(testPlanCreateParams: TestPlanInterfaces.TestPlanCreateParams, project: string): Promise<TestPlanInterfaces.TestPlan>;
106 /**
107 * Delete a test plan.
108 *
109 * @param {string} project - Project ID or project name
110 * @param {number} planId - ID of the test plan to be deleted.
111 */
112 deleteTestPlan(project: string, planId: number): Promise<void>;
113 /**
114 * Get a test plan by Id.
115 *
116 * @param {string} project - Project ID or project name
117 * @param {number} planId - ID of the test plan to get.
118 */
119 getTestPlanById(project: string, planId: number): Promise<TestPlanInterfaces.TestPlan>;
120 /**
121 * Get a list of test plans
122 *
123 * @param {string} project - Project ID or project name
124 * @param {string} owner - Filter for test plan by owner ID or name
125 * @param {string} continuationToken - If the list of plans returned is not complete, a continuation token to query next batch of plans is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test plans.
126 * @param {boolean} includePlanDetails - Get all properties of the test plan
127 * @param {boolean} filterActivePlans - Get just the active plans
128 */
129 getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestPlan>>;
130 /**
131 * Update a test plan.
132 *
133 * @param {TestPlanInterfaces.TestPlanUpdateParams} testPlanUpdateParams - A testPlanUpdateParams object.TestPlanUpdateParams
134 * @param {string} project - Project ID or project name
135 * @param {number} planId - ID of the test plan to be updated.
136 */
137 updateTestPlan(testPlanUpdateParams: TestPlanInterfaces.TestPlanUpdateParams, project: string, planId: number): Promise<TestPlanInterfaces.TestPlan>;
138 /**
139 * Get a list of test suite entries in the test suite.
140 *
141 * @param {string} project - Project ID or project name
142 * @param {number} suiteId - Id of the parent suite.
143 * @param {TestPlanInterfaces.SuiteEntryTypes} suiteEntryType
144 */
145 getSuiteEntries(project: string, suiteId: number, suiteEntryType?: TestPlanInterfaces.SuiteEntryTypes): Promise<TestPlanInterfaces.SuiteEntry[]>;
146 /**
147 * Reorder test suite entries in the test suite.
148 *
149 * @param {TestPlanInterfaces.SuiteEntryUpdateParams[]} suiteEntries - List of SuiteEntry to reorder.
150 * @param {string} project - Project ID or project name
151 * @param {number} suiteId - Id of the parent test suite.
152 */
153 reorderSuiteEntries(suiteEntries: TestPlanInterfaces.SuiteEntryUpdateParams[], project: string, suiteId: number): Promise<TestPlanInterfaces.SuiteEntry[]>;
154 /**
155 * Create bulk requirement based test suites.
156 *
157 * @param {TestPlanInterfaces.TestSuiteCreateParams[]} testSuiteCreateParams - Parameters for suite creation
158 * @param {string} project - Project ID or project name
159 * @param {number} planId - ID of the test plan where requirement based suites need to be created.
160 * @param {number} parentSuiteId - ID of the parent suite under which requirement based suites will be created
161 */
162 createBulkTestSuites(testSuiteCreateParams: TestPlanInterfaces.TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestPlanInterfaces.TestSuite[]>;
163 /**
164 * Create test suite.
165 *
166 * @param {TestPlanInterfaces.TestSuiteCreateParams} testSuiteCreateParams - Parameters for suite creation
167 * @param {string} project - Project ID or project name
168 * @param {number} planId - ID of the test plan that contains the suites.
169 */
170 createTestSuite(testSuiteCreateParams: TestPlanInterfaces.TestSuiteCreateParams, project: string, planId: number): Promise<TestPlanInterfaces.TestSuite>;
171 /**
172 * Delete test suite.
173 *
174 * @param {string} project - Project ID or project name
175 * @param {number} planId - ID of the test plan that contains the suite.
176 * @param {number} suiteId - ID of the test suite to delete.
177 */
178 deleteTestSuite(project: string, planId: number, suiteId: number): Promise<void>;
179 /**
180 * Get test suite by suite id.
181 *
182 * @param {string} project - Project ID or project name
183 * @param {number} planId - ID of the test plan that contains the suites.
184 * @param {number} suiteId - ID of the suite to get.
185 * @param {TestPlanInterfaces.SuiteExpand} expand - Include the children suites and testers details
186 */
187 getTestSuiteById(project: string, planId: number, suiteId: number, expand?: TestPlanInterfaces.SuiteExpand): Promise<TestPlanInterfaces.TestSuite>;
188 /**
189 * Get test suites for plan.
190 *
191 * @param {string} project - Project ID or project name
192 * @param {number} planId - ID of the test plan for which suites are requested.
193 * @param {TestPlanInterfaces.SuiteExpand} expand - Include the children suites and testers details.
194 * @param {string} continuationToken - If the list of suites returned is not complete, a continuation token to query next batch of suites is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test suites.
195 * @param {boolean} asTreeView - If the suites returned should be in a tree structure.
196 */
197 getTestSuitesForPlan(project: string, planId: number, expand?: TestPlanInterfaces.SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestSuite>>;
198 /**
199 * Update test suite.
200 *
201 * @param {TestPlanInterfaces.TestSuiteUpdateParams} testSuiteUpdateParams - Parameters for suite updation
202 * @param {string} project - Project ID or project name
203 * @param {number} planId - ID of the test plan that contains the suites.
204 * @param {number} suiteId - ID of the parent suite.
205 */
206 updateTestSuite(testSuiteUpdateParams: TestPlanInterfaces.TestSuiteUpdateParams, project: string, planId: number, suiteId: number): Promise<TestPlanInterfaces.TestSuite>;
207 /**
208 * Find the list of all test suites in which a given test case is present. This is helpful if you need to find out which test suites are using a test case, when you need to make changes to a test case.
209 *
210 * @param {number} testCaseId - ID of the test case for which suites need to be fetched.
211 */
212 getSuitesByTestCaseId(testCaseId: number): Promise<TestPlanInterfaces.TestSuite[]>;
213 /**
214 * Add test cases to a suite with specified configurations
215 *
216 * @param {TestPlanInterfaces.SuiteTestCaseCreateUpdateParameters[]} suiteTestCaseCreateUpdateParameters - SuiteTestCaseCreateUpdateParameters object.
217 * @param {string} project - Project ID or project name
218 * @param {number} planId - ID of the test plan to which test cases are to be added.
219 * @param {number} suiteId - ID of the test suite to which test cases are to be added.
220 */
221 addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: TestPlanInterfaces.SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestPlanInterfaces.TestCase[]>;
222 /**
223 * Get a particular Test Case from a Suite.
224 *
225 * @param {string} project - Project ID or project name
226 * @param {number} planId - ID of the test plan for which test cases are requested.
227 * @param {number} suiteId - ID of the test suite for which test cases are requested.
228 * @param {string} testCaseId - Test Case Id to be fetched.
229 * @param {string} witFields - Get the list of witFields.
230 * @param {boolean} returnIdentityRef - If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
231 */
232 getTestCase(project: string, planId: number, suiteId: number, testCaseId: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestPlanInterfaces.TestCase[]>;
233 /**
234 * Get Test Case List return those test cases which have all the configuration Ids as mentioned in the optional parameter. If configuration Ids is null, it return all the test cases
235 *
236 * @param {string} project - Project ID or project name
237 * @param {number} planId - ID of the test plan for which test cases are requested.
238 * @param {number} suiteId - ID of the test suite for which test cases are requested.
239 * @param {string} testIds - Test Case Ids to be fetched.
240 * @param {string} configurationIds - Fetch Test Cases which contains all the configuration Ids specified.
241 * @param {string} witFields - Get the list of witFields.
242 * @param {string} continuationToken - If the list of test cases returned is not complete, a continuation token to query next batch of test cases is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test cases.
243 * @param {boolean} returnIdentityRef - If set to true, returns all identity fields, like AssignedTo, ActivatedBy etc., as IdentityRef objects. If set to false, these fields are returned as unique names in string format. This is false by default.
244 * @param {boolean} expand - If set to false, will get a smaller payload containing only basic details about the suite test case object
245 * @param {TestPlanInterfaces.ExcludeFlags} excludeFlags - Flag to exclude various values from payload. For example to remove point assignments pass exclude = 1. To remove extra information (links, test plan , test suite) pass exclude = 2. To remove both extra information and point assignments pass exclude = 3 (1 + 2).
246 * @param {boolean} isRecursive
247 */
248 getTestCaseList(project: string, planId: number, suiteId: number, testIds?: string, configurationIds?: string, witFields?: string, continuationToken?: string, returnIdentityRef?: boolean, expand?: boolean, excludeFlags?: TestPlanInterfaces.ExcludeFlags, isRecursive?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestCase>>;
249 /**
250 * Removes test cases from a suite based on the list of test case Ids provided.
251 *
252 * @param {string} project - Project ID or project name
253 * @param {number} planId - ID of the test plan from which test cases are to be removed.
254 * @param {number} suiteId - ID of the test suite from which test cases are to be removed.
255 * @param {string} testCaseIds - Test Case Ids to be removed.
256 */
257 removeTestCasesFromSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>;
258 /**
259 * Removes test cases from a suite based on the list of test case Ids provided. This API can be used to remove a larger number of test cases.
260 *
261 * @param {string} project - Project ID or project name
262 * @param {number} planId - ID of the test plan from which test cases are to be removed.
263 * @param {number} suiteId - ID of the test suite from which test cases are to be removed.
264 * @param {string} testIds - Comma separated string of Test Case Ids to be removed.
265 */
266 removeTestCasesListFromSuite(project: string, planId: number, suiteId: number, testIds: string): Promise<void>;
267 /**
268 * Update the configurations for test cases
269 *
270 * @param {TestPlanInterfaces.SuiteTestCaseCreateUpdateParameters[]} suiteTestCaseCreateUpdateParameters - A SuiteTestCaseCreateUpdateParameters object.
271 * @param {string} project - Project ID or project name
272 * @param {number} planId - ID of the test plan to which test cases are to be updated.
273 * @param {number} suiteId - ID of the test suite to which test cases are to be updated.
274 */
275 updateSuiteTestCases(suiteTestCaseCreateUpdateParameters: TestPlanInterfaces.SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestPlanInterfaces.TestCase[]>;
276 /**
277 * @param {TestPlanInterfaces.CloneTestCaseParams} cloneRequestBody
278 * @param {string} project - Project ID or project name
279 */
280 cloneTestCase(cloneRequestBody: TestPlanInterfaces.CloneTestCaseParams, project: string): Promise<TestPlanInterfaces.CloneTestCaseOperationInformation>;
281 /**
282 * Get clone information.
283 *
284 * @param {string} project - Project ID or project name
285 * @param {number} cloneOperationId - Operation ID returned when we queue a clone operation
286 */
287 getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<TestPlanInterfaces.CloneTestCaseOperationInformation>;
288 /**
289 * Exports a set of test cases from a suite to a file. Currently supported formats: xlsx
290 *
291 * @param {TestPlanInterfaces.ExportTestCaseParams} exportTestCaseRequestBody - A ExportTestCaseParams object.ExportTestCaseParams
292 * @param {string} project - Project ID or project name
293 */
294 exportTestCases(exportTestCaseRequestBody: TestPlanInterfaces.ExportTestCaseParams, project: string): Promise<NodeJS.ReadableStream>;
295 /**
296 * Delete a test case.
297 *
298 * @param {string} project - Project ID or project name
299 * @param {number} testCaseId - Id of test case to be deleted.
300 */
301 deleteTestCase(project: string, testCaseId: number): Promise<void>;
302 /**
303 * Clone test plan
304 *
305 * @param {TestPlanInterfaces.CloneTestPlanParams} cloneRequestBody - Plan Clone Request Body detail TestPlanCloneRequest
306 * @param {string} project - Project ID or project name
307 * @param {boolean} deepClone - Clones all the associated test cases as well
308 */
309 cloneTestPlan(cloneRequestBody: TestPlanInterfaces.CloneTestPlanParams, project: string, deepClone?: boolean): Promise<TestPlanInterfaces.CloneTestPlanOperationInformation>;
310 /**
311 * Get clone information.
312 *
313 * @param {string} project - Project ID or project name
314 * @param {number} cloneOperationId - Operation ID returned when we queue a clone operation
315 */
316 getCloneInformation(project: string, cloneOperationId: number): Promise<TestPlanInterfaces.CloneTestPlanOperationInformation>;
317 /**
318 * Get a particular Test Point from a suite.
319 *
320 * @param {string} project - Project ID or project name
321 * @param {number} planId - ID of the test plan for which test points are requested.
322 * @param {number} suiteId - ID of the test suite for which test points are requested.
323 * @param {string} pointId - ID of test point to be fetched.
324 * @param {boolean} returnIdentityRef - If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
325 * @param {boolean} includePointDetails - If set to false, will get a smaller payload containing only basic details about the test point object
326 */
327 getPoints(project: string, planId: number, suiteId: number, pointId: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPlanInterfaces.TestPoint[]>;
328 /**
329 * Get all the points inside a suite based on some filters
330 *
331 * @param {string} project - Project ID or project name
332 * @param {number} planId - ID of the test plan for which test points are requested.
333 * @param {number} suiteId - ID of the test suite for which test points are requested
334 * @param {string} testPointIds - ID of test points to fetch.
335 * @param {string} testCaseId - Get Test Points for specific test case Ids.
336 * @param {string} continuationToken - If the list of test point returned is not complete, a continuation token to query next batch of test points is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test points.
337 * @param {boolean} returnIdentityRef - If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
338 * @param {boolean} includePointDetails - If set to false, will get a smaller payload containing only basic details about the test point object
339 * @param {boolean} isRecursive - If set to true, will also fetch test points belonging to child suites recursively.
340 */
341 getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean, isRecursive?: boolean): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestPoint>>;
342 /**
343 * Update Test Points. This is used to Reset test point to active, update the outcome of a test point or update the tester of a test point
344 *
345 * @param {TestPlanInterfaces.TestPointUpdateParams[]} testPointUpdateParams - A TestPointUpdateParams Object.
346 * @param {string} project - Project ID or project name
347 * @param {number} planId - ID of the test plan for which test points are requested.
348 * @param {number} suiteId - ID of the test suite for which test points are requested.
349 * @param {boolean} includePointDetails - If set to false, will get a smaller payload containing only basic details about the test point object
350 * @param {boolean} returnIdentityRef - If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
351 */
352 updateTestPoints(testPointUpdateParams: TestPlanInterfaces.TestPointUpdateParams[], project: string, planId: number, suiteId: number, includePointDetails?: boolean, returnIdentityRef?: boolean): Promise<TestPlanInterfaces.TestPoint[]>;
353 /**
354 * Clone test suite
355 *
356 * @param {TestPlanInterfaces.CloneTestSuiteParams} cloneRequestBody - Suite Clone Request Body detail TestSuiteCloneRequest
357 * @param {string} project - Project ID or project name
358 * @param {boolean} deepClone - Clones all the associated test cases as well
359 */
360 cloneTestSuite(cloneRequestBody: TestPlanInterfaces.CloneTestSuiteParams, project: string, deepClone?: boolean): Promise<TestPlanInterfaces.CloneTestSuiteOperationInformation>;
361 /**
362 * Get clone information.
363 *
364 * @param {string} project - Project ID or project name
365 * @param {number} cloneOperationId - Operation ID returned when we queue a clone operation
366 */
367 getSuiteCloneInformation(project: string, cloneOperationId: number): Promise<TestPlanInterfaces.CloneTestSuiteOperationInformation>;
368 /**
369 * Create a test variable.
370 *
371 * @param {TestPlanInterfaces.TestVariableCreateUpdateParameters} testVariableCreateUpdateParameters - TestVariableCreateUpdateParameters
372 * @param {string} project - Project ID or project name
373 */
374 createTestVariable(testVariableCreateUpdateParameters: TestPlanInterfaces.TestVariableCreateUpdateParameters, project: string): Promise<TestPlanInterfaces.TestVariable>;
375 /**
376 * Delete a test variable by its ID.
377 *
378 * @param {string} project - Project ID or project name
379 * @param {number} testVariableId - ID of the test variable to delete.
380 */
381 deleteTestVariable(project: string, testVariableId: number): Promise<void>;
382 /**
383 * Get a test variable by its ID.
384 *
385 * @param {string} project - Project ID or project name
386 * @param {number} testVariableId - ID of the test variable to get.
387 */
388 getTestVariableById(project: string, testVariableId: number): Promise<TestPlanInterfaces.TestVariable>;
389 /**
390 * Get a list of test variables.
391 *
392 * @param {string} project - Project ID or project name
393 * @param {string} continuationToken - If the list of variables returned is not complete, a continuation token to query next batch of variables is included in the response header as "x-ms-continuationtoken". Omit this parameter to get the first batch of test variables.
394 */
395 getTestVariables(project: string, continuationToken?: string): Promise<VSSInterfaces.PagedList<TestPlanInterfaces.TestVariable>>;
396 /**
397 * Update a test variable by its ID.
398 *
399 * @param {TestPlanInterfaces.TestVariableCreateUpdateParameters} testVariableCreateUpdateParameters - TestVariableCreateUpdateParameters
400 * @param {string} project - Project ID or project name
401 * @param {number} testVariableId - ID of the test variable to update.
402 */
403 updateTestVariable(testVariableCreateUpdateParameters: TestPlanInterfaces.TestVariableCreateUpdateParameters, project: string, testVariableId: number): Promise<TestPlanInterfaces.TestVariable>;
404}