@artisan-commerce/types 0.14.0-canary.19 → 0.14.0-canary.20

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 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.20](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.19...@artisan-commerce/types@0.14.0-canary.20) (2021-10-19)
+
+
+### Bug Fixes
+
+* **global:** add interfaces and builders for order ([53d18b0](https://bitbucket.org/tradesystem/artisn_sdk/commit/53d18b07c53fa54f9af69a0751b94a95452bfdc3))
+* **global:** fix tax calculation builder ([3f7698f](https://bitbucket.org/tradesystem/artisn_sdk/commit/3f7698f1cfdf97e2b8d8fa4040b70a7cfa150b74))
+
+
+
 ## [0.14.0-canary.19](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.18...@artisan-commerce/types@0.14.0-canary.19) (2021-10-14)
 
 

package/dist/bundle.d.ts

@@ -1080,8 +1080,8 @@ interface Alert {
 interface CartStore extends Store {
     /** The products that belong to the store, see {@link CartProduct} */
     products: Objectify<CartProduct>;
-    /** Cart store's alerts */
-    alerts: [];
+    /** Cart store's alerts, see {@link Alert} */
+    alerts: Alert[];
 }
 /**
  * The possible values of a Bill Total.
@@ -2246,6 +2246,8 @@ interface OrderStore extends Store {
 interface OrderProduct {
     /** Order product id */
     id: number;
+    /** Order product additional info, see {@link OrderProductAdditionalInfo } */
+    additionalInfo: OrderProductAdditionalInfo;
     /** Order product unique identifier */
     productId: number;
     /** Order product name */
@@ -2259,6 +2261,125 @@ interface OrderProduct {
     /** Order product questions and answers, see {@link CartProductQuestion} */
     questionsAndAnswers: CartProductQuestion[];
 }
+/**
+ * The order product additional info.
+ *
+ * @interface OrderProductAdditionalInfo
+ * @since 0.1.0
+ */
+interface OrderProductAdditionalInfo {
+    /** Order product attributes, see {@link OrderProductAttributes} */
+    attributes: OrderProductAttributes;
+    /** Indicates if a product is available */
+    available: boolean;
+    /** Order bill product, see {@link OrderBillProduct} */
+    bill_product: OrderBillProductAdditionalInfo;
+    /** Order bill product and answers, see {@link OrderBillProduct} */
+    bill_product_and_answers: OrderBillProductAdditionalInfo;
+    /** The description of the product */
+    description: string;
+    /** Array of product images, see {@link OrderProductImage} */
+    images: OrderProductImage[];
+    /** Indicates if a product has a price vip */
+    is_price_vip: boolean;
+    /** The max amount for sale of the product */
+    max_amount_for_sale: number;
+    /** The measure of the product */
+    measure: string;
+    /** The store associated with the product */
+    new_store: number;
+    /** Indicates if a product is out of service */
+    out_of_service: boolean;
+    /** Indicates if a product is out of stock */
+    out_of_stock: boolean;
+    /** Price category type, see {@link PriceCategoryType} */
+    price_category: PriceCategoryType;
+    /** Order bill product prices, see {@link OrderBillProduct} */
+    prices: OrderBillProductAdditionalInfo;
+    /** Indicates if a product is sponsored */
+    sponsored: boolean;
+    /** The status of the product, see {@link ProductStatus} */
+    status: ProductStatus;
+    /** The stock of the product */
+    stock: number;
+    /** The suggested price of the product */
+    suggested_price: string;
+    /** The type of the product, see {@link ProductType} */
+    type: ProductType;
+}
+/**
+ * Order product attributes.
+ *
+ * @interface OrderProductAttributes
+ * @since 0.1.0
+ */
+interface OrderProductAttributes {
+    /** Whether or not to show product in menu */
+    show_in_menu: boolean;
+    /** Product's quantity, the attribute is not in camel case purposefully */
+    cantidad: string;
+    /** Product external id */
+    external_id: string | null;
+}
+/**
+ * Order product image.
+ *
+ * @interface OrderProductImage
+ * @since 0.1.0
+ */
+interface OrderProductImage {
+    /** The directory where the image is saved */
+    key: string;
+    /** Image's name */
+    name: string;
+    /** The bucket where the image is located */
+    bucket: string;
+    /** The url where the image is saved */
+    url: string;
+    /** The cloud where the image is saved */
+    cloud_front_url: string;
+}
+/**
+ * Order bill product additional information.
+ *
+ * @interface OrderBillProductAdditionalInfo
+ * @since 0.1.0
+ */
+interface OrderBillProductAdditionalInfo {
+    /** Normal price category, see {@link OrderProductPriceCategory} */
+    normal: OrderProductPriceCategory;
+    /** Points price category, see {@link OrderProductPriceCategory} */
+    points: OrderProductPriceCategory;
+}
+/**
+ * Order bill product tax calculations.
+ *
+ * @typedef TaxCalculations
+ * @since 0.1.0
+ */
+declare type TaxCalculations = Record<string, TaxCalculation>;
+/**
+ * Order bill product tax calculation
+ *
+ * @interface TaxCalculation
+ * @since 0.1.0
+ */
+interface TaxCalculation {
+    /** Tax calculation code */
+    code: number;
+    /** Tax calculation name, see {@link TaxType} */
+    name: TaxType;
+    /** Tax calculation value added tax rate */
+    vat_rate_code: number;
+    /** Tax calculation value added tax */
+    vat_rate: string;
+    /** Tax calculation percentage */
+    percentage: number;
+    /** Tax calculation base */
+    tax_base: number;
+    /** Tax calculation value */
+    value: number;
+}
 /**
  * The total bill associated with a product of order.
  *
@@ -2281,6 +2402,54 @@ interface OrderBillProduct extends OrderBillTotal {
     /** Order bill product amount */
     amount: number;
 }
+/**
+ * The bill associated with a product of order.
+ *
+ * @interface OrderProductPriceCategory
+ * @since 0.1.0
+ */
+interface OrderProductPriceCategory {
+    /** Order product price category amount */
+    amount: number;
+    /** Array of tax calculation, see {@link TaxCalculation} */
+    taxes: TaxCalculation[];
+    /** Order product price category with taxes */
+    net_price: number;
+    /** Order product price currency symbol */
+    symbol: string;
+    /** Order product price category without taxes */
+    gross_price: number;
+    /** Array of discounts applied to the price category */
+    discounts: any[];
+    /** Order product price discount */
+    discount: number;
+    /** Order product price total discounts with taxes */
+    discount_net_price: number;
+    /** Order product price total discounts without taxes */
+    discount_gross_price: number;
+    /** Order product price category type, see {@link PriceCategoryType} */
+    category: PriceCategoryType;
+    /** Order product price product id */
+    product_id?: number;
+    /** Order product price product name */
+    name?: string;
+    /** Order product price subtotal without taxes */
+    subtotal_before_taxes: number;
+    /** Order product price tax total */
+    tax_total: number;
+    /** Order product price discount total */
+    discount_total: number;
+    /** Order product price total */
+    total: number;
+    /** Order product price subtotal without taxes and discounts */
+    subtotal_before_taxes_before_discounts: number;
+    /** Order product price subtotal */
+    subtotal_zero?: number;
+    /** Order product price subtotal without taxes */
+    subtotal_without_taxes?: number;
+    /** An object of tax calculations, see {@link TaxCalculations} */
+    tax_calcs?: TaxCalculations;
+}
 /**
  * The retry of the order.
  *
@@ -2773,4 +2942,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, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, 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, 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, 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 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
-  "version": "0.14.0-canary.19",
+  "version": "0.14.0-canary.20",
   "main": "./dist/bundle.d.ts",
   "module": "./dist/bundle.d.ts",
   "types": "./dist/bundle.d.ts",
@@ -50,5 +50,5 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^2.1.2"
   },
-  "gitHead": "9ec4dccd5dd073b70584657e1c91ac0710121f70"
+  "gitHead": "bf40692bccbfb025fc0a8d34dc7abe33c89694a9"
 }