@artisan-commerce/types 0.14.0-canary.51 → 0.14.0-canary.56

package/dist/bundle.d.ts

@@ -280,39 +280,22 @@ interface Account<T extends AdditionalInfo = AdditionalInfo> {
 }
 
 /**
- * Representation of a Commerce Category.
+ * Representation of a Commerce Catalogue.
  *
- * @interface Category
+ * @interface Catalogue
  * @since 0.1.0
  */
-interface Category<T extends AdditionalInfo = AdditionalInfo> {
-    /** Category's id */
-    categoryId: string;
-    /** Category's name */
+interface Catalogue<T extends AdditionalInfo = AdditionalInfo> {
+    /** Catalogue's id */
+    catalogueId: string;
+    /** Catalogue's name */
     name: string;
-    /** Category image's array, see {@link CDNImage} */
-    images: CDNImage[];
-    /** Whether or not to display the category */
-    displayInMenu: boolean;
-    /** Whether or not the category should be reloaded */
-    reload: boolean;
-    /** Whether or not the category has subcategories */
-    subcategories: boolean;
-    /** Category additional info */
+    /** Whether or not the catalogue is active */
+    active: boolean;
+    /** Catalogue's friendly name to use on front end */
+    friendlyName?: string;
+    /** Catalogue additional info */
     additionalInfo?: T;
-    /** Whether or not the category is featured */
-    featured: boolean;
-}
-/**
- * Representation of a category which contains several base products.
- *
- * @interface CategoryWithProducts
- * @since 0.1.0
- * @extends {{@link Category}
- */
-interface CategoryWithProducts extends Category {
-    /** Array of base products associated with a category, see {@link BaseProduct} */
-    products: BaseProduct[];
 }
 
 /**
@@ -340,25 +323,6 @@ interface Vendor<T extends AdditionalInfo = AdditionalInfo> {
     additionalInfo?: T;
 }
 
-/**
- * Representation of a Commerce Catalogue.
- *
- * @interface Catalogue
- * @since 0.1.0
- */
-interface Catalogue<T extends AdditionalInfo = AdditionalInfo> {
-    /** Catalogue's id */
-    catalogueId: string;
-    /** Catalogue's name */
-    name: string;
-    /** Whether or not the catalogue is active */
-    active: boolean;
-    /** Catalogue's friendly name to use on front end */
-    friendlyName?: string;
-    /** Catalogue additional info */
-    additionalInfo?: T;
-}
-
 /**
  * Representation of a Commerce Store.
  *
@@ -553,289 +517,116 @@ interface StorePolygons {
 }
 
 /**
- * Representation of a Commerce Shipping Cost.
+ * Representation of a Commerce Category.
  *
- * @interface ShippingCost
+ * @interface Category
  * @since 0.1.0
  */
-interface ShippingCost<T extends AdditionalInfo = AdditionalInfo> {
-    /** Shipping cost product's id */
-    productId: string;
-    /** Shipping cost's name */
+interface Category<T extends AdditionalInfo = AdditionalInfo> {
+    /** Category's id */
+    categoryId: string;
+    /** Category's name */
     name: string;
-    /** Shipping cost's amount */
-    amount: number;
-    /** Currency's symbol */
-    symbol: string;
-    /** Array of shipping cost's taxes, see {@link ShippingCostTax} */
-    taxes: ShippingCostTax[];
-    /** Shipping cost's price without taxes */
-    grossPrice: number;
-    /** Shipping cost's price */
-    netPrice: number;
-    /** Shipping cost's subtotal without taxes */
-    subtotalBeforeTaxes: number;
-    /** Shipping cost's tax total */
-    taxTotal: number;
-    /** Shipping cost's discount */
-    discounts: any[];
-    /** Shipping cost's discount total amount */
-    discountTotal: number;
-    /** Shipping cost's total */
-    total: number;
-    /** Shipping cost additional info */
+    /** Category image's array, see {@link CDNImage} */
+    images: CDNImage[];
+    /** Whether or not to display the category */
+    displayInMenu: boolean;
+    /** Whether or not the category should be reloaded */
+    reload: boolean;
+    /** Whether or not the category has subcategories */
+    subcategories: boolean;
+    /** Category additional info */
     additionalInfo?: T;
-    /** Discount net price */
-    discountNetPrice?: number;
+    /** Whether or not the category is featured */
+    featured: boolean;
 }
 /**
- * Representation of a shipping cost tax.
+ * Representation of a category which contains several base products.
  *
- * @interface ShippingCostTax
+ * @interface CategoryWithProducts
  * @since 0.1.0
+ * @extends {{@link Category}
  */
-interface ShippingCostTax {
-    /** Tax percentage to be applied */
-    percentage: number;
-    /** Tax name */
-    name: string;
-    /** Value added tax rate code */
-    vatRateCode: number;
-    /** Tax code */
-    code: number;
-    /** Value added tax rate */
-    vatRate: string;
-    /** Tax base value */
-    taxBase: number;
-    /** Tax value */
-    value: string;
+interface CategoryWithProducts extends Category {
+    /** Array of base products associated with a category, see {@link BaseProduct} */
+    products: BaseProduct[];
 }
 
 /**
- * Representation of a Commerce Shopping Cart.
+ * Representation of a Commerce Product.
  *
- * @interface ShoppingCart
- * @template T Shopping cart additional info
- * @template U Product additional info
- * @template V Categories additional info
- * @template W Store additional info
- * @template X Vendor additional info
- * @template Y Catalogues additional info
- * @template Z Shipping cost additional info
+ * @typedef Product
+ * @template T Product additional info
+ * @template U Categories additional info
  * @since 0.1.0
  */
-interface ShoppingCart<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo, V extends AdditionalInfo = AdditionalInfo, W extends AdditionalInfo = AdditionalInfo, X extends AdditionalInfo = AdditionalInfo, Y extends AdditionalInfo = AdditionalInfo, Z extends AdditionalInfo = AdditionalInfo> {
-    /** Shopping cart unique identifier */
-    id: string;
-    /** Shopping cart name */
-    name: string;
-    /** Shopping cart latitude */
-    latitude: number;
-    /** Shopping cart longitude */
-    longitude: number;
-    /** Shopping cart price category, see {@link PriceCategoryType}*/
-    priceCategory?: PriceCategoryType;
-    /** Shopping cart creation date */
-    createdAt: string;
-    /** Shopping cart update date */
-    updatedAt: string;
-    /** Shopping cart channel unique identifier */
-    channelId: string;
-    /** Shopping cart stores, see Objectify<{@link CartStore}> */
-    stores: Objectify<CartStore<W, U, V, X, Y>>;
-    /** Shopping cart shipping cost */
-    shippingCost: ShippingCost<Z> | null;
-    /** Shopping cart additional info */
-    additional_info?: T;
-    /** Shopping cart bill total */
-    billTotal: BillTotal;
-    /** Shopping cart applied benefits */
-    benefits?: ShoppingCartBenefits;
-    /** Shopping cart user wallet id */
-    benefitsHash?: string;
-    /**
-     * Shopping cart pick up time, must be in UTC and
-     * `YYYY-MM-DD HH:mm:ss` format
-     */
-    pickUpTime?: string;
-}
+type Product<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo> = BaseProduct<T> | ProductDetails<T, U> | CartProduct<T, U>;
 /**
- * Representation of a Alert.
+ * Base product attributes.
  *
- * @interface Alert
+ * @interface BaseProduct
  * @since 0.1.0
  */
-interface Alert {
-    /** Alert error level */
-    errorLevel: number;
-    /** Alert message */
-    message: string;
-    /** Alert type */
-    type: string;
+interface BaseProduct<T extends AdditionalInfo = AdditionalInfo> {
+    /** Product unique identifier */
+    productId: string;
+    /** The name of the product */
+    name: string;
+    /** The description of the product */
+    description: string;
+    /** The type of the product, see {@link ProductType} */
+    type: ProductType;
+    /** The cover url of the product */
+    coverUrl: string;
+    /** Product prices, see {@link ProductPrices} */
+    prices: ProductPrices;
+    /** Indicates if a product can be added directly to cart */
+    addDirectlyToCart: boolean;
+    /** Indicates if a product is out of service */
+    outOfService: boolean;
+    /** Indicates if a product is out of stock */
+    outOfStock: boolean;
+    /** The stock of the product */
+    stock: number;
+    /** The measure of the product */
+    measure: string;
+    /** Product attributes, see {@link ProductAttributes} */
+    attributes: ProductAttributes;
+    /** The suggested price of the product */
+    suggestedPrice: string;
+    /**  Indicates if a product is available */
+    available: boolean;
+    /** Array of product images, see {@link CDNImage} */
+    images: CDNImage[];
+    /** The standard time of the product */
+    standardTime: string;
+    /** Indicates if a product is sponsored */
+    sponsored: boolean;
+    /** The status of the product, see {@link ProductStatus} */
+    status: ProductStatus;
+    /** Product additional info */
+    additionalInfo?: T;
+    /** Up-sell products related to the base product */
+    upSelling?: BaseProduct[];
 }
 /**
- * Representation of a Cart Store.
+ * Product prices attributes.
  *
- * @interface CartStore
- * @template T Store additional info
- * @template U Product additional info
- * @template V Categories additional info
- * @template W Vendor additional info
- * @template X Catalogues additional info
+ * @interface ProductPrices
  * @since 0.1.0
- * @extends {{@link Store}
  */
-interface CartStore<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo, V extends AdditionalInfo = AdditionalInfo, W extends AdditionalInfo = AdditionalInfo, X extends AdditionalInfo = AdditionalInfo> extends Store<T, W, X> {
-    /** The products that belong to the store, see {@link CartProduct} */
-    products: Objectify<CartProduct<U, V>>;
-    /** Cart store's alerts, see {@link Alert} */
-    alerts: Alert[];
+interface ProductPrices {
+    /** Normal price category, see {@link PriceCategory} */
+    NORMAL: PriceCategory;
+    /** Points price category, see {@link PriceCategory} */
+    POINTS: PriceCategory;
+    /** Suggested price category, see {@link PriceCategory} */
+    SUGGESTED: PriceCategory;
 }
 /**
- * The possible values of a Bill Total.
+ * Price category attributes.
  *
- * @typedef BillTotal
- * @since 0.1.0
- */
-type BillTotal = {
-    /** Normal bill total category */
-    NORMAL?: BillTotalCategory;
-    /** Points bill total category */
-    POINTS?: BillTotalCategory;
-};
-/**
- * Representation of a Bill Total Category.
- *
- * @interface BillTotalCategory
- * @since 0.1.0
- */
-interface BillTotalCategory {
-    /** Bill total category subtotal without taxes */
-    subtotalBeforeTaxes: number;
-    /** Bill total category total taxes */
-    taxTotal: number;
-    /** Bill total category total */
-    total: number;
-    /** discounts shopping cart */
-    discounts: Discount[];
-    /** Taxes shopping cart */
-    taxes: PriceCategoryTax[];
-}
-/**
- * Representation of shopping cart discount.
- *
- * @interface Discounts
- * @since 0.1.0
- */
-interface Discount {
-    benefitId: string;
-    /** Benefit wallet id */
-    benefitWalletId: string;
-    /** Discount base value */
-    discountBase: number;
-    /** Whether or not the coupon has taxes */
-    hasTaxes: boolean;
-    /** If the coupon discount has been initialized */
-    isInitialized: boolean;
-    /** The benefit name */
-    name: string;
-    /** The benefit percentage */
-    percentage: number;
-    /** The benefit taxes */
-    taxValue: number;
-    /** The benefit type */
-    type: BenefitTypes;
-    /** The discount value */
-    value: number;
-}
-/**
- * Representation of a Cart Totals.
- *
- * @interface CartTotals
- * @since 0.1.0
- */
-interface CartTotals {
-    /** Cart totals subtotal */
-    subtotal: number;
-    /** Cart totals shipping cost */
-    shippingCost: number;
-}
-
-/**
- * Representation of a Commerce Product.
- *
- * @typedef Product
- * @template T Product additional info
- * @template U Categories additional info
- * @since 0.1.0
- */
-type Product<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo> = BaseProduct<T> | ProductDetails<T, U> | CartProduct<T, U>;
-/**
- * Base product attributes.
- *
- * @interface BaseProduct
- * @since 0.1.0
- */
-interface BaseProduct<T extends AdditionalInfo = AdditionalInfo> {
-    /** Product unique identifier */
-    productId: string;
-    /** The name of the product */
-    name: string;
-    /** The description of the product */
-    description: string;
-    /** The type of the product, see {@link ProductType} */
-    type: ProductType;
-    /** The cover url of the product */
-    coverUrl: string;
-    /** Product prices, see {@link ProductPrices} */
-    prices: ProductPrices;
-    /** Indicates if a product can be added directly to cart */
-    addDirectlyToCart: boolean;
-    /** Indicates if a product is out of service */
-    outOfService: boolean;
-    /** Indicates if a product is out of stock */
-    outOfStock: boolean;
-    /** The stock of the product */
-    stock: number;
-    /** The measure of the product */
-    measure: string;
-    /** Product attributes, see {@link ProductAttributes} */
-    attributes: ProductAttributes;
-    /** The suggested price of the product */
-    suggestedPrice: string;
-    /**  Indicates if a product is available */
-    available: boolean;
-    /** Array of product images, see {@link CDNImage} */
-    images: CDNImage[];
-    /** The standard time of the product */
-    standardTime: string;
-    /** Indicates if a product is sponsored */
-    sponsored: boolean;
-    /** The status of the product, see {@link ProductStatus} */
-    status: ProductStatus;
-    /** Product additional info */
-    additionalInfo?: T;
-    /** Up-sell products related to the base product */
-    upSelling?: BaseProduct[];
-}
-/**
- * Product prices attributes.
- *
- * @interface ProductPrices
- * @since 0.1.0
- */
-interface ProductPrices {
-    /** Normal price category, see {@link PriceCategory} */
-    NORMAL: PriceCategory;
-    /** Points price category, see {@link PriceCategory} */
-    POINTS: PriceCategory;
-    /** Suggested price category, see {@link PriceCategory} */
-    SUGGESTED: PriceCategory;
-}
-/**
- * Price category attributes.
- *
- * @interface PriceCategory
+ * @interface PriceCategory
  * @since 0.1.0
  */
 interface PriceCategory {
@@ -1086,6 +877,707 @@ interface CartProduct<T extends AdditionalInfo = AdditionalInfo, U extends Addit
     addedFrom?: string;
 }
 
+/**
+ * Representation of a Commerce Shipping Cost.
+ *
+ * @interface ShippingCost
+ * @since 0.1.0
+ */
+interface ShippingCost<T extends AdditionalInfo = AdditionalInfo> {
+    /** Shipping cost product's id */
+    productId: string;
+    /** Shipping cost's name */
+    name: string;
+    /** Shipping cost's amount */
+    amount: number;
+    /** Currency's symbol */
+    symbol: string;
+    /** Array of shipping cost's taxes, see {@link ShippingCostTax} */
+    taxes: ShippingCostTax[];
+    /** Shipping cost's price without taxes */
+    grossPrice: number;
+    /** Shipping cost's price */
+    netPrice: number;
+    /** Shipping cost's subtotal without taxes */
+    subtotalBeforeTaxes: number;
+    /** Shipping cost's tax total */
+    taxTotal: number;
+    /** Shipping cost's discount */
+    discounts: any[];
+    /** Shipping cost's discount total amount */
+    discountTotal: number;
+    /** Shipping cost's total */
+    total: number;
+    /** Shipping cost additional info */
+    additionalInfo?: T;
+    /** Discount net price */
+    discountNetPrice?: number;
+}
+/**
+ * Representation of a shipping cost tax.
+ *
+ * @interface ShippingCostTax
+ * @since 0.1.0
+ */
+interface ShippingCostTax {
+    /** Tax percentage to be applied */
+    percentage: number;
+    /** Tax name */
+    name: string;
+    /** Value added tax rate code */
+    vatRateCode: number;
+    /** Tax code */
+    code: number;
+    /** Value added tax rate */
+    vatRate: string;
+    /** Tax base value */
+    taxBase: number;
+    /** Tax value */
+    value: string;
+}
+
+/**
+ * Representation of a Commerce Shopping Cart.
+ *
+ * @interface ShoppingCart
+ * @template T Shopping cart additional info
+ * @template U Product additional info
+ * @template V Categories additional info
+ * @template W Store additional info
+ * @template X Vendor additional info
+ * @template Y Catalogues additional info
+ * @template Z Shipping cost additional info
+ * @since 0.1.0
+ */
+interface ShoppingCart<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo, V extends AdditionalInfo = AdditionalInfo, W extends AdditionalInfo = AdditionalInfo, X extends AdditionalInfo = AdditionalInfo, Y extends AdditionalInfo = AdditionalInfo, Z extends AdditionalInfo = AdditionalInfo> {
+    /** Shopping cart unique identifier */
+    id: string;
+    /** Shopping cart name */
+    name: string;
+    /** Shopping cart latitude */
+    latitude: number;
+    /** Shopping cart longitude */
+    longitude: number;
+    /** Shopping cart price category, see {@link PriceCategoryType}*/
+    priceCategory?: PriceCategoryType;
+    /** Shopping cart creation date */
+    createdAt: string;
+    /** Shopping cart update date */
+    updatedAt: string;
+    /** Shopping cart channel unique identifier */
+    channelId: string;
+    /** Shopping cart stores, see Objectify<{@link CartStore}> */
+    stores: Objectify<CartStore<W, U, V, X, Y>>;
+    /** Shopping cart shipping cost */
+    shippingCost: ShippingCost<Z> | null;
+    /** Shopping cart additional info */
+    additional_info?: T;
+    /** Shopping cart bill total */
+    billTotal: BillTotal;
+    /** Shopping cart applied benefits */
+    benefits?: ShoppingCartBenefits;
+    /** Shopping cart user wallet id */
+    benefitsHash?: string;
+    /**
+     * Shopping cart pick up time, must be in UTC and
+     * `YYYY-MM-DD HH:mm:ss` format
+     */
+    pickUpTime?: string;
+}
+/**
+ * Representation of a Alert.
+ *
+ * @interface Alert
+ * @since 0.1.0
+ */
+interface Alert {
+    /** Alert error level */
+    errorLevel: number;
+    /** Alert message */
+    message: string;
+    /** Alert type */
+    type: string;
+}
+/**
+ * Representation of a Cart Store.
+ *
+ * @interface CartStore
+ * @template T Store additional info
+ * @template U Product additional info
+ * @template V Categories additional info
+ * @template W Vendor additional info
+ * @template X Catalogues additional info
+ * @since 0.1.0
+ * @extends {{@link Store}
+ */
+interface CartStore<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo, V extends AdditionalInfo = AdditionalInfo, W extends AdditionalInfo = AdditionalInfo, X extends AdditionalInfo = AdditionalInfo> extends Store<T, W, X> {
+    /** The products that belong to the store, see {@link CartProduct} */
+    products: Objectify<CartProduct<U, V>>;
+    /** Cart store's alerts, see {@link Alert} */
+    alerts: Alert[];
+}
+/**
+ * The possible values of a Bill Total.
+ *
+ * @typedef BillTotal
+ * @since 0.1.0
+ */
+type BillTotal = {
+    /** Normal bill total category */
+    NORMAL?: BillTotalCategory;
+    /** Points bill total category */
+    POINTS?: BillTotalCategory;
+};
+/**
+ * Representation of a Bill Total Category.
+ *
+ * @interface BillTotalCategory
+ * @since 0.1.0
+ */
+interface BillTotalCategory {
+    /** Bill total category subtotal without taxes */
+    subtotalBeforeTaxes: number;
+    /** Bill total category total taxes */
+    taxTotal: number;
+    /** Bill total category total */
+    total: number;
+    /** discounts shopping cart */
+    discounts: Discount[];
+    /** Taxes shopping cart */
+    taxes: PriceCategoryTax[];
+}
+/**
+ * Representation of shopping cart discount.
+ *
+ * @interface Discounts
+ * @since 0.1.0
+ */
+interface Discount {
+    benefitId: string;
+    /** Benefit wallet id */
+    benefitWalletId: string;
+    /** Discount base value */
+    discountBase: number;
+    /** Whether or not the coupon has taxes */
+    hasTaxes: boolean;
+    /** If the coupon discount has been initialized */
+    isInitialized: boolean;
+    /** The benefit name */
+    name: string;
+    /** The benefit percentage */
+    percentage: number;
+    /** The benefit taxes */
+    taxValue: number;
+    /** The benefit type */
+    type: BenefitTypes;
+    /** The discount value */
+    value: number;
+}
+/**
+ * Representation of a Cart Totals.
+ *
+ * @interface CartTotals
+ * @since 0.1.0
+ */
+interface CartTotals {
+    /** Cart totals subtotal */
+    subtotal: number;
+    /** Cart totals shipping cost */
+    shippingCost: number;
+}
+
+type MasivoRegistrationStatus = "REGISTERED" | "UNREGISTERED";
+/**
+ * Represents a customer in the Masivo system.
+ */
+interface MasivoCustomer {
+    /** The unique identifier for the customer. */
+    id: string;
+    /** The name of the customer. */
+    name: string;
+    /** The email address of the customer. */
+    email: string;
+    /** The date of birth of the customer. */
+    dob: string;
+    /** The gender of the customer. */
+    gender: string;
+    /** The date when the customer registered. */
+    registration_date: string;
+    /** The current status of the customer. */
+    status: string;
+    /** Additional metadata related to the customer. */
+    metadata: Metadata;
+    /** The identifier for the customer's tier. */
+    tier_id: string;
+    /** The metrics for the customer. */
+    metrics: MasivoCustomerMetrics;
+}
+/**
+ * Represents metadata information.
+ *
+ * @property {string} [exampleProperty] - Description of the example property.
+ */
+interface Metadata {
+}
+/**
+ * Represents the metrics for a Masivo customer.
+ */
+interface MasivoCustomerMetrics {
+    /** Metrics for the last month. */
+    last_month: MetricPeriod;
+    /** Metrics for the last quarter. */
+    last_quarter: MetricPeriod;
+    /** Metrics for the last semester */
+    last_semester: MetricPeriod;
+    /** Metrics for the last year. */
+    last_year: MetricPeriod;
+    /** Metrics for the lifetime of the customer. */
+    lifetime: MetricPeriod;
+    /** Metrics for this month */
+    this_month: MetricPeriod;
+    /** Metrics for this quarter */
+    this_quarter: MetricPeriod;
+    /** Metrics for this semester */
+    this_semester: MetricPeriod;
+    /** Metrics for this year */
+    this_year: MetricPeriod;
+}
+/**
+ * Represents the metrics for a specific period.
+ */
+interface MetricPeriod {
+    /** The start date of the period. */
+    from: string;
+    /** The date of the last visit within the period. */
+    last_visit: string | null;
+    /** The number of purchases made within the period. */
+    number_of_purchases: number;
+    /** The total amount spent within the period. */
+    spend_total: number;
+    /** The identifier for the tier during the period. */
+    tier_id: string | null;
+    /** The end date of the period. */
+    to: string;
+}
+/**
+ * Represents a Masivo Wallet.
+ */
+interface MasivoWallet {
+    /** The unique identifier of the wallet. */
+    id: string;
+    /** The unique identifier of the wallet owner. */
+    owner_id: string;
+    /** An array of wallet totals */
+    totals: WalletTotal[];
+    /** An array of wallet lines */
+    lines: WalletLine[];
+}
+/**
+ * Represents the total amount in a wallet along with reward details.
+ */
+interface WalletTotal {
+    /** The total amount in the wallet. */
+    total: number;
+    /** The unique identifier for the reward. */
+    reward_id: string;
+    /** The expiration date of the reward. */
+    expiration_date: string;
+    /** The reward details associated with the wallet. */
+    reward: WalletReward;
+}
+/**
+ * Represents a line item in a wallet.
+ */
+interface WalletLine {
+    /** The amount associated with the wallet line. */
+    amount: number;
+    /** The identifier for the reward. */
+    reward_id: string;
+    /** The identifier for the campaign. */
+    campaign_id: string;
+    /** The identifier for the brand, or null if not applicable. */
+    brand_id: string;
+    /** The date and time when the wallet line was issued. */
+    issued_at: string;
+    /** The date and time when the wallet line expires. */
+    expiration_date: string;
+    /** The optional date and time when the reservation expires. */
+    reservation_expires_at?: string;
+    /** The reward object containing detailed information */
+    reward: WalletReward;
+}
+/**
+ * Represents a reward in the wallet.
+ */
+interface WalletReward {
+    /** The unique identifier of the reward. */
+    id: string;
+    /** The identifier of the brand associated with the reward, or null if not applicable. */
+    brand_id: string | null;
+    /** The name of the reward. */
+    name: string;
+    /** A description of the reward. */
+    description: string;
+    /** The type of the reward. */
+    type: MasivoRewardType;
+    /** The conditions associated with the reward. */
+    conditions: MasivoCondition[][];
+    /** The attributes of the reward. */
+    attributes: WalletAttribute;
+    /** The media associated with the reward. */
+    media: WalletMedia;
+    /** The status of the reward. */
+    status: string;
+    /** Optional content associated with the reward. */
+    content?: Objectify<MasivoTemplateContent>;
+}
+/**
+ * Enum representing the types of rewards that can be associated with a wallet.
+ */
+type MasivoRewardType = "DISCOUNT" | "POINTS" | "GIFT_CARD" | "PRODUCT";
+/**
+ * Represents the base structure for a Masivo condition.
+ */
+interface MasivoConditionBase {
+    /** The primitive value associated with the condition. */
+    primitive: string;
+    /** The type of the Masivo condition. */
+    type: MasivoConditionType;
+    /** The operator used in the condition */
+    operator: MasivoOperator;
+    /** An optional message indicating why the condition is invalid. */
+    invalidMessage?: string;
+}
+/**
+ * Type representing the conditions of rewards that can be associated with a wallet.
+ */
+type MasivoConditionType = "Current date" | "Registration" | "Birthday" | "Customer number of purchases" | "Customer has made a purchase" | "Customer points balance" | "Customer spend total" | "Customer total spend" | "Ordered at store" | "Ordered in channel" | "Payment method" | "Order includes product" | "Order value" | "Order includes tag" | "Product includes tag" | "Shipping includes tag";
+type MasivoTransactionType = "CASH" | "DEBIT" | "CREDIT" | "BANK_TRANSFER";
+/**
+ * Type representing the operators of rewards that can be associated with a wallet.
+ */
+type MasivoOperator = "greater than" | "greater than or equal to" | "less than" | "less than or equal to" | "equal to" | "not equal to" | "is" | "is not" | "falls within period" | "occurred" | "occurred in the last" | "occurred more than";
+/**
+ * Type representing the reporting periods for Masivo.
+ */
+type MasivoReportingPeriod = "MONTHLY" | "QUARTERLY" | "YEARLY" | "SEMESTERLY";
+/**
+ * Type representing the possible repeat intervals for a Masivo event.
+ */
+type MasivoRepeatInterval = "NONE" | "DAILY" | "WEEKLY" | "FORTNIGHTLY" | "MONTHLY" | "WEEK_OF_MONTH";
+/**
+ * Represents the attributes of a wallet in the system.
+ */
+interface WalletAttribute {
+    /** Conversion factor used to calculate the wallet value. */
+    conversion_factor?: number;
+    /** Value of the applied discount. */
+    discount_value?: number;
+    /** Type of discount, can be fixed or percentage. */
+    discount_type?: "fixed" | "percentage";
+    /** Type of action associated with the wallet, can be shipping, order, or product. */
+    type?: "shipping" | "order" | "product";
+    /** Reward action associated with the wallet. */
+    action?: MasivoRewardAction;
+    /** New amount assigned to the wallet. */
+    new_amount?: number;
+    /** ID of the new product associated with the wallet. */
+    new_product_id?: string;
+    /** Replacement amount assigned to the wallet. */
+    replace_amount?: number;
+    /** ID of the replacement product associated with the wallet. */
+    replace_product_id?: string;
+    /** The ID of the product associated with the reward */
+    item_id?: string;
+}
+/**
+ * Type representing the possible actions for Masivo rewards.
+ */
+type MasivoRewardAction = "ADD_PRODUCT" | "REPLACE_PRODUCT";
+/**
+ * Interface representing the media associated with a wallet.
+ */
+interface WalletMedia {
+    /** The URL of the thumbnail image. */
+    thumbnail_url: string | null;
+    /** The URL of the cover image. */
+    cover_url: string | null;
+}
+/**
+ * Represents the content of a Masivo template.
+ */
+interface MasivoTemplateContent {
+    /** The name of the template content. */
+    name: string;
+    /** The type of the template content */
+    type: MasivoTemplateType;
+    /** The value of the template content */
+    value: string;
+}
+/**
+ * Type representing the types of templates available for Masivo.
+ */
+type MasivoTemplateType = "input" | "textarea";
+/**
+ * Represents a tier in from Masivo.
+ */
+interface MasivoTier {
+    /** The unique identifier for the tier. */
+    id: string;
+    /** The name of the tier. */
+    name: string;
+    /** The current status of the tier. */
+    status: string;
+    /** The level of the tier. */
+    level: number;
+    /** A brief description of the tier. */
+    description: string;
+    /** The conditions required to enter the tier. */
+    entry_conditions: MasivoCondition[][];
+    /** The conditions required to exit the tier. */
+    exit_conditions: MasivoCondition[][];
+    /** The identifier for the template associated with the tier. */
+    template_id?: string;
+    /** The content of the template associated with the tier. */
+    content?: Objectify<MasivoTemplateContent>;
+}
+/**
+ * Represents a redeemable benefit from Masivo in the wallet.
+ */
+interface RedeemableBenefit extends WalletTotal {
+    /**The identifier for the brand associated with the benefit */
+    brand_id: string;
+    /** The identifier for the campaign associated with the benefit */
+    campaign_id: string;
+    /** The date and time when the benefit was issued */
+    issued_at: string;
+    /** The amount of the benefit */
+    amount: number;
+}
+/**
+ * Represents a masivo benefit payload to send to the Masivo API and redeem the benefit.
+ */
+interface MasivoBenefitPayload {
+    /** The unique identifier of the reward */
+    reward_id: string;
+    /** The amount of the benefit */
+    amount: number;
+    /** The total of the benefit */
+    total: number;
+    /** The identifier for the brand associated with the benefit */
+    brand_id: string;
+    /** The identifier for the campaign associated with the benefit */
+    campaign_id: string;
+    /** The date and time when the benefit was issued */
+    issued_at: string;
+    /** The date and time when the benefit expires */
+    expiration_date: string;
+    /** The reward in the wallet, see {@link WalletReward} */
+    reward: WalletReward;
+}
+/**
+ * Interface representing the conditions of a tier from Masivo.
+ */
+interface MasivoCondition extends MasivoConditionBase {
+    /** The reporting period for the condition. */
+    reporting_period: MasivoReportingPeriod;
+    /** The value associated with the condition. */
+    value: string | `${string}/${string}`;
+    /** The identifier for the reward associated with the condition. */
+    reward_id?: string;
+    /** Indicates if the condition is valid all day. */
+    allDay?: boolean;
+    /** The start date for the condition */
+    startDate?: string;
+    /** The end date for the condition */
+    endDate?: string;
+    /** The repeat interval for the condition */
+    repeat?: MasivoRepeatInterval;
+}
+/**
+ * Interface representing the conditions from Masivo.
+ *
+ * @interface MasivoCondition
+ * @extends MasivoConditionBase see {@link MasivoConditionBase}
+ */
+interface MasivoCondition extends MasivoConditionBase {
+    /** The reporting period for the condition. */
+    reporting_period: MasivoReportingPeriod;
+    /** The value associated with the condition. */
+    value: string | `${string}/${string}`;
+    /** The identifier for the reward associated with the condition. */
+    reward_id?: string;
+    /** Indicates if the condition is valid all day. */
+    allDay?: boolean;
+    /** The start date for the condition */
+    startDate?: string;
+    /** The end date for the condition */
+    endDate?: string;
+    /** The repeat interval for the condition */
+    repeat?: MasivoRepeatInterval;
+}
+/**
+ * Configuration interface for validating Masivo conditions.
+ */
+interface ValidateConditionConfig {
+    /** Store information */
+    store?: Store;
+    /** Catalogue identifier */
+    catalogueId?: Catalogue["catalogueId"];
+    /** Payment method name identifier */
+    paymentMethodName?: string;
+    /** The current shopping cart */
+    shoppingCart?: ShoppingCart;
+}
+/**
+ * Interface representing a customer from Masivo
+ */
+interface MasivoInfo {
+    /** The customer associated with the loyalty program. */
+    customer: MasivoCustomer;
+    /** The wallet containing the loyalty points and rewards. */
+    wallet: MasivoWallet;
+}
+/**
+ * ExtendedLoyaltyInfo interface extends the LoyaltyInfo interface to include additional properties
+ * related to loyalty accumulations and redemptions.
+ *
+ * @extends LoyaltyInfo see {@link MasivoInfo}
+ */
+interface ExtendedLoyaltyInfo extends MasivoInfo {
+    /** An array of loyalty accumulation records */
+    accumulations: LoyaltyAccumulation[];
+    /** An  array of loyalty redemption records*/
+    redemptions: unknown[];
+}
+/**
+ * Interface representing the accumulations in a loyalty wallet.
+ *
+ * @extends WalletLine see {@link WalletLine}
+ */
+interface LoyaltyAccumulation extends WalletLine {
+    /** The reward associated with the accumulation */
+    reward: WalletReward;
+}
+/**
+ * Represents the summary of coupon codes.
+ */
+interface CodesSummary {
+    /** Array of coupon codes */
+    codes: string[];
+    /** Number of times coupon code has been redeemed */
+    used: number;
+    /** Number of times coupon code can be redeemed */
+    left: number;
+    /** Total number of uses for the coupon code */
+    total: number;
+}
+/**
+ * Represents the format configuration for a code generation system.
+ */
+interface CodeFormat {
+    /** Determines if the code should be case sensitive */
+    case_sensitive: boolean;
+    /** The template pattern for code generation */
+    template: string;
+    /** Characters that should not be included in the generated code */
+    exclude_characters: string;
+    /** Characters that must be included in the generated code */
+    include_characters: string;
+}
+type MasivoCampaignAttributes = BehaviorCampaignAttributes | CouponCampaignAttributes;
+/**
+ * Interface representing attributes for a behavior-based campaign
+ */
+interface BehaviorCampaignAttributes {
+    /** The trigger identifier for the campaign behavior */
+    trigger: string;
+}
+/**
+ * Interface representing the attributes of a coupon campaign
+ */
+interface CouponCampaignAttributes {
+    /** The format specification for coupon codes */
+    code_format: CodeFormat;
+    /** Array of valid coupon codes for the campaign */
+    codes_summary: CodesSummary;
+    /** Maximum number of times each code can be redeemed in total */
+    max_redemptions_per_code: number;
+    /** Maximum number of times each code can be redeemed by a single customer */
+    max_redemptions_per_code_per_customer: number;
+}
+type BudgetDivision = "daily" | "weekly" | "monthly" | "total";
+type MasivoCampaignStatus = "RUNNING" | "PAUSED" | "SCHEDULED" | "FINISHED";
+type MasivoCampaignType = "COUPONS" | "BEHAVIOR";
+/**
+ * Represents a Masivo Campaign configuration.
+ */
+interface MasivoCampaign {
+    /** The attributes of the campaign */
+    attributes: MasivoCampaignAttributes;
+    /** Identifier of the associated brand */
+    brand_id: string;
+    /** The budget allocated for the campaign */
+    budget: number;
+    /** The content of the campaign */
+    content: Objectify<MasivoTemplateContent>;
+    /** A detailed description of the campaign */
+    description: string;
+    /** The division of the budget */
+    divide_budget_in: BudgetDivision;
+    /** The end date of the campaign, if applicable */
+    end_date: string | null;
+    /** The source of funding for the campaign, if specified */
+    funded_by: string | null;
+    /** Unique identifier for the campaign */
+    id: string;
+    /** Array of labels associated to filter the campaigns by */
+    labels: string[];
+    /** Additional metadata for the campaign */
+    metadata: unknown;
+    /** The name of the campaign */
+    name: string;
+    /** The rules governing the campaign */
+    rules: MasivoCampaignRule[];
+    /** The start date of the campaign */
+    start_date: string;
+    /** The current status of the campaign */
+    status: MasivoCampaignStatus;
+    /** Identifier of the template used for the campaign */
+    template_id: string;
+    /** The type of the campaign */
+    type: MasivoCampaignType;
+}
+/**
+ * Defines the structure for rules in a masivo campaign.
+ */
+interface MasivoCampaignRule {
+    /** A matrix of conditions that must be met for the campaign rules to apply */
+    conditions: MasivoCondition[][];
+    /** Array of effects to be applied when conditions are met */
+    effects: MasivoEffect[];
+}
+/**
+ * Represents the effect of a Masivo reward.
+ */
+interface MasivoEffect {
+    /** The unique identifier of the reward */
+    reward_id: string;
+    /** The type of the reward */
+    type: MasivoRewardType;
+    /** The identifier of the tier this effect belongs to */
+    tier_id: string;
+    /** The reward object containing detailed information */
+    reward: WalletReward;
+    /** The date when the effect expires */
+    expiration_date: string;
+    /** The amount value of the effect */
+    amount: number;
+    /** The multiplier condition type */
+    multiplier: MasivoEffectMultiplierType;
+}
+type MasivoEffectMultiplierType = Extract<MasivoConditionType, "Order value">;
+
 /**
  * Wallet user information.
  *
@@ -1190,7 +1682,7 @@ interface Award {
  * @typedef ShoppingCartBenefits
  * @since 0.1.0
  */
-type ShoppingCartBenefits = Benefit[];
+type ShoppingCartBenefits = Benefit[] | RedeemableBenefit[];
 /**
  * The possible values of the benefit type.
  *
@@ -2114,6 +2606,10 @@ interface BaseUser<T extends AdditionalInfo = AdditionalInfo> {
 interface User<T extends AdditionalInfo = AdditionalInfo> extends BaseUser<T> {
     /** User's auto generated id */
     idInt: number;
+    /** User registration status in Masivo */
+    rewardsProgramStatus?: MasivoRegistrationStatus | null;
+    /** Last date when the user accepted the new conditions */
+    latestConditionsAcceptanceDate?: string | null;
 }
 /**
  * The possible values for the user's type.
@@ -3298,4 +3794,4 @@ interface CardInscription {
     createdAt?: string;
 }
 
-export type { ARDocumentType, Account, AdditionalInfo, Alert, Allocation, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, Award, BODocumentType, BRDocumentType, Banner, BannerBenefits, BannerCoupon, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, Benefit, BenefitData, BenefitTypes, BillTotal, BillTotalCategory, BillingData, CDNImage, CLDocumentType, CODocumentType, CardInscription, CardName, CartProduct, CartProductAnswer, CartProductQuestion, CartStore, CartTotals, Catalogue, Category, CategoryWithProducts, Code, CommonDocumentType, Country, CountryCode, CountryCurrency, CountrySummary, Coupon, CouponCategory, CouponType, CreditCardMapping, CurrencyCodes, DayOfWeek, Days, Delivery, DeliveryTimeUnit, Discount, DocumentType, ECDocumentType, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, MaritalStatus, Message, MetadataShipping, NewShippingAddress, Notification, NotificationAdditionalInfo, NotificationExtraData, NotificationListItem, NotificationPriority, NotificationStep, NotificationStore, NotificationUser, NotificationVendor, Objectify, OperatorInformation, Order, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductBillTotal, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderStoreAdditionalInfo, OrderStoreDelivery, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, PaymentStatus, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductCoupon, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, ReadValue, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreCoupon, StoreCouponDetail, StoreLocation, StorePolygons, Suborder, Tax, TaxCalculation, TaxCalculations, TaxType, Token, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, Vendor, Wallet, WebhookWorkflow, Workflow, ZipCodeField };
+export type { ARDocumentType, Account, AdditionalInfo, Alert, Allocation, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, Award, BODocumentType, BRDocumentType, Banner, BannerBenefits, BannerCoupon, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, BehaviorCampaignAttributes, Benefit, BenefitData, BenefitTypes, BillTotal, BillTotalCategory, BillingData, BudgetDivision, CDNImage, CLDocumentType, CODocumentType, CardInscription, CardName, CartProduct, CartProductAnswer, CartProductQuestion, CartStore, CartTotals, Catalogue, Category, CategoryWithProducts, Code, CodeFormat, CodesSummary, CommonDocumentType, Country, CountryCode, CountryCurrency, CountrySummary, Coupon, CouponCampaignAttributes, CouponCategory, CouponType, CreditCardMapping, CurrencyCodes, DayOfWeek, Days, Delivery, DeliveryTimeUnit, Discount, DocumentType, ECDocumentType, ExtendedLoyaltyInfo, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, LoyaltyAccumulation, MaritalStatus, MasivoBenefitPayload, MasivoCampaign, MasivoCampaignAttributes, MasivoCampaignRule, MasivoCampaignStatus, MasivoCampaignType, MasivoCondition, MasivoConditionBase, MasivoConditionType, MasivoCustomer, MasivoCustomerMetrics, MasivoEffect, MasivoEffectMultiplierType, MasivoInfo, MasivoOperator, MasivoRegistrationStatus, MasivoRepeatInterval, MasivoReportingPeriod, MasivoRewardAction, MasivoRewardType, MasivoTemplateContent, MasivoTemplateType, MasivoTier, MasivoTransactionType, MasivoWallet, Message, Metadata, MetadataShipping, MetricPeriod, NewShippingAddress, Notification, NotificationAdditionalInfo, NotificationExtraData, NotificationListItem, NotificationPriority, NotificationStep, NotificationStore, NotificationUser, NotificationVendor, Objectify, OperatorInformation, Order, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductBillTotal, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderStoreAdditionalInfo, OrderStoreDelivery, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, PaymentStatus, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductCoupon, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, ReadValue, RedeemableBenefit, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreCoupon, StoreCouponDetail, StoreLocation, StorePolygons, Suborder, Tax, TaxCalculation, TaxCalculations, TaxType, Token, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, ValidateConditionConfig, Vendor, Wallet, WalletAttribute, WalletLine, WalletMedia, WalletReward, WalletTotal, WebhookWorkflow, Workflow, ZipCodeField };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
   "type": "module",
-  "version": "0.14.0-canary.51",
+  "version": "0.14.0-canary.56",
   "types": "./dist/bundle.d.ts",
   "files": [
     "dist"
@@ -24,7 +24,7 @@
   },
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
-  "gitHead": "dc9c6871ee7e26d4bb2052aeff48305e7b9890f2",
+  "gitHead": "41f1511aa3a414cab385c560855ecd01bb4325d1",
   "nx": {
     "targets": {
       "build": {