stack

Home > @infiniteobjects/data-types > IPrintButtonPlatformConfig

IPrintButtonPlatformConfig interface

Print Button Platform Configuration

Signature:

export interface IPrintButtonPlatformConfig 

Properties

Property Modifiers Type Description
aboutCard   IPrintButtonAboutCard Data needed to render the about card
aboutView   IPrintButtonAboutView Data needed to render the About View
active readonly boolean Active “state” means we can take orders from this configuration.
adminId   string UserId who has writing access to this resource
allowedDomains   string[] Domains in which the print button can appear
allowsUnlimitedPrints   boolean Does the platform allows multiple prints per token owner?
announcement   Nullable<string> A markdown text containing an announcement to display on the header of the modal
apiKeyId   Nullable<string> API Key ID associated with this configuration
availableBlockchains   IPrintButtonAvailableBlockchain[] Blockchains used by the platform.
availableMaterials   DeviceMaterial[] List of available Device Materials selected by the partner
availableSizes   DeviceSize[] List of available Device Sizes selected by the partner
availableVariants   IPrintButtonAvailableVariant[] Available Product Variants.
baseVideoPrint   IVideoPrintBase Default VideoPrint settings.
brandHeader   Nullable<string> Co Branded Platform image
brandImage   Nullable<string> Platform Brand image
dateCreated   Date The date the entity was created.
dateUpdated   Date The date the entity was updated.
defaultBlockchain readonly IPrintButtonAvailableBlockchain Default IPrintButtonAvailableBlockchain used by this platform.
description   Nullable<string> Platform description
editorFeatures   IVideoPrintEditorFeatures Available Editor features
helpDesk   IHelpDesk Data needed to render the Help component
hooks   IPrintButtonPartnerConfigHooks Webhooks event urls map
id   string Unique Identifier
latestPayout   Nullable<Date> Date of the last successful payout
managerId   Nullable<string> UserId that manages the integration
name   string Platform name
ownerId   string UserId that owns the platform
payoutMode   PrintButtonPlatformPayoutMode How do we generate payouts?
productId   Nullable<string> Id of the associated product on our store.
sharedSecret   string Shared secret used to verify the webHooks
status   PrintButtonPlatformStatus Indicates the lifecycle status of this configuration.