btcpay-greenfield-node-client/dist/services/WebhooksService.d.ts

## Installation

import type { WebhookData } from '../models/WebhookData';
import type { WebhookDataBase } from '../models/WebhookDataBase';
import type { WebhookDataCreate } from '../models/WebhookDataCreate';
import type { WebhookDataList } from '../models/WebhookDataList';
import type { WebhookDeliveryData } from '../models/WebhookDeliveryData';
import type { WebhookDeliveryList } from '../models/WebhookDeliveryList';
export declare class WebhooksService {
    /**
     * Get webhooks of a store
     * View webhooks of a store
     * @returns WebhookDataList List of webhooks
     * @throws ApiError
     */
    static webhokksGetWebhooks({ storeId, }: {
        /** The store id **/
        storeId: string;
    }): Promise<WebhookDataList>;
    /**
     * Create a new webhook
     * Create a new webhook
     * @returns WebhookDataCreate Information about the new webhook
     * @throws ApiError
     */
    static postWebhooksService({ storeId, requestBody, }: {
        /** The store id **/
        storeId: string;
        requestBody: WebhookDataCreate;
    }): Promise<WebhookDataCreate>;
    /**
     * Get a webhook of a store
     * View webhook of a store
     * @returns WebhookData A webhook
     * @throws ApiError
     */
    static webhokksGetWebhook({ storeId, webhookId, }: {
        /** The store id **/
        storeId: string;
        /** The webhook id **/
        webhookId: string;
    }): Promise<WebhookData>;
    /**
     * Update a webhook
     * Update a webhook
     * @returns WebhookData Information about the updated webhook
     * @throws ApiError
     */
    static putWebhooksService({ storeId, webhookId, requestBody, }: {
        /** The store id **/
        storeId: string;
        /** The webhook id **/
        webhookId: string;
        requestBody: WebhookDataBase;
    }): Promise<WebhookData>;
    /**
     * Delete a webhook
     * Delete a webhook
     * @returns any The webhook has been deleted
     * @throws ApiError
     */
    static deleteWebhooksService({ storeId, webhookId, requestBody, }: {
        /** The store id **/
        storeId: string;
        /** The webhook id **/
        webhookId: string;
        requestBody: WebhookDataBase;
    }): Promise<any>;
    /**
     * Get latest deliveries
     * List the latest deliveries to the webhook, ordered from the most recent
     * @returns WebhookDeliveryList List of deliveries
     * @throws ApiError
     */
    static getWebhooksService({ storeId, webhookId, count, }: {
        /** The store id **/
        storeId: string;
        /** The webhook id **/
        webhookId: string;
        /** The number of latest deliveries to fetch **/
        count?: string;
    }): Promise<WebhookDeliveryList>;
    /**
     * Get a webhook delivery
     * Information about a webhook delivery
     * @returns WebhookDeliveryData Information about a delivery
     * @throws ApiError
     */
    static getWebhooksService1({ storeId, webhookId, deliveryId, }: {
        /** The store id **/
        storeId: string;
        /** The webhook id **/
        webhookId: string;
        /** The id of the delivery **/
        deliveryId: string;
    }): Promise<WebhookDeliveryData>;
    /**
     * Get the delivery's request
     * The delivery's JSON request sent to the endpoint
     * @returns any The delivery's JSON Request
     * @throws ApiError
     */
    static getWebhooksService2({ storeId, webhookId, deliveryId, }: {
        /** The store id **/
        storeId: string;
        /** The webhook id **/
        webhookId: string;
        /** The id of the delivery **/
        deliveryId: string;
    }): Promise<any>;
    /**
     * Redeliver the delivery
     * Redeliver the delivery
     * @returns string The new delivery id being broadcasted. (Broadcast happen asynchronously with this call)
     * @throws ApiError
     */
    static postWebhooksService1({ storeId, webhookId, deliveryId, }: {
        /** The store id **/
        storeId: string;
        /** The webhook id **/
        webhookId: string;
        /** The id of the delivery **/
        deliveryId: string;
    }): Promise<string>;
}