azure-devops-extension-api 4.270.0 → 5.272.0

package/FileContainer/FileContainer.d.ts

@@ -1,193 +1,193 @@
-/**
- * Compression type for file stored in Blobstore
- */
-export declare enum BlobCompressionType {
-    None = 0,
-    GZip = 1
-}
-/**
- * Represents an reference to a file in Blobstore
- */
-export interface ContainerItemBlobReference {
-    artifactHash: string;
-    artifactId: number;
-    compressionType: BlobCompressionType;
-    scopeIdentifier: string;
-    sessionId: string;
-}
-/**
- * Status of a container item.
- */
-export declare enum ContainerItemStatus {
-    /**
-     * Item is created.
-     */
-    Created = 1,
-    /**
-     * Item is a file pending for upload.
-     */
-    PendingUpload = 2
-}
-/**
- * Type of a container item.
- */
-export declare enum ContainerItemType {
-    /**
-     * Any item type.
-     */
-    Any = 0,
-    /**
-     * Item is a folder which can have child items.
-     */
-    Folder = 1,
-    /**
-     * Item is a file which is stored in the file service.
-     */
-    File = 2
-}
-/**
- * Options a container can have.
- */
-export declare enum ContainerOptions {
-    /**
-     * No option.
-     */
-    None = 0
-}
-/**
- * Represents a container that encapsulates a hierarchical file system.
- */
-export interface FileContainer {
-    /**
-     * Uri of the artifact associated with the container.
-     */
-    artifactUri: string;
-    /**
-     * Download Url for the content of this item.
-     */
-    contentLocation: string;
-    /**
-     * Owner.
-     */
-    createdBy: string;
-    /**
-     * Creation date.
-     */
-    dateCreated: Date;
-    /**
-     * Description.
-     */
-    description: string;
-    /**
-     * Id.
-     */
-    id: number;
-    /**
-     * Location of the item resource.
-     */
-    itemLocation: string;
-    /**
-     * ItemStore Locator for this container.
-     */
-    locatorPath: string;
-    /**
-     * Name.
-     */
-    name: string;
-    /**
-     * Options the container can have.
-     */
-    options: ContainerOptions;
-    /**
-     * Project Id.
-     */
-    scopeIdentifier: string;
-    /**
-     * Security token of the artifact associated with the container.
-     */
-    securityToken: string;
-    /**
-     * Identifier of the optional encryption key.
-     */
-    signingKeyId: string;
-    /**
-     * Total size of the files in bytes.
-     */
-    size: number;
-}
-/**
- * Represents an item in a container.
- */
-export interface FileContainerItem {
-    /**
-     * Id for Blobstore reference
-     */
-    artifactId: number;
-    blobMetadata: ContainerItemBlobReference;
-    /**
-     * Container Id.
-     */
-    containerId: number;
-    contentId: number[];
-    /**
-     * Download Url for the content of this item.
-     */
-    contentLocation: string;
-    /**
-     * Creator.
-     */
-    createdBy: string;
-    /**
-     * Creation date.
-     */
-    dateCreated: Date;
-    /**
-     * Last modified date.
-     */
-    dateLastModified: Date;
-    /**
-     * Encoding of the file. Zero if not a file.
-     */
-    fileEncoding: number;
-    /**
-     * Hash value of the file. Null if not a file.
-     */
-    fileHash: number[];
-    /**
-     * Id of the file content.
-     */
-    fileId: number;
-    /**
-     * Length of the file. Zero if not of a file.
-     */
-    fileLength: number;
-    /**
-     * Type of the file. Zero if not a file.
-     */
-    fileType: number;
-    /**
-     * Location of the item resource.
-     */
-    itemLocation: string;
-    /**
-     * Type of the item: Folder, File or String.
-     */
-    itemType: ContainerItemType;
-    /**
-     * Modifier.
-     */
-    lastModifiedBy: string;
-    /**
-     * Unique path that identifies the item.
-     */
-    path: string;
-    /**
-     * Project Id.
-     */
-    scopeIdentifier: string;
-    /**
-     * Status of the item: Created or Pending Upload.
-     */
-    status: ContainerItemStatus;
-    ticket: string;
-}
+/**
+ * Compression type for file stored in Blobstore
+ */
+export declare enum BlobCompressionType {
+    None = 0,
+    GZip = 1
+}
+/**
+ * Represents an reference to a file in Blobstore
+ */
+export interface ContainerItemBlobReference {
+    artifactHash: string;
+    artifactId: number;
+    compressionType: BlobCompressionType;
+    scopeIdentifier: string;
+    sessionId: string;
+}
+/**
+ * Status of a container item.
+ */
+export declare enum ContainerItemStatus {
+    /**
+     * Item is created.
+     */
+    Created = 1,
+    /**
+     * Item is a file pending for upload.
+     */
+    PendingUpload = 2
+}
+/**
+ * Type of a container item.
+ */
+export declare enum ContainerItemType {
+    /**
+     * Any item type.
+     */
+    Any = 0,
+    /**
+     * Item is a folder which can have child items.
+     */
+    Folder = 1,
+    /**
+     * Item is a file which is stored in the file service.
+     */
+    File = 2
+}
+/**
+ * Options a container can have.
+ */
+export declare enum ContainerOptions {
+    /**
+     * No option.
+     */
+    None = 0
+}
+/**
+ * Represents a container that encapsulates a hierarchical file system.
+ */
+export interface FileContainer {
+    /**
+     * Uri of the artifact associated with the container.
+     */
+    artifactUri: string;
+    /**
+     * Download Url for the content of this item.
+     */
+    contentLocation: string;
+    /**
+     * Owner.
+     */
+    createdBy: string;
+    /**
+     * Creation date.
+     */
+    dateCreated: Date;
+    /**
+     * Description.
+     */
+    description: string;
+    /**
+     * Id.
+     */
+    id: number;
+    /**
+     * Location of the item resource.
+     */
+    itemLocation: string;
+    /**
+     * ItemStore Locator for this container.
+     */
+    locatorPath: string;
+    /**
+     * Name.
+     */
+    name: string;
+    /**
+     * Options the container can have.
+     */
+    options: ContainerOptions;
+    /**
+     * Project Id.
+     */
+    scopeIdentifier: string;
+    /**
+     * Security token of the artifact associated with the container.
+     */
+    securityToken: string;
+    /**
+     * Identifier of the optional encryption key.
+     */
+    signingKeyId: string;
+    /**
+     * Total size of the files in bytes.
+     */
+    size: number;
+}
+/**
+ * Represents an item in a container.
+ */
+export interface FileContainerItem {
+    /**
+     * Id for Blobstore reference
+     */
+    artifactId: number;
+    blobMetadata: ContainerItemBlobReference;
+    /**
+     * Container Id.
+     */
+    containerId: number;
+    contentId: number[];
+    /**
+     * Download Url for the content of this item.
+     */
+    contentLocation: string;
+    /**
+     * Creator.
+     */
+    createdBy: string;
+    /**
+     * Creation date.
+     */
+    dateCreated: Date;
+    /**
+     * Last modified date.
+     */
+    dateLastModified: Date;
+    /**
+     * Encoding of the file. Zero if not a file.
+     */
+    fileEncoding: number;
+    /**
+     * Hash value of the file. Null if not a file.
+     */
+    fileHash: number[];
+    /**
+     * Id of the file content.
+     */
+    fileId: number;
+    /**
+     * Length of the file. Zero if not of a file.
+     */
+    fileLength: number;
+    /**
+     * Type of the file. Zero if not a file.
+     */
+    fileType: number;
+    /**
+     * Location of the item resource.
+     */
+    itemLocation: string;
+    /**
+     * Type of the item: Folder, File or String.
+     */
+    itemType: ContainerItemType;
+    /**
+     * Modifier.
+     */
+    lastModifiedBy: string;
+    /**
+     * Unique path that identifies the item.
+     */
+    path: string;
+    /**
+     * Project Id.
+     */
+    scopeIdentifier: string;
+    /**
+     * Status of the item: Created or Pending Upload.
+     */
+    status: ContainerItemStatus;
+    ticket: string;
+}

