Update typings to M141.
This commit is contained in:
Trevor Gau
Родитель
5e19f91dc1
Коммит
d0ac443fc8
|
|
@ -14,7 +14,7 @@
|
|||
"resolved": "https://registry.npmjs.org/@types/jqueryui/-/jqueryui-1.12.1.tgz",
|
||||
"integrity": "sha512-aLMCZSEsZJqnE6K1wcTsMojH/MZRaYkoiWbr/NauE96LP3+BzR8ki29wWYkVOunolb95a7hotCtTgzeoTPqb6A==",
|
||||
"requires": {
|
||||
"@types/jquery": "3.3.0"
|
||||
"@types/jquery": "*"
|
||||
}
|
||||
},
|
||||
"@types/knockout": {
|
||||
|
|
@ -28,7 +28,8 @@
|
|||
"integrity": "sha1-IrM42cS839j4HDBoSu/rBKRycWg="
|
||||
},
|
||||
"@types/q": {
|
||||
"version": "https://registry.npmjs.org/@types/q/-/q-0.0.32.tgz",
|
||||
"version": "0.0.32",
|
||||
"resolved": "http://registry.npmjs.org/@types/q/-/q-0.0.32.tgz",
|
||||
"integrity": "sha1-vShOV8hPEyXacCur/IKlMoGQwMU="
|
||||
},
|
||||
"@types/react": {
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@
|
|||
"es6",
|
||||
"dom"
|
||||
],
|
||||
"skipLibCheck": true,
|
||||
"types": []
|
||||
},
|
||||
"include": [
|
||||
|
|
|
|||
|
|
@ -98,8 +98,8 @@ declare module XDM {
|
|||
* @param contextData Optional context data to pass to a registered object's factory method
|
||||
*/
|
||||
getRemoteObjectProxy<T>(instanceId: string, contextData?: Object): IPromise<T>;
|
||||
private invokeMethod(registeredInstance, rpcMessage);
|
||||
private getRegisteredObject(instanceId, instanceContext?);
|
||||
private invokeMethod;
|
||||
private getRegisteredObject;
|
||||
/**
|
||||
* Handle a received message on this channel. Dispatch to the appropriate object found via object registry
|
||||
*
|
||||
|
|
@ -110,13 +110,13 @@ declare module XDM {
|
|||
onMessage(data: any, origin: string): boolean;
|
||||
owns(source: Window, origin: string, data: any): boolean;
|
||||
error(data: any, errorObj: any): void;
|
||||
private _error(messageObj, errorObj, handshakeToken);
|
||||
private _success(messageObj, result, handshakeToken);
|
||||
private _sendRpcMessage(message);
|
||||
private _shouldSkipSerialization(obj);
|
||||
private _customSerializeObject(obj, settings, parentObjects?, nextCircularRefId?, depth?);
|
||||
private _registerProxyFunction(func, context);
|
||||
private _customDeserializeObject(obj, circularRefs?);
|
||||
private _error;
|
||||
private _success;
|
||||
private _sendRpcMessage;
|
||||
private _shouldSkipSerialization;
|
||||
private _customSerializeObject;
|
||||
private _registerProxyFunction;
|
||||
private _customDeserializeObject;
|
||||
}
|
||||
/**
|
||||
* Registry of XDM channels kept per target frame/window
|
||||
|
|
@ -134,8 +134,8 @@ declare module XDM {
|
|||
*/
|
||||
addChannel(window: Window, targetOrigin?: string): IXDMChannel;
|
||||
removeChannel(channel: IXDMChannel): void;
|
||||
private _handleMessageReceived(event);
|
||||
private _subscribe(windowObj);
|
||||
private _handleMessageReceived;
|
||||
private _subscribe;
|
||||
}
|
||||
}
|
||||
declare module VSS {
|
||||
|
|
@ -267,4 +267,8 @@ declare module VSS {
|
|||
* @param height Optional height, defaults to scrollHeight
|
||||
*/
|
||||
function resize(width?: number, height?: number): void;
|
||||
/**
|
||||
* Applies theme variables to the current document
|
||||
*/
|
||||
function applyTheme(themeData: any): void;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
// Type definitions for Microsoft Visual Studio Services v134.20180525.1751
|
||||
// Type definitions for Microsoft Visual Studio Services v141.20180928.1725
|
||||
// Project: https://www.visualstudio.com/integrate/extensions/overview
|
||||
// Definitions by: Microsoft <vsointegration@microsoft.com>
|
||||
|
||||
|
|
@ -171,7 +171,7 @@ export interface TooltipStyleType {
|
|||
}
|
||||
export enum TooltipLineItemMarkerType {
|
||||
Bar = 0,
|
||||
Square = 1,
|
||||
Square = 1
|
||||
}
|
||||
/** Chart options for use only when rendering a pie chart */
|
||||
export interface PieChartOptions {
|
||||
|
|
@ -339,7 +339,7 @@ export interface ChartOptions {
|
|||
suppressAnimation?: boolean;
|
||||
/** Handler for click on chart series content. */
|
||||
click?: (clickEvent: ClickEvent) => void;
|
||||
/**Handler for chart legend click event. Can return false to supress default behavior.*/
|
||||
/** Handler for chart legend click event. Can return false to supress default behavior.*/
|
||||
legendClick?: (clickEvent: LegendClickEvent) => boolean;
|
||||
/** Options for configuring the legend. Notably, visibility and placement */
|
||||
legend?: LegendOptions;
|
||||
|
|
@ -354,8 +354,8 @@ export interface ChartOptions {
|
|||
showAccessibleForm?: boolean;
|
||||
/**Container for passing type-specific chart options. */
|
||||
specializedOptions?: PieChartOptions | LineChartOptions | HybridChartOptions | AreaChartOptions | FunnelChartOptions;
|
||||
/**Title of the chart. This helps in distinguishing if there are multiple charts on the same page.
|
||||
Used for describing the chart in accessible rendering mode. */
|
||||
/** Title of the chart. This helps in distinguishing if there are multiple charts on the same page.
|
||||
Used for describing the chart in accessible rendering mode and in the aria-label of the chart container. */
|
||||
title?: string;
|
||||
}
|
||||
export interface CommonChartOptions extends ChartOptions {
|
||||
|
|
|
|||
|
|
@ -1,23 +1,11 @@
|
|||
// Type definitions for Microsoft Visual Studio Services v134.20180525.1750
|
||||
// Type definitions for Microsoft Visual Studio Services v121.20170727.2106
|
||||
// Project: https://www.visualstudio.com/integrate/extensions/overview
|
||||
// Definitions by: Microsoft <vsointegration@microsoft.com>
|
||||
|
||||
/// <reference types='knockout' />
|
||||
/// <reference types='jquery' />
|
||||
/// <reference types='jqueryui' />
|
||||
/// <reference types='q' />
|
||||
/// <reference types='requirejs' />
|
||||
/// <reference types='react' />
|
||||
/// <reference types='mousetrap' />
|
||||
/// <reference path='vss.d.ts' />
|
||||
declare module "Notifications/Contracts" {
|
||||
import VSS_Common_Contracts = require("VSS/WebApi/Contracts");
|
||||
import VSS_FormInput_Contracts = require("VSS/Common/Contracts/FormInput");
|
||||
export interface ActorFilter extends RoleBasedFilter {
|
||||
}
|
||||
export interface ActorNotificationReason extends NotificationReason {
|
||||
matchedRoles: string[];
|
||||
}
|
||||
export interface ArtifactFilter extends BaseSubscriptionFilter {
|
||||
artifactId: string;
|
||||
artifactType: string;
|
||||
|
|
@ -32,40 +20,6 @@ export interface BatchNotificationOperation {
|
|||
notificationOperation: NotificationOperation;
|
||||
notificationQueryConditions: NotificationQueryCondition[];
|
||||
}
|
||||
export interface BlockFilter extends RoleBasedFilter {
|
||||
}
|
||||
export interface BlockSubscriptionChannel {
|
||||
type: string;
|
||||
}
|
||||
export interface DiagnosticIdentity {
|
||||
displayName: string;
|
||||
emailAddress: string;
|
||||
id: string;
|
||||
}
|
||||
export interface DiagnosticNotification {
|
||||
eventId: number;
|
||||
eventType: string;
|
||||
id: number;
|
||||
messages: NotificationDiagnosticLogMessage[];
|
||||
recipients: {
|
||||
[key: string]: DiagnosticRecipient;
|
||||
};
|
||||
result: string;
|
||||
stats: {
|
||||
[key: string]: number;
|
||||
};
|
||||
subscriptionId: string;
|
||||
}
|
||||
export interface DiagnosticRecipient {
|
||||
recipient: DiagnosticIdentity;
|
||||
status: string;
|
||||
}
|
||||
export interface EmailHtmlSubscriptionChannel extends SubscriptionChannelWithAddress {
|
||||
type: string;
|
||||
}
|
||||
export interface EmailPlaintextSubscriptionChannel extends SubscriptionChannelWithAddress {
|
||||
type: string;
|
||||
}
|
||||
/**
|
||||
* Describes the subscription evaluation operation status.
|
||||
*/
|
||||
|
|
@ -103,44 +57,6 @@ export enum EvaluationOperationStatus {
|
|||
*/
|
||||
NotFound = 7,
|
||||
}
|
||||
export interface EventBacklogStatus {
|
||||
maxUnprocessedEventAgeMs: number;
|
||||
publisher: string;
|
||||
timeSinceLastProcessedEventMs: number;
|
||||
unprocessedEvents: number;
|
||||
}
|
||||
export interface EventBatch {
|
||||
endTime: any;
|
||||
eventCounts: {
|
||||
[key: string]: number;
|
||||
};
|
||||
eventIds: string;
|
||||
notificationCounts: {
|
||||
[key: string]: number;
|
||||
};
|
||||
preProcessEndTime: any;
|
||||
preProcessStartTime: any;
|
||||
processEndTime: any;
|
||||
processStartTime: any;
|
||||
startTime: any;
|
||||
subscriptionCounts: {
|
||||
[key: string]: number;
|
||||
};
|
||||
}
|
||||
export interface EventProcessingLog extends NotificationJobDiagnosticLog {
|
||||
batches: EventBatch[];
|
||||
matcherResults: MatcherResult[];
|
||||
}
|
||||
/**
|
||||
* Set of flags used to determine which set of information is retrieved when querying for event publishers
|
||||
*/
|
||||
export enum EventPublisherQueryFlags {
|
||||
None = 0,
|
||||
/**
|
||||
* Include event types from the remote services too
|
||||
*/
|
||||
IncludeRemoteServices = 2,
|
||||
}
|
||||
/**
|
||||
* Encapsulates events result properties. It defines the total number of events used and the number of matched events.
|
||||
*/
|
||||
|
|
@ -154,52 +70,6 @@ export interface EventsEvaluationResult {
|
|||
*/
|
||||
matchedCount: number;
|
||||
}
|
||||
/**
|
||||
* A transform request specify the properties of a notification event to be transformed.
|
||||
*/
|
||||
export interface EventTransformRequest {
|
||||
/**
|
||||
* Event payload.
|
||||
*/
|
||||
eventPayload: string;
|
||||
/**
|
||||
* Event type.
|
||||
*/
|
||||
eventType: string;
|
||||
}
|
||||
/**
|
||||
* Result of transforming a notification event.
|
||||
*/
|
||||
export interface EventTransformResult {
|
||||
/**
|
||||
* Transformed html content.
|
||||
*/
|
||||
content: string;
|
||||
/**
|
||||
* Calculated data.
|
||||
*/
|
||||
data: any;
|
||||
/**
|
||||
* Calculated system inputs.
|
||||
*/
|
||||
systemInputs: {
|
||||
[key: string]: string;
|
||||
};
|
||||
}
|
||||
/**
|
||||
* Set of flags used to determine which set of information is retrieved when querying for eventtypes
|
||||
*/
|
||||
export enum EventTypeQueryFlags {
|
||||
None = 0,
|
||||
/**
|
||||
* IncludeFields will include all fields and their types
|
||||
*/
|
||||
IncludeFields = 1,
|
||||
}
|
||||
export interface ExpressionFilter extends BaseSubscriptionFilter {
|
||||
criteria: ExpressionFilterModel;
|
||||
type: string;
|
||||
}
|
||||
/**
|
||||
* Subscription Filter Clause represents a single clause in a subscription filter e.g. If the subscription has the following criteria "Project Name = [Current Project] AND Assigned To = [Me] it will be represented as two Filter Clauses Clause 1: Index = 1, Logical Operator: NULL , FieldName = 'Project Name', Operator = '=', Value = '[Current Project]' Clause 2: Index = 2, Logical Operator: 'AND' , FieldName = 'Assigned To' , Operator = '=', Value = '[Me]'
|
||||
*/
|
||||
|
|
@ -254,28 +124,6 @@ export interface FieldValuesQuery extends VSS_FormInput_Contracts.InputValuesQue
|
|||
inputValues: FieldInputValues[];
|
||||
scope: string;
|
||||
}
|
||||
export interface GeneratedNotification {
|
||||
recipients: DiagnosticIdentity[];
|
||||
}
|
||||
export interface GroupSubscriptionChannel extends SubscriptionChannelWithAddress {
|
||||
type: string;
|
||||
}
|
||||
/**
|
||||
* Abstraction interface for the diagnostic log. Primarily for deserialization.
|
||||
*/
|
||||
export interface INotificationDiagnosticLog {
|
||||
activityId: string;
|
||||
description: string;
|
||||
endTime: Date;
|
||||
id: string;
|
||||
logType: string;
|
||||
messages: NotificationDiagnosticLogMessage[];
|
||||
properties: {
|
||||
[key: string]: string;
|
||||
};
|
||||
source: string;
|
||||
startTime: Date;
|
||||
}
|
||||
export interface ISubscriptionChannel {
|
||||
type: string;
|
||||
}
|
||||
|
|
@ -283,49 +131,11 @@ export interface ISubscriptionFilter {
|
|||
eventType: string;
|
||||
type: string;
|
||||
}
|
||||
export interface MatcherResult {
|
||||
matcher: string;
|
||||
stats: {
|
||||
[key: string]: {
|
||||
[key: string]: number;
|
||||
};
|
||||
};
|
||||
}
|
||||
export interface MessageQueueSubscriptionChannel {
|
||||
type: string;
|
||||
}
|
||||
export interface NotificationAdminSettings {
|
||||
/**
|
||||
* The default group delivery preference for groups in this collection
|
||||
*/
|
||||
defaultGroupDeliveryPreference: NotificationSubscriberDeliveryPreference;
|
||||
}
|
||||
export interface NotificationAdminSettingsUpdateParameters {
|
||||
defaultGroupDeliveryPreference: NotificationSubscriberDeliveryPreference;
|
||||
}
|
||||
export interface NotificationBacklogStatus {
|
||||
channel: string;
|
||||
maxUnprocessedNotificationAgeMs: number;
|
||||
publisher: string;
|
||||
timeSinceLastProcessedNotificationMs: number;
|
||||
unprocessedNotifications: number;
|
||||
}
|
||||
export interface NotificationBatch {
|
||||
endTime: any;
|
||||
notificationCount: number;
|
||||
notificationIds: string;
|
||||
problematicNotifications: DiagnosticNotification[];
|
||||
startTime: any;
|
||||
}
|
||||
export interface NotificationCommonViewData {
|
||||
/**
|
||||
* The Url to the admin page
|
||||
*/
|
||||
adminPageUrl: string;
|
||||
/**
|
||||
* Admin notification settings
|
||||
*/
|
||||
adminSettings: NotificationAdminSettings;
|
||||
/**
|
||||
* Default service instance type, currently it is Tfs, it used if there is no publisher passed
|
||||
*/
|
||||
|
|
@ -358,48 +168,6 @@ export interface NotificationCommonViewData {
|
|||
*/
|
||||
subscriberIdentity: VSS_Common_Contracts.IdentityRef;
|
||||
}
|
||||
export interface NotificationDeliveryLog extends NotificationJobDiagnosticLog {
|
||||
batches: NotificationBatch[];
|
||||
}
|
||||
/**
|
||||
* Abstract base class for all of the diagnostic logs.
|
||||
*/
|
||||
export interface NotificationDiagnosticLog {
|
||||
/**
|
||||
* Identifier used for correlating to other diagnostics that may have been recorded elsewhere.
|
||||
*/
|
||||
activityId: string;
|
||||
description: string;
|
||||
endTime: Date;
|
||||
errors: number;
|
||||
/**
|
||||
* Unique instance identifier.
|
||||
*/
|
||||
id: string;
|
||||
logType: string;
|
||||
messages: NotificationDiagnosticLogMessage[];
|
||||
properties: {
|
||||
[key: string]: string;
|
||||
};
|
||||
/**
|
||||
* This identifier depends on the logType. For notification jobs, this will be the job Id. For subscription tracing, this will be a special root Guid with the subscription Id encoded.
|
||||
*/
|
||||
source: string;
|
||||
startTime: Date;
|
||||
warnings: number;
|
||||
}
|
||||
export interface NotificationDiagnosticLogMessage {
|
||||
/**
|
||||
* Corresponds to .Net TraceLevel enumeration
|
||||
*/
|
||||
level: number;
|
||||
message: string;
|
||||
time: any;
|
||||
}
|
||||
export interface NotificationEventBacklogStatus {
|
||||
eventBacklogStatus: EventBacklogStatus[];
|
||||
notificationBacklogStatus: NotificationBacklogStatus[];
|
||||
}
|
||||
/**
|
||||
* Encapsulates the properties of a filterable field. A filterable field is a field in an event that can used to filter notifications for a certain event type.
|
||||
*/
|
||||
|
|
@ -532,14 +300,6 @@ export interface NotificationEventTypeCategory {
|
|||
*/
|
||||
name: string;
|
||||
}
|
||||
export interface NotificationJobDiagnosticLog extends NotificationDiagnosticLog {
|
||||
result: string;
|
||||
stats: {
|
||||
[key: string]: {
|
||||
[key: string]: number;
|
||||
};
|
||||
};
|
||||
}
|
||||
export enum NotificationOperation {
|
||||
None = 0,
|
||||
SuspendUnprocessed = 1,
|
||||
|
|
@ -550,24 +310,6 @@ export interface NotificationQueryCondition {
|
|||
subscriber: string;
|
||||
subscriptionId: string;
|
||||
}
|
||||
export interface NotificationReason {
|
||||
notificationReasonType: NotificationReasonType;
|
||||
targetIdentities: VSS_Common_Contracts.IdentityRef[];
|
||||
}
|
||||
export enum NotificationReasonType {
|
||||
Unknown = 0,
|
||||
Follows = 1,
|
||||
Personal = 2,
|
||||
PersonalAlias = 3,
|
||||
DirectMember = 4,
|
||||
IndirectMember = 5,
|
||||
GroupAlias = 6,
|
||||
SubscriptionAlias = 7,
|
||||
SingleRole = 8,
|
||||
DirectMemberGroupRole = 9,
|
||||
InDirectMemberGroupRole = 10,
|
||||
AliasMemberGroupRole = 11,
|
||||
}
|
||||
/**
|
||||
* Encapsulates notifications result properties. It defines the number of notifications and the recipients of notifications.
|
||||
*/
|
||||
|
|
@ -603,7 +345,6 @@ export enum NotificationStatisticType {
|
|||
NotificationByEventTypePerUser = 4,
|
||||
Events = 5,
|
||||
Notifications = 6,
|
||||
NotificationFailureBySubscription = 7,
|
||||
UnprocessedRangeStart = 100,
|
||||
UnprocessedEventsByPublisher = 101,
|
||||
UnprocessedEventDelayByPublisher = 102,
|
||||
|
|
@ -690,10 +431,6 @@ export interface NotificationSubscription {
|
|||
* Description of the subscription. Typically describes filter criteria which helps identity the subscription.
|
||||
*/
|
||||
description: string;
|
||||
/**
|
||||
* Diagnostics for this subscription.
|
||||
*/
|
||||
diagnostics: SubscriptionDiagnostics;
|
||||
/**
|
||||
* Any extra properties like detailed description for different contexts, user/group contexts
|
||||
*/
|
||||
|
|
@ -701,7 +438,7 @@ export interface NotificationSubscription {
|
|||
[key: string]: string;
|
||||
};
|
||||
/**
|
||||
* Matching criteria for the subscription. ExpressionFilter
|
||||
* Matching criteria for the subscription.
|
||||
*/
|
||||
filter: ISubscriptionFilter;
|
||||
/**
|
||||
|
|
@ -762,7 +499,7 @@ export interface NotificationSubscriptionCreateParameters {
|
|||
*/
|
||||
description: string;
|
||||
/**
|
||||
* Matching criteria for the new subscription. ExpressionFilter
|
||||
* Matching criteria for the new subscription.
|
||||
*/
|
||||
filter: ISubscriptionFilter;
|
||||
/**
|
||||
|
|
@ -826,7 +563,7 @@ export interface NotificationSubscriptionUpdateParameters {
|
|||
*/
|
||||
description: string;
|
||||
/**
|
||||
* Matching criteria for the subscription. ExpressionFilter
|
||||
* Matching criteria for the subscription.
|
||||
*/
|
||||
filter: ISubscriptionFilter;
|
||||
/**
|
||||
|
|
@ -856,73 +593,15 @@ export interface OperatorConstraint {
|
|||
*/
|
||||
supportedScopes: string[];
|
||||
}
|
||||
export interface ProcessedEvent {
|
||||
/**
|
||||
* All of the users that were associtated with this event and their role.
|
||||
*/
|
||||
actors: VSS_Common_Contracts.EventActor[];
|
||||
allowedChannels: string;
|
||||
artifactUri: string;
|
||||
/**
|
||||
* Evaluations for each user
|
||||
*/
|
||||
evaluations: {
|
||||
[key: string]: SubscriptionEvaluation;
|
||||
};
|
||||
eventId: number;
|
||||
/**
|
||||
* Which members were excluded from evaluation (only applies to ActorMatcher subscriptions)
|
||||
*/
|
||||
exclusions: VSS_Common_Contracts.EventActor[];
|
||||
/**
|
||||
* Which members were included for evaluation (only applies to ActorMatcher subscriptions)
|
||||
*/
|
||||
inclusions: VSS_Common_Contracts.EventActor[];
|
||||
notifications: GeneratedNotification[];
|
||||
}
|
||||
export interface RoleBasedFilter extends ExpressionFilter {
|
||||
exclusions: string[];
|
||||
inclusions: string[];
|
||||
}
|
||||
export interface ServiceBusSubscriptionChannel {
|
||||
type: string;
|
||||
}
|
||||
export interface ServiceHooksSubscriptionChannel {
|
||||
type: string;
|
||||
}
|
||||
export interface SoapSubscriptionChannel extends SubscriptionChannelWithAddress {
|
||||
type: string;
|
||||
}
|
||||
export enum SubscriberFlags {
|
||||
/**
|
||||
* None
|
||||
*/
|
||||
None = 0,
|
||||
/**
|
||||
* Subscriber's delivery preferences could be updated
|
||||
*/
|
||||
DeliveryPreferencesEditable = 2,
|
||||
/**
|
||||
* Subscriber's delivery preferences supports email delivery
|
||||
*/
|
||||
SupportsPreferredEmailAddressDelivery = 4,
|
||||
/**
|
||||
* Subscriber's delivery preferences supports individual members delivery(group expansion)
|
||||
*/
|
||||
SupportsEachMemberDelivery = 8,
|
||||
/**
|
||||
* Subscriber's delivery preferences supports no delivery
|
||||
*/
|
||||
SupportsNoDelivery = 16,
|
||||
/**
|
||||
* Subscriber is a user
|
||||
*/
|
||||
IsUser = 32,
|
||||
/**
|
||||
* Subscriber is a group
|
||||
*/
|
||||
IsGroup = 64,
|
||||
/**
|
||||
* Subscriber is a team
|
||||
*/
|
||||
IsTeam = 128,
|
||||
DeliveryPreferencesEditable = 1,
|
||||
}
|
||||
/**
|
||||
* Admin-managed settings for a group subscription.
|
||||
|
|
@ -938,20 +617,6 @@ export interface SubscriptionChannelWithAddress {
|
|||
type: string;
|
||||
useCustomAddress: boolean;
|
||||
}
|
||||
export interface SubscriptionDiagnostics {
|
||||
deliveryResults: SubscriptionTracing;
|
||||
deliveryTracing: SubscriptionTracing;
|
||||
evaluationTracing: SubscriptionTracing;
|
||||
}
|
||||
export interface SubscriptionEvaluation {
|
||||
clauses: SubscriptionEvaluationClause[];
|
||||
user: DiagnosticIdentity;
|
||||
}
|
||||
export interface SubscriptionEvaluationClause {
|
||||
clause: string;
|
||||
order: number;
|
||||
result: boolean;
|
||||
}
|
||||
/**
|
||||
* Encapsulates the properties of a SubscriptionEvaluationRequest. It defines the subscription to be evaluated and time interval for events used in evaluation.
|
||||
*/
|
||||
|
|
@ -1141,6 +806,7 @@ export enum SubscriptionQueryFlags {
|
|||
* A resource, typically an account or project, in which events are published from.
|
||||
*/
|
||||
export interface SubscriptionScope extends VSS_Common_Contracts.EventScope {
|
||||
name: string;
|
||||
}
|
||||
export interface SubscriptionStatisticViewData {
|
||||
events: {
|
||||
|
|
@ -1170,10 +836,6 @@ export enum SubscriptionStatus {
|
|||
* Subscription is disabled and will be deleted.
|
||||
*/
|
||||
PendingDeletion = -100,
|
||||
/**
|
||||
* Subscription is disabled because the identity does not have the appropriate permissions
|
||||
*/
|
||||
DisabledMissingPermissions = -10,
|
||||
/**
|
||||
* Subscription is disabled service due to failures.
|
||||
*/
|
||||
|
|
@ -1219,77 +881,12 @@ export enum SubscriptionStatus {
|
|||
*/
|
||||
EnabledOnProbation = 1,
|
||||
}
|
||||
/**
|
||||
* Set of flags used to determine which set of templates is retrieved when querying for subscription templates
|
||||
*/
|
||||
export enum SubscriptionTemplateQueryFlags {
|
||||
None = 0,
|
||||
/**
|
||||
* Include user templates
|
||||
*/
|
||||
IncludeUser = 1,
|
||||
/**
|
||||
* Include group templates
|
||||
*/
|
||||
IncludeGroup = 2,
|
||||
/**
|
||||
* Include user and group templates
|
||||
*/
|
||||
IncludeUserAndGroup = 4,
|
||||
/**
|
||||
* Include the event type details like the fields and operators
|
||||
*/
|
||||
IncludeEventTypeInformation = 22,
|
||||
}
|
||||
export enum SubscriptionTemplateType {
|
||||
User = 0,
|
||||
Team = 1,
|
||||
Both = 2,
|
||||
None = 3,
|
||||
}
|
||||
export interface SubscriptionTraceDiagnosticLog extends NotificationDiagnosticLog {
|
||||
/**
|
||||
* Indicates the job Id that processed or delivered this subscription
|
||||
*/
|
||||
jobId: string;
|
||||
/**
|
||||
* Indicates unique instance identifier for the job that processed or delivered this subscription
|
||||
*/
|
||||
jobInstanceId: string;
|
||||
subscriptionId: string;
|
||||
}
|
||||
export interface SubscriptionTraceEventProcessingLog extends SubscriptionTraceDiagnosticLog {
|
||||
channel: string;
|
||||
/**
|
||||
* Which members opted out from receiving notifications from this subscription
|
||||
*/
|
||||
optedOut: DiagnosticIdentity[];
|
||||
processedEvents: {
|
||||
[key: number]: ProcessedEvent;
|
||||
};
|
||||
}
|
||||
export interface SubscriptionTraceNotificationDeliveryLog extends SubscriptionTraceDiagnosticLog {
|
||||
notifications: DiagnosticNotification[];
|
||||
}
|
||||
export interface SubscriptionTracing {
|
||||
enabled: boolean;
|
||||
/**
|
||||
* Trace until the specified end date.
|
||||
*/
|
||||
endDate: Date;
|
||||
/**
|
||||
* The maximum number of result details to trace.
|
||||
*/
|
||||
maxTracedEntries: number;
|
||||
/**
|
||||
* The date and time tracing started.
|
||||
*/
|
||||
startDate: Date;
|
||||
/**
|
||||
* Trace until remaining count reaches 0.
|
||||
*/
|
||||
tracedEntries: number;
|
||||
}
|
||||
/**
|
||||
* User-managed settings for a group subscription.
|
||||
*/
|
||||
|
|
@ -1299,26 +896,6 @@ export interface SubscriptionUserSettings {
|
|||
*/
|
||||
optedOut: boolean;
|
||||
}
|
||||
export interface UnsupportedFilter extends BaseSubscriptionFilter {
|
||||
type: string;
|
||||
}
|
||||
export interface UnsupportedSubscriptionChannel {
|
||||
type: string;
|
||||
}
|
||||
export interface UpdateSubscripitonDiagnosticsParameters {
|
||||
deliveryResults: UpdateSubscripitonTracingParameters;
|
||||
deliveryTracing: UpdateSubscripitonTracingParameters;
|
||||
evaluationTracing: UpdateSubscripitonTracingParameters;
|
||||
}
|
||||
export interface UpdateSubscripitonTracingParameters {
|
||||
enabled: boolean;
|
||||
}
|
||||
export interface UserSubscriptionChannel extends SubscriptionChannelWithAddress {
|
||||
type: string;
|
||||
}
|
||||
export interface UserSystemSubscriptionChannel extends SubscriptionChannelWithAddress {
|
||||
type: string;
|
||||
}
|
||||
/**
|
||||
* Encapsulates the properties of a field value definition. It has the information needed to retrieve the list of possible values for a certain field and how to handle that field values in the UI. This information includes what type of object this value represents, which property to use for UI display and which property to use for saving the subscription
|
||||
*/
|
||||
|
|
@ -1337,7 +914,6 @@ export interface ValueDefinition {
|
|||
resultTemplate: string;
|
||||
}
|
||||
export var TypeInfo: {
|
||||
ActorNotificationReason: any;
|
||||
BatchNotificationOperation: any;
|
||||
EvaluationOperationStatus: {
|
||||
enumValues: {
|
||||
|
|
@ -1351,52 +927,16 @@ export var TypeInfo: {
|
|||
"notFound": number;
|
||||
};
|
||||
};
|
||||
EventProcessingLog: any;
|
||||
EventPublisherQueryFlags: {
|
||||
enumValues: {
|
||||
"none": number;
|
||||
"includeRemoteServices": number;
|
||||
};
|
||||
};
|
||||
EventTypeQueryFlags: {
|
||||
enumValues: {
|
||||
"none": number;
|
||||
"includeFields": number;
|
||||
};
|
||||
};
|
||||
INotificationDiagnosticLog: any;
|
||||
NotificationAdminSettings: any;
|
||||
NotificationAdminSettingsUpdateParameters: any;
|
||||
NotificationCommonViewData: any;
|
||||
NotificationDeliveryLog: any;
|
||||
NotificationDiagnosticLog: any;
|
||||
NotificationEventField: any;
|
||||
NotificationEventFieldType: any;
|
||||
NotificationEventType: any;
|
||||
NotificationJobDiagnosticLog: any;
|
||||
NotificationOperation: {
|
||||
enumValues: {
|
||||
"none": number;
|
||||
"suspendUnprocessed": number;
|
||||
};
|
||||
};
|
||||
NotificationReason: any;
|
||||
NotificationReasonType: {
|
||||
enumValues: {
|
||||
"unknown": number;
|
||||
"follows": number;
|
||||
"personal": number;
|
||||
"personalAlias": number;
|
||||
"directMember": number;
|
||||
"indirectMember": number;
|
||||
"groupAlias": number;
|
||||
"subscriptionAlias": number;
|
||||
"singleRole": number;
|
||||
"directMemberGroupRole": number;
|
||||
"inDirectMemberGroupRole": number;
|
||||
"aliasMemberGroupRole": number;
|
||||
};
|
||||
};
|
||||
NotificationStatistic: any;
|
||||
NotificationStatisticsQuery: any;
|
||||
NotificationStatisticsQueryConditions: any;
|
||||
|
|
@ -1409,7 +949,6 @@ export var TypeInfo: {
|
|||
"notificationByEventTypePerUser": number;
|
||||
"events": number;
|
||||
"notifications": number;
|
||||
"notificationFailureBySubscription": number;
|
||||
"unprocessedRangeStart": number;
|
||||
"unprocessedEventsByPublisher": number;
|
||||
"unprocessedEventDelayByPublisher": number;
|
||||
|
|
@ -1452,15 +991,8 @@ export var TypeInfo: {
|
|||
enumValues: {
|
||||
"none": number;
|
||||
"deliveryPreferencesEditable": number;
|
||||
"supportsPreferredEmailAddressDelivery": number;
|
||||
"supportsEachMemberDelivery": number;
|
||||
"supportsNoDelivery": number;
|
||||
"isUser": number;
|
||||
"isGroup": number;
|
||||
"isTeam": number;
|
||||
};
|
||||
};
|
||||
SubscriptionDiagnostics: any;
|
||||
SubscriptionEvaluationRequest: any;
|
||||
SubscriptionEvaluationResult: any;
|
||||
SubscriptionFieldType: {
|
||||
|
|
@ -1515,7 +1047,6 @@ export var TypeInfo: {
|
|||
enumValues: {
|
||||
"jailedByNotificationsVolume": number;
|
||||
"pendingDeletion": number;
|
||||
"disabledMissingPermissions": number;
|
||||
"disabledBySystem": number;
|
||||
"disabledInactiveIdentity": number;
|
||||
"disabledMessageQueueNotSupported": number;
|
||||
|
|
@ -1529,15 +1060,6 @@ export var TypeInfo: {
|
|||
"enabledOnProbation": number;
|
||||
};
|
||||
};
|
||||
SubscriptionTemplateQueryFlags: {
|
||||
enumValues: {
|
||||
"none": number;
|
||||
"includeUser": number;
|
||||
"includeGroup": number;
|
||||
"includeUserAndGroup": number;
|
||||
"includeEventTypeInformation": number;
|
||||
};
|
||||
};
|
||||
SubscriptionTemplateType: {
|
||||
enumValues: {
|
||||
"user": number;
|
||||
|
|
@ -1546,25 +1068,8 @@ export var TypeInfo: {
|
|||
"none": number;
|
||||
};
|
||||
};
|
||||
SubscriptionTraceDiagnosticLog: any;
|
||||
SubscriptionTraceEventProcessingLog: any;
|
||||
SubscriptionTraceNotificationDeliveryLog: any;
|
||||
SubscriptionTracing: any;
|
||||
};
|
||||
}
|
||||
declare module "Notifications/Extensions" {
|
||||
import VSS_Common_Contracts = require("VSS/WebApi/Contracts");
|
||||
/**
|
||||
* Service instance type id for the Extension Management Service
|
||||
*/
|
||||
export const ExtensionManagementServiceInstaceTypeId = "00000028-0000-8888-8000-000000000000";
|
||||
/**
|
||||
* Publish the specified notification event
|
||||
*
|
||||
* @param notificationEvent Notification event to publish to the extension management service
|
||||
*/
|
||||
export function publishEvent(notificationEvent: VSS_Common_Contracts.VssNotificationEvent): IPromise<VSS_Common_Contracts.VssNotificationEvent>;
|
||||
}
|
||||
declare module "Notifications/Resources" {
|
||||
export module BatchNotificationOperationsResource {
|
||||
var LocationId: string;
|
||||
|
|
@ -1615,9 +1120,8 @@ export module SubscriptionTemplatesResource {
|
|||
}
|
||||
declare module "Notifications/RestClient" {
|
||||
import Contracts = require("Notifications/Contracts");
|
||||
import VSS_Common_Contracts = require("VSS/WebApi/Contracts");
|
||||
import VSS_WebApi = require("VSS/WebApi/RestClient");
|
||||
export class CommonMethods3To5 extends VSS_WebApi.VssHttpClient {
|
||||
export class CommonMethods3To4 extends VSS_WebApi.VssHttpClient {
|
||||
static serviceInstanceId: string;
|
||||
protected eventsApiVersion: string;
|
||||
protected eventTypeFieldValuesQueryApiVersion: string;
|
||||
|
|
@ -1627,12 +1131,6 @@ export class CommonMethods3To5 extends VSS_WebApi.VssHttpClient {
|
|||
protected subscriptionsApiVersion: string;
|
||||
protected subscriptionTemplatesApiVersion: string;
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Get available subscription templates.
|
||||
*
|
||||
* @return IPromise<Contracts.NotificationSubscriptionTemplate[]>
|
||||
*/
|
||||
getSubscriptionTemplates(): IPromise<Contracts.NotificationSubscriptionTemplate[]>;
|
||||
/**
|
||||
* [Preview API] Update an existing subscription. Depending on the type of subscription and permissions, the caller can update the description, filter settings, channel (delivery) settings and more.
|
||||
*
|
||||
|
|
@ -1708,35 +1206,51 @@ export class CommonMethods3To5 extends VSS_WebApi.VssHttpClient {
|
|||
* @return IPromise<Contracts.NotificationEventField[]>
|
||||
*/
|
||||
queryEventTypes(inputValuesQuery: Contracts.FieldValuesQuery, eventType: string): IPromise<Contracts.NotificationEventField[]>;
|
||||
/**
|
||||
* [Preview API] Publish an event.
|
||||
*
|
||||
* @param {VSS_Common_Contracts.VssNotificationEvent} notificationEvent
|
||||
* @return IPromise<VSS_Common_Contracts.VssNotificationEvent>
|
||||
*/
|
||||
publishEvent(notificationEvent: VSS_Common_Contracts.VssNotificationEvent): IPromise<VSS_Common_Contracts.VssNotificationEvent>;
|
||||
}
|
||||
export class CommonMethods3_1To5 extends CommonMethods3To5 {
|
||||
export class CommonMethods3_1To4 extends CommonMethods3To4 {
|
||||
protected batchNotificationOperationsApiVersion: string;
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
}
|
||||
export class CommonMethods3_2To5 extends CommonMethods3_1To5 {
|
||||
export class CommonMethods3_2To4 extends CommonMethods3_1To4 {
|
||||
protected subscriptionEvaluationRequestsApiVersion: string;
|
||||
protected userSettingsApiVersion: string;
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Update the specified user's settings for the specified subscription. This API is typically used to opt in or out of a shared subscription. User settings can only be applied to shared subscriptions, like team subscriptions or default subscriptions.
|
||||
* [Preview API] Update the specified users' settings for the specified subscription. User settings can only be applied to shared subscriptions, like team subscriptions or default subscriptions. This API is typically used to opt in or out of a shared subscription.
|
||||
*
|
||||
* @param {Contracts.SubscriptionUserSettings} userSettings
|
||||
* @param {string} subscriptionId
|
||||
* @param {string} userId - ID of the user
|
||||
* @param {string} userId - ID of the user or "me" to indicate the calling user
|
||||
* @return IPromise<Contracts.SubscriptionUserSettings>
|
||||
*/
|
||||
updateSubscriptionUserSettings(userSettings: Contracts.SubscriptionUserSettings, subscriptionId: string, userId: string): IPromise<Contracts.SubscriptionUserSettings>;
|
||||
updateSubscriptionUserSettings(userSettings: Contracts.SubscriptionUserSettings, subscriptionId: string, userId?: string): IPromise<Contracts.SubscriptionUserSettings>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {string} requestId
|
||||
* @return IPromise<Contracts.SubscriptionEvaluationResult>
|
||||
*/
|
||||
getSubscriptionEvaluationResults(requestId: string): IPromise<Contracts.SubscriptionEvaluationResult>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {Contracts.SubscriptionEvaluationRequest} subscriptionEvaluationRequest
|
||||
* @return IPromise<Contracts.SubscriptionEvaluationResult>
|
||||
*/
|
||||
evaluateSubscription(subscriptionEvaluationRequest: Contracts.SubscriptionEvaluationRequest): IPromise<Contracts.SubscriptionEvaluationResult>;
|
||||
}
|
||||
export class CommonMethods4To5 extends CommonMethods3_2To5 {
|
||||
protected notificationReasonsApiVersion: string;
|
||||
protected subscribersApiVersion: string;
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class NotificationHttpClient4 extends CommonMethods3_2To4 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {string} subscriberId
|
||||
* @return IPromise<Contracts.NotificationSubscriber>
|
||||
*/
|
||||
getSubscriber(subscriberId: string): IPromise<Contracts.NotificationSubscriber>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
|
|
@ -1745,109 +1259,34 @@ export class CommonMethods4To5 extends CommonMethods3_2To5 {
|
|||
* @return IPromise<Contracts.NotificationSubscriber>
|
||||
*/
|
||||
updateSubscriber(updateParameters: Contracts.NotificationSubscriberUpdateParameters, subscriberId: string): IPromise<Contracts.NotificationSubscriber>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {string} subscriberId
|
||||
* @return IPromise<Contracts.NotificationSubscriber>
|
||||
*/
|
||||
getSubscriber(subscriberId: string): IPromise<Contracts.NotificationSubscriber>;
|
||||
}
|
||||
export class CommonMethods4_1To5 extends CommonMethods4To5 {
|
||||
protected diagnosticLogsApiVersion: string;
|
||||
protected diagnosticsApiVersion: string;
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {Contracts.UpdateSubscripitonDiagnosticsParameters} updateParameters
|
||||
* @param {string} subscriptionId
|
||||
* @return IPromise<Contracts.SubscriptionDiagnostics>
|
||||
*/
|
||||
updateSubscriptionDiagnostics(updateParameters: Contracts.UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): IPromise<Contracts.SubscriptionDiagnostics>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {string} subscriptionId
|
||||
* @return IPromise<Contracts.SubscriptionDiagnostics>
|
||||
*/
|
||||
getSubscriptionDiagnostics(subscriptionId: string): IPromise<Contracts.SubscriptionDiagnostics>;
|
||||
/**
|
||||
* [Preview API] List diagnostic logs this service.
|
||||
*
|
||||
* @param {string} source
|
||||
* @param {string} entryId
|
||||
* @param {Date} startTime
|
||||
* @param {Date} endTime
|
||||
* @return IPromise<Contracts.INotificationDiagnosticLog[]>
|
||||
*/
|
||||
listLogs(source: string, entryId?: string, startTime?: Date, endTime?: Date): IPromise<Contracts.INotificationDiagnosticLog[]>;
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class NotificationHttpClient5 extends CommonMethods4_1To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Tranform a notification event.
|
||||
*
|
||||
* @param {Contracts.EventTransformRequest} transformRequest - Object to be transformed.
|
||||
* @return IPromise<Contracts.EventTransformResult>
|
||||
*/
|
||||
transformEvent(transformRequest: Contracts.EventTransformRequest): IPromise<Contracts.EventTransformResult>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @return IPromise<Contracts.NotificationAdminSettings>
|
||||
*/
|
||||
getSettings(): IPromise<Contracts.NotificationAdminSettings>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {Contracts.NotificationAdminSettingsUpdateParameters} updateParameters
|
||||
* @return IPromise<Contracts.NotificationAdminSettings>
|
||||
*/
|
||||
updateSettings(updateParameters: Contracts.NotificationAdminSettingsUpdateParameters): IPromise<Contracts.NotificationAdminSettings>;
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class NotificationHttpClient4_1 extends CommonMethods4_1To5 {
|
||||
export class NotificationHttpClient3_2 extends CommonMethods3_2To4 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class NotificationHttpClient4 extends CommonMethods4To5 {
|
||||
export class NotificationHttpClient3_1 extends CommonMethods3_1To4 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class NotificationHttpClient3_2 extends CommonMethods3_2To5 {
|
||||
export class NotificationHttpClient3 extends CommonMethods3To4 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class NotificationHttpClient3_1 extends CommonMethods3_1To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class NotificationHttpClient3 extends CommonMethods3To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
}
|
||||
export class NotificationHttpClient extends NotificationHttpClient5 {
|
||||
export class NotificationHttpClient extends NotificationHttpClient4 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
}
|
||||
/**
|
||||
* Gets an http client targeting the latest released version of the APIs.
|
||||
*
|
||||
* @return NotificationHttpClient4_1
|
||||
* @return NotificationHttpClient3_2
|
||||
*/
|
||||
export function getClient(options?: VSS_WebApi.IVssHttpClientOptions): NotificationHttpClient4_1;
|
||||
export function getClient(options?: VSS_WebApi.IVssHttpClientOptions): NotificationHttpClient3_2;
|
||||
}
|
||||
declare module "Notifications/Services" {
|
||||
import Service = require("VSS/Service");
|
||||
|
|
@ -1886,14 +1325,14 @@ export class FollowsService extends Service.VssService {
|
|||
static FOLLOWS_STATE_CHANGING: string;
|
||||
static FOLLOWS_TYPE: string;
|
||||
private static LAYER;
|
||||
initializeConnection(tfsConnection: Service.VssConnection, serviceInstanceId?: string): void;
|
||||
clearCache(): void;
|
||||
getSubscription(artifact: ArtifactSubscription, subscriberId?: string): IPromise<ArtifactSubscription>;
|
||||
getSubscription(artifact: ArtifactSubscription): IPromise<ArtifactSubscription>;
|
||||
followArtifact(artifact: ArtifactSubscription, telemetryData?: IFollowsTelemetryData): IPromise<ArtifactSubscription>;
|
||||
unfollowArtifact(artifact: ArtifactSubscription, subscriberId?: string, telemetryData?: IFollowsTelemetryData): IPromise<ArtifactSubscription>;
|
||||
unfollowArtifact(artifact: ArtifactSubscription, telemetryData?: IFollowsTelemetryData): IPromise<ArtifactSubscription>;
|
||||
refresh(artifact: ArtifactSubscription): void;
|
||||
private _getNotificationSubscriptionObject(artifactSubscription);
|
||||
private _handlePromise(artifact, isFollow, promise);
|
||||
private _ensureInitialized();
|
||||
private _artifactSubscriptionFromNotificationSubscription(subscription);
|
||||
private _makePromiseKey(artifactId, artifactType);
|
||||
private _fireChanging(artifact, state);
|
||||
|
|
|
|||
|
|
@ -0,0 +1,106 @@
|
|||
/**
|
||||
* ---------------------------------------------------------
|
||||
* Generated file, DO NOT EDIT
|
||||
* ---------------------------------------------------------
|
||||
*
|
||||
* See following wiki page for instructions on how to regenerate:
|
||||
* https://dev.azure.com/mseng/VSOnline/_wiki/wikis/VSOnline.wiki?pagePath=%2FOrphaned%20pages%2FDocQuality%2FDocQuality%252DInProgress%2FRest%20Client%20Generation
|
||||
*
|
||||
* Configuration file:
|
||||
* distributedtask\shared\common\contracts\clientgeneratorconfigs\genclient.json
|
||||
*/
|
||||
export interface AuthorizationHeader {
|
||||
name: string;
|
||||
value: string;
|
||||
}
|
||||
/**
|
||||
* Represents binding of data source for the service endpoint request.
|
||||
*/
|
||||
export interface DataSourceBindingBase {
|
||||
/**
|
||||
* Pagination format supported by this data source(ContinuationToken/SkipTop).
|
||||
*/
|
||||
callbackContextTemplate: string;
|
||||
/**
|
||||
* Subsequent calls needed?
|
||||
*/
|
||||
callbackRequiredTemplate: string;
|
||||
/**
|
||||
* Gets or sets the name of the data source.
|
||||
*/
|
||||
dataSourceName: string;
|
||||
/**
|
||||
* Gets or sets the endpoint Id.
|
||||
*/
|
||||
endpointId: string;
|
||||
/**
|
||||
* Gets or sets the url of the service endpoint.
|
||||
*/
|
||||
endpointUrl: string;
|
||||
/**
|
||||
* Gets or sets the authorization headers.
|
||||
*/
|
||||
headers: AuthorizationHeader[];
|
||||
/**
|
||||
* Defines the initial value of the query params
|
||||
*/
|
||||
initialContextTemplate: string;
|
||||
/**
|
||||
* Gets or sets the parameters for the data source.
|
||||
*/
|
||||
parameters: {
|
||||
[key: string]: string;
|
||||
};
|
||||
/**
|
||||
* Gets or sets the result selector.
|
||||
*/
|
||||
resultSelector: string;
|
||||
/**
|
||||
* Gets or sets the result template.
|
||||
*/
|
||||
resultTemplate: string;
|
||||
/**
|
||||
* Gets or sets the target of the data source.
|
||||
*/
|
||||
target: string;
|
||||
}
|
||||
export interface ProcessParameters {
|
||||
dataSourceBindings: DataSourceBindingBase[];
|
||||
inputs: TaskInputDefinitionBase[];
|
||||
sourceDefinitions: TaskSourceDefinitionBase[];
|
||||
}
|
||||
export interface TaskInputDefinitionBase {
|
||||
aliases: string[];
|
||||
defaultValue: string;
|
||||
groupName: string;
|
||||
helpMarkDown: string;
|
||||
label: string;
|
||||
name: string;
|
||||
options: {
|
||||
[key: string]: string;
|
||||
};
|
||||
properties: {
|
||||
[key: string]: string;
|
||||
};
|
||||
required: boolean;
|
||||
type: string;
|
||||
validation: TaskInputValidation;
|
||||
visibleRule: string;
|
||||
}
|
||||
export interface TaskInputValidation {
|
||||
/**
|
||||
* Conditional expression
|
||||
*/
|
||||
expression: string;
|
||||
/**
|
||||
* Message explaining how user can correct if validation fails
|
||||
*/
|
||||
message: string;
|
||||
}
|
||||
export interface TaskSourceDefinitionBase {
|
||||
authKey: string;
|
||||
endpoint: string;
|
||||
keySelector: string;
|
||||
selector: string;
|
||||
target: string;
|
||||
}
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// Type definitions for Microsoft Visual Studio Services v134.20180525.1751
|
||||
// Type definitions for Microsoft Visual Studio Services v141.20180928.1724
|
||||
// Project: https://www.visualstudio.com/integrate/extensions/overview
|
||||
// Definitions by: Microsoft <vsointegration@microsoft.com>
|
||||
|
||||
|
|
@ -10,6 +10,7 @@
|
|||
/// <reference types='react' />
|
||||
/// <reference types='mousetrap' />
|
||||
/// <reference path='vss.d.ts' />
|
||||
/// <reference path='rmo.contracts.d.ts' />
|
||||
/// <reference path='tfs.d.ts' />
|
||||
declare module "ReleaseManagement/Core/Constants" {
|
||||
export module ApprovalOptions {
|
||||
|
|
@ -46,6 +47,7 @@ export module ArtifactDefinitionConstants {
|
|||
var LabelSources: string;
|
||||
var LabelSourcesFormat: string;
|
||||
var CheckoutSubmodules: string;
|
||||
var CheckoutNestedSubmodules: string;
|
||||
var GitLfsSupport: string;
|
||||
var FetchDepth: string;
|
||||
var ReportBuildStatus: string;
|
||||
|
|
@ -85,6 +87,7 @@ export module BuildVersionConstants {
|
|||
var RepositoryIdKey: string;
|
||||
var RepositoryTypeKey: string;
|
||||
var PullRequestSourceBranchCommitIdKey: string;
|
||||
var PullRequestMergedAtKey: string;
|
||||
var PullRequestIdKey: string;
|
||||
var CommitMessageKey: string;
|
||||
}
|
||||
|
|
@ -139,6 +142,7 @@ export module WellKnownPullRequestVariables {
|
|||
var PullRequestId: string;
|
||||
var PullRequestSourceBranchCommitId: string;
|
||||
var PullRequestMergeCommitId: string;
|
||||
var PullRequestMergedAt: string;
|
||||
var TfsGitRepositoryId: string;
|
||||
var TfsGitProjectId: string;
|
||||
var GitHubRepositoryName: string;
|
||||
|
|
@ -176,6 +180,8 @@ export module WellKnownReleaseVariables {
|
|||
var ReleaseRequestedForEmail: string;
|
||||
var AttemptNumber: string;
|
||||
var ReleaseReason: string;
|
||||
var ReleasePrimaryArtifactSourceAlias: string;
|
||||
var ReleaseTriggeringArtifactAlias: string;
|
||||
var ReleaseDeploymentRequestedForId: string;
|
||||
var ReleaseDeploymentRequestedForEmail: string;
|
||||
var ReleaseDeploymentRequestedFor: string;
|
||||
|
|
@ -183,6 +189,17 @@ export module WellKnownReleaseVariables {
|
|||
}
|
||||
}
|
||||
declare module "ReleaseManagement/Core/Contracts" {
|
||||
/**
|
||||
* ---------------------------------------------------------
|
||||
* Generated file, DO NOT EDIT
|
||||
* ---------------------------------------------------------
|
||||
*
|
||||
* See following wiki page for instructions on how to regenerate:
|
||||
* https://vsowiki.com/index.php?title=Rest_Client_Generation
|
||||
*
|
||||
* Configuration file:
|
||||
* releasemanagement\client\webapi\clientgeneratorconfigs\genclient.json
|
||||
*/
|
||||
import TFS_DistributedTask_Common_Contracts = require("TFS/DistributedTaskCommon/Contracts");
|
||||
import VSS_Common_Contracts = require("VSS/WebApi/Contracts");
|
||||
import VSS_FormInput_Contracts = require("VSS/Common/Contracts/FormInput");
|
||||
|
|
@ -204,7 +221,7 @@ export enum AgentArtifactType {
|
|||
TFGit = 7,
|
||||
ExternalTfsBuild = 8,
|
||||
Custom = 9,
|
||||
Tfvc = 10,
|
||||
Tfvc = 10
|
||||
}
|
||||
export interface AgentBasedDeployPhase extends DeployPhase {
|
||||
deploymentInput: AgentDeploymentInput;
|
||||
|
|
@ -216,7 +233,7 @@ export interface AgentDeploymentInput extends DeploymentInput {
|
|||
export enum ApprovalExecutionOrder {
|
||||
BeforeGates = 1,
|
||||
AfterSuccessfulGates = 2,
|
||||
AfterGatesAlways = 4,
|
||||
AfterGatesAlways = 4
|
||||
}
|
||||
export enum ApprovalFilters {
|
||||
/**
|
||||
|
|
@ -238,7 +255,7 @@ export enum ApprovalFilters {
|
|||
/**
|
||||
* All approval steps and approval snapshots
|
||||
*/
|
||||
All = 7,
|
||||
All = 7
|
||||
}
|
||||
export interface ApprovalOptions {
|
||||
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped: boolean;
|
||||
|
|
@ -255,13 +272,13 @@ export enum ApprovalStatus {
|
|||
Rejected = 4,
|
||||
Reassigned = 6,
|
||||
Canceled = 7,
|
||||
Skipped = 8,
|
||||
Skipped = 8
|
||||
}
|
||||
export enum ApprovalType {
|
||||
Undefined = 0,
|
||||
PreDeploy = 1,
|
||||
PostDeploy = 2,
|
||||
All = 3,
|
||||
All = 3
|
||||
}
|
||||
export interface Artifact {
|
||||
/**
|
||||
|
|
@ -278,6 +295,7 @@ export interface Artifact {
|
|||
* Gets or sets as artifact is primary or not.
|
||||
*/
|
||||
isPrimary: boolean;
|
||||
isRetained: boolean;
|
||||
sourceId: string;
|
||||
/**
|
||||
* Gets or sets type. It can have value as 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.
|
||||
|
|
@ -298,6 +316,9 @@ export interface ArtifactContributionDefinition {
|
|||
endpointTypeId: string;
|
||||
inputDescriptors: VSS_FormInput_Contracts.InputDescriptor[];
|
||||
name: string;
|
||||
taskInputMapping: {
|
||||
[key: string]: string;
|
||||
};
|
||||
uniqueSourceIdentifier: string;
|
||||
}
|
||||
export interface ArtifactDownloadInputBase {
|
||||
|
|
@ -375,11 +396,11 @@ export enum AuditAction {
|
|||
Add = 1,
|
||||
Update = 2,
|
||||
Delete = 3,
|
||||
Undelete = 4,
|
||||
Undelete = 4
|
||||
}
|
||||
export enum AuthorizationHeaderFor {
|
||||
RevalidateApproverIdentity = 0,
|
||||
OnBehalfOf = 1,
|
||||
OnBehalfOf = 1
|
||||
}
|
||||
export interface AutoTriggerIssue {
|
||||
issue: Issue;
|
||||
|
|
@ -434,7 +455,7 @@ export interface Change {
|
|||
*/
|
||||
author: VSS_Common_Contracts.IdentityRef;
|
||||
/**
|
||||
* The type of change. "commit", "changeset", etc.
|
||||
* The type of source. "TfsVersionControl", "TfsGit", etc.
|
||||
*/
|
||||
changeType: string;
|
||||
/**
|
||||
|
|
@ -453,6 +474,10 @@ export interface Change {
|
|||
* A description of the change. This might be a commit message or changeset description.
|
||||
*/
|
||||
message: string;
|
||||
/**
|
||||
* The person or process that pushed the change.
|
||||
*/
|
||||
pushedBy: VSS_Common_Contracts.IdentityRef;
|
||||
/**
|
||||
* The person or process that pushed the change.
|
||||
*/
|
||||
|
|
@ -501,9 +526,13 @@ export enum ConditionType {
|
|||
/**
|
||||
* The condition type is artifact.
|
||||
*/
|
||||
Artifact = 4,
|
||||
Artifact = 4
|
||||
}
|
||||
export interface ConfigurationVariableValue {
|
||||
/**
|
||||
* Gets or sets if a variable can be overridden at deployment time or not.
|
||||
*/
|
||||
allowOverride: boolean;
|
||||
/**
|
||||
* Gets or sets as variable is secret or not.
|
||||
*/
|
||||
|
|
@ -533,9 +562,12 @@ export interface ControlOptions {
|
|||
export interface CustomArtifactDownloadInput extends ArtifactDownloadInputBase {
|
||||
}
|
||||
export interface DataSourceBinding {
|
||||
callbackContextTemplate: string;
|
||||
callBackRequiredTemplate: string;
|
||||
dataSourceName: string;
|
||||
endpointId: string;
|
||||
endpointUrl: string;
|
||||
initialContextTemplate: string;
|
||||
parameters: {
|
||||
[key: string]: string;
|
||||
};
|
||||
|
|
@ -697,7 +729,7 @@ export interface DeploymentAuthorizationInfo {
|
|||
export enum DeploymentAuthorizationOwner {
|
||||
Automatic = 0,
|
||||
DeploymentSubmitter = 1,
|
||||
FirstPreDeploymentApprover = 2,
|
||||
FirstPreDeploymentApprover = 2
|
||||
}
|
||||
export interface DeploymentCompletedEvent {
|
||||
comment: string;
|
||||
|
|
@ -712,7 +744,7 @@ export enum DeploymentExpands {
|
|||
All = 0,
|
||||
DeploymentOnly = 1,
|
||||
Approvals = 2,
|
||||
Artifacts = 4,
|
||||
Artifacts = 4
|
||||
}
|
||||
export interface DeploymentInput extends BaseDeploymentInput {
|
||||
artifactsDownloadInput: ArtifactsDownloadInput;
|
||||
|
|
@ -813,7 +845,7 @@ export enum DeploymentOperationStatus {
|
|||
/**
|
||||
* The deployment operation status is all.
|
||||
*/
|
||||
All = 258047,
|
||||
All = 258047
|
||||
}
|
||||
export interface DeploymentQueryParameters {
|
||||
artifactSourceId: string;
|
||||
|
|
@ -853,11 +885,11 @@ export enum DeploymentReason {
|
|||
/**
|
||||
* The deployment reason is RedeployTrigger.
|
||||
*/
|
||||
RedeployTrigger = 8,
|
||||
RedeployTrigger = 8
|
||||
}
|
||||
export enum DeploymentsQueryType {
|
||||
Regular = 1,
|
||||
FailingSince = 2,
|
||||
FailingSince = 2
|
||||
}
|
||||
export interface DeploymentStartedEvent {
|
||||
environment: ReleaseEnvironment;
|
||||
|
|
@ -892,7 +924,7 @@ export enum DeploymentStatus {
|
|||
/**
|
||||
* The deployment status is all.
|
||||
*/
|
||||
All = 31,
|
||||
All = 31
|
||||
}
|
||||
export interface DeployPhase {
|
||||
name: string;
|
||||
|
|
@ -909,13 +941,13 @@ export enum DeployPhaseStatus {
|
|||
Failed = 16,
|
||||
Canceled = 32,
|
||||
Skipped = 64,
|
||||
Cancelling = 128,
|
||||
Cancelling = 128
|
||||
}
|
||||
export enum DeployPhaseTypes {
|
||||
Undefined = 0,
|
||||
AgentBasedDeployment = 1,
|
||||
RunOnServer = 2,
|
||||
MachineGroupBasedDeployment = 4,
|
||||
MachineGroupBasedDeployment = 4
|
||||
}
|
||||
export interface EmailRecipients {
|
||||
emailAddresses: string[];
|
||||
|
|
@ -959,7 +991,7 @@ export enum EnvironmentStatus {
|
|||
Rejected = 16,
|
||||
Queued = 32,
|
||||
Scheduled = 64,
|
||||
PartiallySucceeded = 128,
|
||||
PartiallySucceeded = 128
|
||||
}
|
||||
export interface EnvironmentTrigger {
|
||||
definitionEnvironmentId: number;
|
||||
|
|
@ -973,7 +1005,7 @@ export interface EnvironmentTriggerContent {
|
|||
}
|
||||
export enum EnvironmentTriggerType {
|
||||
Undefined = 0,
|
||||
DeploymentGroupRedeploy = 1,
|
||||
DeploymentGroupRedeploy = 1
|
||||
}
|
||||
export interface ExecutionInput {
|
||||
parallelExecutionType: ParallelExecutionTypes;
|
||||
|
|
@ -1019,7 +1051,7 @@ export enum FolderPathQueryOrder {
|
|||
/**
|
||||
* Order by folder name and path descending.
|
||||
*/
|
||||
Descending = 2,
|
||||
Descending = 2
|
||||
}
|
||||
export enum GateStatus {
|
||||
None = 0,
|
||||
|
|
@ -1027,11 +1059,32 @@ export enum GateStatus {
|
|||
InProgress = 2,
|
||||
Succeeded = 4,
|
||||
Failed = 8,
|
||||
Canceled = 16
|
||||
}
|
||||
export interface GateUpdateMetadata {
|
||||
/**
|
||||
* Comment
|
||||
*/
|
||||
comment: string;
|
||||
/**
|
||||
* Name of gate to be ignored.
|
||||
*/
|
||||
gatesToIgnore: string[];
|
||||
}
|
||||
export interface GitArtifactDownloadInput extends ArtifactDownloadInputBase {
|
||||
}
|
||||
export interface GitHubArtifactDownloadInput extends ArtifactDownloadInputBase {
|
||||
}
|
||||
export interface IgnoredGate {
|
||||
/**
|
||||
* Gets the date on which gate is last ignored.
|
||||
*/
|
||||
lastModifiedOn: Date;
|
||||
/**
|
||||
* Name of gate ignored.
|
||||
*/
|
||||
name: string;
|
||||
}
|
||||
export interface Issue {
|
||||
data: {
|
||||
[key: string]: string;
|
||||
|
|
@ -1042,7 +1095,7 @@ export interface Issue {
|
|||
export enum IssueSource {
|
||||
None = 0,
|
||||
User = 1,
|
||||
System = 2,
|
||||
System = 2
|
||||
}
|
||||
export interface JenkinsArtifactDownloadInput extends ArtifactDownloadInputBase {
|
||||
artifactItems: string[];
|
||||
|
|
@ -1073,7 +1126,7 @@ export enum MailSectionType {
|
|||
Issues = 2,
|
||||
TestResults = 3,
|
||||
WorkItems = 4,
|
||||
ReleaseInfo = 5,
|
||||
ReleaseInfo = 5
|
||||
}
|
||||
export interface ManualIntervention {
|
||||
/**
|
||||
|
|
@ -1152,7 +1205,7 @@ export enum ManualInterventionStatus {
|
|||
/**
|
||||
* The manual intervention is canceled.
|
||||
*/
|
||||
Canceled = 8,
|
||||
Canceled = 8
|
||||
}
|
||||
export interface ManualInterventionUpdateMetadata {
|
||||
/**
|
||||
|
|
@ -1188,14 +1241,14 @@ export interface ParallelExecutionInputBase extends ExecutionInput {
|
|||
export enum ParallelExecutionTypes {
|
||||
None = 0,
|
||||
MultiConfiguration = 1,
|
||||
MultiMachine = 2,
|
||||
MultiMachine = 2
|
||||
}
|
||||
export interface PipelineProcess {
|
||||
type: PipelineProcessTypes;
|
||||
}
|
||||
export enum PipelineProcessTypes {
|
||||
Designer = 1,
|
||||
Yaml = 2,
|
||||
Yaml = 2
|
||||
}
|
||||
export interface ProjectReference {
|
||||
/**
|
||||
|
|
@ -1213,7 +1266,7 @@ export interface PropertySelector {
|
|||
}
|
||||
export enum PropertySelectorType {
|
||||
Inclusion = 0,
|
||||
Exclusion = 1,
|
||||
Exclusion = 1
|
||||
}
|
||||
export interface PullRequestConfiguration {
|
||||
codeRepositoryReference: CodeRepositoryReference;
|
||||
|
|
@ -1229,7 +1282,7 @@ export interface PullRequestFilter {
|
|||
export enum PullRequestSystemType {
|
||||
None = 0,
|
||||
TfsGit = 1,
|
||||
GitHub = 2,
|
||||
GitHub = 2
|
||||
}
|
||||
export interface PullRequestTrigger extends ReleaseTriggerBase {
|
||||
artifactAlias: string;
|
||||
|
|
@ -1616,13 +1669,14 @@ export enum ReleaseDefinitionExpands {
|
|||
Triggers = 8,
|
||||
Variables = 16,
|
||||
Tags = 32,
|
||||
LastRelease = 64,
|
||||
LastRelease = 64
|
||||
}
|
||||
export interface ReleaseDefinitionGate {
|
||||
tasks: WorkflowTask[];
|
||||
}
|
||||
export interface ReleaseDefinitionGatesOptions {
|
||||
isEnabled: boolean;
|
||||
minimumSuccessDuration: number;
|
||||
samplingInterval: number;
|
||||
stabilizationTime: number;
|
||||
timeout: number;
|
||||
|
|
@ -1636,7 +1690,7 @@ export enum ReleaseDefinitionQueryOrder {
|
|||
IdAscending = 0,
|
||||
IdDescending = 1,
|
||||
NameAscending = 2,
|
||||
NameDescending = 3,
|
||||
NameDescending = 3
|
||||
}
|
||||
export interface ReleaseDefinitionRevision {
|
||||
/**
|
||||
|
|
@ -1703,7 +1757,7 @@ export enum ReleaseDefinitionSource {
|
|||
RestApi = 1,
|
||||
UserInterface = 2,
|
||||
Ibiza = 4,
|
||||
PortalExtensionApi = 8,
|
||||
PortalExtensionApi = 8
|
||||
}
|
||||
export interface ReleaseDefinitionSummary {
|
||||
environments: ReleaseDefinitionEnvironmentSummary[];
|
||||
|
|
@ -1921,16 +1975,18 @@ export enum ReleaseExpands {
|
|||
Approvals = 8,
|
||||
ManualInterventions = 16,
|
||||
Variables = 32,
|
||||
Tags = 64,
|
||||
Tags = 64
|
||||
}
|
||||
export interface ReleaseGates {
|
||||
deploymentJobs: DeploymentJob[];
|
||||
id: number;
|
||||
ignoredGates: IgnoredGate[];
|
||||
lastModifiedOn: Date;
|
||||
runPlanId: string;
|
||||
stabilizationCompletedOn: Date;
|
||||
startedOn: Date;
|
||||
status: GateStatus;
|
||||
succeedingSince: Date;
|
||||
}
|
||||
export interface ReleaseManagementInputValue {
|
||||
/**
|
||||
|
|
@ -1944,14 +2000,14 @@ export interface ReleaseManagementInputValue {
|
|||
}
|
||||
export enum ReleaseQueryOrder {
|
||||
Descending = 0,
|
||||
Ascending = 1,
|
||||
Ascending = 1
|
||||
}
|
||||
export enum ReleaseReason {
|
||||
None = 0,
|
||||
Manual = 1,
|
||||
ContinuousIntegration = 2,
|
||||
Schedule = 3,
|
||||
PullRequest = 4,
|
||||
PullRequest = 4
|
||||
}
|
||||
export interface ReleaseReference {
|
||||
/**
|
||||
|
|
@ -2049,6 +2105,18 @@ export interface ReleaseShallowReference {
|
|||
*/
|
||||
url: string;
|
||||
}
|
||||
export interface ReleaseStartEnvironmentMetadata {
|
||||
/**
|
||||
* Sets release definition environment id.
|
||||
*/
|
||||
definitionEnvironmentId: number;
|
||||
/**
|
||||
* Sets list of environments variables to be overridden at deployment time.
|
||||
*/
|
||||
variables: {
|
||||
[key: string]: ConfigurationVariableValue;
|
||||
};
|
||||
}
|
||||
export interface ReleaseStartMetadata {
|
||||
/**
|
||||
* Sets list of artifact to create a release.
|
||||
|
|
@ -2062,6 +2130,10 @@ export interface ReleaseStartMetadata {
|
|||
* Sets description to create a release.
|
||||
*/
|
||||
description: string;
|
||||
/**
|
||||
* Sets list of environments meta data.
|
||||
*/
|
||||
environmentsMetadata: ReleaseStartEnvironmentMetadata[];
|
||||
/**
|
||||
* Sets 'true' to create release in draft mode, 'false' otherwise.
|
||||
*/
|
||||
|
|
@ -2075,12 +2147,18 @@ export interface ReleaseStartMetadata {
|
|||
* Sets reason to create a release.
|
||||
*/
|
||||
reason: ReleaseReason;
|
||||
/**
|
||||
* Sets list of release variables to be overridden at deployment time.
|
||||
*/
|
||||
variables: {
|
||||
[key: string]: ConfigurationVariableValue;
|
||||
};
|
||||
}
|
||||
export enum ReleaseStatus {
|
||||
Undefined = 0,
|
||||
Draft = 1,
|
||||
Active = 2,
|
||||
Abandoned = 4,
|
||||
Abandoned = 4
|
||||
}
|
||||
export interface ReleaseTask {
|
||||
agentName: string;
|
||||
|
|
@ -2131,7 +2209,7 @@ export enum ReleaseTriggerType {
|
|||
SourceRepo = 3,
|
||||
ContainerImage = 4,
|
||||
Package = 5,
|
||||
PullRequest = 6,
|
||||
PullRequest = 6
|
||||
}
|
||||
export interface ReleaseUpdatedEvent extends RealtimeReleaseEvent {
|
||||
release: Release;
|
||||
|
|
@ -2182,7 +2260,7 @@ export enum ScheduleDays {
|
|||
Friday = 16,
|
||||
Saturday = 32,
|
||||
Sunday = 64,
|
||||
All = 127,
|
||||
All = 127
|
||||
}
|
||||
export interface ScheduledReleaseTrigger extends ReleaseTriggerBase {
|
||||
/**
|
||||
|
|
@ -2192,14 +2270,14 @@ export interface ScheduledReleaseTrigger extends ReleaseTriggerBase {
|
|||
}
|
||||
export enum SenderType {
|
||||
ServiceAccount = 1,
|
||||
RequestingUser = 2,
|
||||
RequestingUser = 2
|
||||
}
|
||||
export interface ServerDeploymentInput extends BaseDeploymentInput {
|
||||
parallelExecution: ExecutionInput;
|
||||
}
|
||||
export enum SingleReleaseExpands {
|
||||
None = 0,
|
||||
Tasks = 1,
|
||||
Tasks = 1
|
||||
}
|
||||
export interface SourceIdInput {
|
||||
id: string;
|
||||
|
|
@ -2210,6 +2288,7 @@ export interface SourcePullRequestVersion {
|
|||
* Pull Request Id for which the release will publish status
|
||||
*/
|
||||
pullRequestId: string;
|
||||
pullRequestMergedAt: Date;
|
||||
/**
|
||||
* Source branch commit Id of the Pull Request for which the release will publish status
|
||||
*/
|
||||
|
|
@ -2242,7 +2321,7 @@ export enum TaskStatus {
|
|||
Skipped = 6,
|
||||
Succeeded = 7,
|
||||
Failed = 8,
|
||||
PartiallySucceeded = 9,
|
||||
PartiallySucceeded = 9
|
||||
}
|
||||
export interface TfvcArtifactDownloadInput extends ArtifactDownloadInputBase {
|
||||
}
|
||||
|
|
@ -2298,7 +2377,7 @@ export interface VariableGroup {
|
|||
export enum VariableGroupActionFilter {
|
||||
None = 0,
|
||||
Manage = 2,
|
||||
Use = 16,
|
||||
Use = 16
|
||||
}
|
||||
export interface VariableGroupProviderData {
|
||||
}
|
||||
|
|
@ -2385,8 +2464,11 @@ export var TypeInfo: {
|
|||
};
|
||||
};
|
||||
ArtifactContributionDefinition: any;
|
||||
ArtifactMetadata: any;
|
||||
ArtifactSourceTrigger: any;
|
||||
ArtifactTypeDefinition: any;
|
||||
ArtifactVersion: any;
|
||||
ArtifactVersionQueryResult: any;
|
||||
AuditAction: {
|
||||
enumValues: {
|
||||
"add": number;
|
||||
|
|
@ -2404,6 +2486,7 @@ export var TypeInfo: {
|
|||
AutoTriggerIssue: any;
|
||||
AzureKeyVaultVariableGroupProviderData: any;
|
||||
AzureKeyVaultVariableValue: any;
|
||||
BuildVersion: any;
|
||||
Change: any;
|
||||
CodeRepositoryReference: any;
|
||||
Condition: any;
|
||||
|
|
@ -2550,8 +2633,10 @@ export var TypeInfo: {
|
|||
"inProgress": number;
|
||||
"succeeded": number;
|
||||
"failed": number;
|
||||
"canceled": number;
|
||||
};
|
||||
};
|
||||
IgnoredGate: any;
|
||||
IssueSource: {
|
||||
enumValues: {
|
||||
"none": number;
|
||||
|
|
@ -2746,6 +2831,7 @@ export var TypeInfo: {
|
|||
"tasks": number;
|
||||
};
|
||||
};
|
||||
SourcePullRequestVersion: any;
|
||||
SourceRepoTrigger: any;
|
||||
SummaryMailSection: any;
|
||||
TaskStatus: {
|
||||
|
|
@ -2912,6 +2998,17 @@ export interface IReleaseEnvironmentNodeExtensionContext extends IExtensionConte
|
|||
}
|
||||
}
|
||||
declare module "ReleaseManagement/Core/RestClient" {
|
||||
/**
|
||||
* ---------------------------------------------------------
|
||||
* Generated file, DO NOT EDIT
|
||||
* ---------------------------------------------------------
|
||||
*
|
||||
* See following wiki page for instructions on how to regenerate:
|
||||
* https://vsowiki.com/index.php?title=Rest_Client_Generation
|
||||
*
|
||||
* Configuration file:
|
||||
* releasemanagement\client\webapi\clientgeneratorconfigs\genclient.json
|
||||
*/
|
||||
import Contracts = require("ReleaseManagement/Core/Contracts");
|
||||
import VSS_FormInput_Contracts = require("VSS/Common/Contracts/FormInput");
|
||||
import VSS_WebApi = require("VSS/WebApi/RestClient");
|
||||
|
|
@ -3174,26 +3271,6 @@ export class CommonMethods2_2To5 extends CommonMethods2To5 {
|
|||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
updateReleaseDefinition(releaseDefinition: Contracts.ReleaseDefinition, project: string): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Get a list of release definitions.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {string} searchText - Get release definitions with names starting with searchText.
|
||||
* @param {Contracts.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
|
||||
* @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
|
||||
* @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
|
||||
* @param {number} top - Number of release definitions to get.
|
||||
* @param {string} continuationToken - Gets the release definitions after the continuation token provided.
|
||||
* @param {Contracts.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
|
||||
* @param {string} path - Gets the release definitions under the specified path.
|
||||
* @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
|
||||
* @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
|
||||
* @return IPromise<Contracts.ReleaseDefinition[]>
|
||||
*/
|
||||
getReleaseDefinitions(project: string, searchText?: string, expand?: Contracts.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: Contracts.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean): IPromise<Contracts.ReleaseDefinition[]>;
|
||||
/**
|
||||
* [Preview API] Get release definition of a given revision.
|
||||
*
|
||||
|
|
@ -3203,15 +3280,6 @@ export class CommonMethods2_2To5 extends CommonMethods2To5 {
|
|||
* @return IPromise<string>
|
||||
*/
|
||||
getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): IPromise<string>;
|
||||
/**
|
||||
* [Preview API] Get a release definition.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Id of the release definition.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Delete a release definition.
|
||||
*
|
||||
|
|
@ -3353,11 +3421,12 @@ export class CommonMethods3To5 extends CommonMethods2_2To5 {
|
|||
* @param {string} project - Project ID or project name
|
||||
* @param {number} releaseId - Id of the release.
|
||||
* @param {Contracts.ApprovalFilters} approvalFilters - A filter which would allow fetching approval steps selectively based on whether it is automated, or manual. This would also decide whether we should fetch pre and post approval snapshots. Assumes All by default
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of properties to include in the results.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Release will contain values for the specified property Ids (if they exist). If not set, properties will not be included.
|
||||
* @param {Contracts.SingleReleaseExpands} expand - A property that should be expanded in the release.
|
||||
* @param {number} topGateRecords - Number of release gate records to get. Default is 5.
|
||||
* @return IPromise<Contracts.Release>
|
||||
*/
|
||||
getRelease(project: string, releaseId: number, approvalFilters?: Contracts.ApprovalFilters, propertyFilters?: string[], expand?: Contracts.SingleReleaseExpands): IPromise<Contracts.Release>;
|
||||
getRelease(project: string, releaseId: number, approvalFilters?: Contracts.ApprovalFilters, propertyFilters?: string[], expand?: Contracts.SingleReleaseExpands, topGateRecords?: number): IPromise<Contracts.Release>;
|
||||
/**
|
||||
* [Preview API] Update manual intervention.
|
||||
*
|
||||
|
|
@ -3466,7 +3535,7 @@ export class CommonMethods3_1To5 extends CommonMethods3To5 {
|
|||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Releases from this release definition Id.
|
||||
* @param {number} definitionEnvironmentId
|
||||
* @param {string} searchText - Releases with names starting with searchText.
|
||||
* @param {string} searchText - Releases with names containing searchText.
|
||||
* @param {string} createdBy - Releases created by this user.
|
||||
* @param {Contracts.ReleaseStatus} statusFilter - Releases that have this status.
|
||||
* @param {number} environmentStatusFilter
|
||||
|
|
@ -3482,7 +3551,7 @@ export class CommonMethods3_1To5 extends CommonMethods3To5 {
|
|||
* @param {string} sourceBranchFilter - Releases with given sourceBranchFilter will be returned.
|
||||
* @param {boolean} isDeleted - Gets the soft deleted releases, if true.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only releases with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Releases will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release from results irrespective of whether it has property set or not.
|
||||
* @param {number[]} releaseIdFilter - A comma-delimited list of releases Ids. Only releases with these Ids will be returned.
|
||||
* @return IPromise<Contracts.Release[]>
|
||||
*/
|
||||
|
|
@ -3694,6 +3763,35 @@ export class CommonMethods4To5 extends CommonMethods3_2To5 {
|
|||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: Contracts.ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Get a list of release definitions.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {string} searchText - Get release definitions with names containing searchText.
|
||||
* @param {Contracts.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
|
||||
* @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
|
||||
* @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
|
||||
* @param {number} top - Number of release definitions to get.
|
||||
* @param {string} continuationToken - Gets the release definitions after the continuation token provided.
|
||||
* @param {Contracts.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
|
||||
* @param {string} path - Gets the release definitions under the specified path.
|
||||
* @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definitions will contain values for the specified property Ids (if they exist). If not set, properties will not be included. Note that this will not filter out any Release Definition from results irrespective of whether it has property set or not.
|
||||
* @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
|
||||
* @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
|
||||
* @return IPromise<Contracts.ReleaseDefinition[]>
|
||||
*/
|
||||
getReleaseDefinitions(project: string, searchText?: string, expand?: Contracts.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: Contracts.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean): IPromise<Contracts.ReleaseDefinition[]>;
|
||||
/**
|
||||
* [Preview API] Get a release definition.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Id of the release definition.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to be retrieved. If set, the returned Release Definition will contain values for the specified property Ids (if they exist). If not set, properties will not be included.
|
||||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
|
|
@ -3729,7 +3827,7 @@ export class CommonMethods4_1To5 extends CommonMethods4To5 {
|
|||
*/
|
||||
getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): IPromise<string>;
|
||||
/**
|
||||
* [Preview API]
|
||||
* [Obsolete - GetTaskAttachments API is deprecated. Use GetReleaseTaskAttachments API instead.]
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} releaseId
|
||||
|
|
@ -3741,7 +3839,7 @@ export class CommonMethods4_1To5 extends CommonMethods4To5 {
|
|||
*/
|
||||
getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): IPromise<Contracts.ReleaseTaskAttachment[]>;
|
||||
/**
|
||||
* [Preview API]
|
||||
* [Obsolete - GetTaskAttachmentContent API is deprecated. Use GetReleaseTaskAttachmentContent API instead.]
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} releaseId
|
||||
|
|
@ -3760,6 +3858,42 @@ export class CommonMethods4_1To5 extends CommonMethods4To5 {
|
|||
*/
|
||||
export class ReleaseHttpClient5 extends CommonMethods4_1To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} releaseId
|
||||
* @param {number} environmentId
|
||||
* @param {number} attemptId
|
||||
* @param {string} planId
|
||||
* @param {string} timelineId
|
||||
* @param {string} recordId
|
||||
* @param {string} type
|
||||
* @param {string} name
|
||||
* @return IPromise<ArrayBuffer>
|
||||
*/
|
||||
getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): IPromise<ArrayBuffer>;
|
||||
/**
|
||||
* [Preview API]
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} releaseId
|
||||
* @param {number} environmentId
|
||||
* @param {number} attemptId
|
||||
* @param {string} planId
|
||||
* @param {string} type
|
||||
* @return IPromise<Contracts.ReleaseTaskAttachment[]>
|
||||
*/
|
||||
getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): IPromise<Contracts.ReleaseTaskAttachment[]>;
|
||||
/**
|
||||
* [Preview API] Updates the gate for a deployment.
|
||||
*
|
||||
* @param {Contracts.GateUpdateMetadata} gateUpdateMetadata - Metadata to patch the Release Gates.
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} gateStepId - Gate step Id.
|
||||
* @return IPromise<Contracts.ReleaseGates>
|
||||
*/
|
||||
updateGates(gateUpdateMetadata: Contracts.GateUpdateMetadata, project: string, gateStepId: number): IPromise<Contracts.ReleaseGates>;
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
|
|
@ -3778,12 +3912,70 @@ export class ReleaseHttpClient4 extends CommonMethods4To5 {
|
|||
*/
|
||||
export class ReleaseHttpClient3_2 extends CommonMethods3_2To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Get a release definition.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Id of the release definition.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Get a list of release definitions.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {string} searchText - Get release definitions with names containing searchText.
|
||||
* @param {Contracts.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
|
||||
* @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
|
||||
* @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
|
||||
* @param {number} top - Number of release definitions to get.
|
||||
* @param {string} continuationToken - Gets the release definitions after the continuation token provided.
|
||||
* @param {Contracts.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
|
||||
* @param {string} path - Gets the release definitions under the specified path.
|
||||
* @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
|
||||
* @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
|
||||
* @return IPromise<Contracts.ReleaseDefinition[]>
|
||||
*/
|
||||
getReleaseDefinitions(project: string, searchText?: string, expand?: Contracts.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: Contracts.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean): IPromise<Contracts.ReleaseDefinition[]>;
|
||||
}
|
||||
/**
|
||||
* @exemptedapi
|
||||
*/
|
||||
export class ReleaseHttpClient3_1 extends CommonMethods3_1To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Get a release definition.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Id of the release definition.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Get a list of release definitions.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {string} searchText - Get release definitions with names containing searchText.
|
||||
* @param {Contracts.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
|
||||
* @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
|
||||
* @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
|
||||
* @param {number} top - Number of release definitions to get.
|
||||
* @param {string} continuationToken - Gets the release definitions after the continuation token provided.
|
||||
* @param {Contracts.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
|
||||
* @param {string} path - Gets the release definitions under the specified path.
|
||||
* @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
|
||||
* @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
|
||||
* @return IPromise<Contracts.ReleaseDefinition[]>
|
||||
*/
|
||||
getReleaseDefinitions(project: string, searchText?: string, expand?: Contracts.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: Contracts.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean): IPromise<Contracts.ReleaseDefinition[]>;
|
||||
/**
|
||||
* [Preview API] Returns throttled queue as per the task hub license of parallel releases
|
||||
*
|
||||
|
|
@ -3798,13 +3990,42 @@ export class ReleaseHttpClient3_1 extends CommonMethods3_1To5 {
|
|||
*/
|
||||
export class ReleaseHttpClient3 extends CommonMethods3To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Get a release definition.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Id of the release definition.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Get a list of release definitions.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {string} searchText - Get release definitions with names containing searchText.
|
||||
* @param {Contracts.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
|
||||
* @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
|
||||
* @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
|
||||
* @param {number} top - Number of release definitions to get.
|
||||
* @param {string} continuationToken - Gets the release definitions after the continuation token provided.
|
||||
* @param {Contracts.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
|
||||
* @param {string} path - Gets the release definitions under the specified path.
|
||||
* @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
|
||||
* @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
|
||||
* @return IPromise<Contracts.ReleaseDefinition[]>
|
||||
*/
|
||||
getReleaseDefinitions(project: string, searchText?: string, expand?: Contracts.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: Contracts.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean): IPromise<Contracts.ReleaseDefinition[]>;
|
||||
/**
|
||||
* [Preview API] Get Releases
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Releases from this release definition Id.
|
||||
* @param {number} definitionEnvironmentId
|
||||
* @param {string} searchText - Releases with names starting with searchText.
|
||||
* @param {string} searchText - Releases with names containing searchText.
|
||||
* @param {string} createdBy - Releases created by this user.
|
||||
* @param {Contracts.ReleaseStatus} statusFilter - Releases that have this status.
|
||||
* @param {number} environmentStatusFilter
|
||||
|
|
@ -3839,6 +4060,35 @@ export class ReleaseHttpClient3 extends CommonMethods3To5 {
|
|||
*/
|
||||
export class ReleaseHttpClient2_3 extends CommonMethods2_2To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Get a release definition.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Id of the release definition.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Get a list of release definitions.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {string} searchText - Get release definitions with names containing searchText.
|
||||
* @param {Contracts.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
|
||||
* @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
|
||||
* @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
|
||||
* @param {number} top - Number of release definitions to get.
|
||||
* @param {string} continuationToken - Gets the release definitions after the continuation token provided.
|
||||
* @param {Contracts.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
|
||||
* @param {string} path - Gets the release definitions under the specified path.
|
||||
* @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
|
||||
* @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
|
||||
* @return IPromise<Contracts.ReleaseDefinition[]>
|
||||
*/
|
||||
getReleaseDefinitions(project: string, searchText?: string, expand?: Contracts.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: Contracts.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean): IPromise<Contracts.ReleaseDefinition[]>;
|
||||
/**
|
||||
* [Preview API] Get A Release
|
||||
*
|
||||
|
|
@ -3847,16 +4097,17 @@ export class ReleaseHttpClient2_3 extends CommonMethods2_2To5 {
|
|||
* @param {Contracts.ApprovalFilters} approvalFilters - A filter which would allow fetching approval steps selectively based on whether it is automated, or manual. This would also decide whether we should fetch pre and post approval snapshots. Assumes All by default
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of properties to include in the results.
|
||||
* @param {Contracts.SingleReleaseExpands} expand - A property that should be expanded in the release.
|
||||
* @param {number} topGateRecords
|
||||
* @return IPromise<Contracts.Release>
|
||||
*/
|
||||
getRelease(project: string, releaseId: number, approvalFilters?: Contracts.ApprovalFilters, propertyFilters?: string[], expand?: Contracts.SingleReleaseExpands): IPromise<Contracts.Release>;
|
||||
getRelease(project: string, releaseId: number, approvalFilters?: Contracts.ApprovalFilters, propertyFilters?: string[], expand?: Contracts.SingleReleaseExpands, topGateRecords?: number): IPromise<Contracts.Release>;
|
||||
/**
|
||||
* [Preview API] Get a list of releases
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Releases from this release definition Id.
|
||||
* @param {number} definitionEnvironmentId
|
||||
* @param {string} searchText - Releases with names starting with searchText.
|
||||
* @param {string} searchText - Releases with names containing searchText.
|
||||
* @param {string} createdBy - Releases created by this user.
|
||||
* @param {Contracts.ReleaseStatus} statusFilter - Releases that have this status.
|
||||
* @param {number} environmentStatusFilter
|
||||
|
|
@ -3883,6 +4134,35 @@ export class ReleaseHttpClient2_3 extends CommonMethods2_2To5 {
|
|||
*/
|
||||
export class ReleaseHttpClient2_2 extends CommonMethods2_2To5 {
|
||||
constructor(rootRequestPath: string, options?: VSS_WebApi.IVssHttpClientOptions);
|
||||
/**
|
||||
* [Preview API] Get a release definition.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Id of the release definition.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @return IPromise<Contracts.ReleaseDefinition>
|
||||
*/
|
||||
getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): IPromise<Contracts.ReleaseDefinition>;
|
||||
/**
|
||||
* [Preview API] Get a list of release definitions.
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {string} searchText - Get release definitions with names containing searchText.
|
||||
* @param {Contracts.ReleaseDefinitionExpands} expand - The properties that should be expanded in the list of Release definitions.
|
||||
* @param {string} artifactType - Release definitions with given artifactType will be returned. Values can be Build, Jenkins, GitHub, Nuget, Team Build (external), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild.
|
||||
* @param {string} artifactSourceId - Release definitions with given artifactSourceId will be returned. e.g. For build it would be {projectGuid}:{BuildDefinitionId}, for Jenkins it would be {JenkinsConnectionId}:{JenkinsDefinitionId}, for TfsOnPrem it would be {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. For third-party artifacts e.g. TeamCity, BitBucket you may refer 'uniqueSourceIdentifier' inside vss-extension.json at https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions.
|
||||
* @param {number} top - Number of release definitions to get.
|
||||
* @param {string} continuationToken - Gets the release definitions after the continuation token provided.
|
||||
* @param {Contracts.ReleaseDefinitionQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdAscending'.
|
||||
* @param {string} path - Gets the release definitions under the specified path.
|
||||
* @param {boolean} isExactNameMatch - 'true'to gets the release definitions with exact match as specified in searchText. Default is 'false'.
|
||||
* @param {string[]} tagFilter - A comma-delimited list of tags. Only release definitions with these tags will be returned.
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of extended properties to retrieve.
|
||||
* @param {string[]} definitionIdFilter - A comma-delimited list of release definitions to retrieve.
|
||||
* @param {boolean} isDeleted - 'true' to get release definitions that has been deleted. Default is 'false'
|
||||
* @return IPromise<Contracts.ReleaseDefinition[]>
|
||||
*/
|
||||
getReleaseDefinitions(project: string, searchText?: string, expand?: Contracts.ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: Contracts.ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean): IPromise<Contracts.ReleaseDefinition[]>;
|
||||
/**
|
||||
* [Preview API] Get A Release
|
||||
*
|
||||
|
|
@ -3891,16 +4171,17 @@ export class ReleaseHttpClient2_2 extends CommonMethods2_2To5 {
|
|||
* @param {Contracts.ApprovalFilters} approvalFilters - A filter which would allow fetching approval steps selectively based on whether it is automated, or manual. This would also decide whether we should fetch pre and post approval snapshots. Assumes All by default
|
||||
* @param {string[]} propertyFilters - A comma-delimited list of properties to include in the results.
|
||||
* @param {Contracts.SingleReleaseExpands} expand - A property that should be expanded in the release.
|
||||
* @param {number} topGateRecords
|
||||
* @return IPromise<Contracts.Release>
|
||||
*/
|
||||
getRelease(project: string, releaseId: number, approvalFilters?: Contracts.ApprovalFilters, propertyFilters?: string[], expand?: Contracts.SingleReleaseExpands): IPromise<Contracts.Release>;
|
||||
getRelease(project: string, releaseId: number, approvalFilters?: Contracts.ApprovalFilters, propertyFilters?: string[], expand?: Contracts.SingleReleaseExpands, topGateRecords?: number): IPromise<Contracts.Release>;
|
||||
/**
|
||||
* [Preview API] Get a list of releases
|
||||
*
|
||||
* @param {string} project - Project ID or project name
|
||||
* @param {number} definitionId - Releases from this release definition Id.
|
||||
* @param {number} definitionEnvironmentId
|
||||
* @param {string} searchText - Releases with names starting with searchText.
|
||||
* @param {string} searchText - Releases with names containing searchText.
|
||||
* @param {string} createdBy - Releases created by this user.
|
||||
* @param {Contracts.ReleaseStatus} statusFilter - Releases that have this status.
|
||||
* @param {number} environmentStatusFilter
|
||||
|
|
|
|||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Загрузка…
Ссылка в новой задаче