@zikeji/hypixel
Version:
With IntelliSense support & test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses, built-in rate-limit handling, flexible
41 lines (40 loc) • 1.94 kB
TypeScript
import { Paths } from "../../types/api";
import { Method } from "../../util/Method";
import { ResultArray } from "../../util/ResultArray";
import type { SkyblockAuctionResponse } from "../../types/AugmentedTypes";
/**
* @example
* ```typescript
* const auctions = await client.skyblock.auctions.player("347ef6c1daac45ed9d1fa02818cf0fb6");
* ```
* @category Client
*/
export declare class SkyBlockAuction extends Method {
/**
* Returns SkyBlock auctions by either player, profile or auction uuid. Only "active" auctions are returned, these are auctions that are still open or that have not had all bids/items claimed.
* @example
* ```typescript
* const auctions = await client.skyblock.auction.player("347ef6c1daac45ed9d1fa02818cf0fb6");
* ```
* @category API
*/
player(player: Paths.V2SkyblockAuction.Get.Parameters.Player): Promise<ResultArray<SkyblockAuctionResponse, "auctions">>;
/**
* Returns SkyBlock auctions by either player, profile or auction uuid. Only "active" auctions are returned, these are auctions that are still open or that have not had all bids/items claimed.
* @example
* ```typescript
* const auctions = await client.skyblock.auction.profile("347ef6c1daac45ed9d1fa02818cf0fb6");
* ```
* @category API
*/
profile(profile: Paths.V2SkyblockAuction.Get.Parameters.Profile): Promise<ResultArray<SkyblockAuctionResponse, "auctions">>;
/**
* Returns SkyBlock auctions by either player, profile or auction uuid. Only "active" auctions are returned, these are auctions that are still open or that have not had all bids/items claimed.
* @example
* ```typescript
* const auctions = await client.skyblock.auction.uuid("409a1e0f261a49849493278d6cd9305a");
* ```
* @category API
*/
uuid(uuid: Paths.V2SkyblockAuction.Get.Parameters.Uuid): Promise<ResultArray<SkyblockAuctionResponse, "auctions">>;
}