azure-devops-extension-api 4.269.1 → 5.271.0

package/esm/TestPlan/TestPlanClient.js

@@ -0,0 +1,1051 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+import { RestClientBase } from "../Common/RestClientBase";
+import { deserializeVssJsonObject } from "../Common/Util/Serialization";
+export class TestPlanRestClient extends RestClientBase {
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Create a test configuration.
+     *
+     * @param testConfigurationCreateUpdateParameters - TestConfigurationCreateUpdateParameters
+     * @param project - Project ID or project name
+     */
+    async createTestConfiguration(testConfigurationCreateUpdateParameters, project) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Configurations/{testConfigurationId}",
+            routeValues: {
+                project: project
+            },
+            body: testConfigurationCreateUpdateParameters
+        });
+    }
+    /**
+     * Delete a test configuration by its ID.
+     *
+     * @param project - Project ID or project name
+     * @param testConfiguartionId - ID of the test configuration to delete.
+     */
+    async deleteTestConfguration(project, testConfiguartionId) {
+        const queryValues = {
+            testConfiguartionId: testConfiguartionId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/testplan/Configurations/{testConfigurationId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a test configuration
+     *
+     * @param project - Project ID or project name
+     * @param testConfigurationId - ID of the test configuration to get.
+     */
+    async getTestConfigurationById(project, testConfigurationId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Configurations/{testConfigurationId}",
+            routeValues: {
+                project: project,
+                testConfigurationId: testConfigurationId
+            }
+        });
+    }
+    /**
+     * Get a list of test configurations.
+     *
+     * @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.
+     */
+    async getTestConfigurations(project, continuationToken) {
+        const queryValues = {
+            continuationToken: continuationToken
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Configurations/{testConfigurationId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Update a test configuration by its ID.
+     *
+     * @param testConfigurationCreateUpdateParameters - TestConfigurationCreateUpdateParameters
+     * @param project - Project ID or project name
+     * @param testConfiguartionId - ID of the test configuration to update.
+     */
+    async updateTestConfiguration(testConfigurationCreateUpdateParameters, project, testConfiguartionId) {
+        const queryValues = {
+            testConfiguartionId: testConfiguartionId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/Configurations/{testConfigurationId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            body: testConfigurationCreateUpdateParameters
+        });
+    }
+    /**
+     * @param project - Project ID or project name
+     * @param planId -
+     * @param states -
+     * @param outcome -
+     * @param configurations -
+     * @param testers -
+     * @param assignedTo -
+     * @param entity -
+     */
+    async getTestEntityCountByPlanId(project, planId, states, outcome, configurations, testers, assignedTo, entity) {
+        const queryValues = {
+            states: states,
+            outcome: outcome,
+            configurations: configurations,
+            testers: testers,
+            assignedTo: assignedTo,
+            entity: entity
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Count/{planId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Create a test plan.
+     *
+     * @param testPlanCreateParams - A testPlanCreateParams object.TestPlanCreateParams
+     * @param project - Project ID or project name
+     */
+    async createTestPlan(testPlanCreateParams, project) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}",
+            routeValues: {
+                project: project
+            },
+            body: testPlanCreateParams
+        });
+    }
+    /**
+     * Delete a test plan.
+     *
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan to be deleted.
+     */
+    async deleteTestPlan(project, planId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            }
+        });
+    }
+    /**
+     * Get a test plan by Id.
+     *
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan to get.
+     */
+    async getTestPlanById(project, planId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            }
+        });
+    }
+    /**
+     * Get a list of test plans
+     *
+     * @param project - Project ID or project name
+     * @param owner - Filter for test plan by owner ID or name
+     * @param 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.
+     * @param includePlanDetails - Get all properties of the test plan
+     * @param filterActivePlans - Get just the active plans
+     */
+    async getTestPlans(project, owner, continuationToken, includePlanDetails, filterActivePlans) {
+        const queryValues = {
+            owner: owner,
+            continuationToken: continuationToken,
+            includePlanDetails: includePlanDetails,
+            filterActivePlans: filterActivePlans
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Update a test plan.
+     *
+     * @param testPlanUpdateParams - A testPlanUpdateParams object.TestPlanUpdateParams
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan to be updated.
+     */
+    async updateTestPlan(testPlanUpdateParams, project, planId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            },
+            body: testPlanUpdateParams
+        });
+    }
+    /**
+     * Get a list of test suite entries in the test suite.
+     *
+     * @param project - Project ID or project name
+     * @param suiteId - Id of the parent suite.
+     * @param suiteEntryType -
+     */
+    async getSuiteEntries(project, suiteId, suiteEntryType) {
+        const queryValues = {
+            suiteEntryType: suiteEntryType
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/SuiteEntry/{suiteId}",
+            routeValues: {
+                project: project,
+                suiteId: suiteId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Reorder test suite entries in the test suite.
+     *
+     * @param suiteEntries - List of SuiteEntry to reorder.
+     * @param project - Project ID or project name
+     * @param suiteId - Id of the parent test suite.
+     */
+    async reorderSuiteEntries(suiteEntries, project, suiteId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/SuiteEntry/{suiteId}",
+            routeValues: {
+                project: project,
+                suiteId: suiteId
+            },
+            body: suiteEntries
+        });
+    }
+    /**
+     * 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
+     */
+    async createBulkTestSuites(testSuiteCreateParams, project, planId, parentSuiteId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{parentSuiteId}/bulk",
+            routeValues: {
+                project: project,
+                planId: planId,
+                parentSuiteId: parentSuiteId
+            },
+            body: testSuiteCreateParams
+        });
+    }
+    /**
+     * Create test suite.
+     *
+     * @param testSuiteCreateParams - Parameters for suite creation
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan that contains the suites.
+     */
+    async createTestSuite(testSuiteCreateParams, project, planId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            },
+            body: testSuiteCreateParams
+        });
+    }
+    /**
+     * Delete test suite.
+     *
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan that contains the suite.
+     * @param suiteId - ID of the test suite to delete.
+     */
+    async deleteTestSuite(project, planId, suiteId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            }
+        });
+    }
+    /**
+     * Get test suite by suite id.
+     *
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan that contains the suites.
+     * @param suiteId - ID of the suite to get.
+     * @param expand - Include the children suites and testers details
+     */
+    async getTestSuiteById(project, planId, suiteId, expand) {
+        const queryValues = {
+            expand: expand
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get test suites for plan.
+     *
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan for which suites are requested.
+     * @param expand - Include the children suites and testers details.
+     * @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.
+     */
+    async getTestSuitesForPlan(project, planId, expand, continuationToken, asTreeView) {
+        const queryValues = {
+            expand: expand,
+            continuationToken: continuationToken,
+            asTreeView: asTreeView
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Update test suite.
+     *
+     * @param testSuiteUpdateParams - Parameters for suite updation
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan that contains the suites.
+     * @param suiteId - ID of the parent suite.
+     */
+    async updateTestSuite(testSuiteUpdateParams, project, planId, suiteId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            body: testSuiteUpdateParams
+        });
+    }
+    /**
+     * 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.
+     *
+     * @param testCaseId - ID of the test case for which suites need to be fetched.
+     */
+    async getSuitesByTestCaseId(testCaseId) {
+        const queryValues = {
+            testCaseId: testCaseId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/testplan/Suites",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Add test cases to a suite with specified configurations
+     *
+     * @param suiteTestCaseCreateUpdateParameters - SuiteTestCaseCreateUpdateParameters object.
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan to which test cases are to be added.
+     * @param suiteId - ID of the test suite to which test cases are to be added.
+     */
+    async addTestCasesToSuite(suiteTestCaseCreateUpdateParameters, project, planId, suiteId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase/{testCaseId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            body: suiteTestCaseCreateUpdateParameters
+        });
+    }
+    /**
+     * 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 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.
+     */
+    async getTestCase(project, planId, suiteId, testCaseId, witFields, returnIdentityRef) {
+        const queryValues = {
+            witFields: witFields,
+            returnIdentityRef: returnIdentityRef
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase/{testCaseId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId,
+                testCaseId: testCaseId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * 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.
+     * @param suiteId - ID of the test suite for which test cases are requested.
+     * @param testIds - Test Case Ids to be fetched.
+     * @param configurationIds - Fetch Test Cases which contains all the configuration Ids specified.
+     * @param witFields - Get the list of witFields.
+     * @param 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.
+     * @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 -
+     */
+    async getTestCaseList(project, planId, suiteId, testIds, configurationIds, witFields, continuationToken, returnIdentityRef, expand, excludeFlags, isRecursive) {
+        const queryValues = {
+            testIds: testIds,
+            configurationIds: configurationIds,
+            witFields: witFields,
+            continuationToken: continuationToken,
+            returnIdentityRef: returnIdentityRef,
+            expand: expand,
+            excludeFlags: excludeFlags,
+            isRecursive: isRecursive
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase/{testCaseId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Removes test cases from a suite based on the list of test case Ids provided.
+     *
+     * @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 testCaseIds - Test Case Ids to be removed.
+     */
+    async removeTestCasesFromSuite(project, planId, suiteId, testCaseIds) {
+        const queryValues = {
+            testCaseIds: testCaseIds
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase/{testCaseId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * 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.
+     */
+    async removeTestCasesListFromSuite(project, planId, suiteId, testIds) {
+        const queryValues = {
+            testIds: testIds
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase/{testCaseId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update the configurations for test cases
+     *
+     * @param suiteTestCaseCreateUpdateParameters - A SuiteTestCaseCreateUpdateParameters object.
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan to which test cases are to be updated.
+     * @param suiteId - ID of the test suite to which test cases are to be updated.
+     */
+    async updateSuiteTestCases(suiteTestCaseCreateUpdateParameters, project, planId, suiteId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase/{testCaseId}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            body: suiteTestCaseCreateUpdateParameters
+        });
+    }
+    /**
+     * @param cloneRequestBody -
+     * @param project - Project ID or project name
+     */
+    async cloneTestCase(cloneRequestBody, project) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/TestCases/CloneTestCaseOperation/{cloneOperationId}",
+            routeValues: {
+                project: project
+            },
+            body: cloneRequestBody
+        });
+    }
+    /**
+     * Get clone information.
+     *
+     * @param project - Project ID or project name
+     * @param cloneOperationId - Operation ID returned when we queue a clone operation
+     */
+    async getTestCaseCloneInformation(project, cloneOperationId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "{project}/_apis/testplan/TestCases/CloneTestCaseOperation/{cloneOperationId}",
+            routeValues: {
+                project: project,
+                cloneOperationId: cloneOperationId
+            }
+        });
+    }
+    /**
+     * Exports a set of test cases from a suite to a file. Currently supported  formats: xlsx
+     *
+     * @param exportTestCaseRequestBody - A ExportTestCaseParams object.ExportTestCaseParams
+     * @param project - Project ID or project name
+     */
+    async exportTestCases(exportTestCaseRequestBody, project) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            httpResponseType: "application/octet-stream",
+            routeTemplate: "{project}/_apis/testplan/TestCases/TestCaseFile",
+            routeValues: {
+                project: project
+            },
+            body: exportTestCaseRequestBody
+        });
+    }
+    /**
+     * Delete a test case.
+     *
+     * @param project - Project ID or project name
+     * @param testCaseId - Id of test case to be deleted.
+     */
+    async deleteTestCase(project, testCaseId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/testplan/TestCases/{testCaseId}",
+            routeValues: {
+                project: project,
+                testCaseId: testCaseId
+            }
+        });
+    }
+    /**
+     * Get a list of deleted test plans
+     *
+     * @param project - Project ID or project name
+     * @param 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.
+     */
+    async getDeletedTestPlans(project, continuationToken) {
+        const queryValues = {
+            continuationToken: continuationToken
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/recycleBin/TestPlan/{planId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Restores the deleted test plan
+     *
+     * @param restoreModel - The model containing the restore information
+     * @param project - Project ID or project name
+     * @param planId - The ID of the test plan to restore
+     */
+    async restoreDeletedTestPlan(restoreModel, project, planId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/recycleBin/TestPlan/{planId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            },
+            body: restoreModel
+        });
+    }
+    /**
+     * Clone test plan
+     *
+     * @param cloneRequestBody - Plan Clone Request Body detail TestPlanCloneRequest
+     * @param project - Project ID or project name
+     * @param deepClone - Clones all the associated test cases as well
+     */
+    async cloneTestPlan(cloneRequestBody, project, deepClone) {
+        const queryValues = {
+            deepClone: deepClone
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Plans/CloneOperation/{cloneOperationId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            body: cloneRequestBody
+        });
+    }
+    /**
+     * Get clone information.
+     *
+     * @param project - Project ID or project name
+     * @param cloneOperationId - Operation ID returned when we queue a clone operation
+     */
+    async getCloneInformation(project, cloneOperationId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "{project}/_apis/testplan/Plans/CloneOperation/{cloneOperationId}",
+            routeValues: {
+                project: project,
+                cloneOperationId: cloneOperationId
+            }
+        });
+    }
+    /**
+     * Create a test plan with test cases by queueing a job.
+     *
+     * @param creationParams - Parameters for creating the test plan and test cases.
+     * @param project - Project ID or project name
+     */
+    async createTestPlanWithTestCases(creationParams, project) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/TestPlanWithTestCases",
+            routeValues: {
+                project: project
+            },
+            body: creationParams
+        });
+    }
+    /**
+     * 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 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
+     */
+    async getPoints(project, planId, suiteId, pointId, returnIdentityRef, includePointDetails) {
+        const queryValues = {
+            pointId: pointId,
+            returnIdentityRef: returnIdentityRef,
+            includePointDetails: includePointDetails
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestPoint/{pointIds}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get all the points inside a suite based on some filters
+     *
+     * @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 testPointIds - ID of test points to fetch.
+     * @param testCaseId - Get Test Points for specific test case Ids.
+     * @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.
+     */
+    async getPointsList(project, planId, suiteId, testPointIds, testCaseId, continuationToken, returnIdentityRef, includePointDetails, isRecursive) {
+        const queryValues = {
+            testPointIds: testPointIds,
+            testCaseId: testCaseId,
+            continuationToken: continuationToken,
+            returnIdentityRef: returnIdentityRef,
+            includePointDetails: includePointDetails,
+            isRecursive: isRecursive
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestPoint/{pointIds}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * 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
+     *
+     * @param testPointUpdateParams - A TestPointUpdateParams Object.
+     * @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 includePointDetails - If set to false, will get a smaller payload containing only basic details about the test point object
+     * @param returnIdentityRef - If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.
+     */
+    async updateTestPoints(testPointUpdateParams, project, planId, suiteId, includePointDetails, returnIdentityRef) {
+        const queryValues = {
+            includePointDetails: includePointDetails,
+            returnIdentityRef: returnIdentityRef
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestPoint/{pointIds}",
+            routeValues: {
+                project: project,
+                planId: planId,
+                suiteId: suiteId
+            },
+            queryParams: queryValues,
+            body: testPointUpdateParams
+        });
+    }
+    /**
+     * Get Deleted Test Suites for a Test Plan.
+     *
+     * @param project - Project ID or project name
+     * @param planId - ID of the test plan for which suites are requested.
+     * @param expand - Include the children suites and testers details.
+     * @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.
+     */
+    async getDeletedTestSuitesForPlan(project, planId, expand, continuationToken, asTreeView) {
+        const queryValues = {
+            expand: expand,
+            continuationToken: continuationToken,
+            asTreeView: asTreeView
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/recycleBin/TestPlan/{planId}/TestSuite/{suiteId}",
+            routeValues: {
+                project: project,
+                planId: planId
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Get Deleted Test Suites within a Project.
+     *
+     * @param project - Project ID or project name
+     * @param expand - Include the children suites and testers details.
+     * @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.
+     */
+    async getDeletedTestSuitesForProject(project, expand, continuationToken, asTreeView) {
+        const queryValues = {
+            expand: expand,
+            continuationToken: continuationToken,
+            asTreeView: asTreeView
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/recycleBin/TestSuite/{suiteId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Restores the deleted test suite
+     *
+     * @param payload - The model containing the restore information
+     * @param project - Project ID or project name
+     * @param suiteId - The ID of the test suite to restore
+     */
+    async restoreDeletedTestSuite(payload, project, suiteId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/recycleBin/TestSuite/{suiteId}",
+            routeValues: {
+                project: project,
+                suiteId: suiteId
+            },
+            body: payload
+        });
+    }
+    /**
+     * Clone test suite
+     *
+     * @param cloneRequestBody - Suite Clone Request Body detail TestSuiteCloneRequest
+     * @param project - Project ID or project name
+     * @param deepClone - Clones all the associated test cases as well
+     */
+    async cloneTestSuite(cloneRequestBody, project, deepClone) {
+        const queryValues = {
+            deepClone: deepClone
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Suites/CloneOperation/{cloneOperationId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            body: cloneRequestBody
+        });
+    }
+    /**
+     * Get clone information.
+     *
+     * @param project - Project ID or project name
+     * @param cloneOperationId - Operation ID returned when we queue a clone operation
+     */
+    async getSuiteCloneInformation(project, cloneOperationId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "{project}/_apis/testplan/Suites/CloneOperation/{cloneOperationId}",
+            routeValues: {
+                project: project,
+                cloneOperationId: cloneOperationId
+            }
+        });
+    }
+    /**
+     * Create a test variable.
+     *
+     * @param testVariableCreateUpdateParameters - TestVariableCreateUpdateParameters
+     * @param project - Project ID or project name
+     */
+    async createTestVariable(testVariableCreateUpdateParameters, project) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/testplan/Variables/{testVariableId}",
+            routeValues: {
+                project: project
+            },
+            body: testVariableCreateUpdateParameters
+        });
+    }
+    /**
+     * Delete a test variable by its ID.
+     *
+     * @param project - Project ID or project name
+     * @param testVariableId - ID of the test variable to delete.
+     */
+    async deleteTestVariable(project, testVariableId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/testplan/Variables/{testVariableId}",
+            routeValues: {
+                project: project,
+                testVariableId: testVariableId
+            }
+        });
+    }
+    /**
+     * Get a test variable by its ID.
+     *
+     * @param project - Project ID or project name
+     * @param testVariableId - ID of the test variable to get.
+     */
+    async getTestVariableById(project, testVariableId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Variables/{testVariableId}",
+            routeValues: {
+                project: project,
+                testVariableId: testVariableId
+            }
+        });
+    }
+    /**
+     * Get a list of test variables.
+     *
+     * @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.
+     */
+    async getTestVariables(project, continuationToken) {
+        const queryValues = {
+            continuationToken: continuationToken
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/testplan/Variables/{testVariableId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            const body = await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+    /**
+     * Update a test variable by its ID.
+     *
+     * @param testVariableCreateUpdateParameters - TestVariableCreateUpdateParameters
+     * @param project - Project ID or project name
+     * @param testVariableId - ID of the test variable to update.
+     */
+    async updateTestVariable(testVariableCreateUpdateParameters, project, testVariableId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/testplan/Variables/{testVariableId}",
+            routeValues: {
+                project: project,
+                testVariableId: testVariableId
+            },
+            body: testVariableCreateUpdateParameters
+        });
+    }
+}