azure-devops-extension-api 1.158.0 → 2.220.0

package/TestPlan/TestPlanClient.d.ts

@@ -1,6 +1,7 @@
 import { IVssRestClientOptions } from "../Common/Context";
 import { RestClientBase } from "../Common/RestClientBase";
 import * as TestPlan from "../TestPlan/TestPlan";
+import * as WebApi from "../WebApi/WebApi";
 export declare class TestPlanRestClient extends RestClientBase {
     constructor(options: IVssRestClientOptions);
     /**
@@ -30,7 +31,7 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param project - Project ID or project name
      * @param 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.
      */
-    getTestConfigurations(project: string, continuationToken?: string): Promise<TestPlan.TestConfiguration[]>;
+    getTestConfigurations(project: string, continuationToken?: string): Promise<WebApi.PagedList<TestPlan.TestConfiguration>>;
     /**
      * Update a test configuration by its ID.
      *
@@ -47,8 +48,9 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param configurations -
      * @param testers -
      * @param assignedTo -
+     * @param entity -
      */
-    getTestPointCountByPlanId(project: string, planId: number, states?: string, outcome?: TestPlan.UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string): Promise<TestPlan.TestPointCount[]>;
+    getTestEntityCountByPlanId(project: string, planId: number, states?: string, outcome?: TestPlan.UserFriendlyTestOutcome, configurations?: string, testers?: string, assignedTo?: string, entity?: TestPlan.TestEntityTypes): Promise<TestPlan.TestEntityCount[]>;
     /**
      * Create a test plan.
      *
@@ -79,7 +81,7 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param includePlanDetails - Get all properties of the test plan
      * @param filterActivePlans - Get just the active plans
      */
-    getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<TestPlan.TestPlan[]>;
+    getTestPlans(project: string, owner?: string, continuationToken?: string, includePlanDetails?: boolean, filterActivePlans?: boolean): Promise<WebApi.PagedList<TestPlan.TestPlan>>;
     /**
      * Update a test plan.
      *
@@ -104,6 +106,15 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param suiteId - Id of the parent test suite.
      */
     reorderSuiteEntries(suiteEntries: TestPlan.SuiteEntryUpdateParams[], project: string, suiteId: number): Promise<TestPlan.SuiteEntry[]>;
+    /**
+     * Create bulk requirement based test suites.
+     *
+     * @param testSuiteCreateParams - Parameters for suite creation
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan where requirement based suites need to be created.
+     * @param parentSuiteId - ID of the parent suite under which requirement based suites will be created
+     */
+    createBulkTestSuites(testSuiteCreateParams: TestPlan.TestSuiteCreateParams[], project: string, planId: number, parentSuiteId: number): Promise<TestPlan.TestSuite[]>;
     /**
      * Create test suite.
      *
@@ -138,7 +149,7 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param 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.
      * @param asTreeView - If the suites returned should be in a tree structure.
      */
-    getTestSuitesForPlan(project: string, planId: number, expand?: TestPlan.SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<TestPlan.TestSuite[]>;
+    getTestSuitesForPlan(project: string, planId: number, expand?: TestPlan.SuiteExpand, continuationToken?: string, asTreeView?: boolean): Promise<WebApi.PagedList<TestPlan.TestSuite>>;
     /**
      * Update test suite.
      *
@@ -164,18 +175,18 @@ export declare class TestPlanRestClient extends RestClientBase {
      */
     addTestCasesToSuite(suiteTestCaseCreateUpdateParameters: TestPlan.SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestPlan.TestCase[]>;
     /**
-     * Get Test Cases For a Suite.
+     * Get a particular Test Case from a Suite.
      *
      * @param project - Project ID or project name
      * @param planId - ID of the test plan for which test cases are requested.
      * @param suiteId - ID of the test suite for which test cases are requested.
-     * @param testCaseIds - Test Case Ids to be fetched.
+     * @param testCaseId - Test Case Id to be fetched.
      * @param witFields - Get the list of witFields.
      * @param 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.
      */
-    getTestCase(project: string, planId: number, suiteId: number, testCaseIds: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestPlan.TestCase[]>;
+    getTestCase(project: string, planId: number, suiteId: number, testCaseId: string, witFields?: string, returnIdentityRef?: boolean): Promise<TestPlan.TestCase[]>;
     /**
-     * Get Test Case List return those test cases which have all the configuration Ids as mentioned in the optional paramter. If configuration Ids is null, it return all the test cases
+     * 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
      *
      * @param project - Project ID or project name
      * @param planId - ID of the test plan for which test cases are requested.
@@ -187,8 +198,9 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param 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.
      * @param expand - If set to false, will get a smaller payload containing only basic details about the suite test case object
      * @param 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).
+     * @param isRecursive -
      */
-    getTestCaseList(project: string, planId: number, suiteId: number, testIds?: string, configurationIds?: string, witFields?: string, continuationToken?: string, returnIdentityRef?: boolean, expand?: boolean, excludeFlags?: TestPlan.ExcludeFlags): Promise<TestPlan.TestCase[]>;
+    getTestCaseList(project: string, planId: number, suiteId: number, testIds?: string, configurationIds?: string, witFields?: string, continuationToken?: string, returnIdentityRef?: boolean, expand?: boolean, excludeFlags?: TestPlan.ExcludeFlags, isRecursive?: boolean): Promise<WebApi.PagedList<TestPlan.TestCase>>;
     /**
      * Removes test cases from a suite based on the list of test case Ids provided.
      *
@@ -198,6 +210,15 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param testCaseIds - Test Case Ids to be removed.
      */
     removeTestCasesFromSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>;
+    /**
+     * 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.
+     *
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan from which test cases are to be removed.
+     * @param suiteId - ID of the test suite from which test cases are to be removed.
+     * @param testIds - Comma separated string of Test Case Ids to be removed.
+     */
+    removeTestCasesListFromSuite(project: string, planId: number, suiteId: number, testIds: string): Promise<void>;
     /**
      * Update the configurations for test cases
      *
@@ -207,6 +228,18 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param suiteId - ID of the test suite to which test cases are to be updated.
      */
     updateSuiteTestCases(suiteTestCaseCreateUpdateParameters: TestPlan.SuiteTestCaseCreateUpdateParameters[], project: string, planId: number, suiteId: number): Promise<TestPlan.TestCase[]>;
+    /**
+     * @param cloneRequestBody -
+     * @param project - Project ID or project name
+     */
+    cloneTestCase(cloneRequestBody: TestPlan.CloneTestCaseParams, project: string): Promise<TestPlan.CloneTestCaseOperationInformation>;
+    /**
+     * Get clone information.
+     *
+     * @param project - Project ID or project name
+     * @param cloneOperationId - Operation ID returned when we queue a clone operation
+     */
+    getTestCaseCloneInformation(project: string, cloneOperationId: number): Promise<TestPlan.CloneTestCaseOperationInformation>;
     /**
      * Delete a test case.
      *
@@ -230,16 +263,16 @@ export declare class TestPlanRestClient extends RestClientBase {
      */
     getCloneInformation(project: string, cloneOperationId: number): Promise<TestPlan.CloneTestPlanOperationInformation>;
     /**
-     * Get a list of points based on point Ids provided.
+     * Get a particular Test Point from a suite.
      *
      * @param project - Project ID or project name
      * @param planId - ID of the test plan for which test points are requested.
      * @param suiteId - ID of the test suite for which test points are requested.
-     * @param pointIds - ID of test points to be fetched.
+     * @param pointId - ID of test point to be fetched.
      * @param returnIdentityRef - If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
      * @param includePointDetails - If set to false, will get a smaller payload containing only basic details about the test point object
      */
-    getPoints(project: string, planId: number, suiteId: number, pointIds: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPlan.TestPoint[]>;
+    getPoints(project: string, planId: number, suiteId: number, pointId: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPlan.TestPoint[]>;
     /**
      * Get all the points inside a suite based on some filters
      *
@@ -251,8 +284,9 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param 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.
      * @param returnIdentityRef - If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
      * @param includePointDetails - If set to false, will get a smaller payload containing only basic details about the test point object
+     * @param isRecursive - If set to true, will also fetch test points belonging to child suites recursively.
      */
-    getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean): Promise<TestPlan.TestPoint[]>;
+    getPointsList(project: string, planId: number, suiteId: number, testPointIds?: string, testCaseId?: string, continuationToken?: string, returnIdentityRef?: boolean, includePointDetails?: boolean, isRecursive?: boolean): Promise<WebApi.PagedList<TestPlan.TestPoint>>;
     /**
      * 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
      *
@@ -306,7 +340,7 @@ export declare class TestPlanRestClient extends RestClientBase {
      * @param project - Project ID or project name
      * @param 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.
      */
-    getTestVariables(project: string, continuationToken?: string): Promise<TestPlan.TestVariable[]>;
+    getTestVariables(project: string, continuationToken?: string): Promise<WebApi.PagedList<TestPlan.TestVariable>>;
     /**
      * Update a test variable by its ID.
      *