/** @noSelfInFile */

declare namespace WoWAPI {
  type ITEM_QUALITY_GENERIC = -1;
  type ITEM_QUALITY_POOR = 0;
  type ITEM_QUALITY_COMMON = 1;
  type ITEM_QUALITY_UNCOMMON = 2;
  type ITEM_QUALITY_RARE = 3;
  type ITEM_QUALITY_EPIC = 4;
  type ITEM_QUALITY_LEGENDARY = 5;
  type ITEM_QUALITY_ARTIFACT = 6;
  type ITEM_QUALITY_HEIRLOOM = 7;
  type ITEM_QUALITY_WOW_TOKEN = 8;

  /**
   * all currently known item qualities
   */
  type ITEM_QUALITY =
    | ITEM_QUALITY_GENERIC
    | ITEM_QUALITY_POOR
    | ITEM_QUALITY_COMMON
    | ITEM_QUALITY_UNCOMMON
    | ITEM_QUALITY_RARE
    | ITEM_QUALITY_EPIC
    | ITEM_QUALITY_LEGENDARY
    | ITEM_QUALITY_ARTIFACT
    | ITEM_QUALITY_HEIRLOOM
    | ITEM_QUALITY_WOW_TOKEN;

  type BIND_TYPE_NONE = 0;
  type BIND_TYPE_PICKUP = 1;
  type BIND_TYPE_EQUIP = 2;
  type BIND_TYPE_USE = 3;
  type BIND_TYPE_QUEST = 4;

  /**
   * all currently known bind types
   */
  type BIND_TYPE =
    | BIND_TYPE_NONE
    | BIND_TYPE_PICKUP
    | BIND_TYPE_EQUIP
    | BIND_TYPE_USE
    | BIND_TYPE_QUEST;

  type EquippableItemType =
    | 'Miscellaneous'
    | 'Cloth'
    | 'Leather'
    | 'Mail'
    | 'Plate'
    | 'Shields'
    | 'Librams'
    | 'Idols'
    | 'Totems'
    | 'Sigils';

  /**
   * a clickable ingame item link
   */
  type ItemLink = Hyperlink;

  interface CorruptionEffectInfo {
    name: string;
    description: string;
    minCorruption: number;
  }

  interface ItemLocationMixin {
    bagID: number | null;
    slotIndex: number | null;
    equipmentSlotIndex: number | null;
    IsValid: boolean;

    Clear(): void;
    GetBagAndSlot(): [number | null, number | null];
    SetEquipmentSlot(equipmentSlotIndex: number | null): void;
    GetEquipmentSlot(): number | null;
    IsEquipmentSlot(): boolean;
    IsBagAndSlot(): boolean;
    HasAnyLocation(): boolean;
    IsEqualToBagAndSlot(otherBagID: number, otherSlotIndex: number): boolean;
    IsEqualToEquipmentSlot(otherEquipmentSlotIndex: number): boolean;
    IsEqualTo(otherItemLocation: ItemLocationMixin): boolean;
  }

  /**
   * Output table for the AuctionHouse system.
   */
  interface ItemKey {
    itemID: number;
    itemLevel: number;
    itemSuffix: number;
    battlePetSpeciesID: number;
  }

  interface ItemKeyInfo {
    itemName: string;
    battlePetLink: string | null;
    quality: ITEM_QUALITY;
    iconFileID: number; // FileID
    isPet: boolean;
    isCommodity: boolean;
    isEquipment: boolean;
  }

  interface C_AzeriteItem {
    /**
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.FindActiveAzeriteItem
     */
    FindActiveAzeriteItem(): ItemLocationMixin;

    /**
     *
     * @param azeriteItemLocation
     * @returns
     * - **xp**
     * - **totalLevelXP**
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.GetAzeriteItemXPInfo
     */
    GetAzeriteItemXPInfo(
      azeriteItemLocation: ItemLocationMixin
    ): [number, number];

    /**
     *
     * @param azeriteItemLocation
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.GetPowerLevel
     */
    GetPowerLevel(azeriteItemLocation: ItemLocationMixin): number;

