azure-devops-extension-api 4.270.0 → 5.271.0

package/esm/WorkItemTracking/WorkItemTrackingClient.js

@@ -0,0 +1,1525 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+import { RestClientBase } from "../Common/RestClientBase";
+export class WorkItemTrackingRestClient extends RestClientBase {
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE. This returns Doing, Done, Follows and activity work items details.
+     *
+     * @param queryOption -
+     */
+    async getAccountMyWorkData(queryOption) {
+        const queryValues = {
+            '$queryOption': queryOption
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "_apis/work/accountMyWork",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Gets recent work item activities
+     *
+     */
+    async getRecentActivityData() {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "_apis/work/accountMyWorkRecentActivity"
+        });
+    }
+    /**
+     * INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE.
+     *
+     */
+    async getRecentMentions() {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "_apis/work/accountRecentMentions"
+        });
+    }
+    /**
+     * Get the list of work item tracking outbound artifact link types.
+     *
+     */
+    async getWorkArtifactLinkTypes() {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "_apis/wit/artifactLinkTypes"
+        });
+    }
+    /**
+     * Queries work items linked to a given list of artifact URI.
+     *
+     * @param artifactUriQuery - Defines a list of artifact URI for querying work items.
+     * @param project - Project ID or project name
+     */
+    async queryWorkItemsForArtifactUris(artifactUriQuery, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/artifactUriQuery",
+            routeValues: {
+                project: project
+            },
+            body: artifactUriQuery
+        });
+    }
+    /**
+     * Uploads an attachment.
+     *
+     * @param content - Content to upload
+     * @param project - Project ID or project name
+     * @param fileName - The name of the file
+     * @param uploadType - Attachment upload type: Simple or Chunked
+     * @param areaPath - Target project Area Path
+     */
+    async createAttachment(content, project, fileName, uploadType, areaPath) {
+        const queryValues = {
+            fileName: fileName,
+            uploadType: uploadType,
+            areaPath: areaPath
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/attachments/{id}",
+            routeValues: {
+                project: project
+            },
+            customHeaders: {
+                "Content-Type": "application/octet-stream",
+            },
+            queryParams: queryValues,
+            body: content,
+            isRawData: true
+        });
+    }
+    /**
+     * Downloads an attachment.
+     *
+     * @param id - Attachment ID
+     * @param project - Project ID or project name
+     * @param fileName - Name of the file
+     * @param download - If set to \<c\>true\</c\> always download attachment
+     */
+    async getAttachmentContent(id, project, fileName, download) {
+        const queryValues = {
+            fileName: fileName,
+            download: download
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            httpResponseType: "application/octet-stream",
+            routeTemplate: "{project}/_apis/wit/attachments/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Downloads an attachment.
+     *
+     * @param id - Attachment ID
+     * @param project - Project ID or project name
+     * @param fileName - Name of the file
+     * @param download - If set to \<c\>true\</c\> always download attachment
+     */
+    async getAttachmentZip(id, project, fileName, download) {
+        const queryValues = {
+            fileName: fileName,
+            download: download
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            httpResponseType: "application/zip",
+            routeTemplate: "{project}/_apis/wit/attachments/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will  get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.
+     *
+     * @param project - Project ID or project name
+     * @param ids - Comma separated integer classification nodes ids. It's not required, if you want root nodes.
+     * @param depth - Depth of children to fetch.
+     * @param errorPolicy - Flag to handle errors in getting some nodes. Possible options are Fail and Omit.
+     */
+    async getClassificationNodes(project, ids, depth, errorPolicy) {
+        const queryValues = {
+            ids: ids && ids.join(","),
+            '$depth': depth,
+            errorPolicy: errorPolicy
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/classificationNodes",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Gets root classification nodes under the project.
+     *
+     * @param project - Project ID or project name
+     * @param depth - Depth of children to fetch.
+     */
+    async getRootNodes(project, depth) {
+        const queryValues = {
+            '$depth': depth
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/classificationNodes",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Create new or update an existing classification node.
+     *
+     * @param postedNode - Node to create or update.
+     * @param project - Project ID or project name
+     * @param structureGroup - Structure group of the classification node, area or iteration.
+     * @param path - Path of the classification node.
+     */
+    async createOrUpdateClassificationNode(postedNode, project, structureGroup, path) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/classificationNodes/{structureGroup}/{*path}",
+            routeValues: {
+                project: project,
+                structureGroup: structureGroup,
+                path: path
+            },
+            body: postedNode
+        });
+    }
+    /**
+     * Delete an existing classification node.
+     *
+     * @param project - Project ID or project name
+     * @param structureGroup - Structure group of the classification node, area or iteration.
+     * @param path - Path of the classification node.
+     * @param reclassifyId - Id of the target classification node for reclassification.
+     */
+    async deleteClassificationNode(project, structureGroup, path, reclassifyId) {
+        const queryValues = {
+            '$reclassifyId': reclassifyId
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/wit/classificationNodes/{structureGroup}/{*path}",
+            routeValues: {
+                project: project,
+                structureGroup: structureGroup,
+                path: path
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Gets the classification node for a given node path.
+     *
+     * @param project - Project ID or project name
+     * @param structureGroup - Structure group of the classification node, area or iteration.
+     * @param path - Path of the classification node.
+     * @param depth - Depth of children to fetch.
+     */
+    async getClassificationNode(project, structureGroup, path, depth) {
+        const queryValues = {
+            '$depth': depth
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/classificationNodes/{structureGroup}/{*path}",
+            routeValues: {
+                project: project,
+                structureGroup: structureGroup,
+                path: path
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update an existing classification node.
+     *
+     * @param postedNode - Node to create or update.
+     * @param project - Project ID or project name
+     * @param structureGroup - Structure group of the classification node, area or iteration.
+     * @param path - Path of the classification node.
+     */
+    async updateClassificationNode(postedNode, project, structureGroup, path) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/wit/classificationNodes/{structureGroup}/{*path}",
+            routeValues: {
+                project: project,
+                structureGroup: structureGroup,
+                path: path
+            },
+            body: postedNode
+        });
+    }
+    /**
+     * Gets a comment for a work item at the specified revision.
+     *
+     * @param id - Work item id
+     * @param revision - Revision for which the comment need to be fetched
+     * @param project - Project ID or project name
+     */
+    async getComment(id, revision, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}/comments/{revision}",
+            routeValues: {
+                project: project,
+                id: id,
+                revision: revision
+            }
+        });
+    }
+    /**
+     * Gets the specified number of comments for a work item from the specified revision.
+     *
+     * @param id - Work item id
+     * @param project - Project ID or project name
+     * @param fromRevision - Revision from which comments are to be fetched (default is 1)
+     * @param top - The number of comments to return (default is 200)
+     * @param order - Ascending or descending by revision id (default is ascending)
+     */
+    async getComments(id, project, fromRevision, top, order) {
+        const queryValues = {
+            fromRevision: fromRevision,
+            '$top': top,
+            order: order
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}/comments/{revision}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Create a new field.
+     *
+     * @param workItemField - New field definition
+     * @param project - Project ID or project name
+     */
+    async createField(workItemField, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/fields/{fieldNameOrRefName}",
+            routeValues: {
+                project: project
+            },
+            body: workItemField
+        });
+    }
+    /**
+     * Deletes the field. To undelete a filed, see "Update Field" API.
+     *
+     * @param fieldNameOrRefName - Field simple name or reference name
+     * @param project - Project ID or project name
+     */
+    async deleteField(fieldNameOrRefName, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/wit/fields/{fieldNameOrRefName}",
+            routeValues: {
+                project: project,
+                fieldNameOrRefName: fieldNameOrRefName
+            }
+        });
+    }
+    /**
+     * Gets information on a specific field.
+     *
+     * @param fieldNameOrRefName - Field simple name or reference name
+     * @param project - Project ID or project name
+     */
+    async getField(fieldNameOrRefName, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/fields/{fieldNameOrRefName}",
+            routeValues: {
+                project: project,
+                fieldNameOrRefName: fieldNameOrRefName
+            }
+        });
+    }
+    /**
+     * Returns information for all fields. The project ID/name parameter is optional.
+     *
+     * @param project - Project ID or project name
+     * @param expand - Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.
+     */
+    async getFields(project, expand) {
+        const queryValues = {
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/fields/{fieldNameOrRefName}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update a field.
+     *
+     * @param payload - Payload contains desired value of the field's properties
+     * @param fieldNameOrRefName - Name/reference name of the field to be updated
+     * @param project - Project ID or project name
+     */
+    async updateField(payload, fieldNameOrRefName, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/wit/fields/{fieldNameOrRefName}",
+            routeValues: {
+                project: project,
+                fieldNameOrRefName: fieldNameOrRefName
+            },
+            body: payload
+        });
+    }
+    /**
+     * Creates a query, or moves a query.
+     *
+     * @param postedQuery - The query to create.
+     * @param project - Project ID or project name
+     * @param query - The parent id or path under which the query is to be created.
+     * @param validateWiqlOnly - If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.
+     */
+    async createQuery(postedQuery, project, query, validateWiqlOnly) {
+        const queryValues = {
+            validateWiqlOnly: validateWiqlOnly
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/queries/{*query}",
+            routeValues: {
+                project: project,
+                query: query
+            },
+            queryParams: queryValues,
+            body: postedQuery
+        });
+    }
+    /**
+     * Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.
+     *
+     * @param project - Project ID or project name
+     * @param query - ID or path of the query or folder to delete.
+     */
+    async deleteQuery(project, query) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/wit/queries/{*query}",
+            routeValues: {
+                project: project,
+                query: query
+            }
+        });
+    }
+    /**
+     * Gets the root queries and their children
+     *
+     * @param project - Project ID or project name
+     * @param expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.
+     * @param depth - In the folder of queries, return child queries and folders to this depth.
+     * @param includeDeleted - Include deleted queries and folders
+     */
+    async getQueries(project, expand, depth, includeDeleted) {
+        const queryValues = {
+            '$expand': expand,
+            '$depth': depth,
+            '$includeDeleted': includeDeleted
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/queries/{*query}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Retrieves an individual query and its children
+     *
+     * @param project - Project ID or project name
+     * @param query - ID or path of the query.
+     * @param expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.
+     * @param depth - In the folder of queries, return child queries and folders to this depth.
+     * @param includeDeleted - Include deleted queries and folders
+     * @param useIsoDateFormat - DateTime query clauses will be formatted using a ISO 8601 compliant format
+     */
+    async getQuery(project, query, expand, depth, includeDeleted, useIsoDateFormat) {
+        const queryValues = {
+            '$expand': expand,
+            '$depth': depth,
+            '$includeDeleted': includeDeleted,
+            '$useIsoDateFormat': useIsoDateFormat
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/queries/{*query}",
+            routeValues: {
+                project: project,
+                query: query
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Searches all queries the user has access to in the current project
+     *
+     * @param project - Project ID or project name
+     * @param filter - The text to filter the queries with.
+     * @param top - The number of queries to return (Default is 50 and maximum is 200).
+     * @param expand -
+     * @param includeDeleted - Include deleted queries and folders
+     */
+    async searchQueries(project, filter, top, expand, includeDeleted) {
+        const queryValues = {
+            '$filter': filter,
+            '$top': top,
+            '$expand': expand,
+            '$includeDeleted': includeDeleted
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/queries/{*query}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update a query or a folder. This allows you to update, rename and move queries and folders.
+     *
+     * @param queryUpdate - The query to update.
+     * @param project - Project ID or project name
+     * @param query - The ID or path for the query to update.
+     * @param undeleteDescendants - Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.
+     */
+    async updateQuery(queryUpdate, project, query, undeleteDescendants) {
+        const queryValues = {
+            '$undeleteDescendants': undeleteDescendants
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/wit/queries/{*query}",
+            routeValues: {
+                project: project,
+                query: query
+            },
+            queryParams: queryValues,
+            body: queryUpdate
+        });
+    }
+    /**
+     * Gets a list of queries by ids (Maximum 1000)
+     *
+     * @param queryGetRequest -
+     * @param project - Project ID or project name
+     */
+    async getQueriesBatch(queryGetRequest, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/queriesBatch",
+            routeValues: {
+                project: project
+            },
+            body: queryGetRequest
+        });
+    }
+    /**
+     * Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.
+     *
+     * @param id - ID of the work item to be destroyed permanently
+     * @param project - Project ID or project name
+     */
+    async destroyWorkItem(id, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/wit/recyclebin/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            }
+        });
+    }
+    /**
+     * Gets a deleted work item from Recycle Bin.
+     *
+     * @param id - ID of the work item to be returned
+     * @param project - Project ID or project name
+     */
+    async getDeletedWorkItem(id, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/recyclebin/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            }
+        });
+    }
+    /**
+     * Gets the work items from the recycle bin, whose IDs have been specified in the parameters
+     *
+     * @param ids - Comma separated list of IDs of the deleted work items to be returned
+     * @param project - Project ID or project name
+     */
+    async getDeletedWorkItems(ids, project) {
+        const queryValues = {
+            ids: ids && ids.join(",")
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/recyclebin/{id}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.
+     *
+     * @param project - Project ID or project name
+     */
+    async getDeletedWorkItemShallowReferences(project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/recyclebin/{id}",
+            routeValues: {
+                project: project
+            }
+        });
+    }
+    /**
+     * Restores the deleted work item from Recycle Bin.
+     *
+     * @param payload - Paylod with instructions to update the IsDeleted flag to false
+     * @param id - ID of the work item to be restored
+     * @param project - Project ID or project name
+     */
+    async restoreWorkItem(payload, id, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/wit/recyclebin/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            body: payload
+        });
+    }
+    /**
+     * Returns a fully hydrated work item for the requested revision
+     *
+     * @param id -
+     * @param revisionNumber -
+     * @param project - Project ID or project name
+     * @param expand -
+     */
+    async getRevision(id, revisionNumber, project, expand) {
+        const queryValues = {
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}/revisions/{revisionNumber}",
+            routeValues: {
+                project: project,
+                id: id,
+                revisionNumber: revisionNumber
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Returns the list of fully hydrated work item revisions, paged.
+     *
+     * @param id -
+     * @param project - Project ID or project name
+     * @param top -
+     * @param skip -
+     * @param expand -
+     */
+    async getRevisions(id, project, top, skip, expand) {
+        const queryValues = {
+            '$top': top,
+            '$skip': skip,
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}/revisions/{revisionNumber}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * RESTful method to send mail for selected/queried work items.
+     *
+     * @param body -
+     * @param project - Project ID or project name
+     */
+    async sendMail(body, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/sendMail",
+            routeValues: {
+                project: project
+            },
+            body: body
+        });
+    }
+    /**
+     * Creates a template
+     *
+     * @param template - Template contents
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     */
+    async createTemplate(template, project, team) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/{team}/_apis/wit/templates",
+            routeValues: {
+                project: project,
+                team: team
+            },
+            body: template
+        });
+    }
+    /**
+     * Gets template
+     *
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     * @param workitemtypename - Optional, When specified returns templates for given Work item type.
+     */
+    async getTemplates(project, team, workitemtypename) {
+        const queryValues = {
+            workitemtypename: workitemtypename
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "{project}/{team}/_apis/wit/templates",
+            routeValues: {
+                project: project,
+                team: team
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Deletes the template with given id
+     *
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     * @param templateId - Template id
+     */
+    async deleteTemplate(project, team, templateId) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/{team}/_apis/wit/templates/{templateId}",
+            routeValues: {
+                project: project,
+                team: team,
+                templateId: templateId
+            }
+        });
+    }
+    /**
+     * Gets the template with specified id
+     *
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     * @param templateId - Template Id
+     */
+    async getTemplate(project, team, templateId) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "{project}/{team}/_apis/wit/templates/{templateId}",
+            routeValues: {
+                project: project,
+                team: team,
+                templateId: templateId
+            }
+        });
+    }
+    /**
+     * Replace template contents
+     *
+     * @param templateContent - Template contents to replace with
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     * @param templateId - Template id
+     */
+    async replaceTemplate(templateContent, project, team, templateId) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "PUT",
+            routeTemplate: "{project}/{team}/_apis/wit/templates/{templateId}",
+            routeValues: {
+                project: project,
+                team: team,
+                templateId: templateId
+            },
+            body: templateContent
+        });
+    }
+    /**
+     * Returns a single update for a work item
+     *
+     * @param id -
+     * @param updateNumber -
+     * @param project - Project ID or project name
+     */
+    async getUpdate(id, updateNumber, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}/updates/{updateNumber}",
+            routeValues: {
+                project: project,
+                id: id,
+                updateNumber: updateNumber
+            }
+        });
+    }
+    /**
+     * Returns the deltas between work item revisions
+     *
+     * @param id -
+     * @param project - Project ID or project name
+     * @param top -
+     * @param skip -
+     */
+    async getUpdates(id, project, top, skip) {
+        const queryValues = {
+            '$top': top,
+            '$skip': skip
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}/updates/{updateNumber}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Gets the results of the query given its WIQL.
+     *
+     * @param wiql - The query containing the WIQL.
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     * @param timePrecision - Whether or not to use time precision.
+     * @param top - The max number of results to return.
+     */
+    async queryByWiql(wiql, project, team, timePrecision, top) {
+        const queryValues = {
+            timePrecision: timePrecision,
+            '$top': top
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/{team}/_apis/wit/wiql",
+            routeValues: {
+                project: project,
+                team: team
+            },
+            queryParams: queryValues,
+            body: wiql
+        });
+    }
+    /**
+     * Gets the results of the query given the query ID.
+     *
+     * @param id - The query ID.
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     * @param timePrecision - Whether or not to use time precision.
+     * @param top - The max number of results to return.
+     */
+    async getQueryResultCount(id, project, team, timePrecision, top) {
+        const queryValues = {
+            timePrecision: timePrecision,
+            '$top': top
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "HEAD",
+            routeTemplate: "{project}/{team}/_apis/wit/wiql/{id}",
+            routeValues: {
+                project: project,
+                team: team,
+                id: id
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async (response) => {
+            return Number(response.headers.get("X-Total-Count"));
+        });
+    }
+    /**
+     * Gets the results of the query given the query ID.
+     *
+     * @param id - The query ID.
+     * @param project - Project ID or project name
+     * @param team - Team ID or team name
+     * @param timePrecision - Whether or not to use time precision.
+     * @param top - The max number of results to return.
+     */
+    async queryById(id, project, team, timePrecision, top) {
+        const queryValues = {
+            timePrecision: timePrecision,
+            '$top': top
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/{team}/_apis/wit/wiql/{id}",
+            routeValues: {
+                project: project,
+                team: team,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a work item icon given the friendly name and icon color.
+     *
+     * @param icon - The name of the icon
+     * @param color - The 6-digit hex color for the icon
+     * @param v - The version of the icon (used only for cache invalidation)
+     */
+    async getWorkItemIconJson(icon, color, v) {
+        const queryValues = {
+            color: color,
+            v: v
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "_apis/wit/workItemIcons/{icon}",
+            routeValues: {
+                icon: icon
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a list of all work item icons.
+     *
+     */
+    async getWorkItemIcons() {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "_apis/wit/workItemIcons/{icon}"
+        });
+    }
+    /**
+     * Get a work item icon given the friendly name and icon color.
+     *
+     * @param icon - The name of the icon
+     * @param color - The 6-digit hex color for the icon
+     * @param v - The version of the icon (used only for cache invalidation)
+     */
+    async getWorkItemIconSvg(icon, color, v) {
+        const queryValues = {
+            color: color,
+            v: v
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            httpResponseType: "image/svg+xml",
+            routeTemplate: "_apis/wit/workItemIcons/{icon}",
+            routeValues: {
+                icon: icon
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a work item icon given the friendly name and icon color.
+     *
+     * @param icon - The name of the icon
+     * @param color - The 6-digit hex color for the icon
+     * @param v - The version of the icon (used only for cache invalidation)
+     */
+    async getWorkItemIconXaml(icon, color, v) {
+        const queryValues = {
+            color: color,
+            v: v
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            httpResponseType: "image/xaml+xml",
+            routeTemplate: "_apis/wit/workItemIcons/{icon}",
+            routeValues: {
+                icon: icon
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a batch of work item links
+     *
+     * @param project - Project ID or project name
+     * @param linkTypes - A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.
+     * @param types - A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
+     * @param continuationToken - Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
+     * @param startDateTime - Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
+     */
+    async getReportingLinksByLinkType(project, linkTypes, types, continuationToken, startDateTime) {
+        const queryValues = {
+            linkTypes: linkTypes && linkTypes.join(","),
+            types: types && types.join(","),
+            continuationToken: continuationToken,
+            startDateTime: startDateTime
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/reporting/workItemLinks",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Gets the work item relation type definition.
+     *
+     * @param relation - The relation name
+     */
+    async getRelationType(relation) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "_apis/wit/workItemRelationTypes/{relation}",
+            routeValues: {
+                relation: relation
+            }
+        });
+    }
+    /**
+     * Gets the work item relation types.
+     *
+     */
+    async getRelationTypes() {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "_apis/wit/workItemRelationTypes/{relation}"
+        });
+    }
+    /**
+     * Get a batch of work item revisions with the option of including deleted items
+     *
+     * @param project - Project ID or project name
+     * @param fields - A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
+     * @param types - A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
+     * @param continuationToken - Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
+     * @param startDateTime - Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
+     * @param includeIdentityRef - Return an identity reference instead of a string value for identity fields.
+     * @param includeDeleted - Specify if the deleted item should be returned.
+     * @param includeTagRef - Specify if the tag objects should be returned for System.Tags field.
+     * @param includeLatestOnly - Return only the latest revisions of work items, skipping all historical revisions
+     * @param expand - Return all the fields in work item revisions, including long text fields which are not returned by default
+     * @param includeDiscussionChangesOnly - Return only the those revisions of work items, where only history field was changed
+     * @param maxPageSize - The maximum number of results to return in this batch
+     */
+    async readReportingRevisionsGet(project, fields, types, continuationToken, startDateTime, includeIdentityRef, includeDeleted, includeTagRef, includeLatestOnly, expand, includeDiscussionChangesOnly, maxPageSize) {
+        const queryValues = {
+            fields: fields && fields.join(","),
+            types: types && types.join(","),
+            continuationToken: continuationToken,
+            startDateTime: startDateTime,
+            includeIdentityRef: includeIdentityRef,
+            includeDeleted: includeDeleted,
+            includeTagRef: includeTagRef,
+            includeLatestOnly: includeLatestOnly,
+            '$expand': expand,
+            includeDiscussionChangesOnly: includeDiscussionChangesOnly,
+            '$maxPageSize': maxPageSize
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/reporting/workItemRevisions",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit.
+     *
+     * @param filter - An object that contains request settings: field filter, type filter, identity format
+     * @param project - Project ID or project name
+     * @param continuationToken - Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
+     * @param startDateTime - Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
+     * @param expand -
+     */
+    async readReportingRevisionsPost(filter, project, continuationToken, startDateTime, expand) {
+        const queryValues = {
+            continuationToken: continuationToken,
+            startDateTime: startDateTime,
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/reporting/workItemRevisions",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            body: filter
+        });
+    }
+    /**
+     * Creates a single work item.
+     *
+     * @param document - The JSON Patch document representing the work item
+     * @param project - Project ID or project name
+     * @param type - The work item type of the work item to create
+     * @param validateOnly - Indicate if you only want to validate the changes without saving the work item
+     * @param bypassRules - Do not enforce the work item type rules on this update
+     * @param suppressNotifications - Do not fire any notifications for this change
+     * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
+     */
+    async createWorkItem(document, project, type, validateOnly, bypassRules, suppressNotifications, expand) {
+        const queryValues = {
+            validateOnly: validateOnly,
+            bypassRules: bypassRules,
+            suppressNotifications: suppressNotifications,
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/workItems/${type}",
+            routeValues: {
+                project: project,
+                type: type
+            },
+            customHeaders: {
+                "Content-Type": "application/json-patch+json",
+            },
+            queryParams: queryValues,
+            body: document
+        });
+    }
+    /**
+     * Returns a single work item from a template.
+     *
+     * @param project - Project ID or project name
+     * @param type - The work item type name
+     * @param fields - Comma-separated list of requested fields
+     * @param asOf - AsOf UTC date time string
+     * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
+     */
+    async getWorkItemTemplate(project, type, fields, asOf, expand) {
+        const queryValues = {
+            fields: fields,
+            asOf: asOf,
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workItems/${type}",
+            routeValues: {
+                project: project,
+                type: type
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.
+     *
+     * @param id - ID of the work item to be deleted
+     * @param project - Project ID or project name
+     * @param destroy - Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
+     */
+    async deleteWorkItem(id, project, destroy) {
+        const queryValues = {
+            destroy: destroy
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Returns a single work item.
+     *
+     * @param id - The work item id
+     * @param project - Project ID or project name
+     * @param fields - Comma-separated list of requested fields
+     * @param asOf - AsOf UTC date time string
+     * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
+     */
+    async getWorkItem(id, project, fields, asOf, expand) {
+        const queryValues = {
+            fields: fields && fields.join(","),
+            asOf: asOf,
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Returns a list of work items (Maximum 200)
+     *
+     * @param ids - The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
+     * @param project - Project ID or project name
+     * @param fields - Comma-separated list of requested fields
+     * @param asOf - AsOf UTC date time string
+     * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
+     * @param errorPolicy - The flag to control error policy in a bulk get work items request. Possible options are \{Fail, Omit\}.
+     */
+    async getWorkItems(ids, project, fields, asOf, expand, errorPolicy) {
+        const queryValues = {
+            ids: ids && ids.join(","),
+            fields: fields && fields.join(","),
+            asOf: asOf,
+            '$expand': expand,
+            errorPolicy: errorPolicy
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Updates a single work item.
+     *
+     * @param document - The JSON Patch document representing the update
+     * @param id - The id of the work item to update
+     * @param project - Project ID or project name
+     * @param validateOnly - Indicate if you only want to validate the changes without saving the work item
+     * @param bypassRules - Do not enforce the work item type rules on this update
+     * @param suppressNotifications - Do not fire any notifications for this change
+     * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
+     */
+    async updateWorkItem(document, id, project, validateOnly, bypassRules, suppressNotifications, expand) {
+        const queryValues = {
+            validateOnly: validateOnly,
+            bypassRules: bypassRules,
+            suppressNotifications: suppressNotifications,
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/wit/workItems/{id}",
+            routeValues: {
+                project: project,
+                id: id
+            },
+            customHeaders: {
+                "Content-Type": "application/json-patch+json",
+            },
+            queryParams: queryValues,
+            body: document
+        });
+    }
+    /**
+     * Gets work items for a list of work item ids (Maximum 200)
+     *
+     * @param workItemGetRequest -
+     * @param project - Project ID or project name
+     */
+    async getWorkItemsBatch(workItemGetRequest, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/workItemsBatch",
+            routeValues: {
+                project: project
+            },
+            body: workItemGetRequest
+        });
+    }
+    /**
+     * INTERNAL ONLY: It will be used for My account work experience. Get the work item type state color for multiple projects
+     *
+     * @param projectNames -
+     */
+    async getWorkItemStateColors(projectNames) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/work/workitemStateColor",
+            body: projectNames
+        });
+    }
+    /**
+     * Returns the next state on the given work item IDs.
+     *
+     * @param ids - list of work item ids
+     * @param action - possible actions. Currently only supports checkin
+     */
+    async getWorkItemNextStatesOnCheckinAction(ids, action) {
+        const queryValues = {
+            ids: ids && ids.join(","),
+            action: action
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "_apis/wit/workItemTransitions",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get all work item type categories.
+     *
+     * @param project - Project ID or project name
+     */
+    async getWorkItemTypeCategories(project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/workItemTypeCategories/{category}",
+            routeValues: {
+                project: project
+            }
+        });
+    }
+    /**
+     * Get specific work item type category by name.
+     *
+     * @param project - Project ID or project name
+     * @param category - The category name
+     */
+    async getWorkItemTypeCategory(project, category) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/workItemTypeCategories/{category}",
+            routeValues: {
+                project: project,
+                category: category
+            }
+        });
+    }
+    /**
+     * INTERNAL ONLY: It will be used for My account work experience. Get the wit type color for multiple projects
+     *
+     * @param projectNames -
+     */
+    async getWorkItemTypeColors(projectNames) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/work/workitemTypeColor",
+            body: projectNames
+        });
+    }
+    /**
+     * INTERNAL ONLY: It is used for color and icon providers. Get the wit type color for multiple projects
+     *
+     * @param projectNames -
+     */
+    async getWorkItemTypeColorAndIcons(projectNames) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/wit/workItemTypeColorAndIcon",
+            body: projectNames
+        });
+    }
+    /**
+     * Returns a work item type definition.
+     *
+     * @param project - Project ID or project name
+     * @param type - Work item type name
+     */
+    async getWorkItemType(project, type) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/workItemTypes/{type}",
+            routeValues: {
+                project: project,
+                type: type
+            }
+        });
+    }
+    /**
+     * Returns the list of work item types
+     *
+     * @param project - Project ID or project name
+     */
+    async getWorkItemTypes(project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.2",
+            routeTemplate: "{project}/_apis/wit/workItemTypes/{type}",
+            routeValues: {
+                project: project
+            }
+        });
+    }
+    /**
+     * Get a list of fields for a work item type with detailed references.
+     *
+     * @param project - Project ID or project name
+     * @param type - Work item type.
+     * @param expand - Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
+     */
+    async getWorkItemTypeFieldsWithReferences(project, type, expand) {
+        const queryValues = {
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workitemtypes/{type}/fields/{field}",
+            routeValues: {
+                project: project,
+                type: type
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a field for a work item type with detailed references.
+     *
+     * @param project - Project ID or project name
+     * @param type - Work item type.
+     * @param field -
+     * @param expand - Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
+     */
+    async getWorkItemTypeFieldWithReferences(project, type, field, expand) {
+        const queryValues = {
+            '$expand': expand
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.3",
+            routeTemplate: "{project}/_apis/wit/workitemtypes/{type}/fields/{field}",
+            routeValues: {
+                project: project,
+                type: type,
+                field: field
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Returns the state names and colors for a work item type.
+     *
+     * @param project - Project ID or project name
+     * @param type - The state name
+     */
+    async getWorkItemTypeStates(project, type) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "{project}/_apis/wit/workitemtypes/{type}/states",
+            routeValues: {
+                project: project,
+                type: type
+            }
+        });
+    }
+    /**
+     * Export work item type
+     *
+     * @param project - Project ID or project name
+     * @param type -
+     * @param exportGlobalLists -
+     */
+    async exportWorkItemTypeDefinition(project, type, exportGlobalLists) {
+        const queryValues = {
+            exportGlobalLists: exportGlobalLists
+        };
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            routeTemplate: "{project}/_apis/wit/workItemTypeTemplate/{type}",
+            routeValues: {
+                project: project,
+                type: type
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Add/updates a work item type
+     *
+     * @param updateModel -
+     * @param project - Project ID or project name
+     */
+    async updateWorkItemTypeDefinition(updateModel, project) {
+        return this.beginRequest({
+            apiVersion: "5.0-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/wit/workItemTypeTemplate/{type}",
+            routeValues: {
+                project: project
+            },
+            body: updateModel
+        });
+    }
+}
+WorkItemTrackingRestClient.RESOURCE_AREA_ID = "5264459e-e5e0-4bd8-b118-0985e68a4ec5";