azure-devops-extension-api 1.158.0 → 2.220.0

package/Git/GitClient.d.ts

@@ -6,6 +6,37 @@ import * as WebApi from "../WebApi/WebApi";
 export declare class GitRestClient extends RestClientBase {
     constructor(options: IVssRestClientOptions);
     static readonly RESOURCE_AREA_ID: string;
+    /**
+     * DELETE Deletes Enablement status and BillableCommitters data from DB. Deleting the enablement data will effectively disable it for the repositories affected.
+     *
+     * @param allProjects -
+     * @param includeBillableCommitters -
+     * @param projectIds -
+     */
+    deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>;
+    /**
+     * GET Enablement status for project's repositories.
+     *
+     * @param projectIds - Null defaults to all projects in the host, list of project's repos status to return
+     * @param billingDate - UTC expected, Null defaults to UtcNow(), can be provided for a point in time status
+     * @param skip - Skip X rows of resultset to simulate paging.
+     * @param take - Return Y rows of resultset to simulate paging.
+     */
+    getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<Git.AdvSecEnablementStatus[]>;
+    /**
+     * POST Enablement status for repositories.
+     *
+     * @param enablementUpdates -
+     */
+    updateEnablementStatus(enablementUpdates: Git.AdvSecEnablementUpdate[]): Promise<void>;
+    /**
+     * GET Advanced Security Permission status.
+     *
+     * @param projectName -
+     * @param repositoryId - Repository user is trying to access
+     * @param permission - Permission being requestd, must be "viewAlert" "dismissAlert" or "manage"
+     */
+    getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>;
     /**
      * Create an annotated tag.
      *
@@ -22,6 +53,33 @@ export declare class GitRestClient extends RestClientBase {
      * @param objectId - ObjectId (Sha1Id) of tag to get.
      */
     getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<Git.GitAnnotatedTag>;
+    /**
+     * Retrieve actual billable committers for Advanced Security service for a given date.
+     *
+     * @param project - Project ID or project name
+     * @param billingDate - UTC expected.  If not specified defaults to the previous billing day.
+     * @param skip - Skip X rows of resultset to simulate paging.
+     * @param take - Return Y rows of resultset to simulate paging.
+     */
+    getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<Git.BillableCommitter[]>;
+    /**
+     * Retrieve detailed actual billable committers for Advanced Security service for a given date.
+     *
+     * @param project - Project ID or project name
+     * @param includeDetails - Return all the details on the billable committers.
+     * @param billingDate - UTC expected. If not specified defaults to the previous billing day.
+     * @param skip - Skip X rows of resultset to simulate paging.
+     * @param take - Return Y rows of resultset to simulate paging.
+     */
+    getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date, skip?: number, take?: number): Promise<Git.BillableCommitterDetail[]>;
+    /**
+     * Retrieve actual billable committers for Advanced Security service for a given date.
+     *
+     * @param project - Project ID or project name
+     * @param estimateOnly -
+     * @param repositoryId -
+     */
+    getEstimatedBillableCommitters(project: string, estimateOnly: string, repositoryId?: string): Promise<Git.BillableCommitter[]>;
     /**
      * Get a single blob.
      *
@@ -97,6 +155,47 @@ export declare class GitRestClient extends RestClientBase {
      * @param skip - The number of changes to skip.
      */
     getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<Git.GitCommitChanges>;
