This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
75 lines
6.7 KiB
Plaintext
75 lines
6.7 KiB
Plaintext
---
|
||
displayed_sidebar: pricingReference
|
||
badge:
|
||
variant: orange
|
||
text: Beta
|
||
slug: /references/pricing
|
||
---
|
||
|
||
import TypeList from "@site/src/components/TypeList"
|
||
|
||
# IPricingModuleService Reference
|
||
|
||
This section of the documentation provides a reference to the `IPricingModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Pricing Module.
|
||
|
||
## Methods
|
||
|
||
- [calculatePrices](../IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx)
|
||
- [retrieve](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx)
|
||
- [list](../IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx)
|
||
- [listAndCount](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx)
|
||
- [create](../IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx)
|
||
- [removeRules](../IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx)
|
||
- [delete](../IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx)
|
||
- [addPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx)
|
||
- [addRules](../IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx)
|
||
- [retrieveMoneyAmount](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx)
|
||
- [listMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx)
|
||
- [listAndCountMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx)
|
||
- [createMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx)
|
||
- [updateMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx)
|
||
- [deleteMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx)
|
||
- [softDeleteMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.softDeleteMoneyAmounts.mdx)
|
||
- [restoreMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.restoreMoneyAmounts.mdx)
|
||
- [retrieveCurrency](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx)
|
||
- [listCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx)
|
||
- [listAndCountCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx)
|
||
- [createCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx)
|
||
- [updateCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx)
|
||
- [deleteCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx)
|
||
- [retrieveRuleType](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx)
|
||
- [listRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx)
|
||
- [listAndCountRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx)
|
||
- [createRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx)
|
||
- [updateRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx)
|
||
- [deleteRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx)
|
||
- [retrievePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx)
|
||
- [listPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
|
||
- [listAndCountPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
|
||
- [listPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx)
|
||
- [listAndCountPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
|
||
- [createPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx)
|
||
- [updatePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx)
|
||
- [deletePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx)
|
||
- [retrievePriceRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx)
|
||
- [listPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx)
|
||
- [listAndCountPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx)
|
||
- [createPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx)
|
||
- [updatePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx)
|
||
- [deletePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx)
|
||
- [retrievePriceList](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx)
|
||
- [listPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx)
|
||
- [listAndCountPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx)
|
||
- [createPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx)
|
||
- [updatePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx)
|
||
- [deletePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx)
|
||
- [retrievePriceListRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx)
|
||
- [listPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx)
|
||
- [listAndCountPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx)
|
||
- [createPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx)
|
||
- [updatePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx)
|
||
- [deletePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx)
|
||
- [addPriceListPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx)
|
||
- [setPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx)
|
||
- [removePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx)
|