azure-devops-extension-api 4.270.0 → 5.272.0

package/esm/Alert/AlertClient.js

@@ -0,0 +1,499 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+import { RestClientBase } from "../Common/RestClientBase";
+import { deserializeVssJsonObject } from "../Common/Util/Serialization";
+export class AlertRestClient extends RestClientBase {
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Get an alert.
+     *
+     * @param project - Project ID or project name
+     * @param alertId - ID of alert to retrieve
+     * @param repository - Name or id  of a repository that alert is part of
+     * @param ref -
+     * @param expand - Expand attributes of a secret alert. Possible values are \`None\` and \`ValidationFingerprint\`. Defaults to \`None\`. Be aware that if \`expand\` is set to \`ValidationFingerprint\`, the response may contain the secret in its unencrypted form. Please exercise caution when using this data.
+     */
+    async getAlert(project, alertId, repository, ref, expand) {
+        const queryValues = {
+            ref: ref,
+            expand: expand
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",
+            routeValues: {
+                project: project,
+                alertId: alertId,
+                repository: repository
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get alerts for a repository
+     *
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of the repository
+     * @param top - The maximum number of alerts to return
+     * @param orderBy - Must be "id" "firstSeen" "lastSeen" "fixedOn" or "severity"  Defaults to "id"
+     * @param criteria - Options to limit the alerts returned
+     * @param expand -
+     * @param continuationToken - If there are more alerts than can be returned, a continuation token is placed in the "x-ms-continuationtoken" header.  Use that token here to get the next page of alerts
+     */
+    async getAlerts(project, repository, top, orderBy, criteria, expand, continuationToken) {
+        const queryValues = {
+            top: top,
+            orderBy: orderBy,
+            criteria: criteria,
+            expand: expand,
+            continuationToken: continuationToken
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            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 an alert.
+     *
+     * @param project - Project ID or project name
+     * @param alertId - ID of alert to retrieve
+     * @param repository - Name or id  of a repository that alert is part of
+     * @param ref -
+     * @param expand - Expand attributes of a secret alert. Possible values are \`None\` and \`ValidationFingerprint\`. Defaults to \`None\`. Be aware that if \`expand\` is set to \`ValidationFingerprint\`, the response may contain the secret in its unencrypted form. Please exercise caution when using this data.
+     */
+    async getAlertSarif(project, alertId, repository, ref, expand) {
+        const queryValues = {
+            ref: ref,
+            expand: expand
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",
+            routeValues: {
+                project: project,
+                alertId: alertId,
+                repository: repository
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update the status of an alert
+     *
+     * @param stateUpdate - The new status of the alert
+     * @param project - Project ID or project name
+     * @param alertId - The ID of the alert
+     * @param repository - The name or ID of the repository
+     */
+    async updateAlert(stateUpdate, project, alertId, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",
+            routeValues: {
+                project: project,
+                alertId: alertId,
+                repository: repository
+            },
+            body: stateUpdate
+        });
+    }
+    /**
+     * Get alerts by alert IDs Currently supports fetching secret alerts only.
+     *
+     * @param request - Request containing alert IDs and optional alert type filter
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of the repository
+     */
+    async getAlertsByIds(request, project, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/AlertsBatch",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            body: request
+        });
+    }
+    /**
+     * Returns the branches for which analysis results were submitted.
+     *
+     * @param project - Project ID or project name
+     * @param repository -
+     * @param alertType - The type of alert: Dependency Scanning (1), Secret (2), Code QL (3), etc.
+     * @param continuationToken - A string variable that represents the branch name and is used to fetch branches that follow it in alphabetical order.
+     * @param branchNameContains - A string variable used to fetch branches that contain this string anywhere in the branch name, case insensitive.
+     * @param top - An int variable used to return the top k branches that satisfy the search criteria.
+     * @param includePullRequestBranches - A bool variable indicating whether or not to include pull request branches.
+     */
+    async getBranches(project, repository, alertType, continuationToken, branchNameContains, top, includePullRequestBranches) {
+        const queryValues = {
+            alertType: alertType,
+            continuationToken: continuationToken,
+            branchNameContains: branchNameContains,
+            top: top,
+            includePullRequestBranches: includePullRequestBranches
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/filters/{action}",
+            routeValues: {
+                project: project,
+                repository: repository,
+                action: "Branches"
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * @param project - Project ID or project name
+     * @param repository -
+     * @param alertType -
+     */
+    async getUxFilters(project, repository, alertType) {
+        const queryValues = {
+            alertType: alertType
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/filters/{action}",
+            routeValues: {
+                project: project,
+                repository: repository,
+                action: "Default"
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Create an autofix request for the specified alert.
+     *
+     * @param project - Project ID or project name
+     * @param alertId - The ID of the alert to create an autofix for.
+     * @param repository - The name or ID of the repository.
+     */
+    async createAutofixRequest(project, alertId, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Autofix",
+            routeValues: {
+                project: project,
+                alertId: alertId,
+                repository: repository
+            }
+        });
+    }
+    /**
+     * Upload a SARIF to GitHub Code Scanning via a GitOps app.
+     *
+     * @param content - Content to upload
+     * @param project - Project ID or project name
+     * @param hostname - The GitHub hostname (e.g., github.com or microsoft.ghe.com)
+     * @param owner - The GitHub repository owner (organization or user)
+     * @param repo - The GitHub repository name
+     */
+    async uploadSarifToGitHub(content, project, hostname, owner, repo) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/Alert/github/{hostname}/{owner}/{repo}/sarifs",
+            routeValues: {
+                project: project,
+                hostname: hostname,
+                owner: owner,
+                repo: repo
+            },
+            customHeaders: {
+                "Content-Type": "application/octet-stream",
+            },
+            body: content
+        });
+    }
+    /**
+     * Get instances of an alert on a branch specified with \@ref. If \@ref is not provided, return instances of an alert on default branch(if the alert exist in default branch) or latest affected branch.
+     *
+     * @param project - Project ID or project name
+     * @param alertId - ID of alert to retrieve
+     * @param repository - Name or id of a repository that alert is part of
+     * @param ref -
+     */
+    async getAlertInstances(project, alertId, repository, ref) {
+        const queryValues = {
+            ref: ref
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Instances",
+            routeValues: {
+                project: project,
+                alertId: alertId,
+                repository: repository
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Create legal review. This creates the legal review associated with the alert. It include the review work item url.
+     *
+     * @param project - Project ID or project name
+     * @param repository - Name or id  of a repository for the legal alert
+     * @param alertId - Advance Security alert id of the legal alert to get the legal review
+     * @param ref -
+     */
+    async createLegalReview(project, repository, alertId, ref) {
+        const queryValues = {
+            alertId: alertId,
+            ref: ref
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/Metadata",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update alert metadata associations.
+     *
+     * @param alertsMetadata - A list of metadata to associate with alerts.
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of the repository.
+     */
+    async updateAlertsMetadata(alertsMetadata, project, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/Metadata",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            body: alertsMetadata
+        });
+    }
+    /**
+     * Get an alert metadata.
+     *
+     * @param project - Project ID or project name
+     * @param alertId - ID of alert to retrieve
+     * @param repository - Name or id  of a repository that alert is part of
+     */
+    async getAlertMetadata(project, alertId, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/metadata",
+            routeValues: {
+                project: project,
+                alertId: alertId,
+                repository: repository
+            }
+        });
+    }
+    /**
+     * Get alerts metadata.
+     *
+     * @param alertMetadataBatchRequest -
+     * @param project - Project ID or project name
+     * @param repository - Name or id  of a repository that alert is part of
+     */
+    async getAlertMetadataBatch(alertMetadataBatchRequest, project, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/MetadataBatch",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            body: alertMetadataBatchRequest
+        });
+    }
+    /**
+     * Get alerts by their IDs at the organization level. Only retruns alerts that the user has permission to view. Only returns alerts of sku plans that are enabled.
+     *
+     * @param alertIds - List of alert IDs to retrieve
+     */
+    async getOrgLevelAlertsByIds(alertIds) {
+        const queryValues = {
+            alertIds: alertIds && alertIds.join(",")
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/Alert/alerts",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Soft-deletes analysis data for all pipelines in a repository, cleaning up the associated Advanced Security alerts.
+     *
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of the repository.
+     */
+    async deleteAllPipelineAnalyses(project, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/pipelineAnalyses",
+            routeValues: {
+                project: project,
+                repository: repository
+            }
+        });
+    }
+    /**
+     * Soft-deletes analysis data for a specific pipeline, cleaning up the associated Advanced Security alerts.
+     *
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of the repository.
+     * @param adoPipelineId - The ID of the ADO pipeline whose analysis data should be cleaned up.
+     */
+    async deletePipelineAnalysis(project, repository, adoPipelineId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/pipelineAnalysis/{adoPipelineId}",
+            routeValues: {
+                project: project,
+                repository: repository,
+                adoPipelineId: adoPipelineId
+            }
+        });
+    }
+    /**
+     * Export alerts as a single SARIF file
+     *
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of a repository
+     * @param alertIds - List of alert IDs to export
+     * @param branchName - The branch name of the target alerts. If not specified, the default branch will be used.
+     */
+    async exportSarif(project, repository, alertIds, branchName) {
+        const queryValues = {
+            alertIds: alertIds,
+            branchName: branchName
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/sarifs",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Upload a Sarif containing security alerts
+     *
+     * @param content - Content to upload
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of a repository
+     * @param notificationFlag - Header to signal that this is a progress notification
+     */
+    async uploadSarif(content, project, repository, notificationFlag) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/sarifs",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            customHeaders: {
+                "Content-Type": "application/octet-stream",
+                "X-AdvSec-NotificationSarif": notificationFlag,
+            },
+            body: content
+        });
+    }
+    /**
+     * Get the status of the Sarif processing job
+     *
+     * @param sarifId - Sarif ID returned when the Sarif was uploaded
+     */
+    async getSarif(sarifId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "_apis/Alert/Sarifs/{sarifId}",
+            routeValues: {
+                sarifId: sarifId
+            }
+        });
+    }
+    /**
+     * Upload a Sarif file at the organization level
+     *
+     * @param content - Content to upload
+     */
+    async uploadOrgSarif(content) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            method: "POST",
+            routeTemplate: "_apis/Alert/Sarifs/{sarifId}",
+            customHeaders: {
+                "Content-Type": "application/octet-stream",
+            },
+            body: content
+        });
+    }
+    /**
+     * Get the validity details for an alert.
+     *
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of a repository
+     * @param alertId - The ID of the alert
+     */
+    async getValidityData(project, repository, alertId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Validate",
+            routeValues: {
+                project: project,
+                repository: repository,
+                alertId: alertId
+            }
+        });
+    }
+    /**
+     * Initiate the validation process for a given alert
+     *
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of a repository
+     * @param alertId - The ID of the alert
+     */
+    async initiateValidation(project, repository, alertId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Validate",
+            routeValues: {
+                project: project,
+                repository: repository,
+                alertId: alertId
+            }
+        });
+    }
+}

package/esm/Alert/AlertClient.min.js

@@ -0,0 +1 @@
+import{RestClientBase}from"../Common/RestClientBase";import{deserializeVssJsonObject}from"../Common/Util/Serialization";export class AlertRestClient extends RestClientBase{constructor(e){super(e)}async getAlert(e,t,r,s,o){const i={ref:s,expand:o};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",routeValues:{project:e,alertId:t,repository:r},queryParams:i})}async getAlerts(e,t,r,s,o,i,a){const p={top:r,orderBy:s,criteria:o,expand:i,continuationToken:a};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",routeValues:{project:e,repository:t},queryParams:p,returnRawResponse:!0}).then(async e=>{const t=await e.text().then(deserializeVssJsonObject);return t.continuationToken=e.headers.get("x-ms-continuationtoken"),t})}async getAlertSarif(e,t,r,s,o){const i={ref:s,expand:o};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",routeValues:{project:e,alertId:t,repository:r},queryParams:i})}async updateAlert(e,t,r,s){return this.beginRequest({apiVersion:"7.2-preview.1",method:"PATCH",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}",routeValues:{project:t,alertId:r,repository:s},body:e})}async getAlertsByIds(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/AlertsBatch",routeValues:{project:t,repository:r},body:e})}async getBranches(e,t,r,s,o,i,a){const p={alertType:r,continuationToken:s,branchNameContains:o,top:i,includePullRequestBranches:a};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/filters/{action}",routeValues:{project:e,repository:t,action:"Branches"},queryParams:p})}async getUxFilters(e,t,r){const s={alertType:r};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/filters/{action}",routeValues:{project:e,repository:t,action:"Default"},queryParams:s})}async createAutofixRequest(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Autofix",routeValues:{project:e,alertId:t,repository:r}})}async uploadSarifToGitHub(e,t,r,s,o){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/github/{hostname}/{owner}/{repo}/sarifs",routeValues:{project:t,hostname:r,owner:s,repo:o},customHeaders:{"Content-Type":"application/octet-stream"},body:e})}async getAlertInstances(e,t,r,s){const o={ref:s};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Instances",routeValues:{project:e,alertId:t,repository:r},queryParams:o})}async createLegalReview(e,t,r,s){const o={alertId:r,ref:s};return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/Metadata",routeValues:{project:e,repository:t},queryParams:o})}async updateAlertsMetadata(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",method:"PATCH",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/Metadata",routeValues:{project:t,repository:r},body:e})}async getAlertMetadata(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/metadata",routeValues:{project:e,alertId:t,repository:r}})}async getAlertMetadataBatch(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/MetadataBatch",routeValues:{project:t,repository:r},body:e})}async getOrgLevelAlertsByIds(e){const t={alertIds:e&&e.join(",")};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/Alert/alerts",queryParams:t})}async deleteAllPipelineAnalyses(e,t){return this.beginRequest({apiVersion:"7.2-preview.1",method:"DELETE",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/pipelineAnalyses",routeValues:{project:e,repository:t}})}async deletePipelineAnalysis(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",method:"DELETE",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/pipelineAnalysis/{adoPipelineId}",routeValues:{project:e,repository:t,adoPipelineId:r}})}async exportSarif(e,t,r,s){const o={alertIds:r,branchName:s};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/sarifs",routeValues:{project:e,repository:t},queryParams:o})}async uploadSarif(e,t,r,s){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/sarifs",routeValues:{project:t,repository:r},customHeaders:{"Content-Type":"application/octet-stream","X-AdvSec-NotificationSarif":s},body:e})}async getSarif(e){return this.beginRequest({apiVersion:"7.2-preview.2",routeTemplate:"_apis/Alert/Sarifs/{sarifId}",routeValues:{sarifId:e}})}async uploadOrgSarif(e){return this.beginRequest({apiVersion:"7.2-preview.2",method:"POST",routeTemplate:"_apis/Alert/Sarifs/{sarifId}",customHeaders:{"Content-Type":"application/octet-stream"},body:e})}async getValidityData(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Validate",routeValues:{project:e,repository:t,alertId:r}})}async initiateValidation(e,t,r){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Validate",routeValues:{project:e,repository:t,alertId:r}})}};