    /**
     *
     * @param azeriteItemLocation
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.GetUnlimitedPowerLevel
     */
    GetUnlimitedPowerLevel(azeriteItemLocation: ItemLocationMixin): number;

    /**
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.HasActiveAzeriteItem
     */
    HasActiveAzeriteItem(): boolean;

    /**
     *
     * @param itemLocation
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.IsAzeriteItem
     */
    IsAzeriteItem(itemLocation: ItemLocationMixin): boolean;

    /**
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.IsAzeriteItemAtMaxLevel
     */
    IsAzeriteItemAtMaxLevel(): boolean;

    /**
     *
     * @param itemInfo
     * @see https://wow.gamepedia.com/API_C_AzeriteItem.IsAzeriteItemByID
     */
    IsAzeriteItemByID(itemInfo: string): boolean;
  }
}

declare const C_AzeriteItem: WoWAPI.C_AzeriteItem;

/**
 * Equips an item, optionally into a specified slot
 * @param itemIdentifier itemId or "itemName" or "itemLink"
 * - **itemId**: The numeric ID of the item. ie. 12345
 * - **itemName**: The name of the item, ie "Worn Dagger". Partial names are valid inputs as well, ie "Worn". If several items with same piece
 * of name exists, the first one found will be equipped
 * - **itemLink**: The itemLink, when Shift-Clicking items
 * @param slot The inventory slot to put the item in, obtained via GetInventorySlotInfo().
 * @description When in combat this function now "picks up" the item instead of equipping it, similar to PickupInventoryItem. Out of combat, the
 * function behaves as expected. This change was made to address the issue of rogues using "poison swapping" addons to increase their DPS
 * @see https://wow.gamepedia.com/API_EquipItemByName
 */
declare function EquipItemByName(
  itemIdentifier: string | number | WoWAPI.ItemLink,
  slot?: WoWAPI.INVENTORY_SLOT_ID
): void;

/**
 * Returns a link of the object located in the specified slot of a specified bag.
 * @param bagId Bag index (bagID). Valid indices are integers -2 through 11. 0 is the backpack
 * @param slotIndex Slot index within the specified bag, ascending from 1. Slot 1 is typically the leftmost topmost slot
 * @returns a chat link for the object in the specified bag slot; nil if there is no such object. This is typically, but not always an ItemLink
 * @see https://wow.gamepedia.com/API_GetContainerItemLink
 */
declare function GetContainerItemLink(
  bagId: WoWAPI.CONTAINER_ID,
  slotIndex: number
): WoWAPI.ItemLink | null;

/**
 * Tracks the extent to which a player is wearing items touched by N'Zoth's influence.
 * @returns the amount of corruption independent of any resistances
 * @see https://wow.gamepedia.com/API_GetCorruption
 */
declare function GetCorruption(): number;

/**
 * Tracks how much the player has offset their exposure to dangers that result from wearing items touched by N'Zoth's influence.
 * @returns Amount of corruption resistance, independent of how much corruption is actually present
 * @see https://wow.gamepedia.com/API_GetCorruptionResistance
 */
declare function GetCorruptionResistance(): number;

/**
 * Returns detailed item level information about a given item
 * @param itemIdentifier One of the following four ways to specify which item to query
 * - **itemId**: Numeric ID of the item. e.g. 30234 for  [Nordrassil Wrath-Kilt],
 * - **itemName**: Name of an item owned by the player at some point during this play session, e.g. "Nordrassil Wrath-Kilt"
 * - **itemString**: A fragment of the itemString for the item, e.g. "item:30234:0:0:0:0:0:0:0" or "item:30234"
 * - **itemLink**: The full itemLink
 * @returns **
 * - **effectiveILvl**: same as in tooltip
 * - **isPreview**: True means it would have a + in the tooltip, a minimal level for item used in loot preview in encounter journal
 * - **baseLevel**: base item level
 * @since 7.1.0
 * @see https://wow.gamepedia.com/API_GetDetailedItemLevelInfo
 * @tupleReturn
 */
declare function GetDetailedItemLevelInfo(
  itemIdentifier: string | number | WoWAPI.ItemLink
): [number, boolean, number];

