@artisan-commerce/types 0.14.0-canary.23 → 0.14.0-canary.25

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.14.0-canary.25](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.24...@artisan-commerce/types@0.14.0-canary.25) (2021-11-05)
+
+
+### Features
+
+* **global:** fix types and builders for store coupon and add condition to shipping cost ([2800a87](https://bitbucket.org/tradesystem/artisn_sdk/commit/2800a87a326c9f0ca5e0f1fbe202e15768fc32c9))
+
+
+
+## [0.14.0-canary.24](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.23...@artisan-commerce/types@0.14.0-canary.24) (2021-10-22)
+
+
+### Features
+
+* **global:** add interfaces, functions and services for store coupons ([7e8a959](https://bitbucket.org/tradesystem/artisn_sdk/commit/7e8a95998982e8c8b892b61eb709e98ac7671a09))
+* **global:** add missing interface and docs ([e7fca2f](https://bitbucket.org/tradesystem/artisn_sdk/commit/e7fca2f5a608a592380b8cd9aafab04cc32ce13d))
+
+
+
 ## [0.14.0-canary.23](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.22...@artisan-commerce/types@0.14.0-canary.23) (2021-10-21)
 
 **Note:** Version bump only for package @artisan-commerce/types

package/dist/bundle.d.ts

@@ -965,7 +965,7 @@ interface Benefit {
     /** Benefit update date */
     updatedAt: string;
     /** The vendor id of the benefit */
-    vendorId: number;
+    vendorId: Vendor["id"];
 }
 /**
  * Award information.
@@ -989,7 +989,7 @@ interface Award {
     /** Product unique identifier associated with the benefit award */
     productId: number;
     /** The vendor id of the award */
-    vendorId: number;
+    vendorId: Vendor["id"];
 }
 /**
  * Applied benefit array in shopping cart.
@@ -1019,6 +1019,231 @@ declare type BenefitsByUserNodes = ArtisnDBCollectionReference<ArtisnDBDocumentD
  * @since 0.5.14
  */
 declare type BenefitTypes = "ALTER_DELIVERY" | "PRODUCT" | "DISCOUNT";
+/**
+ * Redeemed coupon related data.
+ *
+ * @interface RedeemCouponData
+ * @since 0.1.0
+ */
+interface BenefitData {
+    /** Benefit account unique identifier */
+    account_id: number;
+    /** Benefit data amount */
+    amount: number | null;
+    /** Indicates if the benefit is redeemed automatically */
+    automatic_redeemed: string;
+    /** Benefit code */
+    code: string | null;
+    /** Indicates if the benefit is combined or not */
+    combined: string;
+    /** Benefit days */
+    days: null;
+    /** Benefit description */
+    description: string;
+    /** Benefit discount percentage */
+    discount_percentage: number;
+    /** Benefit end date */
+    end_date: string;
+    /** Benefit error validation */
+    error_validation: string;
+    /** Benefit expired date */
+    expiration_date: string;
+    /** Benefit external id */
+    external_id: string | null;
+    /** Benefit data unique identifier */
+    id: number;
+    /** Benefit image */
+    image: null;
+    /** Benefit instruction */
+    instruction: null;
+    /** Benefit award limit */
+    limit_award: null;
+    /** Benefit limit */
+    limit_benefit: number;
+    /** Benefit logic operator */
+    logic_operator: string;
+    /** Benefit name */
+    name: string;
+    /** Benefit quantity */
+    quantity: number;
+    /** An array of coupon products, see {@link BenefitData} */
+    products: ProductCoupon[];
+    /** Array of benefit rules */
+    rules: any[];
+    /** Benefit spend */
+    spend: number;
+    /** Benefit start date */
+    start_date: string;
+    /** Benefit status */
+    status: string;
+    /** Benefit stock */
+    stock: number;
+    /** Benefit success message */
+    success_message: string;
+    /** Benefit term and condition */
+    term_and_condition: string;
+    /** Benefit type */
+    type: string;
+    /** Benefit type alias */
+    type_alias: string;
+    /** Benefit unit */
+    unit: null;
+    /** Coupon vendor unique identifier */
+    vendor_id: Vendor["id"];
+}
+/**
+ * Product coupon associated with a benefit.
+ *
+ * @interface ProductCoupon
+ * @since 0.1.0
+ */
+interface ProductCoupon {
+    /** Product coupon amount */
+    amount: number;
+    /** Product coupon benefit unique identifier */
+    benefitId: number;
+    /** Product coupon discount percentage */
+    discountPercentage: number;
+    /** Product coupon discount */
+    discountValue: number | null;
+    /** Product coupon id */
+    id: number;
+    /** Product description */
+    productDescription: string | null;
+    /** Product unique identifier */
+    productId: number | null;
+    /** Coupon swap product unique identifier */
+    swapProductId: null;
+    /** Coupon vendor unique identifier */
+    vendorId: Vendor["id"];
+}
+/**
+ * Representation of a store coupon.
+ *
+ * @interface StoreCoupon
+ * @since 0.1.0
+ */
+interface StoreCoupon {
+    /** An array of coupons, see {@link Coupon} */
+    coupons: Coupon[];
+    /** Whether or not the store coupon is featured */
+    featured: boolean;
+    /** Store coupon unique identifier */
+    id: number;
+    /** Store coupon name */
+    name: string;
+    /** Store coupon vendor unique identifier */
+    vendor_id: Vendor["id"];
+}
+/**
+ * Representation of a coupon associated to the store.
+ *
+ * @interface Coupon
+ * @since 0.1.0
+ */
+interface Coupon {
+    /**
+     * An array of benefits associated with the coupon,
+     * see {@link BenefitData}
+     */
+    benefits: BenefitData[];
+    /** Coupon category, see {@link CouponCategory} */
+    category: CouponCategory;
+    /** An array of codes associated with the coupon, see {@link Code} */
+    codes: Code[];
+    /** Coupon end date */
+    end_date: string;
+    /** Coupon unique identifier */
+    id: number;
+    /** Coupon image */
+    image: URLImage | null;
+    /** Coupon name */
+    name: string;
+    /** Whether or not the coupon is exclusive to one store */
+    only_store: boolean;
+    /** Coupon spend quantity */
+    spend: number;
+    /** Coupon start date */
+    start_date: string;
+    /** Coupon status, see {@link ProductStatus} */
+    status: ProductStatus;
+    /** Coupon stock */
+    stock: number;
+    /** Coupon term and condition */
+    term_and_condition: string;
+    /** Coupon text */
+    text: string;
+    /** Coupon type, see {@link CouponType} */
+    type: CouponType;
+    /** Coupon vendor unique identifier */
+    vendor_id: Vendor["id"];
+}
+/**
+ * The possible values of a coupon type.
+ *
+ * @typedef CouponType
+ * @since 0.1.0
+ */
+declare type CouponType = "COUPON" | "MIX";
+/**
+ * Coupon category object associated with a store coupon.
+ *
+ * @interface CouponCategory
+ * @since 0.1.0
+ */
+interface CouponCategory {
+    /** Whether or not the store coupon category is featured */
+    featured: boolean;
+    /** Coupon category unique identifier */
+    id: number;
+    /** Coupon category name */
+    name: string;
+}
+/**
+ * Code object associated with a coupon.
+ *
+ * @interface Code
+ * @since 0.1.0
+ */
+interface Code {
+    /** The code associated with the coupon */
+    code: string;
+    /** Coupon code unique identifier */
+    coupon_id: number;
+    /** Code unique identifier */
+    id: number;
+    /** The token corresponding to a QR code */
+    jwt: Token | null;
+    /** The status of the code, see {@link ProductStatus} */
+    status: ProductStatus;
+    /** Whether or not the code has been used */
+    used: boolean;
+}
+/**
+ * An object which contains the token corresponding to a QR code.
+ *
+ * @interface Token
+ * @since 0.1.0
+ */
+interface Token {
+    /** Token associated with the coupon code */
+    token: string;
+    /** Coupon QR code expiration time */
+    dif: number;
+    /** Coupon expiration date */
+    exp: number;
+    /** Coupon international atomic time */
+    iat: number;
+}
+/**
+ * Representation of a store coupon detail, omits the coupon category.
+ *
+ * @interface StoreCouponDetail
+ * @since 0.1.0
+ * @extends {{@link Coupon}
+ */
+interface StoreCouponDetail extends Omit<Coupon, "category"> {
+}
 
 /**
  * Representation of a Commerce Shopping Cart.
@@ -1357,6 +1582,7 @@ interface ProductDetails extends BaseProduct {
     questions: ProductQuestion[];
     /** The benefit id of the product */
     benefitId: number | null;
+    /** An array of categories which the product belongs to, see {@link Category} */
     categories: Category[] | null;
 }
 /**
@@ -2942,4 +3168,4 @@ interface CardInscription {
     createdAt?: string;
 }
 
-export { ARDocumentType, Account, AdditionalInfo, AdditionalStoreInformation, Alert, Allocation, ArtisnApp, ArtisnDB, ArtisnDBCollectionReference, ArtisnDBDocumentData, ArtisnDBQueryDocumentSnapshot, ArtisnHeaders, ArtisnHints, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRNApp, ArtisnRNAuth, ArtisnRNAuthInstance, ArtisnRNSettings, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, ArtisnRestrictedHeaders, ArtisnWebApp, ArtisnWebAuth, ArtisnWebAuthInstance, ArtisnWebSettings, Award, BODocumentType, BRDocumentType, Banner, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, Benefit, BenefitTypes, BenefitsByUserNode, BenefitsByUserNodes, BillTotal, BillTotalCategory, BillingData, CDNImage, CLDocumentType, CODocumentType, CardInscription, CardName, CartProduct, CartProductAnswer, CartProductQuestion, CartStore, CartTotals, Catalogue, Category, CategoryWithProducts, CommonDocumentType, Country, CountryCode, CountryCurrency, CountrySummary, CreditCardMapping, CurrencyCodes, DayOfWeek, Days, Delivery, DeliveryTimeUnit, DocumentType, ECDocumentType, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, MaritalStatus, Message, MetadataShipping, NewShippingAddress, Notification, Objectify, OperatorInformation, Order, OrderAdditionalInfo, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, ShoppingCartNode, ShoppingCartNodes, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreLocation, StorePolygons, Suborder, TaxCalculation, TaxCalculations, TaxType, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, Vendor, Wallet, WebhookWorkflow, Workflow, ZipCodeField };
+export { ARDocumentType, Account, AdditionalInfo, AdditionalStoreInformation, Alert, Allocation, ArtisnApp, ArtisnDB, ArtisnDBCollectionReference, ArtisnDBDocumentData, ArtisnDBQueryDocumentSnapshot, ArtisnHeaders, ArtisnHints, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRNApp, ArtisnRNAuth, ArtisnRNAuthInstance, ArtisnRNSettings, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, ArtisnRestrictedHeaders, ArtisnWebApp, ArtisnWebAuth, ArtisnWebAuthInstance, ArtisnWebSettings, Award, BODocumentType, BRDocumentType, Banner, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, Benefit, BenefitData, BenefitTypes, BenefitsByUserNode, BenefitsByUserNodes, 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, DocumentType, ECDocumentType, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, MaritalStatus, Message, MetadataShipping, NewShippingAddress, Notification, Objectify, OperatorInformation, Order, OrderAdditionalInfo, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductCoupon, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, ShoppingCartNode, ShoppingCartNodes, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreCoupon, StoreCouponDetail, StoreLocation, StorePolygons, Suborder, TaxCalculation, TaxCalculations, TaxType, Token, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, Vendor, Wallet, WebhookWorkflow, Workflow, ZipCodeField };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
-  "version": "0.14.0-canary.23",
+  "version": "0.14.0-canary.25",
   "main": "./dist/bundle.d.ts",
   "module": "./dist/bundle.d.ts",
   "types": "./dist/bundle.d.ts",
@@ -34,5 +34,5 @@
     "@react-native-firebase/firestore": "^12.8.0",
     "firebase": "^8.1.1"
   },
-  "gitHead": "2744d72df22b817ab8b684f14b702cc39488f5b4"
+  "gitHead": "b388e92c72e306a3f446181f11d0cb05ca55bbf3"
 }