/** @module PayVault */
import type HTTPChannel from "../channel";
import { KeyValue } from "../utilities/util";
export default class PayVault {
    private channel;
    private currentVersion;
    private _coins?;
    private _items?;
    constructor(channel: HTTPChannel);
    /**
     * The number of coins in this user's Vault. You must call refresh() first to initialize this value.
     */
    get coins(): number;
    /**
     * The number of coins in this user's Vault. You must call refresh() first to initialize this value.
     */
    get items(): any[];
    /**
    * This method checks if the Vault contains at least one item of the given itemKey. This method can only be called on an up-to-date vault.
    * @param {string} itemKey The itemKey to check for.
    * @return {boolean} True if the user has at least one item of the given type (itemKey).
    */
    has(itemKey: string): boolean;
    /**
    * Returns the first item of the given itemKey from this Vault. This method can only be called on an up-to-date vault.
    * @param {string} itemKey The itemKey of the item to get.
    * @return {number} A VaultItem if one was found, or null if not.
    */
    first(itemKey: string): any;
    /**
    * Returns the number of items of a given itemKey is in this Vault. This method can only be called on an up-to-date vault.
    * @param string itemKey The itemKey of the items to count.
    * @return {number} The number of items of the given type that the user has in the vault.
    */
    count(itemKey: string): number;
    /**
    * Refreshes this Vault, making sure the Items and Coins are up-to-date.
    * @return {Promise<boolean>}
    */
    refresh(): Promise<boolean>;
    /**
    * Loads a page of entries from this Vaults history, in reverse chronological order, i.e. newest first.
    * @param {number} page The page of entries to load. The first page has number 0.
    * @param {number} pageSize The number of entries per page.
    */
    readHistory(page: number, pageSize: number): Promise<PayVaultHistoryEntry[]>;
    /**
    * Give coins to this Vault
    * @param {number} coinAmount The amount of coins to give.
    * @param {string} reason Your reason for giving the coins to this user. This will show up in the vault history, and in the PayVault admin panel for this user.
    */
    credit(coinAmount: number, reason: string): Promise<boolean>;
    /**
    * Take coins from this Vault
    * @param {number} coinAmount The amount of coins to take.
    * @param {string} reason Your reason for taking the coins from this user. This will show up in the vault history, and in the PayVault admin panel for this user.
    */
    debit(coinAmount: number, reason: string): Promise<boolean>;
    /**
    * Consume items in this Vault. This will cause them to be removed, but this action will not show up in the vault history.
    *
    * You don't need to call refresh after this call.
    * @param {VaultItem[]} items The VaultItems to use from the users vault - this should be instances of items in this Vault.
    */
    consume(items: VaultItem[]): Promise<boolean>;
    /**
    * Buy items with Coins.
    * @param {object[]} items A list of items to buy. Each item must have a property called 'itemkey' with the item key. Any additional properties will be converted to item payload.
    * @param {boolean} storeItems Whether or not to store the items in the vault after purchase
    */
    buy(items: ItemPayload[], storeItems: boolean): Promise<boolean>;
    /**
    * Give the user items without taking any of his coins from the vault.
    * @param {object[]} items A list of items to give. Each item must have a property called 'itemkey' with the item key. Any additional properties will be converted to item payload.
    */
    give(items: ItemPayload[]): Promise<boolean>;
    /**
    * Gets information about how to make a coin purchase with the specified PayVault provider.
    * @param {string} provider The name of the PayVault provider to use for the coin purchase.
    * @param {object} purchaseArguments Any additional information that will be given to the PayVault provider to configure this purchase.
    */
    getBuyCoinsInfo(provider: string, purchaseArguments?: KeyValue): Promise<KeyValue<string>>;
    /**
    * Gets information about how to make a direct item purchase with the specified PayVault provider.
    * @param {string} provider The name of the PayVault provider to use for the item purchase.
    * @param {object} purchaseArguments Any additional information that will be given to the PayVault provider to configure this purchase.
    * @param {object[]} items A list of items to buy. Each item must have a property called 'itemkey' with the item key. Any additional properties will be converted to item payload.
    */
    getBuyDirectInfo(provider: string, purchaseArguments: KeyValue, items: ItemPayload[]): Promise<KeyValue<string>>;
    protected readContent(content: any): boolean;
}
/**
 * This class represents an item in a user's Vault
 */
export declare class VaultItem {
    /** The unique id of this particular vault item in the user's vault
    */
    id: string;
    /** The key of the underlying item in the PayVaultItems BigDB table
    */
    itemKey: string;
    /** The time when the vault item was originally purchased
    */
    purchaseDate: Date;
    constructor(id: string, itemKey: string, purchaseDate: string);
}
/**
* This class represents an entry in a user's PayVault history.
*/
export declare class PayVaultHistoryEntry {
    /**
     * The type of this entry, for example 'buy','credit','debit'...
     */
    type: string;
    /**
     * The coin amount of this entry.
     */
    amount: number;
    /**
     * When this entry was created.
     */
    timestamp: Date;
    /**
     * he item keys related to this entry (entries with type 'buy').
     */
    itemKeys: string[];
    /**
     * The developer supplied reason for entries of type 'credit' and 'debit'.
     */
    reason: string;
    /**
     * The transaction id from the PayVault provider corresponding to this entry.
     */
    providerTransactionId: string;
    /**
     * The price in real currency of this entry formatted as a human readable currency string, e.g. $10.00 USD
     */
    providerPrice: string;
    constructor(type: string, amount: number, timestamp: number, itemkeys: string[], reason: string, providerTransactionId: string, providerPrice: string);
}
interface ItemPayload {
    itemkey: string;
    [extra: string]: unknown;
}
export declare function convertBuyItems(items?: Array<any>): ItemPayload[];
export {};