Defines callbacks that Granify can call to navigate to different pages within your application. These callbacks will be invoked when a user engages with the call-to-action on a Granify campaign.

Order

data class Order @JvmOverloads constructor(val orderNumber: String, val lineItemsTotal: Price, val subtotal: Price, val totalTax: Price, val totalShipping: Price, val total: Price, val lineItems: HashMap<Product, Int>, val discountCodes: List<DiscountCode>, val financialStatus: String = defaultFinancialStatus, val currency: Currency = Currency.USD)

Represents an order placed on the site.

PageIdentifier

class PageIdentifier(val pageType: PageType, val path: String)

Contains information about a page's type and its unique path.

PageType

@Serializable

enum PageType : Enum<PageType>

Page type values that represent different types of pages that may be present in an application.

Price

@Serializable(with = PriceSerializer::class)

open class Price

Represents a non-negative monetary price value.

Product

data class Product(val sku: String, val productId: String, val title: String, val price: Price, val regularPrice: Price, val image: URL? = null, val stock: ProductStock? = null, val reviews: ProductReviews? = null, val category: String? = null, val subCategory: String? = null, val color: String? = null, val size: String? = null, val childSiteOwnerId: SiteIdentifier? = null, val customProperties: Map<String, StringOrInt> = mapOf())

Represents a distinct product with basic identifiers, price, display information, and further optional detailed information.

ProductReviews

open class ProductReviews

Contains product review and rating information.

ProductStock

data class ProductStock(val count: Int)

Contains product stock information.

RestrictionState

enum RestrictionState : Enum<RestrictionState>

States governing when a campaign is allowed to be shown to a shopper.

ScrollableView

sealed class ScrollableView : Scrollable

A view that is scrollable.

SiteIdentifier

@Serializable(with = SiteIdentifierSerializer::class)

class SiteIdentifier

Unique site identifier.

SliderMargins

class SliderMargins(val left: Int, val top: Int, val right: Int, val bottom: Int) : Parcelable

Represents a collection of margins that dictate where a Granify campaign slider can be displayed.

StringOrInt

@Serializable(with = StringOrIntSerializer::class)

sealed class StringOrInt

Discriminated union type for a String or Int for use in Product.customProperties.

WishListItem

@Serializable(with = WishListItemSerializer::class)

data class WishListItem(val productId: String, val inStock: Boolean, val sku: String? = null, val price: Price? = null, val regularPrice: Price? = null, val title: String? = null, val image: URL? = null, val dateAdded: Date? = null, val priceWhenAdded: Price? = null)

Represents a product within a wish list.