From 2b9e8bda5eec3bb11746e29c0c98928694ded7cf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 21 Nov 2023 12:36:09 +0000 Subject: [PATCH] chore(docs): Generated References (#5666) Generated the following references: - `entities` - `js-client` - `pricing` - `services` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com> --- .../references/entities/classes/Product.mdx | 9 + .../entities/classes/ProductCategory.mdx | 18 + ...l.internal-1.CacheTypes.ICacheService.mdx} | 0 ...l.internal-1.CommonTypes.ConfigModule.mdx} | 4 +- ....EventBusTypes.IEventBusModuleService.mdx} | 14 +- ...rnal-1.EventBusTypes.IEventBusService.mdx} | 14 +- ...nal.internal-1.EventBusTypes.EmitData.mdx} | 0 ...l.internal-1.EventBusTypes.Subscriber.mdx} | 0 ...nal-1.EventBusTypes.SubscriberContext.mdx} | 0 ...l-1.EventBusTypes.SubscriberDescriptor.mdx | 2 +- ...oryTypes.BulkUpdateInventoryLevelInput.mdx | 4 +- ...nventoryTypes.CreateInventoryItemInput.mdx | 2 +- ...al-1.InventoryTypes.IInventoryService.mdx} | 72 +- ...InventoryTypes.ReserveQuantityContext.mdx} | 0 ...nternal.internal-1.LoggerTypes.Logger.mdx} | 0 ...nternal-1.ModulesSdkTypes.Constructor.mdx} | 0 ...ternal-1.ModulesSdkTypes.LoaderOptions.mdx | 2 +- ...ternal-1.ModulesSdkTypes.ModuleExports.mdx | 4 +- ...1.ModulesSdkTypes.RemoteQueryFunction.mdx} | 0 ...-1.PricingTypes.IPricingModuleService.mdx} | 252 ++-- ...internal-1.PricingTypes.MoneyAmountDTO.mdx | 2 +- ....ProductTypes.CreateProductCategoryDTO.mdx | 2 +- ...roductTypes.CreateProductCollectionDTO.mdx | 2 +- ...ternal-1.ProductTypes.CreateProductDTO.mdx | 2 +- ...Types.FilterableProductCollectionProps.mdx | 2 +- ...-1.ProductTypes.FilterableProductProps.mdx | 12 +- ...uctTypes.FilterableProductVariantProps.mdx | 2 +- ...rnal-1.ProductTypes.ProductCategoryDTO.mdx | 8 +- ...al-1.ProductTypes.ProductCollectionDTO.mdx | 4 +- ...nal.internal-1.ProductTypes.ProductDTO.mdx | 56 +- ...ternal-1.ProductTypes.ProductOptionDTO.mdx | 8 +- ...l-1.ProductTypes.ProductOptionValueDTO.mdx | 8 +- ....internal-1.ProductTypes.ProductTagDTO.mdx | 4 +- ...ernal-1.ProductTypes.ProductVariantDTO.mdx | 34 +- ....ProductTypes.UpdateProductCategoryDTO.mdx | 2 +- ...ternal-1.ProductTypes.UpdateProductDTO.mdx | 2 +- ...ckLocationTypes.IStockLocationService.mdx} | 24 +- .../AdminProductCategoriesResource.mdx | 72 ++ .../classes/ProductCategoriesResource.mdx | 18 + .../internal.internal-1.Context.mdx | 4 +- .../internal.internal-1.CacheTypes.mdx | 4 + .../internal.internal-1.CommonTypes.mdx | 1 + .../internal.internal-1.EventBusTypes.mdx | 8 + .../internal.internal-1.InventoryTypes.mdx | 5 + .../internal.internal-1.LoggerTypes.mdx | 4 + .../internal.internal-1.ModulesSdkTypes.mdx | 2 + .../internal.internal-1.PricingTypes.mdx | 1 + ...internal.internal-1.StockLocationTypes.mdx | 1 + ...internal.AbstractEventBusModuleService.mdx | 14 +- ....AdminPostProductCategoriesCategoryReq.mdx | 9 + ...internal.AdminPostProductCategoriesReq.mdx | 9 + .../classes/internal.ProductCategory.mdx | 9 + .../internal.internal.EventBusService.mdx | 18 +- ...al.internal.OrderEditItemChangeService.mdx | 2 +- .../internal.internal.OrderEditService.mdx | 2 +- .../internal.internal.OrderService.mdx | 2 +- ...nternal.ProductVariantInventoryService.mdx | 4 +- ....internal.SalesChannelInventoryService.mdx | 2 +- ...l.internal.SalesChannelLocationService.mdx | 2 +- .../internal.internal.StagedJobService.mdx | 2 +- .../internal.internal.TaxProviderService.mdx | 4 +- .../internal.internal.TokenService.mdx | 2 +- .../interfaces/internal.SubscriberContext.mdx | 23 + .../internal.InjectedDependencies-10.mdx | 2 +- .../internal.InjectedDependencies-18.mdx | 2 +- .../internal.InjectedDependencies-19.mdx | 2 +- .../internal.InjectedDependencies-20.mdx | 2 +- .../internal.InjectedDependencies-23.mdx | 4 +- .../internal.InjectedDependencies-27.mdx | 6 +- .../internal.InjectedDependencies-32.mdx | 4 +- .../internal.InjectedDependencies-33.mdx | 4 +- .../types/internal.ProductCategoryInput.mdx | 9 + .../internal.internal.ScheduledJobArgs.mdx | 53 + .../internal.internal.ScheduledJobConfig.mdx | 53 + .../internal.internal.SubscriberArgs.mdx | 62 + .../internal.internal.SubscriberConfig.mdx | 30 + .../references/js-client/modules/internal.mdx | 15 +- ...ricingModuleService.addPriceListPrices.mdx | 315 +++++ .../IPricingModuleService.addPrices.mdx | 41 +- .../IPricingModuleService.addRules.mdx | 37 +- .../IPricingModuleService.calculatePrices.mdx | 47 +- .../methods/IPricingModuleService.create.mdx | 45 +- ...IPricingModuleService.createCurrencies.mdx | 4 +- ...ricingModuleService.createMoneyAmounts.mdx | 23 +- ...cingModuleService.createPriceListRules.mdx | 211 ++++ ...IPricingModuleService.createPriceLists.mdx | 414 +++++++ ...IPricingModuleService.createPriceRules.mdx | 35 +- ...Service.createPriceSetMoneyAmountRules.mdx | 14 +- .../IPricingModuleService.createRuleTypes.mdx | 4 +- .../methods/IPricingModuleService.delete.mdx | 6 +- ...IPricingModuleService.deleteCurrencies.mdx | 4 +- ...ricingModuleService.deleteMoneyAmounts.mdx | 6 +- ...cingModuleService.deletePriceListRules.mdx | 113 ++ ...IPricingModuleService.deletePriceLists.mdx | 113 ++ ...IPricingModuleService.deletePriceRules.mdx | 6 +- ...Service.deletePriceSetMoneyAmountRules.mdx | 6 +- .../IPricingModuleService.deleteRuleTypes.mdx | 6 +- .../methods/IPricingModuleService.list.mdx | 14 +- .../IPricingModuleService.listAndCount.mdx | 14 +- ...ngModuleService.listAndCountCurrencies.mdx | 10 +- ...ModuleService.listAndCountMoneyAmounts.mdx | 12 +- ...duleService.listAndCountPriceListRules.mdx | 349 ++++++ ...ngModuleService.listAndCountPriceLists.mdx | 377 ++++++ ...ngModuleService.listAndCountPriceRules.mdx | 12 +- ...e.listAndCountPriceSetMoneyAmountRules.mdx | 14 +- ...rvice.listAndCountPriceSetMoneyAmounts.mdx | 23 +- ...ingModuleService.listAndCountRuleTypes.mdx | 12 +- .../IPricingModuleService.listCurrencies.mdx | 10 +- ...IPricingModuleService.listMoneyAmounts.mdx | 25 +- ...ricingModuleService.listPriceListRules.mdx | 386 ++++++ .../IPricingModuleService.listPriceLists.mdx | 468 +++++++ .../IPricingModuleService.listPriceRules.mdx | 20 +- ...leService.listPriceSetMoneyAmountRules.mdx | 20 +- ...ModuleService.listPriceSetMoneyAmounts.mdx | 44 +- .../IPricingModuleService.listRuleTypes.mdx | 12 +- ...cingModuleService.removePriceListRules.mdx | 513 ++++++++ .../IPricingModuleService.removeRules.mdx | 6 +- .../IPricingModuleService.retrieve.mdx | 23 +- ...IPricingModuleService.retrieveCurrency.mdx | 8 +- ...icingModuleService.retrieveMoneyAmount.mdx | 85 +- ...PricingModuleService.retrievePriceList.mdx | 590 +++++++++ ...ingModuleService.retrievePriceListRule.mdx | 425 +++++++ ...PricingModuleService.retrievePriceRule.mdx | 16 +- ...rvice.retrievePriceSetMoneyAmountRules.mdx | 39 +- ...IPricingModuleService.retrieveRuleType.mdx | 8 +- ...PricingModuleService.setPriceListRules.mdx | 515 ++++++++ ...IPricingModuleService.updateCurrencies.mdx | 4 +- ...ricingModuleService.updateMoneyAmounts.mdx | 21 +- ...cingModuleService.updatePriceListRules.mdx | 221 ++++ ...IPricingModuleService.updatePriceLists.mdx | 314 +++++ ...IPricingModuleService.updatePriceRules.mdx | 22 +- ...Service.updatePriceSetMoneyAmountRules.mdx | 14 +- .../IPricingModuleService.updateRuleTypes.mdx | 6 +- .../pricing/enums/PriceListStatus.mdx | 25 + .../pricing/enums/PriceListType.mdx | 25 + .../docs/content/references/pricing/index.md | 19 + .../interfaces/AddPriceListPricesDTO.mdx | 133 ++ .../pricing/interfaces/AddPricesDTO.mdx | 6 +- .../pricing/interfaces/AddRulesDTO.mdx | 6 +- .../interfaces/CalculatedPriceSetDTO.mdx | 37 +- .../references/pricing/interfaces/Context.mdx | 6 +- .../interfaces/CreateMoneyAmountDTO.mdx | 6 +- .../pricing/interfaces/CreatePriceListDTO.mdx | 234 ++++ .../interfaces/CreatePriceListRuleDTO.mdx | 50 + .../interfaces/CreatePriceListRules.mdx | 10 + .../pricing/interfaces/CreatePriceRuleDTO.mdx | 13 +- .../pricing/interfaces/CreatePriceSetDTO.mdx | 12 +- .../pricing/interfaces/CreatePricesDTO.mdx | 6 +- .../interfaces/FilterablePriceListProps.mdx | 98 ++ .../FilterablePriceListRuleProps.mdx | 68 + .../interfaces/FilterablePriceRuleProps.mdx | 2 +- .../FilterablePriceSetMoneyAmountProps.mdx | 9 + .../interfaces/IPricingModuleService.mdx | 15 + .../interfaces/JoinerServiceConfig.mdx | 2 +- .../pricing/interfaces/MoneyAmountDTO.mdx | 351 +++++- .../pricing/interfaces/PriceListDTO.mdx | 1094 +++++++++++++++++ .../pricing/interfaces/PriceListPriceDTO.mdx | 114 ++ .../pricing/interfaces/PriceListRuleDTO.mdx | 546 ++++++++ .../interfaces/PriceListRuleValueDTO.mdx | 252 ++++ .../pricing/interfaces/PriceRuleDTO.mdx | 21 +- .../pricing/interfaces/PriceSetDTO.mdx | 77 +- .../interfaces/PriceSetMoneyAmountDTO.mdx | 497 +++++++- .../PriceSetMoneyAmountRulesDTO.mdx | 152 ++- .../interfaces/RemovePriceListRulesDTO.mdx | 32 + .../interfaces/SetPriceListRulesDTO.mdx | 32 + .../interfaces/UpdateMoneyAmountDTO.mdx | 2 - .../pricing/interfaces/UpdatePriceListDTO.mdx | 96 ++ .../interfaces/UpdatePriceListRuleDTO.mdx | 59 + .../pricing/interfaces/UpdatePriceRuleDTO.mdx | 6 +- .../references/pricing/types/Exclude.mdx | 2 +- .../pricing/types/ModuleJoinerConfig.mdx | 2 +- .../types/ModuleJoinerRelationship.mdx | 2 +- .../services/classes/ProductCategory.mdx | 9 + .../BulkUpdateInventoryLevelInput.mdx | 4 +- .../services/interfaces/Context.mdx | 4 +- .../interfaces/CreateInventoryItemInput.mdx | 2 +- .../services/interfaces/MoneyAmountDTO.mdx | 2 +- .../services/types/ProductCategoryInput.mdx | 9 + 178 files changed, 10576 insertions(+), 718 deletions(-) rename www/apps/docs/content/references/js-client/{internal/interfaces/internal.ICacheService.mdx => CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/types/internal.ConfigModule.mdx => CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx} (67%) rename www/apps/docs/content/references/js-client/{internal/interfaces/internal.IEventBusModuleService.mdx => EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx} (81%) rename www/apps/docs/content/references/js-client/{internal/interfaces/internal.IEventBusService.mdx => EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx} (81%) rename www/apps/docs/content/references/js-client/{internal/types/internal.EmitData.mdx => EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/types/internal.Subscriber.mdx => EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/types/internal.SubscriberContext.mdx => EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/interfaces/internal.IInventoryService.mdx => InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx} (92%) rename www/apps/docs/content/references/js-client/{internal/types/internal.ReserveQuantityContext.mdx => InventoryTypes/types/internal.internal-1.InventoryTypes.ReserveQuantityContext.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/interfaces/internal.Logger.mdx => LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/types/internal.Constructor.mdx => ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.Constructor.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/types/internal.RemoteQueryFunction.mdx => ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.RemoteQueryFunction.mdx} (100%) rename www/apps/docs/content/references/js-client/{internal/interfaces/internal.IPricingModuleService.mdx => PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx} (88%) rename www/apps/docs/content/references/js-client/{internal/interfaces/internal.IStockLocationService.mdx => StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx} (91%) create mode 100644 www/apps/docs/content/references/js-client/internal/interfaces/internal.SubscriberContext.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobArgs.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobConfig.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberArgs.mdx create mode 100644 www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberConfig.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPriceListPrices.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removePriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceList.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceListRule.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.setPriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceLists.mdx create mode 100644 www/apps/docs/content/references/pricing/enums/PriceListStatus.mdx create mode 100644 www/apps/docs/content/references/pricing/enums/PriceListType.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/AddPriceListPricesDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/CreatePriceListDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/CreatePriceListRuleDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/FilterablePriceListProps.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/FilterablePriceListRuleProps.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/PriceListPriceDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/PriceListRuleValueDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/RemovePriceListRulesDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/SetPriceListRulesDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx create mode 100644 www/apps/docs/content/references/pricing/interfaces/UpdatePriceListRuleDTO.mdx diff --git a/www/apps/docs/content/references/entities/classes/Product.mdx b/www/apps/docs/content/references/entities/classes/Product.mdx index f34e1f91d3..a449babff6 100644 --- a/www/apps/docs/content/references/entities/classes/Product.mdx +++ b/www/apps/docs/content/references/entities/classes/Product.mdx @@ -83,6 +83,15 @@ A product is a saleable item that holds general information such as name or desc "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/entities/classes/ProductCategory.mdx b/www/apps/docs/content/references/entities/classes/ProductCategory.mdx index e885832432..e304e2cdcb 100644 --- a/www/apps/docs/content/references/entities/classes/ProductCategory.mdx +++ b/www/apps/docs/content/references/entities/classes/ProductCategory.mdx @@ -82,6 +82,15 @@ A product category can be used to categorize products into a hierarchy of catego "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -210,6 +219,15 @@ A product category can be used to categorize products into a hierarchy of catego "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.ICacheService.mdx b/www/apps/docs/content/references/js-client/CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx similarity index 100% rename from www/apps/docs/content/references/js-client/internal/interfaces/internal.ICacheService.mdx rename to www/apps/docs/content/references/js-client/CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.ConfigModule.mdx b/www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx similarity index 67% rename from www/apps/docs/content/references/js-client/internal/types/internal.ConfigModule.mdx rename to www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx index e7e0db2103..1935124eb1 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.ConfigModule.mdx +++ b/www/apps/docs/content/references/js-client/CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "modules", - "type": "`Record`", + "type": "`Record`", "description": "", "optional": true, "defaultValue": "", @@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "projectConfig", - "type": "[ProjectConfigOptions](../../CommonTypes/types/internal.internal-1.CommonTypes.ProjectConfigOptions.mdx)", + "type": "[ProjectConfigOptions](internal.internal-1.CommonTypes.ProjectConfigOptions.mdx)", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.IEventBusModuleService.mdx b/www/apps/docs/content/references/js-client/EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx similarity index 81% rename from www/apps/docs/content/references/js-client/internal/interfaces/internal.IEventBusModuleService.mdx rename to www/apps/docs/content/references/js-client/EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx index c40e45a489..192173c78a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.IEventBusModuleService.mdx +++ b/www/apps/docs/content/references/js-client/EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" -`**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>` +`**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>` This method adds prices to multiple price sets. @@ -268,7 +268,7 @@ async function addPricesToPriceSet (priceSetId: string) { -`**addRules**(data, sharedContext?): Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>` +`**addRules**(data, sharedContext?): Promise<[PriceSetDTO](internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>` This method adds rules to multiple price sets. @@ -396,7 +396,7 @@ async function addRulesToPriceSet (priceSetId: string) { -`**create**(data, sharedContext?): Promise<[PriceSetDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>` +`**create**(data, sharedContext?): Promise<[PriceSetDTO](internal.internal-1.PricingTypes.PriceSetDTO.mdx)[]>` This method is used to create multiple price sets. @@ -749,7 +749,7 @@ async function createPriceSets() { diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx index 32a56069f2..1d773e50f6 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCategoryDTO.mdx @@ -59,7 +59,7 @@ A product category to create. { "name": "parent_category_id", "type": "`null` \\| `string`", - "description": "The ID of the parent product category, if it has any. It may also be `null`.", + "description": "The ID of the parent product category, if it has any.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCollectionDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCollectionDTO.mdx index 33558d48bd..717b6ab2c0 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCollectionDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductCollectionDTO.mdx @@ -32,7 +32,7 @@ A product collection to create. { "name": "product_ids", "type": "`string`[]", - "description": "", + "description": "The products to associate with the collection.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx index de1f1f97c0..f791426aa6 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.CreateProductDTO.mdx @@ -149,7 +149,7 @@ A product to create. { "name": "status", "type": "[ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx).", + "description": "The status of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx index 99f84f6a1e..a7ecc7e3bf 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx @@ -32,7 +32,7 @@ The filters to apply on retrieved product collections. { "name": "handle", "type": "`string` \\| `string`[]", - "description": "", + "description": "The handles to filter product collections by.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductProps.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductProps.mdx index d08ca5f0ed..71b3e06d89 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductProps.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductProps.mdx @@ -41,7 +41,7 @@ The filters to apply on retrieved products. { "name": "categories.id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../internal/types/internal.OperatorMap.mdx)<string>", - "description": "", + "description": "IDs to filter categories by.", "optional": true, "defaultValue": "", "expandable": false, @@ -50,7 +50,7 @@ The filters to apply on retrieved products. { "name": "categories.is_active", "type": "`boolean`", - "description": "", + "description": "Filter categories by whether they're active.", "optional": true, "defaultValue": "", "expandable": false, @@ -59,7 +59,7 @@ The filters to apply on retrieved products. { "name": "categories.is_internal", "type": "`boolean`", - "description": "", + "description": "Filter categories by whether they're internal", "optional": true, "defaultValue": "", "expandable": false, @@ -68,7 +68,7 @@ The filters to apply on retrieved products. { "name": "category_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../internal/types/internal.OperatorMap.mdx)<string>", - "description": "", + "description": "Filter a product by the IDs of their associated categories.", "optional": true, "defaultValue": "", "expandable": false, @@ -77,7 +77,7 @@ The filters to apply on retrieved products. { "name": "collection_id", "type": "`string` \\| `string`[] \\| [OperatorMap](../../internal/types/internal.OperatorMap.mdx)<string>", - "description": "Filters a product by its associated collections.", + "description": "Filters a product by the IDs of their associated collections.", "optional": true, "defaultValue": "", "expandable": false, @@ -122,7 +122,7 @@ The filters to apply on retrieved products. { "name": "tags.value", "type": "`string`[]", - "description": "", + "description": "Values to filter product tags by.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx index 80b26da9f0..025301cb1b 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx @@ -50,7 +50,7 @@ The filters to apply on retrieved product variants. { "name": "options.id", "type": "`string`[]", - "description": "", + "description": "IDs to filter options by.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCategoryDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCategoryDTO.mdx index d5972fc1bd..4f94202896 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCategoryDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCategoryDTO.mdx @@ -14,10 +14,10 @@ A product category's data. { "name": "category_children", "type": "[ProductCategoryDTO](internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)[]", - "description": "The associated child categories. It may only be available if the `category_children` relation is expanded.", + "description": "The associated child categories.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -86,10 +86,10 @@ A product category's data. { "name": "parent_category", "type": "[ProductCategoryDTO](internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)", - "description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.", + "description": "The associated parent category.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCollectionDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCollectionDTO.mdx index 491fad9088..a665e6cec5 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCollectionDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductCollectionDTO.mdx @@ -50,10 +50,10 @@ A product collection's data. { "name": "products", "type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx index 06ae6e14de..497eba2a26 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductDTO.mdx @@ -14,19 +14,19 @@ A product's data. { "name": "categories", "type": "`null` \\| [ProductCategoryDTO](internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)[]", - "description": "The associated product categories. It may only be available if the `categories` relation is expanded.", + "description": "The associated product categories.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "collection", "type": "[ProductCollectionDTO](internal.internal-1.ProductTypes.ProductCollectionDTO.mdx)", - "description": "The associated product collection. It may only be available if the `collection` relation is expanded.", + "description": "The associated product collection.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -50,7 +50,7 @@ A product's data. { "name": "description", "type": "`null` \\| `string`", - "description": "The description of the product. It can possibly be `null`.", + "description": "The description of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -77,7 +77,7 @@ A product's data. { "name": "handle", "type": "`null` \\| `string`", - "description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.", + "description": "The handle of the product. The handle can be used to create slug URL paths.", "optional": true, "defaultValue": "", "expandable": false, @@ -86,7 +86,7 @@ A product's data. { "name": "height", "type": "`null` \\| `number`", - "description": "The height of the product. It can possibly be `null`.", + "description": "The height of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -95,7 +95,7 @@ A product's data. { "name": "hs_code", "type": "`null` \\| `string`", - "description": "The HS Code of the product. It can possibly be `null`.", + "description": "The HS Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -113,10 +113,10 @@ A product's data. { "name": "images", "type": "[ProductImageDTO](internal.internal-1.ProductTypes.ProductImageDTO.mdx)[]", - "description": "The associated product images. It may only be available if the `images` relation is expanded.", + "description": "The associated product images.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -131,7 +131,7 @@ A product's data. { "name": "length", "type": "`null` \\| `number`", - "description": "The length of the product. It can possibly be `null`.", + "description": "The length of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -140,7 +140,7 @@ A product's data. { "name": "material", "type": "`null` \\| `string`", - "description": "The material of the product. It can possibly be `null`.", + "description": "The material of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -149,7 +149,7 @@ A product's data. { "name": "metadata", "type": "`Record`", - "description": "", + "description": "Holds custom data in key-value pairs.", "optional": true, "defaultValue": "", "expandable": false, @@ -158,7 +158,7 @@ A product's data. { "name": "mid_code", "type": "`null` \\| `string`", - "description": "The MID Code of the product. It can possibly be `null`.", + "description": "The MID Code of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -167,16 +167,16 @@ A product's data. { "name": "options", "type": "[ProductOptionDTO](internal.internal-1.ProductTypes.ProductOptionDTO.mdx)[]", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", "type": "`null` \\| `string`", - "description": "The origin country of the product. It can possibly be `null`.", + "description": "The origin country of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -185,7 +185,7 @@ A product's data. { "name": "status", "type": "[ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx).", + "description": "The status of the product.", "optional": false, "defaultValue": "", "expandable": false, @@ -194,7 +194,7 @@ A product's data. { "name": "subtitle", "type": "`null` \\| `string`", - "description": "The subttle of the product. It can possibly be `null`.", + "description": "The subttle of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -203,16 +203,16 @@ A product's data. { "name": "tags", "type": "[ProductTagDTO](internal.internal-1.ProductTypes.ProductTagDTO.mdx)[]", - "description": "The associated product tags. It may only be available if the `tags` relation is expanded.", + "description": "The associated product tags.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "thumbnail", "type": "`null` \\| `string`", - "description": "The URL of the product's thumbnail. It can possibly be `null`.", + "description": "The URL of the product's thumbnail.", "optional": true, "defaultValue": "", "expandable": false, @@ -230,10 +230,10 @@ A product's data. { "name": "type", "type": "[ProductTypeDTO](internal.internal-1.ProductTypes.ProductTypeDTO.mdx)[]", - "description": "The associated product type. It may only be available if the `type` relation is expanded.", + "description": "The associated product type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -248,16 +248,16 @@ A product's data. { "name": "variants", "type": "[ProductVariantDTO](internal.internal-1.ProductTypes.ProductVariantDTO.mdx)[]", - "description": "The associated product variants. It may only be available if the `variants` relation is expanded.", + "description": "The associated product variants.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "weight", "type": "`null` \\| `number`", - "description": "The weight of the product. It can possibly be `null`.", + "description": "The weight of the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -266,7 +266,7 @@ A product's data. { "name": "width", "type": "`null` \\| `number`", - "description": "", + "description": "The width of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx index 513f89b0df..9c47f4e314 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionDTO.mdx @@ -41,10 +41,10 @@ A product option's data. { "name": "product", "type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -59,10 +59,10 @@ A product option's data. { "name": "values", "type": "[ProductOptionValueDTO](internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)[]", - "description": "The associated product option values. It may only be available if the `values` relation is expanded.", + "description": "The associated product option values.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ]} /> diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx index 88daf74255..7d1d47d4fb 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx @@ -41,10 +41,10 @@ The product option value's data. { "name": "option", "type": "[ProductOptionDTO](internal.internal-1.ProductTypes.ProductOptionDTO.mdx)", - "description": "The associated product option. It may only be available if the `option` relation is expanded.", + "description": "The associated product option.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -59,10 +59,10 @@ The product option value's data. { "name": "variant", "type": "[ProductVariantDTO](internal.internal-1.ProductTypes.ProductVariantDTO.mdx)", - "description": "The associated product variant. It may only be available if the `variant` relation is expanded.", + "description": "The associated product variant.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ]} /> diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx index 68b3356106..3b55544fb4 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductTagDTO.mdx @@ -32,10 +32,10 @@ A product tag's data. { "name": "products", "type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)[]", - "description": "The associated products. It may only be available if the `products` relation is expanded.", + "description": "The associated products.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx index a786cc3085..2e8899d066 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.ProductVariantDTO.mdx @@ -23,7 +23,7 @@ A product variant's data. { "name": "barcode", "type": "`null` \\| `string`", - "description": "The barcode of the product variant. It can possibly be `null`.", + "description": "The barcode of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -50,7 +50,7 @@ A product variant's data. { "name": "ean", "type": "`null` \\| `string`", - "description": "The EAN of the product variant. It can possibly be `null`.", + "description": "The EAN of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -59,7 +59,7 @@ A product variant's data. { "name": "height", "type": "`null` \\| `number`", - "description": "The height of the product variant. It can possibly be `null`.", + "description": "The height of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -68,7 +68,7 @@ A product variant's data. { "name": "hs_code", "type": "`null` \\| `string`", - "description": "The HS Code of the product variant. It can possibly be `null`.", + "description": "The HS Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -95,7 +95,7 @@ A product variant's data. { "name": "length", "type": "`null` \\| `number`", - "description": "The length of the product variant. It can possibly be `null`.", + "description": "The length of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -113,7 +113,7 @@ A product variant's data. { "name": "material", "type": "`null` \\| `string`", - "description": "The material of the product variant. It can possibly be `null`.", + "description": "The material of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -131,7 +131,7 @@ A product variant's data. { "name": "mid_code", "type": "`null` \\| `string`", - "description": "The MID Code of the product variant. It can possibly be `null`.", + "description": "The MID Code of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -140,16 +140,16 @@ A product variant's data. { "name": "options", "type": "[ProductOptionValueDTO](internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)", - "description": "The associated product options. It may only be available if the `options` relation is expanded.", + "description": "The associated product options.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "origin_country", "type": "`null` \\| `string`", - "description": "The origin country of the product variant. It can possibly be `null`.", + "description": "The origin country of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -158,10 +158,10 @@ A product variant's data. { "name": "product", "type": "[ProductDTO](internal.internal-1.ProductTypes.ProductDTO.mdx)", - "description": "The associated product. It may only be available if the `product` relation is expanded.", + "description": "The associated product.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -176,7 +176,7 @@ A product variant's data. { "name": "sku", "type": "`null` \\| `string`", - "description": "The SKU of the product variant. It can possibly be `null`.", + "description": "The SKU of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -194,7 +194,7 @@ A product variant's data. { "name": "upc", "type": "`null` \\| `string`", - "description": "The UPC of the product variant. It can possibly be `null`.", + "description": "The UPC of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -212,7 +212,7 @@ A product variant's data. { "name": "variant_rank", "type": "`null` \\| `number`", - "description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.", + "description": "he ranking of the variant among other variants associated with the product.", "optional": true, "defaultValue": "", "expandable": false, @@ -221,7 +221,7 @@ A product variant's data. { "name": "weight", "type": "`null` \\| `number`", - "description": "The weight of the product variant. It can possibly be `null`.", + "description": "The weight of the product variant.", "optional": true, "defaultValue": "", "expandable": false, @@ -230,7 +230,7 @@ A product variant's data. { "name": "width", "type": "`null` \\| `number`", - "description": "The width of the product variant. It can possibly be `null`.", + "description": "The width of the product variant.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx index 3bef7a65d0..a87aa5a9c2 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductCategoryDTO.mdx @@ -59,7 +59,7 @@ The data to update in a product category. { "name": "parent_category_id", "type": "`null` \\| `string`", - "description": "The ID of the parent product category, if it has any. It may also be `null`.", + "description": "The ID of the parent product category, if it has any.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx index 0481fb92c1..d92b646667 100644 --- a/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx +++ b/www/apps/docs/content/references/js-client/ProductTypes/interfaces/internal.internal-1.ProductTypes.UpdateProductDTO.mdx @@ -158,7 +158,7 @@ The data to update in a product. The `id` is used to identify which product to u { "name": "status", "type": "[ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx)", - "description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/internal.internal-1.ProductTypes.ProductStatus.mdx).", + "description": "The status of the product.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx b/www/apps/docs/content/references/js-client/StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx similarity index 91% rename from www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx rename to www/apps/docs/content/references/js-client/StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx index 7f7e414d20..af403389ab 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/internal.IStockLocationService.mdx +++ b/www/apps/docs/content/references/js-client/StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx @@ -35,7 +35,7 @@ async function createStockLocation (name: string) { `", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -319,6 +328,15 @@ medusa.admin.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional set of key-value pairs to hold additional information.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -440,6 +458,15 @@ medusa.admin.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -871,6 +898,15 @@ medusa.admin.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -1100,6 +1136,15 @@ medusa.admin.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -1339,6 +1384,15 @@ medusa.admin.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -1478,6 +1532,15 @@ medusa.admin.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional set of key-value pairs to hold additional information.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -1608,6 +1671,15 @@ medusa.admin.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx index fbbd57184d..3e8b9dddc5 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx +++ b/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.mdx @@ -302,6 +302,15 @@ medusa.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", @@ -541,6 +550,15 @@ medusa.productCategories "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx b/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx index 32d62446ef..cd1f08fb8e 100644 --- a/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.Context.mdx @@ -28,7 +28,7 @@ A shared context object that is used to share resources between the application { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -55,7 +55,7 @@ A shared context object that is used to share resources between the application { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CacheTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CacheTypes.mdx index 86bdaa0f08..c56f149c09 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CacheTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CacheTypes.mdx @@ -5,3 +5,7 @@ displayed_sidebar: jsClientSidebar import ParameterTypes from "@site/src/components/ParameterTypes" # CacheTypes + +## Interfaces + +- [ICacheService](../../CacheTypes/interfaces/internal.internal-1.CacheTypes.ICacheService.mdx) diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CommonTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CommonTypes.mdx index b71d207374..5b305fda2c 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CommonTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.CommonTypes.mdx @@ -24,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Type Aliases +- [ConfigModule](../../CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx) - [ExtendedFindConfig](../../CommonTypes/types/internal.internal-1.CommonTypes.ExtendedFindConfig.mdx) - [HttpCompressionOptions](../../CommonTypes/types/internal.internal-1.CommonTypes.HttpCompressionOptions.mdx) - [PartialPick](../../CommonTypes/types/internal.internal-1.CommonTypes.PartialPick.mdx) diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.EventBusTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.EventBusTypes.mdx index bd1fd2516c..8a7dac3b6f 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.EventBusTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.EventBusTypes.mdx @@ -6,7 +6,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # EventBusTypes +## Interfaces + +- [IEventBusModuleService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx) +- [IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx) + ## Type Aliases +- [EmitData](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EmitData.mdx) - [EventHandler](../../EventBusTypes/types/internal.internal-1.EventBusTypes.EventHandler.mdx) +- [Subscriber](../../EventBusTypes/types/internal.internal-1.EventBusTypes.Subscriber.mdx) +- [SubscriberContext](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberContext.mdx) - [SubscriberDescriptor](../../EventBusTypes/types/internal.internal-1.EventBusTypes.SubscriberDescriptor.mdx) diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.InventoryTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.InventoryTypes.mdx index 2eb584f315..9e6425bde4 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.InventoryTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.InventoryTypes.mdx @@ -15,5 +15,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [FilterableInventoryItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryItemProps.mdx) - [FilterableInventoryLevelProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableInventoryLevelProps.mdx) - [FilterableReservationItemProps](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.FilterableReservationItemProps.mdx) +- [IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx) - [UpdateInventoryLevelInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateInventoryLevelInput.mdx) - [UpdateReservationItemInput](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.UpdateReservationItemInput.mdx) + +## Type Aliases + +- [ReserveQuantityContext](../../InventoryTypes/types/internal.internal-1.InventoryTypes.ReserveQuantityContext.mdx) diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.LoggerTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.LoggerTypes.mdx index 2bf5f0f4d6..8617f58c46 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.LoggerTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.LoggerTypes.mdx @@ -5,3 +5,7 @@ displayed_sidebar: jsClientSidebar import ParameterTypes from "@site/src/components/ParameterTypes" # LoggerTypes + +## Interfaces + +- [Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx) diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.ModulesSdkTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.ModulesSdkTypes.mdx index 01852a0723..0434e79060 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.ModulesSdkTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.ModulesSdkTypes.mdx @@ -17,6 +17,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Type Aliases +- [Constructor](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.Constructor.mdx) - [ExternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ExternalModuleDeclaration.mdx) - [InternalModuleDeclaration](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.InternalModuleDeclaration.mdx) - [LinkModuleDefinition](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.LinkModuleDefinition.mdx) @@ -33,3 +34,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [ModuleResolution](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleResolution.mdx) - [ModuleServiceInitializeCustomDataLayerOptions](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions.mdx) - [ModulesResponse](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModulesResponse.mdx) +- [RemoteQueryFunction](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.RemoteQueryFunction.mdx) diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.PricingTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.PricingTypes.mdx index 1105607df7..19db1eea39 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.PricingTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.PricingTypes.mdx @@ -43,6 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [FilterablePriceSetProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx) - [FilterablePriceSetRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx) - [FilterableRuleTypeProps](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx) +- [IPricingModuleService](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.IPricingModuleService.mdx) - [MoneyAmountDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.MoneyAmountDTO.mdx) - [PriceListDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListDTO.mdx) - [PriceListPriceDTO](../../PricingTypes/interfaces/internal.internal-1.PricingTypes.PriceListPriceDTO.mdx) diff --git a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.StockLocationTypes.mdx b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.StockLocationTypes.mdx index a1e8da7c10..433f53a27f 100644 --- a/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.StockLocationTypes.mdx +++ b/www/apps/docs/content/references/js-client/internal-1/modules/internal.internal-1.StockLocationTypes.mdx @@ -9,6 +9,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Interfaces - [FilterableStockLocationProps](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.FilterableStockLocationProps.mdx) +- [IStockLocationService](../../StockLocationTypes/interfaces/internal.internal-1.StockLocationTypes.IStockLocationService.mdx) ## Type Aliases diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractEventBusModuleService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractEventBusModuleService.mdx index 5d1c7abb8a..57b5736cbd 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractEventBusModuleService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.AbstractEventBusModuleService.mdx @@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Implements -- [IEventBusModuleService](../interfaces/internal.IEventBusModuleService.mdx) +- [IEventBusModuleService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusModuleService.mdx) ## Properties @@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" `", + "description": "An optional set of key-value pairs to hold additional information.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.AdminPostProductCategoriesReq.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.AdminPostProductCategoriesReq.mdx index 1a6a8ededa..7a7195b31d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.AdminPostProductCategoriesReq.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.AdminPostProductCategoriesReq.mdx @@ -45,6 +45,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional set of key-value pairs to hold additional information.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx index ab201ccba8..4b0d863dda 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.ProductCategory.mdx @@ -74,6 +74,15 @@ A product category can be used to categorize products into a hierarchy of catego "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx index 000d6f73dd..15ad724358 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/internal.internal.EventBusService.mdx @@ -11,7 +11,7 @@ subscribers when events happen. Events will run asynchronously. ## Implements -- [IEventBusService](../interfaces/internal.IEventBusService.mdx) +- [IEventBusService](../../EventBusTypes/interfaces/internal.internal-1.EventBusTypes.IEventBusService.mdx) ## Properties @@ -45,7 +45,7 @@ subscribers when events happen. Events will run asynchronously. }, { "name": "config_", - "type": "[ConfigModule](../types/internal.ConfigModule.mdx)", + "type": "[ConfigModule](../../CommonTypes/types/internal.internal-1.CommonTypes.ConfigModule.mdx)", "description": "", "optional": false, "defaultValue": "", @@ -63,7 +63,7 @@ subscribers when events happen. Events will run asynchronously. }, { "name": "logger_", - "type": "[Logger](../interfaces/internal.Logger.mdx)", + "type": "[Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx)", "description": "", "optional": false, "defaultValue": "", @@ -135,7 +135,7 @@ ___ diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-10.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-10.mdx index 03adc8898b..cd07198751 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-10.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-10.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "logger", - "type": "[Logger](../interfaces/internal.Logger.mdx)", + "type": "[Logger](../../LoggerTypes/interfaces/internal.internal-1.LoggerTypes.Logger.mdx)", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-18.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-18.mdx index 522c0f5094..5067043fb9 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-18.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-18.mdx @@ -101,7 +101,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "inventoryService", - "type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)", + "type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)", "description": "", "optional": false, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-19.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-19.mdx index 1898062c2c..26b550654f 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-19.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-19.mdx @@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "inventoryService", - "type": "[IInventoryService](../interfaces/internal.IInventoryService.mdx)", + "type": "[IInventoryService](../../InventoryTypes/interfaces/internal.internal-1.InventoryTypes.IInventoryService.mdx)", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-20.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-20.mdx index c947613008..f991381eed 100644 --- a/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-20.mdx +++ b/www/apps/docs/content/references/js-client/internal/types/internal.InjectedDependencies-20.mdx @@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" `", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "parent_category", "type": "[ProductCategory](../classes/internal.ProductCategory.mdx) \\| `null`", diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobArgs.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobArgs.mdx new file mode 100644 index 0000000000..86837d9c46 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobArgs.mdx @@ -0,0 +1,53 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ScheduledJobArgs + +### Type parameters + + + +### Type declaration + +`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobConfig.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobConfig.mdx new file mode 100644 index 0000000000..afafd46657 --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/types/internal.internal.ScheduledJobConfig.mdx @@ -0,0 +1,53 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ScheduledJobConfig + +### Type parameters + + + +### Type declaration + + diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberArgs.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberArgs.mdx new file mode 100644 index 0000000000..23da317c5a --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberArgs.mdx @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SubscriberArgs + +### Type parameters + + + +### Type declaration + +`", + "description": "", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberConfig.mdx b/www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberConfig.mdx new file mode 100644 index 0000000000..0ca7ad2a1f --- /dev/null +++ b/www/apps/docs/content/references/js-client/internal/types/internal.internal.SubscriberConfig.mdx @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SubscriberConfig + +### Type declaration + + diff --git a/www/apps/docs/content/references/js-client/modules/internal.mdx b/www/apps/docs/content/references/js-client/modules/internal.mdx index 3e1f0327fb..72d969e1fb 100644 --- a/www/apps/docs/content/references/js-client/modules/internal.mdx +++ b/www/apps/docs/content/references/js-client/modules/internal.mdx @@ -449,12 +449,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [FilePropertyBag](../internal/interfaces/internal.FilePropertyBag.mdx) - [HTTPResponse](../internal/interfaces/internal.HTTPResponse.mdx) - [HeadersDefaults](../internal/interfaces/internal.HeadersDefaults.mdx) -- [ICacheService](../internal/interfaces/internal.ICacheService.mdx) -- [IEventBusModuleService](../internal/interfaces/internal.IEventBusModuleService.mdx) -- [IEventBusService](../internal/interfaces/internal.IEventBusService.mdx) -- [IInventoryService](../internal/interfaces/internal.IInventoryService.mdx) -- [IPricingModuleService](../internal/interfaces/internal.IPricingModuleService.mdx) -- [IStockLocationService](../internal/interfaces/internal.IStockLocationService.mdx) - [ITransactionBaseService](../internal/interfaces/internal.ITransactionBaseService.mdx) - [IncomingHttpHeaders](../internal/interfaces/internal.IncomingHttpHeaders.mdx) - [IpcSocketConnectOpts](../internal/interfaces/internal.IpcSocketConnectOpts.mdx) @@ -463,7 +457,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [Iterator](../internal/interfaces/internal.Iterator.mdx) - [IteratorReturnResult](../internal/interfaces/internal.IteratorReturnResult.mdx) - [IteratorYieldResult](../internal/interfaces/internal.IteratorYieldResult.mdx) -- [Logger](../internal/interfaces/internal.Logger.mdx) - [LookupAddress](../internal/interfaces/internal.LookupAddress.mdx) - [LookupAllOptions](../internal/interfaces/internal.LookupAllOptions.mdx) - [LookupOptions](../internal/interfaces/internal.LookupOptions.mdx) @@ -509,6 +502,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [StaticEventEmitterOptions](../internal/interfaces/internal.StaticEventEmitterOptions.mdx) - [StreamPipeOptions](../internal/interfaces/internal.StreamPipeOptions.mdx) - [StreamPipeOptions](../internal/interfaces/internal.StreamPipeOptions-1.mdx) +- [SubscriberContext](../internal/interfaces/internal.SubscriberContext.mdx) - [TcpSocketConnectOpts](../internal/interfaces/internal.TcpSocketConnectOpts.mdx) - [TransformOptions](../internal/interfaces/internal.TransformOptions.mdx) - [TransitionalOptions](../internal/interfaces/internal.TransitionalOptions.mdx) @@ -659,8 +653,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [CategoryQueryParams](../internal/types/internal.CategoryQueryParams.mdx) - [ClaimTypeValue](../internal/types/internal.ClaimTypeValue.mdx) - [ComposeFnParam](../internal/types/internal.ComposeFnParam.mdx) -- [ConfigModule](../internal/types/internal.ConfigModule.mdx) -- [Constructor](../internal/types/internal.Constructor.mdx) - [CreateAnalyticsConfig](../internal/types/internal.CreateAnalyticsConfig.mdx) - [CreateClaimInput](../internal/types/internal.CreateClaimInput.mdx) - [CreateClaimItemAdditionalItemInput](../internal/types/internal.CreateClaimItemAdditionalItemInput.mdx) @@ -717,7 +709,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [DiscountConditionInput](../internal/types/internal.DiscountConditionInput.mdx) - [DiscountConditionResourceType](../internal/types/internal.DiscountConditionResourceType.mdx) - [DraftOrderCreateProps](../internal/types/internal.DraftOrderCreateProps.mdx) -- [EmitData](../internal/types/internal.EmitData.mdx) - [EndingType](../internal/types/internal.EndingType.mdx) - [Exclude](../internal/types/internal.Exclude.mdx) - [ExpandScalar](../internal/types/internal.ExpandScalar.mdx) @@ -859,12 +850,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [ReadonlyPrimary](../internal/types/internal.ReadonlyPrimary.mdx) - [Record](../internal/types/internal.Record.mdx) - [RegionDetails](../internal/types/internal.RegionDetails.mdx) -- [RemoteQueryFunction](../internal/types/internal.RemoteQueryFunction.mdx) - [ReorderConditions](../internal/types/internal.ReorderConditions.mdx) - [RequestContext](../internal/types/internal.RequestContext.mdx) - [RequestMethod](../internal/types/internal.RequestMethod.mdx) - [ReservationItemDTO](../internal/types/internal.ReservationItemDTO.mdx) -- [ReserveQuantityContext](../internal/types/internal.ReserveQuantityContext.mdx) - [Response](../internal/types/internal.Response.mdx) - [ResponsePromise](../internal/types/internal.ResponsePromise.mdx) - [ResponseType](../internal/types/internal.ResponseType.mdx) @@ -915,8 +904,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [StoreSwapsRes](../internal/types/internal.StoreSwapsRes.mdx) - [StoreVariantsListRes](../internal/types/internal.StoreVariantsListRes.mdx) - [StoreVariantsRes](../internal/types/internal.StoreVariantsRes.mdx) -- [Subscriber](../internal/types/internal.Subscriber.mdx) -- [SubscriberContext](../internal/types/internal.SubscriberContext.mdx) - [SubtotalOptions](../internal/types/internal.SubtotalOptions.mdx) - [TaxLinesMaps](../internal/types/internal.TaxLinesMaps.mdx) - [TaxRateListByConfig](../internal/types/internal.TaxRateListByConfig.mdx) diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPriceListPrices.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPriceListPrices.mdx new file mode 100644 index 0000000000..7397dd9750 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPriceListPrices.mdx @@ -0,0 +1,315 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/addPriceListPrices +sidebar_label: addPriceListPrices +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# addPriceListPrices - Pricing Module Reference + +This documentation provides a reference to the `addPriceListPrices` method. This belongs to the Pricing Module. + +This method is used to add prices to price lists. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function addPriceListPrices (items: { + priceListId: string, + prices: { + currency_code: string, + amount: number, + price_set_id: string + }[] +}[]) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.addPriceListPrices(items) + + // do something with the price lists or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx index 5f70526128..4d7a705877 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx @@ -22,7 +22,7 @@ This method adds prices to a price set. To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -47,7 +47,7 @@ async function addPricesToPriceSet (priceSetId: string) { To add prices with rules: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -120,7 +120,7 @@ async function addPricesToPriceSet (priceSetId: string) { "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -154,7 +154,7 @@ async function addPricesToPriceSet (priceSetId: string) { }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -163,7 +163,7 @@ async function addPricesToPriceSet (priceSetId: string) { }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -194,7 +194,7 @@ async function addPricesToPriceSet (priceSetId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -221,7 +221,7 @@ async function addPricesToPriceSet (priceSetId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -280,10 +280,10 @@ async function addPricesToPriceSet (priceSetId: string) { { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -321,6 +321,15 @@ async function addPricesToPriceSet (priceSetId: string) { "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] }, @@ -383,7 +392,7 @@ This method adds prices to multiple price sets. To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -408,7 +417,7 @@ async function addPricesToPriceSet (priceSetId: string) { To add prices with rules: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -481,7 +490,7 @@ async function addPricesToPriceSet (priceSetId: string) { "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -515,7 +524,7 @@ async function addPricesToPriceSet (priceSetId: string) { }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -524,7 +533,7 @@ async function addPricesToPriceSet (priceSetId: string) { }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -555,7 +564,7 @@ async function addPricesToPriceSet (priceSetId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -582,7 +591,7 @@ async function addPricesToPriceSet (priceSetId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx index 81e7ae4aec..f040c77975 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx @@ -20,7 +20,7 @@ This method adds rules to a price set. ### Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -60,8 +60,8 @@ async function addRulesToPriceSet (priceSetId: string) { }, { "name": "rules", - "type": "`{ attribute: string }`[]", - "description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ attribute: string }``[]", + "description": "The rules to add to a price set.", "optional": false, "defaultValue": "", "expandable": false, @@ -69,7 +69,7 @@ async function addRulesToPriceSet (priceSetId: string) { { "name": "attribute", "type": "`string`", - "description": "", + "description": "The value of the rule's `rule_attribute` attribute.", "optional": false, "defaultValue": "", "expandable": false, @@ -90,7 +90,7 @@ async function addRulesToPriceSet (priceSetId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -117,7 +117,7 @@ async function addRulesToPriceSet (priceSetId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -176,10 +176,10 @@ async function addRulesToPriceSet (priceSetId: string) { { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -217,6 +217,15 @@ async function addRulesToPriceSet (priceSetId: string) { "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] }, @@ -277,7 +286,7 @@ This method adds rules to multiple price sets. ### Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -317,8 +326,8 @@ async function addRulesToPriceSet (priceSetId: string) { }, { "name": "rules", - "type": "`{ attribute: string }`[]", - "description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ attribute: string }``[]", + "description": "The rules to add to a price set.", "optional": false, "defaultValue": "", "expandable": false, @@ -326,7 +335,7 @@ async function addRulesToPriceSet (priceSetId: string) { { "name": "attribute", "type": "`string`", - "description": "", + "description": "The value of the rule's `rule_attribute` attribute.", "optional": false, "defaultValue": "", "expandable": false, @@ -347,7 +356,7 @@ async function addRulesToPriceSet (priceSetId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -374,7 +383,7 @@ async function addRulesToPriceSet (priceSetId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx index 3b0cba20a5..e774633f5a 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx @@ -20,7 +20,7 @@ This method is used to calculate prices based on the provided filters and contex When you calculate prices, you must at least specify the currency code: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" async function calculatePrice (priceSetId: string, currencyCode: string) { @@ -42,7 +42,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { To calculate prices for specific minimum and/or maximum quantity: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" async function calculatePrice (priceSetId: string, currencyCode: string) { @@ -65,7 +65,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { To calculate prices for custom rule types: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" async function calculatePrice (priceSetId: string, currencyCode: string) { @@ -137,7 +137,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -164,7 +164,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -196,7 +196,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { "children": [ { "name": "amount", - "type": "``null`` \\| `number`", + "type": "`null` \\| `string`", "description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.", "optional": false, "defaultValue": "", @@ -205,7 +205,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { }, { "name": "currency_code", - "type": "``null`` \\| `string`", + "type": "`null` \\| `string`", "description": "The currency code of the calculated price. It can possibly be `null`.", "optional": false, "defaultValue": "", @@ -215,7 +215,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { { "name": "id", "type": "`string`", - "description": "The ID of the price set.", + "description": "The ID of the money amount.", "optional": false, "defaultValue": "", "expandable": false, @@ -223,7 +223,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `string`", "description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.", "optional": false, "defaultValue": "", @@ -232,12 +232,39 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `string`", "description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.", "optional": false, "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_list_id", + "type": "`null` \\| `string`", + "description": "The ID of the associated price list, if any.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_list_type", + "type": "`null` \\| `string`", + "description": "The type of the associated price list, if any.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] } ] } diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx index e41ecc32d9..3c43342821 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx @@ -114,7 +114,7 @@ async function createPriceSet() { "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -148,7 +148,7 @@ async function createPriceSet() { }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -157,7 +157,7 @@ async function createPriceSet() { }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -177,8 +177,8 @@ async function createPriceSet() { }, { "name": "rules", - "type": "`{ rule_attribute: string }`[]", - "description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ rule_attribute: string }``[]", + "description": "The rules to associate with the price set.", "optional": true, "defaultValue": "", "expandable": false, @@ -186,7 +186,7 @@ async function createPriceSet() { { "name": "rule_attribute", "type": "`string`", - "description": "", + "description": "the value of the rule's `rule_attribute` attribute.", "optional": false, "defaultValue": "", "expandable": false, @@ -207,7 +207,7 @@ async function createPriceSet() { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -234,7 +234,7 @@ async function createPriceSet() { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -293,10 +293,10 @@ async function createPriceSet() { { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -334,6 +334,15 @@ async function createPriceSet() { "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] }, @@ -485,7 +494,7 @@ async function createPriceSets() { "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -519,7 +528,7 @@ async function createPriceSets() { }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -528,7 +537,7 @@ async function createPriceSets() { }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -548,8 +557,8 @@ async function createPriceSets() { }, { "name": "rules", - "type": "`{ rule_attribute: string }`[]", - "description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ rule_attribute: string }``[]", + "description": "The rules to associate with the price set.", "optional": true, "defaultValue": "", "expandable": false, @@ -557,7 +566,7 @@ async function createPriceSets() { { "name": "rule_attribute", "type": "`string`", - "description": "", + "description": "the value of the rule's `rule_attribute` attribute.", "optional": false, "defaultValue": "", "expandable": false, @@ -578,7 +587,7 @@ async function createPriceSets() { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -605,7 +614,7 @@ async function createPriceSets() { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx index 615302c0be..e921389619 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx @@ -96,7 +96,7 @@ async function createCurrencies() { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -123,7 +123,7 @@ async function createCurrencies() { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx index 7d05a09766..99002c4236 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx @@ -55,7 +55,7 @@ async function retrieveMoneyAmounts() { "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -126,7 +126,7 @@ async function retrieveMoneyAmounts() { }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -135,7 +135,7 @@ async function retrieveMoneyAmounts() { }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -155,7 +155,7 @@ async function retrieveMoneyAmounts() { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -182,7 +182,7 @@ async function retrieveMoneyAmounts() { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -232,10 +232,10 @@ async function retrieveMoneyAmounts() { { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -273,6 +273,15 @@ async function retrieveMoneyAmounts() { "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] } diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceListRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceListRules.mdx new file mode 100644 index 0000000000..ca5d29593c --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceListRules.mdx @@ -0,0 +1,211 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/createPriceListRules +sidebar_label: createPriceListRules +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# createPriceListRules - Pricing Module Reference + +This documentation provides a reference to the `createPriceListRules` method. This belongs to the Pricing Module. + +This method is used to create price list rules. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function createPriceListRules (items: { + rule_type_id: string + price_list_id: string +}[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.createPriceListRules(items) + + // do something with the price list rule or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceLists.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceLists.mdx new file mode 100644 index 0000000000..851fa1b80b --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceLists.mdx @@ -0,0 +1,414 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/createPriceLists +sidebar_label: createPriceLists +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# createPriceLists - Pricing Module Reference + +This documentation provides a reference to the `createPriceLists` method. This belongs to the Pricing Module. + +This method is used to create price lists. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function createPriceList (items: { + title: string + description: string + starts_at?: string + ends_at?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.createPriceLists(items) + + // do something with the price lists or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx index 53381dbd30..9848ced730 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx @@ -18,16 +18,16 @@ This method is used to create new price rules based on the provided data. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" async function createPriceRules ( id: string, - priceSetId: string, - ruleTypeId: string, - value: string, - priceSetMoneyAmountId: string, + priceSetId: string, + ruleTypeId: string, + value: string, + priceSetMoneyAmountId: string, priceListId: string ) { const pricingService = await initializePricingModule() @@ -67,15 +67,6 @@ async function createPriceRules ( "expandable": false, "children": [] }, - { - "name": "price_list_id", - "type": "`string`", - "description": "The ID of the associated price list.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "price_set_id", "type": "`string`", @@ -88,7 +79,7 @@ async function createPriceRules ( { "name": "price_set_money_amount_id", "type": "`string`", - "description": "The ID of the associated price set money amount.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -97,7 +88,7 @@ async function createPriceRules ( { "name": "priority", "type": "`number`", - "description": "The priority of the price rule in comparison to other applicable price rules.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -134,7 +125,7 @@ async function createPriceRules ( { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -161,7 +152,7 @@ async function createPriceRules ( { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -220,10 +211,10 @@ async function createPriceRules ( { "name": "price_set", "type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -256,10 +247,10 @@ async function createPriceRules ( { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx index df304c3661..f5fb93c14b 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx @@ -19,7 +19,7 @@ a rule type. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -89,7 +89,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -116,7 +116,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -166,19 +166,19 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru { "name": "price_set_money_amount", "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", - "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "description": "The associated price set money amount.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx index 8c5cec522f..d2cba36a6e 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx @@ -94,7 +94,7 @@ async function createRuleTypes() { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -121,7 +121,7 @@ async function createRuleTypes() { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx index 4ee8f16060..937b80e7a0 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx @@ -18,7 +18,7 @@ This method deletes price sets by their IDs. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -52,7 +52,7 @@ async function removePriceSetRule (priceSetIds: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function removePriceSetRule (priceSetIds: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx index 8cea1e260c..ab92bb9a37 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx @@ -50,7 +50,7 @@ async function deleteCurrencies() { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -77,7 +77,7 @@ async function deleteCurrencies() { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx index 178aa1c4ed..afc8dc0baa 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx @@ -18,7 +18,7 @@ This method deletes money amounts by their IDs. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -54,7 +54,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -81,7 +81,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceListRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceListRules.mdx new file mode 100644 index 0000000000..27670f942a --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceListRules.mdx @@ -0,0 +1,113 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/deletePriceListRules +sidebar_label: deletePriceListRules +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# deletePriceListRules - Pricing Module Reference + +This documentation provides a reference to the `deletePriceListRules` method. This belongs to the Pricing Module. + +This method is used to delete price list rules. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function deletePriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + await pricingService.deletePriceListRules(priceListRuleIds) +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceLists.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceLists.mdx new file mode 100644 index 0000000000..79ea824399 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceLists.mdx @@ -0,0 +1,113 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/deletePriceLists +sidebar_label: deletePriceLists +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# deletePriceLists - Pricing Module Reference + +This documentation provides a reference to the `deletePriceLists` method. This belongs to the Pricing Module. + +This method is used to delete price lists. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function deletePriceLists (ids: string[]) { + const pricingService = await initializePricingModule() + + await pricingService.deletePriceLists(ids) +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx index 7f8d3a7242..04d37364bf 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx @@ -18,7 +18,7 @@ This method is used to delete price rules based on the specified IDs. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -54,7 +54,7 @@ async function deletePriceRules ( { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -81,7 +81,7 @@ async function deletePriceRules ( { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx index 7dc61ee12b..8cf73e39b3 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx @@ -18,7 +18,7 @@ This method is used to delete price set money amount rules based on the specifie ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -52,7 +52,7 @@ async function deletePriceSetMoneyAmountRule (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function deletePriceSetMoneyAmountRule (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx index 7ad9169eb0..268b5d3502 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx @@ -18,7 +18,7 @@ This method is used to delete rule types based on the provided IDs. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -52,7 +52,7 @@ async function deleteRuleTypes (ruleTypeId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -79,7 +79,7 @@ async function deleteRuleTypes (ruleTypeId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx index e583226e75..d667b9af0c 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price sets based on optional To retrieve a list of price sets using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrievePriceSets (priceSetIds: string[]) { To specify relations that should be retrieved within the price sets: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -63,7 +63,7 @@ async function retrievePriceSets (priceSetIds: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -88,10 +88,10 @@ async function retrievePriceSets (priceSetIds: string[], skip: number, take: num You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" - + async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[], skip: number, take: number) { const pricingService = await initializePricingModule() @@ -290,7 +290,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -317,7 +317,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx index a089d89daf..cc6aa1cac6 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price sets along with the to To retrieve a list of prices sets using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrievePriceSets (priceSetIds: string[]) { To specify relations that should be retrieved within the price sets: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -63,7 +63,7 @@ async function retrievePriceSets (priceSetIds: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -88,10 +88,10 @@ async function retrievePriceSets (priceSetIds: string[], skip: number, take: num You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" - + async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[], skip: number, take: number) { const pricingService = await initializePricingModule() @@ -290,7 +290,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -317,7 +317,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx index bcb1e5535c..c74b05d674 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of currencies along with the to To retrieve a list of currencies using their codes: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrieveCurrencies (codes: string[]) { To specify attributes that should be retrieved within the money amounts: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -63,7 +63,7 @@ async function retrieveCurrencies (codes: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -210,7 +210,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -237,7 +237,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx index 34658f0b49..87267398a7 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of money amounts along with the To retrieve a list of money amounts using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[]) { To specify relations that should be retrieved within the money amounts: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -63,7 +63,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -88,7 +88,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], skip: number, tak You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -251,7 +251,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -278,7 +278,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceListRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceListRules.mdx new file mode 100644 index 0000000000..e304a3ea7f --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceListRules.mdx @@ -0,0 +1,349 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/listAndCountPriceListRules +sidebar_label: listAndCountPriceListRules +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# listAndCountPriceListRules - Pricing Module Reference + +This documentation provides a reference to the `listAndCountPriceListRules` method. This belongs to the Pricing Module. + +This method is used to retrieve a paginated list of price list ruless along with the total count of available price list ruless satisfying the provided filters. + +## Example + +To retrieve a list of price list vs using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + ) + + // do something with the price list rules or return them +} +``` + +To specify relations that should be retrieved within the price list rules: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"] + } + ) + + // do something with the price list rules or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listAndCountPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceListRules, count] = await pricingService.listAndCountPriceListRules( + { + $and: [ + { + id: priceListRuleIds + }, + { + rule_types: ruleTypeIDs + } + ] + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceLists.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceLists.mdx new file mode 100644 index 0000000000..479ed13b43 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceLists.mdx @@ -0,0 +1,377 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/listAndCountPriceLists +sidebar_label: listAndCountPriceLists +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# listAndCountPriceLists - Pricing Module Reference + +This documentation provides a reference to the `listAndCountPriceLists` method. This belongs to the Pricing Module. + +This method is used to retrieve a paginated list of price lists along with the total count of available price lists satisfying the provided filters. + +## Example + +To retrieve a list of price lists using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + ) + + // do something with the price lists or return them +} +``` + +To specify relations that should be retrieved within the price lists: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price lists or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const [priceLists, count] = await pricingService.listPriceLists( + { + $and: [ + { + id: priceListIds + }, + { + title: titles + } + ] + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx index 0bc85eba85..cdac760bb1 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price rules along with the t To retrieve a list of price rules using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -38,7 +38,7 @@ async function retrievePriceRules (id: string) { To specify relations that should be retrieved within the price rules: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -58,7 +58,7 @@ async function retrievePriceRules (id: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -80,7 +80,7 @@ async function retrievePriceRules (id: string, skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -258,7 +258,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -285,7 +285,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx index c566a84bc6..c9d3b29f30 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" This documentation provides a reference to the `listAndCountPriceSetMoneyAmountRules` method. This belongs to the Pricing Module. -This method is used to retrieve a paginated list of price set money amount rules along with the total count of +This method is used to retrieve a paginated list of price set money amount rules along with the total count of available price set money amount rules satisfying the provided filters. ## Example @@ -21,7 +21,7 @@ available price set money amount rules satisfying the provided filters. To retrieve a list of price set money amounts using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -39,7 +39,7 @@ async function retrievePriceSetMoneyAmountRules (id: string) { To specify relations that should be retrieved within the price set money amount rules: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -59,7 +59,7 @@ async function retrievePriceSetMoneyAmountRules (id: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -81,7 +81,7 @@ async function retrievePriceSetMoneyAmountRules (id: string, skip: number, take: You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -259,7 +259,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -286,7 +286,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx index c662b58b0b..cde4d7475e 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx @@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" This documentation provides a reference to the `listAndCountPriceSetMoneyAmounts` method. This belongs to the Pricing Module. -This method is used to retrieve a paginated list of price set money amounts along with the total count of +This method is used to retrieve a paginated list of price set money amounts along with the total count of available price set money amounts satisfying the provided filters. ## Example @@ -21,7 +21,7 @@ available price set money amounts satisfying the provided filters. To retrieve a list of price set money amounts using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -39,7 +39,7 @@ async function retrievePriceSetMoneyAmounts (id: string) { To specify relations that should be retrieved within the price set money amounts: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -59,7 +59,7 @@ async function retrievePriceSetMoneyAmounts (id: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -81,7 +81,7 @@ async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: num You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -145,6 +145,15 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk "expandable": false, "children": [] }, + { + "name": "price_list_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount's associated price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "price_set_id", "type": "`string`[]", @@ -241,7 +250,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -268,7 +277,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx index 6f7e0a8625..3bfc445d7b 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of rule types along with the to To retrieve a list of rule types using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrieveRuleTypes (ruleTypeId: string) { To specify attributes that should be retrieved within the rule types: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -62,7 +62,7 @@ async function retrieveRuleTypes (ruleTypeId: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -86,7 +86,7 @@ async function retrieveRuleTypes (ruleTypeId: string, skip: number, take: number You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -255,7 +255,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -282,7 +282,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx index c8cea5e729..732709cfdc 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of currencies based on optional To retrieve a list of currencies using their codes: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrieveCurrencies (codes: string[]) { To specify attributes that should be retrieved within the money amounts: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -63,7 +63,7 @@ async function retrieveCurrencies (codes: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -210,7 +210,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -237,7 +237,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx index 562263721b..4381dbc7f0 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of money amounts based on optio To retrieve a list of money amounts using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[]) { To specify relations that should be retrieved within the money amounts: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -63,7 +63,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[]) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -88,7 +88,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], skip: number, tak You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -251,7 +251,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -278,7 +278,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -328,10 +328,10 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -369,6 +369,15 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] } diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceListRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceListRules.mdx new file mode 100644 index 0000000000..4be8642bd7 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceListRules.mdx @@ -0,0 +1,386 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/listPriceListRules +sidebar_label: listPriceListRules +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# listPriceListRules - Pricing Module Reference + +This documentation provides a reference to the `listPriceListRules` method. This belongs to the Pricing Module. + +This method is used to retrieve a paginated list of price list rules based on optional filters and configuration. + +## Example + +To retrieve a list of price list vs using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + ) + + // do something with the price list rules or return them +} +``` + +To specify relations that should be retrieved within the price list rules: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"] + } + ) + + // do something with the price list rules or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + id: priceListRuleIds + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceListRules (priceListRuleIds: string[], ruleTypeIDs: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.listPriceListRules( + { + $and: [ + { + id: priceListRuleIds + }, + { + rule_types: ruleTypeIDs + } + ] + }, + { + relations: ["price_list_rule_values"], + skip, + take + } + ) + + // do something with the price list rules or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceLists.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceLists.mdx new file mode 100644 index 0000000000..9b42a2e79a --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceLists.mdx @@ -0,0 +1,468 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/listPriceLists +sidebar_label: listPriceLists +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# listPriceLists - Pricing Module Reference + +This documentation provides a reference to the `listPriceLists` method. This belongs to the Pricing Module. + +This method is used to retrieve a paginated list of price lists based on optional filters and configuration. + +## Example + +To retrieve a list of price lists using their IDs: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + ) + + // do something with the price lists or return them +} +``` + +To specify relations that should be retrieved within the price lists: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[]) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price lists or return them +} +``` + +By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + id: priceListIds + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function listPriceLists (priceListIds: string[], titles: string[], skip: number, take: number) { + const pricingService = await initializePricingModule() + + const priceLists = await pricingService.listPriceLists( + { + $and: [ + { + id: priceListIds + }, + { + title: titles + } + ] + }, + { + relations: ["price_set_money_amounts"], + skip, + take + } + ) + + // do something with the price lists or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx index 4ab9e2a533..9c79f73316 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price rules based on optiona To retrieve a list of price rules using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -38,7 +38,7 @@ async function retrievePriceRules (id: string) { To specify relations that should be retrieved within the price rules: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -58,7 +58,7 @@ async function retrievePriceRules (id: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -80,7 +80,7 @@ async function retrievePriceRules (id: string, skip: number, take: number) { You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -258,7 +258,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -285,7 +285,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -344,10 +344,10 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, { "name": "price_set", "type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -380,10 +380,10 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx index bd1d5969b9..2c8554c19e 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price set money amount rules To retrieve a list of price set money amount rules using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -38,7 +38,7 @@ async function retrievePriceSetMoneyAmountRules (id: string) { To specify relations that should be retrieved within the price set money amount rules: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -58,7 +58,7 @@ async function retrievePriceSetMoneyAmountRules (id: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -80,7 +80,7 @@ async function retrievePriceSetMoneyAmountRules (id: string, skip: number, take: You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -258,7 +258,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -285,7 +285,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -335,19 +335,19 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri { "name": "price_set_money_amount", "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", - "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "description": "The associated price set money amount.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx index 166489f7ee..77d26cce23 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of price set money amounts base To retrieve a list of price set money amounts using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -38,7 +38,7 @@ async function retrievePriceSetMoneyAmounts (id: string) { To specify relations that should be retrieved within the price set money amounts: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -58,7 +58,7 @@ async function retrievePriceSetMoneyAmounts (id: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -80,7 +80,7 @@ async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: num You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -144,6 +144,15 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk "expandable": false, "children": [] }, + { + "name": "price_list_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount's associated price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "price_set_id", "type": "`string`[]", @@ -240,7 +249,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -267,7 +276,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -317,34 +326,43 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk { "name": "money_amount", "type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)", - "description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.", + "description": "The money amount associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](../../interfaces/PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, "children": [] }, { "name": "price_rules", "type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]", - "description": "", + "description": "The price rules associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set", "type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)", - "description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.", + "description": "The price set associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set_id", "type": "`string`", - "description": "", + "description": "The ID of the associated price set.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx index 4810a723ef..355e0615fc 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a paginated list of rule types based on optional To retrieve a list of rule types using their IDs: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -40,7 +40,7 @@ async function retrieveRuleTypes (ruleTypeId: string) { To specify attributes that should be retrieved within the rule types: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -62,7 +62,7 @@ async function retrieveRuleTypes (ruleTypeId: string) { By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -86,7 +86,7 @@ async function retrieveRuleTypes (ruleTypeId: string, skip: number, take: number You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -255,7 +255,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -282,7 +282,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removePriceListRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removePriceListRules.mdx new file mode 100644 index 0000000000..399da1567a --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removePriceListRules.mdx @@ -0,0 +1,513 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/removePriceListRules +sidebar_label: removePriceListRules +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# removePriceListRules - Pricing Module Reference + +This documentation provides a reference to the `removePriceListRules` method. This belongs to the Pricing Module. + +This method is used to remove rules from a price list. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function setPriceListRules (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.removePriceListRules({ + priceListId, + rules: ["region_id"] + }) + + // do something with the price list or return it +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx index 3ca9d6e5ec..6bc1453ac7 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx @@ -18,7 +18,7 @@ This method remove rules from a price set. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -76,7 +76,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -103,7 +103,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx index 898a686f76..627a8fbda5 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx @@ -13,14 +13,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" This documentation provides a reference to the `retrieve` method. This belongs to the Pricing Module. -This method is used to retrieves a price set by its ID. +This method is used to retrieve a price set by its ID. ## Example A simple example that retrieves a price set by its ID: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -38,7 +38,7 @@ async function retrievePriceSet (priceSetId: string) { To specify relations that should be retrieved: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -153,7 +153,7 @@ async function retrievePriceSet (priceSetId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -180,7 +180,7 @@ async function retrievePriceSet (priceSetId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -239,10 +239,10 @@ async function retrievePriceSet (priceSetId: string) { { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -280,6 +280,15 @@ async function retrievePriceSet (priceSetId: string) { "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] }, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx index 7357f8153b..9dfb2836f1 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx @@ -20,7 +20,7 @@ This method retrieves a currency by its code and and optionally based on the pro A simple example that retrieves a currency by its code: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -38,7 +38,7 @@ async function retrieveCurrency (code: string) { To specify attributes that should be retrieved: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -153,7 +153,7 @@ async function retrieveCurrency (code: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -180,7 +180,7 @@ async function retrieveCurrency (code: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx index 38f28eee07..b573a9f93e 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx @@ -20,7 +20,7 @@ This method retrieves a money amount by its ID. To retrieve a money amount by its ID: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -38,7 +38,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) { To retrieve relations along with the money amount: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -153,7 +153,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -180,7 +180,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -222,10 +222,10 @@ async function retrieveMoneyAmount (moneyAmountId: string) { { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "code", @@ -300,6 +300,79 @@ async function retrieveMoneyAmount (moneyAmountId: string) { "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of a price set money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amount", + "type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)", + "description": "The money amount associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](../../interfaces/PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_rules", + "type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]", + "description": "The price rules associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set", + "type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)", + "description": "The price set associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The title of the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] } ] } diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceList.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceList.mdx new file mode 100644 index 0000000000..6e31cdb68a --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceList.mdx @@ -0,0 +1,590 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/retrievePriceList +sidebar_label: retrievePriceList +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# retrievePriceList - Pricing Module Reference + +This documentation provides a reference to the `retrievePriceList` method. This belongs to the Pricing Module. + +This method is used to retrieve a price list by its ID. + +## Example + +A simple example that retrieves a price list by its ID: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceList (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.retrievePriceList( + priceListId + ) + + // do something with the price list or return it +} +``` + +To specify relations that should be retrieved: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceList (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.retrievePriceList( + priceListId, + { + relations: ["price_set_money_amounts"] + } + ) + + // do something with the price list or return it +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceListRule.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceListRule.mdx new file mode 100644 index 0000000000..5b34d3d536 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceListRule.mdx @@ -0,0 +1,425 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/retrievePriceListRule +sidebar_label: retrievePriceListRule +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# retrievePriceListRule - Pricing Module Reference + +This documentation provides a reference to the `retrievePriceListRule` method. This belongs to the Pricing Module. + +This method is used to retrieve a price list rule by its ID. + +## Example + +A simple example that retrieves a price list rule by its ID: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceListRule (priceListRuleId: string) { + const pricingService = await initializePricingModule() + + const priceListRule = await pricingService.retrievePriceListRule( + priceListRuleId + ) + + // do something with the price list rule or return it +} +``` + +To specify relations that should be retrieved: + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function retrievePriceListRule (priceListRuleId: string) { + const pricingService = await initializePricingModule() + + const priceListRule = await pricingService.retrievePriceListRule( + priceListRuleId, + { + relations: ["price_list"] + } + ) + + // do something with the price list rule or return it +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx index a63746bb5b..ca9e923a85 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a price rule by its ID. A simple example that retrieves a price rule by its ID: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -36,7 +36,7 @@ async function retrievePriceRule (id: string) { To specify relations that should be retrieved: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -148,7 +148,7 @@ async function retrievePriceRule (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrievePriceRule (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -226,10 +226,10 @@ async function retrievePriceRule (id: string) { { "name": "price_set", "type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -290,10 +290,10 @@ async function retrievePriceRule (id: string) { { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "default_priority", diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx index 88f7bba861..831972d31f 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx @@ -20,7 +20,7 @@ This method is used to a price set money amount rule by its ID based on the prov A simple example that retrieves a price set money amount rule by its ID: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -36,7 +36,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) { To specify relations that should be retrieved: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -148,7 +148,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -217,10 +217,10 @@ async function retrievePriceSetMoneyAmountRule (id: string) { { "name": "price_set_money_amount", "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", - "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "description": "The associated price set money amount.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -234,34 +234,43 @@ async function retrievePriceSetMoneyAmountRule (id: string) { { "name": "money_amount", "type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)", - "description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.", + "description": "The money amount associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](../../interfaces/PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, "children": [] }, { "name": "price_rules", "type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]", - "description": "", + "description": "The price rules associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set", "type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)", - "description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.", + "description": "The price set associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "price_set_id", "type": "`string`", - "description": "", + "description": "The ID of the associated price set.", "optional": true, "defaultValue": "", "expandable": false, @@ -281,10 +290,10 @@ async function retrievePriceSetMoneyAmountRule (id: string) { { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "default_priority", diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx index ee4869e1a4..68e975f585 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx @@ -20,7 +20,7 @@ This method is used to retrieve a rule type by its ID and and optionally based o A simple example that retrieves a rule type by its code: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -36,7 +36,7 @@ async function retrieveRuleType (ruleTypeId: string) { To specify attributes that should be retrieved: ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -148,7 +148,7 @@ async function retrieveRuleType (ruleTypeId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -175,7 +175,7 @@ async function retrieveRuleType (ruleTypeId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.setPriceListRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.setPriceListRules.mdx new file mode 100644 index 0000000000..3da757f2a9 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.setPriceListRules.mdx @@ -0,0 +1,515 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/setPriceListRules +sidebar_label: setPriceListRules +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# setPriceListRules - Pricing Module Reference + +This documentation provides a reference to the `setPriceListRules` method. This belongs to the Pricing Module. + +This method is used to set the rules of a price list. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function setPriceListRules (priceListId: string) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.setPriceListRules({ + priceListId, + rules: { + region_id: "US" + } + }) + + // do something with the price list or return it +} +``` + +## Parameters + +`", + "description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value is the value(s) of the rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[Context](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "A boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "isolationLevel", + "type": "`string`", + "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "A string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + } +]} /> + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx index f3fe8d9c0a..4fdfeb1753 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx @@ -94,7 +94,7 @@ async function updateCurrencies() { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -121,7 +121,7 @@ async function updateCurrencies() { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx index 1a6c3aa143..3a3181f0a3 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx @@ -18,7 +18,7 @@ This method updates existing money amounts. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -27,7 +27,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { const moneyAmounts = await pricingService.updateMoneyAmounts([ { - id: moneyAmountId, + id: moneyAmountId, amount } ]) @@ -105,7 +105,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -132,7 +132,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -182,10 +182,10 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { { "name": "currency", "type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -223,6 +223,15 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] } diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceListRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceListRules.mdx new file mode 100644 index 0000000000..ad2b8f5b31 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceListRules.mdx @@ -0,0 +1,221 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/updatePriceListRules +sidebar_label: updatePriceListRules +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# updatePriceListRules - Pricing Module Reference + +This documentation provides a reference to the `updatePriceListRules` method. This belongs to the Pricing Module. + +This method is used to update price list rules. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function updatePriceListRules (items: { + id: string + rule_type_id?: string + price_list_id?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceListRules = await pricingService.updatePriceListRules(items) + + // do something with the price list rule or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceLists.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceLists.mdx new file mode 100644 index 0000000000..84076d9db9 --- /dev/null +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceLists.mdx @@ -0,0 +1,314 @@ +--- +displayed_sidebar: pricingReference +badge: + variant: orange + text: Beta +slug: /references/pricing/updatePriceLists +sidebar_label: updatePriceLists +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# updatePriceLists - Pricing Module Reference + +This documentation provides a reference to the `updatePriceLists` method. This belongs to the Pricing Module. + +This method is used to update price lists. + +## Example + +```ts +import { + initialize as initializePricingModule, +} from "@medusajs/pricing" + +async function updatePriceLists (items: { + id: string + title: string + description: string + starts_at?: string + ends_at?: string +}[]) { + const pricingService = await initializePricingModule() + + const priceList = await pricingService.updatePriceLists(items) + + // do something with the price lists or return them +} +``` + +## Parameters + + + +## Returns + + diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx index 1e5fefb3ee..c421a81789 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx @@ -18,13 +18,13 @@ This method is used to update price rules, each with their provided data. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" async function updatePriceRules ( id: string, - priceSetId: string, + priceSetId: string, ) { const pricingService = await initializePricingModule() @@ -53,7 +53,7 @@ async function updatePriceRules ( { "name": "id", "type": "`string`", - "description": "The ID of the price rule to update.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -71,7 +71,7 @@ async function updatePriceRules ( { "name": "price_set_id", "type": "`string`", - "description": "The ID of the associated price set.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -98,7 +98,7 @@ async function updatePriceRules ( { "name": "rule_type_id", "type": "`string`", - "description": "The ID of the associated rule type.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -126,7 +126,7 @@ async function updatePriceRules ( { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -153,7 +153,7 @@ async function updatePriceRules ( { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -212,10 +212,10 @@ async function updatePriceRules ( { "name": "price_set", "type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -248,10 +248,10 @@ async function updatePriceRules ( { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx index 6f2e07dc8b..29f8f247e6 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx @@ -18,7 +18,7 @@ This method is used to update price set money amount rules, each with their prov ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -96,7 +96,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -123,7 +123,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, @@ -173,19 +173,19 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) { { "name": "price_set_money_amount", "type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)", - "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "description": "The associated price set money amount.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { "name": "rule_type", "type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx index a2a665fd61..22a02a2b78 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx @@ -18,7 +18,7 @@ This method is used to update existing rule types with the provided data. ## Example ```ts -import { +import { initialize as initializePricingModule, } from "@medusajs/pricing" @@ -96,7 +96,7 @@ async function updateRuleTypes (ruleTypeId: string) { { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -123,7 +123,7 @@ async function updateRuleTypes (ruleTypeId: string) { { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/enums/PriceListStatus.mdx b/www/apps/docs/content/references/pricing/enums/PriceListStatus.mdx new file mode 100644 index 0000000000..4114a7d4f6 --- /dev/null +++ b/www/apps/docs/content/references/pricing/enums/PriceListStatus.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListStatus + +The price list's status. + +## Enumeration Members + +### ACTIVE + + **ACTIVE** = `"active"` + +The price list is enabled and its prices can be used. + +___ + +### DRAFT + + **DRAFT** = `"draft"` + +The price list is disabled, meaning its prices can't be used yet. diff --git a/www/apps/docs/content/references/pricing/enums/PriceListType.mdx b/www/apps/docs/content/references/pricing/enums/PriceListType.mdx new file mode 100644 index 0000000000..2f46797a8a --- /dev/null +++ b/www/apps/docs/content/references/pricing/enums/PriceListType.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListType + +The price list's type. + +## Enumeration Members + +### OVERRIDE + + **OVERRIDE** = `"override"` + +The price list's prices override original prices. This affects the calculated price of associated price sets. + +___ + +### SALE + + **SALE** = `"sale"` + +The price list's prices are used for a sale. diff --git a/www/apps/docs/content/references/pricing/index.md b/www/apps/docs/content/references/pricing/index.md index b26a8bdae3..e650998859 100644 --- a/www/apps/docs/content/references/pricing/index.md +++ b/www/apps/docs/content/references/pricing/index.md @@ -6,8 +6,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Pricing Module Reference Reference +## Enumerations + +- [PriceListStatus](enums/PriceListStatus.mdx) +- [PriceListType](enums/PriceListType.mdx) + ## Interfaces +- [AddPriceListPricesDTO](interfaces/AddPriceListPricesDTO.mdx) - [AddPricesDTO](interfaces/AddPricesDTO.mdx) - [AddRulesDTO](interfaces/AddRulesDTO.mdx) - [BaseFilterable](interfaces/BaseFilterable.mdx) @@ -15,6 +21,9 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [Context](interfaces/Context.mdx) - [CreateCurrencyDTO](interfaces/CreateCurrencyDTO.mdx) - [CreateMoneyAmountDTO](interfaces/CreateMoneyAmountDTO.mdx) +- [CreatePriceListDTO](interfaces/CreatePriceListDTO.mdx) +- [CreatePriceListRuleDTO](interfaces/CreatePriceListRuleDTO.mdx) +- [CreatePriceListRules](interfaces/CreatePriceListRules.mdx) - [CreatePriceRuleDTO](interfaces/CreatePriceRuleDTO.mdx) - [CreatePriceSetDTO](interfaces/CreatePriceSetDTO.mdx) - [CreatePriceSetMoneyAmountRulesDTO](interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx) @@ -23,6 +32,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [CurrencyDTO](interfaces/CurrencyDTO.mdx) - [FilterableCurrencyProps](interfaces/FilterableCurrencyProps.mdx) - [FilterableMoneyAmountProps](interfaces/FilterableMoneyAmountProps.mdx) +- [FilterablePriceListProps](interfaces/FilterablePriceListProps.mdx) +- [FilterablePriceListRuleProps](interfaces/FilterablePriceListRuleProps.mdx) - [FilterablePriceRuleProps](interfaces/FilterablePriceRuleProps.mdx) - [FilterablePriceSetMoneyAmountProps](interfaces/FilterablePriceSetMoneyAmountProps.mdx) - [FilterablePriceSetMoneyAmountRulesProps](interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) @@ -33,16 +44,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes" - [JoinerServiceConfig](interfaces/JoinerServiceConfig.mdx) - [JoinerServiceConfigAlias](interfaces/JoinerServiceConfigAlias.mdx) - [MoneyAmountDTO](interfaces/MoneyAmountDTO.mdx) +- [PriceListDTO](interfaces/PriceListDTO.mdx) +- [PriceListPriceDTO](interfaces/PriceListPriceDTO.mdx) +- [PriceListRuleDTO](interfaces/PriceListRuleDTO.mdx) +- [PriceListRuleValueDTO](interfaces/PriceListRuleValueDTO.mdx) - [PriceRuleDTO](interfaces/PriceRuleDTO.mdx) - [PriceSetDTO](interfaces/PriceSetDTO.mdx) - [PriceSetMoneyAmountDTO](interfaces/PriceSetMoneyAmountDTO.mdx) - [PriceSetMoneyAmountRulesDTO](interfaces/PriceSetMoneyAmountRulesDTO.mdx) - [PricingContext](interfaces/PricingContext.mdx) - [PricingFilters](interfaces/PricingFilters.mdx) +- [RemovePriceListRulesDTO](interfaces/RemovePriceListRulesDTO.mdx) - [RemovePriceSetRulesDTO](interfaces/RemovePriceSetRulesDTO.mdx) - [RuleTypeDTO](interfaces/RuleTypeDTO.mdx) +- [SetPriceListRulesDTO](interfaces/SetPriceListRulesDTO.mdx) - [UpdateCurrencyDTO](interfaces/UpdateCurrencyDTO.mdx) - [UpdateMoneyAmountDTO](interfaces/UpdateMoneyAmountDTO.mdx) +- [UpdatePriceListDTO](interfaces/UpdatePriceListDTO.mdx) +- [UpdatePriceListRuleDTO](interfaces/UpdatePriceListRuleDTO.mdx) - [UpdatePriceRuleDTO](interfaces/UpdatePriceRuleDTO.mdx) - [UpdatePriceSetDTO](interfaces/UpdatePriceSetDTO.mdx) - [UpdatePriceSetMoneyAmountRulesDTO](interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx) diff --git a/www/apps/docs/content/references/pricing/interfaces/AddPriceListPricesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/AddPriceListPricesDTO.mdx new file mode 100644 index 0000000000..abbc6a102e --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/AddPriceListPricesDTO.mdx @@ -0,0 +1,133 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AddPriceListPricesDTO + +The prices to be added to a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx index 12b13beac4..810e783406 100644 --- a/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx @@ -32,7 +32,7 @@ The prices to add to a price set. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -103,7 +103,7 @@ The prices to add to a price set. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -112,7 +112,7 @@ The prices to add to a price set. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx index 87b76b8038..3ca620c7b0 100644 --- a/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx @@ -22,8 +22,8 @@ The rules to add to a price set. }, { "name": "rules", - "type": "`{ attribute: string }`[]", - "description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ attribute: string }``[]", + "description": "The rules to add to a price set.", "optional": false, "defaultValue": "", "expandable": false, @@ -31,7 +31,7 @@ The rules to add to a price set. { "name": "attribute", "type": "`string`", - "description": "", + "description": "The value of the rule's `rule_attribute` attribute.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx index 12bbe7ccb2..c9dd954d50 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx @@ -13,7 +13,7 @@ A calculated price set's data. diff --git a/www/apps/docs/content/references/pricing/interfaces/Context.mdx b/www/apps/docs/content/references/pricing/interfaces/Context.mdx index d117cd062f..9d1e2de191 100644 --- a/www/apps/docs/content/references/pricing/interfaces/Context.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/Context.mdx @@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Context -The interface tag is used to ensure that the type is documented similar to interfaces. - A shared context object that is used to share resources between the application and the module. ## Type parameters @@ -30,7 +28,7 @@ A shared context object that is used to share resources between the application { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -57,7 +55,7 @@ A shared context object that is used to share resources between the application { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx index eb01ff6669..0157c8d9e9 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx @@ -15,7 +15,7 @@ The money amount to create. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -86,7 +86,7 @@ The money amount to create. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -95,7 +95,7 @@ The money amount to create. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceListDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListDTO.mdx new file mode 100644 index 0000000000..76248d4c04 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListDTO.mdx @@ -0,0 +1,234 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListDTO + +The price list to create. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRuleDTO.mdx new file mode 100644 index 0000000000..af66561298 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRuleDTO.mdx @@ -0,0 +1,50 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRuleDTO + +The price list rule to create. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx new file mode 100644 index 0000000000..3bf7d28d57 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx @@ -0,0 +1,10 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CreatePriceListRules + +The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value + * is the values of the rule. diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx index 5afea2d57b..fc4b183603 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx @@ -20,15 +20,6 @@ A price rule to create. "expandable": false, "children": [] }, - { - "name": "price_list_id", - "type": "`string`", - "description": "The ID of the associated price list.", - "optional": false, - "defaultValue": "", - "expandable": false, - "children": [] - }, { "name": "price_set_id", "type": "`string`", @@ -41,7 +32,7 @@ A price rule to create. { "name": "price_set_money_amount_id", "type": "`string`", - "description": "The ID of the associated price set money amount.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -50,7 +41,7 @@ A price rule to create. { "name": "priority", "type": "`number`", - "description": "The priority of the price rule in comparison to other applicable price rules.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx index 4d4222e37c..4d56b368bc 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx @@ -23,7 +23,7 @@ A price set to create. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -94,7 +94,7 @@ A price set to create. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -103,7 +103,7 @@ A price set to create. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -123,8 +123,8 @@ A price set to create. }, { "name": "rules", - "type": "`{ rule_attribute: string }`[]", - "description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.", + "type": "``{ rule_attribute: string }``[]", + "description": "The rules to associate with the price set.", "optional": true, "defaultValue": "", "expandable": false, @@ -132,7 +132,7 @@ A price set to create. { "name": "rule_attribute", "type": "`string`", - "description": "", + "description": "the value of the rule's `rule_attribute` attribute.", "optional": false, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx index 8f7ec0ec40..aa981d9d9d 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx @@ -15,7 +15,7 @@ The prices to create part of a price set. "name": "amount", "type": "`number`", "description": "The amount of this money amount.", - "optional": true, + "optional": false, "defaultValue": "", "expandable": false, "children": [] @@ -86,7 +86,7 @@ The prices to create part of a price set. }, { "name": "max_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The maximum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", @@ -95,7 +95,7 @@ The prices to create part of a price set. }, { "name": "min_quantity", - "type": "``null`` \\| `number`", + "type": "`null` \\| `number`", "description": "The minimum quantity required to be purchased for this money amount to be applied.", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceListProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceListProps.mdx new file mode 100644 index 0000000000..23742ade84 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceListProps.mdx @@ -0,0 +1,98 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterablePriceListProps + +#### Inteface + +Filters to apply on price lists. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceListRuleProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceListRuleProps.mdx new file mode 100644 index 0000000000..cf35a02925 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceListRuleProps.mdx @@ -0,0 +1,68 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FilterablePriceListRuleProps + +Filters to apply on price list rules. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx index 05f79d54c6..5e084131e3 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # FilterablePriceRuleProps -Filters to apply to price rules. +Filters to apply on price rules. ## Properties diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx index 6fc4c1cc3c..0e53f9993d 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx @@ -38,6 +38,15 @@ Filters to apply on price set money amounts. "expandable": false, "children": [] }, + { + "name": "price_list_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount's associated price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "price_set_id", "type": "`string`[]", diff --git a/www/apps/docs/content/references/pricing/interfaces/IPricingModuleService.mdx b/www/apps/docs/content/references/pricing/interfaces/IPricingModuleService.mdx index 5e92b653f2..3c562baa7f 100644 --- a/www/apps/docs/content/references/pricing/interfaces/IPricingModuleService.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/IPricingModuleService.mdx @@ -14,18 +14,23 @@ This section of the documentation provides a reference to the `IPricingModuleSer ## Methods +- [addPriceListPrices](../IPricingModuleService/methods/IPricingModuleService.addPriceListPrices.mdx) - [addPrices](../IPricingModuleService/methods/IPricingModuleService.addPrices.mdx) - [addRules](../IPricingModuleService/methods/IPricingModuleService.addRules.mdx) - [calculatePrices](../IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx) - [create](../IPricingModuleService/methods/IPricingModuleService.create.mdx) - [createCurrencies](../IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx) - [createMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx) +- [createPriceListRules](../IPricingModuleService/methods/IPricingModuleService.createPriceListRules.mdx) +- [createPriceLists](../IPricingModuleService/methods/IPricingModuleService.createPriceLists.mdx) - [createPriceRules](../IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx) - [createPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx) - [createRuleTypes](../IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx) - [delete](../IPricingModuleService/methods/IPricingModuleService.delete.mdx) - [deleteCurrencies](../IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx) - [deleteMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx) +- [deletePriceListRules](../IPricingModuleService/methods/IPricingModuleService.deletePriceListRules.mdx) +- [deletePriceLists](../IPricingModuleService/methods/IPricingModuleService.deletePriceLists.mdx) - [deletePriceRules](../IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx) - [deletePriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx) - [deleteRuleTypes](../IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx) @@ -33,25 +38,35 @@ This section of the documentation provides a reference to the `IPricingModuleSer - [listAndCount](../IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx) - [listAndCountCurrencies](../IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx) - [listAndCountMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx) +- [listAndCountPriceListRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceListRules.mdx) +- [listAndCountPriceLists](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceLists.mdx) - [listAndCountPriceRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx) - [listAndCountPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx) - [listAndCountPriceSetMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx) - [listAndCountRuleTypes](../IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx) - [listCurrencies](../IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx) - [listMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx) +- [listPriceListRules](../IPricingModuleService/methods/IPricingModuleService.listPriceListRules.mdx) +- [listPriceLists](../IPricingModuleService/methods/IPricingModuleService.listPriceLists.mdx) - [listPriceRules](../IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx) - [listPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx) - [listPriceSetMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx) - [listRuleTypes](../IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx) +- [removePriceListRules](../IPricingModuleService/methods/IPricingModuleService.removePriceListRules.mdx) - [removeRules](../IPricingModuleService/methods/IPricingModuleService.removeRules.mdx) - [retrieve](../IPricingModuleService/methods/IPricingModuleService.retrieve.mdx) - [retrieveCurrency](../IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx) - [retrieveMoneyAmount](../IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx) +- [retrievePriceList](../IPricingModuleService/methods/IPricingModuleService.retrievePriceList.mdx) +- [retrievePriceListRule](../IPricingModuleService/methods/IPricingModuleService.retrievePriceListRule.mdx) - [retrievePriceRule](../IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx) - [retrievePriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx) - [retrieveRuleType](../IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx) +- [setPriceListRules](../IPricingModuleService/methods/IPricingModuleService.setPriceListRules.mdx) - [updateCurrencies](../IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx) - [updateMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx) +- [updatePriceListRules](../IPricingModuleService/methods/IPricingModuleService.updatePriceListRules.mdx) +- [updatePriceLists](../IPricingModuleService/methods/IPricingModuleService.updatePriceLists.mdx) - [updatePriceRules](../IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx) - [updatePriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx) - [updateRuleTypes](../IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx) diff --git a/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx b/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx index ffcf9f4092..1d6ef6477c 100644 --- a/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" }, { "name": "extends", - "type": "`{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }`[]", + "type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]", "description": "", "optional": true, "defaultValue": "", diff --git a/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx index bdb42834fa..a4266fb7a6 100644 --- a/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx @@ -23,10 +23,10 @@ A money amount's data. A money amount represents a price. { "name": "currency", "type": "[CurrencyDTO](CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "code", @@ -101,5 +101,352 @@ A money amount's data. A money amount represents a price. "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of a price set money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amount", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)", + "description": "The money amount associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "currency", + "type": "[CurrencyDTO](CurrencyDTO.mdx)", + "description": "The money amount's currency.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + } + ] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "ends_at", + "type": "`null` \\| `string`", + "description": "The price list expires after this date.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The price list's ID.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amounts", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]", + "description": "The associated money amounts.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "number_rules", + "type": "`number`", + "description": "The number of rules associated with this price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_list_rules", + "type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]", + "description": "The price set's rules.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set_money_amounts", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]", + "description": "The associated price set money amounts.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "rule_types", + "type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]", + "description": "The associated rule types.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "rules", + "type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]", + "description": "The price set's rules.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "starts_at", + "type": "`null` \\| `string`", + "description": "The price list is enabled starting from this date.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "status", + "type": "[PriceListStatus](../enums/PriceListStatus.mdx)", + "description": "The price list's status.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The price list's title.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "price_rules", + "type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]", + "description": "The price rules associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_list_id", + "type": "`string`", + "description": "The ID of the associated price list.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_set", + "type": "[PriceSetDTO](PriceSetDTO.mdx)", + "description": "The associated price set.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`", + "description": "The ID of the associated price set money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "priority", + "type": "`number`", + "description": "The priority of the price rule in comparison to other applicable price rules.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "rule_type", + "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", + "description": "The associated rule type.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`", + "description": "The ID of the associated rule type.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "price_set", + "type": "[PriceSetDTO](PriceSetDTO.mdx)", + "description": "The price set associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amounts", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "rule_types", + "type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The title of the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] } ]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx new file mode 100644 index 0000000000..77b4938ac1 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx @@ -0,0 +1,1094 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListDTO + +A price list's details. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceListPriceDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceListPriceDTO.mdx new file mode 100644 index 0000000000..eba5be0250 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/PriceListPriceDTO.mdx @@ -0,0 +1,114 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListPriceDTO + +The prices associated with a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx new file mode 100644 index 0000000000..b5fa0c7508 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx @@ -0,0 +1,546 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListRuleDTO + +The price list rule's details. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceListRuleValueDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceListRuleValueDTO.mdx new file mode 100644 index 0000000000..24d42e5932 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/PriceListRuleValueDTO.mdx @@ -0,0 +1,252 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceListRuleValueDTO + +The price list rule value's details. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx index 9c8196eabf..303cbf68b8 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx @@ -32,10 +32,10 @@ A price rule's data. { "name": "price_set", "type": "[PriceSetDTO](PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -66,10 +66,10 @@ A price rule's data. { "name": "currency", "type": "[CurrencyDTO](CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -107,6 +107,15 @@ A price rule's data. "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] }, @@ -188,10 +197,10 @@ A price rule's data. { "name": "rule_type", "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "default_priority", diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx index e6736baf92..f3aba2f4f7 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx @@ -40,10 +40,10 @@ A price set's data. { "name": "currency", "type": "[CurrencyDTO](CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "code", @@ -118,6 +118,79 @@ A price set's data. "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of a price set money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amount", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)", + "description": "The money amount associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_rules", + "type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]", + "description": "The price rules associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set", + "type": "[PriceSetDTO](PriceSetDTO.mdx)", + "description": "The price set associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The title of the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] } ] }, diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx index 2729e26e40..9a1727e76f 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx @@ -23,10 +23,10 @@ A price set money amount's data. { "name": "money_amount", "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)", - "description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.", + "description": "The money amount associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "amount", @@ -40,10 +40,10 @@ A price set money amount's data. { "name": "currency", "type": "[CurrencyDTO](CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "code", @@ -118,16 +118,474 @@ A price set money amount's data. "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of a price set money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amount", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)", + "description": "The money amount associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_rules", + "type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]", + "description": "The price rules associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set", + "type": "[PriceSetDTO](PriceSetDTO.mdx)", + "description": "The price set associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The title of the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + } + ] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "ends_at", + "type": "`null` \\| `string`", + "description": "The price list expires after this date.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The price list's ID.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amounts", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]", + "description": "The associated money amounts.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "currency", + "type": "[CurrencyDTO](CurrencyDTO.mdx)", + "description": "The money amount's currency.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + } + ] + }, + { + "name": "number_rules", + "type": "`number`", + "description": "The number of rules associated with this price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_list_rules", + "type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]", + "description": "The price set's rules.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The price list rule's ID.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The associated price list.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_list_rule_values", + "type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]", + "description": "The associated rule values.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "rule_type", + "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", + "description": "The associated rule type.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "price_set_money_amounts", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]", + "description": "The associated price set money amounts.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of a price set money amount.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amount", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)", + "description": "The money amount associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_rules", + "type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]", + "description": "The price rules associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set", + "type": "[PriceSetDTO](PriceSetDTO.mdx)", + "description": "The price set associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The title of the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "rule_types", + "type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]", + "description": "The associated rule types.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "default_priority", + "type": "`number`", + "description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "rules", + "type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]", + "description": "The price set's rules.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The price list rule's ID.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The associated price list.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_list_rule_values", + "type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]", + "description": "The associated rule values.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "rule_type", + "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", + "description": "The associated rule type.", + "optional": false, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "starts_at", + "type": "`null` \\| `string`", + "description": "The price list is enabled starting from this date.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "status", + "type": "[PriceListStatus](../enums/PriceListStatus.mdx)", + "description": "The price list's status.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [ + { + "name": "ACTIVE", + "type": "`\"active\"`", + "description": "The price list is enabled and its prices can be used.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "DRAFT", + "type": "`\"draft\"`", + "description": "The price list is disabled, meaning its prices can't be used yet.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + } + ] + }, + { + "name": "title", + "type": "`string`", + "description": "The price list's title.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] } ] }, { "name": "price_rules", "type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]", - "description": "", + "description": "The price rules associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -150,10 +608,10 @@ A price set money amount's data. { "name": "price_set", "type": "[PriceSetDTO](PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -214,10 +672,10 @@ A price set money amount's data. { "name": "rule_type", "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "default_priority", @@ -280,10 +738,10 @@ A price set money amount's data. { "name": "price_set", "type": "[PriceSetDTO](PriceSetDTO.mdx)", - "description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.", + "description": "The price set associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -314,10 +772,10 @@ A price set money amount's data. { "name": "currency", "type": "[CurrencyDTO](CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -355,6 +813,15 @@ A price set money amount's data. "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] } ] }, @@ -409,7 +876,7 @@ A price set money amount's data. { "name": "price_set_id", "type": "`string`", - "description": "", + "description": "The ID of the associated price set.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx index 0ff5ffea8f..2b6b3b9d61 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx @@ -23,10 +23,10 @@ A price set money amount rule's data. { "name": "price_set_money_amount", "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", - "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "description": "The associated price set money amount.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -40,10 +40,10 @@ A price set money amount rule's data. { "name": "money_amount", "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)", - "description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.", + "description": "The money amount associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "amount", @@ -57,10 +57,10 @@ A price set money amount rule's data. { "name": "currency", "type": "[CurrencyDTO](CurrencyDTO.mdx)", - "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "description": "The money amount's currency.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -98,16 +98,134 @@ A price set money amount rule's data. "defaultValue": "", "expandable": false, "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)", + "description": "The details of the relation between the money amount and its associated price set.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + } + ] + }, + { + "name": "price_list", + "type": "[PriceListDTO](PriceListDTO.mdx)", + "description": "The price list associated with the price set money amount.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [ + { + "name": "ends_at", + "type": "`null` \\| `string`", + "description": "The price list expires after this date.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The price list's ID.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "money_amounts", + "type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]", + "description": "The associated money amounts.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "number_rules", + "type": "`number`", + "description": "The number of rules associated with this price list.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "price_list_rules", + "type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]", + "description": "The price set's rules.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "price_set_money_amounts", + "type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]", + "description": "The associated price set money amounts.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "rule_types", + "type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]", + "description": "The associated rule types.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "rules", + "type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]", + "description": "The price set's rules.", + "optional": true, + "defaultValue": "", + "expandable": true, + "children": [] + }, + { + "name": "starts_at", + "type": "`null` \\| `string`", + "description": "The price list is enabled starting from this date.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "status", + "type": "[PriceListStatus](../enums/PriceListStatus.mdx)", + "description": "The price list's status.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The price list's title.", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] } ] }, { "name": "price_rules", "type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]", - "description": "", + "description": "The price rules associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -130,10 +248,10 @@ A price set money amount rule's data. { "name": "price_set", "type": "[PriceSetDTO](PriceSetDTO.mdx)", - "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "description": "The associated price set.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -166,10 +284,10 @@ A price set money amount rule's data. { "name": "rule_type", "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] }, { @@ -195,10 +313,10 @@ A price set money amount rule's data. { "name": "price_set", "type": "[PriceSetDTO](PriceSetDTO.mdx)", - "description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.", + "description": "The price set associated with the price set money amount.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "id", @@ -232,7 +350,7 @@ A price set money amount rule's data. { "name": "price_set_id", "type": "`string`", - "description": "", + "description": "The ID of the associated price set.", "optional": true, "defaultValue": "", "expandable": false, @@ -252,10 +370,10 @@ A price set money amount rule's data. { "name": "rule_type", "type": "[RuleTypeDTO](RuleTypeDTO.mdx)", - "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "description": "The associated rule type.", "optional": false, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [ { "name": "default_priority", diff --git a/www/apps/docs/content/references/pricing/interfaces/RemovePriceListRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/RemovePriceListRulesDTO.mdx new file mode 100644 index 0000000000..03543e5717 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/RemovePriceListRulesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RemovePriceListRulesDTO + +The rules to remove from a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/SetPriceListRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/SetPriceListRulesDTO.mdx new file mode 100644 index 0000000000..7ed9260d25 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/SetPriceListRulesDTO.mdx @@ -0,0 +1,32 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SetPriceListRulesDTO + +The rules to add to a price list. + +## Properties + +`", + "description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value is the value(s) of the rule.", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx index 76e0c481aa..19aad4943c 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx @@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # UpdateMoneyAmountDTO -* - The data to update in a money amount. The `id` is used to identify which money amount to update. ## Properties diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx new file mode 100644 index 0000000000..fdecc4743d --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx @@ -0,0 +1,96 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListDTO + +The attributes to update in a price list. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListRuleDTO.mdx new file mode 100644 index 0000000000..85784efc00 --- /dev/null +++ b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceListRuleDTO.mdx @@ -0,0 +1,59 @@ +--- +displayed_sidebar: pricingReference +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UpdatePriceListRuleDTO + +The attributes to update in a price list rule. + +## Properties + + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx index 37b8c3901c..3567e6a5a9 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx @@ -14,7 +14,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "id", "type": "`string`", - "description": "The ID of the price rule to update.", + "description": "", "optional": false, "defaultValue": "", "expandable": false, @@ -32,7 +32,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "price_set_id", "type": "`string`", - "description": "The ID of the associated price set.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, @@ -59,7 +59,7 @@ The data to update in a price rule. The `id` is used to identify which money amo { "name": "rule_type_id", "type": "`string`", - "description": "The ID of the associated rule type.", + "description": "", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/pricing/types/Exclude.mdx b/www/apps/docs/content/references/pricing/types/Exclude.mdx index d62dafce19..df5ea42dd2 100644 --- a/www/apps/docs/content/references/pricing/types/Exclude.mdx +++ b/www/apps/docs/content/references/pricing/types/Exclude.mdx @@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # Exclude - **Exclude**``: T extends U ? never : T + **Exclude**``: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U diff --git a/www/apps/docs/content/references/pricing/types/ModuleJoinerConfig.mdx b/www/apps/docs/content/references/pricing/types/ModuleJoinerConfig.mdx index e6b3510091..47d3075baf 100644 --- a/www/apps/docs/content/references/pricing/types/ModuleJoinerConfig.mdx +++ b/www/apps/docs/content/references/pricing/types/ModuleJoinerConfig.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerConfig - **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), `"serviceName"` \| `"primaryKeys"` \| `"relationships"` \| `"extends"`> & { databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: `"date"` \| `"time"` \| `"datetime"` \| `"bigint"` \| `"blob"` \| `"uint8array"` \| `"array"` \| `"enumArray"` \| `"enum"` \| `"json"` \| `"integer"` \| `"smallint"` \| `"tinyint"` \| `"mediumint"` \| `"float"` \| `"double"` \| `"boolean"` \| `"decimal"` \| `"string"` \| `"uuid"` \| `"text"` }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string } + **ModuleJoinerConfig**: [Omit](Omit.mdx)<[JoinerServiceConfig](../interfaces/JoinerServiceConfig.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & ``{ databaseConfig?: { extraFields?: Record<string, { defaultValue?: string ; nullable?: boolean ; options?: Record<string, unknown> ; type: "date" \| "time" \| "datetime" \| bigint \| "blob" \| "uint8array" \| "array" \| "enumArray" \| "enum" \| "json" \| "integer" \| "smallint" \| "tinyint" \| "mediumint" \| "float" \| "double" \| "boolean" \| "decimal" \| "string" \| "uuid" \| "text" }> ; idPrefix?: string ; tableName?: string } ; extends?: { fieldAlias?: Record<string, string \| { forwardArgumentsOnPath: string[] ; path: string }> ; relationship: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx) ; serviceName: string }[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record<string, string> ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string }`` diff --git a/www/apps/docs/content/references/pricing/types/ModuleJoinerRelationship.mdx b/www/apps/docs/content/references/pricing/types/ModuleJoinerRelationship.mdx index d8a280b5bf..ef030e0da4 100644 --- a/www/apps/docs/content/references/pricing/types/ModuleJoinerRelationship.mdx +++ b/www/apps/docs/content/references/pricing/types/ModuleJoinerRelationship.mdx @@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # ModuleJoinerRelationship - **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & { deleteCascade?: boolean ; isInternalService?: boolean } + **ModuleJoinerRelationship**: [JoinerRelationship](JoinerRelationship.mdx) & ``{ deleteCascade?: boolean ; isInternalService?: boolean }`` diff --git a/www/apps/docs/content/references/services/classes/ProductCategory.mdx b/www/apps/docs/content/references/services/classes/ProductCategory.mdx index 2ce933d0c9..392aa9119a 100644 --- a/www/apps/docs/content/references/services/classes/ProductCategory.mdx +++ b/www/apps/docs/content/references/services/classes/ProductCategory.mdx @@ -82,6 +82,15 @@ A product category can be used to categorize products into a hierarchy of catego "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "An optional key-value map with additional details", + "optional": false, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "name", "type": "`string`", diff --git a/www/apps/docs/content/references/services/interfaces/BulkUpdateInventoryLevelInput.mdx b/www/apps/docs/content/references/services/interfaces/BulkUpdateInventoryLevelInput.mdx index 8d7a9b9bed..a1770b2b8b 100644 --- a/www/apps/docs/content/references/services/interfaces/BulkUpdateInventoryLevelInput.mdx +++ b/www/apps/docs/content/references/services/interfaces/BulkUpdateInventoryLevelInput.mdx @@ -14,7 +14,7 @@ The attributes to update in an inventory level. The inventory level is identifie { "name": "incoming_quantity", "type": "`number`", - "description": "", + "description": "The incoming quantity of the associated inventory item in the associated location.", "optional": true, "defaultValue": "", "expandable": false, @@ -41,7 +41,7 @@ The attributes to update in an inventory level. The inventory level is identifie { "name": "stocked_quantity", "type": "`number`", - "description": "", + "description": "The stocked quantity of the associated inventory item in the associated location.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/Context.mdx b/www/apps/docs/content/references/services/interfaces/Context.mdx index 0acfa56922..79c6336f76 100644 --- a/www/apps/docs/content/references/services/interfaces/Context.mdx +++ b/www/apps/docs/content/references/services/interfaces/Context.mdx @@ -28,7 +28,7 @@ A shared context object that is used to share resources between the application { "name": "enableNestedTransactions", "type": "`boolean`", - "description": "a boolean value indicating whether nested transactions are enabled.", + "description": "A boolean value indicating whether nested transactions are enabled.", "optional": true, "defaultValue": "", "expandable": false, @@ -55,7 +55,7 @@ A shared context object that is used to share resources between the application { "name": "transactionId", "type": "`string`", - "description": "a string indicating the ID of the current transaction.", + "description": "A string indicating the ID of the current transaction.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx b/www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx index 08c89f0993..75bd9d0db2 100644 --- a/www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx +++ b/www/apps/docs/content/references/services/interfaces/CreateInventoryItemInput.mdx @@ -86,7 +86,7 @@ The details of the inventory item to be created. { "name": "requires_shipping", "type": "`boolean`", - "description": "", + "description": "Whether the inventory item requires shipping.", "optional": true, "defaultValue": "", "expandable": false, diff --git a/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx b/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx index 59f28c36b9..9793735e63 100644 --- a/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/services/interfaces/MoneyAmountDTO.mdx @@ -71,7 +71,7 @@ A money amount's data. A money amount represents a price. "description": "The details of the relation between the money amount and its associated price set.", "optional": true, "defaultValue": "", - "expandable": false, + "expandable": true, "children": [] } ]} /> diff --git a/www/apps/docs/content/references/services/types/ProductCategoryInput.mdx b/www/apps/docs/content/references/services/types/ProductCategoryInput.mdx index 3353d7b49b..95808d069d 100644 --- a/www/apps/docs/content/references/services/types/ProductCategoryInput.mdx +++ b/www/apps/docs/content/references/services/types/ProductCategoryInput.mdx @@ -38,6 +38,15 @@ import ParameterTypes from "@site/src/components/ParameterTypes" "expandable": false, "children": [] }, + { + "name": "metadata", + "type": "`Record`", + "description": "", + "optional": true, + "defaultValue": "", + "expandable": false, + "children": [] + }, { "name": "parent_category", "type": "[ProductCategory](../classes/ProductCategory.mdx) \\| `null`",