claude-flow
Version:
Enterprise-grade AI agent orchestration with ruv-swarm integration (Alpha Release)
176 lines (175 loc) • 11 kB
TypeScript
import basem = require('./ClientApiBases');
import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
import NotificationInterfaces = require("./interfaces/NotificationInterfaces");
import VSSInterfaces = require("./interfaces/common/VSSInterfaces");
export interface INotificationApi extends basem.ClientApiBase {
constructor(operation: NotificationInterfaces.BatchNotificationOperation): Promise<void>;
constructor(source: string, entryId?: string, startTime?: Date, endTime?: Date): Promise<NotificationInterfaces.INotificationDiagnosticLog[]>;
constructor(subscriptionId: string): Promise<NotificationInterfaces.SubscriptionDiagnostics>;
constructor(updateParameters: NotificationInterfaces.UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): Promise<NotificationInterfaces.SubscriptionDiagnostics>;
constructor(notificationEvent: VSSInterfaces.VssNotificationEvent): Promise<VSSInterfaces.VssNotificationEvent>;
constructor(transformRequest: NotificationInterfaces.EventTransformRequest): Promise<NotificationInterfaces.EventTransformResult>;
constructor(inputValuesQuery: NotificationInterfaces.FieldValuesQuery, eventType: string): Promise<NotificationInterfaces.NotificationEventField[]>;
constructor(eventType: string): Promise<NotificationInterfaces.NotificationEventType>;
constructor(publisherId?: string): Promise<NotificationInterfaces.NotificationEventType[]>;
constructor(notificationId: number): Promise<NotificationInterfaces.NotificationReason>;
constructor(notificationIds?: number): Promise<NotificationInterfaces.NotificationReason[]>;
constructor(): Promise<NotificationInterfaces.NotificationAdminSettings>;
constructor(updateParameters: NotificationInterfaces.NotificationAdminSettingsUpdateParameters): Promise<NotificationInterfaces.NotificationAdminSettings>;
constructor(subscriberId: string): Promise<NotificationInterfaces.NotificationSubscriber>;
constructor(updateParameters: NotificationInterfaces.NotificationSubscriberUpdateParameters, subscriberId: string): Promise<NotificationInterfaces.NotificationSubscriber>;
constructor(subscriptionQuery: NotificationInterfaces.SubscriptionQuery): Promise<NotificationInterfaces.NotificationSubscription[]>;
constructor(createParameters: NotificationInterfaces.NotificationSubscriptionCreateParameters): Promise<NotificationInterfaces.NotificationSubscription>;
constructor(subscriptionId: string): Promise<void>;
constructor(subscriptionId: string, queryFlags?: NotificationInterfaces.SubscriptionQueryFlags): Promise<NotificationInterfaces.NotificationSubscription>;
constructor(targetId?: string, ids?: string[], queryFlags?: NotificationInterfaces.SubscriptionQueryFlags): Promise<NotificationInterfaces.NotificationSubscription[]>;
constructor(updateParameters: NotificationInterfaces.NotificationSubscriptionUpdateParameters, subscriptionId: string): Promise<NotificationInterfaces.NotificationSubscription>;
constructor(): Promise<NotificationInterfaces.NotificationSubscriptionTemplate[]>;
constructor(notificationEvent: VSSInterfaces.VssNotificationEvent): Promise<VSSInterfaces.VssNotificationEvent>;
constructor(userSettings: NotificationInterfaces.SubscriptionUserSettings, subscriptionId: string, userId: string): Promise<NotificationInterfaces.SubscriptionUserSettings>;
}
export declare class NotificationApi extends basem.ClientApiBase implements INotificationApi {
constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions);
/**
* @param {NotificationInterfaces.BatchNotificationOperation} operation
*/
constructor(operation: NotificationInterfaces.BatchNotificationOperation): Promise<void>;
/**
* Get a list of diagnostic logs for this service.
*
* @param {string} source - ID specifying which type of logs to check diagnostics for.
* @param {string} entryId - The ID of the specific log to query for.
* @param {Date} startTime - Start time for the time range to query in.
* @param {Date} endTime - End time for the time range to query in.
*/
constructor(source: string, entryId?: string, startTime?: Date, endTime?: Date): Promise<NotificationInterfaces.INotificationDiagnosticLog[]>;
/**
* Get the diagnostics settings for a subscription.
*
* @param {string} subscriptionId - The id of the notifications subscription.
*/
constructor(subscriptionId: string): Promise<NotificationInterfaces.SubscriptionDiagnostics>;
/**
* Update the diagnostics settings for a subscription.
*
* @param {NotificationInterfaces.UpdateSubscripitonDiagnosticsParameters} updateParameters
* @param {string} subscriptionId - The id of the notifications subscription.
*/
constructor(updateParameters: NotificationInterfaces.UpdateSubscripitonDiagnosticsParameters, subscriptionId: string): Promise<NotificationInterfaces.SubscriptionDiagnostics>;
/**
* Publish an event. This request must be directed to the service "extmgmt".
*
* @param {VSSInterfaces.VssNotificationEvent} notificationEvent
*/
constructor(notificationEvent: VSSInterfaces.VssNotificationEvent): Promise<VSSInterfaces.VssNotificationEvent>;
/**
* Tranform a notification event.
*
* @param {NotificationInterfaces.EventTransformRequest} transformRequest - Object to be transformed.
*/
constructor(transformRequest: NotificationInterfaces.EventTransformRequest): Promise<NotificationInterfaces.EventTransformResult>;
/**
* @param {NotificationInterfaces.FieldValuesQuery} inputValuesQuery
* @param {string} eventType
*/
constructor(inputValuesQuery: NotificationInterfaces.FieldValuesQuery, eventType: string): Promise<NotificationInterfaces.NotificationEventField[]>;
/**
* Get a specific event type.
*
* @param {string} eventType - The ID of the event type.
*/
constructor(eventType: string): Promise<NotificationInterfaces.NotificationEventType>;
/**
* List available event types for this service. Optionally filter by only event types for the specified publisher.
*
* @param {string} publisherId - Limit to event types for this publisher
*/
constructor(publisherId?: string): Promise<NotificationInterfaces.NotificationEventType[]>;
/**
* @param {number} notificationId
*/
constructor(notificationId: number): Promise<NotificationInterfaces.NotificationReason>;
/**
* @param {number} notificationIds
*/
constructor(notificationIds?: number): Promise<NotificationInterfaces.NotificationReason[]>;
/**
*/
constructor(): Promise<NotificationInterfaces.NotificationAdminSettings>;
/**
* @param {NotificationInterfaces.NotificationAdminSettingsUpdateParameters} updateParameters
*/
constructor(updateParameters: NotificationInterfaces.NotificationAdminSettingsUpdateParameters): Promise<NotificationInterfaces.NotificationAdminSettings>;
/**
* Get delivery preferences of a notifications subscriber.
*
* @param {string} subscriberId - ID of the user or group.
*/
constructor(subscriberId: string): Promise<NotificationInterfaces.NotificationSubscriber>;
/**
* Update delivery preferences of a notifications subscriber.
*
* @param {NotificationInterfaces.NotificationSubscriberUpdateParameters} updateParameters
* @param {string} subscriberId - ID of the user or group.
*/
constructor(updateParameters: NotificationInterfaces.NotificationSubscriberUpdateParameters, subscriberId: string): Promise<NotificationInterfaces.NotificationSubscriber>;
/**
* Query for subscriptions. A subscription is returned if it matches one or more of the specified conditions.
*
* @param {NotificationInterfaces.SubscriptionQuery} subscriptionQuery
*/
constructor(subscriptionQuery: NotificationInterfaces.SubscriptionQuery): Promise<NotificationInterfaces.NotificationSubscription[]>;
/**
* Create a new subscription.
*
* @param {NotificationInterfaces.NotificationSubscriptionCreateParameters} createParameters
*/
constructor(createParameters: NotificationInterfaces.NotificationSubscriptionCreateParameters): Promise<NotificationInterfaces.NotificationSubscription>;
/**
* Delete a subscription.
*
* @param {string} subscriptionId
*/
constructor(subscriptionId: string): Promise<void>;
/**
* Get a notification subscription by its ID.
*
* @param {string} subscriptionId
* @param {NotificationInterfaces.SubscriptionQueryFlags} queryFlags
*/
constructor(subscriptionId: string, queryFlags?: NotificationInterfaces.SubscriptionQueryFlags): Promise<NotificationInterfaces.NotificationSubscription>;
/**
* Get a list of notification subscriptions, either by subscription IDs or by all subscriptions for a given user or group.
*
* @param {string} targetId - User or Group ID
* @param {string[]} ids - List of subscription IDs
* @param {NotificationInterfaces.SubscriptionQueryFlags} queryFlags
*/
constructor(targetId?: string, ids?: string[], queryFlags?: NotificationInterfaces.SubscriptionQueryFlags): Promise<NotificationInterfaces.NotificationSubscription[]>;
/**
* 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.
*
* @param {NotificationInterfaces.NotificationSubscriptionUpdateParameters} updateParameters
* @param {string} subscriptionId
*/
constructor(updateParameters: NotificationInterfaces.NotificationSubscriptionUpdateParameters, subscriptionId: string): Promise<NotificationInterfaces.NotificationSubscription>;
/**
* Get available subscription templates.
*
*/
constructor(): Promise<NotificationInterfaces.NotificationSubscriptionTemplate[]>;
/**
* Publish an event. This request is only for the Token service since it's a deploy only service.
*
* @param {VSSInterfaces.VssNotificationEvent} notificationEvent
*/
constructor(notificationEvent: VSSInterfaces.VssNotificationEvent): Promise<VSSInterfaces.VssNotificationEvent>;
/**
* 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.
*
* @param {NotificationInterfaces.SubscriptionUserSettings} userSettings
* @param {string} subscriptionId
* @param {string} userId - ID of the user
*/
constructor(userSettings: NotificationInterfaces.SubscriptionUserSettings, subscriptionId: string, userId: string): Promise<NotificationInterfaces.SubscriptionUserSettings>;
}