UNPKG

@venly/venly-core-sdk

Version:

Javascrip/Typescript SDK for Venly's Web3 Services

1,380 lines 24.7 kB
import { Any } from '../../helpers/json'; import * as enums from '../enums/index'; import * as shared from '../shared/index'; /** * */ export declare class VyHealthCheckNftv2Response { /** * Indicates the status of API services as either `UP` or `DOWN`. * @type {string} */ status?: string; constructor(initializer?: VyHealthCheckNftv2Response); } /** * */ export declare class VyTokenContractSummaryDto { /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ address?: string; /** * * @type {string} */ contractUri?: string; /** * * @type {string} */ name?: string; /** * * @type {string} */ symbol?: string; /** * * @type {string} */ image?: string; /** * * @type {VyOnChainState} */ onChainStatus?: enums.VyOnChainState; constructor(initializer?: VyTokenContractSummaryDto); } /** * */ export declare class VyTokenContractMetadataDto { /** * * @type {string} */ name?: string; /** * * @type {string} */ description?: string; /** * * @type {string} */ symbol?: string; /** * * @type {string} */ externalUrl?: string; /** * * @type {string} */ image?: string; /** * * @type {VyTypeValueDto[]} */ media?: shared.VyTypeValueDto[]; /** * * @type {string} */ externalLink?: string; constructor(initializer?: VyTokenContractMetadataDto); } /** * */ export declare class VyUpdateContractMetadataDto { /** * 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. Allowed types are `image, audio, video` * @type {VyTypeValueDto[]} */ media?: shared.VyTypeValueDto[]; constructor(initializer?: VyUpdateContractMetadataDto); } /** * */ export declare class VyTokenTypeSummaryDto { /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @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 {VyStatus} */ onChainStatus?: enums.VyStatus; constructor(initializer?: VyTokenTypeSummaryDto); } /** * */ export declare class VyMetadataDto { constructor(initializer?: VyMetadataDto); } /** * */ export declare class VyTokenAttributeDto { /** * Can be one of: `property|stat|boost` * @type {string} */ type?: string; /** * Name of the attribute * @type {string} */ name?: string; /** * Value of the attribute * @type {string} */ value?: string; /** * Max value for the attribute * @type {string} */ maxValue?: string; constructor(initializer?: VyTokenAttributeDto); } /** * */ export declare class VyUpdateTokenTypeMetadataDto { /** * 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 {VyTypeValueDto[]} */ animationUrls?: shared.VyTypeValueDto[]; /** * 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 {VyTokenAttributeDto[]} */ attributes?: VyTokenAttributeDto[]; constructor(initializer?: VyUpdateTokenTypeMetadataDto); } /** * */ export declare class VyTokenMintsInfoDto { /** * * @type {BigInt} */ pending?: BigInt; /** * * @type {BigInt} */ succeeded?: BigInt; /** * * @type {BigInt} */ failed?: BigInt; constructor(initializer?: VyTokenMintsInfoDto); } /** * */ export declare class VyTokenSummaryDto { /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ contractAddress?: string; /** * * @type {number} */ tokenTypeId?: number; /** * * @type {number} */ tokenId?: number; /** * * @type {string} */ tokenUri?: string; /** * * @type {string} */ name?: string; /** * * @type {string} */ image?: string; /** * * @type {string} */ imagePreview?: string; /** * * @type {string} */ imageThumbnail?: string; /** * * @type {boolean} */ fungible?: boolean; /** * * @type {VyTokenMintsInfoDto} */ mints?: VyTokenMintsInfoDto; constructor(initializer?: VyTokenSummaryDto); } /** * */ export declare class VyUpdateTokenPropertyDto { /** * The new value of the property you wish to update. * @type {string} */ value?: string; constructor(initializer?: VyUpdateTokenPropertyDto); } /** * */ export declare class VyUpdateTokenAttributeDto { /** * Can be one of these: **property|stat|boost** * @type {string} */ type?: string; /** * Value of the attribute * @type {string} */ value?: string; /** * Max value for the attribute * @type {string} */ maxValue?: string; constructor(initializer?: VyUpdateTokenAttributeDto); } /** * */ export declare class VyOrgWalletBalanceDto { /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ address?: string; /** * * @type {number} */ balance?: number; /** * * @type {string} */ symbol?: string; /** * * @type {string} */ rawBalance?: string; /** * * @type {number} */ decimals?: number; constructor(initializer?: VyOrgWalletBalanceDto); } /** * */ export declare class VySortingDto { /** * * @type {boolean} */ empty?: boolean; /** * * @type {boolean} */ unsorted?: boolean; /** * * @type {boolean} */ sorted?: boolean; constructor(initializer?: VySortingDto); } /** * */ export declare class VyPageableObjectDto { /** * * @type {BigInt} */ offset?: BigInt; /** * * @type {VySortingDto} */ sort?: VySortingDto; /** * * @type {boolean} */ unpaged?: boolean; /** * * @type {boolean} */ paged?: boolean; /** * * @type {number} */ pageNumber?: number; /** * * @type {number} */ pageSize?: number; constructor(initializer?: VyPageableObjectDto); } /** * */ export declare class VyPagedOrgWalletBalanceDto { /** * * @type {number} */ totalPages?: number; /** * * @type {BigInt} */ totalElements?: BigInt; /** * * @type {number} */ size?: number; /** * * @type {VyOrgWalletBalanceDto[]} */ content?: VyOrgWalletBalanceDto[]; /** * * @type {number} */ number?: number; /** * * @type {VySortingDto} */ sort?: VySortingDto; /** * * @type {VyPageableObjectDto} */ pageable?: VyPageableObjectDto; /** * * @type {number} */ numberOfElements?: number; /** * * @type {boolean} */ first?: boolean; /** * * @type {boolean} */ last?: boolean; /** * * @type {boolean} */ empty?: boolean; constructor(initializer?: VyPagedOrgWalletBalanceDto); } /** * */ export declare class VyPageableDto { /** * * @type {number} */ pageNumber?: number; /** * * @type {number} */ pageSize?: number; constructor(initializer?: VyPageableDto); } /** * */ export declare class VyCreateCompanyWalletRequest { /** * The blockchain on which you want to create a company minter wallet * @type {VyChain} */ chain?: enums.VyChain; constructor(initializer?: VyCreateCompanyWalletRequest); } /** * */ export declare class VyCreateCompanyWalletOneOf { constructor(initializer?: VyCreateCompanyWalletOneOf); } export interface IVyCompanyWalletBaseProps { /** * * @type {string} */ id?: string; /** * * @type {enums.VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ address?: string; /** * * @type {string} */ walletId?: string; } /** * */ export declare class VyCompanyWalletBase { /** * * @type {string} */ id?: string; /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ address?: string; /** * * @type {string} */ walletId?: string; /** * * @type {VyCompanyWalletType} */ type: enums.VyCompanyWalletType; constructor(_type?: enums.VyCompanyWalletType, initializer?: VyCompanyWalletBase); } export interface IVyCompanyMinterWalletDtoProps extends IVyCompanyWalletBaseProps { /** * * @type {string} */ companyId?: string; } /** * */ export declare class VyCompanyMinterWalletDto extends VyCompanyWalletBase { /** * * @type {string} */ companyId?: string; constructor(initializer?: IVyCompanyMinterWalletDtoProps); } export interface IVyDeployerWalletDtoProps extends IVyCompanyWalletBaseProps { } /** * */ export declare class VyDeployerWalletDto extends VyCompanyWalletBase { constructor(initializer?: IVyDeployerWalletDtoProps); } export interface IVyMinterWalletDtoProps extends IVyCompanyWalletBaseProps { } /** * */ export declare class VyMinterWalletDto extends VyCompanyWalletBase { constructor(initializer?: IVyMinterWalletDtoProps); } /** * */ export declare class VyTokenDestinationDto { /** * Address of the destination wallet where minted tokens will be sent * @type {string} */ address?: string; /** * Amount of tokens to be minted and sent to specified wallet address * @type {BigInt} */ amount?: BigInt; constructor(initializer?: VyTokenDestinationDto); } /** * */ export declare class VyTokenMintResponseDto { /** * * @type {string} */ id?: string; /** * * @type {number} */ tokenId?: number; /** * * @type {Date} */ createdOn?: Date; /** * * @type {VyStatus} */ status?: enums.VyStatus; /** * * @type {string} */ transactionHash?: string; /** * * @type {VyTokenDestinationDto} */ destination?: VyTokenDestinationDto; constructor(initializer?: VyTokenMintResponseDto); } /** * */ export declare class VyPagedTokenMintResponseDto { /** * * @type {number} */ totalPages?: number; /** * * @type {BigInt} */ totalElements?: BigInt; /** * * @type {number} */ size?: number; /** * * @type {VyTokenMintResponseDto[]} */ content?: VyTokenMintResponseDto[]; /** * * @type {number} */ number?: number; /** * * @type {VySortingDto} */ sort?: VySortingDto; /** * * @type {VyPageableObjectDto} */ pageable?: VyPageableObjectDto; /** * * @type {number} */ numberOfElements?: number; /** * * @type {boolean} */ first?: boolean; /** * * @type {boolean} */ last?: boolean; /** * * @type {boolean} */ empty?: boolean; constructor(initializer?: VyPagedTokenMintResponseDto); } /** * */ export declare class VyMintTokensDto { /** * 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 where token is to be sent and the amount of tokens to send * @type {VyTokenDestinationDto[]} */ destinations?: VyTokenDestinationDto[]; constructor(initializer?: VyMintTokensDto); } /** * */ export declare class VyMintTokensResponseDto { /** * * @type {VyTokenMintResponseDto[]} */ mints?: VyTokenMintResponseDto[]; /** * * @type {Any} */ metadata?: Any; constructor(initializer?: VyMintTokensResponseDto); } /** * */ export declare class VyStorageDto { /** * Can be one of: `cloud | ipfs | custom`. **cloud:** We store metadata in our cloud. **ipfs:** metadata will be stored in ipfs. **custom:** You determine where you will store the metadata for this NFT template. * @type {VyStorageType} */ type?: enums.VyStorageType; /** * Location of the NFT metadata. This property is mandatory only if `storage.type` is set to custom * @type {string} */ location?: string; constructor(initializer?: VyStorageDto); } /** * */ export declare class VyTokenTypeCreationDto { /** * 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 {VyTypeValueDto[]} */ animationUrls?: shared.VyTypeValueDto[]; /** * 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 {VyTokenAttributeDto[]} */ attributes?: VyTokenAttributeDto[]; /** * This array if defined will create the token-type and also mint tokens to the provided wallet addresses. * @type {VyTokenDestinationDto[]} */ destinations?: VyTokenDestinationDto[]; /** * * @type {VyStorageDto} */ storage?: VyStorageDto; constructor(initializer?: VyTokenTypeCreationDto); } /** * */ export declare class VyCreateTokenTypeDto { /** * 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; /** * * @type {VyTokenTypeCreationDto[]} */ creations?: VyTokenTypeCreationDto[]; constructor(initializer?: VyCreateTokenTypeDto); } /** * */ export declare class VyTokenTypeCreationDetailView { /** * * @type {string} */ id?: string; /** * * @type {VyStatus} */ status?: enums.VyStatus; /** * * @type {string} */ transactionHash?: string; /** * * @type {number} */ tokenTypeId?: number; /** * * @type {VyTokenMintResponseDto[]} */ mints?: VyTokenMintResponseDto[]; /** * * @type {Any} */ metadata?: Any; /** * * @type {string} */ errorMessage?: string; constructor(initializer?: VyTokenTypeCreationDetailView); } /** * */ export declare class VyTokenTypeCreationStatusDto { /** * * @type {VyTokenTypeCreationDetailView[]} */ creations?: VyTokenTypeCreationDetailView[]; constructor(initializer?: VyTokenTypeCreationStatusDto); } /** * */ export declare class VyAddMediaRequest { /** * Upload the media file * @type {Buffer} */ file?: Buffer; constructor(initializer?: VyAddMediaRequest); } /** * */ export declare class VyTokenMediaDto { /** * * @type {string} */ media?: string; constructor(initializer?: VyTokenMediaDto); } /** * */ export declare class VyAddNftImageRequest { /** * Upload the NFT image * @type {Buffer} */ file?: Buffer; constructor(initializer?: VyAddNftImageRequest); } /** * */ export declare class VyTokenImageDto { /** * * @type {string} */ image?: string; /** * * @type {string} */ imagePreview?: string; /** * * @type {string} */ imageThumbnail?: string; constructor(initializer?: VyTokenImageDto); } /** * */ export declare class VyJsonNodeTokenContractViewV2 { constructor(initializer?: VyJsonNodeTokenContractViewV2); } /** * */ export declare class VyCreateContractDto { /** * 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; /** * * @type {Any} */ media?: Any; /** * 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 {VyStorageDto} */ storage?: VyStorageDto; /** * The blockchain on which your contract/collection will be created * @type {VyChain} */ chain?: enums.VyChain; constructor(initializer?: VyCreateContractDto); } /** * */ export declare class VyDeployedContractDto { /** * * @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 {VyTypeValueDto[]} */ media?: shared.VyTypeValueDto[]; /** * * @type {string} */ transactionHash?: string; /** * * @type {VyOnChainState} */ status?: enums.VyOnChainState; /** * * @type {string} */ owner?: string; /** * * @type {VyStorageDto} */ storage?: VyStorageDto; /** * * @type {string} */ contractUri?: string; /** * * @type {string} */ externalLink?: string; constructor(initializer?: VyDeployedContractDto); } /** * */ export declare class VyTokenMintStatusDto { /** * * @type {string} */ id?: string; /** * * @type {number} */ tokenId?: number; /** * * @type {Date} */ createdOn?: Date; /** * * @type {VyStatus} */ status?: enums.VyStatus; /** * * @type {string} */ transactionHash?: string; /** * * @type {VyTokenDestinationDto} */ destination?: VyTokenDestinationDto; /** * * @type {Any} */ metadata?: Any; /** * * @type {string} */ errorMessage?: string; constructor(initializer?: VyTokenMintStatusDto); } /** * */ export declare class VyTokenContractDto { /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ address?: string; /** * * @type {string} */ contractUri?: string; /** * * @type {VyOnChainState} */ onChainStatus?: enums.VyOnChainState; /** * * @type {VyTokenContractMetadataDto} */ metadata?: VyTokenContractMetadataDto; constructor(initializer?: VyTokenContractDto); } /** * */ export declare class VyTokenDto { /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ contractAddress?: string; /** * * @type {number} */ tokenTypeId?: number; /** * * @type {number} */ tokenId?: number; /** * * @type {string} */ tokenUri?: string; /** * * @type {VyTokenMintsInfoDto} */ mints?: VyTokenMintsInfoDto; /** * * @type {Any} */ metadata?: Any; constructor(initializer?: VyTokenDto); } /** * */ export declare class VyTokenTypeDto { /** * * @type {VyChain} */ chain?: enums.VyChain; /** * * @type {string} */ contractAddress?: string; /** * * @type {number} */ tokenTypeId?: number; /** * * @type {VyStatus} */ onChainStatus?: enums.VyStatus; /** * * @type {Any} */ metadata?: Any; constructor(initializer?: VyTokenTypeDto); } /** * */ export declare class VyPaginationDto { /** * * @type {number} */ pageNumber?: number; /** * * @type {number} */ pageSize?: number; /** * * @type {number} */ numberOfPages?: number; /** * * @type {BigInt} */ numberOfElements?: BigInt; /** * * @type {boolean} */ hasNextPage?: boolean; /** * * @type {boolean} */ hasPreviousPage?: boolean; constructor(initializer?: VyPaginationDto); } /** * */ export declare class VyResponseEnvelope { /** * * @type {boolean} */ success?: boolean; /** * * @type {VyPaginationDto} */ pagination?: VyPaginationDto; /** * * @type {VySortDto} */ sort?: shared.VySortDto; /** * * @type {Any} */ result?: Any; /** * * @type {VyErrorBody[]} */ errors?: shared.VyErrorBody[]; constructor(initializer?: VyResponseEnvelope); } //# sourceMappingURL=VyModels.Nft.generated.d.ts.map