bitpay-sdk/dist/Model/Invoice/Invoice.d.ts

Complete version of the NodeJS library for the new cryptographically secure BitPay API

import { Buyer } from './Buyer';
import { InvoiceBuyerProvidedInfo } from './InvoiceBuyerProvidedInfo';
import { InvoiceTransaction } from './InvoiceTransaction';
import { Shopper } from './Shopper';
import { RefundInfo } from './RefundInfo';
import { InvoiceUniversalCodes } from './InvoiceUniversalCodes';
import { MinerFeesItem } from './MinerFeesItem';
import { SupportedTransactionCurrency } from './SupportedTransactionCurrency';
import { InvoiceRefundAddresses } from './InvoiceRefundAddresses';
export interface InvoiceInterface {
    currency: string;
    guid: string;
    token: string;
    price?: number;
    posData?: string;
    notificationURL?: string;
    transactionSpeed?: string;
    fullNotifications?: boolean;
    notificationEmail?: string;
    redirectURL?: string;
    closeURL?: string;
    orderId?: string;
    itemDesc?: string;
    itemCode?: string;
    physical?: boolean;
    paymentCurrencies?: string[];
    acceptanceWindow?: number;
    autoRedirect?: boolean;
    forcedBuyerSelectedWallet?: string;
    forcedBuyerSelectedTransactionCurrency?: string;
    buyer?: Buyer;
    id?: string;
    url?: string;
    status?: string;
    lowFeeDetected?: boolean;
    invoiceTime?: number;
    expirationTime?: number;
    currentTime?: number;
    exceptionStatus?: boolean | string;
    targetConfirmations?: number;
    transactions?: InvoiceTransaction[];
    refundAddresses?: Array<{
        [key: string]: InvoiceRefundAddresses;
    }>;
    refundAddressRequestPending?: boolean;
    buyerProvidedEmail?: string;
    buyerProvidedInfo?: InvoiceBuyerProvidedInfo;
    supportedTransactionCurrencies?: Record<string, SupportedTransactionCurrency>;
    minerFees?: Record<string, MinerFeesItem>;
    shopper?: Shopper;
    billId?: string;
    refundInfo?: RefundInfo;
    extendedNotifications?: boolean;
    transactionCurrency?: string;
    amountPaid?: number;
    displayAmountPaid?: string;
    exchangeRates?: Record<string, Record<string, number>>;
    paymentSubtotals?: Record<string, number>;
    paymentTotals?: Record<string, number>;
    paymentDisplayTotals?: Record<string, string>;
    paymentDisplaySubTotals?: Record<string, string>;
    nonPayProPaymentReceived?: boolean;
    jsonPayProRequired?: boolean;
    merchantName?: string;
    bitpayIdRequired?: boolean;
    underpaidAmount?: number;
    overpaidAmount?: number;
    paymentCodes?: Record<string, Record<string, string>>;
    isCancelled?: boolean;
    universalCodes?: InvoiceUniversalCodes;
    setCurrency(_currency?: string): void;
}
export declare class Invoice implements InvoiceInterface {
    currency: string;
    guid: string;
    token: string;
    price?: number;
    posData?: string;
    notificationURL?: string;
    transactionSpeed?: string;
    fullNotifications?: boolean;
    notificationEmail?: string;
    redirectURL?: string;
    closeURL?: string;
    orderId?: string;
    itemDesc?: string;
    itemCode?: string;
    physical?: boolean;
    paymentCurrencies?: string[];
    acceptanceWindow?: number;
    autoRedirect?: boolean;
    forcedBuyerSelectedWallet?: string;
    forcedBuyerSelectedTransactionCurrency?: string;
    buyer?: Buyer;
    id?: string;
    url?: string;
    status?: string;
    lowFeeDetected?: boolean;
    invoiceTime?: number;
    expirationTime?: number;
    currentTime?: number;
    exceptionStatus?: boolean | string;
    targetConfirmations?: number;
    transactions?: InvoiceTransaction[];
    refundAddresses?: Array<{
        [key: string]: InvoiceRefundAddresses;
    }>;
    refundAddressRequestPending?: boolean;
    buyerProvidedEmail?: string;
    buyerProvidedInfo?: InvoiceBuyerProvidedInfo;
    supportedTransactionCurrencies?: Record<string, SupportedTransactionCurrency>;
    minerFees?: Record<string, MinerFeesItem>;
    shopper?: Shopper;
    billId?: string;
    refundInfo?: RefundInfo;
    extendedNotifications?: boolean;
    transactionCurrency?: string;
    amountPaid?: number;
    displayAmountPaid?: string;
    exchangeRates?: Record<string, Record<string, number>>;
    paymentSubtotals?: Record<string, number>;
    paymentTotals?: Record<string, number>;
    paymentDisplayTotals?: Record<string, string>;
    paymentDisplaySubTotals?: Record<string, string>;
    nonPayProPaymentReceived?: boolean;
    jsonPayProRequired?: boolean;
    merchantName?: string;
    bitpayIdRequired?: boolean;
    underpaidAmount?: number;
    overpaidAmount?: number;
    paymentCodes?: Record<string, Record<string, string>>;
    isCancelled?: boolean;
    universalCodes?: InvoiceUniversalCodes;
    /**
     * Constructor, create a minimal request Invoice object.
     *
     * @param price    The amount for which the invoice will be created.
     * @param currency The three digit currency type used to compute the invoice bitcoin amount.
     */
    constructor(price: number, currency: string);
    /**
     * Set currency for invoice.
     * @param currency string
     * @throws BitPayGenericException BitPayGenericException class
     */
    setCurrency(currency: string): void;
}