@zikeji/hypixel/src/methods/skyblock/auction.ts

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

import { Paths } from "../../types/api";
import { Method } from "../../util/Method";
import { getResultArray, ResultArray } from "../../util/ResultArray";
import type { SkyblockAuctionResponse } from "../../types/AugmentedTypes";

/**
 * @example
 * ```typescript
 * const auctions = await client.skyblock.auctions.player("347ef6c1daac45ed9d1fa02818cf0fb6");
 * ```
 * @category Client
 */
export 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
   */
  public async player(
    player: Paths.V2SkyblockAuction.Get.Parameters.Player
  ): Promise<ResultArray<SkyblockAuctionResponse, "auctions">> {
    return getResultArray(
      await this.client.call<SkyblockAuctionResponse>("skyblock/auction", {
        player,
      }),
      "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
   */
  public async profile(
    profile: Paths.V2SkyblockAuction.Get.Parameters.Profile
  ): Promise<ResultArray<SkyblockAuctionResponse, "auctions">> {
    return getResultArray(
      await this.client.call<SkyblockAuctionResponse>("skyblock/auction", {
        profile,
      }),
      "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
   */
  public async uuid(
    uuid: Paths.V2SkyblockAuction.Get.Parameters.Uuid
  ): Promise<ResultArray<SkyblockAuctionResponse, "auctions">> {
    return getResultArray(
      await this.client.call<SkyblockAuctionResponse>("skyblock/auction", {
        uuid,
      }),
      "auctions"
    );
  }
}