@venly/venly-core-sdk/dist/api/VyNftAPI.generated.d.ts

Javascrip/Typescript SDK for Venly's Web3 Services

import { VyPromise } from '../core';
import { Any } from '../helpers/json';
import * as nft from '../models/nft/index';
import * as shared from '../models/shared/index';
import * as enums from '../models/enums/index';
import { VyApiBase } from './VyApiBase';
export declare abstract class VyNftAPI_Gen {
    protected _apiBase: VyApiBase;
    protected _apiEndpoint: enums.VyApiEndpoint;
    constructor(_apiBase: VyApiBase);
    /**
    * This endpoint is used to check the current health of the **NFT-API**. It returns the API health status as either **UP** or **DOWN**.
    * @returns {VyHealthCheckNftv2Response}
    */
    checkHealth(): VyPromise<nft.VyHealthCheckNftv2Response>;
    /**
    * This endpoint fetches all of your contracts.
    * @returns {VyTokenContractSummaryDto[]}
    */
    getContracts(): VyPromise<nft.VyTokenContractSummaryDto[]>;
    /**
    * This endpoint is used to fetch the metadata of as contract.
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address whose metadata you want to fetch.
    * @returns {VyTokenContractMetadataDto}
    */
    getContractMetadata(chain: enums.VyChain, contractAddress: string): VyPromise<nft.VyTokenContractMetadataDto>;
    /**
    * This endpoint is used to update the metadata of a contract.
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address whose metadata you want to update.
    * @param {VyUpdateContractMetadataDto} reqParams - Request data for the operation
    * @returns {VyTokenContractMetadataDto}
    */
    updateContractMetadata(chain: enums.VyChain, contractAddress: string, reqParams: nft.VyUpdateContractMetadataDto): VyPromise<nft.VyTokenContractMetadataDto>;
    /**
    *
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address.
    * @returns {VyTokenTypeSummaryDto[]}
    */
    getTokenTypes(chain: enums.VyChain, contractAddress: string): VyPromise<nft.VyTokenTypeSummaryDto[]>;
    /**
    * This endpoint is used to fetch the metadata of a token-type
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address.
    * @param {number} tokenTypeId - The `id` of the token-type whose metadata ypu want to fetch.
    * @returns {Any}
    */
    getTokenTypeMetadata(chain: enums.VyChain, contractAddress: string, tokenTypeId: number): VyPromise<Any>;
    /**
    * This endpoint is used to update the metadata of a token-type.
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address.
    * @param {number} tokenTypeId - The `id` of the token-type whose metadata you want to update.
    * @param {VyUpdateTokenTypeMetadataDto} reqParams - Request data for the operation
    * @returns {Any}
    */
    updateTokenTypeMetadata(chain: enums.VyChain, contractAddress: string, tokenTypeId: number, reqParams: nft.VyUpdateTokenTypeMetadataDto): VyPromise<Any>;
    /**
    * This endpoint is used to get all tokens in a contract.
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address whose tokens you want to fetch.
    * @param {VyQuery_GetAllTokens} query - Query to filter the operation results
    * @returns {VyTokenSummaryDto[]}
    */
    getAllTokens(chain: enums.VyChain, contractAddress: string, query?: nft.VyQuery_GetAllTokens): VyPromise<nft.VyTokenSummaryDto[]>;
    /**
    * This endpoint fetches the metadata of a token by `tokenId`.
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address.
    * @param {number} tokenId - The `id` of the token whose metadata you want to fetch.
    * @returns {Any}
    */
    getTokenMetadata(chain: enums.VyChain, contractAddress: string, tokenId: number): VyPromise<Any>;
    /**
    * This endpoint is used to update a property for a specific NFT.
    * @param {VyChain} chain - The blockchain of the NFT collection
    * @param {string} contractAddress - The NFT contract address
    * @param {number} tokenId - The `ID` of the token you want to update
    * @param {VyTokenPropertyName2} propertyName - The name of the property you want to update (**NOTE**: This param is case sensitive.)
    * @param {VyUpdateTokenPropertyDto} reqParams - Request data for the operation
    * @returns {Any}
    */
    updateTokenProperty(chain: enums.VyChain, contractAddress: string, tokenId: number, propertyName: enums.VyTokenPropertyName2, reqParams: nft.VyUpdateTokenPropertyDto): VyPromise<Any>;
    /**
    * This endpoint is used to delete a property for a specific NFT.
    * @param {VyChain} chain - The blockchain of the NFT collection
    * @param {string} contractAddress - The NFT contract address
    * @param {number} tokenId - The `ID` of the token you want to update
    * @param {VyTokenPropertyName1} propertyName - The name of the property you want to update (**NOTE**: This param is case sensitive.)
    * @returns {Any}
    */
    deleteTokenProperty(chain: enums.VyChain, contractAddress: string, tokenId: number, propertyName: enums.VyTokenPropertyName1): VyPromise<Any>;
    /**
    * This endpoint is used to add attributes to a specific NFT.
    * @param {VyChain} chain - The blockchain of the NFT collection
    * @param {string} contractAddress - The NFT contract address
    * @param {number} tokenId - The `ID` of the token
    * @param {VyTokenAttributeDto} reqParams - Request data for the operation
    * @returns {Any}
    */
    addTokenAttribute(chain: enums.VyChain, contractAddress: string, tokenId: number, reqParams: nft.VyTokenAttributeDto): VyPromise<Any>;
    /**
    * This endpoint is used to update an attribute's data for a specific NFT.
    * @param {VyChain} chain - The blockchain of the NFT collection
    * @param {string} contractAddress - The NFT contract address
    * @param {number} tokenId - The `ID` of the token you want to update
    * @param {string} attributeName - The name of the attribute you want to update (**NOTE**: This param is case sensitive.)
    * @param {VyUpdateTokenAttributeDto} reqParams - Request data for the operation
    * @returns {Any}
    */
    updateAttribute(chain: enums.VyChain, contractAddress: string, tokenId: number, attributeName: string, reqParams: nft.VyUpdateTokenAttributeDto): VyPromise<Any>;
    /**
    * This endpoint is used to delete an attribute for a specific NFT.
    * @param {VyChain} chain - The blockchain of the NFT collection
    * @param {string} contractAddress - The NFT contract address
    * @param {number} tokenId - The `ID` of the token for which you want to delete the attribute
    * @param {string} attributeName - The name of the attribute you want to delete. (**NOTE**: This param is case sensitive.)
    * @returns {Any}
    */
    deleteAttribute(chain: enums.VyChain, contractAddress: string, tokenId: number, attributeName: string): VyPromise<Any>;
    /**
    * This endpoint is used to update the `animationUrls` for a specific NFT.
    * @param {VyChain} chain - The blockchain of the NFT collection
    * @param {string} contractAddress - The NFT contract address
    * @param {number} tokenId - The `ID` of the token you want to update
    * @param {VyTypeValueDto[]} reqParams - Request data for the operation
    * @returns {Any}
    */
    updateAnimationUrLs(chain: enums.VyChain, contractAddress: string, tokenId: number, reqParams: shared.VyTypeValueDto[]): VyPromise<Any>;
    /**
    * This endpoint is used to delete `animationUrls` for a specific NFT.
    * @param {VyChain} chain - The blockchain of the NFT collection
    * @param {string} contractAddress - The NFT contract address
    * @param {number} tokenId - The `ID` of the token
    * @returns {Any}
    */
    deleteAnimationUrls(chain: enums.VyChain, contractAddress: string, tokenId: number): VyPromise<Any>;
    /**
    * This endpoint retrieves all company minter wallets.
    * @param {VyQuery_GetAllCompanyWallets} query - Query to filter the operation results
    * @returns {VyPagedOrgWalletBalanceDto}
    */
    getAllCompanyWallets(query?: nft.VyQuery_GetAllCompanyWallets): VyPromise<nft.VyPagedOrgWalletBalanceDto>;
    /**
    * This endpoint is used to create company minter wallets per blockchain.
    * @param {VyCreateCompanyWalletRequest} reqParams - Request data for the operation
    * @returns {VyCompanyWalletBase}
    */
    createCompanyWallet(reqParams: nft.VyCreateCompanyWalletRequest): VyPromise<nft.VyCompanyWalletBase>;
    /**
    * This endpoint is used to retrieve all of your token mint requests.
    * @param {VyQuery_GetAllTokenMints} query - Query to filter the operation results
    * @returns {VyPagedTokenMintResponseDto}
    */
    getAllTokenMints(query?: nft.VyQuery_GetAllTokenMints): VyPromise<nft.VyPagedTokenMintResponseDto>;
    /**
    * This endpoint is used to mint fungible or non-fungible tokens.
    * @param {VyMintTokensDto} reqParams - Request data for the operation
    * @returns {VyMintTokensResponseDto}
    */
    mintTokens(reqParams: nft.VyMintTokensDto): VyPromise<nft.VyMintTokensResponseDto>;
    /**
    * This endpoint is used to create a token-type.
    * @param {VyCreateTokenTypeDto} reqParams - Request data for the operation
    * @returns {VyTokenTypeCreationStatusDto}
    */
    createTokenType(reqParams: nft.VyCreateTokenTypeDto): VyPromise<nft.VyTokenTypeCreationStatusDto>;
    /**
    * This endpoint is used to upload a media file to our servers.
    * @param {VyAddMediaRequest} reqParams - Request data for the operation
    * @returns {VyTokenMediaDto}
    */
    uploadMediaFile(reqParams: nft.VyAddMediaRequest): VyPromise<nft.VyTokenMediaDto>;
    /**
    * This endpoint is used to upload an NFT image to our servers. Make sure to only upload images to with this endpoint.
    * @param {VyAddNftImageRequest} reqParams - Request data for the operation
    * @returns {VyTokenImageDto}
    */
    uploadImage(reqParams: nft.VyAddNftImageRequest): VyPromise<nft.VyTokenImageDto>;
    /**
    * This endpoint is used to create a contract.
    * @param {VyCreateContractDto} reqParams - Request data for the operation
    * @returns {VyDeployedContractDto}
    */
    createContract(reqParams: nft.VyCreateContractDto): VyPromise<nft.VyDeployedContractDto>;
    /**
    * This endpoint is used to check the status of the contract creation request.
    * @param {string} deploymentId - To track the status of contract creation. It is in the response body of the create contract endpoint as `result.id`.
    * @returns {VyDeployedContractDto}
    */
    getContractDeploymentStatus(deploymentId: string): VyPromise<nft.VyDeployedContractDto>;
    /**
    * This endpoint retrieves company minter wallets by blockchain.
    * @param {VyChain} chain - The blockchain to filter the result by
    * @param {VyQuery_GetCompanyWallets} query - Query to filter the operation results
    * @returns {VyPagedOrgWalletBalanceDto}
    */
    getCompanyWallets(chain: enums.VyChain, query?: nft.VyQuery_GetCompanyWallets): VyPromise<nft.VyPagedOrgWalletBalanceDto>;
    /**
    * This endpoint is used to check the status of a token mint request.
    * @param {string} mintId - To track the status of token mint. It is in the response body of the mint tokens endpoint as `result.mints.id`.
    * @returns {VyTokenMintStatusDto}
    */
    getTokenMintStatus(mintId: string): VyPromise<nft.VyTokenMintStatusDto>;
    /**
    * This endpoint is used to check the status of token-type creation request.
    * @param {string} creationId - To track the status of token-type creation. It is in the response body of the create token-type endpoint as `result.id`.
    * @returns {VyTokenTypeCreationDetailView}
    */
    getTokenTypeCreationStatus(creationId: string): VyPromise<nft.VyTokenTypeCreationDetailView>;
    /**
    * This endpoint is used to get a specific contract by blockchain and contract address.
    * @param {VyChain} chain - The blockchain of the contract
    * @param {string} contractAddress - The contract address whose details you want to fetch.
    * @returns {VyTokenContractDto}
    */
    getContract(chain: enums.VyChain, contractAddress: string): VyPromise<nft.VyTokenContractDto>;
    /**
    * This endpoint is used to delete a contract.
    * @param {VyChain} chain - The blockchain of the contract.
    * @param {string} contractAddress - The contract address that you want to delete.
    */
    deleteContract(chain: enums.VyChain, contractAddress: string): VyPromise<Any>;
    /**
    * This endpoint fetches the details of a specific token by tokenId.
    * @param {string} contractAddress - The contract address.
    * @param {number} tokenId - The `id` of the token whose details you want to fetch.
    * @param {VyChain} chain - The blockchain of the contract.
    * @returns {VyTokenDto}
    */
    getToken(contractAddress: string, tokenId: number, chain: enums.VyChain): VyPromise<nft.VyTokenDto>;
    /**
    * This endpoint fetches the details of a specific token-type by `tokenTypeId`.
    * @param {VyChain} chain - Thge blockchain of the contract.
    * @param {string} contractAddress - The contract address
    * @param {number} tokenTypeId - This is the `id` of the token-type.
    * @returns {VyTokenTypeDto}
    */
    getTokenType(chain: enums.VyChain, contractAddress: string, tokenTypeId: number): VyPromise<nft.VyTokenTypeDto>;
    /**
    * This endpoint is used to delete a token-type.
    * @param {VyChain} chain -
    * @param {string} contractAddress - The contract address.
    * @param {number} tokenTypeId - The `id` of the token-type that you want to delete.
    */
    deleteTokenType(chain: enums.VyChain, contractAddress: string, tokenTypeId: number): VyPromise<Any>;
    /**
    * This endpoint deletes a company wallet by blockchain and wallet address.
    * @param {VyChain} chain - The blockchain of the company wallet.
    * @param {string} address - This is the wallet `address` of the company wallet.
    * @returns {VyResponseEnvelope}
    */
    deleteCompanyWallet(chain: enums.VyChain, address: string): VyPromise<nft.VyResponseEnvelope>;
}
//# sourceMappingURL=VyNftAPI.generated.d.ts.map