/**
 *  * Returns cooldown info for an item ID
 *
 * {@link https://wowpedia.fandom.com/wiki/API_GetItemCooldown}
 *
 * @param itemId The item's Identifier to be queried
 *
 * @return 0 - startTime - The time when the cooldown started (as returned by {@link GetTime()}) or zero if no cooldown
 * @return 1 - duration - The number of seconds the cooldown will last, or zero if no cooldown
 * @return 2 - enable - 1 if the item is ready or on cooldown, 0 if the item is used, but the cooldown didn't start yet (e.g. potion in combat)'
 *
 * @tupleReturn
 */
declare function GetItemCooldown(
  itemId: number
): LuaMultiReturn<[number, number, WoWAPI.Flag]>;

/**
 * Gets the bitfield of what types of bags an item can go into or contain
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 * @returns What type of bags an item can go into or if the item is a container what it can contain
 * @see https://wow.gamepedia.com/API_GetItemFamily
 */
declare function GetItemFamily(
  itemIdentifier: string | number | WoWAPI.ItemLink
): WoWAPI.BAG_TYPE;

/**
 * Returns an item's icon texture
 * @param itemId The numeric ID of the item to query e.g. 23405 for  [Farstrider's Tunic].
 * @returns Icon texture used by the item
 * @see https://wow.gamepedia.com/API_GetItemIcon
 */
declare function GetItemIcon(itemId: number): WoWAPI.TexturePath;

/**
 * Return information about a specific item
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 * @returns
 * - **itemName**: The localized name of the item
 * - **itemLink**: The localized item link of the item
 * - **itemRarity**: The quality of the item. The value is 0 to 7, which represents Poor to Heirloom. This appears to include gains from upgrades/bonuses
 * - **itemLevel**: The base item level of this item, not including item levels gained from upgrades. Use GetDetailedItemLevelInfo to get the
 * actual current level of the item
 * - **itemMinLevel**: The minimum level required to use the item, 0 meaning no level requirement
 * - **itemType**: The localized type of the item: Armor, Weapon, Quest, Key, etc
 * - **itemSubType**: The localized sub-type of the item: Enchanting, Cloth, Sword, etc. See itemType
 * - **itemStackCount**: How many of the item per stack: 20 for Runecloth, 1 for weapon, 100 for Alterac Ram Hide, etc
 * - **itemEquipLocation**: The type of inventory equipment location in which the item may be equipped, or "" if it can't be equippable. The
 * string returned is also the name of a global string variable e.g. if "INVTYPE_WEAPONMAINHAND" is returned, _G["INVTYPE_WEAPONMAINHAND"] will
 * be the localized, displayable name of the location
 * - **itemIcon**: The icon texture for the item
 * - **itemSellPrice**: The price, in copper, a vendor is willing to pay for this item, 0 for items that cannot be sold
 * - **itemClassId**: This is the numerical value that determines the string to display for 'itemType'
 * - **itemSubClassId**: This is the numerical value that determines the string to display for 'itemSubType'
 * - **bindType**: Item binding type: 0 - none; 1 - on pickup; 2 - on equip; 3 - on use; 4 - quest
 * - **expactId**: unknown
 * - **itemSetId**: unknown
 * - **isCraftingReagent**: unknown
 * @see https://wow.gamepedia.com/API_GetItemInfo
 * @tupleReturn
 */
// tslint:disable-next-line max-line-length
declare function GetItemInfo(
  itemIdentifier: string | number | WoWAPI.ItemLink
): [
  string,
  WoWAPI.ItemLink,
  WoWAPI.ITEM_QUALITY,
  number,
  number,
  string,
  string,
  number,
  WoWAPI.INVENTORY_SLOT_ID,
  WoWAPI.TexturePath,
  number,
  number,
  number,
  WoWAPI.BIND_TYPE,
  number,
  number,
  boolean
];

