azure-devops-extension-api 4.270.0 → 5.271.0

package/esm/ServiceHooks/ServiceHooksClient.js

@@ -0,0 +1,375 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+import { RestClientBase } from "../Common/RestClientBase";
+export class ServiceHooksRestClient extends RestClientBase {
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Get details about a specific consumer action.
+     *
+     * @param consumerId - ID for a consumer.
+     * @param consumerActionId - ID for a consumerActionId.
+     * @param publisherId -
+     */
+    async getConsumerAction(consumerId, consumerActionId, publisherId) {
+        const queryValues = {
+            publisherId: publisherId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/consumers/{consumerId}/Actions/{consumerActionId}",
+            routeValues: {
+                consumerId: consumerId,
+                consumerActionId: consumerActionId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a list of consumer actions for a specific consumer.
+     *
+     * @param consumerId - ID for a consumer.
+     * @param publisherId -
+     */
+    async listConsumerActions(consumerId, publisherId) {
+        const queryValues = {
+            publisherId: publisherId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/consumers/{consumerId}/Actions/{consumerActionId}",
+            routeValues: {
+                consumerId: consumerId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a specific consumer service. Optionally filter out consumer actions that do not support any event types for the specified publisher.
+     *
+     * @param consumerId - ID for a consumer.
+     * @param publisherId -
+     */
+    async getConsumer(consumerId, publisherId) {
+        const queryValues = {
+            publisherId: publisherId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/Consumers/{consumerId}",
+            routeValues: {
+                consumerId: consumerId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a list of available service hook consumer services. Optionally filter by consumers that support at least one event type from the specific publisher.
+     *
+     * @param publisherId -
+     */
+    async listConsumers(publisherId) {
+        const queryValues = {
+            publisherId: publisherId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/Consumers/{consumerId}",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * @param subscriptionId -
+     */
+    async getSubscriptionDiagnostics(subscriptionId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/subscriptions/{subscriptionId}/diagnostics",
+            routeValues: {
+                subscriptionId: subscriptionId
+            }
+        });
+    }
+    /**
+     * @param updateParameters -
+     * @param subscriptionId -
+     */
+    async updateSubscriptionDiagnostics(updateParameters, subscriptionId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PUT",
+            routeTemplate: "_apis/hooks/subscriptions/{subscriptionId}/diagnostics",
+            routeValues: {
+                subscriptionId: subscriptionId
+            },
+            body: updateParameters
+        });
+    }
+    /**
+     * Get a specific event type.
+     *
+     * @param publisherId - ID for a publisher.
+     * @param eventTypeId -
+     */
+    async getEventType(publisherId, eventTypeId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/publishers/{publisherId}/EventTypes/{eventTypeId}",
+            routeValues: {
+                publisherId: publisherId,
+                eventTypeId: eventTypeId
+            }
+        });
+    }
+    /**
+     * Get the event types for a specific publisher.
+     *
+     * @param publisherId - ID for a publisher.
+     */
+    async listEventTypes(publisherId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/publishers/{publisherId}/EventTypes/{eventTypeId}",
+            routeValues: {
+                publisherId: publisherId
+            }
+        });
+    }
+    /**
+     * Publish an external event.
+     *
+     * @param publisherId -
+     * @param channelId -
+     */
+    async publishExternalEvent(publisherId, channelId) {
+        const queryValues = {
+            publisherId: publisherId,
+            channelId: channelId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/public/hooks/ExternalEvents",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get a specific notification for a subscription.
+     *
+     * @param subscriptionId - ID for a subscription.
+     * @param notificationId -
+     */
+    async getNotification(subscriptionId, notificationId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/subscriptions/{subscriptionId}/Notifications/{notificationId}",
+            routeValues: {
+                subscriptionId: subscriptionId,
+                notificationId: notificationId
+            }
+        });
+    }
+    /**
+     * Get a list of notifications for a specific subscription. A notification includes details about the event, the request to and the response from the consumer service.
+     *
+     * @param subscriptionId - ID for a subscription.
+     * @param maxResults - Maximum number of notifications to return. Default is **100**.
+     * @param status - Get only notifications with this status.
+     * @param result - Get only notifications with this result type.
+     */
+    async getNotifications(subscriptionId, maxResults, status, result) {
+        const queryValues = {
+            maxResults: maxResults,
+            status: status,
+            result: result
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/subscriptions/{subscriptionId}/Notifications/{notificationId}",
+            routeValues: {
+                subscriptionId: subscriptionId
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Query for notifications. A notification includes details about the event, the request to and the response from the consumer service.
+     *
+     * @param query -
+     */
+    async queryNotifications(query) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/hooks/NotificationsQuery",
+            body: query
+        });
+    }
+    /**
+     * @param inputValuesQuery -
+     * @param publisherId -
+     */
+    async queryInputValues(inputValuesQuery, publisherId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/hooks/publishers/{publisherId}/inputValuesQuery",
+            routeValues: {
+                publisherId: publisherId
+            },
+            body: inputValuesQuery
+        });
+    }
+    /**
+     * Get a specific service hooks publisher.
+     *
+     * @param publisherId - ID for a publisher.
+     */
+    async getPublisher(publisherId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/Publishers/{publisherId}",
+            routeValues: {
+                publisherId: publisherId
+            }
+        });
+    }
+    /**
+     * Get a list of publishers.
+     *
+     */
+    async listPublishers() {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/Publishers/{publisherId}"
+        });
+    }
+    /**
+     * Query for service hook publishers.
+     *
+     * @param query -
+     */
+    async queryPublishers(query) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/hooks/PublishersQuery",
+            body: query
+        });
+    }
+    /**
+     * Create a subscription.
+     *
+     * @param subscription - Subscription to be created.
+     */
+    async createSubscription(subscription) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/hooks/Subscriptions/{subscriptionId}",
+            body: subscription
+        });
+    }
+    /**
+     * Delete a specific service hooks subscription.
+     *
+     * @param subscriptionId - ID for a subscription.
+     */
+    async deleteSubscription(subscriptionId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "_apis/hooks/Subscriptions/{subscriptionId}",
+            routeValues: {
+                subscriptionId: subscriptionId
+            }
+        });
+    }
+    /**
+     * Get a specific service hooks subscription.
+     *
+     * @param subscriptionId - ID for a subscription.
+     */
+    async getSubscription(subscriptionId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/Subscriptions/{subscriptionId}",
+            routeValues: {
+                subscriptionId: subscriptionId
+            }
+        });
+    }
+    /**
+     * Get a list of subscriptions.
+     *
+     * @param publisherId - ID for a subscription.
+     * @param eventType - The event type to filter on (if any).
+     * @param consumerId - ID for a consumer.
+     * @param consumerActionId - ID for a consumerActionId.
+     */
+    async listSubscriptions(publisherId, eventType, consumerId, consumerActionId) {
+        const queryValues = {
+            publisherId: publisherId,
+            eventType: eventType,
+            consumerId: consumerId,
+            consumerActionId: consumerActionId
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/hooks/Subscriptions/{subscriptionId}",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update a subscription. \<param name="subscriptionId"\>ID for a subscription that you wish to update.\</param\>
+     *
+     * @param subscription -
+     * @param subscriptionId -
+     */
+    async replaceSubscription(subscription, subscriptionId) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "PUT",
+            routeTemplate: "_apis/hooks/Subscriptions/{subscriptionId}",
+            routeValues: {
+                subscriptionId: subscriptionId
+            },
+            body: subscription
+        });
+    }
+    /**
+     * Query for service hook subscriptions.
+     *
+     * @param query -
+     */
+    async createSubscriptionsQuery(query) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/hooks/SubscriptionsQuery",
+            body: query
+        });
+    }
+    /**
+     * Sends a test notification. This is useful for verifying the configuration of an updated or new service hooks subscription.
+     *
+     * @param testNotification -
+     * @param useRealData - Only allow testing with real data in existing subscriptions.
+     */
+    async createTestNotification(testNotification, useRealData) {
+        const queryValues = {
+            useRealData: useRealData
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/hooks/TestNotifications/{notificationId}",
+            queryParams: queryValues,
+            body: testNotification
+        });
+    }
+}

