nmkr-studio-api/dist/services/ToolsService.d.ts

Typesafe API Client to work with the NMKR Studio V2 API

import type { AssetsAssociatedWithAccount } from '../models/AssetsAssociatedWithAccount';
import type { Blockchain } from '../models/Blockchain';
import type { CheckConditionsResultClass } from '../models/CheckConditionsResultClass';
import type { CheckDiscountsResultClass } from '../models/CheckDiscountsResultClass';
import type { Coin } from '../models/Coin';
import type { Dataproviders } from '../models/Dataproviders';
import type { NewRatesClass } from '../models/NewRatesClass';
import type { NmkrAssetAddress } from '../models/NmkrAssetAddress';
import type { RoyaltyClass } from '../models/RoyaltyClass';
import type { TokenInformationClass } from '../models/TokenInformationClass';
import type { TxInAddressesClass } from '../models/TxInAddressesClass';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class ToolsService {
    readonly httpRequest: BaseHttpRequest;
    constructor(httpRequest: BaseHttpRequest);
    /**
     * Checks if there applies a discount for an address
     * Checks if there applies a discount for an address
     * @returns CheckDiscountsResultClass Returns the CheckDiscountsResultClass Class
     * @throws ApiError
     */
    getV2CheckIfEligibleForDiscount({ projectuid, address, couponcode, }: {
        projectuid: string;
        address: string;
        couponcode?: string;
    }): CancelablePromise<CheckDiscountsResultClass>;
    /**
     * Checks, if an address matches the sale conditions
     * Checks, if an address matches the sale conditions of a project
     * @returns CheckConditionsResultClass Returns the CheckConditionsResultClass Class
     * @throws ApiError
     */
    getV2CheckIfSaleConditionsMet({ projectuid, address, countnft, blockchain, }: {
        projectuid: string;
        address: string;
        countnft: number;
        blockchain?: Blockchain;
    }): CancelablePromise<CheckConditionsResultClass>;
    /**
     * Returns the utxo of an address
     * @returns TxInAddressesClass Returns the AssetsAssociatedWithAccount Class
     * @throws ApiError
     */
    getV2CheckUtxo({ address, dataprovider, }: {
        address: string;
        dataprovider?: Dataproviders;
    }): CancelablePromise<TxInAddressesClass>;
    /**
     * @returns any OK
     * @throws ApiError
     */
    getV2GetActiveDirectsaleListings({ stakeaddress }: {
        stakeaddress: string;
    }): CancelablePromise<any>;
    /**
     * Returns all assets that are in a wallet
     * @returns AssetsAssociatedWithAccount Returns the AssetsAssociatedWithAccount Class
     * @throws ApiError
     */
    getV2GetAllAssetsInWallet({ address, blockchain, }: {
        address: string;
        blockchain?: Blockchain;
    }): CancelablePromise<Array<AssetsAssociatedWithAccount>>;
    /**
     * Returns the quantity of a specific token in a wallet
     * @returns AssetsAssociatedWithAccount Returns the AssetsAssociatedWithAccount Class
     * @throws ApiError
     */
    getV2GetAmountOfSpecificTokenInWallet({ address, policyid, tokenname, }: {
        address: string;
        policyid: string;
        tokenname: string;
    }): CancelablePromise<AssetsAssociatedWithAccount>;
    /**
     * Returns the quantity of a specific token in a wallet
     * @returns AssetsAssociatedWithAccount Returns the AssetsAssociatedWithAccount Class
     * @throws ApiError
     */
    postV2GetAmountOfSpecificTokenInWallet({ policyid, tokenname, requestBody, }: {
        policyid: string;
        tokenname: string;
        requestBody?: Array<string>;
    }): CancelablePromise<AssetsAssociatedWithAccount>;
    /**
     * Returns the Token Registry Information for a specific token (if available)
     * @returns TokenInformationClass Returns TokenInformationClass
     * @throws ApiError
     */
    getV2GetCardanoTokenRegistryInformation({ policyid, tokenname, }: {
        policyid: string;
        /**
         * The Name of the Token (not HEX)
         */
        tokenname: string;
    }): CancelablePromise<TokenInformationClass>;
    /**
     * Returns the Metadata for a specific token
     * @returns string Returns the Metadata as String
     * @throws ApiError
     */
    getV2GetMetadataForToken({ policyid, tokennamehex, }: {
        policyid: string;
        tokennamehex: string;
    }): CancelablePromise<string>;
    /**
     * Returns a snapshot with all addresses and tokens for a specific policyid
     * You will receive all tokens and the holding addresses of a specific policyid
     * @returns NmkrAssetAddress Returns an array of NmkrAssetAddress
     * @throws ApiError
     */
    getV2GetPolicySnapshot({ policyid, cumulateStakeAddresses, withMintingInformation, blockchain, }: {
        policyid: string;
        cumulateStakeAddresses?: boolean;
        withMintingInformation?: boolean;
        blockchain?: Blockchain;
    }): CancelablePromise<Array<NmkrAssetAddress>>;
    /**
     * Returns the IPFS Hash of the preview image for a specific token
     * @returns string Returns the IPFS/IAGON Link for the preview image
     * @throws ApiError
     */
    getV2GetPreviewImageForToken({ policyid, tokennamehex, }: {
        policyid: string;
        tokennamehex: string;
    }): CancelablePromise<string>;
    /**
     * Returns the actual price in EUR and USD for ADA,APT,SOL,ETH, etc.
     * @returns NewRatesClass Returns the NewRatesClass
     * @throws ApiError
     */
    getV2GetRates({ coin }: {
        coin?: Coin;
    }): CancelablePromise<NewRatesClass>;
    /**
     * Returns the royalty information for a specific policyid
     * You will receive the rate in percent and the wallet address for the royalties (if applicable) of a specific policyid
     * @returns RoyaltyClass Returns an array of RoyaltyClass
     * @throws ApiError
     */
    getV2GetRoyaltyInformation({ policyid }: {
        policyid: string;
    }): CancelablePromise<RoyaltyClass>;
}