azure-devops-extension-api 4.248.0 → 4.248.1

package/src/Favorite/Favorite.ts

@@ -1,136 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import * as WebApi from "../WebApi/WebApi";
-
-export interface ArtifactProperties {
-}
-
-/**
- * Describes the scope a favorited Artifact resides in. e.g. A team project.
- */
-export interface ArtifactScope {
-    /**
-     * The identifier of the scope the artifact resides in. For a TFS Project, this refers to the Project GUID string. For a Collection, marked this property with an empty string.
-     */
-    id: string;
-    /**
-     * Name of the artifact scope (e.g. Project Name)  Note: This property is a read-only extension over the stored favorite model. This value cannot be overridden on writes.
-     */
-    name: string;
-    /**
-     * Type of scope the favorite artifact resides in. Known scopes include "Project" or "Collection"
-     */
-    type: string;
-}
-
-/**
- * Implementation of Favorite contract following modern storage
- */
-export interface Favorite {
-    /**
-     * Links to the resources associated to the underlying artifact.
-     */
-    _links: any;
-    /**
-     * ID of the favorited artifact, unique in context of this artifact type.
-     */
-    artifactId: string;
-    /**
-     * Indicates if the artifact described by this favorite could not be located.
-     */
-    artifactIsDeleted: boolean;
-    /**
-     * Last known name of the artifact.
-     */
-    artifactName: string;
-    /**
-     * A dictionary of cached properties describing a Favorited artifact. Structure is generated by the service-side feature metadata provider handling this Artifact Type.
-     */
-    artifactProperties: ArtifactProperties;
-    /**
-     * Artifact Scope - This object describes where an artifact is contained. e.g. Project Mandatory param for creating all favorites.
-     */
-    artifactScope: ArtifactScope;
-    /**
-     * Type of artifact.
-     */
-    artifactType: string;
-    /**
-     * Date and time this Favorite was created on server.
-     */
-    creationDate: Date;
-    /**
-     * Unique Id of the favorite item, defined by server at creation time.
-     */
-    id: string;
-    /**
-     * User identity, defined by server, based on active user context.
-     */
-    owner: WebApi.IdentityRef;
-    /**
-     * Fully-Qualified link to this Resource
-     */
-    url: string;
-}
-
-export interface FavoriteCreateParameters {
-    artifactId: string;
-    artifactName: string;
-    artifactProperties: ArtifactProperties;
-    artifactScope: ArtifactScope;
-    artifactType: string;
-}
-
-/**
- * Exposes a provider of favorites.
- */
-export interface FavoriteProvider extends FavoritesSecuredObject {
-    /**
-     * Favorite artifact type
-     */
-    artifactType: string;
-    /**
-     * URI for retrieving favorite artifacts
-     */
-    artifactUri: string;
-    /**
-     * contributed client side service that is available for this provider to provide dynamic associated data.
-     */
-    clientServiceIdentifier: string;
-    /**
-     * Contribution Id
-     */
-    contributionId: string;
-    /**
-     * Css class to be applied to the icon for the artifact.
-     */
-    iconClass: string;
-    /**
-     * Name of the fabric icon to be applied for the artifact
-     */
-    iconName: string;
-    /**
-     * Group of favorites will be rendered in this order, 0 is top If 2 types share order, they will be coalesced into a single group
-     */
-    order: number;
-    /**
-     * Name used for rendering the title of each group of favorites
-     */
-    pluralName: string;
-    /**
-     * Service identifier of the service.
-     */
-    serviceIdentifier: string;
-    /**
-     * Base URI of the service
-     */
-    serviceUri: string;
-}
-
-export interface FavoritesSecuredObject {
-    token: string;
-}

package/src/Favorite/FavoriteClient.ts

