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

## Installation

import type { PaymentRequestBaseData } from '../models/PaymentRequestBaseData';
import type { PaymentRequestData } from '../models/PaymentRequestData';
import type { PaymentRequestDataList } from '../models/PaymentRequestDataList';
export declare class PaymentRequestsService {
    /**
     * Get payment requests
     * View information about the existing payment requests
     * @returns PaymentRequestDataList list of payment requests
     * @throws ApiError
     */
    static paymentRequestsGetPaymentRequests({ storeId, }: {
        /** The store to query **/
        storeId: string;
    }): Promise<PaymentRequestDataList>;
    /**
     * Create a new payment request
     * Create a new payment request
     * @returns PaymentRequestData Information about the new payment request
     * @throws ApiError
     */
    static paymentRequestsCreatePaymentRequest({ storeId, requestBody, }: {
        /** The store to query **/
        storeId: string;
        requestBody: PaymentRequestBaseData;
    }): Promise<PaymentRequestData>;
    /**
     * Get payment request
     * View information about the specified payment request
     * @returns PaymentRequestData specified payment request
     * @throws ApiError
     */
    static paymentRequestsGetPaymentRequest({ storeId, paymentRequestId, }: {
        /** The store to fetch **/
        storeId: string;
        /** The payment request to fetch **/
        paymentRequestId: string;
    }): Promise<PaymentRequestData>;
    /**
     * Archive payment request
     * Archives the specified payment request.
     * @returns any The payment request has been archived
     * @throws ApiError
     */
    static paymentRequestsArchivePaymentRequest({ storeId, paymentRequestId, }: {
        /** The store the payment request belongs to **/
        storeId: string;
        /** The payment request to remove **/
        paymentRequestId: string;
    }): Promise<any>;
    /**
     * Update payment request
     * Update a payment request
     * @returns PaymentRequestData The updated payment request
     * @throws ApiError
     */
    static paymentRequestsUpdatePaymentRequest({ storeId, paymentRequestId, requestBody, }: {
        /** The store to query **/
        storeId: string;
        /** The payment request to update **/
        paymentRequestId: string;
        requestBody: PaymentRequestBaseData;
    }): Promise<PaymentRequestData>;
}