+    /**
+     * Retrieve one conflict for a cherry pick by ID
+     *
+     * @param repositoryId -
+     * @param cherryPickId -
+     * @param conflictId -
+     * @param project - Project ID or project name
+     */
+    getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<Git.GitConflict>;
+    /**
+     * Retrieve all conflicts for a cherry pick
+     *
+     * @param repositoryId -
+     * @param cherryPickId -
+     * @param project - Project ID or project name
+     * @param continuationToken -
+     * @param top -
+     * @param excludeResolved -
+     * @param onlyResolved -
+     * @param includeObsolete -
+     */
+    getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<WebApi.PagedList<Git.GitConflict>>;
+    /**
+     * Update merge conflict resolution
+     *
+     * @param conflict -
+     * @param repositoryId -
+     * @param cherryPickId -
+     * @param conflictId -
+     * @param project - Project ID or project name
+     */
+    updateCherryPickConflict(conflict: Git.GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<Git.GitConflict>;
+    /**
+     * Update multiple merge conflict resolutions
+     *
+     * @param conflictUpdates -
+     * @param repositoryId -
+     * @param cherryPickId -
+     * @param project - Project ID or project name
+     */
+    updateCherryPickConflicts(conflictUpdates: Git.GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<Git.GitConflictUpdateResult[]>;
     /**
      * Given a commitId, returns a list of commits that are in the same cherry-pick family.
      *
@@ -115,7 +214,7 @@ export declare class GitRestClient extends RestClientBase {
      */
     createCherryPick(cherryPickToCreate: Git.GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<Git.GitCherryPick>;
     /**
-     * Retrieve information about a cherry pick by cherry pick Id.
+     * Retrieve information about a cherry pick operation by cherry pick Id.
      *
      * @param project - Project ID or project name
      * @param cherryPickId - ID of the cherry pick.
@@ -123,7 +222,7 @@ export declare class GitRestClient extends RestClientBase {
      */
     getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<Git.GitCherryPick>;
     /**
-     * Retrieve information about a cherry pick for a specific branch.
+     * Retrieve information about a cherry pick operation for a specific branch. This operation is expensive due to the underlying object structure, so this API only looks at the 1000 most recent cherry pick operations.
      *
      * @param project - Project ID or project name
      * @param repositoryId - ID of the repository.
@@ -278,8 +377,9 @@ export declare class GitRestClient extends RestClientBase {
      * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
      * @param includeContent - Set to true to include item content when requesting json.  Default is false.
      * @param resolveLfs - Set to true to resolve Git LFS pointer files to return actual content from Git LFS.  Default is false.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
      */
-    getItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean): Promise<Git.GitItem>;
+    getItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<Git.GitItem>;
     /**
      * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
      *
@@ -294,8 +394,9 @@ export declare class GitRestClient extends RestClientBase {
      * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
      * @param includeContent - Set to true to include item content when requesting json.  Default is false.
      * @param resolveLfs - Set to true to resolve Git LFS pointer files to return actual content from Git LFS.  Default is false.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
      */
-    getItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean): Promise<ArrayBuffer>;
+    getItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>;
     /**
      * Get Item Metadata and/or Content for a collection of items. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.
      *
@@ -308,8 +409,9 @@ export declare class GitRestClient extends RestClientBase {
      * @param download - Set to true to download the response as a file.  Default is false.
      * @param includeLinks - Set to true to include links to items.  Default is false.
      * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+     * @param zipForUnix - Set to true to keep the file permissions for unix (and POSIX) systems like executables and symlinks
      */
-    getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: Git.GitVersionDescriptor): Promise<Git.GitItem[]>;
+    getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: Git.GitVersionDescriptor, zipForUnix?: boolean): Promise<Git.GitItem[]>;
     /**
      * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
      *
@@ -324,8 +426,9 @@ export declare class GitRestClient extends RestClientBase {
      * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
      * @param includeContent - Set to true to include item content when requesting json.  Default is false.
      * @param resolveLfs - Set to true to resolve Git LFS pointer files to return actual content from Git LFS.  Default is false.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
      */
-    getItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean): Promise<string>;
+    getItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<string>;
     /**
      * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
      *
@@ -340,8 +443,9 @@ export declare class GitRestClient extends RestClientBase {
      * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
      * @param includeContent - Set to true to include item content when requesting json.  Default is false.
      * @param resolveLfs - Set to true to resolve Git LFS pointer files to return actual content from Git LFS.  Default is false.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
      */
-    getItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean): Promise<ArrayBuffer>;
+    getItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>;
     /**
      * Post for retrieving a creating a batch out of a set of items in a repo / project given a list of paths or a long path
      *
@@ -472,7 +576,7 @@ export declare class GitRestClient extends RestClientBase {
      * @param pullRequestId - ID of the pull request.
      * @param project - Project ID or project name
      */