/**
 * Returns instantly-available information about a specific item
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 * @returns
 * - **itemId**: ID of the item
 * - **itemType**: The localized type of the item: Armor, Weapon, Quest, Key, etc
 * - **itemSubType**: The localized sub-type of the item: Enchanting, Cloth, Sword, etc. See itemType
 * - **itemEquipLocation**: The type of inventory equipment location in which the item may be equipped, or "" if it can't be equippable. The
 * string returned is also the name of a global string variable e.g. if "INVTYPE_WEAPONMAINHAND" is returned, _G["INVTYPE_WEAPONMAINHAND"] will be
 * the localized, displayable name of the location
 * - **itemIcon**: The icon texture for the item
 * - **itemClassId**: This is the numerical value that determines the string to display for 'itemType'
 * - **itemSubClassId**: This is the numerical value that determines the string to display for 'itemSubType'
 * @description Though it is not documented, this function apparently returns info available directly in client files. Because of that it returns
 * less data, but have several advantages over GetItemInfo: it always return data, when GetItemInfo can return nil for valid, but not loaded items
 * and it never initiates requests to server, that could be subject to throttling or forced disconnection.
 * @see https://wow.gamepedia.com/API_GetItemInfoInstant
 * @since 7.0.3
 * @tupleReturn
 */
// tslint:disable-next-line max-line-length
declare function GetItemInfoInstant(
  itemIdentifier: string | number | WoWAPI.ItemLink
): [
  number,
  string,
  string,
  WoWAPI.INVENTORY_SLOT_ID,
  WoWAPI.TexturePath,
  number,
  number
];

/**
 * Returns RGB color codes for an item quality
 * @param quality The numeric ID of the quality from 0 (Poor) to 7 (Heirloom)
 * @returns
 *  - **red**: The Red component of the color (0 to 1, inclusive)
 *  - **green**: The Green component of the color (0 to 1, inclusive)
 *  - **blue**: The Blue component of the color (0 to 1, inclusive)
 *  - **hex**: The UI escape sequence for this color, without the leading "|c".
 * @see https://wow.gamepedia.com/API_GetItemQualityColor
 * @tupleReturn
 */
declare function GetItemQualityColor(
  quality: WoWAPI.ITEM_QUALITY
): [number, number, number, string];

/**
 * Return spell information about a specific item
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 * @returns
 * - **spellName**: The name of the spell
 * - **spellRank**: The secondary text of the spell, displayed in the top right-hand corner of the spell's tooltip
 * - **spellId**: The spell's unique identifier
 * @see https://wow.gamepedia.com/API_GetItemSpell
 */
declare function GetItemSpell(
  itemIdentifier: string | number | WoWAPI.ItemLink
): [string, string, number];

/**
 * Returns a table of stats for an item
 * @param itemLink An item link for which to get stats
 * @param statTable An optional, empty table that will be filled with stats and returned. If this parameter is omitted, a new table is returned
 * @see https://wow.gamepedia.com/API_GetItemStats
 */
declare function GetItemStats(
  itemLink: WoWAPI.ItemLink,
  statTable?: object
): { [index: string]: number };

/**
 * Returns a link to the indexed item in the merchant's inventory
 * @param merchantIndex The index of the item in the merchant's inventory
 * @returns returns a string that will show as a clickable link to the item
 * @see https://wow.gamepedia.com/API_GetMerchantWoWAPI.ItemLink
 */
declare function GetMerchantItemLink(merchantIndex: number): WoWAPI.ItemLink;

/**
 * @see https://wow.gamepedia.com/API_GetNegativeCorruptionEffectInfo
 */
declare function GetNegativeCorruptionEffectInfo(): WoWAPI.CorruptionEffectInfo[];

/**
 * Returns link to the quest item
 * @param type "required", "reward" or "choice"
 * @param index Quest reward item index
 * @returns The link to the quest item specified
 * @see https://wow.gamepedia.com/API_GetQuestWoWAPI.ItemLink
 */
declare function GetQuestItemLink(
  type: WoWAPI.QuestType,
  index: number
): WoWAPI.ItemLink;

