azure-devops-extension-api 4.269.1 → 5.271.0

package/Policy/Policy.d.ts

@@ -1,160 +1,160 @@
-import * as WebApi from "../WebApi/WebApi";
-/**
- * The full policy configuration with settings.
- */
-export interface PolicyConfiguration extends VersionedPolicyConfigurationRef {
-    /**
-     * The links to other objects related to this object.
-     */
-    _links: any;
-    /**
-     * A reference to the identity that created the policy.
-     */
-    createdBy: WebApi.IdentityRef;
-    /**
-     * The date and time when the policy was created.
-     */
-    createdDate: Date;
-    /**
-     * Indicates whether the policy is blocking.
-     */
-    isBlocking: boolean;
-    /**
-     * Indicates whether the policy has been (soft) deleted.
-     */
-    isDeleted: boolean;
-    /**
-     * Indicates whether the policy is enabled.
-     */
-    isEnabled: boolean;
-    /**
-     * If set, this policy requires "Manage Enterprise Policies" permission to create, edit, or delete.
-     */
-    isEnterpriseManaged: boolean;
-    /**
-     * The policy configuration settings.
-     */
-    settings: any;
-}
-/**
- * Policy configuration reference.
- */
-export interface PolicyConfigurationRef {
-    /**
-     * The policy configuration ID.
-     */
-    id: number;
-    /**
-     * The policy configuration type.
-     */
-    type: PolicyTypeRef;
-    /**
-     * The URL where the policy configuration can be retrieved.
-     */
-    url: string;
-}
-/**
- * This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to.
- */
-export interface PolicyEvaluationRecord {
-    /**
-     * Links to other related objects
-     */
-    _links: any;
-    /**
-     * A string which uniquely identifies the target of a policy evaluation.
-     */
-    artifactId: string;
-    /**
-     * Time when this policy finished evaluating on this pull request.
-     */
-    completedDate: Date;
-    /**
-     * Contains all configuration data for the policy which is being evaluated.
-     */
-    configuration: PolicyConfiguration;
-    /**
-     * Internal context data of this policy evaluation.
-     */
-    context: any;
-    /**
-     * Guid which uniquely identifies this evaluation record (one policy running on one pull request).
-     */
-    evaluationId: string;
-    /**
-     * Time when this policy was first evaluated on this pull request.
-     */
-    startedDate: Date;
-    /**
-     * Status of the policy (Running, Approved, Failed, etc.)
-     */
-    status: PolicyEvaluationStatus;
-}
-/**
- * Status of a policy which is running against a specific pull request.
- */
-export declare enum PolicyEvaluationStatus {
-    /**
-     * The policy is either queued to run, or is waiting for some event before progressing.
-     */
-    Queued = 0,
-    /**
-     * The policy is currently running.
-     */
-    Running = 1,
-    /**
-     * The policy has been fulfilled for this pull request.
-     */
-    Approved = 2,
-    /**
-     * The policy has rejected this pull request.
-     */
-    Rejected = 3,
-    /**
-     * The policy does not apply to this pull request.
-     */
-    NotApplicable = 4,
-    /**
-     * The policy has encountered an unexpected error.
-     */
-    Broken = 5
-}
-/**
- * User-friendly policy type with description (used for querying policy types).
- */
-export interface PolicyType extends PolicyTypeRef {
-    /**
-     * The links to other objects related to this object.
-     */
-    _links: any;
-    /**
-     * Detailed description of the policy type.
-     */
-    description: string;
-}
-/**
- * Policy type reference.
- */
-export interface PolicyTypeRef {
-    /**
-     * Display name of the policy type.
-     */
-    displayName: string;
-    /**
-     * The policy type ID.
-     */
-    id: string;
-    /**
-     * The URL where the policy type can be retrieved.
-     */
-    url: string;
-}
-/**
- * A particular revision for a policy configuration.
- */
-export interface VersionedPolicyConfigurationRef extends PolicyConfigurationRef {
-    /**
-     * The policy configuration revision ID.
-     */
-    revision: number;
-}
+import * as WebApi from "../WebApi/WebApi";
+/**
+ * The full policy configuration with settings.
+ */
+export interface PolicyConfiguration extends VersionedPolicyConfigurationRef {
+    /**
+     * The links to other objects related to this object.
+     */
+    _links: any;
+    /**
+     * A reference to the identity that created the policy.
+     */
+    createdBy: WebApi.IdentityRef;
+    /**
+     * The date and time when the policy was created.
+     */
+    createdDate: Date;
+    /**
+     * Indicates whether the policy is blocking.
+     */
+    isBlocking: boolean;
+    /**
+     * Indicates whether the policy has been (soft) deleted.
+     */
+    isDeleted: boolean;
+    /**
+     * Indicates whether the policy is enabled.
+     */
+    isEnabled: boolean;
+    /**
+     * If set, this policy requires "Manage Enterprise Policies" permission to create, edit, or delete.
+     */
+    isEnterpriseManaged: boolean;
+    /**
+     * The policy configuration settings.
+     */
+    settings: any;
+}
+/**
+ * Policy configuration reference.
+ */
+export interface PolicyConfigurationRef {
+    /**
+     * The policy configuration ID.
+     */
+    id: number;
+    /**
+     * The policy configuration type.
+     */
+    type: PolicyTypeRef;
+    /**
+     * The URL where the policy configuration can be retrieved.
+     */
+    url: string;
+}
+/**
+ * This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to.
+ */
+export interface PolicyEvaluationRecord {
+    /**
+     * Links to other related objects
+     */
+    _links: any;
+    /**
+     * A string which uniquely identifies the target of a policy evaluation.
+     */
+    artifactId: string;
+    /**
+     * Time when this policy finished evaluating on this pull request.
+     */
+    completedDate: Date;
+    /**
+     * Contains all configuration data for the policy which is being evaluated.
+     */
+    configuration: PolicyConfiguration;
+    /**
+     * Internal context data of this policy evaluation.
+     */
+    context: any;
+    /**
+     * Guid which uniquely identifies this evaluation record (one policy running on one pull request).
+     */
+    evaluationId: string;
+    /**
+     * Time when this policy was first evaluated on this pull request.
+     */
+    startedDate: Date;
+    /**
+     * Status of the policy (Running, Approved, Failed, etc.)
+     */
+    status: PolicyEvaluationStatus;
+}
+/**
+ * Status of a policy which is running against a specific pull request.
+ */
+export declare enum PolicyEvaluationStatus {
+    /**
+     * The policy is either queued to run, or is waiting for some event before progressing.
+     */
+    Queued = 0,
+    /**
+     * The policy is currently running.
+     */
+    Running = 1,
+    /**
+     * The policy has been fulfilled for this pull request.
+     */
+    Approved = 2,
+    /**
+     * The policy has rejected this pull request.
+     */
+    Rejected = 3,
+    /**
+     * The policy does not apply to this pull request.
+     */
+    NotApplicable = 4,
+    /**
+     * The policy has encountered an unexpected error.
+     */
+    Broken = 5
+}
+/**
+ * User-friendly policy type with description (used for querying policy types).
+ */
+export interface PolicyType extends PolicyTypeRef {
+    /**
+     * The links to other objects related to this object.
+     */
+    _links: any;
+    /**
+     * Detailed description of the policy type.
+     */
+    description: string;
+}
+/**
+ * Policy type reference.
+ */
+export interface PolicyTypeRef {
+    /**
+     * Display name of the policy type.
+     */
+    displayName: string;
+    /**
+     * The policy type ID.
+     */
+    id: string;
+    /**
+     * The URL where the policy type can be retrieved.
+     */
+    url: string;
+}
+/**
+ * A particular revision for a policy configuration.
+ */
+export interface VersionedPolicyConfigurationRef extends PolicyConfigurationRef {
+    /**
+     * The policy configuration revision ID.
+     */
+    revision: number;
+}

