@venly/venly-core-sdk/dist/models/token/VyModels.Token.generated.d.ts

Javascrip/Typescript SDK for Venly's Web3 Services

import { Any } from '../../helpers/json';
import * as enums from '../enums/index';
import * as shared from '../shared/index';
/**
*
*/
export declare class VySupportedErc1155ChainDto {
    constructor(initializer?: VySupportedErc1155ChainDto);
}
/**
*
*/
export declare class VyCompanyWalletBalanceDto {
    /**
    *
    * @type {string}
    */
    chain?: string;
    /**
    *
    * @type {string}
    */
    address?: string;
    /**
    *
    * @type {number}
    */
    balance?: number;
    /**
    *
    * @type {string}
    */
    symbol?: string;
    /**
    *
    * @type {string}
    */
    rawBalance?: string;
    /**
    *
    * @type {number}
    */
    decimals?: number;
    constructor(initializer?: VyCompanyWalletBalanceDto);
}
/**
*
*/
export declare class VyPageableDto {
    /**
    * The current page number
    * @type {number}
    */
    page?: number;
    /**
    * The number of items per page
    * @type {number}
    */
    size?: number;
    constructor(initializer?: VyPageableDto);
}
/**
*
*/
export declare class VyErc1155TokenContractMetadataDto {
    /**
    *
    * @type {string}
    */
    name?: string;
    /**
    *
    * @type {string}
    */
    description?: string;
    /**
    *
    * @type {string}
    */
    symbol?: string;
    /**
    *
    * @type {string}
    */
    externalUrl?: string;
    /**
    *
    * @type {string}
    */
    image?: string;
    /**
    *
    * @type {Any[]}
    */
    media?: Any[];
    /**
    *
    * @type {string}
    */
    externalLink?: string;
    constructor(initializer?: VyErc1155TokenContractMetadataDto);
}
/**
*
*/
export declare class VyMediaDto {
    /**
    * Add media to the NFT contract/collection. [Read more](https://docs.venly.io/docs/collection-info)
    * @type {VyMediaType}
    */
    type?: enums.VyMediaType;
    /**
    * URL of image or URL of social links
    * @type {string}
    */
    value?: string;
    constructor(initializer?: VyMediaDto);
}
/**
*
*/
export declare class VyUpdateErc1155ContractMetadataRequest {
    /**
    * The name of the contract/collection
    * @type {string}
    */
    name?: string;
    /**
    * The symbol for the contract such as **VENS**
    * @type {string}
    */
    symbol?: string;
    /**
    * The description of the contract/collection
    * @type {string}
    */
    description?: string;
    /**
    * The URL of the image that will be displayed for your collection
    * @type {string}
    */
    image?: string;
    /**
    * You can add an external URL to your collection. This can be anything such as a link to your website
    * @type {string}
    */
    externalUrl?: string;
    /**
    * This is the media object where you can add an social links
    * @type {VyMediaDto[]}
    */
    media?: VyMediaDto[];
    constructor(initializer?: VyUpdateErc1155ContractMetadataRequest);
}
/**
*
*/
export declare class VyErc1155TokenTypeSupplyDto {
    /**
    * The current quantity of tokens minted.
    * @type {number}
    */
    current?: number;
    /**
    * The quantity of tokens that are pending/ being minted.
    * @type {number}
    */
    pending?: number;
    /**
    * The maximum quantity of tokens allowed to be minted.
    * @type {number}
    */
    max?: number;
    constructor(initializer?: VyErc1155TokenTypeSupplyDto);
}
/**
*
*/
export declare class VyErc1155TokenTypeSummaryDto {
    /**
    *
    * @type {string}
    */
    chain: string;
    /**
    *
    * @type {string}
    */
    contractAddress: string;
    /**
    *
    * @type {number}
    */
    tokenTypeId: number;
    /**
    *
    * @type {string}
    */
    name?: string;
    /**
    *
    * @type {string}
    */
    image?: string;
    /**
    *
    * @type {string}
    */
    imagePreview?: string;
    /**
    *
    * @type {string}
    */
    imageThumbnail?: string;
    /**
    *
    * @type {boolean}
    */
    fungible?: boolean;
    /**
    *
    * @type {string}
    */
    onChainStatus?: string;
    /**
    *
    * @type {VyErc1155TokenTypeSupplyDto}
    */
    supply?: VyErc1155TokenTypeSupplyDto;
    constructor(initializer?: VyErc1155TokenTypeSummaryDto);
}
/**
*
*/
export declare class VyMetadataAttribute {
    /**
    *
    * @type {string}
    */
    type?: string;
    /**
    *
    * @type {string}
    */
    name?: string;
    /**
    *
    * @type {string}
    */
    value?: string;
    /**
    *
    * @type {string}
    */
    maxValue?: string;
    /**
    *
    * @type {string}
    */
    displayType?: string;
    /**
    *
    * @type {string}
    */
    traitType?: string;
    constructor(initializer?: VyMetadataAttribute);
}
/**
*
*/
export declare class VyMetadataContractDto {
    /**
    *
    * @type {string}
    */
    address?: string;
    /**
    *
    * @type {string}
    */
    name?: string;
    /**
    *
    * @type {string}
    */
    symbol?: string;
    /**
    *
    * @type {string}
    */
    image?: string;
    /**
    *
    * @type {string}
    */
    imageUrl?: string;
    /**
    *
    * @type {string}
    */
    description?: string;
    /**
    *
    * @type {string}
    */
    externalLink?: string;
    /**
    *
    * @type {string}
    */
    externalUrl?: string;
    /**
    *
    * @type {VyTypeValueDto[]}
    */
    media?: shared.VyTypeValueDto[];
    /**
    *
    * @type {string}
    */
    type?: string;
    constructor(initializer?: VyMetadataContractDto);
}
/**
*
*/
export declare class VyMetadataDto {
    /**
    *
    * @type {string}
    */
    name?: string;
    /**
    *
    * @type {string}
    */
    description?: string;
    /**
    *
    * @type {string}
    */
    symbol?: string;
    /**
    *
    * @type {string}
    */
    image?: string;
    /**
    *
    * @type {string}
    */
    imagePreview?: string;
    /**
    *
    * @type {string}
    */
    imageThumbnail?: string;
    /**
    *
    * @type {string}
    */
    backgroundColor?: string;
    /**
    *
    * @type {string}
    */
    animationUrl?: string;
    /**
    *
    * @type {string}
    */
    externalUrl?: string;
    /**
    *
    * @type {string}
    */
    youtubeUrl?: string;
    /**
    *
    * @type {VyTypeValueDto[]}
    */
    animationUrls?: shared.VyTypeValueDto[];
    /**
    *
    * @type {VyMetadataAttribute[]}
    */
    attributes?: VyMetadataAttribute[];
    /**
    *
    * @type {VyMetadataContractDto}
    */
    contract?: VyMetadataContractDto;
    /**
    *
    * @type {boolean}
    */
    fungible?: boolean;
    constructor(initializer?: VyMetadataDto);
}
/**
*
*/
export declare class VyAnimationUrlDto {
    /**
    * Type of the animation media: `audio`. Supported formats: `mp3 / wav / oga`
    * @type {string}
    */
    type?: string;
    /**
    * URL of the animation media
    * @type {string}
    */
    value?: string;
    constructor(initializer?: VyAnimationUrlDto);
}
/**
*
*/
export declare class VyErc1155TokenAttributeDto {
    /**
    * The stats section is used to display certain stats and metrics, such as the level of a certain item, and the amount of defense, power, or top speed a certain item possesses. When a stat also has a max value defined it will be visualized as a progress bar, otherwise, it will be shown as a card.
    * @type {string}
    */
    type?: string;
    /**
    * Name of the stat
    * @type {string}
    */
    name?: string;
    /**
    * Value of the stat
    * @type {string}
    */
    value?: string;
    /**
    * The maximum value of the stat
    * @type {string}
    */
    maxValue?: string;
    constructor(initializer?: VyErc1155TokenAttributeDto);
}
/**
*
*/
export declare class VyUpdateErc1155TokenTypeMetadataRequest {
    /**
    * The name of the NFT
    * @type {string}
    */
    name?: string;
    /**
    * The description of the NFT
    * @type {string}
    */
    description?: string;
    /**
    * The image URL for the image of the NFT
    * @type {string}
    */
    image?: string;
    /**
    * This can be anything such as a link to your website, landing page, etc
    * @type {string}
    */
    externalUrl?: string;
    /**
    * A hex color code for the background of the NFT
    * @type {string}
    */
    backgroundColor?: string;
    /**
    * The `animationUrls` is an array so you can add more than one piece of media to an NFT. [Read more](https://docs.venly.io/docs/animation-media#animationurls)
    * @type {VyAnimationUrlDto[]}
    */
    animationUrls?: VyAnimationUrlDto[];
    /**
    * In the token type you can define an attribute as one of three types: `property, stat, boost`. [Read more](https://docs.venly.io/docs/nft-attributes)
    * @type {VyErc1155TokenAttributeDto[]}
    */
    attributes?: VyErc1155TokenAttributeDto[];
    constructor(initializer?: VyUpdateErc1155TokenTypeMetadataRequest);
}
/**
*
*/
export declare class VyErc1155TokenMintsInfoDto {
    /**
    * Number of pending mints.
    * @type {BigInt}
    */
    pending?: BigInt;
    /**
    * Number of successful mints.
    * @type {BigInt}
    */
    succeeded?: BigInt;
    /**
    * Number of failed mints.
    * @type {BigInt}
    */
    failed?: BigInt;
    constructor(initializer?: VyErc1155TokenMintsInfoDto);
}
/**
*
*/
export declare class VyErc1155TokenDto {
    /**
    *
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The address of the NFT's smart contract.
    * @type {string}
    */
    contractAddress?: string;
    /**
    * Unique identifier for the token-type.
    * @type {number}
    */
    tokenTypeId?: number;
    /**
    * Unique identifier for the token.
    * @type {number}
    */
    tokenId?: number;
    /**
    * URI pointing to the token's metadata.
    * @type {string}
    */
    tokenUri?: string;
    /**
    * The name of the NFT.
    * @type {string}
    */
    name?: string;
    /**
    * URL of the token's main image.
    * @type {string}
    */
    image?: string;
    /**
    * URL of the token's preview image.
    * @type {string}
    */
    imagePreview?: string;
    /**
    * URL of the token's thumbnail image.
    * @type {string}
    */
    imageThumbnail?: string;
    /**
    * Indicates whether the token is fungible.
    * @type {boolean}
    */
    fungible?: boolean;
    /**
    *
    * @type {VyErc1155TokenMintsInfoDto}
    */
    mints?: VyErc1155TokenMintsInfoDto;
    constructor(initializer?: VyErc1155TokenDto);
}
/**
*
*/
export declare class VyUpdateErc1155TokenPropertyRequest {
    /**
    * The new value of the property you wish to update.
    * @type {string}
    */
    value?: string;
    constructor(initializer?: VyUpdateErc1155TokenPropertyRequest);
}
/**
*
*/
export declare class VyUpdateErc1155TokenAttributeRequest {
    /**
    * Can be one of these: **property | stat | boost**
    * @type {VyTokenAttributeType}
    */
    type?: enums.VyTokenAttributeType;
    /**
    * Value of the attribute
    * @type {string}
    */
    value?: string;
    /**
    * Max value for the attribute
    * @type {string}
    */
    maxValue?: string;
    constructor(initializer?: VyUpdateErc1155TokenAttributeRequest);
}
/**
* Details of the transaction destination.
*/
export declare class VyMintDestinationDto {
    /**
    * Destination wallet address.
    * @type {string}
    */
    address?: string;
    /**
    * Amount sent to the destination.
    * @type {number}
    */
    amount?: number;
    constructor(initializer?: VyMintDestinationDto);
}
/**
*
*/
export declare class VyMintSuiTokensRequest {
    /**
    * The blockchain of the contract
    * @type {string}
    */
    readonly chain: string;
    /**
    * The contract address
    * @type {string}
    */
    contractAddress?: string;
    /**
    * The `id` of the token-type
    * @type {number}
    */
    tokenTypeId?: number;
    /**
    * An array of objects which include the wallet address or email address where token is to be sent and the amount of tokens to send
    * @type {VyMintDestinationDto[]}
    */
    destinations?: VyMintDestinationDto[];
    constructor(initializer?: VyMintSuiTokensRequest);
}
/**
*
*/
export declare class VyErc1155TokenMintInfoDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {number}
    */
    tokenId?: number;
    /**
    *
    * @type {Date}
    */
    createdOn?: Date;
    /**
    *
    * @type {VyStatus}
    */
    status?: enums.VyStatus;
    /**
    *
    * @type {string}
    */
    transactionHash?: string;
    /**
    *
    * @type {VyMintDestinationDto}
    */
    destination?: VyMintDestinationDto;
    constructor(initializer?: VyErc1155TokenMintInfoDto);
}
/**
*
*/
export declare class VyMintErc1155TokensResultDto {
    /**
    *
    * @type {VyErc1155TokenMintInfoDto[]}
    */
    mints?: VyErc1155TokenMintInfoDto[];
    /**
    *
    * @type {VyMetadataDto}
    */
    metadata?: VyMetadataDto;
    constructor(initializer?: VyMintErc1155TokensResultDto);
}
/**
*
*/
export declare class VyMintErc1155TokensRequest {
    /**
    * The blockchain of the contract
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The contract address
    * @type {string}
    */
    contractAddress?: string;
    /**
    * The `id` of the token-type
    * @type {number}
    */
    tokenTypeId?: number;
    /**
    * An array of objects which include the wallet address or email address where token is to be sent and the amount of tokens to send
    * @type {VyMintDestinationDto[]}
    */
    destinations?: VyMintDestinationDto[];
    constructor(initializer?: VyMintErc1155TokensRequest);
}
/**
*
*/
export declare class VyStorageDto {
    /**
    *
    * @type {string}
    */
    type?: string;
    /**
    *
    * @type {string}
    */
    location?: string;
    constructor(initializer?: VyStorageDto);
}
/**
*
*/
export declare class VyCreateErc1155TokenTypeDto {
    /**
    * Determines if the NFTs from this token-type will be minted as fungible/non fungible. If missing it defaults to false.
    * @type {boolean}
    */
    fungible?: boolean;
    /**
    * Determines if the NFTs from this token-type will be burnable. If missing it defaults to false.
    * @type {boolean}
    */
    burnable?: boolean;
    /**
    * Name of the NFTs that will be created from this token-type
    * @type {string}
    */
    name?: string;
    /**
    * Description of the NFTs that will be created from this token-type
    * @type {string}
    */
    description?: string;
    /**
    * Image of the NFTs that will be created from this token-type
    * @type {string}
    */
    image?: string;
    /**
    * External URL of the NFTs that will be created from this token-type
    * @type {string}
    */
    externalUrl?: string;
    /**
    * Background color of the NFTs that will be created from this token-type
    * @type {string}
    */
    backgroundColor?: string;
    /**
    * The `animationUrls` is an array so you can add more than one piece of media to an NFT. [Read more](https://docs.venly.io/docs/animation-media#animationurls)
    * @type {VyAnimationUrlDto[]}
    */
    animationUrls?: VyAnimationUrlDto[];
    /**
    * Max Supply for NFTs created by this token-type
    * @type {number}
    */
    maxSupply?: number;
    /**
    *
    * @deprecated This property will be removed in a future release
    * @type {string}
    */
    animationUrl?: string;
    /**
    *
    * @deprecated This property will be removed in a future release
    * @type {string}
    */
    youtubeUrl?: string;
    /**
    * In the token type you can define an attribute as one of three types: `property, stat, boost`. [Read more](https://docs.venly.io/docs/nft-attributes)
    * @type {VyErc1155TokenAttributeDto[]}
    */
    attributes?: VyErc1155TokenAttributeDto[];
    /**
    * This array if defined will create the token-type and also mint tokens to the provided wallet/email addresses.
    * @type {VyMintDestinationDto[]}
    */
    destinations?: VyMintDestinationDto[];
    /**
    *
    * @type {VyStorageDto}
    */
    storage?: VyStorageDto;
    constructor(initializer?: VyCreateErc1155TokenTypeDto);
}
/**
*
*/
export declare class VyCreateErc1155TokenTypeRequest {
    /**
    * The blockchain of the contract
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The contract address under which you want to create the token-type
    * @type {string}
    */
    contractAddress?: string;
    /**
    * This array defines the properties of the token-type
    * @type {VyCreateErc1155TokenTypeDto[]}
    */
    creations?: VyCreateErc1155TokenTypeDto[];
    constructor(initializer?: VyCreateErc1155TokenTypeRequest);
}
/**
*
*/
export declare class VyErc1155TokenTypeMintInfoDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {Date}
    */
    createdOn?: Date;
    /**
    *
    * @type {string}
    */
    status?: string;
    /**
    *
    * @type {VyMintDestinationDto}
    */
    destination?: VyMintDestinationDto;
    constructor(initializer?: VyErc1155TokenTypeMintInfoDto);
}
/**
*
*/
export declare class VyErc1155TokenTypeCreationDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    status?: string;
    /**
    *
    * @type {number}
    */
    tokenTypeId?: number;
    /**
    *
    * @type {VyErc1155TokenTypeMintInfoDto[]}
    */
    mints?: VyErc1155TokenTypeMintInfoDto[];
    /**
    *
    * @type {VyMetadataDto}
    */
    metadata?: VyMetadataDto;
    constructor(initializer?: VyErc1155TokenTypeCreationDto);
}
/**
*
*/
export declare class VyCreateErc1155TokenTypeResultDto {
    /**
    *
    * @type {VyErc1155TokenTypeCreationDto[]}
    */
    creations?: VyErc1155TokenTypeCreationDto[];
    constructor(initializer?: VyCreateErc1155TokenTypeResultDto);
}
/**
*
*/
export declare class VySuiTokenTypeCreationDto {
    /**
    * Only non-fungible token-type creation is allowed on Sui.
    * @type {boolean}
    */
    fungible?: boolean;
    /**
    * Determines if the NFTs from this token-type will be burnable. If missing it defaults to false.
    * @type {boolean}
    */
    burnable?: boolean;
    /**
    * Name of the NFTs that will be created from this token-type
    * @type {string}
    */
    name?: string;
    /**
    * Description of the NFTs that will be created from this token-type
    * @type {string}
    */
    description?: string;
    /**
    * Image of the NFTs that will be created from this token-type
    * @type {string}
    */
    image?: string;
    /**
    * External URL of the NFTs that will be created from this token-type
    * @type {string}
    */
    externalUrl?: string;
    /**
    * Background color of the NFTs that will be created from this token-type
    * @type {string}
    */
    backgroundColor?: string;
    /**
    * The `animationUrls` is an array so you can add more than one piece of media to an NFT. [Read more](https://docs.venly.io/docs/animation-media#animationurls)
    * @type {VyAnimationUrlDto[]}
    */
    animationUrls?: VyAnimationUrlDto[];
    /**
    * Max Supply for NFTs created by this token-type
    * @type {number}
    */
    maxSupply?: number;
    /**
    *
    * @deprecated This property will be removed in a future release
    * @type {string}
    */
    animationUrl?: string;
    /**
    *
    * @deprecated This property will be removed in a future release
    * @type {string}
    */
    youtubeUrl?: string;
    /**
    * In the token type you can define an attribute as one of three types: `property, stat, boost`. [Read more](https://docs.venly.io/docs/nft-attributes)
    * @type {VyErc1155TokenAttributeDto[]}
    */
    attributes?: VyErc1155TokenAttributeDto[];
    /**
    * This array if defined will create the token-type and also mint tokens to the provided wallet/email addresses.
    * @type {VyMintDestinationDto[]}
    */
    destinations?: VyMintDestinationDto[];
    /**
    *
    * @type {VyStorageDto}
    */
    storage?: VyStorageDto;
    constructor(initializer?: VySuiTokenTypeCreationDto);
}
/**
*
*/
export declare class VyCreateSuiTokenTypeRequest {
    /**
    * The blockchain of the contract
    * @type {string}
    */
    readonly chain: string;
    /**
    * The contract address under which you want to create the token-type
    * @type {string}
    */
    contractAddress?: string;
    /**
    * This array defines the properties of the token-type
    * @type {VySuiTokenTypeCreationDto[]}
    */
    creations?: VySuiTokenTypeCreationDto[];
    constructor(initializer?: VyCreateSuiTokenTypeRequest);
}
/**
*
*/
export declare class VyUploadMediaRequest {
    /**
    * Upload the media file
    * @type {Buffer}
    */
    file?: Buffer;
    constructor(initializer?: VyUploadMediaRequest);
}
/**
*
*/
export declare class VyErc1155TokenMediaDto {
    /**
    *
    * @type {string}
    */
    media?: string;
    constructor(initializer?: VyErc1155TokenMediaDto);
}
/**
*
*/
export declare class VyUploadImageRequest {
    /**
    * Upload the NFT image
    * @type {Buffer}
    */
    file?: Buffer;
    constructor(initializer?: VyUploadImageRequest);
}
/**
*
*/
export declare class VyErc1155TokenImageDto {
    /**
    *
    * @type {string}
    */
    image?: string;
    /**
    *
    * @type {string}
    */
    imagePreview?: string;
    /**
    *
    * @type {string}
    */
    imageThumbnail?: string;
    constructor(initializer?: VyErc1155TokenImageDto);
}
/**
*
*/
export declare class VyRoyaltiesReceiverDto {
    /**
    * The percentage royalties that will be paid out automatically with each succeeding sale of an NFT in the secondary market. The royalty percentage can only contain up to 2 decimals.
    * @type {number}
    */
    percentage?: number;
    /**
    * The recipient wallet address where the royalties will be transferred.
    * @type {string}
    */
    receiver?: string;
    constructor(initializer?: VyRoyaltiesReceiverDto);
}
/**
*
*/
export declare class VyCreateErc1155ContractRequest {
    /**
    * The blockchain on which your contract/collection will be created
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The name of the contract/collection
    * @type {string}
    */
    name?: string;
    /**
    * The symbol for the contract such as **VENS**
    * @type {string}
    */
    symbol?: string;
    /**
    * The description of the contract/collection
    * @type {string}
    */
    description?: string;
    /**
    * The URL of the image that will be displayed for your collection
    * @type {string}
    */
    image?: string;
    /**
    * You can add an external URL to your collection. This can be anything such as a link to your website
    * @type {string}
    */
    externalUrl?: string;
    /**
    * This is the media object where you can add an optional key-value pair
    * @type {VyMediaDto[]}
    */
    media?: VyMediaDto[];
    /**
    * The wallet address which will have admin access to the contract. The owner can call the admin right functions on the contract. You will be co-owning the contract with Venly where you will be the public owner of the contract. Venly is still allowed to do mints on your behalf.
    * @type {string}
    */
    owner?: string;
    /**
    *
    * @type {boolean}
    */
    autoApprovedAddressesLocked?: boolean;
    /**
    *
    * @type {VyRoyaltiesReceiverDto}
    */
    royalties?: VyRoyaltiesReceiverDto;
    /**
    *
    * @type {VyStorageDto}
    */
    storage?: VyStorageDto;
    /**
    * You can optionally provide the `companyId` to specify for which company the contract should be created.
    * @type {string}
    */
    companyId?: string;
    constructor(initializer?: VyCreateErc1155ContractRequest);
}
/**
*
*/
export declare class VyErc1155ContractMediaDto {
    /**
    *
    * @type {string}
    */
    type?: string;
    /**
    *
    * @type {string}
    */
    value?: string;
    constructor(initializer?: VyErc1155ContractMediaDto);
}
/**
*
*/
export declare class VyErc1155ContractRoyaltiesDto {
    /**
    *
    * @type {number}
    */
    percentage?: number;
    /**
    *
    * @type {string}
    */
    receiver?: string;
    constructor(initializer?: VyErc1155ContractRoyaltiesDto);
}
/**
*
*/
export declare class VyDeployedErc1155ContractDto {
    /**
    *
    * @type {string}
    */
    name?: string;
    /**
    *
    * @type {string}
    */
    description?: string;
    /**
    *
    * @type {string}
    */
    address?: string;
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    *
    * @type {string}
    */
    symbol?: string;
    /**
    *
    * @type {string}
    */
    externalUrl?: string;
    /**
    *
    * @type {string}
    */
    image?: string;
    /**
    *
    * @type {VyErc1155ContractMediaDto[]}
    */
    media?: VyErc1155ContractMediaDto[];
    /**
    *
    * @type {string}
    */
    transactionHash?: string;
    /**
    *
    * @type {VyStatus}
    */
    status?: enums.VyStatus;
    /**
    *
    * @type {string}
    */
    owner?: string;
    /**
    *
    * @type {VyStorageDto}
    */
    storage?: VyStorageDto;
    /**
    *
    * @type {string}
    */
    contractUri?: string;
    /**
    *
    * @type {VyErc1155ContractRoyaltiesDto}
    */
    royalties?: VyErc1155ContractRoyaltiesDto;
    /**
    *
    * @type {string}
    */
    externalLink?: string;
    constructor(initializer?: VyDeployedErc1155ContractDto);
}
/**
*
*/
export declare class VyCreateSuiContractRequest {
    /**
    * You can add an external URL to your collection. This can be anything such as a link to your website
    * @type {string}
    */
    externalUrl?: string;
    /**
    * The symbol for the contract such as **VENS**
    * @type {string}
    */
    symbol?: string;
    /**
    *
    * @type {VyRoyaltiesReceiverDto}
    */
    royalties?: VyRoyaltiesReceiverDto;
    constructor(initializer?: VyCreateSuiContractRequest);
}
/**
*
*/
export declare class VyUpdateErc1155ContractOwnerRequest {
    /**
    * The wallet address of the new owner that will have admin rights on the contract.
    * @type {string}
    */
    owner?: string;
    constructor(initializer?: VyUpdateErc1155ContractOwnerRequest);
}
/**
*
*/
export declare class VyUpdateErc1155ContractRoyaltiesRequest {
    /**
    *
    * @type {VyRoyaltiesReceiverDto}
    */
    royalties?: VyRoyaltiesReceiverDto;
    constructor(initializer?: VyUpdateErc1155ContractRoyaltiesRequest);
}
/**
*
*/
export declare class VyErc1155TokenMintDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    chain?: string;
    /**
    *
    * @type {string}
    */
    contractAddress?: string;
    /**
    *
    * @type {number}
    */
    tokenTypeId?: number;
    /**
    *
    * @type {number}
    */
    tokenId?: number;
    /**
    *
    * @type {Date}
    */
    createdOn?: Date;
    /**
    *
    * @type {VyStatus}
    */
    status?: enums.VyStatus;
    /**
    *
    * @type {string}
    */
    transactionHash?: string;
    /**
    *
    * @type {VyMintDestinationDto}
    */
    destination?: VyMintDestinationDto;
    /**
    *
    * @type {VyMetadataDto}
    */
    metadata?: VyMetadataDto;
    constructor(initializer?: VyErc1155TokenMintDto);
}
/**
*
*/
export declare class VyCheckErc1155TokenTypeResultDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    status?: string;
    /**
    *
    * @type {string}
    */
    transactionHash?: string;
    /**
    *
    * @type {number}
    */
    tokenTypeId?: number;
    /**
    *
    * @type {VyErc1155TokenTypeMintInfoDto[]}
    */
    mints?: VyErc1155TokenTypeMintInfoDto[];
    /**
    *
    * @type {VyMetadataDto}
    */
    metadata?: VyMetadataDto;
    /**
    *
    * @type {boolean}
    */
    fungible?: boolean;
    constructor(initializer?: VyCheckErc1155TokenTypeResultDto);
}
/**
*
*/
export declare class VyErc1155ContractMetadataDto {
    /**
    *
    * @type {string}
    */
    name?: string;
    /**
    *
    * @type {string}
    */
    description?: string;
    /**
    *
    * @type {string}
    */
    symbol?: string;
    /**
    *
    * @type {string}
    */
    externalUrl?: string;
    /**
    *
    * @type {string}
    */
    image?: string;
    /**
    *
    * @type {Any[]}
    */
    media?: Any[];
    /**
    *
    * @type {string}
    */
    externalLink?: string;
    constructor(initializer?: VyErc1155ContractMetadataDto);
}
/**
*
*/
export declare class VyErc1155ContractDto {
    /**
    *
    * @type {VyChain}
    */
    chain: enums.VyChain;
    /**
    *
    * @type {string}
    */
    address?: string;
    /**
    *
    * @type {string}
    */
    contractUri?: string;
    /**
    *
    * @type {VyStatus}
    */
    onChainStatus?: enums.VyStatus;
    /**
    *
    * @type {string}
    */
    owner?: string;
    /**
    *
    * @type {VyErc1155ContractRoyaltiesDto}
    */
    royalties?: VyErc1155ContractRoyaltiesDto;
    /**
    *
    * @type {VyErc1155ContractMetadataDto}
    */
    metadata?: VyErc1155ContractMetadataDto;
    constructor(initializer?: VyErc1155ContractDto);
}
/**
*
*/
export declare class VyErc1155TokenTypeDto {
    /**
    *
    * @type {string}
    */
    chain?: string;
    /**
    *
    * @type {string}
    */
    contractAddress?: string;
    /**
    *
    * @type {number}
    */
    tokenTypeId?: number;
    /**
    *
    * @type {string}
    */
    onChainStatus?: string;
    /**
    *
    * @type {boolean}
    */
    burnable?: boolean;
    /**
    *
    * @type {VyErc1155TokenTypeSupplyDto}
    */
    supply?: VyErc1155TokenTypeSupplyDto;
    /**
    *
    * @type {VyStorageDto}
    */
    storage?: VyStorageDto;
    /**
    *
    * @type {VyMetadataDto}
    */
    metadata?: VyMetadataDto;
    constructor(initializer?: VyErc1155TokenTypeDto);
}
/**
*
*/
export declare class VyTokenApiHealthDto {
    /**
    * Indicates the status of the API service as either `UP` or `DOWN`.
    * @type {string}
    */
    status?: string;
    constructor(initializer?: VyTokenApiHealthDto);
}
/**
*
*/
export declare class VySupportedErc20ChainDto {
    constructor(initializer?: VySupportedErc20ChainDto);
}
/**
*
*/
export declare class VyCreateErc20ContractRequest {
    /**
    * The blockchain of the token contract.
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The name of the token contract.
    * @type {string}
    */
    name?: string;
    /**
    * The symbol for your token contract. (generated based on name if empty)
    * @type {string}
    */
    symbol?: string;
    /**
    * The maximum amount of tokens allowed to be minted.
    * @type {number}
    */
    maxSupply?: number;
    /**
    * Indication wether the tokens will be burnable or not. Burning tokens is the act of sending tokens to a wallet that cannot be accessed
    * @type {boolean}
    */
    burnable?: boolean;
    /**
    * The wallet address who will be the owner of this token contract. The owner will have admin rights on the token contract.
    * @type {string}
    */
    owner?: string;
    /**
    * You can optionally provide the `companyId` to specify for which company the contract should be created.
    * @type {string}
    */
    companyId?: string;
    constructor(initializer?: VyCreateErc20ContractRequest);
}
/**
*
*/
export declare class VyDeployedErc20ContractDto {
    /**
    * The deploment UUID of the token contract.
    * @type {string}
    */
    id?: string;
    /**
    * The blockchain of the token contract.
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The token contract address.
    * @type {string}
    */
    address?: string;
    /**
    * The token contract name.
    * @type {string}
    */
    name?: string;
    /**
    * The token contract symbol.
    * @type {string}
    */
    symbol?: string;
    /**
    * The maximum number of tokens allowed to be minted.
    * @type {number}
    */
    maxSupply?: number;
    /**
    * Indication if the token contract is burnable or not.
    * @type {boolean}
    */
    burnable?: boolean;
    /**
    * The owner wallet address that has admin right on the token contract.
    * @type {string}
    */
    owner?: string;
    /**
    * The transaction hash of the token contract deployment.
    * @type {string}
    */
    transactionHash?: string;
    /**
    * The current status of the token contract deployment.
    * @type {VyStatus}
    */
    status?: enums.VyStatus;
    constructor(initializer?: VyDeployedErc20ContractDto);
}
/**
*
*/
export declare class VyErc20TokenDestinationDto {
    /**
    * Address of the destination wallet where minted ERC20 tokens will be sent.
    * @type {string}
    */
    address?: string;
    /**
    * Amount of ERC20 tokens to be minted and sent to specified wallet address.
    * @type {number}
    */
    amount?: number;
    constructor(initializer?: VyErc20TokenDestinationDto);
}
/**
*
*/
export declare class VyMintErc20TokensRequest {
    /**
    * The blockchain of the token contract.
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The token contract address.
    * @type {string}
    */
    contractAddress?: string;
    /**
    * An array of objects which include the wallet addresses where token are to be sent and the amount of tokens to send. You can define multiple destinations.
    * @type {VyErc20TokenDestinationDto[]}
    */
    destinations?: VyErc20TokenDestinationDto[];
    constructor(initializer?: VyMintErc20TokensRequest);
}
/**
*
*/
export declare class VyErc20TokenContractDto {
    /**
    * The blockchain of the token contract.
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The token contract address.
    * @type {string}
    */
    address?: string;
    /**
    * The token contract name.
    * @type {string}
    */
    name?: string;
    /**
    * The token contract symbol.
    * @type {string}
    */
    symbol?: string;
    /**
    * The maximum number of token allowed to be minted under the token contract.
    * @type {number}
    */
    maxSupply?: number;
    /**
    * Indication if the token contract is set to burnable or not.
    * @type {boolean}
    */
    burnable?: boolean;
    /**
    * The owner wallet address that has admin rights on the token contract.
    * @type {string}
    */
    owner?: string;
    /**
    * The current on-chain status of the deployed token contract.
    * @type {VyOnChainState}
    */
    onChainStatus?: enums.VyOnChainState;
    constructor(initializer?: VyErc20TokenContractDto);
}
/**
*
*/
export declare class VyErc20TokenMintDto {
    /**
    * The mint UUID used to track the token mint request.
    * @type {string}
    */
    id?: string;
    /**
    * The date-time the token mint was created.
    * @type {Date}
    */
    createdOn?: Date;
    /**
    * The on-chain status of the token mint request.
    * @type {VyStatus}
    */
    status?: enums.VyStatus;
    /**
    * The transaction hash of the token mint.
    * @type {string}
    */
    transactionHash?: string;
    /**
    *
    * @type {VyErc20TokenDestinationDto}
    */
    destination?: VyErc20TokenDestinationDto;
    /**
    *
    * @type {VyErc20TokenContractDto}
    */
    contract?: VyErc20TokenContractDto;
    constructor(initializer?: VyErc20TokenMintDto);
}
/**
*
*/
export declare class VyMintErc20TokensResultDto {
    /**
    * Details of the token mint request.
    * @type {VyErc20TokenMintDto[]}
    */
    mints?: VyErc20TokenMintDto[];
    /**
    *
    * @type {VyErc20TokenContractDto}
    */
    contract?: VyErc20TokenContractDto;
    constructor(initializer?: VyMintErc20TokensResultDto);
}
/**
*
*/
export declare class VyErc20TokenMintSummaryDto {
    /**
    * Unique identifier or Mint ID.
    * @type {string}
    */
    id?: string;
    /**
    * Blockchain of the token mint
    * @type {VyChain}
    */
    chain?: enums.VyChain;
    /**
    * The contract address.
    * @type {string}
    */
    contractAddress?: string;
    /**
    * Timestamp when the transaction was created.
    * @type {Date}
    */
    createdOn?: Date;
    /**
    * Current status of the transaction.
    * @type {VyStatus}
    */
    status?: enums.VyStatus;
    /**
    * The transaction hash.
    * @type {string}
    */
    transactionHash?: string;
    /**
    *
    * @type {VyErc20TokenDestinationDto}
    */
    destination?: VyErc20TokenDestinationDto;
    constructor(initializer?: VyErc20TokenMintSummaryDto);
}
/**
*
*/
export declare class VyUpdateErc20ContractOwnerRequest {
    /**
    * Wallet address of the new owner for the token contract.
    * @type {string}
    */
    owner?: string;
    constructor(initializer?: VyUpdateErc20ContractOwnerRequest);
}
//# sourceMappingURL=VyModels.Token.generated.d.ts.map