/**
 * Returns link to the quest item
 * @param type  "required", "reward" or "choice"
 * @param index Quest reward item index (starts with 1)
 * @returns The link to the quest item specified or nil, if the type and/or index is invalid, there is no active quest at the moment or if the
 * server did not transmit the item information until the timeout (which can happen, if the item is not in the local item cache yet)
 * @see https://wow.gamepedia.com/API_GetQuestLogWoWAPI.ItemLink
 */
declare function GetQuestLogItemLink(
  type: WoWAPI.QuestType,
  index: number
): WoWAPI.ItemLink;

/**
 * Returns a single value: chat-ready item link
 * @param tradeSlotIndex index value of the "player's" (your character) trade slots (starts at 1 and proceeds to 6. 7 may be used for the
 * will-not-be-traded-slot.)
 * @returns a string that can be used to link items in the chat log
 * @see https://wow.gamepedia.com/API_GetTradePlayerWoWAPI.ItemLink
 */
declare function GetTradePlayerItemLink(
  tradeSlotIndex: number
): WoWAPI.ItemLink;

/**
 * Gets the link string for a trade skill item
 * @param skillId The Id specifying which trade skill's link to get. Trade Skill window must be open for this to work. Indexes start at 1 which
 * is the general category of the tradeskill, if you have selected a sub-group of trade skills then 1 will be the name of that sub-group
 * @see https://wow.gamepedia.com/API_GetTradeSkillWoWAPI.ItemLink
 */
declare function GetTradeSkillItemLink(skillId: number): WoWAPI.ItemLink;

/**
 * Gets the link string for a trade skill reagent
 * @param skillId The Id specifying which trade skill's reagent to link
 * @param reagentId The Id specifying which of the skill's reagents to link
 * @see https://wow.gamepedia.com/API_GetTradeSkillReagentWoWAPI.ItemLink
 */
declare function GetTradeSkillReagentItemLink(
  skillId: number,
  reagentId: number
): WoWAPI.ItemLink;

/**
 * Simply view, except this function is for your trading partner, ie, the other side of the trade window
 * @param tradeIndex index value of the "player's" (your character) trade slots (starts at 1 and proceeds to 6. 7 may be used for the will-not-be-traded-slot.)
 * @see https://wow.gamepedia.com/API_GetTradeTargetWoWAPI.ItemLink
 */
declare function GetTradeTargetItemLink(tradeIndex: number): WoWAPI.ItemLink;

/**
 * Returns usable, noMana
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 */
declare function IsUsableItem(
  itemIdentifier: string | number | WoWAPI.ItemLink
): LuaMultiReturn<[boolean, boolean]>;

/**
 * Returns whether an item is consumed when used
 * @param itemIdentifier An item ID (number), item link or item name (string) to query
 * @returns 1 if the item is consumed when used, nil otherwise
 * @see https://wow.gamepedia.com/API_IsConsumableItem
 */
declare function IsConsumableItem(
  itemIdentifier: string | number | WoWAPI.ItemLink
): WoWAPI.Flag;

/**
 *
 * @param itemIdentifier An item ID (number), item link or item name (string) to query
 * @see https://wow.gamepedia.com/API_IsCorruptedItem
 */
declare function IsCorruptedItem(
  itemIdentifier: string | number | WoWAPI.ItemLink
): boolean;

/**
 * unknown
 * @param itemIdentifier An item ID (number), item link or item name (string) to query
 */
declare function IsCurrentItem(
  itemIdentifier: string | number | WoWAPI.ItemLink
): WoWAPI.Flag;

/**
 * Determines if an item is equipped
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 * @see https://wow.gamepedia.com/API_IsEquippedItem
 */
declare function IsEquippedItem(
  itemIdentifier: string | number | WoWAPI.ItemLink
): boolean;

/**
 * Returns 1 if item is an equip-able one at all, your character notwithstanding, or nil if not
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 * @see https://wow.gamepedia.com/API_IsEquippableItem
 */
declare function IsEquippableItem(
  itemIdentifier: string | number | WoWAPI.ItemLink
): boolean;

/**
 * Determines if an item of a given type is equipped
 * @param itemType any valid inventory type, item class, or item subclass
 * @see https://wow.gamepedia.com/API_IsEquippedItemType
 */
