import { TradeCurrencyGroup } from "./TradeCurrencyGroup"; import { TradeCurrencyId } from "./TradeCurrencyIds"; import { Language } from "./Language"; /** * A currency item as used in the PoE Trade API */ export interface TradeCurrencyItem { /** * The {@link TradeCurrencyGroup} this currency item belongs to */ group: TradeCurrencyGroup; /** * The {@link TradeCurrencyId} of this currency item */ id: TradeCurrencyId; /** * Relative URL to the image of the currency item */ imageURL?: string; } /** * A {@link TradeCurrencyItem} with it's localized name */ export interface LocalizedTradeCurrencyItem extends TradeCurrencyItem { /** * The name of the currency item in the given language */ localizedName: string; /** * The language used for localization */ language: Language; } /** * A currency item used in a trade bulk whisper */ export interface TradeBulkCurrencyItem extends LocalizedTradeCurrencyItem { /** * The name of the currency item as used in the whisper * * @remarks This may differ from the `localizedName` due to abbreviations used in the whisper */ whisperLabel: string; } /** * Searches for the currency item by name * * @param name The localized name of the currency item. Can be abbreviated * * @remarks If the item is not found and the language is not English, the search is repeated in English. * This is due to the fact that in some languages the items are written in English */ export declare function getTradeCurrencyItemByName(name: string, language: Language): LocalizedTradeCurrencyItem | undefined; /** * Searches for the trade currency item by its Trade API ID. * * @param id The ID of the currency item as defined by the PoE trade API * @param language The language */ export declare function getTradeCurrencyItemByTradeId(id: string, language: Language): LocalizedTradeCurrencyItem | undefined;