package/Policy/Policy.js

@@ -1,39 +1,38 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-define(["require", "exports"], function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    /**
-     * Status of a policy which is running against a specific pull request.
-     */
-    var PolicyEvaluationStatus;
-    (function (PolicyEvaluationStatus) {
-        /**
-         * The policy is either queued to run, or is waiting for some event before progressing.
-         */
-        PolicyEvaluationStatus[PolicyEvaluationStatus["Queued"] = 0] = "Queued";
-        /**
-         * The policy is currently running.
-         */
-        PolicyEvaluationStatus[PolicyEvaluationStatus["Running"] = 1] = "Running";
-        /**
-         * The policy has been fulfilled for this pull request.
-         */
-        PolicyEvaluationStatus[PolicyEvaluationStatus["Approved"] = 2] = "Approved";
-        /**
-         * The policy has rejected this pull request.
-         */
-        PolicyEvaluationStatus[PolicyEvaluationStatus["Rejected"] = 3] = "Rejected";
-        /**
-         * The policy does not apply to this pull request.
-         */
-        PolicyEvaluationStatus[PolicyEvaluationStatus["NotApplicable"] = 4] = "NotApplicable";
-        /**
-         * The policy has encountered an unexpected error.
-         */
-        PolicyEvaluationStatus[PolicyEvaluationStatus["Broken"] = 5] = "Broken";
-    })(PolicyEvaluationStatus = exports.PolicyEvaluationStatus || (exports.PolicyEvaluationStatus = {}));
-});
+"use strict";
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PolicyEvaluationStatus = void 0;
+/**
+ * Status of a policy which is running against a specific pull request.
+ */
+var PolicyEvaluationStatus;
+(function (PolicyEvaluationStatus) {
+    /**
+     * The policy is either queued to run, or is waiting for some event before progressing.
+     */
+    PolicyEvaluationStatus[PolicyEvaluationStatus["Queued"] = 0] = "Queued";
+    /**
+     * The policy is currently running.
+     */
+    PolicyEvaluationStatus[PolicyEvaluationStatus["Running"] = 1] = "Running";
+    /**
+     * The policy has been fulfilled for this pull request.
+     */
+    PolicyEvaluationStatus[PolicyEvaluationStatus["Approved"] = 2] = "Approved";
+    /**
+     * The policy has rejected this pull request.
+     */
+    PolicyEvaluationStatus[PolicyEvaluationStatus["Rejected"] = 3] = "Rejected";
+    /**
+     * The policy does not apply to this pull request.
+     */
+    PolicyEvaluationStatus[PolicyEvaluationStatus["NotApplicable"] = 4] = "NotApplicable";
+    /**
+     * The policy has encountered an unexpected error.
+     */
+    PolicyEvaluationStatus[PolicyEvaluationStatus["Broken"] = 5] = "Broken";
+})(PolicyEvaluationStatus || (exports.PolicyEvaluationStatus = PolicyEvaluationStatus = {}));