declare function IsEquippedItemType(
  itemType: WoWAPI.EquippableItemType
): boolean;

/**
 * Returns if you are in range of the specified unit to use the specified item
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 * @param unit which unit the range should be checked to
 * @returns
 * - If the item is not in range, false; if the item is in range, true; if the query is invalid, nil
 * - If the item is not in range, 0; if the item is in range, 1; if the query is invalid, nil
 * @see https://wow.gamepedia.com/API_IsItemInRange
 */
declare function IsItemInRange(
  itemIdentifier: string | number | WoWAPI.ItemLink,
  unit?: WoWAPI.UnitId
): [boolean, WoWAPI.Flag];

/**
 * unknown
 * @param itemIdentifier Number/String/String - Numeric ID of the item, name of the item, or itemLink of the item to query
 */
declare function ItemHasRange(
  itemIdentifier: string | number | WoWAPI.ItemLink
): boolean;

/**
 * Called to handle clicks on Blizzard hyperlinks in chat
 * @param link Link to Use, (eg 'item:3577:0:0:0:0:0:0:276308480' is a [Gold Bar], 'player:Kaso' is [Kaso]).
 * @param text The Text of the link, including Text Colour Infomation and itemlinks (eg The previous two examples
 * : '|cff1eff00|Hitem:3577:0:0:0:0:0:0:276308480|h[Gold Bar]|h|r' '|Hplayer:Kaso|h[Kaso]|h'
 * @param button The button used to click the notes 'LeftButton' or 'RightButton' Apparently, See Notes
 * @description
 *  - Do not insecurely hook this function to add your own link types; hook ChatFrame_OnHyperlinkShow(frame, link, text, button) instead.
 * Hooking this function insecurely will end up tainting Blizzard's combat log, which will taint UIParent's update routines and result in
 * "action has been blocked" messages
 *  - This function is affected by Shift and Ctrl keys, and depends on what is being clicked, according to the below table
 * @see https://wow.gamepedia.com/API_SetItemRef
 */
declare function SetItemRef(
  link: WoWAPI.ItemLink,
  text: string,
  button: WoWAPI.MouseButton
): void;

/**
 * Uses an item, optionally on a specified target
 * @param itemName name of the item to use
 * @param target unit to use the item on, defaults to "target" for items that can be used on others
 * @protected
 * @see https://wow.gamepedia.com/API_UseItemByName
 */
declare function UseItemByName(
  itemName: string,
  targetId?: WoWAPI.UnitId
): void;

/** @noSelfInFile **/

/**
 * Get cooldown information for an inventory item
 *
 * {@link https://wowpedia.fandom.com/wiki/API_GetInventoryItemCooldown}
 *
 * @param unitId The unit's Identifier to be queried
 * @param slotId The slot's Identifier to be queried
 *
 * @return 0 - start - The start time of the cooldown period, or 0 if there is no cooldown (or no item in the slot)
 * @return 1 - duration - The duration of the cooldown period (NOT the remaining time). 0 if the item has no use/cooldown or the slot is empty
 * @return 2 - enable - True if the inventory item is capable of having a cooldown, False if not.
 */
declare function GetInventoryItemCooldown(
  unitId: IUnitId,
  slotId: number
): LuaMultiReturn<[number, number, number]>;

/**
 * Get the Item Id for a specific inventory slot
 *
 * {@link https://wowpedia.fandom.com/wiki/API_GetInventoryItemID}
 *
 * @param unitId The unit's Identifier to be queried
 * @param slotId The slot's Identifier to be queried
 *
 * @return itemId - Item id of the item in the inventory slot; nil if there is no item
 */
declare function GetInventoryItemID(unitId: string, slotId: number): number;

