@artisan-commerce/types 0.14.0-canary.78 → 0.14.0-canary.79

package/dist/bundle.d.ts

@@ -70,7 +70,7 @@ type BODocumentType = CommonDocumentType;
  * @typedef BRDocumentType
  * @since 0.1.0
  */
-type BRDocumentType = CommonDocumentType;
+type BRDocumentType = CommonDocumentType | "CPF";
 /**
  * Chile supported document types.
  *
@@ -622,6 +622,8 @@ interface ProductPrices {
     POINTS: PriceCategory;
     /** Suggested price category, see {@link PriceCategory} */
     SUGGESTED: PriceCategory;
+    /** Reference price category, useful for Brazil */
+    REFERENCE: PriceCategory;
 }
 /**
  * Price category attributes.
@@ -705,7 +707,7 @@ type ProductType = "PRODUCT" | "MODIFIER";
  * @typedef PriceCategoryType
  * @since 0.1.0
  **/
-type PriceCategoryType = "NORMAL" | "POINTS" | "SUGGESTED";
+type PriceCategoryType = "NORMAL" | "POINTS" | "SUGGESTED" | "REFERENCE";
 /**
  * Tax's possible values.
  *
@@ -876,6 +878,20 @@ interface CartProduct<T extends AdditionalInfo = AdditionalInfo, U extends Addit
     /** Indicates where the product was added from */
     addedFrom?: string;
 }
+/**
+ * Representation of a Commerce Product Modifier.
+ *
+ * @interface ProductModifier
+ * @since 0.1.0
+ */
+interface ProductModifier {
+    /** Product amount */
+    amount: number;
+    /** Product price */
+    price: number;
+    /** Product name */
+    name: string;
+}
 
 /**
  * Representation of a Commerce Shipping Cost.
@@ -1886,6 +1902,16 @@ interface CouponCategory {
     /** Coupon category name */
     name: string;
 }
+/**
+ * Coupon object that contains the OTP code for Kioscos
+ *
+ * @interface CouponOtp
+ * @since 0.1.0
+ */
+interface CouponOtp {
+    /** OTP code */
+    code: string;
+}
 /**
  * Code object associated with a coupon.
  *
@@ -1905,6 +1931,8 @@ interface Code {
     status: ProductStatus;
     /** Whether or not the code has been used */
     used: boolean;
+    /** Coupon otp, see {@link CouponOtp} */
+    otp?: CouponOtp;
 }
 /**
  * An object which contains the token corresponding to a QR code.
@@ -2096,7 +2124,7 @@ interface BillingData<T extends AdditionalInfo = AdditionalInfo> extends BaseBil
  * @typedef CurrencyCodes
  * @since 0.1.0
  */
-type CurrencyCodes = "USD" | "ARS" | "COP" | "CLP" | "VES";
+type CurrencyCodes = "USD" | "ARS" | "COP" | "CLP" | "VES" | "BRL";
 
 /**
  * Fulfillment workflow.
@@ -3033,6 +3061,8 @@ interface OrderBillProductAdditionalInfo {
     normal: OrderProductPriceCategory;
     /** Points price category, see {@link OrderProductPriceCategory} */
     points: OrderProductPriceCategory;
+    /** Suggested price category, see {@link OrderProductPriceCategory} */
+    suggested: OrderProductPriceCategory;
 }
 /**
  * Order bill product tax calculations.
@@ -3149,6 +3179,8 @@ interface OrderProductPriceCategory {
     subtotal_without_taxes?: number;
     /** An object of tax calculations, see {@link TaxCalculations} */
     tax_calcs?: TaxCalculations;
+    /** Order product price before sale */
+    price_before_sale?: number;
 }
 /**
  * The retry of the order.
@@ -3808,4 +3840,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, 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, MasivoBenefitAlerts, MasivoBenefitPayload, MasivoCampaign, MasivoCampaignAttributes, MasivoCampaignRule, MasivoCampaignStatus, MasivoCampaignType, MasivoCondition, MasivoConditionBase, MasivoConditionType, MasivoCustomer, MasivoCustomerMetrics, MasivoEffect, MasivoEffectMultiplierType, MasivoInfo, MasivoLabels, 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 };
+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, CouponOtp, 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, MasivoBenefitAlerts, MasivoBenefitPayload, MasivoCampaign, MasivoCampaignAttributes, MasivoCampaignRule, MasivoCampaignStatus, MasivoCampaignType, MasivoCondition, MasivoConditionBase, MasivoConditionType, MasivoCustomer, MasivoCustomerMetrics, MasivoEffect, MasivoEffectMultiplierType, MasivoInfo, MasivoLabels, 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, ProductModifier, 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.78",
+  "version": "0.14.0-canary.79",
   "types": "./dist/bundle.d.ts",
   "files": [
     "dist"
@@ -24,7 +24,7 @@
   },
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
-  "gitHead": "f04a31cbac48185838d39cca0151cdf1a87405b0",
+  "gitHead": "f12af97364f52fc5767594d709abd3cee2069514",
   "nx": {
     "targets": {
       "build": {