Home > @infiniteobjects/models > PrintButtonPlatformConfigModel
Print Button Platform Configuration
Signature:
export declare class PrintButtonPlatformConfigModel extends BaseFirebaseEntity implements IPrintButtonPlatformConfigSchema, IPrintButtonPlatformConfig
Extends: BaseFirebaseEntity
Implements: IPrintButtonPlatformConfigSchema, IPrintButtonPlatformConfig
| Property | Modifiers | Type | Description |
|---|---|---|---|
| aboutCard | PrintButtonAboutCard | Data needed to render the about card | |
| aboutView | PrintButtonAboutView | Data needed to render the About View | |
| active | readonly |
boolean | Active “state” means we can take orders from this configuration. |
| adminId | readonly |
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 | PrintButtonAvailableBlockchain[] | 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 | PrintButtonAvailableVariant[] | Available Product Variants. | |
| baseVideoPrint | VideoPrintBase | 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 |
PrintButtonAvailableBlockchain | Default used by this platform. |
| description | Nullable<string> | Platform description | |
| editorFeatures | VideoPrintEditorFeatures | Available Editor features | |
| helpDesk | HelpDesk | Data needed to render the Help component | |
| hooks | PrintButtonPartnerConfigHooks | 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. | |
| schemaVersion | PrintButtonPlatformSchemaVersion | Schema version | |
| sharedSecret | string | Shared secret used to verify the webHooks | |
| status | PrintButtonPlatformStatus | Indicates the lifecycle status of this configuration. | |
| statusName | readonly |
string | Helper for easier identification of the status |
| Method | Modifiers | Description |
|---|---|---|
| afterUpdate() | Runs after updating the platform | |
| beforeInsert() | Runs before saving the platform for the first time: | |
| beforeUpdate() | Runs before updating the platform | |
| getApiProductWithVariants() | Get all the Shopify variants for the current product | |
| getProduct() | Returns the shopify product | |
| getProduct(fail) | ||
| getProduct(fail) | ||
| getSalesRecords() | Finds all the sale recods for this platform | |
| makeVariant(simple) | Creates a variant instance from a simple object and the payout mode | |
| toApplicationConfig() | Serializes this class in to IPrintButtonApiResponseConfig |
|
| toEmbedded() | Serializes this class as an simplified object | |
| toModel() | Serializes this class back to the model | |
| toSchema() | Serializes this class to the Schema type, Setting the helpDesk and aboutIo as null as needed. |
|
| updateVariantsFromShopify() | Updates the available variants with the data from shopify. | |
| upsertVariant(variant, allowTitleChange) | Upsert the given variant on the available variants array. |