declare const enum InvSlotName {
  ammoSlot = 'AMMOSLOT',
  backSlot = 'BACKSLOT',
  chestSlot = 'CHESTSLOT',
  feetSlot = 'FEETSLOT',
  finger0Slot = 'FINGER0SLOT',
  finger1Slot = 'FINGER1SLOT',
  handsSlot = 'HANDSSLOT',
  headSlot = 'HEADSLOT',
  legsSlot = 'LEGSSLOT',
  mainHandSlot = 'MAINHANDSLOT',
  neckSlot = 'NECKSLOT',
  rangedSlot = 'RANGEDSLOT',
  secondaryHandSlot = 'SECONDARYHANDSLOT',
  shirtSlot = 'SHIRTSLOT',
  shouldersSlot = 'SHOULDERSSLOT',
  tabardSlot = 'TABARDSLOT',
  trinket0Slot = 'TRINKET0SLOT',
  trinket1Slot = 'TRINKET1SLOT',
  waistSlot = 'WAISTSLOT',
  wristSlot = 'WRISTSLOT',
}

declare const INVSLOT_AMMO: number;
declare const INVSLOT_HEAD: number;
declare const INVSLOT_NECK: number;
declare const INVSLOT_SHOULDER: number;
declare const INVSLOT_BODY: number;
declare const INVSLOT_CHEST: number;
declare const INVSLOT_WAIST: number;
declare const INVSLOT_LEGS: number;
declare const INVSLOT_FEET: number;
declare const INVSLOT_WRIST: number;
declare const INVSLOT_HAND: number;
declare const INVSLOT_FINGER1: number;
declare const INVSLOT_FINGER2: number;
declare const INVSLOT_TRINKET1: number;
declare const INVSLOT_TRINKET2: number;
declare const INVSLOT_BACK: number;
declare const INVSLOT_MAINHAND: number;
declare const INVSLOT_OFFHAND: number;
declare const INVSLOT_RANGED: number;
declare const INVSLOT_TABARD: number;

declare const enum InvSlotId {
  ammoSlot = 0,
  headSlot = 1,
  neckSlot = 2,
  shoulderSlot = 3,
  shirtSlot = 4,
  chestSlot = 5,
  waistSlot = 6,
  legsSlot = 7,
  feetSlot = 8,
  wristSlot = 9,
  handsSlot = 10,
  finger0Slot = 11,
  finger1Slot = 12,
  trinket0Slot = 13,
  trinket1Slot = 14,
  backSlot = 15,
  mainHandSlot = 16,
  secondaryHandSlot = 17,
  rangedSlot = 18,
  tabardSlot = 19,
}

/**
 * Returns info for an equipment slot
 *
 * {@link https://wowpedia.fandom.com/wiki/API_GetInventorySlotInfo}
 *
 * @param invSlotName The {@link InvSlotName} to be queried
 *
 * @return 0 - invSlotId - The {@link InvSlotId} to use to refer to that slot in the other GetInventory functions
 * @return 1 - textureName - The texture to use for the empty slot on the paper doll display
 * @return 2 - checkRelic - True if the slot is a relic slot
 */
declare function GetInventorySlotInfo(
  invSlotName: InvSlotName
): LuaMultiReturn<[InvSlotId, string, boolean]>;

/**
 * Returns the item link for an equipped item
 *
 * {@link https://wowpedia.fandom.com/wiki/API_GetInventoryItemLink}
 *
 * @param unitId The unit's Identifier to be queried
 * @param invSlotId The {@link InvSlotId} to be queried
 */
declare function GetInventoryItemLink(
  unitId: IUnitId,
  invSlotId: InvSlotId
): string | undefined;

/**
 * Returns the number (or available charges) of an item in the inventory
 *
 * {@link https://wowpedia.fandom.com/wiki/API_GetItemCount}
 *
 * @param itemInfo Item ID, Link or Name
 * @param includeBank If true, includes the bank
 * @param includeUses If true, includes each charge of an item similar to GetActionCount()
 * @param includeReagentBank If true, includes the reagent bank
 */
declare function GetItemCount(
  itemInfo: number | string,
  includeBank?: boolean,
  includeUses?: boolean,
  includeReagentBank?: boolean
): number;

/**
 * Use an item in a specific inventory slot
 *
 * {@link https://wowpedia.fandom.com/wiki/API_UseInventoryItem}
 *
 * @param slotId The inventory slot ID
 */
declare function UseInventoryItem(slotId: number): void;