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

package/dist/bundle.d.ts

@@ -1086,6 +1086,7 @@ interface CartTotals {
     shippingCost: number;
 }
 
+type MasivoRegistrationStatus = "REGISTERED" | "UNREGISTERED";
 /**
  * Represents a customer in the Masivo system.
  */
@@ -1458,6 +1459,124 @@ 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.
@@ -2487,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.
@@ -3671,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, ExtendedLoyaltyInfo, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, LoyaltyAccumulation, MaritalStatus, MasivoBenefitPayload, MasivoCondition, MasivoConditionBase, MasivoConditionType, MasivoCustomer, MasivoCustomerMetrics, MasivoInfo, MasivoOperator, 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 };
+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.55",
+  "version": "0.14.0-canary.56",
   "types": "./dist/bundle.d.ts",
   "files": [
     "dist"
@@ -24,7 +24,7 @@
   },
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
-  "gitHead": "84bec16c67d1912b28b687ea4b1e0e422f4e5332",
+  "gitHead": "41f1511aa3a414cab385c560855ecd01bb4325d1",
   "nx": {
     "targets": {
       "build": {