@erp-galoper/types 1.0.350 → 1.0.352

package/openapi.ts

@@ -12311,6 +12311,9 @@ export interface paths {
          *         - itemOrItemPackageRequired
          *         - discountShouldBeLessThanSalesMaxDiscount
          *         - discountValueShouldBeLessThanSalesMaxDiscount
+         *         - brandDoesNotExist
+         *         - TagDoesNotExist
+         *         - familyDoesNotExist
          *     - 403:
          *         - permissionDenied
          *         - noModuleAccess
@@ -12381,6 +12384,9 @@ export interface paths {
          *         - discountShouldBeLessThanSalesMaxDiscount
          *         - discountValueShouldBeLessThanSalesMaxDiscount
          *         - OfferAndPromotionShouldBeDraft
+         *         - brandDoesNotExist
+         *         - TagDoesNotExist
+         *         - familyDoesNotExist
          *     - 404:
          *         - offerAndPromotionDoesNotExist
          *     - 403:
@@ -26734,7 +26740,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example 49ff6865-b461-47cb-bd23-5f8aa8308f8f
+             * @example 1838aeba-41b2-4d70-87df-d32be8e6dc4b
              */
             id: string;
             /**
@@ -34591,7 +34597,7 @@ export interface components {
          * AppliesOnSchema
          * @enum {string}
          */
-        AppliesOnSchema: "items" | "categories";
+        AppliesOnSchema: "allItems" | "specificItems";
         /**
          * AppliesToSchema
          * @enum {string}
@@ -34621,16 +34627,26 @@ export interface components {
              * @description discount amount when promotion type is fixed amount otherwise discount percentage
              */
             discountValue: number | null;
-            /** Quantity */
+            /**
+             * Quantity
+             * @description visible when promotion type in [volumeBased, bundleOffers]
+             */
             quantity: number | null;
-            /** Minordervalue */
+            /**
+             * Minordervalue
+             * @description visible when promotion type in [orderValue, fixedAmount]
+             */
             minOrderValue: number | null;
+            /** @description visible when promotion type in [orderValue, fixedAmount] */
             currency: components["schemas"]["CurrencySummaryInfo"] | null;
             item: components["schemas"]["ItemSummaryInfo"] | null;
             itemPackage: components["schemas"]["ItemPackageSharedSchema"] | null;
             /** Unitpackage */
             unitPackage: number | null;
             itemCategory: components["schemas"]["ProductCategorySharedSchema"] | null;
+            brand: components["schemas"]["BrandSchema"] | null;
+            family: components["schemas"]["ProductCategorySharedSchema"] | null;
+            tag: components["schemas"]["TagSchema"] | null;
             /**
              * Offeredproducts
              * @default []
@@ -34790,7 +34806,7 @@ export interface components {
             /**
              * Customers
              * @description
-             *             always visible, use route api/v1//customers/?type=children and filter by isActive equals to true
+             *             always visible, use route api/v1/customers/?type=children and filter by isActive equals to true
              *             in case appliesTo = customer and customers list is empty, the promotion will be applied to all customers
              *
              * @default []
@@ -34798,11 +34814,24 @@ export interface components {
             customers: number[];
             /**
              * Customergroups
-             * @description  always visible,
+             * @description
+             *                 - always visible,
              *                 - use route api/v1/contact-segmentation/ and filter by type equals to customer
              * @default []
              */
             customerGroups: string[];
+            /** @description
+             *         - percentage: user should select appliesOn(Optional), discountValue
+             *         - orderValue, fixedAmount: user should select discountValue, minOrderValue, currency
+             *         - volumeBased: user should select discountValue, item, quantity
+             *         - buyOneGetOne: user should select appliesOn, discountValue, offeredItemsOperator, offeredItems
+             *         - bundleOffers: user should select discountValue, item, quantity
+             *         - timeSensitiveOffers : user should select appliesOn(Optional), discountValue
+             *         - promotionalCode : user should select appliesOn(Optional), discountValue, promotionCode
+             *         Note :
+             *             - if appliesOn is allItems user should not select any of (item, itemPackage, itemCategory, brand, family, tag)
+             *             - if appliesOn is specificItems user should select either (item or itemPackage ) or (itemCategory , brand, family, tag)
+             *          */
             promotionType: components["schemas"]["PromotionTypes"];
             /**
              * Stackable
@@ -34835,17 +34864,21 @@ export interface components {
             discountValue?: number;
             /**
              * Item
-             * @description  visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = item,
+             * @description
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems,
              *             - use use route /settings/sales-settings/ to check if price list is on  get items from route api/v1/inventory/price-list/{id}/ where id is selected price list,
              *             - if price list is off :
-             *                 - to get items :  api/v1/inventory/items/ where isActive is true and type not equal to template
+             *                 - to get items :  /api/v1/inventory/items/?active=true&role!=template&allowSales=true
              *                 - get price from route api/v1/inventory/items/{id}/ (default selling price or usd default selling price)
              */
             item?: number;
             /**
              * Itempackage
              * Format: uuid
-             * @description visible when promotion type in [percentage, volumeBased, buyOneGetOne], use route api/v1/inventory/items/ where isActive is true, field is item_packages
+             * @description
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes]  and appliesOn = specificItems
+             *             - use route /api/v1/inventory/items/?active=true&role!=template&allowSales=true, field is item_packages
+             *
              */
             itemPackage?: string;
             /**
@@ -34855,17 +34888,46 @@ export interface components {
             unitPackage?: number;
             /**
              * Itemcategory
-             * @description visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = category, use route api/v1/inventory/categories/
+             * @description
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route api/v1/inventory/categories/
              */
             itemCategory?: number;
+            /**
+             * Brand
+             * @description
+             *             - brand id
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route /api/v1/inventory/brands/
+             *
+             */
+            brand?: number;
+            /**
+             * Family
+             * @description
+             *             - family id
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route /api/v1/inventory/families/
+             *
+             */
+            family?: number;
+            /**
+             * Tag
+             * @description
+             *             - tag id
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route /api/v1/inventory/tags/
+             *
+             */
+            tag?: number;
             /**
              * Quantity
-             * @description required when promotion type in [volumeBased, bundleOffers]
+             * @description visible and required when promotion type in [volumeBased, bundleOffers]
              */
             quantity?: number;
             /**
              * Minordervalue
-             * @description required when promotion type in [orderValue, fixedAmount]
+             * @description visible and required when promotion type in [orderValue, fixedAmount]
              */
             minOrderValue?: number;
             /**
@@ -34891,13 +34953,13 @@ export interface components {
         OfferedItemCreateSchema: {
             /**
              * Item
-             * @description item id, to get items :  api/v1/inventory/items/ where isActive is true and type not equal to template
+             * @description item id, to get items :  /api/v1/inventory/items/?active=true&role!=template&allowSales=true
              */
             item?: number;
             /**
              * Itempackage
              * Format: uuid
-             * @description item package id, to get item package : api/v1/inventory/items/ where isActive is true, field is item_packages
+             * @description item package id, to get item package : /api/v1/inventory/items/?active=true&role!=template&allowSales=true, field is item_packages
              */
             itemPackage?: string;
             /** Discount */
@@ -34985,17 +35047,21 @@ export interface components {
             discountValue?: number;
             /**
              * Item
-             * @description  visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = item,
+             * @description
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems,
              *             - use use route /settings/sales-settings/ to check if price list is on  get items from route api/v1/inventory/price-list/{id}/ where id is selected price list,
              *             - if price list is off :
-             *                 - to get items :  api/v1/inventory/items/ where isActive is true and type not equal to template
+             *                 - to get items :  /api/v1/inventory/items/?active=true&role!=template&allowSales=true
              *                 - get price from route api/v1/inventory/items/{id}/ (default selling price or usd default selling price)
              */
             item?: number;
             /**
              * Itempackage
              * Format: uuid
-             * @description visible when promotion type in [percentage, volumeBased, buyOneGetOne], use route api/v1/inventory/items/ where isActive is true, field is item_packages
+             * @description
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes]  and appliesOn = specificItems
+             *             - use route /api/v1/inventory/items/?active=true&role!=template&allowSales=true, field is item_packages
+             *
              */
             itemPackage?: string;
             /**
@@ -35005,17 +35071,46 @@ export interface components {
             unitPackage?: number;
             /**
              * Itemcategory
-             * @description visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = category, use route api/v1/inventory/categories/
+             * @description
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route api/v1/inventory/categories/
              */
             itemCategory?: number;
+            /**
+             * Brand
+             * @description
+             *             - brand id
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route /api/v1/inventory/brands/
+             *
+             */
+            brand?: number;
+            /**
+             * Family
+             * @description
+             *             - family id
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route /api/v1/inventory/families/
+             *
+             */
+            family?: number;
+            /**
+             * Tag
+             * @description
+             *             - tag id
+             *             - visible when promotion type in [percentage, volumeBased, buyOneGetOne, timeSensitiveOffers, promotionalCodes] and appliesOn = specificItems
+             *             - use route /api/v1/inventory/tags/
+             *
+             */
+            tag?: number;
             /**
              * Quantity
-             * @description required when promotion type in [volumeBased, bundleOffers]
+             * @description visible and required when promotion type in [volumeBased, bundleOffers]
              */
             quantity?: number;
             /**
              * Minordervalue
-             * @description required when promotion type in [orderValue, fixedAmount]
+             * @description visible and required when promotion type in [orderValue, fixedAmount]
              */
             minOrderValue?: number;
             /**
@@ -35092,6 +35187,18 @@ export interface components {
              * @default []
              */
             customerGroups: string[];
+            /** @description
+             *         - percentage: user should select appliesOn(Optional), discountValue
+             *         - orderValue, fixedAmount: user should select discountValue, minOrderValue, currency
+             *         - volumeBased: user should select appliesOn, discountValue, quantity
+             *         - buyOneGetOne: user should select appliesOn, discountValue, offeredItemsOperator, offeredItems
+             *         - bundleOffers: user should select appliesOn, discountValue, quantity
+             *         - timeSensitiveOffers : user should select appliesOn(Optional), discountValue
+             *         - promotionalCode : user should select appliesOn(Optional), discountValue, promotionCode
+             *         Note :
+             *             - if appliesOn is allItems user should not select any of (item, itemPackage, itemCategory, brand, family, tag)
+             *             - if appliesOn is specificItems user should select either (item or itemPackage ) or (itemCategory , brand, family, tag)
+             *          */
             promotionType: components["schemas"]["PromotionTypes"];
             /**
              * Stackable
@@ -35119,13 +35226,13 @@ export interface components {
         OfferedItemUpdateSchema: {
             /**
              * Item
-             * @description item id, to get items :  api/v1/inventory/items/ where isActive is true and type not equal to template
+             * @description item id, to get items :  /api/v1/inventory/items/?active=true&role!=template&allowSales=true
              */
             item?: number;
             /**
              * Itempackage
              * Format: uuid
-             * @description item package id, to get item package : api/v1/inventory/items/ where isActive is true, field is item_packages
+             * @description item package id, to get item package : /api/v1/inventory/items/?active=true&role!=template&allowSales=true, field is item_packages
              */
             itemPackage?: string;
             /** Discount */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erp-galoper/types",
-  "version": "1.0.350",
+  "version": "1.0.352",
   "main": "openapi.ts",
   "types": "openapi.ts",
   "files": ["openapi.ts"],