package/esm/ServiceHooks/ServiceHooksClient.min.js

@@ -0,0 +1 @@
+import{RestClientBase}from"../Common/RestClientBase";export class ServiceHooksRestClient extends RestClientBase{constructor(e){super(e)}async getConsumerAction(e,s,i){const t={publisherId:i};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/consumers/{consumerId}/Actions/{consumerActionId}",routeValues:{consumerId:e,consumerActionId:s},queryParams:t})}async listConsumerActions(e,s){const i={publisherId:s};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/consumers/{consumerId}/Actions/{consumerActionId}",routeValues:{consumerId:e},queryParams:i})}async getConsumer(e,s){const i={publisherId:s};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/Consumers/{consumerId}",routeValues:{consumerId:e},queryParams:i})}async listConsumers(e){const s={publisherId:e};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/Consumers/{consumerId}",queryParams:s})}async getSubscriptionDiagnostics(e){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/subscriptions/{subscriptionId}/diagnostics",routeValues:{subscriptionId:e}})}async updateSubscriptionDiagnostics(e,s){return this.beginRequest({apiVersion:"7.2-preview.1",method:"PUT",routeTemplate:"_apis/hooks/subscriptions/{subscriptionId}/diagnostics",routeValues:{subscriptionId:s},body:e})}async getEventType(e,s){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/publishers/{publisherId}/EventTypes/{eventTypeId}",routeValues:{publisherId:e,eventTypeId:s}})}async listEventTypes(e){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/publishers/{publisherId}/EventTypes/{eventTypeId}",routeValues:{publisherId:e}})}async publishExternalEvent(e,s){const i={publisherId:e,channelId:s};return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/public/hooks/ExternalEvents",queryParams:i})}async getNotification(e,s){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/subscriptions/{subscriptionId}/Notifications/{notificationId}",routeValues:{subscriptionId:e,notificationId:s}})}async getNotifications(e,s,i,t){const r={maxResults:s,status:i,result:t};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/subscriptions/{subscriptionId}/Notifications/{notificationId}",routeValues:{subscriptionId:e},queryParams:r})}async queryNotifications(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/hooks/NotificationsQuery",body:e})}async queryInputValues(e,s){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/hooks/publishers/{publisherId}/inputValuesQuery",routeValues:{publisherId:s},body:e})}async getPublisher(e){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/Publishers/{publisherId}",routeValues:{publisherId:e}})}async listPublishers(){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/Publishers/{publisherId}"})}async queryPublishers(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/hooks/PublishersQuery",body:e})}async createSubscription(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/hooks/Subscriptions/{subscriptionId}",body:e})}async deleteSubscription(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"DELETE",routeTemplate:"_apis/hooks/Subscriptions/{subscriptionId}",routeValues:{subscriptionId:e}})}async getSubscription(e){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/Subscriptions/{subscriptionId}",routeValues:{subscriptionId:e}})}async listSubscriptions(e,s,i,t){const r={publisherId:e,eventType:s,consumerId:i,consumerActionId:t};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/hooks/Subscriptions/{subscriptionId}",queryParams:r})}async replaceSubscription(e,s){return this.beginRequest({apiVersion:"7.2-preview.1",method:"PUT",routeTemplate:"_apis/hooks/Subscriptions/{subscriptionId}",routeValues:{subscriptionId:s},body:e})}async createSubscriptionsQuery(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/hooks/SubscriptionsQuery",body:e})}async createTestNotification(e,s){const i={useRealData:s};return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/hooks/TestNotifications/{notificationId}",queryParams:i,body:e})}};

package/esm/ServiceHooks/index.js

@@ -0,0 +1,2 @@
+export * from "./ServiceHooks";
+export * from "./ServiceHooksClient";

package/esm/ServiceHooks/index.min.js

@@ -0,0 +1 @@
+export*from"./ServiceHooks";export*from"./ServiceHooksClient";