package/FileContainer/FileContainer.js

@@ -1,59 +1,58 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-define(["require", "exports"], function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    /**
-     * Compression type for file stored in Blobstore
-     */
-    var BlobCompressionType;
-    (function (BlobCompressionType) {
-        BlobCompressionType[BlobCompressionType["None"] = 0] = "None";
-        BlobCompressionType[BlobCompressionType["GZip"] = 1] = "GZip";
-    })(BlobCompressionType = exports.BlobCompressionType || (exports.BlobCompressionType = {}));
-    /**
-     * Status of a container item.
-     */
-    var ContainerItemStatus;
-    (function (ContainerItemStatus) {
-        /**
-         * Item is created.
-         */
-        ContainerItemStatus[ContainerItemStatus["Created"] = 1] = "Created";
-        /**
-         * Item is a file pending for upload.
-         */
-        ContainerItemStatus[ContainerItemStatus["PendingUpload"] = 2] = "PendingUpload";
-    })(ContainerItemStatus = exports.ContainerItemStatus || (exports.ContainerItemStatus = {}));
-    /**
-     * Type of a container item.
-     */
-    var ContainerItemType;
-    (function (ContainerItemType) {
-        /**
-         * Any item type.
-         */
-        ContainerItemType[ContainerItemType["Any"] = 0] = "Any";
-        /**
-         * Item is a folder which can have child items.
-         */
-        ContainerItemType[ContainerItemType["Folder"] = 1] = "Folder";
-        /**
-         * Item is a file which is stored in the file service.
-         */
-        ContainerItemType[ContainerItemType["File"] = 2] = "File";
-    })(ContainerItemType = exports.ContainerItemType || (exports.ContainerItemType = {}));
-    /**
-     * Options a container can have.
-     */
-    var ContainerOptions;
-    (function (ContainerOptions) {
-        /**
-         * No option.
-         */
-        ContainerOptions[ContainerOptions["None"] = 0] = "None";
-    })(ContainerOptions = exports.ContainerOptions || (exports.ContainerOptions = {}));
-});
+"use strict";
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContainerOptions = exports.ContainerItemType = exports.ContainerItemStatus = exports.BlobCompressionType = void 0;
+/**
+ * Compression type for file stored in Blobstore
+ */
+var BlobCompressionType;
+(function (BlobCompressionType) {
+    BlobCompressionType[BlobCompressionType["None"] = 0] = "None";
+    BlobCompressionType[BlobCompressionType["GZip"] = 1] = "GZip";
+})(BlobCompressionType || (exports.BlobCompressionType = BlobCompressionType = {}));
+/**
+ * Status of a container item.
+ */
+var ContainerItemStatus;
+(function (ContainerItemStatus) {
+    /**
+     * Item is created.
+     */
+    ContainerItemStatus[ContainerItemStatus["Created"] = 1] = "Created";
+    /**
+     * Item is a file pending for upload.
+     */
+    ContainerItemStatus[ContainerItemStatus["PendingUpload"] = 2] = "PendingUpload";
+})(ContainerItemStatus || (exports.ContainerItemStatus = ContainerItemStatus = {}));
+/**
+ * Type of a container item.
+ */
+var ContainerItemType;
+(function (ContainerItemType) {
+    /**
+     * Any item type.
+     */
+    ContainerItemType[ContainerItemType["Any"] = 0] = "Any";
+    /**
+     * Item is a folder which can have child items.
+     */
+    ContainerItemType[ContainerItemType["Folder"] = 1] = "Folder";
+    /**
+     * Item is a file which is stored in the file service.
+     */
+    ContainerItemType[ContainerItemType["File"] = 2] = "File";
+})(ContainerItemType || (exports.ContainerItemType = ContainerItemType = {}));
+/**
+ * Options a container can have.
+ */
+var ContainerOptions;
+(function (ContainerOptions) {
+    /**
+     * No option.
+     */
+    ContainerOptions[ContainerOptions["None"] = 0] = "None";
+})(ContainerOptions || (exports.ContainerOptions = ContainerOptions = {}));

