@erp-galoper/types 1.0.221 → 1.0.222

package/openapi.ts

@@ -26504,7 +26504,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example 6640fd8b-706a-4265-8c2d-aad076cb7be6
+             * @example bc2613bf-e457-454b-89df-290047634b65
              */
             id: string;
             /**
@@ -36019,13 +36019,17 @@ export interface components {
             /** Commissionvalue */
             commissionValue: number;
             commissionValueType: components["schemas"]["CommissionValueTypes"];
-            /** Salesvolumevalue */
+            /**
+             * Salesvolumevalue
+             * @description visible when structure = tiered, required when salesTierType exist
+             */
             salesVolumeValue?: number;
             /**
              * Currency
-             * @description currency id
+             * @description currency id, visible when structure = tiered, required when salesVolumeValue exist
              */
             currency?: number;
+            /** @description visible when structure = tiered */
             salesTierType?: components["schemas"]["SalesTierType"];
             /**
              * Products
@@ -36047,19 +36051,25 @@ export interface components {
             categories: number[];
             /**
              * Customergroups
-             * @description to get customer groups use route /api/v1/common/contact-segmentation/ and filter by type=customer
+             * @description
+             *             customers or customerGroups required , cannot both be empty
+             *             to get customer groups use route /api/v1/common/contact-segmentation/ and filter by type=customer
+             *
              * @default []
              */
             customerGroups: string[];
             /**
              * Customers
-             * @description to get customers use route /api/v1/customers/?type=children and filter by isActive=true
+             * @description
+             *             customers or customerGroups required , cannot both be empty
+             *             to get customers use route /api/v1/customers/?type=children and filter by isActive=true
+             *
              * @default []
              */
             customers: number[];
             /**
              * Paymentmethod
-             * @description to get payment methods use route /api/v1/payment-methods/
+             * @description visible and required when structure = paymentBased, to get payment methods use route /api/v1/payment-methods/
              */
             paymentMethod?: number;
             /** Target */
@@ -36167,13 +36177,17 @@ export interface components {
             /** Commissionvalue */
             commissionValue: number;
             commissionValueType: components["schemas"]["CommissionValueTypes"];
-            /** Salesvolumevalue */
+            /**
+             * Salesvolumevalue
+             * @description visible when structure = tiered, required when salesTierType exist
+             */
             salesVolumeValue?: number;
             /**
              * Currency
-             * @description currency id
+             * @description currency id, visible when structure = tiered, required when salesVolumeValue exist
              */
             currency?: number;
+            /** @description visible when structure = tiered */
             salesTierType?: components["schemas"]["SalesTierType"];
             /**
              * Products
@@ -36195,15 +36209,26 @@ export interface components {
             categories: number[];
             /**
              * Customergroups
+             * @description
+             *              customers or customerGroups required , cannot both be empty
+             *             to get customer groups use route /api/v1/common/contact-segmentation/ and filter by type=customer
+             *
              * @default []
              */
             customerGroups: string[];
             /**
              * Customers
+             * @description
+             *              customers or customerGroups required , cannot both be empty
+             *             to get customers use route /api/v1/customers/?type=children and filter by isActive=true
+             *
              * @default []
              */
             customers: number[];
-            /** Paymentmethod */
+            /**
+             * Paymentmethod
+             * @description visible and required when structure = paymentBased, to get payment methods use route /api/v1/payment-methods/
+             */
             paymentMethod?: number;
             /** Target */
             target?: number;

package/package.json

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