-    getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<Git.GitCommitRef[]>;
+    getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<WebApi.PagedList<Git.GitCommitRef>>;
     /**
      * Retrieve one conflict for a pull request by ID
      *
@@ -485,14 +589,14 @@ export declare class GitRestClient extends RestClientBase {
     /**
      * Retrieve all conflicts for a pull request
      *
-     * @param repositoryId -
-     * @param pullRequestId -
+     * @param repositoryId - The repository of the Pull Request.
+     * @param pullRequestId - The pull request ID.
      * @param project - Project ID or project name
-     * @param skip -
-     * @param top -
-     * @param includeObsolete -
-     * @param excludeResolved -
-     * @param onlyResolved -
+     * @param skip - Conflicts to skip.
+     * @param top - Conflicts to return after skip.
+     * @param includeObsolete - Includes obsolete conflicts.
+     * @param excludeResolved - Excludes conflicts already resolved.
+     * @param onlyResolved - Returns only the conflicts that are resolved.
      */
     getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<Git.GitConflict[]>;
     /**
@@ -519,7 +623,7 @@ export declare class GitRestClient extends RestClientBase {
      *
      * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request.
-     * @param iterationId - ID of the pull request iteration. \<br /\> Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.
+     * @param iterationId - ID of the pull request iteration. \<br /\> Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch. Allowed values are between 1 and the maximum iteration on this pull request.
      * @param project - Project ID or project name
      * @param top - Optional. The number of changes to retrieve.  The default value is 100 and the maximum value is 2000.
      * @param skip - Optional. The number of changes to ignore.  For example, to retrieve changes 101-150, set top 50 and skip to 100.
@@ -661,7 +765,7 @@ export declare class GitRestClient extends RestClientBase {
      * Add a reviewer to a pull request or cast a vote.
      *
      * @param reviewer - Reviewer's vote.\<br /\>If the reviewer's ID is included here, it must match the reviewerID parameter.\<br /\>Reviewers can set their own vote with this method.  When adding other reviewers, vote must be set to zero.
-     * @param repositoryId - The repository ID of the pull request’s target branch.
+     * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request.
      * @param reviewerId - ID of the reviewer.
      * @param project - Project ID or project name
@@ -671,15 +775,24 @@ export declare class GitRestClient extends RestClientBase {
      * Add reviewers to a pull request.
      *
      * @param reviewers - Reviewers to add to the pull request.
-     * @param repositoryId - The repository ID of the pull request’s target branch.
+     * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request.
      * @param project - Project ID or project name
      */
     createPullRequestReviewers(reviewers: WebApi.IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<Git.IdentityRefWithVote[]>;
+    /**
+     * Add an unmaterialized identity to the reviewers of a pull request.
+     *
+     * @param reviewer - Reviewer to add to the pull request.
+     * @param repositoryId - The repository ID of the pull request's target branch.
+     * @param pullRequestId - ID of the pull request.
+     * @param project - Project ID or project name
+     */
+    createUnmaterializedPullRequestReviewer(reviewer: Git.IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<Git.IdentityRefWithVote>;
     /**
      * Remove a reviewer from a pull request.
      *
-     * @param repositoryId - The repository ID of the pull request’s target branch.
+     * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request.
      * @param reviewerId - ID of the reviewer to remove.
      * @param project - Project ID or project name
@@ -688,7 +801,7 @@ export declare class GitRestClient extends RestClientBase {
     /**
      * Retrieve information about a particular reviewer on a pull request
      *
-     * @param repositoryId - The repository ID of the pull request’s target branch.
+     * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request.
      * @param reviewerId - ID of the reviewer.
      * @param project - Project ID or project name
@@ -697,16 +810,16 @@ export declare class GitRestClient extends RestClientBase {
     /**
      * Retrieve the reviewers for a pull request
      *
-     * @param repositoryId - The repository ID of the pull request’s target branch.
+     * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request.
      * @param project - Project ID or project name
      */
     getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<Git.IdentityRefWithVote[]>;
     /**
-     * Edit a reviewer entry. These fields are patchable: isFlagged
+     * Edit a reviewer entry. These fields are patchable: isFlagged, hasDeclined
      *
      * @param reviewer - Reviewer data.\<br /\>If the reviewer's ID is included here, it must match the reviewerID parameter.
-     * @param repositoryId - The repository ID of the pull request’s target branch.
+     * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request.
      * @param reviewerId - ID of the reviewer.
      * @param project - Project ID or project name
@@ -716,7 +829,7 @@ export declare class GitRestClient extends RestClientBase {
      * Reset the votes of multiple reviewers on a pull request.  NOTE: This endpoint only supports updating votes, but does not support updating required reviewers (use policy) or display names.
      *
      * @param patchVotes - IDs of the reviewers whose votes will be reset to zero
-     * @param repositoryId - The repository ID of the pull request’s target branch.
+     * @param repositoryId - The repository ID of the pull request's target branch.
      * @param pullRequestId - ID of the pull request
      * @param project - Project ID or project name
      */
@@ -993,7 +1106,7 @@ export declare class GitRestClient extends RestClientBase {
      * @param peelTags - [optional] Annotated tags will populate the PeeledObjectId property. default is false.
      * @param filterContains - [optional] A filter to apply to the refs (contains).
      */
-    getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string): Promise<Git.GitRef[]>;
+    getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string): Promise<WebApi.PagedList<Git.GitRef>>;
     /**
      * Lock or Unlock a branch.
      *
@@ -1045,7 +1158,7 @@ export declare class GitRestClient extends RestClientBase {
     /**
      * Create a git repository in a team project.
      *
-     * @param gitRepositoryToCreate - Specify the repo name, team project and/or parent repository. Team project information can be ommitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
+     * @param gitRepositoryToCreate - Specify the repo name, team project and/or parent repository. Team project information can be omitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).
      * @param project - Project ID or project name
      * @param sourceRef - [optional] Specify the source refs to use while creating a fork repo
      */
@@ -1053,7 +1166,7 @@ export declare class GitRestClient extends RestClientBase {
     /**
      * Delete a git repository
      *
-     * @param repositoryId - The name or ID of the repository.
+     * @param repositoryId - The ID of the repository.
      * @param project - Project ID or project name
      */
     deleteRepository(repositoryId: string, project?: string): Promise<void>;
@@ -1085,10 +1198,51 @@ export declare class GitRestClient extends RestClientBase {
      * Updates the Git repository with either a new repo name or a new default branch.
      *
      * @param newRepositoryInfo - Specify a new repo name or a new default branch of the repository
-     * @param repositoryId - The name or ID of the repository.
+     * @param repositoryId - The ID of the repository.
      * @param project - Project ID or project name
      */
     updateRepository(newRepositoryInfo: Git.GitRepository, repositoryId: string, project?: string): Promise<Git.GitRepository>;
+    /**
+     * Retrieve one conflict for a revert by ID
+     *
+     * @param repositoryId -
+     * @param revertId -
+     * @param conflictId -
+     * @param project - Project ID or project name
+     */
+    getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<Git.GitConflict>;
+    /**
+     * Retrieve all conflicts for a revert
+     *
+     * @param repositoryId -
+     * @param revertId -
+     * @param project - Project ID or project name
+     * @param continuationToken -
+     * @param top -
+     * @param excludeResolved -
+     * @param onlyResolved -
+     * @param includeObsolete -
+     */
+    getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<WebApi.PagedList<Git.GitConflict>>;
+    /**
+     * Update merge conflict resolution
+     *
+     * @param conflict -
+     * @param repositoryId -
+     * @param revertId -
+     * @param conflictId -
+     * @param project - Project ID or project name
+     */
+    updateRevertConflict(conflict: Git.GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<Git.GitConflict>;
+    /**
+     * Update multiple merge conflict resolutions
+     *
+     * @param conflictUpdates -
+     * @param repositoryId -
+     * @param revertId -
+     * @param project - Project ID or project name
+     */
+    updateRevertConflicts(conflictUpdates: Git.GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<Git.GitConflictUpdateResult[]>;
     /**
      * Starts the operation to create a new branch which reverts changes introduced by either a specific commit or commits that are associated to a pull request.
      *