package/FileContainer/FileContainer.min.js

@@ -1 +1 @@
-define(["require","exports"],function(e,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0});!function(e){e[e.None=0]="None",e[e.GZip=1]="GZip"}(n.BlobCompressionType||(n.BlobCompressionType={}));!function(e){e[e.Created=1]="Created",e[e.PendingUpload=2]="PendingUpload"}(n.ContainerItemStatus||(n.ContainerItemStatus={}));!function(e){e[e.Any=0]="Any",e[e.Folder=1]="Folder",e[e.File=2]="File"}(n.ContainerItemType||(n.ContainerItemType={}));!function(e){e[e.None=0]="None"}(n.ContainerOptions||(n.ContainerOptions={}))});
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ContainerOptions=exports.ContainerItemType=exports.ContainerItemStatus=exports.BlobCompressionType=void 0;var BlobCompressionType;!function(e){e[e.None=0]="None",e[e.GZip=1]="GZip"}(BlobCompressionType||(exports.BlobCompressionType=BlobCompressionType={}));var ContainerItemStatus;!function(e){e[e.Created=1]="Created",e[e.PendingUpload=2]="PendingUpload"}(ContainerItemStatus||(exports.ContainerItemStatus=ContainerItemStatus={}));var ContainerItemType;!function(e){e[e.Any=0]="Any",e[e.Folder=1]="Folder",e[e.File=2]="File"}(ContainerItemType||(exports.ContainerItemType=ContainerItemType={}));var ContainerOptions;!function(e){e[e.None=0]="None"}(ContainerOptions||(exports.ContainerOptions=ContainerOptions={}));

package/FileContainer/FileContainerClient.d.ts