@@ -1,301 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-
-import * as Favorite from "../Favorite/Favorite";
-
-export class FavoriteRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions) {
-        super(options);
-    }
-
-    /**
-     * @param faultInMissingHost - 
-     */
-    public async getFavoriteProviders(
-        faultInMissingHost?: boolean
-        ): Promise<Favorite.FavoriteProvider[]> {
-
-        const queryValues: any = {
-            faultInMissingHost: faultInMissingHost
-        };
-
-        return this.beginRequest<Favorite.FavoriteProvider[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/Favorite/FavoriteProviders",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param favorite - 
-     */
-    public async createFavorite(
-        favorite: Favorite.FavoriteCreateParameters
-        ): Promise<Favorite.Favorite> {
-
-        return this.beginRequest<Favorite.Favorite>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            body: favorite
-        });
-    }
-
-    /**
-     * @param favorite - 
-     * @param ownerScopeType - 
-     * @param ownerScopeId - 
-     */
-    public async createFavoriteOfOwner(
-        favorite: Favorite.FavoriteCreateParameters,
-        ownerScopeType: string,
-        ownerScopeId: string
-        ): Promise<Favorite.Favorite> {
-
-        const queryValues: any = {
-            ownerScopeType: ownerScopeType,
-            ownerScopeId: ownerScopeId
-        };
-
-        return this.beginRequest<Favorite.Favorite>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            queryParams: queryValues,
-            body: favorite
-        });
-    }
-
-    /**
-     * @param favoriteId - 
-     * @param artifactType - 
-     * @param artifactScopeType - 
-     * @param artifactScopeId - 
-     */
-    public async deleteFavoriteById(
-        favoriteId: string,
-        artifactType: string,
-        artifactScopeType: string,
-        artifactScopeId?: string
-        ): Promise<void> {
-
-        const queryValues: any = {
-            artifactType: artifactType,
-            artifactScopeType: artifactScopeType,
-            artifactScopeId: artifactScopeId
-        };
-
-        return this.beginRequest<void>({
-            apiVersion: "7.2-preview.1",
-            method: "DELETE",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            routeValues: {
-                favoriteId: favoriteId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param favoriteId - 
-     * @param ownerScopeType - 
-     * @param ownerScopeId - 
-     * @param artifactType - 
-     * @param artifactScopeType - 
-     * @param artifactScopeId - 
-     */
-    public async deleteFavoriteOfOwnerById(
-        favoriteId: string,
-        ownerScopeType: string,
-        ownerScopeId: string,
-        artifactType: string,
-        artifactScopeType: string,
-        artifactScopeId?: string
-        ): Promise<void> {
-
-        const queryValues: any = {
-            ownerScopeType: ownerScopeType,
-            ownerScopeId: ownerScopeId,
-            artifactType: artifactType,
-            artifactScopeType: artifactScopeType,
-            artifactScopeId: artifactScopeId
-        };
-
-        return this.beginRequest<void>({
-            apiVersion: "7.2-preview.1",
-            method: "DELETE",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            routeValues: {
-                favoriteId: favoriteId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param artifactType - 
-     * @param artifactId - 
-     * @param artifactScopeType - 
-     * @param artifactScopeId - 
-     * @param includeExtendedDetails - 
-     */
-    public async getFavoriteByArtifact(
-        artifactType: string,
-        artifactId: string,
-        artifactScopeType: string,
-        artifactScopeId?: string,
-        includeExtendedDetails?: boolean
-        ): Promise<Favorite.Favorite> {
-
-        const queryValues: any = {
-            artifactType: artifactType,
-            artifactId: artifactId,
-            artifactScopeType: artifactScopeType,
-            artifactScopeId: artifactScopeId,
-            includeExtendedDetails: includeExtendedDetails
-        };
-
-        return this.beginRequest<Favorite.Favorite>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param favoriteId - 
-     * @param artifactScopeType - 
-     * @param artifactType - 
-     * @param artifactScopeId - 
-     * @param includeExtendedDetails - 
-     */
-    public async getFavoriteById(
-        favoriteId: string,
-        artifactScopeType: string,
-        artifactType: string,
-        artifactScopeId?: string,
-        includeExtendedDetails?: boolean
-        ): Promise<Favorite.Favorite> {
-
-        const queryValues: any = {
-            artifactScopeType: artifactScopeType,
-            artifactType: artifactType,
-            artifactScopeId: artifactScopeId,
-            includeExtendedDetails: includeExtendedDetails
-        };
-
-        return this.beginRequest<Favorite.Favorite>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            routeValues: {
-                favoriteId: favoriteId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param favoriteId - 
-     * @param ownerScopeType - 
-     * @param ownerScopeId - 
-     * @param artifactScopeType - 
-     * @param artifactType - 
-     * @param artifactScopeId - 
-     * @param includeExtendedDetails - 
-     */
-    public async getFavoriteOfOwnerById(
-        favoriteId: string,
-        ownerScopeType: string,
-        ownerScopeId: string,
-        artifactScopeType: string,
-        artifactType: string,
-        artifactScopeId?: string,
-        includeExtendedDetails?: boolean
-        ): Promise<Favorite.Favorite> {
-
-        const queryValues: any = {
-            ownerScopeType: ownerScopeType,
-            ownerScopeId: ownerScopeId,
-            artifactScopeType: artifactScopeType,
-            artifactType: artifactType,
-            artifactScopeId: artifactScopeId,
-            includeExtendedDetails: includeExtendedDetails
-        };
-
-        return this.beginRequest<Favorite.Favorite>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            routeValues: {
-                favoriteId: favoriteId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param artifactType - 
-     * @param artifactScopeType - 
-     * @param artifactScopeId - 
-     * @param includeExtendedDetails - 
-     */
-    public async getFavorites(
-        artifactType?: string,
-        artifactScopeType?: string,
-        artifactScopeId?: string,
-        includeExtendedDetails?: boolean
-        ): Promise<Favorite.Favorite[]> {
-
-        const queryValues: any = {
-            artifactType: artifactType,
-            artifactScopeType: artifactScopeType,
-            artifactScopeId: artifactScopeId,
-            includeExtendedDetails: includeExtendedDetails
-        };
-
-        return this.beginRequest<Favorite.Favorite[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * @param ownerScopeType - 
-     * @param ownerScopeId - 
-     * @param artifactType - 
-     * @param artifactScopeType - 
-     * @param artifactScopeId - 
-     * @param includeExtendedDetails - 
-     */
-    public async getFavoritesOfOwner(
-        ownerScopeType: string,
-        ownerScopeId: string,
-        artifactType?: string,
-        artifactScopeType?: string,
-        artifactScopeId?: string,
-        includeExtendedDetails?: boolean
-        ): Promise<Favorite.Favorite[]> {
-
-        const queryValues: any = {
-            ownerScopeType: ownerScopeType,
-            ownerScopeId: ownerScopeId,
-            artifactType: artifactType,
-            artifactScopeType: artifactScopeType,
-            artifactScopeId: artifactScopeId,
-            includeExtendedDetails: includeExtendedDetails
-        };
-
-        return this.beginRequest<Favorite.Favorite[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/Favorite/Favorites/{favoriteId}",
-            queryParams: queryValues
-        });
-    }
-
-}

package/src/FeatureAvailability/FeatureAvailability.ts

@@ -1,20 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-export interface FeatureFlag {
-    description: string;
-    effectiveState: string;
-    explicitState: string;
-    name: string;
-    uri: string;
-}
-
-/**
- * This is passed to the FeatureFlagController to edit the status of a feature flag
- */
-export interface FeatureFlagPatch {
-    state: string;
-}

package/src/FeatureAvailability/FeatureAvailabilityClient.ts

@@ -1,153 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-
-import * as FeatureAvailability from "../FeatureAvailability/FeatureAvailability";
-
-export class FeatureAvailabilityRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions) {
-        super(options);
-    }
-
-    /**
-     * Retrieve a listing of all feature flags and their current states for a user
-     * 
-     * @param userEmail - The email of the user to check
-     */
-    public async getAllFeatureFlags(
-        userEmail?: string
-        ): Promise<FeatureAvailability.FeatureFlag[]> {
-
-        const queryValues: any = {
-            userEmail: userEmail
-        };
-
-        return this.beginRequest<FeatureAvailability.FeatureFlag[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureFlags/{name}",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Retrieve information on a single feature flag and its current states
-     * 
-     * @param name - The name of the feature to retrieve
-     * @param checkFeatureExists - Check if feature exists
-     */
-    public async getFeatureFlagByName(
-        name: string,
-        checkFeatureExists?: boolean
-        ): Promise<FeatureAvailability.FeatureFlag> {
-
-        const queryValues: any = {
-            checkFeatureExists: checkFeatureExists
-        };
-
-        return this.beginRequest<FeatureAvailability.FeatureFlag>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureFlags/{name}",
-            routeValues: {
-                name: name
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Retrieve information on a single feature flag and its current states for a user
-     * 
-     * @param name - The name of the feature to retrieve
-     * @param userEmail - The email of the user to check
-     * @param checkFeatureExists - Check if feature exists
-     */
-    public async getFeatureFlagByNameAndUserEmail(
-        name: string,
-        userEmail: string,
-        checkFeatureExists?: boolean
-        ): Promise<FeatureAvailability.FeatureFlag> {
-
-        const queryValues: any = {
-            userEmail: userEmail,
-            checkFeatureExists: checkFeatureExists
-        };
-
-        return this.beginRequest<FeatureAvailability.FeatureFlag>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureFlags/{name}",
-            routeValues: {
-                name: name
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Retrieve information on a single feature flag and its current states for a user
-     * 
-     * @param name - The name of the feature to retrieve
-     * @param userId - The id of the user to check
-     * @param checkFeatureExists - Check if feature exists
-     */
-    public async getFeatureFlagByNameAndUserId(
-        name: string,
-        userId: string,
-        checkFeatureExists?: boolean
-        ): Promise<FeatureAvailability.FeatureFlag> {
-
-        const queryValues: any = {
-            userId: userId,
-            checkFeatureExists: checkFeatureExists
-        };
-
-        return this.beginRequest<FeatureAvailability.FeatureFlag>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureFlags/{name}",
-            routeValues: {
-                name: name
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Change the state of an individual feature flag for a name
-     * 
-     * @param state - State that should be set
-     * @param name - The name of the feature to change
-     * @param userEmail - 
-     * @param checkFeatureExists - Checks if the feature exists before setting the state
-     * @param setAtApplicationLevelAlso - 
-     */
-    public async updateFeatureFlag(
-        state: FeatureAvailability.FeatureFlagPatch,
-        name: string,
-        userEmail?: string,
-        checkFeatureExists?: boolean,
-        setAtApplicationLevelAlso?: boolean
-        ): Promise<FeatureAvailability.FeatureFlag> {
-
-        const queryValues: any = {
-            userEmail: userEmail,
-            checkFeatureExists: checkFeatureExists,
-            setAtApplicationLevelAlso: setAtApplicationLevelAlso
-        };
-
-        return this.beginRequest<FeatureAvailability.FeatureFlag>({
-            apiVersion: "7.2-preview.1",
-            method: "PATCH",
-            routeTemplate: "_apis/FeatureFlags/{name}",
-            routeValues: {
-                name: name
-            },
-            queryParams: queryValues,
-            body: state
-        });
-    }
-
-}

package/src/FeatureAvailability/index.ts

@@ -1,2 +0,0 @@
-export * from "./FeatureAvailability";
-export * from "./FeatureAvailabilityClient";