@mojito-inc/core-service/Auction/AuctionService.d.ts

Mojito Core API service for auction, payment, token

import { Response } from '../data';
import { QueryOptions } from '../domain';
import { AuctionData, OnChainBidResponse, ConfirmOnChainBidResponse, CreateMarketplaceAuctionBidResponse, AuctionByClaimCodeData } from './data';
import { AuctionDetailsByClaimCodeParam, AuctionDetailsParam, ConfirmOnChainBidParam, CreateMarketplaceAuctionBidParam, VerifyOnChainBidParam } from './AuctionParam';
export interface AuctionService {
    /**
     * Returns auction Details
     *
     * @remarks
     * This method is part of auction module, fetch auction details
     *
     * @param param - param {@link OnChainBidResponse}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link AuctionData} auction data
     *
     */
    auctionDetails: (param: AuctionDetailsParam, options?: QueryOptions) => Promise<Response<AuctionData>>;
    /**
    * Returns auction by claim code Details
    *
    * @remarks
    * This method is part of auction module, fetch auction by claim code details
    *
    * @param param - param {@link OnChainBidResponse}
    * @param options - graphql fetch query options {@link QueryOptions}
    * @returns {@link AuctionByClaimCodeData} auction by claim code data
    *
    */
    auctionDetailsByClaimCode: (param: AuctionDetailsByClaimCodeParam, options?: QueryOptions) => Promise<Response<AuctionByClaimCodeData>>;
    /**
     * Returns On ChainBid Details
     *
     * @remarks
     * This method is part of auction module, verify on chain bid
     *
     * @param param - param {@link OnChainBidResponse}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link OnChainBidResponse} On ChainBid data
     *
     */
    verifyOnChainBid: (param: VerifyOnChainBidParam, options?: QueryOptions) => Promise<Response<OnChainBidResponse>>;
    /**
     * Returns ConfirmOnChainBidResponse confirm On ChainBid
     *
     * @remarks
     * This method is part of auction module, confirm on chain bid
     *
     * @param param - param {@link ConfirmOnChainBidParam}
     * @param options - graphql fetch query options {@link QueryOptions}
     * @returns {@link ConfirmOnChainBidResponse} BidsItem Data
     *
     */
    confirmOnChainBid: (param: ConfirmOnChainBidParam, options?: QueryOptions) => Promise<Response<ConfirmOnChainBidResponse>>;
    /**
   * Returns CreateMarketplaceAuctionBidResponse on create marketplace auction bid
   *
   * @remarks
   * This method is part of auction module, create marketplace auction bid
   *
   * @param param - param {@link CreateMarketplaceAuctionBidParam}
   * @param options - graphql fetch query options {@link QueryOptions}
   * @returns {@link CreateMarketplaceAuctionBidResponse} BidsItem Data
   *
   */
    createMarketplaceAuctionBid: (param: CreateMarketplaceAuctionBidParam, options?: QueryOptions) => Promise<Response<CreateMarketplaceAuctionBidResponse>>;
}