@@ -1,47 +1,47 @@
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-import * as FileContainer from "../FileContainer/FileContainer";
-import * as WebApi from "../WebApi/WebApi";
-export declare class FileContainerRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions);
-    /**
-     * Creates the specified items in the referenced container.
-     *
-     * @param items -
-     * @param containerId -
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     */
-    createItems(items: WebApi.VssJsonCollectionWrapperV<FileContainer.FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainer.FileContainerItem[]>;
-    /**
-     * Deletes the specified items in a container.
-     *
-     * @param containerId - Container Id.
-     * @param itemPath - Path to delete.
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     */
-    deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>;
-    /**
-     * Gets containers filtered by a comma separated list of artifact uris within the same scope, if not specified returns all containers
-     *
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     * @param artifactUris -
-     */
-    getContainers(scope?: string, artifactUris?: string): Promise<FileContainer.FileContainer[]>;
-    /**
-     * Gets the specified file container object in a format dependent upon the given parameters or HTTP Accept request header
-     *
-     * @param containerId - The requested container Id
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     * @param itemPath - The path to the item of interest
-     * @param metadata - If true, this overrides any specified format parameter or HTTP Accept request header to provide non-recursive information for the given itemPath
-     * @param format - If specified, this overrides the HTTP Accept request header to return either 'json' or 'zip'.  If $format is specified, then api-version should also be specified as a query parameter.
-     * @param downloadFileName - If specified and returning other than JSON format, then this download name will be used (else defaults to itemPath)
-     * @param includeDownloadTickets -
-     * @param isShallow - If true, returns only immediate children(files & folders) for the given itemPath. False will return all items recursively within itemPath.
-     * @param ignoreRequestedMediaType - Set to true to ignore the HTTP Accept request header. Default is false.
-     * @param includeBlobMetadata -
-     * @param saveAbsolutePath - Set to false to not save the absolute path to the specified directory of the artifact in the returned archive. Works only for artifact directories. Default is true.
-     * @param preferRedirect - Set to true to get the redirect response which leads to the stream with content. Default is false.
-     */
-    getItems(containerId: number, scope?: string, itemPath?: string, metadata?: boolean, format?: string, downloadFileName?: string, includeDownloadTickets?: boolean, isShallow?: boolean, ignoreRequestedMediaType?: boolean, includeBlobMetadata?: boolean, saveAbsolutePath?: boolean, preferRedirect?: boolean): Promise<FileContainer.FileContainerItem[]>;
-}
+import { IVssRestClientOptions } from "../Common/Context";
+import { RestClientBase } from "../Common/RestClientBase";
+import * as FileContainer from "../FileContainer/FileContainer";
+import * as WebApi from "../WebApi/WebApi";
+export declare class FileContainerRestClient extends RestClientBase {
+    constructor(options: IVssRestClientOptions);
+    /**
+     * Creates the specified items in the referenced container.
+     *
+     * @param items -
+     * @param containerId -
+     * @param scope - A guid representing the scope of the container. This is often the project id.
+     */
+    createItems(items: WebApi.VssJsonCollectionWrapperV<FileContainer.FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainer.FileContainerItem[]>;
+    /**
+     * Deletes the specified items in a container.
+     *
+     * @param containerId - Container Id.
+     * @param itemPath - Path to delete.
+     * @param scope - A guid representing the scope of the container. This is often the project id.
+     */
+    deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>;
+    /**
+     * Gets containers filtered by a comma separated list of artifact uris within the same scope, if not specified returns all containers
+     *
+     * @param scope - A guid representing the scope of the container. This is often the project id.
+     * @param artifactUris -
+     */
+    getContainers(scope?: string, artifactUris?: string): Promise<FileContainer.FileContainer[]>;
+    /**
+     * Gets the specified file container object in a format dependent upon the given parameters or HTTP Accept request header
+     *
+     * @param containerId - The requested container Id
+     * @param scope - A guid representing the scope of the container. This is often the project id.
+     * @param itemPath - The path to the item of interest
+     * @param metadata - If true, this overrides any specified format parameter or HTTP Accept request header to provide non-recursive information for the given itemPath
+     * @param format - If specified, this overrides the HTTP Accept request header to return either 'json' or 'zip'.  If $format is specified, then api-version should also be specified as a query parameter.
+     * @param downloadFileName - If specified and returning other than JSON format, then this download name will be used (else defaults to itemPath)
+     * @param includeDownloadTickets -
+     * @param isShallow - If true, returns only immediate children(files & folders) for the given itemPath. False will return all items recursively within itemPath.
+     * @param ignoreRequestedMediaType - Set to true to ignore the HTTP Accept request header. Default is false.
+     * @param includeBlobMetadata -
+     * @param saveAbsolutePath - Set to false to not save the absolute path to the specified directory of the artifact in the returned archive. Works only for artifact directories. Default is true.
+     * @param preferRedirect - Set to true to get the redirect response which leads to the stream with content. Default is false.
+     */
+    getItems(containerId: number, scope?: string, itemPath?: string, metadata?: boolean, format?: string, downloadFileName?: string, includeDownloadTickets?: boolean, isShallow?: boolean, ignoreRequestedMediaType?: boolean, includeBlobMetadata?: boolean, saveAbsolutePath?: boolean, preferRedirect?: boolean): Promise<FileContainer.FileContainerItem[]>;
+}