Home > @infiniteobjects/data-types
Common Schemas and types
| Class | Description |
|---|---|
| AnimationDetails | AnimationDetails specific to ERC721 tokens |
| ArtistRegistry | Artist Registry |
| ArtistRegistryContractData | Contract signed data (from the blockchain) |
| ArtistRegistryMailStats | Information about the status of transactional emails |
| AssetCollection | Metadata about the collection this Token is part of. |
| AssetContract | An smart contract address enhanced with metadata |
| AssetContractAllowList | AllowList Entity. Used to determine if a contract is explicitly allowed/disallowed for printing |
| AssetOriginalFile | Asset Original File |
| AssetPointer | NFT pointer |
| AssetPrintabilityStatus | Printability status |
| Attribute | Attribute specific to ERC721 token attributes array |
| BlockchainNetworkPointerAvalanche | A reference to an Avalanche network |
| BlockchainNetworkPointerBase | A reference to a Base network |
| BlockchainNetworkPointerBinance | A reference to a Binance network |
| BlockchainNetworkPointerEth | A reference to an Ethereum network |
| BlockchainNetworkPointerFlow | A reference to a FLow network |
| BlockchainNetworkPointerPalm | A reference to a Palm network |
| BlockchainNetworkPointerPolygon | A reference to a Polygon network |
| BlockchainNetworkPointerPrivate | A reference to a Private network |
| BlockchainNetworkPointerSolana | A reference to a Solana network |
| BlockchainNetworkPointerTezos | A reference to a Tezos network |
| BlockchainTransactionStatus | Status of a Blockchain transaction |
| Color | Color manager, Expressed in RGBA |
| Device | The Device that plays the video |
| Dimension | Dimensions (in Pixels) |
| EthAssetToken | Ethereum Token |
| HelpDesk | Help Desk Interface |
| ImageDetails | ImageDetails specific to ERC721 tokens |
| MediaVideo | A media video resource |
| MediaVideoSrc | Media Video source resource |
| PartialVector2D | Partial Vector2D |
| PrintButtonAboutCard | Data needed to render the about card |
| PrintButtonAboutView | Data needed to render the about view |
| PrintButtonAvailableBlockchain | Blockchain Available to the print button configuration |
| PrintButtonAvailableVariant | PrintButtonAvailableVariant |
| PrintButtonCallbackJob | Print Button Callback Job |
| PrintButtonCallbackPayload | Print Button Callback Payload |
| PrintButtonPartnerConfigHooks | Hook events that the partner is subscribed to. |
| PrintButtonPlatformConfig | Print Button Platform Configuration |
| PrintButtonPlatformConfigUtils | Utilities to manage the PlatformConfig |
| PrintButtonSale | Print Button Sale |
| Profile | An User Profile |
| QrCode | QrCode |
| RenderJob | Render Job |
| RenderJobPayload | The Render Job Payload includes the data needed to perform the job |
| RenderJobResult | Render Job Result |
| RenderJobWorker | The render worker that performed this job |
| ScreenPosition | Dimensions (in Pixels) |
| ShippingTimes | Shipping Time Utils class |
| Sku | |
| StorageObject | Google Storage Object |
| TokenMetadata | This is the official ERC721 token metadata format |
| TopShotAssetToken | TopShot NFT Asset Public API |
| Transform | Utility to serialize and deserialize Classes |
| Validate | Utility to validate Classes |
| Vector2D | 2D Vector Class |
| Vector3D | 3D Vector Class |
| VideoMetadata | Video Metadata |
| VideoPrint | Video Print |
| VideoPrintBase | Video Print Base |
| VideoPrintBaseBackgroundColor | Video Print Base Background Color |
| VideoPrintBaseDevice | Video Print Base Device |
| VideoPrintBaseTransform | Video Print Base Transformations |
| VideoPrintEditorColorPickerFeatures | Color Picker Feature flags |
| VideoPrintEditorDeviceFeatures | Device Customization Feature Flags |
| VideoPrintEditorFeatures | Feature Flags available to the VideoPrintEditor |
| VideoPrintEditorTransformFeatures | Video Transformation Feature Flags |
| VideoPrintRenders | Video Print Renders Model |
| VideoPrintRendersFlash | Video Print Renders for Flashing |
| VideoPrintSale | Sales data from shopify |
| VideoPrintSource | Video Print Source Model |
| VideoPrintSourceUrl | Video Print Source Url Model |
| VideoTransform | Transformations applied to the video |
| Abstract Class | Description |
|---|---|
| AssetToken | Asset Token data. |
| BlockchainNetworkPointer | An abstract class referencing to an specific Blockchain Network. |
| Enumeration | Description |
|---|---|
| ArtistRegistryContractPriceTier | This is the price selected during the contract sign process. |
| AssetContractAllowListReason | AssetContractAllowList Reasons for allowing/disallowing printing |
| AssetContractSchemaName | Token standards and well known non standardized ones like CryptoPunks. |
| AssetContractType | Types of asset contracts |
| AssetSorting | Sorting values for the asset list. |
| AssetType | Type of data the Token points to |
| AvailableVariantTierPrice | Variant Tier price |
| Blockchain | Supported Blockchains |
| BlockchainNetwork | Blockchain Networks we use |
| DeviceBackLayer | Device Black Layer |
| DeviceColorProfile | Color Profile IDs |
| DeviceFrontLayer | Device Front Layer |
| DeviceLayer | Device Layer |
| DeviceMaterial | Device Material |
| DeviceOrientation | Device Orientation |
| DeviceSize | Device size |
| FileType | Type of file used to discriminate between different types of render modes |
| MediaVideoCodec | Media Video Codec |
| MomentLeague | Moment League type |
| PrintabilityReason | Reason why an asset cannot be printed |
| PrintabilityReasonSeverity | Severity of printability reason |
| PrintButtonCopyrightEnforcementMethod | Copyright enforcement method |
| PrintButtonPlatformPayoutMode | Type of Payout distribution |
| PrintButtonPlatformStatus | Platform Configuration Status |
| PrintButtonWebhookEvent | Events that are sent to the partners |
| ProfileServices | List of known profile services |
| RenderJobState | Render Job State |
| RenderJobType | Render Job Types |
| SkuCustomization | SKU customizations |
| SkuMaterial | SkuMaterials. Maps 1-1 with DeviceMaterials |
| SkuOrderType | SKU order types |
| SocialNetwork | Supported SocialNetworks |
| TokenService | Blockchain services we use |
| VideoFilter | The Filter applied to the video |
| VideoLoop | Loop Effect |
| VideoPrintState | VideoPrint State |
| VideoPrintType | Type of VideoPrint ‘UGC’ |
| Function | Description |
|---|---|
| AddressTransformer({ value }) | Checks if the given value is a valid address and normalizes it. |
| HasDefaultBlockchain(options) | Checks if the PrintButtonPlatformConfig.availableBlockchains array has only one default blockchain. |
| IsDomain(options) | Checks if the given value is a valid numericID string. Uses the last digit as a check digit |
| isSkuCustomization(val) | Checks if the given value is a valid SkuCustomization |
| IsSkuCustomization(options) | Checks if the given value is a valid SkuCustomization |
| isSkuMaterial(val) | |
| IsSkuMaterial(options) | |
| isSkuOrderType(val) | |
| IsSkuOrderType(options) | |
| isSkuTuple(arr) | Checks if the given value is a valid SkuTuple ([DeviseSize, DeviceMaterial]) |
| IsSkuTuple(options) | Checks if the given value is a valid SKU ([DeviseSize, DeviceMaterial]) |
| IsUrl(options, validationOptions) | Checks if a given string is a valid URL |
| IsValidNumericId(options) | Checks if the given value is a valid numericID string. Uses the last digit as a check digit |
| VariantsMatchSettings(options) | Checks if the PrintButtonPlatformConfig.availableVariants array has the right amount of variants. |
| Interface | Description |
|---|---|
| DistinctUnit | Distinct Unit |
| IArtistRegistry | Artist Registry Public API |
| IArtistRegistryContractData | Contract signed data |
| IArtistRegistryMailStats | Information about the status of transactional emails |
| IArtistRegistrySchemaV1 | Artist Registry Database Schema |
| IArtistRegistrySignedData | IArtistRegistryContractData with hasSigned prop |
| IAssetAnyTraits | Object Like Asset Interface |
| IAssetCollection | Metadata about the collection this Token is part of. |
| IAssetContract | An smart contract address enhanced with metadata |
| IAssetContractAllowList | AllowList Entity. Used to determine if a contract is explicitly allowed/disallowed for printing |
| IAssetContractAllowListSchema | IAllowListSchema Schema |
| IAssetOriginalFile | Asset Original File |
| IAssetPointer | NFT data |
| IAssetPrintabilityStatus | Printability status |
| IAssetToken | Asset Token data. |
| IAssetTokenBase | Minimal information about an asset |
| IAssetTraits | Generic Asset Interface |
| IBlockchainNetworkPointer | A reference to an specific Blockchain Network. (blockchain type and network running) |
| IBlockchainTransactionStatus | Status of a Blockchain transaction |
| IDevice | The Device that plays the video |
| IDimension | Dimensions in Pixels |
| IEthAssetToken | Ethereum Token |
| IHelpDesk | Help Desk Interface |
| IMediaVideo | A media video resource |
| IMediaVideoSrc | Media Video source resource |
| IPrintButtonAboutCard | Data needed to render the about card |
| IPrintButtonAboutView | Data needed to render the about |
| IPrintButtonApiRequestProduct | Request search params to call GET /print-button/:partnerId/product |
| IPrintButtonApiResponseConfig | Response from calling GET /print-button/:partnerId/config |
| IPrintButtonApiResponseProduct | Response from calling GET /print-button/:partnerId/product |
| IPrintButtonAvailableBlockchain | Blockchain Available to the print button configuration |
| IPrintButtonAvailableVariant | Print button partner available variant |
| IPrintButtonCallbackJob | The callback job that is sent to the pub/sub |
| IPrintButtonCallbackPayload | The contents of the payload being sent to the partner |
| IPrintButtonPartnerConfigHooks | Hook events that the partner is subscribed to. |
| IPrintButtonPlatformConfig | Print Button Platform Configuration |
| IPrintButtonSale | Print Button Sale |
| IPrintButtonSaleLineItemProps | Line Item Properties for print button sales |
| IProfile | User Profile Public API |
| IQrCode | QrCode Public API |
| IQrCodeCsv | Serialized for CSV |
| IQrCodeSchemaV1 | Qr Code Schema V1 |
| IQrCodeSchemaV2 | Qr Code Schema |
| IRenderJob | Render Job Public API |
| IRenderJobPayload | The Render Job Payload includes the data needed to perform the job |
| IRenderJobResult | Render Job Result |
| IRenderJobSchemaV1 | Render Job Storage Schema |
| IRenderJobSchemaV2 | Render Job Storage Schema V2 |
| IRenderJobWorker | The render worker that performed this job |
| IScreenPosition | Screen Position |
| IShopifyMediaImage | Media Image type |
| IShopifyMediaVideo | Media Video type |
| IShopifyMediaVideoSrc | Media video source type |
| IShopifyMetafield | Metafield |
| IShopifyPreviewImage | Preview image |
| IShopifyProduct | Product |
| IShopifyVariant | ShopifyVariant |
| ISku | |
| IStorageObject | Google Storage Object Public API |
| IStorageObjectSchemaV1 | Storage Object Schema V1 |
| IStorageObjectSchemaV2 | (BETA) Storage Object Schema V2 |
| ITopshotAssetSchemaV1 | TopShot NFT Asset Schema |
| ITopShotAssetToken | TopShot NFT Asset Public API |
| ITopshotAssetTraits | TopShots Asset Traits |
| IVariant | Own Shopify variant |
| IVector2D | 2D Vector |
| IVector3D | 3D vector |
| IVideoMetadata | Video metadata |
| IVideoPrint | Video Print Public API |
| IVideoPrintBase | Video Print Base |
| IVideoPrintEditorColorPickerFeatures | Color Picker Feature flags |
| IVideoPrintEditorDeviceFeatures | Device Customization Feature Flags |
| IVideoPrintEditorFeatures | Feature Flags available to the VideoPrintEditor |
| IVideoPrintEditorTransformFeatures | Video Transformation Feature Flags |
| IVideoPrintRenders | Render Data |
| IVideoPrintSale | Sale data from shopify |
| IVideoPrintSchemaV1 | Original Video Print Schema |
| IVideoPrintSchemaV2 | Current Video Print Schema V2 |
| IVideoPrintSchemaV3 | Video Print Schema |
| IVideoPrintSource | Video Print Source Schema |
| IVideoPrintSourceUrl | Video Print source files for consumption on webAPPs (api response) |
| IVideoTransform | Video transformations |
| ProcessingTimesByDistinctUnit | Processing Times by Distinct Unit |
| RGBA | RGB Color Space |
| ServiceStatuses | Service Statuses |
| Variable | Description |
|---|---|
| ARTIST_REGISTRY_COLLECTION | Collection Name |
| ARTIST_REGISTRY_CURRENT_SCHEMA | Current Schema Version |
| ARTIST_REGISTRY_KLAVIYO_LIST | Klaviyo List ID |
| ASSET_CONTRACT_ALLOW_LIST_COLLECTION | AssetContractAllowList Collection Name |
| ASSET_CONTRACT_ALLOW_LIST_CURRENT_VERSION | AssetContractAllowList Current schema version |
| AvalancheNetworks | Avalanche Network Names |
| BaseNetworks | Ethereum Network Names |
| BaseScanNetworksHosts | Base Scan Networks Host |
| BinanceNetworks | Binance Network Names |
| BlockchainArtistRegistryMap | Mappeed object defining if a blockchain has an artist registry available |
| BlockchainNameMap | Names of the supported Blockchains |
| BscscanNetworksHosts | Binance Scan Networks Host |
| DEFAULT_PROCESSING_TIME | Default processing time |
| DEFAULT_PROCESSING_TIMES | Default processing time for each distinct unit |
| EthereumNetworks | Ethereum Network Names |
| EtherscanNetworksHosts | Etherscan Networks Host |
| FlowNetworks | Flow Network Names |
| HELP_DESK_URL | Help Desk fallback url |
| MomentAssetRarity | Moment Rarity |
| NIFTY_ADDRESS | Nifty Omnibus Address |
| NULL_ADDRESS | A Null Address |
| PalmNetworks | Palm Network Names |
| PolygonNetworks | Polygon Network Names |
| PolygonscanNetworksHosts | Polyscan Networks Host |
| PRINT_BUTTON_CALLBACK_ID_HEADER | The header we use for Ids |
| PRINT_BUTTON_CALLBACK_SIGN_HEADER | The header we use for sending the signature |
| PRINT_BUTTON_CALLBACK_TOPIC_HEADER | The header we use for the topic |
| PrintabilityReasonSeverityMap | Printability reason to severity mapping |
| PrintabilityReasonSortingOrderMap | Printability reason to sorting order mapping |
| PrintableAssetTypes | Asset types we can print |
| PrivateNetworks | Private Network Names |
| PROFILE_DEFAULT_AVATAR | Our default avatar. |
| QR_CODE_COLLECTION | QrCode Collection Name |
| QR_CODE_CURRENT_SCHEMA | QrCode Current schema version |
| QR_CODE_DEFAULT_REDIRECT | QrCode default redirect |
| QR_CODE_DOMAIN | QrCode Domain |
| QR_CODE_ID_LENGTH | QrCode Url length |
| RENDER_JOB_COLLECTION | Collection Name |
| RENDER_JOB_CURRENT_SCHEMA | Current Schema Version |
| RENDER_JOB_MAX_ELAPSED_TIME_MIN | Max Elapsed time before considering the job stalled |
| RENDER_JOB_TOPIC | The PubSub Topic that manages the jobs |
| SolanaNetworks | Solana Network Names |
| TezosNetworks | Tezos Network Names |
| TOP_SHOT_PRINT_SCALE | TopShot Print Scale |
| VIDEO_PRINT_COLLECTION | Collection Name |
| VIDEO_PRINT_CURRENT_SCHEMA | Current Schema Version |
| Type Alias | Description |
|---|---|
| AnyBlockchainNetworkPointer | Union type of the available pointer types |
| AnyQrCodeSchema | |
| AnyRenderJobSchema | |
| ArtistRegistrySchemaVersion | Artist registry Schema Version 1 |
| AssetContractAllowListVersion | AssetContractAllowListVersions |
| bit8 | <p>An 8bit number</p><p>0 255</p> |
| degrees | <p>A Number in degrees (-360 to 360)</p><p>-360 360</p> |
| DistinctUnitType | Distinct Unit Type |
| float | A Float Number |
| integer | An Integer Number |
| IPrintableAssetTypes | PrintableAssetTypes |
| IPrintButtonApiReQuestPrint | Request body to call POST /print-button/:partnerId/print |
| IPrintButtonApiResponsePrint | Response from calling POST /print-button/:partnerId/print |
| IShopifyMetafieldResource | Metafield resource |
| ITopshotAsset | TopShot NFT Asset Public API |
| IVideoPrintBaseBackgroundColor | Video Print Base Color Partial |
| IVideoPrintBaseDevice | Video Print Base Device |
| IVideoPrintBaseTransform | Video Print Base Transformations |
| IVideoPrintRendersFlash | Flash render files |
| QrCodeSchemaVersion | Qr Code Schema version 1 |
| RenderJobSchemaVersion | Render Job Schema Version |
| SkuTuple | SKU tuple |
| TopShotAssetRarity | TopShots Asset Rarities |
| unit | <p>An unit number</p><p>0 1</p> |
| ValidationArguments | Arguments being sent to message builders - user can create message either by simply returning a string, either by returning a function that accepts MessageArguments and returns a message string built based on these arguments. |
| ValidationDecoratorOptions | Options needed to register a decorator |
| ValidationOptions | Options used to pass to validation decorators. |
| ValidatorConstraintInterface | Custom validators must implement this interface to provide custom validation logic. |
| Vector1D | <p>1 dimensional vector</p><p>-1 1</p> |
| VideoPrintSchemaVersion | Video Print Schema Version 3 |