package/Policy/Policy.min.js

@@ -1 +1 @@
-define(["require","exports"],function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0});!function(e){e[e.Queued=0]="Queued",e[e.Running=1]="Running",e[e.Approved=2]="Approved",e[e.Rejected=3]="Rejected",e[e.NotApplicable=4]="NotApplicable",e[e.Broken=5]="Broken"}(t.PolicyEvaluationStatus||(t.PolicyEvaluationStatus={}))});
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PolicyEvaluationStatus=void 0;var PolicyEvaluationStatus;!function(e){e[e.Queued=0]="Queued",e[e.Running=1]="Running",e[e.Approved=2]="Approved",e[e.Rejected=3]="Rejected",e[e.NotApplicable=4]="NotApplicable",e[e.Broken=5]="Broken"}(PolicyEvaluationStatus||(exports.PolicyEvaluationStatus=PolicyEvaluationStatus={}));

package/Policy/PolicyClient.d.ts

@@ -1,99 +1,99 @@
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-import * as Policy from "../Policy/Policy";
-import * as WebApi from "../WebApi/WebApi";
-export declare class PolicyRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions);
-    static readonly RESOURCE_AREA_ID: string;
-    /**
-     * Create a policy configuration of a given policy type.
-     *
-     * @param configuration - The policy configuration to create.
-     * @param project - Project ID or project name
-     */
-    createPolicyConfiguration(configuration: Policy.PolicyConfiguration, project: string): Promise<Policy.PolicyConfiguration>;
-    /**
-     * Delete a policy configuration by its ID.
-     *
-     * @param project - Project ID or project name
-     * @param configurationId - ID of the policy configuration to delete.
-     */
-    deletePolicyConfiguration(project: string, configurationId: number): Promise<void>;
-    /**
-     * Get a policy configuration by its ID.
-     *
-     * @param project - Project ID or project name
-     * @param configurationId - ID of the policy configuration
-     */
-    getPolicyConfiguration(project: string, configurationId: number): Promise<Policy.PolicyConfiguration>;
-    /**
-     * Get a list of policy configurations in a project.
-     *
-     * @param project - Project ID or project name
-     * @param scope - [Provided for legacy reasons] The scope on which a subset of policies is defined.
-     * @param policyType - Filter returned policies to only this type
-     */
-    getPolicyConfigurations(project: string, scope?: string, policyType?: string): Promise<WebApi.PagedList<Policy.PolicyConfiguration>>;
-    /**
-     * Update a policy configuration by its ID.
-     *
-     * @param configuration - The policy configuration to update.
-     * @param project - Project ID or project name
-     * @param configurationId - ID of the existing policy configuration to be updated.
-     */
-    updatePolicyConfiguration(configuration: Policy.PolicyConfiguration, project: string, configurationId: number): Promise<Policy.PolicyConfiguration>;
-    /**
-     * Gets the present evaluation state of a policy.
-     *
-     * @param project - Project ID or project name
-     * @param evaluationId - ID of the policy evaluation to be retrieved.
-     */
-    getPolicyEvaluation(project: string, evaluationId: string): Promise<Policy.PolicyEvaluationRecord>;
-    /**
-     * Requeue the policy evaluation.
-     *
-     * @param project - Project ID or project name
-     * @param evaluationId - ID of the policy evaluation to be retrieved.
-     */
-    requeuePolicyEvaluation(project: string, evaluationId: string): Promise<Policy.PolicyEvaluationRecord>;
-    /**
-     * Retrieves a list of all the policy evaluation statuses for a specific pull request.
-     *
-     * @param project - Project ID or project name
-     * @param artifactId - A string which uniquely identifies the target of a policy evaluation.
-     * @param includeNotApplicable - Some policies might determine that they do not apply to a specific pull request. Setting this parameter to true will return evaluation records even for policies which don't apply to this pull request.
-     * @param top - The number of policy evaluation records to retrieve.
-     * @param skip - The number of policy evaluation records to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
-     */
-    getPolicyEvaluations(project: string, artifactId: string, includeNotApplicable?: boolean, top?: number, skip?: number): Promise<Policy.PolicyEvaluationRecord[]>;
-    /**
-     * Retrieve a specific revision of a given policy by ID.
-     *
-     * @param project - Project ID or project name
-     * @param configurationId - The policy configuration ID.
-     * @param revisionId - The revision ID.
-     */
-    getPolicyConfigurationRevision(project: string, configurationId: number, revisionId: number): Promise<Policy.PolicyConfiguration>;
-    /**
-     * Retrieve all revisions for a given policy.
-     *
-     * @param project - Project ID or project name
-     * @param configurationId - The policy configuration ID.
-     * @param top - The number of revisions to retrieve.
-     * @param skip - The number of revisions to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
-     */
-    getPolicyConfigurationRevisions(project: string, configurationId: number, top?: number, skip?: number): Promise<Policy.PolicyConfiguration[]>;
-    /**
-     * Retrieve a specific policy type by ID.
-     *
-     * @param project - Project ID or project name
-     * @param typeId - The policy ID.
-     */
-    getPolicyType(project: string, typeId: string): Promise<Policy.PolicyType>;
-    /**
-     * Retrieve all available policy types.
-     *
-     * @param project - Project ID or project name
-     */
-    getPolicyTypes(project: string): Promise<Policy.PolicyType[]>;
-}
+import { IVssRestClientOptions } from "../Common/Context";
+import { RestClientBase } from "../Common/RestClientBase";
+import * as Policy from "../Policy/Policy";
+import * as WebApi from "../WebApi/WebApi";
+export declare class PolicyRestClient extends RestClientBase {
+    constructor(options: IVssRestClientOptions);
+    static readonly RESOURCE_AREA_ID = "fb13a388-40dd-4a04-b530-013a739c72ef";
+    /**
+     * Create a policy configuration of a given policy type.
+     *
+     * @param configuration - The policy configuration to create.
+     * @param project - Project ID or project name
+     */
+    createPolicyConfiguration(configuration: Policy.PolicyConfiguration, project: string): Promise<Policy.PolicyConfiguration>;
+    /**
+     * Delete a policy configuration by its ID.
+     *
+     * @param project - Project ID or project name
+     * @param configurationId - ID of the policy configuration to delete.
+     */
+    deletePolicyConfiguration(project: string, configurationId: number): Promise<void>;
+    /**
+     * Get a policy configuration by its ID.
+     *
+     * @param project - Project ID or project name
+     * @param configurationId - ID of the policy configuration
+     */
+    getPolicyConfiguration(project: string, configurationId: number): Promise<Policy.PolicyConfiguration>;
+    /**
+     * Get a list of policy configurations in a project.
+     *
+     * @param project - Project ID or project name
+     * @param scope - [Provided for legacy reasons] The scope on which a subset of policies is defined.
+     * @param policyType - Filter returned policies to only this type
+     */
+    getPolicyConfigurations(project: string, scope?: string, policyType?: string): Promise<WebApi.PagedList<Policy.PolicyConfiguration>>;
+    /**
+     * Update a policy configuration by its ID.
+     *
+     * @param configuration - The policy configuration to update.
+     * @param project - Project ID or project name
+     * @param configurationId - ID of the existing policy configuration to be updated.
+     */
+    updatePolicyConfiguration(configuration: Policy.PolicyConfiguration, project: string, configurationId: number): Promise<Policy.PolicyConfiguration>;
+    /**
+     * Gets the present evaluation state of a policy.
+     *
+     * @param project - Project ID or project name
+     * @param evaluationId - ID of the policy evaluation to be retrieved.
+     */
+    getPolicyEvaluation(project: string, evaluationId: string): Promise<Policy.PolicyEvaluationRecord>;
+    /**
+     * Requeue the policy evaluation.
+     *
+     * @param project - Project ID or project name
+     * @param evaluationId - ID of the policy evaluation to be retrieved.
+     */
+    requeuePolicyEvaluation(project: string, evaluationId: string): Promise<Policy.PolicyEvaluationRecord>;
+    /**
+     * Retrieves a list of all the policy evaluation statuses for a specific pull request.
+     *
+     * @param project - Project ID or project name
+     * @param artifactId - A string which uniquely identifies the target of a policy evaluation.
+     * @param includeNotApplicable - Some policies might determine that they do not apply to a specific pull request. Setting this parameter to true will return evaluation records even for policies which don't apply to this pull request.
+     * @param top - The number of policy evaluation records to retrieve.
+     * @param skip - The number of policy evaluation records to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
+     */
+    getPolicyEvaluations(project: string, artifactId: string, includeNotApplicable?: boolean, top?: number, skip?: number): Promise<Policy.PolicyEvaluationRecord[]>;
+    /**
+     * Retrieve a specific revision of a given policy by ID.
+     *
+     * @param project - Project ID or project name
+     * @param configurationId - The policy configuration ID.
+     * @param revisionId - The revision ID.
+     */
+    getPolicyConfigurationRevision(project: string, configurationId: number, revisionId: number): Promise<Policy.PolicyConfiguration>;
+    /**
+     * Retrieve all revisions for a given policy.
+     *
+     * @param project - Project ID or project name
+     * @param configurationId - The policy configuration ID.
+     * @param top - The number of revisions to retrieve.
+     * @param skip - The number of revisions to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
+     */
+    getPolicyConfigurationRevisions(project: string, configurationId: number, top?: number, skip?: number): Promise<Policy.PolicyConfiguration[]>;
+    /**
+     * Retrieve a specific policy type by ID.
+     *
+     * @param project - Project ID or project name
+     * @param typeId - The policy ID.
+     */
+    getPolicyType(project: string, typeId: string): Promise<Policy.PolicyType>;
+    /**
+     * Retrieve all available policy types.
+     *
+     * @param project - Project ID or project name
+     */
+    getPolicyTypes(project: string): Promise<Policy.PolicyType[]>;
+}