import type { DetailedInvocation } from '../models/DetailedInvocation.js'; import type { RestInvocationHistory } from '../models/RestInvocationHistory.js'; import type { RestWebhook } from '../models/RestWebhook.js'; import type { Webhook } from '../models/Webhook.js'; import type { CancelablePromise } from '../core/CancelablePromise.js'; export declare class WebhooksService { /** * Find webhooks * Find webhooks. The authenticated user must be an administrator to call this resource. * @param limit the limit of the number of items to return, this may be restricted by fixed system limits. * @param start the start point of the collection to return * @param event list of webhook event ids to filter for * @param statistics if statistics should be provided for all found webhooks. * @returns any returns a list of webhooks. * @throws ApiError */ static findWebhooks(limit?: string, start?: string, event?: string, statistics?: string): CancelablePromise<{ results?: Array; totalCount?: number; start?: number; limit?: number; size?: number; _links?: { base?: string; context?: string; self?: string; next?: string; prev?: string; }; }>; /** * Create webhook * Create a webhook via the URL. The authenticated user must be an administrator to call this resource. * @param requestBody the webhook to be created. * @returns Webhook returns a created webhook. * @throws ApiError */ static createWebhook(requestBody: RestWebhook): CancelablePromise; /** * Get webhook * Get a webhook by id. The authenticated user must be an administrator to call this resource. * @param webhookId id of the webhook * @param statistics * @returns RestWebhook returns a webhook. * @throws ApiError */ static getWebhook(webhookId: string, statistics?: boolean): CancelablePromise; /** * Update webhook * Update an existing webhook. The authenticated user must be an administrator to call this resource. * @param webhookId the existing webhook id * @param requestBody the representation of the updated values for the webhook * @returns RestWebhook returns a webhook. * @throws ApiError */ static updateWebhook(webhookId: string, requestBody: RestWebhook): CancelablePromise; /** * Delete webhook * Delete a webhook via the URL. The authenticated user must be an administrator to call this resource. * @param webhookId the id of the webhook to be deleted. * @returns void * @throws ApiError */ static deleteWebhook(webhookId: string): CancelablePromise; /** * Get latest invocations * Get the latest invocations for a specific webhook. The authenticated user must be an administrator to call this resource. * @param webhookId id of the webhook * @param outcomes the outcome to filter for. Can be SUCCESS, FAILURE, ERROR. None specified means that the all will be considered. * @param event the string id of a specific event to retrieve the last invocation for. * @param outcome * @returns DetailedInvocation returns a webhook invocation dataset. * @throws ApiError */ static getLatestInvocation(webhookId: string, outcomes?: string, event?: string, outcome?: Array): CancelablePromise; /** * Get statistic * Get the statistics for a specific webhook. The authenticated user must be an administrator to call this resource. * @param webhookId id of the webhook * @param event the string id of a specific event to retrieve the last invocation for. * @returns RestInvocationHistory returns a webhook invocation dataset. * @throws ApiError */ static getStatistics(webhookId: string, event?: string): CancelablePromise; /** * Get statistics summary * Get the statistics summary for a specific webhook. The authenticated user must be an administrator to call this resource. * @param webhookId id of the webhook * @returns RestInvocationHistory returns a webhook invocation dataset. * @throws ApiError */ static getStatisticsSummary(webhookId: string): CancelablePromise; /** * Test webhook * Test connectivity to a specific endpoint. The authenticated user must be an administrator to call this resource. * @param url the url in which to connect to * @returns any returns a webhook. * @throws ApiError */ static testWebhook(url: string): CancelablePromise; } //# sourceMappingURL=WebhooksService.d.ts.map